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