//===-- llvm/Constants.h - Constant class subclass definitions --*- 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 for the subclasses of Constant, which
-// represent the different flavors of constant values that live in LLVM. Note
-// that Constants are immutable (once created they never change) and are fully
-// shared by structural equivalence. This means that two structurally
-// equivalent constants will always have the same address. Constant's are
-// created on demand as needed and never deleted: thus clients don't have to
-// worry about the lifetime of the objects.
+/// @file This file contains the declarations for the subclasses of Constant,
+/// which represent the different flavors of constant values that live in LLVM.
+/// Note that Constants are immutable (once created they never change) and are
+/// fully shared by structural equivalence. This means that two structurally
+/// equivalent constants will always have the same address. Constant's are
+/// created on demand as needed and never deleted: thus clients don't have to
+/// worry about the lifetime of the objects.
//
//===----------------------------------------------------------------------===//
#include "llvm/Constant.h"
#include "llvm/Type.h"
-#include "llvm/Support/DataTypes.h"
+#include "llvm/ADT/APInt.h"
+#include "llvm/ADT/APFloat.h"
namespace llvm {
class ArrayType;
class StructType;
class PointerType;
-class PackedType;
+class VectorType;
template<class ConstantClass, class TypeClass, class ValType>
struct ConstantCreator;
struct ConvertConstantType;
//===----------------------------------------------------------------------===//
-/// ConstantIntegral - Shared superclass of boolean and integer constants.
-///
-/// This class just defines some common interfaces to be implemented.
-///
-class ConstantIntegral : public Constant {
+/// This is the shared class of boolean and integer constants. This class
+/// represents both boolean and integral constants.
+/// @brief Class for constant integers.
+class ConstantInt : public Constant {
+ static ConstantInt *TheTrueVal, *TheFalseVal;
+ ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
+ ConstantInt(const IntegerType *Ty, const APInt& V);
+ APInt Val;
protected:
- union {
- int64_t Signed;
- uint64_t Unsigned;
- } Val;
- ConstantIntegral(const Type *Ty, uint64_t V);
-public:
-
- /// getRawValue - return the underlying value of this constant as a 64-bit
- /// unsigned integer value.
- ///
- inline uint64_t getRawValue() const { return Val.Unsigned; }
-
- /// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue.
- ///
- virtual bool isNullValue() const = 0;
-
- /// isMaxValue - Return true if this is the largest value that may be
- /// represented by this type.
- ///
- virtual bool isMaxValue() const = 0;
-
- /// isMinValue - Return true if this is the smallest value that may be
- /// represented by this type.
- ///
- virtual bool isMinValue() const = 0;
-
- /// isAllOnesValue - Return true if every bit in this constant is set to true.
- ///
- virtual bool isAllOnesValue() const = 0;
-
- /// Static constructor to get the maximum/minimum/allones constant of
- /// specified (integral) type...
- ///
- static ConstantIntegral *getMaxValue(const Type *Ty);
- static ConstantIntegral *getMinValue(const Type *Ty);
- static ConstantIntegral *getAllOnesValue(const Type *Ty);
-
- /// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const ConstantIntegral *) { return true; }
- static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->isIntegral();
+ static void destroyThis(ConstantInt*v) {
+ Constant::destroyThis(v);
}
-};
-
-
-//===----------------------------------------------------------------------===//
-/// ConstantBool - Boolean Values
-///
-class ConstantBool : public ConstantIntegral {
- ConstantBool(bool V);
+ friend class Value;
public:
- static ConstantBool *True, *False; // The True & False values
-
- /// get() - Static factory methods - Return objects of the specified value
- static ConstantBool *get(bool Value) { return Value ? True : False; }
- static ConstantBool *get(const Type *Ty, bool Value) { return get(Value); }
-
- /// inverted - Return the opposite value of the current value.
- inline ConstantBool *inverted() const { return (this==True) ? False : True; }
-
- /// getValue - return the boolean value of this constant.
- ///
- inline bool getValue() const { return static_cast<bool>(getRawValue()); }
-
- /// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue.
- ///
- virtual bool isNullValue() const { return this == False; }
- virtual bool isMaxValue() const { return this == True; }
- virtual bool isMinValue() const { return this == False; }
- virtual bool isAllOnesValue() const { return this == True; }
-
- /// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const ConstantBool *) { return true; }
- static bool classof(const Value *V) {
- return (V == True) | (V == False);
+ /// Return the constant as an APInt value reference. This allows clients to
+ /// obtain a copy of the value, with all its precision in tact.
+ /// @brief Return the constant's value.
+ inline const APInt& getValue() const {
+ return Val;
}
-};
-
-
-//===----------------------------------------------------------------------===//
-/// ConstantInt - Superclass of ConstantSInt & ConstantUInt, to make dealing
-/// with integral constants easier.
-///
-class ConstantInt : public ConstantIntegral {
-protected:
- ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
- ConstantInt(const Type *Ty, uint64_t V);
-public:
- /// equalsInt - Provide a helper method that can be used to determine if the
- /// constant contained within is equal to a constant. This only works for
- /// very small values, because this is all that can be represented with all
- /// types.
- ///
- bool equalsInt(unsigned char V) const {
- assert(V <= 127 &&
- "equalsInt: Can only be used with very small positive constants!");
- return Val.Unsigned == V;
+
+ /// getBitWidth - Return the bitwidth of this constant.
+ unsigned getBitWidth() const { return Val.getBitWidth(); }
+
+ /// Return the constant as a 64-bit unsigned integer value after it
+ /// has been zero extended as appropriate for the type of this constant. Note
+ /// that this method can assert if the value does not fit in 64 bits.
+ /// @deprecated
+ /// @brief Return the zero extended value.
+ inline uint64_t getZExtValue() const {
+ return Val.getZExtValue();
}
- /// ConstantInt::get static method: return a ConstantInt with the specified
- /// value. as above, we work only with very small values here.
- ///
- static ConstantInt *get(const Type *Ty, unsigned char V);
+ /// Return the constant as a 64-bit integer value after it has been sign
+ /// sign extended as appropriate for the type of this constant. Note that
+ /// this method can assert if the value does not fit in 64 bits.
+ /// @deprecated
+ /// @brief Return the sign extended value.
+ inline int64_t getSExtValue() const {
+ return Val.getSExtValue();
+ }
- /// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue.
- virtual bool isNullValue() const { return Val.Unsigned == 0; }
- virtual bool isMaxValue() const = 0;
- virtual bool isMinValue() const = 0;
+ /// A helper method that can be used to determine if the constant contained
+ /// within is equal to a constant. This only works for very small values,
+ /// because this is all that can be represented with all types.
+ /// @brief Determine if this constant's value is same as an unsigned char.
+ bool equalsInt(uint64_t V) const {
+ return Val == V;
+ }
- /// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const ConstantInt *) { return true; }
- static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->isInteger();
+ /// getTrue/getFalse - Return the singleton true/false values.
+ static inline ConstantInt *getTrue() {
+ if (TheTrueVal) return TheTrueVal;
+ return CreateTrueFalseVals(true);
+ }
+ static inline ConstantInt *getFalse() {
+ if (TheFalseVal) return TheFalseVal;
+ return CreateTrueFalseVals(false);
}
-};
+ /// Return a ConstantInt with the specified value for the specified type. The
+ /// value V will be canonicalized to a an unsigned APInt. Accessing it with
+ /// either getSExtValue() or getZExtValue() will yield a correctly sized and
+ /// signed value for the type Ty.
+ /// @brief Get a ConstantInt for a specific value.
+ static ConstantInt *get(const Type *Ty, uint64_t V, bool isSigned = false);
-//===----------------------------------------------------------------------===//
-/// ConstantSInt - Signed Integer Values [sbyte, short, int, long]
-///
-class ConstantSInt : public ConstantInt {
- ConstantSInt(const ConstantSInt &); // DO NOT IMPLEMENT
- friend struct ConstantCreator<ConstantSInt, Type, int64_t>;
+ /// Return a ConstantInt with the specified value and an implied Type. The
+ /// type is the integer type that corresponds to the bit width of the value.
+ static ConstantInt *get(const APInt &V);
-protected:
- ConstantSInt(const Type *Ty, int64_t V);
-public:
- /// get() - Static factory methods - Return objects of the specified value
+ /// getType - Specialize the getType() method to always return an IntegerType,
+ /// which reduces the amount of casting needed in parts of the compiler.
///
- static ConstantSInt *get(const Type *Ty, int64_t V);
+ inline const IntegerType *getType() const {
+ return reinterpret_cast<const IntegerType*>(Value::getType());
+ }
- /// isValueValidForType - return true if Ty is big enough to represent V.
- ///
+ /// This static method returns true if the type Ty is big enough to
+ /// represent the value V. This can be used to avoid having the get method
+ /// assert when V is larger than Ty can represent. Note that there are two
+ /// versions of this method, one for unsigned and one for signed integers.
+ /// Although ConstantInt canonicalizes everything to an unsigned integer,
+ /// the signed version avoids callers having to convert a signed quantity
+ /// to the appropriate unsigned type before calling the method.
+ /// @returns true if V is a valid value for type Ty
+ /// @brief Determine if the value is in range for the given type.
+ static bool isValueValidForType(const Type *Ty, uint64_t V);
static bool isValueValidForType(const Type *Ty, int64_t V);
- /// getValue - return the underlying value of this constant.
- ///
- inline int64_t getValue() const { return Val.Signed; }
+ /// This function will return true iff this constant represents the "null"
+ /// value that would be returned by the getNullValue method.
+ /// @returns true if this is the null integer value.
+ /// @brief Determine if the value is null.
+ virtual bool isNullValue() const {
+ return Val == 0;
+ }
- virtual bool isAllOnesValue() const { return getValue() == -1; }
+ /// This is just a convenience method to make client code smaller for a
+ /// common code. It also correctly performs the comparison without the
+ /// potential for an assertion from getZExtValue().
+ bool isZero() const {
+ return Val == 0;
+ }
- /// isMaxValue - Return true if this is the largest value that may be
- /// represented by this type.
- ///
- virtual bool isMaxValue() const {
- int64_t V = getValue();
- if (V < 0) return false; // Be careful about wrap-around on 'long's
- ++V;
- return !isValueValidForType(getType(), V) || V < 0;
+ /// This is just a convenience method to make client code smaller for a
+ /// common case. It also correctly performs the comparison without the
+ /// potential for an assertion from getZExtValue().
+ /// @brief Determine if the value is one.
+ bool isOne() const {
+ return Val == 1;
}
- /// isMinValue - Return true if this is the smallest value that may be
- /// represented by this type.
- ///
- virtual bool isMinValue() const {
- int64_t V = getValue();
- if (V > 0) return false; // Be careful about wrap-around on 'long's
- --V;
- return !isValueValidForType(getType(), V) || V > 0;
+ /// This function will return true iff every bit in this constant is set
+ /// to true.
+ /// @returns true iff this constant's bits are all set to true.
+ /// @brief Determine if the value is all ones.
+ bool isAllOnesValue() const {
+ return Val.isAllOnesValue();
}
- /// Methods for support type inquiry through isa, cast, and dyn_cast:
- ///
- static inline bool classof(const ConstantSInt *) { return true; }
- static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->isSigned();
+ /// This function will return true iff this constant represents the largest
+ /// value that may be represented by the constant's type.
+ /// @returns true iff this is the largest value that may be represented
+ /// by this type.
+ /// @brief Determine if the value is maximal.
+ bool isMaxValue(bool isSigned) const {
+ if (isSigned)
+ return Val.isMaxSignedValue();
+ else
+ return Val.isMaxValue();
}
-};
-//===----------------------------------------------------------------------===//
-/// ConstantUInt - Unsigned Integer Values [ubyte, ushort, uint, ulong]
-///
-class ConstantUInt : public ConstantInt {
- ConstantUInt(const ConstantUInt &); // DO NOT IMPLEMENT
- friend struct ConstantCreator<ConstantUInt, Type, uint64_t>;
-protected:
- ConstantUInt(const Type *Ty, uint64_t V);
-public:
- /// get() - Static factory methods - Return objects of the specified value
- ///
- static ConstantUInt *get(const Type *Ty, uint64_t V);
+ /// This function will return true iff this constant represents the smallest
+ /// value that may be represented by this constant's type.
+ /// @returns true if this is the smallest value that may be represented by
+ /// this type.
+ /// @brief Determine if the value is minimal.
+ bool isMinValue(bool isSigned) const {
+ if (isSigned)
+ return Val.isMinSignedValue();
+ else
+ return Val.isMinValue();
+ }
- /// isValueValidForType - return true if Ty is big enough to represent V.
- ///
- static bool isValueValidForType(const Type *Ty, uint64_t V);
+ /// This function will return true iff this constant represents a value with
+ /// active bits bigger than 64 bits or a value greater than the given uint64_t
+ /// value.
+ /// @returns true iff this constant is greater or equal to the given number.
+ /// @brief Determine if the value is greater or equal to the given number.
+ bool uge(uint64_t Num) {
+ return Val.getActiveBits() > 64 || Val.getZExtValue() >= Num;
+ }
- /// getValue - return the underlying value of this constant.
- ///
- inline uint64_t getValue() const { return Val.Unsigned; }
+ /// @returns the 64-bit value of this constant if its active bits number is
+ /// not greater than 64, otherwise, just return the given uint64_t number.
+ /// @brief Get the constant's value if possible.
+ uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
+ return Val.getLimitedValue(Limit);
+ }
- /// isMaxValue - Return true if this is the largest value that may be
- /// represented by this type.
- ///
- virtual bool isAllOnesValue() const;
- virtual bool isMaxValue() const { return isAllOnesValue(); }
- virtual bool isMinValue() const { return getValue() == 0; }
+ /// @returns the value for an integer constant of the given type that has all
+ /// its bits set to true.
+ /// @brief Get the all ones value
+ static ConstantInt *getAllOnesValue(const Type *Ty);
- /// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const ConstantUInt *) { return true; }
+ /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
+ static inline bool classof(const ConstantInt *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->isUnsigned();
+ return V->getValueID() == ConstantIntVal;
}
+ static void ResetTrueFalse() { TheTrueVal = TheFalseVal = 0; }
+private:
+ static ConstantInt *CreateTrueFalseVals(bool WhichOne);
};
/// ConstantFP - Floating Point Values [float, double]
///
class ConstantFP : public Constant {
- double Val;
- friend struct ConstantCreator<ConstantFP, Type, uint64_t>;
- friend struct ConstantCreator<ConstantFP, Type, uint32_t>;
+ APFloat Val;
ConstantFP(const ConstantFP &); // DO NOT IMPLEMENT
protected:
- ConstantFP(const Type *Ty, double V);
+ ConstantFP(const Type *Ty, const APFloat& V);
+ static void destroyThis(ConstantFP*v) {
+ Constant::destroyThis(v);
+ }
+ friend class Value;
public:
/// get() - Static factory methods - Return objects of the specified value
- static ConstantFP *get(const Type *Ty, double V);
+ static ConstantFP *get(const Type *Ty, const APFloat& V);
/// isValueValidForType - return true if Ty is big enough to represent V.
- static bool isValueValidForType(const Type *Ty, double V);
- inline double getValue() const { return Val; }
+ static bool isValueValidForType(const Type *Ty, const APFloat& V);
+ inline const APFloat& getValueAPF() const { return Val; }
/// isNullValue - Return true if this is the value that would be returned by
/// getNullValue. Don't depend on == for doubles to tell us it's zero, it
/// considers -0.0 to be null as well as 0.0. :(
- virtual bool isNullValue() const {
- union {
- double V;
- uint64_t I;
- } T;
- T.V = Val;
- return T.I == 0;
- }
+ virtual bool isNullValue() const;
+
+ // Get a negative zero.
+ static ConstantFP *getNegativeZero(const Type* Ty);
/// isExactlyValue - We don't rely on operator== working on double values, as
/// it returns true for things that are clearly not equal, like -0.0 and 0.0.
/// As such, this method can be used to do an exact bit-for-bit comparison of
- /// two floating point values.
+ /// two floating point values. The version with a double operand is retained
+ /// because it's so convenient to write isExactlyValue(2.0), but please use
+ /// it only for constants.
+ bool isExactlyValue(const APFloat& V) const;
+
bool isExactlyValue(double V) const {
- union {
- double V;
- uint64_t I;
- } T1;
- T1.V = Val;
- union {
- double V;
- uint64_t I;
- } T2;
- T2.V = V;
- return T1.I == T2.I;
+ if (&Val.getSemantics() == &APFloat::IEEEdouble)
+ return isExactlyValue(APFloat(V));
+ else if (&Val.getSemantics() == &APFloat::IEEEsingle)
+ return isExactlyValue(APFloat((float)V));
+ assert(0);
+ return false;
}
-
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantFP *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->isFloatingPoint();
+ return V->getValueID() == ConstantFPVal;
}
};
friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
protected:
- ConstantAggregateZero(const Type *Ty)
- : Constant(Ty, ConstantAggregateZeroVal) {}
+ explicit ConstantAggregateZero(const Type *Ty)
+ : Constant(Ty, ConstantAggregateZeroVal, 0, 0) {}
+
+ static void destroyThis(ConstantAggregateZero*v) {
+ Constant::destroyThis(v);
+ }
+ friend class Value;
public:
/// get() - static factory method for creating a null aggregate. It is
/// illegal to call this method with a non-aggregate type.
virtual bool isNullValue() const { return true; }
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
- bool DisableChecking = false);
/// Methods for support type inquiry through isa, cast, and dyn_cast:
///
static bool classof(const ConstantAggregateZero *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == ConstantAggregateZeroVal;
+ return V->getValueID() == ConstantAggregateZeroVal;
}
};
ConstantArray(const ConstantArray &); // DO NOT IMPLEMENT
protected:
ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
+ static void destroyThis(ConstantArray*);
+ friend class Value;
public:
/// get() - Static factory methods - Return objects of the specified value
static Constant *get(const ArrayType *T, const std::vector<Constant*> &);
- static Constant *get(const std::string &Initializer);
-
+ static Constant *get(const ArrayType *T,
+ Constant*const*Vals, unsigned NumVals) {
+ // FIXME: make this the primary ctor method.
+ return get(T, std::vector<Constant*>(Vals, Vals+NumVals));
+ }
+
+ /// This method constructs a ConstantArray and initializes it with a text
+ /// string. The default behavior (AddNull==true) causes a null terminator to
+ /// be placed at the end of the array. This effectively increases the length
+ /// of the array by one (you've been warned). However, in some situations
+ /// this is not desired so if AddNull==false then the string is copied without
+ /// null termination.
+ static Constant *get(const std::string &Initializer, bool AddNull = true);
+
/// getType - Specialize the getType() method to always return an ArrayType,
/// which reduces the amount of casting needed in parts of the compiler.
///
/// ubyte, and if the elements of the array are all ConstantInt's.
bool isString() const;
+ /// isCString - This method returns true if the array is a string (see
+ /// @verbatim
+ /// isString) and it ends in a null byte \0 and does not contains any other
+ /// @endverbatim
+ /// null bytes except its terminator.
+ bool isCString() const;
+
/// getAsString - If this array is isString(), then this method converts the
/// array to an std::string and returns it. Otherwise, it asserts out.
///
virtual bool isNullValue() const { return false; }
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
- bool DisableChecking = false);
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantArray *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->getTypeID() == Type::ArrayTyID;
+ return V->getValueID() == ConstantArrayVal;
}
};
ConstantStruct(const ConstantStruct &); // DO NOT IMPLEMENT
protected:
ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
+ static void destroyThis(ConstantStruct*);
+ friend class Value;
public:
/// get() - Static factory methods - Return objects of the specified value
///
static Constant *get(const StructType *T, const std::vector<Constant*> &V);
- static Constant *get(const std::vector<Constant*> &V);
-
+ static Constant *get(const std::vector<Constant*> &V, bool Packed = false);
+ static Constant *get(Constant*const* Vals, unsigned NumVals,
+ bool Packed = false) {
+ // FIXME: make this the primary ctor method.
+ return get(std::vector<Constant*>(Vals, Vals+NumVals), Packed);
+ }
+
/// getType() specialization - Reduce amount of casting...
///
inline const StructType *getType() const {
}
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
- bool DisableChecking = false);
-
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
+
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantStruct *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->getTypeID() == Type::StructTyID;
+ return V->getValueID() == ConstantStructVal;
}
};
//===----------------------------------------------------------------------===//
-/// ConstantPacked - Constant Packed Declarations
+/// ConstantVector - Constant Vector Declarations
///
-class ConstantPacked : public Constant {
- friend struct ConstantCreator<ConstantPacked, PackedType,
+class ConstantVector : public Constant {
+ friend struct ConstantCreator<ConstantVector, VectorType,
std::vector<Constant*> >;
- ConstantPacked(const ConstantPacked &); // DO NOT IMPLEMENT
+ ConstantVector(const ConstantVector &); // DO NOT IMPLEMENT
protected:
- ConstantPacked(const PackedType *T, const std::vector<Constant*> &Val);
+ ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
+ static void destroyThis(ConstantVector*v);
+ friend class Value;
public:
/// get() - Static factory methods - Return objects of the specified value
- static Constant *get(const PackedType *T, const std::vector<Constant*> &);
+ static Constant *get(const VectorType *T, const std::vector<Constant*> &);
static Constant *get(const std::vector<Constant*> &V);
+ static Constant *get(Constant*const* Vals, unsigned NumVals) {
+ // FIXME: make this the primary ctor method.
+ return get(std::vector<Constant*>(Vals, Vals+NumVals));
+ }
- /// getType - Specialize the getType() method to always return an PackedType,
+ /// getType - Specialize the getType() method to always return a VectorType,
/// which reduces the amount of casting needed in parts of the compiler.
///
- inline const PackedType *getType() const {
- return reinterpret_cast<const PackedType*>(Value::getType());
+ inline const VectorType *getType() const {
+ return reinterpret_cast<const VectorType*>(Value::getType());
}
+ /// @returns the value for a vector integer constant of the given type that
+ /// has all its bits set to true.
+ /// @brief Get the all ones value
+ static ConstantVector *getAllOnesValue(const VectorType *Ty);
+
/// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue. This always returns false because zero arrays are always
+ /// getNullValue. This always returns false because zero vectors are always
/// created as ConstantAggregateZero objects.
virtual bool isNullValue() const { return false; }
+ /// This function will return true iff every element in this vector constant
+ /// is set to all ones.
+ /// @returns true iff this constant's emements are all set to all ones.
+ /// @brief Determine if the value is all ones.
+ bool isAllOnesValue() const;
+
+ /// getSplatValue - If this is a splat constant, meaning that all of the
+ /// elements have the same value, return that value. Otherwise return NULL.
+ Constant *getSplatValue();
+
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
- bool DisableChecking = false);
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
/// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const ConstantPacked *) { return true; }
+ static inline bool classof(const ConstantVector *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->getTypeID() == Type::PackedTyID;
+ return V->getValueID() == ConstantVectorVal;
}
};
friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
protected:
- ConstantPointerNull(const PointerType *T)
- : Constant(reinterpret_cast<const Type*>(T)) {}
-
+ explicit ConstantPointerNull(const PointerType *T)
+ : Constant(reinterpret_cast<const Type*>(T),
+ Value::ConstantPointerNullVal, 0, 0) {}
+ static void destroyThis(ConstantPointerNull*v) {
+ Constant::destroyThis(v);
+ }
+ friend class Value;
public:
/// get() - Static factory methods - Return objects of the specified value
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantPointerNull *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- isa<PointerType>(V->getType());
+ return V->getValueID() == ConstantPointerNullVal;
}
};
/// ConstantExpr - a constant value that is initialized with an expression using
-/// other constant values. This is only used to represent values that cannot be
-/// evaluated at compile-time (e.g., something derived from an address) because
-/// it does not have a mechanism to store the actual value. Use the appropriate
-/// Constant subclass above for known constants.
+/// other constant values.
///
+/// This class uses the standard Instruction opcodes to define the various
+/// constant expressions. The Opcode field for the ConstantExpr class is
+/// maintained in the Value::SubclassData field.
class ConstantExpr : public Constant {
- unsigned iType; // Operation type (an Instruction opcode)
friend struct ConstantCreator<ConstantExpr,Type,
std::pair<unsigned, std::vector<Constant*> > >;
friend struct ConvertConstantType<ConstantExpr, Type>;
-
+
protected:
- // Cast creation ctor
- ConstantExpr(unsigned Opcode, Constant *C, const Type *Ty);
- // Binary/Shift instruction creation ctor
- ConstantExpr(unsigned Opcode, Constant *C1, Constant *C2);
- // Select instruction creation ctor
- ConstantExpr(Constant *C, Constant *V1, Constant *V2);
- // GEP instruction creation ctor
- ConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
- const Type *DestTy);
+ ConstantExpr(const Type *Ty, unsigned Opcode, Use *Ops, unsigned NumOps)
+ : Constant(Ty, ConstantExprVal, Ops, NumOps) {
+ // Operation type (an Instruction opcode) is stored as the SubclassData.
+ SubclassData = Opcode;
+ }
// These private methods are used by the type resolution code to create
// ConstantExprs in intermediate forms.
static Constant *getTy(const Type *Ty, unsigned Opcode,
Constant *C1, Constant *C2);
- static Constant *getShiftTy(const Type *Ty,
- unsigned Opcode, Constant *C1, Constant *C2);
+ static Constant *getCompareTy(unsigned short pred, Constant *C1,
+ Constant *C2);
static Constant *getSelectTy(const Type *Ty,
Constant *C1, Constant *C2, Constant *C3);
static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
- const std::vector<Value*> &IdxList);
-
+ Value* const *Idxs, unsigned NumIdxs);
+ static Constant *getExtractElementTy(const Type *Ty, Constant *Val,
+ Constant *Idx);
+ static Constant *getInsertElementTy(const Type *Ty, Constant *Val,
+ Constant *Elt, Constant *Idx);
+ static Constant *getShuffleVectorTy(const Type *Ty, Constant *V1,
+ Constant *V2, Constant *Mask);
+
+ static void destroyThis(ConstantExpr* v) {
+ Constant::destroyThis(v);
+ }
+ friend class Value;
public:
// Static methods to construct a ConstantExpr of different kinds. Note that
// these methods may return a object that is not an instance of the
// ConstantExpr class, because they will attempt to fold the constant
// expression into something simpler if possible.
-
+
/// Cast constant expr
///
- static Constant *getCast(Constant *C, const Type *Ty);
- static Constant *getSignExtend(Constant *C, const Type *Ty);
- static Constant *getZeroExtend(Constant *C, const Type *Ty);
+ static Constant *getTrunc (Constant *C, const Type *Ty);
+ static Constant *getSExt (Constant *C, const Type *Ty);
+ static Constant *getZExt (Constant *C, const Type *Ty);
+ static Constant *getFPTrunc (Constant *C, const Type *Ty);
+ static Constant *getFPExtend(Constant *C, const Type *Ty);
+ static Constant *getUIToFP (Constant *C, const Type *Ty);
+ static Constant *getSIToFP (Constant *C, const Type *Ty);
+ static Constant *getFPToUI (Constant *C, const Type *Ty);
+ static Constant *getFPToSI (Constant *C, const Type *Ty);
+ static Constant *getPtrToInt(Constant *C, const Type *Ty);
+ static Constant *getIntToPtr(Constant *C, const Type *Ty);
+ static Constant *getBitCast (Constant *C, const Type *Ty);
+
+ // @brief Convenience function for getting one of the casting operations
+ // using a CastOps opcode.
+ static Constant *getCast(
+ unsigned ops, ///< The opcode for the conversion
+ Constant *C, ///< The constant to be converted
+ const Type *Ty ///< The type to which the constant is converted
+ );
+
+ // @brief Create a ZExt or BitCast cast constant expression
+ static Constant *getZExtOrBitCast(
+ Constant *C, ///< The constant to zext or bitcast
+ const Type *Ty ///< The type to zext or bitcast C to
+ );
+
+ // @brief Create a SExt or BitCast cast constant expression
+ static Constant *getSExtOrBitCast(
+ Constant *C, ///< The constant to sext or bitcast
+ const Type *Ty ///< The type to sext or bitcast C to
+ );
+
+ // @brief Create a Trunc or BitCast cast constant expression
+ static Constant *getTruncOrBitCast(
+ Constant *C, ///< The constant to trunc or bitcast
+ const Type *Ty ///< The type to trunc or bitcast C to
+ );
+
+ /// @brief Create a BitCast or a PtrToInt cast constant expression
+ static Constant *getPointerCast(
+ Constant *C, ///< The pointer value to be casted (operand 0)
+ const Type *Ty ///< The type to which cast should be made
+ );
+
+ /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
+ static Constant *getIntegerCast(
+ Constant *C, ///< The integer constant to be casted
+ const Type *Ty, ///< The integer type to cast to
+ bool isSigned ///< Whether C should be treated as signed or not
+ );
+
+ /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
+ static Constant *getFPCast(
+ Constant *C, ///< The integer constant to be casted
+ const Type *Ty ///< The integer type to cast to
+ );
+
+ /// @brief Return true if this is a convert constant expression
+ bool isCast() const;
+
+ /// @brief Return true if this is a compare constant expression
+ bool isCompare() const;
/// Select constant expr
///
}
/// getSizeOf constant expr - computes the size of a type in a target
- /// independent way (Note: the return type is UInt but the object is not
- /// necessarily a ConstantUInt).
+ /// independent way (Note: the return type is an i64).
///
static Constant *getSizeOf(const Type *Ty);
///
static Constant *get(unsigned Opcode, Constant *C1, Constant *C2);
+ /// @brief Return an ICmp or FCmp comparison operator constant expression.
+ static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
+
/// ConstantExpr::get* - Return some common constants without having to
/// specify the full Instruction::OPCODE identifier.
///
static Constant *getAdd(Constant *C1, Constant *C2);
static Constant *getSub(Constant *C1, Constant *C2);
static Constant *getMul(Constant *C1, Constant *C2);
- static Constant *getDiv(Constant *C1, Constant *C2);
- static Constant *getRem(Constant *C1, Constant *C2);
+ static Constant *getUDiv(Constant *C1, Constant *C2);
+ static Constant *getSDiv(Constant *C1, Constant *C2);
+ static Constant *getFDiv(Constant *C1, Constant *C2);
+ static Constant *getURem(Constant *C1, Constant *C2); // unsigned rem
+ static Constant *getSRem(Constant *C1, Constant *C2); // signed rem
+ static Constant *getFRem(Constant *C1, Constant *C2);
static Constant *getAnd(Constant *C1, Constant *C2);
static Constant *getOr(Constant *C1, Constant *C2);
static Constant *getXor(Constant *C1, Constant *C2);
- static Constant *getSetEQ(Constant *C1, Constant *C2);
- static Constant *getSetNE(Constant *C1, Constant *C2);
- static Constant *getSetLT(Constant *C1, Constant *C2);
- static Constant *getSetGT(Constant *C1, Constant *C2);
- static Constant *getSetLE(Constant *C1, Constant *C2);
- static Constant *getSetGE(Constant *C1, Constant *C2);
+ static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
+ static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
static Constant *getShl(Constant *C1, Constant *C2);
- static Constant *getShr(Constant *C1, Constant *C2);
-
- static Constant *getUShr(Constant *C1, Constant *C2); // unsigned shr
- static Constant *getSShr(Constant *C1, Constant *C2); // signed shr
+ static Constant *getLShr(Constant *C1, Constant *C2);
+ static Constant *getAShr(Constant *C1, Constant *C2);
/// Getelementptr form. std::vector<Value*> is only accepted for convenience:
/// all elements must be Constant's.
///
static Constant *getGetElementPtr(Constant *C,
- const std::vector<Constant*> &IdxList);
+ Constant* const *IdxList, unsigned NumIdx);
static Constant *getGetElementPtr(Constant *C,
- const std::vector<Value*> &IdxList);
+ Value* const *IdxList, unsigned NumIdx);
+ static Constant *getExtractElement(Constant *Vec, Constant *Idx);
+ static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
+ static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
+
+ /// Floating point negation must be implemented with f(x) = -0.0 - x. This
+ /// method returns the negative zero constant for floating point or vector
+ /// floating point types; for all other types, it returns the null value.
+ static Constant *getZeroValueForNegationExpr(const Type *Ty);
+
/// isNullValue - Return true if this is the value that would be returned by
/// getNullValue.
virtual bool isNullValue() const { return false; }
-
+
/// getOpcode - Return the opcode at the root of this constant expression
- unsigned getOpcode() const { return iType; }
+ unsigned getOpcode() const { return SubclassData; }
+
+ /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
+ /// not an ICMP or FCMP constant expression.
+ unsigned getPredicate() const;
/// getOpcodeName - Return a string representation for an opcode.
const char *getOpcodeName() const;
+
+ /// getWithOperandReplaced - Return a constant expression identical to this
+ /// one, but with the specified operand set to the specified value.
+ Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
+
+ /// getWithOperands - This returns the current constant expression with the
+ /// operands replaced with the specified values. The specified operands must
+ /// match count and type with the existing ones.
+ Constant *getWithOperands(const std::vector<Constant*> &Ops) const;
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
- bool DisableChecking = false);
-
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
+
/// Override methods to provide more type information...
- inline Constant *getOperand(unsigned i) {
+ inline Constant *getOperand(unsigned i) {
return cast<Constant>(User::getOperand(i));
}
inline Constant *getOperand(unsigned i) const {
return const_cast<Constant*>(cast<Constant>(User::getOperand(i)));
}
-
+
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantExpr *) { return true; }
static inline bool classof(const Value *V) {
- return V->getValueType() == ConstantExprVal;
+ return V->getValueID() == ConstantExprVal;
}
};
friend struct ConstantCreator<UndefValue, Type, char>;
UndefValue(const UndefValue &); // DO NOT IMPLEMENT
protected:
- UndefValue(const Type *T) : Constant(T, UndefValueVal) {}
+ explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
+ static void destroyThis(UndefValue*v) {
+ Constant::destroyThis(v);
+ }
+ friend class Value;
public:
/// get() - Static factory methods - Return an 'undef' object of the specified
/// type.
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const UndefValue *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == UndefValueVal;
+ return V->getValueID() == UndefValueVal;
+ }
+};
+
+/// GetElementPtrConstantExpr - Helper class for Constants.cpp,
+/// used behind the scenes to implement getelementpr constant exprs.
+class GetElementPtrConstantExpr : public ConstantExpr {
+protected:
+ static void destroyThis(GetElementPtrConstantExpr*v) {
+ delete [] v->OperandList;
+ ConstantExpr::destroyThis(v);
+ }
+ friend class Value;
+public:
+ GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
+ const Type *DestTy);
+};
+
+/// UnaryConstantExpr - Helper class for Constants.cpp, used
+/// behind the scenes to implement unary constant exprs.
+class UnaryConstantExpr : public ConstantExpr {
+ Use Op;
+protected:
+ static void destroyThis(UnaryConstantExpr*v) {
+ ConstantExpr::destroyThis(v);
+ }
+ friend class Value;
+public:
+ UnaryConstantExpr(unsigned Opcode, Constant *C, const Type *Ty);
+};
+
+/// BinaryConstantExpr - Helper class for Constants.cpp, used
+/// behind the scenes to implement binary constant exprs.
+class BinaryConstantExpr : public ConstantExpr {
+ Use Ops[2];
+protected:
+ static void destroyThis(BinaryConstantExpr*v) {
+ ConstantExpr::destroyThis(v);
+ }
+ friend class Value;
+public:
+ BinaryConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
+ : ConstantExpr(C1->getType(), Opcode, Ops, 2) {
+ Ops[0].init(C1, this);
+ Ops[1].init(C2, this);
+ }
+};
+
+/// SelectConstantExpr - Helper class for Constants.cpp, used
+/// behind the scenes to implement select constant exprs.
+class SelectConstantExpr : public ConstantExpr {
+ Use Ops[3];
+protected:
+ static void destroyThis(SelectConstantExpr*v) {
+ ConstantExpr::destroyThis(v);
}
+ friend class Value;
+public:
+ SelectConstantExpr(Constant *C1, Constant *C2, Constant *C3);
+};
+
+/// ExtractElementConstantExpr - Helper class for Constants.cpp, used
+/// behind the scenes to implement extractelement constant exprs.
+class ExtractElementConstantExpr : public ConstantExpr {
+ Use Ops[2];
+protected:
+ static void destroyThis(ExtractElementConstantExpr*v) {
+ ConstantExpr::destroyThis(v);
+ }
+ friend class Value;
+public:
+ ExtractElementConstantExpr(Constant *C1, Constant *C2);
+};
+
+/// InsertElementConstantExpr - Helper class for Constants.cpp, used
+/// behind the scenes to implement insertelement constant exprs.
+class InsertElementConstantExpr : public ConstantExpr {
+ Use Ops[3];
+protected:
+ static void destroyThis(InsertElementConstantExpr*v) {
+ ConstantExpr::destroyThis(v);
+ }
+ friend class Value;
+public:
+ InsertElementConstantExpr(Constant *C1, Constant *C2, Constant *C3);
+};
+
+/// ShuffleVectorConstantExpr - Helper class for Constants.cpp, used
+/// behind the scenes to implement shufflevector constant exprs.
+class ShuffleVectorConstantExpr : public ConstantExpr {
+ Use Ops[3];
+protected:
+ static void destroyThis(ShuffleVectorConstantExpr*v) {
+ ConstantExpr::destroyThis(v);
+ }
+ friend class Value;
+public:
+ ShuffleVectorConstantExpr(Constant *C1, Constant *C2, Constant *C3);
+};
+
+
+
+// CompareConstantExpr - Helper class for Constants.cpp, used
+// behind the scenes to implement ICmp and FCmp constant expressions. This is
+// needed in order to store the predicate value for these instructions.
+class CompareConstantExpr : public ConstantExpr {
+protected:
+ static void destroyThis(CompareConstantExpr*v) {
+ ConstantExpr::destroyThis(v);
+ }
+ friend class Value;
+public:
+ unsigned short predicate;
+ Use Ops[2];
+ CompareConstantExpr(unsigned opc, unsigned short pred,
+ Constant* LHS, Constant* RHS);
};
} // End llvm namespace
projects / oota-llvm.git / blobdiff