array.h 8.31 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"

Michael Beck's avatar
Michael Beck committed
35
36
37
38
39
40
41
42
43
44
45
46
/**
 * 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).
 */
47
#define NEW_ARR_F(type, nelts) \
48
  ((type *)ir_new_arr_f((nelts), sizeof(type) * (nelts)))
Michael Beck's avatar
Michael Beck committed
49
50

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

/**
 * 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).
 */
78
#define DUP_ARR_F(type, arr) \
79
  ((type*) memcpy(CLONE_ARR_F(type, (arr)), (arr), sizeof(type) * ARR_LEN((arr))))
Michael Beck's avatar
Michael Beck committed
80
81
82
83
84
85

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

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

/**
 * 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).
 */
120
#define CLONE_ARR_D(type, obstack, arr) \
121
  NEW_ARR_D(type, (obstack), ARR_LEN((arr)))
Michael Beck's avatar
Michael Beck committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135

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

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

Michael Beck's avatar
Michael Beck committed
146
147
148
149
150
151
152
153
154
155
/**
 * 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!
 */
156
#define ARR_RESIZE(type, arr, n) \
157
  ((arr) = (type*) ir_arr_resize((void *)(arr), (n), sizeof(type)))
Michael Beck's avatar
Michael Beck committed
158
159
160
161
162
163
164
165
166
167

/**
 * 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!
 */
168
#define ARR_SETLEN(type, arr, n) \
169
  ((arr) = (type*) ir_arr_setlen((void *)(arr), (n), sizeof(type) * (n)))
Michael Beck's avatar
Michael Beck committed
170
171
172
173
174
175
176
177
178
179

/**
 * 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!
 */
180
#define ARR_EXTEND(type, arr, delta) \
181
  ARR_RESIZE(type, (arr), ARR_LEN((arr)) + (delta))
Michael Beck's avatar
Michael Beck committed
182
183
184
185
186
187
188
189
190
191
192

/**
 * 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!
 */
193
#define ARR_EXTO(type, arr, n) \
194
195
196
	do { \
		if ((n) >= ARR_LEN(arr)) { ARR_RESIZE(type, arr, (n)+1); } \
	} while(0)
Michael Beck's avatar
Michael Beck committed
197
198
199
200
201
202
203
204

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

#ifdef NDEBUG
209
# define ARR_VRFY(arr)          ((void)0)
Christian Schäfer's avatar
Christian Schäfer committed
210
211
# define ARR_IDX_VRFY(arr, idx) ((void)0)
#else
212
# define ARR_VRFY(arr)          ir_verify_arr(arr)
213
# define ARR_IDX_VRFY(arr, idx) \
214
    assert((0 <= (idx)) && ((idx) < ARR_LEN((arr))))
Christian Schäfer's avatar
Christian Schäfer committed
215
216
#endif

217
218
219
220
221
222
/** 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
223
224


Michael Beck's avatar
Michael Beck committed
225
226
227
/**
 * The array descriptor header type.
 */
228
229
230
231
232
233
234
235
236
237
typedef struct {
	int magic;                    /**< array magic. */
	size_t eltsize;               /**< size of array elements. */
	union {
		struct obstack *obstack;  /**< for obstack array: the obstack. */
		size_t allocated;         /**< number of allocated elements. */
	} u;
	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
238

239
extern ir_arr_descr arr_mt_descr;
Christian Schäfer's avatar
Christian Schäfer committed
240

241
FIRM_API void *ir_new_arr_f(size_t nelts, size_t elts_size);
Michael Beck's avatar
Michael Beck committed
242
FIRM_API void ir_del_arr_f(void *elts);
243
244
245
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
246
FIRM_API void ir_verify_arr(const void *elts);
Christian Schäfer's avatar
Christian Schäfer committed
247

248
#define ARR_ELTS_OFFS offsetof(ir_arr_descr, elts)
249
#define ARR_DESCR(elts) ((ir_arr_descr *)(void *)((char *)(elts) - ARR_ELTS_OFFS))
Christian Schäfer's avatar
Christian Schäfer committed
250

Matthias Braun's avatar
Matthias Braun committed
251
252
/** Set a length smaller than the current length of the array.  Do not
 *  resize. len must be <= ARR_LEN(arr). */
253
254
255
256
257
258
259
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;
}

260
261
262
#include "../end.h"

#endif