nsz Git - libfirm/blob - ir/adt/array.c

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Array --- dynamic & flexible arrays.
  23  * @author      Markus Armbruster
  24  */
  25
  26 #include "config.h"
  27
  28 #include <stdlib.h>
  29
  30 #include "array_t.h"
  31 #include "xmalloc.h"
  32
  33 /* Undefine the macros to get the functions instead, cf tmalloc.c.  */
  34 #undef xmalloc
  35 #undef xrealloc
  36 #undef xstrdup
  37 #undef xfree
  38
  39 #ifndef MAX
  40 # define MAX(a,b) ((a) > (b) ? (a) : (b))
  41 #endif
  42 #ifndef MIN
  43 # define MIN(a,b) ((a) > (b) ? (b) : (a))
  44 #endif
  45
  46 /**
  47  * An empty dynamic array descriptor.
  48  */
  49 ir_arr_descr arr_mt_descr = { ARR_D_MAGIC, 0, { 0 }, 0,  { { 0 } } };
  50
  51 void ir_verify_arr(const void *arr)
  52 {
  53 #ifndef NDEBUG
  54         ir_arr_descr *descr = ARR_DESCR(arr);
  55         assert(descr->magic == ARR_D_MAGIC || descr->magic == ARR_A_MAGIC
  56                          || descr->magic == ARR_F_MAGIC);
  57         assert(descr->magic != ARR_F_MAGIC || descr->u.allocated >= descr->nelts);
  58 #else
  59         (void) arr;
  60 #endif
  61 }
  62
  63 /**
  64  * Creates a dynamic array on a obstack.
  65  *
  66  * @param obstack    An struct obstack * were the data will be allocated
  67  * @param nelts      The number of elements
  68  * @param elts_size  The size of the array elements.
  69  *
  70  * @return A pointer to the dynamic array (can be used as a pointer to the
  71  *         first element of this array).
  72  *
  73  * @remark Helper function, use NEW_ARR_D() instead.
  74  */
  75 void *ir_new_arr_d(struct obstack *obstack, size_t nelts, size_t elts_size)
  76 {
  77         ir_arr_descr *dp;
  78
  79         assert(obstack);
  80
  81         dp = (ir_arr_descr*)obstack_alloc(obstack, ARR_ELTS_OFFS + elts_size);
  82         ARR_SET_DBGINF(dp, ARR_D_MAGIC, elts_size/nelts);
  83         dp->u.obstack = obstack;
  84         dp->nelts = nelts;
  85         return dp->elts;
  86 }
  87
  88 /**
  89  * Creates a flexible array.
  90  *
  91  * @param nelts      The number of elements
  92  * @param elts_size  The size of the array elements.
  93  *
  94  * @return A pointer to the flexible array (can be used as a pointer to the
  95  *         first element of this array).
  96  *
  97  * @remark Helper function, use NEW_ARR_F() instead.
  98  */
  99 void *ir_new_arr_f(size_t nelts, size_t elts_size)
 100 {
 101         ir_arr_descr *newa;
 102
 103         newa = (ir_arr_descr*)xmalloc(ARR_ELTS_OFFS+elts_size);
 104         ARR_SET_DBGINF(newa, ARR_F_MAGIC, nelts ? elts_size/nelts : 0);
 105         newa->u.allocated = newa->nelts = nelts;
 106         return newa->elts;
 107 }
 108
 109 /**
 110  * Delete a flexible array.
 111  *
 112  * @param elts    The flexible array (pointer to the first element).
 113  *
 114  * @remark Helper function, use DEL_ARR_F() instead.
 115  */
 116 void ir_del_arr_f(void *elts)
 117 {
 118         ir_arr_descr *dp = ARR_DESCR (elts);
 119
 120         ARR_VRFY(elts);
 121         assert(dp->magic == ARR_F_MAGIC);
 122
 123 #ifndef NDEBUG
 124         dp->magic = 0xdeadbeef;
 125 #endif
 126         free(dp);
 127 }
 128
 129 /**
 130  * Resize a flexible array, always reallocate data.
 131  *
 132  * @param elts       The flexible array (pointer to the first element).
 133  * @param nelts      The new number of elements.
 134  * @param elts_size  The size of the array elements.
 135  *
 136  * @return A resized flexible array, possibly other address than
 137  *         elts.
 138  *
 139  * @remark Helper function, use ARR_SETLEN() instead.
 140  */
 141 void *ir_arr_setlen (void *elts, size_t nelts, size_t elts_size)
 142 {
 143         ir_arr_descr *dp = ARR_DESCR (elts);
 144
 145         assert(dp->magic == ARR_F_MAGIC);
 146         ARR_VRFY(elts);
 147         assert(!dp->eltsize || !nelts || (dp->eltsize == elts_size/nelts));
 148
 149         dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+elts_size);
 150         dp->u.allocated = dp->nelts = nelts;
 151
 152         return dp->elts;
 153 }
 154
 155 /**
 156  * Resize a flexible array, allocate more data if needed but do NOT
 157  * reduce.
 158  *
 159  * @param elts     The flexible array (pointer to the first element).
 160  * @param nelts    The new number of elements.
 161  * @param eltsize  The size of the array elements.
 162  *
 163  * @return A resized flexible array, possibly other address than
 164  *         elts.
 165  *
 166  * @remark Helper function, use ARR_RESIZE() instead.
 167  */
 168 void *ir_arr_resize(void *elts, size_t nelts, size_t eltsize)
 169 {
 170         ir_arr_descr *dp = ARR_DESCR(elts);
 171         size_t n;
 172
 173         assert(dp->magic == ARR_F_MAGIC);
 174         ARR_VRFY(elts);
 175         assert(dp->eltsize ? dp->eltsize == eltsize : (dp->eltsize = eltsize, 1));
 176
 177         /* @@@ lots of resizes for small nelts */
 178         n = MAX(1, dp->u.allocated);
 179         while (nelts > n) n <<= 1;
 180         while (3*nelts < n) n >>= 1;
 181         assert(n >= nelts);
 182
 183         if (n != dp->u.allocated) {
 184                 dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+eltsize*n);
 185                 dp->u.allocated = n;
 186         }
 187         dp->nelts = nelts;
 188
 189         return dp->elts;
 190 }
 191
 192 #ifdef DEBUG_libfirm
 193 /* forward declarations to avoid warnings */
 194 size_t array_len(const void *arr);
 195 ir_arr_descr *array_descr(const void *arr);
 196
 197 /**
 198  * This function returns the length of a flexible array.
 199  * Do NOT use is in code, use ARR_LEN() macro!
 200  * This function is intended to be called from a debugger.
 201  */
 202 size_t array_len(const void *arr)
 203 {
 204         return ARR_LEN(arr);
 205 }
 206
 207 /**
 208  * This function returns the array descriptor of a flexible array.
 209  * Do NOT use is in code!.
 210  * This function is intended to be called from a debugger.
 211  */
 212 ir_arr_descr *array_descr(const void *arr)
 213 {
 214         if (! arr)
 215                 return NULL;
 216         return ARR_DESCR(arr);
 217 }
 218 #endif /* DEBUG_libfirm */