DPDK  20.11.3
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 #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
43 #define RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0)
44 
45 struct rte_memseg {
46  rte_iova_t iova;
48  union {
49  void *addr;
50  uint64_t addr_64;
51  };
52  size_t len;
53  uint64_t hugepage_sz;
54  int32_t socket_id;
55  uint32_t nchannel;
56  uint32_t nrank;
57  uint32_t flags;
58 } __rte_packed;
59 
66  union {
67  void *base_va;
69  uint64_t addr_64;
71  };
72  uint64_t page_sz;
73  int socket_id;
74  volatile uint32_t version;
75  size_t len;
76  unsigned int external;
77  unsigned int heap;
78  struct rte_fbarray memseg_arr;
79 };
80 
89 int rte_mem_lock_page(const void *virt);
90 
101 phys_addr_t rte_mem_virt2phy(const void *virt);
102 
116 rte_iova_t rte_mem_virt2iova(const void *virt);
117 
130 __rte_experimental
131 void *
133 
145 __rte_experimental
146 struct rte_memseg *
147 rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
148 
157 __rte_experimental
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 __rte_experimental
213 int
214 rte_memseg_walk(rte_memseg_walk_t func, void *arg);
215 
234 __rte_experimental
235 int
237 
256 __rte_experimental
257 int
259 
275 __rte_experimental
276 int
278 
294 __rte_experimental
295 int
297 
313 __rte_experimental
314 int
316 
338 __rte_experimental
339 int
340 rte_memseg_get_fd(const struct rte_memseg *ms);
341 
363 __rte_experimental
364 int
365 rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms);
366 
388 __rte_experimental
389 int
390 rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
391 
413 __rte_experimental
414 int
415 rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms,
416  size_t *offset);
417 
455 __rte_experimental
456 int
457 rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[],
458  unsigned int n_pages, size_t page_sz);
459 
486 __rte_experimental
487 int
488 rte_extmem_unregister(void *va_addr, size_t len);
489 
513 __rte_experimental
514 int
515 rte_extmem_attach(void *va_addr, size_t len);
516 
540 __rte_experimental
541 int
542 rte_extmem_detach(void *va_addr, size_t len);
543 
553 void rte_dump_physmem_layout(FILE *f);
554 
564 uint64_t rte_eal_get_physmem_size(void);
565 
573 unsigned rte_memory_get_nchannel(void);
574 
582 unsigned rte_memory_get_nrank(void);
583 
594 __rte_experimental
595 int rte_mem_check_dma_mask(uint8_t maskbits);
596 
613 __rte_experimental
614 int rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits);
615 
624 __rte_experimental
625 void rte_mem_set_dma_mask(uint8_t maskbits);
626 
636 int rte_eal_using_phys_addrs(void);
637 
638 
646 };
647 #define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64
648 
653 typedef void (*rte_mem_event_callback_t)(enum rte_mem_event event_type,
654  const void *addr, size_t len, void *arg);
655 
681 __rte_experimental
682 int
684  void *arg);
685 
700 __rte_experimental
701 int
702 rte_mem_event_callback_unregister(const char *name, void *arg);
703 
704 
705 #define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
706 
714  size_t cur_limit, size_t new_len);
715 
750 __rte_experimental
751 int
752 rte_mem_alloc_validator_register(const char *name,
753  rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
754 
769 __rte_experimental
770 int
771 rte_mem_alloc_validator_unregister(const char *name, int socket_id);
772 
773 #ifdef __cplusplus
774 }
775 #endif
776 
777 #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.
#define __rte_packed
Definition: rte_common.h:84
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:418
__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:168
rte_mem_event
Definition: rte_memory.h:643
phys_addr_t rte_mem_virt2phy(const void *virt)
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:653
uint64_t phys_addr_t
Definition: rte_common.h:408
__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:67
volatile uint32_t version
Definition: rte_memory.h:74
uint64_t addr_64
Definition: rte_memory.h:69
void rte_dump_physmem_layout(FILE *f)
#define RTE_STD_C11
Definition: rte_common.h:40
unsigned int heap
Definition: rte_memory.h:77
unsigned int external
Definition: rte_memory.h:76
__rte_experimental int rte_extmem_unregister(void *va_addr, size_t len)
uint64_t page_sz
Definition: rte_memory.h:72
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
__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:713
__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:191
__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)