firm_types.h 17 KB
Newer Older
1
/*
2
 * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 *
 * 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.
 */

/**
 * @file
 * @brief      Definition of opaque firm types
 * @author     Michael Beck
 */
#ifndef FIRM_COMMON_FIRM_TYPES_H
#define FIRM_COMMON_FIRM_TYPES_H

28
29
#include "begin.h"

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/**
 * @page visited_counters Visited Counters
 * A visited counter is an alternative to a visited flag for elements of a
 * graph datastructure.
 * A visited counter is an integer number added to the elements of a graph.
 * There is also a global reference number for the whole datastructure. It is
 * now possible to mark nodes by setting their visited counter to the global
 * reference counter. Testing is done by comparing with the global reference
 * counter.
 * The advantage to simple boolean flag variables is that you can clear all
 * element marks by increasing the global reference counter and don't need to
 * visit the whole structure.
 * This makes it more efficient when you only visit/mark a small amount of
 * nodes in the graph.
 */

/** Type for visited counters
 * @see visited_counters */
Michael Beck's avatar
Michael Beck committed
48
typedef unsigned long ir_visited_t;
49
/** A label in the code (usually attached to a @ref Block) */
Michael Beck's avatar
Michael Beck committed
50
typedef unsigned long ir_label_t;
51

52
53
/** @ingroup dbg_info
 * Source Reference */
54
typedef struct dbg_info             dbg_info;
55
56
/** @ingroup dbg_info
 * Source Type Reference */
57
typedef struct type_dbg_info        type_dbg_info;
58
59
/** @ingroup ir_ident
 * Identifier */
60
typedef struct ident                ident;
61
62
/** @ingroup ir_node
 * Procedure Graph Node */
63
typedef struct ir_node              ir_node;
64
65
/** @ingroup ir_op
 * Node Opcode */
66
typedef struct ir_op                ir_op;
67
68
/** @ingroup ir_mode
 * SSA Value mode */
69
typedef struct ir_mode              ir_mode;
70
71
/** @ingroup iredges
 * Dynamic Reverse Edge */
72
typedef struct ir_edge_t            ir_edge_t;
73
74
/** @ingroup ir_heights
 * Computed graph Heights */
75
typedef struct ir_heights_t         ir_heights_t;
76
77
/** @ingroup ir_tarval
 * Target Machine Value */
78
typedef struct ir_tarval            ir_tarval;
79
80
/** @ingroup enumeration_type
 * Enumeration constant */
81
typedef struct ir_enum_const        ir_enum_const;
82
83
/** @ingroup ir_type
 * Type */
84
typedef struct ir_type              ir_type;
85
86
/** @ingroup ir_graph
 * Procedure Grpah */
87
typedef struct ir_graph             ir_graph;
88
89
/** @ingroup ir_prog
 * Program */
90
typedef struct ir_prog              ir_prog;
91
92
/** @ingroup ir_loop
 * Loop */
93
typedef struct ir_loop              ir_loop;
94
95
/** @ingroup ir_entity
 * Entity */
96
typedef struct ir_entity            ir_entity;
97
/** Extended Basic Block */
98
typedef struct ir_extblk            ir_extblk;
99
100
/** @ingroup execfreq
 * Execution Frequency Analysis Results */
101
typedef struct ir_exec_freq         ir_exec_freq;
102
103
/** @ingroup ir_cdep
 * Control Dependence Analysis Results */
104
typedef struct ir_cdep              ir_cdep;
105
106
/** @ingroup be
 * Target Architecture specific node operations */
Matthias Braun's avatar
Matthias Braun committed
107
typedef struct arch_irn_ops_t       arch_irn_ops_t;
108
/** A graph transformation pass */
109
typedef struct ir_graph_pass_t      ir_graph_pass_t;
110
/** A whole program transformation pass */
111
112
typedef struct ir_prog_pass_t       ir_prog_pass_t;

113
/** A graph pass manager */
114
typedef struct ir_graph_pass_manager_t      ir_graph_pass_manager_t;
115
/** A program pass manager */
116
typedef struct ir_prog_pass_manager_t       ir_prog_pass_manager_t;
117

118
119
/** @ingroup ir_initializer
 * Initializer (for entities) */
120
typedef union  ir_initializer_t     ir_initializer_t;
121

122
123
124
/**
 * @ingroup irgwalk
 * type for graph-walk callbacks */
125
126
typedef void irg_walk_func(ir_node *, void *);

Matthias Braun's avatar
Matthias Braun committed
127
/**
128
 * @ingroup Switch
Matthias Braun's avatar
Matthias Braun committed
129
130
131
132
133
134
 * A switch table mapping integer numbers to proj-numbers of a Switch-node.
 * Entries map a continuous range of integer numbers to a proj-number.
 * There must never be two different entries matching the same integer number.
 */
