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 unsigned has_label:1; /**< Set if this block has a label assigned. */
123 ir_node **graph_arr; /**< An array to store all parameters. */
124 /* Attributes holding analyses information */
125 ir_dom_info dom; /**< Datastructure that holds information about dominators.
127 Eventually overlay with graph_arr as only valid
128 in different phases. Eventually inline the whole
130 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
131 ir_node ** in_cg; /**< array with predecessors in
132 * interprocedural_view, if they differ
133 * from intraprocedural predecessors */
134 int *backedge; /**< Field n set to true if pred n is backedge.
135 @@@ @todo Ev. replace by bit field! */
136 int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge.
137 @@@ @todo Ev. replace by bit field! */
138 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
139 ir_region *region; /**< The immediate structural region this block belongs to. */
140 unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */
141 ir_label_t label; /**< The block label if assigned. */
143 struct list_head succ_head; /**< A list head for all successor edges of a block. */
146 /** Cond attributes. */
148 cond_kind kind; /**< flavor of Cond */
149 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
150 cond_jmp_predicate pred; /**< only for binary Conds: The jump predication. */
153 /** Const attributes. */
155 tarval *tv; /**< the target value */
156 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
159 /** SymConst attributes. */
161 symconst_symbol sym; // old tori
163 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
166 /** Sel attributes. */
168 ir_entity *ent; /**< entity to select */
171 /** Exception attributes. */
173 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
174 If it's know that no exception will be generated, could be set to
175 op_pin_state_floats. */
176 #if PRECISE_EXC_CONTEXT
177 struct ir_node **frag_arr; /**< For Phi node construction in case of exception */
181 /** Call attributes. */
183 except_attr exc; /**< the exception attribute. MUST be the first one. */
184 ir_type *cld_tp; /**< type of called procedure */
185 ir_entity ** callee_arr; /**< result of callee analysis */
188 /** Alloc attributes. */
190 except_attr exc; /**< the exception attribute. MUST be the first one. */
191 ir_type *type; /**< Type of the allocated object. */
192 where_alloc where; /**< stack, heap or other managed part of memory */
195 /** Free attributes. */
197 ir_type *type; /**< Type of the allocated object. */
198 where_alloc where; /**< stack, heap or other managed part of memory */
201 /** InstOf attributes. */
203 except_attr exc; /**< the exception attribute. MUST be the first one. */
204 ir_type *type; /**< the type of which the object pointer must be */
207 /** Filter attributes. */
209 long proj; /**< contains the result position to project (Proj) */
210 ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */
211 int *backedge; /**< Field n set to true if pred n is backedge.
212 @todo Ev. replace by bitfield! */
215 /** CallBegin attributes. */
217 ir_node * call; /**< Associated Call-operation. */
220 /** Cast attributes. */
222 ir_type *totype; /**< Type of the casted node. */
225 /** Load attributes. */
227 except_attr exc; /**< The exception attribute. MUST be the first one. */
228 ir_mode *load_mode; /**< The mode of this Load operation. */
229 ir_volatility volatility; /**< The volatility of a Load/Store operation. */
232 /** Store attributes. */
234 except_attr exc; /**< the exception attribute. MUST be the first one. */
235 ir_volatility volatility; /**< the volatility of a Store operation */
239 int pos; /**< For Phi0. Used to remember the value defined by
240 this Phi node. Needed when the Phi is completed
241 to call get_r_internal_value to find the
242 predecessors. If this attribute is set, the Phi
243 node takes the role of the obsolete Phi0 node,
244 therefore the name. */
247 /**< Confirm attribute. */
249 pn_Cmp cmp; /**< The compare operation. */
252 /** CopyB attribute. */
254 except_attr exc; /**< The exception attribute. MUST be the first one. */
255 ir_type *data_type; /**< Type of the copied entity. */
258 /** Bound attribute. */
260 except_attr exc; /**< The exception attribute. MUST be the first one. */
263 /** Conv attribute. */
265 char strict; /**< If set, this is a strict Conv that cannot be removed. */
268 /** Div/Mod/DivMod/Quot attribute. */
270 except_attr exc; /**< The exception attribute. MUST be the first one. */
271 ir_mode *res_mode; /**< Result mode for the division. */
274 /** Inline Assembler support attribute. */
276 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
277 ident *asm_text; /**< The inline assembler text. */
278 ir_asm_constraint *inputs; /**< Input constraints. */
279 ir_asm_constraint *outputs; /**< Output constraints. */
280 ident **clobber; /**< List of clobbered registers. */
283 /** Some IR-nodes just have one attribute, these are stored here,
284 some have more. Their name is 'irnodename_attr' */
286 block_attr block; /**< For Block: Fields needed to construct it */
287 cond_attr cond; /**< For Cond. */
288 const_attr con; /**< For Const: contains the value of the constant and a type */
289 symconst_attr symc; /**< For SymConst. */
290 sel_attr sel; /**< For Sel. */
291 call_attr call; /**< For Call: pointer to the type of the method to call */
292 callbegin_attr callbegin; /**< For CallBegin. */
293 alloc_attr alloc; /**< For Alloc. */
294 free_attr free; /**< For Free. */
295 io_attr instof; /**< For InstOf */
296 cast_attr cast; /**< For Cast. */
297 load_attr load; /**< For Load. */
298 store_attr store; /**< For Store. */
299 phi0_attr phi0; /**< for Phi0 nodes. */
300 int *phi_backedge; /**< For Phi after construction.
301 Field n set to true if pred n is backedge.
302 @todo Ev. replace by bitfield! */
303 long proj; /**< For Proj: contains the result position to project */
304 confirm_attr confirm; /**< For Confirm: compare operation and region. */
305 filter_attr filter; /**< For Filter */
306 except_attr except; /**< For Phi node construction in case of exceptions */
307 copyb_attr copyb; /**< For CopyB operation */
308 bound_attr bound; /**< For Bound operation */
309 conv_attr conv; /**< For Conv operation */
310 divmod_attr divmod; /**< For Div/Mod/DivMod operation */
311 asm_attr assem; /**< For ASM operation. */
315 * Edge info to put into an irn.
317 typedef struct _irn_edge_kind_info_t {
318 struct list_head outs_head; /**< The list of all outs. */
319 int out_count; /**< Number of outs in the list. */
322 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
325 * The common structure of an irnode.
326 * If the node has some attributes, they are stored in the attr field.
329 /* ------- Basics of the representation ------- */
330 firm_kind kind; /**< Distinguishes this node from others. */
331 ir_op *op; /**< The Opcode of this node. */
332 ir_mode *mode; /**< The Mode of this node. */
333 struct ir_node **in; /**< The array of predecessors / operands. */
334 unsigned long visited; /**< The visited counter for walks of the graph. */
335 unsigned node_idx; /**< The node index of this node in its graph. */
336 void *link; /**< To attach additional information to the node, e.g.
337 used while construction to link Phi0 nodes and
338 during optimization to link to nodes that
339 shall replace a node. */
340 /* ------- Fields for optimizations / analysis information ------- */
341 struct ir_node **out; /**< @deprecated array of out edges. */
342 struct dbg_info *dbi; /**< A pointer to information for debug support. */
343 /* ------- For debugging ------- */
346 long node_nr; /**< A unique node number for each node to make output
349 /* ------- For analyses -------- */
350 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
351 #ifdef DO_HEAPANALYSIS
352 struct abstval *av; /**< Heapanalysis: The abstract value of this node. */
353 struct section *sec; /**< Heapanalysis: The section of this node. */
355 struct ir_node **deps; /**< Additional dependencies induced by state. */
356 irn_edges_info_t edge_info; /**< Everlasting out edges. */
357 /* ------- Opcode depending fields -------- */
358 attr attr; /**< The set of attributes of this node. Depends on opcode.
359 Must be last field of struct ir_node. */
363 * Edge info to put into an irg.
365 typedef struct _irg_edge_info_t {
366 set *edges; /**< a set containing all edges of a graph. */
367 unsigned activated : 1; /**< set if edges are activated for the graph. */
370 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
373 * Index constants for nodes that can be accessed through the graph anchor node.
376 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
377 anchor_start_block, /**< block the start node will belong to */
378 anchor_end, /**< end node of this ir_graph */
379 anchor_start, /**< start node of this ir_graph */
380 anchor_end_reg, /**< end node of this ir_graph */
381 anchor_end_except, /**< end node of this ir_graph */
382 anchor_frame, /**< method's frame */
383 anchor_globals, /**< pointer to the data segment containing all
384 globals as well as global procedures. */
385 anchor_tls, /**< pointer to the thread local storage containing all
386 thread local data. */
387 anchor_initial_mem, /**< initial memory of this graph */
388 anchor_args, /**< methods arguments */
389 anchor_value_param_base, /**< method value param base */
390 anchor_bad, /**< bad node of this ir_graph, the one and
391 only in this graph */
392 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
396 /** A callgraph entry for callees. */
397 typedef struct cg_callee_entry {
398 ir_graph *irg; /**< The called irg. */
399 ir_node **call_list; /**< The list of all calls to the irg. */
400 int max_depth; /**< Maximum depth of all Call nodes to irg. */
404 * An ir_graph holds all information for a procedure.
407 firm_kind kind; /**< Always set to k_ir_graph. */
408 /* -- Basics of the representation -- */
409 ir_entity *ent; /**< The entity of this procedure, i.e.,
410 the type of the procedure and the
411 class it belongs to. */
412 ir_type *frame_type; /**< A class type representing the stack frame.
413 Can include "inner" methods. */
414 ir_node *anchor; /**< The anchor node. */
415 ir_node **proj_args; /**< Projs of the methods arguments. */
416 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
417 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
418 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
420 unsigned last_node_idx; /**< The last IR node index for this graph. */
422 /* -- Fields for graph properties -- */
423 irg_inline_property inline_property; /**< How to handle inlineing. */
424 unsigned additional_properties; /**< Additional graph properties. */
426 /* -- Fields indicating different states of irgraph -- */
427 irg_phase_state phase_state; /**< Compiler phase. */
428 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
429 irg_outs_state outs_state; /**< Out edges. */
430 irg_dom_state dom_state; /**< Dominator state information. */
431 irg_dom_state pdom_state; /**< Post Dominator state information. */
432 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
433 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
434 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
435 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
436 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
437 exec_freq_state execfreq_state; /**< Execution frequency state. */
438 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
439 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
440 unsigned fp_model; /**< floating point model of the graph. */
442 /* -- Fields for construction -- */
443 #if USE_EXPLICIT_PHI_IN_STACK
444 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
446 int n_loc; /**< Number of local variables in this
447 procedure including procedure parameters. */
448 void **loc_descriptions; /**< Storage for local variable descriptions. */
450 /* -- Fields for optimizations / analysis information -- */
451 pset *value_table; /**< Hash table for global value numbering (cse)
452 for optimizing use in iropt.c */
453 ir_node **outs; /**< Space for the out arrays. */
455 ir_loop *loop; /**< The outermost loop for this graph. */
456 void *link; /**< A void* field to link any information to
459 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
460 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
461 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
462 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
463 int callgraph_loop_depth; /**< For callgraph analysis */
464 int callgraph_recursion_depth; /**< For callgraph analysis */
465 double method_execution_frequency; /**< For callgraph analysis */
467 ir_loop *l; /**< For callgraph analysis. */
469 /* -- Fields for Walking the graph -- */
470 unsigned long visited; /**< this flag is an identifier for
471 ir walk. it will be incremented
472 every time someone walks through
474 unsigned long block_visited; /**< same as visited, for a complete block */
476 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
477 updated after every walk */
478 irg_edges_info_t edge_info; /**< edge info for automatic outs */
479 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
482 int n_outs; /**< Size wasted for outs */
483 long graph_nr; /**< a unique graph number for each graph to make output
488 unsigned using_visited : 1; /**< set to 1 if we are currently using the visited flag */
489 unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */
490 unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */
496 firm_kind kind; /**< must be k_ir_prog */
497 ident *name; /**< A file name or the like. */
498 ir_graph *main_irg; /**< The entry point to the compiled program
499 or NULL if no point exists. */
500 ir_graph **graphs; /**< A list of all graphs in the ir. */
501 ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */
502 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
503 to allocate nodes the represent values
504 of constant entities. It is not meant as
506 ir_type *glob_type; /**< The global type. Must be a class as it can
507 have fields and procedures. */
508 ir_type *tls_type; /**< The thread local storage type. Must be a struct as it can
510 ir_type **types; /**< A list of all types in the ir. */
511 ir_mode **modes; /**< A list of all modes in the ir. */
512 ir_op **opcodes; /**< A list of all opcodes in the ir. */
514 /* -- states of and access to generated information -- */
515 irg_phase_state phase_state; /**< The state of construction. */
517 ip_view_state ip_view; /**< The state of interprocedural view. */
519 irg_outs_state outs_state; /**< The state of out edges of ir nodes. */
520 ir_node **ip_outedges; /**< A huge Array that contains all out edges
521 in interprocedural view. */
522 irg_outs_state trouts_state; /**< The state of out edges of type information. */
524 irg_callee_info_state callee_info_state; /**< Validity of callee information.
525 Contains the lowest value or all irgs. */
526 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
527 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
528 of inheritance relations. */
530 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
531 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
532 to looptree over callgraph. */
533 int max_callgraph_loop_depth; /**< needed in callgraph. */
534 int max_callgraph_recursion_depth; /**< needed in callgraph. */
535 double max_method_execution_frequency; /**< needed in callgraph. */
536 irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
537 exec_freq_state execfreq_state; /**< The state of execution frequency information */
538 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
539 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
540 ir_address_taken_computed_state globals_adr_taken_state; /**< Address taken state of the globals. */
542 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
543 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
545 long max_node_nr; /**< to generate unique numbers for nodes. */