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 * *proj_args The proj nodes off the args node.
87 * *bad The Bad node is an auxiliary node. It is needed only once,
88 * so there is this globally reachable node.
90 * *no_mem The NoMem node is an auxiliary node. It is needed only once,
91 * so there is this globally reachable node.
93 * Datastructures that are private to a graph:
95 * *obst An obstack that contains all nodes.
97 * *current_block A pointer to the current block. Any node created with
98 * one of the node constructors (new_<opcode>) are assigned
99 * to this block. It can be set with set_cur_block(block).
100 * Only needed for ir construction.
102 * params/n_loc An int giving the number of local variables in this
103 * procedure. This is neede for ir construction. Name will
106 * *value_table This hash table (pset) is used for global value numbering
107 * for optimizing use in iropt.c.
109 * *Phi_in_stack; a stack needed for automatic Phi construction, needed only
110 * during ir construction.
112 * visited A int used as flag to traverse the ir_graph.
114 * block_visited A int used as a flag to traverse block nodes in the graph.
117 /** Global variable holding the current ir graph.
119 * This global variable is used by the ir construction
120 * interface in ircons and by the optimizations.
121 * Further it is set by all walker functions.
123 extern ir_graph *current_ir_graph;
125 ir_graph *get_current_ir_graph(void);
126 void set_current_ir_graph(ir_graph *graph);
128 /** This flag indicate the current view. The behaviour of some methods
129 * (get_irn_*, set_irn_*) is influenced by this flag. */
130 int get_interprocedural_view(void);
131 void set_interprocedural_view(int state);
134 * Create a new ir graph to build ir for a procedure.
136 * @param ent A pointer to an entity representing the procedure,
137 * i.e., the type of the entity must be of a method type.
139 * @param n_loc The number of local variables in this procedure including
140 * the procedure parameters.
142 * This constructor generates the basic infrastructure needed to
143 * represent a procedure in FIRM.
145 * It allocates an ir_graph and sets the field irg of the entity ent
146 * as well as current_ir_graph to point to this graph.
147 * Further it allocates the following nodes needed for every
150 * - The start block containing a start node and Proj nodes for it's
151 * five results (X, M, P, P, T).
152 * - The end block containing an end node. This block is not matured
153 * after executing new_ir_graph as predecessors need to be added to it.
154 * (Maturing a block means fixing it's number of predecessors.)
155 * - The current block, which is empty and also not matured.
157 * Further it enters the global store into the datastructure of the start
158 * block that contanis all valid values in this block (set_store()). This
159 * datastructure is used to build the Phi nodes and removed after
160 * completion of the graph. There is no path from end to start in the
161 * graph after calling ir_graph.
163 * The op_pin_state of the graph is set to "op_pin_state_pinned"
164 * if no global cse was performed on the graph.
165 * It is set to "op_pin_state_floats" if global cse was performed
166 * (and during construction: did actually change something).
167 * Code placement is necessary.
169 * @see new_pseudo_ir_graph()
171 ir_graph *new_ir_graph (entity *ent, int n_loc);
173 /** Frees the passed irgraph.
174 * Deallocates all nodes in this graph and the ir_graph structure.
175 * Sets the field irgraph in the corresponding entity to NULL.
176 * Does not remove the irgraph from the list in irprog (requires
177 * inefficient search, call remove_irp_irg by hand).
178 * Does not free types, entities or modes that are used only by this
179 * graph, nor the entity standing for this graph.
181 void free_ir_graph (ir_graph *irg);
183 /* --- access routines for all ir_graph attributes --- */
186 * Checks whether a pointer points to a ir graph.
188 * @param thing an arbitrary pointer
191 * true if the thing is a ir graph, else false
193 int is_ir_graph(const void *thing);
195 /* #define get_irg_entity get_irg_ent */
196 /* #define set_irg_entity set_irg_ent */
197 entity *get_irg_entity (const ir_graph *irg);
198 void set_irg_entity (ir_graph *irg, entity *ent);
200 type *get_irg_frame_type (const ir_graph *irg);
201 void set_irg_frame_type (ir_graph *irg, type *ftp);
202 /* To test for a frame type. O(#irgs) if ftp is class type. */
203 int is_frame_type (const type *ftp);
205 ir_node *get_irg_start_block (const ir_graph *irg);
206 void set_irg_start_block (ir_graph *irg, ir_node *node);
208 ir_node *get_irg_start (const ir_graph *irg);
209 void set_irg_start (ir_graph *irg, ir_node *node);
211 ir_node *get_irg_end_block (const ir_graph *irg);
212 void set_irg_end_block (ir_graph *irg, ir_node *node);
214 ir_node *get_irg_end (const ir_graph *irg);
215 void set_irg_end (ir_graph *irg, ir_node *node);
217 /* The fields end_reg and end_except contain the end nodes of the
218 interprocedural view. If the view is not constructed they contain
219 the nomal end node. */
220 ir_node *get_irg_end_reg (const ir_graph *irg);
221 void set_irg_end_reg (ir_graph *irg, ir_node *node);
223 ir_node *get_irg_end_except (const ir_graph *irg);
224 void set_irg_end_except (ir_graph *irg, ir_node *node);
227 /* @@@ oblivious, no more supported. */
228 ir_node *get_irg_cstore (const ir_graph *irg);
229 void set_irg_cstore (ir_graph *irg, ir_node *node);
232 /** Returns the node that represents the frame pointer. */
233 ir_node *get_irg_frame (const ir_graph *irg);
234 /** Sets the node that represents the frame pointer. */
235 void set_irg_frame (ir_graph *irg, ir_node *node);
237 /** Returns the node that represents the global pointer. */
238 ir_node *get_irg_globals (const ir_graph *irg);
239 /** Sets the node that represents the global pointer. */
240 void set_irg_globals (ir_graph *irg, ir_node *node);
242 /** Returns the node that represents the initial memory. */
243 ir_node *get_irg_initial_mem (const ir_graph *irg);
244 /** Sets the node that represents the initial memory. */
245 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
247 /** Returns the node that represents the argument pointer. */
248 ir_node *get_irg_args (const ir_graph *irg);
249 /** Sets the node that represents the argument pointer. */
250 void set_irg_args (ir_graph *irg, ir_node *node);
252 /** Returns an array of the nodes off the argument pointer. */
253 ir_node **get_irg_proj_args (const ir_graph *irg);
254 /** Sets the array of the nodes off the argument pointer. */
255 void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
257 /** Returns the current block of a graph. */
258 ir_node *get_irg_current_block (const ir_graph *irg);
259 /** Sets the current block of a graph. */
260 void set_irg_current_block (ir_graph *irg, ir_node *node);
262 /** Returns the Bad node. Use new_Bad() instead!! */
263 ir_node *get_irg_bad (const ir_graph *irg);
264 void set_irg_bad (ir_graph *irg, ir_node *node);
266 /** Returns the NoMem node. Use new_NoMem() instead!! */
267 ir_node *get_irg_no_mem (const ir_graph *irg);
268 void set_irg_no_mem (ir_graph *irg, ir_node *node);
270 /** Returns the number of value numbers of a graph. */
271 int get_irg_n_locs (ir_graph *irg);
273 /** Returns the graph number. */
274 long get_irg_graph_nr(ir_graph *irg);
276 /********************************************************************************/
277 /* States of an ir_graph. */
278 /********************************************************************************/
281 information associated with the graph. Optimizations invalidate these
284 /** The states of an ir graph.
286 * state phase values: phase_building, phase_high, phase_low.
288 * The graph is in phase_building during construction of the irgraph.
289 * The construction is finished by a call to finalize_cons().
291 * Finalize_cons() sets the state to phase_high. All Firm nodes are
294 * To get the irgraph into phase_low all Sel nodes must be removed and
295 * replaced by explicit address computations. SymConst size and
296 * typetag nodes must be removed (@@@ really?). Initialization of
297 * memory allocated by Alloc must be explicit. @@@ More conditions?
306 /** returns the phase_state of an IR graph. */
307 irg_phase_state get_irg_phase_state (const ir_graph *irg);
309 /** sets the phase state of an IR graph. */
310 void set_irg_phase_low(ir_graph *irg);
312 /** state: op_pin_state_pinned
313 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
314 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
315 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
316 invalid block, i.e., the block is not a dominator of all the uses of
318 The enum op_pin_state is defined in irop.h. */
319 op_pin_state get_irg_pinned (const ir_graph *irg);
321 /** state: outs_state
322 * Outs are the back edges or def-use edges of ir nodes.
323 * 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. */
330 irg_outs_state get_irg_outs_state(const ir_graph *irg);
331 void set_irg_outs_inconsistent(ir_graph *irg);
334 Signals the state of the dominator infomation.
335 Values: dom_none, dom_consistent, dom_inconsistent
336 dom_none: doms are not computed, no memory is allocated. The access routines
338 dom_consistent: dominator information is computed and correct,
339 dom_inconsistent: dominator information is computed, memory is still allocated,
340 but the graph has been changed since. Using the access routines is possible,
341 obtained information may be incorrect. */
343 dom_none, /**< doms are not computed, no memory is allocated */
344 dom_consistent, /**< dominator information is computed and correct */
345 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
348 /** returns the dom_state of an IR graph. */
349 irg_dom_state get_irg_dom_state(const ir_graph *irg);
351 /** sets the dom_state of an IR graph. */
352 void set_irg_dom_inconsistent(ir_graph *irg);
354 /** state: loopinfo_state
355 Loop information describes the loops within the control and
356 data flow of the procedure. */
358 loopinfo_none = 0, /**< No loop information is constructed. Default. */
359 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
360 loopinfo_valid = 2, /**< Loop information is valid. */
361 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
362 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
364 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
365 are used in a switch. */
367 /** IntRAprocedural loop information constructed and valid. */
368 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
369 /** IntRAprocedural loop information constructed and invalid. */
370 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
372 /** IntERprocedural loop information constructed and valid. */
373 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
374 /** IntERprocedural loop information constructed and invalid. */
375 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
377 /** IntRAprocedural control loop information constructed and valid. */
378 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
379 /** IntRAprocedural control loop information constructed and invalid. */
380 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
382 /** IntERprocedural control loop information constructed and valid. */
383 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
384 /** IntERprocedural control loop information constructed and invalid. */
385 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
386 } irg_loopinfo_state;
388 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
389 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
390 /** Sets the loopinformation state to the appropriate inconsistent state.
391 If state is 'none' does not change. */
392 void set_irg_loopinfo_inconsistent(ir_graph *irg);
394 /** state: callee_information_state
395 * Call nodes contain a list of possible callees. This list must be
396 * computed by an analysis.
398 * It's strange that this state is administered on irg basis, as the
399 * information must be computed for the whole program, or not?
402 irg_callee_info_none,
403 irg_callee_info_consistent,
404 irg_callee_info_inconsistent
405 } irg_callee_info_state;
407 /** returns the callee_info_state of an IR graph. */
408 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
410 /** sets the callee_info_state of an IR graph. */
411 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
414 * Tells how to handle an ir graph in inlineing.
417 irg_inline_any, /**< No restriction on inlineing. Default. */
418 irg_inline_forbidden, /**< The graph may not be inlined. */
419 irg_inline_recomended, /**< The graph should be inlined. */
420 irg_inline_forced /**< The graph must be inlined. */
421 } irg_inline_property;
423 /** Returns the inline property of a graph. */
424 irg_inline_property get_irg_inline_property(const ir_graph *irg);
425 /** Sets the inline property of a graph. */
426 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
428 /** A void * field to link arbitrary information to the node. */
429 void set_irg_link (ir_graph *irg, void *thing);
430 void *get_irg_link (const ir_graph *irg);
432 /** Increments visited flag by one.
433 * @see also: get_irn_visited() get_irg_block_visited(). */
434 void inc_irg_visited (ir_graph *irg);
435 unsigned long get_irg_visited (const ir_graph *irg);
436 void set_irg_visited (ir_graph *irg, unsigned long i);
437 /** An interprocedural flag valid for all irgs.
438 * @see also: get_irn_visited() get_irg_block_visited(). */
439 unsigned long get_max_irg_visited (void);
440 void set_max_irg_visited (int val);
441 unsigned long inc_max_irg_visited (void);
443 /** Increments block_visited by one.
444 * @see also: get_irn_visited() get_irg_block_visited(). */
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_ */