lib/ecoli_malloc.h

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef ECOLI_MALLOC_
  29 #define ECOLI_MALLOC_
  30
  31 #include <sys/types.h>
  32
  33 typedef void *(*ec_malloc_t)(size_t size);
  34 typedef void (*ec_free_t)(void *ptr);
  35 typedef void *(*ec_realloc_t)(void *ptr, size_t size);
  36
  37 struct ec_malloc_handler {
  38         ec_malloc_t malloc;
  39         ec_free_t free;
  40         ec_realloc_t realloc;
  41 };
  42
  43 extern struct ec_malloc_handler ec_malloc_handler;
  44
  45 int ec_malloc_register(ec_malloc_t usr_malloc, ec_free_t usr_free,
  46         ec_realloc_t usr_realloc);
  47
  48 /* internal */
  49 void *__ec_malloc(size_t size);
  50 void __ec_free(void *ptr);
  51 void *__ec_calloc(size_t nmemb, size_t size);
  52 void *__ec_realloc(void *ptr, size_t size);
  53 char *__ec_strdup(const char *s);
  54 char *__ec_strndup(const char *s, size_t n);
  55
  56 /* we use macros here to ensure the file/line stay correct when
  57  * debugging the standard malloc with valgrind */
  58
  59 #define ec_malloc(sz) ({                                \
  60         void *ret_;                                     \
  61         if (ec_malloc_handler.malloc == NULL)           \
  62                 ret_ = malloc(sz);                      \
  63         else                                            \
  64                 ret_ = __ec_malloc(sz);                 \
  65         ret_;                                           \
  66         })
  67
  68 #define ec_free(ptr) ({                                 \
  69         if (ec_malloc_handler.free == NULL)             \
  70                 free(ptr);                              \
  71         else                                            \
  72                 __ec_free(ptr);                         \
  73         })
  74
  75 #define ec_realloc(ptr, sz) ({                          \
  76         void *ret_;                                     \
  77         if (ec_malloc_handler.realloc == NULL)          \
  78                 ret_ = realloc(ptr, sz);                \
  79         else                                            \
  80                 ret_ = __ec_realloc(ptr, sz);           \
  81         ret_;                                           \
  82         })
  83
  84 #define ec_calloc(n, sz) ({                             \
  85         void *ret_;                                     \
  86         if (ec_malloc_handler.malloc == NULL)           \
  87                 ret_ = calloc(n, sz);                   \
  88         else                                            \
  89                 ret_ = __ec_calloc(n, sz);              \
  90         ret_;                                           \
  91         })
  92
  93 #define ec_strdup(s) ({                                 \
  94         void *ret_;                                     \
  95         if (ec_malloc_handler.malloc == NULL)           \
  96                 ret_ = strdup(s);                       \
  97         else                                            \
  98                 ret_ = __ec_strdup(s);                  \
  99         ret_;                                           \
 100         })
 101
 102 #define ec_strndup(s, n) ({                             \
 103         void *ret_;                                     \
 104         if (ec_malloc_handler.malloc == NULL)           \
 105                 ret_ = strndup(s, n);                   \
 106         else                                            \
 107                 ret_ = __ec_strndup(s, n);              \
 108         ret_;                                           \
 109         })
 110
 111
 112 #endif