lib/librte_malloc/malloc_heap.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 #include <stdint.h>
  34 #include <stddef.h>
  35 #include <stdlib.h>
  36 #include <stdio.h>
  37 #include <stdarg.h>
  38 #include <errno.h>
  39 #include <sys/queue.h>
  40
  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_launch.h>
  47 #include <rte_per_lcore.h>
  48 #include <rte_lcore.h>
  49 #include <rte_common.h>
  50 #include <rte_string_fns.h>
  51 #include <rte_spinlock.h>
  52 #include <rte_memcpy.h>
  53 #include <rte_atomic.h>
  54
  55 #include "malloc_elem.h"
  56 #include "malloc_heap.h"
  57
  58 /* since the memzone size starts with a digit, it will appear unquoted in
  59  * rte_config.h, so quote it so it can be passed to rte_str_to_size */
  60 #define MALLOC_MEMZONE_SIZE RTE_STR(RTE_MALLOC_MEMZONE_SIZE)
  61
  62 /*
  63  * returns the configuration setting for the memzone size as a size_t value
  64  */
  65 static inline size_t
  66 get_malloc_memzone_size(void)
  67 {
  68         return rte_str_to_size(MALLOC_MEMZONE_SIZE);
  69 }
  70
  71 /*
  72  * reserve an extra memory zone and make it available for use by a particular
  73  * heap. This reserves the zone and sets a dummy malloc_elem header at the end
  74  * to prevent overflow. The rest of the zone is added to free list as a single
  75  * large free block
  76  */
  77 static int
  78 malloc_heap_add_memzone(struct malloc_heap *heap, size_t size, unsigned align)
  79 {
  80         const unsigned mz_flags = 0;
  81         const size_t min_size = get_malloc_memzone_size();
  82         /* ensure the data we want to allocate will fit in the memzone */
  83         size_t mz_size = size + align + MALLOC_ELEM_OVERHEAD * 2;
  84         if (mz_size < min_size)
  85                 mz_size = min_size;
  86
  87         char mz_name[RTE_MEMZONE_NAMESIZE];
  88         rte_snprintf(mz_name, sizeof(mz_name), "MALLOC_S%u_HEAP_%u",
  89                         heap->numa_socket, heap->mz_count++);
  90         const struct rte_memzone *mz = rte_memzone_reserve(mz_name, mz_size,
  91                         heap->numa_socket, mz_flags);
  92         if (mz == NULL)
  93                 return -1;
  94
  95         /* allocate the memory block headers, one at end, one at start */
  96         struct malloc_elem *start_elem = (struct malloc_elem *)mz->addr;
  97         struct malloc_elem *end_elem = RTE_PTR_ADD(mz->addr,
  98                         mz_size - MALLOC_ELEM_OVERHEAD);
  99         end_elem = RTE_PTR_ALIGN_FLOOR(end_elem, CACHE_LINE_SIZE);
 100
 101         const unsigned elem_size = (uintptr_t)end_elem - (uintptr_t)start_elem;
 102         malloc_elem_init(start_elem, heap, elem_size);
 103         malloc_elem_mkend(end_elem, start_elem);
 104
 105         start_elem->next_free = heap->free_head;
 106         heap->free_head = start_elem;
 107         /* increase heap total size by size of new memzone */
 108         heap->total_size+=mz_size - MALLOC_ELEM_OVERHEAD;
 109         return 0;
 110 }
 111
 112 /*
 113  * initialise a malloc heap object. The heap is locked with a private
 114  * lock while being initialised. This function should only be called the
 115  * first time a thread calls malloc - if even then, as heaps are per-socket
 116  * not per-thread.
 117  */
 118 static void
 119 malloc_heap_init(struct malloc_heap *heap)
 120 {
 121         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 122
 123         rte_eal_mcfg_wait_complete(mcfg);
 124         while (heap->initialised != INITIALISED) {
 125                 if (rte_atomic32_cmpset(
 126                                 (volatile uint32_t*)&heap->initialised,
 127                                 NOT_INITIALISED, INITIALISING)) {
 128
 129                         heap->free_head = NULL;
 130                         heap->mz_count = 0;
 131                         heap->alloc_count = 0;
 132                         heap->total_size = 0;
 133                         /*
 134                          * Find NUMA socket of heap that is being initialised, so that
 135                          * malloc_heaps[n].numa_socket == n
 136                          */
 137                         heap->numa_socket = heap - mcfg->malloc_heaps;
 138                         rte_spinlock_init(&heap->lock);
 139                         heap->initialised = INITIALISED;
 140                 }
 141         }
 142 }
 143
 144 /*
 145  * Iterates through the freelist for a heap to find a free element
 146  * which can store data of the required size and with the requested alignment.
 147  * Returns null on failure, or pointer to element on success, with the pointer
 148  * to the previous element in the list, if any, being returned in a parameter
 149  * (to make removing the element from the free list faster).
 150  */
 151 static struct malloc_elem *
 152 find_suitable_element(struct malloc_heap *heap, size_t size,
 153                 unsigned align, struct malloc_elem **prev)
 154 {
 155         struct malloc_elem *elem, *min_elem, *min_prev;
 156         size_t min_sz;
 157
 158         elem = heap->free_head;
 159         min_elem = NULL;
 160         min_prev = NULL;
 161         min_sz = (size_t) SIZE_MAX;
 162         *prev = NULL;
 163
 164         while(elem){
 165                 if (malloc_elem_can_hold(elem, size, align)) {
 166                         if (min_sz > elem->size) {
 167                                 min_elem = elem;
 168                                 *prev = min_prev;
 169                                 min_sz = elem->size;
 170                         }
 171                 }
 172                 min_prev = elem;
 173                 elem = elem->next_free;
 174         }
 175         return (min_elem);
 176 }
 177
 178 /*
 179  * Main function called by malloc to allocate a block of memory from the
 180  * heap. It locks the free list, scans it, and adds a new memzone if the
 181  * scan fails. Once the new memzone is added, it re-scans and should return
 182  * the new element after releasing the lock.
 183  */
 184 void *
 185 malloc_heap_alloc(struct malloc_heap *heap,
 186                 const char *type __attribute__((unused)), size_t size, unsigned align)
 187 {
 188         if (!heap->initialised)
 189                 malloc_heap_init(heap);
 190
 191         size = CACHE_LINE_ROUNDUP(size);
 192         align = CACHE_LINE_ROUNDUP(align);
 193         rte_spinlock_lock(&heap->lock);
 194         struct malloc_elem *prev, *elem = find_suitable_element(heap,
 195                         size, align, &prev);
 196         if (elem == NULL){
 197                 if ((malloc_heap_add_memzone(heap, size, align)) == 0)
 198                         elem = find_suitable_element(heap, size, align, &prev);
 199         }
 200
 201         if (elem != NULL){
 202                 elem = malloc_elem_alloc(elem, size, align, prev);
 203                 /* increase heap's count of allocated elements */
 204                 heap->alloc_count++;
 205         }
 206         rte_spinlock_unlock(&heap->lock);
 207         return elem == NULL ? NULL : (void *)(&elem[1]);
 208
 209 }
 210
 211 /*
 212  * Function to retrieve data for heap on given socket
 213  */
 214 int
 215 malloc_heap_get_stats(struct malloc_heap *heap,
 216                 struct rte_malloc_socket_stats *socket_stats)
 217 {
 218         if (!heap->initialised)
 219                 return -1;
 220
 221         struct malloc_elem *elem = heap->free_head;
 222
 223         /* Initialise variables for heap */
 224         socket_stats->free_count = 0;
 225         socket_stats->heap_freesz_bytes = 0;
 226         socket_stats->greatest_free_size = 0;
 227
 228         /* Iterate through free list */
 229         while(elem) {
 230                 socket_stats->free_count++;
 231                 socket_stats->heap_freesz_bytes += elem->size;
 232                 if (elem->size > socket_stats->greatest_free_size)
 233                         socket_stats->greatest_free_size = elem->size;
 234
 235                 elem = elem->next_free;
 236         }
 237         /* Get stats on overall heap and allocated memory on this heap */
 238         socket_stats->heap_totalsz_bytes = heap->total_size;
 239         socket_stats->heap_allocsz_bytes = (socket_stats->heap_totalsz_bytes -
 240                         socket_stats->heap_freesz_bytes);
 241         socket_stats->alloc_count = heap->alloc_count;
 242         return 0;
 243 }
 244