typedef struct ir_switch_table  ir_switch_table;

135
/**
136
 * @ingroup ir_cons
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 * This function is called, whenever a local variable is used before definition
 *
 * @param irg       the IR graph on which this happens
 * @param mode      the mode of the local var
 * @param pos       position chosen be the frontend for this variable (n_loc)
 *
 * @return a firm node of mode @p mode that initializes the var at position pos
 *
 * @note
 *      Do not return NULL!
 *      If this function is not set, FIRM will create a const node with tarval BAD.
 *      Use set_irg_loc_description()/get_irg_loc_description() to assign additional
 *      informations to local variables.
 */
typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
152

153
#ifdef __cplusplus
154
# define ENUM_BITSET(type) \
155
156
157
158
159
160
161
162
163
164
	extern "C++" { \
		static inline type operator ~  (type  a)         { return     (type)~(int)a;           } \
		static inline type operator &  (type  a, type b) { return     (type)((int)a & (int)b); } \
		static inline type operator &= (type& a, type b) { return a = (type)((int)a & (int)b); } \
		static inline type operator ^  (type  a, type b) { return     (type)((int)a ^ (int)b); } \
		static inline type operator ^= (type& a, type b) { return a = (type)((int)a ^ (int)b); } \
		static inline type operator |  (type  a, type b) { return     (type)((int)a | (int)b); } \
		static inline type operator |= (type& a, type b) { return a = (type)((int)a | (int)b); } \
	}
#else
165
166
167
168
/** Marks an enum type as bitset enum. That is the enumeration values will
 * probably be combined to form a (bit)set of flags.
 * When compiling for C++ this macro will define the ~, &, &=, ^, ^=, | and |=
 * operators for the enum values. */
169
# define ENUM_BITSET(type)
170
171
172
#endif

#ifdef __cplusplus
173
# define ENUM_COUNTABLE(type) \
174
175
176
177
178
	extern "C++" { \
		static inline type operator ++(type& a) { return a = (type)((int)a + 1); } \
		static inline type operator --(type& a) { return a = (type)((int)a - 1); } \
	}
#else
179
180
181
182
/** Marks an enum type as countable enum. The enumeration values will be a
 * linear sequence of numbers which can be iterated through by incrementing
 * by 1.
 * When compiling for C++ this macro will define the ++ and -- operators. */
183
# define ENUM_COUNTABLE(type)
184
185
#endif

186
/**
187
 * @ingroup ir_node
188
189
190
191
192
193
194
195
196
197
198
199
200
 * Relations for comparing numbers
 */
typedef enum ir_relation {
	ir_relation_false              = 0,       /**< always false */
	ir_relation_equal              = 1u << 0, /**< equal */
	ir_relation_less               = 1u << 1, /**< less */
	ir_relation_greater            = 1u << 2, /**< greater */
	ir_relation_unordered          = 1u << 3, /**< unordered */
	ir_relation_less_equal         = ir_relation_equal|ir_relation_less,    /**< less or equal */
	ir_relation_greater_equal      = ir_relation_equal|ir_relation_greater, /**< greater or equal */
	ir_relation_less_greater       = ir_relation_less|ir_relation_greater,  /** less or greater ('not equal' for integer numbers) */
	ir_relation_less_equal_greater = ir_relation_equal|ir_relation_less|ir_relation_greater, /**< less equal or greater ('not unordered') */
	ir_relation_unordered_equal    = ir_relation_unordered|ir_relation_equal, /**< unordered or equal */
yb9976's avatar
yb9976 committed
201
	ir_relation_unordered_less     = ir_relation_unordered|ir_relation_less,  /**< unordered or less */
202
203
204
205
206
207
208
209
	ir_relation_unordered_less_equal = ir_relation_unordered|ir_relation_less|ir_relation_equal, /**< unordered, less or equal */
	ir_relation_unordered_greater    = ir_relation_unordered|ir_relation_greater, /**< unordered or greater */
	ir_relation_unordered_greater_equal = ir_relation_unordered|ir_relation_greater|ir_relation_equal, /**< unordered, greater or equal */
	ir_relation_unordered_less_greater  = ir_relation_unordered|ir_relation_less|ir_relation_greater, /**< unordered, less or greater ('not equal' for floatingpoint numbers) */
	ir_relation_true                    = ir_relation_equal|ir_relation_less|ir_relation_greater|ir_relation_unordered, /**< always true */
} ir_relation;
ENUM_BITSET(ir_relation)

210
/**
211
 * @ingroup ir_node
212
213
214
 * constrained flags for memory operations.
 */
