fix lower_mode_b relying on current_ir_graph being equal to the passed irg; make...
[libfirm] / include / libfirm / irgraph.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Entry point to the representation of procedure code.
23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier
24  * @version  $Id$
25  */
26 #ifndef FIRM_IR_IRGRAPH_H
27 #define FIRM_IR_IRGRAPH_H
28
29 #include <stddef.h>
30
31 #include "firm_types.h"
32 #include "begin.h"
33
34 /**
35  * @page ir_graph   The struct ir_graph
36  *
37  * This struct contains all information about a procedure.
38  * It's allocated directly to memory.
39  *
40  * The fields of ir_graph:
41  *
42  * - ent             The entity describing this procedure.
43  *
44  * The beginning and end of a graph:
45  *
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.
51  *
52  * - end_block       This ir_node is the block that contains the unique
53  *                   end node of the procedure.  This block contains no
54  *                   further nodes.
55  * - end             This ir_node is the unique end node of the procedure.
56  *
57  * The following nodes are Projs from the Start node, held in ir_graph for
58  * simple access:
59  *
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
67  *                   frame.
68  *
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... .
73  *
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.
77  *
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.
81  *
82  * - proj_args       The proj nodes of the args node.
83  *
84  * - bad             The Bad node is an auxiliary node. It is needed only once,
85  *                   so there is this globally reachable node.
86  *
87  * - no_mem          The NoMem node is an auxiliary node. It is needed only once,
88  *                   so there is this globally reachable node.
89  *
90  * Data structures that are private to a graph:
91  *
92  * - obst            An obstack that contains all nodes.
93  *
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.
98  *
99  * - params/n_loc    An int giving the number of local variables in this
100  *                  procedure.  This is needed for ir construction. Name will
101  *                   be changed.
102  *
103  * - value_table     This hash table (pset) is used for global value numbering
104  *                   for optimizing use in iropt.c.
105  *
106  * - Phi_in_stack;   a stack needed for automatic Phi construction, needed only
107  *                   during ir construction.
108  *
109  * - visited         A int used as flag to traverse the ir_graph.
110  *
111  * - block_visited    A int used as a flag to traverse block nodes in the graph.
112  */
113
114 /** Global variable holding the current ir graph.
115  *
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.
119  */
120 FIRM_API ir_graph *current_ir_graph;
121
122 FIRM_API ir_graph *get_current_ir_graph(void);
123 FIRM_API void set_current_ir_graph(ir_graph *graph);
124
125 /**
126  * Create a new ir graph to build ir for a procedure.
127  *
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.
130  *
131  * @param n_loc  The number of local variables in this procedure including
132  *               the procedure parameters.
133  *
134  * This constructor generates the basic infrastructure needed to
135  * represent a procedure in FIRM.
136  *
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
140  * procedure:
141  *
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.
148  *
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.
154  *
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.
160  *
161  * @see new_pseudo_ir_graph()
162  */
163 FIRM_API ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
164
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.
172  */
173 FIRM_API void free_ir_graph(ir_graph *irg);
174
175 /* --- access routines for all ir_graph attributes --- */
176
177 /**
178  *   Checks whether a pointer points to a ir graph.
179  *
180  *   @param thing     an arbitrary pointer
181  *
182  *   @return
183  *       true if the thing is a IR graph, else false
184  */
185 FIRM_API int is_ir_graph(const void *thing);
186
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);
191
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);
196
197 /** Returns the value parameter type of an IR graph. */
198 FIRM_API ir_type *get_irg_value_param_type(ir_graph *irg);
199
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);
204
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);
209
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);
214
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);
219
220 /** Returns the node that represents the initial control flow of the given
221  * IR graph. */
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);
225
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);
230
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);
235
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);
240
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);
245
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);
250
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);
254
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);
258
259 /** Returns the number of value numbers of an IR graph. */
260 FIRM_API int get_irg_n_locs(ir_graph *irg);
261
262 /** Returns the graph number. */
263 FIRM_API long get_irg_graph_nr(const ir_graph *irg);
264
265 /**
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()
269  */
270 FIRM_API int get_irg_idx(const ir_graph *irg);
271
272 /**
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
277  *            index.
278  * @note      The node you got might be dead.
279  */
280 FIRM_API ir_node *get_idx_irn(ir_graph *irg, unsigned idx);
281
282
283 /******************************************************************************/
284 /* States of an ir_graph.                                                     */
285 /******************************************************************************/
286
287 /*
288    information associated with the graph.  Optimizations invalidate these
289    states.  */
290
291 /** The states of an ir graph.
292  *
293  * state phase values: phase_building, phase_high, phase_low, phase_backend.
294  *
295  * The graph is in phase_building during construction of the irgraph.
296  * The construction is finished by a call to finalize_cons().
297  *
298  * Finalize_cons() sets the state to phase_high.  All standard Firm nodes are
299  * allowed.
300  *
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?
305  *
306  * phase_backend is set if architecture specific machine nodes are inserted
307  * (and probably most standard Firm are removed).
308  */
309 typedef enum {
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. */
314 } irg_phase_state;
315
316 /** Returns the phase_state of an IR graph. */
317 FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg);
318
319 /** Sets the phase state of an IR graph. */
320 FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
321
322 /** state: op_pin_state_pinned
323    The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
324    It is in state "op_pin_state_floats" if nodes are in arbitrary blocks.  In state
325    "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
326    invalid block, i.e., the block is not a dominator of all the uses of
327    the node.
328    The enum op_pin_state is defined in irop.h. */
329 FIRM_API op_pin_state get_irg_pinned(const ir_graph *irg);
330
331 /** state: outs_state
332  *  Outs are the back edges or def-use edges of ir nodes.
333  *  Values:  outs_none, outs_consistent, outs_inconsistent */
334 typedef enum {
335         outs_none,         /**< Outs are not computed, no memory is allocated. */
336         outs_consistent,   /**< Outs are computed and correct. */
337         outs_inconsistent  /**< Outs have been computed, memory is still allocated,
338                                 but the graph has been changed since. */
339 } irg_outs_state;
340 FIRM_API irg_outs_state get_irg_outs_state(const ir_graph *irg);
341 FIRM_API void set_irg_outs_inconsistent(ir_graph *irg);
342
343 /** state:  extended basic block state. */
344 typedef enum {
345         extblk_none    = 0,  /**< No extended basic block information is constructed. Default. */
346         extblk_valid   = 1,  /**< Extended basic block information is valid. */
347         extblk_invalid = 2   /**< Extended basic block information is constructed but invalid. */
348 } irg_extblk_state;
349 FIRM_API irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
350 FIRM_API void set_irg_extblk_inconsistent(ir_graph *irg);
351
352 /** state: dom_state
353  * Signals the state of the dominator / post dominator information.
354  */
355 typedef enum {
356         dom_none,             /**< dominator are not computed, no memory is allocated */
357         dom_consistent,       /**< dominator information is computed and correct */
358         dom_inconsistent      /**< dominator information is computed but the graph has been changed since */
359 } irg_dom_state;
360
361 /** returns the dominator state of an IR graph. */
362 FIRM_API irg_dom_state get_irg_dom_state(const ir_graph *irg);
363
364 /** returns the post dominator state of an IR graph. */
365 FIRM_API irg_dom_state get_irg_postdom_state(const ir_graph *irg);
366
367 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
368 FIRM_API void set_irg_doms_inconsistent(ir_graph *irg);
369
370 /** state: loopinfo_state
371  *  Loop information describes the loops within the control and
372  *  data flow of the procedure.
373  */
374 typedef enum {
375         loopinfo_none             = 0,       /**< No loop information is constructed. Default. */
376         loopinfo_constructed      = 1,       /**< Some kind of loop information is constructed. */
377         loopinfo_valid            = 2,       /**< Loop information is valid. */
378         loopinfo_cf               = 4,       /**< Loop information constructed for control flow only. */
379         loopinfo_inter            = 8,       /**< Loop information for interprocedural view. */
380
381         /** IntRAprocedural loop information constructed and valid. */
382         loopinfo_consistent         = loopinfo_constructed | loopinfo_valid,
383         /** IntRAprocedural loop information constructed and invalid. */
384         loopinfo_inconsistent       = loopinfo_constructed,
385
386         /** IntERprocedural loop information constructed and valid. */
387         loopinfo_ip_consistent      = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
388         /** IntERprocedural loop information constructed and invalid. */
389         loopinfo_ip_inconsistent    = loopinfo_constructed | loopinfo_inter,
390
391         /** IntRAprocedural control loop information constructed and valid. */
392         loopinfo_cf_consistent      = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
393         /** IntRAprocedural control loop information constructed and invalid. */
394         loopinfo_cf_inconsistent    = loopinfo_constructed | loopinfo_cf,
395
396         /** IntERprocedural control loop information constructed and valid. */
397         loopinfo_cf_ip_consistent   = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
398         /** IntERprocedural control loop information constructed and invalid. */
399         loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
400 } irg_loopinfo_state;
401
402 /** Return the current loop information state. */
403 FIRM_API irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
404
405 /** Sets the current loop information state. */
406 FIRM_API void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
407
408 /** Sets the loop information state to the appropriate inconsistent state.
409  *  If state is 'none' does not change. */
410 FIRM_API void set_irg_loopinfo_inconsistent(ir_graph *irg);
411 /** Sets the loop information state to the appropriate inconsistent state.
412  *  If state is 'none' does not change.
413  *  Does this for all irgs. */
414 FIRM_API void set_irp_loopinfo_inconsistent(void);
415
416 /** state: callee_information_state
417  *  Call nodes contain a list of possible callees.  This list must be
418  *  computed by an analysis.
419  *
420  *  It's strange that this state is administered on irg basis, as the
421  *  information must be computed for the whole program, or not?
422  */
423 typedef enum {
424         irg_callee_info_none,
425         irg_callee_info_consistent,
426         irg_callee_info_inconsistent
427 } irg_callee_info_state;
428
429 /** Returns the callee_info_state of an IR graph. */
430 FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
431
432 /** Sets the callee_info_state of an IR graph. */
433 FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
434
435 /** property:
436  *  Tells how to handle an ir graph in inlining.
437  */
438 typedef enum {
439         irg_inline_any,            /**< No restriction on inlining. Default. */
440         irg_inline_forbidden,      /**< The graph must not be inlined. */
441         irg_inline_recomended,     /**< The graph should be inlined. */
442         irg_inline_forced,         /**< The graph must be inlined. */
443         irg_inline_forced_no_body  /**< The graph must be inlined. No body is allowed
444                                         to be emitted. */
445 } irg_inline_property;
446
447 /** Returns the inline property of a graph. */
448 FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg);
449 /** Sets the inline property of a graph. */
450 FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
451
452 /**
453  * Returns the mask of the additional graph properties.
454  * The properties are automatically inherited from the method type
455  * if they were not set using set_irg_additional_properties() or
456  * set_irg_additional_property().
457  *
458  * @return a bitset of mtp_additional_property values
459  */
460 FIRM_API unsigned get_irg_additional_properties(const ir_graph *irg);
461
462 /** Sets the mask of the additional graph properties. */
463 FIRM_API void set_irg_additional_properties(ir_graph *irg,
464                                             unsigned property_mask);
465
466 /** Sets one additional graph property. */
467 FIRM_API void set_irg_additional_property(ir_graph *irg,
468                                           mtp_additional_property flag);
469
470 /** A void * field to link arbitrary information to the node. */
471 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
472 FIRM_API void *get_irg_link(const ir_graph *irg);
473
474 /** Increments visited flag by one.
475  *  @see also: get_irn_visited() get_irg_block_visited(). */
476 FIRM_API void inc_irg_visited(ir_graph *irg);
477 FIRM_API ir_visited_t get_irg_visited(const ir_graph *irg);
478 FIRM_API void set_irg_visited(ir_graph *irg, ir_visited_t i);
479 /** An interprocedural flag valid for all irgs.
480  *  @see also: get_irn_visited() get_irg_block_visited(). */
481 FIRM_API ir_visited_t get_max_irg_visited(void);
482 FIRM_API void set_max_irg_visited(int val);
483 FIRM_API ir_visited_t inc_max_irg_visited(void);
484
485 /** Increments block_visited by one.
486  *  @see also: get_irn_visited() get_irg_block_visited(). */
487 FIRM_API void inc_irg_block_visited(ir_graph *irg);
488 FIRM_API ir_visited_t get_irg_block_visited(const ir_graph *irg);
489 FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
490
491 /**
492  * Debug helpers: You can indicate whether you are currently using visited or
493  * block_visited flags. If NDEBUG is not defined, then the compiler will abort
494  * if 2 parties try to use the flags.
495  */
496 enum ir_resources_enum_t {
497         /* local (irg) resources */
498         IR_RESOURCE_BLOCK_VISITED = 1 << 0,  /**< Block visited flags are used. */
499         IR_RESOURCE_BLOCK_MARK    = 1 << 1,  /**< Block mark bits are used. */
500         IR_RESOURCE_IRN_VISITED   = 1 << 2,  /**< IR-node visited flags are used. */
501         IR_RESOURCE_IRN_LINK      = 1 << 3,  /**< IR-node link fields are used. */
502         IR_RESOURCE_LOOP_LINK     = 1 << 4,  /**< IR-loop link fields are used. */
503         IR_RESOURCE_PHI_LIST      = 1 << 5,  /**< Block Phi lists are used. */
504         IR_RESOURCE_IRG_LINK      = 1 << 6,  /**< IR-graph link fields used. */
505
506         /* global (irp) resources */
507         IR_RESOURCE_ENTITY_LINK   = 1 << 8,  /**< IR-entity link fields are used. */
508         IR_RESOURCE_TYPE_VISITED  = 1 << 9,  /**< type visited flags */
509
510         /* masks */
511         IR_RESOURCE_LOCAL_MASK    = 0x00FF,  /**< Mask for all local resources. */
512         IR_RESOURCE_GLOBAL_MASK   = 0xFF00   /**< Mask for all global resources. */
513 };
514 typedef unsigned ir_resources_t;
515
516 #ifndef NDEBUG
517 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
518 FIRM_API void ir_free_resources(ir_graph *irg, ir_resources_t resources);
519 FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg);
520 #else
521 #define ir_reserve_resources(irg,resources)  (void)0
522 #define ir_free_resources(irg,resources)     (void)0
523 #define ir_resources_reserved(irg)           0
524 #endif
525
526 /**
527  * Graph State
528  */
529 typedef enum {
530         IR_GRAPH_STATE_KEEP_MUX      = 1U << 0,  /**< should perform no further optimisations on Mux nodes */
531         IR_GRAPH_STATE_ARCH_DEP      = 1U << 1,  /**< should not construct more nodes which irarch potentially breaks down */
532         IR_GRAPH_STATE_BCONV_ALLOWED = 1U << 2,  /**< Conv(mode_b) to Iu is allowed as set command */
533 } ir_graph_state_t;
534
535 /** set some state flags on the graph (this does not clear the other flags) */
536 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
537 /** clear some state flags of the graph */
538 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
539 /** query wether a set of graph state flags are activated */
540 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
541
542 /** Normalization: Move Proj nodes into the same block as its predecessors */
543 FIRM_API void normalize_proj_nodes(ir_graph *irg);
544
545 /** Set a description for local value n. */
546 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);
547
548 /** Get the description for local value n. */
549 FIRM_API void *get_irg_loc_description(ir_graph *irg, int n);
550
551 /** Returns a estimated node count of the irg. This count is updated
552  * after every irg_walk_graph().
553  */
554 FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
555
556 /** Returns the last irn index for this graph. */
557 FIRM_API unsigned get_irg_last_idx(const ir_graph *irg);
558
559 /** Returns the floating point model of this graph. */
560 FIRM_API unsigned get_irg_fp_model(const ir_graph *irg);
561
562 /** Sets a floating point model for this graph. */
563 FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model);
564
565 /**
566  * Access custom graph data.
567  * The data must have been registered with
568  * register_additional_graph_data() before.
569  * @param graph The graph to get the data from.
570  * @param type The type of the data you registered.
571  * @param off The value returned by register_additional_graph_data().
572  * @return A pointer of type @p type.
573  */
574 #define get_irg_data(graph,type,off) \
575         (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
576
577 /**
578  * Get the pointer to the node some custom data belongs to.
579  * @param data The pointer to the custom data.
580  * @param off The number as returned by register_additional_graph_data().
581  * @return A pointer to the ir node the custom data belongs to.
582  */
583 #define get_irg_data_base(data,off) \
584         (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
585
586 /**
587  * Request additional data to be allocated with an ir graph.
588  * @param size The size of the additional data required.
589  * @return A positive number, if the operation was successful, which
590  * must be passed to the access macro get_irg_data(), 0 if the
591  * registration failed.
592  */
593 FIRM_API size_t register_additional_graph_data(size_t size);
594
595 #include "end.h"
596
597 #endif