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 align, int socket_arg)
42 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
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 (!rte_eal_has_hugepages())
51 socket_arg = SOCKET_ID_ANY;
53 if (socket_arg == SOCKET_ID_ANY)
54 socket = malloc_get_numa_socket();
58 /* Check socket parameter */
59 if (socket >= RTE_MAX_NUMA_NODES)
62 ret = malloc_heap_alloc(&mcfg->malloc_heaps[socket], type,
63 size, 0, align == 0 ? 1 : align, 0);
64 if (ret != NULL || socket_arg != SOCKET_ID_ANY)
68 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
69 /* we already tried this one */
73 ret = malloc_heap_alloc(&mcfg->malloc_heaps[i], type,
74 size, 0, align == 0 ? 1 : align, 0);
83 * Allocate memory on default heap.
86 rte_malloc(const char *type, size_t size, unsigned align)
88 return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
92 * Allocate zero'd memory on specified heap.
95 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
97 return rte_malloc_socket(type, size, align, socket);
101 * Allocate zero'd memory on default heap.
104 rte_zmalloc(const char *type, size_t size, unsigned align)
106 return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
110 * Allocate zero'd memory on specified heap.
113 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
115 return rte_zmalloc_socket(type, num * size, align, socket);
119 * Allocate zero'd memory on default heap.
122 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
124 return rte_zmalloc(type, num * size, align);
128 * Resize allocated memory.
131 rte_realloc(void *ptr, size_t size, unsigned align)
134 return rte_malloc(NULL, size, align);
136 struct malloc_elem *elem = malloc_elem_from_data(ptr);
138 RTE_LOG(ERR, EAL, "Error: memory corruption detected\n");
142 size = RTE_CACHE_LINE_ROUNDUP(size), align = RTE_CACHE_LINE_ROUNDUP(align);
143 /* check alignment matches first, and if ok, see if we can resize block */
144 if (RTE_PTR_ALIGN(ptr,align) == ptr &&
145 malloc_heap_resize(elem, size) == 0)
148 /* either alignment is off, or we have no room to expand,
150 void *new_ptr = rte_malloc(NULL, size, align);
153 const unsigned old_size = elem->size - MALLOC_ELEM_OVERHEAD;
154 rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
161 rte_malloc_validate(const void *ptr, size_t *size)
163 const struct malloc_elem *elem = malloc_elem_from_data(ptr);
164 if (!malloc_elem_cookies_ok(elem))
167 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
172 * Function to retrieve data for heap on given socket
175 rte_malloc_get_socket_stats(int socket,
176 struct rte_malloc_socket_stats *socket_stats)
178 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
180 if (socket >= RTE_MAX_NUMA_NODES || socket < 0)
183 return malloc_heap_get_stats(&mcfg->malloc_heaps[socket], socket_stats);
187 * Function to dump contents of all heaps
189 void __rte_experimental
190 rte_malloc_dump_heaps(FILE *f)
192 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
195 for (idx = 0; idx < rte_socket_count(); idx++) {
196 unsigned int socket = rte_socket_id_by_idx(idx);
197 fprintf(f, "Heap on socket %i:\n", socket);
198 malloc_heap_dump(&mcfg->malloc_heaps[socket], f);
204 * Print stats on memory type. If type is NULL, info on all types is printed
207 rte_malloc_dump_stats(FILE *f, __rte_unused const char *type)
210 struct rte_malloc_socket_stats sock_stats;
211 /* Iterate through all initialised heaps */
212 for (socket=0; socket< RTE_MAX_NUMA_NODES; socket++) {
213 if ((rte_malloc_get_socket_stats(socket, &sock_stats) < 0))
216 fprintf(f, "Socket:%u\n", socket);
217 fprintf(f, "\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
218 fprintf(f, "\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
219 fprintf(f, "\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
220 fprintf(f, "\tGreatest_free_size:%zu,\n",
221 sock_stats.greatest_free_size);
222 fprintf(f, "\tAlloc_count:%u,\n",sock_stats.alloc_count);
223 fprintf(f, "\tFree_count:%u,\n", sock_stats.free_count);
229 * TODO: Set limit to memory that can be allocated to memory type
232 rte_malloc_set_limit(__rte_unused const char *type,
233 __rte_unused size_t max)
239 * Return the IO address of a virtual address obtained through rte_malloc
242 rte_malloc_virt2iova(const void *addr)
245 const struct malloc_elem *elem = malloc_elem_from_data(addr);
248 if (elem->ms->iova == RTE_BAD_IOVA)
251 if (rte_eal_iova_mode() == RTE_IOVA_VA)
252 iova = (uintptr_t)addr;
254 iova = elem->ms->iova +
255 RTE_PTR_DIFF(addr, elem->ms->addr);