3 * File name: ir/ir/irgraph.c
4 * Purpose: Entry point to the representation of procedure code -- internal header.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier, Michael Beck
9 * Copyright: (c) 1998-2007 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * IR graph construction.
21 #include "firm_types.h"
24 #include "firm_common_t.h"
25 #include "irtypeinfo.h"
27 #include "pseudo_irg.h"
31 #include "tr_inheritance.h"
32 #include "iredgekinds.h"
36 #include "execution_frequency.h"
42 /** Prefix that is added to every frame type. */
43 #define FRAME_TP_SUFFIX "frame_tp"
46 * Edge info to put into an irg.
48 typedef struct _irg_edge_info_t {
49 set *edges; /**< a set containing all edges of a graph. */
50 unsigned activated : 1; /**< set if edges are activated for the graph. */
53 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
56 * Index constants for nodes that can be accessed through the graph itself.
59 anchor_start_block = 0, /**< block the start node will belong to */
60 anchor_start, /**< start node of this ir_graph */
61 anchor_end_block, /**< block the end node will belong to */
62 anchor_end, /**< end node of this ir_graph */
63 anchor_end_reg, /**< end node of this ir_graph */
64 anchor_end_except, /**< end node of this ir_graph */
65 anchor_frame, /**< method's frame */
66 anchor_globals, /**< pointer to the data segment containing all
67 globals as well as global procedures. */
68 anchor_tls, /**< pointer to the thread local storage containing all
70 anchor_initial_mem, /**< initial memory of this graph */
71 anchor_args, /**< methods arguments */
72 anchor_value_param_base, /**< method value param base */
73 anchor_bad, /**< bad node of this ir_graph, the one and
75 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
79 /** A callgraph entry for callees. */
80 typedef struct cg_callee_entry {
81 ir_graph *irg; /**< The called irg. */
82 ir_node **call_list; /**< The list of all calls to the irg. */
83 int max_depth; /**< Maximum depth of all Call nodes to irg. */
87 * An ir_graph holds all information for a procedure.
90 firm_kind kind; /**< Always set to k_ir_graph. */
91 /* -- Basics of the representation -- */
92 ir_entity *ent; /**< The entity of this procedure, i.e.,
93 the type of the procedure and the
94 class it belongs to. */
95 ir_type *frame_type; /**< A class type representing the stack frame.
96 Can include "inner" methods. */
97 ir_node *anchors[anchor_max]; /**< List of anchor nodes. */
98 ir_node **proj_args; /**< Projs of the methods arguments. */
99 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
100 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
101 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
103 unsigned last_node_idx; /**< The last IR node index for this graph. */
105 /* -- Fields for graph properties -- */
106 irg_inline_property inline_property; /**< How to handle inlineing. */
107 unsigned additional_properties; /**< Additional graph properties. */
109 /* -- Fields indicating different states of irgraph -- */
110 irg_phase_state phase_state; /**< Compiler phase. */
111 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
112 irg_outs_state outs_state; /**< Out edges. */
113 irg_dom_state dom_state; /**< Dominator state information. */
114 irg_dom_state pdom_state; /**< Post Dominator state information. */
115 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
116 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
117 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
118 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
119 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
120 exec_freq_state execfreq_state; /**< Execution frequency state. */
121 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
122 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
123 unsigned fp_model; /**< floating point model of the graph. */
125 /* -- Fields for construction -- */
126 #if USE_EXPLICIT_PHI_IN_STACK
127 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
129 int n_loc; /**< Number of local variables in this
130 procedure including procedure parameters. */
131 void **loc_descriptions; /**< Storage for local variable descriptions. */
133 /* -- Fields for optimizations / analysis information -- */
134 pset *value_table; /**< Hash table for global value numbering (cse)
135 for optimizing use in iropt.c */
136 ir_node **outs; /**< Space for the out arrays. */
138 ir_loop *loop; /**< The outermost loop for this graph. */
139 void *link; /**< A void* field to link any information to
142 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
143 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
144 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
145 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
146 int callgraph_loop_depth; /**< For callgraph analysis */
147 int callgraph_recursion_depth; /**< For callgraph analysis */
148 double method_execution_frequency; /**< For callgraph analysis */
150 ir_loop *l; /**< For callgraph analysis. */
152 /* -- Fields for Walking the graph -- */
153 unsigned long visited; /**< this flag is an identifier for
154 ir walk. it will be incremented
155 every time someone walks through
157 unsigned long block_visited; /**< same as visited, for a complete block */
160 unsigned using_visited : 1; /**< set to 1 if we are currently using the visited flag */
161 unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */
162 unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */
165 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
166 updated after every walk */
167 irg_edges_info_t edge_info; /**< edge info for automatic outs */
168 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
171 int n_outs; /**< Size wasted for outs */
172 long graph_nr; /**< a unique graph number for each graph to make output
179 * Initializes the graph construction module
181 void firm_init_irgraph(void);
183 /* Internal constructor that does not add to irp_irgs or the like. */
184 ir_graph *new_r_ir_graph (ir_entity *ent, int n_loc);
186 /** Make a rudimentary ir graph for the constant code.
187 Must look like a correct irg, spare everything else. */
188 ir_graph *new_const_code_irg(void);
191 * Set the op_pin_state_pinned state of a graph.
193 * @param irg the IR graph
194 * @param p new pin state
197 set_irg_pinned (ir_graph *irg, op_pin_state p);
199 /** Returns the obstack associated with the graph. */
200 struct obstack *get_irg_obstack(const ir_graph *irg);
203 * Returns true if the node n is allocated on the storage of graph irg.
205 * @param irg the IR graph
206 * @param n the IR node
208 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
210 /*-------------------------------------------------------------------*/
211 /* inline functions for graphs */
212 /*-------------------------------------------------------------------*/
214 extern int firm_interprocedural_view;
217 _get_interprocedural_view(void) {
218 return firm_interprocedural_view;
222 _is_ir_graph(const void *thing) {
223 return (get_kind(thing) == k_ir_graph);
226 /** Returns the start block of a graph. */
227 static INLINE ir_node *
228 _get_irg_start_block(const ir_graph *irg) {
229 return irg->anchors[anchor_start_block];
233 _set_irg_start_block(ir_graph *irg, ir_node *node) {
234 irg->anchors[anchor_start_block] = node;
237 static INLINE ir_node *
238 _get_irg_start(const ir_graph *irg) {
239 return irg->anchors[anchor_start];
243 _set_irg_start(ir_graph *irg, ir_node *node) {
244 irg->anchors[anchor_start] = node;
247 static INLINE ir_node *
248 _get_irg_end_block(const ir_graph *irg) {
249 return irg->anchors[anchor_end_block];
253 _set_irg_end_block(ir_graph *irg, ir_node *node) {
254 irg->anchors[anchor_end_block] = node;
257 static INLINE ir_node *
258 _get_irg_end(const ir_graph *irg) {
259 return irg->anchors[anchor_end];
263 _set_irg_end(ir_graph *irg, ir_node *node) {
264 irg->anchors[anchor_end] = node;
267 static INLINE ir_node *
268 _get_irg_end_reg(const ir_graph *irg) {
269 return irg->anchors[anchor_end_reg];
272 static INLINE ir_node *
273 _get_irg_end_except (const ir_graph *irg) {
274 return irg->anchors[anchor_end_except];
277 static INLINE ir_node *
278 _get_irg_frame(const ir_graph *irg) {
279 return irg->anchors[anchor_frame];
283 _set_irg_frame(ir_graph *irg, ir_node *node) {
284 irg->anchors[anchor_frame] = node;
287 static INLINE ir_node *
288 _get_irg_globals(const ir_graph *irg) {
289 return irg->anchors[anchor_globals];
293 _set_irg_globals(ir_graph *irg, ir_node *node) {
294 irg->anchors[anchor_globals] = node;
297 static INLINE ir_node *
298 _get_irg_tls(const ir_graph *irg) {
299 return irg->anchors[anchor_tls];
303 _set_irg_tls(ir_graph *irg, ir_node *node) {
304 irg->anchors[anchor_tls] = node;
307 static INLINE ir_node *
308 _get_irg_initial_mem(const ir_graph *irg) {
309 return irg->anchors[anchor_initial_mem];
313 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
314 irg->anchors[anchor_initial_mem] = node;
317 static INLINE ir_node *
318 _get_irg_args(const ir_graph *irg) {
319 return irg->anchors[anchor_args];
323 _set_irg_args(ir_graph *irg, ir_node *node) {
324 irg->anchors[anchor_args] = node;
327 static INLINE ir_node *
328 _get_irg_value_param_base(const ir_graph *irg) {
329 return irg->anchors[anchor_value_param_base];
333 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
334 irg->anchors[anchor_value_param_base] = node;
337 static INLINE ir_node **
338 _get_irg_proj_args(const ir_graph *irg) {
339 return irg->proj_args;
343 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
344 irg->proj_args = nodes;
347 static INLINE ir_node *
348 _get_irg_bad(const ir_graph *irg) {
349 return irg->anchors[anchor_bad];
353 _set_irg_bad(ir_graph *irg, ir_node *node) {
354 irg->anchors[anchor_bad] = node;
357 static INLINE ir_node *
358 _get_irg_no_mem(const ir_graph *irg) {
359 return irg->anchors[anchor_no_mem];
363 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
364 irg->anchors[anchor_no_mem] = node;
366 static INLINE ir_node *
367 _get_irg_current_block(const ir_graph *irg) {
368 return irg->current_block;
372 _set_irg_current_block(ir_graph *irg, ir_node *node) {
373 irg->current_block = node;
376 static INLINE ir_entity *
377 _get_irg_entity(const ir_graph *irg) {
378 assert(irg && irg->ent);
383 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
387 static INLINE ir_type *
388 _get_irg_frame_type(ir_graph *irg) {
389 assert(irg && irg->frame_type);
390 return irg->frame_type = skip_tid(irg->frame_type);
394 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
395 assert(is_frame_type(ftp));
396 irg->frame_type = ftp;
399 static INLINE struct obstack *
400 _get_irg_obstack(const ir_graph *irg) {
405 static INLINE irg_phase_state
406 _get_irg_phase_state(const ir_graph *irg) {
407 return irg->phase_state;
411 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
412 irg->phase_state = state;
415 static INLINE op_pin_state
416 _get_irg_pinned(const ir_graph *irg) {
417 return irg->irg_pinned_state;
420 static INLINE irg_outs_state
421 _get_irg_outs_state(const ir_graph *irg) {
422 return irg->outs_state;
426 _set_irg_outs_inconsistent(ir_graph *irg) {
427 if (irg->outs_state == outs_consistent)
428 irg->outs_state = outs_inconsistent;
431 static INLINE irg_extblk_state
432 _get_irg_extblk_state(const ir_graph *irg) {
433 return irg->extblk_state;
437 _set_irg_extblk_inconsistent(ir_graph *irg) {
438 if (irg->extblk_state == extblk_valid)
439 irg->extblk_state = extblk_invalid;
442 static INLINE irg_dom_state
443 _get_irg_dom_state(const ir_graph *irg) {
444 return irg->dom_state;
447 static INLINE irg_dom_state
448 _get_irg_postdom_state(const ir_graph *irg) {
449 return irg->pdom_state;
453 _set_irg_doms_inconsistent(ir_graph *irg) {
454 if (irg->dom_state != dom_none)
455 irg->dom_state = dom_inconsistent;
456 if (irg->pdom_state != dom_none)
457 irg->pdom_state = dom_inconsistent;
460 static INLINE irg_loopinfo_state
461 _get_irg_loopinfo_state(const ir_graph *irg) {
462 return irg->loopinfo_state;
466 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
467 irg->loopinfo_state = s;
471 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
472 irg->loopinfo_state &= ~loopinfo_valid;
476 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
477 irg->irg_pinned_state = p;
480 static INLINE irg_callee_info_state
481 _get_irg_callee_info_state(const ir_graph *irg) {
482 return irg->callee_info_state;
486 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
487 irg_callee_info_state irp_state = get_irp_callee_info_state();
489 irg->callee_info_state = s;
491 /* I could compare ... but who knows? */
492 if ((irp_state == irg_callee_info_consistent) ||
493 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
494 set_irp_callee_info_state(s);
497 static INLINE irg_inline_property
498 _get_irg_inline_property(const ir_graph *irg) {
499 return irg->inline_property;
503 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
504 irg->inline_property = s;
507 static INLINE unsigned
508 _get_irg_additional_properties(const ir_graph *irg) {
509 if (irg->additional_properties & mtp_property_inherited)
510 return get_method_additional_properties(get_entity_type(irg->ent));
511 return irg->additional_properties;
515 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
516 /* do not allow to set the mtp_property_inherited flag or
517 * the automatic inheritance of flags will not work */
518 irg->additional_properties = mask & ~mtp_property_inherited;
522 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
523 unsigned prop = irg->additional_properties;
525 if (prop & mtp_property_inherited)
526 prop = get_method_additional_properties(get_entity_type(irg->ent));
527 irg->additional_properties = prop | flag;
531 _set_irg_link(ir_graph *irg, void *thing) {
536 _get_irg_link(const ir_graph *irg) {
540 static INLINE unsigned long
541 _get_irg_visited(const ir_graph *irg) {
545 static INLINE unsigned long
546 _get_irg_block_visited(const ir_graph *irg) {
547 return irg->block_visited;
551 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
552 irg->block_visited = visited;
556 _inc_irg_block_visited(ir_graph *irg) {
557 ++irg->block_visited;
561 _dec_irg_block_visited(ir_graph *irg) {
562 --irg->block_visited;
565 static INLINE unsigned
566 _get_irg_estimated_node_cnt(const ir_graph *irg) {
567 return irg->estimated_node_count;
570 /* Return the floating point model of this graph. */
571 static INLINE unsigned
572 _get_irg_fp_model(const ir_graph *irg) {
573 return irg->fp_model;
577 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
578 * @param irg The graph.
579 * @param irn The node.
580 * @return The index allocated for the node.
582 static INLINE unsigned
583 irg_register_node_idx(ir_graph *irg, ir_node *irn)
585 unsigned idx = irg->last_node_idx++;
586 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
587 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
589 irg->idx_irn_map[idx] = irn;
594 * Kill a node from the irg. BEWARE: this kills
595 * all later created nodes.
598 irg_kill_node(ir_graph *irg, ir_node *n) {
599 unsigned idx = get_irn_idx(n);
600 if (idx + 1 == irg->last_node_idx)
601 --irg->last_node_idx;
602 irg->idx_irn_map[idx] = NULL;
603 obstack_free(irg->obst, n);
607 * Get the node for an index.
608 * @param irg The graph.
609 * @param idx The index you want the node for.
610 * @return The node with that index or NULL, if there is no node with that index.
611 * @note The node you got might be dead.
613 static INLINE ir_node *
614 get_idx_irn(ir_graph *irg, unsigned idx) {
615 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
616 return irg->idx_irn_map[idx];
619 #define get_interprocedural_view() _get_interprocedural_view()
620 #define is_ir_graph(thing) _is_ir_graph(thing)
621 #define get_irg_start_block(irg) _get_irg_start_block(irg)
622 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
623 #define get_irg_start(irg) _get_irg_start(irg)
624 #define set_irg_start(irg, node) _set_irg_start(irg, node)
625 #define get_irg_end_block(irg) _get_irg_end_block(irg)
626 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
627 #define get_irg_end(irg) _get_irg_end(irg)
628 #define set_irg_end(irg, node) _set_irg_end(irg, node)
629 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
630 #define get_irg_end_except(irg) _get_irg_end_except(irg)
631 #define get_irg_frame(irg) _get_irg_frame(irg)
632 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
633 #define get_irg_globals(irg) _get_irg_globals(irg)
634 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
635 #define get_irg_tls(irg) _get_irg_tls(irg)
636 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
637 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
638 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
639 #define get_irg_args(irg) _get_irg_args(irg)
640 #define set_irg_args(irg, node) _set_irg_args(irg, node)
641 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
642 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
643 #define get_irg_bad(irg) _get_irg_bad(irg)
644 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
645 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
646 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
647 #define get_irg_current_block(irg) _get_irg_current_block(irg)
648 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
649 #define get_irg_entity(irg) _get_irg_entity(irg)
650 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
651 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
652 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
653 #define get_irg_obstack(irg) _get_irg_obstack(irg)
654 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
655 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
656 #define get_irg_pinned(irg) _get_irg_pinned(irg)
657 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
658 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
659 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
660 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
661 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
662 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
663 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
664 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
665 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
666 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
667 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
668 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
669 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
670 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
671 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
672 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
673 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
674 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
675 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
676 #define get_irg_link(irg) _get_irg_link(irg)
677 #define get_irg_visited(irg) _get_irg_visited(irg)
678 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
679 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
680 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
681 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
682 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
683 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)
685 # endif /* _IRGRAPH_T_H_ */