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_common.h>
17 #include <rte_spinlock.h>
19 #include <rte_eal_trace.h>
21 #include <rte_malloc.h>
22 #include "malloc_elem.h"
23 #include "malloc_heap.h"
24 #include "eal_memalloc.h"
25 #include "eal_memcfg.h"
26 #include "eal_private.h"
29 /* Free the memory space back to heap */
31 mem_free(void *addr, const bool trace_ena)
34 rte_eal_trace_mem_free(addr);
36 if (addr == NULL) return;
37 if (malloc_heap_free(malloc_elem_from_data(addr)) < 0)
38 RTE_LOG(ERR, EAL, "Error: Invalid memory\n");
44 return mem_free(addr, true);
48 eal_free_no_trace(void *addr)
50 return mem_free(addr, false);
54 malloc_socket(const char *type, size_t size, unsigned int align,
55 int socket_arg, const bool trace_ena)
59 /* return NULL if size is 0 or alignment is not power-of-2 */
60 if (size == 0 || (align && !rte_is_power_of_2(align)))
63 /* if there are no hugepages and if we are not allocating from an
64 * external heap, use memory from any socket available. checking for
65 * socket being external may return -1 in case of invalid socket, but
66 * that's OK - if there are no hugepages, it doesn't matter.
68 if (rte_malloc_heap_socket_is_external(socket_arg) != 1 &&
69 !rte_eal_has_hugepages())
70 socket_arg = SOCKET_ID_ANY;
72 ptr = malloc_heap_alloc(type, size, socket_arg, 0,
73 align == 0 ? 1 : align, 0, false);
76 rte_eal_trace_mem_malloc(type, size, align, socket_arg, ptr);
81 * Allocate memory on specified heap.
84 rte_malloc_socket(const char *type, size_t size, unsigned int align,
87 return malloc_socket(type, size, align, socket_arg, true);
91 eal_malloc_no_trace(const char *type, size_t size, unsigned int align)
93 return malloc_socket(type, size, align, SOCKET_ID_ANY, false);
97 * Allocate memory on default heap.
100 rte_malloc(const char *type, size_t size, unsigned align)
102 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
106 * Allocate zero'd memory on specified heap.
109 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
111 void *ptr = rte_malloc_socket(type, size, align, socket);
114 struct malloc_elem *elem = malloc_elem_from_data(ptr);
117 memset(ptr, 0, size);
119 #ifdef RTE_MALLOC_DEBUG
121 * If DEBUG is enabled, then freed memory is marked
122 * with a poison value and set to zero on allocation.
123 * If DEBUG is disabled then memory is already zeroed.
125 memset(ptr, 0, size);
130 rte_eal_trace_mem_zmalloc(type, size, align, socket, ptr);
135 * Allocate zero'd memory on default heap.
138 rte_zmalloc(const char *type, size_t size, unsigned align)
140 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
144 * Allocate zero'd memory on specified heap.
147 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
149 return rte_zmalloc_socket(type, num * size, align, socket);
153 * Allocate zero'd memory on default heap.
156 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
158 return rte_zmalloc(type, num * size, align);
162 * Resize allocated memory on specified heap.
165 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
170 return rte_malloc_socket(NULL, size, align, socket);
172 struct malloc_elem *elem = malloc_elem_from_data(ptr);
174 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
180 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
182 /* check requested socket id and alignment matches first, and if ok,
183 * see if we can resize block
185 if ((socket == SOCKET_ID_ANY ||
186 (unsigned int)socket == elem->heap->socket_id) &&
187 RTE_PTR_ALIGN(ptr, align) == ptr &&
188 malloc_heap_resize(elem, size) == 0) {
189 rte_eal_trace_mem_realloc(size, align, socket, ptr);
191 asan_set_redzone(elem, user_size);
196 /* either requested socket id doesn't match, alignment is off
197 * or we have no room to expand,
200 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
203 /* elem: |pad|data_elem|data|trailer| */
204 const size_t old_size = old_malloc_size(elem);
205 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
208 rte_eal_trace_mem_realloc(size, align, socket, new_ptr);
213 * Resize allocated memory.
216 rte_realloc(void *ptr, size_t size, unsigned int align)
218 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
222 rte_malloc_validate(const void *ptr, size_t *size)
224 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
225 if (!malloc_elem_cookies_ok(elem))
228 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
233 * Function to retrieve data for heap on given socket
236 rte_malloc_get_socket_stats(int socket,
237 struct rte_malloc_socket_stats *socket_stats)
239 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
242 heap_idx = malloc_socket_to_heap_id(socket);
246 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
251 * Function to dump contents of all heaps
254 rte_malloc_dump_heaps(FILE *f)
256 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
259 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
260 fprintf(f, "Heap id: %u\n", idx);
261 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
266 rte_malloc_heap_get_socket(const char *name)
268 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
269 struct malloc_heap *heap = NULL;
274 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
275 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
276 RTE_HEAP_NAME_MAX_LEN) {
280 rte_mcfg_mem_read_lock();
281 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
282 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
284 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
291 ret = heap->socket_id;
296 rte_mcfg_mem_read_unlock();
302 rte_malloc_heap_socket_is_external(int socket_id)
304 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
308 if (socket_id == SOCKET_ID_ANY)
311 rte_mcfg_mem_read_lock();
312 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
313 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
315 if ((int)tmp->socket_id == socket_id) {
316 /* external memory always has large socket ID's */
317 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
321 rte_mcfg_mem_read_unlock();
327 * Print stats on memory type. If type is NULL, info on all types is printed
330 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
332 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
333 unsigned int heap_id;
334 struct rte_malloc_socket_stats sock_stats;
336 /* Iterate through all initialised heaps */
337 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
338 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
340 malloc_heap_get_stats(heap, &sock_stats);
342 fprintf(f, "Heap id:%u\n", heap_id);
343 fprintf(f, "\tHeap name:%s\n", heap->name);
344 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
345 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
346 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
347 fprintf(f, "\tGreatest_free_size:%zu,\n",
348 sock_stats.greatest_free_size);
349 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
350 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
356 * TODO: Set limit to memory that can be allocated to memory type
359 rte_malloc_set_limit(__rte_unused const char *type,
360 __rte_unused size_t max)
366 * Return the IO address of a virtual address obtained through rte_malloc
369 rte_malloc_virt2iova(const void *addr)
371 const struct rte_memseg *ms;
372 struct malloc_elem *elem = malloc_elem_from_data(addr);
377 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
378 return (uintptr_t) addr;
380 ms = rte_mem_virt2memseg(addr, elem->msl);
384 if (ms->iova == RTE_BAD_IOVA)
387 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
390 static struct malloc_heap *
391 find_named_heap(const char *name)
393 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
396 for (i = 0; i < RTE_MAX_HEAPS; i++) {
397 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
399 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
406 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
407 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
409 struct malloc_heap *heap = NULL;
410 struct rte_memseg_list *msl;
414 if (heap_name == NULL || va_addr == NULL ||
415 page_sz == 0 || !rte_is_power_of_2(page_sz) ||
416 RTE_ALIGN(len, page_sz) != len ||
417 !rte_is_aligned(va_addr, page_sz) ||
418 ((len / page_sz) != n_pages && iova_addrs != NULL) ||
419 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
420 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
421 RTE_HEAP_NAME_MAX_LEN) {
425 rte_mcfg_mem_write_lock();
428 heap = find_named_heap(heap_name);
434 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
435 /* cannot add memory to internal heaps */
442 msl = malloc_heap_create_external_seg(va_addr, iova_addrs, n, page_sz,
443 heap_name, heap->socket_id);
449 rte_spinlock_lock(&heap->lock);
450 ret = malloc_heap_add_external_memory(heap, msl);
451 msl->heap = 1; /* mark it as heap segment */
452 rte_spinlock_unlock(&heap->lock);
455 rte_mcfg_mem_write_unlock();
461 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
463 struct malloc_heap *heap = NULL;
464 struct rte_memseg_list *msl;
467 if (heap_name == NULL || va_addr == NULL || len == 0 ||
468 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
469 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
470 RTE_HEAP_NAME_MAX_LEN) {
474 rte_mcfg_mem_write_lock();
476 heap = find_named_heap(heap_name);
482 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
483 /* cannot remove memory from internal heaps */
489 msl = malloc_heap_find_external_seg(va_addr, len);
495 rte_spinlock_lock(&heap->lock);
496 ret = malloc_heap_remove_external_memory(heap, va_addr, len);
497 rte_spinlock_unlock(&heap->lock);
501 ret = malloc_heap_destroy_external_seg(msl);
504 rte_mcfg_mem_write_unlock();
510 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
512 struct malloc_heap *heap = NULL;
513 struct rte_memseg_list *msl;
516 if (heap_name == NULL || va_addr == NULL || len == 0 ||
517 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
518 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
519 RTE_HEAP_NAME_MAX_LEN) {
523 rte_mcfg_mem_read_lock();
526 heap = find_named_heap(heap_name);
532 /* we shouldn't be able to sync to internal heaps */
533 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
539 /* find corresponding memseg list to sync to */
540 msl = malloc_heap_find_external_seg(va_addr, len);
547 ret = rte_fbarray_attach(&msl->memseg_arr);
549 /* notify all subscribers that a new memory area was
552 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
559 /* notify all subscribers that a memory area is about to
562 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
563 msl->base_va, msl->len);
564 ret = rte_fbarray_detach(&msl->memseg_arr);
571 rte_mcfg_mem_read_unlock();
576 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
578 return sync_memory(heap_name, va_addr, len, true);
582 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
584 return sync_memory(heap_name, va_addr, len, false);
588 rte_malloc_heap_create(const char *heap_name)
590 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
591 struct malloc_heap *heap = NULL;
594 if (heap_name == NULL ||
595 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
596 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
597 RTE_HEAP_NAME_MAX_LEN) {
601 /* check if there is space in the heap list, or if heap with this name
604 rte_mcfg_mem_write_lock();
606 for (i = 0; i < RTE_MAX_HEAPS; i++) {
607 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
609 if (strncmp(heap_name, tmp->name,
610 RTE_HEAP_NAME_MAX_LEN) == 0) {
611 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
618 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
624 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
630 /* we're sure that we can create a new heap, so do it */
631 ret = malloc_heap_create(heap, heap_name);
633 rte_mcfg_mem_write_unlock();
639 rte_malloc_heap_destroy(const char *heap_name)
641 struct malloc_heap *heap = NULL;
644 if (heap_name == NULL ||
645 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
646 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
647 RTE_HEAP_NAME_MAX_LEN) {
651 rte_mcfg_mem_write_lock();
653 /* start from non-socket heaps */
654 heap = find_named_heap(heap_name);
656 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
661 /* we shouldn't be able to destroy internal heaps */
662 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
667 /* sanity checks done, now we can destroy the heap */
668 rte_spinlock_lock(&heap->lock);
669 ret = malloc_heap_destroy(heap);
671 /* if we failed, lock is still active */
673 rte_spinlock_unlock(&heap->lock);
675 rte_mcfg_mem_write_unlock();