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 */
80 * An ir_graph holds all information for a procedure.
83 firm_kind kind; /**< Always set to k_ir_graph. */
84 /* -- Basics of the representation -- */
85 ir_entity *ent; /**< The entity of this procedure, i.e.,
86 the type of the procedure and the
87 class it belongs to. */
88 ir_type *frame_type; /**< A class type representing the stack frame.
89 Can include "inner" methods. */
90 ir_node *anchors[anchor_max]; /**< List of anchor nodes. */
91 ir_node **proj_args; /**< Projs of the methods arguments. */
92 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
93 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
94 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
96 unsigned last_node_idx; /**< The last IR node index for this graph. */
98 /* -- Fields for graph properties -- */
99 irg_inline_property inline_property; /**< How to handle inlineing. */
100 unsigned additional_properties; /**< Additional graph properties. */
102 /* -- Fields indicating different states of irgraph -- */
103 irg_phase_state phase_state; /**< Compiler phase. */
104 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
105 irg_outs_state outs_state; /**< Out edges. */
106 irg_dom_state dom_state; /**< Dominator state information. */
107 irg_dom_state pdom_state; /**< Post Dominator state information. */
108 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
109 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
110 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
111 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
112 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
113 exec_freq_state execfreq_state; /**< Execution frequency state. */
114 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
115 unsigned mem_disamgig_opt; /**< Options for the memory disambiguator. */
116 unsigned fp_model; /**< floating point model of the graph. */
118 /* -- Fields for construction -- */
119 #if USE_EXPLICIT_PHI_IN_STACK
120 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
122 int n_loc; /**< Number of local variables in this
123 procedure including procedure parameters. */
124 void **loc_descriptions; /**< Storage for local variable descriptions. */
126 /* -- Fields for optimizations / analysis information -- */
127 pset *value_table; /**< Hash table for global value numbering (cse)
128 for optimizing use in iropt.c */
129 ir_node **outs; /**< Space for the out arrays. */
131 ir_loop *loop; /**< The outermost loop for this graph. */
132 void *link; /**< A void* field to link any information to
135 ir_graph **callers; /**< For callgraph analysis. */
136 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
137 ir_graph **callees; /**< For callgraph analysis. */
138 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
139 int callgraph_loop_depth; /**< For callgraph analysis */
140 int callgraph_recursion_depth; /**< For callgraph analysis */
141 double method_execution_frequency; /**< For callgraph analysis */
145 /* -- Fields for Walking the graph -- */
146 unsigned long visited; /**< this flag is an identifier for
147 ir walk. it will be incremented
148 every time someone walks through
150 unsigned long block_visited; /**< same as visited, for a complete block */
151 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
152 updated after every walk */
153 irg_edges_info_t edge_info; /**< edge info for automatic outs */
154 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
157 int n_outs; /**< Size wasted for outs */
158 long graph_nr; /**< a unique graph number for each graph to make output
165 * Initializes the graph construction module
167 void firm_init_irgraph(void);
169 /* Internal constructor that does not add to irp_irgs or the like. */
170 ir_graph *new_r_ir_graph (ir_entity *ent, int n_loc);
172 /** Make a rudimentary ir graph for the constant code.
173 Must look like a correct irg, spare everything else. */
174 ir_graph *new_const_code_irg(void);
177 * Set the op_pin_state_pinned state of a graph.
179 * @param irg the IR graph
180 * @param p new pin state
183 set_irg_pinned (ir_graph *irg, op_pin_state p);
185 /** Returns the obstack associated with the graph. */
186 struct obstack *get_irg_obstack(const ir_graph *irg);
189 * Returns true if the node n is allocated on the storage of graph irg.
191 * @param irg the IR graph
192 * @param n the IR node
194 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
196 /*-------------------------------------------------------------------*/
197 /* inline functions for graphs */
198 /*-------------------------------------------------------------------*/
200 extern int firm_interprocedural_view;
203 _get_interprocedural_view(void) {
204 return firm_interprocedural_view;
208 _is_ir_graph(const void *thing) {
209 return (get_kind(thing) == k_ir_graph);
212 /** Returns the start block of a graph. */
213 static INLINE ir_node *
214 _get_irg_start_block(const ir_graph *irg) {
215 return irg->anchors[anchor_start_block];
219 _set_irg_start_block(ir_graph *irg, ir_node *node) {
220 irg->anchors[anchor_start_block] = node;
223 static INLINE ir_node *
224 _get_irg_start(const ir_graph *irg) {
225 return irg->anchors[anchor_start];
229 _set_irg_start(ir_graph *irg, ir_node *node) {
230 irg->anchors[anchor_start] = node;
233 static INLINE ir_node *
234 _get_irg_end_block(const ir_graph *irg) {
235 return irg->anchors[anchor_end_block];
239 _set_irg_end_block(ir_graph *irg, ir_node *node) {
240 irg->anchors[anchor_end_block] = node;
243 static INLINE ir_node *
244 _get_irg_end(const ir_graph *irg) {
245 return irg->anchors[anchor_end];
249 _set_irg_end(ir_graph *irg, ir_node *node) {
250 irg->anchors[anchor_end] = node;
253 static INLINE ir_node *
254 _get_irg_end_reg(const ir_graph *irg) {
255 return irg->anchors[anchor_end_reg];
258 static INLINE ir_node *
259 _get_irg_end_except (const ir_graph *irg) {
260 return irg->anchors[anchor_end_except];
263 static INLINE ir_node *
264 _get_irg_frame(const ir_graph *irg) {
265 return irg->anchors[anchor_frame];
269 _set_irg_frame(ir_graph *irg, ir_node *node) {
270 irg->anchors[anchor_frame] = node;
273 static INLINE ir_node *
274 _get_irg_globals(const ir_graph *irg) {
275 return irg->anchors[anchor_globals];
279 _set_irg_globals(ir_graph *irg, ir_node *node) {
280 irg->anchors[anchor_globals] = node;
283 static INLINE ir_node *
284 _get_irg_tls(const ir_graph *irg) {
285 return irg->anchors[anchor_tls];
289 _set_irg_tls(ir_graph *irg, ir_node *node) {
290 irg->anchors[anchor_tls] = node;
293 static INLINE ir_node *
294 _get_irg_initial_mem(const ir_graph *irg) {
295 return irg->anchors[anchor_initial_mem];
299 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
300 irg->anchors[anchor_initial_mem] = node;
303 static INLINE ir_node *
304 _get_irg_args(const ir_graph *irg) {
305 return irg->anchors[anchor_args];
309 _set_irg_args(ir_graph *irg, ir_node *node) {
310 irg->anchors[anchor_args] = node;
313 static INLINE ir_node *
314 _get_irg_value_param_base(const ir_graph *irg) {
315 return irg->anchors[anchor_value_param_base];
319 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
320 irg->anchors[anchor_value_param_base] = node;
323 static INLINE ir_node **
324 _get_irg_proj_args(const ir_graph *irg) {
325 return irg->proj_args;
329 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
330 irg->proj_args = nodes;
333 static INLINE ir_node *
334 _get_irg_bad(const ir_graph *irg) {
335 return irg->anchors[anchor_bad];
339 _set_irg_bad(ir_graph *irg, ir_node *node) {
340 irg->anchors[anchor_bad] = node;
343 static INLINE ir_node *
344 _get_irg_no_mem(const ir_graph *irg) {
345 return irg->anchors[anchor_no_mem];
349 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
350 irg->anchors[anchor_no_mem] = node;
352 static INLINE ir_node *
353 _get_irg_current_block(const ir_graph *irg) {
354 return irg->current_block;
358 _set_irg_current_block(ir_graph *irg, ir_node *node) {
359 irg->current_block = node;
362 static INLINE ir_entity *
363 _get_irg_entity(const ir_graph *irg) {
364 assert(irg && irg->ent);
369 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
373 static INLINE ir_type *
374 _get_irg_frame_type(ir_graph *irg) {
375 assert(irg && irg->frame_type);
376 return irg->frame_type = skip_tid(irg->frame_type);
380 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
381 assert(is_frame_type(ftp));
382 irg->frame_type = ftp;
385 static INLINE struct obstack *
386 _get_irg_obstack(const ir_graph *irg) {
391 static INLINE irg_phase_state
392 _get_irg_phase_state(const ir_graph *irg) {
393 return irg->phase_state;
397 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
398 irg->phase_state = state;
401 static INLINE op_pin_state
402 _get_irg_pinned(const ir_graph *irg) {
403 return irg->irg_pinned_state;
406 static INLINE irg_outs_state
407 _get_irg_outs_state(const ir_graph *irg) {
408 return irg->outs_state;
412 _set_irg_outs_inconsistent(ir_graph *irg) {
413 if (irg->outs_state == outs_consistent)
414 irg->outs_state = outs_inconsistent;
417 static INLINE irg_extblk_state
418 _get_irg_extblk_state(const ir_graph *irg) {
419 return irg->extblk_state;
423 _set_irg_extblk_inconsistent(ir_graph *irg) {
424 if (irg->extblk_state == extblk_valid)
425 irg->extblk_state = extblk_invalid;
428 static INLINE irg_dom_state
429 _get_irg_dom_state(const ir_graph *irg) {
430 return irg->dom_state;
433 static INLINE irg_dom_state
434 _get_irg_postdom_state(const ir_graph *irg) {
435 return irg->pdom_state;
439 _set_irg_doms_inconsistent(ir_graph *irg) {
440 if (irg->dom_state != dom_none)
441 irg->dom_state = dom_inconsistent;
442 if (irg->pdom_state != dom_none)
443 irg->pdom_state = dom_inconsistent;
446 static INLINE irg_loopinfo_state
447 _get_irg_loopinfo_state(const ir_graph *irg) {
448 return irg->loopinfo_state;
452 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
453 irg->loopinfo_state = s;
457 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
458 irg->loopinfo_state &= ~loopinfo_valid;
462 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
463 irg->irg_pinned_state = p;
466 static INLINE irg_callee_info_state
467 _get_irg_callee_info_state(const ir_graph *irg) {
468 return irg->callee_info_state;
472 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
473 irg_callee_info_state irp_state = get_irp_callee_info_state();
475 irg->callee_info_state = s;
477 /* I could compare ... but who knows? */
478 if ((irp_state == irg_callee_info_consistent) ||
479 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
480 set_irp_callee_info_state(s);
483 static INLINE irg_inline_property
484 _get_irg_inline_property(const ir_graph *irg) {
485 return irg->inline_property;
489 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
490 irg->inline_property = s;
493 static INLINE unsigned
494 _get_irg_additional_properties(const ir_graph *irg) {
495 if (irg->additional_properties & mtp_property_inherited)
496 return get_method_additional_properties(get_entity_type(irg->ent));
497 return irg->additional_properties;
501 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
502 /* do not allow to set the mtp_property_inherited flag or
503 * the automatic inheritance of flags will not work */
504 irg->additional_properties = mask & ~mtp_property_inherited;
508 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
509 unsigned prop = irg->additional_properties;
511 if (prop & mtp_property_inherited)
512 prop = get_method_additional_properties(get_entity_type(irg->ent));
513 irg->additional_properties = prop | flag;
517 _set_irg_link(ir_graph *irg, void *thing) {
522 _get_irg_link(const ir_graph *irg) {
526 static INLINE unsigned long
527 _get_irg_visited(const ir_graph *irg) {
531 static INLINE unsigned long
532 _get_irg_block_visited(const ir_graph *irg) {
533 return irg->block_visited;
537 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
538 irg->block_visited = visited;
542 _inc_irg_block_visited(ir_graph *irg) {
543 ++irg->block_visited;
547 _dec_irg_block_visited(ir_graph *irg) {
548 --irg->block_visited;
551 static INLINE unsigned
552 _get_irg_estimated_node_cnt(const ir_graph *irg) {
553 return irg->estimated_node_count;
556 /* Return the floating point model of this graph. */
557 static INLINE unsigned
558 _get_irg_fp_model(const ir_graph *irg) {
559 return irg->fp_model;
563 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
564 * @param irg The graph.
565 * @param irn The node.
566 * @return The index allocated for the node.
568 static INLINE unsigned
569 irg_register_node_idx(ir_graph *irg, ir_node *irn)
571 unsigned idx = irg->last_node_idx++;
572 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
573 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
575 irg->idx_irn_map[idx] = irn;
580 * Kill a node from the irg. BEWARE: this kills
581 * all later created nodes.
584 irg_kill_node(ir_graph *irg, ir_node *n) {
585 unsigned idx = get_irn_idx(n);
586 if (idx + 1 == irg->last_node_idx)
587 --irg->last_node_idx;
588 irg->idx_irn_map[idx] = NULL;
589 obstack_free(irg->obst, n);
593 * Get the node for an index.
594 * @param irg The graph.
595 * @param idx The index you want the node for.
596 * @return The node with that index or NULL, if there is no node with that index.
597 * @note The node you got might be dead.
599 static INLINE ir_node *
600 get_idx_irn(ir_graph *irg, unsigned idx) {
601 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
602 return irg->idx_irn_map[idx];
605 #define get_interprocedural_view() _get_interprocedural_view()
606 #define is_ir_graph(thing) _is_ir_graph(thing)
607 #define get_irg_start_block(irg) _get_irg_start_block(irg)
608 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
609 #define get_irg_start(irg) _get_irg_start(irg)
610 #define set_irg_start(irg, node) _set_irg_start(irg, node)
611 #define get_irg_end_block(irg) _get_irg_end_block(irg)
612 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
613 #define get_irg_end(irg) _get_irg_end(irg)
614 #define set_irg_end(irg, node) _set_irg_end(irg, node)
615 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
616 #define get_irg_end_except(irg) _get_irg_end_except(irg)
617 #define get_irg_frame(irg) _get_irg_frame(irg)
618 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
619 #define get_irg_globals(irg) _get_irg_globals(irg)
620 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
621 #define get_irg_tls(irg) _get_irg_tls(irg)
622 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
623 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
624 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
625 #define get_irg_args(irg) _get_irg_args(irg)
626 #define set_irg_args(irg, node) _set_irg_args(irg, node)
627 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
628 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
629 #define get_irg_bad(irg) _get_irg_bad(irg)
630 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
631 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
632 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
633 #define get_irg_current_block(irg) _get_irg_current_block(irg)
634 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
635 #define get_irg_entity(irg) _get_irg_entity(irg)
636 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
637 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
638 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
639 #define get_irg_obstack(irg) _get_irg_obstack(irg)
640 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
641 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
642 #define get_irg_pinned(irg) _get_irg_pinned(irg)
643 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
644 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
645 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
646 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
647 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
648 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
649 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
650 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
651 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
652 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
653 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
654 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
655 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
656 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
657 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
658 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
659 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
660 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
661 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
662 #define get_irg_link(irg) _get_irg_link(irg)
663 #define get_irg_visited(irg) _get_irg_visited(irg)
664 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
665 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
666 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
667 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
668 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
669 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)
671 # endif /* _IRGRAPH_T_H_ */