common/mem.h

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  10 /*  1. Redistributions of source code must retain the above copyright         */
  11 /*     notice, this list of conditions and the following disclaimer.          */
  12 /*  2. Redistributions in binary form must reproduce the above copyright      */
  13 /*     notice, this list of conditions and the following disclaimer in the    */
  14 /*     documentation and/or other materials provided with the distribution.   */
  15 /*  3. The names of its contributors may not be used to endorse or promote    */
  16 /*     products derived from this software without specific prior written     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  19 /*  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND   */
  20 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     */
  21 /*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR        */
  22 /*  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS    */
  23 /*  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR    */
  24 /*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF      */
  25 /*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  */
  26 /*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN   */
  27 /*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)   */
  28 /*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF    */
  29 /*  THE POSSIBILITY OF SUCH DAMAGE.                                           */
  30 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2006 Pierre Habouzit
  34  */
  35
  36 #ifndef PFIXTOOLS_MEM_H
  37 #define PFIXTOOLS_MEM_H
  38
  39 #include <assert.h>
  40 #include <ctype.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43
  44 #define MIN(a, b)               ((a) < (b) ? (a) : (b))
  45 #define MAX(a, b)               ((a) > (b) ? (a) : (b))
  46
  47 #define ssizeof(foo)            (ssize_t)sizeof(foo)
  48 #define countof(foo)            (ssizeof(foo) / ssizeof(foo[0]))
  49
  50 #define p_new(type, count)      ((type *)xmalloc(sizeof(type) * (count)))
  51 #define p_clear(p, count)       ((void)memset((p), 0, sizeof(*(p)) * (count)))
  52 #define p_dup(p, count)         xmemdup((p), sizeof(*(p)) * (count))
  53 #define p_dupstr(p, len)        xmemdupstr((p), (len))
  54 #define p_realloc(pp, count)    xrealloc((void*)(pp), sizeof(**(pp)) * (count))
  55
  56 #  define p_shrink(pp, goalnb, allocnb)           \
  57     do {                                          \
  58         if (*(allocnb) > (goalnb)) {              \
  59             p_realloc(pp, (goalnb));              \
  60             *(allocnb) = (goalnb);                \
  61         }                                         \
  62     } while(0)
  63
  64 #  define p_alloc_nr(x) (((x) + 16) * 3 / 2)
  65 #  define p_allocgrow(pp, goalnb, allocnb)                  \
  66     do {                                                    \
  67         if ((goalnb) > *(allocnb)) {                        \
  68             if (p_alloc_nr(goalnb) > *(allocnb)) {          \
  69                 *(allocnb) = (goalnb);                      \
  70             } else {                                        \
  71                 *(allocnb) = p_alloc_nr(goalnb);            \
  72             }                                               \
  73             p_realloc(pp, *(allocnb));                      \
  74         }                                                   \
  75     } while (0)
  76
  77 #ifdef __GNUC__
  78
  79 #  define p_delete(mem_pp)                          \
  80         do {                                        \
  81             typeof(**(mem_pp)) **__ptr = (mem_pp);  \
  82             free(*__ptr);                           \
  83             *__ptr = NULL;                          \
  84         } while(0)
  85
  86 #else
  87
  88 #  define p_delete(mem_p)                           \
  89         do {                                        \
  90             void *__ptr = (mem_p);                  \
  91             free(*__ptr);                           \
  92             *(void **)__ptr = NULL;                 \
  93         } while (0)
  94
  95 #endif
  96
  97 static inline void *xmalloc(ssize_t size) {
  98     void *mem;
  99
 100     if (size <= 0)
 101         return NULL;
 102
 103     mem = calloc(size, 1);
 104     if (!mem)
 105         abort();
 106     return mem;
 107 }
 108
 109 static inline void xmemfree(void **ptr) {
 110     p_delete(ptr);
 111 }
 112
 113 static inline void xrealloc(void **ptr, ssize_t newsize) {
 114     if (newsize <= 0) {
 115         p_delete(ptr);
 116     } else {
 117         *ptr = realloc(*ptr, newsize);
 118         if (!*ptr)
 119             abort();
 120     }
 121 }
 122
 123 static inline void *xmemdup(const void *src, ssize_t size) {
 124     return memcpy(xmalloc(size), src, size);
 125 }
 126
 127 static inline void *xmemdupstr(const void *src, ssize_t len) {
 128     char *res = memcpy(xmalloc(len + 1), src, len);
 129     res[len] = '\0';
 130     return res;
 131 }
 132
 133
 134 #define DO_INIT(type, prefix) \
 135     static inline type * prefix##_init(type *var) {         \
 136         p_clear(var, 1);                                    \
 137         return var;                                         \
 138     }
 139 #define DO_WIPE(type, prefix) \
 140     static inline void prefix##_wipe(type *var __attribute__((unused))) { }
 141
 142 #define DO_NEW(type, prefix) \
 143     static inline type * prefix##_new(void) {               \
 144         return prefix##_init(p_new(type, 1));               \
 145     }
 146 #define DO_DELETE(type, prefix) \
 147     static inline void __attribute__((nonnull))             \
 148     prefix##_delete(type **var) {                           \
 149         if (*var) {                                         \
 150             prefix##_wipe(*var);                            \
 151             p_delete(var);                                  \
 152         }                                                   \
 153     }
 154
 155 #endif /* PFIXTOOLS_MEM_H */