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
27 #include "firm_common_t.h"
28 #include "irtypeinfo.h"
30 #include "pseudo_irg.h"
39 #define FRAME_TP_SUFFIX "frame_tp"
42 * Edge info to put into an irg.
44 typedef struct _irg_edge_info_t {
46 unsigned activated : 1;
50 /** ir_graph holds all information for a procedure */
52 firm_kind kind; /**< always set to k_ir_graph*/
53 /* -- Basics of the representation -- */
54 struct entity *ent; /**< The entity of this procedure, i.e.,
55 the type of the procedure and the
56 class it belongs to. */
57 struct type *frame_type; /**< A class type representing the stack frame.
58 Can include "inner" methods. */
59 struct ir_node *start_block; /**< block the start node will belong to */
60 struct ir_node *start; /**< start node of this ir_graph */
61 struct ir_node *end_block; /**< block the end node will belong to */
62 struct ir_node *end; /**< end node of this ir_graph */
63 struct ir_node *end_reg; /**< end node of this ir_graph */
64 struct ir_node *end_except; /**< end node of this ir_graph */
65 struct ir_node *cstore; /**< constant store -- no more needed!! */
66 struct ir_node *frame; /**< method's frame */
67 struct ir_node *globals; /**< pointer to the data segment containing all
68 globals as well as global procedures. */
69 struct ir_node *initial_mem; /**< initial memory of this graph */
70 struct ir_node *args; /**< methods arguments */
71 struct ir_node **proj_args; /**< projs off the methods arguments */
72 struct ir_node *bad; /**< bad node of this ir_graph, the one and
74 struct ir_node *no_mem; /**< NoMem node of this ir_graph, the one and
76 /* GL removed: we need unknown with mode for analyses. */
77 /* struct ir_node *unknown;*/ /**< unknown node of this ir_graph */
78 struct obstack *obst; /**< obstack where all of the ir_nodes live */
79 struct ir_node *current_block; /**< block for newly gen_*()-erated
82 /* -- Fields indicating different states of irgraph -- */
83 irg_phase_state phase_state; /**< compiler phase */
84 op_pin_state op_pin_state_pinned; /**< Flag for status of nodes */
85 irg_outs_state outs_state; /**< Out edges. */
86 irg_dom_state dom_state; /**< Dominator information */
87 irg_typeinfo_state typeinfo_state; /**< Validity of type information */
88 irg_callee_info_state callee_info_state; /**< Validity of callee information */
89 irg_inline_property inline_property; /**< How to handle inlineing. */
90 irg_loopinfo_state loopinfo_state; /**< state of loop information */
92 /* -- Fields for construction -- */
93 #if USE_EXPLICIT_PHI_IN_STACK
94 struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
96 int n_loc; /**< number of local variable in this
97 procedure including procedure parameters. */
98 void **loc_descriptions; /**< storage for local variable desriptions */
100 /* -- Fields for optimizations / analysis information -- */
101 pset *value_table; /**< hash table for global value numbering (cse)
102 for optimizing use in iropt.c */
103 struct ir_node **outs; /**< Space for the out arrays. */
106 int n_outs; /* < Size wasted for outs */
107 #endif /* defined DEBUG_libfirm */
108 struct ir_loop *loop; /**< The outermost loop */
109 void *link; /**< A void* field to link any information to
112 ir_graph **callers; /**< For callgraph analysis. */
113 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
114 ir_graph **callees; /**< For callgraph analysis. */
115 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
116 int callgraph_loop_depth; /**< For callgraph analysis */
117 int callgraph_recursion_depth; /**< For callgraph analysis */
118 double method_execution_frequency; /**< For callgraph analysis */
122 /* -- Fields for Walking the graph -- */
123 unsigned long visited; /**< this flag is an identifier for
124 ir walk. it will be incremented
125 every time someone walks through
127 unsigned long block_visited; /**< same as visited, for a complete block */
129 int graph_nr; /**< a unique graph number for each graph to make output
133 #ifdef FIRM_EDGES_INPLACE
134 irg_edge_info_t edge_info;
139 * Initializes the graph construction module
141 void init_irgraph(void);
143 /* Internal constructor that does not add to irp_irgs or the like. */
144 ir_graph *new_r_ir_graph (entity *ent, int n_loc);
146 /** Make a rudimentary ir graph for the constant code.
147 Must look like a correct irg, spare everything else. */
148 ir_graph *new_const_code_irg(void);
151 * Set the op_pin_state_pinned state of a graph.
153 * @param irg the IR graph
154 * @param p new pin state
157 set_irg_pinned (ir_graph *irg, op_pin_state p);
159 /** Returns the obstack associated with the graph. */
160 struct obstack *get_irg_obstack(const ir_graph *irg);
163 * Returns true if the node n is allocated on the storage of graph irg.
165 * @param irg the IR graph
166 * @param n the IR node
168 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
170 /*-------------------------------------------------------------------*/
171 /* inline functions for graphs */
172 /*-------------------------------------------------------------------*/
174 extern int __interprocedural_view;
177 _get_interprocedural_view(void) {
178 return __interprocedural_view;
182 _is_ir_graph(const void *thing) {
183 return (get_kind(thing) == k_ir_graph);
186 /** Returns the start block of a graph. */
187 static INLINE ir_node *
188 _get_irg_start_block(const ir_graph *irg) {
189 return irg->start_block;
193 _set_irg_start_block(ir_graph *irg, ir_node *node) {
194 irg->start_block = node;
197 static INLINE ir_node *
198 _get_irg_start(const ir_graph *irg) {
203 _set_irg_start(ir_graph *irg, ir_node *node) {
207 static INLINE ir_node *
208 _get_irg_end_block(const ir_graph *irg) {
209 return irg->end_block;
213 _set_irg_end_block(ir_graph *irg, ir_node *node) {
214 irg->end_block = node;
217 static INLINE ir_node *
218 _get_irg_end(const ir_graph *irg) {
223 _set_irg_end(ir_graph *irg, ir_node *node) {
227 static INLINE ir_node *
228 _get_irg_end_reg(const ir_graph *irg) {
232 static INLINE ir_node *
233 _get_irg_end_except (const ir_graph *irg) {
234 return irg->end_except;
237 static INLINE ir_node *
238 _get_irg_cstore(const ir_graph *irg) {
243 _set_irg_cstore(ir_graph *irg, ir_node *node) {
247 static INLINE ir_node *
248 _get_irg_frame(const ir_graph *irg) {
253 _set_irg_frame(ir_graph *irg, ir_node *node) {
257 static INLINE ir_node *
258 _get_irg_globals(const ir_graph *irg) {
263 _set_irg_globals(ir_graph *irg, ir_node *node) {
267 static INLINE ir_node *
268 _get_irg_initial_mem(const ir_graph *irg) {
269 return irg->initial_mem;
273 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
274 irg->initial_mem = node;
277 static INLINE ir_node *
278 _get_irg_args(const ir_graph *irg) {
283 _set_irg_args(ir_graph *irg, ir_node *node) {
287 static INLINE ir_node **
288 _get_irg_proj_args(const ir_graph *irg) {
289 return irg->proj_args;
293 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
294 irg->proj_args = nodes;
297 static INLINE ir_node *
298 _get_irg_bad(const ir_graph *irg) {
303 _set_irg_bad(ir_graph *irg, ir_node *node) {
307 static INLINE ir_node *
308 _get_irg_no_mem(const ir_graph *irg) {
313 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
316 static INLINE ir_node *
317 _get_irg_current_block(const ir_graph *irg) {
318 return irg->current_block;
322 _set_irg_current_block(ir_graph *irg, ir_node *node) {
323 irg->current_block = node;
326 static INLINE entity *
327 _get_irg_entity(const ir_graph *irg) {
328 assert(irg && irg->ent);
333 _set_irg_entity(ir_graph *irg, entity *ent) {
338 _get_irg_frame_type(const ir_graph *irg) {
339 assert(irg && irg->frame_type);
340 return irg->frame_type;
344 _set_irg_frame_type(ir_graph *irg, type *ftp) {
345 assert(is_Class_type(ftp));
346 irg->frame_type = ftp;
349 static INLINE struct obstack *
350 _get_irg_obstack(const ir_graph *irg) {
355 static INLINE irg_phase_state
356 _get_irg_phase_state(const ir_graph *irg) {
357 return irg->phase_state;
361 _set_irg_phase_low(ir_graph *irg) {
362 irg->phase_state = phase_low;
365 static INLINE op_pin_state
366 _get_irg_pinned(const ir_graph *irg) {
367 return irg->op_pin_state_pinned;
370 static INLINE irg_outs_state
371 _get_irg_outs_state(const ir_graph *irg) {
372 return irg->outs_state;
376 _set_irg_outs_inconsistent(ir_graph *irg) {
377 irg->outs_state = outs_inconsistent;
380 static INLINE irg_dom_state
381 _get_irg_dom_state(const ir_graph *irg) {
382 return irg->dom_state;
386 _set_irg_dom_inconsistent(ir_graph *irg) {
387 irg->dom_state = dom_inconsistent;
390 static INLINE irg_loopinfo_state
391 _get_irg_loopinfo_state(const ir_graph *irg) {
392 return irg->loopinfo_state;
396 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
397 irg->loopinfo_state = s;
401 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
402 irg->op_pin_state_pinned = p;
405 static INLINE irg_callee_info_state
406 _get_irg_callee_info_state(const ir_graph *irg) {
407 return irg->callee_info_state;
411 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
412 irg_callee_info_state irp_state = get_irp_callee_info_state();
414 irg->callee_info_state = s;
416 /* I could compare ... but who knows? */
417 if ((irp_state == irg_callee_info_consistent) ||
418 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
419 set_irp_callee_info_state(s);
422 static INLINE irg_inline_property
423 _get_irg_inline_property(const ir_graph *irg) {
424 return irg->inline_property;
428 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
429 irg->inline_property = s;
433 _set_irg_link(ir_graph *irg, void *thing) {
438 _get_irg_link(const ir_graph *irg) {
442 static INLINE unsigned long
443 _get_irg_visited(const ir_graph *irg) {
447 static INLINE unsigned long
448 _get_irg_block_visited(const ir_graph *irg) {
449 return irg->block_visited;
453 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
454 irg->block_visited = visited;
458 _inc_irg_block_visited(ir_graph *irg) {
459 ++irg->block_visited;
462 #define get_interprocedural_view() _get_interprocedural_view()
463 #define is_ir_graph(thing) _is_ir_graph(thing)
464 #define get_irg_start_block(irg) _get_irg_start_block(irg)
465 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
466 #define get_irg_start(irg) _get_irg_start(irg)
467 #define set_irg_start(irg, node) _set_irg_start(irg, node)
468 #define get_irg_end_block(irg) _get_irg_end_block(irg)
469 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
470 #define get_irg_end(irg) _get_irg_end(irg)
471 #define set_irg_end(irg, node) _set_irg_end(irg, node)
472 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
473 #define get_irg_end_except(irg) _get_irg_end_except(irg)
474 #define get_irg_cstore(irg) _get_irg_cstore(irg)
475 #define set_irg_cstore(irg, node) _set_irg_cstore(irg, node)
476 #define get_irg_frame(irg) _get_irg_frame(irg)
477 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
478 #define get_irg_globals(irg) _get_irg_globals(irg)
479 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
480 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
481 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
482 #define get_irg_args(irg) _get_irg_args(irg)
483 #define set_irg_args(irg, node) _set_irg_args(irg, node)
484 #define get_irg_bad(irg) _get_irg_bad(irg)
485 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
486 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
487 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
488 #define get_irg_current_block(irg) _get_irg_current_block(irg)
489 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
490 #define get_irg_entity(irg) _get_irg_entity(irg)
491 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
492 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
493 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
494 #define get_irg_obstack(irg) _get_irg_obstack(irg)
495 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
496 #define set_irg_phase_low(irg) _set_irg_phase_low(irg)
497 #define get_irg_pinned(irg) _get_irg_pinned(irg)
498 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
499 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
500 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
501 #define set_irg_dom_inconsistent(irg) _set_irg_dom_inconsistent(irg)
502 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
503 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
504 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
505 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
506 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
507 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
508 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
509 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
510 #define get_irg_link(irg) _get_irg_link(irg)
511 #define get_irg_visited(irg) _get_irg_visited(irg)
512 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
513 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
514 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
516 # endif /* _IRGRAPH_T_H_ */