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 fp_model; /**< floating point model of the graph. */
117 /* -- Fields for construction -- */
118 #if USE_EXPLICIT_PHI_IN_STACK
119 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
121 int n_loc; /**< Number of local variables in this
122 procedure including procedure parameters. */
123 void **loc_descriptions; /**< Storage for local variable descriptions. */
125 /* -- Fields for optimizations / analysis information -- */
126 pset *value_table; /**< Hash table for global value numbering (cse)
127 for optimizing use in iropt.c */
128 ir_node **outs; /**< Space for the out arrays. */
130 ir_loop *loop; /**< The outermost loop for this graph. */
131 void *link; /**< A void* field to link any information to
134 ir_graph **callers; /**< For callgraph analysis. */
135 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
136 ir_graph **callees; /**< For callgraph analysis. */
137 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
138 int callgraph_loop_depth; /**< For callgraph analysis */
139 int callgraph_recursion_depth; /**< For callgraph analysis */
140 double method_execution_frequency; /**< For callgraph analysis */
144 /* -- Fields for Walking the graph -- */
145 unsigned long visited; /**< this flag is an identifier for
146 ir walk. it will be incremented
147 every time someone walks through
149 unsigned long block_visited; /**< same as visited, for a complete block */
150 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
151 updated after every walk */
152 irg_edges_info_t edge_info; /**< edge info for automatic outs */
153 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
156 int n_outs; /**< Size wasted for outs */
157 long graph_nr; /**< a unique graph number for each graph to make output
164 * Initializes the graph construction module
166 void firm_init_irgraph(void);
168 /* Internal constructor that does not add to irp_irgs or the like. */
169 ir_graph *new_r_ir_graph (ir_entity *ent, int n_loc);
171 /** Make a rudimentary ir graph for the constant code.
172 Must look like a correct irg, spare everything else. */
173 ir_graph *new_const_code_irg(void);
176 * Set the op_pin_state_pinned state of a graph.
178 * @param irg the IR graph
179 * @param p new pin state
182 set_irg_pinned (ir_graph *irg, op_pin_state p);
184 /** Returns the obstack associated with the graph. */
185 struct obstack *get_irg_obstack(const ir_graph *irg);
188 * Returns true if the node n is allocated on the storage of graph irg.
190 * @param irg the IR graph
191 * @param n the IR node
193 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
195 /*-------------------------------------------------------------------*/
196 /* inline functions for graphs */
197 /*-------------------------------------------------------------------*/
199 extern int firm_interprocedural_view;
202 _get_interprocedural_view(void) {
203 return firm_interprocedural_view;
207 _is_ir_graph(const void *thing) {
208 return (get_kind(thing) == k_ir_graph);
211 /** Returns the start block of a graph. */
212 static INLINE ir_node *
213 _get_irg_start_block(const ir_graph *irg) {
214 return irg->anchors[anchor_start_block];
218 _set_irg_start_block(ir_graph *irg, ir_node *node) {
219 irg->anchors[anchor_start_block] = node;
222 static INLINE ir_node *
223 _get_irg_start(const ir_graph *irg) {
224 return irg->anchors[anchor_start];
228 _set_irg_start(ir_graph *irg, ir_node *node) {
229 irg->anchors[anchor_start] = node;
232 static INLINE ir_node *
233 _get_irg_end_block(const ir_graph *irg) {
234 return irg->anchors[anchor_end_block];
238 _set_irg_end_block(ir_graph *irg, ir_node *node) {
239 irg->anchors[anchor_end_block] = node;
242 static INLINE ir_node *
243 _get_irg_end(const ir_graph *irg) {
244 return irg->anchors[anchor_end];
248 _set_irg_end(ir_graph *irg, ir_node *node) {
249 irg->anchors[anchor_end] = node;
252 static INLINE ir_node *
253 _get_irg_end_reg(const ir_graph *irg) {
254 return irg->anchors[anchor_end_reg];
257 static INLINE ir_node *
258 _get_irg_end_except (const ir_graph *irg) {
259 return irg->anchors[anchor_end_except];
262 static INLINE ir_node *
263 _get_irg_frame(const ir_graph *irg) {
264 return irg->anchors[anchor_frame];
268 _set_irg_frame(ir_graph *irg, ir_node *node) {
269 irg->anchors[anchor_frame] = node;
272 static INLINE ir_node *
273 _get_irg_globals(const ir_graph *irg) {
274 return irg->anchors[anchor_globals];
278 _set_irg_globals(ir_graph *irg, ir_node *node) {
279 irg->anchors[anchor_globals] = node;
282 static INLINE ir_node *
283 _get_irg_tls(const ir_graph *irg) {
284 return irg->anchors[anchor_tls];
288 _set_irg_tls(ir_graph *irg, ir_node *node) {
289 irg->anchors[anchor_tls] = node;
292 static INLINE ir_node *
293 _get_irg_initial_mem(const ir_graph *irg) {
294 return irg->anchors[anchor_initial_mem];
298 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
299 irg->anchors[anchor_initial_mem] = node;
302 static INLINE ir_node *
303 _get_irg_args(const ir_graph *irg) {
304 return irg->anchors[anchor_args];
308 _set_irg_args(ir_graph *irg, ir_node *node) {
309 irg->anchors[anchor_args] = node;
312 static INLINE ir_node *
313 _get_irg_value_param_base(const ir_graph *irg) {
314 return irg->anchors[anchor_value_param_base];
318 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
319 irg->anchors[anchor_value_param_base] = node;
322 static INLINE ir_node **
323 _get_irg_proj_args(const ir_graph *irg) {
324 return irg->proj_args;
328 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
329 irg->proj_args = nodes;
332 static INLINE ir_node *
333 _get_irg_bad(const ir_graph *irg) {
334 return irg->anchors[anchor_bad];
338 _set_irg_bad(ir_graph *irg, ir_node *node) {
339 irg->anchors[anchor_bad] = node;
342 static INLINE ir_node *
343 _get_irg_no_mem(const ir_graph *irg) {
344 return irg->anchors[anchor_no_mem];
348 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
349 irg->anchors[anchor_no_mem] = node;
351 static INLINE ir_node *
352 _get_irg_current_block(const ir_graph *irg) {
353 return irg->current_block;
357 _set_irg_current_block(ir_graph *irg, ir_node *node) {
358 irg->current_block = node;
361 static INLINE ir_entity *
362 _get_irg_entity(const ir_graph *irg) {
363 assert(irg && irg->ent);
368 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
372 static INLINE ir_type *
373 _get_irg_frame_type(ir_graph *irg) {
374 assert(irg && irg->frame_type);
375 return irg->frame_type = skip_tid(irg->frame_type);
379 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
380 assert(is_frame_type(ftp));
381 irg->frame_type = ftp;
384 static INLINE struct obstack *
385 _get_irg_obstack(const ir_graph *irg) {
390 static INLINE irg_phase_state
391 _get_irg_phase_state(const ir_graph *irg) {
392 return irg->phase_state;
396 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
397 irg->phase_state = state;
400 static INLINE op_pin_state
401 _get_irg_pinned(const ir_graph *irg) {
402 return irg->irg_pinned_state;
405 static INLINE irg_outs_state
406 _get_irg_outs_state(const ir_graph *irg) {
407 return irg->outs_state;
411 _set_irg_outs_inconsistent(ir_graph *irg) {
412 if (irg->outs_state == outs_consistent)
413 irg->outs_state = outs_inconsistent;
416 static INLINE irg_extblk_state
417 _get_irg_extblk_state(const ir_graph *irg) {
418 return irg->extblk_state;
422 _set_irg_extblk_inconsistent(ir_graph *irg) {
423 if (irg->extblk_state == extblk_valid)
424 irg->extblk_state = extblk_invalid;
427 static INLINE irg_dom_state
428 _get_irg_dom_state(const ir_graph *irg) {
429 return irg->dom_state;
432 static INLINE irg_dom_state
433 _get_irg_postdom_state(const ir_graph *irg) {
434 return irg->pdom_state;
438 _set_irg_doms_inconsistent(ir_graph *irg) {
439 if (irg->dom_state != dom_none)
440 irg->dom_state = dom_inconsistent;
441 if (irg->pdom_state != dom_none)
442 irg->pdom_state = dom_inconsistent;
445 static INLINE irg_loopinfo_state
446 _get_irg_loopinfo_state(const ir_graph *irg) {
447 return irg->loopinfo_state;
451 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
452 irg->loopinfo_state = s;
456 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
457 irg->loopinfo_state &= ~loopinfo_valid;
461 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
462 irg->irg_pinned_state = p;
465 static INLINE irg_callee_info_state
466 _get_irg_callee_info_state(const ir_graph *irg) {
467 return irg->callee_info_state;
471 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
472 irg_callee_info_state irp_state = get_irp_callee_info_state();
474 irg->callee_info_state = s;
476 /* I could compare ... but who knows? */
477 if ((irp_state == irg_callee_info_consistent) ||
478 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
479 set_irp_callee_info_state(s);
482 static INLINE irg_inline_property
483 _get_irg_inline_property(const ir_graph *irg) {
484 return irg->inline_property;
488 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
489 irg->inline_property = s;
492 static INLINE unsigned
493 _get_irg_additional_properties(const ir_graph *irg) {
494 if (irg->additional_properties & mtp_property_inherited)
495 return get_method_additional_properties(get_entity_type(irg->ent));
496 return irg->additional_properties;
500 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
501 /* do not allow to set the mtp_property_inherited flag or
502 * the automatic inheritance of flags will not work */
503 irg->additional_properties = mask & ~mtp_property_inherited;
507 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
508 unsigned prop = irg->additional_properties;
510 if (prop & mtp_property_inherited)
511 prop = get_method_additional_properties(get_entity_type(irg->ent));
512 irg->additional_properties = prop | flag;
516 _set_irg_link(ir_graph *irg, void *thing) {
521 _get_irg_link(const ir_graph *irg) {
525 static INLINE unsigned long
526 _get_irg_visited(const ir_graph *irg) {
530 static INLINE unsigned long
531 _get_irg_block_visited(const ir_graph *irg) {
532 return irg->block_visited;
536 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
537 irg->block_visited = visited;
541 _inc_irg_block_visited(ir_graph *irg) {
542 ++irg->block_visited;
546 _dec_irg_block_visited(ir_graph *irg) {
547 --irg->block_visited;
550 static INLINE unsigned
551 _get_irg_estimated_node_cnt(const ir_graph *irg) {
552 return irg->estimated_node_count;
555 /* Return the floating point model of this graph. */
556 static INLINE unsigned
557 _get_irg_fp_model(const ir_graph *irg) {
558 return irg->fp_model;
562 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
563 * @param irg The graph.
564 * @param irn The node.
565 * @return The index allocated for the node.
567 static INLINE unsigned
568 irg_register_node_idx(ir_graph *irg, ir_node *irn)
570 unsigned idx = irg->last_node_idx++;
571 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
572 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
574 irg->idx_irn_map[idx] = irn;
579 * Kill a node from the irg. BEWARE: this kills
580 * all later created nodes.
583 irg_kill_node(ir_graph *irg, ir_node *n) {
584 unsigned idx = get_irn_idx(n);
585 if (idx + 1 == irg->last_node_idx)
586 --irg->last_node_idx;
587 irg->idx_irn_map[idx] = NULL;
588 obstack_free(irg->obst, n);
592 * Get the node for an index.
593 * @param irg The graph.
594 * @param idx The index you want the node for.
595 * @return The node with that index or NULL, if there is no node with that index.
596 * @note The node you got might be dead.
598 static INLINE ir_node *
599 get_idx_irn(ir_graph *irg, unsigned idx) {
600 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
601 return irg->idx_irn_map[idx];
604 #define get_interprocedural_view() _get_interprocedural_view()
605 #define is_ir_graph(thing) _is_ir_graph(thing)
606 #define get_irg_start_block(irg) _get_irg_start_block(irg)
607 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
608 #define get_irg_start(irg) _get_irg_start(irg)
609 #define set_irg_start(irg, node) _set_irg_start(irg, node)
610 #define get_irg_end_block(irg) _get_irg_end_block(irg)
611 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
612 #define get_irg_end(irg) _get_irg_end(irg)
613 #define set_irg_end(irg, node) _set_irg_end(irg, node)
614 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
615 #define get_irg_end_except(irg) _get_irg_end_except(irg)
616 #define get_irg_frame(irg) _get_irg_frame(irg)
617 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
618 #define get_irg_globals(irg) _get_irg_globals(irg)
619 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
620 #define get_irg_tls(irg) _get_irg_tls(irg)
621 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
622 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
623 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
624 #define get_irg_args(irg) _get_irg_args(irg)
625 #define set_irg_args(irg, node) _set_irg_args(irg, node)
626 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
627 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
628 #define get_irg_bad(irg) _get_irg_bad(irg)
629 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
630 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
631 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
632 #define get_irg_current_block(irg) _get_irg_current_block(irg)
633 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
634 #define get_irg_entity(irg) _get_irg_entity(irg)
635 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
636 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
637 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
638 #define get_irg_obstack(irg) _get_irg_obstack(irg)
639 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
640 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
641 #define get_irg_pinned(irg) _get_irg_pinned(irg)
642 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
643 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
644 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
645 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
646 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
647 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
648 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
649 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
650 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
651 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
652 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
653 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
654 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
655 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
656 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
657 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
658 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
659 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
660 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
661 #define get_irg_link(irg) _get_irg_link(irg)
662 #define get_irg_visited(irg) _get_irg_visited(irg)
663 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
664 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
665 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
666 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
667 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
668 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)
670 # endif /* _IRGRAPH_T_H_ */