typedef enum ir_cons_flags {
215
216
217
218
219
220
221
	cons_none             = 0,        /**< No constrains. */
	cons_volatile         = 1U << 0,  /**< Memory operation is volatile. */
	cons_unaligned        = 1U << 1,  /**< Memory operation is unaligned. */
	cons_floats           = 1U << 2,  /**< Memory operation can float. */
	cons_throws_exception = 1U << 3,  /**< fragile op throws exception (and
	                                       produces X_regular and X_except
	                                       values) */
222
223
} ir_cons_flags;
ENUM_BITSET(ir_cons_flags)
224

225
226
227
228
/**
 * @ingroup ir_node
 * pinned states.
 */
229
typedef enum op_pin_state {
230
231
232
233
234
235
236
237
	op_pin_state_floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
	op_pin_state_pinned = 1,    /**< Nodes must remain in this basic block. */
	op_pin_state_exc_pinned,    /**< Node must be remain in this basic block if it can throw an
	                                 exception, else can float. Used internally. */
	op_pin_state_mem_pinned     /**< Node must be remain in this basic block if it can throw an
	                                 exception or uses memory, else can float. Used internally. */
} op_pin_state;

238
/**
239
 * @ingroup Cond
240
241
 * A type to express conditional jump predictions.
 */
242
typedef enum cond_jmp_predicate {
243
244
245
246
247
	COND_JMP_PRED_NONE,        /**< No jump prediction. Default. */
	COND_JMP_PRED_TRUE,        /**< The True case is predicted. */
	COND_JMP_PRED_FALSE        /**< The False case is predicted. */
} cond_jmp_predicate;

248
/**
249
 * @ingroup method_type
250
251
252
253
 * Additional method type properties:
 * Tell about special properties of a method type. Some
 * of these may be discovered by analyses.
 */
254
typedef enum mtp_additional_properties {
255
256
257
	mtp_no_property            = 0x00000000, /**< no additional properties, default */
	mtp_property_const         = 0x00000001, /**< This method did not access memory and calculates
	                                              its return values solely from its parameters.
258
259
260
261
	                                              The only observable effect of a const function must be its
	                                              return value. So they must not exhibit infinite loops or wait
	                                              for user input. The return value must not depend on any
	                                              global variables/state.
262
263
264
265
	                                              GCC: __attribute__((const)). */
	mtp_property_pure          = 0x00000002, /**< This method did NOT write to memory and calculates
	                                              its return values solely from its parameters and
	                                              the memory they points to (or global vars).
266
267
268
	                                              The only observable effect of a const function must be its
	                                              return value. So they must not exhibit infinite loops or wait
	                                              for user input.
269
270
271
272
273
274
275
276
277
278
	                                              GCC: __attribute__((pure)). */
	mtp_property_noreturn      = 0x00000004, /**< This method did not return due to an aborting system
	                                              call.
	                                              GCC: __attribute__((noreturn)). */
	mtp_property_nothrow       = 0x00000008, /**< This method cannot throw an exception.
	                                              GCC: __attribute__((nothrow)). */
	mtp_property_naked         = 0x00000010, /**< This method is naked.
	                                              GCC: __attribute__((naked)). */
	mtp_property_malloc        = 0x00000020, /**< This method returns newly allocate memory.
	                                              GCC: __attribute__((malloc)). */
279
	mtp_property_returns_twice = 0x00000040, /**< This method can return more than one (typically setjmp).
280
                                                  GCC: __attribute__((returns_twice)). */
281
	mtp_property_intrinsic     = 0x00000080, /**< This method is intrinsic. It is expected that
282
	                                              a lowering phase will remove all calls to it. */
283
284
	mtp_property_runtime       = 0x00000100, /**< This method represents a runtime routine. */
	mtp_property_private       = 0x00000200, /**< All method invocations are known, the backend is free to
285
	                                              optimize the call in any possible way. */
286
	mtp_property_has_loop      = 0x00000400, /**< Set, if this method contains one possible endless loop. */
287
288
	mtp_property_inherited     = (1<<31)     /**< Internal. Used only in irg's, means property is
	                                              inherited from type. */
289
290
} mtp_additional_properties;
ENUM_BITSET(mtp_additional_properties)
291

292
293
294
/**
 * @ingroup SymConst
 * This enum names the different kinds of symbolic Constants represented by
295
 * SymConst.  The content of the attribute symconst_symbol depends on this tag.
296
297
 * Use the proper access routine after testing this flag.
 */
