remove unused exception region numbers
[libfirm] / ir / ir / irtypes.h
1 /*
2  * Copyright (C) 1995-2011 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   Definition of the Firm IR base types, concentrated here
23  * @author  Michael Beck
24  */
25 #ifndef FIRM_IR_IRDEFS_H
26 #define FIRM_IR_IRDEFS_H
27
28 #include <stdbool.h>
29
30 #include "firm_types.h"
31 #include "irdom_t.h"
32 #include "irmode.h"
33 #include "irnode.h"
34 #include "irgraph.h"
35 #include "iredgekinds.h"
36 #include "irtypeinfo.h"
37 #include "irextbb.h"
38 #include "irmemory.h"
39 #include "callgraph.h"
40 #include "irprog.h"
41 #include "bitset.h"
42
43 #include "pset.h"
44 #include "set.h"
45 #include "list.h"
46 #include "obst.h"
47 #include "vrp.h"
48
49 struct ir_nodemap {
50         void **data;  /**< maps node indices to void* */
51 };
52
53 /** The type of an ir_op. */
54 struct ir_op {
55         unsigned code;            /**< The unique opcode of the op. */
56         ident *name;              /**< The name of the op. */
57         size_t attr_size;         /**< Space needed in memory for private attributes
58                                        */
59         op_pin_state pin_state;   /**< How to deal with the node in CSE, PRE. */
60         op_arity opar;            /**< The arity of operator. */
61         int op_index;             /**< The index of the first data operand, 0 for
62                                        most cases, 1 for Div etc. */
63         int memory_index;         /**< index of memory input for memory nodes */
64         int pn_x_regular;         /**< for fragile ops the position of the
65                                        X_regular output */
66         int pn_x_except;          /**< for fragile ops the position of the
67                                        X_except output */
68         unsigned flags;           /**< Flags describing the behavior of the ir_op,
69                                        a bitmasks of irop_flags. */
70         unsigned tag;             /**< Some custom TAG value the op's creator set */
71         void *attr;               /**< custom pointer where op's creator can attach
72                                        attribute stuff to. */
73         ir_op_ops ops;            /**< The operations of the this op. */
74 };
75
76 /** Helper values for ir_mode_sort. */
77 enum ir_mode_sort_helper {
78         irmsh_is_num   = 0x10, /**< mode represents a number */
79         irmsh_is_data  = 0x20, /**< mode represents data (can be carried in registers) */
80         irmsh_is_datab = 0x40, /**< mode represents data or is internal boolean */
81         irmsh_is_dataM = 0x80, /**< mode represents data or is memory */
82 };
83
84 /**
85  * These values represent the different mode classes of value representations.
86  * Beware: do not change the order of these values without checking
87  * the mode_is
88  */
89 typedef enum ir_mode_sort {
90         irms_control_flow     = 0, /**< Marks all control flow modes. */
91         irms_block            = 1,
92         irms_tuple            = 2,
93         irms_any              = 3,
94         irms_bad              = 4,
95         irms_memory           = 5 | irmsh_is_dataM, /**< Marks the memory mode.  Not extensible. (irm_M) */
96
97         /** Internal boolean representation.
98              Storing to memory impossible, convert first. (irm_b) */
99         irms_internal_boolean = 6 | irmsh_is_datab,
100
101         /** A mode to represent entities.
102             Restricted int computations can be performed */
103         irms_reference        = 7 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM,
104         /** A mode to represent int numbers.
105             Integer computations can be performed. */
106         irms_int_number       = 8 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
107         /** A mode to represent float numbers.
108             Floating point computations can be performed. */
109         irms_float_number     = 9 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
110 } ir_mode_sort;
111
112 /**
113  * A descriptor for an IEEE754 float value.
114  */
115 typedef struct float_descriptor_t {
116         unsigned char exponent_size;    /**< size of exponent in bits */
117         unsigned char mantissa_size;    /**< size of mantissa in bits */
118         bool          explicit_one;     /**< set if the leading one is explicit */
119 } float_descriptor_t;
120
121 /**
122  * Contains relevant information about a mode.
123  *
124  * Necessary information about a mode is stored in this struct
125  * which is used by the tarval module to perform calculations
126  * and comparisons of values of a such described mode.
127  *
128  * ATTRIBUTES:
129  *  -  ident *name:             Name of this mode. Two modes are different if the name is different.
130  *  -  ir_mode_sort sort:       sort of mode specifying possible usage categories
131  *  -  int    size:             size of the mode in Bits.
132  *  -  unsigned sign:1:         signedness of this mode
133  *  -  ... more to come
134  *  -  modulo_shift             specifies for modes of kind irms_int_number
135  *                              whether shift applies modulo to value of bits to shift
136  *
137  * SEE ALSO:
138  *    The tech report 1999-44 describing FIRM and predefined modes
139  *    tarval.h
140  */
141 struct ir_mode {
142         firm_kind         kind;       /**< distinguishes this node from others */
143         ident             *name;      /**< Name ident of this mode */
144         ir_type           *type;      /**< corresponding primitive type */
145
146         /* ---------------------------------------------------------------------- */
147         /* On changing this struct you have to evaluate the mode_are_equal function!*/
148         ir_mode_sort       sort;          /**< coarse classification of this mode:
149                                            int, float, reference ...
150                                            (see irmode.h) */
151         ir_mode_arithmetic arithmetic;    /**< different arithmetic operations possible with a mode */
152         unsigned           size;          /**< size of the mode in Bits. */
153         unsigned           sign:1;        /**< signedness of this mode */
154         unsigned int       modulo_shift;  /**< number of bits a values of this mode will be shifted */
155         float_descriptor_t float_desc;
156
157         /* ---------------------------------------------------------------------- */
158         ir_tarval         *min;         /**< the minimum value that can be expressed */
159         ir_tarval         *max;         /**< the maximum value that can be expressed */
160         ir_tarval         *null;        /**< the value 0 */
161         ir_tarval         *one;         /**< the value 1 */
162         ir_tarval         *minus_one;   /**< the value -1 */
163         ir_tarval         *all_one;     /**< the value ~0 */
164         ir_mode           *eq_signed;   /**< For pointer modes, the equivalent signed integer one. */
165         ir_mode           *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
166         void              *link;        /**< To store some intermediate information */
167         const void        *tv_priv;     /**< tarval module will save private data here */
168 };
169
170 /* note: we use "long" here because that is the type used for Proj-Numbers */
171 typedef struct ir_switch_table_entry {
172         ir_tarval *min;
173         ir_tarval *max;
174         long       pn;
175 } ir_switch_table_entry;
176
177 struct ir_switch_table {
178         size_t                n_entries;
179         ir_switch_table_entry entries[];
180 };
181
182 /* ir node attributes */
183
184 /** first attribute of Bad, Block, Anchor nodes */
185 typedef struct irg_attr {
186         ir_graph *irg;              /**< The graph this block like node belongs to. */
187 } irg_attr;
188
189 typedef struct bad_attr {
190         irg_attr    irg;
191 } bad_attr;
192
193 typedef struct anchor_attr {
194         irg_attr  irg;
195 } anchor_attr;
196
197 /** Block attributes */
198 typedef struct block_attr {
199         /* General attributes */
200         irg_attr     irg;           /**< The graph this block belongs to. */
201         ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
202         /* Attributes private to construction: */
203         unsigned is_matured:1;      /**< If set, all in-nodes of the block are fixed. */
204         unsigned marked:1;          /**< Can be set/unset to temporary mark a block. */
205         ir_node **graph_arr;        /**< An array to store all parameters. */
206         /* Attributes holding analyses information */
207         ir_dom_info dom;            /**< Datastructure that holds information about dominators.
208                                          @@@ @todo
209                                          Eventually overlay with graph_arr as only valid
210                                          in different phases.  Eventually inline the whole
211                                          datastructure. */
212         ir_dom_info pdom;           /**< Datastructure that holds information about post-dominators. */
213         ir_node ** in_cg;           /**< array with predecessors in
214                                      * interprocedural_view, if they differ
215                                      * from intraprocedural predecessors */
216         bitset_t *backedge;         /**< Bitfield n set to true if pred n is backedge.*/
217         bitset_t *cg_backedge;      /**< Bitfield n set to true if pred n is interprocedural backedge. */
218         ir_extblk *extblk;          /**< The extended basic block this block belongs to. */
219         ir_entity *entity;          /**< entitiy representing this block */
220         ir_node  *phis;             /**< The list of Phi nodes in this block. */
221
222         struct list_head succ_head; /**< A list head for all successor edges of a block. */
223 } block_attr;
224
225 /** Cond attributes. */
226 typedef struct cond_attr {
227         long default_proj;           /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
228         cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
229 } cond_attr;
230
231 /** Const attributes. */
232 typedef struct const_attr {
233         ir_tarval *tarval;  /**< the target value */
234 } const_attr;
235
236 /** SymConst attributes. */
237 typedef struct symconst_attr {
238         symconst_symbol sym;  // old tori
239         symconst_kind   kind;
240 } symconst_attr;
241
242 /** Sel attributes. */
243 typedef struct sel_attr {
244         ir_entity *entity;    /**< entity to select */
245 } sel_attr;
246
247 /** Exception attributes. */
248 typedef struct except_attr {
249         unsigned  pin_state : 2;         /**< the pin state for operations with
250                                               variable pinned state. Contains a
251                                               op_pin_state */
252         unsigned  throws_exception : 1; /**< if true a fragile op throws and
253                                              must produce X_except and X_regular
254                                              values */
255 } except_attr;
256
257 /** Call attributes. */
258 typedef struct call_attr {
259         except_attr exc;               /**< the exception attribute. MUST be the first one. */
260         ir_type     *type;             /**< type of called procedure */
261         ir_entity   **callee_arr;      /**< result of callee analysis */
262 } call_attr;
263
264 /** Builtin attributes. */
265 typedef struct builtin_attr {
266         except_attr     exc;           /**< the exception attribute. MUST be the first one. */
267         ir_builtin_kind kind;          /**< kind of the called builtin procedure */
268         ir_type         *type;         /**< type of called builtin procedure */
269 } builtin_attr;
270
271 /** Alloc attributes. */
272 typedef struct alloc_attr {
273         except_attr    exc;           /**< the exception attribute. MUST be the first one. */
274     ir_where_alloc where;         /**< stack, heap or other managed part of memory */
275         ir_type        *type;         /**< Type of the allocated object.  */
276 } alloc_attr;
277
278 /** Free attributes. */
279 typedef struct free_attr {
280         ir_type *type;                /**< Type of the allocated object.  */
281         ir_where_alloc where;         /**< stack, heap or other managed part of memory */
282 } free_attr;
283
284 /** InstOf attributes. */
285 typedef struct io_attr {
286         except_attr    exc;           /**< the exception attribute. MUST be the first one. */
287         ir_type *type;                /**< the type of which the object pointer must be */
288 } io_attr;
289
290 /** Cast attributes. */
291 typedef struct cast_attr {
292         ir_type *type;                /**< Type of the casted node. */
293 } cast_attr;
294
295 /** Load attributes. */
296 typedef struct load_attr {
297         except_attr   exc;            /**< The exception attribute. MUST be the first one. */
298     unsigned      volatility:1;   /**< The volatility of this Load operation. */
299     unsigned      unaligned:1;    /**< The align attribute of this Load operation. */
300         ir_mode       *mode;          /**< The mode of this Load operation. */
301 } load_attr;
302
303 /** Store attributes. */
304 typedef struct store_attr {
305         except_attr   exc;            /**< the exception attribute. MUST be the first one. */
306         unsigned      volatility:1;   /**< The volatility of this Store operation. */
307         unsigned      unaligned:1;    /**< The align attribute of this Store operation. */
308 } store_attr;
309
310 typedef struct phi_attr {
311         ir_node        *next;         /**< Points to the next Phi in the Phi list of a block. */
312         union {
313                 bitset_t      *backedge;     /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
314                 int            pos;           /**< For Phi0. Used to remember the value defined by
315                                                this Phi node.  Needed when the Phi is completed
316                                                to call get_r_internal_value() to find the
317                                                predecessors. If this attribute is set, the Phi
318                                                node takes the role of the obsolete Phi0 node,
319                                                therefore the name. */
320         } u;
321 } phi_attr;
322
323 /**< Cmp attribute. */
324 typedef struct cmp_attr {
325         ir_relation relation;         /**< comparison condition. */
326 } cmp_attr;
327
328 /**< Confirm attribute. */
329 typedef struct confirm_attr {
330         ir_relation relation;         /**< relation between value and bound */
331 } confirm_attr;
332
333 /** CopyB attribute. */
334 typedef struct copyb_attr {
335         except_attr    exc;           /**< The exception attribute. MUST be the first one. */
336         ir_type        *type;         /**< Type of the copied entity. */
337 } copyb_attr;
338
339 /** Bound attribute. */
340 typedef struct bound_attr {
341         except_attr exc;              /**< The exception attribute. MUST be the first one. */
342 } bound_attr;
343
344 /** Conv attribute. */
345 typedef struct conv_attr {
346         char           strict;        /**< If set, this is a strict Conv that cannot be removed. */
347 } conv_attr;
348
349 /** Div attribute. */
350 typedef struct div_attr {
351         except_attr    exc;           /**< The exception attribute. MUST be the first one. */
352         ir_mode        *resmode;      /**< Result mode for the division. */
353         char           no_remainder;  /**< Set, if known that a division can be done without a remainder. */
354 } div_attr;
355
356 /** Mod attribute. */
357 typedef struct mod_attr {
358         except_attr    exc;           /**< The exception attribute. MUST be the first one. */
359         ir_mode        *resmode;      /**< Result mode for the division. */
360 } mod_attr;
361
362 /** Inline Assembler support attribute. */
363 typedef struct asm_attr {
364         /* BEWARE: pin state MUST be the first attribute */
365         op_pin_state      pin_state;            /**< the pin state for operations that might generate a exception */
366         ident             *text;                /**< The inline assembler text. */
367         ir_asm_constraint *input_constraints;   /**< Input constraints. */
368         ir_asm_constraint *output_constraints;  /**< Output constraints. */
369         ident             **clobbers;           /**< List of clobbered registers. */
370 } asm_attr;
371
372 typedef struct proj_attr {
373         long  proj;           /**< position of tuple sub-value which is projected */
374 } proj_attr;
375
376 typedef struct switch_attr {
377         unsigned         n_outs;
378         ir_switch_table *table;
379 } switch_attr;
380
381 /** Some IR-nodes just have one attribute, these are stored here,
382    some have more. Their name is 'irnodename_attr' */
383 typedef union ir_attr {
384         irg_attr       irg;           /**< For Blocks and Bad: its belonging irg */
385         bad_attr       bad;           /**< for Bads: irg reference */
386         anchor_attr    anchor;        /**< for Anchor: irg reference */
387         block_attr     block;         /**< For Block: Fields needed to construct it */
388         cmp_attr       cmp;           /**< For Cmp. */
389         cond_attr      cond;          /**< For Cond. */
390         const_attr     con;           /**< For Const: contains the value of the constant and a type */
391         symconst_attr  symc;          /**< For SymConst. */
392         sel_attr       sel;           /**< For Sel. */
393         call_attr      call;          /**< For Call. */
394         builtin_attr   builtin;       /**< For Builtin. */
395         alloc_attr     alloc;         /**< For Alloc. */
396         free_attr      free;          /**< For Free. */
397         io_attr        instof;        /**< For InstOf */
398         cast_attr      cast;          /**< For Cast. */
399         load_attr      load;          /**< For Load. */
400         store_attr     store;         /**< For Store. */
401         phi_attr       phi;           /**< For Phi. */
402         proj_attr      proj;          /**< For Proj. */
403         confirm_attr   confirm;       /**< For Confirm: compare operation and region. */
404         except_attr    except;        /**< For Phi node construction in case of exceptions */
405         copyb_attr     copyb;         /**< For CopyB operation */
406         bound_attr     bound;         /**< For Bound operation */
407         conv_attr      conv;          /**< For Conv operation */
408         div_attr       div;           /**< For Div operation */
409         mod_attr       mod;           /**< For Mod operation */
410         asm_attr       assem;         /**< For ASM operation. */
411         switch_attr    switcha;       /**< For Switch operation. */
412 } ir_attr;
413
414 /**
415  * Edge info to put into an irn.
416  */
417 typedef struct irn_edge_kind_info_t {
418         struct list_head outs_head;  /**< The list of all outs. */
419         unsigned edges_built : 1;    /**< Set edges where built for this node. */
420         unsigned out_count : 31;     /**< Number of outs in the list. */
421 } irn_edge_info_t;
422
423 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
424
425 /**
426  * A Def-Use edge.
427  */
428 typedef struct ir_def_use_edge {
429         ir_node *use;            /** The use node of that edge. */
430         int     pos;             /** The position of this edge in use's input array. */
431 } ir_def_use_edge;
432
433 /**
434  * The common structure of an irnode.
435  * If the node has some attributes, they are stored in the attr field.
436  */
437 struct ir_node {
438         /* ------- Basics of the representation  ------- */
439         firm_kind kind;          /**< Distinguishes this node from others. */
440         unsigned node_idx;       /**< The node index of this node in its graph. */
441         ir_op *op;               /**< The Opcode of this node. */
442         ir_mode *mode;           /**< The Mode of this node. */
443         struct ir_node **in;     /**< The array of predecessors / operands. */
444         ir_visited_t visited;    /**< The visited counter for walks of the graph. */
445         void *link;              /**< To attach additional information to the node, e.g.
446                                       used during optimization to link to nodes that
447                                       shall replace a node. */
448         long node_nr;            /**< A globally unique node number for each node. */
449         /* ------- Fields for optimizations / analysis information ------- */
450         ir_def_use_edge *out;    /**< array of def-use edges. */
451         struct dbg_info *dbi;    /**< A pointer to information for debug support. */
452         /* ------- For debugging ------- */
453 #ifdef DEBUG_libfirm
454         unsigned out_valid : 1;
455         unsigned flags     : 31;
456 #endif
457         /* ------- For analyses -------- */
458         ir_loop *loop;           /**< the loop the node is in. Access routines in irloop.h */
459         struct ir_node **deps;   /**< Additional dependencies induced by state. */
460         void            *backend_info;
461         irn_edges_info_t edge_info;  /**< Everlasting out edges. */
462
463         /* ------- Opcode depending fields -------- */
464         ir_attr attr;            /**< The set of attributes of this node. Depends on opcode.
465                                       Must be last field of struct ir_node. */
466 };
467
468 #include "iredgeset.h"
469
470 /**
471  * Edge info to put into an irg.
472  */
473 typedef struct irg_edge_info_t {
474         ir_edgeset_t     edges;          /**< A set containing all edges of the current graph. */
475         struct list_head free_edges;     /**< list of all free edges. */
476         struct obstack   edges_obst;     /**< Obstack, where edges are allocated on. */
477         unsigned         allocated : 1;  /**< Set if edges are allocated on the obstack. */
478         unsigned         activated : 1;  /**< Set if edges are activated for the graph. */
479 } irg_edge_info_t;
480
481 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
482
483 /**
484  * Index constants for nodes that can be accessed through the graph anchor node.
485  */
486 typedef enum irg_anchors {
487         anchor_first,
488         anchor_end_block = anchor_first, /**< block the end node will belong to,
489                                               same as Anchors block */
490         anchor_start_block,      /**< block the start node will belong to */
491         anchor_end,              /**< end node of this ir_graph */
492         anchor_start,            /**< start node of this ir_graph */
493         anchor_initial_exec,     /**< methods initial control flow */
494         anchor_frame,            /**< methods frame */
495         anchor_initial_mem,      /**< initial memory of this graph */
496         anchor_args,             /**< methods arguments */
497         anchor_no_mem,           /**< NoMem node of this ir_graph, the one and only in this graph */
498         anchor_last = anchor_no_mem
499 } irg_anchors;
500 ENUM_COUNTABLE(irg_anchors)
501
502 /** A callgraph entry for callees. */
503 typedef struct cg_callee_entry {
504         ir_graph  *irg;        /**< The called irg. */
505         ir_node  **call_list;  /**< The list of all calls to the irg. */
506         size_t     max_depth;  /**< Maximum depth of all Call nodes to irg. */
507 } cg_callee_entry;
508
509 typedef struct ir_vrp_info {
510         struct ir_nodemap infos;
511         struct obstack    obst;
512 } ir_vrp_info;
513
514 /**
515  * An ir_graph holds all information for a procedure.
516  */
517 struct ir_graph {
518         firm_kind         kind;        /**< Always set to k_ir_graph. */
519         /* --  Basics of the representation -- */
520     unsigned last_node_idx;        /**< The last IR node index for this graph. */
521         ir_entity  *ent;               /**< The entity of this procedure, i.e.,
522                                             the type of the procedure and the
523                                             class it belongs to. */
524         ir_type *frame_type;           /**< A class type representing the stack frame.
525                                             Can include "inner" methods. */
526         ir_node *anchor;               /**< Pointer to the anchor node of this graph. */
527         struct obstack *obst;          /**< The obstack where all of the ir_nodes live. */
528         ir_node *current_block;        /**< Current block for newly gen_*()-erated ir_nodes. */
529         struct obstack *extbb_obst;    /**< The obstack for extended basic block info. */
530
531         /* -- Fields for graph properties -- */
532         irg_inline_property        inline_property;       /**< How to handle inlineing. */
533         mtp_additional_properties  additional_properties; /**< Additional graph properties. */
534
535         /* -- Fields indicating different states of irgraph -- */
536         ir_graph_state_t      state;
537         irg_phase_state       phase_state;       /**< Compiler phase. */
538         op_pin_state          irg_pinned_state;  /**< Flag for status of nodes. */
539         ir_typeinfo_state     typeinfo_state;    /**< Validity of type information. */
540         irg_callee_info_state callee_info_state; /**< Validity of callee information. */
541         ir_class_cast_state   class_cast_state;  /**< Kind of cast operations in code. */
542         unsigned mem_disambig_opt;               /**< Options for the memory disambiguator. */
543         unsigned fp_model;                       /**< floating point model of the graph. */
544
545         /* -- Fields for construction -- */
546         int n_loc;                         /**< Number of local variables in this
547                                                 procedure including procedure parameters. */
548         void **loc_descriptions;           /**< Storage for local variable descriptions. */
549
550         /* -- Fields for optimizations / analysis information -- */
551         pset *value_table;                 /**< Hash table for global value numbering (cse)
552                                                 for optimizing use in iropt.c */
553         ir_def_use_edge *outs;             /**< Space for the Def-Use arrays. */
554         ir_vrp_info      vrp;              /**< vrp info */
555
556         ir_loop *loop;                     /**< The outermost loop for this graph. */
557         void *link;                        /**< A void* field to link any information to
558                                                 the node. */
559
560         ir_graph **callers;                /**< For callgraph analysis: list of caller graphs. */
561         unsigned *caller_isbe;             /**< For callgraph analysis: raw bitset if backedge info calculated. */
562         cg_callee_entry **callees;         /**< For callgraph analysis: list of callee calls */
563         unsigned *callee_isbe;             /**< For callgraph analysis: raw bitset if backedge info calculated. */
564         ir_loop   *l;                            /**< For callgraph analysis. */
565         size_t     callgraph_loop_depth;         /**< For callgraph analysis */
566         size_t     callgraph_recursion_depth;    /**< For callgraph analysis */
567         double     method_execution_frequency;   /**< For callgraph analysis */
568
569
570         /* -- Fields for Walking the graph -- */
571         ir_visited_t visited;             /**< this flag is an identifier for
572                           ir walk. it will be incremented
573                           every time someone walks through
574                           the graph */
575         ir_visited_t block_visited;        /**< same as visited, for a complete block */
576
577         ir_visited_t self_visited;         /**< visited flag of the irg */
578
579         unsigned estimated_node_count;     /**< estimated number of nodes in this graph,
580                                                 updated after every walk */
581         irg_edges_info_t edge_info;        /**< edge info for automatic outs */
582         ir_node **idx_irn_map;             /**< Array mapping node indexes to nodes. */
583
584         size_t index;                      /**< a unique number for each graph */
585         /** extra info which should survive accross multiple passes */
586         void     *be_data;                 /**< backend can put in private data here */
587
588         unsigned  dump_nr;                 /**< number of graph dumps */
589 #ifdef DEBUG_libfirm
590         int   n_outs;                      /**< Size wasted for outs */
591         long graph_nr;                     /**< a unique graph number for each
592                                                 graph to make output readable. */
593 #endif
594
595 #ifndef NDEBUG
596         ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
597 #endif
598 };
599
600 /**
601  * Data structure that holds central information about a program
602  * or a module.
603  * One irp is created by libFirm on construction, so irp should never be NULL.
604  *
605  * - main_irg:  The ir graph that is the entry point to the program.
606  *              (Anything not reachable from here may be optimized away
607  *              if this irp represents a whole program.
608  * - irg:       List of all ir graphs in the program or module.
609  * - type:      A list containing all types known to the translated program.
610  *              Some types can have several entries in this list (as a result of
611  *              using exchange_types()).
612  * - glob_type: The unique global type that is owner of all global entities
613  *              of this module.
614  */
615 struct ir_prog {
616         firm_kind kind;                 /**< must be k_ir_prog */
617         ident     *name;                /**< A file name or the like. */
618         ir_graph  *main_irg;            /**< The entry point to the compiled program
619                                              or NULL if no point exists. */
620         ir_graph **graphs;              /**< A list of all graphs in the ir. */
621         ir_graph  *const_code_irg;      /**< This ir graph gives the proper environment
622                                              to allocate nodes the represent values
623                                              of constant entities. It is not meant as
624                                              a procedure.  */
625         ir_type   *segment_types[IR_SEGMENT_LAST+1];
626         ir_type  **types;               /**< A list of all types in the ir. */
627         ir_mode  **modes;               /**< A list of all modes in the ir. */
628         ir_op    **opcodes;             /**< A list of all opcodes in the ir. */
629         ident    **global_asms;         /**< An array of global ASM insertions. */
630
631         /* -- states of and access to generated information -- */
632         irg_phase_state phase_state;    /**< The state of construction. */
633
634         ir_node **ip_outedges;          /**< A huge Array that contains all out edges
635                                              in interprocedural view. */
636
637         irg_callee_info_state callee_info_state; /**< Validity of callee information.
638                                                       Contains the lowest value or all irgs.  */
639         ir_typeinfo_state typeinfo_state;    /**< Validity of type information. */
640         inh_transitive_closure_state inh_trans_closure_state;  /**< State of transitive closure
641                                                                     of inheritance relations. */
642
643         irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
644         ir_loop *outermost_cg_loop;          /**< For callgraph analysis: entry point
645                                                       to looptree over callgraph. */
646         size_t max_callgraph_loop_depth;        /**< needed in callgraph. */
647         size_t max_callgraph_recursion_depth;   /**< needed in callgraph. */
648         double max_method_execution_frequency;  /**< needed in callgraph. */
649         loop_nesting_depth_state lnd_state;  /**< The state of loop nesting depth information. */
650         ir_class_cast_state class_cast_state;    /**< The state of cast operations in code. */
651         ir_entity_usage_computed_state globals_entity_usage_state;
652
653         ir_label_t last_label_nr;            /**< The highest label number for generating unique labels. */
654         size_t max_irg_idx;                  /**< highest unused irg index */
655         long max_node_nr;                    /**< to generate unique numbers for nodes. */
656         unsigned dump_nr;                    /**< number of program info dumps */
657         unsigned optimization_dumps :1;      /**< dump irg on each optimization */
658 #ifndef NDEBUG
659         ir_resources_t reserved_resources;   /**< Bitset for tracking used global resources. */
660 #endif
661 };
662
663 #endif