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   int align;               /**< Alignment of an entity of this type. This should be
 125                                 set according to the source language needs. If not set it's
 126                                 calculated automatically by get_type_alignment().
 127                                 Alignment must be given in bits. */
 128   ir_mode *mode;           /**< The mode for atomic types */
 129   unsigned long visit;     /**< visited counter for walks of the type information */
 130   void *link;              /**< holds temporary data - like in irnode_t.h */
 131   struct dbg_info* dbi;    /**< A pointer to information for debug support. */
 132
 133   /* ------------- fields for analyses ---------------*/
 134
 135 #ifdef DEBUG_libfirm
 136   int nr;             /**< a unique node number for each node to make output
 137                   readable. */
 138   char *c_name;                 /**< since idents are opaque, provide the name in cleartext */
 139 #endif
 140   tp_attr attr;            /* type kind specific fields. This must be the last
 141                   entry in this struct!  Varying size! */
 142 };
 143
 144 /**
 145  *   Creates a new type representation:
 146  *
 147  *   @param type_op - the kind of this type.  May not be type_id.
 148  *   @param mode    - the mode to be used for this type, may be NULL
 149  *   @param name    - an ident for the name of this type.
 150  *   @return a new type of the given type.  The remaining private attributes are not
 151  *   @return initalized.  The type is in state layout_undefined.
 152  *
 153  */
 154 INLINE type *
 155 new_type(tp_op *type_op,
 156      ir_mode *mode,
 157      ident* name);
 158 void free_type_attrs       (type *tp);
 159
 160 INLINE void free_class_entities      (type *clss);
 161 INLINE void free_struct_entities     (type *strct);
 162 INLINE void free_method_entities     (type *method);
 163 INLINE void free_union_entities      (type *uni);
 164 INLINE void free_array_entities      (type *array);
 165 INLINE void free_enumeration_entities(type *enumeration);
 166 INLINE void free_pointer_entities    (type *pointer);
 167 INLINE void free_primitive_entities  (type *primitive);
 168
 169 INLINE void free_class_attrs      (type *clss);
 170 INLINE void free_struct_attrs     (type *strct);
 171 INLINE void free_method_attrs     (type *method);
 172 INLINE void free_union_attrs      (type *uni);
 173 INLINE void free_array_attrs      (type *array);
 174 INLINE void free_enumeration_attrs(type *enumeration);
 175 INLINE void free_pointer_attrs    (type *pointer);
 176 INLINE void free_primitive_attrs  (type *primitive);
 177
 178
 179 /** initialize the type module */
 180 void init_type (void);
 181
 182
 183 /* ------------------- *
 184  *  inline functions   *
 185  * ------------------- */
 186
 187 extern unsigned long type_visited;
 188
 189 static INLINE void __set_master_type_visited(unsigned long val) { type_visited = val; }
 190 static INLINE unsigned long __get_master_type_visited(void)     { return type_visited; }
 191 static INLINE void __inc_master_type_visited(void)              { type_visited++; }
 192
 193 static INLINE void *
 194 __get_type_link(const type *tp) {
 195   assert(tp && tp->kind == k_type);
 196   return(tp -> link);
 197 }
 198
 199 static INLINE void
 200 __set_type_link(type *tp, void *l) {
 201   assert(tp && tp->kind == k_type);
 202   tp -> link = l;
 203 }
 204
 205 static INLINE tp_op*
 206 __get_type_tpop(const type *tp) {
 207   assert(tp && tp->kind == k_type);
 208   return tp->type_op;
 209 }
 210
 211 static INLINE ident*
 212 __get_type_tpop_nameid(const type *tp) {
 213   assert(tp && tp->kind == k_type);
 214   return get_tpop_ident(tp->type_op);
 215 }
 216
 217 static INLINE tp_opcode
 218 __get_type_tpop_code(const type *tp) {
 219   assert(tp && tp->kind == k_type);
 220   return get_tpop_code(tp->type_op);
 221 }
 222
 223 static INLINE ir_mode *
 224 __get_type_mode(const type *tp) {
 225   assert(tp && tp->kind == k_type);
 226   return tp->mode;
 227 }
 228
 229 static INLINE ident *
 230 __get_type_ident(const type *tp) {
 231   assert(tp && tp->kind == k_type);
 232   return tp->name;
 233 }
 234
 235 static INLINE void
 236 __set_type_ident(type *tp, ident* id) {
 237   assert(tp && tp->kind == k_type);
 238   tp->name = id;
 239 }
 240
 241 static INLINE long
 242 __get_type_nr(const type *tp) {
 243   assert(tp);
 244 #ifdef DEBUG_libfirm
 245   return tp->nr;
 246 #else
 247   return (long)tp;
 248 #endif
 249 }
 250
 251 static INLINE int
 252 __get_type_size_bits(const type *tp) {
 253   assert(tp && tp->kind == k_type);
 254   return tp->size;
 255 }
 256
 257 static INLINE int
 258 __get_type_size_bytes(const type *tp) {
 259   int size = __get_type_size_bits(tp);
 260   if (size < 0)
 261     return -1;
 262   if ((size & 7) != 0) {
 263     assert(0 && "cannot take byte size of this type");
 264     return -1;
 265   }
 266   return size >> 3;
 267 }
 268
 269 static INLINE type_state
 270 __get_type_state(const type *tp) {
 271   assert(tp && tp->kind == k_type);
 272   return tp->state;
 273 }
 274
 275 static INLINE unsigned long
 276 __get_type_visited(const type *tp) {
 277   assert(tp && tp->kind == k_type);
 278   return tp->visit;
 279 }
 280
 281 static INLINE void
 282 __set_type_visited(type *tp, unsigned long num) {
 283   assert(tp && tp->kind == k_type);
 284   tp->visit = num;
 285 }
 286
 287 static INLINE void
 288 __mark_type_visited(type *tp) {
 289   assert(tp && tp->kind == k_type);
 290   assert(tp->visit < type_visited);
 291   tp->visit = type_visited;
 292 }
 293
 294 static INLINE int
 295 __type_visited(const type *tp) {
 296   assert(tp && tp->kind == k_type);
 297   return tp->visit >= type_visited;
 298 }
 299
 300 static INLINE int
 301 __type_not_visited(const type *tp) {
 302   assert(tp && tp->kind == k_type);
 303   return tp->visit  < type_visited;
 304 }
 305
 306 static INLINE int
 307 __is_type(const void *thing) {
 308   return (get_kind(thing) == k_type);
 309 }
 310
 311 static INLINE int
 312 __is_class_type(const type *clss) {
 313   assert(clss);
 314   return (clss->type_op == type_class);
 315 }
 316
 317 static INLINE int
 318 __get_class_n_members (const type *clss) {
 319   assert(clss && (clss->type_op == type_class));
 320   return (ARR_LEN (clss->attr.ca.members));
 321 }
 322
 323 static INLINE entity *
 324 __get_class_member   (const type *clss, int pos) {
 325   assert(clss && (clss->type_op == type_class));
 326   assert(pos >= 0 && pos < __get_class_n_members(clss));
 327   return clss->attr.ca.members[pos];
 328 }
 329
 330 static INLINE int
 331 __is_struct_type(const type *strct) {
 332   assert(strct);
 333   return (strct->type_op == type_struct);
 334 }
 335
 336 static INLINE int
 337 __is_method_type(const type *method) {
 338   assert(method);
 339   return (method->type_op == type_method);
 340 }
 341
 342 static INLINE int
 343 __is_union_type(const type *uni) {
 344   assert(uni);
 345   return (uni->type_op == type_union);
 346 }
 347
 348 static INLINE int
 349 __is_array_type(const type *array) {
 350   assert(array);
 351   return (array->type_op == type_array);
 352 }
 353
 354 static INLINE int
 355 __is_enumeration_type(const type *enumeration) {
 356   assert(enumeration);
 357   return (enumeration->type_op == type_enumeration);
 358 }
 359
 360 static INLINE int
 361 __is_pointer_type(const type *pointer) {
 362   assert(pointer);
 363   return (pointer->type_op == type_pointer);
 364 }
 365
 366 /** Returns true if a type is a primitive type. */
 367 static INLINE int
 368 __is_primitive_type(const type *primitive) {
 369   assert(primitive && primitive->kind == k_type);
 370   return (primitive->type_op == type_primitive);
 371 }
 372
 373 static INLINE int
 374 __is_atomic_type(const type *tp) {
 375   assert(tp && tp->kind == k_type);
 376   return (is_primitive_type(tp) || is_pointer_type(tp) ||
 377       is_enumeration_type(tp));
 378 }
 379
 380
 381 #define set_master_type_visited(val)      __set_master_type_visited(val)
 382 #define get_master_type_visited()         __get_master_type_visited()
 383 #define inc_master_type_visited()         __inc_master_type_visited()
 384 #define get_type_link(tp)                 __get_type_link(tp)
 385 #define set_type_link(tp, l)              __set_type_link(tp, l)
 386 #define get_type_tpop(tp)                 __get_type_tpop(tp)
 387 #define get_type_tpop_nameid(tp)          __get_type_tpop_nameid(tp)
 388 #define get_type_tpop_code(tp)            __get_type_tpop_code(tp)
 389 #define get_type_mode(tp)                 __get_type_mode(tp)
 390 #define get_type_ident(tp)                __get_type_ident(tp)
 391 #define set_type_ident(tp, id)            __set_type_ident(tp, id)
 392 #define get_type_nr(tp)                   __get_type_nr(tp)
 393 #define get_type_size(tp)                 __get_type_size(tp)
 394 #define get_type_state(tp)                __get_type_state(tp)
 395 #define get_type_visited(tp)              __get_type_visited(tp)
 396 #define set_type_visited(tp, num)         __set_type_visited(tp, num)
 397 #define mark_type_visited(tp)             __mark_type_visited(tp)
 398 #define type_visited(tp)                  __type_visited(tp)
 399 #define type_not_visited(tp)              __type_not_visited(tp)
 400 #define is_type(thing)                    __is_type(thing)
 401 #define is_class_type(clss)               __is_class_type(clss)
 402 #define get_class_n_members(clss)         __get_class_n_members(clss)
 403 #define get_class_member(clss, pos)       __get_class_member(clss, pos)
 404 #define is_struct_type(strct)             __is_struct_type(strct)
 405 #define is_method_type(method)            __is_method_type(method)
 406 #define is_union_type(uni)                __is_union_type(uni)
 407 #define is_array_type(array)              __is_array_type(array)
 408 #define is_enumeration_type(enumeration)  __is_enumeration_type(enumeration)
 409 #define is_pointer_type(pointer)          __is_pointer_type(pointer)
 410 #define is_primitive_type(primitive)      __is_primitive_type(primitive)
 411 #define is_atomic_type(tp)                __is_atomic_type(tp)
 412
 413 # endif /* _TYPE_T_H_ */