lib/librte_malloc/malloc_heap.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 block_size = get_malloc_memzone_size();
  82         /* ensure the data we want to allocate will fit in the memzone */
  83         const size_t min_size = size + align + MALLOC_ELEM_OVERHEAD * 2;
  84         const struct rte_memzone *mz = NULL;
  85         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
  86         unsigned numa_socket = heap - mcfg->malloc_heaps;
  87
  88         size_t mz_size = min_size;
  89         if (mz_size < block_size)
  90                 mz_size = block_size;
  91
  92         char mz_name[RTE_MEMZONE_NAMESIZE];
  93         rte_snprintf(mz_name, sizeof(mz_name), "MALLOC_S%u_HEAP_%u",
  94                      numa_socket, heap->mz_count++);
  95
  96         /* try getting a block. if we fail and we don't need as big a block
  97          * as given in the config, we can shrink our request and try again
  98          */
  99         do {
 100                 mz = rte_memzone_reserve(mz_name, mz_size, numa_socket,
 101                                          mz_flags);
 102                 if (mz == NULL)
 103                         mz_size /= 2;
 104         } while (mz == NULL && mz_size > min_size);
 105         if (mz == NULL)
 106                 return -1;
 107
 108         /* allocate the memory block headers, one at end, one at start */
 109         struct malloc_elem *start_elem = (struct malloc_elem *)mz->addr;
 110         struct malloc_elem *end_elem = RTE_PTR_ADD(mz->addr,
 111                         mz_size - MALLOC_ELEM_OVERHEAD);
 112         end_elem = RTE_PTR_ALIGN_FLOOR(end_elem, CACHE_LINE_SIZE);
 113
 114         const unsigned elem_size = (uintptr_t)end_elem - (uintptr_t)start_elem;
 115         malloc_elem_init(start_elem, heap, mz, elem_size);
 116         malloc_elem_mkend(end_elem, start_elem);
 117
 118         start_elem->next_free = heap->free_head;
 119         heap->free_head = start_elem;
 120         /* increase heap total size by size of new memzone */
 121         heap->total_size+=mz_size - MALLOC_ELEM_OVERHEAD;
 122         return 0;
 123 }
 124
 125 /*
 126  * initialise a malloc heap object. The heap is locked with a private
 127  * lock while being initialised. This function should only be called the
 128  * first time a thread calls malloc - if even then, as heaps are per-socket
 129  * not per-thread.
 130  */
 131 static void
 132 malloc_heap_init(struct malloc_heap *heap)
 133 {
 134         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 135
 136         rte_eal_mcfg_wait_complete(mcfg);
 137         while (heap->initialised != INITIALISED) {
 138                 if (rte_atomic32_cmpset(
 139                                 (volatile uint32_t*)&heap->initialised,
 140                                 NOT_INITIALISED, INITIALISING)) {
 141
 142                         heap->free_head = NULL;
 143                         heap->mz_count = 0;
 144                         heap->alloc_count = 0;
 145                         heap->total_size = 0;
 146                         rte_spinlock_init(&heap->lock);
 147                         heap->initialised = INITIALISED;
 148                 }
 149         }
 150 }
 151
 152 /*
 153  * Iterates through the freelist for a heap to find a free element
 154  * which can store data of the required size and with the requested alignment.
 155  * Returns null on failure, or pointer to element on success, with the pointer
 156  * to the previous element in the list, if any, being returned in a parameter
 157  * (to make removing the element from the free list faster).
 158  */
 159 static struct malloc_elem *
 160 find_suitable_element(struct malloc_heap *heap, size_t size,
 161                 unsigned align, struct malloc_elem **prev)
 162 {
 163         struct malloc_elem *elem, *min_elem, *min_prev;
 164         size_t min_sz;
 165
 166         elem = heap->free_head;
 167         min_elem = NULL;
 168         min_prev = NULL;
 169         min_sz = (size_t) SIZE_MAX;
 170         *prev = NULL;
 171
 172         while(elem){
 173                 if (malloc_elem_can_hold(elem, size, align)) {
 174                         if (min_sz > elem->size) {
 175                                 min_elem = elem;
 176                                 *prev = min_prev;
 177                                 min_sz = elem->size;
 178                         }
 179                 }
 180                 min_prev = elem;
 181                 elem = elem->next_free;
 182         }
 183         return (min_elem);
 184 }
 185
 186 /*
 187  * Main function called by malloc to allocate a block of memory from the
 188  * heap. It locks the free list, scans it, and adds a new memzone if the
 189  * scan fails. Once the new memzone is added, it re-scans and should return
 190  * the new element after releasing the lock.
 191  */
 192 void *
 193 malloc_heap_alloc(struct malloc_heap *heap,
 194                 const char *type __attribute__((unused)), size_t size, unsigned align)
 195 {
 196         if (!heap->initialised)
 197                 malloc_heap_init(heap);
 198
 199         size = CACHE_LINE_ROUNDUP(size);
 200         align = CACHE_LINE_ROUNDUP(align);
 201         rte_spinlock_lock(&heap->lock);
 202         struct malloc_elem *prev, *elem = find_suitable_element(heap,
 203                         size, align, &prev);
 204         if (elem == NULL){
 205                 if ((malloc_heap_add_memzone(heap, size, align)) == 0)
 206                         elem = find_suitable_element(heap, size, align, &prev);
 207         }
 208
 209         if (elem != NULL){
 210                 elem = malloc_elem_alloc(elem, size, align, prev);
 211                 /* increase heap's count of allocated elements */
 212                 heap->alloc_count++;
 213         }
 214         rte_spinlock_unlock(&heap->lock);
 215         return elem == NULL ? NULL : (void *)(&elem[1]);
 216
 217 }
 218
 219 /*
 220  * Function to retrieve data for heap on given socket
 221  */
 222 int
 223 malloc_heap_get_stats(const struct malloc_heap *heap,
 224                 struct rte_malloc_socket_stats *socket_stats)
 225 {
 226         if (!heap->initialised)
 227                 return -1;
 228
 229         struct malloc_elem *elem = heap->free_head;
 230
 231         /* Initialise variables for heap */
 232         socket_stats->free_count = 0;
 233         socket_stats->heap_freesz_bytes = 0;
 234         socket_stats->greatest_free_size = 0;
 235
 236         /* Iterate through free list */
 237         while(elem) {
 238                 socket_stats->free_count++;
 239                 socket_stats->heap_freesz_bytes += elem->size;
 240                 if (elem->size > socket_stats->greatest_free_size)
 241                         socket_stats->greatest_free_size = elem->size;
 242
 243                 elem = elem->next_free;
 244         }
 245         /* Get stats on overall heap and allocated memory on this heap */
 246         socket_stats->heap_totalsz_bytes = heap->total_size;
 247         socket_stats->heap_allocsz_bytes = (socket_stats->heap_totalsz_bytes -
 248                         socket_stats->heap_freesz_bytes);
 249         socket_stats->alloc_count = heap->alloc_count;
 250         return 0;
 251 }
 252