array.h 12.1 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
18
 */
Boris Boesler's avatar
Boris Boesler committed
19

Michael Beck's avatar
Michael Beck committed
20
/**
21
22
 * @file
 * @brief     Dynamic and flexible arrays for C.
23
 * @author    Markus Armbruster, Michael Beck, Matthias Braun, Sebastian Hack
24
 * @version   $Id$
Michael Beck's avatar
Michael Beck committed
25
 */
26
27
#ifndef FIRM_ADT_ARRAY_H
#define FIRM_ADT_ARRAY_H
Christian Schäfer's avatar
Christian Schäfer committed
28
29
30

#include <assert.h>
#include <stddef.h>
31

32
#include "obst.h"
Michael Beck's avatar
Michael Beck committed
33
#include "fourcc.h"
34
#include "xmalloc.h"
Christian Schäfer's avatar
Christian Schäfer committed
35

Michael Beck's avatar
Michael Beck committed
36
37
38
39
40
41
42
43
44
45
46
47
/**
 * Creates a flexible array.
 *
 * @param type     The element type of the new array.
 * @param nelts    a size_t expression evaluating to the number of elements
 *
 * This macro creates a flexible array of a given type at runtime.
 * The size of the array can be changed later.
 *
 * @return A pointer to the flexible array (can be used as a pointer to the
 *         first element of this array).
 */
Christian Schäfer's avatar
Christian Schäfer committed
48
#define NEW_ARR_F(type, nelts)						\
49
  ((type *)ir_new_arr_f((nelts), sizeof(type) * (nelts)))
Michael Beck's avatar
Michael Beck committed
50
51

/**
52
 * Creates a new flexible array with the same number of elements as a
Michael Beck's avatar
Michael Beck committed
53
54
55
56
57
58
59
60
61
62
63
 * given one.
 *
 * @param type     The element type of the new array.
 * @param arr      An array from which the number of elements will be taken
 *
 * This macro creates a flexible array of a given type at runtime.
 * The size of the array can be changed later.
 *
 * @return A pointer to the flexible array (can be used as a pointer to the
 *         first element of this array).
 */
Christian Schäfer's avatar
Christian Schäfer committed
64
#define CLONE_ARR_F(type, arr)			\
65
  NEW_ARR_F(type, ARR_LEN((arr)))
Michael Beck's avatar
Michael Beck committed
66
67
68
69
70
71
72
73
74
75
76
77
78

/**
 * Duplicates an array and returns the new flexible one.
 *
 * @param type     The element type of the new array.
 * @param arr      An array from which the elements will be duplicated
 *
 * This macro creates a flexible array of a given type at runtime.
 * The size of the array can be changed later.
 *
 * @return A pointer to the flexible array (can be used as a pointer to the
 *         first element of this array).
 */
Christian Schäfer's avatar
Christian Schäfer committed
79
#define DUP_ARR_F(type, arr)							\
80
  memcpy(CLONE_ARR_F(type, (arr)), (arr), sizeof(type) * ARR_LEN((arr)))
Michael Beck's avatar
Michael Beck committed
81
82
83
84
85
86

/**
 * Delete a flexible array.
 *
 * @param arr    The flexible array.
 */
87
#define DEL_ARR_F(arr) (ir_del_arr_f((void *)(arr)))
Christian Schäfer's avatar
Christian Schäfer committed
88

Michael Beck's avatar
Michael Beck committed
89
/**
Götz Lindenmaier's avatar
Götz Lindenmaier committed
90
 * Creates a dynamic array on an obstack.
Michael Beck's avatar
Michael Beck committed
91
92
 *
 * @param type     The element type of the new array.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
93
94
 * @param obstack  A struct obstack * were the data will be allocated
 * @param nelts    A size_t expression evaluating to the number of elements
Michael Beck's avatar
Michael Beck committed
95
96
97
98
99
100
101
 *
 * This macro creates a dynamic array of a given type at runtime.
 * The size of the array cannot be changed later.
 *
 * @return A pointer to the dynamic array (can be used as a pointer to the
 *         first element of this array).
 */
Christian Schäfer's avatar
Christian Schäfer committed
102
103
#define NEW_ARR_D(type, obstack, nelts)					\
  (  nelts								\
104
   ? (type *)ir_new_arr_d((obstack), (nelts), sizeof(type) * (nelts))	\
Christian Schäfer's avatar
Christian Schäfer committed
105
   : (type *)arr_mt_descr.v.elts)
