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 return rte_malloc_socket(type, size, align, socket);
81 * Allocate zero'd memory on default heap.
84 rte_zmalloc(const char *type, size_t size, unsigned align)
86 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
90 * Allocate zero'd memory on specified heap.
93 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
95 return rte_zmalloc_socket(type, num * size, align, socket);
99 * Allocate zero'd memory on default heap.
102 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
104 return rte_zmalloc(type, num * size, align);
108 * Resize allocated memory on specified heap.
111 rte_realloc_socket(void *ptr, size_t size, unsigned int align, int socket)
114 return rte_malloc_socket(NULL, size, align, socket);
116 struct malloc_elem *elem = malloc_elem_from_data(ptr);
118 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
122 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
124 /* check requested socket id and alignment matches first, and if ok,
125 * see if we can resize block
127 if ((socket == SOCKET_ID_ANY ||
128 (unsigned int)socket == elem->heap->socket_id) &&
129 RTE_PTR_ALIGN(ptr, align) == ptr &&
130 malloc_heap_resize(elem, size) == 0)
133 /* either requested socket id doesn't match, alignment is off
134 * or we have no room to expand,
137 void *new_ptr = rte_malloc_socket(NULL, size, align, socket);
140 const unsigned old_size = elem->size - MALLOC_ELEM_OVERHEAD;
141 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
148 * Resize allocated memory.
151 rte_realloc(void *ptr, size_t size, unsigned int align)
153 return rte_realloc_socket(ptr, size, align, SOCKET_ID_ANY);
157 rte_malloc_validate(const void *ptr, size_t *size)
159 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
160 if (!malloc_elem_cookies_ok(elem))
163 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
168 * Function to retrieve data for heap on given socket
171 rte_malloc_get_socket_stats(int socket,
172 struct rte_malloc_socket_stats *socket_stats)
174 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
177 heap_idx = malloc_socket_to_heap_id(socket);
181 return malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
186 * Function to dump contents of all heaps
188 void __rte_experimental
189 rte_malloc_dump_heaps(FILE *f)
191 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
194 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
195 fprintf(f, "Heap id: %u\n", idx);
196 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
201 rte_malloc_heap_get_socket(const char *name)
203 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
204 struct malloc_heap *heap = NULL;
209 strnlen(name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
210 strnlen(name, RTE_HEAP_NAME_MAX_LEN) ==
211 RTE_HEAP_NAME_MAX_LEN) {
215 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
216 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
217 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
219 if (!strncmp(name, tmp->name, RTE_HEAP_NAME_MAX_LEN)) {
226 ret = heap->socket_id;
231 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
237 rte_malloc_heap_socket_is_external(int socket_id)
239 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
243 if (socket_id == SOCKET_ID_ANY)
246 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
247 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
248 struct malloc_heap *tmp = &mcfg->malloc_heaps[idx];
250 if ((int)tmp->socket_id == socket_id) {
251 /* external memory always has large socket ID's */
252 ret = tmp->socket_id >= RTE_MAX_NUMA_NODES;
256 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
262 * Print stats on memory type. If type is NULL, info on all types is printed
265 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
267 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
268 unsigned int heap_id;
269 struct rte_malloc_socket_stats sock_stats;
271 /* Iterate through all initialised heaps */
272 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
273 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
275 malloc_heap_get_stats(heap, &sock_stats);
277 fprintf(f, "Heap id:%u\n", heap_id);
278 fprintf(f, "\tHeap name:%s\n", heap->name);
279 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
280 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
281 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
282 fprintf(f, "\tGreatest_free_size:%zu,\n",
283 sock_stats.greatest_free_size);
284 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
285 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
291 * TODO: Set limit to memory that can be allocated to memory type
294 rte_malloc_set_limit(__rte_unused const char *type,
295 __rte_unused size_t max)
301 * Return the IO address of a virtual address obtained through rte_malloc
304 rte_malloc_virt2iova(const void *addr)
306 const struct rte_memseg *ms;
307 struct malloc_elem *elem = malloc_elem_from_data(addr);
312 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
313 return (uintptr_t) addr;
315 ms = rte_mem_virt2memseg(addr, elem->msl);
319 if (ms->iova == RTE_BAD_IOVA)
322 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);
325 static struct malloc_heap *
326 find_named_heap(const char *name)
328 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
331 for (i = 0; i < RTE_MAX_HEAPS; i++) {
332 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
334 if (!strncmp(name, heap->name, RTE_HEAP_NAME_MAX_LEN))
341 rte_malloc_heap_memory_add(const char *heap_name, void *va_addr, size_t len,
342 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
344 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
345 struct malloc_heap *heap = NULL;
346 struct rte_memseg_list *msl;
350 if (heap_name == NULL || va_addr == NULL ||
351 page_sz == 0 || !rte_is_power_of_2(page_sz) ||
352 RTE_ALIGN(len, page_sz) != len ||
353 !rte_is_aligned(va_addr, page_sz) ||
354 ((len / page_sz) != n_pages && iova_addrs != NULL) ||
355 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
356 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
357 RTE_HEAP_NAME_MAX_LEN) {
361 rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
364 heap = find_named_heap(heap_name);
370 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
371 /* cannot add memory to internal heaps */
378 msl = malloc_heap_create_external_seg(va_addr, iova_addrs, n, page_sz,
379 heap_name, heap->socket_id);
385 rte_spinlock_lock(&heap->lock);
386 ret = malloc_heap_add_external_memory(heap, msl);
387 rte_spinlock_unlock(&heap->lock);
390 rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
396 rte_malloc_heap_memory_remove(const char *heap_name, void *va_addr, size_t len)
398 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
399 struct malloc_heap *heap = NULL;
400 struct rte_memseg_list *msl;
403 if (heap_name == NULL || va_addr == NULL || len == 0 ||
404 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
405 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
406 RTE_HEAP_NAME_MAX_LEN) {
410 rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
412 heap = find_named_heap(heap_name);
418 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
419 /* cannot remove memory from internal heaps */
425 msl = malloc_heap_find_external_seg(va_addr, len);
431 rte_spinlock_lock(&heap->lock);
432 ret = malloc_heap_remove_external_memory(heap, va_addr, len);
433 rte_spinlock_unlock(&heap->lock);
437 ret = malloc_heap_destroy_external_seg(msl);
440 rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
446 sync_memory(const char *heap_name, void *va_addr, size_t len, bool attach)
448 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
449 struct malloc_heap *heap = NULL;
450 struct rte_memseg_list *msl;
453 if (heap_name == NULL || va_addr == NULL || len == 0 ||
454 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
455 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
456 RTE_HEAP_NAME_MAX_LEN) {
460 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
463 heap = find_named_heap(heap_name);
469 /* we shouldn't be able to sync to internal heaps */
470 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
476 /* find corresponding memseg list to sync to */
477 msl = malloc_heap_find_external_seg(va_addr, len);
484 ret = rte_fbarray_attach(&msl->memseg_arr);
486 /* notify all subscribers that a new memory area was
489 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
496 /* notify all subscribers that a memory area is about to
499 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
500 msl->base_va, msl->len);
501 ret = rte_fbarray_detach(&msl->memseg_arr);
508 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
513 rte_malloc_heap_memory_attach(const char *heap_name, void *va_addr, size_t len)
515 return sync_memory(heap_name, va_addr, len, true);
519 rte_malloc_heap_memory_detach(const char *heap_name, void *va_addr, size_t len)
521 return sync_memory(heap_name, va_addr, len, false);
525 rte_malloc_heap_create(const char *heap_name)
527 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
528 struct malloc_heap *heap = NULL;
531 if (heap_name == NULL ||
532 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
533 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
534 RTE_HEAP_NAME_MAX_LEN) {
538 /* check if there is space in the heap list, or if heap with this name
541 rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
543 for (i = 0; i < RTE_MAX_HEAPS; i++) {
544 struct malloc_heap *tmp = &mcfg->malloc_heaps[i];
546 if (strncmp(heap_name, tmp->name,
547 RTE_HEAP_NAME_MAX_LEN) == 0) {
548 RTE_LOG(ERR, EAL, "Heap %s already exists\n",
555 if (strnlen(tmp->name, RTE_HEAP_NAME_MAX_LEN) == 0) {
561 RTE_LOG(ERR, EAL, "Cannot create new heap: no space\n");
567 /* we're sure that we can create a new heap, so do it */
568 ret = malloc_heap_create(heap, heap_name);
570 rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
576 rte_malloc_heap_destroy(const char *heap_name)
578 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
579 struct malloc_heap *heap = NULL;
582 if (heap_name == NULL ||
583 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) == 0 ||
584 strnlen(heap_name, RTE_HEAP_NAME_MAX_LEN) ==
585 RTE_HEAP_NAME_MAX_LEN) {
589 rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
591 /* start from non-socket heaps */
592 heap = find_named_heap(heap_name);
594 RTE_LOG(ERR, EAL, "Heap %s not found\n", heap_name);
599 /* we shouldn't be able to destroy internal heaps */
600 if (heap->socket_id < RTE_MAX_NUMA_NODES) {
605 /* sanity checks done, now we can destroy the heap */
606 rte_spinlock_lock(&heap->lock);
607 ret = malloc_heap_destroy(heap);
609 /* if we failed, lock is still active */
611 rte_spinlock_unlock(&heap->lock);
613 rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);