//
// 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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#define LLVM_TYPE_H
#include "llvm/AbstractTypeUser.h"
+#include "llvm/LLVMContext.h"
#include "llvm/Support/Casting.h"
-#include "llvm/Support/DataTypes.h"
+#include "llvm/System/DataTypes.h"
+#include "llvm/System/Atomic.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 raw_ostream;
+class Module;
/// This file contains the declaration of the Type class. For more "Type" type
/// stuff, look in DerivedTypes.h.
///
/// 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
+/// 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
/// Type::getPrimitiveType function, or else things will break!
+ /// Also update LLVMTypeKind and LLVMGetTypeKind () in the C binding.
///
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
+ MetadataTyID, ///< 7: Metadata
// 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, ///< 8: Arbitrary bit width integers
+ FunctionTyID, ///< 9: Functions
+ StructTyID, ///< 10: Structures
+ ArrayTyID, ///< 11: Arrays
+ PointerTyID, ///< 12: Pointers
+ OpaqueTyID, ///< 13: Opaque: type with unknown structure
+ VectorTyID, ///< 14: 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 : 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
/// has no AbstractTypeUsers, the type is deleted. This is only sensical for
/// derived types.
///
- mutable unsigned RefCount;
+ mutable sys::cas_flag RefCount;
+
+ /// Context - This refers to the LLVMContext in which this type was uniqued.
+ LLVMContext &Context;
+ friend class LLVMContextImpl;
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 char *Name, TypeID id);
- Type(TypeID id) : ID(id), Abstract(false), RefCount(0), ForwardType(0) {}
+ explicit Type(LLVMContext &C, TypeID id) :
+ ID(id), Abstract(false), SubclassData(0),
+ RefCount(0), Context(C),
+ ForwardType(0), NumContainedTys(0),
+ ContainedTys(0) {}
virtual ~Type() {
- assert(AbstractTypeUsers.empty());
+ assert(AbstractTypeUsers.empty() && "Abstract types remain");
}
/// Types can become nonabstract later, if they are refined.
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(raw_ostream &O) const;
/// @brief Debugging support: print to stderr
void dump() const;
+ /// @brief Debugging support: print to stderr (use type names from context
+ /// module).
+ void dump(const Module *Context) const;
+
+ /// getContext - Fetch the LLVMContext in which this type was uniqued.
+ LLVMContext &getContext() const { return Context; }
+
//===--------------------------------------------------------------------===//
// Property accessors for dealing with types... Some of these virtual methods
// are defined in private classes defined in Type.cpp for primitive types.
///
inline TypeID getTypeID() const { return ID; }
- /// getDescription - Return the string representation of the type...
- const std::string &getDescription() const;
+ /// isVoidTy - Return true if this is 'void'.
+ bool isVoidTy() const { return ID == VoidTyID; }
- /// 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;
- }
+ /// isFloatTy - Return true if this is 'float', a 32-bit IEEE fp type.
+ bool isFloatTy() const { return ID == FloatTyID; }
+
+ /// isDoubleTy - Return true if this is 'double', a 64-bit IEEE fp type.
+ bool isDoubleTy() const { return ID == DoubleTyID; }
- /// 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;
- }
+ /// isX86_FP80Ty - Return true if this is x86 long double.
+ bool isX86_FP80Ty() const { return ID == X86_FP80TyID; }
- /// isInteger - Equivalent to isSigned() || isUnsigned()
- ///
- bool isInteger() const { return ID >= UByteTyID && ID <= LongTyID; }
+ /// isFP128Ty - Return true if this is 'fp128'.
+ bool isFP128Ty() const { return ID == FP128TyID; }
+
+ /// isPPC_FP128Ty - Return true if this is powerpc long double.
+ bool isPPC_FP128Ty() const { return ID == PPC_FP128TyID; }
- /// isIntegral - Returns true if this is an integral type, which is either
- /// BoolTy or one of the Integer types.
+ /// isLabelTy - Return true if this is 'label'.
+ bool isLabelTy() const { return ID == LabelTyID; }
+
+ /// isMetadataTy - Return true if this is 'metadata'.
+ bool isMetadataTy() const { return ID == MetadataTyID; }
+
+ /// getDescription - Return the string representation of the type.
+ std::string getDescription() const;
+
+ /// isInteger - True if this is an instance of IntegerType.
///
- bool isIntegral() const { return isInteger() || this == BoolTy; }
+ bool isInteger() const { return ID == IntegerTyID; }
- /// isFloatingPoint - Return true if this is one of the two floating point
+ /// isIntOrIntVector - Return true if this is an integer type or a vector of
+ /// integer types.
+ ///
+ bool isIntOrIntVector() const;
+
+ /// isFloatingPoint - Return true if this is one of the five 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, i8* to i32*. 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 isPrimitiveType() const { return ID <= LastPrimitiveTyID; }
inline bool isDerivedType() const { return ID >= FirstDerivedTyID; }
- /// isFirstClassType - Return true if the value is holdable in a register.
+ /// isFirstClassType - Return true if the type is "first class", meaning it
+ /// is a valid type for a Value.
///
inline bool isFirstClassType() const {
+ // There are more first-class kinds than non-first-class kinds, so a
+ // negative test is simpler than a positive one.
+ return ID != FunctionTyID && ID != VoidTyID && ID != OpaqueTyID;
+ }
+
+ /// isSingleValueType - Return true if the type is a valid type for a
+ /// virtual register in codegen. This includes all first-class types
+ /// except struct and array types.
+ ///
+ inline bool isSingleValueType() const {
return (ID != VoidTyID && ID <= LastPrimitiveTyID) ||
- ID == PointerTyID || ID == PackedTyID;
+ ID == IntegerTyID || ID == PointerTyID || ID == VectorTyID;
+ }
+
+ /// isAggregateType - Return true if the type is an aggregate type. This
+ /// means it is valid as the first operand of an insertvalue or
+ /// extractvalue instruction. This includes struct and array types, but
+ /// does not include vector types.
+ ///
+ inline bool isAggregateType() const {
+ return ID == StructTyID || ID == ArrayTyID;
}
/// 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.
+ ///
+ /// Note that this may not reflect the size of memory allocated for an
+ /// instance of the type or the number of bytes that are written when an
+ /// instance of the type is stored to memory. The TargetData class provides
+ /// additional query functions to provide this information.
///
- unsigned getPrimitiveSize() const;
unsigned getPrimitiveSizeInBits() const;
- /// getUnsignedVersion - If this is an integer type, return the unsigned
- /// variant of this type. For example int -> uint.
- const Type *getUnsignedVersion() const;
+ /// getScalarSizeInBits - If this is a vector type, return the
+ /// getPrimitiveSizeInBits value for the element type. Otherwise return the
+ /// getPrimitiveSizeInBits value for this type.
+ unsigned getScalarSizeInBits() const;
- /// getSignedVersion - If this is an integer type, return the signed variant
- /// of this type. For example uint -> int.
- const Type *getSignedVersion() const;
-
- /// getIntegralTypeMask - Return a bitmask with ones set for all of the bits
- /// that can be set by an unsigned version of this type. This is 0xFF for
- /// sbyte/ubyte, 0xFFFF for shorts, etc.
- uint64_t getIntegralTypeMask() const {
- assert(isIntegral() && "This only works for integral types!");
- return ~uint64_t(0UL) >> (64-getPrimitiveSizeInBits());
- }
+ /// getFPMantissaWidth - Return the width of the mantissa of this type. This
+ /// is only valid on floating point types. If the FP type does not
+ /// have a stable mantissa (e.g. ppc long double), this method returns -1.
+ int getFPMantissaWidth() 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(LLVMContext &C) const;
+
+ /// getScalarType - If this is a vector type, return the element type,
+ /// otherwise return this.
+ const Type *getScalarType() 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
//
/// getPrimitiveType - Return a type based on an identifier.
- static const Type *getPrimitiveType(TypeID IDNumber);
+ static const Type *getPrimitiveType(LLVMContext &C, TypeID IDNumber);
//===--------------------------------------------------------------------===//
// 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 const Type *getVoidTy(LLVMContext &C);
+ static const Type *getLabelTy(LLVMContext &C);
+ static const Type *getFloatTy(LLVMContext &C);
+ static const Type *getDoubleTy(LLVMContext &C);
+ static const Type *getMetadataTy(LLVMContext &C);
+ static const Type *getX86_FP80Ty(LLVMContext &C);
+ static const Type *getFP128Ty(LLVMContext &C);
+ static const Type *getPPC_FP128Ty(LLVMContext &C);
+ static const IntegerType *getInt1Ty(LLVMContext &C);
+ static const IntegerType *getInt8Ty(LLVMContext &C);
+ static const IntegerType *getInt16Ty(LLVMContext &C);
+ static const IntegerType *getInt32Ty(LLVMContext &C);
+ static const IntegerType *getInt64Ty(LLVMContext &C);
- static Type* LabelTy;
+ //===--------------------------------------------------------------------===//
+ // Convenience methods for getting pointer types with one of the above builtin
+ // types as pointee.
+ //
+ static const PointerType *getFloatPtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getDoublePtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getX86_FP80PtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getFP128PtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getPPC_FP128PtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getInt1PtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getInt8PtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getInt16PtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getInt32PtrTy(LLVMContext &C, unsigned AS = 0);
+ static const PointerType *getInt64PtrTy(LLVMContext &C, unsigned AS = 0);
/// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const Type *T) { return true; }
+ static inline bool classof(const Type *) { return true; }
void addRef() const {
assert(isAbstract() && "Cannot add a reference to a non-abstract type!");
- ++RefCount;
+ sys::AtomicIncrement(&RefCount);
}
void dropRef() const {
// 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 && AbstractTypeUsers.empty())
- delete this;
+ sys::cas_flag OldCount = sys::AtomicDecrement(&RefCount);
+ if (OldCount == 0 && AbstractTypeUsers.empty())
+ this->destroy();
}
/// 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);
- }
+ void addAbstractTypeUser(AbstractTypeUser *U) const;
/// 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
///
void removeAbstractTypeUser(AbstractTypeUser *U) const;
- /// 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();
+ /// getPointerTo - Return a pointer to the current type. This is equivalent
+ /// to PointerType::get(Foo, AddrSpace).
+ const PointerType *getPointerTo(unsigned AddrSpace = 0) const;
private:
/// isSizedDerivedType - Derived types like structures and arrays are sized
//===----------------------------------------------------------------------===//
// 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);
}
-// Define inline methods for PATypeHolder...
-
-inline void PATypeHolder::addRef() {
- if (Ty->isAbstract())
- Ty->addRef();
-}
-
-inline void PATypeHolder::dropRef() {
- if (Ty->isAbstract())
- Ty->dropRef();
-}
+// Define inline methods for PATypeHolder.
/// 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
return *const_cast<PATypeHolder*>(this) = NewTy;
}
+inline void PATypeHolder::addRef() {
+ assert(Ty && "Type Holder has a null type!");
+ if (Ty->isAbstract())
+ Ty->addRef();
+}
+
+inline void PATypeHolder::dropRef() {
+ if (Ty->isAbstract())
+ Ty->dropRef();
+}
//===----------------------------------------------------------------------===//
return Ty.getTypeID() == Type::PointerTyID;
}
-std::ostream &operator<<(std::ostream &OS, const Type &T);
+raw_ostream &operator<<(raw_ostream &OS, const Type &T);
} // End llvm namespace
projects / oota-llvm.git / blobdiff