include/llvm/Type.h

   1 //===-- llvm/Type.h - Classes for handling data types -----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the declaration of the Type class.  For more "Type" type
  11 // stuff, look in DerivedTypes.h.
  12 //
  13 // Note that instances of the Type class are immutable: once they are created,
  14 // they are never changed.  Also note that only one instance of a particular
  15 // type is ever created.  Thus seeing if two types are equal is a matter of
  16 // doing a trivial pointer comparison.
  17 //
  18 // Types, once allocated, are never free'd, unless they are an abstract type
  19 // that is resolved to a more concrete type.
  20 //
  21 // Opaque types are simple derived types with no state.  There may be many
  22 // different Opaque type objects floating around, but two are only considered
  23 // identical if they are pointer equals of each other.  This allows us to have
  24 // two opaque types that end up resolving to different concrete types later.
  25 //
  26 // Opaque types are also kinda wierd and scary and different because they have
  27 // to keep a list of uses of the type.  When, through linking, parsing, or
  28 // bytecode reading, they become resolved, they need to find and update all
  29 // users of the unknown type, causing them to reference a new, more concrete
  30 // type.  Opaque types are deleted when their use list dwindles to zero users.
  31 //
  32 //===----------------------------------------------------------------------===//
  33
  34 #ifndef LLVM_TYPE_H
  35 #define LLVM_TYPE_H
  36
  37 #include "AbstractTypeUser.h"
  38 #include "llvm/Support/Casting.h"
  39 #include "llvm/ADT/GraphTraits.h"
  40 #include "llvm/ADT/iterator"
  41 #include <vector>
  42
  43 namespace llvm {
  44
  45 class ArrayType;
  46 class DerivedType;
  47 class FunctionType;
  48 class OpaqueType;
  49 class PointerType;
  50 class StructType;
  51 class PackedType;
  52
  53 class Type {
  54 public:
  55   ///===-------------------------------------------------------------------===//
  56   /// Definitions of all of the base types for the Type system.  Based on this
  57   /// value, you can cast to a "DerivedType" subclass (see DerivedTypes.h)
  58   /// Note: If you add an element to this, you need to add an element to the
  59   /// Type::getPrimitiveType function, or else things will break!
  60   ///
  61   enum TypeID {
  62     // PrimitiveTypes .. make sure LastPrimitiveTyID stays up to date
  63     VoidTyID = 0  , BoolTyID,           //  0, 1: Basics...
  64     UByteTyID     , SByteTyID,          //  2, 3: 8 bit types...
  65     UShortTyID    , ShortTyID,          //  4, 5: 16 bit types...
  66     UIntTyID      , IntTyID,            //  6, 7: 32 bit types...
  67     ULongTyID     , LongTyID,           //  8, 9: 64 bit types...
  68     FloatTyID     , DoubleTyID,         // 10,11: Floating point types...
  69     LabelTyID     ,                     // 12   : Labels...
  70
  71     // Derived types... see DerivedTypes.h file...
  72     // Make sure FirstDerivedTyID stays up to date!!!
  73     FunctionTyID  , StructTyID,         // Functions... Structs...
  74     ArrayTyID     , PointerTyID,        // Array... pointer...
  75     OpaqueTyID,                         // Opaque type instances...
  76     PackedTyID,                         // SIMD 'packed' format...
  77     //...
  78
  79     NumTypeIDs,                         // Must remain as last defined ID
  80     LastPrimitiveTyID = LabelTyID,
  81     FirstDerivedTyID = FunctionTyID,
  82   };
  83
  84 private:
  85   TypeID   ID : 8;    // The current base type of this type.
  86   bool     Abstract;  // True if type contains an OpaqueType
  87
  88   /// RefCount - This counts the number of PATypeHolders that are pointing to
  89   /// this type.  When this number falls to zero, if the type is abstract and
  90   /// has no AbstractTypeUsers, the type is deleted.  This is only sensical for
  91   /// derived types.
  92   ///
  93   mutable unsigned RefCount;
  94
  95   const Type *getForwardedTypeInternal() const;
  96 protected:
  97   Type(const std::string& Name, TypeID id);
  98   virtual ~Type() {}
  99
 100   /// Types can become nonabstract later, if they are refined.
 101   ///
 102   inline void setAbstract(bool Val) { Abstract = Val; }
 103
 104   // PromoteAbstractToConcrete - This is an internal method used to calculate
 105   // change "Abstract" from true to false when types are refined.
 106   void PromoteAbstractToConcrete();
 107
 108   unsigned getRefCount() const { return RefCount; }
 109
 110   /// ForwardType - This field is used to implement the union find scheme for
 111   /// abstract types.  When types are refined to other types, this field is set
 112   /// to the more refined type.  Only abstract types can be forwarded.
 113   mutable const Type *ForwardType;
 114
 115   /// ContainedTys - The list of types contained by this one.  For example, this
 116   /// includes the arguments of a function type, the elements of the structure,
 117   /// the pointee of a pointer, etc.  Note that keeping this vector in the Type
 118   /// class wastes some space for types that do not contain anything (such as
 119   /// primitive types).  However, keeping it here allows the subtype_* members
 120   /// to be implemented MUCH more efficiently, and dynamically very few types do
 121   /// not contain any elements (most are derived).
 122   std::vector<PATypeHandle> ContainedTys;
 123
 124 public:
 125   virtual void print(std::ostream &O) const;
 126
 127   /// @brief Debugging support: print to stderr
 128   virtual void dump() const;
 129
 130   //===--------------------------------------------------------------------===//
 131   // Property accessors for dealing with types... Some of these virtual methods
 132   // are defined in private classes defined in Type.cpp for primitive types.
 133   //
 134
 135   /// getTypeID - Return the type id for the type.  This will return one
 136   /// of the TypeID enum elements defined above.
 137   ///
 138   inline TypeID getTypeID() const { return ID; }
 139
 140   /// getDescription - Return the string representation of the type...
 141   const std::string &getDescription() const;
 142
 143   /// isSigned - Return whether an integral numeric type is signed.  This is
 144   /// true for SByteTy, ShortTy, IntTy, LongTy.  Note that this is not true for
 145   /// Float and Double.
 146   ///
 147   bool isSigned() const {
 148     return ID == SByteTyID || ID == ShortTyID ||
 149            ID == IntTyID || ID == LongTyID;
 150   }
 151
 152   /// isUnsigned - Return whether a numeric type is unsigned.  This is not quite
 153   /// the complement of isSigned... nonnumeric types return false as they do
 154   /// with isSigned.  This returns true for UByteTy, UShortTy, UIntTy, and
 155   /// ULongTy
 156   ///
 157   bool isUnsigned() const {
 158     return ID == UByteTyID || ID == UShortTyID ||
 159            ID == UIntTyID || ID == ULongTyID;
 160   }
 161
 162   /// isInteger - Equivalent to isSigned() || isUnsigned()
 163   ///
 164   bool isInteger() const { return ID >= UByteTyID && ID <= LongTyID; }
 165
 166   /// isIntegral - Returns true if this is an integral type, which is either
 167   /// BoolTy or one of the Integer types.
 168   ///
 169   bool isIntegral() const { return isInteger() || this == BoolTy; }
 170
 171   /// isFloatingPoint - Return true if this is one of the two floating point
 172   /// types
 173   bool isFloatingPoint() const { return ID == FloatTyID || ID == DoubleTyID; }
 174
 175   /// isAbstract - True if the type is either an Opaque type, or is a derived
 176   /// type that includes an opaque type somewhere in it.
 177   ///
 178   inline bool isAbstract() const { return Abstract; }
 179
 180   /// isLosslesslyConvertibleTo - Return true if this type can be converted to
 181   /// 'Ty' without any reinterpretation of bits.  For example, uint to int.
 182   ///
 183   bool isLosslesslyConvertibleTo(const Type *Ty) const;
 184
 185
 186   /// Here are some useful little methods to query what type derived types are
 187   /// Note that all other types can just compare to see if this == Type::xxxTy;
 188   ///
 189   inline bool isPrimitiveType() const { return ID <= LastPrimitiveTyID; }
 190   inline bool isDerivedType()   const { return ID >= FirstDerivedTyID; }
 191
 192   /// isFirstClassType - Return true if the value is holdable in a register.
 193   ///
 194   inline bool isFirstClassType() const {
 195     return (ID != VoidTyID && ID <= LastPrimitiveTyID) ||
 196             ID == PointerTyID || ID == PackedTyID;
 197   }
 198
 199   /// isSized - Return true if it makes sense to take the size of this type.  To
 200   /// get the actual size for a particular target, it is reasonable to use the
 201   /// TargetData subsystem to do this.
 202   ///
 203   bool isSized() const {
 204     return (ID >= BoolTyID && ID <= DoubleTyID) || ID == PointerTyID ||
 205            isSizedDerivedType();
 206   }
 207
 208   /// getPrimitiveSize - Return the basic size of this type if it is a primitive
 209   /// type.  These are fixed by LLVM and are not target dependent.  This will
 210   /// return zero if the type does not have a size or is not a primitive type.
 211   ///
 212   unsigned getPrimitiveSize() const;
 213
 214   /// getUnsignedVersion - If this is an integer type, return the unsigned
 215   /// variant of this type.  For example int -> uint.
 216   const Type *getUnsignedVersion() const;
 217
 218   /// getSignedVersion - If this is an integer type, return the signed variant
 219   /// of this type.  For example uint -> int.
 220   const Type *getSignedVersion() const;
 221
 222   /// getForwaredType - Return the type that this type has been resolved to if
 223   /// it has been resolved to anything.  This is used to implement the
 224   /// union-find algorithm for type resolution, and shouldn't be used by general
 225   /// purpose clients.
 226   const Type *getForwardedType() const {
 227     if (!ForwardType) return 0;
 228     return getForwardedTypeInternal();
 229   }
 230
 231   //===--------------------------------------------------------------------===//
 232   // Type Iteration support
 233   //
 234   typedef std::vector<PATypeHandle>::const_iterator subtype_iterator;
 235   subtype_iterator subtype_begin() const { return ContainedTys.begin(); }
 236   subtype_iterator subtype_end() const { return ContainedTys.end(); }
 237
 238   /// getContainedType - This method is used to implement the type iterator
 239   /// (defined a the end of the file).  For derived types, this returns the
 240   /// types 'contained' in the derived type.
 241   ///
 242   const Type *getContainedType(unsigned i) const {
 243     assert(i < ContainedTys.size() && "Index out of range!");
 244     return ContainedTys[i];
 245   }
 246
 247   /// getNumContainedTypes - Return the number of types in the derived type.
 248   ///
 249   typedef std::vector<PATypeHandle>::size_type size_type;
 250   size_type getNumContainedTypes() const { return ContainedTys.size(); }
 251
 252   //===--------------------------------------------------------------------===//
 253   // Static members exported by the Type class itself.  Useful for getting
 254   // instances of Type.
 255   //
 256
 257   /// getPrimitiveType - Return a type based on an identifier.
 258   static const Type *getPrimitiveType(TypeID IDNumber);
 259
 260   //===--------------------------------------------------------------------===//
 261   // These are the builtin types that are always available...
 262   //
 263   static Type *VoidTy , *BoolTy;
 264   static Type *SByteTy, *UByteTy,
 265               *ShortTy, *UShortTy,
 266               *IntTy  , *UIntTy,
 267               *LongTy , *ULongTy;
 268   static Type *FloatTy, *DoubleTy;
 269
 270   static Type* LabelTy;
 271
 272   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 273   static inline bool classof(const Type *T) { return true; }
 274
 275 #include "llvm/Type.def"
 276
 277   // Virtual methods used by callbacks below.  These should only be implemented
 278   // in the DerivedType class.
 279   virtual void addAbstractTypeUser(AbstractTypeUser *U) const {
 280     abort(); // Only on derived types!
 281   }
 282   virtual void removeAbstractTypeUser(AbstractTypeUser *U) const {
 283     abort(); // Only on derived types!
 284   }
 285
 286   void addRef() const {
 287     assert(isAbstract() && "Cannot add a reference to a non-abstract type!");
 288     ++RefCount;
 289   }
 290
 291   void dropRef() const {
 292     assert(isAbstract() && "Cannot drop a reference to a non-abstract type!");
 293     assert(RefCount && "No objects are currently referencing this object!");
 294
 295     // If this is the last PATypeHolder using this object, and there are no
 296     // PATypeHandles using it, the type is dead, delete it now.
 297     if (--RefCount == 0)
 298       RefCountIsZero();
 299   }
 300
 301   /// clearAllTypeMaps - This method frees all internal memory used by the
 302   /// type subsystem, which can be used in environments where this memory is
 303   /// otherwise reported as a leak.
 304   static void clearAllTypeMaps();
 305
 306 private:
 307   /// isSizedDerivedType - Derived types like structures and arrays are sized
 308   /// iff all of the members of the type are sized as well.  Since asking for
 309   /// their size is relatively uncommon, move this operation out of line.
 310   bool isSizedDerivedType() const;
 311
 312   virtual void RefCountIsZero() const {
 313     abort(); // only on derived types!
 314   }
 315
 316 };
 317
 318 //===----------------------------------------------------------------------===//
 319 // Define some inline methods for the AbstractTypeUser.h:PATypeHandle class.
 320 // These are defined here because they MUST be inlined, yet are dependent on
 321 // the definition of the Type class.  Of course Type derives from Value, which
 322 // contains an AbstractTypeUser instance, so there is no good way to factor out
 323 // the code.  Hence this bit of uglyness.
 324 //
 325 // In the long term, Type should not derive from Value, allowing
 326 // AbstractTypeUser.h to #include Type.h, allowing us to eliminate this
 327 // nastyness entirely.
 328 //
 329 inline void PATypeHandle::addUser() {
 330   assert(Ty && "Type Handle has a null type!");
 331   if (Ty->isAbstract())
 332     Ty->addAbstractTypeUser(User);
 333 }
 334 inline void PATypeHandle::removeUser() {
 335   if (Ty->isAbstract())
 336     Ty->removeAbstractTypeUser(User);
 337 }
 338
 339 inline void PATypeHandle::removeUserFromConcrete() {
 340   if (!Ty->isAbstract())
 341     Ty->removeAbstractTypeUser(User);
 342 }
 343
 344 // Define inline methods for PATypeHolder...
 345
 346 inline void PATypeHolder::addRef() {
 347   if (Ty->isAbstract())
 348     Ty->addRef();
 349 }
 350
 351 inline void PATypeHolder::dropRef() {
 352   if (Ty->isAbstract())
 353     Ty->dropRef();
 354 }
 355
 356 /// get - This implements the forwarding part of the union-find algorithm for
 357 /// abstract types.  Before every access to the Type*, we check to see if the
 358 /// type we are pointing to is forwarding to a new type.  If so, we drop our
 359 /// reference to the type.
 360 ///
 361 inline Type* PATypeHolder::get() const {
 362   const Type *NewTy = Ty->getForwardedType();
 363   if (!NewTy) return const_cast<Type*>(Ty);
 364   return *const_cast<PATypeHolder*>(this) = NewTy;
 365 }
 366
 367
 368
 369 //===----------------------------------------------------------------------===//
 370 // Provide specializations of GraphTraits to be able to treat a type as a
 371 // graph of sub types...
 372
 373 template <> struct GraphTraits<Type*> {
 374   typedef Type NodeType;
 375   typedef Type::subtype_iterator ChildIteratorType;
 376
 377   static inline NodeType *getEntryNode(Type *T) { return T; }
 378   static inline ChildIteratorType child_begin(NodeType *N) {
 379     return N->subtype_begin();
 380   }
 381   static inline ChildIteratorType child_end(NodeType *N) {
 382     return N->subtype_end();
 383   }
 384 };
 385
 386 template <> struct GraphTraits<const Type*> {
 387   typedef const Type NodeType;
 388   typedef Type::subtype_iterator ChildIteratorType;
 389
 390   static inline NodeType *getEntryNode(const Type *T) { return T; }
 391   static inline ChildIteratorType child_begin(NodeType *N) {
 392     return N->subtype_begin();
 393   }
 394   static inline ChildIteratorType child_end(NodeType *N) {
 395     return N->subtype_end();
 396   }
 397 };
 398
 399 template <> inline bool isa_impl<PointerType, Type>(const Type &Ty) {
 400   return Ty.getTypeID() == Type::PointerTyID;
 401 }
 402
 403 std::ostream &operator<<(std::ostream &OS, const Type &T);
 404
 405 } // End llvm namespace
 406
 407 #endif