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"
32 * @page ir_graph The struct ir_graph
34 * This struct contains all information about a procedure.
35 * It's allocated directly to memory.
37 * The fields of ir_graph:
39 * - ent The entity describing this procedure.
41 * The beginning and end of a graph:
43 * - start_block This ir_node is the block that contains the unique
44 * start node of the procedure. With it it contains
45 * the Proj's on starts results.
46 * Further all Const nodes are placed in the start block.
47 * - start This ir_node is the unique start node of the procedure.
49 * - end_block This ir_node is the block that contains the unique
50 * end node of the procedure. This block contains no
52 * - end This ir_node is the unique end node of the procedure.
54 * The following nodes are Projs from the Start node, held in ir_graph for
57 * - frame The ir_node producing the pointer to the stack frame of
58 * the procedure as output. This is the Proj node on the
59 * third output of the start node. This output of the start
60 * node is tagged as pns_frame_base. In FIRM most local
61 * variables are modeled as data flow edges. Static
62 * allocated arrays can not be represented as data flow
63 * edges. Therefore FIRM has to represent them in the stack
66 * - globals This models a pointer to a space in the memory where
67 * _all_ global things are held. Select from this pointer
68 * with a Sel node the pointer to a global variable /
69 * procedure / compiler known function... .
71 * - tls This models a pointer to a space in the memory where
72 * thread local things are held. Select from this pointer
73 * with a Sel node the pointer to a thread local variable.
75 * - args The ir_node that produces the arguments of the method as
76 * it's result. This is a Proj node on the fourth output of
77 * the start node. This output is tagged as pn_Start_T_args.
79 * - proj_args The proj nodes of the args node.
81 * - bad The Bad node is an auxiliary node. It is needed only once,
82 * so there is this globally reachable node.
84 * - no_mem The NoMem node is an auxiliary node. It is needed only once,
85 * so there is this globally reachable node.
87 * Data structures that are private to a graph:
89 * - obst An obstack that contains all nodes.
91 * - current_block A pointer to the current block. Any node created with
92 * one of the node constructors (new_<opcode>) are assigned
93 * to this block. It can be set with set_cur_block(block).
94 * Only needed for ir construction.
96 * - params/n_loc An int giving the number of local variables in this
97 * procedure. This is needed for ir construction. Name will
100 * - value_table This hash table (pset) is used for global value numbering
101 * for optimizing use in iropt.c.
103 * - Phi_in_stack; a stack needed for automatic Phi construction, needed only
104 * during ir construction.
106 * - isited A int used as flag to traverse the ir_graph.
108 * - block_visited A int used as a flag to traverse block nodes in the graph.
111 /** Global variable holding the current ir graph.
113 * This global variable is used by the ir construction
114 * interface in ircons and by the optimizations.
115 * Further it is set by all walker functions.
117 extern ir_graph *current_ir_graph;
119 ir_graph *get_current_ir_graph(void);
120 void set_current_ir_graph(ir_graph *graph);
122 /** This flag indicate the current view. The behavior of some methods
123 * (get_irn_*, set_irn_*) is influenced by this flag. */
124 int get_interprocedural_view(void);
125 void set_interprocedural_view(int state);
128 * Create a new ir graph to build ir for a procedure.
130 * @param ent A pointer to an entity representing the procedure,
131 * i.e., the type of the entity must be of a method type.
133 * @param n_loc The number of local variables in this procedure including
134 * the procedure parameters.
136 * This constructor generates the basic infrastructure needed to
137 * represent a procedure in FIRM.
139 * It allocates an ir_graph and sets the field irg of the entity ent
140 * as well as current_ir_graph to point to this graph.
141 * Further it allocates the following nodes needed for every
144 * - The start block containing a start node and Proj nodes for it's
145 * seven results (X, M, P, P, P, T, P).
146 * - The end block containing an end node. This block is not matured
147 * after executing new_ir_graph() as predecessors need to be added to it.
148 * (Maturing a block means fixing it's number of predecessors.)
149 * - The current block, which is empty and also not matured.
151 * Further it enters the global store into the data structure of the start
152 * block that contains all valid values in this block (set_store()). This
153 * data structure is used to build the Phi nodes and removed after
154 * completion of the graph. There is no path from end to start in the
155 * graph after calling ir_graph.
157 * The op_pin_state of the graph is set to "op_pin_state_pinned"
158 * if no global cse was performed on the graph.
159 * It is set to "op_pin_state_floats" if global cse was performed
160 * (and during construction: did actually change something).
161 * Code placement is necessary.
163 * @see new_pseudo_ir_graph()
165 ir_graph *new_ir_graph (ir_entity *ent, int n_loc);
167 /** Frees the passed irgraph.
168 * Deallocates all nodes in this graph and the ir_graph structure.
169 * Sets the field irgraph in the corresponding entity to NULL.
170 * Does not remove the irgraph from the list in irprog (requires
171 * inefficient search, call remove_irp_irg by hand).
172 * Does not free types, entities or modes that are used only by this
173 * graph, nor the entity standing for this graph.
175 void free_ir_graph (ir_graph *irg);
177 /* --- access routines for all ir_graph attributes --- */
180 * Checks whether a pointer points to a ir graph.
182 * @param thing an arbitrary pointer
185 * true if the thing is a ir graph, else false
187 int is_ir_graph(const void *thing);
189 /* #define get_irg_entity get_irg_ent */
190 /* #define set_irg_entity set_irg_ent */
191 ir_entity *get_irg_entity (const ir_graph *irg);
192 void set_irg_entity (ir_graph *irg, ir_entity *ent);
194 ir_type *get_irg_frame_type (ir_graph *irg);
195 void set_irg_frame_type (ir_graph *irg, ir_type *ftp);
197 ir_node *get_irg_start_block (const ir_graph *irg);
198 void set_irg_start_block (ir_graph *irg, ir_node *node);
200 ir_node *get_irg_start (const ir_graph *irg);
201 void set_irg_start (ir_graph *irg, ir_node *node);
203 ir_node *get_irg_end_block (const ir_graph *irg);
204 void set_irg_end_block (ir_graph *irg, ir_node *node);
206 ir_node *get_irg_end (const ir_graph *irg);
207 void set_irg_end (ir_graph *irg, ir_node *node);
209 /* The fields end_reg and end_except contain the end nodes of the
210 interprocedural view. If the view is not constructed they contain
211 the normal end node. */
212 ir_node *get_irg_end_reg (const ir_graph *irg);
213 void set_irg_end_reg (ir_graph *irg, ir_node *node);
215 ir_node *get_irg_end_except (const ir_graph *irg);
216 void set_irg_end_except (ir_graph *irg, ir_node *node);
218 /** Returns the node that represents the frame pointer. */
219 ir_node *get_irg_frame (const ir_graph *irg);
220 /** Sets the node that represents the frame pointer. */
221 void set_irg_frame (ir_graph *irg, ir_node *node);
223 /** Returns the node that represents the global pointer. */
224 ir_node *get_irg_globals (const ir_graph *irg);
225 /** Sets the node that represents the global pointer. */
226 void set_irg_globals (ir_graph *irg, ir_node *node);
228 /** Returns the node that represents the tls pointer. */
229 ir_node *get_irg_tls (const ir_graph *irg);
230 /** Sets the node that represents the tls pointer. */
231 void set_irg_tls (ir_graph *irg, ir_node *node);
233 /** Returns the node that represents the initial memory. */
234 ir_node *get_irg_initial_mem (const ir_graph *irg);
235 /** Sets the node that represents the initial memory. */
236 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
238 /** Returns the node that represents the argument pointer. */
239 ir_node *get_irg_args (const ir_graph *irg);
240 /** Sets the node that represents the argument pointer. */
241 void set_irg_args (ir_graph *irg, ir_node *node);
243 /** Returns the node that represents the value parameter base pointer. */
244 ir_node *get_irg_value_param_base (const ir_graph *irg);
245 /** Sets the node that represents the value parameter base pointer. */
246 void set_irg_value_param_base (ir_graph *irg, ir_node *node);
248 /** Returns an array of the nodes of the argument pointer. */
249 ir_node **get_irg_proj_args (const ir_graph *irg);
250 /** Sets the array of the nodes of the argument pointer. */
251 void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
253 /** Returns the current block of a graph. */
254 ir_node *get_irg_current_block (const ir_graph *irg);
255 /** Sets the current block of a graph. */
256 void set_irg_current_block (ir_graph *irg, ir_node *node);
258 /** Returns the Bad node. Use new_Bad() instead!! */
259 ir_node *get_irg_bad (const ir_graph *irg);
260 void set_irg_bad (ir_graph *irg, ir_node *node);
262 /** Returns the NoMem node. Use new_NoMem() instead!! */
263 ir_node *get_irg_no_mem (const ir_graph *irg);
264 void set_irg_no_mem (ir_graph *irg, ir_node *node);
266 /** Returns the number of value numbers of a graph. */
267 int get_irg_n_locs (ir_graph *irg);
269 /** Returns the graph number. */
270 long get_irg_graph_nr(ir_graph *irg);
272 /********************************************************************************/
273 /* States of an ir_graph. */
274 /********************************************************************************/
277 information associated with the graph. Optimizations invalidate these
280 /** The states of an ir graph.
282 * state phase values: phase_building, phase_high, phase_low, phase_backend.
284 * The graph is in phase_building during construction of the irgraph.
285 * The construction is finished by a call to finalize_cons().
287 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
290 * To get the irgraph into phase_low all Sel nodes must be removed and
291 * replaced by explicit address computations. SymConst size and
292 * type tag nodes must be removed (@@@ really?). Initialization of
293 * memory allocated by Alloc must be explicit. @@@ More conditions?
295 * phase_backend is set if architecture specific machine nodes are inserted
296 * (and probably most standard Firm are removed).
305 /** returns the phase_state of an IR graph. */
306 irg_phase_state get_irg_phase_state (const ir_graph *irg);
308 /** sets the phase state of an IR graph. */
309 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
311 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
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 of ir nodes.
324 * Values: outs_none, outs_consistent, outs_inconsistent */
326 outs_none, /**< Outs are not computed, no memory is allocated. */
327 outs_consistent, /**< Outs are computed and correct. */
328 outs_inconsistent /**< Outs have been computed, memory is still allocated,
329 but the graph has been changed since. */
331 irg_outs_state get_irg_outs_state(const ir_graph *irg);
332 void set_irg_outs_inconsistent(ir_graph *irg);
334 /** state: extended basic block state. */
336 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
337 extblk_valid = 1, /**< Extended basic block information is valid. */
338 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
340 irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
341 void set_irg_extblk_inconsistent(ir_graph *irg);
344 * Signals the state of the dominator / post dominator information.
347 dom_none, /**< dominator 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 dominator state of an IR graph. */
353 irg_dom_state get_irg_dom_state(const ir_graph *irg);
355 /** returns the post dominator state of an IR graph. */
356 irg_dom_state get_irg_postdom_state(const ir_graph *irg);
358 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
359 void set_irg_doms_inconsistent(ir_graph *irg);
361 /** state: loopinfo_state
362 * Loop information describes the loops within the control and
363 * data flow of the procedure.
366 loopinfo_none = 0, /**< No loop information is constructed. Default. */
367 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
368 loopinfo_valid = 2, /**< Loop information is valid. */
369 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
370 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
372 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
373 are used in a switch. */
375 /** IntRAprocedural loop information constructed and valid. */
376 loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
377 /** IntRAprocedural loop information constructed and invalid. */
378 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
380 /** IntERprocedural loop information constructed and valid. */
381 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
382 /** IntERprocedural loop information constructed and invalid. */
383 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
385 /** IntRAprocedural control loop information constructed and valid. */
386 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
387 /** IntRAprocedural control loop information constructed and invalid. */
388 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
390 /** IntERprocedural control loop information constructed and valid. */
391 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
392 /** IntERprocedural control loop information constructed and invalid. */
393 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
394 } irg_loopinfo_state;
396 /** Return the current loop information state. */
397 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
399 /** Sets the current loop information state. */
400 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
402 /** Sets the loop information state to the appropriate inconsistent state.
403 * If state is 'none' does not change. */
404 void set_irg_loopinfo_inconsistent(ir_graph *irg);
405 /** Sets the loop information state to the appropriate inconsistent state.
406 * If state is 'none' does not change.
407 * Does this for all irgs. */
408 void set_irp_loopinfo_inconsistent(void);
410 /** state: callee_information_state
411 * Call nodes contain a list of possible callees. This list must be
412 * computed by an analysis.
414 * It's strange that this state is administered on irg basis, as the
415 * information must be computed for the whole program, or not?
418 irg_callee_info_none,
419 irg_callee_info_consistent,
420 irg_callee_info_inconsistent
421 } irg_callee_info_state;
423 /** returns the callee_info_state of an IR graph. */
424 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
426 /** sets the callee_info_state of an IR graph. */
427 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
430 * Tells how to handle an ir graph in inlineing.
433 irg_inline_any, /**< No restriction on inlineing. Default. */
434 irg_inline_forbidden, /**< The graph may not be inlined. */
435 irg_inline_recomended, /**< The graph should be inlined. */
436 irg_inline_forced, /**< The graph must be inlined. */
437 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
439 } irg_inline_property;
441 /** Returns the inline property of a graph. */
442 irg_inline_property get_irg_inline_property(const ir_graph *irg);
443 /** Sets the inline property of a graph. */
444 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
447 * Returns the mask of the additional graph properties.
448 * The properties are automatically inherited from the method type
449 * if they were not set using set_irg_additional_properties() or
450 * set_irg_additional_property().
452 unsigned get_irg_additional_properties(const ir_graph *irg);
454 /** Sets the mask of the additional graph properties. */
455 void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
457 /** Sets one additional graph property. */
458 void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
460 /** A void * field to link arbitrary information to the node. */
461 void set_irg_link (ir_graph *irg, void *thing);
462 void *get_irg_link (const ir_graph *irg);
464 /** Increments visited flag by one.
465 * @see also: get_irn_visited() get_irg_block_visited(). */
466 void inc_irg_visited (ir_graph *irg);
467 unsigned long get_irg_visited (const ir_graph *irg);
468 void set_irg_visited (ir_graph *irg, unsigned long i);
469 /** An interprocedural flag valid for all irgs.
470 * @see also: get_irn_visited() get_irg_block_visited(). */
471 unsigned long get_max_irg_visited (void);
472 void set_max_irg_visited (int val);
473 unsigned long inc_max_irg_visited (void);
475 /** Increments block_visited by one.
476 * @see also: get_irn_visited() get_irg_block_visited(). */
477 void inc_irg_block_visited (ir_graph *irg);
478 unsigned long get_irg_block_visited (const ir_graph *irg);
479 void set_irg_block_visited (ir_graph *irg, unsigned long i);
482 * Debug helpers: You can indicate wether you are currently using visited or
483 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
484 * if 2 parties try to use the flags.
487 void set_using_block_visited(ir_graph *irg);
488 void clear_using_block_visited(ir_graph *irg);
489 int using_block_visited(const ir_graph *irg);
490 void set_using_visited(ir_graph *irg);
491 void clear_using_visited(ir_graph *irg);
492 int using_visited(const ir_graph *irg);
493 void set_using_irn_link(ir_graph *irg);
494 void clear_using_irn_link(ir_graph *irg);
495 int using_irn_link(const ir_graph *irg);
497 static INLINE void set_using_block_visited(ir_graph *irg) { (void) irg; }
498 static INLINE void clear_using_block_visited(ir_graph *irg) { (void) irg; }
499 static INLINE int using_block_visited(const ir_graph *irg) { (void) irg; return 0; }
500 static INLINE void set_using_visited(ir_graph *irg) { (void) irg; }
501 static INLINE void clear_using_visited(ir_graph *irg) { (void) irg; }
502 static INLINE int using_visited(const ir_graph *irg) { (void) irg; return 0; }
503 static INLINE void set_using_irn_link(ir_graph *irg) { (void) irg; }
504 static INLINE void clear_using_irn_link(ir_graph *irg) { (void) irg; }
505 static INLINE int using_irn_link(const ir_graph *irg) { (void) irg; return 0; }
508 /** move Proj nodes into the same block as its predecessors */
509 void normalize_proj_nodes(ir_graph *irg);
511 /** set a description for local value n */
512 void set_irg_loc_description(ir_graph *irg, int n, void *description);
514 /** get the description for local value n */
515 void *get_irg_loc_description(ir_graph *irg, int n);
517 /** Returns a estimated node count of the irg. This count is updated
518 * after every irg_walk_graph().
520 unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
522 /** Returns the last irn index for this graph. */
523 unsigned get_irg_last_idx(const ir_graph *irg);
525 /** Returns the floating point model of this graph. */
526 unsigned get_irg_fp_model(const ir_graph *irg);
528 /** Sets a floating point model for this graph. */
529 void set_irg_fp_model(ir_graph *irg, unsigned model);
532 * Access custom graph data.
533 * The data must have been registered with
534 * register_additional_graph_data() before.
535 * @param graph The graph to get the data from.
536 * @param type The type of the data you registered.
537 * @param off The value returned by register_additional_graph_data().
538 * @return A pointer of type @p type.
540 #define get_irg_data(graph,type,off) \
541 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
544 * Get the pointer to the node some custom data belongs to.
545 * @param data The pointer to the custom data.
546 * @param off The number as returned by register_additional_graph_data().
547 * @return A pointer to the ir node the custom data belongs to.
549 #define get_irg_data_base(data,off) \
550 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
553 * Request additional data to be allocated with an ir graph.
554 * @param size The size of the additional data required.
555 * @return A positive number, if the operation was successful, which
556 * must be passed to the access macro get_irg_data(), 0 if the
557 * registration failed.
559 size_t register_additional_graph_data(size_t size);
561 #endif /* _FIRM_IR_IRGRAPH_H_ */