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);
119 struct malloc_elem *elem = malloc_elem_from_data(ptr);
122 memset(ptr, 0, size);
124 #ifdef RTE_MALLOC_DEBUG
126 * If DEBUG is enabled, then freed memory is marked
127 * with a poison value and set to zero on allocation.
128 * If DEBUG is disabled then memory is already zeroed.
130 memset(ptr, 0, size);
135 rte_eal_trace_mem_zmalloc(type, size, align, socket, ptr);
140 * Allocate zero'd memory on default heap.
143 rte_zmalloc(const char *type, size_t size, unsigned align)
145 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
149 * Allocate zero'd memory on specified heap.
152 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
154 return rte_zmalloc_socket(type, num * size, align, socket);
158 * Allocate zero'd memory on default heap.
161 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
163 return rte_zmalloc(type, num * size, align);
167 * Resize allocated memory on specified heap.
170 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
175 return rte_malloc_socket(NULL, size, align, socket);
177 struct malloc_elem *elem = malloc_elem_from_data(ptr);
179 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
185 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
187 /* check requested socket id and alignment matches first, and if ok,
188 * see if we can resize block
190 if ((socket == SOCKET_ID_ANY ||
191 (unsigned int)socket == elem->heap->socket_id) &&
192 RTE_PTR_ALIGN(ptr, align) == ptr &&
193 malloc_heap_resize(elem, size) == 0) {
194 rte_eal_trace_mem_realloc(size, align, socket, ptr);
196 asan_set_redzone(elem, user_size);
201 /* either requested socket id doesn't match, alignment is off
202 * or we have no room to expand,
205 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
208 /* elem: |pad|data_elem|data|trailer| */
209 const size_t old_size = old_malloc_size(elem);
210 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
213 rte_eal_trace_mem_realloc(size, align, socket, new_ptr);
218 * Resize allocated memory.
221 rte_realloc(void *ptr, size_t size, unsigned int align)
223 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
227 rte_malloc_validate(const void *ptr, size_t *size)
229 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
230 if (!malloc_elem_cookies_ok(elem))
233 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
238 * Function to retrieve data for heap on given socket
241 rte_malloc_get_socket_stats(int socket,
242 struct rte_malloc_socket_stats *socket_stats)
244 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
247 heap_idx = malloc_socket_to_heap_id(socket);
251 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
256 * Function to dump contents of all heaps
259 rte_malloc_dump_heaps(FILE *f)
261 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
264 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
265 fprintf(f, "Heap id: %u\n", idx);
266 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
271 rte_malloc_heap_get_socket(const char *name)
273 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
274 struct malloc_heap *heap = NULL;
279 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
280 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
281 RTE_HEAP_NAME_MAX_LEN) {
285 rte_mcfg_mem_read_lock();
286 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
287 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
289 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
296 ret = heap->socket_id;
301 rte_mcfg_mem_read_unlock();
307 rte_malloc_heap_socket_is_external(int socket_id)
309 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
313 if (socket_id == SOCKET_ID_ANY)
316 rte_mcfg_mem_read_lock();
317 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
318 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
320 if ((int)tmp->socket_id == socket_id) {
321 /* external memory always has large socket ID's */
322 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
326 rte_mcfg_mem_read_unlock();
332 * Print stats on memory type. If type is NULL, info on all types is printed
335 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
337 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
338 unsigned int heap_id;
339 struct rte_malloc_socket_stats sock_stats;
341 /* Iterate through all initialised heaps */
342 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
343 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
345 malloc_heap_get_stats(heap, &sock_stats);
347 fprintf(f, "Heap id:%u\n", heap_id);
348 fprintf(f, "\tHeap name:%s\n", heap->name);
349 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
350 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
351 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
352 fprintf(f, "\tGreatest_free_size:%zu,\n",
353 sock_stats.greatest_free_size);
354 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
355 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
361 * TODO: Set limit to memory that can be allocated to memory type
364 rte_malloc_set_limit(__rte_unused const char *type,
365 __rte_unused size_t max)
371 * Return the IO address of a virtual address obtained through rte_malloc
374 rte_malloc_virt2iova(const void *addr)
376 const struct rte_memseg *ms;
377 struct malloc_elem *elem = malloc_elem_from_data(addr);
382 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
383 return (uintptr_t) addr;
385 ms = rte_mem_virt2memseg(addr, elem->msl);
389 if (ms->iova == RTE_BAD_IOVA)
392 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
395 static struct malloc_heap *
396 find_named_heap(const char *name)
398 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
401 for (i = 0; i < RTE_MAX_HEAPS; i++) {
402 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
404 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
411 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
412 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
414 struct malloc_heap *heap = NULL;
415 struct rte_memseg_list *msl;
419 if (heap_name == NULL || va_addr == NULL ||
420 page_sz == 0 || !rte_is_power_of_2(page_sz) ||
421 RTE_ALIGN(len, page_sz) != len ||
422 !rte_is_aligned(va_addr, page_sz) ||
423 ((len / page_sz) != n_pages && iova_addrs != NULL) ||
424 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
425 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
426 RTE_HEAP_NAME_MAX_LEN) {
430 rte_mcfg_mem_write_lock();
433 heap = find_named_heap(heap_name);
439 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
440 /* cannot add memory to internal heaps */
447 msl = malloc_heap_create_external_seg(va_addr, iova_addrs, n, page_sz,
448 heap_name, heap->socket_id);
454 rte_spinlock_lock(&heap->lock);
455 ret = malloc_heap_add_external_memory(heap, msl);
456 msl->heap = 1; /* mark it as heap segment */
457 rte_spinlock_unlock(&heap->lock);
460 rte_mcfg_mem_write_unlock();
466 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
468 struct malloc_heap *heap = NULL;
469 struct rte_memseg_list *msl;
472 if (heap_name == NULL || va_addr == NULL || len == 0 ||
473 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
474 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
475 RTE_HEAP_NAME_MAX_LEN) {
479 rte_mcfg_mem_write_lock();
481 heap = find_named_heap(heap_name);
487 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
488 /* cannot remove memory from internal heaps */
494 msl = malloc_heap_find_external_seg(va_addr, len);
500 rte_spinlock_lock(&heap->lock);
501 ret = malloc_heap_remove_external_memory(heap, va_addr, len);
502 rte_spinlock_unlock(&heap->lock);
506 ret = malloc_heap_destroy_external_seg(msl);
509 rte_mcfg_mem_write_unlock();
515 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
517 struct malloc_heap *heap = NULL;
518 struct rte_memseg_list *msl;
521 if (heap_name == NULL || va_addr == NULL || len == 0 ||
522 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
523 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
524 RTE_HEAP_NAME_MAX_LEN) {
528 rte_mcfg_mem_read_lock();
531 heap = find_named_heap(heap_name);
537 /* we shouldn't be able to sync to internal heaps */
538 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
544 /* find corresponding memseg list to sync to */
545 msl = malloc_heap_find_external_seg(va_addr, len);
552 ret = rte_fbarray_attach(&msl->memseg_arr);
554 /* notify all subscribers that a new memory area was
557 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
564 /* notify all subscribers that a memory area is about to
567 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
568 msl->base_va, msl->len);
569 ret = rte_fbarray_detach(&msl->memseg_arr);
576 rte_mcfg_mem_read_unlock();
581 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
583 return sync_memory(heap_name, va_addr, len, true);
587 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
589 return sync_memory(heap_name, va_addr, len, false);
593 rte_malloc_heap_create(const char *heap_name)
595 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
596 struct malloc_heap *heap = NULL;
599 if (heap_name == NULL ||
600 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
601 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
602 RTE_HEAP_NAME_MAX_LEN) {
606 /* check if there is space in the heap list, or if heap with this name
609 rte_mcfg_mem_write_lock();
611 for (i = 0; i < RTE_MAX_HEAPS; i++) {
612 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
614 if (strncmp(heap_name, tmp->name,
615 RTE_HEAP_NAME_MAX_LEN) == 0) {
616 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
623 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
629 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
635 /* we're sure that we can create a new heap, so do it */
636 ret = malloc_heap_create(heap, heap_name);
638 rte_mcfg_mem_write_unlock();
644 rte_malloc_heap_destroy(const char *heap_name)
646 struct malloc_heap *heap = NULL;
649 if (heap_name == NULL ||
650 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
651 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
652 RTE_HEAP_NAME_MAX_LEN) {
656 rte_mcfg_mem_write_lock();
658 /* start from non-socket heaps */
659 heap = find_named_heap(heap_name);
661 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
666 /* we shouldn't be able to destroy internal heaps */
667 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
672 /* sanity checks done, now we can destroy the heap */
673 rte_spinlock_lock(&heap->lock);
674 ret = malloc_heap_destroy(heap);
676 /* if we failed, lock is still active */
678 rte_spinlock_unlock(&heap->lock);
680 rte_mcfg_mem_write_unlock();