2 * Copyright (C) 1995-2008 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_config.h"
32 #include "firm_types.h"
39 * @page ir_graph The struct ir_graph
41 * This struct contains all information about a procedure.
42 * It's allocated directly to memory.
44 * The fields of ir_graph:
46 * - ent The entity describing this procedure.
48 * The beginning and end of a graph:
50 * - start_block This ir_node is the block that contains the unique
51 * start node of the procedure. With it it contains
52 * the Proj's on starts results.
53 * Further all Const nodes are placed in the start block.
54 * - start This ir_node is the unique start node of the procedure.
56 * - end_block This ir_node is the block that contains the unique
57 * end node of the procedure. This block contains no
59 * - end This ir_node is the unique end node of the procedure.
61 * The following nodes are Projs from the Start node, held in ir_graph for
64 * - frame The ir_node producing the pointer to the stack frame of
65 * the procedure as output. This is the Proj node on the
66 * third output of the start node. This output of the start
67 * node is tagged as pns_frame_base. In FIRM most local
68 * variables are modeled as data flow edges. Static
69 * allocated arrays can not be represented as data flow
70 * edges. Therefore FIRM has to represent them in the stack
73 * - globals This models a pointer to a space in the memory where
74 * _all_ global things are held. Select from this pointer
75 * with a Sel node the pointer to a global variable /
76 * procedure / compiler known function... .
78 * - tls This models a pointer to a space in the memory where
79 * thread local things are held. Select from this pointer
80 * with a Sel node the pointer to a thread local variable.
82 * - args The ir_node that produces the arguments of the method as
83 * it's result. This is a Proj node on the fourth output of
84 * the start node. This output is tagged as pn_Start_T_args.
86 * - proj_args The proj nodes of the args node.
88 * - bad The Bad node is an auxiliary node. It is needed only once,
89 * so there is this globally reachable node.
91 * - no_mem The NoMem node is an auxiliary node. It is needed only once,
92 * so there is this globally reachable node.
94 * Data structures that are private to a graph:
96 * - obst An obstack that contains all nodes.
98 * - current_block A pointer to the current block. Any node created with
99 * one of the node constructors (new_<opcode>) are assigned
100 * to this block. It can be set with set_cur_block(block).
101 * Only needed for ir construction.
103 * - params/n_loc An int giving the number of local variables in this
104 * procedure. This is needed for ir construction. Name will
107 * - value_table This hash table (pset) is used for global value numbering
108 * for optimizing use in iropt.c.
110 * - Phi_in_stack; a stack needed for automatic Phi construction, needed only
111 * during ir construction.
113 * - visited A int used as flag to traverse the ir_graph.
115 * - block_visited A int used as a flag to traverse block nodes in the graph.
118 /** Global variable holding the current ir graph.
120 * This global variable is used by the ir construction
121 * interface in ircons and by the optimizations.
122 * Further it is set by all walker functions.
124 extern ir_graph *current_ir_graph;
126 ir_graph *get_current_ir_graph(void);
127 void set_current_ir_graph(ir_graph *graph);
129 #ifdef INTERPROCEDURAL_VIEW
130 /** This flag indicate the current view. The behavior of some methods
131 * (get_irn_*, set_irn_*) is influenced by this flag. */
132 int get_interprocedural_view(void);
133 void set_interprocedural_view(int state);
135 #define get_interprocedural_view() 0
139 * Create a new ir graph to build ir for a procedure.
141 * @param ent A pointer to an entity representing the procedure,
142 * i.e., the type of the entity must be of a method type.
144 * @param n_loc The number of local variables in this procedure including
145 * the procedure parameters.
147 * This constructor generates the basic infrastructure needed to
148 * represent a procedure in FIRM.
150 * It allocates an ir_graph and sets the field irg of the entity ent
151 * as well as current_ir_graph to point to this graph.
152 * Further it allocates the following nodes needed for every
155 * - The start block containing a start node and Proj nodes for it's
156 * seven results (X, M, P, P, P, T, P).
157 * - The end block containing an end node. This block is not matured
158 * after executing new_ir_graph() as predecessors need to be added to it.
159 * (Maturing a block means fixing it's number of predecessors.)
160 * - The current block, which is empty and also not matured.
162 * Further it enters the global store into the data structure of the start
163 * block that contains all valid values in this block (set_store()). This
164 * data structure is used to build the Phi nodes and removed after
165 * completion of the graph. There is no path from end to start in the
166 * graph after calling ir_graph.
168 * The op_pin_state of the graph is set to "op_pin_state_pinned"
169 * if no global cse was performed on the graph.
170 * It is set to "op_pin_state_floats" if global cse was performed
171 * (and during construction: did actually change something).
172 * Code placement is necessary.
174 * @see new_pseudo_ir_graph()
176 ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
178 /** Frees the passed irgraph.
179 * Deallocates all nodes in this graph and the ir_graph structure.
180 * Sets the field irgraph in the corresponding entity to NULL.
181 * Does not remove the irgraph from the list in irprog (requires
182 * inefficient search, call remove_irp_irg by hand).
183 * Does not free types, entities or modes that are used only by this
184 * graph, nor the entity standing for this graph.
186 void free_ir_graph(ir_graph *irg);
188 /* --- access routines for all ir_graph attributes --- */
191 * Checks whether a pointer points to a ir graph.
193 * @param thing an arbitrary pointer
196 * true if the thing is a IR graph, else false
198 int is_ir_graph(const void *thing);
200 /** Returns the entity of an IR graph. */
201 ir_entity *get_irg_entity(const ir_graph *irg);
202 /** Sets the entity of an IR graph. */
203 void set_irg_entity(ir_graph *irg, ir_entity *ent);
205 /** Returns the frame type of an IR graph. */
206 ir_type *get_irg_frame_type(ir_graph *irg);
207 /** Sets the frame type of an IR graph. */
208 void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
210 /** Returns the start block of an IR graph. */
211 ir_node *get_irg_start_block(const ir_graph *irg);
212 /** Sets the start block of an IR graph. */
213 void set_irg_start_block(ir_graph *irg, ir_node *node);
215 /** Returns the Start node of an IR graph. */
216 ir_node *get_irg_start(const ir_graph *irg);
217 /** Sets the Start node of an IR graph. */
218 void set_irg_start(ir_graph *irg, ir_node *node);
220 /** Returns the end block of an IR graph. */
221 ir_node *get_irg_end_block(const ir_graph *irg);
222 /** Sets the end block of an IR graph. */
223 void set_irg_end_block(ir_graph *irg, ir_node *node);
225 /** Returns the End node of an IR graph. */
226 ir_node *get_irg_end(const ir_graph *irg);
227 /** Sets the End node of an IR graph. */
228 void set_irg_end(ir_graph *irg, ir_node *node);
230 /* The fields end_reg and end_except contain the end nodes of the
231 interprocedural view. If the view is not constructed they contain
232 the normal end node. */
233 ir_node *get_irg_end_reg(const ir_graph *irg);
234 void set_irg_end_reg(ir_graph *irg, ir_node *node);
236 ir_node *get_irg_end_except(const ir_graph *irg);
237 void set_irg_end_except(ir_graph *irg, ir_node *node);
239 /** Returns the node that represents the initial control flow of the given IR graph. */
240 ir_node *get_irg_initial_exec(const ir_graph *irg);
241 /** Sets the node that represents the initial control of the given IR graph. */
242 void set_irg_initial_exec(ir_graph *irg, ir_node *node);
244 /** Returns the node that represents the frame pointer of the given IR graph. */
245 ir_node *get_irg_frame(const ir_graph *irg);
246 /** Sets the node that represents the frame pointer of the given IR graph. */
247 void set_irg_frame(ir_graph *irg, ir_node *node);
249 /** Returns the node that represents the tls pointer of the given IR graph. */
250 ir_node *get_irg_tls(const ir_graph *irg);
251 /** Sets the node that represents the tls pointer of the given IR graph. */
252 void set_irg_tls(ir_graph *irg, ir_node *node);
254 /** Returns the node that represents the initial memory of the given IR graph. */
255 ir_node *get_irg_initial_mem(const ir_graph *irg);
256 /** Sets the node that represents the initial memory of the given IR graph. */
257 void set_irg_initial_mem(ir_graph *irg, ir_node *node);
259 /** Returns the node that represents the argument pointer of the given IR graph. */
260 ir_node *get_irg_args(const ir_graph *irg);
261 /** Sets the node that represents the argument pointer of the given IR graph. */
262 void set_irg_args(ir_graph *irg, ir_node *node);
264 /** Returns the node that represents the value parameter base pointer of the given IR graph. */
265 ir_node *get_irg_value_param_base(const ir_graph *irg);
266 /** Sets the node that represents the value parameter base pointer of the given IR graph. */
267 void set_irg_value_param_base(ir_graph *irg, ir_node *node);
269 /** Returns the current block of an IR graph. */
270 ir_node *get_irg_current_block(const ir_graph *irg);
271 /** Sets the current block of an IR graph. */
272 void set_irg_current_block(ir_graph *irg, ir_node *node);
274 /** Returns the Bad node of the given IR graph. Use new_Bad() instead!! */
275 ir_node *get_irg_bad(const ir_graph *irg);
276 void set_irg_bad(ir_graph *irg, ir_node *node);
278 /** Returns the NoMem node of the given IR graph. Use new_NoMem() instead!! */
279 ir_node *get_irg_no_mem(const ir_graph *irg);
280 void set_irg_no_mem(ir_graph *irg, ir_node *node);
282 /** Returns the number of value numbers of an IR graph. */
283 int get_irg_n_locs(ir_graph *irg);
286 /** Returns the graph number. */
287 long get_irg_graph_nr(const ir_graph *irg);
291 * Returns the graph number. This is a unique number for the graph and is
292 * smaller than get_irp_last_idx()
293 * Note: you cannot use this number for get_irp_irg()
295 int get_irg_idx(const ir_graph *irg);
297 /********************************************************************************/
298 /* States of an ir_graph. */
299 /********************************************************************************/
302 information associated with the graph. Optimizations invalidate these
305 /** The states of an ir graph.
307 * state phase values: phase_building, phase_high, phase_low, phase_backend.
309 * The graph is in phase_building during construction of the irgraph.
310 * The construction is finished by a call to finalize_cons().
312 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
315 * To get the irgraph into phase_low all Sel nodes must be removed and
316 * replaced by explicit address computations. SymConst size and
317 * type tag nodes must be removed (@@@ really?). Initialization of
318 * memory allocated by Alloc must be explicit. @@@ More conditions?
320 * phase_backend is set if architecture specific machine nodes are inserted
321 * (and probably most standard Firm are removed).
324 phase_building, /**< The graph is still being constructed. */
325 phase_high, /**< The construction of the graph is finish, high level nodes may be present. */
326 phase_low, /**< High level nodes are removed. */
327 phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */
330 /** Returns the phase_state of an IR graph. */
331 irg_phase_state get_irg_phase_state(const ir_graph *irg);
333 /** Sets the phase state of an IR graph. */
334 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
336 /** Sets the phase of the given IR graph to low. */
337 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
339 /** state: op_pin_state_pinned
340 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
341 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
342 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
343 invalid block, i.e., the block is not a dominator of all the uses of
345 The enum op_pin_state is defined in irop.h. */
346 op_pin_state get_irg_pinned(const ir_graph *irg);
348 /** state: outs_state
349 * Outs are the back edges or def-use edges of ir nodes.
350 * Values: outs_none, outs_consistent, outs_inconsistent */
352 outs_none, /**< Outs are not computed, no memory is allocated. */
353 outs_consistent, /**< Outs are computed and correct. */
354 outs_inconsistent /**< Outs have been computed, memory is still allocated,
355 but the graph has been changed since. */
357 irg_outs_state get_irg_outs_state(const ir_graph *irg);
358 void set_irg_outs_inconsistent(ir_graph *irg);
360 /** state: extended basic block state. */
362 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
363 extblk_valid = 1, /**< Extended basic block information is valid. */
364 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
366 irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
367 void set_irg_extblk_inconsistent(ir_graph *irg);
370 * Signals the state of the dominator / post dominator information.
373 dom_none, /**< dominator are not computed, no memory is allocated */
374 dom_consistent, /**< dominator information is computed and correct */
375 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
378 /** returns the dominator state of an IR graph. */
379 irg_dom_state get_irg_dom_state(const ir_graph *irg);
381 /** returns the post dominator state of an IR graph. */
382 irg_dom_state get_irg_postdom_state(const ir_graph *irg);
384 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
385 void set_irg_doms_inconsistent(ir_graph *irg);
387 /** state: loopinfo_state
388 * Loop information describes the loops within the control and
389 * data flow of the procedure.
392 loopinfo_none = 0, /**< No loop information is constructed. Default. */
393 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
394 loopinfo_valid = 2, /**< Loop information is valid. */
395 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
396 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
398 loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they
399 are used in a switch. */
401 /** IntRAprocedural loop information constructed and valid. */
402 loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
403 /** IntRAprocedural loop information constructed and invalid. */
404 loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
406 /** IntERprocedural loop information constructed and valid. */
407 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
408 /** IntERprocedural loop information constructed and invalid. */
409 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
411 /** IntRAprocedural control loop information constructed and valid. */
412 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
413 /** IntRAprocedural control loop information constructed and invalid. */
414 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
416 /** IntERprocedural control loop information constructed and valid. */
417 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
418 /** IntERprocedural control loop information constructed and invalid. */
419 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
420 } irg_loopinfo_state;
422 /** Return the current loop information state. */
423 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
425 /** Sets the current loop information state. */
426 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
428 /** Sets the loop information state to the appropriate inconsistent state.
429 * If state is 'none' does not change. */
430 void set_irg_loopinfo_inconsistent(ir_graph *irg);
431 /** Sets the loop information state to the appropriate inconsistent state.
432 * If state is 'none' does not change.
433 * Does this for all irgs. */
434 void set_irp_loopinfo_inconsistent(void);
436 /** state: callee_information_state
437 * Call nodes contain a list of possible callees. This list must be
438 * computed by an analysis.
440 * It's strange that this state is administered on irg basis, as the
441 * information must be computed for the whole program, or not?
444 irg_callee_info_none,
445 irg_callee_info_consistent,
446 irg_callee_info_inconsistent
447 } irg_callee_info_state;
449 /** returns the callee_info_state of an IR graph. */
450 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
452 /** sets the callee_info_state of an IR graph. */
453 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
456 * Tells how to handle an ir graph in inlineing.
459 irg_inline_any, /**< No restriction on inlineing. Default. */
460 irg_inline_forbidden, /**< The graph may not be inlined. */
461 irg_inline_recomended, /**< The graph should be inlined. */
462 irg_inline_forced, /**< The graph must be inlined. */
463 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
465 } irg_inline_property;
467 /** Returns the inline property of a graph. */
468 irg_inline_property get_irg_inline_property(const ir_graph *irg);
469 /** Sets the inline property of a graph. */
470 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
473 * Returns the mask of the additional graph properties.
474 * The properties are automatically inherited from the method type
475 * if they were not set using set_irg_additional_properties() or
476 * set_irg_additional_property().
478 * @return a bitset of mtp_additional_property values
480 unsigned get_irg_additional_properties(const ir_graph *irg);
482 /** Sets the mask of the additional graph properties. */
483 void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
485 /** Sets one additional graph property. */
486 void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
488 /** A void * field to link arbitrary information to the node. */
489 void set_irg_link (ir_graph *irg, void *thing);
490 void *get_irg_link (const ir_graph *irg);
492 /** Increments visited flag by one.
493 * @see also: get_irn_visited() get_irg_block_visited(). */
494 void inc_irg_visited(ir_graph *irg);
495 unsigned long get_irg_visited(const ir_graph *irg);
496 void set_irg_visited(ir_graph *irg, unsigned long i);
497 /** An interprocedural flag valid for all irgs.
498 * @see also: get_irn_visited() get_irg_block_visited(). */
499 unsigned long get_max_irg_visited(void);
500 void set_max_irg_visited(int val);
501 unsigned long inc_max_irg_visited(void);
503 /** Increments block_visited by one.
504 * @see also: get_irn_visited() get_irg_block_visited(). */
505 void inc_irg_block_visited(ir_graph *irg);
506 unsigned long get_irg_block_visited(const ir_graph *irg);
507 void set_irg_block_visited(ir_graph *irg, unsigned long i);
510 * Debug helpers: You can indicate whether you are currently using visited or
511 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
512 * if 2 parties try to use the flags.
515 enum ir_resources_enum_t {
516 IR_RESOURCE_BLOCK_VISITED = 1 << 0,
517 IR_RESOURCE_BLOCK_MARK = 1 << 1,
518 IR_RESOURCE_IRN_VISITED = 1 << 2,
519 IR_RESOURCE_IRN_LINK = 1 << 3,
520 IR_RESOURCE_LOOP_LINK = 1 << 4,
522 typedef unsigned ir_resources_t;
524 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
525 void ir_free_resources(ir_graph *irg, ir_resources_t resources);
526 ir_resources_t ir_resources_reserved(const ir_graph *irg);
528 #define ir_reserve_resources(irg,resources)
529 #define ir_free_resources(irg,resources)
530 #define ir_resources_reserved(irg) 0
533 /** Normalization: Move Proj nodes into the same block as its predecessors */
534 void normalize_proj_nodes(ir_graph *irg);
536 /** set a description for local value n */
537 void set_irg_loc_description(ir_graph *irg, int n, void *description);
539 /** get the description for local value n */
540 void *get_irg_loc_description(ir_graph *irg, int n);
542 /** Returns a estimated node count of the irg. This count is updated
543 * after every irg_walk_graph().
545 unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
547 /** Returns the last irn index for this graph. */
548 unsigned get_irg_last_idx(const ir_graph *irg);
550 /** Returns the floating point model of this graph. */
551 unsigned get_irg_fp_model(const ir_graph *irg);
553 /** Sets a floating point model for this graph. */
554 void set_irg_fp_model(ir_graph *irg, unsigned model);
557 * Access custom graph data.
558 * The data must have been registered with
559 * register_additional_graph_data() before.
560 * @param graph The graph to get the data from.
561 * @param type The type of the data you registered.
562 * @param off The value returned by register_additional_graph_data().
563 * @return A pointer of type @p type.
565 #define get_irg_data(graph,type,off) \
566 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
569 * Get the pointer to the node some custom data belongs to.
570 * @param data The pointer to the custom data.
571 * @param off The number as returned by register_additional_graph_data().
572 * @return A pointer to the ir node the custom data belongs to.
574 #define get_irg_data_base(data,off) \
575 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
578 * Request additional data to be allocated with an ir graph.
579 * @param size The size of the additional data required.
580 * @return A positive number, if the operation was successful, which
581 * must be passed to the access macro get_irg_data(), 0 if the
582 * registration failed.
584 size_t register_additional_graph_data(size_t size);