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 * @brief Entry point to the representation of procedure code.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
26 #ifndef FIRM_IR_IRGRAPH_H
27 #define FIRM_IR_IRGRAPH_H
31 #include "firm_types.h"
38 * @page ir_graph The struct ir_graph
40 * This struct contains all information about a procedure.
41 * It's allocated directly to memory.
43 * The fields of ir_graph:
45 * - ent The entity describing this procedure.
47 * The beginning and end of a graph:
49 * - start_block This ir_node is the block that contains the unique
50 * start node of the procedure. With it it contains
51 * the Proj's on starts results.
52 * Further all Const nodes are placed in the start block.
53 * - start This ir_node is the unique start node of the procedure.
55 * - end_block This ir_node is the block that contains the unique
56 * end node of the procedure. This block contains no
58 * - end This ir_node is the unique end node of the procedure.
60 * The following nodes are Projs from the Start node, held in ir_graph for
63 * - frame The ir_node producing the pointer to the stack frame of
64 * the procedure as output. This is the Proj node on the
65 * third output of the start node. This output of the start
66 * node is tagged as pns_frame_base. In FIRM most local
67 * variables are modeled as data flow edges. Static
68 * allocated arrays can not be represented as data flow
69 * edges. Therefore FIRM has to represent them in the stack
72 * - globals This models a pointer to a space in the memory where
73 * _all_ global things are held. Select from this pointer
74 * with a Sel node the pointer to a global variable /
75 * procedure / compiler known function... .
77 * - tls This models a pointer to a space in the memory where
78 * thread local things are held. Select from this pointer
79 * with a Sel node the pointer to a thread local variable.
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 of 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 * Data structures 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 needed 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 behavior 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 * seven results (X, M, P, P, P, T, P).
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 data structure of the start
158 * block that contains all valid values in this block (set_store()). This
159 * data structure 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 (ir_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 ir_entity *get_irg_entity (const ir_graph *irg);
198 void set_irg_entity (ir_graph *irg, ir_entity *ent);
200 ir_type *get_irg_frame_type (ir_graph *irg);
201 void set_irg_frame_type (ir_graph *irg, ir_type *ftp);
203 ir_node *get_irg_start_block (const ir_graph *irg);
204 void set_irg_start_block (ir_graph *irg, ir_node *node);
206 ir_node *get_irg_start (const ir_graph *irg);
207 void set_irg_start (ir_graph *irg, ir_node *node);
209 ir_node *get_irg_end_block (const ir_graph *irg);
210 void set_irg_end_block (ir_graph *irg, ir_node *node);
212 ir_node *get_irg_end (const ir_graph *irg);
213 void set_irg_end (ir_graph *irg, ir_node *node);
215 /* The fields end_reg and end_except contain the end nodes of the
216 interprocedural view. If the view is not constructed they contain
217 the normal end node. */
218 ir_node *get_irg_end_reg (const ir_graph *irg);
219 void set_irg_end_reg (ir_graph *irg, ir_node *node);
221 ir_node *get_irg_end_except (const ir_graph *irg);
222 void set_irg_end_except (ir_graph *irg, ir_node *node);
224 /** Returns the node that represents the frame pointer. */
225 ir_node *get_irg_frame (const ir_graph *irg);
226 /** Sets the node that represents the frame pointer. */
227 void set_irg_frame (ir_graph *irg, ir_node *node);
229 /** Returns the node that represents the global pointer. */
230 ir_node *get_irg_globals (const ir_graph *irg);
231 /** Sets the node that represents the global pointer. */
232 void set_irg_globals (ir_graph *irg, ir_node *node);
234 /** Returns the node that represents the tls pointer. */
235 ir_node *get_irg_tls (const ir_graph *irg);
236 /** Sets the node that represents the tls pointer. */
237 void set_irg_tls (ir_graph *irg, ir_node *node);
239 /** Returns the node that represents the initial memory. */
240 ir_node *get_irg_initial_mem (const ir_graph *irg);
241 /** Sets the node that represents the initial memory. */
242 void set_irg_initial_mem (ir_graph *irg, ir_node *node);
244 /** Returns the node that represents the argument pointer. */
245 ir_node *get_irg_args (const ir_graph *irg);
246 /** Sets the node that represents the argument pointer. */
247 void set_irg_args (ir_graph *irg, ir_node *node);
249 /** Returns the node that represents the value parameter base pointer. */
250 ir_node *get_irg_value_param_base (const ir_graph *irg);
251 /** Sets the node that represents the value parameter base pointer. */
252 void set_irg_value_param_base (ir_graph *irg, ir_node *node);
254 /** Returns an array of the nodes of the argument pointer. */
255 ir_node **get_irg_proj_args (const ir_graph *irg);
256 /** Sets the array of the nodes of the argument pointer. */
257 void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
259 /** Returns the current block of a graph. */
260 ir_node *get_irg_current_block (const ir_graph *irg);
261 /** Sets the current block of a graph. */
262 void set_irg_current_block (ir_graph *irg, ir_node *node);
264 /** Returns the Bad node. Use new_Bad() instead!! */
265 ir_node *get_irg_bad (const ir_graph *irg);
266 void set_irg_bad (ir_graph *irg, ir_node *node);
268 /** Returns the NoMem node. Use new_NoMem() instead!! */
269 ir_node *get_irg_no_mem (const ir_graph *irg);
270 void set_irg_no_mem (ir_graph *irg, ir_node *node);
272 /** Returns the number of value numbers of a graph. */
273 int get_irg_n_locs (ir_graph *irg);
275 /** Returns the graph number. */
276 long get_irg_graph_nr(ir_graph *irg);
278 /********************************************************************************/
279 /* States of an ir_graph. */
280 /********************************************************************************/
283 information associated with the graph. Optimizations invalidate these
286 /** The states of an ir graph.
288 * state phase values: phase_building, phase_high, phase_low, phase_backend.
290 * The graph is in phase_building during construction of the irgraph.
291 * The construction is finished by a call to finalize_cons().
293 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
296 * To get the irgraph into phase_low all Sel nodes must be removed and
297 * replaced by explicit address computations. SymConst size and
298 * type tag nodes must be removed (@@@ really?). Initialization of
299 * memory allocated by Alloc must be explicit. @@@ More conditions?
301 * phase_backend is set if architecture specific machine nodes are inserted
302 * (and probably most standard Firm are removed).
305 phase_building, /**< The graph is still being constructed. */
306 phase_high, /**< The construction of the graph is finish, high level nodes may be present. */
307 phase_low, /**< High level nodes are removed. */
308 phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */
311 /** returns the phase_state of an IR graph. */
312 irg_phase_state get_irg_phase_state (const ir_graph *irg);
314 /** sets the phase state of an IR graph. */
315 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
317 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
319 /** state: op_pin_state_pinned
320 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
321 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
322 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
323 invalid block, i.e., the block is not a dominator of all the uses of
325 The enum op_pin_state is defined in irop.h. */
326 op_pin_state get_irg_pinned (const ir_graph *irg);
328 /** state: outs_state
329 * Outs are the back edges or def-use edges of ir nodes.
330 * Values: outs_none, outs_consistent, outs_inconsistent */
332 outs_none, /**< Outs are not computed, no memory is allocated. */
333 outs_consistent, /**< Outs are computed and correct. */
334 outs_inconsistent /**< Outs have been computed, memory is still allocated,
335 but the graph has been changed since. */
337 irg_outs_state get_irg_outs_state(const ir_graph *irg);
338 void set_irg_outs_inconsistent(ir_graph *irg);
340 /** state: extended basic block state. */
342 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
343 extblk_valid = 1, /**< Extended basic block information is valid. */
344 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
346 irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
347 void set_irg_extblk_inconsistent(ir_graph *irg);
350 * Signals the state of the dominator / post dominator information.
353 dom_none, /**< dominator are not computed, no memory is allocated */
354 dom_consistent, /**< dominator information is computed and correct */
355 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
358 /** returns the dominator state of an IR graph. */
359 irg_dom_state get_irg_dom_state(const ir_graph *irg);
361 /** returns the post dominator state of an IR graph. */
362 irg_dom_state get_irg_postdom_state(const ir_graph *irg);
364 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
365 void set_irg_doms_inconsistent(ir_graph *irg);
367 /** state: loopinfo_state
368 * Loop information describes the loops within the control and
369 * data flow of the procedure.
372 loopinfo_none = 0, /**< No loop information is constructed. Default. */
373 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
374 loopinfo_valid = 2, /**< Loop information is valid. */
375 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
376 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
378 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
379 are used in a switch. */
381 /** IntRAprocedural loop information constructed and valid. */
382 loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
383 /** IntRAprocedural loop information constructed and invalid. */
384 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
386 /** IntERprocedural loop information constructed and valid. */
387 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
388 /** IntERprocedural loop information constructed and invalid. */
389 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
391 /** IntRAprocedural control loop information constructed and valid. */
392 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
393 /** IntRAprocedural control loop information constructed and invalid. */
394 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
396 /** IntERprocedural control loop information constructed and valid. */
397 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
398 /** IntERprocedural control loop information constructed and invalid. */
399 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
400 } irg_loopinfo_state;
402 /** Return the current loop information state. */
403 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
405 /** Sets the current loop information state. */
406 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
408 /** Sets the loop information state to the appropriate inconsistent state.
409 * If state is 'none' does not change. */
410 void set_irg_loopinfo_inconsistent(ir_graph *irg);
411 /** Sets the loop information state to the appropriate inconsistent state.
412 * If state is 'none' does not change.
413 * Does this for all irgs. */
414 void set_irp_loopinfo_inconsistent(void);
416 /** state: callee_information_state
417 * Call nodes contain a list of possible callees. This list must be
418 * computed by an analysis.
420 * It's strange that this state is administered on irg basis, as the
421 * information must be computed for the whole program, or not?
424 irg_callee_info_none,
425 irg_callee_info_consistent,
426 irg_callee_info_inconsistent
427 } irg_callee_info_state;
429 /** returns the callee_info_state of an IR graph. */
430 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
432 /** sets the callee_info_state of an IR graph. */
433 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
436 * Tells how to handle an ir graph in inlineing.
439 irg_inline_any, /**< No restriction on inlineing. Default. */
440 irg_inline_forbidden, /**< The graph may not be inlined. */
441 irg_inline_recomended, /**< The graph should be inlined. */
442 irg_inline_forced, /**< The graph must be inlined. */
443 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
445 } irg_inline_property;
447 /** Returns the inline property of a graph. */
448 irg_inline_property get_irg_inline_property(const ir_graph *irg);
449 /** Sets the inline property of a graph. */
450 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
453 * Returns the mask of the additional graph properties.
454 * The properties are automatically inherited from the method type
455 * if they were not set using set_irg_additional_properties() or
456 * set_irg_additional_property().
458 unsigned get_irg_additional_properties(const ir_graph *irg);
460 /** Sets the mask of the additional graph properties. */
461 void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
463 /** Sets one additional graph property. */
464 void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
466 /** A void * field to link arbitrary information to the node. */
467 void set_irg_link (ir_graph *irg, void *thing);
468 void *get_irg_link (const ir_graph *irg);
470 /** Increments visited flag by one.
471 * @see also: get_irn_visited() get_irg_block_visited(). */
472 void inc_irg_visited (ir_graph *irg);
473 unsigned long get_irg_visited (const ir_graph *irg);
474 void set_irg_visited (ir_graph *irg, unsigned long i);
475 /** An interprocedural flag valid for all irgs.
476 * @see also: get_irn_visited() get_irg_block_visited(). */
477 unsigned long get_max_irg_visited (void);
478 void set_max_irg_visited (int val);
479 unsigned long inc_max_irg_visited (void);
481 /** Increments block_visited by one.
482 * @see also: get_irn_visited() get_irg_block_visited(). */
483 void inc_irg_block_visited (ir_graph *irg);
484 unsigned long get_irg_block_visited (const ir_graph *irg);
485 void set_irg_block_visited (ir_graph *irg, unsigned long i);
488 * Debug helpers: You can indicate whether you are currently using visited or
489 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
490 * if 2 parties try to use the flags.
493 void set_using_block_visited(ir_graph *irg);
494 void clear_using_block_visited(ir_graph *irg);
495 int using_block_visited(const ir_graph *irg);
496 void set_using_visited(ir_graph *irg);
497 void clear_using_visited(ir_graph *irg);
498 int using_visited(const ir_graph *irg);
499 void set_using_irn_link(ir_graph *irg);
500 void clear_using_irn_link(ir_graph *irg);
501 int using_irn_link(const ir_graph *irg);
503 static INLINE void set_using_block_visited(ir_graph *irg) { (void) irg; }
504 static INLINE void clear_using_block_visited(ir_graph *irg) { (void) irg; }
505 static INLINE int using_block_visited(const ir_graph *irg) { (void) irg; return 0; }
506 static INLINE void set_using_visited(ir_graph *irg) { (void) irg; }
507 static INLINE void clear_using_visited(ir_graph *irg) { (void) irg; }
508 static INLINE int using_visited(const ir_graph *irg) { (void) irg; return 0; }
509 static INLINE void set_using_irn_link(ir_graph *irg) { (void) irg; }
510 static INLINE void clear_using_irn_link(ir_graph *irg) { (void) irg; }
511 static INLINE int using_irn_link(const ir_graph *irg) { (void) irg; return 0; }
514 /** Normalization: Move Proj nodes into the same block as its predecessors */
515 void normalize_proj_nodes(ir_graph *irg);
517 /** set a description for local value n */
518 void set_irg_loc_description(ir_graph *irg, int n, void *description);
520 /** get the description for local value n */
521 void *get_irg_loc_description(ir_graph *irg, int n);
523 /** Returns a estimated node count of the irg. This count is updated
524 * after every irg_walk_graph().
526 unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
528 /** Returns the last irn index for this graph. */
529 unsigned get_irg_last_idx(const ir_graph *irg);
531 /** Returns the floating point model of this graph. */
532 unsigned get_irg_fp_model(const ir_graph *irg);
534 /** Sets a floating point model for this graph. */
535 void set_irg_fp_model(ir_graph *irg, unsigned model);
538 * Access custom graph data.
539 * The data must have been registered with
540 * register_additional_graph_data() before.
541 * @param graph The graph to get the data from.
542 * @param type The type of the data you registered.
543 * @param off The value returned by register_additional_graph_data().
544 * @return A pointer of type @p type.
546 #define get_irg_data(graph,type,off) \
547 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
550 * Get the pointer to the node some custom data belongs to.
551 * @param data The pointer to the custom data.
552 * @param off The number as returned by register_additional_graph_data().
553 * @return A pointer to the ir node the custom data belongs to.
555 #define get_irg_data_base(data,off) \
556 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
559 * Request additional data to be allocated with an ir graph.
560 * @param size The size of the additional data required.
561 * @return A positive number, if the operation was successful, which
562 * must be passed to the access macro get_irg_data(), 0 if the
563 * registration failed.
565 size_t register_additional_graph_data(size_t size);