4 * Copyright(c) 2010-2013 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.
54 #include <rte_memory.h>
60 #define RTE_MEMZONE_2MB 0x00000001 /**< Use 2MB pages. */
61 #define RTE_MEMZONE_1GB 0x00000002 /**< Use 1GB pages. */
62 #define RTE_MEMZONE_SIZE_HINT_ONLY 0x00000004 /**< Use available page size */
65 * A structure describing a memzone, which is a contiguous portion of
66 * physical memory identified by a name.
70 #define RTE_MEMZONE_NAMESIZE 32 /**< Maximum length of memory zone name.*/
71 char name[RTE_MEMZONE_NAMESIZE]; /**< Name of the memory zone. */
73 phys_addr_t phys_addr; /**< Start physical address. */
75 void *addr; /**< Start virtual address. */
76 uint64_t addr_64; /**< Makes sure addr is always 64-bits */
78 size_t len; /**< Length of the memzone. */
80 size_t hugepage_sz; /**< The page size of underlying memory */
82 int32_t socket_id; /**< NUMA socket ID. */
84 uint32_t flags; /**< Characteristics of this memzone. */
85 } __attribute__((__packed__));
88 * Reserve a portion of physical memory.
90 * This function reserves some memory and returns a pointer to a
91 * correctly filled memzone descriptor. If the allocation cannot be
92 * done, return NULL. Note: A reserved zone cannot be freed.
95 * The name of the memzone. If it already exists, the function will
96 * fail and return NULL.
98 * The size of the memory to be reserved. If it
99 * is 0, the biggest contiguous zone will be reserved.
101 * The socket identifier in the case of
102 * NUMA. The value can be SOCKET_ID_ANY if there is no NUMA
103 * constraint for the reserved zone.
105 * The flags parameter is used to request memzones to be
106 * taken from 1GB or 2MB hugepages.
107 * - RTE_MEMZONE_2MB - Reserve from 2MB pages
108 * - RTE_MEMZONE_1GB - Reserve from 1GB pages
109 * - RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if
110 * the requested page size is unavailable.
111 * If this flag is not set, the function
112 * will return error on an unavailable size
115 * A pointer to a correctly-filled read-only memzone descriptor, or NULL
117 * On error case, rte_errno will be set appropriately:
118 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
119 * - E_RTE_SECONDARY - function was called from a secondary process instance
120 * - ENOSPC - the maximum number of memzones has already been allocated
121 * - EEXIST - a memzone with the same name already exists
122 * - ENOMEM - no appropriate memory area found in which to create memzone
123 * - EINVAL - invalid parameters
125 const struct rte_memzone *rte_memzone_reserve(const char *name,
126 size_t len, int socket_id,
130 * Reserve a portion of physical memory with alignment on a specified
133 * This function reserves some memory with alignment on a specified
134 * boundary, and returns a pointer to a correctly filled memzone
135 * descriptor. If the allocation cannot be done or if the alignment
136 * is not a power of 2, returns NULL.
137 * Note: A reserved zone cannot be freed.
140 * The name of the memzone. If it already exists, the function will
141 * fail and return NULL.
143 * The size of the memory to be reserved. If it
144 * is 0, the biggest contiguous zone will be reserved.
146 * Alignment for resulting memzone. Must be a power of 2.
148 * The socket identifier in the case of
149 * NUMA. The value can be SOCKET_ID_ANY if there is no NUMA
150 * constraint for the reserved zone.
152 * The flags parameter is used to request memzones to be
153 * taken from 1GB or 2MB hugepages.
154 * - RTE_MEMZONE_2MB - Reserve from 2MB pages
155 * - RTE_MEMZONE_1GB - Reserve from 1GB pages
156 * - RTE_MEMZONE_SIZE_HINT_ONLY - Allow alternative page size to be used if
157 * the requested page size is unavailable.
158 * If this flag is not set, the function
159 * will return error on an unavailable size
162 * A pointer to a correctly-filled read-only memzone descriptor, or NULL
164 * On error case, rte_errno will be set appropriately:
165 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
166 * - E_RTE_SECONDARY - function was called from a secondary process instance
167 * - ENOSPC - the maximum number of memzones has already been allocated
168 * - EEXIST - a memzone with the same name already exists
169 * - ENOMEM - no appropriate memory area found in which to create memzone
170 * - EINVAL - invalid parameters
172 const struct rte_memzone *rte_memzone_reserve_aligned(const char *name,
173 size_t len, int socket_id, unsigned flags,
177 * Lookup for a memzone.
179 * Get a pointer to a descriptor of an already reserved memory
180 * zone identified by the name given as an argument.
183 * The name of the memzone.
185 * A pointer to a read-only memzone descriptor.
187 const struct rte_memzone *rte_memzone_lookup(const char *name);
190 * Dump all reserved memzones to the console.
192 void rte_memzone_dump(void);
198 #endif /* _RTE_MEMZONE_H_ */