lib/librte_malloc/rte_malloc.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <stdint.h>
  35 #include <stddef.h>
  36 #include <stdio.h>
  37 #include <string.h>
  38 #include <sys/queue.h>
  39
  40 #include <rte_memcpy.h>
  41 #include <rte_memory.h>
  42 #include <rte_memzone.h>
  43 #include <rte_tailq.h>
  44 #include <rte_eal.h>
  45 #include <rte_eal_memconfig.h>
  46 #include <rte_branch_prediction.h>
  47 #include <rte_debug.h>
  48 #include <rte_launch.h>
  49 #include <rte_per_lcore.h>
  50 #include <rte_lcore.h>
  51 #include <rte_common.h>
  52 #include <rte_spinlock.h>
  53
  54 #include <rte_malloc.h>
  55 #include "malloc_elem.h"
  56 #include "malloc_heap.h"
  57
  58
  59 /* Free the memory space back to heap */
  60 void rte_free(void *addr)
  61 {
  62         if (addr == NULL) return;
  63         if (malloc_elem_free(malloc_elem_from_data(addr)) < 0)
  64                 rte_panic("Fatal error: Invalid memory\n");
  65 }
  66
  67 /*
  68  * Allocate memory on specified heap.
  69  */
  70 void *
  71 rte_malloc_socket(const char *type, size_t size, unsigned align, int socket)
  72 {
  73         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
  74
  75         /* return NULL if size is 0 or alignment is not power-of-2 */
  76         if (size == 0 || !rte_is_power_of_2(align))
  77                 return NULL;
  78
  79         if (socket == SOCKET_ID_ANY)
  80                 socket = malloc_get_numa_socket();
  81
  82         /* Check socket parameter */
  83         if (socket >= RTE_MAX_NUMA_NODES)
  84                 return NULL;
  85
  86         return malloc_heap_alloc(&mcfg->malloc_heaps[socket], type,
  87                         size, align == 0 ? 1 : align);
  88 }
  89
  90 /*
  91  * Allocate memory on default heap.
  92  */
  93 void *
  94 rte_malloc(const char *type, size_t size, unsigned align)
  95 {
  96         return rte_malloc_socket(type, size, align, SOCKET_ID_ANY);
  97 }
  98
  99 /*
 100  * Allocate zero'd memory on specified heap.
 101  */
 102 void *
 103 rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket)
 104 {
 105         void *ptr = rte_malloc_socket(type, size, align, socket);
 106
 107         if (ptr != NULL)
 108                 memset(ptr, 0, size);
 109         return ptr;
 110 }
 111
 112 /*
 113  * Allocate zero'd memory on default heap.
 114  */
 115 void *
 116 rte_zmalloc(const char *type, size_t size, unsigned align)
 117 {
 118         return rte_zmalloc_socket(type, size, align, SOCKET_ID_ANY);
 119 }
 120
 121 /*
 122  * Allocate zero'd memory on specified heap.
 123  */
 124 void *
 125 rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket)
 126 {
 127         return rte_zmalloc_socket(type, num * size, align, socket);
 128 }
 129
 130 /*
 131  * Allocate zero'd memory on default heap.
 132  */
 133 void *
 134 rte_calloc(const char *type, size_t num, size_t size, unsigned align)
 135 {
 136         return rte_zmalloc(type, num * size, align);
 137 }
 138
 139 /*
 140  * Resize allocated memory.
 141  */
 142 void *
 143 rte_realloc(void *ptr, size_t size, unsigned align)
 144 {
 145         if (ptr == NULL)
 146                 return rte_malloc(NULL, size, align);
 147
 148         struct malloc_elem *elem = malloc_elem_from_data(ptr);
 149         if (elem == NULL)
 150                 rte_panic("Fatal error: memory corruption detected\n");
 151
 152         size = CACHE_LINE_ROUNDUP(size), align = CACHE_LINE_ROUNDUP(align);
 153         /* check alignment matches first, and if ok, see if we can resize block */
 154         if (RTE_PTR_ALIGN(ptr,align) == ptr &&
 155                         malloc_elem_resize(elem, size) == 0)
 156                 return ptr;
 157
 158         /* either alignment is off, or we have no room to expand,
 159          * so move data. */
 160         void *new_ptr = rte_malloc(NULL, size, align);
 161         if (new_ptr == NULL)
 162                 return NULL;
 163         const unsigned old_size = elem->size - MALLOC_ELEM_OVERHEAD;
 164         rte_memcpy(new_ptr, ptr, old_size < size ? old_size : size);
 165         rte_free(ptr);
 166
 167         return new_ptr;
 168 }
 169
 170 int
 171 rte_malloc_validate(void *ptr, size_t *size)
 172 {
 173         struct malloc_elem *elem = malloc_elem_from_data(ptr);
 174         if (!malloc_elem_cookies_ok(elem))
 175                 return -1;
 176         if (size != NULL)
 177                 *size = elem->size - elem->pad - MALLOC_ELEM_OVERHEAD;
 178         return 0;
 179 }
 180
 181 /*
 182  * Function to retrieve data for heap on given socket
 183  */
 184 int
 185 rte_malloc_get_socket_stats(int socket,
 186                 struct rte_malloc_socket_stats *socket_stats)
 187 {
 188         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 189
 190         if (socket >= RTE_MAX_NUMA_NODES || socket < 0)
 191                 return -1;
 192
 193         return malloc_heap_get_stats(&mcfg->malloc_heaps[socket], socket_stats);
 194 }
 195
 196 /*
 197  * Print stats on memory type. If type is NULL, info on all types is printed
 198  */
 199 void
 200 rte_malloc_dump_stats(__rte_unused const char *type)
 201 {
 202         unsigned int socket;
 203         struct rte_malloc_socket_stats sock_stats;
 204         /* Iterate through all initialised heaps */
 205         for (socket=0; socket< RTE_MAX_NUMA_NODES; socket++) {
 206                 if ((rte_malloc_get_socket_stats(socket, &sock_stats) < 0))
 207                         continue;
 208
 209                 printf("Socket:%u\n", socket);
 210                 printf("\tHeap_size:%zu,\n", sock_stats.heap_totalsz_bytes);
 211                 printf("\tFree_size:%zu,\n", sock_stats.heap_freesz_bytes);
 212                 printf("\tAlloc_size:%zu,\n", sock_stats.heap_allocsz_bytes);
 213                 printf("\tGreatest_free_size:%zu,\n",
 214                                 sock_stats.greatest_free_size);
 215                 printf("\tAlloc_count:%u,\n",sock_stats.alloc_count);
 216                 printf("\tFree_count:%u,\n", sock_stats.free_count);
 217         }
 218         return;
 219 }
 220
 221 /*
 222  * TODO: Set limit to memory that can be allocated to memory type
 223  */
 224 int
 225 rte_malloc_set_limit(__rte_unused const char *type,
 226                 __rte_unused size_t max)
 227 {
 228         return 0;
 229 }