array.h 8.34 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
/*
2
 * Copyright (C) 1995-2011 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
Michael Beck's avatar
Michael Beck committed
24
 */
25
26
#ifndef FIRM_ADT_ARRAY_H
#define FIRM_ADT_ARRAY_H
Christian Schäfer's avatar
Christian Schäfer committed
27
28
29

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

31
#include "obst.h"
Christian Schäfer's avatar
Christian Schäfer committed
32

33
34
#include "../begin.h"

35
36
37
38
39
40
/**
 * @ingroup adt
 * @defgroup array Arrays
 * @{
 */

Michael Beck's avatar
Michael Beck committed
41
42
43
44
45
46
47
48
49
50
51
52
/**
 * 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).
 */
53
#define NEW_ARR_F(type, nelts) \
54
  ((type *)ir_new_arr_f((nelts), sizeof(type) * (nelts)))
Michael Beck's avatar
Michael Beck committed
55
56

/**
57
 * Creates a new flexible array with the same number of elements as a
Michael Beck's avatar
Michael Beck committed
58
59
60
61
62
63
64
65
66
67
68
 * 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).
 */
69
#define CLONE_ARR_F(type, arr) \
70
  NEW_ARR_F(type, ARR_LEN((arr)))
Michael Beck's avatar
Michael Beck committed
71
72
73
74
75
76
77
78
79
80
81
82
83

/**
 * 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).
 */
84
#define DUP_ARR_F(type, arr) \
85
  ((type*) memcpy(CLONE_ARR_F(type, (arr)), (arr), sizeof(type) * ARR_LEN((arr))))
Michael Beck's avatar
Michael Beck committed
86
87
88
89
90
91

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

Michael Beck's avatar
Michael Beck committed
94
/**
Götz Lindenmaier's avatar
Götz Lindenmaier committed
95
 * Creates a dynamic array on an obstack.
Michael Beck's avatar
Michael Beck committed
96
97
 *
 * @param type     The element type of the new array.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
98
99
 * @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
100
101
102
103
104
105
106
 *
 * 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).
 */
107
108
109
#define NEW_ARR_D(type, obstack, nelts)                                 \
  (  nelts                                                              \
   ? (type *)ir_new_arr_d((obstack), (nelts), sizeof(type) * (nelts))   \
110
   : (type *)arr_mt_descr.elts)
Michael Beck's avatar
Michael Beck committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

/**
 * 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).
 */
126
#define CLONE_ARR_D(type, obstack, arr) \
127
  NEW_ARR_D(type, (obstack), ARR_LEN((arr)))
Michael Beck's avatar
Michael Beck committed
128
129
130
131
132
133
134
135
136
137
138
139
140
141

/**
 * 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).
 */
142
#define DUP_ARR_D(type, obstack, arr) \
143
  ((type*)memcpy(CLONE_ARR_D(type, (obstack), (arr)), (arr), sizeof(type) * ARR_LEN ((arr))))
Christian Schäfer's avatar
Christian Schäfer committed
144

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

Michael Beck's avatar
Michael Beck committed
152
153
154
155
156
157
158
159
160
161
/**
 * 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!
 */
162
#define ARR_RESIZE(type, arr, n) \
163
  ((arr) = (type*) ir_arr_resize((void *)(arr), (n), sizeof(type)))
Michael Beck's avatar
Michael Beck committed
164
165
166
167
168
169
170
171
172
173

/**
 * 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!
 */
174
#define ARR_SETLEN(type, arr, n) \
175
  ((arr) = (type*) ir_arr_setlen((void *)(arr), (n), sizeof(type) * (n)))
Michael Beck's avatar
Michael Beck committed
176
177
178
179
180
181
182
183
184
185

/**
 * 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!
 */
186
#define ARR_EXTEND(type, arr, delta) \
187
  ARR_RESIZE(type, (arr), ARR_LEN((arr)) + (delta))
Michael Beck's avatar
Michael Beck committed
188
189
190
191
192
193
194
195
196
197
198

/**
 * 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!
 */
199
#define ARR_EXTO(type, arr, n) \
200
201
202
	do { \
		if ((n) >= ARR_LEN(arr)) { ARR_RESIZE(type, arr, (n)+1); } \
	} while(0)
Michael Beck's avatar
Michael Beck committed
203
204
205
206
207
208
209
210

/**
 * 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).
 */
211
#define ARR_APP1(type, arr, elt) \
212
  (ARR_EXTEND(type, (arr), 1), (arr)[ARR_LEN((arr))-1] = (elt))
Christian Schäfer's avatar
Christian Schäfer committed
213
214

#ifdef NDEBUG
215
# define ARR_VRFY(arr)          ((void)0)
Christian Schäfer's avatar
Christian Schäfer committed
216
217
# define ARR_IDX_VRFY(arr, idx) ((void)0)
#else
218
/** Check array for consistency */
219
# define ARR_VRFY(arr)          ir_verify_arr(arr)
220
/** Check if index is within array bounds */
221
# define ARR_IDX_VRFY(arr, idx) \
222
    assert((0 <= (idx)) && ((idx) < ARR_LEN((arr))))
Christian Schäfer's avatar
Christian Schäfer committed
223
224
#endif

225
226
/** @cond PRIVATE */

227
228
229
230
231
232
/** 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
233

Michael Beck's avatar
Michael Beck committed
234
235
236
/**
 * The array descriptor header type.
 */
237
238
typedef struct {
	int magic;                    /**< array magic. */
239
	size_t allocated;         /**< number of allocated elements. */
240
241
242
	size_t nelts;                 /**< current length of the array. */
	aligned_type elts[1];         /**< start of the array data. */
} ir_arr_descr;
Christian Schäfer's avatar
Christian Schäfer committed
243

244
extern ir_arr_descr arr_mt_descr;
Christian Schäfer's avatar
Christian Schäfer committed
245

246
FIRM_API void *ir_new_arr_f(size_t nelts, size_t elts_size);
Michael Beck's avatar
Michael Beck committed
247
FIRM_API void ir_del_arr_f(void *elts);
248
249
250
FIRM_API void *ir_new_arr_d(struct obstack *obstack, size_t nelts, size_t elts_size);
FIRM_API void *ir_arr_resize(void *elts, size_t nelts, size_t elts_size);
FIRM_API void *ir_arr_setlen(void *elts, size_t nelts, size_t elts_size);
Michael Beck's avatar
Michael Beck committed
251
FIRM_API void ir_verify_arr(const void *elts);
Christian Schäfer's avatar
Christian Schäfer committed
252

253
#define ARR_ELTS_OFFS offsetof(ir_arr_descr, elts)
254
#define ARR_DESCR(elts) ((ir_arr_descr *)(void *)((char *)(elts) - ARR_ELTS_OFFS))
Christian Schäfer's avatar
Christian Schäfer committed
255

Matthias Braun's avatar
Matthias Braun committed
256
257
/** Set a length smaller than the current length of the array.  Do not
 *  resize. len must be <= ARR_LEN(arr). */
258
259
260
261
262
263
264
static inline void ARR_SHRINKLEN(void *arr, size_t new_len)
{
	ARR_VRFY(arr);
	assert(ARR_DESCR(arr)->nelts >= new_len);
	ARR_DESCR(arr)->nelts = new_len;
}

265
266
267
268
/** @endcond */

/** @} */

269
270
271
#include "../end.h"

#endif