1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
12 #include <sys/queue.h>
15 #include <rte_memory.h>
16 #include <rte_memzone.h>
18 #include <rte_eal_memconfig.h>
19 #include <rte_per_lcore.h>
20 #include <rte_errno.h>
21 #include <rte_string_fns.h>
22 #include <rte_common.h>
24 #include "malloc_heap.h"
25 #include "malloc_elem.h"
26 #include "eal_private.h"
28 static inline const struct rte_memzone *
29 memzone_lookup_thread_unsafe(const char *name)
31 const struct rte_mem_config *mcfg;
32 const struct rte_memzone *mz;
35 /* get pointer to global configuration */
36 mcfg = rte_eal_get_configuration()->mem_config;
39 * the algorithm is not optimal (linear), but there are few
40 * zones and this function should be called at init only
42 for (i = 0; i < RTE_MAX_MEMZONE; i++) {
43 mz = &mcfg->memzone[i];
44 if (mz->addr != NULL && !strncmp(name, mz->name, RTE_MEMZONE_NAMESIZE))
45 return &mcfg->memzone[i];
51 static inline struct rte_memzone *
52 get_next_free_memzone(void)
54 struct rte_mem_config *mcfg;
57 /* get pointer to global configuration */
58 mcfg = rte_eal_get_configuration()->mem_config;
60 for (i = 0; i < RTE_MAX_MEMZONE; i++) {
61 if (mcfg->memzone[i].addr == NULL)
62 return &mcfg->memzone[i];
68 /* This function will return the greatest free block if a heap has been
69 * specified. If no heap has been specified, it will return the heap and
70 * length of the greatest free block available in all heaps */
72 find_heap_max_free_elem(int *s, unsigned align)
74 struct rte_mem_config *mcfg;
75 struct rte_malloc_socket_stats stats;
79 /* get pointer to global configuration */
80 mcfg = rte_eal_get_configuration()->mem_config;
82 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
83 if ((socket != SOCKET_ID_ANY) && (socket != i))
86 malloc_heap_get_stats(&mcfg->malloc_heaps[i], &stats);
87 if (stats.greatest_free_size > len) {
88 len = stats.greatest_free_size;
93 if (len < MALLOC_ELEM_OVERHEAD + align)
96 return len - MALLOC_ELEM_OVERHEAD - align;
99 static const struct rte_memzone *
100 memzone_reserve_aligned_thread_unsafe(const char *name, size_t len,
101 int socket_id, unsigned flags, unsigned align, unsigned bound)
103 struct rte_memzone *mz;
104 struct rte_mem_config *mcfg;
105 size_t requested_len;
108 /* get pointer to global configuration */
109 mcfg = rte_eal_get_configuration()->mem_config;
111 /* no more room in config */
112 if (mcfg->memzone_cnt >= RTE_MAX_MEMZONE) {
113 RTE_LOG(ERR, EAL, "%s(): No more room in config\n", __func__);
118 if (strlen(name) > sizeof(mz->name) - 1) {
119 RTE_LOG(DEBUG, EAL, "%s(): memzone <%s>: name too long\n",
121 rte_errno = ENAMETOOLONG;
125 /* zone already exist */
126 if ((memzone_lookup_thread_unsafe(name)) != NULL) {
127 RTE_LOG(DEBUG, EAL, "%s(): memzone <%s> already exists\n",
133 /* if alignment is not a power of two */
134 if (align && !rte_is_power_of_2(align)) {
135 RTE_LOG(ERR, EAL, "%s(): Invalid alignment: %u\n", __func__,
141 /* alignment less than cache size is not allowed */
142 if (align < RTE_CACHE_LINE_SIZE)
143 align = RTE_CACHE_LINE_SIZE;
145 /* align length on cache boundary. Check for overflow before doing so */
146 if (len > SIZE_MAX - RTE_CACHE_LINE_MASK) {
147 rte_errno = EINVAL; /* requested size too big */
151 len += RTE_CACHE_LINE_MASK;
152 len &= ~((size_t) RTE_CACHE_LINE_MASK);
154 /* save minimal requested length */
155 requested_len = RTE_MAX((size_t)RTE_CACHE_LINE_SIZE, len);
157 /* check that boundary condition is valid */
158 if (bound != 0 && (requested_len > bound || !rte_is_power_of_2(bound))) {
163 if ((socket_id != SOCKET_ID_ANY) &&
164 (socket_id >= RTE_MAX_NUMA_NODES || socket_id < 0)) {
169 if (!rte_eal_has_hugepages())
170 socket_id = SOCKET_ID_ANY;
174 requested_len = bound;
176 requested_len = find_heap_max_free_elem(&socket_id, align);
177 if (requested_len == 0) {
184 if (socket_id == SOCKET_ID_ANY)
185 socket = malloc_get_numa_socket();
189 /* allocate memory on heap */
190 void *mz_addr = malloc_heap_alloc(&mcfg->malloc_heaps[socket], NULL,
191 requested_len, flags, align, bound);
193 if ((mz_addr == NULL) && (socket_id == SOCKET_ID_ANY)) {
194 /* try other heaps */
195 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
199 mz_addr = malloc_heap_alloc(&mcfg->malloc_heaps[i],
200 NULL, requested_len, flags, align, bound);
206 if (mz_addr == NULL) {
211 const struct malloc_elem *elem = malloc_elem_from_data(mz_addr);
213 /* fill the zone in config */
214 mz = get_next_free_memzone();
217 RTE_LOG(ERR, EAL, "%s(): Cannot find free memzone but there is room "
218 "in config!\n", __func__);
224 snprintf(mz->name, sizeof(mz->name), "%s", name);
225 mz->iova = rte_malloc_virt2iova(mz_addr);
227 mz->len = (requested_len == 0 ? elem->size : requested_len);
228 mz->hugepage_sz = elem->ms->hugepage_sz;
229 mz->socket_id = elem->ms->socket_id;
231 mz->memseg_id = elem->ms - rte_eal_get_configuration()->mem_config->memseg;
236 static const struct rte_memzone *
237 rte_memzone_reserve_thread_safe(const char *name, size_t len,
238 int socket_id, unsigned flags, unsigned align,
241 struct rte_mem_config *mcfg;
242 const struct rte_memzone *mz = NULL;
244 /* get pointer to global configuration */
245 mcfg = rte_eal_get_configuration()->mem_config;
247 rte_rwlock_write_lock(&mcfg->mlock);
249 mz = memzone_reserve_aligned_thread_unsafe(
250 name, len, socket_id, flags, align, bound);
252 rte_rwlock_write_unlock(&mcfg->mlock);
258 * Return a pointer to a correctly filled memzone descriptor (with a
259 * specified alignment and boundary). If the allocation cannot be done,
262 const struct rte_memzone *
263 rte_memzone_reserve_bounded(const char *name, size_t len, int socket_id,
264 unsigned flags, unsigned align, unsigned bound)
266 return rte_memzone_reserve_thread_safe(name, len, socket_id, flags,
271 * Return a pointer to a correctly filled memzone descriptor (with a
272 * specified alignment). If the allocation cannot be done, return NULL.
274 const struct rte_memzone *
275 rte_memzone_reserve_aligned(const char *name, size_t len, int socket_id,
276 unsigned flags, unsigned align)
278 return rte_memzone_reserve_thread_safe(name, len, socket_id, flags,
283 * Return a pointer to a correctly filled memzone descriptor. If the
284 * allocation cannot be done, return NULL.
286 const struct rte_memzone *
287 rte_memzone_reserve(const char *name, size_t len, int socket_id,
290 return rte_memzone_reserve_thread_safe(name, len, socket_id,
291 flags, RTE_CACHE_LINE_SIZE, 0);
295 rte_memzone_free(const struct rte_memzone *mz)
297 struct rte_mem_config *mcfg;
305 mcfg = rte_eal_get_configuration()->mem_config;
307 rte_rwlock_write_lock(&mcfg->mlock);
309 idx = ((uintptr_t)mz - (uintptr_t)mcfg->memzone);
310 idx = idx / sizeof(struct rte_memzone);
312 addr = mcfg->memzone[idx].addr;
315 else if (mcfg->memzone_cnt == 0) {
316 rte_panic("%s(): memzone address not NULL but memzone_cnt is 0!\n",
319 memset(&mcfg->memzone[idx], 0, sizeof(mcfg->memzone[idx]));
323 rte_rwlock_write_unlock(&mcfg->mlock);
331 * Lookup for the memzone identified by the given name
333 const struct rte_memzone *
334 rte_memzone_lookup(const char *name)
336 struct rte_mem_config *mcfg;
337 const struct rte_memzone *memzone = NULL;
339 mcfg = rte_eal_get_configuration()->mem_config;
341 rte_rwlock_read_lock(&mcfg->mlock);
343 memzone = memzone_lookup_thread_unsafe(name);
345 rte_rwlock_read_unlock(&mcfg->mlock);
350 /* Dump all reserved memory zones on console */
352 rte_memzone_dump(FILE *f)
354 struct rte_mem_config *mcfg;
357 /* get pointer to global configuration */
358 mcfg = rte_eal_get_configuration()->mem_config;
360 rte_rwlock_read_lock(&mcfg->mlock);
362 for (i=0; i<RTE_MAX_MEMZONE; i++) {
363 if (mcfg->memzone[i].addr == NULL)
365 fprintf(f, "Zone %u: name:<%s>, IO:0x%"PRIx64", len:0x%zx"
366 ", virt:%p, socket_id:%"PRId32", flags:%"PRIx32"\n", i,
367 mcfg->memzone[i].name,
368 mcfg->memzone[i].iova,
369 mcfg->memzone[i].len,
370 mcfg->memzone[i].addr,
371 mcfg->memzone[i].socket_id,
372 mcfg->memzone[i].flags);
374 rte_rwlock_read_unlock(&mcfg->mlock);
378 * Init the memzone subsystem
381 rte_eal_memzone_init(void)
383 struct rte_mem_config *mcfg;
384 const struct rte_memseg *memseg;
386 /* get pointer to global configuration */
387 mcfg = rte_eal_get_configuration()->mem_config;
389 /* secondary processes don't need to initialise anything */
390 if (rte_eal_process_type() == RTE_PROC_SECONDARY)
393 memseg = rte_eal_get_physmem_layout();
394 if (memseg == NULL) {
395 RTE_LOG(ERR, EAL, "%s(): Cannot get physical layout\n", __func__);
399 rte_rwlock_write_lock(&mcfg->mlock);
401 /* delete all zones */
402 mcfg->memzone_cnt = 0;
403 memset(mcfg->memzone, 0, sizeof(mcfg->memzone));
405 rte_rwlock_write_unlock(&mcfg->mlock);
407 return rte_eal_malloc_heap_init();
410 /* Walk all reserved memory zones */
411 void rte_memzone_walk(void (*func)(const struct rte_memzone *, void *),
414 struct rte_mem_config *mcfg;
417 mcfg = rte_eal_get_configuration()->mem_config;
419 rte_rwlock_read_lock(&mcfg->mlock);
420 for (i=0; i<RTE_MAX_MEMZONE; i++) {
421 if (mcfg->memzone[i].addr != NULL)
422 (*func)(&mcfg->memzone[i], arg);
424 rte_rwlock_read_unlock(&mcfg->mlock);