move domfront from be to ana
[libfirm] / ir / ir / irtypes.h
index bf9f238..e69392c 100644 (file)
  * @file
  * @brief   Definition of the Firm IR base types, concentrated here
  * @author  Michael Beck
- * @version $Id$
  */
 #ifndef FIRM_IR_IRDEFS_H
 #define FIRM_IR_IRDEFS_H
 
+#include <stdbool.h>
+
 #include "firm_types.h"
 #include "irdom_t.h"
 #include "irmode.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 "irphase.h"
 #include "bitset.h"
 
 #include "pset.h"
 #include "obst.h"
 #include "vrp.h"
 
-/**
- * List of phases. (We will add a register/unregister interface if managing
- * this gets too tedious)
- */
-typedef enum ir_phase_id {
-       PHASE_FIRST,
-       PHASE_VRP = PHASE_FIRST,
-       PHASE_LAST = PHASE_VRP
-} ir_phase_id;
-ENUM_COUNTABLE(ir_phase_id)
+struct ir_nodemap {
+       void **data;  /**< maps node indices to void* */
+};
 
 /** The type of an ir_op. */
 struct ir_op {
@@ -69,7 +59,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. */
-       int fragile_mem_index;    /**< index of memory input for fragile nodes */
+       int memory_index;         /**< index of memory input for memory nodes */
        int pn_x_regular;         /**< for fragile ops the position of the
                                       X_regular output */
        int pn_x_except;          /**< for fragile ops the position of the
@@ -82,6 +72,51 @@ struct ir_op {
        ir_op_ops ops;            /**< The operations of the this op. */
 };
 
+/** Helper values for ir_mode_sort. */
+enum ir_mode_sort_helper {
+       irmsh_is_num   = 0x10, /**< mode represents a number */
+       irmsh_is_data  = 0x20, /**< mode represents data (can be carried in registers) */
+       irmsh_is_datab = 0x40, /**< mode represents data or is internal boolean */
+       irmsh_is_dataM = 0x80, /**< mode represents data or is memory */
+};
+
+/**
+ * These values represent the different mode classes of value representations.
+ * Beware: do not change the order of these values without checking
+ * the mode_is
+ */
+typedef enum ir_mode_sort {
+       irms_control_flow     = 0, /**< Marks all control flow modes. */
+       irms_block            = 1,
+       irms_tuple            = 2,
+       irms_any              = 3,
+       irms_bad              = 4,
+       irms_memory           = 5 | irmsh_is_dataM, /**< Marks the memory mode.  Not extensible. (irm_M) */
+
+       /** Internal boolean representation.
+            Storing to memory impossible, convert first. (irm_b) */
+       irms_internal_boolean = 6 | irmsh_is_datab,
+
+       /** A mode to represent entities.
+           Restricted int computations can be performed */
+       irms_reference        = 7 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM,
+       /** A mode to represent int numbers.
+           Integer computations can be performed. */
+       irms_int_number       = 8 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
+       /** A mode to represent float numbers.
+           Floating point computations can be performed. */
+       irms_float_number     = 9 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
+} ir_mode_sort;
+
+/**
+ * A descriptor for an IEEE754 float value.
+ */
+typedef struct float_descriptor_t {
+       unsigned char exponent_size;    /**< size of exponent in bits */
+       unsigned char mantissa_size;    /**< size of mantissa in bits */
+       bool          explicit_one;     /**< set if the leading one is explicit */
+} float_descriptor_t;
+
 /**
  * Contains relevant information about a mode.
  *
@@ -107,21 +142,18 @@ struct ir_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!*/
-       ir_mode_sort      sort;          /**< coarse classification of this mode:
-                                          int, float, reference ...
-                                          (see irmode.h) */
-       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
-                                          vector_elem number of elements, size contains the size
-                                          of all bits and must be dividable by vector_elem */
-
-       /* ----------------------------------------------------------------------- */
+       ir_mode_sort       sort;          /**< coarse classification of this mode:
+                                           int, float, reference ...
+                                           (see irmode.h) */
+       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 */
+       float_descriptor_t float_desc;
+
+       /* ---------------------------------------------------------------------- */
        ir_tarval         *min;         /**< the minimum value that can be expressed */
        ir_tarval         *max;         /**< the maximum value that can be expressed */
        ir_tarval         *null;        /**< the value 0 */
