// 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.
-//
-// Note that instances of the Type class are immutable: once they are created,
-// they are never changed. Also note that only one instance of a particular
-// type is ever created. Thus seeing if two types are equal is a matter of
-// doing a trivial pointer comparison.
-//
-// Types, once allocated, are never free'd, unless they are an abstract type
-// that is resolved to a more concrete type.
-//
-// Opaque types are simple derived types with no state. There may be many
-// different Opaque type objects floating around, but two are only considered
-// identical if they are pointer equals of each other. This allows us to have
-// two opaque types that end up resolving to different concrete types later.
-//
-// Opaque types are also kinda weird and scary and different because they have
-// to keep a list of uses of the type. When, through linking, parsing, or
-// bytecode reading, they become resolved, they need to find and update all
-// users of the unknown type, causing them to reference a new, more concrete
-// type. Opaque types are deleted when their use list dwindles to zero users.
-//
-//===----------------------------------------------------------------------===//
+
#ifndef LLVM_TYPE_H
#define LLVM_TYPE_H
-#include "AbstractTypeUser.h"
+#include "llvm/AbstractTypeUser.h"
#include "llvm/Support/Casting.h"
+#include "llvm/Support/DataTypes.h"
+#include "llvm/Support/Streams.h"
#include "llvm/ADT/GraphTraits.h"
#include "llvm/ADT/iterator"
+#include <string>
#include <vector>
namespace llvm {
-class ArrayType;
class DerivedType;
-class FunctionType;
-class OpaqueType;
class PointerType;
-class StructType;
-class PackedType;
+class IntegerType;
+class TypeMapBase;
-class Type {
+/// This file contains the declaration of the Type class. For more "Type" type
+/// stuff, look in DerivedTypes.h.
+///
+/// The instances of the Type class are immutable: once they are created,
+/// they are never changed. Also note that only one instance of a particular
+/// type is ever created. Thus seeing if two types are equal is a matter of
+/// doing a trivial pointer comparison. To enforce that no two equal instances
+/// are created, Type instances can only be created via static factory methods
+/// in class Type and in derived classes.
+///
+/// Once allocated, Types are never free'd, unless they are an abstract type
+/// that is resolved to a more concrete type.
+///
+/// Types themself don't have a name, and can be named either by:
+/// - using SymbolTable instance, typically from some Module,
+/// - using convenience methods in the Module class (which uses module's
+/// SymbolTable too).
+///
+/// Opaque types are simple derived types with no state. There may be many
+/// different Opaque type objects floating around, but two are only considered
+/// identical if they are pointer equals of each other. This allows us to have
+/// two opaque types that end up resolving to different concrete types later.
+///
+/// Opaque types are also kinda weird and scary and different because they have
+/// to keep a list of uses of the type. When, through linking, parsing, or
+/// bitcode reading, they become resolved, they need to find and update all
+/// users of the unknown type, causing them to reference a new, more concrete
+/// type. Opaque types are deleted when their use list dwindles to zero users.
+///
+/// @brief Root of type hierarchy
+class Type : public AbstractTypeUser {
public:
- ///===-------------------------------------------------------------------===//
+ //===-------------------------------------------------------------------===//
/// Definitions of all of the base types for the Type system. Based on this
/// value, you can cast to a "DerivedType" subclass (see DerivedTypes.h)
/// Note: If you add an element to this, you need to add an element to the
///
enum TypeID {
// PrimitiveTypes .. make sure LastPrimitiveTyID stays up to date
- VoidTyID = 0 , BoolTyID, // 0, 1: Basics...
- UByteTyID , SByteTyID, // 2, 3: 8 bit types...
- UShortTyID , ShortTyID, // 4, 5: 16 bit types...
- UIntTyID , IntTyID, // 6, 7: 32 bit types...
- ULongTyID , LongTyID, // 8, 9: 64 bit types...
- FloatTyID , DoubleTyID, // 10,11: Floating point types...
- LabelTyID , // 12 : Labels...
+ VoidTyID = 0, ///< 0: type with no size
+ FloatTyID, ///< 1: 32 bit floating point type
+ DoubleTyID, ///< 2: 64 bit floating point type
+ X86_FP80TyID, ///< 3: 80 bit floating point type (X87)
+ FP128TyID, ///< 4: 128 bit floating point type (112-bit mantissa)
+ PPC_FP128TyID, ///< 5: 128 bit floating point type (two 64-bits)
+ LabelTyID, ///< 6: Labels
// Derived types... see DerivedTypes.h file...
// Make sure FirstDerivedTyID stays up to date!!!
- FunctionTyID , StructTyID, // Functions... Structs...
- ArrayTyID , PointerTyID, // Array... pointer...
- OpaqueTyID, // Opaque type instances...
- PackedTyID, // SIMD 'packed' format...
- //...
+ IntegerTyID, ///< 7: Arbitrary bit width integers
+ FunctionTyID, ///< 8: Functions
+ StructTyID, ///< 9: Structures
+ ArrayTyID, ///< 10: Arrays
+ PointerTyID, ///< 11: Pointers
+ OpaqueTyID, ///< 12: Opaque: type with unknown structure
+ VectorTyID, ///< 13: SIMD 'packed' format, or other vector type
NumTypeIDs, // Must remain as last defined ID
LastPrimitiveTyID = LabelTyID,
- FirstDerivedTyID = FunctionTyID
+ FirstDerivedTyID = IntegerTyID
};
private:
TypeID ID : 8; // The current base type of this type.
- bool Abstract; // True if type contains an OpaqueType
+ bool Abstract : 1; // True if type contains an OpaqueType
+ unsigned SubclassData : 23; //Space for subclasses to store data
/// 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
mutable unsigned RefCount;
const Type *getForwardedTypeInternal() const;
+
+ // Some Type instances are allocated as arrays, some aren't. So we provide
+ // this method to get the right kind of destruction for the type of Type.
+ void destroy() const; // const is a lie, this does "delete this"!
+
protected:
- Type(const std::string& Name, TypeID id);
- virtual ~Type() {}
+ explicit Type(TypeID id) : ID(id), Abstract(false), SubclassData(0),
+ RefCount(0), ForwardType(0), NumContainedTys(0),
+ ContainedTys(0) {}
+ virtual ~Type() {
+ assert(AbstractTypeUsers.empty() && "Abstract types remain");
+ }
/// Types can become nonabstract later, if they are refined.
///
inline void setAbstract(bool Val) { Abstract = Val; }
- // PromoteAbstractToConcrete - This is an internal method used to calculate
- // change "Abstract" from true to false when types are refined.
- void PromoteAbstractToConcrete();
-
unsigned getRefCount() const { return RefCount; }
+ unsigned getSubclassData() const { return SubclassData; }
+ void setSubclassData(unsigned val) { SubclassData = val; }
+
/// 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;
+
+ /// 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;
+
+ /// NumContainedTys - Keeps track of how many PATypeHandle instances there
+ /// are at the end of this type instance for the list of contained types. It
+ /// is the subclasses responsibility to set this up. Set to 0 if there are no
+ /// contained types in this type.
+ unsigned NumContainedTys;
+
+ /// ContainedTys - A pointer to the array of Types (PATypeHandle) contained
+ /// by this Type. For example, this includes the arguments of a function
+ /// type, the elements of a structure, the pointee of a pointer, the element
+ /// type of an array, etc. This pointer may be 0 for types that don't
+ /// contain other types (Integer, Double, Float). In general, the subclass
+ /// should arrange for space for the PATypeHandles to be included in the
+ /// allocation of the type object and set this pointer to the address of the
+ /// first element. This allows the Type class to manipulate the ContainedTys
+ /// without understanding the subclass's placement for this array. keeping
+ /// it here also allows the subtype_* members to be implemented MUCH more
+ /// efficiently, and dynamically very few types do not contain any elements.
+ PATypeHandle *ContainedTys;
public:
void print(std::ostream &O) const;
+ void print(std::ostream *O) const { if (O) print(*O); }
/// @brief Debugging support: print to stderr
void dump() const;
/// getDescription - Return the string representation of the type...
const std::string &getDescription() const;
- /// 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.
- ///
- bool isSigned() const {
- return ID == SByteTyID || ID == ShortTyID ||
- ID == IntTyID || ID == LongTyID;
- }
-
- /// isUnsigned - Return whether a numeric type is unsigned. This is not quite
- /// the complement of isSigned... nonnumeric types return false as they do
- /// with isSigned. This returns true for UByteTy, UShortTy, UIntTy, and
- /// ULongTy
- ///
- bool isUnsigned() const {
- return ID == UByteTyID || ID == UShortTyID ||
- ID == UIntTyID || ID == ULongTyID;
- }
-
- /// isInteger - Equivalent to isSigned() || isUnsigned()
+ /// isInteger - True if this is an instance of IntegerType.
///
- bool isInteger() const { return ID >= UByteTyID && ID <= LongTyID; }
+ bool isInteger() const { return ID == IntegerTyID; }
- /// isIntegral - Returns true if this is an integral type, which is either
- /// BoolTy or one of the Integer types.
+ /// isIntOrIntVector - Return true if this is an integer type or a vector of
+ /// integer types.
///
- bool isIntegral() const { return isInteger() || this == BoolTy; }
-
+ bool isIntOrIntVector() const;
+
/// isFloatingPoint - Return true if this is one of the two floating point
/// types
- bool isFloatingPoint() const { return ID == FloatTyID || ID == DoubleTyID; }
+ bool isFloatingPoint() const { return ID == FloatTyID || ID == DoubleTyID ||
+ ID == X86_FP80TyID || ID == FP128TyID || ID == PPC_FP128TyID; }
+ /// isFPOrFPVector - Return true if this is a FP type or a vector of FP types.
+ ///
+ bool isFPOrFPVector() const;
+
/// isAbstract - True if the type is either an Opaque type, or is a derived
/// type that includes an opaque type somewhere in it.
///
inline bool isAbstract() const { return Abstract; }
- /// isLosslesslyConvertibleTo - Return true if this type can be converted to
- /// 'Ty' without any reinterpretation of bits. For example, uint to int.
- ///
- bool isLosslesslyConvertibleTo(const Type *Ty) const;
+ /// canLosslesslyBitCastTo - Return true if this type could be converted
+ /// with a lossless BitCast to type 'Ty'. For example, uint to int. BitCasts
+ /// are valid for types of the same size only where no re-interpretation of
+ /// the bits is done.
+ /// @brief Determine if this type could be losslessly bitcast to Ty
+ bool canLosslesslyBitCastTo(const Type *Ty) const;
/// Here are some useful little methods to query what type derived types are
///
inline bool isFirstClassType() const {
return (ID != VoidTyID && ID <= LastPrimitiveTyID) ||
- ID == PointerTyID || ID == PackedTyID;
+ ID == IntegerTyID || ID == PointerTyID || ID == VectorTyID;
}
/// isSized - Return true if it makes sense to take the size of this type. To
///
bool isSized() const {
// If it's a primitive, it is always sized.
- if (ID >= BoolTyID && ID <= DoubleTyID || ID == PointerTyID)
+ if (ID == IntegerTyID || isFloatingPoint() || ID == PointerTyID)
return true;
// If it is not something that can have a size (e.g. a function or label),
// it doesn't have a size.
- if (ID != StructTyID && ID != ArrayTyID && ID != PackedTyID)
+ if (ID != StructTyID && ID != ArrayTyID && ID != VectorTyID)
return false;
// If it is something that can have a size and it's concrete, it definitely
// has a size, otherwise we have to try harder to decide.
return !isAbstract() || isSizedDerivedType();
}
- /// getPrimitiveSize - Return the basic size of this type if it is a primitive
- /// type. These are fixed by LLVM and are not target dependent. This will
- /// return zero if the type does not have a size or is not a primitive type.
+ /// getPrimitiveSizeInBits - Return the basic size of this type if it is a
+ /// primitive type. These are fixed by LLVM and are not target dependent.
+ /// This will return zero if the type does not have a size or is not a
+ /// primitive type.
///
- 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;
+ unsigned getPrimitiveSizeInBits() 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
+ /// getForwardedType - 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, and shouldn't be used by general
/// purpose clients.
/// getVAArgsPromotedType - Return the type an argument of this type
/// will be promoted to if passed through a variable argument
/// function.
- const Type *getVAArgsPromotedType() const {
- if (ID == BoolTyID || ID == UByteTyID || ID == UShortTyID)
- return Type::UIntTy;
- else if (ID == SByteTyID || ID == ShortTyID)
- return Type::IntTy;
- else if (ID == FloatTyID)
- return Type::DoubleTy;
- else
- return this;
- }
+ const Type *getVAArgsPromotedType() const;
//===--------------------------------------------------------------------===//
// Type Iteration support
//
- typedef std::vector<PATypeHandle>::const_iterator subtype_iterator;
- subtype_iterator subtype_begin() const { return ContainedTys.begin(); }
- subtype_iterator subtype_end() const { return ContainedTys.end(); }
+ typedef PATypeHandle *subtype_iterator;
+ subtype_iterator subtype_begin() const { return ContainedTys; }
+ subtype_iterator subtype_end() const { return &ContainedTys[NumContainedTys];}
/// 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.
///
const Type *getContainedType(unsigned i) const {
- assert(i < ContainedTys.size() && "Index out of range!");
- return ContainedTys[i];
+ assert(i < NumContainedTys && "Index out of range!");
+ return ContainedTys[i].get();
}
/// getNumContainedTypes - Return the number of types in the derived type.
///
- typedef std::vector<PATypeHandle>::size_type size_type;
- size_type getNumContainedTypes() const { return ContainedTys.size(); }
+ unsigned getNumContainedTypes() const { return NumContainedTys; }
//===--------------------------------------------------------------------===//
// Static members exported by the Type class itself. Useful for getting
//===--------------------------------------------------------------------===//
// These are the builtin types that are always available...
//
- static Type *VoidTy , *BoolTy;
- static Type *SByteTy, *UByteTy,
- *ShortTy, *UShortTy,
- *IntTy , *UIntTy,
- *LongTy , *ULongTy;
- static Type *FloatTy, *DoubleTy;
-
- static Type* LabelTy;
+ static const Type *VoidTy, *LabelTy, *FloatTy, *DoubleTy;
+ static const Type *X86_FP80Ty, *FP128Ty, *PPC_FP128Ty;
+ static const IntegerType *Int1Ty, *Int8Ty, *Int16Ty, *Int32Ty, *Int64Ty;
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const Type *T) { return true; }
-#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;
// 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();
+ if (--RefCount == 0 && AbstractTypeUsers.empty())
+ this->destroy();
}
-
- /// clearAllTypeMaps - This method frees all internal memory used by the
- /// type subsystem, which can be used in environments where this memory is
- /// otherwise reported as a leak.
- static void clearAllTypeMaps();
+
+ /// 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);
+ }
+
+ /// 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;
private:
/// isSizedDerivedType - Derived types like structures and arrays are sized
/// their size is relatively uncommon, move this operation out of line.
bool isSizedDerivedType() const;
- virtual void RefCountIsZero() const {
- abort(); // only on derived types!
- }
+ virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ virtual void typeBecameConcrete(const DerivedType *AbsTy);
+protected:
+ // PromoteAbstractToConcrete - This is an internal method used to calculate
+ // change "Abstract" from true to false when types are refined.
+ void PromoteAbstractToConcrete();
+ friend class TypeMapBase;
};
//===----------------------------------------------------------------------===//
// 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.
+// the definition of the Type class.
//
inline void PATypeHandle::addUser() {
assert(Ty && "Type Handle has a null type!");
Ty->removeAbstractTypeUser(User);
}
-inline void PATypeHandle::removeUserFromConcrete() {
- if (!Ty->isAbstract())
- Ty->removeAbstractTypeUser(User);
-}
-
// Define inline methods for PATypeHolder...
inline void PATypeHolder::addRef() {
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 Type* PATypeHolder::get() const {
- const Type *NewTy = Ty->getForwardedType();
- if (!NewTy) return const_cast<Type*>(Ty);
- return *const_cast<PATypeHolder*>(this) = NewTy;
-}
-
-
//===----------------------------------------------------------------------===//
// Provide specializations of GraphTraits to be able to treat a type as a
projects / oota-llvm.git / blobdiff