contrib/llvm/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() {
 194     delete [] ContainedTys; // Delete the body.
 195   }
 196
 197   /// StructType::createNamed - This creates a named struct with no body
 198   /// specified.  If the name is empty, it creates an unnamed struct, which has
 199   /// a unique identity but no actual name.
 200   static StructType *createNamed(LLVMContext &Context, StringRef Name);
 201
 202   static StructType *createNamed(StringRef Name, ArrayRef<Type*> Elements,
 203                                  bool isPacked = false);
 204   static StructType *createNamed(LLVMContext &Context, StringRef Name,
 205                                  ArrayRef<Type*> Elements,
 206                                  bool isPacked = false);
 207   static StructType *createNamed(StringRef Name, Type *elt1, ...) END_WITH_NULL;
 208
 209   /// StructType::get - This static method is the primary way to create a
 210   /// StructType.
 211   static StructType *get(LLVMContext &Context, ArrayRef<Type*> Elements,
 212                          bool isPacked = false);
 213
 214   /// StructType::get - Create an empty structure type.
 215   ///
 216   static StructType *get(LLVMContext &Context, bool isPacked = false);
 217
 218   /// StructType::get - This static method is a convenience method for creating
 219   /// structure types by specifying the elements as arguments.  Note that this
 220   /// method always returns a non-packed struct, and requires at least one
 221   /// element type.
 222   static StructType *get(Type *elt1, ...) END_WITH_NULL;
 223
 224   bool isPacked() const { return (getSubclassData() & SCDB_Packed) != 0; }
 225
 226   /// isAnonymous - Return true if this type is uniqued by structural
 227   /// equivalence, false if it has an identity.
 228   bool isAnonymous() const {return (getSubclassData() & SCDB_IsAnonymous) != 0;}
 229
 230   /// isOpaque - Return true if this is a type with an identity that has no body
 231   /// specified yet.  These prints as 'opaque' in .ll files.
 232   bool isOpaque() const { return (getSubclassData() & SCDB_HasBody) == 0; }
 233
 234   /// hasName - Return true if this is a named struct that has a non-empty name.
 235   bool hasName() const { return SymbolTableEntry != 0; }
 236
 237   /// getName - Return the name for this struct type if it has an identity.
 238   /// This may return an empty string for an unnamed struct type.  Do not call
 239   /// this on an anonymous type.
 240   StringRef getName() const;
 241
 242   /// setName - Change the name of this type to the specified name, or to a name
 243   /// with a suffix if there is a collision.  Do not call this on an anonymous
 244   /// type.
 245   void setName(StringRef Name);
 246
 247   /// setBody - Specify a body for an opaque type.
 248   void setBody(ArrayRef<Type*> Elements, bool isPacked = false);
 249   void setBody(Type *elt1, ...) END_WITH_NULL;
 250
 251   /// isValidElementType - Return true if the specified type is valid as a
 252   /// element type.
 253   static bool isValidElementType(const Type *ElemTy);
 254
 255
 256   // Iterator access to the elements.
 257   typedef Type::subtype_iterator element_iterator;
 258   element_iterator element_begin() const { return ContainedTys; }
 259   element_iterator element_end() const { return &ContainedTys[NumContainedTys];}
 260
 261   /// isLayoutIdentical - Return true if this is layout identical to the
 262   /// specified struct.
 263   bool isLayoutIdentical(const StructType *Other) const;
 264
 265   // Random access to the elements
 266   unsigned getNumElements() const { return NumContainedTys; }
 267   Type *getElementType(unsigned N) const {
 268     assert(N < NumContainedTys && "Element number out of range!");
 269     return ContainedTys[N];
 270   }
 271
 272   // Methods for support type inquiry through isa, cast, and dyn_cast.
 273   static inline bool classof(const StructType *) { return true; }
 274   static inline bool classof(const Type *T) {
 275     return T->getTypeID() == StructTyID;
 276   }
 277 };
 278
 279 /// SequentialType - This is the superclass of the array, pointer and vector
 280 /// type classes.  All of these represent "arrays" in memory.  The array type
 281 /// represents a specifically sized array, pointer types are unsized/unknown
 282 /// size arrays, vector types represent specifically sized arrays that
 283 /// allow for use of SIMD instructions.  SequentialType holds the common
 284 /// features of all, which stem from the fact that all three lay their
 285 /// components out in memory identically.
 286 ///
 287 class SequentialType : public CompositeType {
 288   Type *ContainedType;               ///< Storage for the single contained type.
 289   SequentialType(const SequentialType &);                  // Do not implement!
 290   const SequentialType &operator=(const SequentialType &); // Do not implement!
 291
 292 protected:
 293   SequentialType(TypeID TID, Type *ElType)
 294     : CompositeType(ElType->getContext(), TID), ContainedType(ElType) {
 295     ContainedTys = &ContainedType;
 296     NumContainedTys = 1;
 297   }
 298
 299 public:
 300   Type *getElementType() const { return ContainedTys[0]; }
 301
 302   // Methods for support type inquiry through isa, cast, and dyn_cast.
 303   static inline bool classof(const SequentialType *) { return true; }
 304   static inline bool classof(const Type *T) {
 305     return T->getTypeID() == ArrayTyID ||
 306            T->getTypeID() == PointerTyID ||
 307            T->getTypeID() == VectorTyID;
 308   }
 309 };
 310
 311
 312 /// ArrayType - Class to represent array types.
 313 ///
 314 class ArrayType : public SequentialType {
 315   uint64_t NumElements;
 316
 317   ArrayType(const ArrayType &);                   // Do not implement
 318   const ArrayType &operator=(const ArrayType &);  // Do not implement
 319   ArrayType(Type *ElType, uint64_t NumEl);
 320 public:
 321   /// ArrayType::get - This static method is the primary way to construct an
 322   /// ArrayType
 323   ///
 324   static ArrayType *get(const Type *ElementType, uint64_t NumElements);
 325
 326   /// isValidElementType - Return true if the specified type is valid as a
 327   /// element type.
 328   static bool isValidElementType(const Type *ElemTy);
 329
 330   uint64_t getNumElements() const { return NumElements; }
 331
 332   // Methods for support type inquiry through isa, cast, and dyn_cast.
 333   static inline bool classof(const ArrayType *) { return true; }
 334   static inline bool classof(const Type *T) {
 335     return T->getTypeID() == ArrayTyID;
 336   }
 337 };
 338
 339 /// VectorType - Class to represent vector types.
 340 ///
 341 class VectorType : public SequentialType {
 342   unsigned NumElements;
 343
 344   VectorType(const VectorType &);                   // Do not implement
 345   const VectorType &operator=(const VectorType &);  // Do not implement
 346   VectorType(Type *ElType, unsigned NumEl);
 347 public:
 348   /// VectorType::get - This static method is the primary way to construct an
 349   /// VectorType.
 350   ///
 351   static VectorType *get(const Type *ElementType, unsigned NumElements);
 352
 353   /// VectorType::getInteger - This static method gets a VectorType with the
 354   /// same number of elements as the input type, and the element type is an
 355   /// integer type of the same width as the input element type.
 356   ///
 357   static VectorType *getInteger(const VectorType *VTy) {
 358     unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
 359     Type *EltTy = IntegerType::get(VTy->getContext(), EltBits);
 360     return VectorType::get(EltTy, VTy->getNumElements());
 361   }
 362
 363   /// VectorType::getExtendedElementVectorType - This static method is like
 364   /// getInteger except that the element types are twice as wide as the
 365   /// elements in the input type.
 366   ///
 367   static VectorType *getExtendedElementVectorType(const VectorType *VTy) {
 368     unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
 369     Type *EltTy = IntegerType::get(VTy->getContext(), EltBits * 2);
 370     return VectorType::get(EltTy, VTy->getNumElements());
 371   }
 372
 373   /// VectorType::getTruncatedElementVectorType - This static method is like
 374   /// getInteger except that the element types are half as wide as the
 375   /// elements in the input type.
 376   ///
 377   static VectorType *getTruncatedElementVectorType(const VectorType *VTy) {
 378     unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
 379     assert((EltBits & 1) == 0 &&
 380            "Cannot truncate vector element with odd bit-width");
 381     Type *EltTy = IntegerType::get(VTy->getContext(), EltBits / 2);
 382     return VectorType::get(EltTy, VTy->getNumElements());
 383   }
 384
 385   /// isValidElementType - Return true if the specified type is valid as a
 386   /// element type.
 387   static bool isValidElementType(const Type *ElemTy);
 388
 389   /// @brief Return the number of elements in the Vector type.
 390   unsigned getNumElements() const { return NumElements; }
 391
 392   /// @brief Return the number of bits in the Vector type.
 393   unsigned getBitWidth() const {
 394     return NumElements * getElementType()->getPrimitiveSizeInBits();
 395   }
 396
 397   // Methods for support type inquiry through isa, cast, and dyn_cast.
 398   static inline bool classof(const VectorType *) { return true; }
 399   static inline bool classof(const Type *T) {
 400     return T->getTypeID() == VectorTyID;
 401   }
 402 };
 403
 404
 405 /// PointerType - Class to represent pointers.
 406 ///
 407 class PointerType : public SequentialType {
 408   PointerType(const PointerType &);                   // Do not implement
 409   const PointerType &operator=(const PointerType &);  // Do not implement
 410   explicit PointerType(Type *ElType, unsigned AddrSpace);
 411 public:
 412   /// PointerType::get - This constructs a pointer to an object of the specified
 413   /// type in a numbered address space.
 414   static PointerType *get(const Type *ElementType, unsigned AddressSpace);
 415
 416   /// PointerType::getUnqual - This constructs a pointer to an object of the
 417   /// specified type in the generic address space (address space zero).
 418   static PointerType *getUnqual(const Type *ElementType) {
 419     return PointerType::get(ElementType, 0);
 420   }
 421
 422   /// isValidElementType - Return true if the specified type is valid as a
 423   /// element type.
 424   static bool isValidElementType(const Type *ElemTy);
 425
 426   /// @brief Return the address space of the Pointer type.
 427   inline unsigned getAddressSpace() const { return getSubclassData(); }
 428
 429   // Implement support type inquiry through isa, cast, and dyn_cast.
 430   static inline bool classof(const PointerType *) { return true; }
 431   static inline bool classof(const Type *T) {
 432     return T->getTypeID() == PointerTyID;
 433   }
 434 };
 435
 436 } // End llvm namespace
 437
 438 #endif