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