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"
35 * @page ir_graph The struct ir_graph
37 * This struct contains all information about a procedure.
38 * It's allocated directly to memory.
40 * The fields of ir_graph:
42 * - ent The entity describing this procedure.
44 * The beginning and end of a graph:
46 * - start_block This ir_node is the block that contains the unique
47 * start node of the procedure. With it it contains
48 * the Proj's on starts results.
49 * Further all Const nodes are placed in the start block.
50 * - start This ir_node is the unique start node of the procedure.
52 * - end_block This ir_node is the block that contains the unique
53 * end node of the procedure. This block contains no
55 * - end This ir_node is the unique end node of the procedure.
57 * The following nodes are Projs from the Start node, held in ir_graph for
60 * - frame The ir_node producing the pointer to the stack frame of
61 * the procedure as output. This is the Proj node on the
62 * third output of the start node. This output of the start
63 * node is tagged as pns_frame_base. In FIRM most local
64 * variables are modeled as data flow edges. Static
65 * allocated arrays can not be represented as data flow
66 * edges. Therefore FIRM has to represent them in the stack
69 * - globals This models a pointer to a space in the memory where
70 * _all_ global things are held. Select from this pointer
71 * with a Sel node the pointer to a global variable /
72 * procedure / compiler known function... .
74 * - tls This models a pointer to a space in the memory where
75 * thread local things are held. Select from this pointer
76 * with a Sel node the pointer to a thread local variable.
78 * - args The ir_node that produces the arguments of the method as
79 * it's result. This is a Proj node on the fourth output of
80 * the start node. This output is tagged as pn_Start_T_args.
82 * - proj_args The proj nodes of the args node.
84 * - bad The Bad node is an auxiliary node. It is needed only once,
85 * so there is this globally reachable node.
87 * - no_mem The NoMem node is an auxiliary node. It is needed only once,
88 * so there is this globally reachable node.
90 * Data structures that are private to a graph:
92 * - obst An obstack that contains all nodes.
94 * - current_block A pointer to the current block. Any node created with
95 * one of the node constructors (new_<opcode>) are assigned
96 * to this block. It can be set with set_cur_block(block).
97 * Only needed for ir construction.
99 * - params/n_loc An int giving the number of local variables in this
100 * procedure. This is needed for ir construction. Name will
103 * - value_table This hash table (pset) is used for global value numbering
104 * for optimizing use in iropt.c.
106 * - Phi_in_stack; a stack needed for automatic Phi construction, needed only
107 * during ir construction.
109 * - visited A int used as flag to traverse the ir_graph.
111 * - block_visited A int used as a flag to traverse block nodes in the graph.
114 /** Global variable holding the current ir graph.
116 * This global variable is used by the ir construction
117 * interface in ircons and by the optimizations.
118 * Further it is set by all walker functions.
120 FIRM_API ir_graph *current_ir_graph;
122 FIRM_API ir_graph *get_current_ir_graph(void);
123 FIRM_API void set_current_ir_graph(ir_graph *graph);
126 * Create a new ir graph to build ir for a procedure.
128 * @param ent A pointer to an entity representing the procedure,
129 * i.e., the type of the entity must be of a method type.
131 * @param n_loc The number of local variables in this procedure including
132 * the procedure parameters.
134 * This constructor generates the basic infrastructure needed to
135 * represent a procedure in FIRM.
137 * It allocates an ir_graph and sets the field irg of the entity ent
138 * as well as current_ir_graph to point to this graph.
139 * Further it allocates the following nodes needed for every
142 * - The start block containing a start node and Proj nodes for it's
143 * seven results (X, M, P, P, P, T, P).
144 * - The end block containing an end node. This block is not matured
145 * after executing new_ir_graph() as predecessors need to be added to it.
146 * (Maturing a block means fixing it's number of predecessors.)
147 * - The current block, which is empty and also not matured.
149 * Further it enters the global store into the data structure of the start
150 * block that contains all valid values in this block (set_store()). This
151 * data structure is used to build the Phi nodes and removed after
152 * completion of the graph. There is no path from end to start in the
153 * graph after calling ir_graph.
155 * The op_pin_state of the graph is set to "op_pin_state_pinned"
156 * if no global cse was performed on the graph.
157 * It is set to "op_pin_state_floats" if global cse was performed
158 * (and during construction: did actually change something).
159 * Code placement is necessary.
161 * @see new_pseudo_ir_graph()
163 FIRM_API ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
165 /** Frees the passed irgraph.
166 * Deallocates all nodes in this graph and the ir_graph structure.
167 * Sets the field irgraph in the corresponding entity to NULL.
168 * Does not remove the irgraph from the list in irprog (requires
169 * inefficient search, call remove_irp_irg by hand).
170 * Does not free types, entities or modes that are used only by this
171 * graph, nor the entity standing for this graph.
173 FIRM_API void free_ir_graph(ir_graph *irg);
175 /* --- access routines for all ir_graph attributes --- */
178 * Checks whether a pointer points to a ir graph.
180 * @param thing an arbitrary pointer
183 * true if the thing is a IR graph, else false
185 FIRM_API int is_ir_graph(const void *thing);
187 /** Returns the entity of an IR graph. */
188 FIRM_API ir_entity *get_irg_entity(const ir_graph *irg);
189 /** Sets the entity of an IR graph. */
190 FIRM_API void set_irg_entity(ir_graph *irg, ir_entity *ent);
192 /** Returns the frame type of an IR graph. */
193 FIRM_API ir_type *get_irg_frame_type(ir_graph *irg);
194 /** Sets the frame type of an IR graph. */
195 FIRM_API void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
197 /** Returns the value parameter type of an IR graph. */
198 FIRM_API ir_type *get_irg_value_param_type(ir_graph *irg);
200 /** Returns the start block of an IR graph. */
201 FIRM_API ir_node *get_irg_start_block(const ir_graph *irg);
202 /** Sets the start block of an IR graph. */
203 FIRM_API void set_irg_start_block(ir_graph *irg, ir_node *node);
205 /** Returns the Start node of an IR graph. */
206 FIRM_API ir_node *get_irg_start(const ir_graph *irg);
207 /** Sets the Start node of an IR graph. */
208 FIRM_API void set_irg_start(ir_graph *irg, ir_node *node);
210 /** Returns the end block of an IR graph. */
211 FIRM_API ir_node *get_irg_end_block(const ir_graph *irg);
212 /** Sets the end block of an IR graph. */
213 FIRM_API void set_irg_end_block(ir_graph *irg, ir_node *node);
215 /** Returns the End node of an IR graph. */
216 FIRM_API ir_node *get_irg_end(const ir_graph *irg);
217 /** Sets the End node of an IR graph. */
218 FIRM_API void set_irg_end(ir_graph *irg, ir_node *node);
220 /** Returns the node that represents the initial control flow of the given
222 FIRM_API ir_node *get_irg_initial_exec(const ir_graph *irg);
223 /** Sets the node that represents the initial control of the given IR graph. */
224 FIRM_API void set_irg_initial_exec(ir_graph *irg, ir_node *node);
226 /** Returns the node that represents the frame pointer of the given IR graph. */
227 FIRM_API ir_node *get_irg_frame(const ir_graph *irg);
228 /** Sets the node that represents the frame pointer of the given IR graph. */
229 FIRM_API void set_irg_frame(ir_graph *irg, ir_node *node);
231 /** Returns the node that represents the tls pointer of the given IR graph. */
232 FIRM_API ir_node *get_irg_tls(const ir_graph *irg);
233 /** Sets the node that represents the tls pointer of the given IR graph. */
234 FIRM_API void set_irg_tls(ir_graph *irg, ir_node *node);
236 /** Returns the node that represents the initial memory of the given IR graph. */
237 FIRM_API ir_node *get_irg_initial_mem(const ir_graph *irg);
238 /** Sets the node that represents the initial memory of the given IR graph. */
239 FIRM_API void set_irg_initial_mem(ir_graph *irg, ir_node *node);
241 /** Returns the node that represents the argument pointer of the given IR graph. */
242 FIRM_API ir_node *get_irg_args(const ir_graph *irg);
243 /** Sets the node that represents the argument pointer of the given IR graph. */
244 FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
246 /** Returns the current block of an IR graph. */
247 FIRM_API ir_node *get_irg_current_block(const ir_graph *irg);
248 /** Sets the current block of an IR graph. */
249 FIRM_API void set_irg_current_block(ir_graph *irg, ir_node *node);
251 /** Returns the Bad node of the given IR graph. Use new_Bad() instead!! */
252 FIRM_API ir_node *get_irg_bad(const ir_graph *irg);
253 FIRM_API void set_irg_bad(ir_graph *irg, ir_node *node);
255 /** Returns the NoMem node of the given IR graph. Use new_NoMem() instead!! */
256 FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg);
257 FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node);
259 /** Returns the number of value numbers of an IR graph. */
260 FIRM_API int get_irg_n_locs(ir_graph *irg);
262 /** Returns the graph number. */
263 FIRM_API long get_irg_graph_nr(const ir_graph *irg);
266 * Returns the graph number. This is a unique number for the graph and is
267 * smaller than get_irp_last_idx()
268 * Note: you cannot use this number for get_irp_irg()
270 FIRM_API int get_irg_idx(const ir_graph *irg);
273 * Get the node for an index.
274 * @param irg The graph.
275 * @param idx The index you want the node for.
276 * @return The node with that index or NULL, if there is no node with that
278 * @note The node you got might be dead.
280 FIRM_API ir_node *get_idx_irn(ir_graph *irg, unsigned idx);
283 /******************************************************************************/
284 /* States of an ir_graph. */
285 /******************************************************************************/
288 information associated with the graph. Optimizations invalidate these
291 /** The states of an ir graph.
293 * state phase values: phase_building, phase_high, phase_low, phase_backend.
295 * The graph is in phase_building during construction of the irgraph.
296 * The construction is finished by a call to finalize_cons().
298 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
301 * To get the irgraph into phase_low all Sel nodes must be removed and
302 * replaced by explicit address computations. SymConst size and
303 * type tag nodes must be removed (@@@ really?). Initialization of
304 * memory allocated by Alloc must be explicit. @@@ More conditions?
306 * phase_backend is set if architecture specific machine nodes are inserted
307 * (and probably most standard Firm are removed).
310 phase_building, /**< The graph is still being constructed. */
311 phase_high, /**< The construction of the graph is finish, high level nodes may be present. */
312 phase_low, /**< High level nodes are removed. */
313 phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */
316 /** Returns the phase_state of an IR graph. */
317 FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg);
319 /** Sets the phase state of an IR graph. */
320 FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
322 /** Sets the phase of the given IR graph to low. */
323 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
325 /** state: op_pin_state_pinned
326 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
327 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
328 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
329 invalid block, i.e., the block is not a dominator of all the uses of
331 The enum op_pin_state is defined in irop.h. */
332 FIRM_API op_pin_state get_irg_pinned(const ir_graph *irg);
334 /** state: outs_state
335 * Outs are the back edges or def-use edges of ir nodes.
336 * Values: outs_none, outs_consistent, outs_inconsistent */
338 outs_none, /**< Outs are not computed, no memory is allocated. */
339 outs_consistent, /**< Outs are computed and correct. */
340 outs_inconsistent /**< Outs have been computed, memory is still allocated,
341 but the graph has been changed since. */
343 FIRM_API irg_outs_state get_irg_outs_state(const ir_graph *irg);
344 FIRM_API void set_irg_outs_inconsistent(ir_graph *irg);
346 /** state: extended basic block state. */
348 extblk_none = 0, /**< No extended basic block information is constructed. Default. */
349 extblk_valid = 1, /**< Extended basic block information is valid. */
350 extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
352 FIRM_API irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
353 FIRM_API void set_irg_extblk_inconsistent(ir_graph *irg);
356 * Signals the state of the dominator / post dominator information.
359 dom_none, /**< dominator are not computed, no memory is allocated */
360 dom_consistent, /**< dominator information is computed and correct */
361 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
364 /** returns the dominator state of an IR graph. */
365 FIRM_API irg_dom_state get_irg_dom_state(const ir_graph *irg);
367 /** returns the post dominator state of an IR graph. */
368 FIRM_API irg_dom_state get_irg_postdom_state(const ir_graph *irg);
370 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
371 FIRM_API void set_irg_doms_inconsistent(ir_graph *irg);
373 /** state: loopinfo_state
374 * Loop information describes the loops within the control and
375 * data flow of the procedure.
378 loopinfo_none = 0, /**< No loop information is constructed. Default. */
379 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
380 loopinfo_valid = 2, /**< Loop information is valid. */
381 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
382 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
384 /** IntRAprocedural loop information constructed and valid. */
385 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
386 /** IntRAprocedural loop information constructed and invalid. */
387 loopinfo_inconsistent = loopinfo_constructed,
389 /** IntERprocedural loop information constructed and valid. */
390 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
391 /** IntERprocedural loop information constructed and invalid. */
392 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
394 /** IntRAprocedural control loop information constructed and valid. */
395 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
396 /** IntRAprocedural control loop information constructed and invalid. */
397 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
399 /** IntERprocedural control loop information constructed and valid. */
400 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
401 /** IntERprocedural control loop information constructed and invalid. */
402 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
403 } irg_loopinfo_state;
405 /** Return the current loop information state. */
406 FIRM_API irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
408 /** Sets the current loop information state. */
409 FIRM_API void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
411 /** Sets the loop information state to the appropriate inconsistent state.
412 * If state is 'none' does not change. */
413 FIRM_API void set_irg_loopinfo_inconsistent(ir_graph *irg);
414 /** Sets the loop information state to the appropriate inconsistent state.
415 * If state is 'none' does not change.
416 * Does this for all irgs. */
417 FIRM_API void set_irp_loopinfo_inconsistent(void);
419 /** state: callee_information_state
420 * Call nodes contain a list of possible callees. This list must be
421 * computed by an analysis.
423 * It's strange that this state is administered on irg basis, as the
424 * information must be computed for the whole program, or not?
427 irg_callee_info_none,
428 irg_callee_info_consistent,
429 irg_callee_info_inconsistent
430 } irg_callee_info_state;
432 /** Returns the callee_info_state of an IR graph. */
433 FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
435 /** Sets the callee_info_state of an IR graph. */
436 FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
439 * Tells how to handle an ir graph in inlining.
442 irg_inline_any, /**< No restriction on inlining. Default. */
443 irg_inline_forbidden, /**< The graph must not be inlined. */
444 irg_inline_recomended, /**< The graph should be inlined. */
445 irg_inline_forced, /**< The graph must be inlined. */
446 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
448 } irg_inline_property;
450 /** Returns the inline property of a graph. */
451 FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg);
452 /** Sets the inline property of a graph. */
453 FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
456 * Returns the mask of the additional graph properties.
457 * The properties are automatically inherited from the method type
458 * if they were not set using set_irg_additional_properties() or
459 * set_irg_additional_property().
461 * @return a bitset of mtp_additional_property values
463 FIRM_API unsigned get_irg_additional_properties(const ir_graph *irg);
465 /** Sets the mask of the additional graph properties. */
466 FIRM_API void set_irg_additional_properties(ir_graph *irg,
467 unsigned property_mask);
469 /** Sets one additional graph property. */
470 FIRM_API void set_irg_additional_property(ir_graph *irg,
471 mtp_additional_property flag);
473 /** A void * field to link arbitrary information to the node. */
474 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
475 FIRM_API void *get_irg_link(const ir_graph *irg);
477 /** Increments visited flag by one.
478 * @see also: get_irn_visited() get_irg_block_visited(). */
479 FIRM_API void inc_irg_visited(ir_graph *irg);
480 FIRM_API ir_visited_t get_irg_visited(const ir_graph *irg);
481 FIRM_API void set_irg_visited(ir_graph *irg, ir_visited_t i);
482 /** An interprocedural flag valid for all irgs.
483 * @see also: get_irn_visited() get_irg_block_visited(). */
484 FIRM_API ir_visited_t get_max_irg_visited(void);
485 FIRM_API void set_max_irg_visited(int val);
486 FIRM_API ir_visited_t inc_max_irg_visited(void);
488 /** Increments block_visited by one.
489 * @see also: get_irn_visited() get_irg_block_visited(). */
490 FIRM_API void inc_irg_block_visited(ir_graph *irg);
491 FIRM_API ir_visited_t get_irg_block_visited(const ir_graph *irg);
492 FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
495 * Debug helpers: You can indicate whether you are currently using visited or
496 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
497 * if 2 parties try to use the flags.
499 enum ir_resources_enum_t {
500 /* local (irg) resources */
501 IR_RESOURCE_BLOCK_VISITED = 1 << 0, /**< Block visited flags are used. */
502 IR_RESOURCE_BLOCK_MARK = 1 << 1, /**< Block mark bits are used. */
503 IR_RESOURCE_IRN_VISITED = 1 << 2, /**< IR-node visited flags are used. */
504 IR_RESOURCE_IRN_LINK = 1 << 3, /**< IR-node link fields are used. */
505 IR_RESOURCE_LOOP_LINK = 1 << 4, /**< IR-loop link fields are used. */
506 IR_RESOURCE_PHI_LIST = 1 << 5, /**< Block Phi lists are used. */
507 IR_RESOURCE_IRG_LINK = 1 << 6, /**< IR-graph link fields used. */
509 /* global (irp) resources */
510 IR_RESOURCE_ENTITY_LINK = 1 << 8, /**< IR-entity link fields are used. */
511 IR_RESOURCE_TYPE_VISITED = 1 << 9, /**< type visited flags */
514 IR_RESOURCE_LOCAL_MASK = 0x00FF, /**< Mask for all local resources. */
515 IR_RESOURCE_GLOBAL_MASK = 0xFF00 /**< Mask for all global resources. */
517 typedef unsigned ir_resources_t;
520 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
521 FIRM_API void ir_free_resources(ir_graph *irg, ir_resources_t resources);
522 FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg);
524 #define ir_reserve_resources(irg,resources) (void)0
525 #define ir_free_resources(irg,resources) (void)0
526 #define ir_resources_reserved(irg) 0
533 IR_GRAPH_STATE_KEEP_MUX = 1 << 0, /**< should perform no further optimisations on Mux nodes */
534 IR_GRAPH_STATE_ARCH_DEP = 1 << 1, /**< should not construct more nodes which irarch potentially breaks down */
537 /** set some state flags on the graph (this does not clear the other flags) */
538 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
539 /** clear some state flags of the graph */
540 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
541 /** query wether a set of graph state flags are activated */
542 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
544 /** Normalization: Move Proj nodes into the same block as its predecessors */
545 FIRM_API void normalize_proj_nodes(ir_graph *irg);
547 /** Set a description for local value n. */
548 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);
550 /** Get the description for local value n. */
551 FIRM_API void *get_irg_loc_description(ir_graph *irg, int n);
553 /** Returns a estimated node count of the irg. This count is updated
554 * after every irg_walk_graph().
556 FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
558 /** Returns the last irn index for this graph. */
559 FIRM_API unsigned get_irg_last_idx(const ir_graph *irg);
561 /** Returns the floating point model of this graph. */
562 FIRM_API unsigned get_irg_fp_model(const ir_graph *irg);
564 /** Sets a floating point model for this graph. */
565 FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model);
568 * Access custom graph data.
569 * The data must have been registered with
570 * register_additional_graph_data() before.
571 * @param graph The graph to get the data from.
572 * @param type The type of the data you registered.
573 * @param off The value returned by register_additional_graph_data().
574 * @return A pointer of type @p type.
576 #define get_irg_data(graph,type,off) \
577 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
580 * Get the pointer to the node some custom data belongs to.
581 * @param data The pointer to the custom data.
582 * @param off The number as returned by register_additional_graph_data().
583 * @return A pointer to the ir node the custom data belongs to.
585 #define get_irg_data_base(data,off) \
586 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
589 * Request additional data to be allocated with an ir graph.
590 * @param size The size of the additional data required.
591 * @return A positive number, if the operation was successful, which
592 * must be passed to the access macro get_irg_data(), 0 if the
593 * registration failed.
595 FIRM_API size_t register_additional_graph_data(size_t size);