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
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * ir graph construction.
18 * @author Martin Trapp, Christian Schaefer
25 #include "firm_types.h"
28 #include "firm_common_t.h"
29 #include "irtypeinfo.h"
31 #include "pseudo_irg.h"
35 #include "tr_inheritance.h"
38 #include "execution_frequency.h"
44 #define FRAME_TP_SUFFIX "frame_tp"
47 * Edge info to put into an irg.
49 typedef struct _irg_edge_info_t {
51 unsigned activated : 1;
55 * Index constants for nodes that can be accessed through the graph itself.
58 anchor_start_block = 0, /**< block the start node will belong to */
59 anchor_start, /**< start node of this ir_graph */
60 anchor_end_block, /**< block the end node will belong to */
61 anchor_end, /**< end node of this ir_graph */
62 anchor_end_reg, /**< end node of this ir_graph */
63 anchor_end_except, /**< end node of this ir_graph */
64 anchor_frame, /**< method's frame */
65 anchor_globals, /**< pointer to the data segment containing all
66 globals as well as global procedures. */
67 anchor_tls, /**< pointer to the thread local storage containing all
69 anchor_initial_mem, /**< initial memory of this graph */
70 anchor_args, /**< methods arguments */
71 anchor_value_param_base, /**< method value param base */
72 anchor_bad, /**< bad node of this ir_graph, the one and
74 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
78 /** ir_graph holds all information for a procedure */
80 firm_kind kind; /**< always set to k_ir_graph*/
81 /* -- Basics of the representation -- */
82 entity *ent; /**< The entity of this procedure, i.e.,
83 the type of the procedure and the
84 class it belongs to. */
85 ir_type *frame_type; /**< A class type representing the stack frame.
86 Can include "inner" methods. */
87 ir_node *anchors[anchor_max]; /**< anchor nodes */
88 ir_node **proj_args; /**< projs of the methods arguments */
89 struct obstack *obst; /**< obstack where all of the ir_nodes live */
90 ir_node *current_block; /**< block for newly gen_*()-erated ir_nodes */
91 struct obstack *extbb_obst; /**< obstack for extended basic block info */
93 unsigned last_node_idx; /**< last IR node index for this graph */
95 /* -- Fields for graph properties -- */
96 irg_inline_property inline_property; /**< How to handle inlineing. */
97 unsigned additional_properties; /**< additional graph properties. */
99 /* -- Fields indicating different states of irgraph -- */
100 irg_phase_state phase_state; /**< compiler phase */
101 op_pin_state irg_pinned_state; /**< Flag for status of nodes */
102 irg_outs_state outs_state; /**< Out edges. */
103 irg_dom_state dom_state; /**< Dominator state information */
104 irg_dom_state pdom_state; /**< Post Dominator state information */
105 ir_typeinfo_state typeinfo_state; /**< Validity of type information */
106 irg_callee_info_state callee_info_state; /**< Validity of callee information */
107 irg_loopinfo_state loopinfo_state; /**< state of loop information */
108 exec_freq_state execfreq_state; /**< state of execution frequency information */
109 ir_class_cast_state class_cast_state; /**< kind of cast operations in code. */
110 irg_extblk_info_state extblk_state; /**< state of extended basic block info */
112 /* -- Fields for construction -- */
113 #if USE_EXPLICIT_PHI_IN_STACK
114 struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
116 int n_loc; /**< number of local variable in this
117 procedure including procedure parameters. */
118 void **loc_descriptions; /**< storage for local variable descriptions */
120 /* -- Fields for optimizations / analysis information -- */
121 pset *value_table; /**< hash table for global value numbering (cse)
122 for optimizing use in iropt.c */
123 ir_node **outs; /**< Space for the out arrays. */
125 ir_loop *loop; /**< The outermost loop */
126 void *link; /**< A void* field to link any information to
129 ir_graph **callers; /**< For callgraph analysis. */
130 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
131 ir_graph **callees; /**< For callgraph analysis. */
132 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
133 int callgraph_loop_depth; /**< For callgraph analysis */
134 int callgraph_recursion_depth; /**< For callgraph analysis */
135 double method_execution_frequency; /**< For callgraph analysis */
139 /* -- Fields for Walking the graph -- */
140 unsigned long visited; /**< this flag is an identifier for
141 ir walk. it will be incremented
142 every time someone walks through
144 unsigned long block_visited; /**< same as visited, for a complete block */
145 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
146 updated after every walk */
147 irg_edge_info_t edge_info; /**< edge info for automatic outs */
148 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
151 int n_outs; /**< Size wasted for outs */
152 long graph_nr; /**< a unique graph number for each graph to make output
159 * Initializes the graph construction module
161 void firm_init_irgraph(void);
163 /* Internal constructor that does not add to irp_irgs or the like. */
164 ir_graph *new_r_ir_graph (entity *ent, int n_loc);
166 /** Make a rudimentary ir graph for the constant code.
167 Must look like a correct irg, spare everything else. */
168 ir_graph *new_const_code_irg(void);
171 * Set the op_pin_state_pinned state of a graph.
173 * @param irg the IR graph
174 * @param p new pin state
177 set_irg_pinned (ir_graph *irg, op_pin_state p);
179 /** Returns the obstack associated with the graph. */
180 struct obstack *get_irg_obstack(const ir_graph *irg);
183 * Returns true if the node n is allocated on the storage of graph irg.
185 * @param irg the IR graph
186 * @param n the IR node
188 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
190 /*-------------------------------------------------------------------*/
191 /* inline functions for graphs */
192 /*-------------------------------------------------------------------*/
194 extern int firm_interprocedural_view;
197 _get_interprocedural_view(void) {
198 return firm_interprocedural_view;
202 _is_ir_graph(const void *thing) {
203 return (get_kind(thing) == k_ir_graph);
206 /** Returns the start block of a graph. */
207 static INLINE ir_node *
208 _get_irg_start_block(const ir_graph *irg) {
209 return irg->anchors[anchor_start_block];
213 _set_irg_start_block(ir_graph *irg, ir_node *node) {
214 irg->anchors[anchor_start_block] = node;
217 static INLINE ir_node *
218 _get_irg_start(const ir_graph *irg) {
219 return irg->anchors[anchor_start];
223 _set_irg_start(ir_graph *irg, ir_node *node) {
224 irg->anchors[anchor_start] = node;
227 static INLINE ir_node *
228 _get_irg_end_block(const ir_graph *irg) {
229 return irg->anchors[anchor_end_block];
233 _set_irg_end_block(ir_graph *irg, ir_node *node) {
234 irg->anchors[anchor_end_block] = node;
237 static INLINE ir_node *
238 _get_irg_end(const ir_graph *irg) {
239 return irg->anchors[anchor_end];
243 _set_irg_end(ir_graph *irg, ir_node *node) {
244 irg->anchors[anchor_end] = node;
247 static INLINE ir_node *
248 _get_irg_end_reg(const ir_graph *irg) {
249 return irg->anchors[anchor_end_reg];
252 static INLINE ir_node *
253 _get_irg_end_except (const ir_graph *irg) {
254 return irg->anchors[anchor_end_except];
257 static INLINE ir_node *
258 _get_irg_frame(const ir_graph *irg) {
259 return irg->anchors[anchor_frame];
263 _set_irg_frame(ir_graph *irg, ir_node *node) {
264 irg->anchors[anchor_frame] = node;
267 static INLINE ir_node *
268 _get_irg_globals(const ir_graph *irg) {
269 return irg->anchors[anchor_globals];
273 _set_irg_globals(ir_graph *irg, ir_node *node) {
274 irg->anchors[anchor_globals] = node;
277 static INLINE ir_node *
278 _get_irg_tls(const ir_graph *irg) {
279 return irg->anchors[anchor_tls];
283 _set_irg_tls(ir_graph *irg, ir_node *node) {
284 irg->anchors[anchor_tls] = node;
287 static INLINE ir_node *
288 _get_irg_initial_mem(const ir_graph *irg) {
289 return irg->anchors[anchor_initial_mem];
293 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
294 irg->anchors[anchor_initial_mem] = node;
297 static INLINE ir_node *
298 _get_irg_args(const ir_graph *irg) {
299 return irg->anchors[anchor_args];
303 _set_irg_args(ir_graph *irg, ir_node *node) {
304 irg->anchors[anchor_args] = node;
307 static INLINE ir_node *
308 _get_irg_value_param_base(const ir_graph *irg) {
309 return irg->anchors[anchor_value_param_base];
313 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
314 irg->anchors[anchor_value_param_base] = node;
317 static INLINE ir_node **
318 _get_irg_proj_args(const ir_graph *irg) {
319 return irg->proj_args;
323 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
324 irg->proj_args = nodes;
327 static INLINE ir_node *
328 _get_irg_bad(const ir_graph *irg) {
329 return irg->anchors[anchor_bad];
333 _set_irg_bad(ir_graph *irg, ir_node *node) {
334 irg->anchors[anchor_bad] = node;
337 static INLINE ir_node *
338 _get_irg_no_mem(const ir_graph *irg) {
339 return irg->anchors[anchor_no_mem];
343 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
344 irg->anchors[anchor_no_mem] = node;
346 static INLINE ir_node *
347 _get_irg_current_block(const ir_graph *irg) {
348 return irg->current_block;
352 _set_irg_current_block(ir_graph *irg, ir_node *node) {
353 irg->current_block = node;
356 static INLINE entity *
357 _get_irg_entity(const ir_graph *irg) {
358 assert(irg && irg->ent);
363 _set_irg_entity(ir_graph *irg, entity *ent) {
367 static INLINE ir_type *
368 _get_irg_frame_type(ir_graph *irg) {
369 assert(irg && irg->frame_type);
370 return irg->frame_type = skip_tid(irg->frame_type);
374 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
375 assert(is_frame_type(ftp));
376 irg->frame_type = ftp;
379 static INLINE struct obstack *
380 _get_irg_obstack(const ir_graph *irg) {
385 static INLINE irg_phase_state
386 _get_irg_phase_state(const ir_graph *irg) {
387 return irg->phase_state;
391 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
392 irg->phase_state = state;
395 static INLINE op_pin_state
396 _get_irg_pinned(const ir_graph *irg) {
397 return irg->irg_pinned_state;
400 static INLINE irg_outs_state
401 _get_irg_outs_state(const ir_graph *irg) {
402 return irg->outs_state;
406 _set_irg_outs_inconsistent(ir_graph *irg) {
407 if (irg->outs_state == outs_consistent)
408 irg->outs_state = outs_inconsistent;
411 static INLINE irg_extblk_state
412 _get_irg_extblk_state(const ir_graph *irg) {
413 return irg->extblk_state;
417 _set_irg_extblk_inconsistent(ir_graph *irg) {
418 if (irg->extblk_state == extblk_valid)
419 irg->extblk_state = extblk_invalid;
422 static INLINE irg_dom_state
423 _get_irg_dom_state(const ir_graph *irg) {
424 return irg->dom_state;
427 static INLINE irg_dom_state
428 _get_irg_postdom_state(const ir_graph *irg) {
429 return irg->pdom_state;
433 _set_irg_doms_inconsistent(ir_graph *irg) {
434 if (irg->dom_state != dom_none)
435 irg->dom_state = dom_inconsistent;
436 if (irg->pdom_state != dom_none)
437 irg->pdom_state = dom_inconsistent;
440 static INLINE irg_loopinfo_state
441 _get_irg_loopinfo_state(const ir_graph *irg) {
442 return irg->loopinfo_state;
446 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
447 irg->loopinfo_state = s;
451 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
452 irg->loopinfo_state &= ~loopinfo_valid;
456 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
457 irg->irg_pinned_state = p;
460 static INLINE irg_callee_info_state
461 _get_irg_callee_info_state(const ir_graph *irg) {
462 return irg->callee_info_state;
466 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
467 irg_callee_info_state irp_state = get_irp_callee_info_state();
469 irg->callee_info_state = s;
471 /* I could compare ... but who knows? */
472 if ((irp_state == irg_callee_info_consistent) ||
473 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
474 set_irp_callee_info_state(s);
477 static INLINE irg_inline_property
478 _get_irg_inline_property(const ir_graph *irg) {
479 return irg->inline_property;
483 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
484 irg->inline_property = s;
487 static INLINE unsigned
488 _get_irg_additional_properties(const ir_graph *irg) {
489 if (irg->additional_properties & mtp_property_inherited)
490 return get_method_additional_properties(get_entity_type(irg->ent));
491 return irg->additional_properties;
495 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
496 /* do not allow to set the mtp_property_inherited flag or
497 * the automatic inheritance of flags will not work */
498 irg->additional_properties = mask & ~mtp_property_inherited;
502 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
503 unsigned prop = irg->additional_properties;
505 if (prop & mtp_property_inherited)
506 prop = get_method_additional_properties(get_entity_type(irg->ent));
507 irg->additional_properties = prop | flag;
511 _set_irg_link(ir_graph *irg, void *thing) {
516 _get_irg_link(const ir_graph *irg) {
520 static INLINE unsigned long
521 _get_irg_visited(const ir_graph *irg) {
525 static INLINE unsigned long
526 _get_irg_block_visited(const ir_graph *irg) {
527 return irg->block_visited;
531 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
532 irg->block_visited = visited;
536 _inc_irg_block_visited(ir_graph *irg) {
537 ++irg->block_visited;
541 _dec_irg_block_visited(ir_graph *irg) {
542 --irg->block_visited;
545 static INLINE unsigned
546 _get_irg_estimated_node_cnt(const ir_graph *irg) {
547 return irg->estimated_node_count;
551 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
552 * @param irg The graph.
553 * @param irn The node.
554 * @return The index allocated for the node.
556 static INLINE unsigned
557 irg_register_node_idx(ir_graph *irg, ir_node *irn)
559 unsigned idx = irg->last_node_idx++;
560 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
561 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
563 irg->idx_irn_map[idx] = irn;
568 * Kill a node from the irg. BEWARE: this kills
569 * all later created nodes.
572 irg_kill_node(ir_graph *irg, ir_node *n) {
573 unsigned idx = get_irn_idx(n);
574 if (idx + 1 == irg->last_node_idx)
575 --irg->last_node_idx;
576 irg->idx_irn_map[idx] = NULL;
577 obstack_free(irg->obst, n);
581 * Get the node for an index.
582 * @param irg The graph.
583 * @param idx The index you want the node for.
584 * @return The node with that index or NULL, if there is no node with that index.
585 * @note The node you got might be dead.
587 static INLINE ir_node *
588 get_idx_irn(ir_graph *irg, unsigned idx) {
589 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
590 return irg->idx_irn_map[idx];
593 #define get_interprocedural_view() _get_interprocedural_view()
594 #define is_ir_graph(thing) _is_ir_graph(thing)
595 #define get_irg_start_block(irg) _get_irg_start_block(irg)
596 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
597 #define get_irg_start(irg) _get_irg_start(irg)
598 #define set_irg_start(irg, node) _set_irg_start(irg, node)
599 #define get_irg_end_block(irg) _get_irg_end_block(irg)
600 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
601 #define get_irg_end(irg) _get_irg_end(irg)
602 #define set_irg_end(irg, node) _set_irg_end(irg, node)
603 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
604 #define get_irg_end_except(irg) _get_irg_end_except(irg)
605 #define get_irg_frame(irg) _get_irg_frame(irg)
606 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
607 #define get_irg_globals(irg) _get_irg_globals(irg)
608 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
609 #define get_irg_tls(irg) _get_irg_tls(irg)
610 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
611 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
612 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
613 #define get_irg_args(irg) _get_irg_args(irg)
614 #define set_irg_args(irg, node) _set_irg_args(irg, node)
615 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
616 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
617 #define get_irg_bad(irg) _get_irg_bad(irg)
618 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
619 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
620 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
621 #define get_irg_current_block(irg) _get_irg_current_block(irg)
622 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
623 #define get_irg_entity(irg) _get_irg_entity(irg)
624 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
625 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
626 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
627 #define get_irg_obstack(irg) _get_irg_obstack(irg)
628 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
629 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
630 #define get_irg_pinned(irg) _get_irg_pinned(irg)
631 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
632 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
633 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
634 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
635 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
636 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
637 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
638 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
639 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
640 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
641 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
642 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
643 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
644 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
645 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
646 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
647 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
648 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
649 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
650 #define get_irg_link(irg) _get_irg_link(irg)
651 #define get_irg_visited(irg) _get_irg_visited(irg)
652 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
653 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
654 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
655 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
656 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
658 # endif /* _IRGRAPH_T_H_ */