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