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>
23 #include <rte_eal_trace.h>
25 #include <rte_malloc.h>
26 #include "malloc_elem.h"
27 #include "malloc_heap.h"
28 #include "eal_memalloc.h"
29 #include "eal_memcfg.h"
30 #include "eal_private.h"
33 /* Free the memory space back to heap */
35 mem_free(void *addr, const bool trace_ena)
38 rte_eal_trace_mem_free(addr);
40 if (addr == NULL) return;
41 if (malloc_heap_free(malloc_elem_from_data(addr)) < 0)
42 RTE_LOG(ERR, EAL, "Error: Invalid memory\n");
48 return mem_free(addr, true);
52 eal_free_no_trace(void *addr)
54 return mem_free(addr, false);
58 malloc_socket(const char *type, size_t size, unsigned int align,
59 int socket_arg, const bool trace_ena)
63 /* return NULL if size is 0 or alignment is not power-of-2 */
64 if (size == 0 || (align && !rte_is_power_of_2(align)))
67 /* if there are no hugepages and if we are not allocating from an
68 * external heap, use memory from any socket available. checking for
69 * socket being external may return -1 in case of invalid socket, but
70 * that's OK - if there are no hugepages, it doesn't matter.
72 if (rte_malloc_heap_socket_is_external(socket_arg) != 1 &&
73 !rte_eal_has_hugepages())
74 socket_arg = SOCKET_ID_ANY;
76 ptr = malloc_heap_alloc(type, size, socket_arg, 0,
77 align == 0 ? 1 : align, 0, false);
80 rte_eal_trace_mem_malloc(type, size, align, socket_arg, ptr);
85 * Allocate memory on specified heap.
88 rte_malloc_socket(const char *type, size_t size, unsigned int align,
91 return malloc_socket(type, size, align, socket_arg, true);
95 eal_malloc_no_trace(const char *type, size_t size, unsigned int align)
97 return malloc_socket(type, size, align, SOCKET_ID_ANY, false);
101 * Allocate memory on default heap.
104 rte_malloc(const char *type, size_t size, unsigned align)
106 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
110 * Allocate zero'd memory on specified heap.
113 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
115 void *ptr = rte_malloc_socket(type, size, align, socket);
117 #ifdef RTE_MALLOC_DEBUG
119 * If DEBUG is enabled, then freed memory is marked with poison
120 * value and set to zero on allocation.
121 * If DEBUG is not enabled then memory is already zeroed.
124 memset(ptr, 0, size);
127 rte_eal_trace_mem_zmalloc(type, size, align, socket, ptr);
132 * Allocate zero'd memory on default heap.
135 rte_zmalloc(const char *type, size_t size, unsigned align)
137 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
141 * Allocate zero'd memory on specified heap.
144 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
146 return rte_zmalloc_socket(type, num * size, align, socket);
150 * Allocate zero'd memory on default heap.
153 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
155 return rte_zmalloc(type, num * size, align);
159 * Resize allocated memory on specified heap.
162 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
165 return rte_malloc_socket(NULL, size, align, socket);
167 struct malloc_elem *elem = malloc_elem_from_data(ptr);
169 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
173 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
175 /* check requested socket id and alignment matches first, and if ok,
176 * see if we can resize block
178 if ((socket == SOCKET_ID_ANY ||
179 (unsigned int)socket == elem->heap->socket_id) &&
180 RTE_PTR_ALIGN(ptr, align) == ptr &&
181 malloc_heap_resize(elem, size) == 0) {
182 rte_eal_trace_mem_realloc(size, align, socket, ptr);
186 /* either requested socket id doesn't match, alignment is off
187 * or we have no room to expand,
190 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
193 /* elem: |pad|data_elem|data|trailer| */
194 const size_t old_size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
195 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
198 rte_eal_trace_mem_realloc(size, align, socket, new_ptr);
203 * Resize allocated memory.
206 rte_realloc(void *ptr, size_t size, unsigned int align)
208 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
212 rte_malloc_validate(const void *ptr, size_t *size)
214 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
215 if (!malloc_elem_cookies_ok(elem))
218 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
223 * Function to retrieve data for heap on given socket
226 rte_malloc_get_socket_stats(int socket,
227 struct rte_malloc_socket_stats *socket_stats)
229 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
232 heap_idx = malloc_socket_to_heap_id(socket);
236 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
241 * Function to dump contents of all heaps
244 rte_malloc_dump_heaps(FILE *f)
246 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
249 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
250 fprintf(f, "Heap id: %u\n", idx);
251 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
256 rte_malloc_heap_get_socket(const char *name)
258 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
259 struct malloc_heap *heap = NULL;
264 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
265 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
266 RTE_HEAP_NAME_MAX_LEN) {
270 rte_mcfg_mem_read_lock();
271 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
272 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
274 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
281 ret = heap->socket_id;
286 rte_mcfg_mem_read_unlock();
292 rte_malloc_heap_socket_is_external(int socket_id)
294 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
298 if (socket_id == SOCKET_ID_ANY)
301 rte_mcfg_mem_read_lock();
302 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
303 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
305 if ((int)tmp->socket_id == socket_id) {
306 /* external memory always has large socket ID's */
307 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
311 rte_mcfg_mem_read_unlock();
317 * Print stats on memory type. If type is NULL, info on all types is printed
320 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
322 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
323 unsigned int heap_id;
324 struct rte_malloc_socket_stats sock_stats;
326 /* Iterate through all initialised heaps */
327 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
328 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
330 malloc_heap_get_stats(heap, &sock_stats);
332 fprintf(f, "Heap id:%u\n", heap_id);
333 fprintf(f, "\tHeap name:%s\n", heap->name);
334 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
335 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
336 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
337 fprintf(f, "\tGreatest_free_size:%zu,\n",
338 sock_stats.greatest_free_size);
339 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
340 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
346 * TODO: Set limit to memory that can be allocated to memory type
349 rte_malloc_set_limit(__rte_unused const char *type,
350 __rte_unused size_t max)
356 * Return the IO address of a virtual address obtained through rte_malloc
359 rte_malloc_virt2iova(const void *addr)
361 const struct rte_memseg *ms;
362 struct malloc_elem *elem = malloc_elem_from_data(addr);
367 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
368 return (uintptr_t) addr;
370 ms = rte_mem_virt2memseg(addr, elem->msl);
374 if (ms->iova == RTE_BAD_IOVA)
377 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
380 static struct malloc_heap *
381 find_named_heap(const char *name)
383 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
386 for (i = 0; i < RTE_MAX_HEAPS; i++) {
387 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
389 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
396 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
397 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
399 struct malloc_heap *heap = NULL;
400 struct rte_memseg_list *msl;
404 if (heap_name == NULL || va_addr == NULL ||
405 page_sz == 0 || !rte_is_power_of_2(page_sz) ||
406 RTE_ALIGN(len, page_sz) != len ||
407 !rte_is_aligned(va_addr, page_sz) ||
408 ((len / page_sz) != n_pages && iova_addrs != NULL) ||
409 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
410 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
411 RTE_HEAP_NAME_MAX_LEN) {
415 rte_mcfg_mem_write_lock();
418 heap = find_named_heap(heap_name);
424 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
425 /* cannot add memory to internal heaps */
432 msl = malloc_heap_create_external_seg(va_addr, iova_addrs, n, page_sz,
433 heap_name, heap->socket_id);
439 rte_spinlock_lock(&heap->lock);
440 ret = malloc_heap_add_external_memory(heap, msl);
441 msl->heap = 1; /* mark it as heap segment */
442 rte_spinlock_unlock(&heap->lock);
445 rte_mcfg_mem_write_unlock();
451 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
453 struct malloc_heap *heap = NULL;
454 struct rte_memseg_list *msl;
457 if (heap_name == NULL || va_addr == NULL || len == 0 ||
458 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
459 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
460 RTE_HEAP_NAME_MAX_LEN) {
464 rte_mcfg_mem_write_lock();
466 heap = find_named_heap(heap_name);
472 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
473 /* cannot remove memory from internal heaps */
479 msl = malloc_heap_find_external_seg(va_addr, len);
485 rte_spinlock_lock(&heap->lock);
486 ret = malloc_heap_remove_external_memory(heap, va_addr, len);
487 rte_spinlock_unlock(&heap->lock);
491 ret = malloc_heap_destroy_external_seg(msl);
494 rte_mcfg_mem_write_unlock();
500 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
502 struct malloc_heap *heap = NULL;
503 struct rte_memseg_list *msl;
506 if (heap_name == NULL || va_addr == NULL || len == 0 ||
507 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
508 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
509 RTE_HEAP_NAME_MAX_LEN) {
513 rte_mcfg_mem_read_lock();
516 heap = find_named_heap(heap_name);
522 /* we shouldn't be able to sync to internal heaps */
523 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
529 /* find corresponding memseg list to sync to */
530 msl = malloc_heap_find_external_seg(va_addr, len);
537 ret = rte_fbarray_attach(&msl->memseg_arr);
539 /* notify all subscribers that a new memory area was
542 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
549 /* notify all subscribers that a memory area is about to
552 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
553 msl->base_va, msl->len);
554 ret = rte_fbarray_detach(&msl->memseg_arr);
561 rte_mcfg_mem_read_unlock();
566 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
568 return sync_memory(heap_name, va_addr, len, true);
572 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
574 return sync_memory(heap_name, va_addr, len, false);
578 rte_malloc_heap_create(const char *heap_name)
580 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
581 struct malloc_heap *heap = NULL;
584 if (heap_name == NULL ||
585 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
586 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
587 RTE_HEAP_NAME_MAX_LEN) {
591 /* check if there is space in the heap list, or if heap with this name
594 rte_mcfg_mem_write_lock();
596 for (i = 0; i < RTE_MAX_HEAPS; i++) {
597 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
599 if (strncmp(heap_name, tmp->name,
600 RTE_HEAP_NAME_MAX_LEN) == 0) {
601 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
608 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
614 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
620 /* we're sure that we can create a new heap, so do it */
621 ret = malloc_heap_create(heap, heap_name);
623 rte_mcfg_mem_write_unlock();
629 rte_malloc_heap_destroy(const char *heap_name)
631 struct malloc_heap *heap = NULL;
634 if (heap_name == NULL ||
635 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
636 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
637 RTE_HEAP_NAME_MAX_LEN) {
641 rte_mcfg_mem_write_lock();
643 /* start from non-socket heaps */
644 heap = find_named_heap(heap_name);
646 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
651 /* we shouldn't be able to destroy internal heaps */
652 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
657 /* sanity checks done, now we can destroy the heap */
658 rte_spinlock_lock(&heap->lock);
659 ret = malloc_heap_destroy(heap);
661 /* if we failed, lock is still active */
663 rte_spinlock_unlock(&heap->lock);
665 rte_mcfg_mem_write_unlock();