struct types still require names.
[libfirm] / ir / tr / entity_t.h
index b3c0266..a3f46ca 100644 (file)
@@ -1,62 +1,74 @@
 /*
- * Project:     libFIRM
- * File name:   ir/tr/entity_t.h
- * Purpose:     Representation of all program known entities -- private header.
- * Author:      Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier, Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2007 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
- */
-
-/**
- * @file entity_t.h
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
- * entity.h:  entities represent all program known objects.
+ * This file is part of libFirm.
  *
- * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
  *
- *  An entity is the representation of program known objects in Firm.
- *  The primary concept of entities is to represent members of complex
- *  types, i.e., fields and methods of classes.  As not all programming
- *  language model all variables and methods as members of some class,
- *  the concept of entities is extended to cover also local and global
- *  variables, and arbitrary procedures.
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
  *
- *  An entity always specifies the type of the object it represents and
- *  the type of the object it is a part of, the owner of the entity.
- *  Originally this is the type of the class of which the entity is a
- *  member.
- *  The owner of local variables is the procedure they are defined in.
- *  The owner of global variables and procedures visible in the whole
- *  program is a universally defined class type "GlobalType".  The owner
- *  of procedures defined in the scope of an other procedure is the
- *  enclosing procedure.
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
-#ifndef _FIRM_TR_ENTITY_T_H_
-#define _FIRM_TR_ENTITY_T_H_
+/*
+ * @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 "firm_common_t.h"
-#include "firm_config.h"
+#include <assert.h>
 
+#include "typerep.h"
 #include "type_t.h"
-#include "entity.h"
-#include "typegmod.h"
-#include "mangle.h"
+#include "ident.h"
 #include "pseudo_irg.h"
+#include "compound_path.h"
+
+typedef struct ir_initializer_base_t {
+       ir_initializer_kind_t kind;
+} ir_initializer_base_t;
+
+/**
+ * An compound initializer.
+ */
+typedef struct ir_initializer_compound_t {
+       ir_initializer_base_t  base;
+       unsigned               n_initializers;
+       ir_initializer_t      *initializers[1];
+} ir_initializer_compound_t;
+
+/**
+ * An initializer containing an ir_node,
+ */
+typedef struct ir_initializer_const_t {
+       ir_initializer_base_t  base;
+       ir_node               *value;
+} ir_initializer_const_t ;
 
-/** 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. */
+/**
+ * An initializer containing a tarval.
+ */
+typedef struct ir_initializer_tarval_t {
+       ir_initializer_base_t  base;
+       tarval                *value;
+} ir_initializer_tarval_t ;
+
+union ir_initializer_t {
+       ir_initializer_kind_t      kind;
+       ir_initializer_base_t      base;
+       ir_initializer_compound_t  compound;
+       ir_initializer_const_t     consti;
+       ir_initializer_tarval_t    tarval;
 };
 
 /** The attributes for atomic entities. */
@@ -88,11 +100,15 @@ typedef struct method_ent_attr {
                                            in the virtual function table. */
 
        ptr_access_kind *param_access; /**< the parameter access */
-       float *param_weight;           /**< The weight of method's parameters. Parameters
-                                           with a high weight are good for procedure cloning. */
-       ir_img_section section;        /**< The code section where this method should be placed */
+       unsigned *param_weight;        /**< The weight of method's parameters. Parameters
+                                           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.
@@ -111,23 +127,27 @@ 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. */
-       ir_allocation allocation:3;             /**< Distinguishes static and dynamically allocated
-                                                    entities and some further cases. */
-       ir_visibility visibility:3;             /**< Specifies visibility to external program fragments. */
-       ir_variability variability:3;           /**< Specifies variability of entities content. */
-       ir_volatility volatility:2;             /**< Specifies volatility of entities content. */
-       ir_stickyness stickyness:2;             /**< Specifies whether this entity is sticky.  */
-       ir_peculiarity peculiarity:3;           /**< The peculiarity of this entity. */
-       ir_address_taken_state address_taken:3; /**< A flag that can be set to mark address taken entities. */
+       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 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. */
-       unsigned long visit;           /**< visited counter for walks of the type information. */
+       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. */
@@ -145,6 +165,10 @@ struct ir_entity {
                compound_ent_attr cmpd_attr;
                /* ------------- fields for method entities ---------------- */
                method_ent_attr   mtd_attr;
+               /* fields for code entities */
+               code_ent_attr     code_attr;
+               /* entity initializer */
+               ir_initializer_t *initializer;
        } attr; /**< type specific attributes */
 
        /* ------------- fields for analyses ---------------*/
@@ -159,105 +183,129 @@ void firm_init_entity(void);
 
 
 /* ----------------------- inline functions ------------------------ */
-static INLINE int
+static inline int
 _is_entity(const void *thing) {
        return get_kind(thing) == k_entity;
 }
 
-static INLINE const char *
+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 *
+static inline ident *
 _get_entity_ident(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->name;
 }
 
-static INLINE void
+static inline void
 _set_entity_ident(ir_entity *ent, ident *id) {
        assert(ent && ent->kind == k_entity);
        ent->name = id;
 }
 
-static INLINE ir_type *
+static inline ir_type *
 _get_entity_owner(ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
-       return ent->owner = skip_tid(ent->owner);
+       return ent->owner;
 }
 
-static INLINE ident *
+static inline ident *
 _get_entity_ld_ident(ir_entity *ent)
 {
        assert(ent && ent->kind == k_entity);
        if (ent->ld_name == NULL)
-               ent->ld_name = mangle_entity(ent);
+               ent->ld_name = id_mangle_entity(ent);
        return ent->ld_name;
 }
 
-static INLINE void
+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 *
+static inline const char *
 _get_entity_ld_name(ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return get_id_str(get_entity_ld_ident(ent));
 }
 
-static INLINE ir_type *
+static inline ir_type *
 _get_entity_type(ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
-       return ent->type = skip_tid(ent->type);
+       return ent->type;
 }
 
-static INLINE void
+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
+static inline ir_allocation
 _get_entity_allocation(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->allocation;
 }
 
-static INLINE void
+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
+static inline ir_visibility
 _get_entity_visibility(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->visibility;
 }
 
-static INLINE ir_variability
+static inline ir_variability
 _get_entity_variability(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->variability;
 }
 
-static INLINE ir_volatility
+static inline ir_volatility
 _get_entity_volatility(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->volatility;
 }
 
-static INLINE void
+static inline void
 _set_entity_volatility(ir_entity *ent, ir_volatility vol) {
        assert(ent && ent->kind == k_entity);
        ent->volatility = vol;
 }
 
-static INLINE ir_peculiarity
+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) {
+       assert(ent && ent->kind == k_entity);
+       ent->alignment = alignment;
+}
+
+static inline ir_align
+_get_entity_aligned(const ir_entity *ent) {
+       assert(ent && ent->kind == k_entity);
+       return ent->aligned;
+}
+
+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;
@@ -270,7 +318,7 @@ _get_entity_peculiarity(const ir_entity *ent) {
  *       describe a field?  With inherited the situation changed.  So
  *       I removed the assertion.  GL, 28.2.05
  */
-static INLINE void
+static inline void
 _set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec) {
        assert(ent && ent->kind == k_entity);
        /* @@@ why peculiarity only for methods? */
@@ -279,135 +327,161 @@ _set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec) {
        ent->peculiarity = pec;
 }
 
