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
22 # ifndef _IRGRAPH_T_H_
23 # define _IRGRAPH_T_H_
27 # include "firm_common_t.h"
28 # include "irtypeinfo.h"
30 #define FRAME_TP_SUFFIX "frame_tp"
32 /** ir_graph holds all information for a procedure */
34 firm_kind kind; /**< always set to k_ir_graph*/
35 /* -- Basics of the representation -- */
36 struct entity *ent; /**< The entity of this procedure, i.e.,
37 the type of the procedure and the
38 class it belongs to. */
39 struct type *frame_type; /**< A class type representing the stack frame.
40 Can include "inner" methods. */
41 struct ir_node *start_block; /**< block the start node will belong to */
42 struct ir_node *start; /**< start node of this ir_graph */
43 struct ir_node *end_block; /**< block the end node will belong to */
44 struct ir_node *end; /**< end node of this ir_graph */
45 struct ir_node *end_reg; /**< end node of this ir_graph */
46 struct ir_node *end_except; /**< end node of this ir_graph */
47 struct ir_node *cstore; /**< constant store -- no more needed!! */
48 struct ir_node *frame; /**< method's frame */
49 struct ir_node *globals; /**< pointer to the data segment containing all
50 globals as well as global procedures. */
51 struct ir_node *args; /**< methods arguments */
52 struct ir_node *bad; /**< bad node of this ir_graph, the one and
54 /* GL removed: we need unknown with mode for analyses. */
55 /* struct ir_node *unknown;*/ /**< unknown node of this ir_graph */
56 struct obstack *obst; /**< obstack where all of the ir_nodes live */
57 struct ir_node *current_block; /**< block for newly gen_*()-erated
60 /* -- Fields indicating different states of irgraph -- */
61 irg_phase_state phase_state; /**< compiler phase */
62 op_pinned pinned; /**< Flag for status of nodes */
63 irg_outs_state outs_state; /**< Out edges. */
64 irg_dom_state dom_state; /**< Dominator information */
65 irg_typeinfo_state typeinfo_state; /**< Validity of type information */
66 irg_callee_info_state callee_info_state; /**< Validity of callee information */
67 irg_inline_property inline_property; /**< How to handle inlineing. */
68 irg_loopinfo_state loopinfo_state; /**< state of loop information */
70 /* -- Fields for construction -- */
71 #if USE_EXPLICIT_PHI_IN_STACK
72 struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
74 int n_loc; /**< number of local variable in this
75 procedure including procedure parameters. */
77 /* -- Fields for optimizations / analysis information -- */
78 pset *value_table; /**< hash table for global value numbering (cse)
79 for optimizing use in iropt.c */
80 struct ir_node **outs; /**< Space for the out arrays. */
81 int n_outs; /* < Size wasted for outs */
82 struct ir_loop *loop; /**< The outermost loop */
83 void *link; /**< A void* field to link any information to
86 /* -- Fields for Walking the graph -- */
87 unsigned long visited; /**< this flag is an identifier for
88 ir walk. it will be incremented
89 every time someone walks through
91 unsigned long block_visited; /**< same as visited, for a complete block */
93 int graph_nr; /**< a unique graph number for each graph to make output
98 void init_irgraph(void);
100 /** Make a rudimentary ir graph for the constant code.
101 Must look like a correct irg, spare everything else. */
102 ir_graph *new_const_code_irg(void);
105 * Set the pinned state of a graph.
111 set_irg_pinned (ir_graph *irg, op_pinned p);
113 /** Returns the obstack associated with the graph. */
114 struct obstack *get_irg_obstack(ir_graph *irg);
117 * Returns true if the node n is allocated on the storage of graph irg.
119 * @param irg the IR graph
120 * @param n the IR node
122 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
124 /*-------------------------------------------------------------------*/
125 /* inline functions for graphs */
126 /*-------------------------------------------------------------------*/
128 /** Returns the start block of a graph. */
129 static INLINE ir_node *
130 __get_irg_start_block(ir_graph *irg)
132 return irg->start_block;
136 __set_irg_start_block(ir_graph *irg, ir_node *node)
138 irg->start_block = node;
141 static INLINE ir_node *
142 __get_irg_start(ir_graph *irg)
148 __set_irg_start(ir_graph *irg, ir_node *node)
153 static INLINE ir_node *
154 __get_irg_end_block(ir_graph *irg)
156 return irg->end_block;
160 __set_irg_end_block(ir_graph *irg, ir_node *node)
162 irg->end_block = node;
165 static INLINE ir_node *
166 __get_irg_end(ir_graph *irg)
172 __set_irg_end(ir_graph *irg, ir_node *node)
177 static INLINE ir_node *
178 __get_irg_end_reg(ir_graph *irg) {
182 static INLINE ir_node *
183 __get_irg_end_except (ir_graph *irg) {
184 return irg->end_except;
187 static INLINE ir_node *
188 __get_irg_cstore(ir_graph *irg)
194 __set_irg_cstore(ir_graph *irg, ir_node *node)
199 static INLINE ir_node *
200 __get_irg_frame(ir_graph *irg)
206 __set_irg_frame(ir_graph *irg, ir_node *node)
211 static INLINE ir_node *
212 __get_irg_globals(ir_graph *irg)
218 __set_irg_globals(ir_graph *irg, ir_node *node)
223 static INLINE ir_node *
224 __get_irg_args(ir_graph *irg)
230 __set_irg_args(ir_graph *irg, ir_node *node)
235 static INLINE ir_node *
236 __get_irg_bad(ir_graph *irg)
242 __set_irg_bad(ir_graph *irg, ir_node *node)
247 static INLINE ir_node *
248 __get_irg_current_block(ir_graph *irg)
250 return irg->current_block;
254 __set_irg_current_block(ir_graph *irg, ir_node *node)
256 irg->current_block = node;
259 static INLINE entity *
260 __get_irg_ent(ir_graph *irg)
262 assert(irg && irg->ent);
267 __set_irg_ent(ir_graph *irg, entity *ent)
273 __get_irg_frame_type(ir_graph *irg)
275 assert(irg && irg->frame_type);
276 return irg->frame_type;
280 __set_irg_frame_type(ir_graph *irg, type *ftp)
282 assert(is_class_type(ftp));
283 irg->frame_type = ftp;
286 static INLINE struct obstack *
287 __get_irg_obstack(ir_graph *irg) {
293 __set_irg_link(ir_graph *irg, void *thing) {
298 __get_irg_link(ir_graph *irg) {
302 static INLINE unsigned long
303 __get_irg_visited(ir_graph *irg)
308 static INLINE unsigned long
309 __get_irg_block_visited(ir_graph *irg)
311 return irg->block_visited;
315 __set_irg_block_visited(ir_graph *irg, unsigned long visited)
317 irg->block_visited = visited;
321 __inc_irg_block_visited(ir_graph *irg)
323 ++irg->block_visited;
326 #define get_irg_start_block(irg) __get_irg_start_block(irg)
327 #define set_irg_start_block(irg, node) __set_irg_start_block(irg, node)
328 #define get_irg_start(irg) __get_irg_start(irg)
329 #define set_irg_start(irg, node) __set_irg_start(irg, node)
330 #define get_irg_end_block(irg) __get_irg_end_block(irg)
331 #define set_irg_end_block(irg, node) __set_irg_end_block(irg, node)
332 #define get_irg_end(irg) __get_irg_end(irg)
333 #define set_irg_end(irg, node) __set_irg_end(irg, node)
334 #define get_irg_end_reg(irg) __get_irg_end_reg(irg)
335 #define get_irg_end_except(irg) __get_irg_end_except(irg)
336 #define get_irg_cstore(irg) __get_irg_cstore(irg)
337 #define set_irg_cstore(irg, node) __set_irg_cstore(irg, node)
338 #define get_irg_frame(irg) __get_irg_frame(irg)
339 #define set_irg_frame(irg, node) __set_irg_frame(irg, node)
340 #define get_irg_globals(irg) __get_irg_globals(irg)
341 #define set_irg_globals(irg, node) __set_irg_globals(irg, node)
342 #define get_irg_args(irg) __get_irg_args(irg)
343 #define set_irg_args(irg, node) __set_irg_args(irg, node)
344 #define get_irg_bad(irg) __get_irg_bad(irg)
345 #define set_irg_bad(irg, node) __set_irg_bad(irg, node)
346 #define get_irg_current_block(irg) __get_irg_current_block(irg)
347 #define set_irg_current_block(irg, node) __set_irg_current_block(irg, node)
348 #define get_irg_ent(irg) __get_irg_ent(irg)
349 #define set_irg_ent(irg, ent) __set_irg_ent(irg, ent)
350 #define get_irg_frame_type(irg) __get_irg_frame_type(irg)
351 #define set_irg_frame_type(irg, ftp) __set_irg_frame_type(irg, ftp)
352 #define get_irg_obstack(irg) __get_irg_obstack(irg)
353 #define set_irg_link(irg, thing) __set_irg_link(irg, thing)
354 #define get_irg_link(irg) __get_irg_link(irg)
355 #define get_irg_visited(irg) __get_irg_visited(irg)
356 #define get_irg_block_visited(irg) __get_irg_block_visited(irg)
357 #define set_irg_block_visited(irg, v) __set_irg_block_visited(irg, v)
358 #define inc_irg_block_visited(irg) __inc_irg_block_visited(irg)
360 # endif /* _IRGRAPH_T_H_ */