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"
29 #include "eal_private.h"
32 /* Free the memory space back to heap */
33 void rte_free(void *addr)
35 if (addr == NULL) return;
36 if (malloc_heap_free(malloc_elem_from_data(addr)) < 0)
37 RTE_LOG(ERR, EAL, "Error: Invalid memory\n");
41 * Allocate memory on specified heap.
44 rte_malloc_socket(const char *type, size_t size, unsigned int align,
47 /* return NULL if size is 0 or alignment is not power-of-2 */
48 if (size == 0 || (align && !rte_is_power_of_2(align)))
51 /* if there are no hugepages and if we are not allocating from an
52 * external heap, use memory from any socket available. checking for
53 * socket being external may return -1 in case of invalid socket, but
54 * that's OK - if there are no hugepages, it doesn't matter.
56 if (rte_malloc_heap_socket_is_external(socket_arg) != 1 &&
57 !rte_eal_has_hugepages())
58 socket_arg = SOCKET_ID_ANY;
60 return malloc_heap_alloc(type, size, socket_arg, 0,
61 align == 0 ? 1 : align, 0, false);
65 * Allocate memory on default heap.
68 rte_malloc(const char *type, size_t size, unsigned align)
70 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
74 * Allocate zero'd memory on specified heap.
77 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
79 void *ptr = rte_malloc_socket(type, size, align, socket);
81 #ifdef RTE_MALLOC_DEBUG
83 * If DEBUG is enabled, then freed memory is marked with poison
84 * value and set to zero on allocation.
85 * If DEBUG is not enabled then memory is already zeroed.
94 * Allocate zero'd memory on default heap.
97 rte_zmalloc(const char *type, size_t size, unsigned align)
99 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
103 * Allocate zero'd memory on specified heap.
106 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
108 return rte_zmalloc_socket(type, num * size, align, socket);
112 * Allocate zero'd memory on default heap.
115 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
117 return rte_zmalloc(type, num * size, align);
121 * Resize allocated memory on specified heap.
124 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
127 return rte_malloc_socket(NULL, size, align, socket);
129 struct malloc_elem *elem = malloc_elem_from_data(ptr);
131 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
135 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
137 /* check requested socket id and alignment matches first, and if ok,
138 * see if we can resize block
140 if ((socket == SOCKET_ID_ANY ||
141 (unsigned int)socket == elem->heap->socket_id) &&
142 RTE_PTR_ALIGN(ptr, align) == ptr &&
143 malloc_heap_resize(elem, size) == 0)
146 /* either requested socket id doesn't match, alignment is off
147 * or we have no room to expand,
150 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
153 const unsigned old_size = elem->size - MALLOC_ELEM_OVERHEAD;
154 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
161 * Resize allocated memory.
164 rte_realloc(void *ptr, size_t size, unsigned int align)
166 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
170 rte_malloc_validate(const void *ptr, size_t *size)
172 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
173 if (!malloc_elem_cookies_ok(elem))
176 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
181 * Function to retrieve data for heap on given socket
184 rte_malloc_get_socket_stats(int socket,
185 struct rte_malloc_socket_stats *socket_stats)
187 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
190 heap_idx = malloc_socket_to_heap_id(socket);
194 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
199 * Function to dump contents of all heaps
202 rte_malloc_dump_heaps(FILE *f)
204 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
207 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
208 fprintf(f, "Heap id: %u\n", idx);
209 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
214 rte_malloc_heap_get_socket(const char *name)
216 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
217 struct malloc_heap *heap = NULL;
222 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
223 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
224 RTE_HEAP_NAME_MAX_LEN) {
228 rte_mcfg_mem_read_lock();
229 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
230 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
232 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
239 ret = heap->socket_id;
244 rte_mcfg_mem_read_unlock();
250 rte_malloc_heap_socket_is_external(int socket_id)
252 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
256 if (socket_id == SOCKET_ID_ANY)
259 rte_mcfg_mem_read_lock();
260 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
261 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
263 if ((int)tmp->socket_id == socket_id) {
264 /* external memory always has large socket ID's */
265 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
269 rte_mcfg_mem_read_unlock();
275 * Print stats on memory type. If type is NULL, info on all types is printed
278 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
280 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
281 unsigned int heap_id;
282 struct rte_malloc_socket_stats sock_stats;
284 /* Iterate through all initialised heaps */
285 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
286 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
288 malloc_heap_get_stats(heap, &sock_stats);
290 fprintf(f, "Heap id:%u\n", heap_id);
291 fprintf(f, "\tHeap name:%s\n", heap->name);
292 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
293 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
294 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
295 fprintf(f, "\tGreatest_free_size:%zu,\n",
296 sock_stats.greatest_free_size);
297 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
298 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
304 * TODO: Set limit to memory that can be allocated to memory type
307 rte_malloc_set_limit(__rte_unused const char *type,
308 __rte_unused size_t max)
314 * Return the IO address of a virtual address obtained through rte_malloc
317 rte_malloc_virt2iova(const void *addr)
319 const struct rte_memseg *ms;
320 struct malloc_elem *elem = malloc_elem_from_data(addr);
325 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
326 return (uintptr_t) addr;
328 ms = rte_mem_virt2memseg(addr, elem->msl);
332 if (ms->iova == RTE_BAD_IOVA)
335 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
338 static struct malloc_heap *
339 find_named_heap(const char *name)
341 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
344 for (i = 0; i < RTE_MAX_HEAPS; i++) {
345 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
347 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
354 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
355 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
357 struct malloc_heap *heap = NULL;
358 struct rte_memseg_list *msl;
362 if (heap_name == NULL || va_addr == NULL ||
363 page_sz == 0 || !rte_is_power_of_2(page_sz) ||
364 RTE_ALIGN(len, page_sz) != len ||
365 !rte_is_aligned(va_addr, page_sz) ||
366 ((len / page_sz) != n_pages && iova_addrs != NULL) ||
367 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
368 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
369 RTE_HEAP_NAME_MAX_LEN) {
373 rte_mcfg_mem_write_lock();
376 heap = find_named_heap(heap_name);
382 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
383 /* cannot add memory to internal heaps */
390 msl = malloc_heap_create_external_seg(va_addr, iova_addrs, n, page_sz,
391 heap_name, heap->socket_id);
397 rte_spinlock_lock(&heap->lock);
398 ret = malloc_heap_add_external_memory(heap, msl);
399 rte_spinlock_unlock(&heap->lock);
402 rte_mcfg_mem_write_unlock();
408 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
410 struct malloc_heap *heap = NULL;
411 struct rte_memseg_list *msl;
414 if (heap_name == NULL || va_addr == NULL || len == 0 ||
415 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
416 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
417 RTE_HEAP_NAME_MAX_LEN) {
421 rte_mcfg_mem_write_lock();
423 heap = find_named_heap(heap_name);
429 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
430 /* cannot remove memory from internal heaps */
436 msl = malloc_heap_find_external_seg(va_addr, len);
442 rte_spinlock_lock(&heap->lock);
443 ret = malloc_heap_remove_external_memory(heap, va_addr, len);
444 rte_spinlock_unlock(&heap->lock);
448 ret = malloc_heap_destroy_external_seg(msl);
451 rte_mcfg_mem_write_unlock();
457 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
459 struct malloc_heap *heap = NULL;
460 struct rte_memseg_list *msl;
463 if (heap_name == NULL || va_addr == NULL || len == 0 ||
464 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
465 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
466 RTE_HEAP_NAME_MAX_LEN) {
470 rte_mcfg_mem_read_lock();
473 heap = find_named_heap(heap_name);
479 /* we shouldn't be able to sync to internal heaps */
480 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
486 /* find corresponding memseg list to sync to */
487 msl = malloc_heap_find_external_seg(va_addr, len);
494 ret = rte_fbarray_attach(&msl->memseg_arr);
496 /* notify all subscribers that a new memory area was
499 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
506 /* notify all subscribers that a memory area is about to
509 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
510 msl->base_va, msl->len);
511 ret = rte_fbarray_detach(&msl->memseg_arr);
518 rte_mcfg_mem_read_unlock();
523 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
525 return sync_memory(heap_name, va_addr, len, true);
529 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
531 return sync_memory(heap_name, va_addr, len, false);
535 rte_malloc_heap_create(const char *heap_name)
537 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
538 struct malloc_heap *heap = NULL;
541 if (heap_name == NULL ||
542 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
543 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
544 RTE_HEAP_NAME_MAX_LEN) {
548 /* check if there is space in the heap list, or if heap with this name
551 rte_mcfg_mem_write_lock();
553 for (i = 0; i < RTE_MAX_HEAPS; i++) {
554 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
556 if (strncmp(heap_name, tmp->name,
557 RTE_HEAP_NAME_MAX_LEN) == 0) {
558 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
565 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
571 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
577 /* we're sure that we can create a new heap, so do it */
578 ret = malloc_heap_create(heap, heap_name);
580 rte_mcfg_mem_write_unlock();
586 rte_malloc_heap_destroy(const char *heap_name)
588 struct malloc_heap *heap = NULL;
591 if (heap_name == NULL ||
592 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
593 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
594 RTE_HEAP_NAME_MAX_LEN) {
598 rte_mcfg_mem_write_lock();
600 /* start from non-socket heaps */
601 heap = find_named_heap(heap_name);
603 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
608 /* we shouldn't be able to destroy internal heaps */
609 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
614 /* sanity checks done, now we can destroy the heap */
615 rte_spinlock_lock(&heap->lock);
616 ret = malloc_heap_destroy(heap);
618 /* if we failed, lock is still active */
620 rte_spinlock_unlock(&heap->lock);
622 rte_mcfg_mem_write_unlock();