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