- removed rest of already unsupported USE_EXPLICIT_PHI_IN_STACK
[libfirm] / ir / ir / irtypes.h
index 84c0690..1dd5178 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
 #include "execution_frequency.h"
 #include "irmemory.h"
 #include "callgraph.h"
+#include "irprog.h"
 #include "field_temperature.h"
+#include "irphases_t.h"
 
 #include "pset.h"
 #include "set.h"
 #include "list.h"
+#include "obst.h"
+
+struct ir_phase;
 
 /** The type of an ir_op. */
 struct ir_op {
        unsigned code;          /**< The unique opcode of the op. */
        ident *name;            /**< The name of the op. */
        size_t attr_size;       /**< Space needed in memory for private attributes. */
-       op_pin_state op_pin_state_pinned; /**< How to deal with the node in CSE, PRE. */
+       op_pin_state pin_state; /**< How to deal with the node in CSE, PRE. */
        op_arity opar;          /**< The arity of operator. */
        int op_index;           /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */
        unsigned flags;         /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */
-       void *tag;              /**< Some custom pointer the op's creator can attach stuff to. */
+       unsigned tag;           /**< Some custom TAG value the op's creator set to. */
+       void *attr;             /**< custom pointer where op's creator can attach attribute stuff to. */
 
        ir_op_ops ops;          /**< The operations of the this op. */
 };
