Remove type lower functions from API
[libfirm] / ir / tr / type_t.h
index 59a0d91..598533d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -27,7 +27,6 @@
 #ifndef FIRM_TR_TYPE_T_H
 #define FIRM_TR_TYPE_T_H
 
-#include "firm_config.h"
 #include "typerep.h"
 #include "tpop_t.h"
 #include "irgraph.h"
@@ -62,22 +61,19 @@ typedef struct {
 
 /** A (type, ir_entity) pair. */
 typedef struct {
-       ir_type *tp;         /**< A type. */
-       ir_entity  *ent;     /**< An ir_entity. */
-       ident   *param_name; /**< For debugging purposes: the name of the parameter */
+       ir_type   *tp;      /**< A type. */
+       ir_entity *ent;     /**< An ir_entity. */
 } tp_ent_pair;
 
 /** Method type attributes. */
 typedef struct {
-       int n_params;                   /**< Number of parameters. */
+       size_t       n_params;          /**< Number of parameters. */
        tp_ent_pair *params;            /**< Array of parameter type/value entities pairs. */
-       ir_type *value_params;          /**< A type whose entities represent copied value arguments. */
-       int n_res;                      /**< Number of results. */
+       ir_type     *value_params;      /**< A type whose entities represent copied value arguments. */
+       size_t       n_res;             /**< Number of results. */
        tp_ent_pair *res_type;          /**< Array of result type/value ir_entity pairs. */
-       ir_type *value_ress;            /**< A type whose entities represent copied value results. */
-       variadicity variadicity;        /**< The variadicity of the method. */
-       int first_variadic_param;       /**< The index of the first variadic parameter or -1 if non-variadic .*/
-       unsigned additional_properties; /**< Set of additional method properties. */
+       ir_variadicity variadicity;     /**< The variadicity of the method. */
+mtp_additional_properties additional_properties; /**< Set of additional method properties. */
        unsigned irg_calling_conv;      /**< A set of calling convention flags. */
 } mtd_attr;
 
@@ -88,7 +84,7 @@ typedef struct {
 
 /** Array type attributes. */
 typedef struct {
-       int     n_dimensions;   /**< Number of array dimensions.  */
+       size_t  n_dimensions;   /**< Number of array dimensions.  */
        ir_node **lower_bound;  /**< Lower bounds of dimensions.  Usually all 0. */
        ir_node **upper_bound;  /**< Upper bounds or dimensions. */
        int     *order;         /**< Ordering of dimensions. */
@@ -99,7 +95,7 @@ typedef struct {
 
 /** An enumerator constant. */
 struct ir_enum_const {
-       tarval  *value;     /**< The constants that represents this enumerator identifier. */
+       ir_tarval  *value;  /**< The constants that represents this enumerator identifier. */
        ident   *nameid;    /**< The name of the enumerator identifier. */
        ir_type *owner;     /**< owner type of this enumerator constant. */
 };
@@ -120,12 +116,6 @@ typedef struct {
        ir_type *base_type;  /**< For bitfield types: The base primitive type, NULL else. */
 } pri_attr;
 
-
-/*
-typedef struct {        * No private attr, must be smaller than others! *
-} id_attr;
-*/
-
 /** General type attributes. */
 typedef union {
        cls_attr ca;      /**< Attributes of a class type */
@@ -140,13 +130,16 @@ typedef union {
 
 /** Additional type flags. */
 enum type_flags {
-       tf_none             =  0, /**< No flags. */
-       tf_frame_type       =  1, /**< Set if this is a frame type. */
-       tf_value_param_type =  2, /**< Set if this is a value param type. */
-       tf_lowered_type     =  4, /**< Set if this is a lowered type. */
-       tf_layout_fixed     =  8, /**< Set if the layout of a type is fixed */
-       tf_global_type      = 16, /**< Set only for the global type */
-       tf_tls_type         = 32, /**< Set only for the tls type */
+       tf_none             =   0, /**< No flags. */
+       tf_lowered_type     =   1, /**< Set if this is a lowered type. */
+       tf_layout_fixed     =   2, /**< Set if the layout of a type is fixed */
+
+       tf_frame_type       =   4, /**< Set if this is a frame type. */
+       tf_value_param_type =   8, /**< Set if this is a value param type. */
+       tf_global_type      =  16, /**< Set only for the global type */
+       tf_tls_type         =  32, /**< Set only for the tls type */
+       tf_constructors     =  64, /**< Set only for the constructors segment type */
+       tf_destructors      = 128, /**< Set only for the destructors segment type */
 };
 
 /**
@@ -173,7 +166,6 @@ enum type_flags {
  *  - 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.
- *  - visibility:  The visibility of this type.
  *  - 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,
@@ -217,17 +209,17 @@ 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. */
-       int size;                /**< Size of an ir_entity of this type. This is determined
+       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 bits. */
-       int align;               /**< Alignment of an ir_entity of this type. This should be
-                                     set according to the source language needs. If not set it's
+                                     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 bits. */
+                                     Alignment must be given in bytes. */
        ir_mode *mode;           /**< The mode for atomic types */
-       unsigned long visit;     /**< visited counter for walks of the type information */
+       ir_visited_t visit;      /**< visited counter for walks of the type information */
        void *link;              /**< holds temporary data - like in irnode_t.h */
-       struct dbg_info *dbi;    /**< A pointer to information for debug support. */
+       type_dbg_info *dbi;      /**< A pointer to information for debug support. */
        ir_type *assoc_type;     /**< The associated lowered/unlowered type */
 
        /* ------------- fields for analyses ---------------*/
@@ -245,15 +237,13 @@ struct ir_type {
  *
  *   @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 name     an ident for the name of this type.
  *   @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(tp_op *type_op, ir_mode *mode, ident *name, dbg_info *db);
-void free_type_attrs       (ir_type *tp);
+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_class_entities      (ir_type *clss);
 void free_struct_entities     (ir_type *strct);
@@ -279,320 +269,332 @@ void set_pointer_mode(ir_type *tp, ir_mode *mode);
 void set_primitive_mode(ir_type *tp, ir_mode *mode);
 void set_enumeration_mode(ir_type *tp, ir_mode *mode);
 
-void set_class_size_bits(ir_type *tp, int bits);
-void set_struct_size_bits(ir_type *tp, int bits);
-void set_union_size_bits(ir_type *tp, int bits);
-void set_array_size_bits(ir_type *tp, int size);
-void set_default_size_bits(ir_type *tp, int size);
+void set_class_size(ir_type *tp, unsigned bytes);
+void set_struct_size(ir_type *tp, unsigned bytes);
+void set_union_size(ir_type *tp, unsigned bytes);
+void set_array_size(ir_type *tp, unsigned bytes);
+void set_default_size(ir_type *tp, unsigned bytes);
 
-/**
- * Initialize the type module.
+/** Set and get a class' dfn --
+ * This is an undocumented field, subject to change! */
+void set_class_dfn(ir_type *clss, int dfn);
+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);
+
+/** free internal datastructures of type module */
+void ir_finish_type(void);
+
+/** Clone an existing method type.
  *
- * @param builtin_db       debug info for built-in objects
- * @param default_cc_mask  default calling conventions for methods
+ * @param tp      the method type to clone.
+ * @param prefix  if non-null, will be the prefix for the name of
+ *                the cloned type
+ *
+ * @return the cloned method type.
  */
-void firm_init_type(dbg_info *builtin_db, unsigned default_cc_mask);
-
+ir_type *clone_type_method(ir_type *tp);
 
 /* ------------------- *
  *  inline functions   *
  * ------------------- */
 
-extern unsigned long firm_type_visited;
+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 int is_lowered_type(const ir_type *tp)
+{
+       return tp->flags & tf_lowered_type;
+}
+
+static inline ir_type *get_type_unlowered(const ir_type *tp)
+{
+       assert (is_lowered_type(tp));
+       return tp->assoc_type;
+}
 
-static INLINE void _set_master_type_visited(unsigned long val) { firm_type_visited = val; }
-static INLINE unsigned long _get_master_type_visited(void)     { return firm_type_visited; }
-static INLINE void _inc_master_type_visited(void)              { ++firm_type_visited; }
+static inline ir_type *get_type_lowered(const ir_type *tp)
+{
+       assert (tp->assoc_type == NULL || is_lowered_type(tp->assoc_type));
+       return tp->assoc_type;
+}
 
-static INLINE void *
-_get_type_link(const ir_type *tp) {
+static inline void set_lowered_type(ir_type *tp, ir_type *lowered_type)
+{
+       assert (is_type(tp) && is_type(lowered_type));
+       lowered_type->flags |= tf_lowered_type;
+       /* there might be a chain of lowerings, get to the start */
+       while (is_lowered_type(tp)) {
+               tp = tp->assoc_type;
+       }
+       tp->assoc_type = lowered_type;
+       lowered_type->assoc_type = tp;
+}
+
+static inline void *_get_type_link(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return(tp -> link);
 }
 
-static INLINE void
-_set_type_link(ir_type *tp, void *l) {
+static inline void _set_type_link(ir_type *tp, void *l)
+{
        assert(tp && tp->kind == k_type);
        tp -> link = l;
 }
 
-static INLINE const tp_op*
-_get_type_tpop(const ir_type *tp) {
+static inline const tp_op *_get_type_tpop(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return tp->type_op;
 }
 
-static INLINE ident*
-_get_type_tpop_nameid(const ir_type *tp) {
+static inline ident *_get_type_tpop_nameid(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return get_tpop_ident(tp->type_op);
 }
 
-static INLINE tp_opcode
-_get_type_tpop_code(const ir_type *tp) {
+static inline tp_opcode _get_type_tpop_code(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return get_tpop_code(tp->type_op);
 }
 
-static INLINE ir_mode *
-_get_type_mode(const ir_type *tp) {
+static inline ir_mode *_get_type_mode(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return tp->mode;
 }
 
-static INLINE ident *
-_get_type_ident(const ir_type *tp) {
-       assert(tp && tp->kind == k_type);
-       return tp->name;
-}
-
-static INLINE void
-_set_type_ident(ir_type *tp, ident* id) {
-       assert(tp && tp->kind == k_type);
-       tp->name = id;
-}
-
-static INLINE int
-_get_type_size_bits(const ir_type *tp) {
+static inline unsigned _get_type_size_bytes(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return tp->size;
 }
 
-static INLINE int
-_get_type_size_bytes(const ir_type *tp) {
-       int size = _get_type_size_bits(tp);
-       if (size < 0)
-               return -1;
-       if ((size & 7) != 0) {
-               assert(0 && "cannot take byte size of this type");
-               return -1;
-       }
-       return size >> 3;
-}
-
-static INLINE type_state
-_get_type_state(const ir_type *tp) {
+static inline ir_type_state _get_type_state(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return tp->flags & tf_layout_fixed ? layout_fixed : layout_undefined;
 }
 
-static INLINE unsigned long
-_get_type_visited(const ir_type *tp) {
+static inline ir_visited_t _get_type_visited(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return tp->visit;
 }
 
-static INLINE void
-_set_type_visited(ir_type *tp, unsigned long num) {
+static inline void _set_type_visited(ir_type *tp, ir_visited_t num)
+{
        assert(tp && tp->kind == k_type);
        tp->visit = num;
 }
 
-static INLINE void
-_mark_type_visited(ir_type *tp) {
+static inline void _mark_type_visited(ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        assert(tp->visit < firm_type_visited);
        tp->visit = firm_type_visited;
 }
 
-static INLINE int
-_type_visited(const ir_type *tp) {
+static inline int _type_visited(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return tp->visit >= firm_type_visited;
 }
 
-static INLINE int
-_type_not_visited(const ir_type *tp) {
+static inline int _type_not_visited(const ir_type *tp)
+{
        assert(tp && tp->kind == k_type);
        return tp->visit  < firm_type_visited;
 }
 
-static INLINE dbg_info *
-_get_type_dbg_info(const ir_type *tp) {
+static inline type_dbg_info *_get_type_dbg_info(const ir_type *tp)
+{
        return tp->dbi;
 }
 
-static INLINE void
-_set_type_dbg_info(ir_type *tp, dbg_info *db) {
+static inline void _set_type_dbg_info(ir_type *tp, type_dbg_info *db)
+{
        tp->dbi = db;
 }
 
-static INLINE int
-_is_type(const void *thing) {
-       return (get_kind(thing) == k_type);
+static inline int _is_type(const void *thing)
+{
+       return get_kind(thing) == k_type;
 }
 
-static INLINE int
-_is_class_type(const ir_type *clss) {
-       assert(clss);
-       return (clss->type_op == type_class);
+static inline int _is_class_type(const ir_type *clss)
+{
+       return clss->type_op == type_class;
 }
 
-static INLINE int
-_get_class_n_members (const ir_type *clss) {
-       assert(clss && (clss->type_op == type_class));
-       return (ARR_LEN (clss->attr.ca.members));
+static inline size_t _get_class_n_members(const ir_type *clss)
+{
+       assert(clss->type_op == type_class);
+       return ARR_LEN(clss->attr.ca.members);
 }
 
-static INLINE ir_entity *
-_get_class_member   (const ir_type *clss, int pos) {
-       assert(clss && (clss->type_op == type_class));
-       assert(pos >= 0 && pos < _get_class_n_members(clss));
+static inline ir_entity *_get_class_member(const ir_type *clss, size_t pos)
+{
+       assert(clss->type_op == type_class);
+       assert(pos < _get_class_n_members(clss));
        return clss->attr.ca.members[pos];
 }
 
-static INLINE unsigned
-_get_class_vtable_size(const ir_type *clss) {
-       assert(clss && (clss->type_op == type_class));
+static inline unsigned _get_class_vtable_size(const ir_type *clss)
+{
+       assert(clss->type_op == type_class);
        return clss->attr.ca.vtable_size;
 }
 
-static INLINE void
-_set_class_vtable_size(ir_type *clss, unsigned vtable_size) {
-       assert(clss && (clss->type_op == type_class));
+static inline void _set_class_vtable_size(ir_type *clss, unsigned vtable_size)
+{
+       assert(clss->type_op == type_class);
        clss->attr.ca.vtable_size = vtable_size;
 }
 
-static INLINE int
-_is_class_final(const ir_type *clss) {
-       assert(clss && (clss->type_op == type_class));
+static inline int _is_class_final(const ir_type *clss)
+{
+       assert(clss->type_op == type_class);
        return clss->attr.ca.clss_flags & cf_final_class;
 }
 
-static INLINE void
-_set_class_final(ir_type *clss, int final) {
-       assert(clss && (clss->type_op == type_class));
+static inline void _set_class_final(ir_type *clss, int final)
+{
+       assert(clss->type_op == type_class);
        if (final)
                clss->attr.ca.clss_flags |= cf_final_class;
        else
                clss->attr.ca.clss_flags &= ~cf_final_class;
 }
 
-static INLINE int
-_is_class_interface(const ir_type *clss) {
-       assert(clss && (clss->type_op == type_class));
+static inline int _is_class_interface(const ir_type *clss)
+{
+       assert(clss->type_op == type_class);
        return clss->attr.ca.clss_flags & cf_interface_class;
 }
 
-static INLINE void
-_set_class_interface(ir_type *clss, int final) {
-       assert(clss && (clss->type_op == type_class));
+static inline void _set_class_interface(ir_type *clss, int final)
+{
+       assert(clss->type_op == type_class);
        if (final)
                clss->attr.ca.clss_flags |= cf_interface_class;
        else
                clss->attr.ca.clss_flags &= ~cf_interface_class;
 }
 
-static INLINE int
-_is_class_abstract(const ir_type *clss) {
-       assert(clss && (clss->type_op == type_class));
+static inline int _is_class_abstract(const ir_type *clss)
+{
+       assert(clss->type_op == type_class);
        return clss->attr.ca.clss_flags & cf_absctract_class;
-       }
+}
 
-static INLINE void
-_set_class_abstract(ir_type *clss, int final) {
-       assert(clss && (clss->type_op == type_class));
+static inline void _set_class_abstract(ir_type *clss, int final)
+{
+       assert(clss->type_op == type_class);
        if (final)
                clss->attr.ca.clss_flags |= cf_absctract_class;
        else
                clss->attr.ca.clss_flags &= ~cf_absctract_class;
 }
 
-static INLINE int
-_is_struct_type(const ir_type *strct) {
-       assert(strct);
+static inline int _is_struct_type(const ir_type *strct)
+{
        return (strct->type_op == type_struct);
 }
 
-static INLINE int
-_is_method_type(const ir_type *method) {
-       assert(method);
+static inline int _is_method_type(const ir_type *method)
+{
        return (method->type_op == type_method);
 }
 
-static INLINE int
-_is_union_type(const ir_type *uni) {
-       assert(uni);
+static inline int _is_union_type(const ir_type *uni)
+{
        return (uni->type_op == type_union);
 }
 
-static INLINE int
-_is_array_type(const ir_type *array) {
-       assert(array);
+static inline int _is_array_type(const ir_type *array)
+{
        return (array->type_op == type_array);
 }
 
-static INLINE int
-_is_enumeration_type(const ir_type *enumeration) {
-       assert(enumeration);
+static inline int _is_enumeration_type(const ir_type *enumeration)
+{
        return (enumeration->type_op == type_enumeration);
 }
 
-static INLINE int
-_is_pointer_type(const ir_type *pointer) {
-       assert(pointer);
+static inline int _is_pointer_type(const ir_type *pointer)
+{
        return (pointer->type_op == type_pointer);
 }
 
 /** Returns true if a type is a primitive type. */
-static INLINE int
-_is_primitive_type(const ir_type *primitive) {
-       assert(primitive && primitive->kind == k_type);
+static inline int _is_primitive_type(const ir_type *primitive)
+{
+       assert(primitive->kind == k_type);
        return (primitive->type_op == type_primitive);
 }
 
-static INLINE int
-_is_atomic_type(const ir_type *tp) {
-       assert(tp && tp->kind == k_type);
+static inline int _is_atomic_type(const ir_type *tp)
+{
+       assert(tp->kind == k_type);
        return (_is_primitive_type(tp) || _is_pointer_type(tp) ||
                _is_enumeration_type(tp));
 }
 
-static INLINE int
-_get_method_n_params(const ir_type *method) {
-       assert(method && (method->type_op == type_method));
+static inline size_t _get_method_n_params(const ir_type *method)
+{
+       assert(method->type_op == type_method);
        return method->attr.ma.n_params;
 }
 
-static INLINE int
-_get_method_n_ress(const ir_type *method) {
-       assert(method && (method->type_op == type_method));
+static inline size_t _get_method_n_ress(const ir_type *method)
+{
+       assert(method->type_op == type_method);
        return method->attr.ma.n_res;
 }
 
-static INLINE unsigned
-_get_method_additional_properties(const ir_type *method) {
-       assert(method && (method->type_op == 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;
 }
 
-static INLINE void
-_set_method_additional_properties(ir_type *method, unsigned mask) {
-       assert(method && (method->type_op == type_method));
+static inline void _set_method_additional_properties(ir_type *method, mtp_additional_properties mask)
+{
+       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;
 }
 
-static INLINE void
-_set_method_additional_property(ir_type *method, mtp_additional_property flag) {
-       assert(method && (method->type_op == type_method));
+static inline void _add_method_additional_properties(ir_type *method, mtp_additional_properties flag)
+{
+       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;
 }
 
-static INLINE unsigned
-_get_method_calling_convention(const ir_type *method) {
-       assert(method && (method->type_op == type_method));
+static inline unsigned _get_method_calling_convention(const ir_type *method)
+{
+       assert(method->type_op == type_method);
        return method->attr.ma.irg_calling_conv;
 }
 
-static INLINE void
-_set_method_calling_convention(ir_type *method, unsigned cc_mask) {
-       assert(method && (method->type_op == type_method));
+static inline void _set_method_calling_convention(ir_type *method, unsigned cc_mask)
+{
+       assert(method->type_op == type_method);
        method->attr.ma.irg_calling_conv = cc_mask;
 }
 
@@ -606,9 +608,6 @@ _set_method_calling_convention(ir_type *method, unsigned cc_mask) {
 #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_ident(tp)                _get_type_ident(tp)
-#define set_type_ident(tp, id)            _set_type_ident(tp, id)
-#define get_type_size_bits(tp)            _get_type_size_bits(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)
@@ -642,7 +641,7 @@ _set_method_calling_convention(ir_type *method, unsigned cc_mask) {
 #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 set_method_additional_property(method, flag)    _set_method_additional_property(method, flag)
+#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)