2 * Copyright (C) 1995-2007 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 * File name: ir/ir/irgraph.c
23 * Purpose: Entry point to the representation of procedure code -- internal header.
24 * Author: Martin Trapp, Christian Schaefer
25 * Modified by: Goetz Lindenmaier, Michael Beck
28 * Copyright: (c) 1998-2007 Universität Karlsruhe
34 * IR graph construction.
39 #include "firm_types.h"
42 #include "firm_common_t.h"
43 #include "irtypeinfo.h"
45 #include "pseudo_irg.h"
49 #include "tr_inheritance.h"
50 #include "iredgekinds.h"
54 #include "execution_frequency.h"
60 /** Prefix that is added to every frame type. */
61 #define FRAME_TP_SUFFIX "frame_tp"
64 * Edge info to put into an irg.
66 typedef struct _irg_edge_info_t {
67 set *edges; /**< a set containing all edges of a graph. */
68 unsigned activated : 1; /**< set if edges are activated for the graph. */
71 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
74 * Index constants for nodes that can be accessed through the graph itself.
77 anchor_start_block = 0, /**< block the start node will belong to */
78 anchor_start, /**< start node of this ir_graph */
79 anchor_end_block, /**< block the end node will belong to */
80 anchor_end, /**< end node of this ir_graph */
81 anchor_end_reg, /**< end node of this ir_graph */
82 anchor_end_except, /**< end node of this ir_graph */
83 anchor_frame, /**< method's frame */
84 anchor_globals, /**< pointer to the data segment containing all
85 globals as well as global procedures. */
86 anchor_tls, /**< pointer to the thread local storage containing all
88 anchor_initial_mem, /**< initial memory of this graph */
89 anchor_args, /**< methods arguments */
90 anchor_value_param_base, /**< method value param base */
91 anchor_bad, /**< bad node of this ir_graph, the one and
93 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
97 /** A callgraph entry for callees. */
98 typedef struct cg_callee_entry {
99 ir_graph *irg; /**< The called irg. */
100 ir_node **call_list; /**< The list of all calls to the irg. */
101 int max_depth; /**< Maximum depth of all Call nodes to irg. */
105 * An ir_graph holds all information for a procedure.
108 firm_kind kind; /**< Always set to k_ir_graph. */
109 /* -- Basics of the representation -- */
110 ir_entity *ent; /**< The entity of this procedure, i.e.,
111 the type of the procedure and the
112 class it belongs to. */
113 ir_type *frame_type; /**< A class type representing the stack frame.
114 Can include "inner" methods. */
115 ir_node *anchors[anchor_max]; /**< List of anchor nodes. */
116 ir_node **proj_args; /**< Projs of the methods arguments. */
117 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
118 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
119 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
121 unsigned last_node_idx; /**< The last IR node index for this graph. */
123 /* -- Fields for graph properties -- */
124 irg_inline_property inline_property; /**< How to handle inlineing. */
125 unsigned additional_properties; /**< Additional graph properties. */
127 /* -- Fields indicating different states of irgraph -- */
128 irg_phase_state phase_state; /**< Compiler phase. */
129 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
130 irg_outs_state outs_state; /**< Out edges. */
131 irg_dom_state dom_state; /**< Dominator state information. */
132 irg_dom_state pdom_state; /**< Post Dominator state information. */
133 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
134 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
135 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
136 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
137 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
138 exec_freq_state execfreq_state; /**< Execution frequency state. */
139 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
140 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
141 unsigned fp_model; /**< floating point model of the graph. */
143 /* -- Fields for construction -- */
144 #if USE_EXPLICIT_PHI_IN_STACK
145 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
147 int n_loc; /**< Number of local variables in this
148 procedure including procedure parameters. */
149 void **loc_descriptions; /**< Storage for local variable descriptions. */
151 /* -- Fields for optimizations / analysis information -- */
152 pset *value_table; /**< Hash table for global value numbering (cse)
153 for optimizing use in iropt.c */
154 ir_node **outs; /**< Space for the out arrays. */
156 ir_loop *loop; /**< The outermost loop for this graph. */
157 void *link; /**< A void* field to link any information to
160 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
161 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
162 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
163 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
164 int callgraph_loop_depth; /**< For callgraph analysis */
165 int callgraph_recursion_depth; /**< For callgraph analysis */
166 double method_execution_frequency; /**< For callgraph analysis */
168 ir_loop *l; /**< For callgraph analysis. */
170 /* -- Fields for Walking the graph -- */
171 unsigned long visited; /**< this flag is an identifier for
172 ir walk. it will be incremented
173 every time someone walks through
175 unsigned long block_visited; /**< same as visited, for a complete block */
178 unsigned using_visited : 1; /**< set to 1 if we are currently using the visited flag */
179 unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */
180 unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */
183 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
184 updated after every walk */
185 irg_edges_info_t edge_info; /**< edge info for automatic outs */
186 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
189 int n_outs; /**< Size wasted for outs */
190 long graph_nr; /**< a unique graph number for each graph to make output
197 * Initializes the graph construction module
199 void firm_init_irgraph(void);
201 /* Internal constructor that does not add to irp_irgs or the like. */
202 ir_graph *new_r_ir_graph (ir_entity *ent, int n_loc);
204 /** Make a rudimentary ir graph for the constant code.
205 Must look like a correct irg, spare everything else. */
206 ir_graph *new_const_code_irg(void);
209 * Set the op_pin_state_pinned state of a graph.
211 * @param irg the IR graph
212 * @param p new pin state
215 set_irg_pinned (ir_graph *irg, op_pin_state p);
217 /** Returns the obstack associated with the graph. */
218 struct obstack *get_irg_obstack(const ir_graph *irg);
221 * Returns true if the node n is allocated on the storage of graph irg.
223 * @param irg the IR graph
224 * @param n the IR node
226 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
228 /*-------------------------------------------------------------------*/
229 /* inline functions for graphs */
230 /*-------------------------------------------------------------------*/
232 extern int firm_interprocedural_view;
235 _get_interprocedural_view(void) {
236 return firm_interprocedural_view;
240 _is_ir_graph(const void *thing) {
241 return (get_kind(thing) == k_ir_graph);
244 /** Returns the start block of a graph. */
245 static INLINE ir_node *
246 _get_irg_start_block(const ir_graph *irg) {
247 return irg->anchors[anchor_start_block];
251 _set_irg_start_block(ir_graph *irg, ir_node *node) {
252 irg->anchors[anchor_start_block] = node;
255 static INLINE ir_node *
256 _get_irg_start(const ir_graph *irg) {
257 return irg->anchors[anchor_start];
261 _set_irg_start(ir_graph *irg, ir_node *node) {
262 irg->anchors[anchor_start] = node;
265 static INLINE ir_node *
266 _get_irg_end_block(const ir_graph *irg) {
267 return irg->anchors[anchor_end_block];
271 _set_irg_end_block(ir_graph *irg, ir_node *node) {
272 irg->anchors[anchor_end_block] = node;
275 static INLINE ir_node *
276 _get_irg_end(const ir_graph *irg) {
277 return irg->anchors[anchor_end];
281 _set_irg_end(ir_graph *irg, ir_node *node) {
282 irg->anchors[anchor_end] = node;
285 static INLINE ir_node *
286 _get_irg_end_reg(const ir_graph *irg) {
287 return irg->anchors[anchor_end_reg];
290 static INLINE ir_node *
291 _get_irg_end_except (const ir_graph *irg) {
292 return irg->anchors[anchor_end_except];
295 static INLINE ir_node *
296 _get_irg_frame(const ir_graph *irg) {
297 return irg->anchors[anchor_frame];
301 _set_irg_frame(ir_graph *irg, ir_node *node) {
302 irg->anchors[anchor_frame] = node;
305 static INLINE ir_node *
306 _get_irg_globals(const ir_graph *irg) {
307 return irg->anchors[anchor_globals];
311 _set_irg_globals(ir_graph *irg, ir_node *node) {
312 irg->anchors[anchor_globals] = node;
315 static INLINE ir_node *
316 _get_irg_tls(const ir_graph *irg) {
317 return irg->anchors[anchor_tls];
321 _set_irg_tls(ir_graph *irg, ir_node *node) {
322 irg->anchors[anchor_tls] = node;
325 static INLINE ir_node *
326 _get_irg_initial_mem(const ir_graph *irg) {
327 return irg->anchors[anchor_initial_mem];
331 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
332 irg->anchors[anchor_initial_mem] = node;
335 static INLINE ir_node *
336 _get_irg_args(const ir_graph *irg) {
337 return irg->anchors[anchor_args];
341 _set_irg_args(ir_graph *irg, ir_node *node) {
342 irg->anchors[anchor_args] = node;
345 static INLINE ir_node *
346 _get_irg_value_param_base(const ir_graph *irg) {
347 return irg->anchors[anchor_value_param_base];
351 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
352 irg->anchors[anchor_value_param_base] = node;
355 static INLINE ir_node **
356 _get_irg_proj_args(const ir_graph *irg) {
357 return irg->proj_args;
361 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
362 irg->proj_args = nodes;
365 static INLINE ir_node *
366 _get_irg_bad(const ir_graph *irg) {
367 return irg->anchors[anchor_bad];
371 _set_irg_bad(ir_graph *irg, ir_node *node) {
372 irg->anchors[anchor_bad] = node;
375 static INLINE ir_node *
376 _get_irg_no_mem(const ir_graph *irg) {
377 return irg->anchors[anchor_no_mem];
381 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
382 irg->anchors[anchor_no_mem] = node;
384 static INLINE ir_node *
385 _get_irg_current_block(const ir_graph *irg) {
386 return irg->current_block;
390 _set_irg_current_block(ir_graph *irg, ir_node *node) {
391 irg->current_block = node;
394 static INLINE ir_entity *
395 _get_irg_entity(const ir_graph *irg) {
396 assert(irg && irg->ent);
401 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
405 static INLINE ir_type *
406 _get_irg_frame_type(ir_graph *irg) {
407 assert(irg && irg->frame_type);
408 return irg->frame_type = skip_tid(irg->frame_type);
412 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
413 assert(is_frame_type(ftp));
414 irg->frame_type = ftp;
417 static INLINE struct obstack *
418 _get_irg_obstack(const ir_graph *irg) {
423 static INLINE irg_phase_state
424 _get_irg_phase_state(const ir_graph *irg) {
425 return irg->phase_state;
429 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
430 irg->phase_state = state;
433 static INLINE op_pin_state
434 _get_irg_pinned(const ir_graph *irg) {
435 return irg->irg_pinned_state;
438 static INLINE irg_outs_state
439 _get_irg_outs_state(const ir_graph *irg) {
440 return irg->outs_state;
444 _set_irg_outs_inconsistent(ir_graph *irg) {
445 if (irg->outs_state == outs_consistent)
446 irg->outs_state = outs_inconsistent;
449 static INLINE irg_extblk_state
450 _get_irg_extblk_state(const ir_graph *irg) {
451 return irg->extblk_state;
455 _set_irg_extblk_inconsistent(ir_graph *irg) {
456 if (irg->extblk_state == extblk_valid)
457 irg->extblk_state = extblk_invalid;
460 static INLINE irg_dom_state
461 _get_irg_dom_state(const ir_graph *irg) {
462 return irg->dom_state;
465 static INLINE irg_dom_state
466 _get_irg_postdom_state(const ir_graph *irg) {
467 return irg->pdom_state;
471 _set_irg_doms_inconsistent(ir_graph *irg) {
472 if (irg->dom_state != dom_none)
473 irg->dom_state = dom_inconsistent;
474 if (irg->pdom_state != dom_none)
475 irg->pdom_state = dom_inconsistent;
478 static INLINE irg_loopinfo_state
479 _get_irg_loopinfo_state(const ir_graph *irg) {
480 return irg->loopinfo_state;
484 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
485 irg->loopinfo_state = s;
489 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
490 irg->loopinfo_state &= ~loopinfo_valid;
494 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
495 irg->irg_pinned_state = p;
498 static INLINE irg_callee_info_state
499 _get_irg_callee_info_state(const ir_graph *irg) {
500 return irg->callee_info_state;
504 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
505 irg_callee_info_state irp_state = get_irp_callee_info_state();
507 irg->callee_info_state = s;
509 /* I could compare ... but who knows? */
510 if ((irp_state == irg_callee_info_consistent) ||
511 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
512 set_irp_callee_info_state(s);
515 static INLINE irg_inline_property
516 _get_irg_inline_property(const ir_graph *irg) {
517 return irg->inline_property;
521 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
522 irg->inline_property = s;
525 static INLINE unsigned
526 _get_irg_additional_properties(const ir_graph *irg) {
527 if (irg->additional_properties & mtp_property_inherited)
528 return get_method_additional_properties(get_entity_type(irg->ent));
529 return irg->additional_properties;
533 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
534 /* do not allow to set the mtp_property_inherited flag or
535 * the automatic inheritance of flags will not work */
536 irg->additional_properties = mask & ~mtp_property_inherited;
540 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
541 unsigned prop = irg->additional_properties;
543 if (prop & mtp_property_inherited)
544 prop = get_method_additional_properties(get_entity_type(irg->ent));
545 irg->additional_properties = prop | flag;
549 _set_irg_link(ir_graph *irg, void *thing) {
554 _get_irg_link(const ir_graph *irg) {
558 static INLINE unsigned long
559 _get_irg_visited(const ir_graph *irg) {
563 static INLINE unsigned long
564 _get_irg_block_visited(const ir_graph *irg) {
565 return irg->block_visited;
569 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
570 irg->block_visited = visited;
574 _inc_irg_block_visited(ir_graph *irg) {
575 ++irg->block_visited;
579 _dec_irg_block_visited(ir_graph *irg) {
580 --irg->block_visited;
583 static INLINE unsigned
584 _get_irg_estimated_node_cnt(const ir_graph *irg) {
585 return irg->estimated_node_count;
588 /* Return the floating point model of this graph. */
589 static INLINE unsigned
590 _get_irg_fp_model(const ir_graph *irg) {
591 return irg->fp_model;
595 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
596 * @param irg The graph.
597 * @param irn The node.
598 * @return The index allocated for the node.
600 static INLINE unsigned
601 irg_register_node_idx(ir_graph *irg, ir_node *irn)
603 unsigned idx = irg->last_node_idx++;
604 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
605 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
607 irg->idx_irn_map[idx] = irn;
612 * Kill a node from the irg. BEWARE: this kills
613 * all later created nodes.
616 irg_kill_node(ir_graph *irg, ir_node *n) {
617 unsigned idx = get_irn_idx(n);
618 if (idx + 1 == irg->last_node_idx)
619 --irg->last_node_idx;
620 irg->idx_irn_map[idx] = NULL;
621 obstack_free(irg->obst, n);
625 * Get the node for an index.
626 * @param irg The graph.
627 * @param idx The index you want the node for.
628 * @return The node with that index or NULL, if there is no node with that index.
629 * @note The node you got might be dead.
631 static INLINE ir_node *
632 get_idx_irn(ir_graph *irg, unsigned idx) {
633 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
634 return irg->idx_irn_map[idx];
637 #define get_interprocedural_view() _get_interprocedural_view()
638 #define is_ir_graph(thing) _is_ir_graph(thing)
639 #define get_irg_start_block(irg) _get_irg_start_block(irg)
640 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
641 #define get_irg_start(irg) _get_irg_start(irg)
642 #define set_irg_start(irg, node) _set_irg_start(irg, node)
643 #define get_irg_end_block(irg) _get_irg_end_block(irg)
644 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
645 #define get_irg_end(irg) _get_irg_end(irg)
646 #define set_irg_end(irg, node) _set_irg_end(irg, node)
647 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
648 #define get_irg_end_except(irg) _get_irg_end_except(irg)
649 #define get_irg_frame(irg) _get_irg_frame(irg)
650 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
651 #define get_irg_globals(irg) _get_irg_globals(irg)
652 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
653 #define get_irg_tls(irg) _get_irg_tls(irg)
654 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
655 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
656 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
657 #define get_irg_args(irg) _get_irg_args(irg)
658 #define set_irg_args(irg, node) _set_irg_args(irg, node)
659 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
660 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
661 #define get_irg_bad(irg) _get_irg_bad(irg)
662 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
663 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
664 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
665 #define get_irg_current_block(irg) _get_irg_current_block(irg)
666 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
667 #define get_irg_entity(irg) _get_irg_entity(irg)
668 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
669 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
670 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
671 #define get_irg_obstack(irg) _get_irg_obstack(irg)
672 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
673 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
674 #define get_irg_pinned(irg) _get_irg_pinned(irg)
675 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
676 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
677 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
678 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
679 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
680 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
681 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
682 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
683 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
684 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
685 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
686 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
687 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
688 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
689 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
690 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
691 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
692 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
693 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
694 #define get_irg_link(irg) _get_irg_link(irg)
695 #define get_irg_visited(irg) _get_irg_visited(irg)
696 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
697 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
698 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
699 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
700 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
701 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)
703 # endif /* _IRGRAPH_T_H_ */