2 * Copyright (C) 1995-2007 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
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.
73 _new_arr_d (struct obstack *obstack, int nelts, size_t elts_size)
77 assert (obstack && (nelts >= 0));
79 new = obstack_alloc (obstack, _ARR_ELTS_OFFS+elts_size);
80 _ARR_SET_DBGINF (new, ARR_D_MAGIC, elts_size/nelts);
81 new->u.obstack = obstack;
87 * Creates a flexible array.
89 * @param nelts The number of elements
90 * @param elts_size The size of the array elements.
92 * @return A pointer to the flexible array (can be used as a pointer to the
93 * first element of this array).
95 * @remark Helper function, use NEW_ARR_F() instead.
98 _new_arr_f (int nelts, size_t elts_size)
103 new = xmalloc (_ARR_ELTS_OFFS+elts_size);
104 _ARR_SET_DBGINF (new, ARR_F_MAGIC, nelts ? elts_size/nelts : 0);
105 new->u.allocated = new->nelts = nelts;
110 * Delete a flexible array.
112 * @param elts The flexible array (pointer to the first element).
114 * @remark Helper function, use DEL_ARR_F() instead.
117 _del_arr_f (void *elts)
119 _arr_descr *dp = _ARR_DESCR (elts);
122 assert (dp->magic == ARR_F_MAGIC);
125 dp->magic = 0xdeadbeef;
131 * Resize a flexible array, always reallocate data.
133 * @param elts The flexible array (pointer to the first element).
134 * @param nelts The new number of elements.
135 * @param elts_size The size of the array elements.
137 * @return A resized flexible array, possibly other address than
140 * @remark Helper function, use ARR_SETLEN() instead.
143 _arr_setlen (void *elts, int nelts, size_t elts_size)
145 _arr_descr *dp = _ARR_DESCR (elts);
147 assert ((dp->magic == ARR_F_MAGIC) && (nelts >= 0));
149 assert (!dp->eltsize || !nelts || (dp->eltsize == elts_size/nelts));
151 dp = 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.
171 _arr_resize (void *elts, int nelts, size_t eltsize)
173 _arr_descr *dp = _ARR_DESCR (elts);
176 assert ((dp->magic == ARR_F_MAGIC) && (nelts >= 0));
178 assert (dp->eltsize ? dp->eltsize == eltsize : (dp->eltsize = eltsize, 1));
180 /* @@@ lots of resizes for small nelts */
181 n = MAX (1, dp->u.allocated);
182 while (nelts > n) n <<= 1;
183 while (3*nelts < n) n >>= 1;
186 if (n != dp->u.allocated) {
187 dp = xrealloc (dp, _ARR_ELTS_OFFS+eltsize*n);
189 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
201 * This function returns the length of a flexible array.
202 * Do NOT use is in code, use ARR_LEN() macro!
203 * This function is intended to be called from a debugger.
205 int array_len(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 _arr_descr *array_descr(void *arr) {
217 return _ARR_DESCR(arr);
219 #endif /* DEBUG_libfirm */