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