becopyheur2: Avoid unnecessary copies of the admissible registers.
[libfirm] / ir / tr / type_t.h
index 660fb24..27126de 100644 (file)
@@ -1,27 +1,12 @@
 /*
- * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
- *
  * This file is part of libFirm.
- *
- * 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.
- *
- * Licensees holding valid libFirm Professional Edition licenses may use
- * this file in accordance with the libFirm Commercial License.
- * Agreement provided with the Software.
- *
- * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
- * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
 /**
  * @file
  * @brief   Representation of types -- private header.
  * @author  Goetz Lindenmaier, Michael Beck
- * @version $Id$
  * @see     type.h tpop_t.h tpop.h
  */
 #ifndef FIRM_TR_TYPE_T_H
 
 #include "array.h"
 
+#define set_master_type_visited(val)      _set_master_type_visited(val)
+#define get_master_type_visited()         _get_master_type_visited()
+#define inc_master_type_visited()         _inc_master_type_visited()
+#define get_type_link(tp)                 _get_type_link(tp)
+#define set_type_link(tp, l)              _set_type_link(tp, l)
+#define get_type_tpop(tp)                 _get_type_tpop(tp)
+#define get_type_tpop_nameid(tp)          _get_type_tpop_nameid(tp)
+#define get_type_tpop_code(tp)            _get_type_tpop_code(tp)
+#define get_type_mode(tp)                 _get_type_mode(tp)
+#define get_type_size_bytes(tp)           _get_type_size_bytes(tp)
+#define get_type_state(tp)                _get_type_state(tp)
+#define get_type_visited(tp)              _get_type_visited(tp)
+#define set_type_visited(tp, num)         _set_type_visited(tp, num)
+#define mark_type_visited(tp)             _mark_type_visited(tp)
+#define type_visited(tp)                  _type_visited(tp)
+#define type_not_visited(tp)              _type_not_visited(tp)
+#define get_type_dbg_info(tp)             _get_type_dbg_info(tp)
+#define set_type_dbg_info(tp, db)         _set_type_dbg_info(tp, db)
+#define is_type(thing)                    _is_type(thing)
+#define is_Class_type(clss)               _is_class_type(clss)
+#define get_class_n_members(clss)         _get_class_n_members(clss)
+#define get_class_member(clss, pos)       _get_class_member(clss, pos)
+#define get_class_vtable_size(clss)       _get_class_vtable_size(clss)
+#define set_class_vtable_size(clss, size) _set_class_vtable_size(clss, size)
+#define is_class_final(clss)              _is_class_final(clss)
+#define set_class_final(clss, flag)       _set_class_final(clss, flag)
+#define is_class_interface(clss)          _is_class_interface(clss)
+#define set_class_interface(clss, flag)   _set_class_interface(clss, flag)
+#define is_class_abstract(clss)           _is_class_abstract(clss)
+#define set_class_abstract(clss, flag)    _set_class_abstract(clss, flag)
+#define is_Struct_type(strct)             _is_struct_type(strct)
+#define is_Method_type(method)            _is_method_type(method)
+#define is_Union_type(uni)                _is_union_type(uni)
+#define is_Array_type(array)              _is_array_type(array)
+#define is_Enumeration_type(enumeration)  _is_enumeration_type(enumeration)
+#define is_Pointer_type(pointer)          _is_pointer_type(pointer)
+#define is_Primitive_type(primitive)      _is_primitive_type(primitive)
+#define is_atomic_type(tp)                _is_atomic_type(tp)
+#define get_method_n_params(method)       _get_method_n_params(method)
+#define get_method_n_ress(method)         _get_method_n_ress(method)
+#define get_method_additional_properties(method)        _get_method_additional_properties(method)
+#define set_method_additional_properties(method, mask)  _set_method_additional_properties(method, mask)
+#define add_method_additional_properties(method, flag)  _add_method_additional_properties(method, flag)
+#define get_method_calling_convention(method)           _get_method_calling_convention(method)
+#define set_method_calling_convention(method, cc_mask)  _set_method_calling_convention(method, cc_mask)
+
 /** Class flags. */
 enum class_flags {
        cf_none            = 0,  /**< No flags. */
@@ -49,7 +80,6 @@ typedef struct {
        ir_type **subtypes;          /**< Array containing the direct subtypes. */
        ir_type **supertypes;        /**< Array containing the direct supertypes */
        ir_peculiarity peculiarity;  /**< The peculiarity of this class. */
-       ir_entity *type_info;        /**< An ir_entity representing this class, used for type info. */
        int      dfn;                /**< A number that can be used for 'instanceof' operator. */
        unsigned vtable_size;        /**< The size of the vtable for this class. */
        unsigned clss_flags;         /**< Additional class flags. */
@@ -73,9 +103,8 @@ typedef struct {
        size_t       n_res;             /**< Number of results. */
        tp_ent_pair *res_type;          /**< Array of result type/value ir_entity pairs. */
        ir_variadicity variadicity;     /**< The variadicity of the method. */
-       mtp_additional_properties additional_properties; /**< Set of additional method properties. */
+       mtp_additional_properties properties; /**< Set of additional method properties. */
        unsigned irg_calling_conv;      /**< A set of calling convention flags. */
-       bool     has_compound_ret_parameter : 1; /**< first parameter compound return address */
 } mtd_attr;
 
 /** Union type attributes. */
@@ -130,17 +159,19 @@ typedef union {
 } tp_attr;
 
 /** Additional type flags. */
-enum type_flags {
+typedef enum type_flags {
        tf_none             = 0, /**< No flags. */
        tf_lowered_type     = 1U << 0, /**< Set if this is a lowered type. */
        tf_layout_fixed     = 1U << 1, /**< Set if the layout of a type is fixed */
 
        tf_frame_type       = 1U << 2, /**< Set if this is a frame type. */
-       tf_global_type      = 1U << 3, /**< Set only for the global type */
-       tf_tls_type         = 1U << 4, /**< Set only for the tls type */
-       tf_constructors     = 1U << 5, /**< Set only for the constructors segment type */
-       tf_destructors      = 1U << 6, /**< Set only for the destructors segment type */
-};
+       tf_segment          = 1U << 3, /**< type represents a linker segment */
+       tf_global_type      = 1U << 4, /**< Set only for the global type */
+       tf_tls_type         = 1U << 5, /**< Set only for the tls type */
+       tf_constructors     = 1U << 6, /**< Set only for the constructors segment type */
+       tf_destructors      = 1U << 7, /**< Set only for the destructors segment type */
+       tf_variable_size    = 1U << 8, /**< compound or array type may have variable size last element */
+} type_flags;
 ENUM_BITSET(type_flags)
 
 /**
@@ -156,53 +187,6 @@ ENUM_BITSET(type_flags)
  *  the type.  These are distinguished by a type opcode.
  *  A type is described by a set of attributes.  Some of these attributes
  *  are common to all types, others depend on the kind of the type.
- *
- *  The following describes the common attributes.  They can only be
- *  accessed by the functions given below.
- *
- *  The common fields are:
- *
- *  - firm_kind:   A firm_kind tag containing k_type.  This is useful
- *                 for dynamically checking whether a node is a type node.
- *  - type_op:     A tp_op specifying the kind of the type.
- *  - name:        An identifier specifying the name of the type.  To be
- *                 set by the frontend.
- *  - size:        The size of the type, i.e. an entity of this type will
- *                 occupy size bits in memory.  In several cases this is
- *                 determined when fixing the layout of this type (class,
- *                 struct, union, array, enumeration).
- *  - alignment    The alignment of the type, i.e. an entity of this type will
- *                 be allocated an an address in memory with this alignment.
- *                 In several cases this is determined when fixing the layout
- *                 of this type (class, struct, union, array)
- *  - mode:        The mode to be used to represent the type on a machine.
- *  - state:       The state of the type.  The state represents whether the
- *                 layout of the type is undefined or fixed (values: layout_undefined
- *                 or layout_fixed).  Compound types can have an undefined
- *                 layout.  The layout of the basic types primitive and pointer
- *                 is always layout_fixed.  If the layout of
- *                 compound types is fixed all entities must have an offset
- *                 and the size of the type must be set.
- *                 A fixed layout for enumeration types means that each enumeration
- *                 is associated with an implementation value.
- *  - assoc_type:  The associated lowered/upper type.
- *  - visit:       A counter for walks of the type information.
- *  - link:        A void* to associate some additional information with the type.
- *
- *  These fields can only be accessed via access functions.
- *
- *  Depending on the value of @c type_op, i.e., depending on the kind of the
- *  type the adt contains further attributes.  These are documented below.
- *
- *  @see
- *
- *  @link class_type class @endlink, @link struct_type struct @endlink,
- *  @link method_type method @endlink, @link union_type union @endlink,
- *  @link array_type array @endlink, @link enumeration_type enumeration @endlink,
- *  @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
- *
- *  @todo
- *      mode maybe not global field??
  */
 struct ir_type {
        firm_kind kind;          /**< the firm kind, must be k_type */
@@ -210,41 +194,30 @@ struct ir_type {
        ident *name;             /**< The name of the type */
        ir_visibility visibility;/**< Visibility of entities of this type. */
        unsigned flags;          /**< Type flags, a bitmask of enum type_flags. */
-       unsigned size;           /**< Size of an ir_entity of this type. This is determined
-                                     when fixing the layout of this class.  Size must be
-                                     given in bytes. */
-       unsigned align;          /**< Alignment of an ir_entity of this type. This should be
-                                     set according to the source language needs. If not set, it's
-                                     calculated automatically by get_type_alignment().
+       unsigned size;           /**< Size of an ir_entity of this type. This is
+                                     determined when fixing the layout of this
+                                     class.  Size must be given in bytes. */
+       unsigned align;          /**< Alignment of an ir_entity of this type. This
+                                     should be set according to the source
+                                     language needs. If not set, it's calculated
+                                     automatically by get_type_alignment().
                                      Alignment must be given in bytes. */
        ir_mode *mode;           /**< The mode for atomic types */
        ir_visited_t visit;      /**< visited counter for walks of the type information */
        void *link;              /**< holds temporary data - like in irnode_t.h */
        type_dbg_info *dbi;      /**< A pointer to information for debug support. */
-       ir_type *assoc_type;     /**< The associated lowered/unlowered type */
-
-       /* ------------- fields for analyses ---------------*/
+       ir_type *higher_type;    /**< link to highlevel type in case of lowered
+                                     types */
 
 #ifdef DEBUG_libfirm
-       long nr;                 /**< An unique node number for each node to make output
-                                     readable. */
+       long nr;                 /**< An unique node number for each node to make
+                                     output readable. */
 #endif
-       tp_attr attr;            /**< Type kind specific fields. This must be the last
-                                     entry in this struct!  Varying size! */
+       tp_attr attr;            /**< Type kind specific fields. This must be the
+                                     last entry in this struct!  Varying size! */
 };
 
-/**
- *   Creates a new type representation:
- *
- *   @param type_op  the kind of this type.  May not be type_id.
- *   @param mode     the mode to be used for this type, may be NULL
- *   @param db       debug info
- *
- *   @return A new type of the given type.  The remaining private attributes are not
- *           initialized.  The type is in state layout_undefined.
- */
-ir_type *new_type(const tp_op *type_op, ir_mode *mode, type_dbg_info *db);
-void free_type_attrs(ir_type *tp);
+void free_type_entities(ir_type *tp);
 
 void free_class_entities      (ir_type *clss);
 void free_struct_entities     (ir_type *strct);
@@ -284,10 +257,10 @@ int  get_class_dfn(const ir_type *clss);
 void add_compound_member(ir_type *compound, ir_entity *entity);
 
 /** Initialize the type module. */
-void ir_init_type(void);
+void ir_init_type(ir_prog *irp);
 
 /** free internal datastructures of type module */
-void ir_finish_type(void);
+void ir_finish_type(ir_prog *irp);
 
 /** Clone an existing method type.
  *
@@ -299,114 +272,115 @@ void ir_finish_type(void);
  */
 ir_type *clone_type_method(ir_type *tp);
 
-/* ------------------- *
- *  inline functions   *
- * ------------------- */
-
 extern ir_visited_t firm_type_visited;
 
-static inline void _set_master_type_visited(ir_visited_t val) { firm_type_visited = val; }
-static inline ir_visited_t _get_master_type_visited(void)     { return firm_type_visited; }
-static inline void _inc_master_type_visited(void)             { ++firm_type_visited; }
+static inline void _set_master_type_visited(ir_visited_t val)
+{
+       firm_type_visited = val;
+}
+
+static inline ir_visited_t _get_master_type_visited(void)
+{
+       return firm_type_visited;
+}
+
+static inline void _inc_master_type_visited(void)
+{
+       ++firm_type_visited;
+}
 
 static inline int is_lowered_type(const ir_type *tp)
 {
        return tp->flags & tf_lowered_type;
 }
 
-/**
- * Gets the lowered/unlowered type of a type or NULL if this type
- * has no lowered/unlowered one.
- */
-static inline ir_type *get_associated_type(const ir_type *tp)
+static inline ir_type *get_higher_type(const ir_type *tp)
 {
-       return tp->assoc_type;
+       return tp->higher_type;
 }
 
-static inline void set_lowered_type(ir_type *tp, ir_type *lowered_type)
+static inline void set_higher_type(ir_type *tp, ir_type *higher_type)
 {
-       assert (is_type(tp) && is_type(lowered_type));
-       lowered_type->flags |= tf_lowered_type;
-       tp->assoc_type = lowered_type;
-       lowered_type->assoc_type = tp;
+       tp->flags |= tf_lowered_type;
+       tp->higher_type = higher_type;
 }
 
 static inline void *_get_type_link(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return(tp -> link);
 }
 
 static inline void _set_type_link(ir_type *tp, void *l)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        tp -> link = l;
 }
 
 static inline const tp_op *_get_type_tpop(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return tp->type_op;
 }
 
 static inline ident *_get_type_tpop_nameid(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return get_tpop_ident(tp->type_op);
 }
 
 static inline tp_opcode _get_type_tpop_code(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return get_tpop_code(tp->type_op);
 }
 
 static inline ir_mode *_get_type_mode(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return tp->mode;
 }
 
 static inline unsigned _get_type_size_bytes(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return tp->size;
 }
 
 static inline ir_type_state _get_type_state(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return tp->flags & tf_layout_fixed ? layout_fixed : layout_undefined;
 }
 
 static inline ir_visited_t _get_type_visited(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return tp->visit;
 }
 
 static inline void _set_type_visited(ir_type *tp, ir_visited_t num)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        tp->visit = num;
 }
 
 static inline void _mark_type_visited(ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        assert(tp->visit < firm_type_visited);
        tp->visit = firm_type_visited;
 }
 
 static inline int _type_visited(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return tp->visit >= firm_type_visited;
 }
 
 static inline int _type_not_visited(const ir_type *tp)
 {
-       assert(tp && tp->kind == k_type);
+       assert(tp->kind == k_type);
        return tp->visit  < firm_type_visited;
 }
 
@@ -559,25 +533,19 @@ static inline size_t _get_method_n_ress(const ir_type *method)
 static inline mtp_additional_properties _get_method_additional_properties(const ir_type *method)
 {
        assert(method->type_op == type_method);
-       return method->attr.ma.additional_properties;
+       return method->attr.ma.properties;
 }
 
-static inline void _set_method_additional_properties(ir_type *method, mtp_additional_properties mask)
+static inline void _set_method_additional_properties(ir_type *method, mtp_additional_properties properties)
 {
        assert(method->type_op == type_method);
-
-       /* do not allow to set the mtp_property_inherited flag or
-        * the automatic inheritance of flags will not work */
-       method->attr.ma.additional_properties = mask & ~mtp_property_inherited;
+       method->attr.ma.properties = properties;
 }
 
-static inline void _add_method_additional_properties(ir_type *method, mtp_additional_properties flag)
+static inline void _add_method_additional_properties(ir_type *method, mtp_additional_properties properties)
 {
        assert(method->type_op == type_method);
-
-       /* do not allow to set the mtp_property_inherited flag or
-        * the automatic inheritance of flags will not work */
-       method->attr.ma.additional_properties |= flag & ~mtp_property_inherited;
+       method->attr.ma.properties |= properties;
 }
 
 static inline unsigned _get_method_calling_convention(const ir_type *method)
@@ -592,51 +560,6 @@ static inline void _set_method_calling_convention(ir_type *method, unsigned cc_m
        method->attr.ma.irg_calling_conv = cc_mask;
 }
 
-
-#define set_master_type_visited(val)      _set_master_type_visited(val)
-#define get_master_type_visited()         _get_master_type_visited()
-#define inc_master_type_visited()         _inc_master_type_visited()
-#define get_type_link(tp)                 _get_type_link(tp)
-#define set_type_link(tp, l)              _set_type_link(tp, l)
-#define get_type_tpop(tp)                 _get_type_tpop(tp)
-#define get_type_tpop_nameid(tp)          _get_type_tpop_nameid(tp)
-#define get_type_tpop_code(tp)            _get_type_tpop_code(tp)
-#define get_type_mode(tp)                 _get_type_mode(tp)
-#define get_type_size_bytes(tp)           _get_type_size_bytes(tp)
-#define get_type_state(tp)                _get_type_state(tp)
-#define get_type_visited(tp)              _get_type_visited(tp)
-#define set_type_visited(tp, num)         _set_type_visited(tp, num)
-#define mark_type_visited(tp)             _mark_type_visited(tp)
-#define type_visited(tp)                  _type_visited(tp)
-#define type_not_visited(tp)              _type_not_visited(tp)
-#define get_type_dbg_info(tp)             _get_type_dbg_info(tp)
-#define set_type_dbg_info(tp, db)         _set_type_dbg_info(tp, db)
-#define is_type(thing)                    _is_type(thing)
-#define is_Class_type(clss)               _is_class_type(clss)
-#define get_class_n_members(clss)         _get_class_n_members(clss)
-#define get_class_member(clss, pos)       _get_class_member(clss, pos)
-#define get_class_vtable_size(clss)       _get_class_vtable_size(clss)
-#define set_class_vtable_size(clss, size) _set_class_vtable_size(clss, size)
-#define is_class_final(clss)              _is_class_final(clss)
-#define set_class_final(clss, flag)       _set_class_final(clss, flag)
-#define is_class_interface(clss)          _is_class_interface(clss)
-#define set_class_interface(clss, flag)   _set_class_interface(clss, flag)
-#define is_class_abstract(clss)           _is_class_abstract(clss)
-#define set_class_abstract(clss, flag)    _set_class_abstract(clss, flag)
-#define is_Struct_type(strct)             _is_struct_type(strct)
-#define is_Method_type(method)            _is_method_type(method)
-#define is_Union_type(uni)                _is_union_type(uni)
-#define is_Array_type(array)              _is_array_type(array)
-#define is_Enumeration_type(enumeration)  _is_enumeration_type(enumeration)
-#define is_Pointer_type(pointer)          _is_pointer_type(pointer)
-#define is_Primitive_type(primitive)      _is_primitive_type(primitive)
-#define is_atomic_type(tp)                _is_atomic_type(tp)
-#define get_method_n_params(method)       _get_method_n_params(method)
-#define get_method_n_ress(method)         _get_method_n_ress(method)
-#define get_method_additional_properties(method)        _get_method_additional_properties(method)
-#define set_method_additional_properties(method, mask)  _set_method_additional_properties(method, mask)
-#define add_method_additional_properties(method, flag)  _add_method_additional_properties(method, flag)
-#define get_method_calling_convention(method)           _get_method_calling_convention(method)
-#define set_method_calling_convention(method, cc_mask)  _set_method_calling_convention(method, cc_mask)
+ir_type *new_type_segment(ident *name, type_flags flags);
 
 #endif /* FIRM_TR_TYPE_T_H */