1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
11 #include <rte_memcpy.h>
12 #include <rte_memory.h>
14 #include <rte_eal_memconfig.h>
15 #include <rte_branch_prediction.h>
16 #include <rte_debug.h>
17 #include <rte_launch.h>
18 #include <rte_per_lcore.h>
19 #include <rte_lcore.h>
20 #include <rte_common.h>
21 #include <rte_spinlock.h>
23 #include <rte_malloc.h>
24 #include "malloc_elem.h"
25 #include "malloc_heap.h"
28 /* Free the memory space back to heap */
29 void rte_free(void *addr)
31 if (addr == NULL) return;
32 if (malloc_heap_free(malloc_elem_from_data(addr)) < 0)
33 RTE_LOG(ERR, EAL, "Error: Invalid memory\n");
37 * Allocate memory on specified heap.
40 rte_malloc_socket(const char *type, size_t size, unsigned int align,
43 /* return NULL if size is 0 or alignment is not power-of-2 */
44 if (size == 0 || (align && !rte_is_power_of_2(align)))
47 if (!rte_eal_has_hugepages())
48 socket_arg = SOCKET_ID_ANY;
50 return malloc_heap_alloc(type, size, socket_arg, 0,
51 align == 0 ? 1 : align, 0, false);
55 * Allocate memory on default heap.
58 rte_malloc(const char *type, size_t size, unsigned align)
60 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
64 * Allocate zero'd memory on specified heap.
67 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
69 return rte_malloc_socket(type, size, align, socket);
73 * Allocate zero'd memory on default heap.
76 rte_zmalloc(const char *type, size_t size, unsigned align)
78 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
82 * Allocate zero'd memory on specified heap.
85 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
87 return rte_zmalloc_socket(type, num * size, align, socket);
91 * Allocate zero'd memory on default heap.
94 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
96 return rte_zmalloc(type, num * size, align);
100 * Resize allocated memory.
103 rte_realloc(void *ptr, size_t size, unsigned align)
106 return rte_malloc(NULL, size, align);
108 struct malloc_elem *elem = malloc_elem_from_data(ptr);
110 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
114 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
115 /* check alignment matches first, and if ok, see if we can resize block */
116 if (RTE_PTR_ALIGN(ptr,align) == ptr &&
117 malloc_heap_resize(elem, size) == 0)
120 /* either alignment is off, or we have no room to expand,
122 void *new_ptr = rte_malloc(NULL, size, align);
125 const unsigned old_size = elem->size - MALLOC_ELEM_OVERHEAD;
126 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
133 rte_malloc_validate(const void *ptr, size_t *size)
135 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
136 if (!malloc_elem_cookies_ok(elem))
139 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
144 * Function to retrieve data for heap on given socket
147 rte_malloc_get_socket_stats(int socket,
148 struct rte_malloc_socket_stats *socket_stats)
150 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
151 int heap_idx, ret = -1;
153 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
155 heap_idx = malloc_socket_to_heap_id(socket);
159 ret = malloc_heap_get_stats(&mcfg->malloc_heaps[heap_idx],
162 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
168 * Function to dump contents of all heaps
170 void __rte_experimental
171 rte_malloc_dump_heaps(FILE *f)
173 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
176 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
178 for (idx = 0; idx < RTE_MAX_HEAPS; idx++) {
179 fprintf(f, "Heap id: %u\n", idx);
180 malloc_heap_dump(&mcfg->malloc_heaps[idx], f);
183 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
187 * Print stats on memory type. If type is NULL, info on all types is printed
190 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
192 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
193 unsigned int heap_id;
194 struct rte_malloc_socket_stats sock_stats;
196 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
198 /* Iterate through all initialised heaps */
199 for (heap_id = 0; heap_id < RTE_MAX_HEAPS; heap_id++) {
200 struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
202 malloc_heap_get_stats(heap, &sock_stats);
204 fprintf(f, "Heap id:%u\n", heap_id);
205 fprintf(f, "\tHeap name:%s\n", heap->name);
206 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
207 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
208 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
209 fprintf(f, "\tGreatest_free_size:%zu,\n",
210 sock_stats.greatest_free_size);
211 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
212 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
214 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
219 * TODO: Set limit to memory that can be allocated to memory type
222 rte_malloc_set_limit(__rte_unused const char *type,
223 __rte_unused size_t max)
229 * Return the IO address of a virtual address obtained through rte_malloc
232 rte_malloc_virt2iova(const void *addr)
234 const struct rte_memseg *ms;
235 struct malloc_elem *elem = malloc_elem_from_data(addr);
240 if (!elem->msl->external && rte_eal_iova_mode() == RTE_IOVA_VA)
241 return (uintptr_t) addr;
243 ms = rte_mem_virt2memseg(addr, elem->msl);
247 if (ms->iova == RTE_BAD_IOVA)
250 return ms->iova + RTE_PTR_DIFF(addr, ms->addr);