DPDK  19.11.14-rc1
rte_memory.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation
3  */
4 
5 #ifndef _RTE_MEMORY_H_
6 #define _RTE_MEMORY_H_
7 
14 #include <stdint.h>
15 #include <stddef.h>
16 #include <stdio.h>
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 #include <rte_common.h>
23 #include <rte_compat.h>
24 #include <rte_config.h>
25 #include <rte_fbarray.h>
26 
27 __extension__
28 enum rte_page_sizes {
29  RTE_PGSIZE_4K = 1ULL << 12,
30  RTE_PGSIZE_64K = 1ULL << 16,
31  RTE_PGSIZE_256K = 1ULL << 18,
32  RTE_PGSIZE_2M = 1ULL << 21,
33  RTE_PGSIZE_16M = 1ULL << 24,
34  RTE_PGSIZE_256M = 1ULL << 28,
35  RTE_PGSIZE_512M = 1ULL << 29,
36  RTE_PGSIZE_1G = 1ULL << 30,
37  RTE_PGSIZE_4G = 1ULL << 32,
38  RTE_PGSIZE_16G = 1ULL << 34,
39 };
40 
41 #define SOCKET_ID_ANY -1
46 #define RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0)
47 
48 struct rte_memseg {
50  union {
51  phys_addr_t phys_addr;
52  rte_iova_t iova;
53  };
55  union {
56  void *addr;
57  uint64_t addr_64;
58  };
59  size_t len;
60  uint64_t hugepage_sz;
61  int32_t socket_id;
62  uint32_t nchannel;
63  uint32_t nrank;
64  uint32_t flags;
65 } __rte_packed;
66 
73  union {
74  void *base_va;
76  uint64_t addr_64;
78  };
79  uint64_t page_sz;
80  int socket_id;
81  volatile uint32_t version;
82  size_t len;
83  unsigned int external;
84  unsigned int heap;
85  struct rte_fbarray memseg_arr;
86 };
87 
96 int rte_mem_lock_page(const void *virt);
97 
108 phys_addr_t rte_mem_virt2phy(const void *virt);
109 
123 rte_iova_t rte_mem_virt2iova(const void *virt);
124 
137 __rte_experimental
138 void *
140 
152 __rte_experimental
153 struct rte_memseg *
154 rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
155 
164 __rte_experimental
165 struct rte_memseg_list *
166 rte_mem_virt2memseg_list(const void *virt);
167 
175 typedef int (*rte_memseg_walk_t)(const struct rte_memseg_list *msl,
176  const struct rte_memseg *ms, void *arg);
177 
187 typedef int (*rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl,
188  const struct rte_memseg *ms, size_t len, void *arg);
189 
198 typedef int (*rte_memseg_list_walk_t)(const struct rte_memseg_list *msl,
199  void *arg);
200 
219 __rte_experimental
220 int
221 rte_memseg_walk(rte_memseg_walk_t func, void *arg);
222 
241 __rte_experimental
242 int
244 
263 __rte_experimental
264 int
266 
282 __rte_experimental
283 int
285 
301 __rte_experimental
302 int
304 
320 __rte_experimental
321 int
323 
345 __rte_experimental
346 int
347 rte_memseg_get_fd(const struct rte_memseg *ms);
348 
370 __rte_experimental
371 int
372 rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms);
373 
395 __rte_experimental
396 int
397 rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
398 
420 __rte_experimental
421 int
422 rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms,
423  size_t *offset);
424 
462 __rte_experimental
463 int
464 rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[],
465  unsigned int n_pages, size_t page_sz);
466 
493 __rte_experimental
494 int
495 rte_extmem_unregister(void *va_addr, size_t len);
496 
520 __rte_experimental
521 int
522 rte_extmem_attach(void *va_addr, size_t len);
523 
547 __rte_experimental
548 int
549 rte_extmem_detach(void *va_addr, size_t len);
550 
560 void rte_dump_physmem_layout(FILE *f);
561 
571 uint64_t rte_eal_get_physmem_size(void);
572 
580 unsigned rte_memory_get_nchannel(void);
581 
589 unsigned rte_memory_get_nrank(void);
590 
601 __rte_experimental
602 int rte_mem_check_dma_mask(uint8_t maskbits);
603 
620 __rte_experimental
621 int rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits);
622 
631 __rte_experimental
632 void rte_mem_set_dma_mask(uint8_t maskbits);
633 
643 int rte_eal_using_phys_addrs(void);
644 
645 
653 };
654 #define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64
655 
660 typedef void (*rte_mem_event_callback_t)(enum rte_mem_event event_type,
661  const void *addr, size_t len, void *arg);
662 
688 __rte_experimental
689 int
691  void *arg);
692 
707 __rte_experimental
708 int
709 rte_mem_event_callback_unregister(const char *name, void *arg);
710 
711 
712 #define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
713 
721  size_t cur_limit, size_t new_len);
722 
757 __rte_experimental
758 int
759 rte_mem_alloc_validator_register(const char *name,
760  rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
761 
776 __rte_experimental
777 int
778 rte_mem_alloc_validator_unregister(const char *name, int socket_id);
779 
780 #ifdef __cplusplus
781 }
782 #endif
783 
784 #endif /* _RTE_MEMORY_H_ */
__rte_experimental int rte_memseg_list_walk(rte_memseg_list_walk_t func, void *arg)
__rte_experimental int rte_memseg_walk(rte_memseg_walk_t func, void *arg)
__rte_experimental int rte_mem_alloc_validator_unregister(const char *name, int socket_id)
Unregister validator callback for memory allocations.
unsigned rte_memory_get_nchannel(void)
__rte_experimental int rte_memseg_contig_walk_thread_unsafe(rte_memseg_contig_walk_t func, void *arg)
__rte_experimental struct rte_memseg * rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl)
__rte_experimental int rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms)
__rte_experimental int rte_memseg_walk_thread_unsafe(rte_memseg_walk_t func, void *arg)
uint64_t rte_iova_t
Definition: rte_common.h:340
__rte_experimental int rte_memseg_contig_walk(rte_memseg_contig_walk_t func, void *arg)
int rte_eal_using_phys_addrs(void)
int rte_mem_lock_page(const void *virt)
__rte_experimental int rte_memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg)
__rte_experimental int rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms, size_t *offset)
unsigned rte_memory_get_nrank(void)
__rte_experimental int rte_memseg_get_fd(const struct rte_memseg *ms)
int(* rte_memseg_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, void *arg)
Definition: rte_memory.h:175
rte_mem_event
Definition: rte_memory.h:650
phys_addr_t rte_mem_virt2phy(const void *virt)
#define __rte_packed
Definition: rte_common.h:69
uint64_t rte_eal_get_physmem_size(void)
__rte_experimental int rte_mem_event_callback_unregister(const char *name, void *arg)
__rte_experimental void rte_mem_set_dma_mask(uint8_t maskbits)
void(* rte_mem_event_callback_t)(enum rte_mem_event event_type, const void *addr, size_t len, void *arg)
Definition: rte_memory.h:660
uint64_t phys_addr_t
Definition: rte_common.h:330
__rte_experimental int rte_mem_alloc_validator_register(const char *name, rte_mem_alloc_validator_t clb, int socket_id, size_t limit)
Register validator callback for memory allocations.
__rte_experimental int rte_extmem_attach(void *va_addr, size_t len)
__rte_experimental int rte_extmem_detach(void *va_addr, size_t len)
__rte_experimental void * rte_mem_iova2virt(rte_iova_t iova)
void * base_va
Definition: rte_memory.h:74
volatile uint32_t version
Definition: rte_memory.h:81
uint64_t addr_64
Definition: rte_memory.h:76
void rte_dump_physmem_layout(FILE *f)
#define RTE_STD_C11
Definition: rte_common.h:40
unsigned int heap
Definition: rte_memory.h:84
unsigned int external
Definition: rte_memory.h:83
__rte_experimental int rte_extmem_unregister(void *va_addr, size_t len)
uint64_t page_sz
Definition: rte_memory.h:79
int(* rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, size_t len, void *arg)
Definition: rte_memory.h:187
__rte_experimental struct rte_memseg_list * rte_mem_virt2memseg_list(const void *virt)
int(* rte_mem_alloc_validator_t)(int socket_id, size_t cur_limit, size_t new_len)
Definition: rte_memory.h:720
__rte_experimental int rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
__rte_experimental int rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits)
int(* rte_memseg_list_walk_t)(const struct rte_memseg_list *msl, void *arg)
Definition: rte_memory.h:198
__rte_experimental int rte_mem_check_dma_mask(uint8_t maskbits)
__rte_experimental int rte_mem_event_callback_register(const char *name, rte_mem_event_callback_t clb, void *arg)
rte_iova_t rte_mem_virt2iova(const void *virt)
__rte_experimental int rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset)