1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
8 * ir graph construction.
10 * @author Martin Trapp, Christian Schaefer
21 /* to resolve recursion between irnode.h and irgraph.h */
22 #ifndef _IR_NODE_TYPEDEF_
23 #define _IR_NODE_TYPEDEF_
24 typedef struct ir_node ir_node;
27 /* to resolve recursion between entity.h and irgraph.h */
28 #ifndef _IR_GRAPH_TYPEDEF_
29 #define _IR_GRAPH_TYPEDEF_
30 typedef struct ir_graph ir_graph;
35 * NAME Datastructure that holds central information about a procedure
37 * ir_graph *new_ir_graph (entity *ent, int params);
38 * -------------------------------------------------
40 * This constructor generates the basic infrastructure needed to
41 * represent a procedure in FIRM.
43 * The parameters of new_ir_graph are:
45 * *ent A pointer to an entity representing the procedure.
47 * params An integer giving the number of local variables in the
50 * It allocates an ir_graph and sets current_ir_graph to point to this
51 * graph. Further it allocates the following nodes needed for every
54 * * The start block containing a start node and Proj nodes for it's
55 * five results (X, M, P, P, T).
56 * * The end block containing an end node. This block is not matured
57 * after executing new_ir_graph as predecessors need to be added to it.
58 * (Maturing a block means fixing it's number of predecessors.)
59 * * The current block, which is empty and also not matured.
61 * Further it enters the global store into the datastructure of the start
62 * block that contanis all valid values in this block (set_store()). This
63 * datastructure is used to build the Phi nodes and removed after
64 * completion of the graph. There is no path from end to start in the
65 * graph after calling ir_graph.
66 * pinned set to "pinned" if no global cse was performed on the graph.
67 * set to "floats" if global cse was performed (and during construction:
68 * did actually change something). Code placement is necessary.
71 /* Global variable holding the current_ir_graph. This global variable
72 is used by the ir construction interface in ircons and by the
74 extern ir_graph *current_ir_graph;
75 ir_graph *get_current_ir_graph(void);
76 void set_current_ir_graph(ir_graph *graph);
78 /** This flag indicate the current view. The behaviour of some methods
79 * (get_irn_*, set_irn_*) is influenced by this flag. */
80 extern bool interprocedural_view;
81 bool get_interprocedural_view(void);
82 void set_interprocedural_view(bool state);
84 /** Create a new ir graph to built ir for a procedure.
85 ent is the entity representing this procedure, i.e., the type of the
86 entity must be of a method type. The constructor automatically sets the
87 field irg of the entity as well as current_ir_graph to the new ir graph.
88 n_loc is the number of local variables in this procedure including
89 the procedure parameters.
90 The state of the ir graph is: phase_building, pinned, no_outs. */
91 ir_graph *new_ir_graph (entity *ent, int n_loc);
93 /** Frees the passed irgraph.
94 Deallocates all nodes in this graph and the ir_graph structure.
95 Sets the field irgraph in the corresponding entity to NULL.
96 Does not remove the irgraph from the list in irprog (requires
97 inefficient search, call remove_irp_irg by hand).
98 Does not free types, entities or modes that are used only by this
99 graph, nor the entity standing for this graph. */
100 void free_ir_graph (ir_graph *irg);
102 /* --- access routines for all ir_graph attributes --- */
105 * Checks whether a pointer points to a ir graph.
107 * @param thing an arbitrary pointer
110 * true if the thing is a ir graph, else false
113 is_ir_graph(void *thing);
115 entity *get_irg_ent (ir_graph *irg);
116 void set_irg_ent (ir_graph *irg, entity *ent);
118 type *get_irg_frame_type (ir_graph *irg);
119 void set_irg_frame_type (ir_graph *irg, type *ftp);
120 /* To test for a frame type */
121 int is_frame_type(type *ftp);
123 ir_node *get_irg_start_block (ir_graph *irg);
124 void set_irg_start_block (ir_graph *irg, ir_node *node);
126 ir_node *get_irg_start (ir_graph *irg);
127 void set_irg_start (ir_graph *irg, ir_node *node);
129 ir_node *get_irg_end_block (ir_graph *irg);
130 void set_irg_end_block (ir_graph *irg, ir_node *node);
132 ir_node *get_irg_end (ir_graph *irg);
133 void set_irg_end (ir_graph *irg, ir_node *node);
135 /* @@@ oblivious, no more supported. */
136 ir_node *get_irg_cstore (ir_graph *irg);
137 void set_irg_cstore (ir_graph *irg, ir_node *node);
140 ir_node *get_irg_frame (ir_graph *irg);
141 void set_irg_frame (ir_graph *irg, ir_node *node);
143 ir_node *get_irg_globals (ir_graph *irg);
144 void set_irg_globals (ir_graph *irg, ir_node *node);
146 ir_node *get_irg_args (ir_graph *irg);
147 void set_irg_args (ir_graph *irg, ir_node *node);
149 ir_node *get_irg_current_block (ir_graph *irg);
150 void set_irg_current_block (ir_graph *irg, ir_node *node);
152 /* Use new_Bad() instead!! */
153 ir_node *get_irg_bad (ir_graph *irg);
154 void set_irg_bad (ir_graph *irg, ir_node *node);
156 /* Use new_Unknown() instead!! */
157 ir_node *get_irg_unknown (ir_graph *irg);
158 void set_irg_unknown (ir_graph *irg, ir_node *node);
160 int get_irg_n_locs (ir_graph *irg);
162 INLINE long get_irg_graph_nr(ir_graph *irg);
164 /********************************************************************************/
165 /* States of an ir_graph. */
166 /********************************************************************************/
169 information associated with the graph. Optimizations invalidate these
172 /** state: phase values: phase_building, phase_high, phase_low.
173 The irg is in phase_building during construction of the irgraph. It is in
174 phase_high after construction. All nodes are allowed. To get the irgraph
175 into phase_low all Sel nodes must be removed and replaced by explicit
176 address computations. SymConst size and typetag nodes must be removed (@@@
177 really?). Initialization of memory allocated by Alloc must be explicit.
178 @@@ More conditions? */
185 irg_phase_state get_irg_phase_state (ir_graph *irg);
186 void set_irg_phase_low(ir_graph *irg);
189 The graph is "pinned" if all nodes are associated with a basic block.
190 It is in state "floats" if nodes are in arbitrary blocks. In state
191 "floats" the block predecessor is set in all nodes, but this can be an
192 invalid block, i.e., the block is not a dominator of all the uses of
194 The enum op_pinned is defined in irop.h. */
195 op_pinned get_irg_pinned (ir_graph *irg);
197 /** state: outs_state
198 Outs are the back edges or def-use edges.
199 Values: no_outs, outs_consistent, outs_inconsistent
200 no_outs: outs are not computed, no memory is allocated.
201 outs_consistent: outs are computed and correct,
202 outs_inconsistent: outs have been computed, memory is still allocated,
203 but the graph has been changed since. */
209 irg_outs_state get_irg_outs_state(ir_graph *irg);
210 void set_irg_outs_inconsistent(ir_graph *irg);
213 Signals the state of the dominator infomation.
214 Values: no_dom, dom_consistent, dom_inconsistent
215 no_dom: doms are not computed, no memory is allocated. The access routines
217 dom_consistent: dominator information is computed and correct,
218 dom_inconsistent: dominator information is computed, memory is still allocated,
219 but the graph has been changed since. Using the access routines is possible,
220 obtained information may be incorrect. */
226 irg_dom_state get_irg_dom_state(ir_graph *irg);
227 void set_irg_dom_inconsistent(ir_graph *irg);
229 /* state: loopinfo_state
230 Loop information describes the loops within the control and
231 data flow of the procedure.
232 tpedef enum { @@@ make unrecognizable for jni script!!!
235 loopinfo_inconsistent
236 } irg_loopinfo_state;
237 irg_loopinfo_state get_irg_loopinfo_state(ir_graph *irg);
238 void set_irg_loopinfo_inconsistent(ir_graph *irg);
241 /* A void * field to link arbritary information to the node. */
242 void set_irg_link (ir_graph *irg, void *thing);
243 void *get_irg_link (ir_graph *irg);
245 /* increments visited by one */
246 void inc_irg_visited(ir_graph *irg);
247 unsigned long get_irg_visited (ir_graph *irg);
248 void set_irg_visited(ir_graph *irg, unsigned long i);
249 unsigned long get_max_irg_visited(void);
250 void set_max_irg_visited(int val);
251 unsigned long inc_max_irg_visited(void);
253 /* increments block_visited by one */
254 void inc_irg_block_visited(ir_graph *irg);
255 unsigned long get_irg_block_visited (ir_graph *irg);
256 void set_irg_block_visited(ir_graph *irg, unsigned long i);
258 # endif /* _IRGRAPH_H_ */