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
25 #include "firm_types.h"
31 * @page ir_graph The struct ir_graph
33 * This struct contains all information about a procedure.
34 * It's allocated directly to memory.
36 * The fields of ir_graph:
38 * *ent The entity describing this procedure.
40 * The beginning and end of a graph:
42 * *start_block This ir_node is the block that contains the unique
43 * start node of the procedure. With it it contains
44 * the Proj's on starts results.
45 * Further all Const nodes are placed in the start block.
46 * *start This ir_node is the unique start node of the procedure.
48 * *end_block This ir_node is the block that contains the unique
49 * end node of the procedure. This block contains no
51 * *end This ir_node is the unique end node of the procedure.
53 * The following nodes are Projs from the start node, held in ir_graph for
56 * *frame The ir_node producing the pointer to the stack frame of
57 * the procedure as output. This is the Proj node on the
58 * third output of the start node. This output of the start
59 * node is tagged as pns_frame_base. In FIRM most local
60 * variables are modeled as data flow edges. Static
61 * allocated arrays can not be represented as data flow
62 * edges. Therefore FIRM has to represent them in the stack
65 * *globals This models a pointer to a space in the memory where
66 * _all_ global things are held. Select from this pointer
67 * with a Sel node the pointer to a global variable /
68 * procedure / compiler known function... .
70 * *args The ir_node that produces the arguments of the method as
71 * it's result. This is a Proj node on the fourth output of
72 * the start node. This output is tagged as pn_Start_T_args.
74 * *proj_args The proj nodes of the args node.
76 * *bad The Bad node is an auxiliary node. It is needed only once,
77 * so there is this globally reachable node.
79 * *no_mem The NoMem node is an auxiliary node. It is needed only once,
80 * so there is this globally reachable node.
82 * Data structures that are private to a graph:
84 * *obst An obstack that contains all nodes.
86 * *current_block A pointer to the current block. Any node created with
87 * one of the node constructors (new_<opcode>) are assigned
88 * to this block. It can be set with set_cur_block(block).
89 * Only needed for ir construction.
91 * params/n_loc An int giving the number of local variables in this
92 * procedure. This is needed for ir construction. Name will
95 * *value_table This hash table (pset) is used for global value numbering
96 * for optimizing use in iropt.c.
98 * *Phi_in_stack; a stack needed for automatic Phi construction, needed only
99 * during ir construction.
101 * visited A int used as flag to traverse the ir_graph.
103 * block_visited A int used as a flag to traverse block nodes in the graph.
106 /** Global variable holding the current ir graph.
108 * This global variable is used by the ir construction
109 * interface in ircons and by the optimizations.
110 * Further it is set by all walker functions.
112 extern ir_graph *current_ir_graph;
114 ir_graph *get_current_ir_graph(void);
115 void set_current_ir_graph(ir_graph *graph);
117 /** This flag indicate the current view. The behavior of some methods
118 * (get_irn_*, set_irn_*) is influenced by this flag. */
119 int get_interprocedural_view(void);
120 void set_interprocedural_view(int state);
123 * Create a new ir graph to build ir for a procedure.
125 * @param ent A pointer to an entity representing the procedure,
126 * i.e., the type of the entity must be of a method type.
128 * @param n_loc The number of local variables in this procedure including
129 * the procedure parameters.
131 * This constructor generates the basic infrastructure needed to
132 * represent a procedure in FIRM.
134 * It allocates an ir_graph and sets the field irg of the entity ent
135 * as well as current_ir_graph to point to this graph.
136 * Further it allocates the following nodes needed for every
139 * - The start block containing a start node and Proj nodes for it's
140 * five results (X, M, P, P, T).
141 * - The end block containing an end node. This block is not matured
142 * after executing new_ir_graph() as predecessors need to be added to it.
143 * (Maturing a block means fixing it's number of predecessors.)
144 * - The current block, which is empty and also not matured.
146 * Further it enters the global store into the data structure of the start
147 * block that contains all valid values in this block (set_store()). This
148 * data structure is used to build the Phi nodes and removed after
149 * completion of the graph. There is no path from end to start in the
150 * graph after calling ir_graph.
152 * The op_pin_state of the graph is set to "op_pin_state_pinned"
153 * if no global cse was performed on the graph.
154 * It is set to "op_pin_state_floats" if global cse was performed
155 * (and during construction: did actually change something).
156 * Code placement is necessary.
158 * @see new_pseudo_ir_graph()
160 ir_graph *new_ir_graph (entity *ent, int n_loc);
162 /** Frees the passed irgraph.
163 * Deallocates all nodes in this graph and the ir_graph structure.
164 * Sets the field irgraph in the corresponding entity to NULL.
165 * Does not remove the irgraph from the list in irprog (requires
166 * inefficient search, call remove_irp_irg by hand).
167 * Does not free types, entities or modes that are used only by this
168 * graph, nor the entity standing for this graph.
170 void free_ir_graph (ir_graph *irg);
172 /* --- access routines for all ir_graph attributes --- */
175 * Checks whether a pointer points to a ir graph.
177 * @param thing an arbitrary pointer
180 * true if the thing is a ir graph, else false
182 int is_ir_graph(const void *thing);
184 /* #define get_irg_entity get_irg_ent */
185 /* #define set_irg_entity set_irg_ent */
186 entity *get_irg_entity (const ir_graph *irg);
187 void set_irg_entity (ir_graph *irg, entity *ent);
189 ir_type *get_irg_frame_type (ir_graph *irg);
190 void set_irg_frame_type (ir_graph *irg, ir_type *ftp);
192 ir_node *get_irg_start_block (const ir_graph *irg);
193 void set_irg_start_block (ir_graph *irg, ir_node *node);
195 ir_node *get_irg_start (const ir_graph *irg);
196 void set_irg_start (ir_graph *irg, ir_node *node);
198 ir_node *get_irg_end_block (const ir_graph *irg);
199 void set_irg_end_block (ir_graph *irg, ir_node *node);
201 ir_node *get_irg_end (const ir_graph *irg);
202 void set_irg_end (ir_graph *irg, ir_node *node);
204 /* The fields end_reg and end_except contain the end nodes of the
205 interprocedural view. If the view is not constructed they contain
206 the normal end node. */
207 ir_node *get_irg_end_reg (const ir_graph *irg);
208 void set_irg_end_reg (ir_graph *irg, ir_node *node);
210 ir_node *get_irg_end_except (const ir_graph *irg);
211 void set_irg_end_except (ir_graph *irg, ir_node *node);
213 /** Returns the node that represents the frame pointer. */
214 ir_node *get_irg_frame (const ir_graph *irg);
215 /** Sets the node that represents the frame pointer. */
216 void set_irg_frame (ir_graph *irg, ir_node *node);
218 /** Returns the node that represents the global pointer. */
219 ir_node *get_irg_globals (const ir_graph *irg);
220 /** Sets the node that represents the global pointer. */
221 void set_irg_globals (ir_graph *irg, ir_node *node);
223 /** Returns the node that represents the initial memory. */
224 ir_node *get_irg_initial_mem (const ir_graph *irg);
225 /** Sets the node that represents the initial memory. */
226 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
228 /** Returns the node that represents the argument pointer. */
229 ir_node *get_irg_args (const ir_graph *irg);
230 /** Sets the node that represents the argument pointer. */
231 void set_irg_args (ir_graph *irg, ir_node *node);
233 /** Returns an array of the nodes of the argument pointer. */
234 ir_node **get_irg_proj_args (const ir_graph *irg);
235 /** Sets the array of the nodes of the argument pointer. */
236 void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
238 /** Returns the current block of a graph. */
239 ir_node *get_irg_current_block (const ir_graph *irg);
240 /** Sets the current block of a graph. */
241 void set_irg_current_block (ir_graph *irg, ir_node *node);
243 /** Returns the Bad node. Use new_Bad() instead!! */
244 ir_node *get_irg_bad (const ir_graph *irg);
245 void set_irg_bad (ir_graph *irg, ir_node *node);
247 /** Returns the NoMem node. Use new_NoMem() instead!! */
248 ir_node *get_irg_no_mem (const ir_graph *irg);
249 void set_irg_no_mem (ir_graph *irg, ir_node *node);
251 /** Returns the number of value numbers of a graph. */
252 int get_irg_n_locs (ir_graph *irg);
254 /** Returns the graph number. */
255 long get_irg_graph_nr(ir_graph *irg);
257 /********************************************************************************/
258 /* States of an ir_graph. */
259 /********************************************************************************/
262 information associated with the graph. Optimizations invalidate these
265 /** The states of an ir graph.
267 * state phase values: phase_building, phase_high, phase_low, phase_backend.
269 * The graph is in phase_building during construction of the irgraph.
270 * The construction is finished by a call to finalize_cons().
272 * Finalize_cons() sets the state to phase_high. All stadard Firm nodes are
275 * To get the irgraph into phase_low all Sel nodes must be removed and
276 * replaced by explicit address computations. SymConst size and
277 * type tag nodes must be removed (@@@ really?). Initialization of
278 * memory allocated by Alloc must be explicit. @@@ More conditions?
280 * phase_backend is set if architecture specific machine nodes are inserted
281 * (and probally most standard Firm are removed).
290 /** returns the phase_state of an IR graph. */
291 irg_phase_state get_irg_phase_state (const ir_graph *irg);
293 /** sets the phase state of an IR graph. */
294 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
296 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
298 /** state: op_pin_state_pinned
299 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
300 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
301 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
302 invalid block, i.e., the block is not a dominator of all the uses of
304 The enum op_pin_state is defined in irop.h. */
305 op_pin_state get_irg_pinned (const ir_graph *irg);
307 /** state: outs_state
308 * Outs are the back edges or def-use edges of ir nodes.
309 * Values: outs_none, outs_consistent, outs_inconsistent */
311 outs_none, /**< Outs are not computed, no memory is allocated. */
312 outs_consistent, /**< Outs are computed and correct. */
313 outs_inconsistent /**< Outs have been computed, memory is still allocated,
314 but the graph has been changed since. */
316 irg_outs_state get_irg_outs_state(const ir_graph *irg);
317 void set_irg_outs_inconsistent(ir_graph *irg);
319 /** state: extended basic block state. */
321 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
322 extblk_valid = 1, /**< Extended basic block information is valid. */
323 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
325 irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
326 void set_irg_extblk_inconsistent(ir_graph *irg);
329 * Signals the state of the dominator / post dominator information.
332 dom_none, /**< dominator are not computed, no memory is allocated */
333 dom_consistent, /**< dominator information is computed and correct */
334 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
337 /** returns the dominator state of an IR graph. */
338 irg_dom_state get_irg_dom_state(const ir_graph *irg);
340 /** returns the post dominator state of an IR graph. */
341 irg_dom_state get_irg_postdom_state(const ir_graph *irg);
343 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
344 void set_irg_doms_inconsistent(ir_graph *irg);
346 /** state: loopinfo_state
347 * Loop information describes the loops within the control and
348 * data flow of the procedure.
351 loopinfo_none = 0, /**< No loop information is constructed. Default. */
352 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
353 loopinfo_valid = 2, /**< Loop information is valid. */
354 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
355 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
357 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
358 are used in a switch. */
360 /** IntRAprocedural loop information constructed and valid. */
361 loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
362 /** IntRAprocedural loop information constructed and invalid. */
363 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
365 /** IntERprocedural loop information constructed and valid. */
366 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
367 /** IntERprocedural loop information constructed and invalid. */
368 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
370 /** IntRAprocedural control loop information constructed and valid. */
371 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
372 /** IntRAprocedural control loop information constructed and invalid. */
373 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
375 /** IntERprocedural control loop information constructed and valid. */
376 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
377 /** IntERprocedural control loop information constructed and invalid. */
378 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
379 } irg_loopinfo_state;
381 /** Return the current loop information state. */
382 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
384 /** Sets the current loop information state. */
385 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
387 /** Sets the loop information state to the appropriate inconsistent state.
388 * If state is 'none' does not change. */
389 void set_irg_loopinfo_inconsistent(ir_graph *irg);
390 /** Sets the loop information state to the appropriate inconsistent state.
391 * If state is 'none' does not change.
392 * Does this for all irgs. */
393 void set_irp_loopinfo_inconsistent(void);
395 /** state: callee_information_state
396 * Call nodes contain a list of possible callees. This list must be
397 * computed by an analysis.
399 * It's strange that this state is administered on irg basis, as the
400 * information must be computed for the whole program, or not?
403 irg_callee_info_none,
404 irg_callee_info_consistent,
405 irg_callee_info_inconsistent
406 } irg_callee_info_state;
408 /** returns the callee_info_state of an IR graph. */
409 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
411 /** sets the callee_info_state of an IR graph. */
412 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
415 * Tells how to handle an ir graph in inlineing.
418 irg_inline_any, /**< No restriction on inlineing. Default. */
419 irg_inline_forbidden, /**< The graph may not be inlined. */
420 irg_inline_recomended, /**< The graph should be inlined. */
421 irg_inline_forced /**< The graph must be inlined. */
422 } irg_inline_property;
424 /** Returns the inline property of a graph. */
425 irg_inline_property get_irg_inline_property(const ir_graph *irg);
426 /** Sets the inline property of a graph. */
427 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
430 * Returns the mask of the additional graph properties.
431 * The properties are automatically inherited from the method type
432 * if they were not set using set_irg_additional_properties() or
433 * set_irg_additional_property().
435 unsigned get_irg_additional_properties(const ir_graph *irg);
437 /** Sets the mask of the additional graph properties. */
438 void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
440 /** Sets one additional graph property. */
441 void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
443 /** A void * field to link arbitrary information to the node. */
444 void set_irg_link (ir_graph *irg, void *thing);
445 void *get_irg_link (const ir_graph *irg);
447 /** Increments visited flag by one.
448 * @see also: get_irn_visited() get_irg_block_visited(). */
449 void inc_irg_visited (ir_graph *irg);
450 unsigned long get_irg_visited (const ir_graph *irg);
451 void set_irg_visited (ir_graph *irg, unsigned long i);
452 /** An interprocedural flag valid for all irgs.
453 * @see also: get_irn_visited() get_irg_block_visited(). */
454 unsigned long get_max_irg_visited (void);
455 void set_max_irg_visited (int val);
456 unsigned long inc_max_irg_visited (void);
458 /** Increments block_visited by one.
459 * @see also: get_irn_visited() get_irg_block_visited(). */
460 void inc_irg_block_visited (ir_graph *irg);
461 unsigned long get_irg_block_visited (const ir_graph *irg);
462 void set_irg_block_visited (ir_graph *irg, unsigned long i);
464 /** move Proj nodes into the same block as its predecessors */
465 void normalize_proj_nodes(ir_graph *irg);
467 /** set a description for local value n */
468 void set_irg_loc_description(ir_graph *irg, int n, void *description);
470 /** get the description for local value n */
471 void *get_irg_loc_description(ir_graph *irg, int n);
473 /** Returns a estimated node count of the irg. This count is updated
474 * after every irg_walk_graph().
476 unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
478 /** Returns the last irn index for this graph. */
479 unsigned get_irg_last_idx(const ir_graph *irg);
482 * Access custom graph data.
483 * The data must have been registered with
484 * register_additional_graph_data() before.
485 * @param graph The graph to get the data from.
486 * @param type The type of the data you registered.
487 * @param off The value returned by register_additional_graph_data().
488 * @return A pointer of type @p type.
490 #define get_irg_data(graph,type,off) \
491 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
494 * Get the pointer to the node some custom data belongs to.
495 * @param data The pointer to the custom data.
496 * @param off The number as returned by register_additional_graph_data().
497 * @return A pointer to the ir node the custom data belongs to.
499 #define get_irg_data_base(data,off) \
500 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
503 * Request additional data to be allocated with an ir graph.
504 * @param size The size of the additional data required.
505 * @return A positive number, if the operation was successful, which
506 * must be passed to the access macro get_irg_data(), 0 if the
507 * registration failed.
509 size_t register_additional_graph_data(size_t size);
511 # endif /* _IRGRAPH_H_ */