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

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Representation of types -- private header.
  23  * @author  Goetz Lindenmaier, Michael Beck
  24  * @see     type.h tpop_t.h tpop.h
  25  */
  26 #ifndef FIRM_TR_TYPE_T_H
  27 #define FIRM_TR_TYPE_T_H
  28
  29 #include <stdbool.h>
  30 #include "typerep.h"
  31 #include "tpop_t.h"
  32 #include "irgraph.h"
  33 #include "firm_common.h"
  34
  35 #include "array.h"
  36
  37 #define set_master_type_visited(val)      _set_master_type_visited(val)
  38 #define get_master_type_visited()         _get_master_type_visited()
  39 #define inc_master_type_visited()         _inc_master_type_visited()
  40 #define get_type_link(tp)                 _get_type_link(tp)
  41 #define set_type_link(tp, l)              _set_type_link(tp, l)
  42 #define get_type_tpop(tp)                 _get_type_tpop(tp)
  43 #define get_type_tpop_nameid(tp)          _get_type_tpop_nameid(tp)
  44 #define get_type_tpop_code(tp)            _get_type_tpop_code(tp)
  45 #define get_type_mode(tp)                 _get_type_mode(tp)
  46 #define get_type_size_bytes(tp)           _get_type_size_bytes(tp)
  47 #define get_type_state(tp)                _get_type_state(tp)
  48 #define get_type_visited(tp)              _get_type_visited(tp)
  49 #define set_type_visited(tp, num)         _set_type_visited(tp, num)
  50 #define mark_type_visited(tp)             _mark_type_visited(tp)
  51 #define type_visited(tp)                  _type_visited(tp)
  52 #define type_not_visited(tp)              _type_not_visited(tp)
  53 #define get_type_dbg_info(tp)             _get_type_dbg_info(tp)
  54 #define set_type_dbg_info(tp, db)         _set_type_dbg_info(tp, db)
  55 #define is_type(thing)                    _is_type(thing)
  56 #define is_Class_type(clss)               _is_class_type(clss)
  57 #define get_class_n_members(clss)         _get_class_n_members(clss)
  58 #define get_class_member(clss, pos)       _get_class_member(clss, pos)
  59 #define get_class_vtable_size(clss)       _get_class_vtable_size(clss)
  60 #define set_class_vtable_size(clss, size) _set_class_vtable_size(clss, size)
  61 #define is_class_final(clss)              _is_class_final(clss)
  62 #define set_class_final(clss, flag)       _set_class_final(clss, flag)
  63 #define is_class_interface(clss)          _is_class_interface(clss)
  64 #define set_class_interface(clss, flag)   _set_class_interface(clss, flag)
  65 #define is_class_abstract(clss)           _is_class_abstract(clss)
  66 #define set_class_abstract(clss, flag)    _set_class_abstract(clss, flag)
  67 #define is_Struct_type(strct)             _is_struct_type(strct)
  68 #define is_Method_type(method)            _is_method_type(method)
  69 #define is_Union_type(uni)                _is_union_type(uni)
  70 #define is_Array_type(array)              _is_array_type(array)
  71 #define is_Enumeration_type(enumeration)  _is_enumeration_type(enumeration)
  72 #define is_Pointer_type(pointer)          _is_pointer_type(pointer)
  73 #define is_Primitive_type(primitive)      _is_primitive_type(primitive)
  74 #define is_atomic_type(tp)                _is_atomic_type(tp)
  75 #define get_method_n_params(method)       _get_method_n_params(method)
  76 #define get_method_n_ress(method)         _get_method_n_ress(method)
  77 #define get_method_additional_properties(method)        _get_method_additional_properties(method)
  78 #define set_method_additional_properties(method, mask)  _set_method_additional_properties(method, mask)
  79 #define add_method_additional_properties(method, flag)  _add_method_additional_properties(method, flag)
  80 #define get_method_calling_convention(method)           _get_method_calling_convention(method)
  81 #define set_method_calling_convention(method, cc_mask)  _set_method_calling_convention(method, cc_mask)
  82
  83 /** Class flags. */
  84 enum class_flags {
  85         cf_none            = 0,  /**< No flags. */
  86         cf_final_class     = 1,  /**< Set if a class is an final class */
  87         cf_interface_class = 2,  /**< Set if a class is an "interface" */
  88         cf_absctract_class = 4,  /**< Set if a class is "abstract" */
  89 };
  90
  91 /** Class type attributes. */
  92 typedef struct {
  93         ir_entity  **members;           /**< Array containing the fields and methods of this class. */
  94         ir_type **subtypes;          /**< Array containing the direct subtypes. */
  95         ir_type **supertypes;        /**< Array containing the direct supertypes */
  96         ir_peculiarity peculiarity;  /**< The peculiarity of this class. */
  97         int      dfn;                /**< A number that can be used for 'instanceof' operator. */
  98         unsigned vtable_size;        /**< The size of the vtable for this class. */
  99         unsigned clss_flags;         /**< Additional class flags. */
 100 } cls_attr;
 101
 102 /** Struct type attributes. */
 103 typedef struct {
 104         ir_entity **members; /**< Fields of this struct. No method entities allowed. */
 105 } stc_attr;
 106
 107 /** A (type, ir_entity) pair. */
 108 typedef struct {
 109         ir_type   *tp;      /**< A type. */
 110         ir_entity *ent;     /**< An ir_entity. */
 111 } tp_ent_pair;
 112
 113 /** Method type attributes. */
 114 typedef struct {
 115         size_t       n_params;          /**< Number of parameters. */
 116         tp_ent_pair *params;            /**< Array of parameter type/value entities pairs. */
 117         size_t       n_res;             /**< Number of results. */
 118         tp_ent_pair *res_type;          /**< Array of result type/value ir_entity pairs. */
 119         ir_variadicity variadicity;     /**< The variadicity of the method. */
 120         mtp_additional_properties properties; /**< Set of additional method properties. */
 121         unsigned irg_calling_conv;      /**< A set of calling convention flags. */
 122 } mtd_attr;
 123
 124 /** Union type attributes. */
 125 typedef struct {
 126         ir_entity **members;    /**< Fields of this union. No method entities allowed. */
 127 } uni_attr;
 128
 129 /** Array type attributes. */
 130 typedef struct {
 131         size_t  n_dimensions;   /**< Number of array dimensions.  */
 132         ir_node **lower_bound;  /**< Lower bounds of dimensions.  Usually all 0. */
 133         ir_node **upper_bound;  /**< Upper bounds or dimensions. */
 134         size_t  *order;         /**< Ordering of dimensions. */
 135         ir_type *element_type;  /**< The type of the array elements. */
 136         ir_entity *element_ent; /**< entity for the array elements, to be used for
 137                                      element selection with a Sel node. */
 138 } arr_attr;
 139
 140 /** An enumerator constant. */
 141 struct ir_enum_const {
 142         ir_tarval  *value;  /**< The constants that represents this enumerator identifier. */
 143         ident   *nameid;    /**< The name of the enumerator identifier. */
 144         ir_type *owner;     /**< owner type of this enumerator constant. */
 145 };
 146
 147 /** Enum type attributes. */
 148 typedef struct {
 149         ir_enum_const *enumer;   /**< Contains all enumerator constants that represent a member
 150                                       of the enum -- enumerators. */
 151 } enm_attr;
 152
 153 /** Pointer type attributes. */
 154 typedef struct {
 155         ir_type *points_to;  /**< The type of the ir_entity the pointer points to. */
 156 } ptr_attr;
 157
 158 /** Primitive type attributes. */
 159 typedef struct {
 160         ir_type *base_type;  /**< For bitfield types: The base primitive type, NULL else. */
 161 } pri_attr;
 162
 163 /** General type attributes. */
 164 typedef union {
 165         cls_attr ca;      /**< Attributes of a class type */
 166         stc_attr sa;      /**< Attributes of a struct type */
 167         mtd_attr ma;      /**< Attributes of a method type */
 168         uni_attr ua;      /**< Attributes of an union type */
 169         arr_attr aa;      /**< Attributes of an array type */
 170         enm_attr ea;      /**< Attributes of an enumeration type */
 171         ptr_attr pa;      /**< Attributes of a pointer type */
 172         pri_attr ba;      /**< Attributes of a primitive bitfield type */
 173 } tp_attr;
 174
 175 /** Additional type flags. */
 176 typedef enum type_flags {
 177         tf_none             = 0, /**< No flags. */
 178         tf_lowered_type     = 1U << 0, /**< Set if this is a lowered type. */
 179         tf_layout_fixed     = 1U << 1, /**< Set if the layout of a type is fixed */
 180
 181         tf_frame_type       = 1U << 2, /**< Set if this is a frame type. */
 182         tf_segment          = 1U << 3, /**< type represents a linker segment */
 183         tf_global_type      = 1U << 4, /**< Set only for the global type */
 184         tf_tls_type         = 1U << 5, /**< Set only for the tls type */
 185         tf_constructors     = 1U << 6, /**< Set only for the constructors segment type */
 186         tf_destructors      = 1U << 7, /**< Set only for the destructors segment type */
 187         tf_variable_size    = 1U << 8, /**< compound or array type may have variable size last element */
 188 } type_flags;
 189 ENUM_BITSET(type_flags)
 190
 191 /**
 192  *  An abstract data type to represent types.
 193  *
 194  *  This is the abstract data type with which any type known in the
 195  *  compiled program can be represented.  This includes types specified
 196  *  in the program as well as types defined by the language.  In the
 197  *  view of the intermediate representation there is no difference
 198  *  between these types.
 199  *
 200  *  There exist several kinds of types, arranged by the structure of
 201  *  the type.  These are distinguished by a type opcode.
 202  *  A type is described by a set of attributes.  Some of these attributes
 203  *  are common to all types, others depend on the kind of the type.
 204  */
 205 struct ir_type {
 206         firm_kind kind;          /**< the firm kind, must be k_type */
 207         const tp_op *type_op;    /**< the type operation of the type */
 208         ident *name;             /**< The name of the type */
 209         ir_visibility visibility;/**< Visibility of entities of this type. */
 210         unsigned flags;          /**< Type flags, a bitmask of enum type_flags. */
 211         unsigned size;           /**< Size of an ir_entity of this type. This is
 212                                       determined when fixing the layout of this
 213                                       class.  Size must be given in bytes. */
 214         unsigned align;          /**< Alignment of an ir_entity of this type. This
 215                                       should be set according to the source
 216                                       language needs. If not set, it's calculated
 217                                       automatically by get_type_alignment().
 218                                       Alignment must be given in bytes. */
 219         ir_mode *mode;           /**< The mode for atomic types */
 220         ir_visited_t visit;      /**< visited counter for walks of the type information */
 221         void *link;              /**< holds temporary data - like in irnode_t.h */
 222         type_dbg_info *dbi;      /**< A pointer to information for debug support. */
 223         ir_type *higher_type;    /**< link to highlevel type in case of lowered
 224                                       types */
 225
 226 #ifdef DEBUG_libfirm
 227         long nr;                 /**< An unique node number for each node to make
 228                                       output readable. */
 229 #endif
 230         tp_attr attr;            /**< Type kind specific fields. This must be the
 231                                       last entry in this struct!  Varying size! */
 232 };
 233
 234 void free_type_entities(ir_type *tp);
 235
 236 void free_class_entities      (ir_type *clss);
 237 void free_struct_entities     (ir_type *strct);
 238 void free_method_entities     (ir_type *method);
 239 void free_union_entities      (ir_type *uni);
 240 void free_array_entities      (ir_type *array);
 241 void free_enumeration_entities(ir_type *enumeration);
 242 void free_pointer_entities    (ir_type *pointer);
 243
 244 void free_array_automatic_entities(ir_type *array);
 245
 246 void free_class_attrs      (ir_type *clss);
 247 void free_struct_attrs     (ir_type *strct);
 248 void free_method_attrs     (ir_type *method);
 249 void free_union_attrs      (ir_type *uni);
 250 void free_array_attrs      (ir_type *array);
 251 void free_enumeration_attrs(ir_type *enumeration);
 252 void free_pointer_attrs    (ir_type *pointer);
 253
 254 void set_class_mode(ir_type *tp, ir_mode *mode);
 255 void set_struct_mode(ir_type *tp, ir_mode *mode);
 256 void set_pointer_mode(ir_type *tp, ir_mode *mode);
 257 void set_primitive_mode(ir_type *tp, ir_mode *mode);
 258 void set_enumeration_mode(ir_type *tp, ir_mode *mode);
 259
 260 void set_class_size(ir_type *tp, unsigned bytes);
 261 void set_struct_size(ir_type *tp, unsigned bytes);
 262 void set_union_size(ir_type *tp, unsigned bytes);
 263 void set_array_size(ir_type *tp, unsigned bytes);
 264 void set_default_size(ir_type *tp, unsigned bytes);
 265
 266 /** Set and get a class' dfn --
 267  * This is an undocumented field, subject to change! */
 268 void set_class_dfn(ir_type *clss, int dfn);
 269 int  get_class_dfn(const ir_type *clss);
 270
 271 void add_compound_member(ir_type *compound, ir_entity *entity);
 272
 273 /** Initialize the type module. */
 274 void ir_init_type(ir_prog *irp);
 275
 276 /** free internal datastructures of type module */
 277 void ir_finish_type(ir_prog *irp);
 278
 279 /** Clone an existing method type.
 280  *
 281  * @param tp      the method type to clone.
 282  * @param prefix  if non-null, will be the prefix for the name of
 283  *                the cloned type
 284  *
 285  * @return the cloned method type.
 286  */
 287 ir_type *clone_type_method(ir_type *tp);
 288
 289 extern ir_visited_t firm_type_visited;
 290
 291 static inline void _set_master_type_visited(ir_visited_t val)
 292 {
 293         firm_type_visited = val;
 294 }
 295
 296 static inline ir_visited_t _get_master_type_visited(void)
 297 {
 298         return firm_type_visited;
 299 }
 300
 301 static inline void _inc_master_type_visited(void)
 302 {
 303         ++firm_type_visited;
 304 }
 305
 306 static inline int is_lowered_type(const ir_type *tp)
 307 {
 308         return tp->flags & tf_lowered_type;
 309 }
 310
 311 static inline ir_type *get_higher_type(const ir_type *tp)
 312 {
 313         return tp->higher_type;
 314 }
 315
 316 static inline void set_higher_type(ir_type *tp, ir_type *higher_type)
 317 {
 318         tp->flags |= tf_lowered_type;
 319         tp->higher_type = higher_type;
 320 }
 321
 322 static inline void *_get_type_link(const ir_type *tp)
 323 {
 324         assert(tp->kind == k_type);
 325         return(tp -> link);
 326 }
 327
 328 static inline void _set_type_link(ir_type *tp, void *l)
 329 {
 330         assert(tp->kind == k_type);
 331         tp -> link = l;
 332 }
 333
 334 static inline const tp_op *_get_type_tpop(const ir_type *tp)
 335 {
 336         assert(tp->kind == k_type);
 337         return tp->type_op;
 338 }
 339
 340 static inline ident *_get_type_tpop_nameid(const ir_type *tp)
 341 {
 342         assert(tp->kind == k_type);
 343         return get_tpop_ident(tp->type_op);
 344 }
 345
 346 static inline tp_opcode _get_type_tpop_code(const ir_type *tp)
 347 {
 348         assert(tp->kind == k_type);
 349         return get_tpop_code(tp->type_op);
 350 }
 351
 352 static inline ir_mode *_get_type_mode(const ir_type *tp)
 353 {
 354         assert(tp->kind == k_type);
 355         return tp->mode;
 356 }
 357
 358 static inline unsigned _get_type_size_bytes(const ir_type *tp)
 359 {
 360         assert(tp->kind == k_type);
 361         return tp->size;
 362 }
 363
 364 static inline ir_type_state _get_type_state(const ir_type *tp)
 365 {
 366         assert(tp->kind == k_type);
 367         return tp->flags & tf_layout_fixed ? layout_fixed : layout_undefined;
 368 }
 369
 370 static inline ir_visited_t _get_type_visited(const ir_type *tp)
 371 {
 372         assert(tp->kind == k_type);
 373         return tp->visit;
 374 }
 375
 376 static inline void _set_type_visited(ir_type *tp, ir_visited_t num)
 377 {
 378         assert(tp->kind == k_type);
 379         tp->visit = num;
 380 }
 381
 382 static inline void _mark_type_visited(ir_type *tp)
 383 {
 384         assert(tp->kind == k_type);
 385         assert(tp->visit < firm_type_visited);
 386         tp->visit = firm_type_visited;
 387 }
 388
 389 static inline int _type_visited(const ir_type *tp)
 390 {
 391         assert(tp->kind == k_type);
 392         return tp->visit >= firm_type_visited;
 393 }
 394
 395 static inline int _type_not_visited(const ir_type *tp)
 396 {
 397         assert(tp->kind == k_type);
 398         return tp->visit  < firm_type_visited;
 399 }
 400
 401 static inline type_dbg_info *_get_type_dbg_info(const ir_type *tp)
 402 {
 403         return tp->dbi;
 404 }
 405
 406 static inline void _set_type_dbg_info(ir_type *tp, type_dbg_info *db)
 407 {
 408         tp->dbi = db;
 409 }
 410
 411 static inline int _is_type(const void *thing)
 412 {
 413         return get_kind(thing) == k_type;
 414 }
 415
 416 static inline int _is_class_type(const ir_type *clss)
 417 {
 418         return clss->type_op == type_class;
 419 }
 420
 421 static inline size_t _get_class_n_members(const ir_type *clss)
 422 {
 423         assert(clss->type_op == type_class);
 424         return ARR_LEN(clss->attr.ca.members);
 425 }
 426
 427 static inline ir_entity *_get_class_member(const ir_type *clss, size_t pos)
 428 {
 429         assert(clss->type_op == type_class);
 430         assert(pos < _get_class_n_members(clss));
 431         return clss->attr.ca.members[pos];
 432 }
 433
 434 static inline unsigned _get_class_vtable_size(const ir_type *clss)
 435 {
 436         assert(clss->type_op == type_class);
 437         return clss->attr.ca.vtable_size;
 438 }
 439
 440 static inline void _set_class_vtable_size(ir_type *clss, unsigned vtable_size)
 441 {
 442         assert(clss->type_op == type_class);
 443         clss->attr.ca.vtable_size = vtable_size;
 444 }
 445
 446 static inline int _is_class_final(const ir_type *clss)
 447 {
 448         assert(clss->type_op == type_class);
 449         return clss->attr.ca.clss_flags & cf_final_class;
 450 }
 451
 452 static inline void _set_class_final(ir_type *clss, int final)
 453 {
 454         assert(clss->type_op == type_class);
 455         if (final)
 456                 clss->attr.ca.clss_flags |= cf_final_class;
 457         else
 458                 clss->attr.ca.clss_flags &= ~cf_final_class;
 459 }
 460
 461 static inline int _is_class_interface(const ir_type *clss)
 462 {
 463         assert(clss->type_op == type_class);
 464         return clss->attr.ca.clss_flags & cf_interface_class;
 465 }
 466
 467 static inline void _set_class_interface(ir_type *clss, int final)
 468 {
 469         assert(clss->type_op == type_class);
 470         if (final)
 471                 clss->attr.ca.clss_flags |= cf_interface_class;
 472         else
 473                 clss->attr.ca.clss_flags &= ~cf_interface_class;
 474 }
 475
 476 static inline int _is_class_abstract(const ir_type *clss)
 477 {
 478         assert(clss->type_op == type_class);
 479         return clss->attr.ca.clss_flags & cf_absctract_class;
 480 }
 481
 482 static inline void _set_class_abstract(ir_type *clss, int final)
 483 {
 484         assert(clss->type_op == type_class);
 485         if (final)
 486                 clss->attr.ca.clss_flags |= cf_absctract_class;
 487         else
 488                 clss->attr.ca.clss_flags &= ~cf_absctract_class;
 489 }
 490
 491 static inline int _is_struct_type(const ir_type *strct)
 492 {
 493         return (strct->type_op == type_struct);
 494 }
 495
 496 static inline int _is_method_type(const ir_type *method)
 497 {
 498         return (method->type_op == type_method);
 499 }
 500
 501 static inline int _is_union_type(const ir_type *uni)
 502 {
 503         return (uni->type_op == type_union);
 504 }
 505
 506 static inline int _is_array_type(const ir_type *array)
 507 {
 508         return (array->type_op == type_array);
 509 }
 510
 511 static inline int _is_enumeration_type(const ir_type *enumeration)
 512 {
 513         return (enumeration->type_op == type_enumeration);
 514 }
 515
 516 static inline int _is_pointer_type(const ir_type *pointer)
 517 {
 518         return (pointer->type_op == type_pointer);
 519 }
 520
 521 /** Returns true if a type is a primitive type. */
 522 static inline int _is_primitive_type(const ir_type *primitive)
 523 {
 524         assert(primitive->kind == k_type);
 525         return (primitive->type_op == type_primitive);
 526 }
 527
 528 static inline int _is_atomic_type(const ir_type *tp)
 529 {
 530         assert(tp->kind == k_type);
 531         return (_is_primitive_type(tp) || _is_pointer_type(tp) ||
 532                 _is_enumeration_type(tp));
 533 }
 534
 535 static inline size_t _get_method_n_params(const ir_type *method)
 536 {
 537         assert(method->type_op == type_method);
 538         return method->attr.ma.n_params;
 539 }
 540
 541 static inline size_t _get_method_n_ress(const ir_type *method)
 542 {
 543         assert(method->type_op == type_method);
 544         return method->attr.ma.n_res;
 545 }
 546
 547 static inline mtp_additional_properties _get_method_additional_properties(const ir_type *method)
 548 {
 549         assert(method->type_op == type_method);
 550         return method->attr.ma.properties;
 551 }
 552
 553 static inline void _set_method_additional_properties(ir_type *method, mtp_additional_properties properties)
 554 {
 555         assert(method->type_op == type_method);
 556         method->attr.ma.properties = properties;
 557 }
 558
 559 static inline void _add_method_additional_properties(ir_type *method, mtp_additional_properties properties)
 560 {
 561         assert(method->type_op == type_method);
 562         method->attr.ma.properties |= properties;
 563 }
 564
 565 static inline unsigned _get_method_calling_convention(const ir_type *method)
 566 {
 567         assert(method->type_op == type_method);
 568         return method->attr.ma.irg_calling_conv;
 569 }
 570
 571 static inline void _set_method_calling_convention(ir_type *method, unsigned cc_mask)
 572 {
 573         assert(method->type_op == type_method);
 574         method->attr.ma.irg_calling_conv = cc_mask;
 575 }
 576
 577 ir_type *new_type_segment(ident *name, type_flags flags);
 578
 579 #endif /* FIRM_TR_TYPE_T_H */