include/llvm/DerivedTypes.h

   1 //===-- llvm/DerivedTypes.h - Classes for handling data types ---*- C++ -*-===//
   2 //
   3 // This file contains the declarations of classes that represent "derived
   4 // types".  These are things like "arrays of x" or "structure of x, y, z" or
   5 // "method returning x taking (y,z) as parameters", etc...
   6 //
   7 // The implementations of these classes live in the Type.cpp file.
   8 //
   9 //===----------------------------------------------------------------------===//
  10
  11 #ifndef LLVM_DERIVED_TYPES_H
  12 #define LLVM_DERIVED_TYPES_H
  13
  14 #include "llvm/Type.h"
  15
  16 template<class ValType, class TypeClass> class TypeMap;
  17 class FunctionValType;
  18 class ArrayValType;
  19 class StructValType;
  20 class PointerValType;
  21
  22 class DerivedType : public Type {
  23   char isRefining;                                   // Used for recursive types
  24
  25   // AbstractTypeUsers - Implement a list of the users that need to be notified
  26   // if I am a type, and I get resolved into a more concrete type.
  27   //
  28   ///// FIXME: kill mutable nonsense when Type's are not const
  29   mutable std::vector<AbstractTypeUser *> AbstractTypeUsers;
  30
  31 protected:
  32   inline DerivedType(PrimitiveID id) : Type("", id) {
  33     isRefining = 0;
  34   }
  35   ~DerivedType() {
  36     assert(AbstractTypeUsers.empty());
  37   }
  38
  39   // typeIsRefined - Notify AbstractTypeUsers of this type that the current type
  40   // has been refined a bit.  The pointer is still valid and still should be
  41   // used, but the subtypes have changed.
  42   //
  43   void typeIsRefined();
  44
  45   // dropAllTypeUses - When this (abstract) type is resolved to be equal to
  46   // another (more concrete) type, we must eliminate all references to other
  47   // types, to avoid some circular reference problems.  This also removes the
  48   // type from the internal tables of available types.
  49   virtual void dropAllTypeUses(bool inMap) = 0;
  50
  51
  52   void refineAbstractTypeToInternal(const Type *NewType, bool inMap);
  53
  54 public:
  55
  56   //===--------------------------------------------------------------------===//
  57   // Abstract Type handling methods - These types have special lifetimes, which
  58   // are managed by (add|remove)AbstractTypeUser. See comments in
  59   // AbstractTypeUser.h for more information.
  60
  61   // addAbstractTypeUser - Notify an abstract type that there is a new user of
  62   // it.  This function is called primarily by the PATypeHandle class.
  63   //
  64   void addAbstractTypeUser(AbstractTypeUser *U) const;
  65
  66   // removeAbstractTypeUser - Notify an abstract type that a user of the class
  67   // no longer has a handle to the type.  This function is called primarily by
  68   // the PATypeHandle class.  When there are no users of the abstract type, it
  69   // is annihilated, because there is no way to get a reference to it ever
  70   // again.
  71   //
  72   void removeAbstractTypeUser(AbstractTypeUser *U) const;
  73
  74   // refineAbstractTypeTo - This function is used to when it is discovered that
  75   // the 'this' abstract type is actually equivalent to the NewType specified.
  76   // This causes all users of 'this' to switch to reference the more concrete
  77   // type NewType and for 'this' to be deleted.
  78   //
  79   void refineAbstractTypeTo(const Type *NewType) {
  80     refineAbstractTypeToInternal(NewType, true);
  81   }
  82
  83   // Methods for support type inquiry through isa, cast, and dyn_cast:
  84   static inline bool classof(const DerivedType *T) { return true; }
  85   static inline bool classof(const Type *T) {
  86     return T->isDerivedType();
  87   }
  88   static inline bool classof(const Value *V) {
  89     return isa<Type>(V) && classof(cast<Type>(V));
  90   }
  91 };
  92
  93
  94
  95
  96 struct FunctionType : public DerivedType {
  97   typedef std::vector<PATypeHandle> ParamTypes;
  98   friend class TypeMap<FunctionValType, FunctionType>;
  99 private:
 100   PATypeHandle ResultType;
 101   ParamTypes ParamTys;
 102   bool isVarArgs;
 103
 104   FunctionType(const FunctionType &);                   // Do not implement
 105   const FunctionType &operator=(const FunctionType &);  // Do not implement
 106 protected:
 107   // This should really be private, but it squelches a bogus warning
 108   // from GCC to make them protected:  warning: `class FunctionType' only
 109   // defines private constructors and has no friends
 110
 111   // Private ctor - Only can be created by a static member...
 112   FunctionType(const Type *Result, const std::vector<const Type*> &Params,
 113                bool IsVarArgs);
 114
 115   // dropAllTypeUses - When this (abstract) type is resolved to be equal to
 116   // another (more concrete) type, we must eliminate all references to other
 117   // types, to avoid some circular reference problems.  This also removes the
 118   // type from the internal tables of available types.
 119   virtual void dropAllTypeUses(bool inMap);
 120
 121 public:
 122
 123   inline bool isVarArg() const { return isVarArgs; }
 124   inline const Type *getReturnType() const { return ResultType; }
 125   inline const ParamTypes &getParamTypes() const { return ParamTys; }
 126
 127   // Parameter type accessors...
 128   const Type *getParamType(unsigned i) const { return ParamTys[i]; }
 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 ParamTys.size(); }
 134
 135
 136   virtual const Type *getContainedType(unsigned i) const {
 137     return i == 0 ? ResultType :
 138                     (i <= ParamTys.size() ? ParamTys[i-1].get() : 0);
 139   }
 140   virtual unsigned getNumContainedTypes() const { return ParamTys.size()+1; }
 141
 142   // refineAbstractType - Called when a contained type is found to be more
 143   // concrete - this could potentially change us from an abstract type to a
 144   // concrete type.
 145   //
 146   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 147
 148   static FunctionType *get(const Type *Result,
 149                            const std::vector<const Type*> &Params,
 150                            bool isVarArg);
 151
 152
 153   // Methods for support type inquiry through isa, cast, and dyn_cast:
 154   static inline bool classof(const FunctionType *T) { return true; }
 155   static inline bool classof(const Type *T) {
 156     return T->getPrimitiveID() == FunctionTyID;
 157   }
 158   static inline bool classof(const Value *V) {
 159     return isa<Type>(V) && classof(cast<Type>(V));
 160   }
 161 };
 162
 163
 164 // CompositeType - Common super class of ArrayType, StructType, and PointerType
 165 //
 166 class CompositeType : public DerivedType {
 167 protected:
 168   inline CompositeType(PrimitiveID id) : DerivedType(id) { }
 169 public:
 170
 171   // getTypeAtIndex - Given an index value into the type, return the type of the
 172   // element.
 173   //
 174   virtual const Type *getTypeAtIndex(const Value *V) const = 0;
 175   virtual bool indexValid(const Value *V) const = 0;
 176
 177   // getIndexType - Return the type required of indices for this composite.
 178   // For structures, this is ubyte, for arrays, this is uint
 179   //
 180   virtual const Type *getIndexType() const = 0;
 181
 182
 183   // Methods for support type inquiry through isa, cast, and dyn_cast:
 184   static inline bool classof(const CompositeType *T) { return true; }
 185   static inline bool classof(const Type *T) {
 186     return T->getPrimitiveID() == ArrayTyID ||
 187            T->getPrimitiveID() == StructTyID ||
 188            T->getPrimitiveID() == PointerTyID;
 189   }
 190   static inline bool classof(const Value *V) {
 191     return isa<Type>(V) && classof(cast<Type>(V));
 192   }
 193 };
 194
 195
 196 struct StructType : public CompositeType {
 197   friend class TypeMap<StructValType, StructType>;
 198   typedef std::vector<PATypeHandle> ElementTypes;
 199
 200 private:
 201   ElementTypes ETypes;                              // Element types of struct
 202
 203   StructType(const StructType &);                   // Do not implement
 204   const StructType &operator=(const StructType &);  // Do not implement
 205
 206 protected:
 207   // This should really be private, but it squelches a bogus warning
 208   // from GCC to make them protected:  warning: `class StructType' only
 209   // defines private constructors and has no friends
 210
 211   // Private ctor - Only can be created by a static member...
 212   StructType(const std::vector<const Type*> &Types);
 213
 214   // dropAllTypeUses - When this (abstract) type is resolved to be equal to
 215   // another (more concrete) type, we must eliminate all references to other
 216   // types, to avoid some circular reference problems.  This also removes the
 217   // type from the internal tables of available types.
 218   virtual void dropAllTypeUses(bool inMap);
 219
 220 public:
 221   inline const ElementTypes &getElementTypes() const { return ETypes; }
 222
 223   virtual const Type *getContainedType(unsigned i) const {
 224     return i < ETypes.size() ? ETypes[i].get() : 0;
 225   }
 226   virtual unsigned getNumContainedTypes() const { return ETypes.size(); }
 227
 228   // getTypeAtIndex - Given an index value into the type, return the type of the
 229   // element.  For a structure type, this must be a constant value...
 230   //
 231   virtual const Type *getTypeAtIndex(const Value *V) const ;
 232   virtual bool indexValid(const Value *V) const;
 233
 234   // getIndexType - Return the type required of indices for this composite.
 235   // For structures, this is ubyte, for arrays, this is uint
 236   //
 237   virtual const Type *getIndexType() const { return Type::UByteTy; }
 238
 239   // refineAbstractType - Called when a contained type is found to be more
 240   // concrete - this could potentially change us from an abstract type to a
 241   // concrete type.
 242   //
 243   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 244
 245   static StructType *get(const std::vector<const Type*> &Params);
 246
 247   // Methods for support type inquiry through isa, cast, and dyn_cast:
 248   static inline bool classof(const StructType *T) { return true; }
 249   static inline bool classof(const Type *T) {
 250     return T->getPrimitiveID() == StructTyID;
 251   }
 252   static inline bool classof(const Value *V) {
 253     return isa<Type>(V) && classof(cast<Type>(V));
 254   }
 255 };
 256
 257
 258 // SequentialType - This is the superclass of the array and pointer type
 259 // classes.  Both of these represent "arrays" in memory.  The array type
 260 // represents a specifically sized array, pointer types are unsized/unknown size
 261 // arrays.  SequentialType holds the common features of both, which stem from
 262 // the fact that both lay their components out in memory identically.
 263 //
 264 class SequentialType : public CompositeType {
 265   SequentialType(const SequentialType &);                  // Do not implement!
 266   const SequentialType &operator=(const SequentialType &); // Do not implement!
 267 protected:
 268   PATypeHandle ElementType;
 269
 270   SequentialType(PrimitiveID TID, const Type *ElType)
 271     : CompositeType(TID), ElementType(PATypeHandle(ElType, this)) {
 272   }
 273
 274 public:
 275   inline const Type *getElementType() const { return ElementType; }
 276
 277   virtual const Type *getContainedType(unsigned i) const {
 278     return i == 0 ? ElementType.get() : 0;
 279   }
 280   virtual unsigned getNumContainedTypes() const { return 1; }
 281
 282   // getTypeAtIndex - Given an index value into the type, return the type of the
 283   // element.  For sequential types, there is only one subtype...
 284   //
 285   virtual const Type *getTypeAtIndex(const Value *V) const {
 286     return ElementType.get();
 287   }
 288   virtual bool indexValid(const Value *V) const {
 289     return V->getType() == Type::LongTy;   // Must be a 'long' index
 290   }
 291
 292   // getIndexType() - Return the type required of indices for this composite.
 293   // For structures, this is ubyte, for arrays, this is uint
 294   //
 295   virtual const Type *getIndexType() const { return Type::LongTy; }
 296
 297   // Methods for support type inquiry through isa, cast, and dyn_cast:
 298   static inline bool classof(const SequentialType *T) { return true; }
 299   static inline bool classof(const Type *T) {
 300     return T->getPrimitiveID() == ArrayTyID ||
 301            T->getPrimitiveID() == PointerTyID;
 302   }
 303   static inline bool classof(const Value *V) {
 304     return isa<Type>(V) && classof(cast<Type>(V));
 305   }
 306 };
 307
 308
 309 class ArrayType : public SequentialType {
 310   friend class TypeMap<ArrayValType, ArrayType>;
 311   unsigned NumElements;
 312
 313   ArrayType(const ArrayType &);                   // Do not implement
 314   const ArrayType &operator=(const ArrayType &);  // Do not implement
 315 protected:
 316   // This should really be private, but it squelches a bogus warning
 317   // from GCC to make them protected:  warning: `class ArrayType' only
 318   // defines private constructors and has no friends
 319
 320   // Private ctor - Only can be created by a static member...
 321   ArrayType(const Type *ElType, unsigned NumEl);
 322
 323   // dropAllTypeUses - When this (abstract) type is resolved to be equal to
 324   // another (more concrete) type, we must eliminate all references to other
 325   // types, to avoid some circular reference problems.  This also removes the
 326   // type from the internal tables of available types.
 327   virtual void dropAllTypeUses(bool inMap);
 328
 329 public:
 330   inline unsigned    getNumElements() const { return NumElements; }
 331
 332   // refineAbstractType - Called when a contained type is found to be more
 333   // concrete - this could potentially change us from an abstract type to a
 334   // concrete type.
 335   //
 336   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 337
 338   static ArrayType *get(const Type *ElementType, unsigned NumElements);
 339
 340   // Methods for support type inquiry through isa, cast, and dyn_cast:
 341   static inline bool classof(const ArrayType *T) { return true; }
 342   static inline bool classof(const Type *T) {
 343     return T->getPrimitiveID() == ArrayTyID;
 344   }
 345   static inline bool classof(const Value *V) {
 346     return isa<Type>(V) && classof(cast<Type>(V));
 347   }
 348 };
 349
 350
 351
 352 class PointerType : public SequentialType {
 353   friend class TypeMap<PointerValType, PointerType>;
 354   PointerType(const PointerType &);                   // Do not implement
 355   const PointerType &operator=(const PointerType &);  // Do not implement
 356 protected:
 357   // This should really be private, but it squelches a bogus warning
 358   // from GCC to make them protected:  warning: `class PointerType' only
 359   // defines private constructors and has no friends
 360
 361   // Private ctor - Only can be created by a static member...
 362   PointerType(const Type *ElType);
 363
 364   // dropAllTypeUses - When this (abstract) type is resolved to be equal to
 365   // another (more concrete) type, we must eliminate all references to other
 366   // types, to avoid some circular reference problems.  This also removes the
 367   // type from the internal tables of available types.
 368   virtual void dropAllTypeUses(bool inMap);
 369 public:
 370   // PointerType::get - Named constructor for pointer types...
 371   static PointerType *get(const Type *ElementType);
 372
 373   // refineAbstractType - Called when a contained type is found to be more
 374   // concrete - this could potentially change us from an abstract type to a
 375   // concrete type.
 376   //
 377   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 378
 379   // Methods for support type inquiry through isa, cast, and dyn_cast:
 380   static inline bool classof(const PointerType *T) { return true; }
 381   static inline bool classof(const Type *T) {
 382     return T->getPrimitiveID() == PointerTyID;
 383   }
 384   static inline bool classof(const Value *V) {
 385     return isa<Type>(V) && classof(cast<Type>(V));
 386   }
 387 };
 388
 389
 390 class OpaqueType : public DerivedType {
 391   OpaqueType(const OpaqueType &);                   // DO NOT IMPLEMENT
 392   const OpaqueType &operator=(const OpaqueType &);  // DO NOT IMPLEMENT
 393 protected:
 394   // This should really be private, but it squelches a bogus warning
 395   // from GCC to make them protected:  warning: `class OpaqueType' only
 396   // defines private constructors and has no friends
 397
 398   // Private ctor - Only can be created by a static member...
 399   OpaqueType();
 400
 401   // dropAllTypeUses - When this (abstract) type is resolved to be equal to
 402   // another (more concrete) type, we must eliminate all references to other
 403   // types, to avoid some circular reference problems.
 404   virtual void dropAllTypeUses(bool inMap) {}  // No type uses
 405
 406 public:
 407
 408   // get - Static factory method for the OpaqueType class...
 409   static OpaqueType *get() {
 410     return new OpaqueType();           // All opaque types are distinct
 411   }
 412
 413   // Methods for support type inquiry through isa, cast, and dyn_cast:
 414   static inline bool classof(const OpaqueType *T) { return true; }
 415   static inline bool classof(const Type *T) {
 416     return T->getPrimitiveID() == OpaqueTyID;
 417   }
 418   static inline bool classof(const Value *V) {
 419     return isa<Type>(V) && classof(cast<Type>(V));
 420   }
 421 };
 422
 423
 424 // Define some inline methods for the AbstractTypeUser.h:PATypeHandle class.
 425 // These are defined here because they MUST be inlined, yet are dependent on
 426 // the definition of the Type class.  Of course Type derives from Value, which
 427 // contains an AbstractTypeUser instance, so there is no good way to factor out
 428 // the code.  Hence this bit of uglyness.
 429 //
 430 inline void PATypeHandle::addUser() {
 431   assert(Ty && "Type Handle has a null type!");
 432   if (Ty->isAbstract())
 433     cast<DerivedType>(Ty)->addAbstractTypeUser(User);
 434 }
 435 inline void PATypeHandle::removeUser() {
 436   if (Ty->isAbstract())
 437     cast<DerivedType>(Ty)->removeAbstractTypeUser(User);
 438 }
 439
 440 inline void PATypeHandle::removeUserFromConcrete() {
 441   if (!Ty->isAbstract())
 442     cast<DerivedType>(Ty)->removeAbstractTypeUser(User);
 443 }
 444
 445 #endif