-//===-- llvm/DerivedTypes.h - Classes for handling data types ----*- C++ -*--=//
+//===-- llvm/DerivedTypes.h - Classes for handling data types ---*- C++ -*-===//
//
-// This file contains the declarations of classes that represent "derived
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file contains the declarations of classes that represent "derived
// types". These are things like "arrays of x" or "structure of x, y, z" or
// "method returning x taking (y,z) as parameters", etc...
//
#define LLVM_DERIVED_TYPES_H
#include "llvm/Type.h"
+#include "llvm/Support/DataTypes.h"
+
+namespace llvm {
+
+class Value;
+template<class ValType, class TypeClass> class TypeMap;
+class FunctionValType;
+class ArrayValType;
+class StructValType;
+class PointerValType;
+class PackedValType;
-class DerivedType : public Type {
+class DerivedType : public Type, public AbstractTypeUser {
// AbstractTypeUsers - Implement a list of the users that need to be notified
// if I am a type, and I get resolved into a more concrete type.
//
- ///// FIXME: kill mutable nonsense when Type's are not const
- mutable vector<AbstractTypeUser *> AbstractTypeUsers;
-
- char isRefining; // Used for recursive types
+ mutable std::vector<AbstractTypeUser *> AbstractTypeUsers;
+ friend class Type;
protected:
- inline DerivedType(const string &Name, PrimitiveID id) : Type(Name, id) {
- isRefining = false;
+ DerivedType(TypeID id) : Type("", id) {}
+ ~DerivedType() {
+ assert(AbstractTypeUsers.empty());
+ }
+
+ /// notifyUsesThatTypeBecameConcrete - Notify AbstractTypeUsers of this type
+ /// that the current type has transitioned from being abstract to being
+ /// concrete.
+ ///
+ void notifyUsesThatTypeBecameConcrete();
+
+ /// dropAllTypeUses - When this (abstract) type is resolved to be equal to
+ /// another (more concrete) type, we must eliminate all references to other
+ /// types, to avoid some circular reference problems.
+ ///
+ void dropAllTypeUses();
+
+ void RefCountIsZero() const {
+ if (AbstractTypeUsers.empty())
+ delete this;
}
- // typeIsRefined - Notify AbstractTypeUsers of this type that the current type
- // has been refined a bit. The pointer is still valid and still should be
- // used, but the subtypes have changed.
- //
- void typeIsRefined();
-
- // setDerivedTypeProperties - Based on the subtypes, set the name of this
- // type so that it is printed nicely by the type printer. Also calculate
- // whether this type is abstract or not. Used by the constructor and when
- // the type is refined.
- //
- void setDerivedTypeProperties();
public:
// are managed by (add|remove)AbstractTypeUser. See comments in
// AbstractTypeUser.h for more information.
- // addAbstractTypeUser - Notify an abstract type that there is a new user of
- // it. This function is called primarily by the PATypeHandle class.
- //
+ /// addAbstractTypeUser - Notify an abstract type that there is a new user of
+ /// it. This function is called primarily by the PATypeHandle class.
+ ///
void addAbstractTypeUser(AbstractTypeUser *U) const {
assert(isAbstract() && "addAbstractTypeUser: Current type not abstract!");
-#if 0
- cerr << " addAbstractTypeUser[" << (void*)this << ", " << getDescription()
- << "][" << AbstractTypeUsers.size() << "] User = " << U << endl;
-#endif
AbstractTypeUsers.push_back(U);
}
- // removeAbstractTypeUser - Notify an abstract type that a user of the class
- // no longer has a handle to the type. This function is called primarily by
- // the PATypeHandle class. When there are no users of the abstract type, it
- // is anihilated, because there is no way to get a reference to it ever again.
- //
+ /// removeAbstractTypeUser - Notify an abstract type that a user of the class
+ /// no longer has a handle to the type. This function is called primarily by
+ /// the PATypeHandle class. When there are no users of the abstract type, it
+ /// is annihilated, because there is no way to get a reference to it ever
+ /// again.
+ ///
void removeAbstractTypeUser(AbstractTypeUser *U) const;
- // getNumAbstractTypeUsers - Return the number of users registered to the type
- inline unsigned getNumAbstractTypeUsers() const {
- assert(isAbstract() && "getNumAbstractTypeUsers: Type not abstract!");
- return AbstractTypeUsers.size();
- }
-
- // refineAbstractTypeTo - This function is used to when it is discovered that
- // the 'this' abstract type is actually equivalent to the NewType specified.
- // This causes all users of 'this' to switch to reference the more concrete
- // type NewType and for 'this' to be deleted.
- //
+ /// refineAbstractTypeTo - This function is used to when it is discovered that
+ /// the 'this' abstract type is actually equivalent to the NewType specified.
+ /// This causes all users of 'this' to switch to reference the more concrete
+ /// type NewType and for 'this' to be deleted.
+ ///
void refineAbstractTypeTo(const Type *NewType);
-};
+ void dump() const { Type::dump(); }
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const DerivedType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->isDerivedType();
+ }
+};
-class MethodType : public DerivedType {
-public:
- typedef vector<PATypeHandle<Type> > ParamTypes;
-private:
- PATypeHandle<Type> ResultType;
- ParamTypes ParamTys;
+/// FunctionType - Class to represent function types
+///
+class FunctionType : public DerivedType {
+ friend class TypeMap<FunctionValType, FunctionType>;
bool isVarArgs;
- MethodType(const MethodType &); // Do not implement
- const MethodType &operator=(const MethodType &); // Do not implement
+ FunctionType(const FunctionType &); // Do not implement
+ const FunctionType &operator=(const FunctionType &); // Do not implement
protected:
- // This should really be private, but it squelches a bogus warning
- // from GCC to make them protected: warning: `class MethodType' only
- // defines private constructors and has no friends
-
- // Private ctor - Only can be created by a static member...
- MethodType(const Type *Result, const vector<const Type*> &Params,
- bool IsVarArgs);
+ /// This should really be private, but it squelches a bogus warning
+ /// from GCC to make them protected: warning: `class FunctionType' only
+ /// defines private constructors and has no friends
+ ///
+ /// Private ctor - Only can be created by a static member...
+ ///
+ FunctionType(const Type *Result, const std::vector<const Type*> &Params,
+ bool IsVarArgs);
public:
+ /// FunctionType::get - This static method is the primary way of constructing
+ /// a FunctionType
+ ///
+ static FunctionType *get(const Type *Result,
+ const std::vector<const Type*> &Params,
+ bool isVarArg);
inline bool isVarArg() const { return isVarArgs; }
- inline const Type *getReturnType() const { return ResultType; }
- inline const ParamTypes &getParamTypes() const { return ParamTys; }
+ inline const Type *getReturnType() const { return ContainedTys[0]; }
+ typedef std::vector<PATypeHandle>::const_iterator param_iterator;
+ param_iterator param_begin() const { return ContainedTys.begin()+1; }
+ param_iterator param_end() const { return ContainedTys.end(); }
- virtual const Type *getContainedType(unsigned i) const {
- return i == 0 ? ResultType : (i <= ParamTys.size() ? ParamTys[i-1] : 0);
- }
- virtual unsigned getNumContainedTypes() const { return ParamTys.size()+1; }
+ // Parameter type accessors...
+ const Type *getParamType(unsigned i) const { return ContainedTys[i+1]; }
- // refineAbstractType - Called when a contained type is found to be more
- // concrete - this could potentially change us from an abstract type to a
- // concrete type.
- //
+ /// getNumParams - Return the number of fixed parameters this function type
+ /// requires. This does not consider varargs.
+ ///
+ unsigned getNumParams() const { return unsigned(ContainedTys.size()-1); }
+
+ // Implement the AbstractTypeUser interface.
virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ virtual void typeBecameConcrete(const DerivedType *AbsTy);
- static MethodType *get(const Type *Result, const vector<const Type*> &Params);
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const FunctionType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == FunctionTyID;
+ }
};
-class ArrayType : public DerivedType {
-private:
- PATypeHandle<Type> ElementType;
- int NumElements; // >= 0 for sized array, -1 for unbounded/unknown array
-
- ArrayType(const ArrayType &); // Do not implement
- const ArrayType &operator=(const ArrayType &); // Do not implement
+/// CompositeType - Common super class of ArrayType, StructType, PointerType
+/// and PackedType
+class CompositeType : public DerivedType {
protected:
- // This should really be private, but it squelches a bogus warning
- // from GCC to make them protected: warning: `class ArrayType' only
- // defines private constructors and has no friends
-
+ inline CompositeType(TypeID id) : DerivedType(id) { }
+public:
- // Private ctor - Only can be created by a static member...
- ArrayType(const Type *ElType, int NumEl);
+ /// getTypeAtIndex - Given an index value into the type, return the type of
+ /// the element.
+ ///
+ virtual const Type *getTypeAtIndex(const Value *V) const = 0;
+ virtual bool indexValid(const Value *V) const = 0;
+
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const CompositeType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == ArrayTyID ||
+ T->getTypeID() == StructTyID ||
+ T->getTypeID() == PointerTyID ||
+ T->getTypeID() == PackedTyID;
+ }
+};
-public:
- inline const Type *getElementType() const { return ElementType; }
- inline int getNumElements() const { return NumElements; }
+/// StructType - Class to represent struct types
+///
+class StructType : public CompositeType {
+ friend class TypeMap<StructValType, StructType>;
+ StructType(const StructType &); // Do not implement
+ const StructType &operator=(const StructType &); // Do not implement
- inline bool isSized() const { return NumElements >= 0; }
- inline bool isUnsized() const { return NumElements == -1; }
+protected:
+ /// This should really be private, but it squelches a bogus warning
+ /// from GCC to make them protected: warning: `class StructType' only
+ /// defines private constructors and has no friends
+ ///
+ /// Private ctor - Only can be created by a static member...
+ ///
+ StructType(const std::vector<const Type*> &Types);
- virtual const Type *getContainedType(unsigned i) const {
- return i == 0 ? ElementType : 0;
+public:
+ /// StructType::get - This static method is the primary way to create a
+ /// StructType.
+ ///
+ static StructType *get(const std::vector<const Type*> &Params);
+
+ // Iterator access to the elements
+ typedef std::vector<PATypeHandle>::const_iterator element_iterator;
+ element_iterator element_begin() const { return ContainedTys.begin(); }
+ element_iterator element_end() const { return ContainedTys.end(); }
+
+ // Random access to the elements
+ unsigned getNumElements() const { return unsigned(ContainedTys.size()); }
+ const Type *getElementType(unsigned N) const {
+ assert(N < ContainedTys.size() && "Element number out of range!");
+ return ContainedTys[N];
}
- virtual unsigned getNumContainedTypes() const { return 1; }
- // refineAbstractType - Called when a contained type is found to be more
- // concrete - this could potentially change us from an abstract type to a
- // concrete type.
- //
+ /// getTypeAtIndex - Given an index value into the type, return the type of
+ /// the element. For a structure type, this must be a constant value...
+ ///
+ virtual const Type *getTypeAtIndex(const Value *V) const ;
+ virtual bool indexValid(const Value *V) const;
+
+ // Implement the AbstractTypeUser interface.
virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ virtual void typeBecameConcrete(const DerivedType *AbsTy);
- static ArrayType *get(const Type *ElementType, int NumElements = -1);
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const StructType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == StructTyID;
+ }
};
-class StructType : public DerivedType {
+/// SequentialType - This is the superclass of the array, pointer and packed
+/// type classes. All of these represent "arrays" in memory. The array type
+/// represents a specifically sized array, pointer types are unsized/unknown
+/// size arrays, packed types represent specifically sized arrays that
+/// allow for use of SIMD instructions. SequentialType holds the common
+/// features of all, which stem from the fact that all three lay their
+/// components out in memory identically.
+///
+class SequentialType : public CompositeType {
+ SequentialType(const SequentialType &); // Do not implement!
+ const SequentialType &operator=(const SequentialType &); // Do not implement!
+protected:
+ SequentialType(TypeID TID, const Type *ElType) : CompositeType(TID) {
+ ContainedTys.reserve(1);
+ ContainedTys.push_back(PATypeHandle(ElType, this));
+ }
+
public:
- typedef vector<PATypeHandle<Type> > ElementTypes;
+ inline const Type *getElementType() const { return ContainedTys[0]; }
-private:
- ElementTypes ETypes; // Element types of struct
+ virtual bool indexValid(const Value *V) const;
+
+ /// getTypeAtIndex - Given an index value into the type, return the type of
+ /// the element. For sequential types, there is only one subtype...
+ ///
+ virtual const Type *getTypeAtIndex(const Value *V) const {
+ return ContainedTys[0];
+ }
+
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const SequentialType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == ArrayTyID ||
+ T->getTypeID() == PointerTyID ||
+ T->getTypeID() == PackedTyID;
+ }
+};
- StructType(const StructType &); // Do not implement
- const StructType &operator=(const StructType &); // Do not implement
+/// ArrayType - Class to represent array types
+///
+class ArrayType : public SequentialType {
+ friend class TypeMap<ArrayValType, ArrayType>;
+ uint64_t NumElements;
+
+ ArrayType(const ArrayType &); // Do not implement
+ const ArrayType &operator=(const ArrayType &); // Do not implement
protected:
- // This should really be private, but it squelches a bogus warning
- // from GCC to make them protected: warning: `class StructType' only
- // defines private constructors and has no friends
+ /// This should really be private, but it squelches a bogus warning
+ /// from GCC to make them protected: warning: `class ArrayType' only
+ /// defines private constructors and has no friends
+ ///
+ /// Private ctor - Only can be created by a static member...
+ ///
+ ArrayType(const Type *ElType, uint64_t NumEl);
- // Private ctor - Only can be created by a static member...
- StructType(const vector<const Type*> &Types);
-
public:
- inline const ElementTypes &getElementTypes() const { return ETypes; }
+ /// ArrayType::get - This static method is the primary way to construct an
+ /// ArrayType
+ ///
+ static ArrayType *get(const Type *ElementType, uint64_t NumElements);
- virtual const Type *getContainedType(unsigned i) const {
- return i < ETypes.size() ? ETypes[i] : 0;
- }
- virtual unsigned getNumContainedTypes() const { return ETypes.size(); }
+ inline uint64_t getNumElements() const { return NumElements; }
- // refineAbstractType - Called when a contained type is found to be more
- // concrete - this could potentially change us from an abstract type to a
- // concrete type.
- //
+ // Implement the AbstractTypeUser interface.
virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ virtual void typeBecameConcrete(const DerivedType *AbsTy);
- static StructType *get(const vector<const Type*> &Params);
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const ArrayType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == ArrayTyID;
+ }
};
+/// PackedType - Class to represent packed types
+///
+class PackedType : public SequentialType {
+ friend class TypeMap<PackedValType, PackedType>;
+ unsigned NumElements;
+
+ PackedType(const PackedType &); // Do not implement
+ const PackedType &operator=(const PackedType &); // Do not implement
+protected:
+ /// This should really be private, but it squelches a bogus warning
+ /// from GCC to make them protected: warning: `class PackedType' only
+ /// defines private constructors and has no friends
+ ///
+ /// Private ctor - Only can be created by a static member...
+ ///
+ PackedType(const Type *ElType, unsigned NumEl);
+
+public:
+ /// PackedType::get - This static method is the primary way to construct an
+ /// PackedType
+ ///
+ static PackedType *get(const Type *ElementType, unsigned NumElements);
+
+ inline unsigned getNumElements() const { return NumElements; }
+
+ // Implement the AbstractTypeUser interface.
+ virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ virtual void typeBecameConcrete(const DerivedType *AbsTy);
+
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const PackedType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == PackedTyID;
+ }
+};
-class PointerType : public DerivedType {
-private:
- PATypeHandle<Type> ValueType;
+/// PointerType - Class to represent pointers
+///
+class PointerType : public SequentialType {
+ friend class TypeMap<PointerValType, PointerType>;
PointerType(const PointerType &); // Do not implement
const PointerType &operator=(const PointerType &); // Do not implement
protected:
// This should really be private, but it squelches a bogus warning
- // from GCC to make them protected: warning: `class PointerType' only
+ // from GCC to make them protected: warning: `class PointerType' only
// defines private constructors and has no friends
-
// Private ctor - Only can be created by a static member...
PointerType(const Type *ElType);
public:
-
- inline const Type *getValueType() const { return ValueType; }
-
- virtual const Type *getContainedType(unsigned i) const {
- return i == 0 ? ValueType : 0;
- }
- virtual unsigned getNumContainedTypes() const { return 1; }
-
+ /// PointerType::get - This is the only way to construct a new pointer type.
static PointerType *get(const Type *ElementType);
- // refineAbstractType - Called when a contained type is found to be more
- // concrete - this could potentially change us from an abstract type to a
- // concrete type.
- //
+ // Implement the AbstractTypeUser interface.
virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ virtual void typeBecameConcrete(const DerivedType *AbsTy);
+
+ // Implement support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const PointerType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == PointerTyID;
+ }
};
+/// OpaqueType - Class to represent abstract types
+///
class OpaqueType : public DerivedType {
-private:
- OpaqueType(const OpaqueType &); // Do not implement
- const OpaqueType &operator=(const OpaqueType &); // Do not implement
+ OpaqueType(const OpaqueType &); // DO NOT IMPLEMENT
+ const OpaqueType &operator=(const OpaqueType &); // DO NOT IMPLEMENT
protected:
- // This should really be private, but it squelches a bogus warning
- // from GCC to make them protected: warning: `class OpaqueType' only
- // defines private constructors and has no friends
-
- // Private ctor - Only can be created by a static member...
+ /// This should really be private, but it squelches a bogus warning
+ /// from GCC to make them protected: warning: `class OpaqueType' only
+ /// defines private constructors and has no friends
+ ///
+ /// Private ctor - Only can be created by a static member...
OpaqueType();
public:
-
- // get - Static factory method for the OpaqueType class...
+ /// OpaqueType::get - Static factory method for the OpaqueType class...
+ ///
static OpaqueType *get() {
return new OpaqueType(); // All opaque types are distinct
}
-};
+ // Implement the AbstractTypeUser interface.
+ virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
+ abort(); // FIXME: this is not really an AbstractTypeUser!
+ }
+ virtual void typeBecameConcrete(const DerivedType *AbsTy) {
+ abort(); // FIXME: this is not really an AbstractTypeUser!
+ }
-// Define some inline methods for the AbstractTypeUser.h:PATypeHandle class.
-// These are defined here because they MUST be inlined, yet are dependant on
-// the definition of the Type class. Of course Type derives from Value, which
-// contains an AbstractTypeUser instance, so there is no good way to factor out
-// the code. Hence this bit of uglyness.
-//
-template <class TypeSubClass> void PATypeHandle<TypeSubClass>::addUser() {
- if (Ty->isAbstract())
- Ty->castDerivedTypeAsserting()->addAbstractTypeUser(User);
-}
-template <class TypeSubClass> void PATypeHandle<TypeSubClass>::removeUser() {
- if (Ty->isAbstract())
- Ty->castDerivedTypeAsserting()->removeAbstractTypeUser(User);
-}
+ // Implement support for type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const OpaqueType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == OpaqueTyID;
+ }
+};
+
+} // End llvm namespace
#endif