4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _RTE_MEMORY_H_
35 #define _RTE_MEMORY_H_
40 * Memory-related RTE API.
51 #include <rte_common.h>
52 #include <rte_config.h>
56 RTE_PGSIZE_4K = 1ULL << 12,
57 RTE_PGSIZE_64K = 1ULL << 16,
58 RTE_PGSIZE_256K = 1ULL << 18,
59 RTE_PGSIZE_2M = 1ULL << 21,
60 RTE_PGSIZE_16M = 1ULL << 24,
61 RTE_PGSIZE_256M = 1ULL << 28,
62 RTE_PGSIZE_512M = 1ULL << 29,
63 RTE_PGSIZE_1G = 1ULL << 30,
64 RTE_PGSIZE_4G = 1ULL << 32,
65 RTE_PGSIZE_16G = 1ULL << 34,
68 #define SOCKET_ID_ANY -1 /**< Any NUMA socket. */
69 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */
71 #define RTE_CACHE_LINE_ROUNDUP(size) \
72 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
73 /**< Return the first cache-aligned value greater or equal to size. */
75 /**< Cache line size in terms of log2 */
76 #if RTE_CACHE_LINE_SIZE == 64
77 #define RTE_CACHE_LINE_SIZE_LOG2 6
78 #elif RTE_CACHE_LINE_SIZE == 128
79 #define RTE_CACHE_LINE_SIZE_LOG2 7
81 #error "Unsupported cache line size"
84 #define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */
87 * Force alignment to cache line.
89 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
92 * Force minimum cache line alignment.
94 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
96 typedef uint64_t phys_addr_t; /**< Physical address. */
97 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
99 * IO virtual address type.
100 * When the physical addressing mode (IOVA as PA) is in use,
101 * the translation from an IO virtual address (IOVA) to a physical address
102 * is a direct mapping, i.e. the same value.
103 * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
105 typedef uint64_t rte_iova_t;
106 #define RTE_BAD_IOVA ((rte_iova_t)-1)
109 * Physical memory segment descriptor.
114 phys_addr_t phys_addr; /**< deprecated - Start physical address. */
115 rte_iova_t iova; /**< Start IO address. */
119 void *addr; /**< Start virtual address. */
120 uint64_t addr_64; /**< Makes sure addr is always 64 bits */
122 size_t len; /**< Length of the segment. */
123 uint64_t hugepage_sz; /**< The pagesize of underlying memory */
124 int32_t socket_id; /**< NUMA socket ID. */
125 uint32_t nchannel; /**< Number of channels. */
126 uint32_t nrank; /**< Number of ranks. */
130 * Lock page in physical memory and prevent from swapping.
133 * The virtual address.
135 * 0 on success, negative on error.
137 int rte_mem_lock_page(const void *virt);
140 * Get physical address of any mapped virtual address in the current process.
141 * It is found by browsing the /proc/self/pagemap special file.
142 * The page must be locked.
145 * The virtual address.
147 * The physical address or RTE_BAD_IOVA on error.
149 phys_addr_t rte_mem_virt2phy(const void *virt);
152 * Get IO virtual address of any mapped virtual address in the current process.
155 * The virtual address.
157 * The IO address or RTE_BAD_IOVA on error.
159 rte_iova_t rte_mem_virt2iova(const void *virt);
162 * Get the layout of the available physical memory.
164 * It can be useful for an application to have the full physical
165 * memory layout to decide the size of a memory zone to reserve. This
166 * table is stored in rte_config (see rte_eal_get_configuration()).
169 * - On success, return a pointer to a read-only table of struct
170 * rte_physmem_desc elements, containing the layout of all
171 * addressable physical memory. The last element of the table
172 * contains a NULL address.
173 * - On error, return NULL. This should not happen since it is a fatal
174 * error that will probably cause the entire system to panic.
176 const struct rte_memseg *rte_eal_get_physmem_layout(void);
179 * Dump the physical memory layout to a file.
182 * A pointer to a file for output
184 void rte_dump_physmem_layout(FILE *f);
187 * Get the total amount of available physical memory.
190 * The total amount of available physical memory in bytes.
192 uint64_t rte_eal_get_physmem_size(void);
195 * Get the number of memory channels.
198 * The number of memory channels on the system. The value is 0 if unknown
199 * or not the same on all devices.
201 unsigned rte_memory_get_nchannel(void);
204 * Get the number of memory ranks.
207 * The number of memory ranks on the system. The value is 0 if unknown or
208 * not the same on all devices.
210 unsigned rte_memory_get_nrank(void);
212 /* check memsegs iovas are within a range based on dma mask */
213 int rte_eal_check_dma_mask(uint8_t maskbits);
216 * Drivers based on uio will not load unless physical
217 * addresses are obtainable. It is only possible to get
218 * physical addresses when running as a privileged user.
221 * 1 if the system is able to obtain physical addresses.
222 * 0 if using DMA addresses through an IOMMU.
224 int rte_eal_using_phys_addrs(void);
230 #endif /* _RTE_MEMORY_H_ */