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"
52 * List of phases. (We will add a register/unregister interface if managing
53 * this gets too tedious)
55 typedef enum ir_phase_id {
57 PHASE_VRP = PHASE_FIRST,
58 PHASE_LAST = PHASE_VRP
60 ENUM_COUNTABLE(ir_phase_id)
62 /** The type of an ir_op. */
64 unsigned code; /**< The unique opcode of the op. */
65 ident *name; /**< The name of the op. */
66 size_t attr_size; /**< Space needed in memory for private attributes. */
67 op_pin_state pin_state; /**< How to deal with the node in CSE, PRE. */
68 op_arity opar; /**< The arity of operator. */
69 int op_index; /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */
70 unsigned flags; /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */
71 unsigned tag; /**< Some custom TAG value the op's creator set to. */
72 void *attr; /**< custom pointer where op's creator can attach attribute stuff to. */
74 ir_op_ops ops; /**< The operations of the this op. */
78 * Contains relevant information about a mode.
80 * Necessary information about a mode is stored in this struct
81 * which is used by the tarval module to perform calculations
82 * and comparisons of values of a such described mode.
85 * - ident *name: Name of this mode. Two modes are different if the name is different.
86 * - ir_mode_sort sort: sort of mode specifying possible usage categories
87 * - int size: size of the mode in Bits.
88 * - unsigned sign:1: signedness of this mode
90 * - modulo_shift specifies for modes of kind irms_int_number
91 * whether shift applies modulo to value of bits to shift
94 * The tech report 1999-44 describing FIRM and predefined modes
98 firm_kind kind; /**< distinguishes this node from others */
99 ident *name; /**< Name ident of this mode */
100 ir_type *type; /**< corresponding primitive type */
102 /* ----------------------------------------------------------------------- */
103 /* On changing this struct you have to evaluate the mode_are_equal function!*/
104 ir_mode_sort sort; /**< coarse classification of this mode:
105 int, float, reference ...
108 arithmetic; /**< different arithmetic operations possible with a mode */
109 unsigned size; /**< size of the mode in Bits. */
110 unsigned sign:1; /**< signedness of this mode */
111 unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */
112 unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with
113 vector_elem number of elements, size contains the size
114 of all bits and must be dividable by vector_elem */
116 /* ----------------------------------------------------------------------- */
117 ir_tarval *min; /**< the minimum value that can be expressed */
118 ir_tarval *max; /**< the maximum value that can be expressed */
119 ir_tarval *null; /**< the value 0 */
120 ir_tarval *one; /**< the value 1 */
121 ir_tarval *minus_one; /**< the value -1 */
122 ir_tarval *all_one; /**< the value ~0 */
123 ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */
124 ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
125 void *link; /**< To store some intermediate information */
126 const void *tv_priv; /**< tarval module will save private data here */
129 /* ir node attributes */
131 /** first attribute of Bad, Block, Anchor nodes */
132 typedef struct irg_attr {
133 ir_graph *irg; /**< The graph this block like node belongs to. */
136 typedef struct bad_attr {
140 typedef struct anchor_attr {
144 /** Block attributes */
145 typedef struct block_attr {
146 /* General attributes */
147 irg_attr irg; /**< The graph this block belongs to. */
148 ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
149 /* Attributes private to construction: */
150 unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */
151 unsigned is_dead:1; /**< If set, the block is dead (and could be replace by a Bad. */
152 unsigned marked:1; /**< Can be set/unset to temporary mark a block. */
153 ir_node **graph_arr; /**< An array to store all parameters. */
154 /* Attributes holding analyses information */
155 ir_dom_info dom; /**< Datastructure that holds information about dominators.
157 Eventually overlay with graph_arr as only valid
158 in different phases. Eventually inline the whole
160 ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */
161 ir_node ** in_cg; /**< array with predecessors in
162 * interprocedural_view, if they differ
163 * from intraprocedural predecessors */
164 bitset_t *backedge; /**< Bitfield n set to true if pred n is backedge.*/
165 bitset_t *cg_backedge; /**< Bitfield n set to true if pred n is interprocedural backedge. */
166 ir_extblk *extblk; /**< The extended basic block this block belongs to. */
167 ir_region *region; /**< The immediate structural region this block belongs to. */
168 ir_entity *entity; /**< entitiy representing this block */
169 ir_node *phis; /**< The list of Phi nodes in this block. */
171 struct list_head succ_head; /**< A list head for all successor edges of a block. */
174 /** Cond attributes. */
175 typedef struct cond_attr {
176 long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
177 cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
180 /** Const attributes. */
181 typedef struct const_attr {
182 ir_tarval *tarval; /**< the target value */
185 /** SymConst attributes. */
186 typedef struct symconst_attr {
187 symconst_symbol sym; // old tori
191 /** Sel attributes. */
192 typedef struct sel_attr {
193 ir_entity *entity; /**< entity to select */
196 /** Exception attributes. */
197 typedef struct except_attr {
198 op_pin_state pin_state; /**< the pin state for operations that might generate a exception:
199 If it's know that no exception will be generated, could be set to
200 op_pin_state_floats. */
203 /** Call attributes. */
204 typedef struct call_attr {
205 except_attr exc; /**< the exception attribute. MUST be the first one. */
206 ir_type *type; /**< type of called procedure */
207 ir_entity **callee_arr; /**< result of callee analysis */
208 unsigned tail_call:1; /**< if set, can be a tail call */
211 /** Builtin attributes. */
212 typedef struct builtin_attr {
213 except_attr exc; /**< the exception attribute. MUST be the first one. */
214 ir_builtin_kind kind; /**< kind of the called builtin procedure */
215 ir_type *type; /**< type of called builtin procedure */
218 /** Alloc attributes. */
219 typedef struct alloc_attr {
220 except_attr exc; /**< the exception attribute. MUST be the first one. */
221 ir_where_alloc where; /**< stack, heap or other managed part of memory */
222 ir_type *type; /**< Type of the allocated object. */
225 /** Free attributes. */
226 typedef struct free_attr {
227 ir_type *type; /**< Type of the allocated object. */
228 ir_where_alloc where; /**< stack, heap or other managed part of memory */
231 /** InstOf attributes. */
232 typedef struct io_attr {
233 except_attr exc; /**< the exception attribute. MUST be the first one. */
234 ir_type *type; /**< the type of which the object pointer must be */
237 /** Cast attributes. */
238 typedef struct cast_attr {
239 ir_type *type; /**< Type of the casted node. */
242 /** Load attributes. */
243 typedef struct load_attr {
244 except_attr exc; /**< The exception attribute. MUST be the first one. */
245 unsigned volatility:1; /**< The volatility of this Load operation. */
246 unsigned aligned:1; /**< The align attribute of this Load operation. */
247 ir_mode *mode; /**< The mode of this Load operation. */
250 /** Store attributes. */
251 typedef struct store_attr {
252 except_attr exc; /**< the exception attribute. MUST be the first one. */
253 unsigned volatility:1; /**< The volatility of this Store operation. */
254 unsigned aligned:1; /**< The align attribute of this Store operation. */
257 typedef struct phi_attr {
258 ir_node *next; /**< Points to the next Phi in the Phi list of a block. */
260 bitset_t *backedge; /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
261 int pos; /**< For Phi0. Used to remember the value defined by
262 this Phi node. Needed when the Phi is completed
263 to call get_r_internal_value() to find the
264 predecessors. If this attribute is set, the Phi
265 node takes the role of the obsolete Phi0 node,
266 therefore the name. */
271 /**< Confirm attribute. */
272 typedef struct confirm_attr {
273 pn_Cmp cmp; /**< The compare operation. */
276 /** CopyB attribute. */
277 typedef struct copyb_attr {
278 except_attr exc; /**< The exception attribute. MUST be the first one. */
279 ir_type *type; /**< Type of the copied entity. */
282 /** Bound attribute. */
283 typedef struct bound_attr {
284 except_attr exc; /**< The exception attribute. MUST be the first one. */
287 /** Conv attribute. */
288 typedef struct conv_attr {
289 char strict; /**< If set, this is a strict Conv that cannot be removed. */
292 /** Div/Mod attribute. */
293 typedef struct divmod_attr {
294 except_attr exc; /**< The exception attribute. MUST be the first one. */
295 ir_mode *resmode; /**< Result mode for the division. */
296 char no_remainder; /**< Set, if known that a division can be done without a remainder. */
299 /** Inline Assembler support attribute. */
300 typedef struct asm_attr {
301 /* BEWARE: pin state MUST be the first attribute */
302 op_pin_state pin_state; /**< the pin state for operations that might generate a exception */
303 ident *text; /**< The inline assembler text. */
304 ir_asm_constraint *input_constraints; /**< Input constraints. */
305 ir_asm_constraint *output_constraints; /**< Output constraints. */
306 ident **clobbers; /**< List of clobbered registers. */
309 typedef struct proj_attr {
310 long proj; /**< position of tuple sub-value which is projected */
313 /** Some IR-nodes just have one attribute, these are stored here,
314 some have more. Their name is 'irnodename_attr' */
315 typedef union ir_attr {
316 irg_attr irg; /**< For Blocks and Bad: its belonging irg */
317 bad_attr bad; /**< for Bads: irg reference */
318 anchor_attr anchor; /**< for Anchor: irg reference */
319 block_attr block; /**< For Block: Fields needed to construct it */
320 cond_attr cond; /**< For Cond. */
321 const_attr con; /**< For Const: contains the value of the constant and a type */
322 symconst_attr symc; /**< For SymConst. */
323 sel_attr sel; /**< For Sel. */
324 call_attr call; /**< For Call. */
325 builtin_attr builtin; /**< For Builtin. */
326 alloc_attr alloc; /**< For Alloc. */
327 free_attr free; /**< For Free. */
328 io_attr instof; /**< For InstOf */
329 cast_attr cast; /**< For Cast. */
330 load_attr load; /**< For Load. */
331 store_attr store; /**< For Store. */
332 phi_attr phi; /**< For Phi. */
333 proj_attr proj; /**< For Proj. */
334 confirm_attr confirm; /**< For Confirm: compare operation and region. */
335 except_attr except; /**< For Phi node construction in case of exceptions */
336 copyb_attr copyb; /**< For CopyB operation */
337 bound_attr bound; /**< For Bound operation */
338 conv_attr conv; /**< For Conv operation */
339 divmod_attr divmod; /**< For Div/Mod operation */
340 asm_attr assem; /**< For ASM operation. */
344 * Edge info to put into an irn.
346 typedef struct irn_edge_kind_info_t {
347 struct list_head outs_head; /**< The list of all outs. */
348 unsigned edges_built : 1; /**< Set edges where built for this node. */
349 unsigned out_count : 31; /**< Number of outs in the list. */
352 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
357 typedef struct ir_def_use_edge {
358 ir_node *use; /** The use node of that edge. */
359 int pos; /** The position of this edge in use's input array. */
363 * The common structure of an irnode.
364 * If the node has some attributes, they are stored in the attr field.
367 /* ------- Basics of the representation ------- */
368 firm_kind kind; /**< Distinguishes this node from others. */
369 unsigned node_idx; /**< The node index of this node in its graph. */
370 ir_op *op; /**< The Opcode of this node. */
371 ir_mode *mode; /**< The Mode of this node. */
372 struct ir_node **in; /**< The array of predecessors / operands. */
373 ir_visited_t visited; /**< The visited counter for walks of the graph. */
374 void *link; /**< To attach additional information to the node, e.g.
375 used during optimization to link to nodes that
376 shall replace a node. */
377 long node_nr; /**< A globally unique node number for each node. */
378 /* ------- Fields for optimizations / analysis information ------- */
379 ir_def_use_edge *out; /**< array of def-use edges. */
380 struct dbg_info *dbi; /**< A pointer to information for debug support. */
381 /* ------- For debugging ------- */
383 unsigned out_valid : 1;
386 /* ------- For analyses -------- */
387 ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */
388 struct ir_node **deps; /**< Additional dependencies induced by state. */
390 irn_edges_info_t edge_info; /**< Everlasting out edges. */
392 /* ------- Opcode depending fields -------- */
393 ir_attr attr; /**< The set of attributes of this node. Depends on opcode.
394 Must be last field of struct ir_node. */
397 #include "iredgeset.h"
400 * Edge info to put into an irg.
402 typedef struct irg_edge_info_t {
403 ir_edgeset_t edges; /**< A set containing all edges of the current graph. */
404 struct list_head free_edges; /**< list of all free edges. */
405 struct obstack edges_obst; /**< Obstack, where edges are allocated on. */
406 unsigned allocated : 1; /**< Set if edges are allocated on the obstack. */
407 unsigned activated : 1; /**< Set if edges are activated for the graph. */
410 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
413 * Index constants for nodes that can be accessed through the graph anchor node.
416 anchor_end_block = 0, /**< block the end node will belong to, same as Anchors block */
417 anchor_start_block, /**< block the start node will belong to */
418 anchor_end, /**< end node of this ir_graph */
419 anchor_start, /**< start node of this ir_graph */
420 anchor_initial_exec, /**< methods initial control flow */
421 anchor_frame, /**< methods frame */
422 anchor_tls, /**< pointer to the thread local storage containing all
423 thread local data. */
424 anchor_initial_mem, /**< initial memory of this graph */
425 anchor_args, /**< methods arguments */
426 anchor_bad, /**< bad node of this ir_graph, the one and
427 only in this graph */
428 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
432 /** A callgraph entry for callees. */
433 typedef struct cg_callee_entry {
434 ir_graph *irg; /**< The called irg. */
435 ir_node **call_list; /**< The list of all calls to the irg. */
436 int max_depth; /**< Maximum depth of all Call nodes to irg. */
440 * An ir_graph holds all information for a procedure.
443 firm_kind kind; /**< Always set to k_ir_graph. */
444 /* -- Basics of the representation -- */
445 unsigned last_node_idx; /**< The last IR node index for this graph. */
446 ir_entity *ent; /**< The entity of this procedure, i.e.,
447 the type of the procedure and the
448 class it belongs to. */
449 ir_type *frame_type; /**< A class type representing the stack frame.
450 Can include "inner" methods. */
451 ir_node *anchor; /**< Pointer to the anchor node of this graph. */
452 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
453 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
454 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
456 /* -- Fields for graph properties -- */
457 irg_inline_property inline_property; /**< How to handle inlineing. */
458 mtp_additional_properties additional_properties; /**< Additional graph properties. */
460 /* -- Fields indicating different states of irgraph -- */
461 ir_graph_state_t state;
462 irg_phase_state phase_state; /**< Compiler phase. */
463 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
464 irg_outs_state outs_state; /**< Out edges. */
465 irg_dom_state dom_state; /**< Dominator state information. */
466 irg_dom_state pdom_state; /**< Post Dominator state information. */
467 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
468 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
469 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
470 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
471 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
472 exec_freq_state execfreq_state; /**< Execution frequency state. */
473 ir_entity_usage_computed_state entity_usage_state;
474 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
475 unsigned fp_model; /**< floating point model of the graph. */
477 /* -- Fields for construction -- */
478 int n_loc; /**< Number of local variables in this
479 procedure including procedure parameters. */
480 void **loc_descriptions; /**< Storage for local variable descriptions. */
482 /* -- Fields for optimizations / analysis information -- */
483 pset *value_table; /**< Hash table for global value numbering (cse)
484 for optimizing use in iropt.c */
485 ir_def_use_edge *outs; /**< Space for the Def-Use arrays. */
487 ir_loop *loop; /**< The outermost loop for this graph. */
488 void *link; /**< A void* field to link any information to
491 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
492 unsigned *caller_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
493 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
494 unsigned *callee_isbe; /**< For callgraph analysis: raw bitset if backedge info calculated. */
495 ir_loop *l; /**< For callgraph analysis. */
496 int callgraph_loop_depth; /**< For callgraph analysis */
497 int callgraph_recursion_depth; /**< For callgraph analysis */
498 double method_execution_frequency; /**< For callgraph analysis */
501 /* -- Fields for Walking the graph -- */
502 ir_visited_t visited; /**< this flag is an identifier for
503 ir walk. it will be incremented
504 every time someone walks through
506 ir_visited_t block_visited; /**< same as visited, for a complete block */
508 ir_visited_t self_visited; /**< visited flag of the irg */
510 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
511 updated after every walk */
512 irg_edges_info_t edge_info; /**< edge info for automatic outs */
513 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
515 int index; /**< a unique number for each graph */
516 ir_phase *phases[PHASE_LAST+1]; /**< Phase information. */
517 void *be_data; /**< backend can put in private data here */
519 unsigned dump_nr; /**< number of graph dumps */
521 int n_outs; /**< Size wasted for outs */
522 long graph_nr; /**< a unique graph number for each
523 graph to make output readable. */
527 ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
532 * Data structure that holds central information about a program
534 * One irp is created by libFirm on construction, so irp should never be NULL.
536 * - main_irg: The ir graph that is the entry point to the program.
537 * (Anything not reachable from here may be optimized away
538 * if this irp represents a whole program.
539 * - irg: List of all ir graphs in the program or module.
540 * - type: A list containing all types known to the translated program.
541 * Some types can have several entries in this list (as a result of
542 * using exchange_types()).
543 * - glob_type: The unique global type that is owner of all global entities
547 firm_kind kind; /**< must be k_ir_prog */
548 ident *name; /**< A file name or the like. */
549 ir_graph *main_irg; /**< The entry point to the compiled program
550 or NULL if no point exists. */
551 ir_graph **graphs; /**< A list of all graphs in the ir. */
552 ir_graph *const_code_irg; /**< This ir graph gives the proper environment
553 to allocate nodes the represent values
554 of constant entities. It is not meant as
556 ir_type *segment_types[IR_SEGMENT_LAST+1];
557 ir_type **types; /**< A list of all types in the ir. */
558 ir_mode **modes; /**< A list of all modes in the ir. */
559 ir_op **opcodes; /**< A list of all opcodes in the ir. */
560 ident **global_asms; /**< An array of global ASM insertions. */
562 /* -- states of and access to generated information -- */
563 irg_phase_state phase_state; /**< The state of construction. */
565 irg_outs_state outs_state; /**< The state of out edges of ir nodes. */
566 ir_node **ip_outedges; /**< A huge Array that contains all out edges
567 in interprocedural view. */
568 irg_outs_state trouts_state; /**< The state of out edges of type information. */
570 irg_callee_info_state callee_info_state; /**< Validity of callee information.
571 Contains the lowest value or all irgs. */
572 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
573 inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure
574 of inheritance relations. */
576 irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
577 ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point
578 to looptree over callgraph. */
579 int max_callgraph_loop_depth; /**< needed in callgraph. */
580 int max_callgraph_recursion_depth; /**< needed in callgraph. */
581 double max_method_execution_frequency; /**< needed in callgraph. */
582 irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
583 exec_freq_state execfreq_state; /**< The state of execution frequency information */
584 loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */
585 ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */
586 ir_entity_usage_computed_state globals_entity_usage_state;
588 ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */
589 ir_label_t last_label_nr; /**< The highest label number for generating unique labels. */
590 int max_irg_idx; /**< highest unused irg index */
591 long max_node_nr; /**< to generate unique numbers for nodes. */
592 unsigned dump_nr; /**< number of program info dumps */
594 ir_resources_t reserved_resources; /**< Bitset for tracking used global resources. */