nsz Git - libfirm/blob - ir/ir/irtypes.h

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