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
30 /* to resolve recursion between irnode.h and irgraph.h */
31 #ifndef _IR_NODE_TYPEDEF_
32 #define _IR_NODE_TYPEDEF_
33 typedef struct ir_node ir_node;
36 /* to resolve recursion between entity.h and irgraph.h */
37 #ifndef _IR_GRAPH_TYPEDEF_
38 #define _IR_GRAPH_TYPEDEF_
39 typedef struct ir_graph ir_graph;
43 * @page ir_graph The struct ir_graph
45 * This struct contains all information about a procedure.
46 * It's allocated directly to memory.
48 * The fields of ir_graph:
50 * *ent The entity describing this procedure.
52 * The beginning and end of a graph:
54 * *start_block This ir_node is the block that contains the unique
55 * start node of the procedure. With it it contains
56 * the Proj's on starts results.
57 * Further all Const nodes are placed in the start block.
58 * *start This ir_node is the unique start node of the procedure.
60 * *end_block This ir_node is the block that contains the unique
61 * end node of the procedure. This block contains no
63 * *end This ir_node is the unique end node of the procedure.
65 * The following nodes are Projs from the start node, held in ir_graph for
68 * *frame The ir_node producing the pointer to the stack frame of
69 * the procedure as output. This is the Proj node on the
70 * third output of the start node. This output of the start
71 * node is tagged as pns_frame_base. In FIRM most lokal
72 * variables are modeled as data flow edges. Static
73 * allocated arrays can not be represented as dataflow
74 * edges. Therefore FIRM has to represent them in the stack
77 * *globals This models a pointer to a space in the memory where
78 * _all_ global things are held. Select from this pointer
79 * with a Sel node the pointer to a global variable /
80 * procedure / compiler known function... .
82 * *args The ir_node that produces the arguments of the method as
83 * it's result. This is a Proj node on the fourth output of
84 * the start node. This output is tagged as pn_Start_T_args.
86 * *proj_args The proj nodes off the args node.
88 * *bad The Bad node is an auxiliary node. It is needed only once,
89 * so there is this globally reachable node.
91 * *no_mem The NoMem node is an auxiliary node. It is needed only once,
92 * so there is this globally reachable node.
94 * Datastructures that are private to a graph:
96 * *obst An obstack that contains all nodes.
98 * *current_block A pointer to the current block. Any node created with
99 * one of the node constructors (new_<opcode>) are assigned
100 * to this block. It can be set with set_cur_block(block).
101 * Only needed for ir construction.
103 * params/n_loc An int giving the number of local variables in this
104 * procedure. This is neede for ir construction. Name will
107 * *value_table This hash table (pset) is used for global value numbering
108 * for optimizing use in iropt.c.
110 * *Phi_in_stack; a stack needed for automatic Phi construction, needed only
111 * during ir construction.
113 * visited A int used as flag to traverse the ir_graph.
115 * block_visited A int used as a flag to traverse block nodes in the graph.
118 /** Global variable holding the current ir graph.
120 * This global variable is used by the ir construction
121 * interface in ircons and by the optimizations.
122 * Further it is set by all walker functions.
124 extern ir_graph *current_ir_graph;
126 ir_graph *get_current_ir_graph(void);
127 void set_current_ir_graph(ir_graph *graph);
129 /** This flag indicate the current view. The behaviour of some methods
130 * (get_irn_*, set_irn_*) is influenced by this flag. */
131 int get_interprocedural_view(void);
132 void set_interprocedural_view(int state);
135 * Create a new ir graph to build ir for a procedure.
137 * @param ent A pointer to an entity representing the procedure,
138 * i.e., the type of the entity must be of a method type.
140 * @param n_loc The number of local variables in this procedure including
141 * the procedure parameters.
143 * This constructor generates the basic infrastructure needed to
144 * represent a procedure in FIRM.
146 * It allocates an ir_graph and sets the field irg of the entity ent
147 * as well as current_ir_graph to point to this graph.
148 * Further it allocates the following nodes needed for every
151 * - The start block containing a start node and Proj nodes for it's
152 * five results (X, M, P, P, T).
153 * - The end block containing an end node. This block is not matured
154 * after executing new_ir_graph as predecessors need to be added to it.
155 * (Maturing a block means fixing it's number of predecessors.)
156 * - The current block, which is empty and also not matured.
158 * Further it enters the global store into the datastructure of the start
159 * block that contanis all valid values in this block (set_store()). This
160 * datastructure is used to build the Phi nodes and removed after
161 * completion of the graph. There is no path from end to start in the
162 * graph after calling ir_graph.
164 * The op_pin_state of the graph is set to "op_pin_state_pinned"
165 * if no global cse was performed on the graph.
166 * It is set to "op_pin_state_floats" if global cse was performed
167 * (and during construction: did actually change something).
168 * Code placement is necessary.
170 * @see new_pseudo_ir_graph()
172 ir_graph *new_ir_graph (entity *ent, int n_loc);
174 /** Frees the passed irgraph.
175 * Deallocates all nodes in this graph and the ir_graph structure.
176 * Sets the field irgraph in the corresponding entity to NULL.
177 * Does not remove the irgraph from the list in irprog (requires
178 * inefficient search, call remove_irp_irg by hand).
179 * Does not free types, entities or modes that are used only by this
180 * graph, nor the entity standing for this graph.
182 void free_ir_graph (ir_graph *irg);
184 /* --- access routines for all ir_graph attributes --- */
187 * Checks whether a pointer points to a ir graph.
189 * @param thing an arbitrary pointer
192 * true if the thing is a ir graph, else false
194 int is_ir_graph(const void *thing);
196 /* #define get_irg_entity get_irg_ent */
197 /* #define set_irg_entity set_irg_ent */
198 entity *get_irg_entity (const ir_graph *irg);
199 void set_irg_entity (ir_graph *irg, entity *ent);
201 type *get_irg_frame_type (const ir_graph *irg);
202 void set_irg_frame_type (ir_graph *irg, type *ftp);
203 /* To test for a frame type. O(#irgs) if ftp is class type. */
204 int is_frame_type (const type *ftp);
206 ir_node *get_irg_start_block (const ir_graph *irg);
207 void set_irg_start_block (ir_graph *irg, ir_node *node);
209 ir_node *get_irg_start (const ir_graph *irg);
210 void set_irg_start (ir_graph *irg, ir_node *node);
212 ir_node *get_irg_end_block (const ir_graph *irg);
213 void set_irg_end_block (ir_graph *irg, ir_node *node);
215 ir_node *get_irg_end (const ir_graph *irg);
216 void set_irg_end (ir_graph *irg, ir_node *node);
218 /* The fields end_reg and end_except contain the end nodes of the
219 interprocedural view. If the view is not constructed they contain
220 the nomal end node. */
221 ir_node *get_irg_end_reg (const ir_graph *irg);
222 void set_irg_end_reg (ir_graph *irg, ir_node *node);
224 ir_node *get_irg_end_except (const ir_graph *irg);
225 void set_irg_end_except (ir_graph *irg, ir_node *node);
228 /* @@@ oblivious, no more supported. */
229 ir_node *get_irg_cstore (const ir_graph *irg);
230 void set_irg_cstore (ir_graph *irg, ir_node *node);
233 /** Returns the node that represents the frame pointer. */
234 ir_node *get_irg_frame (const ir_graph *irg);
235 /** Sets the node that represents the frame pointer. */
236 void set_irg_frame (ir_graph *irg, ir_node *node);
238 /** Returns the node that represents the global pointer. */
239 ir_node *get_irg_globals (const ir_graph *irg);
240 /** Sets the node that represents the global pointer. */
241 void set_irg_globals (ir_graph *irg, ir_node *node);
243 /** Returns the node that represents the initial memory. */
244 ir_node *get_irg_initial_mem (const ir_graph *irg);
245 /** Sets the node that represents the initial memory. */
246 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
248 /** Returns the node that represents the argument pointer. */
249 ir_node *get_irg_args (const ir_graph *irg);
250 /** Sets the node that represents the argument pointer. */
251 void set_irg_args (ir_graph *irg, ir_node *node);
253 /** Returns an array of the nodes off the argument pointer. */
254 ir_node **get_irg_proj_args (const ir_graph *irg);
255 /** Sets the array of the nodes off the argument pointer. */
256 void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
258 /** Returns the current block of a graph. */
259 ir_node *get_irg_current_block (const ir_graph *irg);
260 /** Sets the current block of a graph. */
261 void set_irg_current_block (ir_graph *irg, ir_node *node);
263 /** Returns the Bad node. Use new_Bad() instead!! */
264 ir_node *get_irg_bad (const ir_graph *irg);
265 void set_irg_bad (ir_graph *irg, ir_node *node);
267 /** Returns the NoMem node. Use new_NoMem() instead!! */
268 ir_node *get_irg_no_mem (const ir_graph *irg);
269 void set_irg_no_mem (ir_graph *irg, ir_node *node);
271 /** Returns the number of value numbers of a graph. */
272 int get_irg_n_locs (ir_graph *irg);
274 /** Returns the graph number. */
275 long get_irg_graph_nr(ir_graph *irg);
277 /********************************************************************************/
278 /* States of an ir_graph. */
279 /********************************************************************************/
282 information associated with the graph. Optimizations invalidate these
285 /** The states of an ir graph.
287 * state phase values: phase_building, phase_high, phase_low.
289 * The graph is in phase_building during construction of the irgraph.
290 * The construction is finished by a call to finalize_cons().
292 * Finalize_cons() sets the state to phase_high. All Firm nodes are
295 * To get the irgraph into phase_low all Sel nodes must be removed and
296 * replaced by explicit address computations. SymConst size and
297 * typetag nodes must be removed (@@@ really?). Initialization of
298 * memory allocated by Alloc must be explicit. @@@ More conditions?
307 /** returns the phase_state of an IR graph. */
308 irg_phase_state get_irg_phase_state (const ir_graph *irg);
310 /** sets the phase state of an IR graph. */
311 void set_irg_phase_low(ir_graph *irg);
313 /** state: op_pin_state_pinned
314 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
315 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
316 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
317 invalid block, i.e., the block is not a dominator of all the uses of
319 The enum op_pin_state is defined in irop.h. */
320 op_pin_state get_irg_pinned (const ir_graph *irg);
322 /** state: outs_state
323 Outs are the back edges or def-use edges.
324 Values: outs_none, outs_consistent, outs_inconsistent
325 outs_none: outs are not computed, no memory is allocated.
326 outs_consistent: outs are computed and correct,
327 outs_inconsistent: outs have been computed, memory is still allocated,
328 but the graph has been changed since. */
334 irg_outs_state get_irg_outs_state(const ir_graph *irg);
335 void set_irg_outs_inconsistent(ir_graph *irg);
338 Signals the state of the dominator infomation.
339 Values: dom_none, dom_consistent, dom_inconsistent
340 dom_none: doms are not computed, no memory is allocated. The access routines
342 dom_consistent: dominator information is computed and correct,
343 dom_inconsistent: dominator information is computed, memory is still allocated,
344 but the graph has been changed since. Using the access routines is possible,
345 obtained information may be incorrect. */
347 dom_none, /**< doms are not computed, no memory is allocated */
348 dom_consistent, /**< dominator information is computed and correct */
349 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
352 /** returns the dom_state of an IR graph. */
353 irg_dom_state get_irg_dom_state(const ir_graph *irg);
355 /** sets the dom_state of an IR graph. */
356 void set_irg_dom_inconsistent(ir_graph *irg);
358 /** state: loopinfo_state
359 Loop information describes the loops within the control and
360 data flow of the procedure. */
362 loopinfo_none = 0, /**< No loop information is constructed. Default. */
363 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
364 loopinfo_valid = 2, /**< Loop information is valid. */
365 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
366 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
368 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
369 are used in a switch. */
371 /** IntRAprocedural loop information constructed and valid. */
372 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
373 /** IntRAprocedural loop information constructed and invalid. */
374 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
376 /** IntERprocedural loop information constructed and valid. */
377 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
378 /** IntERprocedural loop information constructed and invalid. */
379 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
381 /** IntRAprocedural control loop information constructed and valid. */
382 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
383 /** IntRAprocedural control loop information constructed and invalid. */
384 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
386 /** IntERprocedural control loop information constructed and valid. */
387 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
388 /** IntERprocedural control loop information constructed and invalid. */
389 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
390 } irg_loopinfo_state;
392 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
393 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
394 /** Sets the loopinformation state to the appropriate inconsistent state.
395 If state is 'none' does not change. */
396 void set_irg_loopinfo_inconsistent(ir_graph *irg);
398 /** state: callee_information_state
399 * Call nodes contain a list of possible callees. This list must be
400 * computed by an analysis.
402 * It's strange that this state is administered on irg basis, as the
403 * information must be computed for the whole program, or not?
406 irg_callee_info_none,
407 irg_callee_info_consistent,
408 irg_callee_info_inconsistent
409 } irg_callee_info_state;
411 /** returns the callee_info_state of an IR graph. */
412 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
414 /** sets the callee_info_state of an IR graph. */
415 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
418 * Tells how to handle an ir graph in inlineing.
421 irg_inline_any, /**< No restriction on inlineing. Default. */
422 irg_inline_forbidden, /**< The graph may not be inlined. */
423 irg_inline_recomended, /**< The graph should be inlined. */
424 irg_inline_forced /**< The graph must be inlined. */
425 } irg_inline_property;
427 /** Returns the inline property of a graph. */
428 irg_inline_property get_irg_inline_property(const ir_graph *irg);
429 /** Sets the inline property of a graph. */
430 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
432 /** A void * field to link arbitrary information to the node. */
433 void set_irg_link (ir_graph *irg, void *thing);
434 void *get_irg_link (const ir_graph *irg);
436 /** increments visited by one */
437 void inc_irg_visited (ir_graph *irg);
438 unsigned long get_irg_visited (const ir_graph *irg);
439 void set_irg_visited (ir_graph *irg, unsigned long i);
440 unsigned long get_max_irg_visited (void);
441 void set_max_irg_visited (int val);
442 unsigned long inc_max_irg_visited (void);
444 /** increments block_visited by one */
445 void inc_irg_block_visited (ir_graph *irg);
446 unsigned long get_irg_block_visited (const ir_graph *irg);
447 void set_irg_block_visited (ir_graph *irg, unsigned long i);
449 /** move Proj nodes into the same block as its predecessors */
450 void normalize_proj_nodes(ir_graph *irg);
452 /** set a description for local value n */
453 void set_irg_loc_description(ir_graph *irg, int n, void *description);
455 /** get the description for local value n */
456 void *get_irg_loc_description(ir_graph *irg, int n);
459 * Access custom graph data.
460 * The data must have been registered with
461 * register_additional_graph_data() before.
462 * @param graph The graph to get the data from.
463 * @param type The type of the data you registered.
464 * @param off The value returned by register_additional_graph_data().
465 * @return A pointer of type @p type.
467 #define get_irg_data(graph,type,off) \
468 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
471 * Get the pointer to the node some custom data belongs to.
472 * @param data The pointer to the custom data.
473 * @param off The number as returned by register_additional_graph_data().
474 * @return A pointer to the ir node the custom data belongs to.
476 #define get_irg_data_base(data,off) \
477 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
480 * Request additional data to be allocated with an ir graph.
481 * @param size The size of the additional data required.
482 * @return A positive number, if the opration was successful, which
483 * must be passed to the access macro get_irg_data(), 0 if the
484 * registration failed.
486 size_t register_additional_graph_data(size_t size);
488 # endif /* _IRGRAPH_H_ */