lib/memory.c

   1 /*
   2  * Copyright (c) 2015-16  David Lamparter, for NetDEF, Inc.
   3  *
   4  * Permission to use, copy, modify, and distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #include <zebra.h>
  18
  19 #include <stdlib.h>
  20 #ifdef HAVE_MALLOC_H
  21 #include <malloc.h>
  22 #endif
  23 #ifdef HAVE_MALLOC_NP_H
  24 #include <malloc_np.h>
  25 #endif
  26 #ifdef HAVE_MALLOC_MALLOC_H
  27 #include <malloc/malloc.h>
  28 #endif
  29
  30 #include "memory.h"
  31 #include "log.h"
  32
  33 static struct memgroup *mg_first = NULL;
  34 struct memgroup **mg_insert = &mg_first;
  35
  36 DEFINE_MGROUP(LIB, "libfrr")
  37 DEFINE_MTYPE(LIB, TMP, "Temporary memory")
  38
  39 static inline void mt_count_alloc(struct memtype *mt, size_t size, void *ptr)
  40 {
  41         size_t current;
  42         size_t oldsize;
  43
  44         current = 1 + atomic_fetch_add_explicit(&mt->n_alloc, 1,
  45                                                 memory_order_relaxed);
  46
  47         oldsize = atomic_load_explicit(&mt->n_max, memory_order_relaxed);
  48         if (current > oldsize)
  49                 /* note that this may fail, but approximation is sufficient */
  50                 atomic_compare_exchange_weak_explicit(&mt->n_max, &oldsize,
  51                                                       current,
  52                                                       memory_order_relaxed,
  53                                                       memory_order_relaxed);
  54
  55         oldsize = atomic_load_explicit(&mt->size, memory_order_relaxed);
  56         if (oldsize == 0)
  57                 oldsize = atomic_exchange_explicit(&mt->size, size,
  58                                                    memory_order_relaxed);
  59         if (oldsize != 0 && oldsize != size && oldsize != SIZE_VAR)
  60                 atomic_store_explicit(&mt->size, SIZE_VAR,
  61                                       memory_order_relaxed);
  62
  63 #ifdef HAVE_MALLOC_USABLE_SIZE
  64         size_t mallocsz = malloc_usable_size(ptr);
  65
  66         current = mallocsz + atomic_fetch_add_explicit(&mt->total, mallocsz,
  67                                                        memory_order_relaxed);
  68         oldsize = atomic_load_explicit(&mt->max_size, memory_order_relaxed);
  69         if (current > oldsize)
  70                 /* note that this may fail, but approximation is sufficient */
  71                 atomic_compare_exchange_weak_explicit(&mt->max_size, &oldsize,
  72                                                       current,
  73                                                       memory_order_relaxed,
  74                                                       memory_order_relaxed);
  75 #endif
  76 }
  77
  78 static inline void mt_count_free(struct memtype *mt, void *ptr)
  79 {
  80         assert(mt->n_alloc);
  81         atomic_fetch_sub_explicit(&mt->n_alloc, 1, memory_order_relaxed);
  82
  83 #ifdef HAVE_MALLOC_USABLE_SIZE
  84         size_t mallocsz = malloc_usable_size(ptr);
  85
  86         atomic_fetch_sub_explicit(&mt->total, mallocsz, memory_order_relaxed);
  87 #endif
  88 }
  89
  90 static inline void *mt_checkalloc(struct memtype *mt, void *ptr, size_t size)
  91 {
  92         if (__builtin_expect(ptr == NULL, 0)) {
  93                 if (size) {
  94                         /* malloc(0) is allowed to return NULL */
  95                         memory_oom(size, mt->name);
  96                 }
  97                 return NULL;
  98         }
  99         mt_count_alloc(mt, size, ptr);
 100         return ptr;
 101 }
 102
 103 void *qmalloc(struct memtype *mt, size_t size)
 104 {
 105         return mt_checkalloc(mt, malloc(size), size);
 106 }
 107
 108 void *qcalloc(struct memtype *mt, size_t size)
 109 {
 110         return mt_checkalloc(mt, calloc(size, 1), size);
 111 }
 112
 113 void *qrealloc(struct memtype *mt, void *ptr, size_t size)
 114 {
 115         if (ptr)
 116                 mt_count_free(mt, ptr);
 117         return mt_checkalloc(mt, ptr ? realloc(ptr, size) : malloc(size), size);
 118 }
 119
 120 void *qstrdup(struct memtype *mt, const char *str)
 121 {
 122         return str ? mt_checkalloc(mt, strdup(str), strlen(str) + 1) : NULL;
 123 }
 124
 125 void qfree(struct memtype *mt, void *ptr)
 126 {
 127         if (ptr)
 128                 mt_count_free(mt, ptr);
 129         free(ptr);
 130 }
 131
 132 int qmem_walk(qmem_walk_fn *func, void *arg)
 133 {
 134         struct memgroup *mg;
 135         struct memtype *mt;
 136         int rv;
 137
 138         for (mg = mg_first; mg; mg = mg->next) {
 139                 if ((rv = func(arg, mg, NULL)))
 140                         return rv;
 141                 for (mt = mg->types; mt; mt = mt->next)
 142                         if ((rv = func(arg, mg, mt)))
 143                                 return rv;
 144         }
 145         return 0;
 146 }
 147
 148 struct exit_dump_args {
 149         FILE *fp;
 150         const char *prefix;
 151         int error;
 152 };
 153
 154 static int qmem_exit_walker(void *arg, struct memgroup *mg, struct memtype *mt)
 155 {
 156         struct exit_dump_args *eda = arg;
 157
 158         if (!mt) {
 159                 fprintf(eda->fp,
 160                         "%s: showing active allocations in "
 161                         "memory group %s\n",
 162                         eda->prefix, mg->name);
 163
 164         } else if (mt->n_alloc) {
 165                 char size[32];
 166                 eda->error++;
 167                 snprintf(size, sizeof(size), "%10zu", mt->size);
 168                 fprintf(eda->fp, "%s: memstats:  %-30s: %6zu * %s\n",
 169                         eda->prefix, mt->name, mt->n_alloc,
 170                         mt->size == SIZE_VAR ? "(variably sized)" : size);
 171         }
 172         return 0;
 173 }
 174
 175 int log_memstats(FILE *fp, const char *prefix)
 176 {
 177         struct exit_dump_args eda = {.fp = fp, .prefix = prefix, .error = 0};
 178         qmem_walk(qmem_exit_walker, &eda);
 179         return eda.error;
 180 }