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

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