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 _arr_descr arr_mt_descr
56 = { ARR_D_MAGIC, 0, {0}, 0, {{{0}}} }
61 * Creates a dynamic array on a obstack.
63 * @param obstack An struct obstack * were the data will be allocated
64 * @param nelts The number of elements
65 * @param elts_size The size of the array elements.
67 * @return A pointer to the dynamic array (can be used as a pointer to the
68 * first element of this array).
70 * @remark Helper function, use NEW_ARR_D() instead.
72 void *_new_arr_d(struct obstack *obstack, int nelts, size_t elts_size) {
75 assert(obstack && (nelts >= 0));
77 dp = obstack_alloc(obstack, _ARR_ELTS_OFFS + elts_size);
78 _ARR_SET_DBGINF(dp, ARR_D_MAGIC, elts_size/nelts);
79 dp->u.obstack = obstack;
85 * Creates a flexible array.
87 * @param nelts The number of elements
88 * @param elts_size The size of the array elements.
90 * @return A pointer to the flexible array (can be used as a pointer to the
91 * first element of this array).
93 * @remark Helper function, use NEW_ARR_F() instead.
95 void *_new_arr_f(int nelts, size_t elts_size) {
99 new = xmalloc (_ARR_ELTS_OFFS+elts_size);
100 _ARR_SET_DBGINF (new, ARR_F_MAGIC, nelts ? elts_size/nelts : 0);
101 new->u.allocated = new->nelts = nelts;
106 * Delete a flexible array.
108 * @param elts The flexible array (pointer to the first element).
110 * @remark Helper function, use DEL_ARR_F() instead.
112 void _del_arr_f(void *elts) {
113 _arr_descr *dp = _ARR_DESCR (elts);
116 assert (dp->magic == ARR_F_MAGIC);
120 _arr_descr *wdp = (_arr_descr *)dp;
121 wdp->magic = 0xdeadbeef;
128 * Resize a flexible array, always reallocate data.
130 * @param elts The flexible array (pointer to the first element).
131 * @param nelts The new number of elements.
132 * @param elts_size The size of the array elements.
134 * @return A resized flexible array, possibly other address than
137 * @remark Helper function, use ARR_SETLEN() instead.
139 void *_arr_setlen (void *elts, int nelts, size_t elts_size) {
140 _arr_descr *dp = _ARR_DESCR (elts);
142 assert ((dp->magic == ARR_F_MAGIC) && (nelts >= 0));
144 assert (!dp->eltsize || !nelts || (dp->eltsize == elts_size/nelts));
146 dp = xrealloc (dp, _ARR_ELTS_OFFS+elts_size);
147 dp->u.allocated = dp->nelts = nelts;
153 * Resize a flexible array, allocate more data if needed but do NOT
156 * @param elts The flexible array (pointer to the first element).
157 * @param nelts The new number of elements.
158 * @param eltsize The size of the array elements.
160 * @return A resized flexible array, possibly other address than
163 * @remark Helper function, use ARR_RESIZE() instead.
165 void *_arr_resize(void *elts, int nelts, size_t eltsize) {
166 _arr_descr *dp = _ARR_DESCR(elts);
169 assert((dp->magic == ARR_F_MAGIC) && (nelts >= 0));
171 assert(dp->eltsize ? dp->eltsize == eltsize : (dp->eltsize = eltsize, 1));
173 /* @@@ lots of resizes for small nelts */
174 n = MAX(1, dp->u.allocated);
175 while (nelts > n) n <<= 1;
176 while (3*nelts < n) n >>= 1;
179 if (n != dp->u.allocated) {
180 dp = xrealloc(dp, _ARR_ELTS_OFFS+eltsize*n);
182 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
194 * This function returns the length of a flexible array.
195 * Do NOT use is in code, use ARR_LEN() macro!
196 * This function is intended to be called from a debugger.
198 int array_len(const void *arr) {
203 * This function returns the array descriptor of a flexible array.
204 * Do NOT use is in code!.
205 * This function is intended to be called from a debugger.
207 _arr_descr *array_descr(const void *arr) {
210 return _ARR_DESCR(arr);
212 #endif /* DEBUG_libfirm */