//
//===----------------------------------------------------------------------===//
//
-// 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.
//
//===----------------------------------------------------------------------===//
struct ConvertConstantType;
//===----------------------------------------------------------------------===//
-/// ConstantIntegral - Shared superclass of boolean and integer constants.
-///
-/// This class just defines some common interfaces to be implemented.
-///
+/// This is the shared superclass of boolean and integer constants. This class
+/// just defines some common interfaces to be implemented by the subclasses.
+/// @brief An abstract class for integer constants.
class ConstantIntegral : public Constant {
protected:
- union {
- int64_t Signed;
- uint64_t Unsigned;
- } Val;
+ uint64_t Val;
ConstantIntegral(const Type *Ty, ValueTy VT, 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; }
-
- /// getZExtValue - Return the constant zero extended as appropriate for this
- /// type.
+
+ /// ConstantIntegral::get - Return a bool or integer constant.
+ static ConstantIntegral *get(const Type *Ty, int64_t V);
+
+ /// Return the constant as a 64-bit unsigned integer value after it
+ /// has been zero extended as appropriate for the type of this constant.
+ /// @brief Return the zero extended value.
inline uint64_t getZExtValue() const {
- unsigned Size = getType()->getPrimitiveSizeInBits();
- return Val.Unsigned & (~uint64_t(0UL) >> (64-Size));
+ return Val;
}
- /// getSExtValue - Return the constant sign extended as appropriate for this
- /// type.
+ /// Return the constant as a 64-bit integer value after it has been sign
+ /// sign extended as appropriate for the type of this constant.
+ /// @brief Return the sign extended value.
inline int64_t getSExtValue() const {
unsigned Size = getType()->getPrimitiveSizeInBits();
- return (Val.Signed << (64-Size)) >> (64-Size);
+ return (int64_t(Val) << (64-Size)) >> (64-Size);
}
- /// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue.
- ///
+ /// This function is implemented by subclasses and will return true iff this
+ /// constant represents the the "null" value that would be returned by the
+ /// getNullValue method.
+ /// @returns true if the constant's value is 0.
+ /// @brief Determine if the value is null.
virtual bool isNullValue() const = 0;
- /// isMaxValue - Return true if this is the largest value that may be
- /// represented by this type.
- ///
+ /// This function is implemented by sublcasses and will return true iff this
+ /// constant represents the the largest value that may be represented by this
+ /// constant's type.
+ /// @returns true if the constant's value is maximal.
+ /// @brief Determine if the value is maximal.
virtual bool isMaxValue() const = 0;
- /// isMinValue - Return true if this is the smallest value that may be
- /// represented by this type.
- ///
+ /// This function is implemented by subclasses and will return true iff this
+ /// constant represents the smallest value that may be represented by this
+ /// constant's type.
+ /// @returns true if the constant's value is minimal
+ /// @brief Determine if the value is minimal.
virtual bool isMinValue() const = 0;
- /// isAllOnesValue - Return true if every bit in this constant is set to true.
- ///
+ /// This function is implemented by subclasses and will return true iff every
+ /// bit in this constant is set to true.
+ /// @returns true if all bits of the constant are ones.
+ /// @brief Determine if the value is all ones.
virtual bool isAllOnesValue() const = 0;
- /// Static constructor to get the maximum/minimum/allones constant of
- /// specified (integral) type...
- ///
+ /// @returns the largest value for an integer constant of the given type
+ /// @brief Get the maximal value
static ConstantIntegral *getMaxValue(const Type *Ty);
+
+ /// @returns the smallest value for an integer constant of the given type
+ /// @brief Get the minimal value
static ConstantIntegral *getMinValue(const Type *Ty);
+
+ /// @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 ConstantIntegral *getAllOnesValue(const Type *Ty);
- /// Methods for support type inquiry through isa, cast, and dyn_cast:
+ /// Methods to 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() == ConstantBoolVal ||
- V->getValueType() == ConstantSIntVal ||
- V->getValueType() == ConstantUIntVal;
+ V->getValueType() == ConstantIntVal;
}
};
//===----------------------------------------------------------------------===//
-/// ConstantBool - Boolean Values
-///
+/// This concrete class represents constant values of type BoolTy. There are
+/// only two instances of this class constructed: the True and False static
+/// members. The constructor is hidden to ensure this invariant.
+/// @brief Constant Boolean class
class ConstantBool : public ConstantIntegral {
ConstantBool(bool V);
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; }
+ /// getTrue/getFalse - Return the singleton true/false values.
+ static ConstantBool *getTrue();
+ static ConstantBool *getFalse();
+
+ /// This method is provided mostly for compatibility with the other
+ /// ConstantIntegral subclasses.
+ /// @brief Static factory method for getting a ConstantBool instance.
+ static ConstantBool *get(bool Value) { return Value ? getTrue() : getFalse();}
+
+ /// This method is provided mostly for compatibility with the other
+ /// ConstantIntegral subclasses.
+ /// @brief Static factory method for getting a ConstantBool instance.
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; }
+ /// Returns the opposite value of this ConstantBool value.
+ /// @brief Get inverse value.
+ inline ConstantBool *inverted() const {
+ return getValue() ? getFalse() : getTrue();
+ }
- /// getValue - return the boolean value of this constant.
- ///
- inline bool getValue() const { return static_cast<bool>(getRawValue()); }
+ /// @returns the value of this ConstantBool
+ /// @brief return the boolean value of this constant.
+ inline bool getValue() const { return static_cast<bool>(getZExtValue()); }
- /// 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; }
+ /// @see ConstantIntegral for details
+ /// @brief Implement overrides
+ virtual bool isNullValue() const { return getValue() == false; }
+ virtual bool isMaxValue() const { return getValue() == true; }
+ virtual bool isMinValue() const { return getValue() == false; }
+ virtual bool isAllOnesValue() const { return getValue() == true; }
- /// Methods for support type inquiry through isa, cast, and dyn_cast:
+ /// @brief Methods to 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->getValueType() == ConstantBoolVal;
//===----------------------------------------------------------------------===//
-/// ConstantInt - Superclass of ConstantSInt & ConstantUInt, to make dealing
-/// with integral constants easier.
-///
+/// This is concrete integer subclass of ConstantIntegral that represents
+/// both signed and unsigned integral constants, other than boolean.
+/// @brief Class for constant integers.
class ConstantInt : public ConstantIntegral {
protected:
ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
- ConstantInt(const Type *Ty, ValueTy VT, uint64_t V);
+ ConstantInt(const Type *Ty, uint64_t V);
+ ConstantInt(const Type *Ty, int64_t V);
+ friend struct ConstantCreator<ConstantInt, Type, uint64_t>;
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.
- ///
+ /// 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!");
- return Val.Unsigned == V;
- }
-
- /// 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);
-
- /// 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;
-
- /// 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() == ConstantSIntVal ||
- V->getValueType() == ConstantUIntVal;
+ return Val == V;
}
-};
-
-
-//===----------------------------------------------------------------------===//
-/// 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>;
-protected:
- ConstantSInt(const Type *Ty, int64_t V);
-public:
- /// get() - Static factory methods - Return objects of the specified value
- ///
- static ConstantSInt *get(const Type *Ty, int64_t V);
-
- /// isValueValidForType - return true if Ty is big enough to represent V.
- ///
+ /// 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() (ConstantIntegral) will yield the correct
+ /// sized/signed value for the type Ty.
+ /// @brief Get a ConstantInt for a specific value.
+ static ConstantInt *get(const Type *Ty, int64_t 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.
+ /// @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, int64_t V);
- /// getValue - return the underlying value of this constant.
- ///
- inline int64_t getValue() const { return Val.Signed; }
+ /// @returns true if this is the null integer value.
+ /// @see ConstantIntegral for details
+ /// @brief Implement override.
+ virtual bool isNullValue() const { return Val == 0; }
- virtual bool isAllOnesValue() const { return getValue() == -1; }
+ /// @returns true iff this constant's bits are all set to true.
+ /// @see ConstantIntegral
+ /// @brief Override implementation
+ virtual bool isAllOnesValue() const { return getSExtValue() == -1; }
- /// isMaxValue - Return true if this is the largest value that may be
- /// represented by this type.
- ///
+ /// @returns true iff this is the largest value that may be represented
+ /// by this type.
+ /// @see ConstantIntegeral
+ /// @brief Override implementation
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;
+ if (getType()->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();
}
- /// isMinValue - Return true if this is the smallest value that may be
- /// represented by this type.
- ///
+ /// @returns true if this is the smallest value that may be represented by
+ /// this type.
+ /// @see ConstantIntegral
+ /// @brief Override implementation
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;
- }
-
- /// 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() == ConstantSIntVal;
+ if (getType()->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;
}
-};
-
-//===----------------------------------------------------------------------===//
-/// 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);
-
- /// isValueValidForType - return true if Ty is big enough to represent V.
- ///
- static bool isValueValidForType(const Type *Ty, uint64_t V);
- /// getValue - return the underlying value of this constant.
- ///
- inline uint64_t getValue() const { return Val.Unsigned; }
-
- /// 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; }
-
- /// 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() == ConstantUIntVal;
+ return V->getValueType() == ConstantIntVal;
}
};
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, unsigned len = 0);
+
+ /// 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
+ /// isString) and it ends in a null byte \0 and does not contains any other
+ /// 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.
///
/// 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 *getSignExtend (Constant *C, const Type *Ty);
+ static Constant *getZeroExtend (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
+ );
+
+ // This method uses the CastInst::getCastOpcode method to infer the
+ // cast opcode to use.
+ // @brief Get a ConstantExpr Conversion operator that casts C to Ty
+ static Constant *getInferredCast(Constant *C, bool SrcIsSigned,
+ const Type *Ty, bool DestIsSigned);
+
+ static Constant *getCast(Constant *C, const Type *Ty) {
+ return getInferredCast(C, C->getType()->isSigned(), Ty, Ty->isSigned());
+ }
+
+ /// @brief Return true if this is a convert constant expression
+ bool isCast() const;
/// Select constant expr
///
}
/// getSizeOf constant expr - computes the size of a type in a target
- /// independent way (Note: the return type is ULong but the object is not
- /// necessarily a ConstantUInt).
+ /// independent way (Note: the return type is a ULong).
///
static Constant *getSizeOf(const Type *Ty);
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 *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 *getExtractElement(Constant *Vec, Constant *Idx);
static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
-
+
/// 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 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, Use *U);
projects / oota-llvm.git / blobdiff