2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * File name: ir/ir/irgraph.c
23 * Purpose: Entry point to the representation of procedure code.
24 * Author: Martin Trapp, Christian Schaefer
25 * Modified by: Goetz Lindenmaier
28 * Copyright: (c) 1998-2003 Universität Karlsruhe
34 * ir graph construction.
36 * @author Martin Trapp, Christian Schaefer
38 #ifndef _FIRM_IR_IRGRAPH_H_
39 #define _FIRM_IR_IRGRAPH_H_
43 #include "firm_types.h"
50 * @page ir_graph The struct ir_graph
52 * This struct contains all information about a procedure.
53 * It's allocated directly to memory.
55 * The fields of ir_graph:
57 * - ent The entity describing this procedure.
59 * The beginning and end of a graph:
61 * - start_block This ir_node is the block that contains the unique
62 * start node of the procedure. With it it contains
63 * the Proj's on starts results.
64 * Further all Const nodes are placed in the start block.
65 * - start This ir_node is the unique start node of the procedure.
67 * - end_block This ir_node is the block that contains the unique
68 * end node of the procedure. This block contains no
70 * - end This ir_node is the unique end node of the procedure.
72 * The following nodes are Projs from the Start node, held in ir_graph for
75 * - frame The ir_node producing the pointer to the stack frame of
76 * the procedure as output. This is the Proj node on the
77 * third output of the start node. This output of the start
78 * node is tagged as pns_frame_base. In FIRM most local
79 * variables are modeled as data flow edges. Static
80 * allocated arrays can not be represented as data flow
81 * edges. Therefore FIRM has to represent them in the stack
84 * - globals This models a pointer to a space in the memory where
85 * _all_ global things are held. Select from this pointer
86 * with a Sel node the pointer to a global variable /
87 * procedure / compiler known function... .
89 * - tls This models a pointer to a space in the memory where
90 * thread local things are held. Select from this pointer
91 * with a Sel node the pointer to a thread local variable.
93 * - args The ir_node that produces the arguments of the method as
94 * it's result. This is a Proj node on the fourth output of
95 * the start node. This output is tagged as pn_Start_T_args.
97 * - proj_args The proj nodes of the args node.
99 * - bad The Bad node is an auxiliary node. It is needed only once,
100 * so there is this globally reachable node.
102 * - no_mem The NoMem node is an auxiliary node. It is needed only once,
103 * so there is this globally reachable node.
105 * Data structures that are private to a graph:
107 * - obst An obstack that contains all nodes.
109 * - current_block A pointer to the current block. Any node created with
110 * one of the node constructors (new_<opcode>) are assigned
111 * to this block. It can be set with set_cur_block(block).
112 * Only needed for ir construction.
114 * - params/n_loc An int giving the number of local variables in this
115 * procedure. This is needed for ir construction. Name will
118 * - value_table This hash table (pset) is used for global value numbering
119 * for optimizing use in iropt.c.
121 * - Phi_in_stack; a stack needed for automatic Phi construction, needed only
122 * during ir construction.
124 * - visited A int used as flag to traverse the ir_graph.
126 * - block_visited A int used as a flag to traverse block nodes in the graph.
129 /** Global variable holding the current ir graph.
131 * This global variable is used by the ir construction
132 * interface in ircons and by the optimizations.
133 * Further it is set by all walker functions.
135 extern ir_graph *current_ir_graph;
137 ir_graph *get_current_ir_graph(void);
138 void set_current_ir_graph(ir_graph *graph);
140 /** This flag indicate the current view. The behavior of some methods
141 * (get_irn_*, set_irn_*) is influenced by this flag. */
142 int get_interprocedural_view(void);
143 void set_interprocedural_view(int state);
146 * Create a new ir graph to build ir for a procedure.
148 * @param ent A pointer to an entity representing the procedure,
149 * i.e., the type of the entity must be of a method type.
151 * @param n_loc The number of local variables in this procedure including
152 * the procedure parameters.
154 * This constructor generates the basic infrastructure needed to
155 * represent a procedure in FIRM.
157 * It allocates an ir_graph and sets the field irg of the entity ent
158 * as well as current_ir_graph to point to this graph.
159 * Further it allocates the following nodes needed for every
162 * - The start block containing a start node and Proj nodes for it's
163 * seven results (X, M, P, P, P, T, P).
164 * - The end block containing an end node. This block is not matured
165 * after executing new_ir_graph() as predecessors need to be added to it.
166 * (Maturing a block means fixing it's number of predecessors.)
167 * - The current block, which is empty and also not matured.
169 * Further it enters the global store into the data structure of the start
170 * block that contains all valid values in this block (set_store()). This
171 * data structure is used to build the Phi nodes and removed after
172 * completion of the graph. There is no path from end to start in the
173 * graph after calling ir_graph.
175 * The op_pin_state of the graph is set to "op_pin_state_pinned"
176 * if no global cse was performed on the graph.
177 * It is set to "op_pin_state_floats" if global cse was performed
178 * (and during construction: did actually change something).
179 * Code placement is necessary.
181 * @see new_pseudo_ir_graph()
183 ir_graph *new_ir_graph (ir_entity *ent, int n_loc);
185 /** Frees the passed irgraph.
186 * Deallocates all nodes in this graph and the ir_graph structure.
187 * Sets the field irgraph in the corresponding entity to NULL.
188 * Does not remove the irgraph from the list in irprog (requires
189 * inefficient search, call remove_irp_irg by hand).
190 * Does not free types, entities or modes that are used only by this
191 * graph, nor the entity standing for this graph.
193 void free_ir_graph (ir_graph *irg);
195 /* --- access routines for all ir_graph attributes --- */
198 * Checks whether a pointer points to a ir graph.
200 * @param thing an arbitrary pointer
203 * true if the thing is a ir graph, else false
205 int is_ir_graph(const void *thing);
207 /* #define get_irg_entity get_irg_ent */
208 /* #define set_irg_entity set_irg_ent */
209 ir_entity *get_irg_entity (const ir_graph *irg);
210 void set_irg_entity (ir_graph *irg, ir_entity *ent);
212 ir_type *get_irg_frame_type (ir_graph *irg);
213 void set_irg_frame_type (ir_graph *irg, ir_type *ftp);
215 ir_node *get_irg_start_block (const ir_graph *irg);
216 void set_irg_start_block (ir_graph *irg, ir_node *node);
218 ir_node *get_irg_start (const ir_graph *irg);
219 void set_irg_start (ir_graph *irg, ir_node *node);
221 ir_node *get_irg_end_block (const ir_graph *irg);
222 void set_irg_end_block (ir_graph *irg, ir_node *node);
224 ir_node *get_irg_end (const ir_graph *irg);
225 void set_irg_end (ir_graph *irg, ir_node *node);
227 /* The fields end_reg and end_except contain the end nodes of the
228 interprocedural view. If the view is not constructed they contain
229 the normal end node. */
230 ir_node *get_irg_end_reg (const ir_graph *irg);
231 void set_irg_end_reg (ir_graph *irg, ir_node *node);
233 ir_node *get_irg_end_except (const ir_graph *irg);
234 void set_irg_end_except (ir_graph *irg, ir_node *node);
236 /** Returns the node that represents the frame pointer. */
237 ir_node *get_irg_frame (const ir_graph *irg);
238 /** Sets the node that represents the frame pointer. */
239 void set_irg_frame (ir_graph *irg, ir_node *node);
241 /** Returns the node that represents the global pointer. */
242 ir_node *get_irg_globals (const ir_graph *irg);
243 /** Sets the node that represents the global pointer. */
244 void set_irg_globals (ir_graph *irg, ir_node *node);
246 /** Returns the node that represents the tls pointer. */
247 ir_node *get_irg_tls (const ir_graph *irg);
248 /** Sets the node that represents the tls pointer. */
249 void set_irg_tls (ir_graph *irg, ir_node *node);
251 /** Returns the node that represents the initial memory. */
252 ir_node *get_irg_initial_mem (const ir_graph *irg);
253 /** Sets the node that represents the initial memory. */
254 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
256 /** Returns the node that represents the argument pointer. */
257 ir_node *get_irg_args (const ir_graph *irg);
258 /** Sets the node that represents the argument pointer. */
259 void set_irg_args (ir_graph *irg, ir_node *node);
261 /** Returns the node that represents the value parameter base pointer. */
262 ir_node *get_irg_value_param_base (const ir_graph *irg);
263 /** Sets the node that represents the value parameter base pointer. */
264 void set_irg_value_param_base (ir_graph *irg, ir_node *node);
266 /** Returns an array of the nodes of the argument pointer. */
267 ir_node **get_irg_proj_args (const ir_graph *irg);
268 /** Sets the array of the nodes of the argument pointer. */
269 void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
271 /** Returns the current block of a graph. */
272 ir_node *get_irg_current_block (const ir_graph *irg);
273 /** Sets the current block of a graph. */
274 void set_irg_current_block (ir_graph *irg, ir_node *node);
276 /** Returns the Bad node. Use new_Bad() instead!! */
277 ir_node *get_irg_bad (const ir_graph *irg);
278 void set_irg_bad (ir_graph *irg, ir_node *node);
280 /** Returns the NoMem node. Use new_NoMem() instead!! */
281 ir_node *get_irg_no_mem (const ir_graph *irg);
282 void set_irg_no_mem (ir_graph *irg, ir_node *node);
284 /** Returns the number of value numbers of a graph. */
285 int get_irg_n_locs (ir_graph *irg);
287 /** Returns the graph number. */
288 long get_irg_graph_nr(ir_graph *irg);
290 /********************************************************************************/
291 /* States of an ir_graph. */
292 /********************************************************************************/
295 information associated with the graph. Optimizations invalidate these
298 /** The states of an ir graph.
300 * state phase values: phase_building, phase_high, phase_low, phase_backend.
302 * The graph is in phase_building during construction of the irgraph.
303 * The construction is finished by a call to finalize_cons().
305 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
308 * To get the irgraph into phase_low all Sel nodes must be removed and
309 * replaced by explicit address computations. SymConst size and
310 * type tag nodes must be removed (@@@ really?). Initialization of
311 * memory allocated by Alloc must be explicit. @@@ More conditions?
313 * phase_backend is set if architecture specific machine nodes are inserted
314 * (and probably most standard Firm are removed).
323 /** returns the phase_state of an IR graph. */
324 irg_phase_state get_irg_phase_state (const ir_graph *irg);
326 /** sets the phase state of an IR graph. */
327 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
329 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
331 /** state: op_pin_state_pinned
332 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
333 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
334 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
335 invalid block, i.e., the block is not a dominator of all the uses of
337 The enum op_pin_state is defined in irop.h. */
338 op_pin_state get_irg_pinned (const ir_graph *irg);
340 /** state: outs_state
341 * Outs are the back edges or def-use edges of ir nodes.
342 * Values: outs_none, outs_consistent, outs_inconsistent */
344 outs_none, /**< Outs are not computed, no memory is allocated. */
345 outs_consistent, /**< Outs are computed and correct. */
346 outs_inconsistent /**< Outs have been computed, memory is still allocated,
347 but the graph has been changed since. */
349 irg_outs_state get_irg_outs_state(const ir_graph *irg);
350 void set_irg_outs_inconsistent(ir_graph *irg);
352 /** state: extended basic block state. */
354 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
355 extblk_valid = 1, /**< Extended basic block information is valid. */
356 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
358 irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
359 void set_irg_extblk_inconsistent(ir_graph *irg);
362 * Signals the state of the dominator / post dominator information.
365 dom_none, /**< dominator are not computed, no memory is allocated */
366 dom_consistent, /**< dominator information is computed and correct */
367 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
370 /** returns the dominator state of an IR graph. */
371 irg_dom_state get_irg_dom_state(const ir_graph *irg);
373 /** returns the post dominator state of an IR graph. */
374 irg_dom_state get_irg_postdom_state(const ir_graph *irg);
376 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
377 void set_irg_doms_inconsistent(ir_graph *irg);
379 /** state: loopinfo_state
380 * Loop information describes the loops within the control and
381 * data flow of the procedure.
384 loopinfo_none = 0, /**< No loop information is constructed. Default. */
385 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
386 loopinfo_valid = 2, /**< Loop information is valid. */
387 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
388 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
390 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
391 are used in a switch. */
393 /** IntRAprocedural loop information constructed and valid. */
394 loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
395 /** IntRAprocedural loop information constructed and invalid. */
396 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
398 /** IntERprocedural loop information constructed and valid. */
399 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
400 /** IntERprocedural loop information constructed and invalid. */
401 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
403 /** IntRAprocedural control loop information constructed and valid. */
404 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
405 /** IntRAprocedural control loop information constructed and invalid. */
406 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
408 /** IntERprocedural control loop information constructed and valid. */
409 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
410 /** IntERprocedural control loop information constructed and invalid. */
411 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
412 } irg_loopinfo_state;
414 /** Return the current loop information state. */
415 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
417 /** Sets the current loop information state. */
418 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
420 /** Sets the loop information state to the appropriate inconsistent state.
421 * If state is 'none' does not change. */
422 void set_irg_loopinfo_inconsistent(ir_graph *irg);
423 /** Sets the loop information state to the appropriate inconsistent state.
424 * If state is 'none' does not change.
425 * Does this for all irgs. */
426 void set_irp_loopinfo_inconsistent(void);
428 /** state: callee_information_state
429 * Call nodes contain a list of possible callees. This list must be
430 * computed by an analysis.
432 * It's strange that this state is administered on irg basis, as the
433 * information must be computed for the whole program, or not?
436 irg_callee_info_none,
437 irg_callee_info_consistent,
438 irg_callee_info_inconsistent
439 } irg_callee_info_state;
441 /** returns the callee_info_state of an IR graph. */
442 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
444 /** sets the callee_info_state of an IR graph. */
445 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
448 * Tells how to handle an ir graph in inlineing.
451 irg_inline_any, /**< No restriction on inlineing. Default. */
452 irg_inline_forbidden, /**< The graph may not be inlined. */
453 irg_inline_recomended, /**< The graph should be inlined. */
454 irg_inline_forced, /**< The graph must be inlined. */
455 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
457 } irg_inline_property;
459 /** Returns the inline property of a graph. */
460 irg_inline_property get_irg_inline_property(const ir_graph *irg);
461 /** Sets the inline property of a graph. */
462 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
465 * Returns the mask of the additional graph properties.
466 * The properties are automatically inherited from the method type
467 * if they were not set using set_irg_additional_properties() or
468 * set_irg_additional_property().
470 unsigned get_irg_additional_properties(const ir_graph *irg);
472 /** Sets the mask of the additional graph properties. */
473 void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
475 /** Sets one additional graph property. */
476 void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
478 /** A void * field to link arbitrary information to the node. */
479 void set_irg_link (ir_graph *irg, void *thing);
480 void *get_irg_link (const ir_graph *irg);
482 /** Increments visited flag by one.
483 * @see also: get_irn_visited() get_irg_block_visited(). */
484 void inc_irg_visited (ir_graph *irg);
485 unsigned long get_irg_visited (const ir_graph *irg);
486 void set_irg_visited (ir_graph *irg, unsigned long i);
487 /** An interprocedural flag valid for all irgs.
488 * @see also: get_irn_visited() get_irg_block_visited(). */
489 unsigned long get_max_irg_visited (void);
490 void set_max_irg_visited (int val);
491 unsigned long inc_max_irg_visited (void);
493 /** Increments block_visited by one.
494 * @see also: get_irn_visited() get_irg_block_visited(). */
495 void inc_irg_block_visited (ir_graph *irg);
496 unsigned long get_irg_block_visited (const ir_graph *irg);
497 void set_irg_block_visited (ir_graph *irg, unsigned long i);
500 * Debug helpers: You can indicate wether you are currently using visited or
501 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
502 * if 2 parties try to use the flags.
505 void set_using_block_visited(ir_graph *irg);
506 void clear_using_block_visited(ir_graph *irg);
507 int using_block_visited(const ir_graph *irg);
508 void set_using_visited(ir_graph *irg);
509 void clear_using_visited(ir_graph *irg);
510 int using_visited(const ir_graph *irg);
511 void set_using_irn_link(ir_graph *irg);
512 void clear_using_irn_link(ir_graph *irg);
513 int using_irn_link(const ir_graph *irg);
515 static INLINE void set_using_block_visited(ir_graph *irg) { (void) irg; }
516 static INLINE void clear_using_block_visited(ir_graph *irg) { (void) irg; }
517 static INLINE int using_block_visited(const ir_graph *irg) { (void) irg; return 0; }
518 static INLINE void set_using_visited(ir_graph *irg) { (void) irg; }
519 static INLINE void clear_using_visited(ir_graph *irg) { (void) irg; }
520 static INLINE int using_visited(const ir_graph *irg) { (void) irg; return 0; }
521 static INLINE void set_using_irn_link(ir_graph *irg) { (void) irg; }
522 static INLINE void clear_using_irn_link(ir_graph *irg) { (void) irg; }
523 static INLINE int using_irn_link(const ir_graph *irg) { (void) irg; return 0; }
526 /** move Proj nodes into the same block as its predecessors */
527 void normalize_proj_nodes(ir_graph *irg);
529 /** set a description for local value n */
530 void set_irg_loc_description(ir_graph *irg, int n, void *description);
532 /** get the description for local value n */
533 void *get_irg_loc_description(ir_graph *irg, int n);
535 /** Returns a estimated node count of the irg. This count is updated
536 * after every irg_walk_graph().
538 unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
540 /** Returns the last irn index for this graph. */
541 unsigned get_irg_last_idx(const ir_graph *irg);
543 /** Returns the floating point model of this graph. */
544 unsigned get_irg_fp_model(const ir_graph *irg);
546 /** Sets a floating point model for this graph. */
547 void set_irg_fp_model(ir_graph *irg, unsigned model);
550 * Access custom graph data.
551 * The data must have been registered with
552 * register_additional_graph_data() before.
553 * @param graph The graph to get the data from.
554 * @param type The type of the data you registered.
555 * @param off The value returned by register_additional_graph_data().
556 * @return A pointer of type @p type.
558 #define get_irg_data(graph,type,off) \
559 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
562 * Get the pointer to the node some custom data belongs to.
563 * @param data The pointer to the custom data.
564 * @param off The number as returned by register_additional_graph_data().
565 * @return A pointer to the ir node the custom data belongs to.
567 #define get_irg_data_base(data,off) \
568 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
571 * Request additional data to be allocated with an ir graph.
572 * @param size The size of the additional data required.
573 * @return A positive number, if the operation was successful, which
574 * must be passed to the access macro get_irg_data(), 0 if the
575 * registration failed.
577 size_t register_additional_graph_data(size_t size);
579 #endif /* _FIRM_IR_IRGRAPH_H_ */