2 * Copyright (C) 1995-2011 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
33 /* Undefine the macros to get the functions instead, cf tmalloc.c. */
40 # define MAX(a,b) ((a) > (b) ? (a) : (b))
43 # define MIN(a,b) ((a) > (b) ? (b) : (a))
47 * An empty dynamic array descriptor.
49 ir_arr_descr arr_mt_descr = { ARR_D_MAGIC, 0, { 0 }, 0, { { 0 } } };
51 void ir_verify_arr(const void *arr)
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 if (descr->magic == ARR_F_MAGIC) {
58 assert(descr->u.allocated >= descr->nelts);
66 * Creates a dynamic array on a obstack.
68 * @param obstack An struct obstack * were the data will be allocated
69 * @param nelts The number of elements
70 * @param elts_size The size of the array elements.
72 * @return A pointer to the dynamic array (can be used as a pointer to the
73 * first element of this array).
75 * @remark Helper function, use NEW_ARR_D() instead.
77 void *ir_new_arr_d(struct obstack *obstack, size_t nelts, size_t elts_size)
83 dp = (ir_arr_descr*)obstack_alloc(obstack, ARR_ELTS_OFFS + elts_size);
84 ARR_SET_DBGINF(dp, ARR_D_MAGIC, elts_size/nelts);
85 dp->u.obstack = obstack;
91 * Creates a flexible array.
93 * @param nelts The number of elements
94 * @param elts_size The size of the array elements.
96 * @return A pointer to the flexible array (can be used as a pointer to the
97 * first element of this array).
99 * @remark Helper function, use NEW_ARR_F() instead.
101 void *ir_new_arr_f(size_t nelts, size_t elts_size)
105 newa = (ir_arr_descr*)xmalloc(ARR_ELTS_OFFS+elts_size);
106 ARR_SET_DBGINF(newa, ARR_F_MAGIC, nelts ? elts_size/nelts : 0);
107 newa->u.allocated = newa->nelts = nelts;
112 * Delete a flexible array.
114 * @param elts The flexible array (pointer to the first element).
116 * @remark Helper function, use DEL_ARR_F() instead.
118 void ir_del_arr_f(void *elts)
120 ir_arr_descr *dp = ARR_DESCR (elts);
123 assert(dp->magic == ARR_F_MAGIC);
126 dp->magic = 0xdeadbeef;
132 * Resize a flexible array, always reallocate data.
134 * @param elts The flexible array (pointer to the first element).
135 * @param nelts The new number of elements.
136 * @param elts_size The size of the array elements.
138 * @return A resized flexible array, possibly other address than
141 * @remark Helper function, use ARR_SETLEN() instead.
143 void *ir_arr_setlen (void *elts, size_t nelts, size_t elts_size)
145 ir_arr_descr *dp = ARR_DESCR (elts);
147 assert(dp->magic == ARR_F_MAGIC);
149 assert(!dp->eltsize || !nelts || (dp->eltsize == elts_size/nelts));
151 dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+elts_size);
152 dp->u.allocated = dp->nelts = nelts;
158 * Resize a flexible array, allocate more data if needed but do NOT
161 * @param elts The flexible array (pointer to the first element).
162 * @param nelts The new number of elements.
163 * @param eltsize The size of the array elements.
165 * @return A resized flexible array, possibly other address than
168 * @remark Helper function, use ARR_RESIZE() instead.
170 void *ir_arr_resize(void *elts, size_t nelts, size_t eltsize)
172 ir_arr_descr *dp = ARR_DESCR(elts);
175 assert(dp->magic == ARR_F_MAGIC);
177 assert(dp->eltsize ? dp->eltsize == eltsize : (dp->eltsize = eltsize, 1));
179 /* @@@ lots of resizes for small nelts */
180 n = MAX(1, dp->u.allocated);
181 while (nelts > n) n <<= 1;
182 while (3*nelts < n) n >>= 1;
185 if (n != dp->u.allocated) {
186 dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+eltsize*n);
195 /* forward declarations to avoid warnings */
196 size_t array_len(const void *arr);
197 ir_arr_descr *array_descr(const void *arr);
200 * This function returns the length of a flexible array.
201 * Do NOT use is in code, use ARR_LEN() macro!
202 * This function is intended to be called from a debugger.
204 size_t array_len(const void *arr)
210 * This function returns the array descriptor of a flexible array.
211 * Do NOT use is in code!.
212 * This function is intended to be called from a debugger.
214 ir_arr_descr *array_descr(const void *arr)
218 return ARR_DESCR(arr);
220 #endif /* DEBUG_libfirm */