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