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. */
83 int n_outs; /* < Size wasted for outs */
84 #endif /* defined DEBUG_libfirm */
85 struct ir_loop *loop; /**< The outermost loop */
86 void *link; /**< A void* field to link any information to
89 /* -- Fields for Walking the graph -- */
90 unsigned long visited; /**< this flag is an identifier for
91 ir walk. it will be incremented
92 every time someone walks through
94 unsigned long block_visited; /**< same as visited, for a complete block */
96 int graph_nr; /**< a unique graph number for each graph to make output
101 void init_irgraph(void);
103 /** Make a rudimentary ir graph for the constant code.
104 Must look like a correct irg, spare everything else. */
105 ir_graph *new_const_code_irg(void);
108 * Set the pinned state of a graph.
114 set_irg_pinned (ir_graph *irg, op_pinned p);
116 /** Returns the obstack associated with the graph. */
117 struct obstack *get_irg_obstack(ir_graph *irg);
120 * Returns true if the node n is allocated on the storage of graph irg.
122 * @param irg the IR graph
123 * @param n the IR node
125 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
127 /*-------------------------------------------------------------------*/
128 /* inline functions for graphs */
129 /*-------------------------------------------------------------------*/
131 /** Returns the start block of a graph. */
132 static INLINE ir_node *
133 __get_irg_start_block(ir_graph *irg)
135 return irg->start_block;
139 __set_irg_start_block(ir_graph *irg, ir_node *node)
141 irg->start_block = node;
144 static INLINE ir_node *
145 __get_irg_start(ir_graph *irg)
151 __set_irg_start(ir_graph *irg, ir_node *node)
156 static INLINE ir_node *
157 __get_irg_end_block(ir_graph *irg)
159 return irg->end_block;
163 __set_irg_end_block(ir_graph *irg, ir_node *node)
165 irg->end_block = node;
168 static INLINE ir_node *
169 __get_irg_end(ir_graph *irg)
175 __set_irg_end(ir_graph *irg, ir_node *node)
180 static INLINE ir_node *
181 __get_irg_end_reg(ir_graph *irg) {
185 static INLINE ir_node *
186 __get_irg_end_except (ir_graph *irg) {
187 return irg->end_except;
190 static INLINE ir_node *
191 __get_irg_cstore(ir_graph *irg)
197 __set_irg_cstore(ir_graph *irg, ir_node *node)
202 static INLINE ir_node *
203 __get_irg_frame(ir_graph *irg)
209 __set_irg_frame(ir_graph *irg, ir_node *node)
214 static INLINE ir_node *
215 __get_irg_globals(ir_graph *irg)
221 __set_irg_globals(ir_graph *irg, ir_node *node)
226 static INLINE ir_node *
227 __get_irg_args(ir_graph *irg)
233 __set_irg_args(ir_graph *irg, ir_node *node)
238 static INLINE ir_node *
239 __get_irg_bad(ir_graph *irg)
245 __set_irg_bad(ir_graph *irg, ir_node *node)
250 static INLINE ir_node *
251 __get_irg_current_block(ir_graph *irg)
253 return irg->current_block;
257 __set_irg_current_block(ir_graph *irg, ir_node *node)
259 irg->current_block = node;
262 static INLINE entity *
263 __get_irg_ent(ir_graph *irg)
265 assert(irg && irg->ent);
270 __set_irg_ent(ir_graph *irg, entity *ent)
276 __get_irg_frame_type(ir_graph *irg)
278 assert(irg && irg->frame_type);
279 return irg->frame_type;
283 __set_irg_frame_type(ir_graph *irg, type *ftp)
285 assert(is_class_type(ftp));
286 irg->frame_type = ftp;
289 static INLINE struct obstack *
290 __get_irg_obstack(ir_graph *irg) {
296 __set_irg_link(ir_graph *irg, void *thing) {
301 __get_irg_link(ir_graph *irg) {
305 static INLINE unsigned long
306 __get_irg_visited(ir_graph *irg)
311 static INLINE unsigned long
312 __get_irg_block_visited(ir_graph *irg)
314 return irg->block_visited;
318 __set_irg_block_visited(ir_graph *irg, unsigned long visited)
320 irg->block_visited = visited;
324 __inc_irg_block_visited(ir_graph *irg)
326 ++irg->block_visited;
329 #define get_irg_start_block(irg) __get_irg_start_block(irg)
330 #define set_irg_start_block(irg, node) __set_irg_start_block(irg, node)
331 #define get_irg_start(irg) __get_irg_start(irg)
332 #define set_irg_start(irg, node) __set_irg_start(irg, node)
333 #define get_irg_end_block(irg) __get_irg_end_block(irg)
334 #define set_irg_end_block(irg, node) __set_irg_end_block(irg, node)
335 #define get_irg_end(irg) __get_irg_end(irg)
336 #define set_irg_end(irg, node) __set_irg_end(irg, node)
337 #define get_irg_end_reg(irg) __get_irg_end_reg(irg)
338 #define get_irg_end_except(irg) __get_irg_end_except(irg)
339 #define get_irg_cstore(irg) __get_irg_cstore(irg)
340 #define set_irg_cstore(irg, node) __set_irg_cstore(irg, node)
341 #define get_irg_frame(irg) __get_irg_frame(irg)
342 #define set_irg_frame(irg, node) __set_irg_frame(irg, node)
343 #define get_irg_globals(irg) __get_irg_globals(irg)
344 #define set_irg_globals(irg, node) __set_irg_globals(irg, node)
345 #define get_irg_args(irg) __get_irg_args(irg)
346 #define set_irg_args(irg, node) __set_irg_args(irg, node)
347 #define get_irg_bad(irg) __get_irg_bad(irg)
348 #define set_irg_bad(irg, node) __set_irg_bad(irg, node)
349 #define get_irg_current_block(irg) __get_irg_current_block(irg)
350 #define set_irg_current_block(irg, node) __set_irg_current_block(irg, node)
351 #define get_irg_ent(irg) __get_irg_ent(irg)
352 #define set_irg_ent(irg, ent) __set_irg_ent(irg, ent)
353 #define get_irg_frame_type(irg) __get_irg_frame_type(irg)
354 #define set_irg_frame_type(irg, ftp) __set_irg_frame_type(irg, ftp)
355 #define get_irg_obstack(irg) __get_irg_obstack(irg)
356 #define set_irg_link(irg, thing) __set_irg_link(irg, thing)
357 #define get_irg_link(irg) __get_irg_link(irg)
358 #define get_irg_visited(irg) __get_irg_visited(irg)
359 #define get_irg_block_visited(irg) __get_irg_block_visited(irg)
360 #define set_irg_block_visited(irg, v) __set_irg_block_visited(irg, v)
361 #define inc_irg_block_visited(irg) __inc_irg_block_visited(irg)
363 # endif /* _IRGRAPH_T_H_ */