Remove outs_state attribute
[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  *                   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.
81  *
82  * - proj_args       The proj nodes of the args node.
83  *
84  * - no_mem          The NoMem node is an auxiliary node. It is needed only once,
85  *                   so there is this globally reachable node.
86  *
87  * Data structures that are private to a graph:
88  *
89  * - obst            An obstack that contains all nodes.
90  *
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.
95  *
96  * - params/n_loc    An int giving the number of local variables in this
97  *                  procedure.  This is needed for ir construction. Name will
98  *                   be changed.
99  *
100  * - value_table     This hash table (pset) is used for global value numbering
101  *                   for optimizing use in iropt.c.
102  *
103  * - Phi_in_stack;   a stack needed for automatic Phi construction, needed only
104  *                   during ir construction.
105  *
106  * - visited         A int used as flag to traverse the ir_graph.
107  *
108  * - block_visited    A int used as a flag to traverse block nodes in the graph.
109  */
110
111 /** Global variable holding the current ir graph.
112  *
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.
116  */
117 FIRM_API ir_graph *current_ir_graph;
118
119 FIRM_API ir_graph *get_current_ir_graph(void);
120 FIRM_API void set_current_ir_graph(ir_graph *graph);
121
122 /**
123  * Create a new ir graph to build ir for a procedure.
124  *
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.
127  *
128  * @param n_loc  The number of local variables in this procedure including
129  *               the procedure parameters.
130  *
131  * This constructor generates the basic infrastructure needed to
132  * represent a procedure in FIRM.
133  *
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:
137  *
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.
144  *
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.
150  *
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.
156  *
157  * @see new_pseudo_ir_graph()
158  */
159 FIRM_API ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
160
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.
168  */
169 FIRM_API void free_ir_graph(ir_graph *irg);
170
171 /* --- access routines for all ir_graph attributes --- */
172
173 /**
174  *   Checks whether a pointer points to a ir graph.
175  *
176  *   @param thing     an arbitrary pointer
177  *
178  *   @return
179  *       true if the thing is a IR graph, else false
180  */
181 FIRM_API int is_ir_graph(const void *thing);
182
183 /** Returns the entity of an IR graph. */
184 FIRM_API ir_entity *get_irg_entity(const ir_graph *irg);
185 /** Sets the entity of an IR graph. */
186 FIRM_API void set_irg_entity(ir_graph *irg, ir_entity *ent);
187
188 /** Returns the frame type of an IR graph. */
189 FIRM_API ir_type *get_irg_frame_type(ir_graph *irg);
190 /** Sets the frame type of an IR graph. */
191 FIRM_API void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
192
193 /** Returns the start block of an IR graph. */
194 FIRM_API ir_node *get_irg_start_block(const ir_graph *irg);
195 /** Sets the start block of an IR graph. */
196 FIRM_API void set_irg_start_block(ir_graph *irg, ir_node *node);
197
198 /** Returns the Start node of an IR graph. */
199 FIRM_API ir_node *get_irg_start(const ir_graph *irg);
200 /** Sets the Start node of an IR graph. */
201 FIRM_API void set_irg_start(ir_graph *irg, ir_node *node);
202
203 /** Returns the end block of an IR graph. */
204 FIRM_API ir_node *get_irg_end_block(const ir_graph *irg);
205 /** Sets the end block of an IR graph. */
206 FIRM_API void set_irg_end_block(ir_graph *irg, ir_node *node);
207
208 /** Returns the End node of an IR graph. */
209 FIRM_API ir_node *get_irg_end(const ir_graph *irg);
210 /** Sets the End node of an IR graph. */
211 FIRM_API void set_irg_end(ir_graph *irg, ir_node *node);
212
213 /** Returns the node that represents the initial control flow of the given
214  * IR graph. */
215 FIRM_API ir_node *get_irg_initial_exec(const ir_graph *irg);
216 /** Sets the node that represents the initial control of the given IR graph. */
217 FIRM_API void set_irg_initial_exec(ir_graph *irg, ir_node *node);
218
219 /** Returns the node that represents the frame pointer of the given IR graph. */
220 FIRM_API ir_node *get_irg_frame(const ir_graph *irg);
221 /** Sets the node that represents the frame pointer of the given IR graph. */
222 FIRM_API void set_irg_frame(ir_graph *irg, ir_node *node);
223
224 /** Returns the node that represents the initial memory of the given IR graph. */
225 FIRM_API ir_node *get_irg_initial_mem(const ir_graph *irg);
226 /** Sets the node that represents the initial memory of the given IR graph. */
227 FIRM_API void set_irg_initial_mem(ir_graph *irg, ir_node *node);
228
229 /** Returns the node that represents the argument pointer of the given IR graph. */
230 FIRM_API ir_node *get_irg_args(const ir_graph *irg);
231 /** Sets the node that represents the argument pointer of the given IR graph. */
232 FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
233
234 /** Returns the NoMem node of the given IR graph. */
235 FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg);
236 FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node);
237
238 /** Returns the number of value numbers of an IR graph. */
239 FIRM_API int get_irg_n_locs(ir_graph *irg);
240
241 /** Returns the graph number. */
242 FIRM_API long get_irg_graph_nr(const ir_graph *irg);
243
244 /**
245  * Returns the graph number. This is a unique number for the graph and is
246  * smaller than get_irp_last_idx()
247  * Note: you cannot use this number for get_irp_irg()
248  */
249 FIRM_API size_t get_irg_idx(const ir_graph *irg);
250
251 /**
252  * Get the node for an index.
253  * @param irg The graph.
254  * @param idx The index you want the node for.
255  * @return    The node with that index or NULL, if there is no node with that
256  *            index.
257  * @note      The node you got might be dead.
258  */
259 FIRM_API ir_node *get_idx_irn(const ir_graph *irg, unsigned idx);
260
261
262 /******************************************************************************/
263 /* States of an ir_graph.                                                     */
264 /******************************************************************************/
265
266 /*
267    information associated with the graph.  Optimizations invalidate these
268    states.  */
269
270 /** The states of an ir graph.
271  *
272  * state phase values: phase_building, phase_high, phase_low, phase_backend.
273  *
274  * The graph is in phase_building during construction of the irgraph.
275  * The construction is finished by a call to finalize_cons().
276  *
277  * Finalize_cons() sets the state to phase_high.  All standard Firm nodes are
278  * allowed.
279  *
280  * To get the irgraph into phase_low all Sel nodes must be removed and
281  * replaced by explicit address computations.  SymConst size and
282  * type tag nodes must be removed (@@@ really?).  Initialization of
283  * memory allocated by Alloc must be explicit.  @@@ More conditions?
284  *
285  * phase_backend is set if architecture specific machine nodes are inserted
286  * (and probably most standard Firm are removed).
287  */
288 typedef enum {
289         phase_building,  /**< The graph is still being constructed. */
290         phase_high,      /**< The construction of the graph is finish, high level nodes may be present. */
291         phase_low,       /**< High level nodes are removed. */
292         phase_backend    /**< The graph is taken by the backend.  Machine specific nodes may be present. */
293 } irg_phase_state;
294
295 /** Returns the phase_state of an IR graph. */
296 FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg);
297
298 /** Sets the phase state of an IR graph. */
299 FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
300
301 /** state: op_pin_state_pinned
302    The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
303    It is in state "op_pin_state_floats" if nodes are in arbitrary blocks.  In state
304    "op_pin_state_floats" the block predecessor is set in all nodes, but this can be an
305    invalid block, i.e., the block is not a dominator of all the uses of
306    the node.
307    The enum op_pin_state is defined in irop.h. */
308 FIRM_API op_pin_state get_irg_pinned(const ir_graph *irg);
309
310 /** state: outs_state
311  *  Outs are the back edges or def-use edges of ir nodes.
312  *  Values:  outs_none, outs_consistent, outs_inconsistent */
313 typedef enum {
314         outs_none,         /**< Outs are not computed, no memory is allocated. */
315         outs_consistent,   /**< Outs are computed and correct. */
316         outs_inconsistent  /**< Outs have been computed, memory is still allocated,
317                                 but the graph has been changed since. */
318 } irg_outs_state;
319
320 /** state:  extended basic block state. */
321 typedef enum {
322         ir_extblk_info_none    = 0,  /**< No extended basic block information is constructed. Default. */
323         ir_extblk_info_valid   = 1,  /**< Extended basic block information is valid. */
324         ir_extblk_info_invalid = 2   /**< Extended basic block information is constructed but invalid. */
325 } irg_extblk_info_state;
326 FIRM_API irg_extblk_info_state get_irg_extblk_state(const ir_graph *irg);
327 FIRM_API void set_irg_extblk_inconsistent(ir_graph *irg);
328
329 /** state: dom_state
330  * Signals the state of the dominator / post dominator information.
331  */
332 typedef enum {
333         dom_none,             /**< dominator are not computed, no memory is allocated */
334         dom_consistent,       /**< dominator information is computed and correct */
335         dom_inconsistent      /**< dominator information is computed but the graph has been changed since */
336 } irg_dom_state;
337
338 /** returns the dominator state of an IR graph. */
339 FIRM_API irg_dom_state get_irg_dom_state(const ir_graph *irg);
340
341 /** returns the post dominator state of an IR graph. */
342 FIRM_API irg_dom_state get_irg_postdom_state(const ir_graph *irg);
343
344 /** sets the dominator and post dominator state of an IR graph to inconsistent. */
345 FIRM_API void set_irg_doms_inconsistent(ir_graph *irg);
346
347 /** state: loopinfo_state
348  *  Loop information describes the loops within the control and
349  *  data flow of the procedure.
350  */
351 typedef enum {
352         loopinfo_none             = 0,       /**< No loop information is constructed. Default. */
353         loopinfo_constructed      = 1,       /**< Some kind of loop information is constructed. */
354         loopinfo_valid            = 2,       /**< Loop information is valid. */
355         loopinfo_cf               = 4,       /**< Loop information constructed for control flow only. */
356         loopinfo_inter            = 8,       /**< Loop information for interprocedural view. */
357
358         /** IntRAprocedural loop information constructed and valid. */
359         loopinfo_consistent         = loopinfo_constructed | loopinfo_valid,
360         /** IntRAprocedural loop information constructed and invalid. */
361         loopinfo_inconsistent       = loopinfo_constructed,
362
363         /** IntERprocedural loop information constructed and valid. */
364         loopinfo_ip_consistent      = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
365         /** IntERprocedural loop information constructed and invalid. */
366         loopinfo_ip_inconsistent    = loopinfo_constructed | loopinfo_inter,
367
368         /** IntRAprocedural control loop information constructed and valid. */
369         loopinfo_cf_consistent      = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
370         /** IntRAprocedural control loop information constructed and invalid. */
371         loopinfo_cf_inconsistent    = loopinfo_constructed | loopinfo_cf,
372
373         /** IntERprocedural control loop information constructed and valid. */
374         loopinfo_cf_ip_consistent   = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
375         /** IntERprocedural control loop information constructed and invalid. */
376         loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
377 } irg_loopinfo_state;
378
379 /** Return the current loop information state. */
380 FIRM_API irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
381
382 /** Sets the current loop information state. */
383 FIRM_API void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
384
385 /** Sets the loop information state to the appropriate inconsistent state.
386  *  If state is 'none' does not change. */
387 FIRM_API void set_irg_loopinfo_inconsistent(ir_graph *irg);
388 /** Sets the loop information state to the appropriate inconsistent state.
389  *  If state is 'none' does not change.
390  *  Does this for all irgs. */
391 FIRM_API void set_irp_loopinfo_inconsistent(void);
392
393 /** state: callee_information_state
394  *  Call nodes contain a list of possible callees.  This list must be
395  *  computed by an analysis.
396  *
397  *  It's strange that this state is administered on irg basis, as the
398  *  information must be computed for the whole program, or not?
399  */
400 typedef enum {
401         irg_callee_info_none,
402         irg_callee_info_consistent,
403         irg_callee_info_inconsistent
404 } irg_callee_info_state;
405
406 /** Returns the callee_info_state of an IR graph. */
407 FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
408
409 /** Sets the callee_info_state of an IR graph. */
410 FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
411
412 /** property:
413  *  Tells how to handle an ir graph in inlining.
414  */
415 typedef enum {
416         irg_inline_any,            /**< No restriction on inlining. Default. */
417         irg_inline_forbidden,      /**< The graph must not be inlined. */
418         irg_inline_recomended,     /**< The graph should be inlined. */
419         irg_inline_forced,         /**< The graph must be inlined. */
420         irg_inline_forced_no_body  /**< The graph must be inlined. No body is allowed
421                                         to be emitted. */
422 } irg_inline_property;
423
424 /** Returns the inline property of a graph. */
425 FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg);
426 /** Sets the inline property of a graph. */
427 FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
428
429 /**
430  * Returns the mask of the additional graph properties.
431  * The properties are automatically inherited from the method type
432  * if they were not set using set_irg_additional_properties() or
433  * set_irg_additional_properties().
434  *
435  * @return a bitset of mtp_additional_properties values
436  */
437 FIRM_API mtp_additional_properties get_irg_additional_properties(const ir_graph *irg);
438
439 /** Sets the mask of the additional graph properties. */
440 FIRM_API void set_irg_additional_properties(ir_graph *irg,
441                                             mtp_additional_properties property_mask);
442
443 /** Sets one additional graph property. */
444 FIRM_API void add_irg_additional_properties(ir_graph *irg,
445                                             mtp_additional_properties flag);
446
447 /** A void * field to link arbitrary information to the node. */
448 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
449 FIRM_API void *get_irg_link(const ir_graph *irg);
450
451 /** Increments visited flag by one.
452  *  @see also: get_irn_visited() get_irg_block_visited(). */
453 FIRM_API void inc_irg_visited(ir_graph *irg);
454 FIRM_API ir_visited_t get_irg_visited(const ir_graph *irg);
455 FIRM_API void set_irg_visited(ir_graph *irg, ir_visited_t i);
456 /** An interprocedural flag valid for all irgs.
457  *  @see also: get_irn_visited() get_irg_block_visited(). */
458 FIRM_API ir_visited_t get_max_irg_visited(void);
459 FIRM_API void set_max_irg_visited(int val);
460 FIRM_API ir_visited_t inc_max_irg_visited(void);
461
462 /** Increments block_visited by one.
463  *  @see also: get_irn_visited() get_irg_block_visited(). */
464 FIRM_API void inc_irg_block_visited(ir_graph *irg);
465 FIRM_API ir_visited_t get_irg_block_visited(const ir_graph *irg);
466 FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
467
468 /**
469  * Debug helpers: You can indicate whether you are currently using visited or
470  * block_visited flags. If NDEBUG is not defined, then the compiler will abort
471  * if 2 parties try to use the flags.
472  */
473 typedef enum ir_resources_t {
474         /* local (irg) resources */
475         IR_RESOURCE_NONE          = 0,
476         IR_RESOURCE_BLOCK_VISITED = 1 << 0,  /**< Block visited flags are used. */
477         IR_RESOURCE_BLOCK_MARK    = 1 << 1,  /**< Block mark bits are used. */
478         IR_RESOURCE_IRN_VISITED   = 1 << 2,  /**< IR-node visited flags are used. */
479         IR_RESOURCE_IRN_LINK      = 1 << 3,  /**< IR-node link fields are used. */
480         IR_RESOURCE_LOOP_LINK     = 1 << 4,  /**< IR-loop link fields are used. */
481         IR_RESOURCE_PHI_LIST      = 1 << 5   /**< Block Phi lists are used. */
482 } ir_resources_t;
483 ENUM_BITSET(ir_resources_t)
484
485 #ifndef NDEBUG
486 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
487 FIRM_API void ir_free_resources(ir_graph *irg, ir_resources_t resources);
488 FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg);
489 #else
490 #define ir_reserve_resources(irg,resources)  (void)0
491 #define ir_free_resources(irg,resources)     (void)0
492 #define ir_resources_reserved(irg)           0
493 #endif
494
495 /**
496  * Graph State
497  */
498 typedef enum {
499         IR_GRAPH_STATE_KEEP_MUX      = 1U << 0,  /**< should perform no further optimisations on Mux nodes */
500         IR_GRAPH_STATE_ARCH_DEP      = 1U << 1,  /**< should not construct more nodes which irarch potentially breaks down */
501         IR_GRAPH_STATE_BCONV_ALLOWED = 1U << 2,  /**< Conv(mode_b) to Iu is allowed as set command */
502         /**
503          * There are normalisations where there is no "best" representative.
504          * In this case we first normalise into 1 direction (!NORMALISATION2) and
505          * later in the other (NORMALISATION2).
506          */
507         IR_GRAPH_STATE_NORMALISATION2        = 1U << 4,
508         /**
509          * Define the semantic of Load(Sel(x)), if x has a bit offset (Bitfields!).
510          * Normally, the frontend is responsible for bitfield masking operations.
511          * Set IMPLICIT_BITFIELD_MASKING, if the lowering phase must insert masking operations.
512          */
513         IR_GRAPH_STATE_IMPLICIT_BITFIELD_MASKING  = 1U << 5,
514
515         IR_GRAPH_STATE_NO_CRITICAL_EDGES        = 1U << 6,
516         IR_GRAPH_STATE_NO_BAD_BLOCKS            = 1U << 7,
517         IR_GRAPH_STATE_NO_UNREACHABLE_BLOCKS    = 1U << 8,
518         IR_GRAPH_STATE_ONE_RETURN               = 1U << 9,
519         IR_GRAPH_STATE_CONSISTENT_DOMINANCE     = 1U << 10,
520         IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE = 1U << 11,
521         IR_GRAPH_STATE_CONSISTENT_OUT_EDGES     = 1U << 12,
522         IR_GRAPH_STATE_CONSISTENT_OUTS          = 1U << 13,
523         IR_GRAPH_STATE_CONSISTENT_LOOPINFO      = 1U << 14,
524         IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE  = 1U << 15,
525         IR_GRAPH_STATE_VALID_EXTENDED_BLOCKS    = 1U << 16,
526         IR_GRAPH_STATE_BROKEN_FOR_VERIFIER      = 1U << 17,
527 } ir_graph_state_t;
528 ENUM_BITSET(ir_graph_state_t)
529
530 /** set some state flags on the graph (this does not clear the other flags) */
531 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
532 /** clear some state flags of the graph */
533 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
534 /** query whether a set of graph state flags are activated */
535 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
536
537 /** Set a description for local value n. */
538 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);
539
540 /** Get the description for local value n. */
541 FIRM_API void *get_irg_loc_description(ir_graph *irg, int n);
542
543 /** Returns a estimated node count of the irg. This count is updated
544  * after every irg_walk_graph().
545  */
546 FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
547
548 /** Returns the last irn index for this graph. */
549 FIRM_API unsigned get_irg_last_idx(const ir_graph *irg);
550
551 /** Returns the floating point model of this graph. */
552 FIRM_API unsigned get_irg_fp_model(const ir_graph *irg);
553
554 /** Sets a floating point model for this graph. */
555 FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model);
556
557 /**
558  * Access custom graph data.
559  * The data must have been registered with
560  * register_additional_graph_data() before.
561  * @param graph The graph to get the data from.
562  * @param type The type of the data you registered.
563  * @param off The value returned by register_additional_graph_data().
564  * @return A pointer of type @p type.
565  */
566 #define get_irg_data(graph,type,off) \
567         (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
568
569 /**
570  * Get the pointer to the node some custom data belongs to.
571  * @param data The pointer to the custom data.
572  * @param off The number as returned by register_additional_graph_data().
573  * @return A pointer to the ir node the custom data belongs to.
574  */
575 #define get_irg_data_base(data,off) \
576         (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
577
578 /**
579  * Request additional data to be allocated with an ir graph.
580  * @param size The size of the additional data required.
581  * @return A positive number, if the operation was successful, which
582  * must be passed to the access macro get_irg_data(), 0 if the
583  * registration failed.
584  */
585 FIRM_API size_t register_additional_graph_data(size_t size);
586
587 #include "end.h"
588
589 #endif