DPDK  22.11.0-rc4
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_bitops.h>
23 #include <rte_common.h>
24 #include <rte_config.h>
25 #include <rte_fbarray.h>
26 
27 #define RTE_PGSIZE_4K (1ULL << 12)
28 #define RTE_PGSIZE_64K (1ULL << 16)
29 #define RTE_PGSIZE_256K (1ULL << 18)
30 #define RTE_PGSIZE_2M (1ULL << 21)
31 #define RTE_PGSIZE_16M (1ULL << 24)
32 #define RTE_PGSIZE_256M (1ULL << 28)
33 #define RTE_PGSIZE_512M (1ULL << 29)
34 #define RTE_PGSIZE_1G (1ULL << 30)
35 #define RTE_PGSIZE_4G (1ULL << 32)
36 #define RTE_PGSIZE_16G (1ULL << 34)
37 
38 #define SOCKET_ID_ANY -1
41 #define RTE_MEMSEG_FLAG_DO_NOT_FREE RTE_BIT32(0)
42 
43 #define RTE_MEMSEG_FLAG_DIRTY RTE_BIT32(1)
44 
48 struct rte_memseg {
51  union {
52  void *addr;
53  uint64_t addr_64;
54  };
55  size_t len;
56  uint64_t hugepage_sz;
57  int32_t socket_id;
58  uint32_t nchannel;
59  uint32_t nrank;
60  uint32_t flags;
61 } __rte_packed;
62 
69  union {
70  void *base_va;
72  uint64_t addr_64;
74  };
75  uint64_t page_sz;
76  int socket_id;
77  volatile uint32_t version;
78  size_t len;
79  unsigned int external;
80  unsigned int heap;
81  struct rte_fbarray memseg_arr;
82 };
83 
92 int rte_mem_lock_page(const void *virt);
93 
104 phys_addr_t rte_mem_virt2phy(const void *virt);
105 
119 rte_iova_t rte_mem_virt2iova(const void *virt);
120 
133 void *
135 
147 struct rte_memseg *
148 rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
149 
158 struct rte_memseg_list *
159 rte_mem_virt2memseg_list(const void *virt);
160 
168 typedef int (*rte_memseg_walk_t)(const struct rte_memseg_list *msl,
169  const struct rte_memseg *ms, void *arg);
170 
180 typedef int (*rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl,
181  const struct rte_memseg *ms, size_t len, void *arg);
182 
191 typedef int (*rte_memseg_list_walk_t)(const struct rte_memseg_list *msl,
192  void *arg);
193 
212 int
213 rte_memseg_walk(rte_memseg_walk_t func, void *arg);
214 
233 int
235 
254 int
256 
272 int
274 
290 int
292 
308 int
310 
332 int
333 rte_memseg_get_fd(const struct rte_memseg *ms);
334 
356 int
358 
380 int
381 rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
382 
404 int
406  size_t *offset);
407 
442 int
443 rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[],
444  unsigned int n_pages, size_t page_sz);
445 
469 int
470 rte_extmem_unregister(void *va_addr, size_t len);
471 
492 int
493 rte_extmem_attach(void *va_addr, size_t len);
494 
515 int
516 rte_extmem_detach(void *va_addr, size_t len);
517 
527 void rte_dump_physmem_layout(FILE *f);
528 
538 uint64_t rte_eal_get_physmem_size(void);
539 
547 unsigned rte_memory_get_nchannel(void);
548 
556 unsigned rte_memory_get_nrank(void);
557 
565 int rte_mem_check_dma_mask(uint8_t maskbits);
566 
580 int rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits);
581 
587 void rte_mem_set_dma_mask(uint8_t maskbits);
588 
598 int rte_eal_using_phys_addrs(void);
599 
600 
608 };
609 #define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64
610 
615 typedef void (*rte_mem_event_callback_t)(enum rte_mem_event event_type,
616  const void *addr, size_t len, void *arg);
617 
643 int
645  void *arg);
646 
661 int
662 rte_mem_event_callback_unregister(const char *name, void *arg);
663 
664 
665 #define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
666 
674  size_t cur_limit, size_t new_len);
675 
710 int
711 rte_mem_alloc_validator_register(const char *name,
712  rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
713 
728 int
729 rte_mem_alloc_validator_unregister(const char *name, int socket_id);
730 
731 #ifdef __cplusplus
732 }
733 #endif
734 
735 #endif /* _RTE_MEMORY_H_ */
#define __rte_packed
Definition: rte_common.h:83
uint32_t flags
Definition: rte_memory.h:60
void * addr
Definition: rte_memory.h:52
unsigned rte_memory_get_nchannel(void)
int rte_memseg_walk(rte_memseg_walk_t func, void *arg)
void * rte_mem_iova2virt(rte_iova_t iova)
rte_iova_t iova
Definition: rte_memory.h:49
uint32_t nchannel
Definition: rte_memory.h:58
int rte_memseg_contig_walk_thread_unsafe(rte_memseg_contig_walk_t func, void *arg)
int rte_mem_alloc_validator_unregister(const char *name, int socket_id)
Unregister validator callback for memory allocations.
int rte_mem_event_callback_register(const char *name, rte_mem_event_callback_t clb, void *arg)
uint64_t rte_iova_t
Definition: rte_common.h:458
int rte_eal_using_phys_addrs(void)
int rte_mem_lock_page(const void *virt)
int rte_memseg_get_fd(const struct rte_memseg *ms)
unsigned rte_memory_get_nrank(void)
int rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms)
int32_t socket_id
Definition: rte_memory.h:57
uint64_t addr_64
Definition: rte_memory.h:53
int rte_extmem_attach(void *va_addr, size_t len)
int(* rte_memseg_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, void *arg)
Definition: rte_memory.h:168
size_t len
Definition: rte_memory.h:55
rte_mem_event
Definition: rte_memory.h:605
uint64_t hugepage_sz
Definition: rte_memory.h:56
phys_addr_t rte_mem_virt2phy(const void *virt)
int rte_mem_check_dma_mask(uint8_t maskbits)
struct rte_memseg * rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl)
uint64_t rte_eal_get_physmem_size(void)
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.
void(* rte_mem_event_callback_t)(enum rte_mem_event event_type, const void *addr, size_t len, void *arg)
Definition: rte_memory.h:615
uint64_t phys_addr_t
Definition: rte_common.h:448
int rte_extmem_unregister(void *va_addr, size_t len)
void rte_mem_set_dma_mask(uint8_t maskbits)
void * base_va
Definition: rte_memory.h:70
volatile uint32_t version
Definition: rte_memory.h:77
uint64_t addr_64
Definition: rte_memory.h:72
int rte_extmem_detach(void *va_addr, size_t len)
int rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms, size_t *offset)
void rte_dump_physmem_layout(FILE *f)
int rte_memseg_list_walk(rte_memseg_list_walk_t func, void *arg)
int rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
int rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits)
int rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset)
#define RTE_STD_C11
Definition: rte_common.h:39
struct rte_memseg_list * rte_mem_virt2memseg_list(const void *virt)
int rte_memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg)
unsigned int heap
Definition: rte_memory.h:80
unsigned int external
Definition: rte_memory.h:79
int rte_mem_event_callback_unregister(const char *name, void *arg)
uint64_t page_sz
Definition: rte_memory.h:75
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:180
int(* rte_mem_alloc_validator_t)(int socket_id, size_t cur_limit, size_t new_len)
Definition: rte_memory.h:673
int(* rte_memseg_list_walk_t)(const struct rte_memseg_list *msl, void *arg)
Definition: rte_memory.h:191
int rte_memseg_walk_thread_unsafe(rte_memseg_walk_t func, void *arg)
uint32_t nrank
Definition: rte_memory.h:59
int rte_memseg_contig_walk(rte_memseg_contig_walk_t func, void *arg)
rte_iova_t rte_mem_virt2iova(const void *virt)