2 * Copyright (C) 1995-2007 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 the Firm IR base types, concentrated here
23 * @author Michael Beck
26 #ifndef FIRM_IR_IRDEFS_H
27 #define FIRM_IR_IRDEFS_H
29 #include "firm_types.h"
30 #include "firm_common_t.h"
35 #include "iredgekinds.h"
36 #include "irtypeinfo.h"
37 #include "execution_frequency.h"
39 #include "callgraph.h"
40 #include "field_temperature.h"
46 /** The type of an ir_op. */
48 unsigned code; /**< The unique opcode of the op. */
49 ident *name; /**< The name of the op. */
50 size_t attr_size; /**< Space needed in memory for private attributes. */
51 op_pin_state op_pin_state_pinned; /**< How to deal with the node in CSE, PRE. */
52 op_arity opar; /**< The arity of operator. */
53 int op_index; /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */
54 unsigned flags; /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */
55 void *tag; /**< Some custom pointer the op's creator can attach stuff to. */
57 ir_op_ops ops; /**< The operations of the this op. */
61 * Contains relevant information about a mode.
63 * Necessary information about a mode is stored in this struct
64 * which is used by the tarval module to perform calculations
65 * and comparisons of values of a such described mode.
68 * - modecode code: An unambiguous int (enum) for the mode
69 * - ident *name: Name of this mode. Two modes are different if the name is different.
70 * - mode_sort sort: sort of mode specifying possible usage categories
71 * - int size: size of the mode in Bits.
72 * - unsigned sign:1: signedness of this mode
74 * - modulo_shift specifies for modes of kind irms_int_number
75 * whether shift applies modulo to value of bits to shift
78 * The tech report 1999-44 describing FIRM and predefined modes
82 firm_kind kind; /**< distinguishes this node from others */
83 modecode code; /**< unambiguous identifier of a mode */
84 ident *name; /**< Name ident of this mode */
86 /* ----------------------------------------------------------------------- */
87 /* On changing this struct you have to evaluate the mode_are_equal function!*/
88 mode_sort sort; /**< coarse classification of this mode:
89 int, float, reference ...
91 mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */
92 int size; /**< size of the mode in Bits. */
93 unsigned sign:1; /**< signedness of this mode */
94 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
95 unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with
96 vector_elem number of elements, size contains the size
97 of all bits and must be dividable by vector_elem */
99 /* ----------------------------------------------------------------------- */
100 tarval *min; /**< the minimum value that can be expressed */
101 tarval *max; /**< the maximum value that can be expressed */
102 tarval *null; /**< the value 0 */
103 tarval *one; /**< the value 1 */
104 tarval *minus_one; /**< the value -1 */
105 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
106 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
107 void *link; /**< To store some intermediate information */
108 const void *tv_priv; /**< tarval module will save private data here */
111 /** ir node attributes **/
113 /** Block attributes */
115 /* General attributes */
116 ir_graph *irg; /**< The graph this block belongs to. */
117 unsigned long block_visited; /**< For the walker that walks over all blocks. */
118 /* Attributes private to construction: */
119 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
120 unsigned is_dead:1; /**< If set, the block is dead (and could be replace by a Bad. */
121 unsigned is_mb_head:1; /**< Set if this block is a macroblock head. */
122 ir_node **graph_arr; /**< An array to store all parameters. */
123 /* Attributes holding analyses information */
124 ir_dom_info dom; /**< Datastructure that holds information about dominators.
126 Eventually overlay with graph_arr as only valid
127 in different phases. Eventually inline the whole
129 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
130 ir_node ** in_cg; /**< array with predecessors in
131 * interprocedural_view, if they differ
132 * from intraprocedural predecessors */
133 int *backedge; /**< Field n set to true if pred n is backedge.
134 @@@ @todo Ev. replace by bit field! */
135 int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge.
136 @@@ @todo Ev. replace by bit field! */
137 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
138 ir_region *region; /**< The immediate structural region this block belongs to. */
139 unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */
141 struct list_head succ_head; /**< A list head for all successor edges of a block. */
144 /** Cond attributes. */
146 cond_kind kind; /**< flavor of Cond */
147 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
148 cond_jmp_predicate pred; /**< only for binary Conds: The jump predication. */
151 /** Const attributes. */
153 tarval *tv; /**< the target value */
154 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
157 /** SymConst attributes. */
159 symconst_symbol sym; // old tori
161 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
164 /** Sel attributes. */
166 ir_entity *ent; /**< entity to select */
169 /** Exception attributes. */
171 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
172 If it's know that no exception will be generated, could be set to
173 op_pin_state_floats. */
174 #if PRECISE_EXC_CONTEXT
175 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
179 /** Call attributes. */
181 except_attr exc; /**< the exception attribute. MUST be the first one. */
182 ir_type *cld_tp; /**< type of called procedure */
183 ir_entity ** callee_arr; /**< result of callee analysis */
186 /** Alloc attributes. */
188 except_attr exc; /**< the exception attribute. MUST be the first one. */
189 ir_type *type; /**< Type of the allocated object. */
190 where_alloc where; /**< stack, heap or other managed part of memory */
193 /** Free attributes. */
195 ir_type *type; /**< Type of the allocated object. */
196 where_alloc where; /**< stack, heap or other managed part of memory */
199 /** InstOf attributes. */
201 except_attr exc; /**< the exception attribute. MUST be the first one. */
202 ir_type *type; /**< the type of which the object pointer must be */
205 /** Filter attributes. */
207 long proj; /**< contains the result position to project (Proj) */
208 ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */
209 int *backedge; /**< Field n set to true if pred n is backedge.
210 @todo Ev. replace by bitfield! */
213 /** CallBegin attributes. */
215 ir_node * call; /**< Associated Call-operation. */
218 /** Cast attributes. */
220 ir_type *totype; /**< Type of the casted node. */
223 /** Load attributes. */
225 except_attr exc; /**< The exception attribute. MUST be the first one. */
226 ir_mode *load_mode; /**< The mode of this Load operation. */
227 ir_volatility volatility; /**< The volatility of a Load/Store operation. */
230 /** Store attributes. */
232 except_attr exc; /**< the exception attribute. MUST be the first one. */
233 ir_volatility volatility; /**< the volatility of a Store operation */
237 int pos; /**< For Phi0. Used to remember the value defined by
238 this Phi node. Needed when the Phi is completed
239 to call get_r_internal_value to find the
240 predecessors. If this attribute is set, the Phi
241 node takes the role of the obsolete Phi0 node,
242 therefore the name. */
245 /**< Confirm attribute. */
247 pn_Cmp cmp; /**< The compare operation. */
250 /** CopyB attribute. */
252 except_attr exc; /**< The exception attribute. MUST be the first one. */
253 ir_type *data_type; /**< Type of the copied entity. */
256 /** Bound attribute. */
258 except_attr exc; /**< The exception attribute. MUST be the first one. */
261 /** Conv attribute. */
263 char strict; /**< If set, this is a strict Conv that cannot be removed. */
266 /** Div/Mod/DivMod/Quot attribute. */
268 except_attr exc; /**< The exception attribute. MUST be the first one. */
269 ir_mode *res_mode; /**< Result mode for the division. */
272 /** Inline Assembler support attribute. */
274 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
275 ident *asm_text; /**< The inline assembler text. */
276 ir_asm_constraint *inputs; /**< Input constraints. */
277 ir_asm_constraint *outputs; /**< Output constraints. */
278 ident **clobber; /**< List of clobbered registers. */
281 /** Some IR-nodes just have one attribute, these are stored here,
282 some have more. Their name is 'irnodename_attr' */
284 block_attr block; /**< For Block: Fields needed to construct it */
285 cond_attr cond; /**< For Cond. */
286 const_attr con; /**< For Const: contains the value of the constant and a type */
287 symconst_attr symc; /**< For SymConst. */
288 sel_attr sel; /**< For Sel. */
289 call_attr call; /**< For Call: pointer to the type of the method to call */
290 callbegin_attr callbegin; /**< For CallBegin. */
291 alloc_attr alloc; /**< For Alloc. */
292 free_attr free; /**< For Free. */
293 io_attr instof; /**< For InstOf */
294 cast_attr cast; /**< For Cast. */
295 load_attr load; /**< For Load. */
296 store_attr store; /**< For Store. */
297 phi0_attr phi0; /**< for Phi0 nodes. */
298 int *phi_backedge; /**< For Phi after construction.
299 Field n set to true if pred n is backedge.
300 @todo Ev. replace by bitfield! */
301 long proj; /**< For Proj: contains the result position to project */
302 confirm_attr confirm; /**< For Confirm: compare operation and region. */
303 filter_attr filter; /**< For Filter */
304 except_attr except; /**< For Phi node construction in case of exceptions */
305 copyb_attr copyb; /**< For CopyB operation */
306 bound_attr bound; /**< For Bound operation */
307 conv_attr conv; /**< For Conv operation */
308 divmod_attr divmod; /**< For Div/Mod/DivMod operation */
309 asm_attr assem; /**< For ASM operation. */
313 * Edge info to put into an irn.
315 typedef struct _irn_edge_kind_info_t {
316 struct list_head outs_head; /**< The list of all outs. */
317 int out_count; /**< Number of outs in the list. */
320 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
323 * The common structure of an irnode.
324 * If the node has some attributes, they are stored in the attr field.
327 /* ------- Basics of the representation ------- */
328 firm_kind kind; /**< Distinguishes this node from others. */
329 ir_op *op; /**< The Opcode of this node. */
330 ir_mode *mode; /**< The Mode of this node. */
331 struct ir_node **in; /**< The array of predecessors / operands. */
332 unsigned long visited; /**< The visited counter for walks of the graph. */
333 unsigned node_idx; /**< The node index of this node in its graph. */
334 void *link; /**< To attach additional information to the node, e.g.
335 used while construction to link Phi0 nodes and
336 during optimization to link to nodes that
337 shall replace a node. */
338 /* ------- Fields for optimizations / analysis information ------- */
339 struct ir_node **out; /**< @deprecated array of out edges. */
340 struct dbg_info *dbi; /**< A pointer to information for debug support. */
341 /* ------- For debugging ------- */
344 long node_nr; /**< A unique node number for each node to make output
347 /* ------- For analyses -------- */
348 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
349 #ifdef DO_HEAPANALYSIS
350 struct abstval *av; /**< Heapanalysis: The abstract value of this node. */
351 struct section *sec; /**< Heapanalysis: The section of this node. */
353 struct ir_node **deps; /**< Additional dependencies induced by state. */
354 irn_edges_info_t edge_info; /**< Everlasting out edges. */
355 /* ------- Opcode depending fields -------- */
356 attr attr; /**< The set of attributes of this node. Depends on opcode.
357 Must be last field of struct ir_node. */
361 * Edge info to put into an irg.
363 typedef struct _irg_edge_info_t {
364 set *edges; /**< a set containing all edges of a graph. */
365 unsigned activated : 1; /**< set if edges are activated for the graph. */
368 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
371 * Index constants for nodes that can be accessed through the graph anchor node.
374 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
375 anchor_start_block, /**< block the start node will belong to */
376 anchor_end, /**< end node of this ir_graph */
377 anchor_start, /**< start node of this ir_graph */
378 anchor_end_reg, /**< end node of this ir_graph */
379 anchor_end_except, /**< end node of this ir_graph */
380 anchor_frame, /**< method's frame */
381 anchor_globals, /**< pointer to the data segment containing all
382 globals as well as global procedures. */
383 anchor_tls, /**< pointer to the thread local storage containing all
384 thread local data. */
385 anchor_initial_mem, /**< initial memory of this graph */
386 anchor_args, /**< methods arguments */
387 anchor_value_param_base, /**< method value param base */
388 anchor_bad, /**< bad node of this ir_graph, the one and
389 only in this graph */
390 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
394 /** A callgraph entry for callees. */
395 typedef struct cg_callee_entry {
396 ir_graph *irg; /**< The called irg. */
397 ir_node **call_list; /**< The list of all calls to the irg. */
398 int max_depth; /**< Maximum depth of all Call nodes to irg. */
402 * An ir_graph holds all information for a procedure.
405 firm_kind kind; /**< Always set to k_ir_graph. */
406 /* -- Basics of the representation -- */
407 ir_entity *ent; /**< The entity of this procedure, i.e.,
408 the type of the procedure and the
409 class it belongs to. */
410 ir_type *frame_type; /**< A class type representing the stack frame.
411 Can include "inner" methods. */
412 ir_node *anchor; /**< The anchor node. */
413 ir_node **proj_args; /**< Projs of the methods arguments. */
414 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
415 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
416 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
418 unsigned last_node_idx; /**< The last IR node index for this graph. */
420 /* -- Fields for graph properties -- */
421 irg_inline_property inline_property; /**< How to handle inlineing. */
422 unsigned additional_properties; /**< Additional graph properties. */
424 /* -- Fields indicating different states of irgraph -- */
425 irg_phase_state phase_state; /**< Compiler phase. */
426 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
427 irg_outs_state outs_state; /**< Out edges. */
428 irg_dom_state dom_state; /**< Dominator state information. */
429 irg_dom_state pdom_state; /**< Post Dominator state information. */
430 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
431 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
432 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
433 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
434 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
435 exec_freq_state execfreq_state; /**< Execution frequency state. */
436 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
437 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
438 unsigned fp_model; /**< floating point model of the graph. */
440 /* -- Fields for construction -- */
441 #if USE_EXPLICIT_PHI_IN_STACK
442 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
444 int n_loc; /**< Number of local variables in this
445 procedure including procedure parameters. */
446 void **loc_descriptions; /**< Storage for local variable descriptions. */
448 /* -- Fields for optimizations / analysis information -- */
449 pset *value_table; /**< Hash table for global value numbering (cse)
450 for optimizing use in iropt.c */
451 ir_node **outs; /**< Space for the out arrays. */
453 ir_loop *loop; /**< The outermost loop for this graph. */
454 void *link; /**< A void* field to link any information to
457 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
458 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
459 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
460 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
461 int callgraph_loop_depth; /**< For callgraph analysis */
462 int callgraph_recursion_depth; /**< For callgraph analysis */
463 double method_execution_frequency; /**< For callgraph analysis */
465 ir_loop *l; /**< For callgraph analysis. */
467 /* -- Fields for Walking the graph -- */
468 unsigned long visited; /**< this flag is an identifier for
469 ir walk. it will be incremented
470 every time someone walks through
472 unsigned long block_visited; /**< same as visited, for a complete block */
474 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
475 updated after every walk */
476 irg_edges_info_t edge_info; /**< edge info for automatic outs */
477 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
480 int n_outs; /**< Size wasted for outs */
481 long graph_nr; /**< a unique graph number for each graph to make output
486 unsigned using_visited : 1; /**< set to 1 if we are currently using the visited flag */
487 unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */
488 unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */
494 firm_kind kind; /**< must be k_ir_prog */
495 ident *name; /**< A file name or the like. */
496 ir_graph *main_irg; /**< The entry point to the compiled program
497 or NULL if no point exists. */
498 ir_graph **graphs; /**< A list of all graphs in the ir. */
499 ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */
500 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
501 to allocate nodes the represent values
502 of constant entities. It is not meant as
504 ir_type *glob_type; /**< The global type. Must be a class as it can
505 have fields and procedures. */
506 ir_type *tls_type; /**< The thread local storage type. Must be a struct as it can
508 ir_type **types; /**< A list of all types in the ir. */
509 ir_mode **modes; /**< A list of all modes in the ir. */
510 ir_op **opcodes; /**< A list of all opcodes in the ir. */
512 /* -- states of and access to generated information -- */
513 irg_phase_state phase_state; /**< The state of construction. */
515 ip_view_state ip_view; /**< The state of interprocedural view. */
517 irg_outs_state outs_state; /**< The state of out edges of ir nodes. */
518 ir_node **ip_outedges; /**< A huge Array that contains all out edges
519 in interprocedural view. */
520 irg_outs_state trouts_state; /**< The state of out edges of type information. */
522 irg_callee_info_state callee_info_state; /**< Validity of callee information.
523 Contains the lowest value or all irgs. */
524 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
525 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
526 of inheritance relations. */
528 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
529 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
530 to looptree over callgraph. */
531 int max_callgraph_loop_depth; /**< needed in callgraph. */
532 int max_callgraph_recursion_depth; /**< needed in callgraph. */
533 double max_method_execution_frequency; /**< needed in callgraph. */
534 irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
535 exec_freq_state execfreq_state; /**< The state of execution frequency information */
536 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
537 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
538 ir_address_taken_computed_state globals_adr_taken_state; /**< Address taken state of the globals. */
540 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
542 long max_node_nr; /**< to generate unique numbers for nodes. */