common/array.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 © 2008 Florent Bruneau
  34  */
  35
  36 #ifndef PFIXTOOLS_ARRAY_H
  37 #define PFIXTOOLS_ARRAY_H
  38
  39 #include "common.h"
  40 #include "mem.h"
  41 #include <sys/mman.h>
  42
  43 #define PRIV_ARRAY(Type)                                                       \
  44     struct {                                                                   \
  45         Type    *data;                                                         \
  46         ssize_t len;                                                           \
  47         ssize_t size;                                                          \
  48     }
  49
  50 #define PARRAY(Type)                                                           \
  51     typedef PRIV_ARRAY(Type*) Type ## _ptr_array_t;                            \
  52     static inline Type ## _ptr_array_t *Type ## _ptr_array_new(void)           \
  53     {                                                                          \
  54         return p_new(Type ## _ptr_array_t, 1);                                 \
  55     }                                                                          \
  56                                                                                \
  57     static inline void Type ## _ptr_array_delete(Type ## _ptr_array_t **array) \
  58     {                                                                          \
  59         if (*array) {                                                          \
  60             array_wipe(**array);                                               \
  61             p_delete(array);                                                   \
  62         }                                                                      \
  63     }
  64
  65 #define ARRAY(Type)                                                            \
  66     typedef PRIV_ARRAY(Type) Type ## _array_t;                                 \
  67                                                                                \
  68     static inline Type ## _array_t *Type ## _array_new(void)                   \
  69     {                                                                          \
  70         return p_new(Type ## _array_t, 1);                                     \
  71     }                                                                          \
  72                                                                                \
  73     static inline void Type ## _array_delete(Type ## _array_t **array)         \
  74     {                                                                          \
  75         if (*array) {                                                          \
  76             array_wipe(**array);                                               \
  77             p_delete(array);                                                   \
  78         }                                                                      \
  79     }                                                                          \
  80                                                                                \
  81     PARRAY(Type)
  82
  83 #define A(Type) Type ## _array_t
  84 #define PA(Type) Type ## _ptr_array_t
  85
  86 #define ARRAY_INIT { NULL, 0, 0 }
  87
  88 #define array_init(array) (array) = ARRAY_INIT
  89 #define array_wipe(array)                                                      \
  90     do {                                                                       \
  91         p_delete(&(array).data);                                               \
  92         (array).len  = 0;                                                      \
  93         (array).size = 0;                                                      \
  94     } while (0)
  95 #define array_add(array, obj)                                                  \
  96     do {                                                                       \
  97         array_ensure_capacity_delta(array, 1);                                 \
  98         (array).data[(array).len++] = (obj);                                   \
  99     } while (0)
 100 #define array_append(array, objs, len)                                         \
 101     do {                                                                       \
 102         const ssize_t __len = (len);                                           \
 103         array_ensure_capacity_delta(array, __len);                             \
 104         memcpy((array).data + (array).len, objs,                               \
 105                __len * sizeof(*(array).data));                                 \
 106         (array).len += __len;                                                  \
 107     } while (0)
 108 #define array_ensure_capacity(array, goal)                                     \
 109     do {                                                                       \
 110         if ((array).size < (goal)) {                                           \
 111             const ssize_t required_size = (goal);                              \
 112             ssize_t next_size = (array).size;                                  \
 113             do {                                                               \
 114                 next_size = p_alloc_nr(next_size);                             \
 115             } while (next_size < required_size);                               \
 116             p_allocgrow(&(array).data, next_size, &(array).size);              \
 117         }                                                                      \
 118     } while (0)
 119 #define array_ensure_capacity_delta(array, delta)                              \
 120     array_ensure_capacity(array, (array).len + (delta))
 121 #define array_ensure_exact_capacity(array, goal)                               \
 122     if (array_size(array) < (goal)) {                                          \
 123         p_allocgrow(&(array).data, (goal), &(array).size);                     \
 124     }
 125 #define array_adjust(array)                                                    \
 126     do {                                                                       \
 127         p_shrink(&(array).data, (array).len, &(array).size);                   \
 128     } while (0)
 129 #define array_elt(array, n) (array).data[(n)]
 130 #define array_ptr(array, n) (array).data + (n)
 131
 132 #define foreach(var, array)                                                    \
 133     for (int __Ai = 0 ; __Ai < (array).len ; ++__Ai) {                         \
 134         var = array_ptr(array, __Ai);
 135
 136 #define array_foreach(array, action)                                           \
 137     for (int __Ai = 0 ; __Ai < (array).len ; ++__Ai) {                         \
 138         action(array_ptr(array, __Ai));                                        \
 139     }
 140 #define array_deep_wipe(array, wipe)                                           \
 141     do {                                                                       \
 142         array_foreach(array, wipe);                                            \
 143         array_wipe(array);                                                     \
 144     } while (0)
 145
 146 #define array_lock(array)                                                      \
 147     !(mlock((array).data, (array).len * sizeof(*(array).data)) != 0)
 148 #define array_unlock(array)                                                    \
 149     (void)munlock((array).data, (array).len * sizeof(*(array).data))
 150
 151 ARRAY(char)
 152 ARRAY(int)
 153 ARRAY(bool)
 154 ARRAY(uint32_t)
 155
 156 PARRAY(void)
 157
 158 #endif