2 * Copyright (C) 1995-2008 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"
41 #include "irphases_t.h"
50 /** The type of an ir_op. */
52 unsigned code; /**< The unique opcode of the op. */
53 ident *name; /**< The name of the op. */
54 size_t attr_size; /**< Space needed in memory for private attributes. */
55 op_pin_state pin_state; /**< How to deal with the node in CSE, PRE. */
56 op_arity opar; /**< The arity of operator. */
57 int op_index; /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */
58 unsigned flags; /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */
59 unsigned tag; /**< Some custom TAG value the op's creator set to. */
60 void *attr; /**< custom pointer where op's creator can attach attribute stuff to. */
62 ir_op_ops ops; /**< The operations of the this op. */
66 * Contains relevant information about a mode.
68 * Necessary information about a mode is stored in this struct
69 * which is used by the tarval module to perform calculations
70 * and comparisons of values of a such described mode.
73 * - modecode code: An unambiguous int (enum) for the mode
74 * - ident *name: Name of this mode. Two modes are different if the name is different.
75 * - mode_sort sort: sort of mode specifying possible usage categories
76 * - int size: size of the mode in Bits.
77 * - unsigned sign:1: signedness of this mode
79 * - modulo_shift specifies for modes of kind irms_int_number
80 * whether shift applies modulo to value of bits to shift
83 * The tech report 1999-44 describing FIRM and predefined modes
87 firm_kind kind; /**< distinguishes this node from others */
88 modecode code; /**< unambiguous identifier of a mode */
89 ident *name; /**< Name ident of this mode */
91 /* ----------------------------------------------------------------------- */
92 /* On changing this struct you have to evaluate the mode_are_equal function!*/
93 mode_sort sort; /**< coarse classification of this mode:
94 int, float, reference ...
96 mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */
97 unsigned size; /**< size of the mode in Bits. */
98 unsigned sign:1; /**< signedness of this mode */
99 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
100 unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with
101 vector_elem number of elements, size contains the size
102 of all bits and must be dividable by vector_elem */
104 /* ----------------------------------------------------------------------- */
105 tarval *min; /**< the minimum value that can be expressed */
106 tarval *max; /**< the maximum value that can be expressed */
107 tarval *null; /**< the value 0 */
108 tarval *one; /**< the value 1 */
109 tarval *minus_one; /**< the value -1 */
110 tarval *all_one; /**< the value ~0 */
111 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
112 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
113 void *link; /**< To store some intermediate information */
114 const void *tv_priv; /**< tarval module will save private data here */
117 /** ir node attributes **/
119 /** Block attributes */
121 /* General attributes */
122 ir_graph *irg; /**< The graph this block belongs to. */
123 unsigned long block_visited; /**< For the walker that walks over all blocks. */
124 /* Attributes private to construction: */
125 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
126 unsigned is_dead:1; /**< If set, the block is dead (and could be replace by a Bad. */
127 unsigned is_mb_head:1; /**< Set if this block is a macroblock head. */
128 unsigned has_label:1; /**< Set if this block has a label assigned. */
129 unsigned marked:1; /**< Can be set/unset to temporary mark a block. */
130 ir_node **graph_arr; /**< An array to store all parameters. */
131 /* Attributes holding analyses information */
132 ir_dom_info dom; /**< Datastructure that holds information about dominators.
134 Eventually overlay with graph_arr as only valid
135 in different phases. Eventually inline the whole
137 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
138 ir_node ** in_cg; /**< array with predecessors in
139 * interprocedural_view, if they differ
140 * from intraprocedural predecessors */
141 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge.*/
142 unsigned *cg_backedge; /**< Raw Bitfield n set to true if pred n is interprocedural backedge. */
143 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
144 ir_region *region; /**< The immediate structural region this block belongs to. */
145 unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */
146 ir_label_t label; /**< The block label if assigned. */
147 ir_node *phis; /**< The list of Phi nodes in this block. */
149 struct list_head succ_head; /**< A list head for all successor edges of a block. */
152 /** Cond attributes. */
154 cond_kind kind; /**< flavor of Cond */
155 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
156 cond_jmp_predicate pred; /**< only for binary Conds: The jump predication. */
159 /** Const attributes. */
161 tarval *tv; /**< the target value */
162 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
165 /** SymConst attributes. */
167 symconst_symbol sym; // old tori
169 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
172 /** Sel attributes. */
174 ir_entity *ent; /**< entity to select */
177 /** Exception attributes. */
179 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
180 If it's know that no exception will be generated, could be set to
181 op_pin_state_floats. */
182 #if PRECISE_EXC_CONTEXT
183 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
187 /** Call attributes. */
189 except_attr exc; /**< the exception attribute. MUST be the first one. */
190 ir_type *cld_tp; /**< type of called procedure */
191 ir_entity ** callee_arr; /**< result of callee analysis */
194 /** Alloc attributes. */
196 except_attr exc; /**< the exception attribute. MUST be the first one. */
197 ir_where_alloc where; /**< stack, heap or other managed part of memory */
198 ir_type *type; /**< Type of the allocated object. */
201 /** Free attributes. */
203 ir_type *type; /**< Type of the allocated object. */
204 ir_where_alloc where; /**< stack, heap or other managed part of memory */
207 /** InstOf attributes. */
209 except_attr exc; /**< the exception attribute. MUST be the first one. */
210 ir_type *type; /**< the type of which the object pointer must be */
213 /** Filter attributes. */
215 long proj; /**< contains the result position to project (Proj) */
216 ir_node **in_cg; /**< array with interprocedural predecessors (Phi) */
217 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge. */
220 /** CallBegin attributes. */
222 ir_node *call; /**< Associated Call-operation. */
225 /** Cast attributes. */
227 ir_type *totype; /**< Type of the casted node. */
230 /** Load attributes. */
232 except_attr exc; /**< The exception attribute. MUST be the first one. */
233 unsigned volatility:1; /**< The volatility of this Load operation. */
234 unsigned aligned:1; /**< The align attribute of this Load operation. */
235 ir_mode *load_mode; /**< The mode of this Load operation. */
238 /** Store attributes. */
240 except_attr exc; /**< the exception attribute. MUST be the first one. */
241 unsigned volatility:1; /**< The volatility of this Store operation. */
242 unsigned aligned:1; /**< The align attribute of this Store operation. */
246 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
248 unsigned *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
249 int pos; /**< For Phi0. Used to remember the value defined by
250 this Phi node. Needed when the Phi is completed
251 to call get_r_internal_value() to find the
252 predecessors. If this attribute is set, the Phi
253 node takes the role of the obsolete Phi0 node,
254 therefore the name. */
259 /**< Confirm attribute. */
261 pn_Cmp cmp; /**< The compare operation. */
264 /** CopyB attribute. */
266 except_attr exc; /**< The exception attribute. MUST be the first one. */
267 ir_type *data_type; /**< Type of the copied entity. */
270 /** Bound attribute. */
272 except_attr exc; /**< The exception attribute. MUST be the first one. */
275 /** Conv attribute. */
277 char strict; /**< If set, this is a strict Conv that cannot be removed. */
280 /** Div/Mod/DivMod/Quot attribute. */
282 except_attr exc; /**< The exception attribute. MUST be the first one. */
283 ir_mode *res_mode; /**< Result mode for the division. */
284 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
287 /** Inline Assembler support attribute. */
289 /* BEWARE: pin state MUST be the first attribute */
290 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
291 ident *asm_text; /**< The inline assembler text. */
292 ir_asm_constraint *inputs; /**< Input constraints. */
293 ir_asm_constraint *outputs; /**< Output constraints. */
294 ident **clobber; /**< List of clobbered registers. */
297 /** Some IR-nodes just have one attribute, these are stored here,
298 some have more. Their name is 'irnodename_attr' */
300 block_attr block; /**< For Block: Fields needed to construct it */
301 cond_attr cond; /**< For Cond. */
302 const_attr con; /**< For Const: contains the value of the constant and a type */
303 symconst_attr symc; /**< For SymConst. */
304 sel_attr sel; /**< For Sel. */
305 call_attr call; /**< For Call: pointer to the type of the method to call */
306 callbegin_attr callbegin; /**< For CallBegin. */
307 alloc_attr alloc; /**< For Alloc. */
308 free_attr free; /**< For Free. */
309 io_attr instof; /**< For InstOf */
310 cast_attr cast; /**< For Cast. */
311 load_attr load; /**< For Load. */
312 store_attr store; /**< For Store. */
313 phi_attr phi; /**< For Phi. */
314 long proj; /**< For Proj: contains the result position to project */
315 confirm_attr confirm; /**< For Confirm: compare operation and region. */
316 filter_attr filter; /**< For Filter */
317 except_attr except; /**< For Phi node construction in case of exceptions */
318 copyb_attr copyb; /**< For CopyB operation */
319 bound_attr bound; /**< For Bound operation */
320 conv_attr conv; /**< For Conv operation */
321 divmod_attr divmod; /**< For Div/Mod/DivMod operation */
322 asm_attr assem; /**< For ASM operation. */
326 * Edge info to put into an irn.
328 typedef struct _irn_edge_kind_info_t {
329 struct list_head outs_head; /**< The list of all outs. */
330 int out_count; /**< Number of outs in the list. */
333 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
336 * The common structure of an irnode.
337 * If the node has some attributes, they are stored in the attr field.
340 /* ------- Basics of the representation ------- */
341 firm_kind kind; /**< Distinguishes this node from others. */
342 unsigned node_idx; /**< The node index of this node in its graph. */
343 ir_op *op; /**< The Opcode of this node. */
344 ir_mode *mode; /**< The Mode of this node. */
345 struct ir_node **in; /**< The array of predecessors / operands. */
346 unsigned long visited; /**< The visited counter for walks of the graph. */
347 void *link; /**< To attach additional information to the node, e.g.
348 used while construction to link Phi0 nodes and
349 during optimization to link to nodes that
350 shall replace a node. */
351 /* ------- Fields for optimizations / analysis information ------- */
352 struct ir_node **out; /**< @deprecated array of out edges. */
353 struct dbg_info *dbi; /**< A pointer to information for debug support. */
354 /* ------- For debugging ------- */
356 unsigned out_valid : 1;
358 long node_nr; /**< A unique node number for each node to make output
361 /* ------- For analyses -------- */
362 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
363 #ifdef DO_HEAPANALYSIS
364 struct abstval *av; /**< Heapanalysis: The abstract value of this node. */
365 struct section *sec; /**< Heapanalysis: The section of this node. */
367 struct ir_node **deps; /**< Additional dependencies induced by state. */
368 irn_edges_info_t edge_info; /**< Everlasting out edges. */
369 /* ------- Opcode depending fields -------- */
370 attr attr; /**< The set of attributes of this node. Depends on opcode.
371 Must be last field of struct ir_node. */
374 #include "iredgeset.h"
377 * Edge info to put into an irg.
379 typedef struct _irg_edge_info_t {
381 struct obstack edges_obst;
382 unsigned allocated : 1;
383 unsigned activated : 1; /**< set if edges are activated for the graph. */
386 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
389 * Index constants for nodes that can be accessed through the graph anchor node.
392 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
393 anchor_start_block, /**< block the start node will belong to */
394 anchor_end, /**< end node of this ir_graph */
395 anchor_start, /**< start node of this ir_graph */
396 anchor_end_reg, /**< end node of this ir_graph */
397 anchor_end_except, /**< end node of this ir_graph */
398 anchor_initial_exec, /**< methods initial control flow */
399 anchor_frame, /**< methods frame */
400 anchor_tls, /**< pointer to the thread local storage containing all
401 thread local data. */
402 anchor_initial_mem, /**< initial memory of this graph */
403 anchor_args, /**< methods arguments */
404 anchor_value_param_base, /**< method value param base */
405 anchor_bad, /**< bad node of this ir_graph, the one and
406 only in this graph */
407 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
411 /** A callgraph entry for callees. */
412 typedef struct cg_callee_entry {
413 ir_graph *irg; /**< The called irg. */
414 ir_node **call_list; /**< The list of all calls to the irg. */
415 int max_depth; /**< Maximum depth of all Call nodes to irg. */
419 * An ir_graph holds all information for a procedure.
422 firm_kind kind; /**< Always set to k_ir_graph. */
423 /* -- Basics of the representation -- */
424 unsigned last_node_idx; /**< The last IR node index for this graph. */
425 ir_entity *ent; /**< The entity of this procedure, i.e.,
426 the type of the procedure and the
427 class it belongs to. */
428 ir_type *frame_type; /**< A class type representing the stack frame.
429 Can include "inner" methods. */
430 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
431 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
432 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
433 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
435 /* -- Fields for graph properties -- */
436 irg_inline_property inline_property; /**< How to handle inlineing. */
437 unsigned additional_properties; /**< Additional graph properties. */
439 /* -- Fields indicating different states of irgraph -- */
440 irg_phase_state phase_state; /**< Compiler phase. */
441 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
442 irg_outs_state outs_state; /**< Out edges. */
443 irg_dom_state dom_state; /**< Dominator state information. */
444 irg_dom_state pdom_state; /**< Post Dominator state information. */
445 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
446 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
447 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
448 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
449 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
450 exec_freq_state execfreq_state; /**< Execution frequency state. */
451 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
452 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
453 unsigned fp_model; /**< floating point model of the graph. */
455 /* -- Fields for construction -- */
456 #if USE_EXPLICIT_PHI_IN_STACK
457 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
459 int n_loc; /**< Number of local variables in this
460 procedure including procedure parameters. */
461 void **loc_descriptions; /**< Storage for local variable descriptions. */
463 /* -- Fields for optimizations / analysis information -- */
464 pset *value_table; /**< Hash table for global value numbering (cse)
465 for optimizing use in iropt.c */
466 ir_node **outs; /**< Space for the out arrays. */
468 ir_loop *loop; /**< The outermost loop for this graph. */
469 void *link; /**< A void* field to link any information to
472 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
473 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
474 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
475 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
476 int callgraph_loop_depth; /**< For callgraph analysis */
477 int callgraph_recursion_depth; /**< For callgraph analysis */
478 double method_execution_frequency; /**< For callgraph analysis */
480 ir_loop *l; /**< For callgraph analysis. */
482 /* -- Fields for Walking the graph -- */
483 unsigned long visited; /**< this flag is an identifier for
484 ir walk. it will be incremented
485 every time someone walks through
487 unsigned long block_visited; /**< same as visited, for a complete block */
489 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
490 updated after every walk */
491 irg_edges_info_t edge_info; /**< edge info for automatic outs */
492 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
494 int index; /**< a unique number for each graph */
495 ir_phase *phases[PHASE_LAST]; /**< Phase information. */
497 int n_outs; /**< Size wasted for outs */
498 long graph_nr; /**< a unique graph number for each
499 graph to make output readable. */
503 unsigned using_irn_visited : 1; /**< set to 1 if we are currently using the visited flag */
504 unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */
505 unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */
506 unsigned using_block_mark : 1; /**< set to 1 if we are currently using the block mark flags */
512 firm_kind kind; /**< must be k_ir_prog */
513 ident *name; /**< A file name or the like. */
514 ir_graph *main_irg; /**< The entry point to the compiled program
515 or NULL if no point exists. */
516 ir_graph **graphs; /**< A list of all graphs in the ir. */
517 ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */
518 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
519 to allocate nodes the represent values
520 of constant entities. It is not meant as
522 ir_type *glob_type; /**< The global type. Must be a class as it can
523 have fields and procedures. */
524 ir_type *tls_type; /**< The thread local storage type. Must be a struct as it can
526 ir_type *constructors_type; /**< contains links to module constructor
527 functions. Must be a struct */
528 ir_type **types; /**< A list of all types in the ir. */
529 ir_mode **modes; /**< A list of all modes in the ir. */
530 ir_op **opcodes; /**< A list of all opcodes in the ir. */
532 /* -- states of and access to generated information -- */
533 irg_phase_state phase_state; /**< The state of construction. */
535 ip_view_state ip_view; /**< The state of interprocedural view. */
537 irg_outs_state outs_state; /**< The state of out edges of ir nodes. */
538 ir_node **ip_outedges; /**< A huge Array that contains all out edges
539 in interprocedural view. */
540 irg_outs_state trouts_state; /**< The state of out edges of type information. */
542 irg_callee_info_state callee_info_state; /**< Validity of callee information.
543 Contains the lowest value or all irgs. */
544 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
545 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
546 of inheritance relations. */
548 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
549 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
550 to looptree over callgraph. */
551 int max_callgraph_loop_depth; /**< needed in callgraph. */
552 int max_callgraph_recursion_depth; /**< needed in callgraph. */
553 double max_method_execution_frequency; /**< needed in callgraph. */
554 irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
555 exec_freq_state execfreq_state; /**< The state of execution frequency information */
556 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
557 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
558 ir_address_taken_computed_state globals_adr_taken_state; /**< Address taken state of the globals. */
560 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
561 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
562 int max_irg_idx; /**< highest unused irg index */
564 long max_node_nr; /**< to generate unique numbers for nodes. */