//===-- llvm/Type.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 declaration of the Type class. For more "Type" type
// stuff, look in DerivedTypes.h.
#include "llvm/Value.h"
#include "Support/GraphTraits.h"
#include "Support/iterator"
+#include <vector>
+
+namespace llvm {
class DerivedType;
class FunctionType;
/// Note: If you add an element to this, you need to add an element to the
/// Type::getPrimitiveType function, or else things will break!
///
- enum PrimitiveID {
+ enum TypeID {
VoidTyID = 0 , BoolTyID, // 0, 1: Basics...
UByteTyID , SByteTyID, // 2, 3: 8 bit types...
UShortTyID , ShortTyID, // 4, 5: 16 bit types...
//PackedTyID , // SIMD 'packed' format... TODO
//...
- NumPrimitiveIDs, // Must remain as last defined ID
+ NumTypeIDs, // Must remain as last defined ID
FirstDerivedTyID = FunctionTyID,
};
private:
- PrimitiveID ID; // The current base type of this type...
- unsigned UID; // The unique ID number for this class
- bool Abstract; // True if type contains an OpaqueType
+ TypeID ID; // The current base type of this type...
+ unsigned UID; // The unique ID number for this class
+ bool Abstract; // True if type contains an OpaqueType
+
+ /// RefCount - This counts the number of PATypeHolders that are pointing to
+ /// this type. When this number falls to zero, if the type is abstract and
+ /// has no AbstractTypeUsers, the type is deleted. This is only sensical for
+ /// derived types.
+ ///
+ mutable unsigned RefCount;
const Type *getForwardedTypeInternal() const;
protected:
/// ctor is protected, so only subclasses can create Type objects...
- Type(const std::string &Name, PrimitiveID id);
+ Type(const std::string &Name, TypeID id);
virtual ~Type() {}
- /// setName - Associate the name with this type in the symbol table, but don't
- /// set the local name to be equal specified name.
- ///
- virtual void setName(const std::string &Name, SymbolTable *ST = 0);
/// Types can become nonabstract later, if they are refined.
///
///
bool isTypeAbstract();
+ unsigned getRefCount() const { return RefCount; }
+
/// ForwardType - This field is used to implement the union find scheme for
/// abstract types. When types are refined to other types, this field is set
/// to the more refined type. Only abstract types can be forwarded.
mutable const Type *ForwardType;
+ /// ContainedTys - The list of types contained by this one. For example, this
+ /// includes the arguments of a function type, the elements of the structure,
+ /// the pointee of a pointer, etc. Note that keeping this vector in the Type
+ /// class wastes some space for types that do not contain anything (such as
+ /// primitive types). However, keeping it here allows the subtype_* members
+ /// to be implemented MUCH more efficiently, and dynamically very few types do
+ /// not contain any elements (most are derived).
+ std::vector<PATypeHandle> ContainedTys;
+
public:
virtual void print(std::ostream &O) const;
+ /// @brief Debugging support: print to stderr
+ virtual void dump() const;
+
+ /// setName - Associate the name with this type in the symbol table, but don't
+ /// set the local name to be equal specified name.
+ ///
+ virtual void setName(const std::string &Name, SymbolTable *ST = 0);
+
//===--------------------------------------------------------------------===//
// Property accessors for dealing with types... Some of these virtual methods
// are defined in private classes defined in Type.cpp for primitive types.
//
- /// getPrimitiveID - Return the base type of the type. This will return one
- /// of the PrimitiveID enum elements defined above.
+ /// getTypeID - Return the type id for the type. This will return one
+ /// of the TypeID enum elements defined above.
///
- inline PrimitiveID getPrimitiveID() const { return ID; }
+ inline TypeID getTypeID() const { return ID; }
/// getUniqueID - Returns the UID of the type. This can be thought of as a
/// small integer version of the pointer to the type class. Two types that
/// isSigned - Return whether an integral numeric type is signed. This is
/// true for SByteTy, ShortTy, IntTy, LongTy. Note that this is not true for
/// Float and Double.
- //
+ ///
virtual bool isSigned() const { return 0; }
/// isUnsigned - Return whether a numeric type is unsigned. This is not quite
/// isFirstClassType - Return true if the value is holdable in a register.
inline bool isFirstClassType() const {
- return isPrimitiveType() || ID == PointerTyID;
+ return (ID != VoidTyID && ID < TypeTyID) || ID == PointerTyID;
}
/// isSized - Return true if it makes sense to take the size of this type. To
///
unsigned getPrimitiveSize() const;
+ /// getUnsignedVersion - If this is an integer type, return the unsigned
+ /// variant of this type. For example int -> uint.
+ const Type *getUnsignedVersion() const;
+
+ /// getSignedVersion - If this is an integer type, return the signed variant
+ /// of this type. For example uint -> int.
+ const Type *getSignedVersion() const;
+
/// getForwaredType - Return the type that this type has been resolved to if
/// it has been resolved to anything. This is used to implement the
- /// union-find algorithm for type resolution.
+ /// union-find algorithm for type resolution, and shouldn't be used by general
+ /// purpose clients.
const Type *getForwardedType() const {
if (!ForwardType) return 0;
return getForwardedTypeInternal();
//===--------------------------------------------------------------------===//
// Type Iteration support
//
- class TypeIterator;
- typedef TypeIterator subtype_iterator;
- inline subtype_iterator subtype_begin() const; // DEFINED BELOW
- inline subtype_iterator subtype_end() const; // DEFINED BELOW
+ typedef std::vector<PATypeHandle>::const_iterator subtype_iterator;
+ subtype_iterator subtype_begin() const { return ContainedTys.begin(); }
+ subtype_iterator subtype_end() const { return ContainedTys.end(); }
/// getContainedType - This method is used to implement the type iterator
/// (defined a the end of the file). For derived types, this returns the
/// types 'contained' in the derived type.
///
- virtual const Type *getContainedType(unsigned i) const {
- assert(0 && "No contained types!");
- return 0;
+ const Type *getContainedType(unsigned i) const {
+ assert(i < ContainedTys.size() && "Index out of range!");
+ return ContainedTys[i];
}
- /// getNumContainedTypes - Return the number of types in the derived type
- virtual unsigned getNumContainedTypes() const { return 0; }
+ /// getNumContainedTypes - Return the number of types in the derived type.
+ ///
+ unsigned getNumContainedTypes() const { return ContainedTys.size(); }
//===--------------------------------------------------------------------===//
// Static members exported by the Type class itself. Useful for getting
//
/// getPrimitiveType/getUniqueIDType - Return a type based on an identifier.
- static const Type *getPrimitiveType(PrimitiveID IDNumber);
+ static const Type *getPrimitiveType(TypeID IDNumber);
static const Type *getUniqueIDType(unsigned UID);
//===--------------------------------------------------------------------===//
#include "llvm/Type.def"
+ // Virtual methods used by callbacks below. These should only be implemented
+ // in the DerivedType class.
+ virtual void addAbstractTypeUser(AbstractTypeUser *U) const {
+ abort(); // Only on derived types!
+ }
+ virtual void removeAbstractTypeUser(AbstractTypeUser *U) const {
+ abort(); // Only on derived types!
+ }
+
+ void addRef() const {
+ assert(isAbstract() && "Cannot add a reference to a non-abstract type!");
+ ++RefCount;
+ }
+
+ void dropRef() const {
+ assert(isAbstract() && "Cannot drop a refernce to a non-abstract type!");
+ assert(RefCount && "No objects are currently referencing this object!");
+
+ // If this is the last PATypeHolder using this object, and there are no
+ // PATypeHandles using it, the type is dead, delete it now.
+ if (--RefCount == 0)
+ RefCountIsZero();
+ }
private:
- class TypeIterator : public bidirectional_iterator<const Type, ptrdiff_t> {
- const Type * const Ty;
- unsigned Idx;
-
- typedef TypeIterator _Self;
- public:
- TypeIterator(const Type *ty, unsigned idx) : Ty(ty), Idx(idx) {}
- ~TypeIterator() {}
-
- const _Self &operator=(const _Self &RHS) {
- assert(Ty == RHS.Ty && "Cannot assign from different types!");
- Idx = RHS.Idx;
- return *this;
- }
-
- bool operator==(const _Self& x) const { return Idx == x.Idx; }
- bool operator!=(const _Self& x) const { return !operator==(x); }
-
- pointer operator*() const { return Ty->getContainedType(Idx); }
- pointer operator->() const { return operator*(); }
-
- _Self& operator++() { ++Idx; return *this; } // Preincrement
- _Self operator++(int) { // Postincrement
- _Self tmp = *this; ++*this; return tmp;
- }
-
- _Self& operator--() { --Idx; return *this; } // Predecrement
- _Self operator--(int) { // Postdecrement
- _Self tmp = *this; --*this; return tmp;
- }
- };
+ virtual void RefCountIsZero() const {
+ abort(); // only on derived types!
+ }
+
};
-inline Type::TypeIterator Type::subtype_begin() const {
- return TypeIterator(this, 0);
+//===----------------------------------------------------------------------===//
+// Define some inline methods for the AbstractTypeUser.h:PATypeHandle class.
+// These are defined here because they MUST be inlined, yet are dependent 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.
+//
+// In the long term, Type should not derive from Value, allowing
+// AbstractTypeUser.h to #include Type.h, allowing us to eliminate this
+// nastyness entirely.
+//
+inline void PATypeHandle::addUser() {
+ assert(Ty && "Type Handle has a null type!");
+ if (Ty->isAbstract())
+ Ty->addAbstractTypeUser(User);
+}
+inline void PATypeHandle::removeUser() {
+ if (Ty->isAbstract())
+ Ty->removeAbstractTypeUser(User);
+}
+
+inline void PATypeHandle::removeUserFromConcrete() {
+ if (!Ty->isAbstract())
+ Ty->removeAbstractTypeUser(User);
}
-inline Type::TypeIterator Type::subtype_end() const {
- return TypeIterator(this, getNumContainedTypes());
+// Define inline methods for PATypeHolder...
+
+inline void PATypeHolder::addRef() {
+ if (Ty->isAbstract())
+ Ty->addRef();
}
+inline void PATypeHolder::dropRef() {
+ if (Ty->isAbstract())
+ Ty->dropRef();
+}
+/// get - This implements the forwarding part of the union-find algorithm for
+/// abstract types. Before every access to the Type*, we check to see if the
+/// type we are pointing to is forwarding to a new type. If so, we drop our
+/// reference to the type.
+///
+inline const Type* PATypeHolder::get() const {
+ const Type *NewTy = Ty->getForwardedType();
+ if (!NewTy) return Ty;
+ return *const_cast<PATypeHolder*>(this) = NewTy;
+}
+
+
+
+//===----------------------------------------------------------------------===//
// Provide specializations of GraphTraits to be able to treat a type as a
// graph of sub types...
};
template <> inline bool isa_impl<PointerType, Type>(const Type &Ty) {
- return Ty.getPrimitiveID() == Type::PointerTyID;
+ return Ty.getTypeID() == Type::PointerTyID;
}
+} // End llvm namespace
+
#endif