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