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_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 #ifdef INTERPROCEDURAL_VIEW
129 /** This flag indicate the current view. The behavior of some methods
130 * (get_irn_*, set_irn_*) is influenced by this flag. */
131 int get_interprocedural_view(void);
132 void set_interprocedural_view(int state);
134 #define get_interprocedural_view() 0
138 * Create a new ir graph to build ir for a procedure.
140 * @param ent A pointer to an entity representing the procedure,
141 * i.e., the type of the entity must be of a method type.
143 * @param n_loc The number of local variables in this procedure including
144 * the procedure parameters.
146 * This constructor generates the basic infrastructure needed to
147 * represent a procedure in FIRM.
149 * It allocates an ir_graph and sets the field irg of the entity ent
150 * as well as current_ir_graph to point to this graph.
151 * Further it allocates the following nodes needed for every
154 * - The start block containing a start node and Proj nodes for it's
155 * seven results (X, M, P, P, P, T, P).
156 * - The end block containing an end node. This block is not matured
157 * after executing new_ir_graph() as predecessors need to be added to it.
158 * (Maturing a block means fixing it's number of predecessors.)
159 * - The current block, which is empty and also not matured.
161 * Further it enters the global store into the data structure of the start
162 * block that contains all valid values in this block (set_store()). This
163 * data structure is used to build the Phi nodes and removed after
164 * completion of the graph. There is no path from end to start in the
165 * graph after calling ir_graph.
167 * The op_pin_state of the graph is set to "op_pin_state_pinned"
168 * if no global cse was performed on the graph.
169 * It is set to "op_pin_state_floats" if global cse was performed
170 * (and during construction: did actually change something).
171 * Code placement is necessary.
173 * @see new_pseudo_ir_graph()
175 ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
177 /** Frees the passed irgraph.
178 * Deallocates all nodes in this graph and the ir_graph structure.
179 * Sets the field irgraph in the corresponding entity to NULL.
180 * Does not remove the irgraph from the list in irprog (requires
181 * inefficient search, call remove_irp_irg by hand).
182 * Does not free types, entities or modes that are used only by this
183 * graph, nor the entity standing for this graph.
185 void free_ir_graph(ir_graph *irg);
187 /* --- access routines for all ir_graph attributes --- */
190 * Checks whether a pointer points to a ir graph.
192 * @param thing an arbitrary pointer
195 * true if the thing is a IR graph, else false
197 int is_ir_graph(const void *thing);
199 /** Returns the entity of an IR graph. */
200 ir_entity *get_irg_entity(const ir_graph *irg);
201 /** Sets the entity of an IR graph. */
202 void set_irg_entity(ir_graph *irg, ir_entity *ent);
204 /** Returns the frame type of an IR graph. */
205 ir_type *get_irg_frame_type(ir_graph *irg);
206 /** Sets the frame type of an IR graph. */
207 void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
209 /** Returns the start block of an IR graph. */
210 ir_node *get_irg_start_block(const ir_graph *irg);
211 /** Sets the start block of an IR graph. */
212 void set_irg_start_block(ir_graph *irg, ir_node *node);
214 /** Returns the Start node of an IR graph. */
215 ir_node *get_irg_start(const ir_graph *irg);
216 /** Sets the Start node of an IR graph. */
217 void set_irg_start(ir_graph *irg, ir_node *node);
219 /** Returns the end block of an IR graph. */
220 ir_node *get_irg_end_block(const ir_graph *irg);
221 /** Sets the end block of an IR graph. */
222 void set_irg_end_block(ir_graph *irg, ir_node *node);
224 /** Returns the End node of an IR graph. */
225 ir_node *get_irg_end(const ir_graph *irg);
226 /** Sets the End node of an IR graph. */
227 void set_irg_end(ir_graph *irg, ir_node *node);
229 /* The fields end_reg and end_except contain the end nodes of the
230 interprocedural view. If the view is not constructed they contain
231 the normal end node. */
232 ir_node *get_irg_end_reg(const ir_graph *irg);
233 void set_irg_end_reg(ir_graph *irg, ir_node *node);
235 ir_node *get_irg_end_except(const ir_graph *irg);
236 void set_irg_end_except(ir_graph *irg, ir_node *node);
238 /** Returns the node that represents the initial control flow of the given IR graph. */
239 ir_node *get_irg_initial_exec(const ir_graph *irg);
240 /** Sets the node that represents the initial control of the given IR graph. */
241 void set_irg_initial_exec(ir_graph *irg, ir_node *node);
243 /** Returns the node that represents the frame pointer of the given IR graph. */
244 ir_node *get_irg_frame(const ir_graph *irg);
245 /** Sets the node that represents the frame pointer of the given IR graph. */
246 void set_irg_frame(ir_graph *irg, ir_node *node);
248 /** Returns the node that represents the tls pointer of the given IR graph. */
249 ir_node *get_irg_tls(const ir_graph *irg);
250 /** Sets the node that represents the tls pointer of the given IR graph. */
251 void set_irg_tls(ir_graph *irg, ir_node *node);
253 /** Returns the node that represents the initial memory of the given IR graph. */
254 ir_node *get_irg_initial_mem(const ir_graph *irg);
255 /** Sets the node that represents the initial memory of the given IR graph. */
256 void set_irg_initial_mem(ir_graph *irg, ir_node *node);
258 /** Returns the node that represents the argument pointer of the given IR graph. */
259 ir_node *get_irg_args(const ir_graph *irg);
260 /** Sets the node that represents the argument pointer of the given IR graph. */
261 void set_irg_args(ir_graph *irg, ir_node *node);
263 /** Returns the node that represents the value parameter base pointer of the given IR graph. */
264 ir_node *get_irg_value_param_base(const ir_graph *irg);
265 /** Sets the node that represents the value parameter base pointer of the given IR graph. */
266 void set_irg_value_param_base(ir_graph *irg, ir_node *node);
268 /** Returns the current block of an IR graph. */
269 ir_node *get_irg_current_block(const ir_graph *irg);
270 /** Sets the current block of an IR graph. */
271 void set_irg_current_block(ir_graph *irg, ir_node *node);
273 /** Returns the Bad node of the given IR graph. Use new_Bad() instead!! */
274 ir_node *get_irg_bad(const ir_graph *irg);
275 void set_irg_bad(ir_graph *irg, ir_node *node);
277 /** Returns the NoMem node of the given IR graph. Use new_NoMem() instead!! */
278 ir_node *get_irg_no_mem(const ir_graph *irg);
279 void set_irg_no_mem(ir_graph *irg, ir_node *node);
281 /** Returns the number of value numbers of an IR graph. */
282 int get_irg_n_locs(ir_graph *irg);
284 /** Returns the graph number. */
285 long get_irg_graph_nr(const ir_graph *irg);
288 * Returns the graph number. This is a unique number for the graph and is
289 * smaller than get_irp_last_idx()
290 * Note: you cannot use this number for get_irp_irg()
292 int get_irg_idx(const ir_graph *irg);
294 /********************************************************************************/
295 /* States of an ir_graph. */
296 /********************************************************************************/
299 information associated with the graph. Optimizations invalidate these
302 /** The states of an ir graph.
304 * state phase values: phase_building, phase_high, phase_low, phase_backend.
306 * The graph is in phase_building during construction of the irgraph.
307 * The construction is finished by a call to finalize_cons().
309 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
312 * To get the irgraph into phase_low all Sel nodes must be removed and
313 * replaced by explicit address computations. SymConst size and
314 * type tag nodes must be removed (@@@ really?). Initialization of
315 * memory allocated by Alloc must be explicit. @@@ More conditions?
317 * phase_backend is set if architecture specific machine nodes are inserted
318 * (and probably most standard Firm are removed).
321 phase_building, /**< The graph is still being constructed. */
322 phase_high, /**< The construction of the graph is finish, high level nodes may be present. */
323 phase_low, /**< High level nodes are removed. */
324 phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */
327 /** Returns the phase_state of an IR graph. */
328 irg_phase_state get_irg_phase_state(const ir_graph *irg);
330 /** Sets the phase state of an IR graph. */
331 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
333 /** Sets the phase of the given IR graph to low. */
334 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
336 /** state: op_pin_state_pinned
337 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
338 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
339 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
340 invalid block, i.e., the block is not a dominator of all the uses of
342 The enum op_pin_state is defined in irop.h. */
343 op_pin_state get_irg_pinned(const ir_graph *irg);
345 /** state: outs_state
346 * Outs are the back edges or def-use edges of ir nodes.
347 * Values: outs_none, outs_consistent, outs_inconsistent */
349 outs_none, /**< Outs are not computed, no memory is allocated. */
350 outs_consistent, /**< Outs are computed and correct. */
351 outs_inconsistent /**< Outs have been computed, memory is still allocated,
352 but the graph has been changed since. */
354 irg_outs_state get_irg_outs_state(const ir_graph *irg);
355 void set_irg_outs_inconsistent(ir_graph *irg);
357 /** state: extended basic block state. */
359 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
360 extblk_valid = 1, /**< Extended basic block information is valid. */
361 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
363 irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
364 void set_irg_extblk_inconsistent(ir_graph *irg);
367 * Signals the state of the dominator / post dominator information.
370 dom_none, /**< dominator are not computed, no memory is allocated */
371 dom_consistent, /**< dominator information is computed and correct */
372 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
375 /** returns the dominator state of an IR graph. */
376 irg_dom_state get_irg_dom_state(const ir_graph *irg);
378 /** returns the post dominator state of an IR graph. */
379 irg_dom_state get_irg_postdom_state(const ir_graph *irg);
381 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
382 void set_irg_doms_inconsistent(ir_graph *irg);
384 /** state: loopinfo_state
385 * Loop information describes the loops within the control and
386 * data flow of the procedure.
389 loopinfo_none = 0, /**< No loop information is constructed. Default. */
390 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
391 loopinfo_valid = 2, /**< Loop information is valid. */
392 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
393 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
395 /** IntRAprocedural loop information constructed and valid. */
396 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
397 /** IntRAprocedural loop information constructed and invalid. */
398 loopinfo_inconsistent = loopinfo_constructed,
400 /** IntERprocedural loop information constructed and valid. */
401 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
402 /** IntERprocedural loop information constructed and invalid. */
403 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
405 /** IntRAprocedural control loop information constructed and valid. */
406 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
407 /** IntRAprocedural control loop information constructed and invalid. */
408 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
410 /** IntERprocedural control loop information constructed and valid. */
411 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
412 /** IntERprocedural control loop information constructed and invalid. */
413 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
414 } irg_loopinfo_state;
416 /** Return the current loop information state. */
417 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
419 /** Sets the current loop information state. */
420 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
422 /** Sets the loop information state to the appropriate inconsistent state.
423 * If state is 'none' does not change. */
424 void set_irg_loopinfo_inconsistent(ir_graph *irg);
425 /** Sets the loop information state to the appropriate inconsistent state.
426 * If state is 'none' does not change.
427 * Does this for all irgs. */
428 void set_irp_loopinfo_inconsistent(void);
430 /** state: callee_information_state
431 * Call nodes contain a list of possible callees. This list must be
432 * computed by an analysis.
434 * It's strange that this state is administered on irg basis, as the
435 * information must be computed for the whole program, or not?
438 irg_callee_info_none,
439 irg_callee_info_consistent,
440 irg_callee_info_inconsistent
441 } irg_callee_info_state;
443 /** Returns the callee_info_state of an IR graph. */
444 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
446 /** Sets the callee_info_state of an IR graph. */
447 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
450 * Tells how to handle an ir graph in inlining.
453 irg_inline_any, /**< No restriction on inlining. Default. */
454 irg_inline_forbidden, /**< The graph must not be inlined. */
455 irg_inline_recomended, /**< The graph should be inlined. */
456 irg_inline_forced, /**< The graph must be inlined. */
457 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
459 } irg_inline_property;
461 /** Returns the inline property of a graph. */
462 irg_inline_property get_irg_inline_property(const ir_graph *irg);
463 /** Sets the inline property of a graph. */
464 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
467 * Returns the mask of the additional graph properties.
468 * The properties are automatically inherited from the method type
469 * if they were not set using set_irg_additional_properties() or
470 * set_irg_additional_property().
472 * @return a bitset of mtp_additional_property values
474 unsigned get_irg_additional_properties(const ir_graph *irg);
476 /** Sets the mask of the additional graph properties. */
477 void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
479 /** Sets one additional graph property. */
480 void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
482 /** A void * field to link arbitrary information to the node. */
483 void set_irg_link (ir_graph *irg, void *thing);
484 void *get_irg_link (const ir_graph *irg);
486 /** Increments visited flag by one.
487 * @see also: get_irn_visited() get_irg_block_visited(). */
488 void inc_irg_visited(ir_graph *irg);
489 ir_visited_t get_irg_visited(const ir_graph *irg);
490 void set_irg_visited(ir_graph *irg, ir_visited_t i);
491 /** An interprocedural flag valid for all irgs.
492 * @see also: get_irn_visited() get_irg_block_visited(). */
493 ir_visited_t get_max_irg_visited(void);
494 void set_max_irg_visited(int val);
495 ir_visited_t inc_max_irg_visited(void);
497 /** Increments block_visited by one.
498 * @see also: get_irn_visited() get_irg_block_visited(). */
499 void inc_irg_block_visited(ir_graph *irg);
500 ir_visited_t get_irg_block_visited(const ir_graph *irg);
501 void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
504 * Debug helpers: You can indicate whether you are currently using visited or
505 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
506 * if 2 parties try to use the flags.
508 enum ir_resources_enum_t {
509 /* local (irg) resources */
510 IR_RESOURCE_BLOCK_VISITED = 1 << 0, /**< Block visited flags are used. */
511 IR_RESOURCE_BLOCK_MARK = 1 << 1, /**< Block mark bits are used. */
512 IR_RESOURCE_IRN_VISITED = 1 << 2, /**< IR-node visited flags are used. */
513 IR_RESOURCE_IRN_LINK = 1 << 3, /**< IR-node link fields are used. */
514 IR_RESOURCE_LOOP_LINK = 1 << 4, /**< IR-loop link fields are used. */
515 IR_RESOURCE_PHI_LIST = 1 << 5, /**< Block Phi lists are used. */
516 IR_RESOURCE_IRG_LINK = 1 << 6, /**< IR-graph link fields used. */
518 /* global (irp) resources */
519 IR_RESOURCE_ENTITY_LINK = 1 << 8, /**< IR-entity link fields are used. */
522 IR_RESOURCE_LOCAL_MASK = 0x00FF, /**< Mask for all local resources. */
523 IR_RESOURCE_GLOBAL_MASK = 0xFF00 /**< Mask for all global resources. */
525 typedef unsigned ir_resources_t;
528 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
529 void ir_free_resources(ir_graph *irg, ir_resources_t resources);
530 ir_resources_t ir_resources_reserved(const ir_graph *irg);
532 #define ir_reserve_resources(irg,resources)
533 #define ir_free_resources(irg,resources)
534 #define ir_resources_reserved(irg) 0
537 /** Normalization: Move Proj nodes into the same block as its predecessors */
538 void normalize_proj_nodes(ir_graph *irg);
540 /** Set a description for local value n. */
541 void set_irg_loc_description(ir_graph *irg, int n, void *description);
543 /** Get the description for local value n. */
544 void *get_irg_loc_description(ir_graph *irg, int n);
546 /** Returns a estimated node count of the irg. This count is updated
547 * after every irg_walk_graph().
549 unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
551 /** Returns the last irn index for this graph. */
552 unsigned get_irg_last_idx(const ir_graph *irg);
554 /** Returns the floating point model of this graph. */
555 unsigned get_irg_fp_model(const ir_graph *irg);
557 /** Sets a floating point model for this graph. */
558 void set_irg_fp_model(ir_graph *irg, unsigned model);
561 * Access custom graph data.
562 * The data must have been registered with
563 * register_additional_graph_data() before.
564 * @param graph The graph to get the data from.
565 * @param type The type of the data you registered.
566 * @param off The value returned by register_additional_graph_data().
567 * @return A pointer of type @p type.
569 #define get_irg_data(graph,type,off) \
570 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
573 * Get the pointer to the node some custom data belongs to.
574 * @param data The pointer to the custom data.
575 * @param off The number as returned by register_additional_graph_data().
576 * @return A pointer to the ir node the custom data belongs to.
578 #define get_irg_data_base(data,off) \
579 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
582 * Request additional data to be allocated with an ir graph.
583 * @param size The size of the additional data required.
584 * @return A positive number, if the operation was successful, which
585 * must be passed to the access macro get_irg_data(), 0 if the
586 * registration failed.
588 size_t register_additional_graph_data(size_t size);