DPDK  20.11.2
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_32M (1ULL << 25)
33 #define RTE_PGSIZE_256M (1ULL << 28)
34 #define RTE_PGSIZE_512M (1ULL << 29)
35 #define RTE_PGSIZE_1G (1ULL << 30)
36 #define RTE_PGSIZE_4G (1ULL << 32)
37 #define RTE_PGSIZE_16G (1ULL << 34)
38 
39 #define SOCKET_ID_ANY -1
44 #define RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0)
45 
46 struct rte_memseg {
47  rte_iova_t iova;
49  union {
50  void *addr;
51  uint64_t addr_64;
52  };
53  size_t len;
54  uint64_t hugepage_sz;
55  int32_t socket_id;
56  uint32_t nchannel;
57  uint32_t nrank;
58  uint32_t flags;
59 } __rte_packed;
60 
67  union {
68  void *base_va;
70  uint64_t addr_64;
72  };
73  uint64_t page_sz;
74  int socket_id;
75  volatile uint32_t version;
76  size_t len;
77  unsigned int external;
78  unsigned int heap;
79  struct rte_fbarray memseg_arr;
80 };
81 
90 int rte_mem_lock_page(const void *virt);
91 
102 phys_addr_t rte_mem_virt2phy(const void *virt);
103 
117 rte_iova_t rte_mem_virt2iova(const void *virt);
118 
131 __rte_experimental
132 void *
134 
146 __rte_experimental
147 struct rte_memseg *
148 rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
149 
158 __rte_experimental
159 struct rte_memseg_list *
160 rte_mem_virt2memseg_list(const void *virt);
161 
169 typedef int (*rte_memseg_walk_t)(const struct rte_memseg_list *msl,
170  const struct rte_memseg *ms, void *arg);
171 
181 typedef int (*rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl,
182  const struct rte_memseg *ms, size_t len, void *arg);
183 
192 typedef int (*rte_memseg_list_walk_t)(const struct rte_memseg_list *msl,
193  void *arg);
194 
213 __rte_experimental
214 int
215 rte_memseg_walk(rte_memseg_walk_t func, void *arg);
216 
235 __rte_experimental
236 int
238 
257 __rte_experimental
258 int
260 
276 __rte_experimental
277 int
279 
295 __rte_experimental
296 int
298 
314 __rte_experimental
315 int
317 
339 __rte_experimental
340 int
341 rte_memseg_get_fd(const struct rte_memseg *ms);
342 
364 __rte_experimental
365 int
366 rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms);
367 
389 __rte_experimental
390 int
391 rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
392 
414 __rte_experimental
415 int
416 rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms,
417  size_t *offset);
418 
456 __rte_experimental
457 int
458 rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[],
459  unsigned int n_pages, size_t page_sz);
460 
487 __rte_experimental
488 int
489 rte_extmem_unregister(void *va_addr, size_t len);
490 
514 __rte_experimental
515 int
516 rte_extmem_attach(void *va_addr, size_t len);
517 
541 __rte_experimental
542 int
543 rte_extmem_detach(void *va_addr, size_t len);
544 
554 void rte_dump_physmem_layout(FILE *f);
555 
565 uint64_t rte_eal_get_physmem_size(void);
566 
574 unsigned rte_memory_get_nchannel(void);
575 
583 unsigned rte_memory_get_nrank(void);
584 
595 __rte_experimental
596 int rte_mem_check_dma_mask(uint8_t maskbits);
597 
614 __rte_experimental
615 int rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits);
616 
625 __rte_experimental
626 void rte_mem_set_dma_mask(uint8_t maskbits);
627 
637 int rte_eal_using_phys_addrs(void);
638 
639 
647 };
648 #define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64
649 
654 typedef void (*rte_mem_event_callback_t)(enum rte_mem_event event_type,
655  const void *addr, size_t len, void *arg);
656 
682 __rte_experimental
683 int
685  void *arg);
686 
701 __rte_experimental
702 int
703 rte_mem_event_callback_unregister(const char *name, void *arg);
704 
705 
706 #define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
707 
715  size_t cur_limit, size_t new_len);
716 
751 __rte_experimental
752 int
753 rte_mem_alloc_validator_register(const char *name,
754  rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
755 
770 __rte_experimental
771 int
772 rte_mem_alloc_validator_unregister(const char *name, int socket_id);
773 
774 #ifdef __cplusplus
775 }
776 #endif
777 
778 #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:169
rte_mem_event
Definition: rte_memory.h:644
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:654
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:68
volatile uint32_t version
Definition: rte_memory.h:75
uint64_t addr_64
Definition: rte_memory.h:70
void rte_dump_physmem_layout(FILE *f)
#define RTE_STD_C11
Definition: rte_common.h:40
unsigned int heap
Definition: rte_memory.h:78
unsigned int external
Definition: rte_memory.h:77
__rte_experimental int rte_extmem_unregister(void *va_addr, size_t len)
uint64_t page_sz
Definition: rte_memory.h:73
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:181
__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:714
__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:192
__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)