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 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
106 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
107 unsigned fp_model; /**< floating point model of the graph. */
109 /* -- Fields for construction -- */
110 #if USE_EXPLICIT_PHI_IN_STACK
111 struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
113 int n_loc; /**< number of local variable in this
114 procedure including procedure parameters. */
115 void **loc_descriptions; /**< storage for local variable descriptions */
117 /* -- Fields for optimizations / analysis information -- */
118 pset *value_table; /**< hash table for global value numbering (cse)
119 for optimizing use in iropt.c */
120 ir_node **outs; /**< Space for the out arrays. */
122 ir_loop *loop; /**< The outermost loop */
123 void *link; /**< A void* field to link any information to
126 ir_graph **callers; /**< For callgraph analysis. */
127 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
128 ir_graph **callees; /**< For callgraph analysis. */
129 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
130 int callgraph_loop_depth; /**< For callgraph analysis */
131 int callgraph_recursion_depth; /**< For callgraph analysis */
132 double method_execution_frequency; /**< For callgraph analysis */
136 /* -- Fields for Walking the graph -- */
137 unsigned long visited; /**< this flag is an identifier for
138 ir walk. it will be incremented
139 every time someone walks through
141 unsigned long block_visited; /**< same as visited, for a complete block */
142 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
143 updated after every walk */
144 irg_edge_info_t edge_info; /**< edge info for automatic outs */
145 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
148 int n_outs; /**< Size wasted for outs */
149 long graph_nr; /**< a unique graph number for each graph to make output
156 * Initializes the graph construction module
158 void firm_init_irgraph(void);
160 /* Internal constructor that does not add to irp_irgs or the like. */
161 ir_graph *new_r_ir_graph (entity *ent, int n_loc);
163 /** Make a rudimentary ir graph for the constant code.
164 Must look like a correct irg, spare everything else. */
165 ir_graph *new_const_code_irg(void);
168 * Set the op_pin_state_pinned state of a graph.
170 * @param irg the IR graph
171 * @param p new pin state
174 set_irg_pinned (ir_graph *irg, op_pin_state p);
176 /** Returns the obstack associated with the graph. */
177 struct obstack *get_irg_obstack(const ir_graph *irg);
180 * Returns true if the node n is allocated on the storage of graph irg.
182 * @param irg the IR graph
183 * @param n the IR node
185 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
187 /*-------------------------------------------------------------------*/
188 /* inline functions for graphs */
189 /*-------------------------------------------------------------------*/
191 extern int firm_interprocedural_view;
194 _get_interprocedural_view(void) {
195 return firm_interprocedural_view;
199 _is_ir_graph(const void *thing) {
200 return (get_kind(thing) == k_ir_graph);
203 /** Returns the start block of a graph. */
204 static INLINE ir_node *
205 _get_irg_start_block(const ir_graph *irg) {
206 return irg->anchors[anchor_start_block];
210 _set_irg_start_block(ir_graph *irg, ir_node *node) {
211 irg->anchors[anchor_start_block] = node;
214 static INLINE ir_node *
215 _get_irg_start(const ir_graph *irg) {
216 return irg->anchors[anchor_start];
220 _set_irg_start(ir_graph *irg, ir_node *node) {
221 irg->anchors[anchor_start] = node;
224 static INLINE ir_node *
225 _get_irg_end_block(const ir_graph *irg) {
226 return irg->anchors[anchor_end_block];
230 _set_irg_end_block(ir_graph *irg, ir_node *node) {
231 irg->anchors[anchor_end_block] = node;
234 static INLINE ir_node *
235 _get_irg_end(const ir_graph *irg) {
236 return irg->anchors[anchor_end];
240 _set_irg_end(ir_graph *irg, ir_node *node) {
241 irg->anchors[anchor_end] = node;
244 static INLINE ir_node *
245 _get_irg_end_reg(const ir_graph *irg) {
246 return irg->anchors[anchor_end_reg];
249 static INLINE ir_node *
250 _get_irg_end_except (const ir_graph *irg) {
251 return irg->anchors[anchor_end_except];
254 static INLINE ir_node *
255 _get_irg_frame(const ir_graph *irg) {
256 return irg->anchors[anchor_frame];
260 _set_irg_frame(ir_graph *irg, ir_node *node) {
261 irg->anchors[anchor_frame] = node;
264 static INLINE ir_node *
265 _get_irg_globals(const ir_graph *irg) {
266 return irg->anchors[anchor_globals];
270 _set_irg_globals(ir_graph *irg, ir_node *node) {
271 irg->anchors[anchor_globals] = node;
274 static INLINE ir_node *
275 _get_irg_tls(const ir_graph *irg) {
276 return irg->anchors[anchor_tls];
280 _set_irg_tls(ir_graph *irg, ir_node *node) {
281 irg->anchors[anchor_tls] = node;
284 static INLINE ir_node *
285 _get_irg_initial_mem(const ir_graph *irg) {
286 return irg->anchors[anchor_initial_mem];
290 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
291 irg->anchors[anchor_initial_mem] = node;
294 static INLINE ir_node *
295 _get_irg_args(const ir_graph *irg) {
296 return irg->anchors[anchor_args];
300 _set_irg_args(ir_graph *irg, ir_node *node) {
301 irg->anchors[anchor_args] = node;
304 static INLINE ir_node *
305 _get_irg_value_param_base(const ir_graph *irg) {
306 return irg->anchors[anchor_value_param_base];
310 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
311 irg->anchors[anchor_value_param_base] = node;
314 static INLINE ir_node **
315 _get_irg_proj_args(const ir_graph *irg) {
316 return irg->proj_args;
320 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
321 irg->proj_args = nodes;
324 static INLINE ir_node *
325 _get_irg_bad(const ir_graph *irg) {
326 return irg->anchors[anchor_bad];
330 _set_irg_bad(ir_graph *irg, ir_node *node) {
331 irg->anchors[anchor_bad] = node;
334 static INLINE ir_node *
335 _get_irg_no_mem(const ir_graph *irg) {
336 return irg->anchors[anchor_no_mem];
340 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
341 irg->anchors[anchor_no_mem] = node;
343 static INLINE ir_node *
344 _get_irg_current_block(const ir_graph *irg) {
345 return irg->current_block;
349 _set_irg_current_block(ir_graph *irg, ir_node *node) {
350 irg->current_block = node;
353 static INLINE entity *
354 _get_irg_entity(const ir_graph *irg) {
355 assert(irg && irg->ent);
360 _set_irg_entity(ir_graph *irg, entity *ent) {
364 static INLINE ir_type *
365 _get_irg_frame_type(ir_graph *irg) {
366 assert(irg && irg->frame_type);
367 return irg->frame_type = skip_tid(irg->frame_type);
371 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
372 assert(is_frame_type(ftp));
373 irg->frame_type = ftp;
376 static INLINE struct obstack *
377 _get_irg_obstack(const ir_graph *irg) {
382 static INLINE irg_phase_state
383 _get_irg_phase_state(const ir_graph *irg) {
384 return irg->phase_state;
388 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
389 irg->phase_state = state;
392 static INLINE op_pin_state
393 _get_irg_pinned(const ir_graph *irg) {
394 return irg->irg_pinned_state;
397 static INLINE irg_outs_state
398 _get_irg_outs_state(const ir_graph *irg) {
399 return irg->outs_state;
403 _set_irg_outs_inconsistent(ir_graph *irg) {
404 if (irg->outs_state == outs_consistent)
405 irg->outs_state = outs_inconsistent;
408 static INLINE irg_extblk_state
409 _get_irg_extblk_state(const ir_graph *irg) {
410 return irg->extblk_state;
414 _set_irg_extblk_inconsistent(ir_graph *irg) {
415 if (irg->extblk_state == extblk_valid)
416 irg->extblk_state = extblk_invalid;
419 static INLINE irg_dom_state
420 _get_irg_dom_state(const ir_graph *irg) {
421 return irg->dom_state;
424 static INLINE irg_dom_state
425 _get_irg_postdom_state(const ir_graph *irg) {
426 return irg->pdom_state;
430 _set_irg_doms_inconsistent(ir_graph *irg) {
431 if (irg->dom_state != dom_none)
432 irg->dom_state = dom_inconsistent;
433 if (irg->pdom_state != dom_none)
434 irg->pdom_state = dom_inconsistent;
437 static INLINE irg_loopinfo_state
438 _get_irg_loopinfo_state(const ir_graph *irg) {
439 return irg->loopinfo_state;
443 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
444 irg->loopinfo_state = s;
448 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
449 irg->loopinfo_state &= ~loopinfo_valid;
453 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
454 irg->irg_pinned_state = p;
457 static INLINE irg_callee_info_state
458 _get_irg_callee_info_state(const ir_graph *irg) {
459 return irg->callee_info_state;
463 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
464 irg_callee_info_state irp_state = get_irp_callee_info_state();
466 irg->callee_info_state = s;
468 /* I could compare ... but who knows? */
469 if ((irp_state == irg_callee_info_consistent) ||
470 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
471 set_irp_callee_info_state(s);
474 static INLINE irg_inline_property
475 _get_irg_inline_property(const ir_graph *irg) {
476 return irg->inline_property;
480 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
481 irg->inline_property = s;
484 static INLINE unsigned
485 _get_irg_additional_properties(const ir_graph *irg) {
486 if (irg->additional_properties & mtp_property_inherited)
487 return get_method_additional_properties(get_entity_type(irg->ent));
488 return irg->additional_properties;
492 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
493 /* do not allow to set the mtp_property_inherited flag or
494 * the automatic inheritance of flags will not work */
495 irg->additional_properties = mask & ~mtp_property_inherited;
499 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
500 unsigned prop = irg->additional_properties;
502 if (prop & mtp_property_inherited)
503 prop = get_method_additional_properties(get_entity_type(irg->ent));
504 irg->additional_properties = prop | flag;
508 _set_irg_link(ir_graph *irg, void *thing) {
513 _get_irg_link(const ir_graph *irg) {
517 static INLINE unsigned long
518 _get_irg_visited(const ir_graph *irg) {
522 static INLINE unsigned long
523 _get_irg_block_visited(const ir_graph *irg) {
524 return irg->block_visited;
528 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
529 irg->block_visited = visited;
533 _inc_irg_block_visited(ir_graph *irg) {
534 ++irg->block_visited;
538 _dec_irg_block_visited(ir_graph *irg) {
539 --irg->block_visited;
542 static INLINE unsigned
543 _get_irg_estimated_node_cnt(const ir_graph *irg) {
544 return irg->estimated_node_count;
547 /* Return the floating point model of this graph. */
548 static INLINE unsigned
549 _get_irg_fp_model(const ir_graph *irg) {
550 return irg->fp_model;
554 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
555 * @param irg The graph.
556 * @param irn The node.
557 * @return The index allocated for the node.
559 static INLINE unsigned
560 irg_register_node_idx(ir_graph *irg, ir_node *irn)
562 unsigned idx = irg->last_node_idx++;
563 if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
564 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
566 irg->idx_irn_map[idx] = irn;
571 * Kill a node from the irg. BEWARE: this kills
572 * all later created nodes.
575 irg_kill_node(ir_graph *irg, ir_node *n) {
576 unsigned idx = get_irn_idx(n);
577 if (idx + 1 == irg->last_node_idx)
578 --irg->last_node_idx;
579 irg->idx_irn_map[idx] = NULL;
580 obstack_free(irg->obst, n);
584 * Get the node for an index.
585 * @param irg The graph.
586 * @param idx The index you want the node for.
587 * @return The node with that index or NULL, if there is no node with that index.
588 * @note The node you got might be dead.
590 static INLINE ir_node *
591 get_idx_irn(ir_graph *irg, unsigned idx) {
592 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
593 return irg->idx_irn_map[idx];
596 #define get_interprocedural_view() _get_interprocedural_view()
597 #define is_ir_graph(thing) _is_ir_graph(thing)
598 #define get_irg_start_block(irg) _get_irg_start_block(irg)
599 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
600 #define get_irg_start(irg) _get_irg_start(irg)
601 #define set_irg_start(irg, node) _set_irg_start(irg, node)
602 #define get_irg_end_block(irg) _get_irg_end_block(irg)
603 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
604 #define get_irg_end(irg) _get_irg_end(irg)
605 #define set_irg_end(irg, node) _set_irg_end(irg, node)
606 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
607 #define get_irg_end_except(irg) _get_irg_end_except(irg)
608 #define get_irg_frame(irg) _get_irg_frame(irg)
609 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
610 #define get_irg_globals(irg) _get_irg_globals(irg)
611 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
612 #define get_irg_tls(irg) _get_irg_tls(irg)
613 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
614 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
615 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
616 #define get_irg_args(irg) _get_irg_args(irg)
617 #define set_irg_args(irg, node) _set_irg_args(irg, node)
618 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
619 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
620 #define get_irg_bad(irg) _get_irg_bad(irg)
621 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
622 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
623 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
624 #define get_irg_current_block(irg) _get_irg_current_block(irg)
625 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
626 #define get_irg_entity(irg) _get_irg_entity(irg)
627 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
628 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
629 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
630 #define get_irg_obstack(irg) _get_irg_obstack(irg)
631 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
632 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
633 #define get_irg_pinned(irg) _get_irg_pinned(irg)
634 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
635 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
636 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
637 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
638 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
639 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
640 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
641 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
642 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
643 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
644 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
645 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
646 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
647 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
648 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
649 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
650 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
651 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
652 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
653 #define get_irg_link(irg) _get_irg_link(irg)
654 #define get_irg_visited(irg) _get_irg_visited(irg)
655 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
656 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
657 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
658 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
659 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
660 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)
662 # endif /* _IRGRAPH_T_H_ */