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"
34 #include "execution_frequency.h"
40 /** Prefix that is added to every frame type. */
41 #define FRAME_TP_SUFFIX "frame_tp"
44 * Edge info to put into an irg.
46 typedef struct _irg_edge_info_t {
47 set *edges; /**< a set containing all edges of a graph. */
48 unsigned activated : 1; /**< set if edges are activated for the graph. */
52 * Index constants for nodes that can be accessed through the graph itself.
55 anchor_start_block = 0, /**< block the start node will belong to */
56 anchor_start, /**< start node of this ir_graph */
57 anchor_end_block, /**< block the end node will belong to */
58 anchor_end, /**< end node of this ir_graph */
59 anchor_end_reg, /**< end node of this ir_graph */
60 anchor_end_except, /**< end node of this ir_graph */
61 anchor_frame, /**< method's frame */
62 anchor_globals, /**< pointer to the data segment containing all
63 globals as well as global procedures. */
64 anchor_tls, /**< pointer to the thread local storage containing all
66 anchor_initial_mem, /**< initial memory of this graph */
67 anchor_args, /**< methods arguments */
68 anchor_value_param_base, /**< method value param base */
69 anchor_bad, /**< bad node of this ir_graph, the one and
71 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
75 /** ir_graph holds all information for a procedure */
77 firm_kind kind; /**< always set to k_ir_graph*/
78 /* -- Basics of the representation -- */
79 entity *ent; /**< The entity of this procedure, i.e.,
80 the type of the procedure and the
81 class it belongs to. */
82 ir_type *frame_type; /**< A class type representing the stack frame.
83 Can include "inner" methods. */
84 ir_node *anchors[anchor_max]; /**< anchor nodes */
85 ir_node **proj_args; /**< projs of the methods arguments */
86 struct obstack *obst; /**< obstack where all of the ir_nodes live */
87 ir_node *current_block; /**< block for newly gen_*()-erated ir_nodes */
88 struct obstack *extbb_obst; /**< obstack for extended basic block info */
90 unsigned last_node_idx; /**< last IR node index for this graph */
92 /* -- Fields for graph properties -- */
93 irg_inline_property inline_property; /**< How to handle inlineing. */
94 unsigned additional_properties; /**< additional graph properties. */
96 /* -- Fields indicating different states of irgraph -- */
97 irg_phase_state phase_state; /**< Compiler phase. */
98 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
99 irg_outs_state outs_state; /**< Out edges. */
100 irg_dom_state dom_state; /**< Dominator state information. */
101 irg_dom_state pdom_state; /**< Post Dominator state information. */
102 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
103 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
104 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
105 exec_freq_state execfreq_state; /**< State of execution frequency information. */
106 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
107 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
108 unsigned fp_model; /**< floating point model of the graph. */
110 /* -- Fields for construction -- */
111 #if USE_EXPLICIT_PHI_IN_STACK
112 struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
114 int n_loc; /**< number of local variable in this
115 procedure including procedure parameters. */
116 void **loc_descriptions; /**< storage for local variable descriptions */
118 /* -- Fields for optimizations / analysis information -- */
119 pset *value_table; /**< hash table for global value numbering (cse)
120 for optimizing use in iropt.c */
121 ir_node **outs; /**< Space for the out arrays. */
123 ir_loop *loop; /**< The outermost loop */
124 void *link; /**< A void* field to link any information to
127 ir_graph **callers; /**< For callgraph analysis. */
128 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
129 ir_graph **callees; /**< For callgraph analysis. */
130 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
131 int callgraph_loop_depth; /**< For callgraph analysis */
132 int callgraph_recursion_depth; /**< For callgraph analysis */
133 double method_execution_frequency; /**< For callgraph analysis */
137 /* -- Fields for Walking the graph -- */
138 unsigned long visited; /**< this flag is an identifier for
139 ir walk. it will be incremented
140 every time someone walks through
142 unsigned long block_visited; /**< same as visited, for a complete block */
143 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
144 updated after every walk */
145 irg_edge_info_t edge_info; /**< edge info for automatic outs */
146 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
149 int n_outs; /**< Size wasted for outs */
150 long graph_nr; /**< a unique graph number for each graph to make output
157 * Initializes the graph construction module
159 void firm_init_irgraph(void);
161 /* Internal constructor that does not add to irp_irgs or the like. */
162 ir_graph *new_r_ir_graph (entity *ent, int n_loc);
164 /** Make a rudimentary ir graph for the constant code.
165 Must look like a correct irg, spare everything else. */
166 ir_graph *new_const_code_irg(void);
169 * Set the op_pin_state_pinned state of a graph.
171 * @param irg the IR graph
172 * @param p new pin state
175 set_irg_pinned (ir_graph *irg, op_pin_state p);
177 /** Returns the obstack associated with the graph. */
178 struct obstack *get_irg_obstack(const ir_graph *irg);
181 * Returns true if the node n is allocated on the storage of graph irg.
183 * @param irg the IR graph
184 * @param n the IR node
186 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
188 /*-------------------------------------------------------------------*/
189 /* inline functions for graphs */
190 /*-------------------------------------------------------------------*/
192 extern int firm_interprocedural_view;
195 _get_interprocedural_view(void) {
196 return firm_interprocedural_view;
200 _is_ir_graph(const void *thing) {
201 return (get_kind(thing) == k_ir_graph);
204 /** Returns the start block of a graph. */
205 static INLINE ir_node *
206 _get_irg_start_block(const ir_graph *irg) {
207 return irg->anchors[anchor_start_block];
211 _set_irg_start_block(ir_graph *irg, ir_node *node) {
212 irg->anchors[anchor_start_block] = node;
215 static INLINE ir_node *
216 _get_irg_start(const ir_graph *irg) {
217 return irg->anchors[anchor_start];
221 _set_irg_start(ir_graph *irg, ir_node *node) {
222 irg->anchors[anchor_start] = node;
225 static INLINE ir_node *
226 _get_irg_end_block(const ir_graph *irg) {
227 return irg->anchors[anchor_end_block];
231 _set_irg_end_block(ir_graph *irg, ir_node *node) {
232 irg->anchors[anchor_end_block] = node;
235 static INLINE ir_node *
236 _get_irg_end(const ir_graph *irg) {
237 return irg->anchors[anchor_end];
241 _set_irg_end(ir_graph *irg, ir_node *node) {
242 irg->anchors[anchor_end] = node;
245 static INLINE ir_node *
246 _get_irg_end_reg(const ir_graph *irg) {
247 return irg->anchors[anchor_end_reg];
250 static INLINE ir_node *
251 _get_irg_end_except (const ir_graph *irg) {
252 return irg->anchors[anchor_end_except];
255 static INLINE ir_node *
256 _get_irg_frame(const ir_graph *irg) {
257 return irg->anchors[anchor_frame];
261 _set_irg_frame(ir_graph *irg, ir_node *node) {
262 irg->anchors[anchor_frame] = node;
265 static INLINE ir_node *
266 _get_irg_globals(const ir_graph *irg) {
267 return irg->anchors[anchor_globals];
271 _set_irg_globals(ir_graph *irg, ir_node *node) {
272 irg->anchors[anchor_globals] = node;
275 static INLINE ir_node *
276 _get_irg_tls(const ir_graph *irg) {
277 return irg->anchors[anchor_tls];
281 _set_irg_tls(ir_graph *irg, ir_node *node) {
282 irg->anchors[anchor_tls] = node;
285 static INLINE ir_node *
286 _get_irg_initial_mem(const ir_graph *irg) {
287 return irg->anchors[anchor_initial_mem];
291 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
292 irg->anchors[anchor_initial_mem] = node;
295 static INLINE ir_node *
296 _get_irg_args(const ir_graph *irg) {
297 return irg->anchors[anchor_args];
301 _set_irg_args(ir_graph *irg, ir_node *node) {
302 irg->anchors[anchor_args] = node;
305 static INLINE ir_node *
306 _get_irg_value_param_base(const ir_graph *irg) {
307 return irg->anchors[anchor_value_param_base];
311 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
312 irg->anchors[anchor_value_param_base] = node;
315 static INLINE ir_node **
316 _get_irg_proj_args(const ir_graph *irg) {
317 return irg->proj_args;
321 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
322 irg->proj_args = nodes;
325 static INLINE ir_node *
326 _get_irg_bad(const ir_graph *irg) {
327 return irg->anchors[anchor_bad];
331 _set_irg_bad(ir_graph *irg, ir_node *node) {
332 irg->anchors[anchor_bad] = node;
335 static INLINE ir_node *
336 _get_irg_no_mem(const ir_graph *irg) {
337 return irg->anchors[anchor_no_mem];
341 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
342 irg->anchors[anchor_no_mem] = node;
344 static INLINE ir_node *
345 _get_irg_current_block(const ir_graph *irg) {
346 return irg->current_block;
350 _set_irg_current_block(ir_graph *irg, ir_node *node) {
351 irg->current_block = node;
354 static INLINE entity *
355 _get_irg_entity(const ir_graph *irg) {
356 assert(irg && irg->ent);
361 _set_irg_entity(ir_graph *irg, entity *ent) {
365 static INLINE ir_type *
366 _get_irg_frame_type(ir_graph *irg) {
367 assert(irg && irg->frame_type);
368 return irg->frame_type = skip_tid(irg->frame_type);
372 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
373 assert(is_frame_type(ftp));
374 irg->frame_type = ftp;
377 static INLINE struct obstack *
378 _get_irg_obstack(const ir_graph *irg) {
383 static INLINE irg_phase_state
384 _get_irg_phase_state(const ir_graph *irg) {
385 return irg->phase_state;
389 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
390 irg->phase_state = state;
393 static INLINE op_pin_state
394 _get_irg_pinned(const ir_graph *irg) {
395 return irg->irg_pinned_state;
398 static INLINE irg_outs_state
399 _get_irg_outs_state(const ir_graph *irg) {
400 return irg->outs_state;
404 _set_irg_outs_inconsistent(ir_graph *irg) {
405 if (irg->outs_state == outs_consistent)
406 irg->outs_state = outs_inconsistent;
409 static INLINE irg_extblk_state
410 _get_irg_extblk_state(const ir_graph *irg) {
411 return irg->extblk_state;
415 _set_irg_extblk_inconsistent(ir_graph *irg) {
416 if (irg->extblk_state == extblk_valid)
417 irg->extblk_state = extblk_invalid;
420 static INLINE irg_dom_state
421 _get_irg_dom_state(const ir_graph *irg) {
422 return irg->dom_state;
425 static INLINE irg_dom_state
426 _get_irg_postdom_state(const ir_graph *irg) {
427 return irg->pdom_state;
431 _set_irg_doms_inconsistent(ir_graph *irg) {
432 if (irg->dom_state != dom_none)
433 irg->dom_state = dom_inconsistent;
434 if (irg->pdom_state != dom_none)
435 irg->pdom_state = dom_inconsistent;
438 static INLINE irg_loopinfo_state
439 _get_irg_loopinfo_state(const ir_graph *irg) {
440 return irg->loopinfo_state;
444 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
445 irg->loopinfo_state = s;
449 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
450 irg->loopinfo_state &= ~loopinfo_valid;
454 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
455 irg->irg_pinned_state = p;
458 static INLINE irg_callee_info_state
459 _get_irg_callee_info_state(const ir_graph *irg) {
460 return irg->callee_info_state;
464 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
465 irg_callee_info_state irp_state = get_irp_callee_info_state();
467 irg->callee_info_state = s;
469 /* I could compare ... but who knows? */
470 if ((irp_state == irg_callee_info_consistent) ||
471 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
472 set_irp_callee_info_state(s);
475 static INLINE irg_inline_property
476 _get_irg_inline_property(const ir_graph *irg) {
477 return irg->inline_property;
481 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
482 irg->inline_property = s;
485 static INLINE unsigned
486 _get_irg_additional_properties(const ir_graph *irg) {
487 if (irg->additional_properties & mtp_property_inherited)
488 return get_method_additional_properties(get_entity_type(irg->ent));
489 return irg->additional_properties;
493 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
494 /* do not allow to set the mtp_property_inherited flag or
495 * the automatic inheritance of flags will not work */
496 irg->additional_properties = mask & ~mtp_property_inherited;
500 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
501 unsigned prop = irg->additional_properties;
503 if (prop & mtp_property_inherited)
504 prop = get_method_additional_properties(get_entity_type(irg->ent));
505 irg->additional_properties = prop | flag;
509 _set_irg_link(ir_graph *irg, void *thing) {
514 _get_irg_link(const ir_graph *irg) {
518 static INLINE unsigned long
519 _get_irg_visited(const ir_graph *irg) {
523 static INLINE unsigned long
524 _get_irg_block_visited(const ir_graph *irg) {
525 return irg->block_visited;
529 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
530 irg->block_visited = visited;
534 _inc_irg_block_visited(ir_graph *irg) {
535 ++irg->block_visited;
539 _dec_irg_block_visited(ir_graph *irg) {
540 --irg->block_visited;
543 static INLINE unsigned
544 _get_irg_estimated_node_cnt(const ir_graph *irg) {
545 return irg->estimated_node_count;
548 /* Return the floating point model of this graph. */
549 static INLINE unsigned
550 _get_irg_fp_model(const ir_graph *irg) {
551 return irg->fp_model;
555 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
556 * @param irg The graph.
557 * @param irn The node.
558 * @return The index allocated for the node.
560 static INLINE unsigned
561 irg_register_node_idx(ir_graph *irg, ir_node *irn)
563 unsigned idx = irg->last_node_idx++;
564 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
565 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
567 irg->idx_irn_map[idx] = irn;
572 * Kill a node from the irg. BEWARE: this kills
573 * all later created nodes.
576 irg_kill_node(ir_graph *irg, ir_node *n) {
577 unsigned idx = get_irn_idx(n);
578 if (idx + 1 == irg->last_node_idx)
579 --irg->last_node_idx;
580 irg->idx_irn_map[idx] = NULL;
581 obstack_free(irg->obst, n);
585 * Get the node for an index.
586 * @param irg The graph.
587 * @param idx The index you want the node for.
588 * @return The node with that index or NULL, if there is no node with that index.
589 * @note The node you got might be dead.
591 static INLINE ir_node *
592 get_idx_irn(ir_graph *irg, unsigned idx) {
593 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
594 return irg->idx_irn_map[idx];
597 #define get_interprocedural_view() _get_interprocedural_view()
598 #define is_ir_graph(thing) _is_ir_graph(thing)
599 #define get_irg_start_block(irg) _get_irg_start_block(irg)
600 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
601 #define get_irg_start(irg) _get_irg_start(irg)
602 #define set_irg_start(irg, node) _set_irg_start(irg, node)
603 #define get_irg_end_block(irg) _get_irg_end_block(irg)
604 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
605 #define get_irg_end(irg) _get_irg_end(irg)
606 #define set_irg_end(irg, node) _set_irg_end(irg, node)
607 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
608 #define get_irg_end_except(irg) _get_irg_end_except(irg)
609 #define get_irg_frame(irg) _get_irg_frame(irg)
610 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
611 #define get_irg_globals(irg) _get_irg_globals(irg)
612 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
613 #define get_irg_tls(irg) _get_irg_tls(irg)
614 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
615 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
616 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
617 #define get_irg_args(irg) _get_irg_args(irg)
618 #define set_irg_args(irg, node) _set_irg_args(irg, node)
619 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
620 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
621 #define get_irg_bad(irg) _get_irg_bad(irg)
622 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
623 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
624 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
625 #define get_irg_current_block(irg) _get_irg_current_block(irg)
626 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
627 #define get_irg_entity(irg) _get_irg_entity(irg)
628 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
629 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
630 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
631 #define get_irg_obstack(irg) _get_irg_obstack(irg)
632 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
633 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
634 #define get_irg_pinned(irg) _get_irg_pinned(irg)
635 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
636 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
637 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
638 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
639 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
640 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
641 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
642 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
643 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
644 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
645 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
646 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
647 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
648 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
649 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
650 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
651 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
652 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
653 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
654 #define get_irg_link(irg) _get_irg_link(irg)
655 #define get_irg_visited(irg) _get_irg_visited(irg)
656 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
657 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
658 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
659 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
660 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
661 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)
663 # endif /* _IRGRAPH_T_H_ */