Michael Beck's avatar
Michael Beck committed
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

/**
 * Creates a new dynamic array with the same number of elements as a
 * given one.
 *
 * @param type     The element type of the new array.
 * @param obstack  An struct obstack * were the data will be allocated
 * @param arr      An array from which the number of elements will be taken
 *
 * This macro creates a dynamic array of a given type at runtime.
 * The size of the array cannot be changed later.
 *
 * @return A pointer to the dynamic array (can be used as a pointer to the
 *         first element of this array).
 */
Christian Schäfer's avatar
Christian Schäfer committed
121
#define CLONE_ARR_D(type, obstack, arr)		\
122
  NEW_ARR_D(type, (obstack), ARR_LEN((arr)))
Michael Beck's avatar
Michael Beck committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136

/**
 * Duplicates an array and returns the new dynamic one.
 *
 * @param type     The element type of the new array.
 * @param obstack  An struct obstack * were the data will be allocated
 * @param arr      An array from which the elements will be duplicated
 *
 * This macro creates a dynamic array of a given type at runtime.
 * The size of the array cannot be changed later.
 *
 * @return A pointer to the dynamic array (can be used as a pointer to the
 *         first element of this array).
 */
Christian Schäfer's avatar
Christian Schäfer committed
137
#define DUP_ARR_D(type, obstack, arr)							\
138
  memcpy(CLONE_ARR_D(type, (obstack), (arr)), (arr), sizeof(type) * ARR_LEN ((arr)))
Christian Schäfer's avatar
Christian Schäfer committed
139

Michael Beck's avatar
Michael Beck committed
140
141
142
143
144
/**
 * Returns the length of an array
 *
 * @param arr  a flexible, dynamic, automatic or static array.
 */
145
#define ARR_LEN(arr) (ARR_VRFY((arr)), ARR_DESCR((arr))->nelts)
Christian Schäfer's avatar
Christian Schäfer committed
146

Michael Beck's avatar
Michael Beck committed
147
148
149
150
151
152
153
154
155
156
/**
 * Resize a flexible array, allocate more data if needed but do NOT
 * reduce.
 *
 * @param type     The element type of the array.
 * @param arr      The array, which must be an lvalue.
 * @param n        The new size of the array.
 *
 * @remark  This macro may change arr, so update all references!
 */
Christian Schäfer's avatar
Christian Schäfer committed
157
#define ARR_RESIZE(type, arr, n)					\
158
  ((arr) = ir_arr_resize((void *)(arr), (n), sizeof(type)))
Michael Beck's avatar
Michael Beck committed
159
160
161
162
163
164
165
166
167
168

/**
 * Resize a flexible array, always reallocate data.
 *
 * @param type     The element type of the array.
 * @param arr      The array, which must be an lvalue.
 * @param n        The new size of the array.
 *
 * @remark  This macro may change arr, so update all references!
 */
Christian Schäfer's avatar
Christian Schäfer committed
169
#define ARR_SETLEN(type, arr, n)					\
170
  ((arr) = ir_arr_setlen((void *)(arr), (n), sizeof(type) * (n)))
Michael Beck's avatar
Michael Beck committed
171

172
173
174
/** Set a length smaller than the current length of the array.  Do not
 *  resize. len must be <= ARR_LEN(arr). */
#define ARR_SHRINKLEN(arr,len)                                          \
175
176
   (ARR_VRFY((arr)), assert(ARR_DESCR((arr))->nelts >= len),             \
    ARR_DESCR((arr))->nelts = len)
177

Michael Beck's avatar
Michael Beck committed
178
179
180
181
182
183
184
185
186
/**
 * Resize a flexible array by growing it by delta elements.
 *
 * @param type     The element type of the array.
 * @param arr      The array, which must be an lvalue.
 * @param delta    The delta number of elements.
 *
 * @remark  This macro may change arr, so update all references!
 */
Christian Schäfer's avatar
Christian Schäfer committed
187
#define ARR_EXTEND(type, arr, delta)			\
188
  ARR_RESIZE(type, (arr), ARR_LEN((arr)) + (delta))
Michael Beck's avatar
Michael Beck committed
189
190
191
192
193
194
195
196
197
198
199

/**
 * Resize a flexible array to hold n elements only if it is currently shorter
 * than n.
 *
 * @param type     The element type of the array.
 * @param arr      The array, which must be an lvalue.
 * @param n        The new size of the array.
 *
 * @remark  This macro may change arr, so update all references!
 */
