include/llvm/DerivedTypes.h

   1 //===-- llvm/DerivedTypes.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 declarations of classes that represent "derived
  11 // types".  These are things like "arrays of x" or "structure of x, y, z" or
  12 // "method 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
  23 namespace llvm {
  24
  25 class Value;
  26 template<class ValType, class TypeClass> class TypeMap;
  27 class FunctionValType;
  28 class ArrayValType;
  29 class StructValType;
  30 class PointerValType;
  31 class VectorValType;
  32 class IntegerValType;
  33 class APInt;
  34
  35 class DerivedType : public Type {
  36   friend class Type;
  37
  38 protected:
  39   explicit DerivedType(TypeID id) : Type(id) {}
  40
  41   /// notifyUsesThatTypeBecameConcrete - Notify AbstractTypeUsers of this type
  42   /// that the current type has transitioned from being abstract to being
  43   /// concrete.
  44   ///
  45   void notifyUsesThatTypeBecameConcrete();
  46
  47   /// dropAllTypeUses - When this (abstract) type is resolved to be equal to
  48   /// another (more concrete) type, we must eliminate all references to other
  49   /// types, to avoid some circular reference problems.
  50   ///
  51   void dropAllTypeUses();
  52
  53 public:
  54
  55   //===--------------------------------------------------------------------===//
  56   // Abstract Type handling methods - These types have special lifetimes, which
  57   // are managed by (add|remove)AbstractTypeUser. See comments in
  58   // AbstractTypeUser.h for more information.
  59
  60   /// refineAbstractTypeTo - This function is used to when it is discovered that
  61   /// the 'this' abstract type is actually equivalent to the NewType specified.
  62   /// This causes all users of 'this' to switch to reference the more concrete
  63   /// type NewType and for 'this' to be deleted.
  64   ///
  65   void refineAbstractTypeTo(const Type *NewType);
  66
  67   void dump() const { Type::dump(); }
  68
  69   // Methods for support type inquiry through isa, cast, and dyn_cast:
  70   static inline bool classof(const DerivedType *T) { return true; }
  71   static inline bool classof(const Type *T) {
  72     return T->isDerivedType();
  73   }
  74 };
  75
  76 /// Class to represent integer types. Note that this class is also used to
  77 /// represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and
  78 /// Int64Ty.
  79 /// @brief Integer representation type
  80 class IntegerType : public DerivedType {
  81 protected:
  82   explicit IntegerType(unsigned NumBits) : DerivedType(IntegerTyID) {
  83     setSubclassData(NumBits);
  84   }
  85   friend class TypeMap<IntegerValType, IntegerType>;
  86 public:
  87   /// This enum is just used to hold constants we need for IntegerType.
  88   enum {
  89     MIN_INT_BITS = 1,        ///< Minimum number of bits that can be specified
  90     MAX_INT_BITS = (1<<23)-1 ///< Maximum number of bits that can be specified
  91       ///< Note that bit width is stored in the Type classes SubclassData field
  92       ///< which has 23 bits. This yields a maximum bit width of 8,388,607 bits.
  93   };
  94
  95   /// This static method is the primary way of constructing an IntegerType.
  96   /// If an IntegerType with the same NumBits value was previously instantiated,
  97   /// that instance will be returned. Otherwise a new one will be created. Only
  98   /// one instance with a given NumBits value is ever created.
  99   /// @brief Get or create an IntegerType instance.
 100   static const IntegerType* get(unsigned NumBits);
 101
 102   /// @brief Get the number of bits in this IntegerType
 103   unsigned getBitWidth() const { return getSubclassData(); }
 104
 105   /// getBitMask - Return a bitmask with ones set for all of the bits
 106   /// that can be set by an unsigned version of this type.  This is 0xFF for
 107   /// sbyte/ubyte, 0xFFFF for shorts, etc.
 108   uint64_t getBitMask() const {
 109     return ~uint64_t(0UL) >> (64-getBitWidth());
 110   }
 111
 112   /// getSignBit - Return a uint64_t with just the most significant bit set (the
 113   /// sign bit, if the value is treated as a signed number).
 114   uint64_t getSignBit() const {
 115     return 1ULL << (getBitWidth()-1);
 116   }
 117
 118   /// For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.
 119   /// @returns a bit mask with ones set for all the bits of this type.
 120   /// @brief Get a bit mask for this type.
 121   APInt getMask() const;
 122
 123   /// This method determines if the width of this IntegerType is a power-of-2
 124   /// in terms of 8 bit bytes.
 125   /// @returns true if this is a power-of-2 byte width.
 126   /// @brief Is this a power-of-2 byte-width IntegerType ?
 127   bool isPowerOf2ByteWidth() const;
 128
 129   // Methods for support type inquiry through isa, cast, and dyn_cast:
 130   static inline bool classof(const IntegerType *T) { return true; }
 131   static inline bool classof(const Type *T) {
 132     return T->getTypeID() == IntegerTyID;
 133   }
 134 };
 135
 136
 137 /// FunctionType - Class to represent function types
 138 ///
 139 class FunctionType : public DerivedType {
 140 public:
 141   /// Function parameters can have attributes to indicate how they should be
 142   /// treated by optimizations and code generation. This enumeration lists the
 143   /// set of possible attributes.
 144   /// @brief Function parameter attributes enumeration.
 145   enum ParameterAttributes {
 146     NoAttributeSet    = 0,      ///< No attribute value has been set
 147     ZExtAttribute     = 1,      ///< zero extended before/after call
 148     SExtAttribute     = 1 << 1, ///< sign extended before/after call
 149     NoReturnAttribute = 1 << 2, ///< mark the function as not returning
 150     InRegAttribute    = 1 << 3, ///< force argument to be passed in register
 151     StructRetAttribute= 1 << 4, ///< hidden pointer to structure to return
 152     NoUnwindAttribute = 1 << 5  ///< Function doesn't unwind stack
 153   };
 154   typedef std::vector<ParameterAttributes> ParamAttrsList;
 155 private:
 156   friend class TypeMap<FunctionValType, FunctionType>;
 157   bool isVarArgs;
 158   ParamAttrsList *ParamAttrs;
 159
 160   FunctionType(const FunctionType &);                   // Do not implement
 161   const FunctionType &operator=(const FunctionType &);  // Do not implement
 162   FunctionType(const Type *Result, const std::vector<const Type*> &Params,
 163                bool IsVarArgs, const ParamAttrsList &Attrs);
 164
 165 public:
 166   /// FunctionType::get - This static method is the primary way of constructing
 167   /// a FunctionType.
 168   ///
 169   static FunctionType *get(
 170     const Type *Result, ///< The result type
 171     const std::vector<const Type*> &Params, ///< The types of the parameters
 172     bool isVarArg, ///< Whether this is a variable argument length function
 173     const ParamAttrsList & Attrs = ParamAttrsList()
 174       ///< Indicates the parameter attributes to use, if any. The 0th entry
 175       ///< in the list refers to the return type. Parameters are numbered
 176       ///< starting at 1.
 177   );
 178
 179   inline bool isVarArg() const { return isVarArgs; }
 180   inline const Type *getReturnType() const { return ContainedTys[0]; }
 181
 182   typedef std::vector<PATypeHandle>::const_iterator param_iterator;
 183   param_iterator param_begin() const { return ContainedTys.begin()+1; }
 184   param_iterator param_end() const { return ContainedTys.end(); }
 185
 186   // Parameter type accessors...
 187   const Type *getParamType(unsigned i) const { return ContainedTys[i+1]; }
 188
 189   /// getNumParams - Return the number of fixed parameters this function type
 190   /// requires.  This does not consider varargs.
 191   ///
 192   unsigned getNumParams() const { return unsigned(ContainedTys.size()-1); }
 193
 194   bool isStructReturn() const {
 195     return (getNumParams() && paramHasAttr(1, StructRetAttribute));
 196   }
 197
 198   /// The parameter attributes for the \p ith parameter are returned. The 0th
 199   /// parameter refers to the return type of the function.
 200   /// @returns The ParameterAttributes for the \p ith parameter.
 201   /// @brief Get the attributes for a parameter
 202   ParameterAttributes getParamAttrs(unsigned i) const;
 203
 204   /// @brief Determine if a parameter attribute is set
 205   bool paramHasAttr(unsigned i, ParameterAttributes attr) const {
 206     return getParamAttrs(i) & attr;
 207   }
 208
 209   /// @brief Return the number of parameter attributes this type has.
 210   unsigned getNumAttrs() const {
 211     return (ParamAttrs ?  unsigned(ParamAttrs->size()) : 0);
 212   }
 213
 214   /// @brief Convert a ParameterAttribute into its assembly text
 215   static std::string getParamAttrsText(ParameterAttributes Attr);
 216
 217   // Implement the AbstractTypeUser interface.
 218   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 219   virtual void typeBecameConcrete(const DerivedType *AbsTy);
 220
 221   // Methods for support type inquiry through isa, cast, and dyn_cast:
 222   static inline bool classof(const FunctionType *T) { return true; }
 223   static inline bool classof(const Type *T) {
 224     return T->getTypeID() == FunctionTyID;
 225   }
 226 };
 227
 228
 229 /// CompositeType - Common super class of ArrayType, StructType, PointerType
 230 /// and VectorType
 231 class CompositeType : public DerivedType {
 232 protected:
 233   inline explicit CompositeType(TypeID id) : DerivedType(id) { }
 234 public:
 235
 236   /// getTypeAtIndex - Given an index value into the type, return the type of
 237   /// the element.
 238   ///
 239   virtual const Type *getTypeAtIndex(const Value *V) const = 0;
 240   virtual bool indexValid(const Value *V) const = 0;
 241
 242   // Methods for support type inquiry through isa, cast, and dyn_cast:
 243   static inline bool classof(const CompositeType *T) { return true; }
 244   static inline bool classof(const Type *T) {
 245     return T->getTypeID() == ArrayTyID ||
 246            T->getTypeID() == StructTyID ||
 247            T->getTypeID() == PointerTyID ||
 248            T->getTypeID() == VectorTyID;
 249   }
 250 };
 251
 252
 253 /// StructType - Class to represent struct types
 254 ///
 255 class StructType : public CompositeType {
 256   friend class TypeMap<StructValType, StructType>;
 257   StructType(const StructType &);                   // Do not implement
 258   const StructType &operator=(const StructType &);  // Do not implement
 259   StructType(const std::vector<const Type*> &Types, bool isPacked);
 260 public:
 261   /// StructType::get - This static method is the primary way to create a
 262   /// StructType.
 263   ///
 264   static StructType *get(const std::vector<const Type*> &Params,
 265                          bool isPacked=false);
 266
 267   // Iterator access to the elements
 268   typedef std::vector<PATypeHandle>::const_iterator element_iterator;
 269   element_iterator element_begin() const { return ContainedTys.begin(); }
 270   element_iterator element_end() const { return ContainedTys.end(); }
 271
 272   // Random access to the elements
 273   unsigned getNumElements() const { return unsigned(ContainedTys.size()); }
 274   const Type *getElementType(unsigned N) const {
 275     assert(N < ContainedTys.size() && "Element number out of range!");
 276     return ContainedTys[N];
 277   }
 278
 279   /// getTypeAtIndex - Given an index value into the type, return the type of
 280   /// the element.  For a structure type, this must be a constant value...
 281   ///
 282   virtual const Type *getTypeAtIndex(const Value *V) const ;
 283   virtual bool indexValid(const Value *V) const;
 284
 285   // Implement the AbstractTypeUser interface.
 286   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 287   virtual void typeBecameConcrete(const DerivedType *AbsTy);
 288
 289   // Methods for support type inquiry through isa, cast, and dyn_cast:
 290   static inline bool classof(const StructType *T) { return true; }
 291   static inline bool classof(const Type *T) {
 292     return T->getTypeID() == StructTyID;
 293   }
 294
 295   bool isPacked() const { return getSubclassData(); }
 296 };
 297
 298
 299 /// SequentialType - This is the superclass of the array, pointer and packed
 300 /// type classes.  All of these represent "arrays" in memory.  The array type
 301 /// represents a specifically sized array, pointer types are unsized/unknown
 302 /// size arrays, vector types represent specifically sized arrays that
 303 /// allow for use of SIMD instructions.  SequentialType holds the common
 304 /// features of all, which stem from the fact that all three lay their
 305 /// components out in memory identically.
 306 ///
 307 class SequentialType : public CompositeType {
 308   SequentialType(const SequentialType &);                  // Do not implement!
 309   const SequentialType &operator=(const SequentialType &); // Do not implement!
 310 protected:
 311   SequentialType(TypeID TID, const Type *ElType) : CompositeType(TID) {
 312     ContainedTys.reserve(1);
 313     ContainedTys.push_back(PATypeHandle(ElType, this));
 314   }
 315
 316 public:
 317   inline const Type *getElementType() const { return ContainedTys[0]; }
 318
 319   virtual bool indexValid(const Value *V) const;
 320
 321   /// getTypeAtIndex - Given an index value into the type, return the type of
 322   /// the element.  For sequential types, there is only one subtype...
 323   ///
 324   virtual const Type *getTypeAtIndex(const Value *V) const {
 325     return ContainedTys[0];
 326   }
 327
 328   // Methods for support type inquiry through isa, cast, and dyn_cast:
 329   static inline bool classof(const SequentialType *T) { return true; }
 330   static inline bool classof(const Type *T) {
 331     return T->getTypeID() == ArrayTyID ||
 332            T->getTypeID() == PointerTyID ||
 333            T->getTypeID() == VectorTyID;
 334   }
 335 };
 336
 337
 338 /// ArrayType - Class to represent array types
 339 ///
 340 class ArrayType : public SequentialType {
 341   friend class TypeMap<ArrayValType, ArrayType>;
 342   uint64_t NumElements;
 343
 344   ArrayType(const ArrayType &);                   // Do not implement
 345   const ArrayType &operator=(const ArrayType &);  // Do not implement
 346   ArrayType(const Type *ElType, uint64_t NumEl);
 347 public:
 348   /// ArrayType::get - This static method is the primary way to construct an
 349   /// ArrayType
 350   ///
 351   static ArrayType *get(const Type *ElementType, uint64_t NumElements);
 352
 353   inline uint64_t getNumElements() const { return NumElements; }
 354
 355   // Implement the AbstractTypeUser interface.
 356   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 357   virtual void typeBecameConcrete(const DerivedType *AbsTy);
 358
 359   // Methods for support type inquiry through isa, cast, and dyn_cast:
 360   static inline bool classof(const ArrayType *T) { return true; }
 361   static inline bool classof(const Type *T) {
 362     return T->getTypeID() == ArrayTyID;
 363   }
 364 };
 365
 366 /// VectorType - Class to represent vector types
 367 ///
 368 class VectorType : public SequentialType {
 369   friend class TypeMap<VectorValType, VectorType>;
 370   unsigned NumElements;
 371
 372   VectorType(const VectorType &);                   // Do not implement
 373   const VectorType &operator=(const VectorType &);  // Do not implement
 374   VectorType(const Type *ElType, unsigned NumEl);
 375 public:
 376   /// VectorType::get - This static method is the primary way to construct an
 377   /// VectorType
 378   ///
 379   static VectorType *get(const Type *ElementType, unsigned NumElements);
 380
 381   /// @brief Return the number of elements in the Vector type.
 382   inline unsigned getNumElements() const { return NumElements; }
 383
 384   /// @brief Return the number of bits in the Vector type.
 385   inline unsigned getBitWidth() const {
 386     return NumElements *getElementType()->getPrimitiveSizeInBits();
 387   }
 388
 389   // Implement the AbstractTypeUser interface.
 390   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 391   virtual void typeBecameConcrete(const DerivedType *AbsTy);
 392
 393   // Methods for support type inquiry through isa, cast, and dyn_cast:
 394   static inline bool classof(const VectorType *T) { 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   friend class TypeMap<PointerValType, PointerType>;
 405   PointerType(const PointerType &);                   // Do not implement
 406   const PointerType &operator=(const PointerType &);  // Do not implement
 407   explicit PointerType(const Type *ElType);
 408 public:
 409   /// PointerType::get - This is the only way to construct a new pointer type.
 410   static PointerType *get(const Type *ElementType);
 411
 412   // Implement the AbstractTypeUser interface.
 413   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 414   virtual void typeBecameConcrete(const DerivedType *AbsTy);
 415
 416   // Implement support type inquiry through isa, cast, and dyn_cast:
 417   static inline bool classof(const PointerType *T) { return true; }
 418   static inline bool classof(const Type *T) {
 419     return T->getTypeID() == PointerTyID;
 420   }
 421 };
 422
 423
 424 /// OpaqueType - Class to represent abstract types
 425 ///
 426 class OpaqueType : public DerivedType {
 427   OpaqueType(const OpaqueType &);                   // DO NOT IMPLEMENT
 428   const OpaqueType &operator=(const OpaqueType &);  // DO NOT IMPLEMENT
 429   OpaqueType();
 430 public:
 431   /// OpaqueType::get - Static factory method for the OpaqueType class...
 432   ///
 433   static OpaqueType *get() {
 434     return new OpaqueType();           // All opaque types are distinct
 435   }
 436
 437   // Implement the AbstractTypeUser interface.
 438   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
 439     abort();   // FIXME: this is not really an AbstractTypeUser!
 440   }
 441   virtual void typeBecameConcrete(const DerivedType *AbsTy) {
 442     abort();   // FIXME: this is not really an AbstractTypeUser!
 443   }
 444
 445   // Implement support for type inquiry through isa, cast, and dyn_cast:
 446   static inline bool classof(const OpaqueType *T) { return true; }
 447   static inline bool classof(const Type *T) {
 448     return T->getTypeID() == OpaqueTyID;
 449   }
 450 };
 451
 452 } // End llvm namespace
 453
 454 #endif