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"
34 #include "iredgekinds.h"
35 #include "irtypeinfo.h"
37 #include "execution_frequency.h"
39 #include "callgraph.h"
41 #include "field_temperature.h"
42 #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 * - ident *name: Name of this mode. Two modes are different if the name is different.
76 * - ir_mode_sort sort: sort of mode specifying possible usage categories
77 * - int size: size of the mode in Bits.
78 * - unsigned sign:1: signedness of this mode
80 * - modulo_shift specifies for modes of kind irms_int_number
81 * whether shift applies modulo to value of bits to shift
84 * The tech report 1999-44 describing FIRM and predefined modes
88 firm_kind kind; /**< distinguishes this node from others */
89 ident *name; /**< Name ident of this mode */
90 ir_type *type; /**< corresponding primitive type */
92 /* ----------------------------------------------------------------------- */
93 /* On changing this struct you have to evaluate the mode_are_equal function!*/
94 ir_mode_sort sort; /**< coarse classification of this mode:
95 int, float, reference ...
98 arithmetic; /**< different arithmetic operations possible with a mode */
99 unsigned size; /**< size of the mode in Bits. */
100 unsigned sign:1; /**< signedness of this mode */
101 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
102 unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with
103 vector_elem number of elements, size contains the size
104 of all bits and must be dividable by vector_elem */
106 /* ----------------------------------------------------------------------- */
107 tarval *min; /**< the minimum value that can be expressed */
108 tarval *max; /**< the maximum value that can be expressed */
109 tarval *null; /**< the value 0 */
110 tarval *one; /**< the value 1 */
111 tarval *minus_one; /**< the value -1 */
112 tarval *all_one; /**< the value ~0 */
113 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
114 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
115 void *link; /**< To store some intermediate information */
116 const void *tv_priv; /**< tarval module will save private data here */
119 /* ir node attributes */
121 /** first attribute of Bad and Block nodes */
123 ir_graph *irg; /**< The graph this block like node belongs to. */
126 /** Block attributes */
128 /* General attributes */
129 irg_attr irg; /**< The graph this block belongs to. */
130 ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
131 /* Attributes private to construction: */
132 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
133 unsigned is_dead:1; /**< If set, the block is dead (and could be replace by a Bad. */
134 unsigned is_mb_head:1; /**< Set if this block is a macroblock head. */
135 unsigned marked:1; /**< Can be set/unset to temporary mark a block. */
136 ir_node **graph_arr; /**< An array to store all parameters. */
137 /* Attributes holding analyses information */
138 ir_dom_info dom; /**< Datastructure that holds information about dominators.
140 Eventually overlay with graph_arr as only valid
141 in different phases. Eventually inline the whole
143 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
144 ir_node ** in_cg; /**< array with predecessors in
145 * interprocedural_view, if they differ
146 * from intraprocedural predecessors */
147 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge.*/
148 unsigned *cg_backedge; /**< Raw Bitfield n set to true if pred n is interprocedural backedge. */
149 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
150 ir_region *region; /**< The immediate structural region this block belongs to. */
151 unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */
152 ir_entity *entity; /**< entitiy representing this block */
153 ir_node *phis; /**< The list of Phi nodes in this block. */
155 struct list_head succ_head; /**< A list head for all successor edges of a block. */
158 /** Cond attributes. */
160 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
161 cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
164 /** Const attributes. */
166 tarval *tv; /**< the target value */
167 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
170 /** SymConst attributes. */
172 symconst_symbol sym; // old tori
174 ir_type *tp; /**< the source type, for analyses. default: type_unknown. */
177 /** Sel attributes. */
179 ir_entity *entity; /**< entity to select */
182 /** Exception attributes. */
184 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
185 If it's know that no exception will be generated, could be set to
186 op_pin_state_floats. */
187 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 */
195 unsigned tail_call:1; /**< if set, can be a tail call */
198 /** Builtin attributes. */
200 except_attr exc; /**< the exception attribute. MUST be the first one. */
201 ir_builtin_kind kind; /**< kind of the called builtin procedure */
202 ir_type *type; /**< type of called builtin procedure */
205 /** Alloc attributes. */
207 except_attr exc; /**< the exception attribute. MUST be the first one. */
208 ir_where_alloc where; /**< stack, heap or other managed part of memory */
209 ir_type *type; /**< Type of the allocated object. */
212 /** Free attributes. */
214 ir_type *type; /**< Type of the allocated object. */
215 ir_where_alloc where; /**< stack, heap or other managed part of memory */
218 /** InstOf attributes. */
220 except_attr exc; /**< the exception attribute. MUST be the first one. */
221 ir_type *type; /**< the type of which the object pointer must be */
224 /** Filter attributes. */
226 long proj; /**< contains the result position to project (Proj) */
227 ir_node **in_cg; /**< array with interprocedural predecessors (Phi) */
228 unsigned *backedge; /**< Raw Bitfield n set to true if pred n is backedge. */
231 /** CallBegin attributes. */
233 ir_node *call; /**< Associated Call-operation. */
236 /** Cast attributes. */
238 ir_type *type; /**< Type of the casted node. */
241 /** Load attributes. */
243 except_attr exc; /**< The exception attribute. MUST be the first one. */
244 unsigned volatility:1; /**< The volatility of this Load operation. */
245 unsigned aligned:1; /**< The align attribute of this Load operation. */
246 ir_mode *mode; /**< The mode of this Load operation. */
249 /** Store attributes. */
251 except_attr exc; /**< the exception attribute. MUST be the first one. */
252 unsigned volatility:1; /**< The volatility of this Store operation. */
253 unsigned aligned:1; /**< The align attribute of this Store operation. */
257 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
259 unsigned *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
260 int pos; /**< For Phi0. Used to remember the value defined by
261 this Phi node. Needed when the Phi is completed
262 to call get_r_internal_value() to find the
263 predecessors. If this attribute is set, the Phi
264 node takes the role of the obsolete Phi0 node,
265 therefore the name. */
270 /**< Confirm attribute. */
272 pn_Cmp cmp; /**< The compare operation. */
275 /** CopyB attribute. */
277 except_attr exc; /**< The exception attribute. MUST be the first one. */
278 ir_type *type; /**< Type of the copied entity. */
281 /** Bound attribute. */
283 except_attr exc; /**< The exception attribute. MUST be the first one. */
286 /** Conv attribute. */
288 char strict; /**< If set, this is a strict Conv that cannot be removed. */
291 /** Div/Mod/DivMod/Quot attribute. */
293 except_attr exc; /**< The exception attribute. MUST be the first one. */
294 ir_mode *resmode; /**< Result mode for the division. */
295 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
298 /** Inline Assembler support attribute. */
300 /* BEWARE: pin state MUST be the first attribute */
301 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
302 ident *asm_text; /**< The inline assembler text. */
303 ir_asm_constraint *inputs; /**< Input constraints. */
304 ir_asm_constraint *outputs; /**< Output constraints. */
305 ident **clobber; /**< List of clobbered registers. */
308 /** Some IR-nodes just have one attribute, these are stored here,
309 some have more. Their name is 'irnodename_attr' */
311 irg_attr irg; /**< For Blocks and Bad: its belonging irg */
312 block_attr block; /**< For Block: Fields needed to construct it */
313 cond_attr cond; /**< For Cond. */
314 const_attr con; /**< For Const: contains the value of the constant and a type */
315 symconst_attr symc; /**< For SymConst. */
316 sel_attr sel; /**< For Sel. */
317 call_attr call; /**< For Call. */
318 builtin_attr builtin; /**< For Builtin. */
319 callbegin_attr callbegin; /**< For CallBegin. */
320 alloc_attr alloc; /**< For Alloc. */
321 free_attr free; /**< For Free. */
322 io_attr instof; /**< For InstOf */
323 cast_attr cast; /**< For Cast. */
324 load_attr load; /**< For Load. */
325 store_attr store; /**< For Store. */
326 phi_attr phi; /**< For Phi. */
327 long proj; /**< For Proj: contains the result position to project */
328 confirm_attr confirm; /**< For Confirm: compare operation and region. */
329 filter_attr filter; /**< For Filter */
330 except_attr except; /**< For Phi node construction in case of exceptions */
331 copyb_attr copyb; /**< For CopyB operation */
332 bound_attr bound; /**< For Bound operation */
333 conv_attr conv; /**< For Conv operation */
334 divmod_attr divmod; /**< For Div/Mod/DivMod operation */
335 asm_attr assem; /**< For ASM operation. */
339 * Edge info to put into an irn.
341 typedef struct _irn_edge_kind_info_t {
342 struct list_head outs_head; /**< The list of all outs. */
343 unsigned edges_built : 1; /**< Set edges where built for this node. */
344 unsigned out_count : 31; /**< Number of outs in the list. */
347 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
352 typedef struct _ir_def_use_edge {
353 ir_node *use; /** The use node of that edge. */
354 int pos; /** The position of this edge in use's input array. */
358 * The common structure of an irnode.
359 * If the node has some attributes, they are stored in the attr field.
362 /* ------- Basics of the representation ------- */
363 firm_kind kind; /**< Distinguishes this node from others. */
364 unsigned node_idx; /**< The node index of this node in its graph. */
365 ir_op *op; /**< The Opcode of this node. */
366 ir_mode *mode; /**< The Mode of this node. */
367 struct ir_node **in; /**< The array of predecessors / operands. */
368 ir_visited_t visited; /**< The visited counter for walks of the graph. */
369 void *link; /**< To attach additional information to the node, e.g.
370 used during optimization to link to nodes that
371 shall replace a node. */
372 long node_nr; /**< A globally unique node number for each node. */
373 /* ------- Fields for optimizations / analysis information ------- */
374 ir_def_use_edge *out; /**< array of def-use edges. */
375 struct dbg_info *dbi; /**< A pointer to information for debug support. */
376 /* ------- For debugging ------- */
378 unsigned out_valid : 1;
381 /* ------- For analyses -------- */
382 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
383 struct ir_node **deps; /**< Additional dependencies induced by state. */
385 irn_edges_info_t edge_info; /**< Everlasting out edges. */
387 /* ------- Opcode depending fields -------- */
388 attr attr; /**< The set of attributes of this node. Depends on opcode.
389 Must be last field of struct ir_node. */
392 #include "iredgeset.h"
395 * Edge info to put into an irg.
397 typedef struct _irg_edge_info_t {
398 ir_edgeset_t edges; /**< A set containing all edges of the current graph. */
399 struct list_head free_edges; /**< list of all free edges. */
400 struct obstack edges_obst; /**< Obstack, where edges are allocated on. */
401 unsigned allocated : 1; /**< Set if edges are allocated on the obstack. */
402 unsigned activated : 1; /**< Set if edges are activated for the graph. */
405 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
408 * Index constants for nodes that can be accessed through the graph anchor node.
411 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
412 anchor_start_block, /**< block the start node will belong to */
413 anchor_end, /**< end node of this ir_graph */
414 anchor_start, /**< start node of this ir_graph */
415 anchor_end_reg, /**< end node of this ir_graph */
416 anchor_end_except, /**< end node of this ir_graph */
417 anchor_initial_exec, /**< methods initial control flow */
418 anchor_frame, /**< methods frame */
419 anchor_tls, /**< pointer to the thread local storage containing all
420 thread local data. */
421 anchor_initial_mem, /**< initial memory of this graph */
422 anchor_args, /**< methods arguments */
423 anchor_bad, /**< bad node of this ir_graph, the one and
424 only in this graph */
425 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
429 /** A callgraph entry for callees. */
430 typedef struct cg_callee_entry {
431 ir_graph *irg; /**< The called irg. */
432 ir_node **call_list; /**< The list of all calls to the irg. */
433 int max_depth; /**< Maximum depth of all Call nodes to irg. */
437 * An ir_graph holds all information for a procedure.
440 firm_kind kind; /**< Always set to k_ir_graph. */
441 /* -- Basics of the representation -- */
442 unsigned last_node_idx; /**< The last IR node index for this graph. */
443 ir_entity *ent; /**< The entity of this procedure, i.e.,
444 the type of the procedure and the
445 class it belongs to. */
446 ir_type *frame_type; /**< A class type representing the stack frame.
447 Can include "inner" methods. */
448 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
449 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
450 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
451 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
453 /* -- Fields for graph properties -- */
454 irg_inline_property inline_property; /**< How to handle inlineing. */
455 unsigned additional_properties; /**< Additional graph properties. */
457 /* -- Fields indicating different states of irgraph -- */
459 irg_phase_state phase_state; /**< Compiler phase. */
460 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
461 irg_outs_state outs_state; /**< Out edges. */
462 irg_dom_state dom_state; /**< Dominator state information. */
463 irg_dom_state pdom_state; /**< Post Dominator state information. */
464 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
465 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
466 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
467 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
468 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
469 exec_freq_state execfreq_state; /**< Execution frequency state. */
470 ir_entity_usage_computed_state entity_usage_state;
471 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
472 unsigned fp_model; /**< floating point model of the graph. */
474 /* -- Fields for construction -- */
475 int n_loc; /**< Number of local variables in this
476 procedure including procedure parameters. */
477 void **loc_descriptions; /**< Storage for local variable descriptions. */
479 /* -- Fields for optimizations / analysis information -- */
480 pset *value_table; /**< Hash table for global value numbering (cse)
481 for optimizing use in iropt.c */
482 ir_def_use_edge *outs; /**< Space for the Def-Use arrays. */
484 ir_loop *loop; /**< The outermost loop for this graph. */
485 void *link; /**< A void* field to link any information to
488 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
489 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
490 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
491 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
492 ir_loop *l; /**< For callgraph analysis. */
493 int callgraph_loop_depth; /**< For callgraph analysis */
494 int callgraph_recursion_depth; /**< For callgraph analysis */
495 double method_execution_frequency; /**< For callgraph analysis */
498 /* -- Fields for Walking the graph -- */
499 ir_visited_t visited; /**< this flag is an identifier for
500 ir walk. it will be incremented
501 every time someone walks through
503 ir_visited_t block_visited; /**< same as visited, for a complete block */
505 ir_visited_t self_visited; /**< visited flag of the irg */
507 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
508 updated after every walk */
509 irg_edges_info_t edge_info; /**< edge info for automatic outs */
510 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
512 int index; /**< a unique number for each graph */
513 ir_phase *phases[PHASE_LAST]; /**< Phase information. */
514 void *be_data; /**< backend can put in private data here */
516 int n_outs; /**< Size wasted for outs */
517 long graph_nr; /**< a unique graph number for each
518 graph to make output readable. */
522 ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
527 * Data structure that holds central information about a program
529 * One irp is created by libFirm on construction, so irp should never be NULL.
531 * - main_irg: The ir graph that is the entry point to the program.
532 * (Anything not reachable from here may be optimized away
533 * if this irp represents a whole program.
534 * - irg: List of all ir graphs in the program or module.
535 * - type: A list containing all types known to the translated program.
536 * Some types can have several entries in this list (as a result of
537 * using exchange_types()).
538 * - glob_type: The unique global type that is owner of all global entities
542 firm_kind kind; /**< must be k_ir_prog */
543 ident *name; /**< A file name or the like. */
544 ir_graph *main_irg; /**< The entry point to the compiled program
545 or NULL if no point exists. */
546 ir_graph **graphs; /**< A list of all graphs in the ir. */
547 ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */
548 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
549 to allocate nodes the represent values
550 of constant entities. It is not meant as
552 ir_type *segment_types[IR_SEGMENT_LAST+1];
553 ir_type **types; /**< A list of all types in the ir. */
554 ir_mode **modes; /**< A list of all modes in the ir. */
555 ir_op **opcodes; /**< A list of all opcodes in the ir. */
556 ident **global_asms; /**< An array of global ASM insertions. */
558 /* -- states of and access to generated information -- */
559 irg_phase_state phase_state; /**< The state of construction. */
561 ip_view_state ip_view; /**< The state of interprocedural view. */
563 irg_outs_state outs_state; /**< The state of out edges of ir nodes. */
564 ir_node **ip_outedges; /**< A huge Array that contains all out edges
565 in interprocedural view. */
566 irg_outs_state trouts_state; /**< The state of out edges of type information. */
568 irg_callee_info_state callee_info_state; /**< Validity of callee information.
569 Contains the lowest value or all irgs. */
570 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
571 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
572 of inheritance relations. */
574 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
575 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
576 to looptree over callgraph. */
577 int max_callgraph_loop_depth; /**< needed in callgraph. */
578 int max_callgraph_recursion_depth; /**< needed in callgraph. */
579 double max_method_execution_frequency; /**< needed in callgraph. */
580 irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
581 exec_freq_state execfreq_state; /**< The state of execution frequency information */
582 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
583 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
584 ir_entity_usage_computed_state globals_entity_usage_state;
586 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
587 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
588 int max_irg_idx; /**< highest unused irg index */
589 long max_node_nr; /**< to generate unique numbers for nodes. */
591 ir_resources_t reserved_resources; /**< Bitset for tracking used global resources. */