Christian Schäfer's avatar
Christian Schäfer committed
200
#define ARR_EXTO(type, arr, n)						\
201
  ((n) >= ARR_LEN((arr)) ? ARR_RESIZE(type, (arr), (n)+1) : (arr))
Michael Beck's avatar
Michael Beck committed
202
203
204
205
206
207
208
209

/**
 * Append one element to a flexible array.
 *
 * @param type     The element type of the array.
 * @param arr      The array, which must be an lvalue.
 * @param elt      The new element, must be of type (type).
 */
Christian Schäfer's avatar
Christian Schäfer committed
210
#define ARR_APP1(type, arr, elt)					\
211
  (ARR_EXTEND(type, (arr), 1), (arr)[ARR_LEN((arr))-1] = (elt))
Christian Schäfer's avatar
Christian Schäfer committed
212
213

#ifdef NDEBUG
214
# define ARR_VRFY(arr)          ((void)0)
Christian Schäfer's avatar
Christian Schäfer committed
215
216
# define ARR_IDX_VRFY(arr, idx) ((void)0)
#else
217
# define ARR_VRFY(arr)          ir_verify_arr(arr)
Christian Schäfer's avatar
Christian Schäfer committed
218
# define ARR_IDX_VRFY(arr, idx)				\
219
    assert((0 <= (idx)) && ((idx) < ARR_LEN((arr))))
Christian Schäfer's avatar
Christian Schäfer committed
220
221
#endif

222
223
224
225
226
227
/** A type that has most constrained alignment.  */
typedef union {
  long double d;
  void *p;
  long l;
} aligned_type;
Christian Schäfer's avatar
Christian Schäfer committed
228

Michael Beck's avatar
Michael Beck committed
229
230
231
/**
 * Construct an array header.
 */
232
233
234
235
236
237
238
239
240
241
242
243
244
#define ARR_STRUCT(type, rnelts)                    \
  struct {                                          \
  	int magic;                                      \
  	size_t eltsize;                                 \
    union {                                         \
      struct obstack *obstack;	/* dynamic: allocated on this obstack */  \
      int allocated;			/* flexible: #slots allocated */          \
    } u;                                            \
    int nelts;                                      \
    union {                                         \
      type elts[(rnelts)];                          \
      aligned_type align[1];                        \
    } v;                                            \
Christian Schäfer's avatar
Christian Schäfer committed
245
246
  }

Michael Beck's avatar
Michael Beck committed
247
248
249
/**
 * The array descriptor header type.
 */
250
typedef ARR_STRUCT(aligned_type, 1) ir_arr_descr;
Christian Schäfer's avatar
Christian Schäfer committed
251

252
extern ir_arr_descr arr_mt_descr;
Christian Schäfer's avatar
Christian Schäfer committed
253

254
255
256
257
258
259
void *ir_new_arr_f(int nelts, size_t elts_size);
void ir_del_arr_f(void *elts);
void *ir_new_arr_d(struct obstack *obstack, int nelts, size_t elts_size);
void *ir_arr_resize(void *elts, int nelts, size_t elts_size);
void *ir_arr_setlen(void *elts, int nelts, size_t elts_size);
void ir_verify_arr(const void *elts);
Christian Schäfer's avatar
Christian Schäfer committed
260

261
262
#define ARR_ELTS_OFFS offsetof(ir_arr_descr, v.elts)
#define ARR_DESCR(elts) ((ir_arr_descr *)(void *)((char *)(elts) - ARR_ELTS_OFFS))
Christian Schäfer's avatar
Christian Schäfer committed
263

264
265
266
267
268
269
270
271
272
/*
 ____             _           _      _
/ ___|  ___  _ __| |_ ___  __| |    / \   _ __ _ __ __ _ _   _ ___
\___ \ / _ \| '__| __/ _ \/ _` |   / _ \ | '__| '__/ _` | | | / __|
 ___) | (_) | |  | ||  __/ (_| |  / ___ \| |  | | | (_| | |_| \__ \
|____/ \___/|_|   \__\___|\__,_| /_/   \_\_|  |_|  \__,_|\__, |___/
                                                         |___/
*/

273
typedef int (ir_arr_cmp_func_t)(const void *a, const void *b);
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

