DPDK  19.05.0
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_256M = 1ULL << 28,
37  RTE_PGSIZE_512M = 1ULL << 29,
38  RTE_PGSIZE_1G = 1ULL << 30,
39  RTE_PGSIZE_4G = 1ULL << 32,
40  RTE_PGSIZE_16G = 1ULL << 34,
41 };
42 
43 #define SOCKET_ID_ANY -1
44 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
46 #define RTE_CACHE_LINE_ROUNDUP(size) \
47  (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
48 
51 #if RTE_CACHE_LINE_SIZE == 64
52 #define RTE_CACHE_LINE_SIZE_LOG2 6
53 #elif RTE_CACHE_LINE_SIZE == 128
54 #define RTE_CACHE_LINE_SIZE_LOG2 7
55 #else
56 #error "Unsupported cache line size"
57 #endif
58 
59 #define RTE_CACHE_LINE_MIN_SIZE 64
64 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
65 
69 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
70 
71 typedef uint64_t phys_addr_t;
72 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
73 
80 typedef uint64_t rte_iova_t;
81 #define RTE_BAD_IOVA ((rte_iova_t)-1)
82 
86 #define RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0)
87 
88 struct rte_memseg {
90  union {
91  phys_addr_t phys_addr;
92  rte_iova_t iova;
93  };
95  union {
96  void *addr;
97  uint64_t addr_64;
98  };
99  size_t len;
100  uint64_t hugepage_sz;
101  int32_t socket_id;
102  uint32_t nchannel;
103  uint32_t nrank;
104  uint32_t flags;
105 } __rte_packed;
106 
115 int rte_mem_lock_page(const void *virt);
116 
127 phys_addr_t rte_mem_virt2phy(const void *virt);
128 
137 rte_iova_t rte_mem_virt2iova(const void *virt);
138 
151 __rte_experimental void *
152 rte_mem_iova2virt(rte_iova_t iova);
153 
165 __rte_experimental struct rte_memseg *
166 rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
167 
176 __rte_experimental struct rte_memseg_list *
177 rte_mem_virt2memseg_list(const void *virt);
178 
186 typedef int (*rte_memseg_walk_t)(const struct rte_memseg_list *msl,
187  const struct rte_memseg *ms, void *arg);
198 typedef int (*rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl,
199  const struct rte_memseg *ms, size_t len, void *arg);
209 typedef int (*rte_memseg_list_walk_t)(const struct rte_memseg_list *msl,
210  void *arg);
230 int __rte_experimental
231 rte_memseg_walk(rte_memseg_walk_t func, void *arg);
232 
251 int __rte_experimental
253 
272 int __rte_experimental
274 
290 int __rte_experimental
292 
308 int __rte_experimental
310 
326 int __rte_experimental
328 
350 int __rte_experimental
351 rte_memseg_get_fd(const struct rte_memseg *ms);
352 
374 int __rte_experimental
375 rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms);
376 
398 int __rte_experimental
399 rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
400 
422 int __rte_experimental
423 rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms,
424  size_t *offset);
425 
463 int __rte_experimental
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 int __rte_experimental
494 rte_extmem_unregister(void *va_addr, size_t len);
495 
519 int __rte_experimental
520 rte_extmem_attach(void *va_addr, size_t len);
521 
545 int __rte_experimental
546 rte_extmem_detach(void *va_addr, size_t len);
547 
557 void rte_dump_physmem_layout(FILE *f);
558 
568 uint64_t rte_eal_get_physmem_size(void);
569 
577 unsigned rte_memory_get_nchannel(void);
578 
586 unsigned rte_memory_get_nrank(void);
587 
598 int __rte_experimental rte_mem_check_dma_mask(uint8_t maskbits);
599 
616 int __rte_experimental rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits);
617 
626 void __rte_experimental rte_mem_set_dma_mask(uint8_t maskbits);
627 
637 int rte_eal_using_phys_addrs(void);
638 
639 
644 enum rte_mem_event {
645  RTE_MEM_EVENT_ALLOC = 0,
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);
682 int __rte_experimental
684  void *arg);
685 
700 int __rte_experimental
701 rte_mem_event_callback_unregister(const char *name, void *arg);
702 
703 
704 #define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
705 
712 typedef int (*rte_mem_alloc_validator_t)(int socket_id,
713  size_t cur_limit, size_t new_len);
749 int __rte_experimental
750 rte_mem_alloc_validator_register(const char *name,
751  rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
752 
767 int __rte_experimental
768 rte_mem_alloc_validator_unregister(const char *name, int socket_id);
769 
770 #ifdef __cplusplus
771 }
772 #endif
773 
774 #endif /* _RTE_MEMORY_H_ */