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
20 #ifndef _FIRM_IR_IRGRAPH_H_
21 #define _FIRM_IR_IRGRAPH_H_
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 * *tls This models a pointer to a space in the memory where
71 * thread local things are held. Select from this pointer
72 * with a Sel node the pointer to a thread local variable.
74 * *args The ir_node that produces the arguments of the method as
75 * it's result. This is a Proj node on the fourth output of
76 * the start node. This output is tagged as pn_Start_T_args.
78 * *proj_args The proj nodes of the args node.
80 * *bad The Bad node is an auxiliary node. It is needed only once,
81 * so there is this globally reachable node.
83 * *no_mem The NoMem node is an auxiliary node. It is needed only once,
84 * so there is this globally reachable node.
86 * Data structures that are private to a graph:
88 * *obst An obstack that contains all nodes.
90 * *current_block A pointer to the current block. Any node created with
91 * one of the node constructors (new_<opcode>) are assigned
92 * to this block. It can be set with set_cur_block(block).
93 * Only needed for ir construction.
95 * params/n_loc An int giving the number of local variables in this
96 * procedure. This is needed for ir construction. Name will
99 * *value_table This hash table (pset) is used for global value numbering
100 * for optimizing use in iropt.c.
102 * *Phi_in_stack; a stack needed for automatic Phi construction, needed only
103 * during ir construction.
105 * visited A int used as flag to traverse the ir_graph.
107 * block_visited A int used as a flag to traverse block nodes in the graph.
110 /** Global variable holding the current ir graph.
112 * This global variable is used by the ir construction
113 * interface in ircons and by the optimizations.
114 * Further it is set by all walker functions.
116 extern ir_graph *current_ir_graph;
118 ir_graph *get_current_ir_graph(void);
119 void set_current_ir_graph(ir_graph *graph);
121 /** This flag indicate the current view. The behavior of some methods
122 * (get_irn_*, set_irn_*) is influenced by this flag. */
123 int get_interprocedural_view(void);
124 void set_interprocedural_view(int state);
127 * Create a new ir graph to build ir for a procedure.
129 * @param ent A pointer to an entity representing the procedure,
130 * i.e., the type of the entity must be of a method type.
132 * @param n_loc The number of local variables in this procedure including
133 * the procedure parameters.
135 * This constructor generates the basic infrastructure needed to
136 * represent a procedure in FIRM.
138 * It allocates an ir_graph and sets the field irg of the entity ent
139 * as well as current_ir_graph to point to this graph.
140 * Further it allocates the following nodes needed for every
143 * - The start block containing a start node and Proj nodes for it's
144 * seven results (X, M, P, P, P, T, P).
145 * - The end block containing an end node. This block is not matured
146 * after executing new_ir_graph() as predecessors need to be added to it.
147 * (Maturing a block means fixing it's number of predecessors.)
148 * - The current block, which is empty and also not matured.
150 * Further it enters the global store into the data structure of the start
151 * block that contains all valid values in this block (set_store()). This
152 * data structure is used to build the Phi nodes and removed after
153 * completion of the graph. There is no path from end to start in the
154 * graph after calling ir_graph.
156 * The op_pin_state of the graph is set to "op_pin_state_pinned"
157 * if no global cse was performed on the graph.
158 * It is set to "op_pin_state_floats" if global cse was performed
159 * (and during construction: did actually change something).
160 * Code placement is necessary.
162 * @see new_pseudo_ir_graph()
164 ir_graph *new_ir_graph (entity *ent, int n_loc);
166 /** Frees the passed irgraph.
167 * Deallocates all nodes in this graph and the ir_graph structure.
168 * Sets the field irgraph in the corresponding entity to NULL.
169 * Does not remove the irgraph from the list in irprog (requires
170 * inefficient search, call remove_irp_irg by hand).
171 * Does not free types, entities or modes that are used only by this
172 * graph, nor the entity standing for this graph.
174 void free_ir_graph (ir_graph *irg);
176 /* --- access routines for all ir_graph attributes --- */
179 * Checks whether a pointer points to a ir graph.
181 * @param thing an arbitrary pointer
184 * true if the thing is a ir graph, else false
186 int is_ir_graph(const void *thing);
188 /* #define get_irg_entity get_irg_ent */
189 /* #define set_irg_entity set_irg_ent */
190 entity *get_irg_entity (const ir_graph *irg);
191 void set_irg_entity (ir_graph *irg, entity *ent);
193 ir_type *get_irg_frame_type (ir_graph *irg);
194 void set_irg_frame_type (ir_graph *irg, ir_type *ftp);
196 ir_node *get_irg_start_block (const ir_graph *irg);
197 void set_irg_start_block (ir_graph *irg, ir_node *node);
199 ir_node *get_irg_start (const ir_graph *irg);
200 void set_irg_start (ir_graph *irg, ir_node *node);
202 ir_node *get_irg_end_block (const ir_graph *irg);
203 void set_irg_end_block (ir_graph *irg, ir_node *node);
205 ir_node *get_irg_end (const ir_graph *irg);
206 void set_irg_end (ir_graph *irg, ir_node *node);
208 /* The fields end_reg and end_except contain the end nodes of the
209 interprocedural view. If the view is not constructed they contain
210 the normal end node. */
211 ir_node *get_irg_end_reg (const ir_graph *irg);
212 void set_irg_end_reg (ir_graph *irg, ir_node *node);
214 ir_node *get_irg_end_except (const ir_graph *irg);
215 void set_irg_end_except (ir_graph *irg, ir_node *node);
217 /** Returns the node that represents the frame pointer. */
218 ir_node *get_irg_frame (const ir_graph *irg);
219 /** Sets the node that represents the frame pointer. */
220 void set_irg_frame (ir_graph *irg, ir_node *node);
222 /** Returns the node that represents the global pointer. */
223 ir_node *get_irg_globals (const ir_graph *irg);
224 /** Sets the node that represents the global pointer. */
225 void set_irg_globals (ir_graph *irg, ir_node *node);
227 /** Returns the node that represents the tls pointer. */
228 ir_node *get_irg_tls (const ir_graph *irg);
229 /** Sets the node that represents the tls pointer. */
230 void set_irg_tls (ir_graph *irg, ir_node *node);
232 /** Returns the node that represents the initial memory. */
233 ir_node *get_irg_initial_mem (const ir_graph *irg);
234 /** Sets the node that represents the initial memory. */
235 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
237 /** Returns the node that represents the argument pointer. */
238 ir_node *get_irg_args (const ir_graph *irg);
239 /** Sets the node that represents the argument pointer. */
240 void set_irg_args (ir_graph *irg, ir_node *node);
242 /** Returns an array of the nodes of the argument pointer. */
243 ir_node **get_irg_proj_args (const ir_graph *irg);
244 /** Sets the array of the nodes of the argument pointer. */
245 void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
247 /** Returns the current block of a graph. */
248 ir_node *get_irg_current_block (const ir_graph *irg);
249 /** Sets the current block of a graph. */
250 void set_irg_current_block (ir_graph *irg, ir_node *node);
252 /** Returns the Bad node. Use new_Bad() instead!! */
253 ir_node *get_irg_bad (const ir_graph *irg);
254 void set_irg_bad (ir_graph *irg, ir_node *node);
256 /** Returns the NoMem node. Use new_NoMem() instead!! */
257 ir_node *get_irg_no_mem (const ir_graph *irg);
258 void set_irg_no_mem (ir_graph *irg, ir_node *node);
260 /** Returns the number of value numbers of a graph. */
261 int get_irg_n_locs (ir_graph *irg);
263 /** Returns the graph number. */
264 long get_irg_graph_nr(ir_graph *irg);
266 /********************************************************************************/
267 /* States of an ir_graph. */
268 /********************************************************************************/
271 information associated with the graph. Optimizations invalidate these
274 /** The states of an ir graph.
276 * state phase values: phase_building, phase_high, phase_low, phase_backend.
278 * The graph is in phase_building during construction of the irgraph.
279 * The construction is finished by a call to finalize_cons().
281 * Finalize_cons() sets the state to phase_high. All stadard Firm nodes are
284 * To get the irgraph into phase_low all Sel nodes must be removed and
285 * replaced by explicit address computations. SymConst size and
286 * type tag nodes must be removed (@@@ really?). Initialization of
287 * memory allocated by Alloc must be explicit. @@@ More conditions?
289 * phase_backend is set if architecture specific machine nodes are inserted
290 * (and probally most standard Firm are removed).
299 /** returns the phase_state of an IR graph. */
300 irg_phase_state get_irg_phase_state (const ir_graph *irg);
302 /** sets the phase state of an IR graph. */
303 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
305 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
307 /** state: op_pin_state_pinned
308 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
309 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
310 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
311 invalid block, i.e., the block is not a dominator of all the uses of
313 The enum op_pin_state is defined in irop.h. */
314 op_pin_state get_irg_pinned (const ir_graph *irg);
316 /** state: outs_state
317 * Outs are the back edges or def-use edges of ir nodes.
318 * Values: outs_none, outs_consistent, outs_inconsistent */
320 outs_none, /**< Outs are not computed, no memory is allocated. */
321 outs_consistent, /**< Outs are computed and correct. */
322 outs_inconsistent /**< Outs have been computed, memory is still allocated,
323 but the graph has been changed since. */
325 irg_outs_state get_irg_outs_state(const ir_graph *irg);
326 void set_irg_outs_inconsistent(ir_graph *irg);
328 /** state: extended basic block state. */
330 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
331 extblk_valid = 1, /**< Extended basic block information is valid. */
332 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
334 irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
335 void set_irg_extblk_inconsistent(ir_graph *irg);
338 * Signals the state of the dominator / post dominator information.
341 dom_none, /**< dominator are not computed, no memory is allocated */
342 dom_consistent, /**< dominator information is computed and correct */
343 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
346 /** returns the dominator state of an IR graph. */
347 irg_dom_state get_irg_dom_state(const ir_graph *irg);
349 /** returns the post dominator state of an IR graph. */
350 irg_dom_state get_irg_postdom_state(const ir_graph *irg);
352 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
353 void set_irg_doms_inconsistent(ir_graph *irg);
355 /** state: loopinfo_state
356 * Loop information describes the loops within the control and
357 * data flow of the procedure.
360 loopinfo_none = 0, /**< No loop information is constructed. Default. */
361 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
362 loopinfo_valid = 2, /**< Loop information is valid. */
363 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
364 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
366 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
367 are used in a switch. */
369 /** IntRAprocedural loop information constructed and valid. */
370 loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
371 /** IntRAprocedural loop information constructed and invalid. */
372 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
374 /** IntERprocedural loop information constructed and valid. */
375 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
376 /** IntERprocedural loop information constructed and invalid. */
377 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
379 /** IntRAprocedural control loop information constructed and valid. */
380 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
381 /** IntRAprocedural control loop information constructed and invalid. */
382 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
384 /** IntERprocedural control loop information constructed and valid. */
385 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
386 /** IntERprocedural control loop information constructed and invalid. */
387 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
388 } irg_loopinfo_state;
390 /** Return the current loop information state. */
391 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
393 /** Sets the current loop information state. */
394 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
396 /** Sets the loop information state to the appropriate inconsistent state.
397 * If state is 'none' does not change. */
398 void set_irg_loopinfo_inconsistent(ir_graph *irg);
399 /** Sets the loop information state to the appropriate inconsistent state.
400 * If state is 'none' does not change.
401 * Does this for all irgs. */
402 void set_irp_loopinfo_inconsistent(void);
404 /** state: callee_information_state
405 * Call nodes contain a list of possible callees. This list must be
406 * computed by an analysis.
408 * It's strange that this state is administered on irg basis, as the
409 * information must be computed for the whole program, or not?
412 irg_callee_info_none,
413 irg_callee_info_consistent,
414 irg_callee_info_inconsistent
415 } irg_callee_info_state;
417 /** returns the callee_info_state of an IR graph. */
418 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
420 /** sets the callee_info_state of an IR graph. */
421 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
424 * Tells how to handle an ir graph in inlineing.
427 irg_inline_any, /**< No restriction on inlineing. Default. */
428 irg_inline_forbidden, /**< The graph may not be inlined. */
429 irg_inline_recomended, /**< The graph should be inlined. */
430 irg_inline_forced /**< The graph must be inlined. */
431 } irg_inline_property;
433 /** Returns the inline property of a graph. */
434 irg_inline_property get_irg_inline_property(const ir_graph *irg);
435 /** Sets the inline property of a graph. */
436 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
439 * Returns the mask of the additional graph properties.
440 * The properties are automatically inherited from the method type
441 * if they were not set using set_irg_additional_properties() or
442 * set_irg_additional_property().
444 unsigned get_irg_additional_properties(const ir_graph *irg);
446 /** Sets the mask of the additional graph properties. */
447 void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
449 /** Sets one additional graph property. */
450 void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
452 /** A void * field to link arbitrary information to the node. */
453 void set_irg_link (ir_graph *irg, void *thing);
454 void *get_irg_link (const ir_graph *irg);
456 /** Increments visited flag by one.
457 * @see also: get_irn_visited() get_irg_block_visited(). */
458 void inc_irg_visited (ir_graph *irg);
459 unsigned long get_irg_visited (const ir_graph *irg);
460 void set_irg_visited (ir_graph *irg, unsigned long i);
461 /** An interprocedural flag valid for all irgs.
462 * @see also: get_irn_visited() get_irg_block_visited(). */
463 unsigned long get_max_irg_visited (void);
464 void set_max_irg_visited (int val);
465 unsigned long inc_max_irg_visited (void);
467 /** Increments block_visited by one.
468 * @see also: get_irn_visited() get_irg_block_visited(). */
469 void inc_irg_block_visited (ir_graph *irg);
470 unsigned long get_irg_block_visited (const ir_graph *irg);
471 void set_irg_block_visited (ir_graph *irg, unsigned long i);
473 /** move Proj nodes into the same block as its predecessors */
474 void normalize_proj_nodes(ir_graph *irg);
476 /** set a description for local value n */
477 void set_irg_loc_description(ir_graph *irg, int n, void *description);
479 /** get the description for local value n */
480 void *get_irg_loc_description(ir_graph *irg, int n);
482 /** Returns a estimated node count of the irg. This count is updated
483 * after every irg_walk_graph().
485 unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
487 /** Returns the last irn index for this graph. */
488 unsigned get_irg_last_idx(const ir_graph *irg);
491 * Access custom graph data.
492 * The data must have been registered with
493 * register_additional_graph_data() before.
494 * @param graph The graph to get the data from.
495 * @param type The type of the data you registered.
496 * @param off The value returned by register_additional_graph_data().
497 * @return A pointer of type @p type.
499 #define get_irg_data(graph,type,off) \
500 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
503 * Get the pointer to the node some custom data belongs to.
504 * @param data The pointer to the custom data.
505 * @param off The number as returned by register_additional_graph_data().
506 * @return A pointer to the ir node the custom data belongs to.
508 #define get_irg_data_base(data,off) \
509 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
512 * Request additional data to be allocated with an ir graph.
513 * @param size The size of the additional data required.
514 * @return A positive number, if the operation was successful, which
515 * must be passed to the access macro get_irg_data(), 0 if the
516 * registration failed.
518 size_t register_additional_graph_data(size_t size);
520 #endif /* _FIRM_IR_IRGRAPH_H_ */