3 * File name: ir/ir/irgraph.c
4 * Purpose: Entry point to the representation of procedure code.
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
29 /* to resolve recursion between irnode.h and irgraph.h */
30 #ifndef _IR_NODE_TYPEDEF_
31 #define _IR_NODE_TYPEDEF_
32 typedef struct ir_node ir_node;
35 /* to resolve recursion between entity.h and irgraph.h */
36 #ifndef _IR_GRAPH_TYPEDEF_
37 #define _IR_GRAPH_TYPEDEF_
38 typedef struct ir_graph ir_graph;
43 * NAME Datastructure that holds central information about a procedure
45 * ir_graph *new_ir_graph (entity *ent, int params);
46 * -------------------------------------------------
48 * This constructor generates the basic infrastructure needed to
49 * represent a procedure in FIRM.
51 * The parameters of new_ir_graph are:
53 * *ent A pointer to an entity representing the procedure.
55 * params An integer giving the number of local variables in the
58 * It allocates an ir_graph and sets current_ir_graph to point to this
59 * graph. Further it allocates the following nodes needed for every
62 * * The start block containing a start node and Proj nodes for it's
63 * five results (X, M, P, P, T).
64 * * The end block containing an end node. This block is not matured
65 * after executing new_ir_graph as predecessors need to be added to it.
66 * (Maturing a block means fixing it's number of predecessors.)
67 * * The current block, which is empty and also not matured.
69 * Further it enters the global store into the datastructure of the start
70 * block that contanis all valid values in this block (set_store()). This
71 * datastructure is used to build the Phi nodes and removed after
72 * completion of the graph. There is no path from end to start in the
73 * graph after calling ir_graph.
74 * op_pin_state_pinned set to "op_pin_state_pinned" if no global cse was performed on the graph.
75 * set to "op_pin_state_floats" if global cse was performed (and during construction:
76 * did actually change something). Code placement is necessary.
79 /** Global variable holding the current ir graph.
81 * This global variable is used by the ir construction
82 * interface in ircons and by the optimizations.
84 extern ir_graph *current_ir_graph;
86 ir_graph *get_current_ir_graph(void);
87 void set_current_ir_graph(ir_graph *graph);
89 /** This flag indicate the current view. The behaviour of some methods
90 * (get_irn_*, set_irn_*) is influenced by this flag. */
91 int get_interprocedural_view(void);
92 void set_interprocedural_view(int state);
94 /** Create a new ir graph to built ir for a procedure.
96 * ent is the entity representing this procedure, i.e., the type of the
97 * entity must be of a method type. The constructor automatically sets the
98 * field irg of the entity as well as current_ir_graph to the new ir graph.
99 * n_loc is the number of local variables in this procedure including
100 * the procedure parameters.
101 * The constructor adds the new irgraph to the list in ir_prog.
102 * The state of the ir graph is: phase_building, op_pin_state_pinned, outs_none. */
103 ir_graph *new_ir_graph (entity *ent, int n_loc);
105 /** Frees the passed irgraph.
106 * Deallocates all nodes in this graph and the ir_graph structure.
107 * Sets the field irgraph in the corresponding entity to NULL.
108 * Does not remove the irgraph from the list in irprog (requires
109 * inefficient search, call remove_irp_irg by hand).
110 * Does not free types, entities or modes that are used only by this
111 * graph, nor the entity standing for this graph.
113 void free_ir_graph (ir_graph *irg);
115 /* --- access routines for all ir_graph attributes --- */
118 * Checks whether a pointer points to a ir graph.
120 * @param thing an arbitrary pointer
123 * true if the thing is a ir graph, else false
125 int is_ir_graph(const void *thing);
127 /* #define get_irg_entity get_irg_ent */
128 /* #define set_irg_entity set_irg_ent */
129 entity *get_irg_entity (const ir_graph *irg);
130 void set_irg_entity (ir_graph *irg, entity *ent);
132 type *get_irg_frame_type (const ir_graph *irg);
133 void set_irg_frame_type (ir_graph *irg, type *ftp);
134 /* To test for a frame type. O(#irgs) if ftp is class type. */
135 int is_frame_type (const type *ftp);
137 ir_node *get_irg_start_block (const ir_graph *irg);
138 void set_irg_start_block (ir_graph *irg, ir_node *node);
140 ir_node *get_irg_start (const ir_graph *irg);
141 void set_irg_start (ir_graph *irg, ir_node *node);
143 ir_node *get_irg_end_block (const ir_graph *irg);
144 void set_irg_end_block (ir_graph *irg, ir_node *node);
146 ir_node *get_irg_end (const ir_graph *irg);
147 void set_irg_end (ir_graph *irg, ir_node *node);
149 /* The fields end_reg and end_except contain the end nodes of the
150 interprocedural view. If the view is not constructed they contain
151 the nomal end node. */
152 ir_node *get_irg_end_reg (const ir_graph *irg);
153 void set_irg_end_reg (ir_graph *irg, ir_node *node);
155 ir_node *get_irg_end_except (const ir_graph *irg);
156 void set_irg_end_except (ir_graph *irg, ir_node *node);
159 /* @@@ oblivious, no more supported. */
160 ir_node *get_irg_cstore (const ir_graph *irg);
161 void set_irg_cstore (ir_graph *irg, ir_node *node);
164 /** Returns the node that represents the frame pointer. */
165 ir_node *get_irg_frame (const ir_graph *irg);
166 /** Sets the node that represents the frame pointer. */
167 void set_irg_frame (ir_graph *irg, ir_node *node);
169 /** Returns the node that represents the global pointer. */
170 ir_node *get_irg_globals (const ir_graph *irg);
171 /** Sets the node that represents the global pointer. */
172 void set_irg_globals (ir_graph *irg, ir_node *node);
174 /** Returns the node that represents the initial memory. */
175 ir_node *get_irg_initial_mem (const ir_graph *irg);
176 /** Sets the node that represents the initial memory. */
177 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
179 /** Returns the node that represents the argument pointer. */
180 ir_node *get_irg_args (const ir_graph *irg);
181 /** Sets the node that represents the argument pointer. */
182 void set_irg_args (ir_graph *irg, ir_node *node);
184 /** Returns the current block of a graph. */
185 ir_node *get_irg_current_block (const ir_graph *irg);
186 /** Sets the current block of a graph. */
187 void set_irg_current_block (ir_graph *irg, ir_node *node);
189 /** Returns the Bad node. Use new_Bad() instead!! */
190 ir_node *get_irg_bad (const ir_graph *irg);
191 void set_irg_bad (ir_graph *irg, ir_node *node);
193 /** Returns the number of value numbers of a graph. */
194 int get_irg_n_locs (ir_graph *irg);
196 /** Returns the graph number. */
197 long get_irg_graph_nr(ir_graph *irg);
199 /********************************************************************************/
200 /* States of an ir_graph. */
201 /********************************************************************************/
204 information associated with the graph. Optimizations invalidate these
207 /** The states of an ir graph.
209 * state phase values: phase_building, phase_high, phase_low.
211 * The graph is in phase_building during construction of the irgraph.
212 * The construction is finished by a call to finalize_cons().
214 * Finalize_cons() sets the state to phase_high. All Firm nodes are
217 * To get the irgraph into phase_low all Sel nodes must be removed and
218 * replaced by explicit address computations. SymConst size and
219 * typetag nodes must be removed (@@@ really?). Initialization of
220 * memory allocated by Alloc must be explicit. @@@ More conditions?
229 irg_phase_state get_irg_phase_state (const ir_graph *irg);
230 void set_irg_phase_low(ir_graph *irg);
232 /** state: op_pin_state_pinned
233 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
234 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
235 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
236 invalid block, i.e., the block is not a dominator of all the uses of
238 The enum op_pin_state is defined in irop.h. */
239 op_pin_state get_irg_pinned (const ir_graph *irg);
241 /** state: outs_state
242 Outs are the back edges or def-use edges.
243 Values: outs_none, outs_consistent, outs_inconsistent
244 outs_none: outs are not computed, no memory is allocated.
245 outs_consistent: outs are computed and correct,
246 outs_inconsistent: outs have been computed, memory is still allocated,
247 but the graph has been changed since. */
253 irg_outs_state get_irg_outs_state(const ir_graph *irg);
254 void set_irg_outs_inconsistent(ir_graph *irg);
257 Signals the state of the dominator infomation.
258 Values: dom_none, dom_consistent, dom_inconsistent
259 dom_none: doms are not computed, no memory is allocated. The access routines
261 dom_consistent: dominator information is computed and correct,
262 dom_inconsistent: dominator information is computed, memory is still allocated,
263 but the graph has been changed since. Using the access routines is possible,
264 obtained information may be incorrect. */
266 dom_none, /**< doms are not computed, no memory is allocated */
267 dom_consistent, /**< dominator information is computed and correct */
268 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
270 irg_dom_state get_irg_dom_state(const ir_graph *irg);
271 void set_irg_dom_inconsistent(ir_graph *irg);
273 /** state: loopinfo_state
274 Loop information describes the loops within the control and
275 data flow of the procedure. */
277 loopinfo_none = 0, /**< No loop information is constructed. Default. */
278 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
279 loopinfo_valid = 2, /**< Loop information is valid. */
280 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
281 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
283 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
284 are used in a switch. */
286 /** IntRAprocedural loop information constructed and valid. */
287 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
288 /** IntRAprocedural loop information constructed and invalid. */
289 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
291 /** IntERprocedural loop information constructed and valid. */
292 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
293 /** IntERprocedural loop information constructed and invalid. */
294 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
296 /** IntRAprocedural control loop information constructed and valid. */
297 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
298 /** IntRAprocedural control loop information constructed and invalid. */
299 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
301 /** IntERprocedural control loop information constructed and valid. */
302 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
303 /** IntERprocedural control loop information constructed and invalid. */
304 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
305 } irg_loopinfo_state;
307 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
308 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
309 /** Sets the loopinformation state to the appropriate inconsistent state.
310 If state is 'none' does not change. */
311 void set_irg_loopinfo_inconsistent(ir_graph *irg);
313 /** state: callee_information_state
314 * Call nodes contain a list of possible callees. This list must be
315 * computed by an analysis.
317 * It's strange that this state is administered on irg basis, as the
318 * information must be computed for the whole program, or not?
321 irg_callee_info_none,
322 irg_callee_info_consistent,
323 irg_callee_info_inconsistent
324 } irg_callee_info_state;
325 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
326 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
329 * Tells how to handle an ir graph in inlineing.
332 irg_inline_any, /**< No restriction on inlineing. Default. */
333 irg_inline_forbidden, /**< The graph may not be inlined. */
334 irg_inline_recomended, /**< The graph should be inlined. */
335 irg_inline_forced /**< The graph must be inlined. */
336 } irg_inline_property;
338 /** Returns the inline property of a graph. */
339 irg_inline_property get_irg_inline_property(const ir_graph *irg);
340 /** Sets the inline property of a graph. */
341 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
343 /** A void * field to link arbritary information to the node. */
344 void set_irg_link (ir_graph *irg, void *thing);
345 void *get_irg_link (const ir_graph *irg);
347 /* increments visited by one */
348 void inc_irg_visited (ir_graph *irg);
349 unsigned long get_irg_visited (const ir_graph *irg);
350 void set_irg_visited (ir_graph *irg, unsigned long i);
351 unsigned long get_max_irg_visited (void);
352 void set_max_irg_visited (int val);
353 unsigned long inc_max_irg_visited (void);
355 /* increments block_visited by one */
356 void inc_irg_block_visited (ir_graph *irg);
357 unsigned long get_irg_block_visited (const ir_graph *irg);
358 void set_irg_block_visited (ir_graph *irg, unsigned long i);
360 /* is irg a pseudo graph for analysis? */
361 int is_pseudo_ir_graph(ir_graph *irg);
363 # endif /* _IRGRAPH_H_ */