include/llvm/DerivedTypes.h

   1 //===-- llvm/DerivedTypes.h - Classes for handling data types ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the declarations of classes that represent "derived
  11 // types".  These are things like "arrays of x" or "structure of x, y, z" or
  12 // "function returning x taking (y,z) as parameters", etc...
  13 //
  14 // The implementations of these classes live in the Type.cpp file.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_DERIVED_TYPES_H
  19 #define LLVM_DERIVED_TYPES_H
  20
  21 #include "llvm/Type.h"
  22 #include "llvm/Support/DataTypes.h"
  23
  24 namespace llvm {
  25
  26 class Value;
  27 class APInt;
  28 class LLVMContext;
  29 template<typename T> class ArrayRef;
  30 class StringRef;
  31
  32 /// Class to represent integer types. Note that this class is also used to
  33 /// represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and
  34 /// Int64Ty.
  35 /// @brief Integer representation type
  36 class IntegerType : public Type {
  37   friend class LLVMContextImpl;
  38
  39 protected:
  40   explicit IntegerType(LLVMContext &C, unsigned NumBits) : Type(C, IntegerTyID){
  41     setSubclassData(NumBits);
  42   }
  43 public:
  44   /// This enum is just used to hold constants we need for IntegerType.
  45   enum {
  46     MIN_INT_BITS = 1,        ///< Minimum number of bits that can be specified
  47     MAX_INT_BITS = (1<<23)-1 ///< Maximum number of bits that can be specified
  48       ///< Note that bit width is stored in the Type classes SubclassData field
  49       ///< which has 23 bits. This yields a maximum bit width of 8,388,607 bits.
  50   };
  51
  52   /// This static method is the primary way of constructing an IntegerType.
  53   /// If an IntegerType with the same NumBits value was previously instantiated,
  54   /// that instance will be returned. Otherwise a new one will be created. Only
  55   /// one instance with a given NumBits value is ever created.
  56   /// @brief Get or create an IntegerType instance.
  57   static IntegerType *get(LLVMContext &C, unsigned NumBits);
  58
  59   /// @brief Get the number of bits in this IntegerType
  60   unsigned getBitWidth() const { return getSubclassData(); }
  61
  62   /// getBitMask - Return a bitmask with ones set for all of the bits
  63   /// that can be set by an unsigned version of this type.  This is 0xFF for
  64   /// i8, 0xFFFF for i16, etc.
  65   uint64_t getBitMask() const {
  66     return ~uint64_t(0UL) >> (64-getBitWidth());
  67   }
  68
  69   /// getSignBit - Return a uint64_t with just the most significant bit set (the
  70   /// sign bit, if the value is treated as a signed number).
  71   uint64_t getSignBit() const {
  72     return 1ULL << (getBitWidth()-1);
  73   }
  74
  75   /// For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.
  76   /// @returns a bit mask with ones set for all the bits of this type.
  77   /// @brief Get a bit mask for this type.
  78   APInt getMask() const;
  79
  80   /// This method determines if the width of this IntegerType is a power-of-2
  81   /// in terms of 8 bit bytes.
  82   /// @returns true if this is a power-of-2 byte width.
  83   /// @brief Is this a power-of-2 byte-width IntegerType ?
  84   bool isPowerOf2ByteWidth() const;
  85
  86   // Methods for support type inquiry through isa, cast, and dyn_cast.
  87   static inline bool classof(const IntegerType *) { return true; }
  88   static inline bool classof(const Type *T) {
  89     return T->getTypeID() == IntegerTyID;
  90   }
  91 };
  92
  93
  94 /// FunctionType - Class to represent function types
  95 ///
  96 class FunctionType : public Type {
  97   FunctionType(const FunctionType &);                   // Do not implement
  98   const FunctionType &operator=(const FunctionType &);  // Do not implement
  99   FunctionType(const Type *Result, ArrayRef<Type*> Params, bool IsVarArgs);
 100
 101 public:
 102   /// FunctionType::get - This static method is the primary way of constructing
 103   /// a FunctionType.
 104   ///
 105   static FunctionType *get(const Type *Result,
 106                            ArrayRef<Type*> Params, bool isVarArg);
 107
 108   /// FunctionType::get - Create a FunctionType taking no parameters.
 109   ///
 110   static FunctionType *get(const Type *Result, bool isVarArg);
 111
 112   /// isValidReturnType - Return true if the specified type is valid as a return
 113   /// type.
 114   static bool isValidReturnType(const Type *RetTy);
 115
 116   /// isValidArgumentType - Return true if the specified type is valid as an
 117   /// argument type.
 118   static bool isValidArgumentType(const Type *ArgTy);
 119
 120   bool isVarArg() const { return getSubclassData(); }
 121   Type *getReturnType() const { return ContainedTys[0]; }
 122
 123   typedef Type::subtype_iterator param_iterator;
 124   param_iterator param_begin() const { return ContainedTys + 1; }
 125   param_iterator param_end() const { return &ContainedTys[NumContainedTys]; }
 126
 127   // Parameter type accessors.
 128   Type *getParamType(unsigned i) const { return ContainedTys[i+1]; }
 129
 130   /// getNumParams - Return the number of fixed parameters this function type
 131   /// requires.  This does not consider varargs.
 132   ///
 133   unsigned getNumParams() const { return NumContainedTys - 1; }
 134
 135   // Methods for support type inquiry through isa, cast, and dyn_cast.
 136   static inline bool classof(const FunctionType *) { return true; }
 137   static inline bool classof(const Type *T) {
 138     return T->getTypeID() == FunctionTyID;
 139   }
 140 };
 141
 142
 143 /// CompositeType - Common super class of ArrayType, StructType, PointerType
 144 /// and VectorType.
 145 class CompositeType : public Type {
 146 protected:
 147   explicit CompositeType(LLVMContext &C, TypeID tid) : Type(C, tid) { }
 148 public:
 149
 150   /// getTypeAtIndex - Given an index value into the type, return the type of
 151   /// the element.
 152   ///
 153   Type *getTypeAtIndex(const Value *V) const;
 154   Type *getTypeAtIndex(unsigned Idx) const;
 155   bool indexValid(const Value *V) const;
 156   bool indexValid(unsigned Idx) const;
 157
 158   // Methods for support type inquiry through isa, cast, and dyn_cast.
 159   static inline bool classof(const CompositeType *) { return true; }
 160   static inline bool classof(const Type *T) {
 161     return T->getTypeID() == ArrayTyID ||
 162            T->getTypeID() == StructTyID ||
 163            T->getTypeID() == PointerTyID ||
 164            T->getTypeID() == VectorTyID;
 165   }
 166 };
 167
 168
 169 /// StructType - Class to represent struct types, both normal and packed.
 170 /// Besides being optionally packed, structs can be either "anonymous" or may
 171 /// have an identity.  Anonymous structs are uniqued by structural equivalence,
 172 /// but types are each unique when created, and optionally have a name.
 173 ///
 174 class StructType : public CompositeType {
 175   StructType(const StructType &);                   // Do not implement
 176   const StructType &operator=(const StructType &);  // Do not implement
 177   StructType(LLVMContext &C)
 178     : CompositeType(C, StructTyID), SymbolTableEntry(0) {}
 179   enum {
 180     // This is the contents of the SubClassData field.
 181     SCDB_HasBody = 1,
 182     SCDB_Packed = 2,
 183     SCDB_IsAnonymous = 4
 184   };
 185
 186   /// SymbolTableEntry - For a named struct that actually has a name, this is a
 187   /// pointer to the symbol table entry (maintained by LLVMContext) for the
 188   /// struct.  This is null if the type is an anonymous struct or if it is
 189   /// a named type that has an empty name.
 190   ///
 191   void *SymbolTableEntry;
 192 public:
 193   /// StructType::createNamed - This creates a named struct with no body
 194   /// specified.  If the name is empty, it creates an unnamed struct, which has
 195   /// a unique identity but no actual name.
 196   static StructType *createNamed(LLVMContext &Context, StringRef Name);
 197
 198   static StructType *createNamed(StringRef Name, ArrayRef<Type*> Elements,
 199                                  bool isPacked = false);
 200   static StructType *createNamed(LLVMContext &Context, StringRef Name,
 201                                  ArrayRef<Type*> Elements,
 202                                  bool isPacked = false);
 203   static StructType *createNamed(StringRef Name, Type *elt1, ...) END_WITH_NULL;
 204
 205   /// StructType::get - This static method is the primary way to create a
 206   /// StructType.
 207   static StructType *get(LLVMContext &Context, ArrayRef<Type*> Elements,
 208                          bool isPacked = false);
 209
 210   /// StructType::get - Create an empty structure type.
 211   ///
 212   static StructType *get(LLVMContext &Context, bool isPacked = false);
 213
 214   /// StructType::get - This static method is a convenience method for creating
 215   /// structure types by specifying the elements as arguments.  Note that this
 216   /// method always returns a non-packed struct, and requires at least one
 217   /// element type.
 218   static StructType *get(Type *elt1, ...) END_WITH_NULL;
 219
 220   bool isPacked() const { return (getSubclassData() & SCDB_Packed) != 0; }
 221
 222   /// isAnonymous - Return true if this type is uniqued by structural
 223   /// equivalence, false if it has an identity.
 224   bool isAnonymous() const {return (getSubclassData() & SCDB_IsAnonymous) != 0;}
 225
 226   /// isOpaque - Return true if this is a type with an identity that has no body
 227   /// specified yet.  These prints as 'opaque' in .ll files.
 228   bool isOpaque() const { return (getSubclassData() & SCDB_HasBody) == 0; }
 229
 230   /// hasName - Return true if this is a named struct that has a non-empty name.
 231   bool hasName() const { return SymbolTableEntry != 0; }
 232
 233   /// getName - Return the name for this struct type if it has an identity.
 234   /// This may return an empty string for an unnamed struct type.  Do not call
 235   /// this on an anonymous type.
 236   StringRef getName() const;
 237
 238   /// setName - Change the name of this type to the specified name, or to a name
 239   /// with a suffix if there is a collision.  Do not call this on an anonymous
 240   /// type.
 241   void setName(StringRef Name);
 242
 243   /// setBody - Specify a body for an opaque type.
 244   void setBody(ArrayRef<Type*> Elements, bool isPacked = false);
 245   void setBody(Type *elt1, ...) END_WITH_NULL;
 246
 247   /// isValidElementType - Return true if the specified type is valid as a
 248   /// element type.
 249   static bool isValidElementType(const Type *ElemTy);
 250
 251
 252   // Iterator access to the elements.
 253   typedef Type::subtype_iterator element_iterator;
 254   element_iterator element_begin() const { return ContainedTys; }
 255   element_iterator element_end() const { return &ContainedTys[NumContainedTys];}
 256
 257   /// isLayoutIdentical - Return true if this is layout identical to the
 258   /// specified struct.
 259   bool isLayoutIdentical(const StructType *Other) const;
 260
 261   // Random access to the elements
 262   unsigned getNumElements() const { return NumContainedTys; }
 263   Type *getElementType(unsigned N) const {
 264     assert(N < NumContainedTys && "Element number out of range!");
 265     return ContainedTys[N];
 266   }
 267
 268   // Methods for support type inquiry through isa, cast, and dyn_cast.
 269   static inline bool classof(const StructType *) { return true; }
 270   static inline bool classof(const Type *T) {
 271     return T->getTypeID() == StructTyID;
 272   }
 273 };
 274
 275 /// SequentialType - This is the superclass of the array, pointer and vector
 276 /// type classes.  All of these represent "arrays" in memory.  The array type
 277 /// represents a specifically sized array, pointer types are unsized/unknown
 278 /// size arrays, vector types represent specifically sized arrays that
 279 /// allow for use of SIMD instructions.  SequentialType holds the common
 280 /// features of all, which stem from the fact that all three lay their
 281 /// components out in memory identically.
 282 ///
 283 class SequentialType : public CompositeType {
 284   Type *ContainedType;               ///< Storage for the single contained type.
 285   SequentialType(const SequentialType &);                  // Do not implement!
 286   const SequentialType &operator=(const SequentialType &); // Do not implement!
 287
 288 protected:
 289   SequentialType(TypeID TID, Type *ElType)
 290     : CompositeType(ElType->getContext(), TID), ContainedType(ElType) {
 291     ContainedTys = &ContainedType;
 292     NumContainedTys = 1;
 293   }
 294
 295 public:
 296   Type *getElementType() const { return ContainedTys[0]; }
 297
 298   // Methods for support type inquiry through isa, cast, and dyn_cast.
 299   static inline bool classof(const SequentialType *) { return true; }
 300   static inline bool classof(const Type *T) {
 301     return T->getTypeID() == ArrayTyID ||
 302            T->getTypeID() == PointerTyID ||
 303            T->getTypeID() == VectorTyID;
 304   }
 305 };
 306
 307
 308 /// ArrayType - Class to represent array types.
 309 ///
 310 class ArrayType : public SequentialType {
 311   uint64_t NumElements;
 312
 313   ArrayType(const ArrayType &);                   // Do not implement
 314   const ArrayType &operator=(const ArrayType &);  // Do not implement
 315   ArrayType(Type *ElType, uint64_t NumEl);
 316 public:
 317   /// ArrayType::get - This static method is the primary way to construct an
 318   /// ArrayType
 319   ///
 320   static ArrayType *get(const Type *ElementType, uint64_t NumElements);
 321
 322   /// isValidElementType - Return true if the specified type is valid as a
 323   /// element type.
 324   static bool isValidElementType(const Type *ElemTy);
 325
 326   uint64_t getNumElements() const { return NumElements; }
 327
 328   // Methods for support type inquiry through isa, cast, and dyn_cast.
 329   static inline bool classof(const ArrayType *) { return true; }
 330   static inline bool classof(const Type *T) {
 331     return T->getTypeID() == ArrayTyID;
 332   }
 333 };
 334
 335 /// VectorType - Class to represent vector types.
 336 ///
 337 class VectorType : public SequentialType {
 338   unsigned NumElements;
 339
 340   VectorType(const VectorType &);                   // Do not implement
 341   const VectorType &operator=(const VectorType &);  // Do not implement
 342   VectorType(Type *ElType, unsigned NumEl);
 343 public:
 344   /// VectorType::get - This static method is the primary way to construct an
 345   /// VectorType.
 346   ///
 347   static VectorType *get(const Type *ElementType, unsigned NumElements);
 348
 349   /// VectorType::getInteger - This static method gets a VectorType with the
 350   /// same number of elements as the input type, and the element type is an
 351   /// integer type of the same width as the input element type.
 352   ///
 353   static VectorType *getInteger(const VectorType *VTy) {
 354     unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
 355     Type *EltTy = IntegerType::get(VTy->getContext(), EltBits);
 356     return VectorType::get(EltTy, VTy->getNumElements());
 357   }
 358
 359   /// VectorType::getExtendedElementVectorType - This static method is like
 360   /// getInteger except that the element types are twice as wide as the
 361   /// elements in the input type.
 362   ///
 363   static VectorType *getExtendedElementVectorType(const VectorType *VTy) {
 364     unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
 365     Type *EltTy = IntegerType::get(VTy->getContext(), EltBits * 2);
 366     return VectorType::get(EltTy, VTy->getNumElements());
 367   }
 368
 369   /// VectorType::getTruncatedElementVectorType - This static method is like
 370   /// getInteger except that the element types are half as wide as the
 371   /// elements in the input type.
 372   ///
 373   static VectorType *getTruncatedElementVectorType(const VectorType *VTy) {
 374     unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
 375     assert((EltBits & 1) == 0 &&
 376            "Cannot truncate vector element with odd bit-width");
 377     Type *EltTy = IntegerType::get(VTy->getContext(), EltBits / 2);
 378     return VectorType::get(EltTy, VTy->getNumElements());
 379   }
 380
 381   /// isValidElementType - Return true if the specified type is valid as a
 382   /// element type.
 383   static bool isValidElementType(const Type *ElemTy);
 384
 385   /// @brief Return the number of elements in the Vector type.
 386   unsigned getNumElements() const { return NumElements; }
 387
 388   /// @brief Return the number of bits in the Vector type.
 389   unsigned getBitWidth() const {
 390     return NumElements * getElementType()->getPrimitiveSizeInBits();
 391   }
 392
 393   // Methods for support type inquiry through isa, cast, and dyn_cast.
 394   static inline bool classof(const VectorType *) { return true; }
 395   static inline bool classof(const Type *T) {
 396     return T->getTypeID() == VectorTyID;
 397   }
 398 };
 399
 400
 401 /// PointerType - Class to represent pointers.
 402 ///
 403 class PointerType : public SequentialType {
 404   PointerType(const PointerType &);                   // Do not implement
 405   const PointerType &operator=(const PointerType &);  // Do not implement
 406   explicit PointerType(Type *ElType, unsigned AddrSpace);
 407 public:
 408   /// PointerType::get - This constructs a pointer to an object of the specified
 409   /// type in a numbered address space.
 410   static PointerType *get(const Type *ElementType, unsigned AddressSpace);
 411
 412   /// PointerType::getUnqual - This constructs a pointer to an object of the
 413   /// specified type in the generic address space (address space zero).
 414   static PointerType *getUnqual(const Type *ElementType) {
 415     return PointerType::get(ElementType, 0);
 416   }
 417
 418   /// isValidElementType - Return true if the specified type is valid as a
 419   /// element type.
 420   static bool isValidElementType(const Type *ElemTy);
 421
 422   /// @brief Return the address space of the Pointer type.
 423   inline unsigned getAddressSpace() const { return getSubclassData(); }
 424
 425   // Implement support type inquiry through isa, cast, and dyn_cast.
 426   static inline bool classof(const PointerType *) { return true; }
 427   static inline bool classof(const Type *T) {
 428     return T->getTypeID() == PointerTyID;
 429   }
 430 };
 431
 432 } // End llvm namespace
 433
 434 #endif