//===-- 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
+// 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...
//
namespace llvm {
+class Value;
template<class ValType, class TypeClass> class TypeMap;
class FunctionValType;
class ArrayValType;
class StructValType;
class PointerValType;
+class VectorValType;
+class IntegerValType;
+class APInt;
-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;
+class DerivedType : public Type {
+ friend class Type;
protected:
- DerivedType(PrimitiveID id) : Type("", id) {}
- ~DerivedType() {
- assert(AbstractTypeUsers.empty());
- }
+ explicit DerivedType(TypeID id) : Type(id) {}
/// notifyUsesThatTypeBecameConcrete - Notify AbstractTypeUsers of this type
/// that the current type has transitioned from being abstract to being
///
void dropAllTypeUses();
- void RefCountIsZero() const {
- if (AbstractTypeUsers.empty())
- delete this;
- }
-
-
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.
- ///
- 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;
-
/// 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
///
void refineAbstractTypeTo(const Type *NewType);
- void dump() const { Value::dump(); }
+ 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();
}
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+};
+
+/// Class to represent integer types. Note that this class is also used to
+/// represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and
+/// Int64Ty.
+/// @brief Integer representation type
+class IntegerType : public DerivedType {
+protected:
+ explicit IntegerType(unsigned NumBits) : DerivedType(IntegerTyID) {
+ setSubclassData(NumBits);
+ }
+ friend class TypeMap<IntegerValType, IntegerType>;
+public:
+ /// This enum is just used to hold constants we need for IntegerType.
+ enum {
+ MIN_INT_BITS = 1, ///< Minimum number of bits that can be specified
+ MAX_INT_BITS = (1<<23)-1 ///< Maximum number of bits that can be specified
+ ///< Note that bit width is stored in the Type classes SubclassData field
+ ///< which has 23 bits. This yields a maximum bit width of 8,388,607 bits.
+ };
+
+ /// This static method is the primary way of constructing an IntegerType.
+ /// If an IntegerType with the same NumBits value was previously instantiated,
+ /// that instance will be returned. Otherwise a new one will be created. Only
+ /// one instance with a given NumBits value is ever created.
+ /// @brief Get or create an IntegerType instance.
+ static const IntegerType* get(unsigned NumBits);
+
+ /// @brief Get the number of bits in this IntegerType
+ unsigned getBitWidth() const { return getSubclassData(); }
+
+ /// getBitMask - 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 getBitMask() const {
+ return ~uint64_t(0UL) >> (64-getBitWidth());
+ }
+
+ /// getSignBit - Return a uint64_t with just the most significant bit set (the
+ /// sign bit, if the value is treated as a signed number).
+ uint64_t getSignBit() const {
+ return 1ULL << (getBitWidth()-1);
+ }
+
+ /// For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.
+ /// @returns a bit mask with ones set for all the bits of this type.
+ /// @brief Get a bit mask for this type.
+ APInt getMask() const;
+
+ /// This method determines if the width of this IntegerType is a power-of-2
+ /// in terms of 8 bit bytes.
+ /// @returns true if this is a power-of-2 byte width.
+ /// @brief Is this a power-of-2 byte-width IntegerType ?
+ bool isPowerOf2ByteWidth() const;
+
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const IntegerType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == IntegerTyID;
}
};
/// FunctionType - Class to represent function types
///
class FunctionType : public DerivedType {
+public:
+ /// Function parameters can have attributes to indicate how they should be
+ /// treated by optimizations and code generation. This enumeration lists the
+ /// set of possible attributes.
+ /// @brief Function parameter attributes enumeration.
+ enum ParameterAttributes {
+ NoAttributeSet = 0, ///< No attribute value has been set
+ ZExtAttribute = 1, ///< zero extended before/after call
+ SExtAttribute = 1 << 1, ///< sign extended before/after call
+ NoReturnAttribute = 1 << 2, ///< mark the function as not returning
+ InRegAttribute = 1 << 3, ///< force argument to be passed in register
+ StructRetAttribute= 1 << 4, ///< hidden pointer to structure to return
+ NoUnwindAttribute = 1 << 5 ///< Function doesn't unwind stack
+ };
+ typedef std::vector<ParameterAttributes> ParamAttrsList;
+private:
friend class TypeMap<FunctionValType, FunctionType>;
bool isVarArgs;
+ ParamAttrsList *ParamAttrs;
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 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);
+ FunctionType(const Type *Result, const std::vector<const Type*> &Params,
+ bool IsVarArgs, const ParamAttrsList &Attrs);
public:
/// FunctionType::get - This static method is the primary way of constructing
- /// a FunctionType
+ /// a FunctionType.
///
- static FunctionType *get(const Type *Result,
- const std::vector<const Type*> &Params,
- bool isVarArg);
+ static FunctionType *get(
+ const Type *Result, ///< The result type
+ const std::vector<const Type*> &Params, ///< The types of the parameters
+ bool isVarArg, ///< Whether this is a variable argument length function
+ const ParamAttrsList & Attrs = ParamAttrsList()
+ ///< Indicates the parameter attributes to use, if any. The 0th entry
+ ///< in the list refers to the return type. Parameters are numbered
+ ///< starting at 1.
+ );
inline bool isVarArg() const { return isVarArgs; }
inline const Type *getReturnType() const { return ContainedTys[0]; }
/// getNumParams - Return the number of fixed parameters this function type
/// requires. This does not consider varargs.
///
- unsigned getNumParams() const { return ContainedTys.size()-1; }
+ unsigned getNumParams() const { return unsigned(ContainedTys.size()-1); }
+
+ bool isStructReturn() const {
+ return (getNumParams() && paramHasAttr(1, StructRetAttribute));
+ }
+
+ /// The parameter attributes for the \p ith parameter are returned. The 0th
+ /// parameter refers to the return type of the function.
+ /// @returns The ParameterAttributes for the \p ith parameter.
+ /// @brief Get the attributes for a parameter
+ ParameterAttributes getParamAttrs(unsigned i) const;
+
+ /// @brief Determine if a parameter attribute is set
+ bool paramHasAttr(unsigned i, ParameterAttributes attr) const {
+ return getParamAttrs(i) & attr;
+ }
+
+ /// @brief Return the number of parameter attributes this type has.
+ unsigned getNumAttrs() const {
+ return (ParamAttrs ? unsigned(ParamAttrs->size()) : 0);
+ }
+
+ /// @brief Convert a ParameterAttribute into its assembly text
+ static std::string getParamAttrsText(ParameterAttributes Attr);
// 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->getPrimitiveID() == FunctionTyID;
- }
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+ return T->getTypeID() == FunctionTyID;
}
};
-/// CompositeType - Common super class of ArrayType, StructType, and PointerType
-///
+/// CompositeType - Common super class of ArrayType, StructType, PointerType
+/// and VectorType
class CompositeType : public DerivedType {
protected:
- inline CompositeType(PrimitiveID id) : DerivedType(id) { }
+ inline explicit CompositeType(TypeID id) : DerivedType(id) { }
public:
/// getTypeAtIndex - Given an index value into the type, return the type of
// 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->getPrimitiveID() == ArrayTyID ||
- T->getPrimitiveID() == StructTyID ||
- T->getPrimitiveID() == PointerTyID;
- }
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+ return T->getTypeID() == ArrayTyID ||
+ T->getTypeID() == StructTyID ||
+ T->getTypeID() == PointerTyID ||
+ T->getTypeID() == VectorTyID;
}
};
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
- ///
- /// Private ctor - Only can be created by a static member...
- ///
- StructType(const std::vector<const Type*> &Types);
-
+ StructType(const std::vector<const Type*> &Types, bool isPacked);
public:
/// StructType::get - This static method is the primary way to create a
/// StructType.
///
- static StructType *get(const std::vector<const Type*> &Params);
+ static StructType *get(const std::vector<const Type*> &Params,
+ bool isPacked=false);
// Iterator access to the elements
typedef std::vector<PATypeHandle>::const_iterator element_iterator;
element_iterator element_end() const { return ContainedTys.end(); }
// Random access to the elements
- unsigned getNumElements() const { return ContainedTys.size(); }
+ 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];
// 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->getPrimitiveID() == StructTyID;
- }
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+ return T->getTypeID() == StructTyID;
}
+
+ bool isPacked() const { return getSubclassData(); }
};
-/// SequentialType - This is the superclass of the array and pointer type
-/// classes. Both of these represent "arrays" in memory. The array type
+/// 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. SequentialType holds the common features of both, which stem
-/// from the fact that both lay their components out in memory identically.
+/// size arrays, vector 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(PrimitiveID TID, const Type *ElType) : CompositeType(TID) {
+ SequentialType(TypeID TID, const Type *ElType) : CompositeType(TID) {
ContainedTys.reserve(1);
ContainedTys.push_back(PATypeHandle(ElType, this));
}
public:
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];
}
- virtual bool indexValid(const Value *V) const {
- return V->getType()->isInteger();
- }
// 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->getPrimitiveID() == ArrayTyID ||
- T->getPrimitiveID() == PointerTyID;
- }
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+ return T->getTypeID() == ArrayTyID ||
+ T->getTypeID() == PointerTyID ||
+ T->getTypeID() == VectorTyID;
}
};
///
class ArrayType : public SequentialType {
friend class TypeMap<ArrayValType, ArrayType>;
- unsigned NumElements;
+ 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 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);
-
+ ArrayType(const Type *ElType, uint64_t NumEl);
public:
/// ArrayType::get - This static method is the primary way to construct an
/// ArrayType
///
- static ArrayType *get(const Type *ElementType, unsigned NumElements);
+ static ArrayType *get(const Type *ElementType, uint64_t NumElements);
- inline unsigned getNumElements() const { return NumElements; }
+ inline uint64_t getNumElements() const { return NumElements; }
// Implement the AbstractTypeUser interface.
virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
// 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->getPrimitiveID() == ArrayTyID;
+ return T->getTypeID() == ArrayTyID;
+ }
+};
+
+/// VectorType - Class to represent vector types
+///
+class VectorType : public SequentialType {
+ friend class TypeMap<VectorValType, VectorType>;
+ unsigned NumElements;
+
+ VectorType(const VectorType &); // Do not implement
+ const VectorType &operator=(const VectorType &); // Do not implement
+ VectorType(const Type *ElType, unsigned NumEl);
+public:
+ /// VectorType::get - This static method is the primary way to construct an
+ /// VectorType
+ ///
+ static VectorType *get(const Type *ElementType, unsigned NumElements);
+
+ /// @brief Return the number of elements in the Vector type.
+ inline unsigned getNumElements() const { return NumElements; }
+
+ /// @brief Return the number of bits in the Vector type.
+ inline unsigned getBitWidth() const {
+ return NumElements *getElementType()->getPrimitiveSizeInBits();
}
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+
+ // 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 VectorType *T) { return true; }
+ static inline bool classof(const Type *T) {
+ return T->getTypeID() == VectorTyID;
}
};
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
- // defines private constructors and has no friends
-
- // Private ctor - Only can be created by a static member...
- PointerType(const Type *ElType);
-
+ explicit 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 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->getPrimitiveID() == PointerTyID;
- }
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+ return T->getTypeID() == PointerTyID;
}
};
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();
-
public:
/// OpaqueType::get - Static factory method for the OpaqueType class...
///
// 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->getPrimitiveID() == OpaqueTyID;
- }
- static inline bool classof(const Value *V) {
- return isa<Type>(V) && classof(cast<Type>(V));
+ return T->getTypeID() == OpaqueTyID;
}
};