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_malloc.h>
25 #include "malloc_elem.h"
26 #include "malloc_heap.h"
27 #include "eal_memalloc.h"
28 #include "eal_memcfg.h"
31 /* Free the memory space back to heap */
32 void rte_free(void *addr)
34 if (addr == NULL) return;
35 if (malloc_heap_free(malloc_elem_from_data(addr)) < 0)
36 RTE_LOG(ERR, EAL, "Error: Invalid memory\n");
40 * Allocate memory on specified heap.
43 rte_malloc_socket(const char *type, size_t size, unsigned int align,
46 /* return NULL if size is 0 or alignment is not power-of-2 */
47 if (size == 0 || (align && !rte_is_power_of_2(align)))
50 /* if there are no hugepages and if we are not allocating from an
51 * external heap, use memory from any socket available. checking for
52 * socket being external may return -1 in case of invalid socket, but
53 * that's OK - if there are no hugepages, it doesn't matter.
55 if (rte_malloc_heap_socket_is_external(socket_arg) != 1 &&
56 !rte_eal_has_hugepages())
57 socket_arg = SOCKET_ID_ANY;
59 return malloc_heap_alloc(type, size, socket_arg, 0,
60 align == 0 ? 1 : align, 0, false);
64 * Allocate memory on default heap.
67 rte_malloc(const char *type, size_t size, unsigned align)
69 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
73 * Allocate zero'd memory on specified heap.
76 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
78 void *ptr = rte_malloc_socket(type, size, align, socket);
80 #ifdef RTE_MALLOC_DEBUG
82 * If DEBUG is enabled, then freed memory is marked with poison
83 * value and set to zero on allocation.
84 * If DEBUG is not enabled then memory is already zeroed.
93 * Allocate zero'd memory on default heap.
96 rte_zmalloc(const char *type, size_t size, unsigned align)
98 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
102 * Allocate zero'd memory on specified heap.
105 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
107 return rte_zmalloc_socket(type, num * size, align, socket);
111 * Allocate zero'd memory on default heap.
114 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
116 return rte_zmalloc(type, num * size, align);
120 * Resize allocated memory on specified heap.
123 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
126 return rte_malloc_socket(NULL, size, align, socket);
128 struct malloc_elem *elem = malloc_elem_from_data(ptr);
130 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
134 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
136 /* check requested socket id and alignment matches first, and if ok,
137 * see if we can resize block
139 if ((socket == SOCKET_ID_ANY ||
140 (unsigned int)socket == elem->heap->socket_id) &&
141 RTE_PTR_ALIGN(ptr, align) == ptr &&
142 malloc_heap_resize(elem, size) == 0)
145 /* either requested socket id doesn't match, alignment is off
146 * or we have no room to expand,
149 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
152 const unsigned old_size = elem->size - MALLOC_ELEM_OVERHEAD;
153 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
160 * Resize allocated memory.
163 rte_realloc(void *ptr, size_t size, unsigned int align)
165 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
169 rte_malloc_validate(const void *ptr, size_t *size)
171 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
172 if (!malloc_elem_cookies_ok(elem))
175 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
180 * Function to retrieve data for heap on given socket
183 rte_malloc_get_socket_stats(int socket,
184 struct rte_malloc_socket_stats *socket_stats)
186 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
189 heap_idx = malloc_socket_to_heap_id(socket);
193 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
198 * Function to dump contents of all heaps
201 rte_malloc_dump_heaps(FILE *f)
203 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
206 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
207 fprintf(f, "Heap id: %u\n", idx);
208 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
213 rte_malloc_heap_get_socket(const char *name)
215 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
216 struct malloc_heap *heap = NULL;
221 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
222 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
223 RTE_HEAP_NAME_MAX_LEN) {
227 rte_mcfg_mem_read_lock();
228 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
229 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
231 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
238 ret = heap->socket_id;
243 rte_mcfg_mem_read_unlock();
249 rte_malloc_heap_socket_is_external(int socket_id)
251 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
255 if (socket_id == SOCKET_ID_ANY)
258 rte_mcfg_mem_read_lock();
259 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
260 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
262 if ((int)tmp->socket_id == socket_id) {
263 /* external memory always has large socket ID's */
264 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
268 rte_mcfg_mem_read_unlock();
274 * Print stats on memory type. If type is NULL, info on all types is printed
277 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
279 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
280 unsigned int heap_id;
281 struct rte_malloc_socket_stats sock_stats;
283 /* Iterate through all initialised heaps */
284 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
285 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
287 malloc_heap_get_stats(heap, &sock_stats);
289 fprintf(f, "Heap id:%u\n", heap_id);
290 fprintf(f, "\tHeap name:%s\n", heap->name);
291 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
292 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
293 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
294 fprintf(f, "\tGreatest_free_size:%zu,\n",
295 sock_stats.greatest_free_size);
296 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
297 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
303 * TODO: Set limit to memory that can be allocated to memory type
306 rte_malloc_set_limit(__rte_unused const char *type,
307 __rte_unused size_t max)
313 * Return the IO address of a virtual address obtained through rte_malloc
316 rte_malloc_virt2iova(const void *addr)
318 const struct rte_memseg *ms;
319 struct malloc_elem *elem = malloc_elem_from_data(addr);
324 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
325 return (uintptr_t) addr;
327 ms = rte_mem_virt2memseg(addr, elem->msl);
331 if (ms->iova == RTE_BAD_IOVA)
334 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
337 static struct malloc_heap *
338 find_named_heap(const char *name)
340 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
343 for (i = 0; i < RTE_MAX_HEAPS; i++) {
344 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
346 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
353 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
354 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
356 struct malloc_heap *heap = NULL;
357 struct rte_memseg_list *msl;
361 if (heap_name == NULL || va_addr == NULL ||
362 page_sz == 0 || !rte_is_power_of_2(page_sz) ||
363 RTE_ALIGN(len, page_sz) != len ||
364 !rte_is_aligned(va_addr, page_sz) ||
365 ((len / page_sz) != n_pages && iova_addrs != NULL) ||
366 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
367 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
368 RTE_HEAP_NAME_MAX_LEN) {
372 rte_mcfg_mem_write_lock();
375 heap = find_named_heap(heap_name);
381 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
382 /* cannot add memory to internal heaps */
389 msl = malloc_heap_create_external_seg(va_addr, iova_addrs, n, page_sz,
390 heap_name, heap->socket_id);
396 rte_spinlock_lock(&heap->lock);
397 ret = malloc_heap_add_external_memory(heap, msl);
398 rte_spinlock_unlock(&heap->lock);
401 rte_mcfg_mem_write_unlock();
407 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
409 struct malloc_heap *heap = NULL;
410 struct rte_memseg_list *msl;
413 if (heap_name == NULL || va_addr == NULL || len == 0 ||
414 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
415 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
416 RTE_HEAP_NAME_MAX_LEN) {
420 rte_mcfg_mem_write_lock();
422 heap = find_named_heap(heap_name);
428 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
429 /* cannot remove memory from internal heaps */
435 msl = malloc_heap_find_external_seg(va_addr, len);
441 rte_spinlock_lock(&heap->lock);
442 ret = malloc_heap_remove_external_memory(heap, va_addr, len);
443 rte_spinlock_unlock(&heap->lock);
447 ret = malloc_heap_destroy_external_seg(msl);
450 rte_mcfg_mem_write_unlock();
456 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
458 struct malloc_heap *heap = NULL;
459 struct rte_memseg_list *msl;
462 if (heap_name == NULL || va_addr == NULL || len == 0 ||
463 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
464 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
465 RTE_HEAP_NAME_MAX_LEN) {
469 rte_mcfg_mem_read_lock();
472 heap = find_named_heap(heap_name);
478 /* we shouldn't be able to sync to internal heaps */
479 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
485 /* find corresponding memseg list to sync to */
486 msl = malloc_heap_find_external_seg(va_addr, len);
493 ret = rte_fbarray_attach(&msl->memseg_arr);
495 /* notify all subscribers that a new memory area was
498 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
505 /* notify all subscribers that a memory area is about to
508 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
509 msl->base_va, msl->len);
510 ret = rte_fbarray_detach(&msl->memseg_arr);
517 rte_mcfg_mem_read_unlock();
522 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
524 return sync_memory(heap_name, va_addr, len, true);
528 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
530 return sync_memory(heap_name, va_addr, len, false);
534 rte_malloc_heap_create(const char *heap_name)
536 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
537 struct malloc_heap *heap = NULL;
540 if (heap_name == NULL ||
541 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
542 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
543 RTE_HEAP_NAME_MAX_LEN) {
547 /* check if there is space in the heap list, or if heap with this name
550 rte_mcfg_mem_write_lock();
552 for (i = 0; i < RTE_MAX_HEAPS; i++) {
553 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
555 if (strncmp(heap_name, tmp->name,
556 RTE_HEAP_NAME_MAX_LEN) == 0) {
557 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
564 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
570 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
576 /* we're sure that we can create a new heap, so do it */
577 ret = malloc_heap_create(heap, heap_name);
579 rte_mcfg_mem_write_unlock();
585 rte_malloc_heap_destroy(const char *heap_name)
587 struct malloc_heap *heap = NULL;
590 if (heap_name == NULL ||
591 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
592 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
593 RTE_HEAP_NAME_MAX_LEN) {
597 rte_mcfg_mem_write_lock();
599 /* start from non-socket heaps */
600 heap = find_named_heap(heap_name);
602 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
607 /* we shouldn't be able to destroy internal heaps */
608 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
613 /* sanity checks done, now we can destroy the heap */
614 rte_spinlock_lock(&heap->lock);
615 ret = malloc_heap_destroy(heap);
617 /* if we failed, lock is still active */
619 rte_spinlock_unlock(&heap->lock);
621 rte_mcfg_mem_write_unlock();