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         uint32_t len;                                                          \
  47         uint32_t size;                                                         \
  48         unsigned locked : 1;                                                   \
  49     }
  50
  51 #define PARRAY(Type)                                                           \
  52     typedef PRIV_ARRAY(Type*) Type ## _ptr_array_t;                            \
  53     static inline Type ## _ptr_array_t *Type ## _ptr_array_new(void)           \
  54     {                                                                          \
  55         return p_new(Type ## _ptr_array_t, 1);                                 \
  56     }                                                                          \
  57                                                                                \
  58     static inline void Type ## _ptr_array_delete(Type ## _ptr_array_t **array) \
  59     {                                                                          \
  60         if (*array) {                                                          \
  61             if ((*array)->locked) {                                            \
  62                 array_unlock(**array);                                         \
  63             }                                                                  \
  64             array_wipe(**array);                                               \
  65             p_delete(array);                                                   \
  66         }                                                                      \
  67     }
  68
  69 #define ARRAY(Type)                                                            \
  70     typedef PRIV_ARRAY(Type) Type ## _array_t;                                 \
  71                                                                                \
  72     static inline Type ## _array_t *Type ## _array_new(void)                   \
  73     {                                                                          \
  74         return p_new(Type ## _array_t, 1);                                     \
  75     }                                                                          \
  76                                                                                \
  77     static inline void Type ## _array_delete(Type ## _array_t **array)         \
  78     {                                                                          \
  79         if (*array) {                                                          \
  80             if ((*array)->locked) {                                            \
  81                 array_unlock(**array);                                         \
  82             }                                                                  \
  83             array_wipe(**array);                                               \
  84             p_delete(array);                                                   \
  85         }                                                                      \
  86     }                                                                          \
  87                                                                                \
  88     PARRAY(Type)
  89
  90 #define A(Type) Type ## _array_t
  91 #define PA(Type) Type ## _ptr_array_t
  92
  93 #define ARRAY_INIT { NULL, 0, 0, false }
  94
  95 #define array_init(array) (array) = ARRAY_INIT
  96
  97 #define array_can_edit(array) (!(array).locked)
  98
  99 #define array_ensure_can_edit(array)                                           \
 100     assert(array_can_edit(array) && "Trying to edit array while it is locked")
 101
 102 #define array_wipe(array)                                                      \
 103     do {                                                                       \
 104         array_ensure_can_edit(array);                                          \
 105         p_delete(&(array).data);                                               \
 106         (array).len  = 0;                                                      \
 107         (array).size = 0;                                                      \
 108     } while (0)
 109 #define array_add(array, obj)                                                  \
 110     do {                                                                       \
 111         array_ensure_capacity_delta(array, 1);                                 \
 112         (array).data[(array).len++] = (obj);                                   \
 113     } while (0)
 114 #define array_append(array, objs, len)                                         \
 115     do {                                                                       \
 116         const typeof((array).len) __len = (len);                               \
 117         array_ensure_capacity_delta(array, __len);                             \
 118         memcpy((array).data + (array).len, objs,                               \
 119                __len * sizeof(*(array).data));                                 \
 120         (array).len += __len;                                                  \
 121     } while (0)
 122 #define array_ensure_capacity(array, goal)                                     \
 123     do {                                                                       \
 124         array_ensure_can_edit(array);                                          \
 125         if ((array).size < (goal)) {                                           \
 126             const typeof((array).size) required_size = (goal);                 \
 127             typeof((array).size) next_size = (array).size;                     \
 128             do {                                                               \
 129                 next_size = p_alloc_nr(next_size);                             \
 130             } while (next_size < required_size);                               \
 131             p_allocgrow(&(array).data, next_size, &(array).size);              \
 132         }                                                                      \
 133     } while (0)
 134 #define array_ensure_capacity_delta(array, delta)                              \
 135     array_ensure_capacity(array, (array).len + (delta))
 136 #define array_ensure_exact_capacity(array, goal)                               \
 137     if ((array).size < (goal)) {                                               \
 138         array_ensure_can_edit(array);                                          \
 139         p_allocgrow(&(array).data, (goal), &(array).size);                     \
 140     }
 141 #define array_adjust(array)                                                    \
 142     do {                                                                       \
 143         array_ensure_can_edit(array);                                          \
 144         p_shrink(&(array).data, (array).len, &(array).size);                   \
 145     } while (0)
 146 #define array_elt(array, n) (array).data[(n)]
 147 #define array_ptr(array, n) (array).data + (n)
 148
 149 #define foreach(var, array)                                                    \
 150     for (uint32_t __Ai = 0 ; __Ai < (array).len ; ++__Ai) {                    \
 151         var = array_ptr(array, __Ai);
 152
 153 #define array_foreach(array, action)                                           \
 154     for (uint32_t __Ai = 0 ; __Ai < (array).len ; ++__Ai) {                    \
 155         action(array_ptr(array, __Ai));                                        \
 156     }
 157 #define array_deep_wipe(array, wipe)                                           \
 158     do {                                                                       \
 159         array_foreach(array, wipe);                                            \
 160         array_wipe(array);                                                     \
 161     } while (0)
 162
 163 #define array_byte_len(array) (array).len * sizeof(*(array).data)
 164
 165 #define array_lock(array)                                                      \
 166     ((array).locked                                                            \
 167      || (mprotect((array).data, array_byte_len(array), PROT_READ) == 0         \
 168          && mlock((array).data, array_byte_len(array)) == 0                    \
 169          && ((array).locked = true))                                           \
 170      || (mprotect((array).data, array_byte_len(array),                         \
 171                   PROT_READ | PROT_WRITE) > 0))
 172 #define array_unlock(array)                                                    \
 173     if ((array).locked) {                                                      \
 174         (void)munlock((array).data, array_byte_len(array));                    \
 175         (void)mprotect((array).data, array_byte_len(array),                    \
 176                        PROT_READ | PROT_WRITE);                                \
 177         (array).locked = false;                                                \
 178     }
 179
 180 ARRAY(char)
 181 ARRAY(int)
 182 ARRAY(bool)
 183 ARRAY(uint32_t)
 184
 185 PARRAY(void)
 186
 187 #endif