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.
41 #include <sys/queue.h>
44 #include <rte_memory.h>
45 #include <rte_memzone.h>
47 #include <rte_eal_memconfig.h>
48 #include <rte_per_lcore.h>
49 #include <rte_errno.h>
50 #include <rte_string_fns.h>
51 #include <rte_common.h>
53 #include "malloc_heap.h"
54 #include "malloc_elem.h"
55 #include "eal_private.h"
57 static inline const struct rte_memzone *
58 memzone_lookup_thread_unsafe(const char *name)
60 const struct rte_mem_config *mcfg;
61 const struct rte_memzone *mz;
64 /* get pointer to global configuration */
65 mcfg = rte_eal_get_configuration()->mem_config;
68 * the algorithm is not optimal (linear), but there are few
69 * zones and this function should be called at init only
71 for (i = 0; i < RTE_MAX_MEMZONE; i++) {
72 mz = &mcfg->memzone[i];
73 if (mz->addr != NULL && !strncmp(name, mz->name, RTE_MEMZONE_NAMESIZE))
74 return &mcfg->memzone[i];
80 static inline struct rte_memzone *
81 get_next_free_memzone(void)
83 struct rte_mem_config *mcfg;
86 /* get pointer to global configuration */
87 mcfg = rte_eal_get_configuration()->mem_config;
89 for (i = 0; i < RTE_MAX_MEMZONE; i++) {
90 if (mcfg->memzone[i].addr == NULL)
91 return &mcfg->memzone[i];
97 /* This function will return the greatest free block if a heap has been
98 * specified. If no heap has been specified, it will return the heap and
99 * length of the greatest free block available in all heaps */
101 find_heap_max_free_elem(int *s, unsigned align)
103 struct rte_mem_config *mcfg;
104 struct rte_malloc_socket_stats stats;
108 /* get pointer to global configuration */
109 mcfg = rte_eal_get_configuration()->mem_config;
111 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
112 if ((socket != SOCKET_ID_ANY) && (socket != i))
115 malloc_heap_get_stats(&mcfg->malloc_heaps[i], &stats);
116 if (stats.greatest_free_size > len) {
117 len = stats.greatest_free_size;
122 return len - MALLOC_ELEM_OVERHEAD - align;
125 static const struct rte_memzone *
126 memzone_reserve_aligned_thread_unsafe(const char *name, size_t len,
127 int socket_id, unsigned flags, unsigned align, unsigned bound)
129 struct rte_mem_config *mcfg;
130 size_t requested_len;
133 /* get pointer to global configuration */
134 mcfg = rte_eal_get_configuration()->mem_config;
136 /* no more room in config */
137 if (mcfg->memzone_cnt >= RTE_MAX_MEMZONE) {
138 RTE_LOG(ERR, EAL, "%s(): No more room in config\n", __func__);
143 /* zone already exist */
144 if ((memzone_lookup_thread_unsafe(name)) != NULL) {
145 RTE_LOG(DEBUG, EAL, "%s(): memzone <%s> already exists\n",
151 /* if alignment is not a power of two */
152 if (align && !rte_is_power_of_2(align)) {
153 RTE_LOG(ERR, EAL, "%s(): Invalid alignment: %u\n", __func__,
159 /* alignment less than cache size is not allowed */
160 if (align < RTE_CACHE_LINE_SIZE)
161 align = RTE_CACHE_LINE_SIZE;
163 /* align length on cache boundary. Check for overflow before doing so */
164 if (len > SIZE_MAX - RTE_CACHE_LINE_MASK) {
165 rte_errno = EINVAL; /* requested size too big */
169 len += RTE_CACHE_LINE_MASK;
170 len &= ~((size_t) RTE_CACHE_LINE_MASK);
172 /* save minimal requested length */
173 requested_len = RTE_MAX((size_t)RTE_CACHE_LINE_SIZE, len);
175 /* check that boundary condition is valid */
176 if (bound != 0 && (requested_len > bound || !rte_is_power_of_2(bound))) {
181 if ((socket_id != SOCKET_ID_ANY) && (socket_id >= RTE_MAX_NUMA_NODES)) {
186 if (!rte_eal_has_hugepages())
187 socket_id = SOCKET_ID_ANY;
191 requested_len = bound;
193 requested_len = find_heap_max_free_elem(&socket_id, align);
196 if (socket_id == SOCKET_ID_ANY)
197 socket = malloc_get_numa_socket();
201 /* allocate memory on heap */
202 void *mz_addr = malloc_heap_alloc(&mcfg->malloc_heaps[socket], NULL,
203 requested_len, flags, align, bound);
205 if ((mz_addr == NULL) && (socket_id == SOCKET_ID_ANY)) {
206 /* try other heaps */
207 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
211 mz_addr = malloc_heap_alloc(&mcfg->malloc_heaps[i],
212 NULL, requested_len, flags, align, bound);
218 if (mz_addr == NULL) {
223 const struct malloc_elem *elem = malloc_elem_from_data(mz_addr);
225 /* fill the zone in config */
226 struct rte_memzone *mz = get_next_free_memzone();
229 RTE_LOG(ERR, EAL, "%s(): Cannot find free memzone but there is room "
230 "in config!\n", __func__);
236 snprintf(mz->name, sizeof(mz->name), "%s", name);
237 mz->phys_addr = rte_malloc_virt2phy(mz_addr);
239 mz->len = (requested_len == 0 ? elem->size : requested_len);
240 mz->hugepage_sz = elem->ms->hugepage_sz;
241 mz->socket_id = elem->ms->socket_id;
243 mz->memseg_id = elem->ms - rte_eal_get_configuration()->mem_config->memseg;
248 static const struct rte_memzone *
249 rte_memzone_reserve_thread_safe(const char *name, size_t len,
250 int socket_id, unsigned flags, unsigned align,
253 struct rte_mem_config *mcfg;
254 const struct rte_memzone *mz = NULL;
256 /* get pointer to global configuration */
257 mcfg = rte_eal_get_configuration()->mem_config;
259 rte_rwlock_write_lock(&mcfg->mlock);
261 mz = memzone_reserve_aligned_thread_unsafe(
262 name, len, socket_id, flags, align, bound);
264 rte_rwlock_write_unlock(&mcfg->mlock);
270 * Return a pointer to a correctly filled memzone descriptor (with a
271 * specified alignment and boundary). If the allocation cannot be done,
274 const struct rte_memzone *
275 rte_memzone_reserve_bounded(const char *name, size_t len, int socket_id,
276 unsigned flags, unsigned align, unsigned bound)
278 return rte_memzone_reserve_thread_safe(name, len, socket_id, flags,
283 * Return a pointer to a correctly filled memzone descriptor (with a
284 * specified alignment). If the allocation cannot be done, return NULL.
286 const struct rte_memzone *
287 rte_memzone_reserve_aligned(const char *name, size_t len, int socket_id,
288 unsigned flags, unsigned align)
290 return rte_memzone_reserve_thread_safe(name, len, socket_id, flags,
295 * Return a pointer to a correctly filled memzone descriptor. If the
296 * allocation cannot be done, return NULL.
298 const struct rte_memzone *
299 rte_memzone_reserve(const char *name, size_t len, int socket_id,
302 return rte_memzone_reserve_thread_safe(name, len, socket_id,
303 flags, RTE_CACHE_LINE_SIZE, 0);
307 rte_memzone_free(const struct rte_memzone *mz)
309 struct rte_mem_config *mcfg;
317 mcfg = rte_eal_get_configuration()->mem_config;
319 rte_rwlock_write_lock(&mcfg->mlock);
321 idx = ((uintptr_t)mz - (uintptr_t)mcfg->memzone);
322 idx = idx / sizeof(struct rte_memzone);
324 #ifdef RTE_LIBRTE_IVSHMEM
326 * If ioremap_addr is set, it's an IVSHMEM memzone and we cannot
329 if (mcfg->memzone[idx].ioremap_addr != 0) {
330 rte_rwlock_write_unlock(&mcfg->mlock);
335 addr = mcfg->memzone[idx].addr;
339 else if (mcfg->memzone_cnt == 0) {
340 rte_panic("%s(): memzone address not NULL but memzone_cnt is 0!\n",
343 memset(&mcfg->memzone[idx], 0, sizeof(mcfg->memzone[idx]));
347 rte_rwlock_write_unlock(&mcfg->mlock);
355 * Lookup for the memzone identified by the given name
357 const struct rte_memzone *
358 rte_memzone_lookup(const char *name)
360 struct rte_mem_config *mcfg;
361 const struct rte_memzone *memzone = NULL;
363 mcfg = rte_eal_get_configuration()->mem_config;
365 rte_rwlock_read_lock(&mcfg->mlock);
367 memzone = memzone_lookup_thread_unsafe(name);
369 rte_rwlock_read_unlock(&mcfg->mlock);
374 /* Dump all reserved memory zones on console */
376 rte_memzone_dump(FILE *f)
378 struct rte_mem_config *mcfg;
381 /* get pointer to global configuration */
382 mcfg = rte_eal_get_configuration()->mem_config;
384 rte_rwlock_read_lock(&mcfg->mlock);
386 for (i=0; i<RTE_MAX_MEMZONE; i++) {
387 if (mcfg->memzone[i].addr == NULL)
389 fprintf(f, "Zone %u: name:<%s>, phys:0x%"PRIx64", len:0x%zx"
390 ", virt:%p, socket_id:%"PRId32", flags:%"PRIx32"\n", i,
391 mcfg->memzone[i].name,
392 mcfg->memzone[i].phys_addr,
393 mcfg->memzone[i].len,
394 mcfg->memzone[i].addr,
395 mcfg->memzone[i].socket_id,
396 mcfg->memzone[i].flags);
398 rte_rwlock_read_unlock(&mcfg->mlock);
402 * Init the memzone subsystem
405 rte_eal_memzone_init(void)
407 struct rte_mem_config *mcfg;
408 const struct rte_memseg *memseg;
410 /* get pointer to global configuration */
411 mcfg = rte_eal_get_configuration()->mem_config;
413 /* secondary processes don't need to initialise anything */
414 if (rte_eal_process_type() == RTE_PROC_SECONDARY)
417 memseg = rte_eal_get_physmem_layout();
418 if (memseg == NULL) {
419 RTE_LOG(ERR, EAL, "%s(): Cannot get physical layout\n", __func__);
423 rte_rwlock_write_lock(&mcfg->mlock);
425 /* delete all zones */
426 mcfg->memzone_cnt = 0;
427 memset(mcfg->memzone, 0, sizeof(mcfg->memzone));
429 rte_rwlock_write_unlock(&mcfg->mlock);
431 return rte_eal_malloc_heap_init();
434 /* Walk all reserved memory zones */
435 void rte_memzone_walk(void (*func)(const struct rte_memzone *, void *),
438 struct rte_mem_config *mcfg;
441 mcfg = rte_eal_get_configuration()->mem_config;
443 rte_rwlock_read_lock(&mcfg->mlock);
444 for (i=0; i<RTE_MAX_MEMZONE; i++) {
445 if (mcfg->memzone[i].addr != NULL)
446 (*func)(&mcfg->memzone[i], arg);
448 rte_rwlock_read_unlock(&mcfg->mlock);