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;
42 * @page ir_graph The struct ir_graph
44 * This struct contains all information about a procedure.
45 * It's allocated directly to memory.
47 * The fields of ir_graph:
49 * *ent The entity describing this procedure.
51 * The beginning and end of a graph:
53 * *start_block This ir_node is the block that contains the unique
54 * start node of the procedure. With it it contains
55 * the Proj's on starts results.
56 * Further all Const nodes are placed in the start block.
57 * *start This ir_node is the unique start node of the procedure.
59 * *end_block This ir_node is the block that contains the unique
60 * end node of the procedure. This block contains no
62 * *end This ir_node is the unique end node of the procedure.
64 * The following nodes are Projs from the start node, held in ir_graph for
67 * *frame The ir_node producing the pointer to the stack frame of
68 * the procedure as output. This is the Proj node on the
69 * third output of the start node. This output of the start
70 * node is tagged as pns_frame_base. In FIRM most lokal
71 * variables are modeled as data flow edges. Static
72 * allocated arrays can not be represented as dataflow
73 * edges. Therefore FIRM has to represent them in the stack
76 * *globals This models a pointer to a space in the memory where
77 * _all_ global things are held. Select from this pointer
78 * with a Sel node the pointer to a global variable /
79 * procedure / compiler known function... .
81 * *args The ir_node that produces the arguments of the method as
82 * it's result. This is a Proj node on the fourth output of
83 * the start node. This output is tagged as pn_Start_T_args.
85 * *bad The Bad node is an auxiliary node. It is needed only once,
86 * so there is this globally reachable node.
88 * *no_mem The NoMem node is an auxiliary node. It is needed only once,
89 * so there is this globally reachable node.
91 * Datastructures that are private to a graph:
93 * *obst An obstack that contains all nodes.
95 * *current_block A pointer to the current block. Any node created with
96 * one of the node constructors (new_<opcode>) are assigned
97 * to this block. It can be set with set_cur_block(block).
98 * Only needed for ir construction.
100 * params/n_loc An int giving the number of local variables in this
101 * procedure. This is neede for ir construction. Name will
104 * *value_table This hash table (pset) is used for global value numbering
105 * for optimizing use in iropt.c.
107 * *Phi_in_stack; a stack needed for automatic Phi construction, needed only
108 * during ir construction.
110 * visited A int used as flag to traverse the ir_graph.
112 * block_visited A int used as a flag to traverse block nodes in the graph.
115 /** Global variable holding the current ir graph.
117 * This global variable is used by the ir construction
118 * interface in ircons and by the optimizations.
119 * Further it is set by all walker functions.
121 extern ir_graph *current_ir_graph;
123 ir_graph *get_current_ir_graph(void);
124 void set_current_ir_graph(ir_graph *graph);
126 /** This flag indicate the current view. The behaviour of some methods
127 * (get_irn_*, set_irn_*) is influenced by this flag. */
128 int get_interprocedural_view(void);
129 void set_interprocedural_view(int state);
132 * Create a new ir graph to build ir for a procedure.
134 * @param ent A pointer to an entity representing the procedure,
135 * i.e., the type of the entity must be of a method type.
137 * @param n_loc The number of local variables in this procedure including
138 * the procedure parameters.
140 * This constructor generates the basic infrastructure needed to
141 * represent a procedure in FIRM.
143 * It allocates an ir_graph and sets the field irg of the entity ent
144 * as well as current_ir_graph to point to this graph.
145 * Further it allocates the following nodes needed for every
148 * - The start block containing a start node and Proj nodes for it's
149 * five results (X, M, P, P, T).
150 * - The end block containing an end node. This block is not matured
151 * after executing new_ir_graph as predecessors need to be added to it.
152 * (Maturing a block means fixing it's number of predecessors.)
153 * - The current block, which is empty and also not matured.
155 * Further it enters the global store into the datastructure of the start
156 * block that contanis all valid values in this block (set_store()). This
157 * datastructure is used to build the Phi nodes and removed after
158 * completion of the graph. There is no path from end to start in the
159 * graph after calling ir_graph.
161 * The op_pin_state of the graph is set to "op_pin_state_pinned"
162 * if no global cse was performed on the graph.
163 * It is set to "op_pin_state_floats" if global cse was performed
164 * (and during construction: did actually change something).
165 * Code placement is necessary.
167 * @see new_pseudo_ir_graph()
169 ir_graph *new_ir_graph (entity *ent, int n_loc);
171 /** Frees the passed irgraph.
172 * Deallocates all nodes in this graph and the ir_graph structure.
173 * Sets the field irgraph in the corresponding entity to NULL.
174 * Does not remove the irgraph from the list in irprog (requires
175 * inefficient search, call remove_irp_irg by hand).
176 * Does not free types, entities or modes that are used only by this
177 * graph, nor the entity standing for this graph.
179 void free_ir_graph (ir_graph *irg);
181 /* --- access routines for all ir_graph attributes --- */
184 * Checks whether a pointer points to a ir graph.
186 * @param thing an arbitrary pointer
189 * true if the thing is a ir graph, else false
191 int is_ir_graph(const void *thing);
193 /* #define get_irg_entity get_irg_ent */
194 /* #define set_irg_entity set_irg_ent */
195 entity *get_irg_entity (const ir_graph *irg);
196 void set_irg_entity (ir_graph *irg, entity *ent);
198 type *get_irg_frame_type (const ir_graph *irg);
199 void set_irg_frame_type (ir_graph *irg, type *ftp);
200 /* To test for a frame type. O(#irgs) if ftp is class type. */
201 int is_frame_type (const type *ftp);
203 ir_node *get_irg_start_block (const ir_graph *irg);
204 void set_irg_start_block (ir_graph *irg, ir_node *node);
206 ir_node *get_irg_start (const ir_graph *irg);
207 void set_irg_start (ir_graph *irg, ir_node *node);
209 ir_node *get_irg_end_block (const ir_graph *irg);
210 void set_irg_end_block (ir_graph *irg, ir_node *node);
212 ir_node *get_irg_end (const ir_graph *irg);
213 void set_irg_end (ir_graph *irg, ir_node *node);
215 /* The fields end_reg and end_except contain the end nodes of the
216 interprocedural view. If the view is not constructed they contain
217 the nomal end node. */
218 ir_node *get_irg_end_reg (const ir_graph *irg);
219 void set_irg_end_reg (ir_graph *irg, ir_node *node);
221 ir_node *get_irg_end_except (const ir_graph *irg);
222 void set_irg_end_except (ir_graph *irg, ir_node *node);
225 /* @@@ oblivious, no more supported. */
226 ir_node *get_irg_cstore (const ir_graph *irg);
227 void set_irg_cstore (ir_graph *irg, ir_node *node);
230 /** Returns the node that represents the frame pointer. */
231 ir_node *get_irg_frame (const ir_graph *irg);
232 /** Sets the node that represents the frame pointer. */
233 void set_irg_frame (ir_graph *irg, ir_node *node);
235 /** Returns the node that represents the global pointer. */
236 ir_node *get_irg_globals (const ir_graph *irg);
237 /** Sets the node that represents the global pointer. */
238 void set_irg_globals (ir_graph *irg, ir_node *node);
240 /** Returns the node that represents the initial memory. */
241 ir_node *get_irg_initial_mem (const ir_graph *irg);
242 /** Sets the node that represents the initial memory. */
243 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
245 /** Returns the node that represents the argument pointer. */
246 ir_node *get_irg_args (const ir_graph *irg);
247 /** Sets the node that represents the argument pointer. */
248 void set_irg_args (ir_graph *irg, ir_node *node);
250 /** Returns the current block of a graph. */
251 ir_node *get_irg_current_block (const ir_graph *irg);
252 /** Sets the current block of a graph. */
253 void set_irg_current_block (ir_graph *irg, ir_node *node);
255 /** Returns the Bad node. Use new_Bad() instead!! */
256 ir_node *get_irg_bad (const ir_graph *irg);
257 void set_irg_bad (ir_graph *irg, ir_node *node);
259 /** Returns the NoMem node. Use new_NoMem() instead!! */
260 ir_node *get_irg_no_mem (const ir_graph *irg);
261 void set_irg_no_mem (ir_graph *irg, ir_node *node);
263 /** Returns the number of value numbers of a graph. */
264 int get_irg_n_locs (ir_graph *irg);
266 /** Returns the graph number. */
267 long get_irg_graph_nr(ir_graph *irg);
269 /********************************************************************************/
270 /* States of an ir_graph. */
271 /********************************************************************************/
274 information associated with the graph. Optimizations invalidate these
277 /** The states of an ir graph.
279 * state phase values: phase_building, phase_high, phase_low.
281 * The graph is in phase_building during construction of the irgraph.
282 * The construction is finished by a call to finalize_cons().
284 * Finalize_cons() sets the state to phase_high. All Firm nodes are
287 * To get the irgraph into phase_low all Sel nodes must be removed and
288 * replaced by explicit address computations. SymConst size and
289 * typetag nodes must be removed (@@@ really?). Initialization of
290 * memory allocated by Alloc must be explicit. @@@ More conditions?
299 irg_phase_state get_irg_phase_state (const ir_graph *irg);
300 void set_irg_phase_low(ir_graph *irg);
302 /** state: op_pin_state_pinned
303 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
304 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
305 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
306 invalid block, i.e., the block is not a dominator of all the uses of
308 The enum op_pin_state is defined in irop.h. */
309 op_pin_state get_irg_pinned (const ir_graph *irg);
311 /** state: outs_state
312 Outs are the back edges or def-use edges.
313 Values: outs_none, outs_consistent, outs_inconsistent
314 outs_none: outs are not computed, no memory is allocated.
315 outs_consistent: outs are computed and correct,
316 outs_inconsistent: outs have been computed, memory is still allocated,
317 but the graph has been changed since. */
323 irg_outs_state get_irg_outs_state(const ir_graph *irg);
324 void set_irg_outs_inconsistent(ir_graph *irg);
327 Signals the state of the dominator infomation.
328 Values: dom_none, dom_consistent, dom_inconsistent
329 dom_none: doms are not computed, no memory is allocated. The access routines
331 dom_consistent: dominator information is computed and correct,
332 dom_inconsistent: dominator information is computed, memory is still allocated,
333 but the graph has been changed since. Using the access routines is possible,
334 obtained information may be incorrect. */
336 dom_none, /**< doms are not computed, no memory is allocated */
337 dom_consistent, /**< dominator information is computed and correct */
338 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
340 irg_dom_state get_irg_dom_state(const ir_graph *irg);
341 void set_irg_dom_inconsistent(ir_graph *irg);
343 /** state: loopinfo_state
344 Loop information describes the loops within the control and
345 data flow of the procedure. */
347 loopinfo_none = 0, /**< No loop information is constructed. Default. */
348 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
349 loopinfo_valid = 2, /**< Loop information is valid. */
350 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
351 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
353 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
354 are used in a switch. */
356 /** IntRAprocedural loop information constructed and valid. */
357 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
358 /** IntRAprocedural loop information constructed and invalid. */
359 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
361 /** IntERprocedural loop information constructed and valid. */
362 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
363 /** IntERprocedural loop information constructed and invalid. */
364 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
366 /** IntRAprocedural control loop information constructed and valid. */
367 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
368 /** IntRAprocedural control loop information constructed and invalid. */
369 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
371 /** IntERprocedural control loop information constructed and valid. */
372 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
373 /** IntERprocedural control loop information constructed and invalid. */
374 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
375 } irg_loopinfo_state;
377 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
378 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
379 /** Sets the loopinformation state to the appropriate inconsistent state.
380 If state is 'none' does not change. */
381 void set_irg_loopinfo_inconsistent(ir_graph *irg);
383 /** state: callee_information_state
384 * Call nodes contain a list of possible callees. This list must be
385 * computed by an analysis.
387 * It's strange that this state is administered on irg basis, as the
388 * information must be computed for the whole program, or not?
391 irg_callee_info_none,
392 irg_callee_info_consistent,
393 irg_callee_info_inconsistent
394 } irg_callee_info_state;
395 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
396 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
399 * Tells how to handle an ir graph in inlineing.
402 irg_inline_any, /**< No restriction on inlineing. Default. */
403 irg_inline_forbidden, /**< The graph may not be inlined. */
404 irg_inline_recomended, /**< The graph should be inlined. */
405 irg_inline_forced /**< The graph must be inlined. */
406 } irg_inline_property;
408 /** Returns the inline property of a graph. */
409 irg_inline_property get_irg_inline_property(const ir_graph *irg);
410 /** Sets the inline property of a graph. */
411 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
413 /** A void * field to link arbritary information to the node. */
414 void set_irg_link (ir_graph *irg, void *thing);
415 void *get_irg_link (const ir_graph *irg);
417 /* increments visited by one */
418 void inc_irg_visited (ir_graph *irg);
419 unsigned long get_irg_visited (const ir_graph *irg);
420 void set_irg_visited (ir_graph *irg, unsigned long i);
421 unsigned long get_max_irg_visited (void);
422 void set_max_irg_visited (int val);
423 unsigned long inc_max_irg_visited (void);
425 /* increments block_visited by one */
426 void inc_irg_block_visited (ir_graph *irg);
427 unsigned long get_irg_block_visited (const ir_graph *irg);
428 void set_irg_block_visited (ir_graph *irg, unsigned long i);
430 /** put the proj's into the same block as its predecessors */
431 void normalize_proj_nodes(ir_graph *irg);
433 # endif /* _IRGRAPH_H_ */