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
25 #ifndef FIRM_IR_IRDEFS_H
26 #define FIRM_IR_IRDEFS_H
30 #include "firm_types.h"
35 #include "iredgekinds.h"
36 #include "irtypeinfo.h"
39 #include "callgraph.h"
50 void **data; /**< maps node indices to void* */
53 /** The type of an ir_op. */
55 unsigned code; /**< The unique opcode of the op. */
56 ident *name; /**< The name of the op. */
57 size_t attr_size; /**< Space needed in memory for private attributes
59 op_pin_state pin_state; /**< How to deal with the node in CSE, PRE. */
60 op_arity opar; /**< The arity of operator. */
61 int op_index; /**< The index of the first data operand, 0 for
62 most cases, 1 for Div etc. */
63 int memory_index; /**< index of memory input for memory nodes */
64 int pn_x_regular; /**< for fragile ops the position of the
66 int pn_x_except; /**< for fragile ops the position of the
68 unsigned flags; /**< Flags describing the behavior of the ir_op,
69 a bitmasks of irop_flags. */
70 unsigned tag; /**< Some custom TAG value the op's creator set */
71 void *attr; /**< custom pointer where op's creator can attach
72 attribute stuff to. */
73 ir_op_ops ops; /**< The operations of the this op. */
76 /** Helper values for ir_mode_sort. */
77 enum ir_mode_sort_helper {
78 irmsh_is_num = 0x10, /**< mode represents a number */
79 irmsh_is_data = 0x20, /**< mode represents data (can be carried in registers) */
80 irmsh_is_datab = 0x40, /**< mode represents data or is internal boolean */
81 irmsh_is_dataM = 0x80, /**< mode represents data or is memory */
85 * These values represent the different mode classes of value representations.
86 * Beware: do not change the order of these values without checking
89 typedef enum ir_mode_sort {
90 irms_control_flow = 0, /**< Marks all control flow modes. */
95 irms_memory = 5 | irmsh_is_dataM, /**< Marks the memory mode. Not extensible. (irm_M) */
97 /** Internal boolean representation.
98 Storing to memory impossible, convert first. (irm_b) */
99 irms_internal_boolean = 6 | irmsh_is_datab,
101 /** A mode to represent entities.
102 Restricted int computations can be performed */
103 irms_reference = 7 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM,
104 /** A mode to represent int numbers.
105 Integer computations can be performed. */
106 irms_int_number = 8 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
107 /** A mode to represent float numbers.
108 Floating point computations can be performed. */
109 irms_float_number = 9 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
113 * A descriptor for an IEEE754 float value.
115 typedef struct float_descriptor_t {
116 unsigned char exponent_size; /**< size of exponent in bits */
117 unsigned char mantissa_size; /**< size of mantissa in bits */
118 bool explicit_one; /**< set if the leading one is explicit */
119 } float_descriptor_t;
122 * Contains relevant information about a mode.
124 * Necessary information about a mode is stored in this struct
125 * which is used by the tarval module to perform calculations
126 * and comparisons of values of a such described mode.
129 * - ident *name: Name of this mode. Two modes are different if the name is different.
130 * - ir_mode_sort sort: sort of mode specifying possible usage categories
131 * - int size: size of the mode in Bits.
132 * - unsigned sign:1: signedness of this mode
134 * - modulo_shift specifies for modes of kind irms_int_number
135 * whether shift applies modulo to value of bits to shift
138 * The tech report 1999-44 describing FIRM and predefined modes
142 firm_kind kind; /**< distinguishes this node from others */
143 ident *name; /**< Name ident of this mode */
144 ir_type *type; /**< corresponding primitive type */
146 /* ---------------------------------------------------------------------- */
147 /* On changing this struct you have to evaluate the mode_are_equal function!*/
148 ir_mode_sort sort; /**< coarse classification of this mode:
149 int, float, reference ...
151 ir_mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */
152 unsigned size; /**< size of the mode in Bits. */
153 unsigned sign:1; /**< signedness of this mode */
154 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
155 float_descriptor_t float_desc;
157 /* ---------------------------------------------------------------------- */
158 ir_tarval *min; /**< the minimum value that can be expressed */
159 ir_tarval *max; /**< the maximum value that can be expressed */
160 ir_tarval *null; /**< the value 0 */
161 ir_tarval *one; /**< the value 1 */
162 ir_tarval *minus_one; /**< the value -1 */
163 ir_tarval *all_one; /**< the value ~0 */
164 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
165 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
166 void *link; /**< To store some intermediate information */
167 const void *tv_priv; /**< tarval module will save private data here */
170 /* note: we use "long" here because that is the type used for Proj-Numbers */
171 typedef struct ir_switch_table_entry {
175 } ir_switch_table_entry;
177 struct ir_switch_table {
179 ir_switch_table_entry entries[];
182 /* ir node attributes */
184 /** first attribute of Bad, Block, Anchor nodes */
185 typedef struct irg_attr {
186 ir_graph *irg; /**< The graph this block like node belongs to. */
189 typedef struct bad_attr {
193 typedef struct anchor_attr {
197 /** Block attributes */
198 typedef struct block_attr {
199 /* General attributes */
200 irg_attr irg; /**< The graph this block belongs to. */
201 ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
202 /* Attributes private to construction: */
203 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
204 unsigned dynamic_ins:1; /**< if set in-array is an ARR_F on the heap. */
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 */
265 /** Builtin attributes. */
266 typedef struct builtin_attr {
267 except_attr exc; /**< the exception attribute. MUST be the first one. */
268 ir_builtin_kind kind; /**< kind of the called builtin procedure */
269 ir_type *type; /**< type of called builtin procedure */
272 /** Alloc attributes. */
273 typedef struct alloc_attr {
274 except_attr exc; /**< the exception attribute. MUST be the first one. */
275 ir_where_alloc where; /**< stack, heap or other managed part of memory */
276 ir_type *type; /**< Type of the allocated object. */
279 /** Free attributes. */
280 typedef struct free_attr {
281 ir_type *type; /**< Type of the allocated object. */
282 ir_where_alloc where; /**< stack, heap or other managed part of memory */
285 /** InstOf attributes. */
286 typedef struct io_attr {
287 except_attr exc; /**< the exception attribute. MUST be the first one. */
288 ir_type *type; /**< the type of which the object pointer must be */
291 /** Cast attributes. */
292 typedef struct cast_attr {
293 ir_type *type; /**< Type of the casted node. */
296 /** Load attributes. */
297 typedef struct load_attr {
298 except_attr exc; /**< The exception attribute. MUST be the first one. */
299 unsigned volatility:1; /**< The volatility of this Load operation. */
300 unsigned unaligned:1; /**< The align attribute of this Load operation. */
301 ir_mode *mode; /**< The mode of this Load operation. */
304 /** Store attributes. */
305 typedef struct store_attr {
306 except_attr exc; /**< the exception attribute. MUST be the first one. */
307 unsigned volatility:1; /**< The volatility of this Store operation. */
308 unsigned unaligned:1; /**< The align attribute of this Store operation. */
311 typedef struct phi_attr {
312 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
314 bitset_t *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
315 int pos; /**< For Phi0. Used to remember the value defined by
316 this Phi node. Needed when the Phi is completed
317 to call get_r_internal_value() to find the
318 predecessors. If this attribute is set, the Phi
319 node takes the role of the obsolete Phi0 node,
320 therefore the name. */
324 /**< Cmp attribute. */
325 typedef struct cmp_attr {
326 ir_relation relation; /**< comparison condition. */
329 /**< Confirm attribute. */
330 typedef struct confirm_attr {
331 ir_relation relation; /**< relation between value and bound */
334 /** CopyB attribute. */
335 typedef struct copyb_attr {
336 except_attr exc; /**< The exception attribute. MUST be the first one. */
337 ir_type *type; /**< Type of the copied entity. */
340 /** Bound attribute. */
341 typedef struct bound_attr {
342 except_attr exc; /**< The exception attribute. MUST be the first one. */
345 /** Conv attribute. */
346 typedef struct conv_attr {
347 char strict; /**< If set, this is a strict Conv that cannot be removed. */
350 /** Div attribute. */
351 typedef struct div_attr {
352 except_attr exc; /**< The exception attribute. MUST be the first one. */
353 ir_mode *resmode; /**< Result mode for the division. */
354 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
357 /** Mod attribute. */
358 typedef struct mod_attr {
359 except_attr exc; /**< The exception attribute. MUST be the first one. */
360 ir_mode *resmode; /**< Result mode for the division. */
363 /** Inline Assembler support attribute. */
364 typedef struct asm_attr {
365 /* BEWARE: pin state MUST be the first attribute */
366 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
367 ident *text; /**< The inline assembler text. */
368 ir_asm_constraint *input_constraints; /**< Input constraints. */
369 ir_asm_constraint *output_constraints; /**< Output constraints. */
370 ident **clobbers; /**< List of clobbered registers. */
373 typedef struct proj_attr {
374 long proj; /**< position of tuple sub-value which is projected */
377 typedef struct switch_attr {
379 ir_switch_table *table;
382 /** Some IR-nodes just have one attribute, these are stored here,
383 some have more. Their name is 'irnodename_attr' */
384 typedef union ir_attr {
385 irg_attr irg; /**< For Blocks and Bad: its belonging irg */
386 bad_attr bad; /**< for Bads: irg reference */
387 anchor_attr anchor; /**< for Anchor: irg reference */
388 block_attr block; /**< For Block: Fields needed to construct it */
389 cmp_attr cmp; /**< For Cmp. */
390 cond_attr cond; /**< For Cond. */
391 const_attr con; /**< For Const: contains the value of the constant and a type */
392 symconst_attr symc; /**< For SymConst. */
393 sel_attr sel; /**< For Sel. */
394 call_attr call; /**< For Call. */
395 builtin_attr builtin; /**< For Builtin. */
396 alloc_attr alloc; /**< For Alloc. */
397 free_attr free; /**< For Free. */
398 io_attr instof; /**< For InstOf */
399 cast_attr cast; /**< For Cast. */
400 load_attr load; /**< For Load. */
401 store_attr store; /**< For Store. */
402 phi_attr phi; /**< For Phi. */
403 proj_attr proj; /**< For Proj. */
404 confirm_attr confirm; /**< For Confirm: compare operation and region. */
405 except_attr except; /**< For Phi node construction in case of exceptions */
406 copyb_attr copyb; /**< For CopyB operation */
407 bound_attr bound; /**< For Bound operation */
408 conv_attr conv; /**< For Conv operation */
409 div_attr div; /**< For Div operation */
410 mod_attr mod; /**< For Mod operation */
411 asm_attr assem; /**< For ASM operation. */
412 switch_attr switcha; /**< For Switch operation. */
416 * Edge info to put into an irn.
418 typedef struct irn_edge_kind_info_t {
419 struct list_head outs_head; /**< The list of all outs. */
420 unsigned edges_built : 1; /**< Set edges where built for this node. */
421 unsigned out_count : 31; /**< Number of outs in the list. */
424 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
429 typedef struct ir_def_use_edge {
430 ir_node *use; /** The use node of that edge. */
431 int pos; /** The position of this edge in use's input array. */
435 * The common structure of an irnode.
436 * If the node has some attributes, they are stored in the attr field.
439 /* ------- Basics of the representation ------- */
440 firm_kind kind; /**< Distinguishes this node from others. */
441 unsigned node_idx; /**< The node index of this node in its graph. */
442 ir_op *op; /**< The Opcode of this node. */
443 ir_mode *mode; /**< The Mode of this node. */
444 struct ir_node **in; /**< The array of predecessors / operands. */
445 ir_visited_t visited; /**< The visited counter for walks of the graph. */
446 void *link; /**< To attach additional information to the node, e.g.
447 used during optimization to link to nodes that
448 shall replace a node. */
449 long node_nr; /**< A globally unique node number for each node. */
450 /* ------- Fields for optimizations / analysis information ------- */
451 ir_def_use_edge *out; /**< array of def-use edges. */
452 struct dbg_info *dbi; /**< A pointer to information for debug support. */
453 /* ------- For debugging ------- */
455 unsigned out_valid : 1;
458 /* ------- For analyses -------- */
459 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
460 struct ir_node **deps; /**< Additional dependencies induced by state. */
462 irn_edges_info_t edge_info; /**< Everlasting out edges. */
464 /* ------- Opcode depending fields -------- */
465 ir_attr attr; /**< The set of attributes of this node. Depends on opcode.
466 Must be last field of struct ir_node. */
469 #include "iredgeset.h"
472 * Edge info to put into an irg.
474 typedef struct irg_edge_info_t {
475 ir_edgeset_t edges; /**< A set containing all edges of the current graph. */
476 struct list_head free_edges; /**< list of all free edges. */
477 struct obstack edges_obst; /**< Obstack, where edges are allocated on. */
478 unsigned allocated : 1; /**< Set if edges are allocated on the obstack. */
479 unsigned activated : 1; /**< Set if edges are activated for the graph. */
482 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
485 * Index constants for nodes that can be accessed through the graph anchor node.
487 typedef enum irg_anchors {
489 anchor_end_block = anchor_first, /**< block the end node will belong to,
490 same as Anchors block */
491 anchor_start_block, /**< block the start node will belong to */
492 anchor_end, /**< end node of this ir_graph */
493 anchor_start, /**< start node of this ir_graph */
494 anchor_initial_exec, /**< methods initial control flow */
495 anchor_frame, /**< methods frame */
496 anchor_initial_mem, /**< initial memory of this graph */
497 anchor_args, /**< methods arguments */
498 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
499 anchor_last = anchor_no_mem
501 ENUM_COUNTABLE(irg_anchors)
503 /** A callgraph entry for callees. */
504 typedef struct cg_callee_entry {
505 ir_graph *irg; /**< The called irg. */
506 ir_node **call_list; /**< The list of all calls to the irg. */
507 size_t max_depth; /**< Maximum depth of all Call nodes to irg. */
510 typedef struct ir_vrp_info {
511 struct ir_nodemap infos;
516 * An ir_graph holds all information for a procedure.
519 firm_kind kind; /**< Always set to k_ir_graph. */
520 /* -- Basics of the representation -- */
521 unsigned last_node_idx; /**< The last IR node index for this graph. */
522 ir_entity *ent; /**< The entity of this procedure, i.e.,
523 the type of the procedure and the
524 class it belongs to. */
525 ir_type *frame_type; /**< A class type representing the stack frame.
526 Can include "inner" methods. */
527 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
528 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
529 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
530 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
532 /* -- Fields for graph properties -- */
533 irg_inline_property inline_property; /**< How to handle inlineing. */
534 mtp_additional_properties additional_properties; /**< Additional graph properties. */
536 /* -- Fields indicating different states of irgraph -- */
537 ir_graph_state_t state;
538 irg_phase_state phase_state; /**< Compiler phase. */
539 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
540 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
541 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
542 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
543 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
544 unsigned fp_model; /**< floating point model of the graph. */
546 /* -- Fields for construction -- */
547 int n_loc; /**< Number of local variables in this
548 procedure including procedure parameters. */
549 void **loc_descriptions; /**< Storage for local variable descriptions. */
551 /* -- Fields for optimizations / analysis information -- */
552 pset *value_table; /**< Hash table for global value numbering (cse)
553 for optimizing use in iropt.c */
554 ir_def_use_edge *outs; /**< Space for the Def-Use arrays. */
555 ir_vrp_info vrp; /**< vrp info */
557 ir_loop *loop; /**< The outermost loop for this graph. */
558 void *link; /**< A void* field to link any information to
561 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
562 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
563 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
564 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
565 ir_loop *l; /**< For callgraph analysis. */
566 size_t callgraph_loop_depth; /**< For callgraph analysis */
567 size_t callgraph_recursion_depth; /**< For callgraph analysis */
568 double method_execution_frequency; /**< For callgraph analysis */
571 /* -- Fields for Walking the graph -- */
572 ir_visited_t visited; /**< this flag is an identifier for
573 ir walk. it will be incremented
574 every time someone walks through
576 ir_visited_t block_visited; /**< same as visited, for a complete block */
578 ir_visited_t self_visited; /**< visited flag of the irg */
580 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
581 updated after every walk */
582 irg_edges_info_t edge_info; /**< edge info for automatic outs */
583 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
585 size_t index; /**< a unique number for each graph */
586 /** extra info which should survive accross multiple passes */
587 void *be_data; /**< backend can put in private data here */
589 unsigned dump_nr; /**< number of graph dumps */
591 int n_outs; /**< Size wasted for outs */
592 long graph_nr; /**< a unique graph number for each
593 graph to make output readable. */
597 ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
602 * Data structure that holds central information about a program
604 * One irp is created by libFirm on construction, so irp should never be NULL.
606 * - main_irg: The ir graph that is the entry point to the program.
607 * (Anything not reachable from here may be optimized away
608 * if this irp represents a whole program.
609 * - irg: List of all ir graphs in the program or module.
610 * - type: A list containing all types known to the translated program.
611 * Some types can have several entries in this list (as a result of
612 * using exchange_types()).
613 * - glob_type: The unique global type that is owner of all global entities
617 firm_kind kind; /**< must be k_ir_prog */
618 ident *name; /**< A file name or the like. */
619 ir_graph *main_irg; /**< The entry point to the compiled program
620 or NULL if no point exists. */
621 ir_graph **graphs; /**< A list of all graphs in the ir. */
622 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
623 to allocate nodes the represent values
624 of constant entities. It is not meant as
626 ir_entity *unknown_entity; /**< unique 'unknown'-entity */
627 ir_type *segment_types[IR_SEGMENT_LAST+1];
628 ir_type **types; /**< A list of all types in the ir. */
629 ir_type *none_type; /**< unique 'none'-type */
630 ir_type *code_type; /**< unique 'code'-type */
631 ir_type *unknown_type; /**< unique 'unknown'-type */
632 ir_type *byte_type; /**< type for a 'byte' */
633 ident **global_asms; /**< An array of global ASM insertions. */
635 /* -- states of and access to generated information -- */
636 irg_phase_state phase_state; /**< The state of construction. */
638 ir_node **ip_outedges; /**< A huge Array that contains all out edges
639 in interprocedural view. */
641 irg_callee_info_state callee_info_state; /**< Validity of callee information.
642 Contains the lowest value or all irgs. */
643 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
644 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
645 of inheritance relations. */
647 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
648 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
649 to looptree over callgraph. */
650 size_t max_callgraph_loop_depth; /**< needed in callgraph. */
651 size_t max_callgraph_recursion_depth; /**< needed in callgraph. */
652 double max_method_execution_frequency; /**< needed in callgraph. */
653 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
654 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
655 ir_entity_usage_computed_state globals_entity_usage_state;
657 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
658 size_t max_irg_idx; /**< highest unused irg index */
659 long max_node_nr; /**< to generate unique numbers for nodes. */
660 unsigned dump_nr; /**< number of program info dumps */
661 unsigned optimization_dumps :1; /**< dump irg on each optimization */
663 irp_resources_t reserved_resources; /**< Bitset for tracking used global resources. */