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-2003 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"
35 #include "execution_frequency.h"
41 /** Prefix that is added to every frame type. */
42 #define FRAME_TP_SUFFIX "frame_tp"
45 * Edge info to put into an irg.
47 typedef struct _irg_edge_info_t {
48 set *edges; /**< a set containing all edges of a graph. */
49 unsigned activated : 1; /**< set if edges are activated for the graph. */
52 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
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 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
109 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
110 exec_freq_state execfreq_state; /**< Execution frequency state. */
111 unsigned fp_model; /**< floating point model of the graph. */
113 /* -- Fields for construction -- */
114 #if USE_EXPLICIT_PHI_IN_STACK
115 struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
117 int n_loc; /**< number of local variable in this
118 procedure including procedure parameters. */
119 void **loc_descriptions; /**< storage for local variable descriptions */
121 /* -- Fields for optimizations / analysis information -- */
122 pset *value_table; /**< hash table for global value numbering (cse)
123 for optimizing use in iropt.c */
124 ir_node **outs; /**< Space for the out arrays. */
126 ir_loop *loop; /**< The outermost loop */
127 void *link; /**< A void* field to link any information to
130 ir_graph **callers; /**< For callgraph analysis. */
131 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
132 ir_graph **callees; /**< For callgraph analysis. */
133 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
134 int callgraph_loop_depth; /**< For callgraph analysis */
135 int callgraph_recursion_depth; /**< For callgraph analysis */
136 double method_execution_frequency; /**< For callgraph analysis */
140 /* -- Fields for Walking the graph -- */
141 unsigned long visited; /**< this flag is an identifier for
142 ir walk. it will be incremented
143 every time someone walks through
145 unsigned long block_visited; /**< same as visited, for a complete block */
146 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
147 updated after every walk */
148 irg_edges_info_t edge_info; /**< edge info for automatic outs */
149 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
152 int n_outs; /**< Size wasted for outs */
153 long graph_nr; /**< a unique graph number for each graph to make output
160 * Initializes the graph construction module
162 void firm_init_irgraph(void);
164 /* Internal constructor that does not add to irp_irgs or the like. */
165 ir_graph *new_r_ir_graph (entity *ent, int n_loc);
167 /** Make a rudimentary ir graph for the constant code.
168 Must look like a correct irg, spare everything else. */
169 ir_graph *new_const_code_irg(void);
172 * Set the op_pin_state_pinned state of a graph.
174 * @param irg the IR graph
175 * @param p new pin state
178 set_irg_pinned (ir_graph *irg, op_pin_state p);
180 /** Returns the obstack associated with the graph. */
181 struct obstack *get_irg_obstack(const ir_graph *irg);
184 * Returns true if the node n is allocated on the storage of graph irg.
186 * @param irg the IR graph
187 * @param n the IR node
189 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
191 /*-------------------------------------------------------------------*/
192 /* inline functions for graphs */
193 /*-------------------------------------------------------------------*/
195 extern int firm_interprocedural_view;
198 _get_interprocedural_view(void) {
199 return firm_interprocedural_view;
203 _is_ir_graph(const void *thing) {
204 return (get_kind(thing) == k_ir_graph);
207 /** Returns the start block of a graph. */
208 static INLINE ir_node *
209 _get_irg_start_block(const ir_graph *irg) {
210 return irg->anchors[anchor_start_block];
214 _set_irg_start_block(ir_graph *irg, ir_node *node) {
215 irg->anchors[anchor_start_block] = node;
218 static INLINE ir_node *
219 _get_irg_start(const ir_graph *irg) {
220 return irg->anchors[anchor_start];
224 _set_irg_start(ir_graph *irg, ir_node *node) {
225 irg->anchors[anchor_start] = node;
228 static INLINE ir_node *
229 _get_irg_end_block(const ir_graph *irg) {
230 return irg->anchors[anchor_end_block];
234 _set_irg_end_block(ir_graph *irg, ir_node *node) {
235 irg->anchors[anchor_end_block] = node;
238 static INLINE ir_node *
239 _get_irg_end(const ir_graph *irg) {
240 return irg->anchors[anchor_end];
244 _set_irg_end(ir_graph *irg, ir_node *node) {
245 irg->anchors[anchor_end] = node;
248 static INLINE ir_node *
249 _get_irg_end_reg(const ir_graph *irg) {
250 return irg->anchors[anchor_end_reg];
253 static INLINE ir_node *
254 _get_irg_end_except (const ir_graph *irg) {
255 return irg->anchors[anchor_end_except];
258 static INLINE ir_node *
259 _get_irg_frame(const ir_graph *irg) {
260 return irg->anchors[anchor_frame];
264 _set_irg_frame(ir_graph *irg, ir_node *node) {
265 irg->anchors[anchor_frame] = node;
268 static INLINE ir_node *
269 _get_irg_globals(const ir_graph *irg) {
270 return irg->anchors[anchor_globals];
274 _set_irg_globals(ir_graph *irg, ir_node *node) {
275 irg->anchors[anchor_globals] = node;
278 static INLINE ir_node *
279 _get_irg_tls(const ir_graph *irg) {
280 return irg->anchors[anchor_tls];
284 _set_irg_tls(ir_graph *irg, ir_node *node) {
285 irg->anchors[anchor_tls] = node;
288 static INLINE ir_node *
289 _get_irg_initial_mem(const ir_graph *irg) {
290 return irg->anchors[anchor_initial_mem];
294 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
295 irg->anchors[anchor_initial_mem] = node;
298 static INLINE ir_node *
299 _get_irg_args(const ir_graph *irg) {
300 return irg->anchors[anchor_args];
304 _set_irg_args(ir_graph *irg, ir_node *node) {
305 irg->anchors[anchor_args] = node;
308 static INLINE ir_node *
309 _get_irg_value_param_base(const ir_graph *irg) {
310 return irg->anchors[anchor_value_param_base];
314 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
315 irg->anchors[anchor_value_param_base] = node;
318 static INLINE ir_node **
319 _get_irg_proj_args(const ir_graph *irg) {
320 return irg->proj_args;
324 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
325 irg->proj_args = nodes;
328 static INLINE ir_node *
329 _get_irg_bad(const ir_graph *irg) {
330 return irg->anchors[anchor_bad];
334 _set_irg_bad(ir_graph *irg, ir_node *node) {
335 irg->anchors[anchor_bad] = node;
338 static INLINE ir_node *
339 _get_irg_no_mem(const ir_graph *irg) {
340 return irg->anchors[anchor_no_mem];
344 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
345 irg->anchors[anchor_no_mem] = node;
347 static INLINE ir_node *
348 _get_irg_current_block(const ir_graph *irg) {
349 return irg->current_block;
353 _set_irg_current_block(ir_graph *irg, ir_node *node) {
354 irg->current_block = node;
357 static INLINE entity *
358 _get_irg_entity(const ir_graph *irg) {
359 assert(irg && irg->ent);
364 _set_irg_entity(ir_graph *irg, entity *ent) {
368 static INLINE ir_type *
369 _get_irg_frame_type(ir_graph *irg) {
370 assert(irg && irg->frame_type);
371 return irg->frame_type = skip_tid(irg->frame_type);
375 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
376 assert(is_frame_type(ftp));
377 irg->frame_type = ftp;
380 static INLINE struct obstack *
381 _get_irg_obstack(const ir_graph *irg) {
386 static INLINE irg_phase_state
387 _get_irg_phase_state(const ir_graph *irg) {
388 return irg->phase_state;
392 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
393 irg->phase_state = state;
396 static INLINE op_pin_state
397 _get_irg_pinned(const ir_graph *irg) {
398 return irg->irg_pinned_state;
401 static INLINE irg_outs_state
402 _get_irg_outs_state(const ir_graph *irg) {
403 return irg->outs_state;
407 _set_irg_outs_inconsistent(ir_graph *irg) {
408 if (irg->outs_state == outs_consistent)
409 irg->outs_state = outs_inconsistent;
412 static INLINE irg_extblk_state
413 _get_irg_extblk_state(const ir_graph *irg) {
414 return irg->extblk_state;
418 _set_irg_extblk_inconsistent(ir_graph *irg) {
419 if (irg->extblk_state == extblk_valid)
420 irg->extblk_state = extblk_invalid;
423 static INLINE irg_dom_state
424 _get_irg_dom_state(const ir_graph *irg) {
425 return irg->dom_state;
428 static INLINE irg_dom_state
429 _get_irg_postdom_state(const ir_graph *irg) {
430 return irg->pdom_state;
434 _set_irg_doms_inconsistent(ir_graph *irg) {
435 if (irg->dom_state != dom_none)
436 irg->dom_state = dom_inconsistent;
437 if (irg->pdom_state != dom_none)
438 irg->pdom_state = dom_inconsistent;
441 static INLINE irg_loopinfo_state
442 _get_irg_loopinfo_state(const ir_graph *irg) {
443 return irg->loopinfo_state;
447 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
448 irg->loopinfo_state = s;
452 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
453 irg->loopinfo_state &= ~loopinfo_valid;
457 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
458 irg->irg_pinned_state = p;
461 static INLINE irg_callee_info_state
462 _get_irg_callee_info_state(const ir_graph *irg) {
463 return irg->callee_info_state;
467 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
468 irg_callee_info_state irp_state = get_irp_callee_info_state();
470 irg->callee_info_state = s;
472 /* I could compare ... but who knows? */
473 if ((irp_state == irg_callee_info_consistent) ||
474 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
475 set_irp_callee_info_state(s);
478 static INLINE irg_inline_property
479 _get_irg_inline_property(const ir_graph *irg) {
480 return irg->inline_property;
484 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
485 irg->inline_property = s;
488 static INLINE unsigned
489 _get_irg_additional_properties(const ir_graph *irg) {
490 if (irg->additional_properties & mtp_property_inherited)
491 return get_method_additional_properties(get_entity_type(irg->ent));
492 return irg->additional_properties;
496 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
497 /* do not allow to set the mtp_property_inherited flag or
498 * the automatic inheritance of flags will not work */
499 irg->additional_properties = mask & ~mtp_property_inherited;
503 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
504 unsigned prop = irg->additional_properties;
506 if (prop & mtp_property_inherited)
507 prop = get_method_additional_properties(get_entity_type(irg->ent));
508 irg->additional_properties = prop | flag;
512 _set_irg_link(ir_graph *irg, void *thing) {
517 _get_irg_link(const ir_graph *irg) {
521 static INLINE unsigned long
522 _get_irg_visited(const ir_graph *irg) {
526 static INLINE unsigned long
527 _get_irg_block_visited(const ir_graph *irg) {
528 return irg->block_visited;
532 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
533 irg->block_visited = visited;
537 _inc_irg_block_visited(ir_graph *irg) {
538 ++irg->block_visited;
542 _dec_irg_block_visited(ir_graph *irg) {
543 --irg->block_visited;
546 static INLINE unsigned
547 _get_irg_estimated_node_cnt(const ir_graph *irg) {
548 return irg->estimated_node_count;
551 /* Return the floating point model of this graph. */
552 static INLINE unsigned
553 _get_irg_fp_model(const ir_graph *irg) {
554 return irg->fp_model;
558 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
559 * @param irg The graph.
560 * @param irn The node.
561 * @return The index allocated for the node.
563 static INLINE unsigned
564 irg_register_node_idx(ir_graph *irg, ir_node *irn)
566 unsigned idx = irg->last_node_idx++;
567 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
568 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
570 irg->idx_irn_map[idx] = irn;
575 * Kill a node from the irg. BEWARE: this kills
576 * all later created nodes.
579 irg_kill_node(ir_graph *irg, ir_node *n) {
580 unsigned idx = get_irn_idx(n);
581 if (idx + 1 == irg->last_node_idx)
582 --irg->last_node_idx;
583 irg->idx_irn_map[idx] = NULL;
584 obstack_free(irg->obst, n);
588 * Get the node for an index.
589 * @param irg The graph.
590 * @param idx The index you want the node for.
591 * @return The node with that index or NULL, if there is no node with that index.
592 * @note The node you got might be dead.
594 static INLINE ir_node *
595 get_idx_irn(ir_graph *irg, unsigned idx) {
596 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
597 return irg->idx_irn_map[idx];
600 #define get_interprocedural_view() _get_interprocedural_view()
601 #define is_ir_graph(thing) _is_ir_graph(thing)
602 #define get_irg_start_block(irg) _get_irg_start_block(irg)
603 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
604 #define get_irg_start(irg) _get_irg_start(irg)
605 #define set_irg_start(irg, node) _set_irg_start(irg, node)
606 #define get_irg_end_block(irg) _get_irg_end_block(irg)
607 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
608 #define get_irg_end(irg) _get_irg_end(irg)
609 #define set_irg_end(irg, node) _set_irg_end(irg, node)
610 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
611 #define get_irg_end_except(irg) _get_irg_end_except(irg)
612 #define get_irg_frame(irg) _get_irg_frame(irg)
613 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
614 #define get_irg_globals(irg) _get_irg_globals(irg)
615 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
616 #define get_irg_tls(irg) _get_irg_tls(irg)
617 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
618 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
619 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
620 #define get_irg_args(irg) _get_irg_args(irg)
621 #define set_irg_args(irg, node) _set_irg_args(irg, node)
622 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
623 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
624 #define get_irg_bad(irg) _get_irg_bad(irg)
625 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
626 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
627 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
628 #define get_irg_current_block(irg) _get_irg_current_block(irg)
629 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
630 #define get_irg_entity(irg) _get_irg_entity(irg)
631 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
632 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
633 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
634 #define get_irg_obstack(irg) _get_irg_obstack(irg)
635 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
636 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
637 #define get_irg_pinned(irg) _get_irg_pinned(irg)
638 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
639 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
640 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
641 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
642 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
643 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
644 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
645 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
646 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
647 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
648 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
649 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
650 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
651 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
652 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
653 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
654 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
655 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
656 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
657 #define get_irg_link(irg) _get_irg_link(irg)
658 #define get_irg_visited(irg) _get_irg_visited(irg)
659 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
660 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
661 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
662 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
663 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
664 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)
666 # endif /* _IRGRAPH_T_H_ */