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
34 /* Undefine the macros to get the functions instead, cf tmalloc.c. */
41 * An empty dynamic array descriptor.
43 ir_arr_descr arr_mt_descr = { ARR_D_MAGIC, 0, 0, { { 0 } } };
45 void ir_verify_arr(const void *arr)
48 ir_arr_descr *descr = ARR_DESCR(arr);
49 assert(descr->magic == ARR_D_MAGIC || descr->magic == ARR_A_MAGIC
50 || descr->magic == ARR_F_MAGIC);
51 assert(descr->magic != ARR_F_MAGIC || descr->allocated >= descr->nelts);
58 * Creates a dynamic array on a obstack.
60 * @param obstack An struct obstack * were the data will be allocated
61 * @param nelts The number of elements
62 * @param elts_size The size of the array elements.
64 * @return A pointer to the dynamic array (can be used as a pointer to the
65 * first element of this array).
67 * @remark Helper function, use NEW_ARR_D() instead.
69 void *ir_new_arr_d(struct obstack *obstack, size_t nelts, size_t elts_size)
75 dp = (ir_arr_descr*)obstack_alloc(obstack, ARR_ELTS_OFFS + elts_size);
76 ARR_SET_DBGINF(dp, ARR_D_MAGIC);
77 dp->allocated = dp->nelts = nelts;
82 * Creates a flexible array.
84 * @param nelts The number of elements
85 * @param elts_size The size of the array elements.
87 * @return A pointer to the flexible array (can be used as a pointer to the
88 * first element of this array).
90 * @remark Helper function, use NEW_ARR_F() instead.
92 void *ir_new_arr_f(size_t nelts, size_t elts_size)
96 newa = (ir_arr_descr*)xmalloc(ARR_ELTS_OFFS+elts_size);
97 ARR_SET_DBGINF(newa, ARR_F_MAGIC);
98 newa->allocated = newa->nelts = nelts;
103 * Delete a flexible array.
105 * @param elts The flexible array (pointer to the first element).
107 * @remark Helper function, use DEL_ARR_F() instead.
109 void ir_del_arr_f(void *elts)
111 ir_arr_descr *dp = ARR_DESCR (elts);
114 assert(dp->magic == ARR_F_MAGIC);
117 dp->magic = 0xdeadbeef;
123 * Resize a flexible array, always reallocate data.
125 * @param elts The flexible array (pointer to the first element).
126 * @param nelts The new number of elements.
127 * @param elts_size The size of the array elements.
129 * @return A resized flexible array, possibly other address than
132 * @remark Helper function, use ARR_SETLEN() instead.
134 void *ir_arr_setlen (void *elts, size_t nelts, size_t elts_size)
136 ir_arr_descr *dp = ARR_DESCR (elts);
138 assert(dp->magic == ARR_F_MAGIC);
141 dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+elts_size);
142 dp->allocated = dp->nelts = nelts;
148 * Resize a flexible array, allocate more data if needed but do NOT
151 * @param elts The flexible array (pointer to the first element).
152 * @param nelts The new number of elements.
153 * @param eltsize The size of the array elements.
155 * @return A resized flexible array, possibly other address than
158 * @remark Helper function, use ARR_RESIZE() instead.
160 void *ir_arr_resize(void *elts, size_t nelts, size_t eltsize)
162 ir_arr_descr *dp = ARR_DESCR(elts);
165 assert(dp->magic == ARR_F_MAGIC);
168 /* @@@ lots of resizes for small nelts */
169 n = MAX(1, dp->allocated);
170 while (nelts > n) n <<= 1;
171 while (3*nelts < n) n >>= 1;
174 if (n != dp->allocated) {
175 dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+eltsize*n);
184 /* forward declarations to avoid warnings */
185 size_t array_len(const void *arr);
186 ir_arr_descr *array_descr(const void *arr);
189 * This function returns the length of a flexible array.
190 * Do NOT use is in code, use ARR_LEN() macro!
191 * This function is intended to be called from a debugger.
193 size_t array_len(const void *arr)
199 * This function returns the array descriptor of a flexible array.
200 * Do NOT use is in code!.
201 * This function is intended to be called from a debugger.
203 ir_arr_descr *array_descr(const void *arr)
207 return ARR_DESCR(arr);
209 #endif /* DEBUG_libfirm */