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 void *tag; /**< Some custom pointer the op's creator can attach stuff 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 ir_node **graph_arr; /**< An array to store all parameters. */
130 /* Attributes holding analyses information */
131 ir_dom_info dom; /**< Datastructure that holds information about dominators.
133 Eventually overlay with graph_arr as only valid
134 in different phases. Eventually inline the whole
136 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
137 ir_node ** in_cg; /**< array with predecessors in
138 * interprocedural_view, if they differ
139 * from intraprocedural predecessors */
140 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge.*/
141 unsigned *cg_backedge; /**< Raw Bitfield n set to true if pred n is interprocedural backedge. */
142 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
143 ir_region *region; /**< The immediate structural region this block belongs to. */
144 unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */
145 ir_label_t label; /**< The block label if assigned. */
146 ir_node *phis; /**< The list of Phi nodes in this block. */
148 struct list_head succ_head; /**< A list head for all successor edges of a block. */
151 /** Cond attributes. */
153 cond_kind kind; /**< flavor of Cond */
154 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
155 cond_jmp_predicate pred; /**< only for binary Conds: The jump predication. */
158 /** Const attributes. */
160 tarval *tv; /**< the target value */
161 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
164 /** SymConst attributes. */
166 symconst_symbol sym; // old tori
168 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
171 /** Sel attributes. */
173 ir_entity *ent; /**< entity to select */
176 /** Exception attributes. */
178 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
179 If it's know that no exception will be generated, could be set to
180 op_pin_state_floats. */
181 #if PRECISE_EXC_CONTEXT
182 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
186 /** Call attributes. */
188 except_attr exc; /**< the exception attribute. MUST be the first one. */
189 ir_type *cld_tp; /**< type of called procedure */
190 ir_entity ** callee_arr; /**< result of callee analysis */
193 /** Alloc attributes. */
195 except_attr exc; /**< the exception attribute. MUST be the first one. */
196 ir_type *type; /**< Type of the allocated object. */
197 ir_where_alloc where; /**< stack, heap or other managed part of memory */
200 /** Free attributes. */
202 ir_type *type; /**< Type of the allocated object. */
203 ir_where_alloc where; /**< stack, heap or other managed part of memory */
206 /** InstOf attributes. */
208 except_attr exc; /**< the exception attribute. MUST be the first one. */
209 ir_type *type; /**< the type of which the object pointer must be */
212 /** Filter attributes. */
214 long proj; /**< contains the result position to project (Proj) */
215 ir_node **in_cg; /**< array with interprocedural predecessors (Phi) */
216 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge. */
219 /** CallBegin attributes. */
221 ir_node * call; /**< Associated Call-operation. */
224 /** Cast attributes. */
226 ir_type *totype; /**< Type of the casted node. */
229 /** Load attributes. */
231 except_attr exc; /**< The exception attribute. MUST be the first one. */
232 ir_mode *load_mode; /**< The mode of this Load operation. */
233 unsigned volatility:1; /**< The volatility of this Load operation. */
234 unsigned aligned:1; /**< The align attribute of this Load operation. */
237 /** Store attributes. */
239 except_attr exc; /**< the exception attribute. MUST be the first one. */
240 unsigned volatility:1; /**< The volatility of this Store operation. */
241 unsigned aligned:1; /**< The align attribute of this Store operation. */
245 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
247 unsigned *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
248 int pos; /**< For Phi0. Used to remember the value defined by
249 this Phi node. Needed when the Phi is completed
250 to call get_r_internal_value() to find the
251 predecessors. If this attribute is set, the Phi
252 node takes the role of the obsolete Phi0 node,
253 therefore the name. */
258 /**< Confirm attribute. */
260 pn_Cmp cmp; /**< The compare operation. */
263 /** CopyB attribute. */
265 except_attr exc; /**< The exception attribute. MUST be the first one. */
266 ir_type *data_type; /**< Type of the copied entity. */
269 /** Bound attribute. */
271 except_attr exc; /**< The exception attribute. MUST be the first one. */
274 /** Conv attribute. */
276 char strict; /**< If set, this is a strict Conv that cannot be removed. */
279 /** Div/Mod/DivMod/Quot attribute. */
281 except_attr exc; /**< The exception attribute. MUST be the first one. */
282 ir_mode *res_mode; /**< Result mode for the division. */
283 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
286 /** Inline Assembler support attribute. */
288 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
289 ident *asm_text; /**< The inline assembler text. */
290 ir_asm_constraint *inputs; /**< Input constraints. */
291 ir_asm_constraint *outputs; /**< Output constraints. */
292 ident **clobber; /**< List of clobbered registers. */
295 /** Some IR-nodes just have one attribute, these are stored here,
296 some have more. Their name is 'irnodename_attr' */
298 block_attr block; /**< For Block: Fields needed to construct it */
299 cond_attr cond; /**< For Cond. */
300 const_attr con; /**< For Const: contains the value of the constant and a type */
301 symconst_attr symc; /**< For SymConst. */
302 sel_attr sel; /**< For Sel. */
303 call_attr call; /**< For Call: pointer to the type of the method to call */
304 callbegin_attr callbegin; /**< For CallBegin. */
305 alloc_attr alloc; /**< For Alloc. */
306 free_attr free; /**< For Free. */
307 io_attr instof; /**< For InstOf */
308 cast_attr cast; /**< For Cast. */
309 load_attr load; /**< For Load. */
310 store_attr store; /**< For Store. */
311 phi_attr phi; /**< For Phi. */
312 long proj; /**< For Proj: contains the result position to project */
313 confirm_attr confirm; /**< For Confirm: compare operation and region. */
314 filter_attr filter; /**< For Filter */
315 except_attr except; /**< For Phi node construction in case of exceptions */
316 copyb_attr copyb; /**< For CopyB operation */
317 bound_attr bound; /**< For Bound operation */
318 conv_attr conv; /**< For Conv operation */
319 divmod_attr divmod; /**< For Div/Mod/DivMod operation */
320 asm_attr assem; /**< For ASM operation. */
324 * Edge info to put into an irn.
326 typedef struct _irn_edge_kind_info_t {
327 struct list_head outs_head; /**< The list of all outs. */
328 int out_count; /**< Number of outs in the list. */
331 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
334 * The common structure of an irnode.
335 * If the node has some attributes, they are stored in the attr field.
338 /* ------- Basics of the representation ------- */
339 firm_kind kind; /**< Distinguishes this node from others. */
340 ir_op *op; /**< The Opcode of this node. */
341 ir_mode *mode; /**< The Mode of this node. */
342 struct ir_node **in; /**< The array of predecessors / operands. */
343 unsigned long visited; /**< The visited counter for walks of the graph. */
344 unsigned node_idx; /**< The node index of this node in its graph. */
345 void *link; /**< To attach additional information to the node, e.g.
346 used while construction to link Phi0 nodes and
347 during optimization to link to nodes that
348 shall replace a node. */
349 /* ------- Fields for optimizations / analysis information ------- */
350 struct ir_node **out; /**< @deprecated array of out edges. */
351 struct dbg_info *dbi; /**< A pointer to information for debug support. */
352 /* ------- For debugging ------- */
354 unsigned out_valid : 1;
356 long node_nr; /**< A unique node number for each node to make output
359 /* ------- For analyses -------- */
360 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
361 #ifdef DO_HEAPANALYSIS
362 struct abstval *av; /**< Heapanalysis: The abstract value of this node. */
363 struct section *sec; /**< Heapanalysis: The section of this node. */
365 struct ir_node **deps; /**< Additional dependencies induced by state. */
366 irn_edges_info_t edge_info; /**< Everlasting out edges. */
367 /* ------- Opcode depending fields -------- */
368 attr attr; /**< The set of attributes of this node. Depends on opcode.
369 Must be last field of struct ir_node. */
372 #include "iredgeset.h"
375 * Edge info to put into an irg.
377 typedef struct _irg_edge_info_t {
379 set *edges; /**< a set containing all edges of a graph. */
382 struct obstack edges_obst;
383 unsigned allocated : 1;
385 unsigned activated : 1; /**< set if edges are activated for the graph. */
388 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
391 * Index constants for nodes that can be accessed through the graph anchor node.
394 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
395 anchor_start_block, /**< block the start node will belong to */
396 anchor_end, /**< end node of this ir_graph */
397 anchor_start, /**< start node of this ir_graph */
398 anchor_end_reg, /**< end node of this ir_graph */
399 anchor_end_except, /**< end node of this ir_graph */
400 anchor_frame, /**< method's frame */
401 anchor_globals, /**< pointer to the data segment containing all
402 globals as well as global procedures. */
403 anchor_tls, /**< pointer to the thread local storage containing all
404 thread local data. */
405 anchor_initial_mem, /**< initial memory of this graph */
406 anchor_args, /**< methods arguments */
407 anchor_value_param_base, /**< method value param base */
408 anchor_bad, /**< bad node of this ir_graph, the one and
409 only in this graph */
410 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
414 /** A callgraph entry for callees. */
415 typedef struct cg_callee_entry {
416 ir_graph *irg; /**< The called irg. */
417 ir_node **call_list; /**< The list of all calls to the irg. */
418 int max_depth; /**< Maximum depth of all Call nodes to irg. */
422 * An ir_graph holds all information for a procedure.
425 firm_kind kind; /**< Always set to k_ir_graph. */
426 /* -- Basics of the representation -- */
427 ir_entity *ent; /**< The entity of this procedure, i.e.,
428 the type of the procedure and the
429 class it belongs to. */
430 ir_type *frame_type; /**< A class type representing the stack frame.
431 Can include "inner" methods. */
432 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
433 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
434 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
435 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
437 unsigned last_node_idx; /**< The last IR node index for this graph. */
439 /* -- Fields for graph properties -- */
440 irg_inline_property inline_property; /**< How to handle inlineing. */
441 unsigned additional_properties; /**< Additional graph properties. */
443 /* -- Fields indicating different states of irgraph -- */
444 irg_phase_state phase_state; /**< Compiler phase. */
445 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
446 irg_outs_state outs_state; /**< Out edges. */
447 irg_dom_state dom_state; /**< Dominator state information. */
448 irg_dom_state pdom_state; /**< Post Dominator state information. */
449 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
450 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
451 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
452 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
453 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
454 exec_freq_state execfreq_state; /**< Execution frequency state. */
455 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
456 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
457 unsigned fp_model; /**< floating point model of the graph. */
459 /* -- Fields for construction -- */
460 #if USE_EXPLICIT_PHI_IN_STACK
461 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
463 int n_loc; /**< Number of local variables in this
464 procedure including procedure parameters. */
465 void **loc_descriptions; /**< Storage for local variable descriptions. */
467 /* -- Fields for optimizations / analysis information -- */
468 pset *value_table; /**< Hash table for global value numbering (cse)
469 for optimizing use in iropt.c */
470 ir_node **outs; /**< Space for the out arrays. */
472 ir_loop *loop; /**< The outermost loop for this graph. */
473 void *link; /**< A void* field to link any information to
476 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
477 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
478 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
479 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
480 int callgraph_loop_depth; /**< For callgraph analysis */
481 int callgraph_recursion_depth; /**< For callgraph analysis */
482 double method_execution_frequency; /**< For callgraph analysis */
484 ir_loop *l; /**< For callgraph analysis. */
486 /* -- Fields for Walking the graph -- */
487 unsigned long visited; /**< this flag is an identifier for
488 ir walk. it will be incremented
489 every time someone walks through
491 unsigned long block_visited; /**< same as visited, for a complete block */
493 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
494 updated after every walk */
495 irg_edges_info_t edge_info; /**< edge info for automatic outs */
496 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
498 int index; /**< a unique number for each graph */
499 ir_phase *phases[PHASE_LAST]; /**< Phase information. */
501 int n_outs; /**< Size wasted for outs */
502 long graph_nr; /**< a unique graph number for each
503 graph to make output readable. */
507 unsigned using_irn_visited : 1; /**< set to 1 if we are currently using the visited flag */
508 unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */
509 unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */
515 firm_kind kind; /**< must be k_ir_prog */
516 ident *name; /**< A file name or the like. */
517 ir_graph *main_irg; /**< The entry point to the compiled program
518 or NULL if no point exists. */
519 ir_graph **graphs; /**< A list of all graphs in the ir. */
520 ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */
521 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
522 to allocate nodes the represent values
523 of constant entities. It is not meant as
525 ir_type *glob_type; /**< The global type. Must be a class as it can
526 have fields and procedures. */
527 ir_type *tls_type; /**< The thread local storage type. Must be a struct as it can
529 ir_type **types; /**< A list of all types in the ir. */
530 ir_mode **modes; /**< A list of all modes in the ir. */
531 ir_op **opcodes; /**< A list of all opcodes in the ir. */
533 /* -- states of and access to generated information -- */
534 irg_phase_state phase_state; /**< The state of construction. */
536 ip_view_state ip_view; /**< The state of interprocedural view. */
538 irg_outs_state outs_state; /**< The state of out edges of ir nodes. */
539 ir_node **ip_outedges; /**< A huge Array that contains all out edges
540 in interprocedural view. */
541 irg_outs_state trouts_state; /**< The state of out edges of type information. */
543 irg_callee_info_state callee_info_state; /**< Validity of callee information.
544 Contains the lowest value or all irgs. */
545 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
546 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
547 of inheritance relations. */
549 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
550 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
551 to looptree over callgraph. */
552 int max_callgraph_loop_depth; /**< needed in callgraph. */
553 int max_callgraph_recursion_depth; /**< needed in callgraph. */
554 double max_method_execution_frequency; /**< needed in callgraph. */
555 irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
556 exec_freq_state execfreq_state; /**< The state of execution frequency information */
557 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
558 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
559 ir_address_taken_computed_state globals_adr_taken_state; /**< Address taken state of the globals. */
561 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
562 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
563 int max_irg_idx; /**< highest unused irg index */
565 long max_node_nr; /**< to generate unique numbers for nodes. */