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"
38 #include "execution_frequency.h"
40 #include "callgraph.h"
42 #include "field_temperature.h"
43 #include "irphases_t.h"
52 /** The type of an ir_op. */
54 unsigned code; /**< The unique opcode of the op. */
55 ident *name; /**< The name of the op. */
56 size_t attr_size; /**< Space needed in memory for private attributes. */
57 op_pin_state pin_state; /**< How to deal with the node in CSE, PRE. */
58 op_arity opar; /**< The arity of operator. */
59 int op_index; /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */
60 unsigned flags; /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */
61 unsigned tag; /**< Some custom TAG value the op's creator set to. */
62 void *attr; /**< custom pointer where op's creator can attach attribute stuff to. */
64 ir_op_ops ops; /**< The operations of the this op. */
68 * Contains relevant information about a mode.
70 * Necessary information about a mode is stored in this struct
71 * which is used by the tarval module to perform calculations
72 * and comparisons of values of a such described mode.
75 * - ir_modecode code: An unambiguous int (enum) for the mode
76 * - ident *name: Name of this mode. Two modes are different if the name is different.
77 * - ir_mode_sort sort: sort of mode specifying possible usage categories
78 * - int size: size of the mode in Bits.
79 * - unsigned sign:1: signedness of this mode
81 * - modulo_shift specifies for modes of kind irms_int_number
82 * whether shift applies modulo to value of bits to shift
85 * The tech report 1999-44 describing FIRM and predefined modes
89 firm_kind kind; /**< distinguishes this node from others */
90 ir_modecode code; /**< unambiguous identifier of a mode */
91 ident *name; /**< Name ident of this mode */
93 /* ----------------------------------------------------------------------- */
94 /* On changing this struct you have to evaluate the mode_are_equal function!*/
95 ir_mode_sort sort; /**< coarse classification of this mode:
96 int, float, reference ...
99 arithmetic; /**< different arithmetic operations possible with a mode */
100 unsigned size; /**< size of the mode in Bits. */
101 unsigned sign:1; /**< signedness of this mode */
102 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
103 unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with
104 vector_elem number of elements, size contains the size
105 of all bits and must be dividable by vector_elem */
107 /* ----------------------------------------------------------------------- */
108 tarval *min; /**< the minimum value that can be expressed */
109 tarval *max; /**< the maximum value that can be expressed */
110 tarval *null; /**< the value 0 */
111 tarval *one; /**< the value 1 */
112 tarval *minus_one; /**< the value -1 */
113 tarval *all_one; /**< the value ~0 */
114 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
115 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
116 void *link; /**< To store some intermediate information */
117 const void *tv_priv; /**< tarval module will save private data here */
120 /** ir node attributes **/
122 /** Block attributes */
124 /* General attributes */
125 ir_graph *irg; /**< The graph this block belongs to. */
126 ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
127 /* Attributes private to construction: */
128 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
129 unsigned is_dead:1; /**< If set, the block is dead (and could be replace by a Bad. */
130 unsigned is_mb_head:1; /**< Set if this block is a macroblock head. */
131 unsigned has_label:1; /**< Set if this block has a label assigned. */
132 unsigned marked:1; /**< Can be set/unset to temporary mark a block. */
133 ir_node **graph_arr; /**< An array to store all parameters. */
134 /* Attributes holding analyses information */
135 ir_dom_info dom; /**< Datastructure that holds information about dominators.
137 Eventually overlay with graph_arr as only valid
138 in different phases. Eventually inline the whole
140 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
141 ir_node ** in_cg; /**< array with predecessors in
142 * interprocedural_view, if they differ
143 * from intraprocedural predecessors */
144 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge.*/
145 unsigned *cg_backedge; /**< Raw Bitfield n set to true if pred n is interprocedural backedge. */
146 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
147 ir_region *region; /**< The immediate structural region this block belongs to. */
148 unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */
149 ir_label_t label; /**< The block label if assigned. */
150 ir_node *phis; /**< The list of Phi nodes in this block. */
152 struct list_head succ_head; /**< A list head for all successor edges of a block. */
155 /** Cond attributes. */
157 cond_kind kind; /**< flavor of Cond */
158 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
159 cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
162 /** Const attributes. */
164 tarval *tv; /**< the target value */
165 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
168 /** SymConst attributes. */
170 symconst_symbol sym; // old tori
172 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
175 /** Sel attributes. */
177 ir_entity *entity; /**< entity to select */
180 /** Exception attributes. */
182 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
183 If it's know that no exception will be generated, could be set to
184 op_pin_state_floats. */
185 #if PRECISE_EXC_CONTEXT
186 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
190 /** Call attributes. */
192 except_attr exc; /**< the exception attribute. MUST be the first one. */
193 ir_type *type; /**< type of called procedure */
194 ir_entity ** callee_arr; /**< result of callee analysis */
197 /** Builtin attributes. */
199 except_attr exc; /**< the exception attribute. MUST be the first one. */
200 ir_builtin_kind kind; /**< kind of the called builtin procedure */
201 ir_type *type; /**< type of called builtin procedure */
204 /** Alloc attributes. */
206 except_attr exc; /**< the exception attribute. MUST be the first one. */
207 ir_where_alloc where; /**< stack, heap or other managed part of memory */
208 ir_type *type; /**< Type of the allocated object. */
211 /** Free attributes. */
213 ir_type *type; /**< Type of the allocated object. */
214 ir_where_alloc where; /**< stack, heap or other managed part of memory */
217 /** InstOf attributes. */
219 except_attr exc; /**< the exception attribute. MUST be the first one. */
220 ir_type *type; /**< the type of which the object pointer must be */
223 /** Filter attributes. */
225 long proj; /**< contains the result position to project (Proj) */
226 ir_node **in_cg; /**< array with interprocedural predecessors (Phi) */
227 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge. */
230 /** CallBegin attributes. */
232 ir_node *call; /**< Associated Call-operation. */
235 /** Cast attributes. */
237 ir_type *type; /**< Type of the casted node. */
240 /** Load attributes. */
242 except_attr exc; /**< The exception attribute. MUST be the first one. */
243 unsigned volatility:1; /**< The volatility of this Load operation. */
244 unsigned aligned:1; /**< The align attribute of this Load operation. */
245 ir_mode *mode; /**< The mode of this Load operation. */
248 /** Store attributes. */
250 except_attr exc; /**< the exception attribute. MUST be the first one. */
251 unsigned volatility:1; /**< The volatility of this Store operation. */
252 unsigned aligned:1; /**< The align attribute of this Store operation. */
256 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
258 unsigned *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
259 int pos; /**< For Phi0. Used to remember the value defined by
260 this Phi node. Needed when the Phi is completed
261 to call get_r_internal_value() to find the
262 predecessors. If this attribute is set, the Phi
263 node takes the role of the obsolete Phi0 node,
264 therefore the name. */
269 /**< Confirm attribute. */
271 pn_Cmp cmp; /**< The compare operation. */
274 /** CopyB attribute. */
276 except_attr exc; /**< The exception attribute. MUST be the first one. */
277 ir_type *type; /**< Type of the copied entity. */
280 /** Bound attribute. */
282 except_attr exc; /**< The exception attribute. MUST be the first one. */
285 /** Conv attribute. */
287 char strict; /**< If set, this is a strict Conv that cannot be removed. */
290 /** Div/Mod/DivMod/Quot attribute. */
292 except_attr exc; /**< The exception attribute. MUST be the first one. */
293 ir_mode *resmode; /**< Result mode for the division. */
294 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
297 /** Inline Assembler support attribute. */
299 /* BEWARE: pin state MUST be the first attribute */
300 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
301 ident *asm_text; /**< The inline assembler text. */
302 ir_asm_constraint *inputs; /**< Input constraints. */
303 ir_asm_constraint *outputs; /**< Output constraints. */
304 ident **clobber; /**< List of clobbered registers. */
307 /** Some IR-nodes just have one attribute, these are stored here,
308 some have more. Their name is 'irnodename_attr' */
310 block_attr block; /**< For Block: Fields needed to construct it */
311 cond_attr cond; /**< For Cond. */
312 const_attr con; /**< For Const: contains the value of the constant and a type */
313 symconst_attr symc; /**< For SymConst. */
314 sel_attr sel; /**< For Sel. */
315 call_attr call; /**< For Call. */
316 builtin_attr builtin; /**< For Builtin. */
317 callbegin_attr callbegin; /**< For CallBegin. */
318 alloc_attr alloc; /**< For Alloc. */
319 free_attr free; /**< For Free. */
320 io_attr instof; /**< For InstOf */
321 cast_attr cast; /**< For Cast. */
322 load_attr load; /**< For Load. */
323 store_attr store; /**< For Store. */
324 phi_attr phi; /**< For Phi. */
325 long proj; /**< For Proj: contains the result position to project */
326 confirm_attr confirm; /**< For Confirm: compare operation and region. */
327 filter_attr filter; /**< For Filter */
328 except_attr except; /**< For Phi node construction in case of exceptions */
329 copyb_attr copyb; /**< For CopyB operation */
330 bound_attr bound; /**< For Bound operation */
331 conv_attr conv; /**< For Conv operation */
332 divmod_attr divmod; /**< For Div/Mod/DivMod operation */
333 asm_attr assem; /**< For ASM operation. */
337 * Edge info to put into an irn.
339 typedef struct _irn_edge_kind_info_t {
340 struct list_head outs_head; /**< The list of all outs. */
341 int out_count; /**< Number of outs in the list. */
344 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
349 typedef struct _ir_def_use_edge {
350 ir_node *use; /** The use node of that edge. */
351 int pos; /** The position of this edge in use's input array. */
355 * The common structure of an irnode.
356 * If the node has some attributes, they are stored in the attr field.
359 /* ------- Basics of the representation ------- */
360 firm_kind kind; /**< Distinguishes this node from others. */
361 unsigned node_idx; /**< The node index of this node in its graph. */
362 ir_op *op; /**< The Opcode of this node. */
363 ir_mode *mode; /**< The Mode of this node. */
364 struct ir_node **in; /**< The array of predecessors / operands. */
365 ir_visited_t visited; /**< The visited counter for walks of the graph. */
366 void *link; /**< To attach additional information to the node, e.g.
367 used during optimization to link to nodes that
368 shall replace a node. */
369 long node_nr; /**< A globally unique node number for each node. */
370 /* ------- Fields for optimizations / analysis information ------- */
371 ir_def_use_edge *out; /**< array of def-use edges. */
372 struct dbg_info *dbi; /**< A pointer to information for debug support. */
373 /* ------- For debugging ------- */
375 unsigned out_valid : 1;
378 /* ------- For analyses -------- */
379 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
380 struct ir_node **deps; /**< Additional dependencies induced by state. */
382 irn_edges_info_t edge_info; /**< Everlasting out edges. */
383 /* ------- Opcode depending fields -------- */
384 attr attr; /**< The set of attributes of this node. Depends on opcode.
385 Must be last field of struct ir_node. */
388 #include "iredgeset.h"
391 * Edge info to put into an irg.
393 typedef struct _irg_edge_info_t {
394 ir_edgeset_t edges; /**< A set containing all edges of the current graph. */
395 struct list_head free_edges; /**< list of all free edges. */
396 struct obstack edges_obst; /**< Obstack, where edges are allocated on. */
397 unsigned allocated : 1; /**< Set if edges are allocated on the obstack. */
398 unsigned activated : 1; /**< Set if edges are activated for the graph. */
401 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
404 * Index constants for nodes that can be accessed through the graph anchor node.
407 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
408 anchor_start_block, /**< block the start node will belong to */
409 anchor_end, /**< end node of this ir_graph */
410 anchor_start, /**< start node of this ir_graph */
411 anchor_end_reg, /**< end node of this ir_graph */
412 anchor_end_except, /**< end node of this ir_graph */
413 anchor_initial_exec, /**< methods initial control flow */
414 anchor_frame, /**< methods frame */
415 anchor_tls, /**< pointer to the thread local storage containing all
416 thread local data. */
417 anchor_initial_mem, /**< initial memory of this graph */
418 anchor_args, /**< methods arguments */
419 anchor_bad, /**< bad node of this ir_graph, the one and
420 only in this graph */
421 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
425 /** A callgraph entry for callees. */
426 typedef struct cg_callee_entry {
427 ir_graph *irg; /**< The called irg. */
428 ir_node **call_list; /**< The list of all calls to the irg. */
429 int max_depth; /**< Maximum depth of all Call nodes to irg. */
433 * An ir_graph holds all information for a procedure.
436 firm_kind kind; /**< Always set to k_ir_graph. */
437 /* -- Basics of the representation -- */
438 unsigned last_node_idx; /**< The last IR node index for this graph. */
439 ir_entity *ent; /**< The entity of this procedure, i.e.,
440 the type of the procedure and the
441 class it belongs to. */
442 ir_type *frame_type; /**< A class type representing the stack frame.
443 Can include "inner" methods. */
444 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
445 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
446 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
447 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
449 /* -- Fields for graph properties -- */
450 irg_inline_property inline_property; /**< How to handle inlineing. */
451 unsigned additional_properties; /**< Additional graph properties. */
453 /* -- Fields indicating different states of irgraph -- */
455 irg_phase_state phase_state; /**< Compiler phase. */
456 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
457 irg_outs_state outs_state; /**< Out edges. */
458 irg_dom_state dom_state; /**< Dominator state information. */
459 irg_dom_state pdom_state; /**< Post Dominator state information. */
460 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
461 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
462 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
463 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
464 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
465 exec_freq_state execfreq_state; /**< Execution frequency state. */
466 ir_entity_usage_computed_state entity_usage_state;
467 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
468 unsigned fp_model; /**< floating point model of the graph. */
470 /* -- Fields for construction -- */
471 int n_loc; /**< Number of local variables in this
472 procedure including procedure parameters. */
473 void **loc_descriptions; /**< Storage for local variable descriptions. */
475 /* -- Fields for optimizations / analysis information -- */
476 pset *value_table; /**< Hash table for global value numbering (cse)
477 for optimizing use in iropt.c */
478 ir_def_use_edge *outs; /**< Space for the Def-Use arrays. */
480 ir_loop *loop; /**< The outermost loop for this graph. */
481 void *link; /**< A void* field to link any information to
484 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
485 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
486 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
487 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
488 ir_loop *l; /**< For callgraph analysis. */
489 int callgraph_loop_depth; /**< For callgraph analysis */
490 int callgraph_recursion_depth; /**< For callgraph analysis */
491 double method_execution_frequency; /**< For callgraph analysis */
494 /* -- Fields for Walking the graph -- */
495 ir_visited_t visited; /**< this flag is an identifier for
496 ir walk. it will be incremented
497 every time someone walks through
499 ir_visited_t block_visited; /**< same as visited, for a complete block */
501 ir_visited_t self_visited; /**< visited flag of the irg */
503 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
504 updated after every walk */
505 irg_edges_info_t edge_info; /**< edge info for automatic outs */
506 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
508 int index; /**< a unique number for each graph */
509 ir_phase *phases[PHASE_LAST]; /**< Phase information. */
511 int n_outs; /**< Size wasted for outs */
512 long graph_nr; /**< a unique graph number for each
513 graph to make output readable. */
517 ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
523 firm_kind kind; /**< must be k_ir_prog */
524 ident *name; /**< A file name or the like. */
525 ir_graph *main_irg; /**< The entry point to the compiled program
526 or NULL if no point exists. */
527 ir_graph **graphs; /**< A list of all graphs in the ir. */
528 ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */
529 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
530 to allocate nodes the represent values
531 of constant entities. It is not meant as
533 ir_type *segment_types[IR_SEGMENT_COUNT];
534 ir_type **types; /**< A list of all types in the ir. */
535 ir_mode **modes; /**< A list of all modes in the ir. */
536 ir_op **opcodes; /**< A list of all opcodes in the ir. */
537 ident **global_asms; /**< An array of global ASM insertions. */
539 /* -- states of and access to generated information -- */
540 irg_phase_state phase_state; /**< The state of construction. */
542 ip_view_state ip_view; /**< The state of interprocedural view. */
544 irg_outs_state outs_state; /**< The state of out edges of ir nodes. */
545 ir_node **ip_outedges; /**< A huge Array that contains all out edges
546 in interprocedural view. */
547 irg_outs_state trouts_state; /**< The state of out edges of type information. */
549 irg_callee_info_state callee_info_state; /**< Validity of callee information.
550 Contains the lowest value or all irgs. */
551 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
552 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
553 of inheritance relations. */
555 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
556 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
557 to looptree over callgraph. */
558 int max_callgraph_loop_depth; /**< needed in callgraph. */
559 int max_callgraph_recursion_depth; /**< needed in callgraph. */
560 double max_method_execution_frequency; /**< needed in callgraph. */
561 irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
562 exec_freq_state execfreq_state; /**< The state of execution frequency information */
563 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
564 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
565 ir_entity_usage_computed_state globals_entity_usage_state;
567 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
568 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
569 int max_irg_idx; /**< highest unused irg index */
570 long max_node_nr; /**< to generate unique numbers for nodes. */
572 ir_resources_t reserved_resources; /**< Bitset for tracking used global resources. */