/**
 * Do a binary search in an array.
 * @param arr      The array.
 * @param elm_size The size of an array element.
 * @param cmp      A comparison function for two array elements (see qsort(3) for example).
 * @param elm      A pointer to the element we are looking for.
 * @return         This is somewhat tricky. Let <code>res</code> be the return value.
 *                 If the return value is negative, then <code>elm</code> was not in the array
 *                 but <code>-res - 1</code> gives the proper location where it should be inserted.
 *                 If <code>res >= 0</code> then the element is in the array and <code>res</code>
 *                 represents its index.
 *                 That allows for testing membership and finding proper insertion indices.
 * @note           The differences to bsearch(3) which does not give proper insert locations
 *                 in the case that the element is not conatined in the array.
 */
290
static inline int ir_arr_bsearch(const void *arr, size_t elm_size, ir_arr_cmp_func_t *cmp, const void *elm)
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
{
	int hi = ARR_LEN(arr);
	int lo = 0;

	while(lo < hi) {
		int md     = lo + ((hi - lo) >> 1);
		int res    = cmp((char *) arr + md * elm_size, elm);
		if(res < 0)
			lo = md + 1;
		else if(res > 0)
			hi = md;
		else
			return md;
	}

	return -(lo + 1);
}

#define ARR_SET_INSERT(arr, cmp, elm) \
do { \
311
	int idx = ir_arr_bsearch((arr), sizeof((arr)[0]), (cmp), (elm)); \
312
313
	if (idx < 0) { \
		idx = -idx - 1; \
314
		memmove(&(arr)[idx+1], &(arr)[idx], sizeof((arr)[0]) * (ARR_DESCR((arr))->nelts - idx)); \
Sebastian Hack's avatar
Sebastian Hack committed
315
		(arr)[idx] = *(elm); \
316
		++ARR_DESCR((arr))->nelts; \
317
318
319
	} \
} while(0)

Sebastian Hack's avatar
Sebastian Hack committed
320
321
#define ARR_SET_INSERT_EXT(type, arr, cmp, elm) \
do { \
322
	int idx = ir_arr_bsearch((arr), sizeof((arr)[0]), (cmp), (elm)); \
Sebastian Hack's avatar
Sebastian Hack committed
323
324
325
326
327
328
329
330
331
	if (idx < 0) { \
		int len = ARR_LEN(arr); \
		idx = -idx - 1; \
		ARR_EXTO(type, arr, len + 1); \
		memmove(&(arr)[idx+1], &(arr)[idx], sizeof((arr)[0]) * (len - idx)); \
		(arr)[idx] = *(elm); \
	} \
} while(0)

332
333
#define ARR_SET_REMOVE(arr, cmp, elm) \
do { \
334
	int idx = ir_arr_bsearch((arr), sizeof((arr)[0]), (cmp), (elm)); \
335
	if (idx >= 0) { \
336
337
		--ARR_DESCR((arr))->nelts; \
		memmove(&(arr)[idx], &(arr)[idx+1], sizeof((arr)[0]) * (ARR_DESCR((arr))->nelts - idx)); \
338
339
340
341
342
343
344
345
346
347
348
	} \
} while(0)

/**
 * Return the index of an element in an array set.
 * To check for containment, use the expression:
 *     (ARR_SET_GET_IDX(arr, cmp, elm) >= 0)
 *
 * @return The index or some value < 0 if the element was not in the set.
 */
#define ARR_SET_GET_IDX(arr, cmp, elm) \
349
	(ARR_VRFY((arr)), ir_arr_bsearch((arr), sizeof((arr)[0]), cmp, (elm)))
Sebastian Hack's avatar
Sebastian Hack committed
350
351
352
353
354
355
356
357
358

#ifdef __GNUC__
#define ARR_SET_GET(arr, cmp, elm) \
	({ int idx = ARR_SET_GET_IDX(arr, cmp, elm); idx >= 0 ? &(arr)[idx] : NULL; })
#else
#define ARR_SET_GET(arr, cmp, elm) \
	(ARR_SET_GET_IDX(arr, cmp, elm) >= 0 ? &(arr)[ARR_SET_GET_IDX(arr, cmp, elm)] : NULL)
#endif

359
360
361
362
363
364
365
366
367
368

#define ARR_SET_CONTAINS(arr, cmp, elm) \
	(ARR_SET_GET_IDX((arr), (cmp), (elm)) >= 0)

/**
 * Reset the array set.
 * This just initializes the size to zero but does not wipe out any element.
 */
#define ARR_SET_CLEAR(arr) ARR_SHRINKLEN(arr, 0)

369
#endif /* FIRM_ADT_ARRAY_H */