-static INLINE ir_stickyness
+static inline ir_stickyness
 _get_entity_stickyness(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->stickyness;
 }
 
-static INLINE void
+static inline void
 _set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness) {
        assert(ent && ent->kind == k_entity);
        ent->stickyness = stickyness;
 }
 
-static INLINE int
+static inline int
 _is_entity_final(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return (int)ent->final;
 }
 
-static INLINE void
+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
+static inline int
 _is_entity_compiler_generated(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->compiler_gen;
 }
 
-static INLINE void
+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 ir_address_taken_state
-_get_entity_address_taken(const ir_entity *ent) {
+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);
-       return ent->address_taken;
+       ent->backend_marked = flag ? 1 : 0;
 }
 
-static INLINE void
-_set_entity_address_taken(ir_entity *ent, ir_address_taken_state state) {
+static inline ir_entity_usage
+_get_entity_usage(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
-       assert(ir_address_not_taken <= state && state <= ir_address_taken);
-       ent->address_taken = state;
+       return ent->usage;
 }
 
-static INLINE int
+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) {
        assert(ent && ent->kind == k_entity);
        return ent->offset;
 }
 
-static INLINE void
+static inline void
 _set_entity_offset(ir_entity *ent, int offset) {
        assert(ent && ent->kind == k_entity);
        ent->offset = offset;
 }
 
-static INLINE unsigned char
+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
+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 *
+static inline void *
 _get_entity_link(const ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->link;
 }
 
-static INLINE void
+static inline void
 _set_entity_link(ir_entity *ent, void *l) {
        assert(ent && ent->kind == k_entity);
        ent->link = l;
 }
 
-static INLINE ir_graph *
+static inline ir_graph *
 _get_entity_irg(const ir_entity *ent) {
+       ir_graph *irg;
        assert(ent && ent->kind == k_entity);
-       assert(ent == unknown_entity || is_Method_type(ent->type));
-       if (!get_visit_pseudo_irgs() && ent->attr.mtd_attr.irg
-               && is_pseudo_ir_graph(ent->attr.mtd_attr.irg))
+       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 ent->attr.mtd_attr.irg;
+       return irg;
 }
 
-static INLINE unsigned long
+static inline ir_visited_t
 _get_entity_visited(ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        return ent->visit;
 }
 
-static INLINE void
-_set_entity_visited(ir_entity *ent, unsigned long 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
+static inline void
 _mark_entity_visited(ir_entity *ent) {
        assert(ent && ent->kind == k_entity);
        ent->visit = firm_type_visited;
 }
 
-static INLINE int
+static inline int
 _entity_visited(ir_entity *ent) {
        return _get_entity_visited(ent) >= firm_type_visited;
 }
 
-static INLINE int
+static inline int
 _entity_not_visited(ir_entity *ent) {
        return _get_entity_visited(ent) < firm_type_visited;
 }
 
-static INLINE ir_type *
+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) {
+       return ent->dbi;
+}
+
+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)
@@ -424,6 +498,10 @@ _get_entity_repr_class(const ir_entity *ent) {
 #define get_entity_variability(ent)              _get_entity_variability(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)
@@ -432,8 +510,10 @@ _get_entity_repr_class(const ir_entity *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 get_entity_address_taken(ent)            _get_entity_address_taken(ent)
-#define set_entity_address_taken(ent, flag)      _set_entity_address_taken(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)
 #define set_entity_offset(ent, offset)           _set_entity_offset(ent, offset)
 #define get_entity_offset_bits_remainder(ent)    _get_entity_offset_bits_remainder(ent)
@@ -447,6 +527,8 @@ _get_entity_repr_class(const ir_entity *ent) {
 #define entity_visited(ent)                      _entity_visited(ent)
 #define entity_not_visited(ent)                  _entity_not_visited(ent)
 #define get_entity_repr_class(ent)               _get_entity_repr_class(ent)
+#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 /* FIRM_TR_ENTITY_T_H */