Removed useless forward declaration of ir_phase.
[libfirm] / ir / ir / irtypes.h
index 8bd8c03..b78cdd9 100644 (file)
 #define FIRM_IR_IRDEFS_H
 
 #include "firm_types.h"
-#include "firm_common_t.h"
 #include "irdom_t.h"
 #include "irmode.h"
 #include "irnode.h"
 #include "irgraph.h"
 #include "iredgekinds.h"
 #include "irtypeinfo.h"
+#include "irextbb.h"
 #include "execution_frequency.h"
 #include "irmemory.h"
 #include "callgraph.h"
+#include "irprog.h"
 #include "field_temperature.h"
 #include "irphases_t.h"
 
@@ -44,8 +45,7 @@
 #include "set.h"
 #include "list.h"
 #include "obst.h"
-
-struct ir_phase;
+#include "vrp.h"
 
 /** The type of an ir_op. */
 struct ir_op {
@@ -56,7 +56,7 @@ struct ir_op {
        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. */
@@ -70,9 +70,8 @@ struct ir_op {
  * and comparisons of values of a such described mode.
  *
  * ATTRIBUTES:
- *  -  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
@@ -85,15 +84,16 @@ struct ir_op {
  */
 struct ir_mode {
        firm_kind         kind;       /**< distinguishes this node from others */
-       modecode          code;       /**< unambiguous identifier of a mode */
        ident             *name;      /**< Name ident of this mode */
+       ir_type           *type;      /**< corresponding primitive type */
 
        /* ----------------------------------------------------------------------- */
        /* 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 */
+       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 */
@@ -114,18 +114,23 @@ struct ir_mode {
        const void        *tv_priv;     /**< tarval module will save private data here */
 };
 
-/** ir node attributes **/
+/* ir node attributes */
+
+/** first attribute of Bad and Block nodes */
+typedef struct {
+       ir_graph *irg;              /**< The graph this block like node belongs to. */
+} irg_attr;
 
 /** Block attributes */
 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. */
+       irg_attr     irg;           /**< The graph this block belongs to. */
+       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.
@@ -142,7 +147,7 @@ typedef struct {
        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_entity *entity;          /**< entitiy representing this block */
        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. */
@@ -150,9 +155,8 @@ typedef struct {
 
 /** Cond attributes. */
 typedef struct {
-       cond_kind kind;           /**< flavor of Cond */
-       long default_proj;        /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
-       cond_jmp_predicate pred;  /**< only for binary Conds: The jump predication. */
+       long default_proj;           /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
+       cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
 } cond_attr;
 
 /** Const attributes. */
@@ -164,13 +168,13 @@ 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. */
 typedef struct {
-       ir_entity *ent;    /**< entity to select */
+       ir_entity *entity;    /**< entity to select */
 } sel_attr;
 
 /** Exception attributes. */
@@ -178,23 +182,29 @@ typedef struct {
        op_pin_state   pin_state;     /**< the pin state for operations that might generate a exception:
                                                                         If it's know that no exception will be generated, could be set to
                                                                         op_pin_state_floats. */
-#if PRECISE_EXC_CONTEXT
        struct ir_node **frag_arr;    /**< For Phi node construction in case of exception */
-#endif
 } except_attr;
 
 /** Call attributes. */
 typedef struct {
-       except_attr    exc;           /**< the exception attribute. MUST be the first one. */
-       ir_type *cld_tp;              /**< type of called procedure */
-       ir_entity ** callee_arr;      /**< result of callee analysis */
+       except_attr exc;               /**< the exception attribute. MUST be the first one. */
+       ir_type     *type;             /**< type of called procedure */
+       ir_entity   **callee_arr;      /**< result of callee analysis */
+       unsigned    tail_call:1;       /**< if set, can be a tail call */
 } call_attr;
 
+/** Builtin attributes. */
+typedef struct {
+       except_attr     exc;           /**< the exception attribute. MUST be the first one. */
+       ir_builtin_kind kind;          /**< kind of the called builtin procedure */
+       ir_type         *type;         /**< type of called builtin procedure */
+} builtin_attr;
+
 /** Alloc attributes. */
 typedef struct {
        except_attr    exc;           /**< the exception attribute. MUST be the first one. */
-       ir_type *type;                /**< Type of the allocated object.  */
-       ir_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. */
@@ -218,20 +228,20 @@ typedef struct {
 
 /** CallBegin attributes. */
 typedef struct {
-       ir_node * call;               /**< Associated Call-operation. */
+       ir_node *call;                /**< Associated Call-operation. */
 } callbegin_attr;
 
 /** Cast attributes. */
 typedef struct {
-       ir_type *totype;              /**< Type of the casted node. */
+       ir_type *type;                /**< Type of the casted node. */
 } cast_attr;
 
 /** Load attributes. */
 typedef struct {
        except_attr   exc;            /**< The exception attribute. MUST be the first one. */
-       ir_mode       *load_mode;     /**< The mode of this Load operation. */
-       unsigned      volatility:1;   /**< The volatility of this Load operation. */
-       unsigned      aligned:1;      /**< The align attribute of this Load operation. */
+    unsigned      volatility:1;   /**< The volatility of this Load operation. */
+    unsigned      aligned:1;      /**< The align attribute of this Load operation. */
+       ir_mode       *mode;          /**< The mode of this Load operation. */
 } load_attr;
 
 /** Store attributes. */
@@ -263,7 +273,7 @@ typedef struct {
 /** CopyB attribute. */
 typedef struct {
        except_attr    exc;           /**< The exception attribute. MUST be the first one. */
-       ir_type        *data_type;    /**< Type of the copied entity. */
+       ir_type        *type;         /**< Type of the copied entity. */
 } copyb_attr;
 
 /** Bound attribute. */
@@ -279,12 +289,13 @@ typedef struct {
 /** Div/Mod/DivMod/Quot attribute. */
 typedef struct {
        except_attr    exc;           /**< The exception attribute. MUST be the first one. */
-       ir_mode        *res_mode;     /**< Result mode for the division. */
+       ir_mode        *resmode;      /**< 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. */
@@ -295,12 +306,14 @@ typedef struct {
 /** Some IR-nodes just have one attribute, these are stored here,
    some have more. Their name is 'irnodename_attr' */
 typedef union {
+       irg_attr       irg;           /**< For Blocks and Bad: its belonging irg */
        block_attr     block;         /**< For Block: Fields needed to construct it */
        cond_attr      cond;          /**< For Cond. */
        const_attr     con;           /**< For Const: contains the value of the constant and a type */
        symconst_attr  symc;          /**< For SymConst. */
        sel_attr       sel;           /**< For Sel. */
-       call_attr      call;          /**< For Call: pointer to the type of the method to call */
+       call_attr      call;          /**< For Call. */
+       builtin_attr   builtin;       /**< For Builtin. */
        callbegin_attr callbegin;     /**< For CallBegin. */
        alloc_attr     alloc;         /**< For Alloc. */
        free_attr      free;          /**< For Free. */
@@ -325,11 +338,20 @@ typedef union {
  */
 typedef struct _irn_edge_kind_info_t {
        struct list_head outs_head;  /**< The list of all outs. */
-       int out_count;               /**< Number of outs in the list. */
+       unsigned edges_built : 1;    /**< Set edges where built for this node. */
+       unsigned out_count : 31;     /**< Number of outs in the list. */
 } irn_edge_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.
@@ -337,33 +359,29 @@ 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. */
+       long node_nr;            /**< A globally unique node number for each 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
        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. */
@@ -375,14 +393,11 @@ struct ir_node {
  * Edge info to put into an irg.
  */
 typedef struct _irg_edge_info_t {
-#if 0
-         set      *edges;         /**< a set containing all edges of a graph. */
-#else
-       ir_edgeset_t    edges;
-       struct obstack  edges_obst;
-       unsigned        allocated : 1;
-#endif
-       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];
@@ -397,14 +412,12 @@ enum irg_anchors {
        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 */
        anchor_args,             /**< methods arguments */
-       anchor_value_param_base, /**< method value param base */
        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 */
@@ -424,6 +437,7 @@ 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. */
@@ -434,13 +448,12 @@ struct ir_graph {
        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. */
 
        /* -- Fields indicating different states of irgraph -- */
+       unsigned        state;
        irg_phase_state phase_state;       /**< Compiler phase. */
        op_pin_state irg_pinned_state;     /**< Flag for status of nodes. */
        irg_outs_state outs_state;         /**< Out edges. */
@@ -452,14 +465,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. */
@@ -467,7 +477,7 @@ 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
@@ -477,18 +487,20 @@ struct ir_graph {
        unsigned *caller_isbe;             /**< For callgraph analysis: raw bitset if backedge info calculated. */
        cg_callee_entry **callees;         /**< For callgraph analysis: list of callee calls */
        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 */
@@ -497,6 +509,7 @@ struct ir_graph {
 
        int index;                         /**< a unique number for each graph */
        ir_phase *phases[PHASE_LAST];      /**< Phase information. */
+       void     *be_data;                 /**< backend can put in private data here */
 #ifdef DEBUG_libfirm
        int   n_outs;                      /**< Size wasted for outs */
        long graph_nr;                     /**< a unique graph number for each
@@ -504,13 +517,25 @@ struct ir_graph {
 #endif
 
 #ifndef NDEBUG
-       unsigned using_irn_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
 };
 
-/** ir_prog */
+/**
+ * Data structure that holds central information about a program
+ * or a module.
+ * One irp is created by libFirm on construction, so irp should never be NULL.
+ *
+ * - main_irg:  The ir graph that is the entry point to the program.
+ *              (Anything not reachable from here may be optimized away
+ *              if this irp represents a whole program.
+ * - irg:       List of all ir graphs in the program or module.
+ * - type:      A list containing all types known to the translated program.
+ *              Some types can have several entries in this list (as a result of
+ *              using exchange_types()).
+ * - glob_type: The unique global type that is owner of all global entities
+ *              of this module.
+ */
 struct ir_prog {
        firm_kind kind;                 /**< must be k_ir_prog */
        ident     *name;                /**< A file name or the like. */
@@ -522,15 +547,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   *constructors_type;   /**< contains links to module constructor
-                                            functions. Must be a struct */
+       ir_type   *segment_types[IR_SEGMENT_LAST+1];
        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. */
@@ -558,13 +579,14 @@ 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. */
+#ifndef NDEBUG
+       ir_resources_t reserved_resources;   /**< Bitset for tracking used global resources. */
 #endif
 };