@@ -134,6 +166,18 @@ struct ir_mode {
        const void        *tv_priv;     /**< tarval module will save private data here */
 };
 
+/* note: we use "long" here because that is the type used for Proj-Numbers */
+typedef struct ir_switch_table_entry {
+       ir_tarval *min;
+       ir_tarval *max;
+       long       pn;
+} ir_switch_table_entry;
+
+struct ir_switch_table {
+       size_t                n_entries;
+       ir_switch_table_entry entries[];
+};
+
 /* ir node attributes */
 
 /** first attribute of Bad, Block, Anchor nodes */
@@ -156,31 +200,19 @@ typedef struct block_attr {
        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 dynamic_ins:1;     /**< if set in-array is an ARR_F on the heap. */
        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.
-                                        @@@ @todo
-                                        Eventually overlay with graph_arr as only valid
-                                        in different phases.  Eventually inline the whole
-                                        datastructure. */
+       ir_dom_info dom;            /**< Datastructure that holds information about dominators. */
        ir_dom_info pdom;           /**< Datastructure that holds information about post-dominators. */
-       ir_node ** in_cg;           /**< array with predecessors in
-                                    * interprocedural_view, if they differ
-                                    * from intraprocedural predecessors */
        bitset_t *backedge;         /**< Bitfield n set to true if pred n is backedge.*/
-       bitset_t *cg_backedge;      /**< 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. */
        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. */
 } block_attr;
 
 /** Cond attributes. */
 typedef struct cond_attr {
-       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;
 
@@ -215,7 +247,6 @@ typedef struct call_attr {
        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. */
@@ -252,16 +283,16 @@ typedef struct cast_attr {
 /** Load attributes. */
 typedef struct load_attr {
        except_attr   exc;            /**< The exception attribute. MUST be the first one. */
-    unsigned      volatility:1;   /**< The volatility of this Load operation. */
-    unsigned      unaligned:1;    /**< The align attribute of this Load operation. */
+    ir_volatility volatility:1;   /**< The volatility of this Load operation. */
+    ir_align      unaligned:1;    /**< The align attribute of this Load operation. */
        ir_mode       *mode;          /**< The mode of this Load operation. */
 } load_attr;
 
 /** Store attributes. */
 typedef struct store_attr {
        except_attr   exc;            /**< the exception attribute. MUST be the first one. */
-       unsigned      volatility:1;   /**< The volatility of this Store operation. */
-       unsigned      unaligned:1;    /**< The align attribute of this Store operation. */
+       ir_volatility volatility:1;   /**< The volatility of this Store operation. */
+       ir_align      unaligned:1;    /**< The align attribute of this Store operation. */
 } store_attr;
 
 typedef struct phi_attr {
@@ -330,6 +361,11 @@ typedef struct proj_attr {
        long  proj;           /**< position of tuple sub-value which is projected */
 } proj_attr;
 
+typedef struct switch_attr {
+       unsigned         n_outs;
+       ir_switch_table *table;
+} switch_attr;
+
 /** Some IR-nodes just have one attribute, these are stored here,
    some have more. Their name is 'irnodename_attr' */
 typedef union ir_attr {
@@ -360,6 +396,7 @@ typedef union ir_attr {
        div_attr       div;           /**< For Div operation */
        mod_attr       mod;           /**< For Mod operation */
        asm_attr       assem;         /**< For ASM operation. */
+       switch_attr    switcha;       /**< For Switch operation. */
 } ir_attr;
 
 /**
@@ -434,8 +471,10 @@ typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
 /**
  * Index constants for nodes that can be accessed through the graph anchor node.
  */
-enum irg_anchors {
-       anchor_end_block = 0,    /**< block the end node will belong to, same as Anchors block */
+typedef enum irg_anchors {
+       anchor_first,
+       anchor_end_block = anchor_first, /**< 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 */
@@ -444,8 +483,9 @@ enum irg_anchors {
        anchor_initial_mem,      /**< initial memory of this graph */
        anchor_args,             /**< methods arguments */
        anchor_no_mem,           /**< NoMem node of this ir_graph, the one and only in this graph */
-       anchor_last
-};
+       anchor_last = anchor_no_mem
+} irg_anchors;
+ENUM_COUNTABLE(irg_anchors)
 
 /** A callgraph entry for callees. */
 typedef struct cg_callee_entry {
@@ -454,13 +494,18 @@ typedef struct cg_callee_entry {
        size_t     max_depth;  /**< Maximum depth of all Call nodes to irg. */
 } cg_callee_entry;
 
+typedef struct ir_vrp_info {
+       struct ir_nodemap infos;
+       struct obstack    obst;
+} ir_vrp_info;
+
 /**
  * An ir_graph holds all information for a procedure.
  */
 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. */
+       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. */
@@ -469,20 +514,19 @@ struct ir_graph {
        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. */
 
        /* -- Fields for graph properties -- */
        irg_inline_property        inline_property;       /**< How to handle inlineing. */
        mtp_additional_properties  additional_properties; /**< Additional graph properties. */
 
        /* -- Fields indicating different states of irgraph -- */
-       ir_graph_state_t      state;
-       irg_phase_state       phase_state;       /**< Compiler phase. */
-       op_pin_state          irg_pinned_state;  /**< Flag for status of nodes. */
-       ir_typeinfo_state     typeinfo_state;    /**< Validity of type information. */
-       irg_callee_info_state callee_info_state; /**< Validity of callee information. */
-       ir_class_cast_state   class_cast_state;  /**< Kind of cast operations in code. */
-       exec_freq_state       execfreq_state;    /**< Execution frequency state. */
+       ir_graph_properties_t  properties;
+       ir_graph_constraints_t constraints;
+       irg_phase_state        phase_state;       /**< Compiler phase. */
+       op_pin_state           irg_pinned_state;  /**< Flag for status of nodes. */
+       ir_typeinfo_state      typeinfo_state;    /**< Validity of type information. */
+       irg_callee_info_state  callee_info_state; /**< Validity of callee information. */
+       ir_class_cast_state    class_cast_state;  /**< Kind of cast operations in code. */
        unsigned mem_disambig_opt;               /**< Options for the memory disambiguator. */
        unsigned fp_model;                       /**< floating point model of the graph. */
 
@@ -495,8 +539,10 @@ struct ir_graph {
        pset *value_table;                 /**< Hash table for global value numbering (cse)
                                                for optimizing use in iropt.c */
        ir_def_use_edge *outs;             /**< Space for the Def-Use arrays. */
+       ir_vrp_info      vrp;              /**< vrp info */
 
        ir_loop *loop;                     /**< The outermost loop for this graph. */
+       ir_dom_front_info_t domfront;      /**< dominance frontier analysis data */
        void *link;                        /**< A void* field to link any information to
                                                the node. */
 
@@ -525,7 +571,7 @@ struct ir_graph {
        ir_node **idx_irn_map;             /**< Array mapping node indexes to nodes. */
 
        size_t index;                      /**< a unique number for each graph */
-       ir_phase *phases[PHASE_LAST+1];    /**< Phase information. */
+       /** extra info which should survive accross multiple passes */
        void     *be_data;                 /**< backend can put in private data here */
 
        unsigned  dump_nr;                 /**< number of graph dumps */
@@ -565,10 +611,13 @@ struct ir_prog {
                                             to allocate nodes the represent values
                                             of constant entities. It is not meant as
                                             a procedure.  */
+       ir_entity *unknown_entity;      /**< unique 'unknown'-entity */
        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. */
+       ir_type   *none_type;           /**< unique 'none'-type */
+       ir_type   *code_type;           /**< unique 'code'-type */
+       ir_type   *unknown_type;        /**< unique 'unknown'-type */
+       ir_type   *byte_type;           /**< type for a 'byte' */
        ident    **global_asms;         /**< An array of global ASM insertions. */
 
        /* -- states of and access to generated information -- */
@@ -589,20 +638,16 @@ struct ir_prog {
        size_t max_callgraph_loop_depth;        /**< needed in callgraph. */
        size_t max_callgraph_recursion_depth;   /**< needed in callgraph. */
        double max_method_execution_frequency;  /**< needed in callgraph. */
-       irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
-       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_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. */
        size_t max_irg_idx;                  /**< highest unused irg index */
        long max_node_nr;                    /**< to generate unique numbers for nodes. */
        unsigned dump_nr;                    /**< number of program info dumps */
-       unsigned optimization_dumps :1;      /**< dump irg on each optimization */
 #ifndef NDEBUG
-       ir_resources_t reserved_resources;   /**< Bitset for tracking used global resources. */
+       irp_resources_t reserved_resources;  /**< Bitset for tracking used global resources. */
 #endif
 };