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: Michael Beck
   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 _FIRM_TR_TYPE_T_H_
  14 #define _FIRM_TR_TYPE_T_H_
  15
  16 #include "firm_config.h"
  17 #include "type.h"
  18 #include "tpop_t.h"
  19 #include "irgraph.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 flags. */
  32 enum class_flags {
  33   cf_none            = 0,  /**< No flags. */
  34   cf_final_class     = 1,  /**< Set if a class is an final class */
  35   cf_interface_class = 2,  /**< Set if a class is an "interface" */
  36   cf_absctract_class = 4,  /**< Set if a class is "abstract" */
  37 };
  38
  39 /** Class attributes. */
  40 typedef struct {
  41   entity  **members;        /**< Array containing the fields and methods of this class. */
  42   ir_type **subtypes;       /**< Array containing the direct subtypes. */
  43   ir_type **supertypes;     /**< Array containing the direct supertypes */
  44   peculiarity peculiarity;  /**< The peculiarity of this class. */
  45   entity  *type_info;       /**< An entity representing this class, used for type info. */
  46   int     dfn;              /**< A number that can be used for 'instanceof' operator. */
  47   unsigned vtable_size;     /**< The size of the vtable for this class. */
  48   unsigned clss_flags;      /**< Additional class flags. */
  49 } cls_attr;
  50
  51 /** struct attributes */
  52 typedef struct {
  53   entity **members;    /**< Fields of this struct. No method entities allowed. */
  54 } stc_attr;
  55
  56 /** A (type, entity) pair */
  57 typedef struct {
  58   ir_type *tp;         /**< A type. */
  59   entity  *ent;        /**< An entity. */
  60 } tp_ent_pair;
  61
  62 /** method attributes */
  63 typedef struct {
  64   int n_params;                   /**< Number of parameters. */
  65   tp_ent_pair *param_type;        /**< Array of parameter type/value entities pairs. */
  66   ir_type *value_params;          /**< A type whose entities represent copied value arguments. */
  67   int n_res;                      /**< Number of results. */
  68   tp_ent_pair *res_type;          /**< Array of result type/value entity pairs. */
  69   ir_type *value_ress;            /**< A type whose entities represent copied value results. */
  70   variadicity variadicity;        /**< The variadicity of the method. */
  71   int first_variadic_param;       /**< The index of the first variadic parameter or -1 if non-variadic .*/
  72   unsigned additional_properties; /**< Set of additional method properties. */
  73   unsigned irg_calling_conv;      /**< A set of calling convention flags. */
  74 } mtd_attr;
  75
  76 /** union attributes */
  77 typedef struct {
  78   entity **members;    /**< Fields of this union. No method entities allowed. */
  79 } uni_attr;
  80
  81 /** array attributes */
  82 typedef struct {
  83   int   n_dimensions;     /**< Number of array dimensions.  */
  84   ir_node **lower_bound;  /**< Lower bounds of dimensions.  Usually all 0. */
  85   ir_node **upper_bound;  /**< Upper bounds or dimensions. */
  86   int *order;             /**< Ordering of dimensions. */
  87   ir_type *element_type;  /**< The type of the array elements. */
  88   entity *element_ent;    /**< Entity for the array elements, to be used for
  89                                element selection with Sel. */
  90 } arr_attr;
  91
  92 /** enum attributes */
  93 typedef struct {
  94   int      n_enums;    /**< Number of enumerators. */
  95   tarval **enumer;     /**< Contains all constants that represent a member
  96                           of the enum -- enumerators. */
  97   ident  **enum_nameid;/**< Contains the names of the enum fields as specified by
  98                           the source program. */
  99 } enm_attr;
 100
 101 /** pointer attributes */
 102 typedef struct {
 103   ir_type *points_to;  /**< The type of the entity the pointer points to. */
 104 } ptr_attr;
 105
 106 /*
 107 typedef struct {   * No private attr yet! *
 108 } pri_attr; */
 109
 110
 111 /*
 112 typedef struct {        * No private attr, must be smaller than others! *
 113 } id_attr;
 114 */
 115
 116 /** General type attributes. */
 117 typedef union {
 118   cls_attr ca;      /**< Attributes of a class type */
 119   stc_attr sa;      /**< Attributes of a struct type */
 120   mtd_attr ma;      /**< Attributes of a method type */
 121   uni_attr ua;      /**< Attributes of an union type */
 122   arr_attr aa;      /**< Attributes of an array type */
 123   enm_attr ea;      /**< Attributes of an enumeration type */
 124   ptr_attr pa;      /**< Attributes of a pointer type */
 125 } tp_attr;
 126
 127 /** Additional type flags. */
 128 enum type_flags {
 129   tf_none             = 0,  /**< No flags. */
 130   tf_frame_type       = 1,  /**< Set if this is a frame type. */
 131   tf_value_param_type = 2,  /**< Set if this is a value param type. */
 132   tf_lowered_type     = 4,  /**< Set if this is a lowered type. */
 133   tf_layout_fixed     = 8   /**< Set if the layout of a type is fixed */
 134 };
 135
 136 /** the structure of a type */
 137 struct ir_type {
 138   firm_kind kind;          /**< the firm kind, must be k_type */
 139   const tp_op *type_op;    /**< the type operation of the type */
 140   ident *name;             /**< The name of the type */
 141   visibility visibility;   /**< Visibility of entities of this type. */
 142   unsigned flags;          /**< Type flags, a bitmask of enum type_flags. */
 143   int size;                /**< Size of an entity of this type. This is determined
 144                                 when fixing the layout of this class.  Size must be
 145                                 given in bits. */
 146   int align;               /**< Alignment of an entity of this type. This should be
 147                                 set according to the source language needs. If not set it's
 148                                 calculated automatically by get_type_alignment().
 149                                 Alignment must be given in bits. */
 150   ir_mode *mode;           /**< The mode for atomic types */
 151   unsigned long visit;     /**< visited counter for walks of the type information */
 152   void *link;              /**< holds temporary data - like in irnode_t.h */
 153   struct dbg_info *dbi;    /**< A pointer to information for debug support. */
 154   ir_type *assoc_type;     /**< The associated lowered/unlowered type */
 155
 156   /* ------------- fields for analyses ---------------*/
 157
 158 #ifdef DEBUG_libfirm
 159   long nr;                 /**< An unique node number for each node to make output
 160                                 readable. */
 161 #endif
 162   tp_attr attr;            /**< Type kind specific fields. This must be the last
 163                                 entry in this struct!  Varying size! */
 164 };
 165
 166 /**
 167  *   Creates a new type representation:
 168  *
 169  *   @param type_op  the kind of this type.  May not be type_id.
 170  *   @param mode     the mode to be used for this type, may be NULL
 171  *   @param name     an ident for the name of this type.
 172  *   @param db       debug info
 173  *
 174  *   @return A new type of the given type.  The remaining private attributes are not
 175  *           initialized.  The type is in state layout_undefined.
 176  */
 177 ir_type *
 178 new_type(tp_op *type_op, ir_mode *mode, ident *name, dbg_info *db);
 179 void free_type_attrs       (ir_type *tp);
 180
 181 void free_class_entities      (ir_type *clss);
 182 void free_struct_entities     (ir_type *strct);
 183 void free_method_entities     (ir_type *method);
 184 void free_union_entities      (ir_type *uni);
 185 void free_array_entities      (ir_type *array);
 186 void free_enumeration_entities(ir_type *enumeration);
 187 void free_pointer_entities    (ir_type *pointer);
 188
 189 void free_array_automatic_entities(ir_type *array);
 190
 191 void free_class_attrs      (ir_type *clss);
 192 void free_struct_attrs     (ir_type *strct);
 193 void free_method_attrs     (ir_type *method);
 194 void free_union_attrs      (ir_type *uni);
 195 void free_array_attrs      (ir_type *array);
 196 void free_enumeration_attrs(ir_type *enumeration);
 197 void free_pointer_attrs    (ir_type *pointer);
 198
 199 void set_class_mode(ir_type *tp, ir_mode *mode);
 200 void set_struct_mode(ir_type *tp, ir_mode *mode);
 201 void set_pointer_mode(ir_type *tp, ir_mode *mode);
 202 void set_primitive_mode(ir_type *tp, ir_mode *mode);
 203 void set_enumeration_mode(ir_type *tp, ir_mode *mode);
 204
 205 void set_class_size_bits(ir_type *tp, int bits);
 206 void set_struct_size_bits(ir_type *tp, int bits);
 207 void set_union_size_bits(ir_type *tp, int bits);
 208 void set_array_size_bits(ir_type *tp, int size);
 209 void set_default_size_bits(ir_type *tp, int size);
 210
 211 /**
 212  * Initialize the type module.
 213  *
 214  * @param builtin_db       debug info for built-in objects
 215  * @param default_cc_mask  default calling conventions for methods
 216  */
 217 void firm_init_type(dbg_info *builtin_db, unsigned default_cc_mask);
 218
 219
 220 /* ------------------- *
 221  *  inline functions   *
 222  * ------------------- */
 223
 224 extern unsigned long firm_type_visited;
 225
 226 static INLINE void _set_master_type_visited(unsigned long val) { firm_type_visited = val; }
 227 static INLINE unsigned long _get_master_type_visited(void)     { return firm_type_visited; }
 228 static INLINE void _inc_master_type_visited(void)              { ++firm_type_visited; }
 229
 230 static INLINE void *
 231 _get_type_link(const ir_type *tp) {
 232   assert(tp && tp->kind == k_type);
 233   return(tp -> link);
 234 }
 235
 236 static INLINE void
 237 _set_type_link(ir_type *tp, void *l) {
 238   assert(tp && tp->kind == k_type);
 239   tp -> link = l;
 240 }
 241
 242 static INLINE const tp_op*
 243 _get_type_tpop(const ir_type *tp) {
 244   assert(tp && tp->kind == k_type);
 245   return tp->type_op;
 246 }
 247
 248 static INLINE ident*
 249 _get_type_tpop_nameid(const ir_type *tp) {
 250   assert(tp && tp->kind == k_type);
 251   return get_tpop_ident(tp->type_op);
 252 }
 253
 254 static INLINE tp_opcode
 255 _get_type_tpop_code(const ir_type *tp) {
 256   assert(tp && tp->kind == k_type);
 257   return get_tpop_code(tp->type_op);
 258 }
 259
 260 static INLINE ir_mode *
 261 _get_type_mode(const ir_type *tp) {
 262   assert(tp && tp->kind == k_type);
 263   return tp->mode;
 264 }
 265
 266 static INLINE ident *
 267 _get_type_ident(const ir_type *tp) {
 268   assert(tp && tp->kind == k_type);
 269   return tp->name;
 270 }
 271
 272 static INLINE void
 273 _set_type_ident(ir_type *tp, ident* id) {
 274   assert(tp && tp->kind == k_type);
 275   tp->name = id;
 276 }
 277
 278 static INLINE int
 279 _get_type_size_bits(const ir_type *tp) {
 280   assert(tp && tp->kind == k_type);
 281   return tp->size;
 282 }
 283
 284 static INLINE int
 285 _get_type_size_bytes(const ir_type *tp) {
 286   int size = _get_type_size_bits(tp);
 287   if (size < 0)
 288     return -1;
 289   if ((size & 7) != 0) {
 290     assert(0 && "cannot take byte size of this type");
 291     return -1;
 292   }
 293   return size >> 3;
 294 }
 295
 296 static INLINE type_state
 297 _get_type_state(const ir_type *tp) {
 298   assert(tp && tp->kind == k_type);
 299   return tp->flags & tf_layout_fixed ? layout_fixed : layout_undefined;
 300 }
 301
 302 static INLINE unsigned long
 303 _get_type_visited(const ir_type *tp) {
 304   assert(tp && tp->kind == k_type);
 305   return tp->visit;
 306 }
 307
 308 static INLINE void
 309 _set_type_visited(ir_type *tp, unsigned long num) {
 310   assert(tp && tp->kind == k_type);
 311   tp->visit = num;
 312 }
 313
 314 static INLINE void
 315 _mark_type_visited(ir_type *tp) {
 316   assert(tp && tp->kind == k_type);
 317   assert(tp->visit < firm_type_visited);
 318   tp->visit = firm_type_visited;
 319 }
 320
 321 static INLINE int
 322 _type_visited(const ir_type *tp) {
 323   assert(tp && tp->kind == k_type);
 324   return tp->visit >= firm_type_visited;
 325 }
 326
 327 static INLINE int
 328 _type_not_visited(const ir_type *tp) {
 329   assert(tp && tp->kind == k_type);
 330   return tp->visit  < firm_type_visited;
 331 }
 332
 333 static INLINE int
 334 _is_type(const void *thing) {
 335   return (get_kind(thing) == k_type);
 336 }
 337
 338 static INLINE int
 339 _is_class_type(const ir_type *clss) {
 340   assert(clss);
 341   return (clss->type_op == type_class);
 342 }
 343
 344 static INLINE int
 345 _get_class_n_members (const ir_type *clss) {
 346   assert(clss && (clss->type_op == type_class));
 347   return (ARR_LEN (clss->attr.ca.members));
 348 }
 349
 350 static INLINE entity *
 351 _get_class_member   (const ir_type *clss, int pos) {
 352   assert(clss && (clss->type_op == type_class));
 353   assert(pos >= 0 && pos < _get_class_n_members(clss));
 354   return clss->attr.ca.members[pos];
 355 }
 356
 357 static INLINE unsigned
 358 _get_class_vtable_size(const ir_type *clss) {
 359   assert(clss && (clss->type_op == type_class));
 360   return clss->attr.ca.vtable_size;
 361 }
 362
 363 static INLINE void
 364 _set_class_vtable_size(ir_type *clss, unsigned vtable_size) {
 365   assert(clss && (clss->type_op == type_class));
 366   clss->attr.ca.vtable_size = vtable_size;
 367 }
 368
 369 static INLINE int
 370 _is_class_final(const ir_type *clss) {
 371   assert(clss && (clss->type_op == type_class));
 372   return clss->attr.ca.clss_flags & cf_final_class;
 373 }
 374
 375 static INLINE void
 376 _set_class_final(ir_type *clss, int final) {
 377   assert(clss && (clss->type_op == type_class));
 378   if (final)
 379     clss->attr.ca.clss_flags |= cf_final_class;
 380   else
 381     clss->attr.ca.clss_flags &= ~cf_final_class;
 382 }
 383
 384 static INLINE int
 385 _is_class_interface(const ir_type *clss) {
 386   assert(clss && (clss->type_op == type_class));
 387   return clss->attr.ca.clss_flags & cf_interface_class;
 388 }
 389
 390 static INLINE void
 391 _set_class_interface(ir_type *clss, int final) {
 392   assert(clss && (clss->type_op == type_class));
 393   if (final)
 394     clss->attr.ca.clss_flags |= cf_interface_class;
 395   else
 396     clss->attr.ca.clss_flags &= ~cf_interface_class;
 397 }
 398
 399 static INLINE int
 400 _is_class_abstract(const ir_type *clss) {
 401   assert(clss && (clss->type_op == type_class));
 402   return clss->attr.ca.clss_flags & cf_absctract_class;
 403 }
 404
 405 static INLINE void
 406 _set_class_abstract(ir_type *clss, int final) {
 407   assert(clss && (clss->type_op == type_class));
 408   if (final)
 409     clss->attr.ca.clss_flags |= cf_absctract_class;
 410   else
 411     clss->attr.ca.clss_flags &= ~cf_absctract_class;
 412 }
 413
 414 static INLINE int
 415 _is_struct_type(const ir_type *strct) {
 416   assert(strct);
 417   return (strct->type_op == type_struct);
 418 }
 419
 420 static INLINE int
 421 _is_method_type(const ir_type *method) {
 422   assert(method);
 423   return (method->type_op == type_method);
 424 }
 425
 426 static INLINE int
 427 _is_union_type(const ir_type *uni) {
 428   assert(uni);
 429   return (uni->type_op == type_union);
 430 }
 431
 432 static INLINE int
 433 _is_array_type(const ir_type *array) {
 434   assert(array);
 435   return (array->type_op == type_array);
 436 }
 437
 438 static INLINE int
 439 _is_enumeration_type(const ir_type *enumeration) {
 440   assert(enumeration);
 441   return (enumeration->type_op == type_enumeration);
 442 }
 443
 444 static INLINE int
 445 _is_pointer_type(const ir_type *pointer) {
 446   assert(pointer);
 447   return (pointer->type_op == type_pointer);
 448 }
 449
 450 /** Returns true if a type is a primitive type. */
 451 static INLINE int
 452 _is_primitive_type(const ir_type *primitive) {
 453   assert(primitive && primitive->kind == k_type);
 454   return (primitive->type_op == type_primitive);
 455 }
 456
 457 static INLINE int
 458 _is_atomic_type(const ir_type *tp) {
 459   assert(tp && tp->kind == k_type);
 460   return (_is_primitive_type(tp) || _is_pointer_type(tp) ||
 461       _is_enumeration_type(tp));
 462 }
 463
 464 static INLINE int
 465 _get_method_n_params(const ir_type *method) {
 466   assert(method && (method->type_op == type_method));
 467   return method->attr.ma.n_params;
 468 }
 469
 470 static INLINE int
 471 _get_method_n_ress(const ir_type *method) {
 472   assert(method && (method->type_op == type_method));
 473   return method->attr.ma.n_res;
 474 }
 475
 476 static INLINE unsigned
 477 _get_method_additional_properties(const ir_type *method) {
 478   assert(method && (method->type_op == type_method));
 479   return method->attr.ma.additional_properties;
 480 }
 481
 482 static INLINE void
 483 _set_method_additional_properties(ir_type *method, unsigned mask) {
 484   assert(method && (method->type_op == type_method));
 485
 486   /* do not allow to set the mtp_property_inherited flag or
 487    * the automatic inheritance of flags will not work */
 488   method->attr.ma.additional_properties = mask & ~mtp_property_inherited;
 489 }
 490
 491 static INLINE void
 492 _set_method_additional_property(ir_type *method, mtp_additional_property flag) {
 493   assert(method && (method->type_op == type_method));
 494
 495   /* do not allow to set the mtp_property_inherited flag or
 496    * the automatic inheritance of flags will not work */
 497   method->attr.ma.additional_properties |= flag & ~mtp_property_inherited;
 498 }
 499
 500 static INLINE unsigned
 501 _get_method_calling_convention(const ir_type *method) {
 502   assert(method && (method->type_op == type_method));
 503   return method->attr.ma.irg_calling_conv;
 504 }
 505
 506 static INLINE void
 507 _set_method_calling_convention(ir_type *method, unsigned cc_mask) {
 508   assert(method && (method->type_op == type_method));
 509   method->attr.ma.irg_calling_conv = cc_mask;
 510 }
 511
 512 #define set_master_type_visited(val)      _set_master_type_visited(val)
 513 #define get_master_type_visited()         _get_master_type_visited()
 514 #define inc_master_type_visited()         _inc_master_type_visited()
 515 #define get_type_link(tp)                 _get_type_link(tp)
 516 #define set_type_link(tp, l)              _set_type_link(tp, l)
 517 #define get_type_tpop(tp)                 _get_type_tpop(tp)
 518 #define get_type_tpop_nameid(tp)          _get_type_tpop_nameid(tp)
 519 #define get_type_tpop_code(tp)            _get_type_tpop_code(tp)
 520 #define get_type_mode(tp)                 _get_type_mode(tp)
 521 #define get_type_ident(tp)                _get_type_ident(tp)
 522 #define set_type_ident(tp, id)            _set_type_ident(tp, id)
 523 #define get_type_size_bits(tp)            _get_type_size_bits(tp)
 524 #define get_type_size_bytes(tp)           _get_type_size_bytes(tp)
 525 #define get_type_state(tp)                _get_type_state(tp)
 526 #define get_type_visited(tp)              _get_type_visited(tp)
 527 #define set_type_visited(tp, num)         _set_type_visited(tp, num)
 528 #define mark_type_visited(tp)             _mark_type_visited(tp)
 529 #define type_visited(tp)                  _type_visited(tp)
 530 #define type_not_visited(tp)              _type_not_visited(tp)
 531 #define is_type(thing)                    _is_type(thing)
 532 #define is_Class_type(clss)               _is_class_type(clss)
 533 #define get_class_n_members(clss)         _get_class_n_members(clss)
 534 #define get_class_member(clss, pos)       _get_class_member(clss, pos)
 535 #define get_class_vtable_size(clss)       _get_class_vtable_size(clss)
 536 #define set_class_vtable_size(clss, size) _set_class_vtable_size(clss, size)
 537 #define is_class_final(clss)              _is_class_final(clss)
 538 #define set_class_final(clss, flag)       _set_class_final(clss, flag)
 539 #define is_class_interface(clss)          _is_class_interface(clss)
 540 #define set_class_interface(clss, flag)   _set_class_interface(clss, flag)
 541 #define is_class_abstract(clss)           _is_class_abstract(clss)
 542 #define set_class_abstract(clss, flag)    _set_class_abstract(clss, flag)
 543 #define is_Struct_type(strct)             _is_struct_type(strct)
 544 #define is_Method_type(method)            _is_method_type(method)
 545 #define is_Union_type(uni)                _is_union_type(uni)
 546 #define is_Array_type(array)              _is_array_type(array)
 547 #define is_Enumeration_type(enumeration)  _is_enumeration_type(enumeration)
 548 #define is_Pointer_type(pointer)          _is_pointer_type(pointer)
 549 #define is_Primitive_type(primitive)      _is_primitive_type(primitive)
 550 #define is_atomic_type(tp)                _is_atomic_type(tp)
 551 #define get_method_n_params(method)       _get_method_n_params(method)
 552 #define get_method_n_ress(method)         _get_method_n_ress(method)
 553 #define get_method_additional_properties(method)        _get_method_additional_properties(method)
 554 #define set_method_additional_properties(method, mask)  _set_method_additional_properties(method, mask)
 555 #define set_method_additional_property(method, flag)    _set_method_additional_property(method, flag)
 556 #define get_method_calling_convention(method)           _get_method_calling_convention(method)
 557 #define set_method_calling_convention(method, cc_mask)  _set_method_calling_convention(method, cc_mask)
 558
 559 #endif /* _FIRM_TR_TYPE_T_H_ */