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_MEMZONE_H_
35 #define _RTE_MEMZONE_H_
41 * The goal of the memzone allocator is to reserve contiguous
42 * portions of physical memory. These zones are identified by a name.
44 * The memzone descriptors are shared by all partitions and are
45 * located in a known place of physical memory. This zone is accessed
46 * using rte_eal_get_configuration(). The lookup (by name) of a
47 * memory zone can be done in any partition and returns the same
50 * A reserved memory zone cannot be unreserved. The reservation shall
51 * be done at initialization time only.
55 #include <rte_memory.h>
61 #define RTE_MEMZONE_2MB 0x00000001 /**< Use 2MB pages. */
62 #define RTE_MEMZONE_1GB 0x00000002 /**< Use 1GB pages. */
63 #define RTE_MEMZONE_16MB 0x00000100 /**< Use 16MB pages. */
64 #define RTE_MEMZONE_16GB 0x00000200 /**< Use 16GB pages. */
65 #define RTE_MEMZONE_256KB 0x00010000 /**< Use 256KB pages. */
66 #define RTE_MEMZONE_256MB 0x00020000 /**< Use 256MB pages. */
67 #define RTE_MEMZONE_512MB 0x00040000 /**< Use 512MB pages. */
68 #define RTE_MEMZONE_4GB 0x00080000 /**< Use 4GB pages. */
69 #define RTE_MEMZONE_SIZE_HINT_ONLY 0x00000004 /**< Use available page size */
72 * A structure describing a memzone, which is a contiguous portion of
73 * physical memory identified by a name.
77 #define RTE_MEMZONE_NAMESIZE 32 /**< Maximum length of memory zone name.*/
78 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of the memory zone. */
80 phys_addr_t phys_addr; /**< Start physical address. */
82 void *addr; /**< Start virtual address. */
83 uint64_t addr_64; /**< Makes sure addr is always 64-bits */
85 #ifdef RTE_LIBRTE_IVSHMEM
86 phys_addr_t ioremap_addr; /**< Real physical address inside the VM */
88 size_t len; /**< Length of the memzone. */
90 uint64_t hugepage_sz; /**< The page size of underlying memory */
92 int32_t socket_id; /**< NUMA socket ID. */
94 uint32_t flags; /**< Characteristics of this memzone. */
95 uint32_t memseg_id; /**< Memseg it belongs. */
96 } __attribute__((__packed__));
99 * Reserve a portion of physical memory.
101 * This function reserves some memory and returns a pointer to a
102 * correctly filled memzone descriptor. If the allocation cannot be
103 * done, return NULL. Note: A reserved zone cannot be freed.
106 * The name of the memzone. If it already exists, the function will
107 * fail and return NULL.
109 * The size of the memory to be reserved. If it
110 * is 0, the biggest contiguous zone will be reserved.
112 * The socket identifier in the case of
113 * NUMA. The value can be SOCKET_ID_ANY if there is no NUMA
114 * constraint for the reserved zone.
116 * The flags parameter is used to request memzones to be
117 * taken from specifically sized hugepages.
118 * - RTE_MEMZONE_2MB - Reserved from 2MB pages
119 * - RTE_MEMZONE_1GB - Reserved from 1GB pages
120 * - RTE_MEMZONE_16MB - Reserved from 16MB pages
121 * - RTE_MEMZONE_16GB - Reserved from 16GB pages
122 * - RTE_MEMZONE_256KB - Reserved from 256KB pages
123 * - RTE_MEMZONE_256MB - Reserved from 256MB pages
124 * - RTE_MEMZONE_512MB - Reserved from 512MB pages
125 * - RTE_MEMZONE_4GB - Reserved from 4GB pages
126 * - RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if
127 * the requested page size is unavailable.
128 * If this flag is not set, the function
129 * will return error on an unavailable size
132 * A pointer to a correctly-filled read-only memzone descriptor, or NULL
134 * On error case, rte_errno will be set appropriately:
135 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
136 * - E_RTE_SECONDARY - function was called from a secondary process instance
137 * - ENOSPC - the maximum number of memzones has already been allocated
138 * - EEXIST - a memzone with the same name already exists
139 * - ENOMEM - no appropriate memory area found in which to create memzone
140 * - EINVAL - invalid parameters
142 const struct rte_memzone *rte_memzone_reserve(const char *name,
143 size_t len, int socket_id,
147 * Reserve a portion of physical memory with alignment on a specified
150 * This function reserves some memory with alignment on a specified
151 * boundary, and returns a pointer to a correctly filled memzone
152 * descriptor. If the allocation cannot be done or if the alignment
153 * is not a power of 2, returns NULL.
154 * Note: A reserved zone cannot be freed.
157 * The name of the memzone. If it already exists, the function will
158 * fail and return NULL.
160 * The size of the memory to be reserved. If it
161 * is 0, the biggest contiguous zone will be reserved.
163 * The socket identifier in the case of
164 * NUMA. The value can be SOCKET_ID_ANY if there is no NUMA
165 * constraint for the reserved zone.
167 * The flags parameter is used to request memzones to be
168 * taken from specifically sized hugepages.
169 * - RTE_MEMZONE_2MB - Reserved from 2MB pages
170 * - RTE_MEMZONE_1GB - Reserved from 1GB pages
171 * - RTE_MEMZONE_16MB - Reserved from 16MB pages
172 * - RTE_MEMZONE_16GB - Reserved from 16GB pages
173 * - RTE_MEMZONE_256KB - Reserved from 256KB pages
174 * - RTE_MEMZONE_256MB - Reserved from 256MB pages
175 * - RTE_MEMZONE_512MB - Reserved from 512MB pages
176 * - RTE_MEMZONE_4GB - Reserved from 4GB pages
177 * - RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if
178 * the requested page size is unavailable.
179 * If this flag is not set, the function
180 * will return error on an unavailable size
183 * Alignment for resulting memzone. Must be a power of 2.
185 * A pointer to a correctly-filled read-only memzone descriptor, or NULL
187 * On error case, rte_errno will be set appropriately:
188 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
189 * - E_RTE_SECONDARY - function was called from a secondary process instance
190 * - ENOSPC - the maximum number of memzones has already been allocated
191 * - EEXIST - a memzone with the same name already exists
192 * - ENOMEM - no appropriate memory area found in which to create memzone
193 * - EINVAL - invalid parameters
195 const struct rte_memzone *rte_memzone_reserve_aligned(const char *name,
196 size_t len, int socket_id,
197 unsigned flags, unsigned align);
200 * Reserve a portion of physical memory with specified alignment and
203 * This function reserves some memory with specified alignment and
204 * boundary, and returns a pointer to a correctly filled memzone
205 * descriptor. If the allocation cannot be done or if the alignment
206 * or boundary are not a power of 2, returns NULL.
207 * Memory buffer is reserved in a way, that it wouldn't cross specified
208 * boundary. That implies that requested length should be less or equal
210 * Note: A reserved zone cannot be freed.
213 * The name of the memzone. If it already exists, the function will
214 * fail and return NULL.
216 * The size of the memory to be reserved. If it
217 * is 0, the biggest contiguous zone will be reserved.
219 * The socket identifier in the case of
220 * NUMA. The value can be SOCKET_ID_ANY if there is no NUMA
221 * constraint for the reserved zone.
223 * The flags parameter is used to request memzones to be
224 * taken from specifically sized hugepages.
225 * - RTE_MEMZONE_2MB - Reserved from 2MB pages
226 * - RTE_MEMZONE_1GB - Reserved from 1GB pages
227 * - RTE_MEMZONE_16MB - Reserved from 16MB pages
228 * - RTE_MEMZONE_16GB - Reserved from 16GB pages
229 * - RTE_MEMZONE_256KB - Reserved from 256KB pages
230 * - RTE_MEMZONE_256MB - Reserved from 256MB pages
231 * - RTE_MEMZONE_512MB - Reserved from 512MB pages
232 * - RTE_MEMZONE_4GB - Reserved from 4GB pages
233 * - RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if
234 * the requested page size is unavailable.
235 * If this flag is not set, the function
236 * will return error on an unavailable size
239 * Alignment for resulting memzone. Must be a power of 2.
241 * Boundary for resulting memzone. Must be a power of 2 or zero.
242 * Zero value implies no boundary condition.
244 * A pointer to a correctly-filled read-only memzone descriptor, or NULL
246 * On error case, rte_errno will be set appropriately:
247 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
248 * - E_RTE_SECONDARY - function was called from a secondary process instance
249 * - ENOSPC - the maximum number of memzones has already been allocated
250 * - EEXIST - a memzone with the same name already exists
251 * - ENOMEM - no appropriate memory area found in which to create memzone
252 * - EINVAL - invalid parameters
254 const struct rte_memzone *rte_memzone_reserve_bounded(const char *name,
255 size_t len, int socket_id,
256 unsigned flags, unsigned align, unsigned bound);
261 * Note: an IVSHMEM zone cannot be freed.
264 * A pointer to the memzone
266 * -EINVAL - invalid parameter, IVSHMEM memzone.
269 int rte_memzone_free(const struct rte_memzone *mz);
272 * Lookup for a memzone.
274 * Get a pointer to a descriptor of an already reserved memory
275 * zone identified by the name given as an argument.
278 * The name of the memzone.
280 * A pointer to a read-only memzone descriptor.
282 const struct rte_memzone *rte_memzone_lookup(const char *name);
285 * Dump all reserved memzones to the console.
288 * A pointer to a file for output
290 void rte_memzone_dump(FILE *f);
293 * Walk list of all memzones
298 * Argument passed to iterator
300 void rte_memzone_walk(void (*func)(const struct rte_memzone *, void *arg),
307 #endif /* _RTE_MEMZONE_H_ */