Further pushed size_t: ir_initializer_t uses size_t now.
[libfirm] / ir / tr / entity_t.h
index c93d7b0..cdd8aff 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -18,7 +18,7 @@
  */
 
 /*
- * @file     entity_t.h
+ * @file
  * @brief   Representation of all program known entities -- private header.
  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
  * @version $Id$
 
 #include <assert.h>
 
-#include "firm_common_t.h"
-
 #include "typerep.h"
 #include "type_t.h"
 #include "ident.h"
-#include "pseudo_irg.h"
+#include "compound_path.h"
 
 typedef struct ir_initializer_base_t {
        ir_initializer_kind_t kind;
@@ -44,7 +42,7 @@ typedef struct ir_initializer_base_t {
  */
 typedef struct ir_initializer_compound_t {
        ir_initializer_base_t  base;
-       unsigned               n_initializers;
+       size_t                 n_initializers;
        ir_initializer_t      *initializers[1];
 } ir_initializer_compound_t;
 
@@ -61,7 +59,7 @@ typedef struct ir_initializer_const_t {
  */
 typedef struct ir_initializer_tarval_t {
        ir_initializer_base_t  base;
-       tarval                *value;
+       ir_tarval             *value;
 } ir_initializer_tarval_t ;
 
 union ir_initializer_t {
@@ -72,41 +70,18 @@ union ir_initializer_t {
        ir_initializer_tarval_t    tarval;
 };
 
-/** A path in a compound graph. */
-struct compound_graph_path {
-       firm_kind kind;       /**< The dynamic type tag for compound graph path. */
-       ir_type *tp;          /**< The type this path belongs to. */
-       int len;              /**< The length of the path. */
-       struct tuple {
-               int       index;    /**< Array index.  To compute position of array elements */
-               ir_entity *node;    /**< The accessed entity. */
-       } list[1];            /**< List of entity/index tuple of length len to express the
-                                  access path. */
-};
-
-/** The attributes for atomic entities. */
-typedef struct atomic_ent_attr {
-       ir_node *value;            /**< value if entity is not of variability uninitialized.
-                                    Only for atomic entities. */
-} atomic_ent_attr;
-
 /** The attributes for compound entities. */
 typedef struct compound_ent_attr {
-       ir_node **values;     /**< constant values of compound entities. Only available if
-                                  variability not uninitialized.  Must be set for variability constant. */
+       ir_node **values;     /**< constant values of compound entities. */
        compound_graph_path **val_paths;
-                            /**< paths corresponding to constant values. Only available if
-                                 variability not uninitialized.  Must be set for variability constant. */
+                            /**< paths corresponding to constant values. */
 } compound_ent_attr;
 
-/** A reserved value for "not yet set". */
-#define VTABLE_NUM_NOT_SET ((unsigned)(-1))
-
 /** The attributes for methods. */
 typedef struct method_ent_attr {
        ir_graph *irg;                 /**< The corresponding irg if known.
                                            The ir_graph constructor automatically sets this field. */
-       unsigned irg_add_properties;   /**< Additional graph properties can be
+       mtp_additional_properties irg_add_properties;   /**< Additional graph properties can be
                                            stored in a entity if no irg is available. */
 
        unsigned vtable_number;        /**< For a dynamically called method, the number assigned
@@ -117,6 +92,11 @@ typedef struct method_ent_attr {
                                            with a high weight are good candidates for procedure cloning. */
 } method_ent_attr;
 
+/** additional attributes for code entities */
+typedef struct code_ent_attr {
+       ir_label_t  label;       /** label of the basic block */
+} code_ent_attr;
+
 
 /**
  * An abstract data type to represent program entities.
@@ -135,359 +115,281 @@ struct ir_entity {
        ir_type *type;        /**< The type of this entity, e.g., a method type, a
                                   basic type of the language or a class itself. */
        ir_type *owner;       /**< The compound type (e.g. class type) this entity belongs to. */
-       unsigned allocation:3;         /**< Distinguishes static and dynamically allocated
-                                           entities and some further cases. */
-       unsigned visibility:3;         /**< Specifies visibility to external program fragments. */
-       unsigned variability:3;        /**< Specifies variability of entities content. */
-       unsigned volatility:1;         /**< Specifies volatility of entities content. */
-       unsigned aligned:1;            /**< Specifies alignment of entities content. */
-       unsigned stickyness:2;         /**< Specifies whether this entity is sticky.  */
-       unsigned peculiarity:3;        /**< The peculiarity of this entity. */
-       unsigned usage:4;              /**< flag indicating usage types of this entity, see ir_entity_usage. */
-       unsigned final:1;              /**< If set, this entity cannot be overridden. */
-       unsigned compiler_gen:1;       /**< If set, this entity was compiler generated. */
-       unsigned backend_marked:1;     /**< If set, this entity was marked by the backend for emission. */
-       unsigned has_initializer:1;    /**< if set, this entity is initialized by new style initializers. */
-       int offset;                    /**< Offset in bytes for this entity.  Fixed when layout
-                                           of owner is determined. */
-       unsigned alignment;            /**< entity alignment in bytes */
+       unsigned linkage:10;        /**< Specifies linkage type */
+       unsigned volatility:1;      /**< Specifies volatility of entities content.*/
+       unsigned aligned:1;         /**< Specifies alignment of entities content. */
+       unsigned usage:4;           /**< flag indicating usage types of this entity,
+                                        see ir_entity_usage. */
+       unsigned compiler_gen:1;    /**< If set, this entity was compiler generated.
+                                    */
+       unsigned visibility:3;      /**< @deprecated */
+       unsigned allocation:3;      /**< @deprecated */
+       unsigned peculiarity:3;     /**< @deprecated */
+       unsigned final:1;           /**< @deprecated */
+       int offset;                 /**< Offset in bytes for this entity. Fixed
+                                        when layout of owner is determined. */
+       unsigned alignment;         /**< entity alignment in bytes */
        unsigned char offset_bit_remainder;
-                                      /**< If the entity is a bit field, this is the offset of
-                                           the start of the bit field within the byte specified
-                                           by offset. */
-       ir_visited_t visit;            /**< visited counter for walks of the type information. */
-       struct dbg_info *dbi;          /**< A pointer to information for debug support. */
-       void *link;                    /**< To store some intermediate information. */
-       ir_type *repr_class;           /**< If this entity represents a class info, the associated class. */
+                                   /**< If the entity is a bit field, this is the
+                                        offset of the start of the bit field
+                                        within the byte specified by offset. */
+       ir_visited_t visit;         /**< visited counter for walks of the type
+                                        information. */
+       struct dbg_info *dbi;       /**< A pointer to information for debug support.
+                                    */
+       void *link;                 /**< To store some intermediate information. */
+       ir_type *repr_class;        /**< If this entity represents a class info, the
+                                        associated class. */
 
        /* ------------- fields for entities owned by a class type ---------------*/
 
-       ir_entity **overwrites;     /**< A list of entities this entity overwrites. */
-       ir_entity **overwrittenby;  /**< A list of entities that overwrite this entity.  */
+       ir_entity **overwrites;     /**< A list of entities this entity overwrites.
+                                    */
+       ir_entity **overwrittenby;  /**< A list of entities that overwrite this
+                                        entity. */
 
        /* ------------- fields for atomic entities  --------------- */
-       ir_node *value;          /**< value if entity is not of variability uninitialized.
-                                     Only for atomic entities. */
+       ir_initializer_t *initializer; /**< entity initializer */
        union {
                /* ------------- fields for compound entities -------------- */
                compound_ent_attr cmpd_attr;
                /* ------------- fields for method entities ---------------- */
                method_ent_attr   mtd_attr;
-               /* entity initializer */
-               ir_initializer_t *initializer;
+               /* fields for code entities */
+               code_ent_attr     code_attr;
        } attr; /**< type specific attributes */
 
        /* ------------- fields for analyses ---------------*/
 
 #ifdef DEBUG_libfirm
-       long nr;             /**< A unique node number for each node to make output readable. */
-# endif /* DEBUG_libfirm */
+       long nr;             /**< A unique node number for each node to make output
+                                 readable. */
+#endif
 };
 
 /** Initialize the entity module. */
-void firm_init_entity(void);
-
+void ir_init_entity(void);
+/** Cleanup entity module */
+void ir_finish_entity(void);
 
 /* ----------------------- inline functions ------------------------ */
-static inline int
-_is_entity(const void *thing) {
+static inline int _is_entity(const void *thing)
+{
        return get_kind(thing) == k_entity;
 }
 
-static inline const char *
-_get_entity_name(const ir_entity *ent) {
+static inline const char *_get_entity_name(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return get_id_str(get_entity_ident(ent));
 }
 
-static inline ident *
-_get_entity_ident(const ir_entity *ent) {
+static inline ident *_get_entity_ident(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->name;
 }
 
-static inline void
-_set_entity_ident(ir_entity *ent, ident *id) {
+static inline void _set_entity_ident(ir_entity *ent, ident *id)
+{
        assert(ent && ent->kind == k_entity);
        ent->name = id;
 }
 
-static inline ir_type *
-_get_entity_owner(ir_entity *ent) {
+static inline ir_type *_get_entity_owner(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
-       return ent->owner = skip_tid(ent->owner);
+       return ent->owner;
 }
 
-static inline ident *
-_get_entity_ld_ident(ir_entity *ent)
+static inline ident *_get_entity_ld_ident(const ir_entity *ent)
 {
        assert(ent && ent->kind == k_entity);
        if (ent->ld_name == NULL)
-               ent->ld_name = id_mangle_entity(ent);
+               return ent->name;
        return ent->ld_name;
 }
 
-static inline void
-_set_entity_ld_ident(ir_entity *ent, ident *ld_ident) {
+static inline void _set_entity_ld_ident(ir_entity *ent, ident *ld_ident)
+{
        assert(ent && ent->kind == k_entity);
        ent->ld_name = ld_ident;
 }
 
-static inline const char *
-_get_entity_ld_name(ir_entity *ent) {
+static inline const char *_get_entity_ld_name(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return get_id_str(get_entity_ld_ident(ent));
 }
 
-static inline ir_type *
-_get_entity_type(ir_entity *ent) {
+static inline ir_type *_get_entity_type(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
-       return ent->type = skip_tid(ent->type);
+       return ent->type;
 }
 
-static inline void
-_set_entity_type(ir_entity *ent, ir_type *type) {
+static inline void _set_entity_type(ir_entity *ent, ir_type *type)
+{
        assert(ent && ent->kind == k_entity);
        ent->type = type;
 }
 
-static inline ir_allocation
-_get_entity_allocation(const ir_entity *ent) {
-       assert(ent && ent->kind == k_entity);
-       return ent->allocation;
-}
-
-static inline void
-_set_entity_allocation(ir_entity *ent, ir_allocation al) {
-       assert(ent && ent->kind == k_entity);
-       ent->allocation = al;
-}
-
-static inline ir_visibility
-_get_entity_visibility(const ir_entity *ent) {
-       assert(ent && ent->kind == k_entity);
-       return ent->visibility;
-}
-
-static inline ir_variability
-_get_entity_variability(const ir_entity *ent) {
+static inline ir_linkage _get_entity_linkage(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
-       return ent->variability;
+       return (ir_linkage) ent->linkage;
 }
 
-static inline ir_volatility
-_get_entity_volatility(const ir_entity *ent) {
+static inline ir_volatility _get_entity_volatility(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
-       return ent->volatility;
+       return (ir_volatility) ent->volatility;
 }
 
-static inline void
-_set_entity_volatility(ir_entity *ent, ir_volatility vol) {
+static inline void _set_entity_volatility(ir_entity *ent, ir_volatility vol)
+{
        assert(ent && ent->kind == k_entity);
        ent->volatility = vol;
 }
 
-static inline unsigned
-_get_entity_alignment(const ir_entity *ent) {
+static inline unsigned _get_entity_alignment(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->alignment;
 }
 
-static inline void
-_set_entity_alignment(ir_entity *ent, unsigned alignment) {
+static inline void _set_entity_alignment(ir_entity *ent, unsigned alignment)
+{
        assert(ent && ent->kind == k_entity);
        ent->alignment = alignment;
 }
 
-static inline ir_align
-_get_entity_aligned(const ir_entity *ent) {
+static inline ir_align _get_entity_aligned(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
-       return ent->aligned;
+       return (ir_align) ent->aligned;
 }
 
-static inline void
-_set_entity_aligned(ir_entity *ent, ir_align a) {
+static inline void _set_entity_aligned(ir_entity *ent, ir_align a)
+{
        assert(ent && ent->kind == k_entity);
        ent->aligned = a;
 }
 
-static inline ir_peculiarity
-_get_entity_peculiarity(const ir_entity *ent) {
-       assert(ent && ent->kind == k_entity);
-       return ent->peculiarity;
-}
-
-/**
- * @todo Why peculiarity only for methods?
- *       Good question.  Originally, there were only description and
- *       existent.  The thought was, what sense does it make to
- *       describe a field?  With inherited the situation changed.  So
- *       I removed the assertion.  GL, 28.2.05
- */
-static inline void
-_set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec) {
-       assert(ent && ent->kind == k_entity);
-       /* @@@ why peculiarity only for methods? */
-       //assert(is_Method_type(ent->type));
-
-       ent->peculiarity = pec;
-}
-
-static inline ir_stickyness
-_get_entity_stickyness(const ir_entity *ent) {
-       assert(ent && ent->kind == k_entity);
-       return ent->stickyness;
-}
-
-static inline void
-_set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness) {
-       assert(ent && ent->kind == k_entity);
-       ent->stickyness = stickyness;
-}
-
-static inline int
-_is_entity_final(const ir_entity *ent) {
-       assert(ent && ent->kind == k_entity);
-       return (int)ent->final;
-}
-
-static inline void
-_set_entity_final(ir_entity *ent, int final) {
-       assert(ent && ent->kind == k_entity);
-       ent->final = final ? 1 : 0;
-}
-
-static inline int
-_is_entity_compiler_generated(const ir_entity *ent) {
+static inline int _is_entity_compiler_generated(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->compiler_gen;
 }
 
-static inline void
-_set_entity_compiler_generated(ir_entity *ent, int flag) {
+static inline void _set_entity_compiler_generated(ir_entity *ent, int flag)
+{
        assert(ent && ent->kind == k_entity);
        ent->compiler_gen = flag ? 1 : 0;
 }
 
-static inline int
-_is_entity_backend_marked(const ir_entity *ent) {
-       assert(ent && ent->kind == k_entity);
-       return ent->backend_marked;
-}
-
-static inline void
-_set_entity_backend_marked(ir_entity *ent, int flag) {
-       assert(ent && ent->kind == k_entity);
-       ent->backend_marked = flag ? 1 : 0;
-}
-
-static inline ir_entity_usage
-_get_entity_usage(const ir_entity *ent) {
+static inline ir_entity_usage _get_entity_usage(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
-       return ent->usage;
+       return (ir_entity_usage) ent->usage;
 }
 
-static inline void
-_set_entity_usage(ir_entity *ent, ir_entity_usage state) {
+static inline void _set_entity_usage(ir_entity *ent, ir_entity_usage state)
+{
        assert(ent && ent->kind == k_entity);
        ent->usage = state;
 }
 
-static inline int
-_get_entity_offset(const ir_entity *ent) {
+static inline int _get_entity_offset(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->offset;
 }
 
-static inline void
-_set_entity_offset(ir_entity *ent, int offset) {
+static inline void _set_entity_offset(ir_entity *ent, int offset)
+{
        assert(ent && ent->kind == k_entity);
        ent->offset = offset;
 }
 
-static inline unsigned char
-_get_entity_offset_bits_remainder(const ir_entity *ent) {
+static inline unsigned char _get_entity_offset_bits_remainder(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->offset_bit_remainder;
 }
 
-static inline void
-_set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset) {
+static inline void _set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset)
+{
        assert(ent && ent->kind == k_entity);
        ent->offset_bit_remainder = offset;
 }
 
-static inline void *
-_get_entity_link(const ir_entity *ent) {
+static inline void *_get_entity_link(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->link;
 }
 
-static inline void
-_set_entity_link(ir_entity *ent, void *l) {
+static inline void _set_entity_link(ir_entity *ent, void *l)
+{
        assert(ent && ent->kind == k_entity);
        ent->link = l;
 }
 
-static inline ir_graph *
-_get_entity_irg(const ir_entity *ent) {
-       ir_graph *irg;
+static inline ir_graph *_get_entity_irg(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        if (!is_Method_type(ent->type) || ent == unknown_entity) {
                return NULL;
        }
 
-       irg = ent->attr.mtd_attr.irg;
-       if (irg != NULL && !get_visit_pseudo_irgs()     && is_pseudo_ir_graph(irg))
-               return NULL;
-       return irg;
+       return ent->attr.mtd_attr.irg;
 }
 
-static inline ir_visited_t
-_get_entity_visited(ir_entity *ent) {
+static inline ir_visited_t _get_entity_visited(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->visit;
 }
 
-static inline void
-_set_entity_visited(ir_entity *ent, ir_visited_t num) {
+static inline void _set_entity_visited(ir_entity *ent, ir_visited_t num)
+{
        assert(ent && ent->kind == k_entity);
        ent->visit = num;
 }
 
-static inline void
-_mark_entity_visited(ir_entity *ent) {
+static inline void _mark_entity_visited(ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        ent->visit = firm_type_visited;
 }
 
-static inline int
-_entity_visited(ir_entity *ent) {
+static inline int _entity_visited(const ir_entity *ent)
+{
        return _get_entity_visited(ent) >= firm_type_visited;
 }
 
-static inline int
-_entity_not_visited(ir_entity *ent) {
+static inline int _entity_not_visited(const ir_entity *ent)
+{
        return _get_entity_visited(ent) < firm_type_visited;
 }
 
-static inline ir_type *
-_get_entity_repr_class(const ir_entity *ent) {
+static inline ir_type *_get_entity_repr_class(const ir_entity *ent)
+{
        assert(ent && ent->kind == k_entity);
        return ent->repr_class;
 }
 
-static inline dbg_info *
-_get_entity_dbg_info(const ir_entity *ent) {
+static inline dbg_info *_get_entity_dbg_info(const ir_entity *ent)
+{
        return ent->dbi;
 }
 
-static inline void
-_set_entity_dbg_info(ir_entity *ent, dbg_info *db) {
+static inline void _set_entity_dbg_info(ir_entity *ent, dbg_info *db)
+{
        ent->dbi = db;
 }
 
-
 #define is_entity(thing)                         _is_entity(thing)
 #define get_entity_name(ent)                     _get_entity_name(ent)
 #define get_entity_ident(ent)                    _get_entity_ident(ent)
@@ -498,26 +400,15 @@ _set_entity_dbg_info(ir_entity *ent, dbg_info *db) {
 #define get_entity_ld_name(ent)                  _get_entity_ld_name(ent)
 #define get_entity_type(ent)                     _get_entity_type(ent)
 #define set_entity_type(ent, type)               _set_entity_type(ent, type)
-#define get_entity_allocation(ent)               _get_entity_allocation(ent)
-#define set_entity_allocation(ent, al)           _set_entity_allocation(ent, al)
-#define get_entity_visibility(ent)               _get_entity_visibility(ent)
-#define get_entity_variability(ent)              _get_entity_variability(ent)
+#define get_entity_linkage(ent)                  _get_entity_linkage(ent)
 #define get_entity_volatility(ent)               _get_entity_volatility(ent)
 #define set_entity_volatility(ent, vol)          _set_entity_volatility(ent, vol)
 #define set_entity_alignment(ent, alignment)     _set_entity_alignment(ent, alignment)
 #define get_entity_alignment(ent)                _get_entity_alignment(ent)
 #define get_entity_align(ent)                    _get_entity_align(ent)
 #define set_entity_align(ent, a)                 _set_entity_align(ent, a)
-#define get_entity_peculiarity(ent)              _get_entity_peculiarity(ent)
-#define set_entity_peculiarity(ent, pec)         _set_entity_peculiarity(ent, pec)
-#define get_entity_stickyness(ent)               _get_entity_stickyness(ent)
-#define set_entity_stickyness(ent, stickyness)   _set_entity_stickyness(ent, stickyness)
-#define is_entity_final(ent)                     _is_entity_final(ent)
-#define set_entity_final(ent, final)             _set_entity_final(ent, final)
 #define is_entity_compiler_generated(ent)        _is_entity_compiler_generated(ent)
 #define set_entity_compiler_generated(ent, flag) _set_entity_compiler_generated(ent, flag)
-#define is_entity_backend_marked(ent)            _is_entity_backend_marked(ent)
-#define set_entity_backend_marked(ent, flag)     _set_entity_backend_marked(ent, flag)
 #define get_entity_usage(ent)                    _get_entity_usage(ent)
 #define set_entity_usage(ent, flags)             _set_entity_usage(ent, flags)
 #define get_entity_offset(ent)                   _get_entity_offset(ent)
@@ -536,5 +427,4 @@ _set_entity_dbg_info(ir_entity *ent, dbg_info *db) {
 #define get_entity_dbg_info(ent)                 _get_entity_dbg_info(ent)
 #define set_entity_dbg_info(ent, db)             _set_entity_dbg_info(ent, db)
 
-
-#endif /* FIRM_TR_ENTITY_T_H */
+#endif