nsz Git - libfirm/blob - ir/tr/type_t.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/tr/type_t.h
   4  * Purpose:     Representation of types -- private header.
   5  * Author:      Goetz Lindenmaier
   6  * Modified by:
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 2001-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 # ifndef _TYPE_T_H_
  14 # define _TYPE_T_H_
  15 # ifdef HAVE_CONFIG_H
  16 # include "config.h"
  17 # endif
  18 # include "type.h"
  19 # include "tpop_t.h"
  20
  21 # include "array.h"
  22
  23 /**
  24  * @file type_t.h
  25  * This file contains the datatypes hidden in type.h.
  26  *
  27  * @author Goetz Lindenmaier
  28  * @see  type.h tpop_t.h tpop.h
  29  */
  30
  31 /** class attributes */
  32 typedef struct {
  33   entity **members;    /**< fields and methods of this class */
  34   type   **subtypes;   /**< direct subtypes */
  35   type   **supertypes; /**< direct supertypes */
  36   peculiarity peculiarity;
  37   int dfn;             /**< number used for 'instanceof' operator */
  38 } cls_attr;
  39
  40 /** struct attributs */
  41 typedef struct {
  42   entity **members;    /**< fields of this struct. No method entities
  43                           allowed. */
  44 } stc_attr;
  45
  46 /** method attributes */
  47 typedef struct {
  48   int n_params;              /**< number of parameters */
  49   type **param_type;         /**< code generation needs this information. */
  50   type *value_params;        /**< A type whose entities represent copied value arguments. */
  51   int n_res;                 /**< number of results */
  52   type **res_type;           /**< array with result types */
  53   type *value_ress;          /**< A type whose entities represent copied value results. */
  54   variadicity variadicity;   /**< variadicity of the method. */
  55   int first_variadic_param;  /**< index of the first variadic param or -1 if non-variadic .*/
  56 } mtd_attr;
  57
  58 /** union attributs */
  59 typedef struct {
  60   int     n_types;
  61   /* type  **unioned_type; * a list of unioned types. */
  62   /* ident **delim_names;  * names of the union delimiters. */
  63   entity **members;    /**< fields of this union. No method entities
  64                           allowed.  */
  65
  66 } uni_attr;
  67
  68 /** array attributs */
  69 typedef struct {
  70   int   n_dimensions;  /**< Number of array dimensions.  */
  71   ir_node **lower_bound;   /**< Lower bounds of dimensions.  Usually all 0. */
  72   ir_node **upper_bound;   /**< Upper bounds or dimensions. */
  73   int *order;              /**< Ordering of dimensions. */
  74   type *element_type;  /**< The type of the array elements. */
  75   entity *element_ent; /**< Entity for the array elements, to be used for
  76                           element selection with Sel. */
  77 } arr_attr;
  78
  79 /** enum attributs */
  80 typedef struct {
  81   int      n_enums;    /**< Number of enumerators. */
  82   tarval **enumer;     /**< Contains all constants that represent a member
  83                           of the enum -- enumerators. */
  84   ident  **enum_nameid;/**< Contains the names of the enum fields as specified by
  85                           the source program */
  86 } enm_attr;
  87
  88 /** pointer attributs */
  89 typedef struct {
  90   type *points_to;     /**< The type of the enitity the pointer points to. */
  91 } ptr_attr;
  92
  93 /*
  94 typedef struct {   * No private attr yet! *
  95 } pri_attr; */
  96
  97
  98 /*
  99 typedef struct {        * No private attr, must be smaller than others! *
 100 } id_attr;
 101 */
 102
 103 /** General type attributs. */
 104 typedef union {
 105   cls_attr ca;          /**< attributes of a class type */
 106   stc_attr sa;          /**< attributes of a struct type */
 107   mtd_attr ma;          /**< attributes of a method type */
 108   uni_attr ua;          /**< attributes of an union type */
 109   arr_attr aa;          /**< attributes of an array type */
 110   enm_attr ea;          /**< attributes of an enumeration type */
 111   ptr_attr pa;          /**< attributes of a pointer type */
 112 } tp_attr;
 113
 114 /** the structure of a type */
 115 struct type {
 116   firm_kind kind;
 117   tp_op *type_op;
 118   ident *name;
 119   type_state state;        /**< Represents the types state: layout undefined or
 120                               fixed. */
 121   int size;                /**< Size of an entity of this type. This is determined
 122                               when fixing the layout of this class.  Size must be
 123                               given in bits. */
 124   ir_mode *mode;           /**< The mode for atomic types */
 125   unsigned long visit;     /**< visited counter for walks of the type information */
 126   void *link;              /**< holds temporary data - like in irnode_t.h */
 127   struct dbg_info* dbi;    /**< A pointer to information for debug support. */
 128
 129 #ifdef DEBUG_libfirm
 130   int nr;             /**< a unique node number for each node to make output
 131                               readable. */
 132 #endif
 133   tp_attr attr;            /* type kind specific fields. This must be the last
 134                               entry in this struct!  Varying size! */
 135 };
 136
 137 /**
 138  *   Creates a new type representation:
 139  *
 140  *   @param type_op - the kind of this type.  May not be type_id.
 141  *   @param mode    - the mode to be used for this type, may be NULL
 142  *   @param name    - an ident for the name of this type.
 143  *   @return a new type of the given type.  The remaining private attributes are not
 144  *   @return initalized.  The type is in state layout_undefined.
 145  *
 146  */
 147 INLINE type *
 148 new_type(tp_op *type_op,
 149          ir_mode *mode,
 150          ident* name);
 151 void free_type_attrs       (type *tp);
 152
 153 INLINE void free_class_entities      (type *clss);
 154 INLINE void free_struct_entities     (type *strct);
 155 INLINE void free_method_entities     (type *method);
 156 INLINE void free_union_entities      (type *uni);
 157 INLINE void free_array_entities      (type *array);
 158 INLINE void free_enumeration_entities(type *enumeration);
 159 INLINE void free_pointer_entities    (type *pointer);
 160 INLINE void free_primitive_entities  (type *primitive);
 161
 162 INLINE void free_class_attrs      (type *clss);
 163 INLINE void free_struct_attrs     (type *strct);
 164 INLINE void free_method_attrs     (type *method);
 165 INLINE void free_union_attrs      (type *uni);
 166 INLINE void free_array_attrs      (type *array);
 167 INLINE void free_enumeration_attrs(type *enumeration);
 168 INLINE void free_pointer_attrs    (type *pointer);
 169 INLINE void free_primitive_attrs  (type *primitive);
 170
 171
 172 /** initialize the type module */
 173 void init_type (void);
 174
 175
 176 /* ------------------- *
 177  *  inline functions   *
 178  * ------------------- */
 179
 180 extern unsigned long type_visited;
 181
 182 static INLINE void __set_master_type_visited(unsigned long val) { type_visited = val; }
 183 static INLINE unsigned long __get_master_type_visited(void)     { return type_visited; }
 184 static INLINE void __inc_master_type_visited(void)              { type_visited++; }
 185
 186 static INLINE void *
 187 __get_type_link(type *tp) {
 188   assert(tp && tp->kind == k_type);
 189   return(tp -> link);
 190 }
 191
 192 static INLINE void
 193 __set_type_link(type *tp, void *l) {
 194   assert(tp && tp->kind == k_type);
 195   tp -> link = l;
 196 }
 197
 198 static INLINE tp_op*
 199 __get_type_tpop(type *tp) {
 200   assert(tp && tp->kind == k_type);
 201   return tp->type_op;
 202 }
 203
 204 static INLINE ident*
 205 __get_type_tpop_nameid(type *tp) {
 206   assert(tp && tp->kind == k_type);
 207   return get_tpop_ident(tp->type_op);
 208 }
 209
 210 static INLINE tp_opcode
 211 __get_type_tpop_code(type *tp) {
 212   assert(tp && tp->kind == k_type);
 213   return get_tpop_code(tp->type_op);
 214 }
 215
 216 static INLINE ir_mode *
 217 __get_type_mode(type *tp) {
 218   assert(tp && tp->kind == k_type);
 219   return tp->mode;
 220 }
 221
 222 static INLINE ident *
 223 __get_type_ident(type *tp) {
 224   assert(tp && tp->kind == k_type);
 225   return tp->name;
 226 }
 227
 228 static INLINE void
 229 __set_type_ident(type *tp, ident* id) {
 230   assert(tp && tp->kind == k_type);
 231   tp->name = id;
 232 }
 233
 234 static INLINE long
 235 __get_type_nr(type *tp) {
 236   assert(tp);
 237 #ifdef DEBUG_libfirm
 238   return tp->nr;
 239 #else
 240   return (long)tp;
 241 #endif
 242 }
 243
 244 static INLINE int
 245 __get_type_size_bits(type *tp) {
 246   assert(tp && tp->kind == k_type);
 247   return tp->size;
 248 }
 249
 250 static INLINE int
 251 __get_type_size_bytes(type *tp) {
 252   int size = __get_type_size_bits(tp);
 253   if (size < 0)
 254     return -1;
 255   if ((size & 7) != 0) {
 256     assert(0 && "cannot take byte size of this type");
 257     return -1;
 258   }
 259   return size >> 3;
 260 }
 261
 262 static INLINE type_state
 263 __get_type_state(type *tp) {
 264   assert(tp && tp->kind == k_type);
 265   return tp->state;
 266 }
 267
 268 static INLINE unsigned long
 269 __get_type_visited(type *tp) {
 270   assert(tp && tp->kind == k_type);
 271   return tp->visit;
 272 }
 273
 274 static INLINE void
 275 __set_type_visited(type *tp, unsigned long num) {
 276   assert(tp && tp->kind == k_type);
 277   tp->visit = num;
 278 }
 279
 280 static INLINE void
 281 __mark_type_visited(type *tp) {
 282   assert(tp && tp->kind == k_type);
 283   assert(tp->visit < type_visited);
 284   tp->visit = type_visited;
 285 }
 286
 287 static INLINE int
 288 __type_visited(type *tp) {
 289   assert(tp && tp->kind == k_type);
 290   return tp->visit >= type_visited;
 291 }
 292
 293 static INLINE int
 294 __type_not_visited(type *tp) {
 295   assert(tp && tp->kind == k_type);
 296   return tp->visit  < type_visited;
 297 }
 298
 299 static INLINE int
 300 __is_type(void *thing) {
 301   return (get_kind(thing) == k_type);
 302 }
 303
 304 static INLINE int
 305 __is_class_type(type *clss) {
 306   assert(clss);
 307   return (clss->type_op == type_class);
 308 }
 309
 310 static INLINE int
 311 __get_class_n_members (type *clss) {
 312   assert(clss && (clss->type_op == type_class));
 313   return (ARR_LEN (clss->attr.ca.members));
 314 }
 315
 316 static INLINE entity *
 317 __get_class_member   (type *clss, int pos) {
 318   assert(clss && (clss->type_op == type_class));
 319   assert(pos >= 0 && pos < get_class_n_members(clss));
 320   return clss->attr.ca.members[pos];
 321 }
 322
 323 static INLINE int
 324 __is_struct_type(type *strct) {
 325   assert(strct);
 326   return (strct->type_op == type_struct);
 327 }
 328
 329 static INLINE int
 330 __is_method_type(type *method) {
 331   assert(method);
 332   return (method->type_op == type_method);
 333 }
 334
 335 static INLINE int
 336 __is_union_type(type *uni) {
 337   assert(uni);
 338   return (uni->type_op == type_union);
 339 }
 340
 341 static INLINE int
 342 __is_array_type(type *array) {
 343   assert(array);
 344   return (array->type_op == type_array);
 345 }
 346
 347 static INLINE int
 348 __is_enumeration_type(type *enumeration) {
 349   assert(enumeration);
 350   return (enumeration->type_op == type_enumeration);
 351 }
 352
 353 static INLINE int
 354 __is_pointer_type(type *pointer) {
 355   assert(pointer);
 356   return (pointer->type_op == type_pointer);
 357 }
 358
 359 /** Returns true if a type is a primitive type. */
 360 static INLINE int
 361 __is_primitive_type(type *primitive) {
 362   assert(primitive && primitive->kind == k_type);
 363   return (primitive->type_op == type_primitive);
 364 }
 365
 366 static INLINE int
 367 __is_atomic_type(type *tp) {
 368   assert(tp && tp->kind == k_type);
 369   return (is_primitive_type(tp) || is_pointer_type(tp) ||
 370           is_enumeration_type(tp));
 371 }
 372
 373
 374 #define set_master_type_visited(val)      __set_master_type_visited(val)
 375 #define get_master_type_visited()         __get_master_type_visited()
 376 #define inc_master_type_visited()         __inc_master_type_visited()
 377 #define get_type_link(tp)                 __get_type_link(tp)
 378 #define set_type_link(tp, l)              __set_type_link(tp, l)
 379 #define get_type_tpop(tp)                 __get_type_tpop(tp)
 380 #define get_type_tpop_nameid(tp)          __get_type_tpop_nameid(tp)
 381 #define get_type_tpop_code(tp)            __get_type_tpop_code(tp)
 382 #define get_type_mode(tp)                 __get_type_mode(tp)
 383 #define get_type_ident(tp)                __get_type_ident(tp)
 384 #define set_type_ident(tp, id)            __set_type_ident(tp, id)
 385 #define get_type_nr(tp)                   __get_type_nr(tp)
 386 #define get_type_size(tp)                 __get_type_size(tp)
 387 #define get_type_state(tp)                __get_type_state(tp)
 388 #define get_type_visited(tp)              __get_type_visited(tp)
 389 #define set_type_visited(tp, num)         __set_type_visited(tp, num)
 390 #define mark_type_visited(tp)             __mark_type_visited(tp)
 391 #define type_visited(tp)                  __type_visited(tp)
 392 #define type_not_visited(tp)              __type_not_visited(tp)
 393 #define is_type(thing)                    __is_type(thing)
 394 #define is_class_type(clss)               __is_class_type(clss)
 395 #define get_class_n_members(clss)         __get_class_n_members(clss)
 396 #define get_class_member(clss, pos)       __get_class_member(clss, pos)
 397 #define is_struct_type(strct)             __is_struct_type(strct)
 398 #define is_method_type(method)            __is_method_type(method)
 399 #define is_union_type(uni)                __is_union_type(uni)
 400 #define is_array_type(array)              __is_array_type(array)
 401 #define is_enumeration_type(enumeration)  __is_enumeration_type(enumeration)
 402 #define is_pointer_type(pointer)          __is_pointer_type(pointer)
 403 #define is_primitive_type(primitive)      __is_primitive_type(primitive)
 404 #define is_atomic_type(tp)                __is_atomic_type(tp)
 405
 406 # endif /* _TYPE_T_H_ */