DPDK  18.11.10
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 
26 /* forward declaration for pointers */
27 struct rte_memseg_list;
28 
29 __extension__
30 enum rte_page_sizes {
31  RTE_PGSIZE_4K = 1ULL << 12,
32  RTE_PGSIZE_64K = 1ULL << 16,
33  RTE_PGSIZE_256K = 1ULL << 18,
34  RTE_PGSIZE_2M = 1ULL << 21,
35  RTE_PGSIZE_16M = 1ULL << 24,
36  RTE_PGSIZE_32M = 1ULL << 25,
37  RTE_PGSIZE_256M = 1ULL << 28,
38  RTE_PGSIZE_512M = 1ULL << 29,
39  RTE_PGSIZE_1G = 1ULL << 30,
40  RTE_PGSIZE_4G = 1ULL << 32,
41  RTE_PGSIZE_16G = 1ULL << 34,
42 };
43 
44 #define SOCKET_ID_ANY -1
45 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
47 #define RTE_CACHE_LINE_ROUNDUP(size) \
48  (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
49 
52 #if RTE_CACHE_LINE_SIZE == 64
53 #define RTE_CACHE_LINE_SIZE_LOG2 6
54 #elif RTE_CACHE_LINE_SIZE == 128
55 #define RTE_CACHE_LINE_SIZE_LOG2 7
56 #else
57 #error "Unsupported cache line size"
58 #endif
59 
60 #define RTE_CACHE_LINE_MIN_SIZE 64
65 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
66 
70 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
71 
72 typedef uint64_t phys_addr_t;
73 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
74 
81 typedef uint64_t rte_iova_t;
82 #define RTE_BAD_IOVA ((rte_iova_t)-1)
83 
87 #define RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0)
88 
89 struct rte_memseg {
91  union {
92  phys_addr_t phys_addr;
93  rte_iova_t iova;
94  };
96  union {
97  void *addr;
98  uint64_t addr_64;
99  };
100  size_t len;
101  uint64_t hugepage_sz;
102  int32_t socket_id;
103  uint32_t nchannel;
104  uint32_t nrank;
105  uint32_t flags;
106 } __rte_packed;
107 
116 int rte_mem_lock_page(const void *virt);
117 
128 phys_addr_t rte_mem_virt2phy(const void *virt);
129 
138 rte_iova_t rte_mem_virt2iova(const void *virt);
139 
152 __rte_experimental void *
154 
166 __rte_experimental struct rte_memseg *
167 rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
168 
177 __rte_experimental struct rte_memseg_list *
178 rte_mem_virt2memseg_list(const void *virt);
179 
187 typedef int (*rte_memseg_walk_t)(const struct rte_memseg_list *msl,
188  const struct rte_memseg *ms, void *arg);
199 typedef int (*rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl,
200  const struct rte_memseg *ms, size_t len, void *arg);
210 typedef int (*rte_memseg_list_walk_t)(const struct rte_memseg_list *msl,
211  void *arg);
231 int __rte_experimental
232 rte_memseg_walk(rte_memseg_walk_t func, void *arg);
233 
252 int __rte_experimental
254 
273 int __rte_experimental
275 
291 int __rte_experimental
293 
309 int __rte_experimental
311 
327 int __rte_experimental
329 
351 int __rte_experimental
352 rte_memseg_get_fd(const struct rte_memseg *ms);
353 
375 int __rte_experimental
376 rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms);
377 
399 int __rte_experimental
400 rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
401 
423 int __rte_experimental
424 rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms,
425  size_t *offset);
426 
436 void rte_dump_physmem_layout(FILE *f);
437 
447 uint64_t rte_eal_get_physmem_size(void);
448 
456 unsigned rte_memory_get_nchannel(void);
457 
465 unsigned rte_memory_get_nrank(void);
466 
477 int __rte_experimental rte_mem_check_dma_mask(uint8_t maskbits);
478 
495 int __rte_experimental rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits);
496 
505 void __rte_experimental rte_mem_set_dma_mask(uint8_t maskbits);
506 
516 int rte_eal_using_phys_addrs(void);
517 
518 
523 enum rte_mem_event {
524  RTE_MEM_EVENT_ALLOC = 0,
526 };
527 #define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64
528 
533 typedef void (*rte_mem_event_callback_t)(enum rte_mem_event event_type,
534  const void *addr, size_t len, void *arg);
561 int __rte_experimental
563  void *arg);
564 
579 int __rte_experimental
580 rte_mem_event_callback_unregister(const char *name, void *arg);
581 
582 
583 #define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
584 
591 typedef int (*rte_mem_alloc_validator_t)(int socket_id,
592  size_t cur_limit, size_t new_len);
628 int __rte_experimental
629 rte_mem_alloc_validator_register(const char *name,
630  rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
631 
646 int __rte_experimental
647 rte_mem_alloc_validator_unregister(const char *name, int socket_id);
648 
649 #ifdef __cplusplus
650 }
651 #endif
652 
653 #endif /* _RTE_MEMORY_H_ */
unsigned rte_memory_get_nchannel(void)
__rte_experimental struct rte_memseg * rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl)
int rte_eal_using_phys_addrs(void)
int rte_mem_lock_page(const void *virt)
int __rte_experimental 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.
unsigned rte_memory_get_nrank(void)
int(* rte_memseg_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, void *arg)
Definition: rte_memory.h:189
rte_mem_event
Definition: rte_memory.h:525
phys_addr_t rte_mem_virt2phy(const void *virt)
#define __rte_packed
Definition: rte_common.h:66
int __rte_experimental rte_memseg_get_fd(const struct rte_memseg *ms)
uint64_t rte_eal_get_physmem_size(void)
int __rte_experimental rte_mem_check_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:535
int __rte_experimental rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits)
int __rte_experimental rte_mem_alloc_validator_unregister(const char *name, int socket_id)
Unregister validator callback for memory allocations.
int __rte_experimental rte_memseg_walk(rte_memseg_walk_t func, void *arg)
__rte_experimental void * rte_mem_iova2virt(rte_iova_t iova)
void rte_dump_physmem_layout(FILE *f)
void __rte_experimental rte_mem_set_dma_mask(uint8_t maskbits)
int __rte_experimental rte_memseg_contig_walk_thread_unsafe(rte_memseg_contig_walk_t func, void *arg)
int __rte_experimental rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset)
#define RTE_STD_C11
Definition: rte_common.h:37
uint64_t rte_iova_t
Definition: rte_memory.h:83
uint64_t phys_addr_t
Definition: rte_memory.h:74
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:201
int __rte_experimental rte_memseg_walk_thread_unsafe(rte_memseg_walk_t func, void *arg)
__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:593
int __rte_experimental rte_memseg_list_walk(rte_memseg_list_walk_t func, void *arg)
int __rte_experimental rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms, size_t *offset)
int __rte_experimental rte_memseg_contig_walk(rte_memseg_contig_walk_t func, void *arg)
int __rte_experimental rte_mem_event_callback_unregister(const char *name, void *arg)
int(* rte_memseg_list_walk_t)(const struct rte_memseg_list *msl, void *arg)
Definition: rte_memory.h:212
int __rte_experimental rte_mem_event_callback_register(const char *name, rte_mem_event_callback_t clb, void *arg)
int __rte_experimental rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms)
int __rte_experimental rte_memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg)
rte_iova_t rte_mem_virt2iova(const void *virt)