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 * - no_mem The NoMem node is an auxiliary node. It is needed only once,
85 * so there is this globally reachable node.
87 * Data structures that are private to a graph:
89 * - obst An obstack that contains all nodes.
91 * - current_block A pointer to the current block. Any node created with
92 * one of the node constructors (new_<opcode>) are assigned
93 * to this block. It can be set with set_cur_block(block).
94 * Only needed for ir construction.
96 * - params/n_loc An int giving the number of local variables in this
97 * procedure. This is needed for ir construction. Name will
100 * - value_table This hash table (pset) is used for global value numbering
101 * for optimizing use in iropt.c.
103 * - Phi_in_stack; a stack needed for automatic Phi construction, needed only
104 * during ir construction.
106 * - visited A int used as flag to traverse the ir_graph.
108 * - block_visited A int used as a flag to traverse block nodes in the graph.
111 /** Global variable holding the current ir graph.
113 * This global variable is used by the ir construction
114 * interface in ircons and by the optimizations.
115 * Further it is set by all walker functions.
117 FIRM_API ir_graph *current_ir_graph;
119 FIRM_API ir_graph *get_current_ir_graph(void);
120 FIRM_API void set_current_ir_graph(ir_graph *graph);
123 * Create a new ir graph to build ir for a procedure.
125 * @param ent A pointer to an entity representing the procedure,
126 * i.e., the type of the entity must be of a method type.
128 * @param n_loc The number of local variables in this procedure including
129 * the procedure parameters.
131 * This constructor generates the basic infrastructure needed to
132 * represent a procedure in FIRM.
134 * It allocates an ir_graph and sets the field irg of the entity ent
135 * to point to this graph. Further it allocates the following nodes needed
136 * for every procedure:
138 * - The start block containing a start node and Proj nodes for its
139 * seven results (X, M, P, P, P, T, P).
140 * - The end block containing an end node. This block is not matured
141 * after executing new_ir_graph() as predecessors need to be added to it.
142 * (Maturing a block means fixing its number of predecessors.)
143 * - The current block, which is empty and also not matured.
145 * Further it enters the global store into the data structure of the start
146 * block that contains all valid values in this block (set_store()). This
147 * data structure is used to build the Phi nodes and removed after
148 * completion of the graph. There is no path from end to start in the
149 * graph after calling ir_graph.
151 * The op_pin_state of the graph is set to "op_pin_state_pinned"
152 * if no global cse was performed on the graph.
153 * It is set to "op_pin_state_floats" if global cse was performed
154 * (and during construction: did actually change something).
155 * Code placement is necessary.
157 * @see new_pseudo_ir_graph()
159 FIRM_API ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
161 /** Frees the passed irgraph.
162 * Deallocates all nodes in this graph and the ir_graph structure.
163 * Sets the field irgraph in the corresponding entity to NULL.
164 * Does not remove the irgraph from the list in irprog (requires
165 * inefficient search, call remove_irp_irg by hand).
166 * Does not free types, entities or modes that are used only by this
167 * graph, nor the entity standing for this graph.
169 FIRM_API void free_ir_graph(ir_graph *irg);
172 * Checks whether a pointer points to a ir graph.
174 * @param thing an arbitrary pointer
177 * true if the thing is a IR graph, else false
179 FIRM_API int is_ir_graph(const void *thing);
181 /** Returns the entity of an IR graph. */
182 FIRM_API ir_entity *get_irg_entity(const ir_graph *irg);
183 /** Sets the entity of an IR graph. */
184 FIRM_API void set_irg_entity(ir_graph *irg, ir_entity *ent);
186 /** Returns the frame type of an IR graph. */
187 FIRM_API ir_type *get_irg_frame_type(ir_graph *irg);
188 /** Sets the frame type of an IR graph. */
189 FIRM_API void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
191 /** Returns the start block of an IR graph. */
192 FIRM_API ir_node *get_irg_start_block(const ir_graph *irg);
193 /** Sets the start block of an IR graph. */
194 FIRM_API void set_irg_start_block(ir_graph *irg, ir_node *node);
196 /** Returns the Start node of an IR graph. */
197 FIRM_API ir_node *get_irg_start(const ir_graph *irg);
198 /** Sets the Start node of an IR graph. */
199 FIRM_API void set_irg_start(ir_graph *irg, ir_node *node);
201 /** Returns the end block of an IR graph. */
202 FIRM_API ir_node *get_irg_end_block(const ir_graph *irg);
203 /** Sets the end block of an IR graph. */
204 FIRM_API void set_irg_end_block(ir_graph *irg, ir_node *node);
206 /** Returns the End node of an IR graph. */
207 FIRM_API ir_node *get_irg_end(const ir_graph *irg);
208 /** Sets the End node of an IR graph. */
209 FIRM_API void set_irg_end(ir_graph *irg, ir_node *node);
211 /** Returns the node that represents the initial control flow of the given
213 FIRM_API ir_node *get_irg_initial_exec(const ir_graph *irg);
214 /** Sets the node that represents the initial control of the given IR graph. */
215 FIRM_API void set_irg_initial_exec(ir_graph *irg, ir_node *node);
217 /** Returns the node that represents the frame pointer of the given IR graph. */
218 FIRM_API ir_node *get_irg_frame(const ir_graph *irg);
219 /** Sets the node that represents the frame pointer of the given IR graph. */
220 FIRM_API void set_irg_frame(ir_graph *irg, ir_node *node);
222 /** Returns the node that represents the initial memory of the given IR graph. */
223 FIRM_API ir_node *get_irg_initial_mem(const ir_graph *irg);
224 /** Sets the node that represents the initial memory of the given IR graph. */
225 FIRM_API void set_irg_initial_mem(ir_graph *irg, ir_node *node);
227 /** Returns the node that represents the argument pointer of the given IR graph. */
228 FIRM_API ir_node *get_irg_args(const ir_graph *irg);
229 /** Sets the node that represents the argument pointer of the given IR graph. */
230 FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
232 /** Returns the NoMem node of the given IR graph. */
233 FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg);
234 FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node);
236 /** Returns the number of value numbers of an IR graph. */
237 FIRM_API int get_irg_n_locs(ir_graph *irg);
239 /** Returns the graph number. */
240 FIRM_API long get_irg_graph_nr(const ir_graph *irg);
243 * Returns the graph number. This is a unique number for the graph and is
244 * smaller than get_irp_last_idx()
245 * Note: you cannot use this number for get_irp_irg()
247 FIRM_API size_t get_irg_idx(const ir_graph *irg);
250 * Get the node for an index.
251 * @param irg The graph.
252 * @param idx The index you want the node for.
253 * @return The node with that index or NULL, if there is no node with that
255 * @note The node you got might be dead.
257 FIRM_API ir_node *get_idx_irn(const ir_graph *irg, unsigned idx);
260 /** The states of an ir graph.
262 * state phase values: phase_building, phase_high, phase_low, phase_backend.
264 * The graph is in phase_building during construction of the irgraph.
265 * The construction is finished by a call to finalize_cons().
267 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
270 * To get the irgraph into phase_low all Sel nodes must be removed and
271 * replaced by explicit address computations. SymConst size and
272 * type tag nodes must be removed (@@@ really?). Initialization of
273 * memory allocated by Alloc must be explicit. @@@ More conditions?
275 * phase_backend is set if architecture specific machine nodes are inserted
276 * (and probably most standard Firm are removed).
279 phase_building, /**< The graph is still being constructed. */
280 phase_high, /**< The construction of the graph is finish, high level nodes may be present. */
281 phase_low, /**< High level nodes are removed. */
282 phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */
285 /** Returns the phase_state of an IR graph. */
286 FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg);
288 /** Sets the phase state of an IR graph. */
289 FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
291 /** state: op_pin_state_pinned
292 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
293 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
294 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
295 invalid block, i.e., the block is not a dominator of all the uses of
297 The enum op_pin_state is defined in irop.h. */
298 FIRM_API op_pin_state get_irg_pinned(const ir_graph *irg);
300 /** state: callee_information_state
301 * Call nodes contain a list of possible callees. This list must be
302 * computed by an analysis.
304 * It's strange that this state is administered on irg basis, as the
305 * information must be computed for the whole program, or not?
308 irg_callee_info_none,
309 irg_callee_info_consistent,
310 irg_callee_info_inconsistent
311 } irg_callee_info_state;
313 /** Returns the callee_info_state of an IR graph. */
314 FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
316 /** Sets the callee_info_state of an IR graph. */
317 FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
320 * Tells how to handle an ir graph in inlining.
323 irg_inline_any, /**< No restriction on inlining. Default. */
324 irg_inline_forbidden, /**< The graph must not be inlined. */
325 irg_inline_recomended, /**< The graph should be inlined. */
326 irg_inline_forced, /**< The graph must be inlined. */
327 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
329 } irg_inline_property;
331 /** Returns the inline property of a graph. */
332 FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg);
333 /** Sets the inline property of a graph. */
334 FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
337 * Returns the mask of the additional graph properties.
338 * The properties are automatically inherited from the method type
339 * if they were not set using set_irg_additional_properties() or
340 * set_irg_additional_properties().
342 * @return a bitset of mtp_additional_properties values
344 FIRM_API mtp_additional_properties get_irg_additional_properties(const ir_graph *irg);
346 /** Sets the mask of the additional graph properties. */
347 FIRM_API void set_irg_additional_properties(ir_graph *irg,
348 mtp_additional_properties property_mask);
350 /** Sets one additional graph property. */
351 FIRM_API void add_irg_additional_properties(ir_graph *irg,
352 mtp_additional_properties flag);
354 /** A void * field to link arbitrary information to the node. */
355 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
356 FIRM_API void *get_irg_link(const ir_graph *irg);
358 /** Increments visited flag by one.
359 * @see also: get_irn_visited() get_irg_block_visited(). */
360 FIRM_API void inc_irg_visited(ir_graph *irg);
361 FIRM_API ir_visited_t get_irg_visited(const ir_graph *irg);
362 FIRM_API void set_irg_visited(ir_graph *irg, ir_visited_t i);
363 /** An interprocedural flag valid for all irgs.
364 * @see also: get_irn_visited() get_irg_block_visited(). */
365 FIRM_API ir_visited_t get_max_irg_visited(void);
366 FIRM_API void set_max_irg_visited(int val);
367 FIRM_API ir_visited_t inc_max_irg_visited(void);
369 /** Increments block_visited by one.
370 * @see also: get_irn_visited() get_irg_block_visited(). */
371 FIRM_API void inc_irg_block_visited(ir_graph *irg);
372 FIRM_API ir_visited_t get_irg_block_visited(const ir_graph *irg);
373 FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
376 * Debug helpers: You can indicate whether you are currently using visited or
377 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
378 * if 2 parties try to use the flags.
380 typedef enum ir_resources_t {
381 IR_RESOURCE_NONE = 0,
382 IR_RESOURCE_BLOCK_VISITED = 1 << 0, /**< Block visited flags are used. */
383 IR_RESOURCE_BLOCK_MARK = 1 << 1, /**< Block mark bits are used. */
384 IR_RESOURCE_IRN_VISITED = 1 << 2, /**< IR-node visited flags are used. */
385 IR_RESOURCE_IRN_LINK = 1 << 3, /**< IR-node link fields are used. */
386 IR_RESOURCE_LOOP_LINK = 1 << 4, /**< IR-loop link fields are used. */
387 IR_RESOURCE_PHI_LIST = 1 << 5 /**< Block Phi lists are used. */
389 ENUM_BITSET(ir_resources_t)
392 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
393 FIRM_API void ir_free_resources(ir_graph *irg, ir_resources_t resources);
394 FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg);
396 #define ir_reserve_resources(irg,resources) (void)0
397 #define ir_free_resources(irg,resources) (void)0
398 #define ir_resources_reserved(irg) 0
402 * graph state. This is used for 2 things:
403 * - stating properties about a graph
404 * - disallow certain transformations for the graph (typically highlevel
405 * constructs are disallowed after lowering them)
409 * Should not construct more nodes which irarch potentially breaks down
411 IR_GRAPH_STATE_ARCH_DEP = 1U << 0,
413 * mode_b nodes have been lowered so you should not create any new nodes
414 * with mode_b (except for Cmp)
416 IR_GRAPH_STATE_MODEB_LOWERED = 1U << 1,
418 * There are normalisations where there is no "best" representative.
419 * In this case we first normalise into 1 direction (!NORMALISATION2) and
420 * later in the other (NORMALISATION2).
422 IR_GRAPH_STATE_NORMALISATION2 = 1U << 2,
424 * Define the semantic of Load(Sel(x)), if x has a bit offset (Bitfields!).
425 * Normally, the frontend is responsible for bitfield masking operations.
426 * Set IMPLICIT_BITFIELD_MASKING, if the lowering phase must insert masking
429 IR_GRAPH_STATE_IMPLICIT_BITFIELD_MASKING = 1U << 3,
431 * Allow localopts to remove edges to unreachable code.
432 * Warning: It is only safe to enable this when you are sure that you
433 * apply all localopts to the fixpunkt. (=in optimize_graph_df)
435 IR_GRAPH_STATE_OPTIMIZE_UNREACHABLE_CODE = 1U << 4,
436 /** graph contains no critical edges */
437 IR_GRAPH_STATE_NO_CRITICAL_EDGES = 1U << 5,
438 /** graph contains no Bad nodes */
439 IR_GRAPH_STATE_NO_BADS = 1U << 6,
441 * there exists no (obviously) unreachable code in the graph.
442 * Unreachable in this context is code that you can't reach by following
443 * execution flow from the start block.
445 IR_GRAPH_STATE_NO_UNREACHABLE_CODE = 1U << 7,
446 /** graph contains at most one return */
447 IR_GRAPH_STATE_ONE_RETURN = 1U << 8,
448 /** dominance information about the graph is valid */
449 IR_GRAPH_STATE_CONSISTENT_DOMINANCE = 1U << 9,
450 /** postdominance information about the graph is valid */
451 IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE = 1U << 10,
453 * out edges (=iredges) are enable and there is no dead code that can be
454 * reached by following them
456 IR_GRAPH_STATE_CONSISTENT_OUT_EDGES = 1U << 11,
457 /** outs (irouts) are computed and up to date */
458 IR_GRAPH_STATE_CONSISTENT_OUTS = 1U << 12,
459 /** loopinfo is computed and up to date */
460 IR_GRAPH_STATE_CONSISTENT_LOOPINFO = 1U << 13,
461 /** entity usage information is computed and up to date */
462 IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE = 1U << 14,
463 /** extended basic blocks have been formed and are up to date */
464 IR_GRAPH_STATE_VALID_EXTENDED_BLOCKS = 1U << 15,
466 ENUM_BITSET(ir_graph_state_t)
468 /** set some state flags on the graph (this does not clear the other flags) */
469 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
470 /** clear some state flags of the graph */
471 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
472 /** query whether a set of graph state flags are activated */
473 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
475 /** Set a description for local value n. */
476 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);
478 /** Get the description for local value n. */
479 FIRM_API void *get_irg_loc_description(ir_graph *irg, int n);
481 /** Returns a estimated node count of the irg. This count is updated
482 * after every irg_walk_graph().
484 FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
486 /** Returns the last irn index for this graph. */
487 FIRM_API unsigned get_irg_last_idx(const ir_graph *irg);
489 /** Returns the floating point model of this graph. */
490 FIRM_API unsigned get_irg_fp_model(const ir_graph *irg);
492 /** Sets a floating point model for this graph. */
493 FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model);
496 * Access custom graph data.
497 * The data must have been registered with
498 * register_additional_graph_data() before.
499 * @param graph The graph to get the data from.
500 * @param type The type of the data you registered.
501 * @param off The value returned by register_additional_graph_data().
502 * @return A pointer of type @p type.
504 #define get_irg_data(graph,type,off) \
505 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
508 * Get the pointer to the node some custom data belongs to.
509 * @param data The pointer to the custom data.
510 * @param off The number as returned by register_additional_graph_data().
511 * @return A pointer to the ir node the custom data belongs to.
513 #define get_irg_data_base(data,off) \
514 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
517 * Request additional data to be allocated with an ir graph.
518 * @param size The size of the additional data required.
519 * @return A positive number, if the operation was successful, which
520 * must be passed to the access macro get_irg_data(), 0 if the
521 * registration failed.
523 FIRM_API size_t register_additional_graph_data(size_t size);