2 * Copyright (C) 1995-2011 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
31 #include "firm_types.h"
36 #include "iredgekinds.h"
37 #include "irtypeinfo.h"
40 #include "callgraph.h"
51 void **data; /**< maps node indices to void* */
54 /** The type of an ir_op. */
56 unsigned code; /**< The unique opcode of the op. */
57 ident *name; /**< The name of the op. */
58 size_t attr_size; /**< Space needed in memory for private attributes
60 op_pin_state pin_state; /**< How to deal with the node in CSE, PRE. */
61 op_arity opar; /**< The arity of operator. */
62 int op_index; /**< The index of the first data operand, 0 for
63 most cases, 1 for Div etc. */
64 int fragile_mem_index; /**< index of memory input for fragile nodes */
65 int pn_x_regular; /**< for fragile ops the position of the
67 int pn_x_except; /**< for fragile ops the position of the
69 unsigned flags; /**< Flags describing the behavior of the ir_op,
70 a bitmasks of irop_flags. */
71 unsigned tag; /**< Some custom TAG value the op's creator set */
72 void *attr; /**< custom pointer where op's creator can attach
73 attribute stuff to. */
74 ir_op_ops ops; /**< The operations of the this op. */
77 /** Helper values for ir_mode_sort. */
78 enum ir_mode_sort_helper {
79 irmsh_is_num = 0x10, /**< mode represents a number */
80 irmsh_is_data = 0x20, /**< mode represents data (can be carried in registers) */
81 irmsh_is_datab = 0x40, /**< mode represents data or is internal boolean */
82 irmsh_is_dataM = 0x80, /**< mode represents data or is memory */
86 * These values represent the different mode classes of value representations.
87 * Beware: do not change the order of these values without checking
90 typedef enum ir_mode_sort {
91 irms_control_flow = 0, /**< Marks all control flow modes. */
96 irms_memory = 5 | irmsh_is_dataM, /**< Marks the memory mode. Not extensible. (irm_M) */
98 /** Internal boolean representation.
99 Storing to memory impossible, convert first. (irm_b) */
100 irms_internal_boolean = 6 | irmsh_is_datab,
102 /** A mode to represent entities.
103 Restricted int computations can be performed */
104 irms_reference = 7 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM,
105 /** A mode to represent int numbers.
106 Integer computations can be performed. */
107 irms_int_number = 8 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
108 /** A mode to represent float numbers.
109 Floating point computations can be performed. */
110 irms_float_number = 9 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
114 * A descriptor for an IEEE754 float value.
116 typedef struct float_descriptor_t {
117 unsigned char exponent_size; /**< size of exponent in bits */
118 unsigned char mantissa_size; /**< size of mantissa in bits */
119 bool explicit_one; /**< set if the leading one is explicit */
120 } float_descriptor_t;
123 * Contains relevant information about a mode.
125 * Necessary information about a mode is stored in this struct
126 * which is used by the tarval module to perform calculations
127 * and comparisons of values of a such described mode.
130 * - ident *name: Name of this mode. Two modes are different if the name is different.
131 * - ir_mode_sort sort: sort of mode specifying possible usage categories
132 * - int size: size of the mode in Bits.
133 * - unsigned sign:1: signedness of this mode
135 * - modulo_shift specifies for modes of kind irms_int_number
136 * whether shift applies modulo to value of bits to shift
139 * The tech report 1999-44 describing FIRM and predefined modes
143 firm_kind kind; /**< distinguishes this node from others */
144 ident *name; /**< Name ident of this mode */
145 ir_type *type; /**< corresponding primitive type */
147 /* ---------------------------------------------------------------------- */
148 /* On changing this struct you have to evaluate the mode_are_equal function!*/
149 ir_mode_sort sort; /**< coarse classification of this mode:
150 int, float, reference ...
152 ir_mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */
153 unsigned size; /**< size of the mode in Bits. */
154 unsigned sign:1; /**< signedness of this mode */
155 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
156 float_descriptor_t float_desc;
158 /* ---------------------------------------------------------------------- */
159 ir_tarval *min; /**< the minimum value that can be expressed */
160 ir_tarval *max; /**< the maximum value that can be expressed */
161 ir_tarval *null; /**< the value 0 */
162 ir_tarval *one; /**< the value 1 */
163 ir_tarval *minus_one; /**< the value -1 */
164 ir_tarval *all_one; /**< the value ~0 */
165 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
166 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
167 void *link; /**< To store some intermediate information */
168 const void *tv_priv; /**< tarval module will save private data here */
171 /* note: we use "long" here because that is the type used for Proj-Numbers */
172 typedef struct ir_switch_table_entry {
176 } ir_switch_table_entry;
178 struct ir_switch_table {
180 ir_switch_table_entry entries[];
183 /* ir node attributes */
185 /** first attribute of Bad, Block, Anchor nodes */
186 typedef struct irg_attr {
187 ir_graph *irg; /**< The graph this block like node belongs to. */
190 typedef struct bad_attr {
194 typedef struct anchor_attr {
198 /** Block attributes */
199 typedef struct block_attr {
200 /* General attributes */
201 irg_attr irg; /**< The graph this block belongs to. */
202 ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
203 /* Attributes private to construction: */
204 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
205 unsigned marked:1; /**< Can be set/unset to temporary mark a block. */
206 ir_node **graph_arr; /**< An array to store all parameters. */
207 /* Attributes holding analyses information */
208 ir_dom_info dom; /**< Datastructure that holds information about dominators.
210 Eventually overlay with graph_arr as only valid
211 in different phases. Eventually inline the whole
213 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
214 ir_node ** in_cg; /**< array with predecessors in
215 * interprocedural_view, if they differ
216 * from intraprocedural predecessors */
217 bitset_t *backedge; /**< Bitfield n set to true if pred n is backedge.*/
218 bitset_t *cg_backedge; /**< Bitfield n set to true if pred n is interprocedural backedge. */
219 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
220 ir_entity *entity; /**< entitiy representing this block */
221 ir_node *phis; /**< The list of Phi nodes in this block. */
223 struct list_head succ_head; /**< A list head for all successor edges of a block. */
226 /** Cond attributes. */
227 typedef struct cond_attr {
228 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
229 cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
232 /** Const attributes. */
233 typedef struct const_attr {
234 ir_tarval *tarval; /**< the target value */
237 /** SymConst attributes. */
238 typedef struct symconst_attr {
239 symconst_symbol sym; // old tori
243 /** Sel attributes. */
244 typedef struct sel_attr {
245 ir_entity *entity; /**< entity to select */
248 /** Exception attributes. */
249 typedef struct except_attr {
250 unsigned pin_state : 2; /**< the pin state for operations with
251 variable pinned state. Contains a
253 unsigned throws_exception : 1; /**< if true a fragile op throws and
254 must produce X_except and X_regular
258 /** Call attributes. */
259 typedef struct call_attr {
260 except_attr exc; /**< the exception attribute. MUST be the first one. */
261 ir_type *type; /**< type of called procedure */
262 ir_entity **callee_arr; /**< result of callee analysis */
263 unsigned tail_call:1; /**< if set, can be a tail call */
266 /** Builtin attributes. */
267 typedef struct builtin_attr {
268 except_attr exc; /**< the exception attribute. MUST be the first one. */
269 ir_builtin_kind kind; /**< kind of the called builtin procedure */
270 ir_type *type; /**< type of called builtin procedure */
273 /** Alloc attributes. */
274 typedef struct alloc_attr {
275 except_attr exc; /**< the exception attribute. MUST be the first one. */
276 ir_where_alloc where; /**< stack, heap or other managed part of memory */
277 ir_type *type; /**< Type of the allocated object. */
280 /** Free attributes. */
281 typedef struct free_attr {
282 ir_type *type; /**< Type of the allocated object. */
283 ir_where_alloc where; /**< stack, heap or other managed part of memory */
286 /** InstOf attributes. */
287 typedef struct io_attr {
288 except_attr exc; /**< the exception attribute. MUST be the first one. */
289 ir_type *type; /**< the type of which the object pointer must be */
292 /** Cast attributes. */
293 typedef struct cast_attr {
294 ir_type *type; /**< Type of the casted node. */
297 /** Load attributes. */
298 typedef struct load_attr {
299 except_attr exc; /**< The exception attribute. MUST be the first one. */
300 unsigned volatility:1; /**< The volatility of this Load operation. */
301 unsigned unaligned:1; /**< The align attribute of this Load operation. */
302 ir_mode *mode; /**< The mode of this Load operation. */
305 /** Store attributes. */
306 typedef struct store_attr {
307 except_attr exc; /**< the exception attribute. MUST be the first one. */
308 unsigned volatility:1; /**< The volatility of this Store operation. */
309 unsigned unaligned:1; /**< The align attribute of this Store operation. */
312 typedef struct phi_attr {
313 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
315 bitset_t *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
316 int pos; /**< For Phi0. Used to remember the value defined by
317 this Phi node. Needed when the Phi is completed
318 to call get_r_internal_value() to find the
319 predecessors. If this attribute is set, the Phi
320 node takes the role of the obsolete Phi0 node,
321 therefore the name. */
325 /**< Cmp attribute. */
326 typedef struct cmp_attr {
327 ir_relation relation; /**< comparison condition. */
330 /**< Confirm attribute. */
331 typedef struct confirm_attr {
332 ir_relation relation; /**< relation between value and bound */
335 /** CopyB attribute. */
336 typedef struct copyb_attr {
337 except_attr exc; /**< The exception attribute. MUST be the first one. */
338 ir_type *type; /**< Type of the copied entity. */
341 /** Bound attribute. */
342 typedef struct bound_attr {
343 except_attr exc; /**< The exception attribute. MUST be the first one. */
346 /** Conv attribute. */
347 typedef struct conv_attr {
348 char strict; /**< If set, this is a strict Conv that cannot be removed. */
351 /** Div attribute. */
352 typedef struct div_attr {
353 except_attr exc; /**< The exception attribute. MUST be the first one. */
354 ir_mode *resmode; /**< Result mode for the division. */
355 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
358 /** Mod attribute. */
359 typedef struct mod_attr {
360 except_attr exc; /**< The exception attribute. MUST be the first one. */
361 ir_mode *resmode; /**< Result mode for the division. */
364 /** Inline Assembler support attribute. */
365 typedef struct asm_attr {
366 /* BEWARE: pin state MUST be the first attribute */
367 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
368 ident *text; /**< The inline assembler text. */
369 ir_asm_constraint *input_constraints; /**< Input constraints. */
370 ir_asm_constraint *output_constraints; /**< Output constraints. */
371 ident **clobbers; /**< List of clobbered registers. */
374 typedef struct proj_attr {
375 long proj; /**< position of tuple sub-value which is projected */
378 typedef struct switch_attr {
380 ir_switch_table *table;
383 /** Some IR-nodes just have one attribute, these are stored here,
384 some have more. Their name is 'irnodename_attr' */
385 typedef union ir_attr {
386 irg_attr irg; /**< For Blocks and Bad: its belonging irg */
387 bad_attr bad; /**< for Bads: irg reference */
388 anchor_attr anchor; /**< for Anchor: irg reference */
389 block_attr block; /**< For Block: Fields needed to construct it */
390 cmp_attr cmp; /**< For Cmp. */
391 cond_attr cond; /**< For Cond. */
392 const_attr con; /**< For Const: contains the value of the constant and a type */
393 symconst_attr symc; /**< For SymConst. */
394 sel_attr sel; /**< For Sel. */
395 call_attr call; /**< For Call. */
396 builtin_attr builtin; /**< For Builtin. */
397 alloc_attr alloc; /**< For Alloc. */
398 free_attr free; /**< For Free. */
399 io_attr instof; /**< For InstOf */
400 cast_attr cast; /**< For Cast. */
401 load_attr load; /**< For Load. */
402 store_attr store; /**< For Store. */
403 phi_attr phi; /**< For Phi. */
404 proj_attr proj; /**< For Proj. */
405 confirm_attr confirm; /**< For Confirm: compare operation and region. */
406 except_attr except; /**< For Phi node construction in case of exceptions */
407 copyb_attr copyb; /**< For CopyB operation */
408 bound_attr bound; /**< For Bound operation */
409 conv_attr conv; /**< For Conv operation */
410 div_attr div; /**< For Div operation */
411 mod_attr mod; /**< For Mod operation */
412 asm_attr assem; /**< For ASM operation. */
413 switch_attr switcha; /**< For Switch operation. */
417 * Edge info to put into an irn.
419 typedef struct irn_edge_kind_info_t {
420 struct list_head outs_head; /**< The list of all outs. */
421 unsigned edges_built : 1; /**< Set edges where built for this node. */
422 unsigned out_count : 31; /**< Number of outs in the list. */
425 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
430 typedef struct ir_def_use_edge {
431 ir_node *use; /** The use node of that edge. */
432 int pos; /** The position of this edge in use's input array. */
436 * The common structure of an irnode.
437 * If the node has some attributes, they are stored in the attr field.
440 /* ------- Basics of the representation ------- */
441 firm_kind kind; /**< Distinguishes this node from others. */
442 unsigned node_idx; /**< The node index of this node in its graph. */
443 ir_op *op; /**< The Opcode of this node. */
444 ir_mode *mode; /**< The Mode of this node. */
445 struct ir_node **in; /**< The array of predecessors / operands. */
446 ir_visited_t visited; /**< The visited counter for walks of the graph. */
447 void *link; /**< To attach additional information to the node, e.g.
448 used during optimization to link to nodes that
449 shall replace a node. */
450 long node_nr; /**< A globally unique node number for each node. */
451 /* ------- Fields for optimizations / analysis information ------- */
452 ir_def_use_edge *out; /**< array of def-use edges. */
453 struct dbg_info *dbi; /**< A pointer to information for debug support. */
454 /* ------- For debugging ------- */
456 unsigned out_valid : 1;
459 /* ------- For analyses -------- */
460 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
461 struct ir_node **deps; /**< Additional dependencies induced by state. */
463 irn_edges_info_t edge_info; /**< Everlasting out edges. */
465 /* ------- Opcode depending fields -------- */
466 ir_attr attr; /**< The set of attributes of this node. Depends on opcode.
467 Must be last field of struct ir_node. */
470 #include "iredgeset.h"
473 * Edge info to put into an irg.
475 typedef struct irg_edge_info_t {
476 ir_edgeset_t edges; /**< A set containing all edges of the current graph. */
477 struct list_head free_edges; /**< list of all free edges. */
478 struct obstack edges_obst; /**< Obstack, where edges are allocated on. */
479 unsigned allocated : 1; /**< Set if edges are allocated on the obstack. */
480 unsigned activated : 1; /**< Set if edges are activated for the graph. */
483 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
486 * Index constants for nodes that can be accessed through the graph anchor node.
489 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
490 anchor_start_block, /**< block the start node will belong to */
491 anchor_end, /**< end node of this ir_graph */
492 anchor_start, /**< start node of this ir_graph */
493 anchor_initial_exec, /**< methods initial control flow */
494 anchor_frame, /**< methods frame */
495 anchor_initial_mem, /**< initial memory of this graph */
496 anchor_args, /**< methods arguments */
497 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
501 /** A callgraph entry for callees. */
502 typedef struct cg_callee_entry {
503 ir_graph *irg; /**< The called irg. */
504 ir_node **call_list; /**< The list of all calls to the irg. */
505 size_t max_depth; /**< Maximum depth of all Call nodes to irg. */
508 typedef struct ir_vrp_info {
509 struct ir_nodemap infos;
514 * An ir_graph holds all information for a procedure.
517 firm_kind kind; /**< Always set to k_ir_graph. */
518 /* -- Basics of the representation -- */
519 unsigned last_node_idx; /**< The last IR node index for this graph. */
520 ir_entity *ent; /**< The entity of this procedure, i.e.,
521 the type of the procedure and the
522 class it belongs to. */
523 ir_type *frame_type; /**< A class type representing the stack frame.
524 Can include "inner" methods. */
525 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
526 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
527 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
528 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
530 /* -- Fields for graph properties -- */
531 irg_inline_property inline_property; /**< How to handle inlineing. */
532 mtp_additional_properties additional_properties; /**< Additional graph properties. */
534 /* -- Fields indicating different states of irgraph -- */
535 ir_graph_state_t state;
536 irg_phase_state phase_state; /**< Compiler phase. */
537 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
538 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
539 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
540 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
541 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
542 unsigned fp_model; /**< floating point model of the graph. */
544 /* -- Fields for construction -- */
545 int n_loc; /**< Number of local variables in this
546 procedure including procedure parameters. */
547 void **loc_descriptions; /**< Storage for local variable descriptions. */
549 /* -- Fields for optimizations / analysis information -- */
550 pset *value_table; /**< Hash table for global value numbering (cse)
551 for optimizing use in iropt.c */
552 ir_def_use_edge *outs; /**< Space for the Def-Use arrays. */
553 ir_vrp_info vrp; /**< vrp info */
555 ir_loop *loop; /**< The outermost loop for this graph. */
556 void *link; /**< A void* field to link any information to
559 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
560 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
561 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
562 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
563 ir_loop *l; /**< For callgraph analysis. */
564 size_t callgraph_loop_depth; /**< For callgraph analysis */
565 size_t callgraph_recursion_depth; /**< For callgraph analysis */
566 double method_execution_frequency; /**< For callgraph analysis */
569 /* -- Fields for Walking the graph -- */
570 ir_visited_t visited; /**< this flag is an identifier for
571 ir walk. it will be incremented
572 every time someone walks through
574 ir_visited_t block_visited; /**< same as visited, for a complete block */
576 ir_visited_t self_visited; /**< visited flag of the irg */
578 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
579 updated after every walk */
580 irg_edges_info_t edge_info; /**< edge info for automatic outs */
581 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
583 size_t index; /**< a unique number for each graph */
584 /** extra info which should survive accross multiple passes */
585 void *be_data; /**< backend can put in private data here */
587 unsigned dump_nr; /**< number of graph dumps */
589 int n_outs; /**< Size wasted for outs */
590 long graph_nr; /**< a unique graph number for each
591 graph to make output readable. */
595 ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
600 * Data structure that holds central information about a program
602 * One irp is created by libFirm on construction, so irp should never be NULL.
604 * - main_irg: The ir graph that is the entry point to the program.
605 * (Anything not reachable from here may be optimized away
606 * if this irp represents a whole program.
607 * - irg: List of all ir graphs in the program or module.
608 * - type: A list containing all types known to the translated program.
609 * Some types can have several entries in this list (as a result of
610 * using exchange_types()).
611 * - glob_type: The unique global type that is owner of all global entities
615 firm_kind kind; /**< must be k_ir_prog */
616 ident *name; /**< A file name or the like. */
617 ir_graph *main_irg; /**< The entry point to the compiled program
618 or NULL if no point exists. */
619 ir_graph **graphs; /**< A list of all graphs in the ir. */
620 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
621 to allocate nodes the represent values
622 of constant entities. It is not meant as
624 ir_type *segment_types[IR_SEGMENT_LAST+1];
625 ir_type **types; /**< A list of all types in the ir. */
626 ir_mode **modes; /**< A list of all modes in the ir. */
627 ir_op **opcodes; /**< A list of all opcodes in the ir. */
628 ident **global_asms; /**< An array of global ASM insertions. */
630 /* -- states of and access to generated information -- */
631 irg_phase_state phase_state; /**< The state of construction. */
633 ir_node **ip_outedges; /**< A huge Array that contains all out edges
634 in interprocedural view. */
636 irg_callee_info_state callee_info_state; /**< Validity of callee information.
637 Contains the lowest value or all irgs. */
638 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
639 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
640 of inheritance relations. */
642 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
643 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
644 to looptree over callgraph. */
645 size_t max_callgraph_loop_depth; /**< needed in callgraph. */
646 size_t max_callgraph_recursion_depth; /**< needed in callgraph. */
647 double max_method_execution_frequency; /**< needed in callgraph. */
648 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
649 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
650 ir_entity_usage_computed_state globals_entity_usage_state;
652 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
653 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
654 size_t max_irg_idx; /**< highest unused irg index */
655 long max_node_nr; /**< to generate unique numbers for nodes. */
656 unsigned dump_nr; /**< number of program info dumps */
657 unsigned optimization_dumps :1; /**< dump irg on each optimization */
659 ir_resources_t reserved_resources; /**< Bitset for tracking used global resources. */