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"
30 /* Free the memory space back to heap */
31 void rte_free(void *addr)
33 if (addr == NULL) return;
34 if (malloc_heap_free(malloc_elem_from_data(addr)) < 0)
35 RTE_LOG(ERR, EAL, "Error: Invalid memory\n");
39 * Allocate memory on specified heap.
42 rte_malloc_socket(const char *type, size_t size, unsigned int align,
45 /* return NULL if size is 0 or alignment is not power-of-2 */
46 if (size == 0 || (align && !rte_is_power_of_2(align)))
49 /* if there are no hugepages and if we are not allocating from an
50 * external heap, use memory from any socket available. checking for
51 * socket being external may return -1 in case of invalid socket, but
52 * that's OK - if there are no hugepages, it doesn't matter.
54 if (rte_malloc_heap_socket_is_external(socket_arg) != 1 &&
55 !rte_eal_has_hugepages())
56 socket_arg = SOCKET_ID_ANY;
58 return malloc_heap_alloc(type, size, socket_arg, 0,
59 align == 0 ? 1 : align, 0, false);
63 * Allocate memory on default heap.
66 rte_malloc(const char *type, size_t size, unsigned align)
68 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
72 * Allocate zero'd memory on specified heap.
75 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
77 void *ptr = rte_malloc_socket(type, size, align, socket);
79 #ifdef RTE_MALLOC_DEBUG
81 * If DEBUG is enabled, then freed memory is marked with poison
82 * value and set to zero on allocation.
83 * If DEBUG is not enabled then memory is already zeroed.
92 * Allocate zero'd memory on default heap.
95 rte_zmalloc(const char *type, size_t size, unsigned align)
97 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
101 * Allocate zero'd memory on specified heap.
104 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
106 return rte_zmalloc_socket(type, num * size, align, socket);
110 * Allocate zero'd memory on default heap.
113 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
115 return rte_zmalloc(type, num * size, align);
119 * Resize allocated memory on specified heap.
122 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
125 return rte_malloc_socket(NULL, size, align, socket);
127 struct malloc_elem *elem = malloc_elem_from_data(ptr);
129 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
133 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
135 /* check requested socket id and alignment matches first, and if ok,
136 * see if we can resize block
138 if ((socket == SOCKET_ID_ANY ||
139 (unsigned int)socket == elem->heap->socket_id) &&
140 RTE_PTR_ALIGN(ptr, align) == ptr &&
141 malloc_heap_resize(elem, size) == 0)
144 /* either requested socket id doesn't match, alignment is off
145 * or we have no room to expand,
148 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
151 const unsigned old_size = elem->size - MALLOC_ELEM_OVERHEAD;
152 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
159 * Resize allocated memory.
162 rte_realloc(void *ptr, size_t size, unsigned int align)
164 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
168 rte_malloc_validate(const void *ptr, size_t *size)
170 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
171 if (!malloc_elem_cookies_ok(elem))
174 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
179 * Function to retrieve data for heap on given socket
182 rte_malloc_get_socket_stats(int socket,
183 struct rte_malloc_socket_stats *socket_stats)
185 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
188 heap_idx = malloc_socket_to_heap_id(socket);
192 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
197 * Function to dump contents of all heaps
199 void __rte_experimental
200 rte_malloc_dump_heaps(FILE *f)
202 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
205 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
206 fprintf(f, "Heap id: %u\n", idx);
207 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
212 rte_malloc_heap_get_socket(const char *name)
214 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
215 struct malloc_heap *heap = NULL;
220 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
221 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
222 RTE_HEAP_NAME_MAX_LEN) {
226 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
227 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
228 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
230 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
237 ret = heap->socket_id;
242 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
248 rte_malloc_heap_socket_is_external(int socket_id)
250 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
254 if (socket_id == SOCKET_ID_ANY)
257 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
258 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
259 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
261 if ((int)tmp->socket_id == socket_id) {
262 /* external memory always has large socket ID's */
263 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
267 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
273 * Print stats on memory type. If type is NULL, info on all types is printed
276 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
278 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
279 unsigned int heap_id;
280 struct rte_malloc_socket_stats sock_stats;
282 /* Iterate through all initialised heaps */
283 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
284 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
286 malloc_heap_get_stats(heap, &sock_stats);
288 fprintf(f, "Heap id:%u\n", heap_id);
289 fprintf(f, "\tHeap name:%s\n", heap->name);
290 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
291 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
292 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
293 fprintf(f, "\tGreatest_free_size:%zu,\n",
294 sock_stats.greatest_free_size);
295 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
296 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
302 * TODO: Set limit to memory that can be allocated to memory type
305 rte_malloc_set_limit(__rte_unused const char *type,
306 __rte_unused size_t max)
312 * Return the IO address of a virtual address obtained through rte_malloc
315 rte_malloc_virt2iova(const void *addr)
317 const struct rte_memseg *ms;
318 struct malloc_elem *elem = malloc_elem_from_data(addr);
323 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
324 return (uintptr_t) addr;
326 ms = rte_mem_virt2memseg(addr, elem->msl);
330 if (ms->iova == RTE_BAD_IOVA)
333 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
336 static struct malloc_heap *
337 find_named_heap(const char *name)
339 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
342 for (i = 0; i < RTE_MAX_HEAPS; i++) {
343 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
345 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
352 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
353 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
355 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
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_rwlock_write_lock(&mcfg->memory_hotplug_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_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
407 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
409 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
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_rwlock_write_lock(&mcfg->memory_hotplug_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_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
457 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
459 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
460 struct malloc_heap *heap = NULL;
461 struct rte_memseg_list *msl;
464 if (heap_name == NULL || va_addr == NULL || len == 0 ||
465 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
466 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
467 RTE_HEAP_NAME_MAX_LEN) {
471 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
474 heap = find_named_heap(heap_name);
480 /* we shouldn't be able to sync to internal heaps */
481 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
487 /* find corresponding memseg list to sync to */
488 msl = malloc_heap_find_external_seg(va_addr, len);
495 ret = rte_fbarray_attach(&msl->memseg_arr);
497 /* notify all subscribers that a new memory area was
500 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
507 /* notify all subscribers that a memory area is about to
510 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
511 msl->base_va, msl->len);
512 ret = rte_fbarray_detach(&msl->memseg_arr);
519 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
524 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
526 return sync_memory(heap_name, va_addr, len, true);
530 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
532 return sync_memory(heap_name, va_addr, len, false);
536 rte_malloc_heap_create(const char *heap_name)
538 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
539 struct malloc_heap *heap = NULL;
542 if (heap_name == NULL ||
543 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
544 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
545 RTE_HEAP_NAME_MAX_LEN) {
549 /* check if there is space in the heap list, or if heap with this name
552 rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
554 for (i = 0; i < RTE_MAX_HEAPS; i++) {
555 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
557 if (strncmp(heap_name, tmp->name,
558 RTE_HEAP_NAME_MAX_LEN) == 0) {
559 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
566 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
572 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
578 /* we're sure that we can create a new heap, so do it */
579 ret = malloc_heap_create(heap, heap_name);
581 rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
587 rte_malloc_heap_destroy(const char *heap_name)
589 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
590 struct malloc_heap *heap = NULL;
593 if (heap_name == NULL ||
594 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
595 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
596 RTE_HEAP_NAME_MAX_LEN) {
600 rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
602 /* start from non-socket heaps */
603 heap = find_named_heap(heap_name);
605 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
610 /* we shouldn't be able to destroy internal heaps */
611 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
616 /* sanity checks done, now we can destroy the heap */
617 rte_spinlock_lock(&heap->lock);
618 ret = malloc_heap_destroy(heap);
620 /* if we failed, lock is still active */
622 rte_spinlock_unlock(&heap->lock);
624 rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);