2 * Copyright (C) 1995-2010 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 Definition of opaque firm types
23 * @author Michael Beck
26 #ifndef FIRM_COMMON_FIRM_TYPES_H
27 #define FIRM_COMMON_FIRM_TYPES_H
31 typedef unsigned long ir_visited_t;
32 typedef unsigned long ir_exc_region_t;
33 typedef unsigned long ir_label_t;
35 typedef struct dbg_info dbg_info, *dbg_info_ptr;
36 typedef struct type_dbg_info type_dbg_info, *type_dbg_info_ptr;
37 typedef struct ident ident, *ir_ident_ptr;
38 typedef struct ir_node ir_node, *ir_node_ptr;
39 typedef struct ir_op ir_op, *ir_op_ptr;
40 typedef struct ir_mode ir_mode, *ir_mode_ptr;
41 typedef struct ir_edge_t ir_edge_t, *ir_edge_ptr;
42 typedef struct ir_heights_t ir_heights_t;
43 typedef struct ir_tarval ir_tarval, *ir_tarval_ptr;
44 typedef struct ir_enum_const ir_enum_const, *ir_enum_const_ptr;
45 typedef struct ir_type ir_type, *ir_type_ptr;
46 typedef struct ir_graph ir_graph, *ir_graph_ptr;
47 typedef struct ir_prog ir_prog, *ir_prog_ptr;
48 typedef struct ir_loop ir_loop, *ir_loop_ptr;
49 typedef struct ir_region ir_region, *ir_region_ptr;
50 typedef struct ir_reg_tree ir_reg_tree, *ir_reg_tree_ptr;
51 typedef struct ir_entity ir_entity, *ir_entity_ptr;
52 typedef struct ir_extblk ir_extblk, *ir_extblk_ptr;
53 typedef struct ir_exec_freq ir_exec_freq, *ir_exec_freq_ptr;
54 typedef struct ir_cdep ir_cdep, *ir_cdep_ptr;
55 typedef struct sn_entry *seqno_t;
56 typedef struct arch_irn_ops_t arch_irn_ops_t;
57 typedef struct type_identify_if_t type_identify_if_t;
58 typedef struct ir_graph_pass_t ir_graph_pass_t;
59 typedef struct ir_prog_pass_t ir_prog_pass_t;
61 typedef struct ir_graph_pass_manager_t ir_graph_pass_manager_t;
62 typedef struct ir_prog_pass_manager_t ir_prog_pass_manager_t;
64 typedef union ir_initializer_t ir_initializer_t, *ir_initializer_ptr;
66 typedef void irg_walk_func(ir_node *, void *);
67 typedef void irg_reg_walk_func(ir_region *, void *);
70 typedef struct ir_settings_arch_dep_t ir_settings_arch_dep_t;
71 typedef struct ir_settings_if_conv_t ir_settings_if_conv_t;
73 /* Needed for MSVC to suppress warnings because it doest NOT handle const right. */
74 typedef const ir_node *ir_node_cnst_ptr;
79 * This function is called, whenever a local variable is used before definition
81 * @param irg the IR graph on which this happens
82 * @param mode the mode of the local var
83 * @param pos position chosen be the frontend for this variable (n_loc)
85 * @return a firm node of mode @p mode that initializes the var at position pos
89 * If this function is not set, FIRM will create a const node with tarval BAD.
90 * Use set_irg_loc_description()/get_irg_loc_description() to assign additional
91 * informations to local variables.
93 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
96 # define ENUM_BITSET(type) \
98 static inline type operator ~ (type a) { return (type)~(int)a; } \
99 static inline type operator & (type a, type b) { return (type)((int)a & (int)b); } \
100 static inline type operator &= (type& a, type b) { return a = (type)((int)a & (int)b); } \
101 static inline type operator ^ (type a, type b) { return (type)((int)a ^ (int)b); } \
102 static inline type operator ^= (type& a, type b) { return a = (type)((int)a ^ (int)b); } \
103 static inline type operator | (type a, type b) { return (type)((int)a | (int)b); } \
104 static inline type operator |= (type& a, type b) { return a = (type)((int)a | (int)b); } \
107 # define ENUM_BITSET(type)
111 # define ENUM_COUNTABLE(type) \
113 static inline type operator ++(type& a) { return a = (type)((int)a + 1); } \
114 static inline type operator --(type& a) { return a = (type)((int)a - 1); } \
117 # define ENUM_COUNTABLE(type)
122 /** op_pin_state_pinned states. */
123 typedef enum op_pin_state {
124 op_pin_state_floats = 0, /**< Nodes of this opcode can be placed in any basic block. */
125 op_pin_state_pinned = 1, /**< Nodes must remain in this basic block. */
126 op_pin_state_exc_pinned, /**< Node must be remain in this basic block if it can throw an
127 exception, else can float. Used internally. */
128 op_pin_state_mem_pinned /**< Node must be remain in this basic block if it can throw an
129 exception or uses memory, else can float. Used internally. */
133 * A type to express conditional jump predictions.
135 typedef enum cond_jmp_predicate {
136 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
137 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
138 COND_JMP_PRED_FALSE /**< The False case is predicted. */
139 } cond_jmp_predicate;
142 * Additional method type properties:
143 * Tell about special properties of a method type. Some
144 * of these may be discovered by analyses.
146 typedef enum mtp_additional_properties {
147 mtp_no_property = 0x00000000, /**< no additional properties, default */
148 mtp_property_const = 0x00000001, /**< This method did not access memory and calculates
149 its return values solely from its parameters.
150 GCC: __attribute__((const)). */
151 mtp_property_pure = 0x00000002, /**< This method did NOT write to memory and calculates
152 its return values solely from its parameters and
153 the memory they points to (or global vars).
154 GCC: __attribute__((pure)). */
155 mtp_property_noreturn = 0x00000004, /**< This method did not return due to an aborting system
157 GCC: __attribute__((noreturn)). */
158 mtp_property_nothrow = 0x00000008, /**< This method cannot throw an exception.
159 GCC: __attribute__((nothrow)). */
160 mtp_property_naked = 0x00000010, /**< This method is naked.
161 GCC: __attribute__((naked)). */
162 mtp_property_malloc = 0x00000020, /**< This method returns newly allocate memory.
163 GCC: __attribute__((malloc)). */
164 mtp_property_returns_twice = 0x00000040, /**< This method can return more than one (typically setjmp).
165 GCC: __attribute__((returns_twice)). */
166 mtp_property_intrinsic = 0x00000080, /**< This method is intrinsic. It is expected that
167 a lowering phase will remove all calls to it. */
168 mtp_property_runtime = 0x00000100, /**< This method represents a runtime routine. */
169 mtp_property_private = 0x00000200, /**< All method invocations are known, the backend is free to
170 optimize the call in any possible way. */
171 mtp_property_has_loop = 0x00000400, /**< Set, if this method contains one possible endless loop. */
172 mtp_property_inherited = (1<<31) /**< Internal. Used only in irg's, means property is
173 inherited from type. */
174 } mtp_additional_properties;
175 ENUM_BITSET(mtp_additional_properties)
177 /** This enum names the different kinds of symbolic Constants represented by
178 * SymConst. The content of the attribute symconst_symbol depends on this tag.
179 * Use the proper access routine after testing this flag. */
180 typedef enum symconst_kind {
181 symconst_type_tag, /**< The SymConst is a type tag for the given type.
182 symconst_symbol is type *. */
183 symconst_type_size, /**< The SymConst is the size of the given type.
184 symconst_symbol is type *. */
185 symconst_type_align, /**< The SymConst is the alignment of the given type.
186 symconst_symbol is type *. */
187 symconst_addr_ent, /**< The SymConst is a symbolic pointer to be filled in
188 by the linker. The pointer is represented by an entity.
189 symconst_symbol is entity *. */
190 symconst_ofs_ent, /**< The SymConst is the offset of its entity in the entities
192 symconst_enum_const /**< The SymConst is a enumeration constant of an
196 /** SymConst attribute.
198 * This union contains the symbolic information represented by the node.
200 typedef union symconst_symbol {
201 ir_type *type_p; /**< The type of a SymConst. */
202 ir_entity *entity_p; /**< The entity of a SymConst. */
203 ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */
206 /** The allocation place. */
207 typedef enum ir_where_alloc {
208 stack_alloc, /**< Alloc allocates the object on the stack. */
209 heap_alloc /**< Alloc allocates the object on the heap. */
212 /** A input/output constraint attribute. */
213 typedef struct ir_asm_constraint {
214 unsigned pos; /**< The inputs/output position for this constraint. */
215 ident *constraint; /**< The constraint for this input/output. */
216 ir_mode *mode; /**< The mode of the constraint. */
219 /** Supported libFirm builtins. */
220 typedef enum ir_builtin_kind {
221 ir_bk_trap, /**< GCC __builtin_trap(): insert trap */
222 ir_bk_debugbreak, /**< MS __debugbreak(): insert debug break */
223 ir_bk_return_address, /**< GCC __builtin_return_address() */
224 ir_bk_frame_address, /**< GCC __builtin_frame_address() */
225 ir_bk_prefetch, /**< GCC __builtin_prefetch() */
226 ir_bk_ffs, /**< GCC __builtin_ffs(): find first (least) significant 1 bit */
227 ir_bk_clz, /**< GCC __builtin_clz(): count leading zero */
228 ir_bk_ctz, /**< GCC __builtin_ctz(): count trailing zero */
229 ir_bk_popcount, /**< GCC __builtin_popcount(): population count */
230 ir_bk_parity, /**< GCC __builtin_parity(): parity */
231 ir_bk_bswap, /**< byte swap */
232 ir_bk_inport, /**< in port */
233 ir_bk_outport, /**< out port */
234 ir_bk_inner_trampoline, /**< address of a trampoline for GCC inner functions */
238 * Some projection numbers must be always equal to support automatic phi construction
241 pn_Generic_M = 0, /**< The memory result. */
242 pn_Generic_X_regular = 1, /**< Execution result if no exception occurred. */
243 pn_Generic_X_except = 2, /**< The control flow result branching to the exception handler */
244 pn_Generic_other = 3 /**< First free projection number */
248 * Possible return values of value_classify().
250 typedef enum ir_value_classify_sign {
251 value_classified_unknown = 0, /**< could not classify */
252 value_classified_positive = 1, /**< value is positive, i.e. >= 0 */
253 value_classified_negative = -1 /**< value is negative, i.e. <= 0 if
254 no signed zero exists or < 0 else */
255 } ir_value_classify_sign;