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 CONTRIBUTORS ``AS IS'' AND ANY EXPRESS   */
  20 /*  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED         */
  21 /*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE    */
  22 /*  DISCLAIMED.  IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY         */
  23 /*  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL        */
  24 /*  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS   */
  25 /*  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)     */
  26 /*  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,       */
  27 /*  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN  */
  28 /*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE           */
  29 /*  POSSIBILITY OF SUCH DAMAGE.                                               */
  30 /*                                                                            */
  31 /*   Copyright (c) 2006-2008 the Authors                                      */
  32 /*   see AUTHORS and source files for details                                 */
  33 /******************************************************************************/
  34
  35 /*
  36  * Copyright © 2006 Pierre Habouzit
  37  */
  38
  39 #ifndef PFIXTOOLS_MEM_H
  40 #define PFIXTOOLS_MEM_H
  41
  42 #include <assert.h>
  43 #include <ctype.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46
  47 #define MIN(a, b)               ((a) < (b) ? (a) : (b))
  48 #define MAX(a, b)               ((a) > (b) ? (a) : (b))
  49
  50 #define ssizeof(foo)            (ssize_t)sizeof(foo)
  51 #define countof(foo)            (ssizeof(foo) / ssizeof(foo[0]))
  52
  53 #define p_new(type, count)      ((type *)xmalloc(sizeof(type) * (count)))
  54 #define p_clear(p, count)       ((void)memset((p), 0, sizeof(*(p)) * (count)))
  55 #define p_dup(p, count)         xmemdup((p), sizeof(*(p)) * (count))
  56 #define p_dupstr(p, len)        xmemdupstr((p), (len))
  57 #define p_realloc(pp, count)    xrealloc((void*)(pp), sizeof(**(pp)) * (count))
  58
  59 #  define p_shrink(pp, goalnb, allocnb)           \
  60     do {                                          \
  61         if (*(allocnb) > (goalnb)) {              \
  62             p_realloc(pp, (goalnb));              \
  63             *(allocnb) = (goalnb);                \
  64         }                                         \
  65     } while(0)
  66
  67 #  define p_alloc_nr(x) (((x) + 16) * 3 / 2)
  68 #  define p_allocgrow(pp, goalnb, allocnb)                  \
  69     do {                                                    \
  70         if ((goalnb) > *(allocnb)) {                        \
  71             if (p_alloc_nr(goalnb) > *(allocnb)) {          \
  72                 *(allocnb) = (goalnb);                      \
  73             } else {                                        \
  74                 *(allocnb) = p_alloc_nr(goalnb);            \
  75             }                                               \
  76             p_realloc(pp, *(allocnb));                      \
  77         }                                                   \
  78     } while (0)
  79
  80 #ifdef __GNUC__
  81
  82 #  define p_delete(mem_pp)                          \
  83         do {                                        \
  84             typeof(**(mem_pp)) **__ptr = (mem_pp);  \
  85             free(*__ptr);                           \
  86             *__ptr = NULL;                          \
  87         } while(0)
  88
  89 #else
  90
  91 #  define p_delete(mem_p)                           \
  92         do {                                        \
  93             void *__ptr = (mem_p);                  \
  94             free(*__ptr);                           \
  95             *(void **)__ptr = NULL;                 \
  96         } while (0)
  97
  98 #endif
  99
 100 static inline void *xmalloc(ssize_t size) {
 101     void *mem;
 102
 103     if (size <= 0)
 104         return NULL;
 105
 106     mem = calloc(size, 1);
 107     if (!mem)
 108         abort();
 109     return mem;
 110 }
 111
 112 static inline void xmemfree(void **ptr) {
 113     p_delete(ptr);
 114 }
 115
 116 static inline void xrealloc(void **ptr, ssize_t newsize) {
 117     if (newsize <= 0) {
 118         p_delete(ptr);
 119     } else {
 120         *ptr = realloc(*ptr, newsize);
 121         if (!*ptr)
 122             abort();
 123     }
 124 }
 125
 126 static inline void *xmemdup(const void *src, ssize_t size) {
 127     return memcpy(xmalloc(size), src, size);
 128 }
 129
 130 static inline void *xmemdupstr(const void *src, ssize_t len) {
 131     char *res = memcpy(xmalloc(len + 1), src, len);
 132     res[len] = '\0';
 133     return res;
 134 }
 135
 136
 137 #define DO_INIT(type, prefix) \
 138     static inline type * prefix##_init(type *var) {         \
 139         p_clear(var, 1);                                    \
 140         return var;                                         \
 141     }
 142 #define DO_WIPE(type, prefix) \
 143     static inline void prefix##_wipe(type *var __attribute__((unused))) { }
 144
 145 #define DO_NEW(type, prefix) \
 146     static inline type * prefix##_new(void) {               \
 147         return prefix##_init(p_new(type, 1));               \
 148     }
 149 #define DO_DELETE(type, prefix) \
 150     static inline void __attribute__((nonnull))             \
 151     prefix##_delete(type **var) {                           \
 152         if (*var) {                                         \
 153             prefix##_wipe(*var);                            \
 154             p_delete(var);                                  \
 155         }                                                   \
 156     }
 157
 158 #endif /* PFIXTOOLS_MEM_H */