2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Array --- dynamic & flexible arrays.
23 * @author Markus Armbruster
38 /* Undefine the macros to get the functions instead, cf tmalloc.c. */
45 # define MAX(a,b) ((a) > (b) ? (a) : (b))
48 # define MIN(a,b) ((a) > (b) ? (b) : (a))
52 * An empty dynamic array descriptor.
54 ir_arr_descr arr_mt_descr = { ARR_D_MAGIC, 0, {0}, 0, {{{0}}} };
56 void ir_verify_arr(const void *arr)
59 ir_arr_descr *descr = ARR_DESCR(arr);
60 assert(descr->magic == ARR_D_MAGIC || descr->magic == ARR_A_MAGIC
61 || descr->magic == ARR_F_MAGIC);
62 if (descr->magic == ARR_F_MAGIC) {
63 assert(descr->u.allocated >= descr->nelts);
65 assert(descr->nelts >= 0);
72 * Creates a dynamic array on a obstack.
74 * @param obstack An struct obstack * were the data will be allocated
75 * @param nelts The number of elements
76 * @param elts_size The size of the array elements.
78 * @return A pointer to the dynamic array (can be used as a pointer to the
79 * first element of this array).
81 * @remark Helper function, use NEW_ARR_D() instead.
83 void *ir_new_arr_d(struct obstack *obstack, int nelts, size_t elts_size) {
86 assert(obstack && (nelts >= 0));
88 dp = obstack_alloc(obstack, ARR_ELTS_OFFS + elts_size);
89 ARR_SET_DBGINF(dp, ARR_D_MAGIC, elts_size/nelts);
90 dp->u.obstack = obstack;
96 * Creates a flexible array.
98 * @param nelts The number of elements
99 * @param elts_size The size of the array elements.
101 * @return A pointer to the flexible array (can be used as a pointer to the
102 * first element of this array).
104 * @remark Helper function, use NEW_ARR_F() instead.
106 void *ir_new_arr_f(int nelts, size_t elts_size) {
110 new = xmalloc (ARR_ELTS_OFFS+elts_size);
111 ARR_SET_DBGINF (new, ARR_F_MAGIC, nelts ? elts_size/nelts : 0);
112 new->u.allocated = new->nelts = nelts;
117 * Delete a flexible array.
119 * @param elts The flexible array (pointer to the first element).
121 * @remark Helper function, use DEL_ARR_F() instead.
123 void ir_del_arr_f(void *elts) {
124 ir_arr_descr *dp = ARR_DESCR (elts);
127 assert (dp->magic == ARR_F_MAGIC);
131 ir_arr_descr *wdp = (ir_arr_descr *)dp;
132 wdp->magic = 0xdeadbeef;
139 * Resize a flexible array, always reallocate data.
141 * @param elts The flexible array (pointer to the first element).
142 * @param nelts The new number of elements.
143 * @param elts_size The size of the array elements.
145 * @return A resized flexible array, possibly other address than
148 * @remark Helper function, use ARR_SETLEN() instead.
150 void *ir_arr_setlen (void *elts, int nelts, size_t elts_size) {
151 ir_arr_descr *dp = ARR_DESCR (elts);
153 assert ((dp->magic == ARR_F_MAGIC) && (nelts >= 0));
155 assert (!dp->eltsize || !nelts || (dp->eltsize == elts_size/nelts));
157 dp = xrealloc (dp, ARR_ELTS_OFFS+elts_size);
158 dp->u.allocated = dp->nelts = nelts;
164 * Resize a flexible array, allocate more data if needed but do NOT
167 * @param elts The flexible array (pointer to the first element).
168 * @param nelts The new number of elements.
169 * @param eltsize The size of the array elements.
171 * @return A resized flexible array, possibly other address than
174 * @remark Helper function, use ARR_RESIZE() instead.
176 void *ir_arr_resize(void *elts, int nelts, size_t eltsize) {
177 ir_arr_descr *dp = ARR_DESCR(elts);
180 assert((dp->magic == ARR_F_MAGIC) && (nelts >= 0));
182 assert(dp->eltsize ? dp->eltsize == eltsize : (dp->eltsize = eltsize, 1));
184 /* @@@ lots of resizes for small nelts */
185 n = MAX(1, dp->u.allocated);
186 while (nelts > n) n <<= 1;
187 while (3*nelts < n) n >>= 1;
190 if (n != dp->u.allocated) {
191 dp = xrealloc(dp, ARR_ELTS_OFFS+eltsize*n);
193 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
205 * This function returns the length of a flexible array.
206 * Do NOT use is in code, use ARR_LEN() macro!
207 * This function is intended to be called from a debugger.
209 int array_len(const void *arr) {
214 * This function returns the array descriptor of a flexible array.
215 * Do NOT use is in code!.
216 * This function is intended to be called from a debugger.
218 ir_arr_descr *array_descr(const void *arr) {
221 return ARR_DESCR(arr);
223 #endif /* DEBUG_libfirm */