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