automatically generate most getter/setter functions of firm nodes
[libfirm] / ir / ir / irtypes.h
index e253eda..194084c 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"
+#include "irphase.h"
 
 #include "pset.h"
 #include "set.h"
 #include "list.h"
 #include "obst.h"
+#include "vrp.h"
 
-struct ir_phase;
+/**
+ * List of phases. (We will add a register/unregister interface if managing
+ * this gets too tedious)
+ */
+typedef enum ir_phase_id {
+       PHASE_VRP,
+       PHASE_LAST = PHASE_VRP
+} ir_phase_id;
 
 /** The type of an ir_op. */
 struct ir_op {
@@ -71,7 +79,6 @@ struct ir_op {
  * and comparisons of values of a such described mode.
  *
  * ATTRIBUTES:
- *  -  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.
  *  -  ir_mode_sort sort:       sort of mode specifying possible usage categories
  *  -  int    size:             size of the mode in Bits.
@@ -86,8 +93,8 @@ struct ir_op {
  */
 struct ir_mode {
        firm_kind         kind;       /**< distinguishes this node from others */
-       ir_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!*/
@@ -116,18 +123,22 @@ 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. */
+       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 */
@@ -145,7 +156,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. */
@@ -153,15 +164,14 @@ 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. */
 typedef struct {
-       tarval  *tv;       /**< the target value */
-       ir_type *tp;       /**< the source type, for analyses. default: type_unknown. */
+       tarval  *tarval;  /**< the target value */
+       ir_type *tp;      /**< the source type, for analyses. default: type_unknown. */
 } const_attr;
 
 /** SymConst attributes. */
@@ -173,7 +183,7 @@ typedef struct {
 
 /** Sel attributes. */
 typedef struct {
-       ir_entity *ent;    /**< entity to select */
+       ir_entity *entity;    /**< entity to select */
 } sel_attr;
 
 /** Exception attributes. */
@@ -181,18 +191,24 @@ 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. */
@@ -226,7 +242,7 @@ typedef struct {
 
 /** Cast attributes. */
 typedef struct {
-       ir_type *totype;              /**< Type of the casted node. */
+       ir_type *type;                /**< Type of the casted node. */
 } cast_attr;
 
 /** Load attributes. */
@@ -234,7 +250,7 @@ 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_mode       *mode;          /**< The mode of this Load operation. */
 } load_attr;
 
 /** Store attributes. */
@@ -266,7 +282,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. */
@@ -282,29 +298,31 @@ 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. */
-       ir_asm_constraint *outputs;   /**< Output constraints. */
-       ident             **clobber;  /**< List of clobbered registers. */
+       op_pin_state      pin_state;            /**< the pin state for operations that might generate a exception */
+       ident             *text;                /**< The inline assembler text. */
+       ir_asm_constraint *input_constraints;   /**< Input constraints. */
+       ir_asm_constraint *output_constraints;  /**< Output constraints. */
+       ident             **clobbers;           /**< List of clobbered registers. */
 } asm_attr;
 
 /** 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. */
@@ -329,7 +347,8 @@ 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];
@@ -357,6 +376,7 @@ struct ir_node {
        void *link;              /**< To attach additional information to the node, e.g.
                                      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 ------- */
        ir_def_use_edge *out;    /**< array of def-use edges. */
        struct dbg_info *dbi;    /**< A pointer to information for debug support. */
@@ -364,13 +384,13 @@ struct ir_node {
 #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 */
        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. */
@@ -382,10 +402,11 @@ struct ir_node {
  * Edge info to put into an irg.
  */
 typedef struct _irg_edge_info_t {
-       ir_edgeset_t    edges;
-       struct obstack  edges_obst;
-       unsigned        allocated : 1;
-       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];
@@ -406,7 +427,6 @@ enum irg_anchors {
                                      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 */
@@ -442,25 +462,23 @@ struct ir_graph {
        unsigned additional_properties;          /**< Additional graph properties. */
 
        /* -- Fields indicating different states of irgraph -- */
-       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. */
-       irg_dom_state dom_state;           /**< Dominator state information. */
-       irg_dom_state pdom_state;          /**< Post Dominator state information. */
-       ir_typeinfo_state typeinfo_state;        /**< Validity of type information. */
+       ir_graph_state_t      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. */
+       irg_dom_state         dom_state;         /**< Dominator state information. */
+       irg_dom_state         pdom_state;        /**< Post Dominator state information. */
+       ir_typeinfo_state     typeinfo_state;    /**< Validity of type information. */
        irg_callee_info_state callee_info_state; /**< Validity of callee information. */
-       irg_loopinfo_state loopinfo_state;       /**< State of loop information. */
-       ir_class_cast_state class_cast_state;    /**< Kind of cast operations in code. */
+       irg_loopinfo_state    loopinfo_state;    /**< State of loop information. */
+       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. */
+       exec_freq_state       execfreq_state;    /**< Execution frequency 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. */
@@ -478,11 +496,11 @@ 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 -- */
        ir_visited_t visited;             /**< this flag is an identifier for
@@ -499,7 +517,8 @@ struct ir_graph {
        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. */
+       ir_phase *phases[PHASE_LAST+1];    /**< 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
@@ -507,11 +526,25 @@ struct ir_graph {
 #endif
 
 #ifndef NDEBUG
-       ir_resources_t  reserved_resources;
+       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. */
@@ -523,7 +556,7 @@ struct ir_prog {
                                             to allocate nodes the represent values
                                             of constant entities. It is not meant as
                                             a procedure.  */
-       ir_type   *segment_types[IR_SEGMENT_COUNT];
+       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. */
@@ -560,8 +593,9 @@ struct ir_prog {
        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
 };