add is_unknown_entity(), is_unknown_type(), is_none_type()
[libfirm] / ir / tr / entity_t.h
index 12bf645..120679f 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.
  *
  * @file
  * @brief   Representation of all program known entities -- private header.
  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
- * @version $Id$
  */
 #ifndef FIRM_TR_ENTITY_T_H
 #define FIRM_TR_ENTITY_T_H
 
 #include <assert.h>
+#include <stdbool.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 {
@@ -43,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;
 
@@ -60,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 {
@@ -78,14 +77,11 @@ typedef struct compound_ent_attr {
                             /**< 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
@@ -101,74 +97,87 @@ typedef struct code_ent_attr {
        ir_label_t  label;       /** label of the basic block */
 } code_ent_attr;
 
+typedef struct parameter_ent_attr {
+       /**< parameters might be compounds too */
+       compound_ent_attr  cmpd_attr;
+
+       size_t   number; /**< corresponding parameter number */
+       ir_mode *doubleword_low_mode;/**< entity is a lowered doubleword parameter,
+                                                               so additional stores because of calling
+                                                               convention are correctly performed.
+                                   Matze: This is a hack. In an ideal
+                                   wor^H^H^Hlibfirm we would first establish
+                                   calling conventions and then perform doubleword
+                                   lowering...) */
+} parameter_ent_attr;
+
+typedef enum ir_entity_kind {
+       IR_ENTITY_NORMAL,
+       IR_ENTITY_METHOD,
+       IR_ENTITY_COMPOUND_MEMBER,
+       IR_ENTITY_PARAMETER,
+       IR_ENTITY_LABEL,
+       IR_ENTITY_UNKNOWN,
+} ir_entity_kind;
 
 /**
  * An abstract data type to represent program entities.
- *
- * @see  ir_type
  */
 struct ir_entity {
-       firm_kind kind;       /**< The dynamic type tag for entity. */
-       ident *name;          /**< The name of this entity. */
-       ident *ld_name;       /**< Unique name of this entity, i.e., the mangled
-                                  name.  If the field is read before written a default
-                                  mangling is applies.  The name of the owner is prepended
-                                  to the name of the entity, separated by a underscore.
-                                  E.g.,  for a class `A' with field `a' this
-                                  is the ident for `A_a'. */
-       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 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. */
-
-       /* ------------- 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. */
-
-       /* ------------- fields for atomic entities  --------------- */
+       firm_kind kind;          /**< The dynamic type tag for entity. */
+       ident *name;             /**< The name of this entity. */
+       ident *ld_name;          /**< Unique name of this entity, i.e., the mangled
+                                     name. May be NULL to indicate that a default
+                                     mangling based on the name should happen */
+       ir_type *type;           /**< The type of this entity */
+       ir_type *owner;          /**< The compound type (e.g. class type) this
+                                                             entity belongs to. */
+       unsigned entity_kind:3;  /**< entity kind */
+       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 */
+       unsigned offset_bit_remainder:8;
+                                /**< If the entity is a bit field, this is the
+                                     offset of the start of the bit field
+                                     within the byte specified by offset. */
+       int offset;              /**< Offset in bytes for this entity. Fixed
+                                     when layout of owner is determined. */
+       unsigned alignment;      /**< entity alignment in bytes */
+       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. */
+
+       ir_entity **overwrites;  /**< A list of entities this entity overwrites. */
+       ir_entity **overwrittenby; /**< A list of entities that overwrite this
+                                       entity. */
+
        ir_initializer_t *initializer; /**< entity initializer */
+#ifdef DEBUG_libfirm
+       long nr;             /**< A unique node number for each node to make output
+                                 readable. */
+#endif
+
        union {
                /* ------------- fields for compound entities -------------- */
-               compound_ent_attr cmpd_attr;
+               compound_ent_attr  cmpd_attr;
                /* ------------- fields for method entities ---------------- */
-               method_ent_attr   mtd_attr;
+               method_ent_attr    mtd_attr;
                /* fields for code entities */
-               code_ent_attr     code_attr;
+               code_ent_attr      code_attr;
+               /** parameter number for parameter entities */
+               parameter_ent_attr parameter;
        } attr; /**< type specific attributes */
-
-       /* ------------- fields for analyses ---------------*/
-
-#ifdef DEBUG_libfirm
-       long nr;             /**< A unique node number for each node to make output
-                                 readable. */
-#endif
 };
 
 /** Initialize the entity module. */
@@ -176,6 +185,19 @@ void ir_init_entity(void);
 /** Cleanup entity module */
 void ir_finish_entity(void);
 
+/**
+ * Creates an entity corresponding to the start address of a basic block
+ * (the basic block is marked with a label id).
+ */
+ir_entity *new_label_entity(ir_label_t label);
+
+/**
+ * Like new_label_entity() but with debug information.
+ */
+ir_entity *new_d_label_entity(ir_label_t label, dbg_info *dbgi);
+
+void set_entity_irg(ir_entity *ent, ir_graph *irg);
+
 /* ----------------------- inline functions ------------------------ */
 static inline int _is_entity(const void *thing)
 {
@@ -232,22 +254,16 @@ static inline ir_type *_get_entity_type(const ir_entity *ent)
        return ent->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_linkage _get_entity_linkage(const ir_entity *ent)
 {
        assert(ent && ent->kind == k_entity);
-       return ent->linkage;
+       return (ir_linkage) ent->linkage;
 }
 
 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)
@@ -271,7 +287,7 @@ static inline void _set_entity_alignment(ir_entity *ent, unsigned alignment)
 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)
@@ -295,7 +311,7 @@ static inline void _set_entity_compiler_generated(ir_entity *ent, int flag)
 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)
@@ -342,16 +358,12 @@ static inline void _set_entity_link(ir_entity *ent, void *l)
 
 static inline ir_graph *_get_entity_irg(const ir_entity *ent)
 {
-       ir_graph *irg;
        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(const ir_entity *ent)
@@ -382,6 +394,17 @@ static inline int _entity_not_visited(const ir_entity *ent)
        return _get_entity_visited(ent) < firm_type_visited;
 }
 
+static inline int _is_parameter_entity(const ir_entity *entity)
+{
+       return entity->entity_kind == IR_ENTITY_PARAMETER;
+}
+
+static inline size_t _get_entity_parameter_number(const ir_entity *entity)
+{
+       assert(entity->entity_kind == IR_ENTITY_PARAMETER);
+       return entity->attr.parameter.number;
+}
+
 static inline ir_type *_get_entity_repr_class(const ir_entity *ent)
 {
        assert(ent && ent->kind == k_entity);
@@ -407,7 +430,6 @@ static inline void _set_entity_dbg_info(ir_entity *ent, dbg_info *db)
 #define set_entity_ld_ident(ent, ld_ident)       _set_entity_ld_ident(ent, ld_ident)
 #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_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)
@@ -426,6 +448,8 @@ static inline void _set_entity_dbg_info(ir_entity *ent, dbg_info *db)
 #define get_entity_link(ent)                     _get_entity_link(ent)
 #define set_entity_link(ent, l)                  _set_entity_link(ent, l)
 #define get_entity_irg(ent)                      _get_entity_irg(ent)
+#define is_parameter_entity(ent)                 _is_parameter_entity(ent)
+#define get_entity_parameter_number(ent)         _get_entity_parameter_number(ent)
 #define get_entity_visited(ent)                  _get_entity_visited(ent)
 #define set_entity_visited(ent, num)             _set_entity_visited(ent, num)
 #define mark_entity_visited(ent)                 _mark_entity_visited(ent)