lib/librte_malloc/malloc_heap.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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 <stdlib.h>
  37 #include <stdio.h>
  38 #include <stdarg.h>
  39 #include <errno.h>
  40 #include <sys/queue.h>
  41
  42 #include <rte_memory.h>
  43 #include <rte_memzone.h>
  44 #include <rte_tailq.h>
  45 #include <rte_eal.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
  53 #include "malloc_elem.h"
  54 #include "malloc_heap.h"
  55
  56 #define QUOTE_(x) #x
  57 #define QUOTE(x) QUOTE_(x)
  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 QUOTE(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_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         return 0;
 108 }
 109
 110 /*
 111  * initialise a malloc heap object. The heap is locked with a private
 112  * lock while being initialised. This function should only be called the
 113  * first time a thread calls malloc - if even then, as heaps are per-socket
 114  * not per-thread.
 115  */
 116 static void
 117 malloc_heap_init(struct malloc_heap *heap)
 118 {
 119         static rte_spinlock_t init_lock = RTE_SPINLOCK_INITIALIZER;
 120         rte_spinlock_lock(&init_lock);
 121         if (!heap->initialised) {
 122                 heap->free_head = NULL;
 123                 heap->mz_count = 0;
 124                 heap->numa_socket = malloc_get_numa_socket();
 125                 rte_spinlock_init(&heap->lock);
 126                 heap->initialised = INITIALISED;
 127         }
 128         rte_spinlock_unlock(&init_lock);
 129 }
 130
 131 /*
 132  * Iterates through the freelist for a heap to find a free element
 133  * which can store data of the required size and with the requested alignment.
 134  * Returns null on failure, or pointer to element on success, with the pointer
 135  * to the previous element in the list, if any, being returned in a parameter
 136  * (to make removing the element from the free list faster).
 137  */
 138 static struct malloc_elem *
 139 find_suitable_element(struct malloc_heap *heap, size_t size,
 140                 unsigned align, struct malloc_elem **prev)
 141 {
 142         struct malloc_elem *elem = heap->free_head;
 143         *prev = NULL;
 144         while(elem){
 145                 if (malloc_elem_can_hold(elem, size, align))
 146                         break;
 147                 *prev = elem;
 148                 elem = elem->next_free;
 149         }
 150         return elem;
 151 }
 152
 153 /*
 154  * Main function called by malloc to allocate a block of memory from the
 155  * heap. It locks the free list, scans it, and adds a new memzone if the
 156  * scan fails. Once the new memzone is added, it re-scans and should return
 157  * the new element after releasing the lock.
 158  */
 159 void *
 160 malloc_heap_alloc(struct malloc_heap *heap,
 161                 const char *type __attribute__((unused)), size_t size, unsigned align)
 162 {
 163         if (!heap->initialised)
 164                 malloc_heap_init(heap);
 165
 166         size = CACHE_LINE_ROUNDUP(size);
 167         align = CACHE_LINE_ROUNDUP(align);
 168         rte_spinlock_lock(&heap->lock);
 169
 170         struct malloc_elem *prev, *elem = find_suitable_element(heap,
 171                         size, align, &prev);
 172         if (elem == NULL){
 173                 malloc_heap_add_memzone(heap, size, align);
 174                 elem = find_suitable_element(heap, size, align, &prev);
 175         }
 176         if (elem != NULL)
 177                 elem = malloc_elem_alloc(elem, size, align, prev);
 178         rte_spinlock_unlock(&heap->lock);
 179         return elem == NULL ? NULL : (void *)(&elem[1]);
 180 }