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
25 #ifndef FIRM_IR_IRGRAPH_H
26 #define FIRM_IR_IRGRAPH_H
30 #include "firm_types.h"
34 * @page ir_graph The struct ir_graph
36 * This struct contains all information about a procedure.
37 * It's allocated directly to memory.
39 * The fields of ir_graph:
41 * - ent The entity describing this procedure.
43 * The beginning and end of a graph:
45 * - start_block This ir_node is the block that contains the unique
46 * start node of the procedure. With it it contains
47 * the Proj's on starts results.
48 * Further all Const nodes are placed in the start block.
49 * - start This ir_node is the unique start node of the procedure.
51 * - end_block This ir_node is the block that contains the unique
52 * end node of the procedure. This block contains no
54 * - end This ir_node is the unique end node of the procedure.
56 * The following nodes are Projs from the Start node, held in ir_graph for
59 * - frame The ir_node producing the pointer to the stack frame of
60 * the procedure as output. This is the Proj node on the
61 * third output of the start node. This output of the start
62 * node is tagged as pns_frame_base. In FIRM most local
63 * variables are modeled as data flow edges. Static
64 * allocated arrays can not be represented as data flow
65 * edges. Therefore FIRM has to represent them in the stack
68 * - globals This models a pointer to a space in the memory where
69 * _all_ global things are held. Select from this pointer
70 * with a Sel node the pointer to a global variable /
71 * procedure / compiler known function... .
73 * - tls This models a pointer to a space in the memory where
74 * thread local things are held. Select from this pointer
75 * with a Sel node the pointer to a thread local variable.
77 * - args The ir_node that produces the arguments of the method as
78 * its result. This is a Proj node on the fourth output of
79 * the start node. This output is tagged as pn_Start_T_args.
81 * - proj_args The proj nodes of the args node.
83 * - no_mem The NoMem node is an auxiliary node. It is needed only once,
84 * so there is this globally reachable node.
86 * Data structures that are private to a graph:
88 * - obst An obstack that contains all nodes.
90 * - current_block A pointer to the current block. Any node created with
91 * one of the node constructors (new_<opcode>) are assigned
92 * to this block. It can be set with set_cur_block(block).
93 * Only needed for ir construction.
95 * - params/n_loc An int giving the number of local variables in this
96 * procedure. This is needed for ir construction. Name will
99 * - value_table This hash table (pset) is used for global value numbering
100 * for optimizing use in iropt.c.
102 * - Phi_in_stack; a stack needed for automatic Phi construction, needed only
103 * during ir construction.
105 * - visited A int used as flag to traverse the ir_graph.
107 * - block_visited A int used as a flag to traverse block nodes in the graph.
110 /** Global variable holding the current ir graph.
112 * This global variable is used by the ir construction
113 * interface in ircons and by the optimizations.
114 * Further it is set by all walker functions.
116 FIRM_API ir_graph *current_ir_graph;
118 FIRM_API ir_graph *get_current_ir_graph(void);
119 FIRM_API void set_current_ir_graph(ir_graph *graph);
122 * Create a new ir graph to build ir for a procedure.
124 * @param ent A pointer to an entity representing the procedure,
125 * i.e., the type of the entity must be of a method type.
127 * @param n_loc The number of local variables in this procedure including
128 * the procedure parameters.
130 * This constructor generates the basic infrastructure needed to
131 * represent a procedure in FIRM.
133 * It allocates an ir_graph and sets the field irg of the entity ent
134 * to point to this graph. Further it allocates the following nodes needed
135 * for every procedure:
137 * - The start block containing a start node and Proj nodes for its
138 * seven results (X, M, P, P, P, T, P).
139 * - The end block containing an end node. This block is not matured
140 * after executing new_ir_graph() as predecessors need to be added to it.
141 * (Maturing a block means fixing its number of predecessors.)
142 * - The current block, which is empty and also not matured.
144 * Further it enters the global store into the data structure of the start
145 * block that contains all valid values in this block (set_store()). This
146 * data structure is used to build the Phi nodes and removed after
147 * completion of the graph. There is no path from end to start in the
148 * graph after calling ir_graph.
150 * The op_pin_state of the graph is set to "op_pin_state_pinned"
151 * if no global cse was performed on the graph.
152 * It is set to "op_pin_state_floats" if global cse was performed
153 * (and during construction: did actually change something).
154 * Code placement is necessary.
156 * @see new_pseudo_ir_graph()
158 FIRM_API ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
160 /** Frees the passed irgraph.
161 * Deallocates all nodes in this graph and the ir_graph structure.
162 * Sets the field irgraph in the corresponding entity to NULL.
163 * Does not remove the irgraph from the list in irprog (requires
164 * inefficient search, call remove_irp_irg by hand).
165 * Does not free types, entities or modes that are used only by this
166 * graph, nor the entity standing for this graph.
168 FIRM_API void free_ir_graph(ir_graph *irg);
171 * Checks whether a pointer points to a ir graph.
173 * @param thing an arbitrary pointer
176 * true if the thing is a IR graph, else false
178 FIRM_API int is_ir_graph(const void *thing);
180 /** Returns the entity of an IR graph. */
181 FIRM_API ir_entity *get_irg_entity(const ir_graph *irg);
182 /** Sets the entity of an IR graph. */
183 FIRM_API void set_irg_entity(ir_graph *irg, ir_entity *ent);
185 /** Returns the frame type of an IR graph. */
186 FIRM_API ir_type *get_irg_frame_type(ir_graph *irg);
187 /** Sets the frame type of an IR graph. */
188 FIRM_API void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
190 /** Returns the start block of an IR graph. */
191 FIRM_API ir_node *get_irg_start_block(const ir_graph *irg);
192 /** Sets the start block of an IR graph. */
193 FIRM_API void set_irg_start_block(ir_graph *irg, ir_node *node);
195 /** Returns the Start node of an IR graph. */
196 FIRM_API ir_node *get_irg_start(const ir_graph *irg);
197 /** Sets the Start node of an IR graph. */
198 FIRM_API void set_irg_start(ir_graph *irg, ir_node *node);
200 /** Returns the end block of an IR graph. */
201 FIRM_API ir_node *get_irg_end_block(const ir_graph *irg);
202 /** Sets the end block of an IR graph. */
203 FIRM_API void set_irg_end_block(ir_graph *irg, ir_node *node);
205 /** Returns the End node of an IR graph. */
206 FIRM_API ir_node *get_irg_end(const ir_graph *irg);
207 /** Sets the End node of an IR graph. */
208 FIRM_API void set_irg_end(ir_graph *irg, ir_node *node);
210 /** Returns the node that represents the initial control flow of the given
212 FIRM_API ir_node *get_irg_initial_exec(const ir_graph *irg);
213 /** Sets the node that represents the initial control of the given IR graph. */
214 FIRM_API void set_irg_initial_exec(ir_graph *irg, ir_node *node);
216 /** Returns the node that represents the frame pointer of the given IR graph. */
217 FIRM_API ir_node *get_irg_frame(const ir_graph *irg);
218 /** Sets the node that represents the frame pointer of the given IR graph. */
219 FIRM_API void set_irg_frame(ir_graph *irg, ir_node *node);
221 /** Returns the node that represents the initial memory of the given IR graph. */
222 FIRM_API ir_node *get_irg_initial_mem(const ir_graph *irg);
223 /** Sets the node that represents the initial memory of the given IR graph. */
224 FIRM_API void set_irg_initial_mem(ir_graph *irg, ir_node *node);
226 /** Returns the node that represents the argument pointer of the given IR graph. */
227 FIRM_API ir_node *get_irg_args(const ir_graph *irg);
228 /** Sets the node that represents the argument pointer of the given IR graph. */
229 FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
231 /** Returns the NoMem node of the given IR graph. */
232 FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg);
233 FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node);
235 /** Returns the number of value numbers of an IR graph. */
236 FIRM_API int get_irg_n_locs(ir_graph *irg);
238 /** Returns the graph number. */
239 FIRM_API long get_irg_graph_nr(const ir_graph *irg);
242 * Returns the graph number. This is a unique number for the graph and is
243 * smaller than get_irp_last_idx()
244 * Note: you cannot use this number for get_irp_irg()
246 FIRM_API size_t get_irg_idx(const ir_graph *irg);
249 * Get the node for an index.
250 * @param irg The graph.
251 * @param idx The index you want the node for.
252 * @return The node with that index or NULL, if there is no node with that
254 * @note The node you got might be dead.
256 FIRM_API ir_node *get_idx_irn(const ir_graph *irg, unsigned idx);
259 /** The states of an ir graph.
261 * state phase values: phase_building, phase_high, phase_low, phase_backend.
263 * The graph is in phase_building during construction of the irgraph.
264 * The construction is finished by a call to finalize_cons().
266 * Finalize_cons() sets the state to phase_high. All standard Firm nodes are
269 * To get the irgraph into phase_low all Sel nodes must be removed and
270 * replaced by explicit address computations. SymConst size and
271 * type tag nodes must be removed (@@@ really?). Initialization of
272 * memory allocated by Alloc must be explicit. @@@ More conditions?
274 * phase_backend is set if architecture specific machine nodes are inserted
275 * (and probably most standard Firm are removed).
278 phase_building, /**< The graph is still being constructed. */
279 phase_high, /**< The construction of the graph is finish, high level nodes may be present. */
280 phase_low, /**< High level nodes are removed. */
281 phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */
284 /** Returns the phase_state of an IR graph. */
285 FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg);
287 /** Sets the phase state of an IR graph. */
288 FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
290 /** state: op_pin_state_pinned
291 The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
292 It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state
293 "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
294 invalid block, i.e., the block is not a dominator of all the uses of
296 The enum op_pin_state is defined in irop.h. */
297 FIRM_API op_pin_state get_irg_pinned(const ir_graph *irg);
299 /** state: callee_information_state
300 * Call nodes contain a list of possible callees. This list must be
301 * computed by an analysis.
303 * It's strange that this state is administered on irg basis, as the
304 * information must be computed for the whole program, or not?
307 irg_callee_info_none,
308 irg_callee_info_consistent,
309 irg_callee_info_inconsistent
310 } irg_callee_info_state;
312 /** Returns the callee_info_state of an IR graph. */
313 FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
315 /** Sets the callee_info_state of an IR graph. */
316 FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
319 * Tells how to handle an ir graph in inlining.
322 irg_inline_any, /**< No restriction on inlining. Default. */
323 irg_inline_forbidden, /**< The graph must not be inlined. */
324 irg_inline_recomended, /**< The graph should be inlined. */
325 irg_inline_forced, /**< The graph must be inlined. */
326 irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed
328 } irg_inline_property;
330 /** Returns the inline property of a graph. */
331 FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg);
332 /** Sets the inline property of a graph. */
333 FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
336 * Returns the mask of the additional graph properties.
337 * The properties are automatically inherited from the method type
338 * if they were not set using set_irg_additional_properties() or
339 * set_irg_additional_properties().
341 * @return a bitset of mtp_additional_properties values
343 FIRM_API mtp_additional_properties get_irg_additional_properties(const ir_graph *irg);
345 /** Sets the mask of the additional graph properties. */
346 FIRM_API void set_irg_additional_properties(ir_graph *irg,
347 mtp_additional_properties property_mask);
349 /** Sets one additional graph property. */
350 FIRM_API void add_irg_additional_properties(ir_graph *irg,
351 mtp_additional_properties flag);
353 /** A void * field to link arbitrary information to the node. */
354 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
355 FIRM_API void *get_irg_link(const ir_graph *irg);
357 /** Increments visited flag by one.
358 * @see also: get_irn_visited() get_irg_block_visited(). */
359 FIRM_API void inc_irg_visited(ir_graph *irg);
360 FIRM_API ir_visited_t get_irg_visited(const ir_graph *irg);
361 FIRM_API void set_irg_visited(ir_graph *irg, ir_visited_t i);
362 /** An interprocedural flag valid for all irgs.
363 * @see also: get_irn_visited() get_irg_block_visited(). */
364 FIRM_API ir_visited_t get_max_irg_visited(void);
365 FIRM_API void set_max_irg_visited(int val);
366 FIRM_API ir_visited_t inc_max_irg_visited(void);
368 /** Increments block_visited by one.
369 * @see also: get_irn_visited() get_irg_block_visited(). */
370 FIRM_API void inc_irg_block_visited(ir_graph *irg);
371 FIRM_API ir_visited_t get_irg_block_visited(const ir_graph *irg);
372 FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
375 * Debug helpers: You can indicate whether you are currently using visited or
376 * block_visited flags. If NDEBUG is not defined, then the compiler will abort
377 * if 2 parties try to use the flags.
379 typedef enum ir_resources_t {
380 IR_RESOURCE_NONE = 0,
381 IR_RESOURCE_BLOCK_VISITED = 1 << 0, /**< Block visited flags are used. */
382 IR_RESOURCE_BLOCK_MARK = 1 << 1, /**< Block mark bits are used. */
383 IR_RESOURCE_IRN_VISITED = 1 << 2, /**< IR-node visited flags are used. */
384 IR_RESOURCE_IRN_LINK = 1 << 3, /**< IR-node link fields are used. */
385 IR_RESOURCE_LOOP_LINK = 1 << 4, /**< IR-loop link fields are used. */
386 IR_RESOURCE_PHI_LIST = 1 << 5 /**< Block Phi lists are used. */
388 ENUM_BITSET(ir_resources_t)
391 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
392 FIRM_API void ir_free_resources(ir_graph *irg, ir_resources_t resources);
393 FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg);
395 #define ir_reserve_resources(irg,resources) (void)0
396 #define ir_free_resources(irg,resources) (void)0
397 #define ir_resources_reserved(irg) 0
401 * graph state. This is used for 2 things:
402 * - stating properties about a graph
403 * - disallow certain transformations for the graph (typically highlevel
404 * constructs are disallowed after lowering them)
408 * Should not construct more nodes which irarch potentially breaks down
410 IR_GRAPH_STATE_ARCH_DEP = 1U << 0,
412 * mode_b nodes have been lowered so you should not create any new nodes
413 * with mode_b (except for Cmp)
415 IR_GRAPH_STATE_MODEB_LOWERED = 1U << 1,
417 * There are normalisations where there is no "best" representative.
418 * In this case we first normalise into 1 direction (!NORMALISATION2) and
419 * later in the other (NORMALISATION2).
421 IR_GRAPH_STATE_NORMALISATION2 = 1U << 2,
423 * Define the semantic of Load(Sel(x)), if x has a bit offset (Bitfields!).
424 * Normally, the frontend is responsible for bitfield masking operations.
425 * Set IMPLICIT_BITFIELD_MASKING, if the lowering phase must insert masking
428 IR_GRAPH_STATE_IMPLICIT_BITFIELD_MASKING = 1U << 3,
430 * Allow localopts to remove edges to unreachable code.
431 * Warning: It is only safe to enable this when you are sure that you
432 * apply all localopts to the fixpunkt. (=in optimize_graph_df)
434 IR_GRAPH_STATE_OPTIMIZE_UNREACHABLE_CODE = 1U << 4,
435 /** graph contains no critical edges */
436 IR_GRAPH_STATE_NO_CRITICAL_EDGES = 1U << 5,
437 /** graph contains no Bad nodes */
438 IR_GRAPH_STATE_NO_BADS = 1U << 6,
440 * there exists no (obviously) unreachable code in the graph.
441 * Unreachable in this context is code that you can't reach by following
442 * execution flow from the start block.
444 IR_GRAPH_STATE_NO_UNREACHABLE_CODE = 1U << 7,
445 /** graph contains at most one return */
446 IR_GRAPH_STATE_ONE_RETURN = 1U << 8,
447 /** dominance information about the graph is valid */
448 IR_GRAPH_STATE_CONSISTENT_DOMINANCE = 1U << 9,
449 /** postdominance information about the graph is valid */
450 IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE = 1U << 10,
452 * out edges (=iredges) are enable and there is no dead code that can be
453 * reached by following them
455 IR_GRAPH_STATE_CONSISTENT_OUT_EDGES = 1U << 11,
456 /** outs (irouts) are computed and up to date */
457 IR_GRAPH_STATE_CONSISTENT_OUTS = 1U << 12,
458 /** loopinfo is computed and up to date */
459 IR_GRAPH_STATE_CONSISTENT_LOOPINFO = 1U << 13,
460 /** entity usage information is computed and up to date */
461 IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE = 1U << 14,
462 /** extended basic blocks have been formed and are up to date */
463 IR_GRAPH_STATE_VALID_EXTENDED_BLOCKS = 1U << 15,
464 /** graph contains as many returns as possible */
465 IR_GRAPH_STATE_MANY_RETURNS = 1U << 16,
467 ENUM_BITSET(ir_graph_state_t)
469 /** set some state flags on the graph (this does not clear the other flags) */
470 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
471 /** clear some state flags of the graph */
472 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
473 /** query whether a set of graph state flags are activated */
474 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
476 /** Set a description for local value n. */
477 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);
479 /** Get the description for local value n. */
480 FIRM_API void *get_irg_loc_description(ir_graph *irg, int n);
482 /** Returns a estimated node count of the irg. This count is updated
483 * after every irg_walk_graph().
485 FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
487 /** Returns the last irn index for this graph. */
488 FIRM_API unsigned get_irg_last_idx(const ir_graph *irg);
490 /** Returns the floating point model of this graph. */
491 FIRM_API unsigned get_irg_fp_model(const ir_graph *irg);
493 /** Sets a floating point model for this graph. */
494 FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model);
497 * Access custom graph data.
498 * The data must have been registered with
499 * register_additional_graph_data() before.
500 * @param graph The graph to get the data from.
501 * @param type The type of the data you registered.
502 * @param off The value returned by register_additional_graph_data().
503 * @return A pointer of type @p type.
505 #define get_irg_data(graph,type,off) \
506 (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
509 * Get the pointer to the node some custom data belongs to.
510 * @param data The pointer to the custom data.
511 * @param off The number as returned by register_additional_graph_data().
512 * @return A pointer to the ir node the custom data belongs to.
514 #define get_irg_data_base(data,off) \
515 (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
518 * Request additional data to be allocated with an ir graph.
519 * @param size The size of the additional data required.
520 * @return A positive number, if the operation was successful, which
521 * must be passed to the access macro get_irg_data(), 0 if the
522 * registration failed.
524 FIRM_API size_t register_additional_graph_data(size_t size);