DPDK  16.11.9
rte_memory.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of Intel Corporation nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _RTE_MEMORY_H_
35 #define _RTE_MEMORY_H_
36 
43 #include <stdint.h>
44 #include <stddef.h>
45 #include <stdio.h>
46 
47 #include <rte_config.h>
48 
49 #ifdef RTE_EXEC_ENV_LINUXAPP
50 #include <exec-env/rte_dom0_common.h>
51 #endif
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
57 #include <rte_common.h>
58 
59 __extension__
60 enum rte_page_sizes {
61  RTE_PGSIZE_4K = 1ULL << 12,
62  RTE_PGSIZE_64K = 1ULL << 16,
63  RTE_PGSIZE_256K = 1ULL << 18,
64  RTE_PGSIZE_2M = 1ULL << 21,
65  RTE_PGSIZE_16M = 1ULL << 24,
66  RTE_PGSIZE_256M = 1ULL << 28,
67  RTE_PGSIZE_512M = 1ULL << 29,
68  RTE_PGSIZE_1G = 1ULL << 30,
69  RTE_PGSIZE_4G = 1ULL << 32,
70  RTE_PGSIZE_16G = 1ULL << 34,
71 };
72 
73 #define SOCKET_ID_ANY -1
74 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
76 #define RTE_CACHE_LINE_ROUNDUP(size) \
77  (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
78 
81 #if RTE_CACHE_LINE_SIZE == 64
82 #define RTE_CACHE_LINE_SIZE_LOG2 6
83 #elif RTE_CACHE_LINE_SIZE == 128
84 #define RTE_CACHE_LINE_SIZE_LOG2 7
85 #else
86 #error "Unsupported cache line size"
87 #endif
88 
89 #define RTE_CACHE_LINE_MIN_SIZE 64
94 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
95 
99 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
100 
101 typedef uint64_t phys_addr_t;
102 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
107 struct rte_memseg {
108  phys_addr_t phys_addr;
110  union {
111  void *addr;
112  uint64_t addr_64;
113  };
114  size_t len;
115  uint64_t hugepage_sz;
116  int32_t socket_id;
117  uint32_t nchannel;
118  uint32_t nrank;
119 #ifdef RTE_LIBRTE_XEN_DOM0
121  uint64_t mfn[DOM0_NUM_MEMBLOCK];
122 #endif
123 } __rte_packed;
124 
133 int rte_mem_lock_page(const void *virt);
134 
145 phys_addr_t rte_mem_virt2phy(const void *virt);
146 
162 const struct rte_memseg *rte_eal_get_physmem_layout(void);
163 
170 void rte_dump_physmem_layout(FILE *f);
171 
178 uint64_t rte_eal_get_physmem_size(void);
179 
187 unsigned rte_memory_get_nchannel(void);
188 
196 unsigned rte_memory_get_nrank(void);
197 
198 #ifdef RTE_LIBRTE_XEN_DOM0
199 
201 int rte_xen_dom0_supported(void);
202 
204 phys_addr_t rte_xen_mem_phy2mch(int32_t, const phys_addr_t);
205 
218 static inline phys_addr_t
219 rte_mem_phy2mch(int32_t memseg_id, const phys_addr_t phy_addr)
220 {
221  if (rte_xen_dom0_supported())
222  return rte_xen_mem_phy2mch(memseg_id, phy_addr);
223  else
224  return phy_addr;
225 }
226 
236 int rte_xen_dom0_memory_init(void);
237 
247 int rte_xen_dom0_memory_attach(void);
248 #else
249 static inline int rte_xen_dom0_supported(void)
250 {
251  return 0;
252 }
253 
254 static inline phys_addr_t
255 rte_mem_phy2mch(int32_t memseg_id __rte_unused, const phys_addr_t phy_addr)
256 {
257  return phy_addr;
258 }
259 #endif
260 
261 #ifdef __cplusplus
262 }
263 #endif
264 
265 #endif /* _RTE_MEMORY_H_ */