-//===-- llvm/DerivedTypes.h - Classes for handling data types ----*- C++ -*--=//
+//===-- llvm/DerivedTypes.h - Classes for handling data types ---*- C++ -*-===//
+//
+// 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
#define LLVM_DERIVED_TYPES_H
#include "llvm/Type.h"
-#include "llvm/CodeGen/TargetMachine.h"
-#include <vector>
-// Future derived types: SIMD packed format
+namespace llvm {
+class Value;
+template<class ValType, class TypeClass> class TypeMap;
+class FunctionValType;
+class ArrayValType;
+class StructValType;
+class PointerValType;
+class PackedValType;
-class MethodType : public Type {
-public:
- typedef vector<const Type*> ParamTypes;
-private:
- const Type *ResultType;
- ParamTypes ParamTys;
- bool isVarArgs;
+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.
+ //
+ mutable std::vector<AbstractTypeUser *> AbstractTypeUsers;
+ friend class Type;
- MethodType(const MethodType &); // Do not implement
- const MethodType &operator=(const MethodType &); // 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
+ DerivedType(TypeID id) : Type("", id) {}
+ ~DerivedType() {
+ assert(AbstractTypeUsers.empty());
+ }
- // Private ctor - Only can be created by a static member...
- MethodType(const Type *Result, const vector<const Type*> &Params,
- bool IsVarArgs, const string &Name);
+ /// 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;
+ }
+
+
public:
- inline bool isVarArg() const { return isVarArgs; }
- inline const Type *getReturnType() const { return ResultType; }
- inline const ParamTypes &getParamTypes() const { return ParamTys; }
+ //===--------------------------------------------------------------------===//
+ // Abstract Type handling methods - These types have special lifetimes, which
+ // 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.
+ ///
+ void addAbstractTypeUser(AbstractTypeUser *U) const {
+ assert(isAbstract() && "addAbstractTypeUser: Current type not abstract!");
+ AbstractTypeUsers.push_back(U);
+ }
- static const MethodType *getMethodType(const Type *Result,
- const ParamTypes &Params);
- static const MethodType *get(const Type *Result, const ParamTypes &Params) {
- return getMethodType(Result, Params);
+ /// 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;
+
+ /// 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 ArrayType : public Type {
-private:
- const Type *ElementType;
- int NumElements; // >= 0 for sized array, -1 for unbounded/unknown array
+/// FunctionType - Class to represent function types
+///
+class FunctionType : public DerivedType {
+ friend class TypeMap<FunctionValType, FunctionType>;
+ bool isVarArgs;
- ArrayType(const ArrayType &); // Do not implement
- const ArrayType &operator=(const ArrayType &); // 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 ArrayType' 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 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);
- // Private ctor - Only can be created by a static member...
- ArrayType(const Type *ElType, int NumEl, const string &Name);
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 ContainedTys[0]; }
- inline const Type *getElementType() const { return ElementType; }
- inline int getNumElements() const { return NumElements; }
+ 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(); }
- inline bool isSized() const { return NumElements >= 0; }
- inline bool isUnsized() const { return NumElements == -1; }
+ // Parameter type accessors...
+ const Type *getParamType(unsigned i) const { return ContainedTys[i+1]; }
- static const ArrayType *getArrayType(const Type *ElementType,
- int NumElements = -1);
- static const ArrayType *get(const Type *ElementType, int NumElements = -1) {
- return getArrayType(ElementType, NumElements);
+ /// 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);
+
+ // 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 StructType : public Type {
+/// CompositeType - Common super class of ArrayType, StructType, PointerType
+/// and PackedType
+class CompositeType : public DerivedType {
+protected:
+ inline CompositeType(TypeID id) : DerivedType(id) { }
public:
- typedef vector<const Type*> ElementTypes;
-
-private:
- ElementTypes ETypes;
- struct StructSizeAndOffsetInfo {
- int storageSize; // -1 until the value is computd
- vector<int> memberOffsets; // -1 until values are computed
- const TargetMachine* targetInfo;
- } *layoutCache;
-
-private:
+
+ /// 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;
+ }
+};
+
+
+/// 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
-
+
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 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);
- // Private ctor - Only can be created by a static member...
- StructType(const vector<const Type*> &Types, const string &Name);
-
- // Reset cached info so it will be computed when first requested
- void ResetCachedInfo() const {
- layoutCache->storageSize = -1;
- layoutCache->memberOffsets.insert(layoutCache->memberOffsets.begin(),
- ETypes.size(), -1);
- layoutCache->targetInfo = 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];
}
-
+
+ /// 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);
+
+ // 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;
+ }
+};
+
+
+/// 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:
- inline const ElementTypes &getElementTypes() const { return ETypes; }
- static const StructType *getStructType(const ElementTypes &Params);
- static const StructType *get(const ElementTypes &Params) {
- return getStructType(Params);
+ inline const Type *getElementType() const { return ContainedTys[0]; }
+
+ 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;
+ }
+};
- unsigned int getStorageSize(const TargetMachine& tmi) const {
- if (layoutCache->targetInfo && layoutCache->targetInfo != &tmi) {
- // target machine has changed (hey it could happen). discard cached info.
- ResetCachedInfo();
- layoutCache->targetInfo = &tmi;
- }
-
- if (layoutCache->storageSize < 0) {
- layoutCache->storageSize = tmi.findOptimalStorageSize(this);
- assert(layoutCache->storageSize >= 0);
- }
- return layoutCache->storageSize;
- }
- unsigned int getElementOffset(int i, const TargetMachine& tmi) const {
- // target machine has changed (hey it could happen). discard cached info.
- if (layoutCache->targetInfo && layoutCache->targetInfo != &tmi)
- ResetCachedInfo();
-
- if (layoutCache->memberOffsets[i] < 0) {
- layoutCache->targetInfo = &tmi; // remember which target was used
-
- unsigned int *offsetVec = tmi.findOptimalMemberOffsets(this);
- for (unsigned i=0, N=layoutCache->memberOffsets.size(); i < N; ++i) {
- layoutCache->memberOffsets[i] = offsetVec[i];
- assert(layoutCache->memberOffsets[i] >= 0);
- }
- delete[] offsetVec;
- }
-
- return layoutCache->memberOffsets[i];
+
+/// ArrayType - Class to represent array types
+///
+class ArrayType : public SequentialType {
+ friend class TypeMap<ArrayValType, ArrayType>;
+ unsigned 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 ArrayType' only
+ /// defines private constructors and has no friends
+ ///
+ /// Private ctor - Only can be created by a static member...
+ ///
+ ArrayType(const Type *ElType, unsigned NumEl);
+
+public:
+ /// ArrayType::get - This static method is the primary way to construct an
+ /// ArrayType
+ ///
+ static ArrayType *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 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);
-class PointerType : public Type {
-private:
- const Type *ValueType;
+ 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;
+ }
+};
+
+
+/// 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:
// 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:
+ /// PointerType::get - This is the only way to construct a new pointer type.
+ static PointerType *get(const Type *ElementType);
+
+ // 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;
+ }
+};
- inline const Type *getValueType() const { return ValueType; }
+/// OpaqueType - Class to represent abstract types
+///
+class OpaqueType : public DerivedType {
+ 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...
+ OpaqueType();
- static const PointerType *getPointerType(const Type *ElementType);
- static const PointerType *get(const Type *ElementType) {
- return getPointerType(ElementType);
+public:
+ /// 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!
+ }
+
+ // 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
projects / oota-llvm.git / blobdiff