1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2019 Intel Corporation
11 #include <rte_errno.h>
12 #include <rte_memcpy.h>
13 #include <rte_memory.h>
15 #include <rte_eal_memconfig.h>
16 #include <rte_branch_prediction.h>
17 #include <rte_debug.h>
18 #include <rte_launch.h>
19 #include <rte_per_lcore.h>
20 #include <rte_lcore.h>
21 #include <rte_common.h>
22 #include <rte_spinlock.h>
24 #include <rte_eal_trace.h>
26 #include <rte_malloc.h>
27 #include "malloc_elem.h"
28 #include "malloc_heap.h"
29 #include "eal_memalloc.h"
30 #include "eal_memcfg.h"
31 #include "eal_private.h"
34 /* Free the memory space back to heap */
36 mem_free(void *addr, const bool trace_ena)
39 rte_eal_trace_mem_free(addr);
41 if (addr == NULL) return;
42 if (malloc_heap_free(malloc_elem_from_data(addr)) < 0)
43 RTE_LOG(ERR, EAL, "Error: Invalid memory\n");
49 return mem_free(addr, true);
53 eal_free_no_trace(void *addr)
55 return mem_free(addr, false);
59 malloc_socket(const char *type, size_t size, unsigned int align,
60 int socket_arg, const bool trace_ena)
64 /* return NULL if size is 0 or alignment is not power-of-2 */
65 if (size == 0 || (align && !rte_is_power_of_2(align)))
68 /* if there are no hugepages and if we are not allocating from an
69 * external heap, use memory from any socket available. checking for
70 * socket being external may return -1 in case of invalid socket, but
71 * that's OK - if there are no hugepages, it doesn't matter.
73 if (rte_malloc_heap_socket_is_external(socket_arg) != 1 &&
74 !rte_eal_has_hugepages())
75 socket_arg = SOCKET_ID_ANY;
77 ptr = malloc_heap_alloc(type, size, socket_arg, 0,
78 align == 0 ? 1 : align, 0, false);
81 rte_eal_trace_mem_malloc(type, size, align, socket_arg, ptr);
86 * Allocate memory on specified heap.
89 rte_malloc_socket(const char *type, size_t size, unsigned int align,
92 return malloc_socket(type, size, align, socket_arg, true);
96 eal_malloc_no_trace(const char *type, size_t size, unsigned int align)
98 return malloc_socket(type, size, align, SOCKET_ID_ANY, false);
102 * Allocate memory on default heap.
105 rte_malloc(const char *type, size_t size, unsigned align)
107 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
111 * Allocate zero'd memory on specified heap.
114 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
116 void *ptr = rte_malloc_socket(type, size, align, socket);
118 #ifdef RTE_MALLOC_DEBUG
120 * If DEBUG is enabled, then freed memory is marked with poison
121 * value and set to zero on allocation.
122 * If DEBUG is not enabled then memory is already zeroed.
125 memset(ptr, 0, size);
128 rte_eal_trace_mem_zmalloc(type, size, align, socket, ptr);
133 * Allocate zero'd memory on default heap.
136 rte_zmalloc(const char *type, size_t size, unsigned align)
138 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
142 * Allocate zero'd memory on specified heap.
145 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
147 return rte_zmalloc_socket(type, num * size, align, socket);
151 * Allocate zero'd memory on default heap.
154 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
156 return rte_zmalloc(type, num * size, align);
160 * Resize allocated memory on specified heap.
163 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
166 return rte_malloc_socket(NULL, size, align, socket);
168 struct malloc_elem *elem = malloc_elem_from_data(ptr);
170 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
174 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
176 /* check requested socket id and alignment matches first, and if ok,
177 * see if we can resize block
179 if ((socket == SOCKET_ID_ANY ||
180 (unsigned int)socket == elem->heap->socket_id) &&
181 RTE_PTR_ALIGN(ptr, align) == ptr &&
182 malloc_heap_resize(elem, size) == 0) {
183 rte_eal_trace_mem_realloc(size, align, socket, ptr);
187 /* either requested socket id doesn't match, alignment is off
188 * or we have no room to expand,
191 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
194 /* elem: |pad|data_elem|data|trailer| */
195 const size_t old_size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
196 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
199 rte_eal_trace_mem_realloc(size, align, socket, new_ptr);
204 * Resize allocated memory.
207 rte_realloc(void *ptr, size_t size, unsigned int align)
209 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
213 rte_malloc_validate(const void *ptr, size_t *size)
215 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
216 if (!malloc_elem_cookies_ok(elem))
219 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
224 * Function to retrieve data for heap on given socket
227 rte_malloc_get_socket_stats(int socket,
228 struct rte_malloc_socket_stats *socket_stats)
230 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
233 heap_idx = malloc_socket_to_heap_id(socket);
237 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
242 * Function to dump contents of all heaps
245 rte_malloc_dump_heaps(FILE *f)
247 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
250 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
251 fprintf(f, "Heap id: %u\n", idx);
252 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
257 rte_malloc_heap_get_socket(const char *name)
259 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
260 struct malloc_heap *heap = NULL;
265 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
266 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
267 RTE_HEAP_NAME_MAX_LEN) {
271 rte_mcfg_mem_read_lock();
272 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
273 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
275 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
282 ret = heap->socket_id;
287 rte_mcfg_mem_read_unlock();
293 rte_malloc_heap_socket_is_external(int socket_id)
295 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
299 if (socket_id == SOCKET_ID_ANY)
302 rte_mcfg_mem_read_lock();
303 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
304 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
306 if ((int)tmp->socket_id == socket_id) {
307 /* external memory always has large socket ID's */
308 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
312 rte_mcfg_mem_read_unlock();
318 * Print stats on memory type. If type is NULL, info on all types is printed
321 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
323 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
324 unsigned int heap_id;
325 struct rte_malloc_socket_stats sock_stats;
327 /* Iterate through all initialised heaps */
328 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
329 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
331 malloc_heap_get_stats(heap, &sock_stats);
333 fprintf(f, "Heap id:%u\n", heap_id);
334 fprintf(f, "\tHeap name:%s\n", heap->name);
335 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
336 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
337 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
338 fprintf(f, "\tGreatest_free_size:%zu,\n",
339 sock_stats.greatest_free_size);
340 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
341 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
347 * TODO: Set limit to memory that can be allocated to memory type
350 rte_malloc_set_limit(__rte_unused const char *type,
351 __rte_unused size_t max)
357 * Return the IO address of a virtual address obtained through rte_malloc
360 rte_malloc_virt2iova(const void *addr)
362 const struct rte_memseg *ms;
363 struct malloc_elem *elem = malloc_elem_from_data(addr);
368 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
369 return (uintptr_t) addr;
371 ms = rte_mem_virt2memseg(addr, elem->msl);
375 if (ms->iova == RTE_BAD_IOVA)
378 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
381 static struct malloc_heap *
382 find_named_heap(const char *name)
384 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
387 for (i = 0; i < RTE_MAX_HEAPS; i++) {
388 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
390 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
397 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
398 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
400 struct malloc_heap *heap = NULL;
401 struct rte_memseg_list *msl;
405 if (heap_name == NULL || va_addr == NULL ||
406 page_sz == 0 || !rte_is_power_of_2(page_sz) ||
407 RTE_ALIGN(len, page_sz) != len ||
408 !rte_is_aligned(va_addr, page_sz) ||
409 ((len / page_sz) != n_pages && iova_addrs != NULL) ||
410 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
411 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
412 RTE_HEAP_NAME_MAX_LEN) {
416 rte_mcfg_mem_write_lock();
419 heap = find_named_heap(heap_name);
425 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
426 /* cannot add memory to internal heaps */
433 msl = malloc_heap_create_external_seg(va_addr, iova_addrs, n, page_sz,
434 heap_name, heap->socket_id);
440 rte_spinlock_lock(&heap->lock);
441 ret = malloc_heap_add_external_memory(heap, msl);
442 msl->heap = 1; /* mark it as heap segment */
443 rte_spinlock_unlock(&heap->lock);
446 rte_mcfg_mem_write_unlock();
452 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
454 struct malloc_heap *heap = NULL;
455 struct rte_memseg_list *msl;
458 if (heap_name == NULL || va_addr == NULL || len == 0 ||
459 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
460 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
461 RTE_HEAP_NAME_MAX_LEN) {
465 rte_mcfg_mem_write_lock();
467 heap = find_named_heap(heap_name);
473 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
474 /* cannot remove memory from internal heaps */
480 msl = malloc_heap_find_external_seg(va_addr, len);
486 rte_spinlock_lock(&heap->lock);
487 ret = malloc_heap_remove_external_memory(heap, va_addr, len);
488 rte_spinlock_unlock(&heap->lock);
492 ret = malloc_heap_destroy_external_seg(msl);
495 rte_mcfg_mem_write_unlock();
501 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
503 struct malloc_heap *heap = NULL;
504 struct rte_memseg_list *msl;
507 if (heap_name == NULL || va_addr == NULL || len == 0 ||
508 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
509 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
510 RTE_HEAP_NAME_MAX_LEN) {
514 rte_mcfg_mem_read_lock();
517 heap = find_named_heap(heap_name);
523 /* we shouldn't be able to sync to internal heaps */
524 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
530 /* find corresponding memseg list to sync to */
531 msl = malloc_heap_find_external_seg(va_addr, len);
538 ret = rte_fbarray_attach(&msl->memseg_arr);
540 /* notify all subscribers that a new memory area was
543 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
550 /* notify all subscribers that a memory area is about to
553 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
554 msl->base_va, msl->len);
555 ret = rte_fbarray_detach(&msl->memseg_arr);
562 rte_mcfg_mem_read_unlock();
567 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
569 return sync_memory(heap_name, va_addr, len, true);
573 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
575 return sync_memory(heap_name, va_addr, len, false);
579 rte_malloc_heap_create(const char *heap_name)
581 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
582 struct malloc_heap *heap = NULL;
585 if (heap_name == NULL ||
586 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
587 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
588 RTE_HEAP_NAME_MAX_LEN) {
592 /* check if there is space in the heap list, or if heap with this name
595 rte_mcfg_mem_write_lock();
597 for (i = 0; i < RTE_MAX_HEAPS; i++) {
598 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
600 if (strncmp(heap_name, tmp->name,
601 RTE_HEAP_NAME_MAX_LEN) == 0) {
602 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
609 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
615 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
621 /* we're sure that we can create a new heap, so do it */
622 ret = malloc_heap_create(heap, heap_name);
624 rte_mcfg_mem_write_unlock();
630 rte_malloc_heap_destroy(const char *heap_name)
632 struct malloc_heap *heap = NULL;
635 if (heap_name == NULL ||
636 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
637 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
638 RTE_HEAP_NAME_MAX_LEN) {
642 rte_mcfg_mem_write_lock();
644 /* start from non-socket heaps */
645 heap = find_named_heap(heap_name);
647 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
652 /* we shouldn't be able to destroy internal heaps */
653 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
658 /* sanity checks done, now we can destroy the heap */
659 rte_spinlock_lock(&heap->lock);
660 ret = malloc_heap_destroy(heap);
662 /* if we failed, lock is still active */
664 rte_spinlock_unlock(&heap->lock);
666 rte_mcfg_mem_write_unlock();