cleanup dbginfo public API: no dbg_snprint anymore
[libfirm] / ir / ir / irtypes.h
index 79426b2..6122c8e 100644 (file)
@@ -27,7 +27,6 @@
 #define FIRM_IR_IRDEFS_H
 
 #include "firm_types.h"
-#include "firm_common_t.h"
 #include "irdom_t.h"
 #include "irmode.h"
 #include "irnode.h"
@@ -72,7 +71,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.
@@ -87,7 +85,6 @@ 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 */
 
        /* ----------------------------------------------------------------------- */
@@ -117,18 +114,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 */
@@ -146,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. */
@@ -174,7 +175,7 @@ typedef struct {
 
 /** Sel attributes. */
 typedef struct {
-       ir_entity *ent;    /**< entity to select */
+       ir_entity *entity;    /**< entity to select */
 } sel_attr;
 
 /** Exception attributes. */
@@ -182,23 +183,22 @@ 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         *builtin_tp;   /**< type of called builtin procedure */
+       ir_type         *type;         /**< type of called builtin procedure */
 } builtin_attr;
 
 /** Alloc attributes. */
@@ -234,7 +234,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. */
@@ -242,7 +242,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. */
@@ -274,7 +274,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. */
@@ -290,7 +290,7 @@ 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;
 
@@ -307,6 +307,7 @@ 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 */
@@ -366,6 +367,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. */
@@ -373,8 +375,6 @@ 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 */
@@ -452,6 +452,7 @@ struct ir_graph {
        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. */
@@ -507,6 +508,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
@@ -518,7 +520,21 @@ struct ir_graph {
 #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. */
@@ -567,9 +583,7 @@ 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. */
-#endif
 #ifndef NDEBUG
        ir_resources_t reserved_resources;   /**< Bitset for tracking used global resources. */
 #endif