298
typedef enum symconst_kind {
Matthias Braun's avatar
Matthias Braun committed
299
300
301
302
303
304
305
306
307
	symconst_type_size,   /**< The SymConst is the size of the given type.
	                           symconst_symbol is type *. */
	symconst_type_align,  /**< The SymConst is the alignment of the given type.
	                           symconst_symbol is type *. */
	symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
	                           by the linker.  The pointer is represented by an entity.
	                           symconst_symbol is entity *. */
	symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
	                           owner type. */
308
	symconst_enum_const   /**< The SymConst is a enumeration constant of an
Matthias Braun's avatar
Matthias Braun committed
309
310
311
	                           enumeration type. */
} symconst_kind;

312
313
314
/**
 * @ingroup SymConst
 * SymConst attribute.
Matthias Braun's avatar
Matthias Braun committed
315
316
 *
 *  This union contains the symbolic information represented by the node.
Matthias Braun's avatar
Matthias Braun committed
317
 *  @ingroup SymConst
Matthias Braun's avatar
Matthias Braun committed
318
319
320
321
322
323
324
 */
typedef union symconst_symbol {
	ir_type       *type_p;    /**< The type of a SymConst. */
	ir_entity     *entity_p;  /**< The entity of a SymConst. */
	ir_enum_const *enum_p;    /**< The enumeration constant of a SymConst. */
} symconst_symbol;

325
/**
Matthias Braun's avatar
Matthias Braun committed
326
 * @ingroup Alloc
327
 * The allocation place.
Matthias Braun's avatar
Matthias Braun committed
328
 */
329
typedef enum ir_where_alloc {
Matthias Braun's avatar
Matthias Braun committed
330
331
332
333
	stack_alloc,          /**< Alloc allocates the object on the stack. */
	heap_alloc            /**< Alloc allocates the object on the heap. */
} ir_where_alloc;

Matthias Braun's avatar
Matthias Braun committed
334
335
336
/** A input/output constraint attribute.
 * @ingroup ASM
 */
337
typedef struct ir_asm_constraint {
Matthias Braun's avatar
Matthias Braun committed
338
339
340
341
342
	unsigned       pos;           /**< The inputs/output position for this constraint. */
	ident          *constraint;   /**< The constraint for this input/output. */
	ir_mode        *mode;         /**< The mode of the constraint. */
} ir_asm_constraint;

Matthias Braun's avatar
Matthias Braun committed
343
344
345
/** Supported libFirm builtins.
 * @ingroup Builtin
 */
346
typedef enum ir_builtin_kind {
347
348
	ir_bk_trap,                   /**< GCC __builtin_trap(): insert trap */
	ir_bk_debugbreak,             /**< MS __debugbreak(): insert debug break */
349
	ir_bk_return_address,         /**< GCC __builtin_return_address() */
350
	ir_bk_frame_address,          /**< GCC __builtin_frame_address() */
351
	ir_bk_prefetch,               /**< GCC __builtin_prefetch() */
352
353
354
355
356
	ir_bk_ffs,                    /**< GCC __builtin_ffs(): find first (least) significant 1 bit */
	ir_bk_clz,                    /**< GCC __builtin_clz(): count leading zero */
	ir_bk_ctz,                    /**< GCC __builtin_ctz(): count trailing zero */
	ir_bk_popcount,               /**< GCC __builtin_popcount(): population count */
	ir_bk_parity,                 /**< GCC __builtin_parity(): parity */
Michael Beck's avatar
Michael Beck committed
357
	ir_bk_bswap,                  /**< byte swap */
358
359
	ir_bk_inport,                 /**< in port */
	ir_bk_outport,                /**< out port */
360
	ir_bk_inner_trampoline,       /**< address of a trampoline for GCC inner functions */
361
	ir_bk_last = ir_bk_inner_trampoline,
362
363
} ir_builtin_kind;

364
365
366
/**
 * Possible return values of value_classify().
 */
367
typedef enum ir_value_classify_sign {
368
369
370
371
372
373
	value_classified_unknown  = 0,   /**< could not classify */
	value_classified_positive = 1,   /**< value is positive, i.e. >= 0 */
	value_classified_negative = -1   /**< value is negative, i.e. <= 0 if
	                                      no signed zero exists or < 0 else */
} ir_value_classify_sign;

374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/**
 * This enumeration flags the volatility of entities and Loads/Stores.
 */
typedef enum {
	volatility_non_volatile,    /**< The entity is not volatile. Default. */
	volatility_is_volatile      /**< The entity is volatile. */
} ir_volatility;

/**
 * This enumeration flags the align of Loads/Stores.
 */
typedef enum {
	align_is_aligned = 0, /**< The entity is aligned. Default */
	align_non_aligned,    /**< The entity is not aligned. */
} ir_align;

390
391
#include "end.h"

392
#endif