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"
38 #include "callgraph.h"
49 void **data; /**< maps node indices to void* */
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
58 op_pin_state pin_state; /**< How to deal with the node in CSE, PRE. */
59 op_arity opar; /**< The arity of operator. */
60 int op_index; /**< The index of the first data operand, 0 for
61 most cases, 1 for Div etc. */
62 int memory_index; /**< index of memory input for memory nodes */
63 int pn_x_regular; /**< for fragile ops the position of the
65 int pn_x_except; /**< for fragile ops the position of the
67 unsigned flags; /**< Flags describing the behavior of the ir_op,
68 a bitmasks of irop_flags. */
69 unsigned tag; /**< Some custom TAG value the op's creator set */
70 void *attr; /**< custom pointer where op's creator can attach
71 attribute stuff to. */
72 ir_op_ops ops; /**< The operations of the this op. */
75 /** Helper values for ir_mode_sort. */
76 enum ir_mode_sort_helper {
77 irmsh_is_num = 0x10, /**< mode represents a number */
78 irmsh_is_data = 0x20, /**< mode represents data (can be carried in registers) */
79 irmsh_is_datab = 0x40, /**< mode represents data or is internal boolean */
80 irmsh_is_dataM = 0x80, /**< mode represents data or is memory */
84 * These values represent the different mode classes of value representations.
85 * Beware: do not change the order of these values without checking
88 typedef enum ir_mode_sort {
89 irms_control_flow = 0, /**< Marks all control flow modes. */
94 irms_memory = 5 | irmsh_is_dataM, /**< Marks the memory mode. Not extensible. (irm_M) */
96 /** Internal boolean representation.
97 Storing to memory impossible, convert first. (irm_b) */
98 irms_internal_boolean = 6 | irmsh_is_datab,
100 /** A mode to represent entities.
101 Restricted int computations can be performed */
102 irms_reference = 7 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM,
103 /** A mode to represent int numbers.
104 Integer computations can be performed. */
105 irms_int_number = 8 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
106 /** A mode to represent float numbers.
107 Floating point computations can be performed. */
108 irms_float_number = 9 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
112 * A descriptor for an IEEE754 float value.
114 typedef struct float_descriptor_t {
115 unsigned char exponent_size; /**< size of exponent in bits */
116 unsigned char mantissa_size; /**< size of mantissa in bits */
117 bool explicit_one; /**< set if the leading one is explicit */
118 } float_descriptor_t;
121 * Contains relevant information about a mode.
123 * Necessary information about a mode is stored in this struct
124 * which is used by the tarval module to perform calculations
125 * and comparisons of values of a such described mode.
128 * - ident *name: Name of this mode. Two modes are different if the name is different.
129 * - ir_mode_sort sort: sort of mode specifying possible usage categories
130 * - int size: size of the mode in Bits.
131 * - unsigned sign:1: signedness of this mode
133 * - modulo_shift specifies for modes of kind irms_int_number
134 * whether shift applies modulo to value of bits to shift
137 * The tech report 1999-44 describing FIRM and predefined modes
141 firm_kind kind; /**< distinguishes this node from others */
142 ident *name; /**< Name ident of this mode */
143 ir_type *type; /**< corresponding primitive type */
145 /* ---------------------------------------------------------------------- */
146 /* On changing this struct you have to evaluate the mode_are_equal function!*/
147 ir_mode_sort sort; /**< coarse classification of this mode:
148 int, float, reference ...
150 ir_mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */
151 unsigned size; /**< size of the mode in Bits. */
152 unsigned sign:1; /**< signedness of this mode */
153 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
154 float_descriptor_t float_desc;
156 /* ---------------------------------------------------------------------- */
157 ir_tarval *min; /**< the minimum value that can be expressed */
158 ir_tarval *max; /**< the maximum value that can be expressed */
159 ir_tarval *null; /**< the value 0 */
160 ir_tarval *one; /**< the value 1 */
161 ir_tarval *minus_one; /**< the value -1 */
162 ir_tarval *all_one; /**< the value ~0 */
163 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
164 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
165 void *link; /**< To store some intermediate information */
166 const void *tv_priv; /**< tarval module will save private data here */
169 /* note: we use "long" here because that is the type used for Proj-Numbers */
170 typedef struct ir_switch_table_entry {
174 } ir_switch_table_entry;
176 struct ir_switch_table {
178 ir_switch_table_entry entries[];
181 /* ir node attributes */
183 /** first attribute of Bad, Block, Anchor nodes */
184 typedef struct irg_attr {
185 ir_graph *irg; /**< The graph this block like node belongs to. */
188 typedef struct bad_attr {
192 typedef struct anchor_attr {
196 /** Block attributes */
197 typedef struct block_attr {
198 /* General attributes */
199 irg_attr irg; /**< The graph this block belongs to. */
200 ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
201 /* Attributes private to construction: */
202 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
203 unsigned dynamic_ins:1; /**< if set in-array is an ARR_F on the heap. */
204 unsigned marked:1; /**< Can be set/unset to temporary mark a block. */
205 ir_node **graph_arr; /**< An array to store all parameters. */
206 /* Attributes holding analyses information */
207 ir_dom_info dom; /**< Datastructure that holds information about dominators.
209 Eventually overlay with graph_arr as only valid
210 in different phases. Eventually inline the whole
212 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
213 bitset_t *backedge; /**< Bitfield n set to true if pred n is backedge.*/
214 ir_entity *entity; /**< entitiy representing this block */
215 ir_node *phis; /**< The list of Phi nodes in this block. */
218 /** Cond attributes. */
219 typedef struct cond_attr {
220 cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
223 /** Const attributes. */
224 typedef struct const_attr {
225 ir_tarval *tarval; /**< the target value */
228 /** SymConst attributes. */
229 typedef struct symconst_attr {
230 symconst_symbol sym; // old tori
234 /** Sel attributes. */
235 typedef struct sel_attr {
236 ir_entity *entity; /**< entity to select */
239 /** Exception attributes. */
240 typedef struct except_attr {
241 unsigned pin_state : 2; /**< the pin state for operations with
242 variable pinned state. Contains a
244 unsigned throws_exception : 1; /**< if true a fragile op throws and
245 must produce X_except and X_regular
249 /** Call attributes. */
250 typedef struct call_attr {
251 except_attr exc; /**< the exception attribute. MUST be the first one. */
252 ir_type *type; /**< type of called procedure */
253 ir_entity **callee_arr; /**< result of callee analysis */
256 /** Builtin attributes. */
257 typedef struct builtin_attr {
258 except_attr exc; /**< the exception attribute. MUST be the first one. */
259 ir_builtin_kind kind; /**< kind of the called builtin procedure */
260 ir_type *type; /**< type of called builtin procedure */
263 /** Alloc attributes. */
264 typedef struct alloc_attr {
265 except_attr exc; /**< the exception attribute. MUST be the first one. */
266 ir_where_alloc where; /**< stack, heap or other managed part of memory */
267 ir_type *type; /**< Type of the allocated object. */
270 /** Free attributes. */
271 typedef struct free_attr {
272 ir_type *type; /**< Type of the allocated object. */
273 ir_where_alloc where; /**< stack, heap or other managed part of memory */
276 /** InstOf attributes. */
277 typedef struct io_attr {
278 except_attr exc; /**< the exception attribute. MUST be the first one. */
279 ir_type *type; /**< the type of which the object pointer must be */
282 /** Cast attributes. */
283 typedef struct cast_attr {
284 ir_type *type; /**< Type of the casted node. */
287 /** Load attributes. */
288 typedef struct load_attr {
289 except_attr exc; /**< The exception attribute. MUST be the first one. */
290 ir_volatility volatility:1; /**< The volatility of this Load operation. */
291 ir_align unaligned:1; /**< The align attribute of this Load operation. */
292 ir_mode *mode; /**< The mode of this Load operation. */
295 /** Store attributes. */
296 typedef struct store_attr {
297 except_attr exc; /**< the exception attribute. MUST be the first one. */
298 ir_volatility volatility:1; /**< The volatility of this Store operation. */
299 ir_align unaligned:1; /**< The align attribute of this Store operation. */
302 typedef struct phi_attr {
303 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
305 bitset_t *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
306 int pos; /**< For Phi0. Used to remember the value defined by
307 this Phi node. Needed when the Phi is completed
308 to call get_r_internal_value() to find the
309 predecessors. If this attribute is set, the Phi
310 node takes the role of the obsolete Phi0 node,
311 therefore the name. */
315 /**< Cmp attribute. */
316 typedef struct cmp_attr {
317 ir_relation relation; /**< comparison condition. */
320 /**< Confirm attribute. */
321 typedef struct confirm_attr {
322 ir_relation relation; /**< relation between value and bound */
325 /** CopyB attribute. */
326 typedef struct copyb_attr {
327 except_attr exc; /**< The exception attribute. MUST be the first one. */
328 ir_type *type; /**< Type of the copied entity. */
331 /** Bound attribute. */
332 typedef struct bound_attr {
333 except_attr exc; /**< The exception attribute. MUST be the first one. */
336 /** Conv attribute. */
337 typedef struct conv_attr {
338 char strict; /**< If set, this is a strict Conv that cannot be removed. */
341 /** Div attribute. */
342 typedef struct div_attr {
343 except_attr exc; /**< The exception attribute. MUST be the first one. */
344 ir_mode *resmode; /**< Result mode for the division. */
345 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
348 /** Mod attribute. */
349 typedef struct mod_attr {
350 except_attr exc; /**< The exception attribute. MUST be the first one. */
351 ir_mode *resmode; /**< Result mode for the division. */
354 /** Inline Assembler support attribute. */
355 typedef struct asm_attr {
356 /* BEWARE: pin state MUST be the first attribute */
357 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
358 ident *text; /**< The inline assembler text. */
359 ir_asm_constraint *input_constraints; /**< Input constraints. */
360 ir_asm_constraint *output_constraints; /**< Output constraints. */
361 ident **clobbers; /**< List of clobbered registers. */
364 typedef struct proj_attr {
365 long proj; /**< position of tuple sub-value which is projected */
368 typedef struct switch_attr {
370 ir_switch_table *table;
373 /** Some IR-nodes just have one attribute, these are stored here,
374 some have more. Their name is 'irnodename_attr' */
375 typedef union ir_attr {
376 irg_attr irg; /**< For Blocks and Bad: its belonging irg */
377 bad_attr bad; /**< for Bads: irg reference */
378 anchor_attr anchor; /**< for Anchor: irg reference */
379 block_attr block; /**< For Block: Fields needed to construct it */
380 cmp_attr cmp; /**< For Cmp. */
381 cond_attr cond; /**< For Cond. */
382 const_attr con; /**< For Const: contains the value of the constant and a type */
383 symconst_attr symc; /**< For SymConst. */
384 sel_attr sel; /**< For Sel. */
385 call_attr call; /**< For Call. */
386 builtin_attr builtin; /**< For Builtin. */
387 alloc_attr alloc; /**< For Alloc. */
388 free_attr free; /**< For Free. */
389 io_attr instof; /**< For InstOf */
390 cast_attr cast; /**< For Cast. */
391 load_attr load; /**< For Load. */
392 store_attr store; /**< For Store. */
393 phi_attr phi; /**< For Phi. */
394 proj_attr proj; /**< For Proj. */
395 confirm_attr confirm; /**< For Confirm: compare operation and region. */
396 except_attr except; /**< For Phi node construction in case of exceptions */
397 copyb_attr copyb; /**< For CopyB operation */
398 bound_attr bound; /**< For Bound operation */
399 conv_attr conv; /**< For Conv operation */
400 div_attr div; /**< For Div operation */
401 mod_attr mod; /**< For Mod operation */
402 asm_attr assem; /**< For ASM operation. */
403 switch_attr switcha; /**< For Switch operation. */
407 * Edge info to put into an irn.
409 typedef struct irn_edge_kind_info_t {
410 struct list_head outs_head; /**< The list of all outs. */
411 unsigned edges_built : 1; /**< Set edges where built for this node. */
412 unsigned out_count : 31; /**< Number of outs in the list. */
415 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
420 typedef struct ir_def_use_edge {
421 ir_node *use; /** The use node of that edge. */
422 int pos; /** The position of this edge in use's input array. */
426 * The common structure of an irnode.
427 * If the node has some attributes, they are stored in the attr field.
430 /* ------- Basics of the representation ------- */
431 firm_kind kind; /**< Distinguishes this node from others. */
432 unsigned node_idx; /**< The node index of this node in its graph. */
433 ir_op *op; /**< The Opcode of this node. */
434 ir_mode *mode; /**< The Mode of this node. */
435 struct ir_node **in; /**< The array of predecessors / operands. */
436 ir_visited_t visited; /**< The visited counter for walks of the graph. */
437 void *link; /**< To attach additional information to the node, e.g.
438 used during optimization to link to nodes that
439 shall replace a node. */
440 long node_nr; /**< A globally unique node number for each node. */
441 /* ------- Fields for optimizations / analysis information ------- */
442 ir_def_use_edge *out; /**< array of def-use edges. */
443 struct dbg_info *dbi; /**< A pointer to information for debug support. */
444 /* ------- For debugging ------- */
446 unsigned out_valid : 1;
449 /* ------- For analyses -------- */
450 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
451 struct ir_node **deps; /**< Additional dependencies induced by state. */
453 irn_edges_info_t edge_info; /**< Everlasting out edges. */
455 /* ------- Opcode depending fields -------- */
456 ir_attr attr; /**< The set of attributes of this node. Depends on opcode.
457 Must be last field of struct ir_node. */
460 #include "iredgeset.h"
463 * Edge info to put into an irg.
465 typedef struct irg_edge_info_t {
466 ir_edgeset_t edges; /**< A set containing all edges of the current graph. */
467 struct list_head free_edges; /**< list of all free edges. */
468 struct obstack edges_obst; /**< Obstack, where edges are allocated on. */
469 unsigned allocated : 1; /**< Set if edges are allocated on the obstack. */
470 unsigned activated : 1; /**< Set if edges are activated for the graph. */
473 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
476 * Index constants for nodes that can be accessed through the graph anchor node.
478 typedef enum irg_anchors {
480 anchor_end_block = anchor_first, /**< block the end node will belong to,
481 same as Anchors block */
482 anchor_start_block, /**< block the start node will belong to */
483 anchor_end, /**< end node of this ir_graph */
484 anchor_start, /**< start node of this ir_graph */
485 anchor_initial_exec, /**< methods initial control flow */
486 anchor_frame, /**< methods frame */
487 anchor_initial_mem, /**< initial memory of this graph */
488 anchor_args, /**< methods arguments */
489 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
490 anchor_last = anchor_no_mem
492 ENUM_COUNTABLE(irg_anchors)
494 /** A callgraph entry for callees. */
495 typedef struct cg_callee_entry {
496 ir_graph *irg; /**< The called irg. */
497 ir_node **call_list; /**< The list of all calls to the irg. */
498 size_t max_depth; /**< Maximum depth of all Call nodes to irg. */
501 typedef struct ir_vrp_info {
502 struct ir_nodemap infos;
507 * An ir_graph holds all information for a procedure.
510 firm_kind kind; /**< Always set to k_ir_graph. */
511 /* -- Basics of the representation -- */
512 unsigned last_node_idx; /**< The last IR node index for this graph. */
513 ir_entity *ent; /**< The entity of this procedure, i.e.,
514 the type of the procedure and the
515 class it belongs to. */
516 ir_type *frame_type; /**< A class type representing the stack frame.
517 Can include "inner" methods. */
518 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
519 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
520 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
522 /* -- Fields for graph properties -- */
523 irg_inline_property inline_property; /**< How to handle inlineing. */
524 mtp_additional_properties additional_properties; /**< Additional graph properties. */
526 /* -- Fields indicating different states of irgraph -- */
527 ir_graph_properties_t properties;
528 ir_graph_constraints_t constraints;
529 irg_phase_state phase_state; /**< Compiler phase. */
530 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
531 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
532 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
533 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
534 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
535 unsigned fp_model; /**< floating point model of the graph. */
537 /* -- Fields for construction -- */
538 int n_loc; /**< Number of local variables in this
539 procedure including procedure parameters. */
540 void **loc_descriptions; /**< Storage for local variable descriptions. */
542 /* -- Fields for optimizations / analysis information -- */
543 pset *value_table; /**< Hash table for global value numbering (cse)
544 for optimizing use in iropt.c */
545 ir_def_use_edge *outs; /**< Space for the Def-Use arrays. */
546 ir_vrp_info vrp; /**< vrp info */
548 ir_loop *loop; /**< The outermost loop for this graph. */
549 void *link; /**< A void* field to link any information to
552 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
553 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
554 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
555 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
556 ir_loop *l; /**< For callgraph analysis. */
557 size_t callgraph_loop_depth; /**< For callgraph analysis */
558 size_t callgraph_recursion_depth; /**< For callgraph analysis */
559 double method_execution_frequency; /**< For callgraph analysis */
562 /* -- Fields for Walking the graph -- */
563 ir_visited_t visited; /**< this flag is an identifier for
564 ir walk. it will be incremented
565 every time someone walks through
567 ir_visited_t block_visited; /**< same as visited, for a complete block */
569 ir_visited_t self_visited; /**< visited flag of the irg */
571 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
572 updated after every walk */
573 irg_edges_info_t edge_info; /**< edge info for automatic outs */
574 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
576 size_t index; /**< a unique number for each graph */
577 /** extra info which should survive accross multiple passes */
578 void *be_data; /**< backend can put in private data here */
580 unsigned dump_nr; /**< number of graph dumps */
582 int n_outs; /**< Size wasted for outs */
583 long graph_nr; /**< a unique graph number for each
584 graph to make output readable. */
588 ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
593 * Data structure that holds central information about a program
595 * One irp is created by libFirm on construction, so irp should never be NULL.
597 * - main_irg: The ir graph that is the entry point to the program.
598 * (Anything not reachable from here may be optimized away
599 * if this irp represents a whole program.
600 * - irg: List of all ir graphs in the program or module.
601 * - type: A list containing all types known to the translated program.
602 * Some types can have several entries in this list (as a result of
603 * using exchange_types()).
604 * - glob_type: The unique global type that is owner of all global entities
608 firm_kind kind; /**< must be k_ir_prog */
609 ident *name; /**< A file name or the like. */
610 ir_graph *main_irg; /**< The entry point to the compiled program
611 or NULL if no point exists. */
612 ir_graph **graphs; /**< A list of all graphs in the ir. */
613 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
614 to allocate nodes the represent values
615 of constant entities. It is not meant as
617 ir_entity *unknown_entity; /**< unique 'unknown'-entity */
618 ir_type *segment_types[IR_SEGMENT_LAST+1];
619 ir_type **types; /**< A list of all types in the ir. */
620 ir_type *none_type; /**< unique 'none'-type */
621 ir_type *code_type; /**< unique 'code'-type */
622 ir_type *unknown_type; /**< unique 'unknown'-type */
623 ir_type *byte_type; /**< type for a 'byte' */
624 ident **global_asms; /**< An array of global ASM insertions. */
626 /* -- states of and access to generated information -- */
627 irg_phase_state phase_state; /**< The state of construction. */
629 ir_node **ip_outedges; /**< A huge Array that contains all out edges
630 in interprocedural view. */
632 irg_callee_info_state callee_info_state; /**< Validity of callee information.
633 Contains the lowest value or all irgs. */
634 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
635 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
636 of inheritance relations. */
638 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
639 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
640 to looptree over callgraph. */
641 size_t max_callgraph_loop_depth; /**< needed in callgraph. */
642 size_t max_callgraph_recursion_depth; /**< needed in callgraph. */
643 double max_method_execution_frequency; /**< needed in callgraph. */
644 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
645 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
646 ir_entity_usage_computed_state globals_entity_usage_state;
648 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
649 size_t max_irg_idx; /**< highest unused irg index */
650 long max_node_nr; /**< to generate unique numbers for nodes. */
651 unsigned dump_nr; /**< number of program info dumps */
653 irp_resources_t reserved_resources; /**< Bitset for tracking used global resources. */