//
// 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.
//
//===----------------------------------------------------------------------===//
//
#include "llvm/Constant.h"
#include "llvm/Type.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;
//===----------------------------------------------------------------------===//
-/// This is the shared class of boolean and integrer constants. This class
+/// 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 {
-protected:
- uint64_t Val;
-protected:
+ static ConstantInt *TheTrueVal, *TheFalseVal;
ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
- ConstantInt(const Type *Ty, uint64_t V);
- ConstantInt(const Type *Ty, int64_t V);
- ConstantInt(bool V);
- friend struct ConstantCreator<ConstantInt, Type, uint64_t>;
+ ConstantInt(const IntegerType *Ty, const APInt& V);
+ APInt Val;
public:
+ /// 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;
+ }
+
+ /// 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.
+ /// 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;
+ return Val.getZExtValue();
}
/// Return the constant as a 64-bit integer value after it has been sign
- /// sign extended as appropriate for the type of this constant.
+ /// 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 {
- unsigned Size = getType()->getPrimitiveSizeInBits();
- return (int64_t(Val) << (64-Size)) >> (64-Size);
+ return Val.getSExtValue();
}
+
/// 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(unsigned char V) const {
- assert(V <= 127 &&
- "equalsInt: Can only be used with very small positive constants!");
+ bool equalsInt(uint64_t V) const {
return Val == V;
}
/// getTrue/getFalse - Return the singleton true/false values.
static inline ConstantInt *getTrue() {
- static ConstantInt *T = 0;
- if (T) return T;
- return T = new ConstantInt(true);
+ if (TheTrueVal) return TheTrueVal;
+ return CreateTrueFalseVals(true);
}
static inline ConstantInt *getFalse() {
- static ConstantInt *F = 0;
- if (F) return F;
- return F = new ConstantInt(false);
+ if (TheFalseVal) return TheFalseVal;
+ return CreateTrueFalseVals(false);
}
- /// @brief Static factory method for getting a ConstantInt instance which
- /// stands for a bool value.
- static ConstantInt *get(bool Value) { return Value ? getTrue() : getFalse();}
-
/// Return a ConstantInt with the specified value for the specified type. The
- /// value V will be canonicalized to a uint64_t but accessing it with either
- /// getSExtValue() or getZExtValue() (ConstantInt) will yield the correct
- /// sized/signed value for the type Ty.
+ /// 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, int64_t V);
+ static ConstantInt *get(const Type *Ty, uint64_t V, bool isSigned = false);
- /// Returns the opposite value of this ConstantInt.
- /// @brief Get inverse value.
- inline ConstantInt *inverted() const {
- static ConstantInt *CI = 0;
- if (CI) return CI;
- return CI = new ConstantInt(getType(),
- Val ^ (getType() == Type::Int1Ty ? 1 : -1));
- }
+ /// 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);
- /// @returns the value of this ConstantInt only if it's a boolean type.
- /// @brief return the boolean value of this constant.
- inline bool getBoolValue() const {
- assert(getType() == Type::Int1Ty && "Should be a boolean constant!");
- return static_cast<bool>(getZExtValue());
+ /// getType - Specialize the getType() method to always return an IntegerType,
+ /// which reduces the amount of casting needed in parts of the compiler.
+ ///
+ inline const IntegerType *getType() const {
+ return reinterpret_cast<const IntegerType*>(Value::getType());
}
/// This static method returns true if the type Ty is big enough to
return Val == 0;
}
+ /// 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;
+ }
+
+ /// 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;
+ }
+
/// 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.
- virtual bool isAllOnesValue() const {
- if (getType() == Type::Int1Ty) return getBoolValue() == true;
- return getSExtValue() == -1;
+ bool isAllOnesValue() const {
+ return Val.isAllOnesValue();
}
/// This function will return true iff this constant represents the largest
/// @returns true iff this is the largest value that may be represented
/// by this type.
/// @brief Determine if the value is maximal.
- virtual bool isMaxValue(bool isSigned) const {
- if (getType() == Type::Int1Ty) return getBoolValue() == true;
- if (isSigned) {
- int64_t V = getSExtValue();
- if (V < 0) return false; // Be careful about wrap-around on 'long's
- ++V;
- return !isValueValidForType(getType(), V) || V < 0;
- }
- return isAllOnesValue();
+ bool isMaxValue(bool isSigned) const {
+ if (isSigned)
+ return Val.isMaxSignedValue();
+ else
+ return Val.isMaxValue();
}
/// This function will return true iff this constant represents the smallest
/// @returns true if this is the smallest value that may be represented by
/// this type.
/// @brief Determine if the value is minimal.
- virtual bool isMinValue(bool isSigned) const {
- if (getType() == Type::Int1Ty) return getBoolValue() == false;
- if (isSigned) {
- int64_t V = getSExtValue();
- if (V > 0) return false; // Be careful about wrap-around on 'long's
- --V;
- return !isValueValidForType(getType(), V) || V > 0;
- }
- return getZExtValue() == 0;
+ bool isMinValue(bool isSigned) const {
+ if (isSigned)
+ return Val.isMinSignedValue();
+ else
+ return Val.isMinValue();
+ }
+
+ /// 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;
+ }
+
+ /// @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);
}
/// @returns the value for an integer constant of the given type that has all
/// @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() == ConstantIntVal;
+ 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);
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;
+ // 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.
- bool isExactlyValue(double V) const;
-
+ /// 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 {
+ 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() == ConstantFPVal;
+ return V->getValueID() == ConstantFPVal;
}
};
friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
protected:
- ConstantAggregateZero(const Type *Ty)
+ explicit ConstantAggregateZero(const Type *Ty)
: Constant(Ty, ConstantAggregateZeroVal, 0, 0) {}
public:
/// get() - static factory method for creating a null aggregate. It is
///
static bool classof(const ConstantAggregateZero *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == ConstantAggregateZeroVal;
+ return V->getValueID() == ConstantAggregateZeroVal;
}
};
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 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
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;
/// 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() == ConstantArrayVal;
+ return V->getValueID() == ConstantArrayVal;
}
};
/// 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, bool packed = false);
-
+ 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 {
/// 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() == ConstantStructVal;
+ 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);
- ~ConstantPacked();
+ ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
+ ~ConstantVector();
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);
-
- /// getType - Specialize the getType() method to always return an PackedType,
+ 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 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 an packed integer constant of the given type that
+ /// @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 ConstantPacked *getAllOnesValue(const PackedType *Ty);
+ 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, 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() == ConstantPackedVal;
+ return V->getValueID() == ConstantVectorVal;
}
};
friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
protected:
- ConstantPointerNull(const PointerType *T)
+ explicit ConstantPointerNull(const PointerType *T)
: Constant(reinterpret_cast<const Type*>(T),
Value::ConstantPointerNullVal, 0, 0) {}
/// 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() == ConstantPointerNullVal;
+ return V->getValueID() == ConstantPointerNullVal;
}
};
Constant *C1, Constant *C2);
static Constant *getCompareTy(unsigned short pred, Constant *C1,
Constant *C2);
- static Constant *getShiftTy(const Type *Ty,
- unsigned Opcode, 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,
}
/// getSizeOf constant expr - computes the size of a type in a target
- /// independent way (Note: the return type is a ULong).
+ /// independent way (Note: the return type is an i64).
///
static Constant *getSizeOf(const Type *Ty);
- /// getPtrPtrFromArrayPtr constant expr - given a pointer to a constant array,
- /// return a pointer to a pointer of the array element type.
- static Constant *getPtrPtrFromArrayPtr(Constant *C);
-
/// ConstantExpr::get - Return a binary or shift operator constant expression,
/// folding if possible.
///
static Constant *getAnd(Constant *C1, Constant *C2);
static Constant *getOr(Constant *C1, Constant *C2);
static Constant *getXor(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 *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 *getLShr(Constant *C1, Constant *C2);
static Constant *getAShr(Constant *C1, Constant *C2);
/// 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; }
/// 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, 0, 0) {}
+ explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
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;
}
};