@@ -65,9 +71,9 @@ struct ir_op {
  * and comparisons of values of a such described mode.
  *
  * ATTRIBUTES:
- *  -  modecode code:           An unambiguous int (enum) for the mode
+ *  -  ir_modecode code:        An unambiguous int (enum) for the mode
  *  -  ident *name:             Name of this mode. Two modes are different if the name is different.
- *  -  mode_sort sort:          sort of mode specifying possible usage categories
+ *  -  ir_mode_sort sort:       sort of mode specifying possible usage categories
  *  -  int    size:             size of the mode in Bits.
  *  -  unsigned sign:1:         signedness of this mode
  *  -  ... more to come
@@ -80,16 +86,17 @@ struct ir_op {
  */
 struct ir_mode {
        firm_kind         kind;       /**< distinguishes this node from others */
-       modecode          code;       /**< unambiguous identifier of a mode */
+       ir_modecode       code;       /**< unambiguous identifier of a mode */
        ident             *name;      /**< Name ident of this mode */
 
        /* ----------------------------------------------------------------------- */
        /* On changing this struct you have to evaluate the mode_are_equal function!*/
-       mode_sort         sort;          /**< coarse classification of this mode:
+       ir_mode_sort      sort;          /**< coarse classification of this mode:
                                           int, float, reference ...
                                           (see irmode.h) */
-       mode_arithmetic   arithmetic;    /**< different arithmetic operations possible with a mode */
-       int               size;          /**< size of the mode in Bits. */
+       ir_mode_arithmetic
+                         arithmetic;    /**< different arithmetic operations possible with a mode */
+       unsigned          size;          /**< size of the mode in Bits. */
        unsigned          sign:1;        /**< signedness of this mode */
        unsigned int      modulo_shift;  /**< number of bits a values of this mode will be shifted */
        unsigned          vector_elem;   /**< if this is not equal 1, this is a vector mode with
@@ -102,6 +109,7 @@ struct ir_mode {
        tarval            *null;        /**< the value 0 */
        tarval            *one;         /**< the value 1 */
        tarval            *minus_one;   /**< the value -1 */
+       tarval            *all_one;     /**< the value ~0 */
        ir_mode           *eq_signed;   /**< For pointer modes, the equivalent signed integer one. */
        ir_mode           *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
        void              *link;        /**< To store some intermediate information */
@@ -114,11 +122,13 @@ struct ir_mode {
 typedef struct {
        /* General attributes */
        ir_graph *irg;              /**< The graph this block belongs to. */
-       unsigned long block_visited; /**< For the walker that walks over all blocks. */
+       ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
        /* Attributes private to construction: */
        unsigned is_matured:1;      /**< If set, all in-nodes of the block are fixed. */
        unsigned is_dead:1;         /**< If set, the block is dead (and could be replace by a Bad. */
        unsigned is_mb_head:1;      /**< Set if this block is a macroblock head. */
+       unsigned has_label:1;       /**< Set if this block has a label assigned. */
+       unsigned marked:1;          /**< Can be set/unset to temporary mark a block. */
        ir_node **graph_arr;        /**< An array to store all parameters. */
        /* Attributes holding analyses information */
        ir_dom_info dom;            /**< Datastructure that holds information about dominators.
@@ -130,13 +140,13 @@ typedef struct {
        ir_node ** in_cg;           /**< array with predecessors in
                                     * interprocedural_view, if they differ
                                     * from intraprocedural predecessors */
-       int *backedge;              /**< Field n set to true if pred n is backedge.
-                                        @@@ @todo Ev. replace by bit field! */
-       int *cg_backedge;           /**< Field n set to true if pred n is interprocedural backedge.
-                                        @@@ @todo Ev. replace by bit field! */
+       unsigned *backedge;         /**< Raw Bitfield n set to true if pred n is backedge.*/
+       unsigned *cg_backedge;      /**< Raw Bitfield n set to true if pred n is interprocedural backedge. */
        ir_extblk *extblk;          /**< The extended basic block this block belongs to. */
        ir_region *region;          /**< The immediate structural region this block belongs to. */
        unsigned mb_depth;          /**< The macroblock depth: A distance from the macroblock header */
+       ir_label_t label;           /**< The block label if assigned. */
+       ir_node  *phis;             /**< The list of Phi nodes in this block. */
 
        struct list_head succ_head; /**< A list head for all successor edges of a block. */
 } block_attr;
@@ -157,8 +167,8 @@ typedef struct {
 /** SymConst attributes. */
 typedef struct {
        symconst_symbol sym;  // old tori
-       symconst_kind num;
-       ir_type *tp;       /**< the source type, for analyses. default: type_unknown. */
+       symconst_kind   kind;
+       ir_type         *tp;  /**< the source type, for analyses. default: type_unknown. */
 } symconst_attr;
 
 /** Sel attributes. */
@@ -186,14 +196,14 @@ typedef struct {
 /** Alloc attributes. */
 typedef struct {
        except_attr    exc;           /**< the exception attribute. MUST be the first one. */
-       ir_type *type;                /**< Type of the allocated object.  */
-       where_alloc where;            /**< stack, heap or other managed part of memory */
+    ir_where_alloc where;         /**< stack, heap or other managed part of memory */
+       ir_type        *type;         /**< Type of the allocated object.  */
 } alloc_attr;
 
 /** Free attributes. */
 typedef struct {
        ir_type *type;                /**< Type of the allocated object.  */
-       where_alloc where;            /**< stack, heap or other managed part of memory */
+       ir_where_alloc where;         /**< stack, heap or other managed part of memory */
 } free_attr;
 
 /** InstOf attributes. */
@@ -205,14 +215,13 @@ typedef struct {
 /** Filter attributes. */
 typedef struct {
        long proj;                 /**< contains the result position to project (Proj) */
-       ir_node ** in_cg;          /**< array with interprocedural predecessors (Phi) */
-       int *backedge;             /**< Field n set to true if pred n is backedge.
-                                       @todo Ev. replace by bitfield! */
+       ir_node **in_cg;           /**< array with interprocedural predecessors (Phi) */
+       unsigned *backedge;        /**< Raw Bitfield n set to true if pred n is backedge. */
 } filter_attr;
 
 /** CallBegin attributes. */
 typedef struct {
-       ir_node * call;               /**< Associated Call-operation. */
+       ir_node *call;                /**< Associated Call-operation. */
 } callbegin_attr;
 
 /** Cast attributes. */
@@ -223,24 +232,31 @@ typedef struct {
 /** Load attributes. */
 typedef struct {
        except_attr   exc;            /**< The exception attribute. MUST be the first one. */
+    unsigned      volatility:1;   /**< The volatility of this Load operation. */
+    unsigned      aligned:1;      /**< The align attribute of this Load operation. */
        ir_mode       *load_mode;     /**< The mode of this Load operation. */
-       ir_volatility volatility;     /**< The volatility of a Load/Store operation. */
 } load_attr;
 
 /** Store attributes. */
 typedef struct {
        except_attr   exc;            /**< the exception attribute. MUST be the first one. */
-       ir_volatility volatility;     /**< the volatility of a Store operation */
+       unsigned      volatility:1;   /**< The volatility of this Store operation. */
+       unsigned      aligned:1;      /**< The align attribute of this Store operation. */
 } store_attr;
 
 typedef struct {
-       int            pos;  /**< For Phi0. Used to remember the value defined by
-                                 this Phi node.  Needed when the Phi is completed
-                                 to call get_r_internal_value to find the
-                                 predecessors. If this attribute is set, the Phi
-                                 node takes the role of the obsolete Phi0 node,
-                                 therefore the name. */
-} phi0_attr;
+       ir_node        *next;         /**< Points to the next Phi in the Phi list of a block. */
+       union {
+               unsigned       *backedge;     /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
+               int            pos;           /**< For Phi0. Used to remember the value defined by
+                                              this Phi node.  Needed when the Phi is completed
+                                              to call get_r_internal_value() to find the
+                                              predecessors. If this attribute is set, the Phi
+                                              node takes the role of the obsolete Phi0 node,
+                                              therefore the name. */
+       } u;
+} phi_attr;
+
 
 /**< Confirm attribute. */
 typedef struct {
@@ -267,10 +283,12 @@ typedef struct {
 typedef struct {
        except_attr    exc;           /**< The exception attribute. MUST be the first one. */
        ir_mode        *res_mode;     /**< Result mode for the division. */
+       char           no_remainder;  /**< Set, if known that a division can be done without a remainder. */
 } divmod_attr;
 
 /** Inline Assembler support attribute. */
 typedef struct {
+       /* BEWARE: pin state MUST be the first attribute */
        op_pin_state      pin_state;  /**< the pin state for operations that might generate a exception */
        ident             *asm_text;  /**< The inline assembler text. */
        ir_asm_constraint *inputs;    /**< Input constraints. */
@@ -294,10 +312,7 @@ typedef union {
        cast_attr      cast;          /**< For Cast. */
        load_attr      load;          /**< For Load. */
        store_attr     store;         /**< For Store. */
-       phi0_attr      phi0;          /**< for Phi0 nodes. */
-       int            *phi_backedge; /**< For Phi after construction.
-                                          Field n set to true if pred n is backedge.
-                                          @todo Ev. replace by bitfield! */
+       phi_attr       phi;           /**< For Phi. */
        long           proj;          /**< For Proj: contains the result position to project */
        confirm_attr   confirm;       /**< For Confirm: compare operation and region. */
        filter_attr    filter;        /**< For Filter */
@@ -319,6 +334,14 @@ typedef struct _irn_edge_kind_info_t {
 
 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
 
+/**
+ * A Def-Use edge.
+ */
+typedef struct _ir_def_use_edge {
+       ir_node *use;            /** The use node of that edge. */
+       int     pos;             /** The position of this edge in use's input array. */
+} ir_def_use_edge;
+
 /**
  * The common structure of an irnode.
  * If the node has some attributes, they are stored in the attr field.
@@ -326,60 +349,61 @@ typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
 struct ir_node {
        /* ------- Basics of the representation  ------- */
        firm_kind kind;          /**< Distinguishes this node from others. */
+       unsigned node_idx;       /**< The node index of this node in its graph. */
        ir_op *op;               /**< The Opcode of this node. */
        ir_mode *mode;           /**< The Mode of this node. */
        struct ir_node **in;     /**< The array of predecessors / operands. */
-       unsigned long visited;   /**< The visited counter for walks of the graph. */
-       unsigned node_idx;       /**< The node index of this node in its graph. */
+       ir_visited_t visited;    /**< The visited counter for walks of the graph. */
        void *link;              /**< To attach additional information to the node, e.g.
-                                     used while construction to link Phi0 nodes and
-                                     during optimization to link to nodes that
+                                     used during optimization to link to nodes that
                                      shall replace a node. */
        /* ------- Fields for optimizations / analysis information ------- */
-       struct ir_node **out;    /**< @deprecated array of out edges. */
+       ir_def_use_edge *out;    /**< array of def-use edges. */
        struct dbg_info *dbi;    /**< A pointer to information for debug support. */
        /* ------- For debugging ------- */
 #ifdef DEBUG_libfirm
-       int out_valid;
+       unsigned out_valid : 1;
+       unsigned flags     : 31;
        long node_nr;            /**< A unique node number for each node to make output
                                      readable. */
 #endif
        /* ------- For analyses -------- */
        ir_loop *loop;           /**< the loop the node is in. Access routines in irloop.h */
-#ifdef DO_HEAPANALYSIS
-       struct abstval *av;      /**< Heapanalysis: The abstract value of this node. */
-       struct section *sec;     /**< Heapanalysis: The section of this node. */
-#endif
        struct ir_node **deps;   /**< Additional dependencies induced by state. */
+       void            *backend_info;
        irn_edges_info_t edge_info;  /**< Everlasting out edges. */
        /* ------- Opcode depending fields -------- */
        attr attr;               /**< The set of attributes of this node. Depends on opcode.
                                      Must be last field of struct ir_node. */
 };
 
+#include "iredgeset.h"
+
 /**
  * Edge info to put into an irg.
  */
 typedef struct _irg_edge_info_t {
-         set      *edges;         /**< a set containing all edges of a graph. */
-         unsigned activated : 1;  /**< set if edges are activated for the graph. */
+       ir_edgeset_t     edges;          /**< A set containing all edges of the current graph. */
+       struct list_head free_edges;     /**< list of all free edges. */
+       struct obstack   edges_obst;     /**< Obstack, where edges are allocated on. */
+       unsigned         allocated : 1;  /**< Set if edges are allocated on the obstack. */
+       unsigned         activated : 1;  /**< Set if edges are activated for the graph. */
 } irg_edge_info_t;
 
 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
 
 /**
- * Index constants for nodes that can be accessed through the graph itself.
+ * Index constants for nodes that can be accessed through the graph anchor node.
  */
 enum irg_anchors {
-       anchor_start_block = 0,  /**< block the start node will belong to */
-       anchor_start,            /**< start node of this ir_graph */
-       anchor_end_block,        /**< block the end node will belong to */
+       anchor_end_block = 0,    /**< block the end node will belong to, same as Anchors block */
+       anchor_start_block,      /**< block the start node will belong to */
        anchor_end,              /**< end node of this ir_graph */
+       anchor_start,            /**< start node of this ir_graph */
        anchor_end_reg,          /**< end node of this ir_graph */
        anchor_end_except,       /**< end node of this ir_graph */
-       anchor_frame,            /**< method's frame */
-       anchor_globals,          /**< pointer to the data segment containing all
-                                     globals as well as global procedures. */
+       anchor_initial_exec,     /**< methods initial control flow */
+       anchor_frame,            /**< methods frame */
        anchor_tls,              /**< pointer to the thread local storage containing all
                                      thread local data. */
        anchor_initial_mem,      /**< initial memory of this graph */
@@ -388,7 +412,7 @@ enum irg_anchors {
        anchor_bad,              /**< bad node of this ir_graph, the one and
                                      only in this graph */
        anchor_no_mem,           /**< NoMem node of this ir_graph, the one and only in this graph */
-       anchor_max
+       anchor_last
 };
 
 /** A callgraph entry for callees. */
@@ -404,19 +428,17 @@ typedef struct cg_callee_entry {
 struct ir_graph {
        firm_kind         kind;        /**< Always set to k_ir_graph. */
        /* --  Basics of the representation -- */
+    unsigned last_node_idx;        /**< The last IR node index for this graph. */
        ir_entity  *ent;               /**< The entity of this procedure, i.e.,
                                            the type of the procedure and the
                                            class it belongs to. */
        ir_type *frame_type;           /**< A class type representing the stack frame.
                                            Can include "inner" methods. */
-       ir_node *anchors[anchor_max];  /**< List of anchor nodes. */
-       ir_node **proj_args;           /**< Projs of the methods arguments. */
+       ir_node *anchor;               /**< Pointer to the anchor node of this graph. */
        struct obstack *obst;          /**< The obstack where all of the ir_nodes live. */
        ir_node *current_block;        /**< Current block for newly gen_*()-erated ir_nodes. */
        struct obstack *extbb_obst;    /**< The obstack for extended basic block info. */
 
-       unsigned last_node_idx;        /**< The last IR node index for this graph. */
-
        /* -- Fields for graph properties -- */
        irg_inline_property inline_property;     /**< How to handle inlineing. */
        unsigned additional_properties;          /**< Additional graph properties. */
@@ -433,14 +455,11 @@ struct ir_graph {
        ir_class_cast_state class_cast_state;    /**< Kind of cast operations in code. */
        irg_extblk_info_state extblk_state;      /**< State of extended basic block info. */
        exec_freq_state execfreq_state;          /**< Execution frequency state. */
-       ir_address_taken_computed_state adr_taken_state;  /**< Address taken state. */
+       ir_entity_usage_computed_state entity_usage_state;
        unsigned mem_disambig_opt;               /**< Options for the memory disambiguator. */
        unsigned fp_model;                       /**< floating point model of the graph. */
 
        /* -- Fields for construction -- */
-#if USE_EXPLICIT_PHI_IN_STACK
-       struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
-#endif
        int n_loc;                         /**< Number of local variables in this
                                                procedure including procedure parameters. */
        void **loc_descriptions;           /**< Storage for local variable descriptions. */
@@ -448,44 +467,46 @@ struct ir_graph {
        /* -- Fields for optimizations / analysis information -- */
        pset *value_table;                 /**< Hash table for global value numbering (cse)
                                                for optimizing use in iropt.c */
-       ir_node **outs;                    /**< Space for the out arrays. */
+       ir_def_use_edge *outs;             /**< Space for the Def-Use arrays. */
 
        ir_loop *loop;                     /**< The outermost loop for this graph. */
        void *link;                        /**< A void* field to link any information to
                                                the node. */
 
        ir_graph **callers;                /**< For callgraph analysis: list of caller graphs. */
-       unsigned char *caller_isbe;        /**< For callgraph analysis: set if backedge. */
+       unsigned *caller_isbe;             /**< For callgraph analysis: raw bitset if backedge info calculated. */
        cg_callee_entry **callees;         /**< For callgraph analysis: list of callee calls */
-       unsigned char *callee_isbe;        /**< For callgraph analysis: set if backedge. */
+       unsigned *callee_isbe;             /**< For callgraph analysis: raw bitset if backedge info calculated. */
+       ir_loop   *l;                            /**< For callgraph analysis. */
        int        callgraph_loop_depth;         /**< For callgraph analysis */
        int        callgraph_recursion_depth;    /**< For callgraph analysis */
        double     method_execution_frequency;   /**< For callgraph analysis */
 
-       ir_loop   *l;                            /**< For callgraph analysis. */
 
        /* -- Fields for Walking the graph -- */
-       unsigned long visited;             /**< this flag is an identifier for
+       ir_visited_t visited;             /**< this flag is an identifier for
                          ir walk. it will be incremented
                          every time someone walks through
                          the graph */
-       unsigned long block_visited;       /**< same as visited, for a complete block */
+       ir_visited_t block_visited;        /**< same as visited, for a complete block */
+
+       ir_visited_t self_visited;         /**< visited flag of the irg */
 
        unsigned estimated_node_count;     /**< estimated number of nodes in this graph,
                                                updated after every walk */
        irg_edges_info_t edge_info;        /**< edge info for automatic outs */
        ir_node **idx_irn_map;             /**< Array mapping node indexes to nodes. */
 
+       int index;                         /**< a unique number for each graph */
+       ir_phase *phases[PHASE_LAST];      /**< Phase information. */
 #ifdef DEBUG_libfirm
-       int             n_outs;            /**< Size wasted for outs */
-       long graph_nr;                     /**< a unique graph number for each graph to make output
-                                               readable. */
+       int   n_outs;                      /**< Size wasted for outs */
+       long graph_nr;                     /**< a unique graph number for each
+                                               graph to make output readable. */
 #endif
 
 #ifndef NDEBUG
-       unsigned using_visited       : 1;  /**< set to 1 if we are currently using the visited flag */
-       unsigned using_block_visited : 1;  /**< set to 1 if we are currently using the block_visited flag */
-       unsigned using_irn_link      : 1;  /**< set to 1 if we are currently using the irn_link fields */
+       ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
 #endif
 };
 
@@ -501,13 +522,11 @@ struct ir_prog {
                                             to allocate nodes the represent values
                                             of constant entities. It is not meant as
                                             a procedure.  */
-       ir_type   *glob_type;           /**< The global type.  Must be a class as it can
-                                            have fields and procedures.  */
-       ir_type   *tls_type;            /**< The thread local storage type.  Must be a struct as it can
-                                            only have fields.  */
+       ir_type   *segment_types[IR_SEGMENT_COUNT];
        ir_type  **types;               /**< A list of all types in the ir. */
        ir_mode  **modes;               /**< A list of all modes in the ir. */
        ir_op    **opcodes;             /**< A list of all opcodes in the ir. */
+       ident    **global_asms;         /**< An array of global ASM insertions. */
 
        /* -- states of and access to generated information -- */
        irg_phase_state phase_state;    /**< The state of construction. */
@@ -535,13 +554,17 @@ struct ir_prog {
        exec_freq_state execfreq_state;      /**< The state of execution frequency information */
        loop_nesting_depth_state lnd_state;  /**< The state of loop nesting depth information. */
        ir_class_cast_state class_cast_state;    /**< The state of cast operations in code. */
-       ir_address_taken_computed_state globals_adr_taken_state;  /**< Address taken state of the globals. */
+       ir_entity_usage_computed_state globals_entity_usage_state;
 
        ir_exc_region_t last_region_nr;      /**< The last exception region number that was assigned. */
+       ir_label_t last_label_nr;            /**< The highest label number for generating unique labels. */
+       int  max_irg_idx;                    /**< highest unused irg index */
 #ifdef DEBUG_libfirm
        long max_node_nr;                    /**< to generate unique numbers for nodes. */
 #endif
+#ifndef NDEBUG
+       ir_resources_t reserved_resources;   /**< Bitset for tracking used global resources. */
+#endif
 };
 
-
 #endif