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 * its 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 * to point to this graph. Further it allocates the following nodes needed
139 * for every procedure:
141 * - The start block containing a start node and Proj nodes for its
142 * seven results (X, M, P, P, P, T, P).
143 * - The end block containing an end node. This block is not matured
144 * after executing new_ir_graph() as predecessors need to be added to it.
145 * (Maturing a block means fixing its number of predecessors.)
146 * - The current block, which is empty and also not matured.
148 * Further it enters the global store into the data structure of the start
149 * block that contains all valid values in this block (set_store()). This
150 * data structure is used to build the Phi nodes and removed after
151 * completion of the graph. There is no path from end to start in the
152 * graph after calling ir_graph.
154 * The op_pin_state of the graph is set to "op_pin_state_pinned"
155 * if no global cse was performed on the graph.
156 * It is set to "op_pin_state_floats" if global cse was performed
157 * (and during construction: did actually change something).
158 * Code placement is necessary.
160 * @see new_pseudo_ir_graph()
162 FIRM_API ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
164 /** Frees the passed irgraph.
165 * Deallocates all nodes in this graph and the ir_graph structure.
166 * Sets the field irgraph in the corresponding entity to NULL.
167 * Does not remove the irgraph from the list in irprog (requires
168 * inefficient search, call remove_irp_irg by hand).
169 * Does not free types, entities or modes that are used only by this
170 * graph, nor the entity standing for this graph.
172 FIRM_API void free_ir_graph(ir_graph *irg);
174 /* --- access routines for all ir_graph attributes --- */
177 * Checks whether a pointer points to a ir graph.
179 * @param thing an arbitrary pointer
182 * true if the thing is a IR graph, else false
184 FIRM_API int is_ir_graph(const void *thing);
186 /** Returns the entity of an IR graph. */
187 FIRM_API ir_entity *get_irg_entity(const ir_graph *irg);
188 /** Sets the entity of an IR graph. */
189 FIRM_API void set_irg_entity(ir_graph *irg, ir_entity *ent);
191 /** Returns the frame type of an IR graph. */
192 FIRM_API ir_type *get_irg_frame_type(ir_graph *irg);
193 /** Sets the frame type of an IR graph. */
194 FIRM_API void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
196 /** Returns the value parameter type of an IR graph. */
197 FIRM_API ir_type *get_irg_value_param_type(ir_graph *irg);
199 /** Returns the start block of an IR graph. */
200 FIRM_API ir_node *get_irg_start_block(const ir_graph *irg);
201 /** Sets the start block of an IR graph. */
202 FIRM_API void set_irg_start_block(ir_graph *irg, ir_node *node);
204 /** Returns the Start node of an IR graph. */
205 FIRM_API ir_node *get_irg_start(const ir_graph *irg);
206 /** Sets the Start node of an IR graph. */
207 FIRM_API void set_irg_start(ir_graph *irg, ir_node *node);
209 /** Returns the end block of an IR graph. */
210 FIRM_API ir_node *get_irg_end_block(const ir_graph *irg);
211 /** Sets the end block of an IR graph. */
212 FIRM_API void set_irg_end_block(ir_graph *irg, ir_node *node);
214 /** Returns the End node of an IR graph. */
215 FIRM_API ir_node *get_irg_end(const ir_graph *irg);
216 /** Sets the End node of an IR graph. */
217 FIRM_API void set_irg_end(ir_graph *irg, ir_node *node);
219 /** Returns the node that represents the initial control flow of the given
221 FIRM_API ir_node *get_irg_initial_exec(const ir_graph *irg);
222 /** Sets the node that represents the initial control of the given IR graph. */
223 FIRM_API void set_irg_initial_exec(ir_graph *irg, ir_node *node);
225 /** Returns the node that represents the frame pointer of the given IR graph. */
226 FIRM_API ir_node *get_irg_frame(const ir_graph *irg);
227 /** Sets the node that represents the frame pointer of the given IR graph. */
228 FIRM_API void set_irg_frame(ir_graph *irg, ir_node *node);
230 /** Returns the node that represents the initial memory of the given IR graph. */
231 FIRM_API ir_node *get_irg_initial_mem(const ir_graph *irg);
232 /** Sets the node that represents the initial memory of the given IR graph. */
233 FIRM_API void set_irg_initial_mem(ir_graph *irg, ir_node *node);
235 /** Returns the node that represents the argument pointer of the given IR graph. */
236 FIRM_API ir_node *get_irg_args(const ir_graph *irg);
237 /** Sets the node that represents the argument pointer of the given IR graph. */
238 FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
240 /** Returns the Bad node of the given IR graph. Use new_Bad() instead!! */
241 FIRM_API ir_node *get_irg_bad(const ir_graph *irg);
242 FIRM_API void set_irg_bad(ir_graph *irg, ir_node *node);
244 /** Returns the NoMem node of the given IR graph. Use new_NoMem() instead!! */
245 FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg);
246 FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node);
248 /** Returns the number of value numbers of an IR graph. */
249 FIRM_API int get_irg_n_locs(ir_graph *irg);
251 /** Returns the graph number. */
252 FIRM_API long get_irg_graph_nr(const ir_graph *irg);
255 * Returns the graph number. This is a unique number for the graph and is
256 * smaller than get_irp_last_idx()
257 * Note: you cannot use this number for get_irp_irg()
259 FIRM_API size_t get_irg_idx(const ir_graph *irg);
262 * Get the node for an index.
263 * @param irg The graph.
264 * @param idx The index you want the node for.
265 * @return The node with that index or NULL, if there is no node with that
267 * @note The node you got might be dead.
269 FIRM_API ir_node *get_idx_irn(ir_graph *irg, unsigned idx);
272 /******************************************************************************/
273 /* States of an ir_graph. */
274 /******************************************************************************/
277 information associated with the graph. Optimizations invalidate these
280 /** The states of an ir graph.
282 * state phase values: phase_building, phase_high, phase_low, phase_backend.
284 * The graph is in phase_building during construction of the irgraph.
285 * The construction is finished by a call to finalize_cons().
287 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
290 * To get the irgraph into phase_low all Sel nodes must be removed and
291 * replaced by explicit address computations. SymConst size and
292 * type tag nodes must be removed (@@@ really?). Initialization of
293 * memory allocated by Alloc must be explicit. @@@ More conditions?
295 * phase_backend is set if architecture specific machine nodes are inserted
296 * (and probably most standard Firm are removed).
299 phase_building, /**< The graph is still being constructed. */
300 phase_high, /**< The construction of the graph is finish, high level nodes may be present. */
301 phase_low, /**< High level nodes are removed. */
302 phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */
305 /** Returns the phase_state of an IR graph. */
306 FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg);
308 /** Sets the phase state of an IR graph. */
309 FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
311 /** state: op_pin_state_pinned
312 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
313 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
314 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
315 invalid block, i.e., the block is not a dominator of all the uses of
317 The enum op_pin_state is defined in irop.h. */
318 FIRM_API op_pin_state get_irg_pinned(const ir_graph *irg);
320 /** state: outs_state
321 * Outs are the back edges or def-use edges of ir nodes.
322 * Values: outs_none, outs_consistent, outs_inconsistent */
324 outs_none, /**< Outs are not computed, no memory is allocated. */
325 outs_consistent, /**< Outs are computed and correct. */
326 outs_inconsistent /**< Outs have been computed, memory is still allocated,
327 but the graph has been changed since. */
329 FIRM_API irg_outs_state get_irg_outs_state(const ir_graph *irg);
330 FIRM_API void set_irg_outs_inconsistent(ir_graph *irg);
332 /** state: extended basic block state. */
334 ir_extblk_info_none = 0, /**< No extended basic block information is constructed. Default. */
335 ir_extblk_info_valid = 1, /**< Extended basic block information is valid. */
336 ir_extblk_info_invalid = 2 /**< Extended basic block information is constructed but invalid. */
337 } irg_extblk_info_state;
338 FIRM_API irg_extblk_info_state get_irg_extblk_state(const ir_graph *irg);
339 FIRM_API void set_irg_extblk_inconsistent(ir_graph *irg);
342 * Signals the state of the dominator / post dominator information.
345 dom_none, /**< dominator are not computed, no memory is allocated */
346 dom_consistent, /**< dominator information is computed and correct */
347 dom_inconsistent /**< dominator information is computed but the graph has been changed since */
350 /** returns the dominator state of an IR graph. */
351 FIRM_API irg_dom_state get_irg_dom_state(const ir_graph *irg);
353 /** returns the post dominator state of an IR graph. */
354 FIRM_API irg_dom_state get_irg_postdom_state(const ir_graph *irg);
356 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
357 FIRM_API void set_irg_doms_inconsistent(ir_graph *irg);
359 /** state: loopinfo_state
360 * Loop information describes the loops within the control and
361 * data flow of the procedure.
364 loopinfo_none = 0, /**< No loop information is constructed. Default. */
365 loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
366 loopinfo_valid = 2, /**< Loop information is valid. */
367 loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
368 loopinfo_inter = 8, /**< Loop information for interprocedural view. */
370 /** IntRAprocedural loop information constructed and valid. */
371 loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
372 /** IntRAprocedural loop information constructed and invalid. */
373 loopinfo_inconsistent = loopinfo_constructed,
375 /** IntERprocedural loop information constructed and valid. */
376 loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
377 /** IntERprocedural loop information constructed and invalid. */
378 loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
380 /** IntRAprocedural control loop information constructed and valid. */
381 loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
382 /** IntRAprocedural control loop information constructed and invalid. */
383 loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
385 /** IntERprocedural control loop information constructed and valid. */
386 loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
387 /** IntERprocedural control loop information constructed and invalid. */
388 loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
389 } irg_loopinfo_state;
391 /** Return the current loop information state. */
392 FIRM_API irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
394 /** Sets the current loop information state. */
395 FIRM_API void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
397 /** Sets the loop information state to the appropriate inconsistent state.
398 * If state is 'none' does not change. */
399 FIRM_API void set_irg_loopinfo_inconsistent(ir_graph *irg);
400 /** Sets the loop information state to the appropriate inconsistent state.
401 * If state is 'none' does not change.
402 * Does this for all irgs. */
403 FIRM_API void set_irp_loopinfo_inconsistent(void);
405 /** state: callee_information_state
406 * Call nodes contain a list of possible callees. This list must be
407 * computed by an analysis.
409 * It's strange that this state is administered on irg basis, as the
410 * information must be computed for the whole program, or not?
413 irg_callee_info_none,
414 irg_callee_info_consistent,
415 irg_callee_info_inconsistent
416 } irg_callee_info_state;
418 /** Returns the callee_info_state of an IR graph. */
419 FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
421 /** Sets the callee_info_state of an IR graph. */
422 FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
425 * Tells how to handle an ir graph in inlining.
428 irg_inline_any, /**< No restriction on inlining. Default. */
429 irg_inline_forbidden, /**< The graph must not be inlined. */
430 irg_inline_recomended, /**< The graph should be inlined. */
431 irg_inline_forced, /**< The graph must be inlined. */
432 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
434 } irg_inline_property;
436 /** Returns the inline property of a graph. */
437 FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg);
438 /** Sets the inline property of a graph. */
439 FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
442 * Returns the mask of the additional graph properties.
443 * The properties are automatically inherited from the method type
444 * if they were not set using set_irg_additional_properties() or
445 * set_irg_additional_properties().
447 * @return a bitset of mtp_additional_properties values
449 FIRM_API mtp_additional_properties get_irg_additional_properties(const ir_graph *irg);
451 /** Sets the mask of the additional graph properties. */
452 FIRM_API void set_irg_additional_properties(ir_graph *irg,
453 mtp_additional_properties property_mask);
455 /** Sets one additional graph property. */
456 FIRM_API void add_irg_additional_properties(ir_graph *irg,
457 mtp_additional_properties flag);
459 /** A void * field to link arbitrary information to the node. */
460 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
461 FIRM_API void *get_irg_link(const ir_graph *irg);
463 /** Increments visited flag by one.
464 * @see also: get_irn_visited() get_irg_block_visited(). */
465 FIRM_API void inc_irg_visited(ir_graph *irg);
466 FIRM_API ir_visited_t get_irg_visited(const ir_graph *irg);
467 FIRM_API void set_irg_visited(ir_graph *irg, ir_visited_t i);
468 /** An interprocedural flag valid for all irgs.
469 * @see also: get_irn_visited() get_irg_block_visited(). */
470 FIRM_API ir_visited_t get_max_irg_visited(void);
471 FIRM_API void set_max_irg_visited(int val);
472 FIRM_API ir_visited_t inc_max_irg_visited(void);
474 /** Increments block_visited by one.
475 * @see also: get_irn_visited() get_irg_block_visited(). */
476 FIRM_API void inc_irg_block_visited(ir_graph *irg);
477 FIRM_API ir_visited_t get_irg_block_visited(const ir_graph *irg);
478 FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
481 * Debug helpers: You can indicate whether you are currently using visited or
482 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
483 * if 2 parties try to use the flags.
485 typedef enum ir_resources_t {
486 /* local (irg) resources */
487 IR_RESOURCE_NONE = 0,
488 IR_RESOURCE_BLOCK_VISITED = 1 << 0, /**< Block visited flags are used. */
489 IR_RESOURCE_BLOCK_MARK = 1 << 1, /**< Block mark bits are used. */
490 IR_RESOURCE_IRN_VISITED = 1 << 2, /**< IR-node visited flags are used. */
491 IR_RESOURCE_IRN_LINK = 1 << 3, /**< IR-node link fields are used. */
492 IR_RESOURCE_LOOP_LINK = 1 << 4, /**< IR-loop link fields are used. */
493 IR_RESOURCE_PHI_LIST = 1 << 5, /**< Block Phi lists are used. */
494 IR_RESOURCE_IRG_LINK = 1 << 6, /**< IR-graph link fields used. */
496 /* global (irp) resources */
497 IR_RESOURCE_ENTITY_LINK = 1 << 8, /**< IR-entity link fields are used. */
498 IR_RESOURCE_TYPE_VISITED = 1 << 9, /**< type visited flags */
501 IR_RESOURCE_LOCAL_MASK = 0x00FF, /**< Mask for all local resources. */
502 IR_RESOURCE_GLOBAL_MASK = 0xFF00 /**< Mask for all global resources. */
504 ENUM_BITSET(ir_resources_t)
507 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
508 FIRM_API void ir_free_resources(ir_graph *irg, ir_resources_t resources);
509 FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg);
511 #define ir_reserve_resources(irg,resources) (void)0
512 #define ir_free_resources(irg,resources) (void)0
513 #define ir_resources_reserved(irg) 0
520 IR_GRAPH_STATE_KEEP_MUX = 1U << 0, /**< should perform no further optimisations on Mux nodes */
521 IR_GRAPH_STATE_ARCH_DEP = 1U << 1, /**< should not construct more nodes which irarch potentially breaks down */
522 IR_GRAPH_STATE_BCONV_ALLOWED = 1U << 2, /**< Conv(mode_b) to Iu is allowed as set command */
524 ENUM_BITSET(ir_graph_state_t)
526 /** set some state flags on the graph (this does not clear the other flags) */
527 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
528 /** clear some state flags of the graph */
529 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
530 /** query whether a set of graph state flags are activated */
531 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
533 /** Set a description for local value n. */
534 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);
536 /** Get the description for local value n. */
537 FIRM_API void *get_irg_loc_description(ir_graph *irg, int n);
539 /** Returns a estimated node count of the irg. This count is updated
540 * after every irg_walk_graph().
542 FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
544 /** Returns the last irn index for this graph. */
545 FIRM_API unsigned get_irg_last_idx(const ir_graph *irg);
547 /** Returns the floating point model of this graph. */
548 FIRM_API unsigned get_irg_fp_model(const ir_graph *irg);
550 /** Sets a floating point model for this graph. */
551 FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model);
554 * Access custom graph data.
555 * The data must have been registered with
556 * register_additional_graph_data() before.
557 * @param graph The graph to get the data from.
558 * @param type The type of the data you registered.
559 * @param off The value returned by register_additional_graph_data().
560 * @return A pointer of type @p type.
562 #define get_irg_data(graph,type,off) \
563 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
566 * Get the pointer to the node some custom data belongs to.
567 * @param data The pointer to the custom data.
568 * @param off The number as returned by register_additional_graph_data().
569 * @return A pointer to the ir node the custom data belongs to.
571 #define get_irg_data_base(data,off) \
572 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
575 * Request additional data to be allocated with an ir graph.
576 * @param size The size of the additional data required.
577 * @return A positive number, if the operation was successful, which
578 * must be passed to the access macro get_irg_data(), 0 if the
579 * registration failed.
581 FIRM_API size_t register_additional_graph_data(size_t size);