-//===-- llvm/Constants.h - Constant class subclass definitions ---*- C++ -*--=//
+//===-- 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 type of constant pool values
#include "llvm/Constant.h"
#include "Support/DataTypes.h"
+namespace llvm {
+
class ArrayType;
class StructType;
class PointerType;
+template<class ConstantClass, class TypeClass, class ValType>
+struct ConstantCreator;
+template<class ConstantClass, class TypeClass>
+struct ConvertConstantType;
+
//===---------------------------------------------------------------------------
/// ConstantIntegral - Shared superclass of boolean and integer constants.
class ConstantBool : public ConstantIntegral {
bool Val;
ConstantBool(bool V);
- ~ConstantBool() {}
public:
static ConstantBool *True, *False; // The True & False values
} Val;
ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
ConstantInt(const Type *Ty, uint64_t V);
- ~ConstantInt() {}
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
///
static ConstantInt *get(const Type *Ty, unsigned char V);
+ /// 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 { return Val.Unsigned == 0; }
///
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);
- ~ConstantSInt() {}
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.
+ ///
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; }
virtual bool isAllOnesValue() const { return getValue() == -1; }
}
/// Methods for support type inquiry through isa, cast, and dyn_cast:
+ ///
static inline bool classof(const ConstantSInt *) { return true; }
static bool classof(const Constant *CPV); // defined in Constants.cpp
static inline bool classof(const Value *V) {
///
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);
- ~ConstantUInt() {}
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
///
class ConstantFP : public Constant {
double Val;
+ friend struct ConstantCreator<ConstantFP, Type, uint64_t>;
+ friend struct ConstantCreator<ConstantFP, Type, uint32_t>;
ConstantFP(const ConstantFP &); // DO NOT IMPLEMENT
protected:
ConstantFP(const Type *Ty, double V);
- ~ConstantFP() {}
public:
/// get() - Static factory methods - Return objects of the specified value
static ConstantFP *get(const Type *Ty, double V);
inline double getValue() const { return Val; }
/// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue.
- virtual bool isNullValue() const { return Val == 0; }
+ /// 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;
+ }
+
+ /// 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 {
+ 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;
+ }
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantFP *) { return true; }
}
};
+//===---------------------------------------------------------------------------
+/// ConstantAggregateZero - All zero aggregate value
+///
+class ConstantAggregateZero : public Constant {
+ friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
+ ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
+protected:
+ ConstantAggregateZero(const Type *Ty) : Constant(Ty) {}
+public:
+ /// get() - static factory method for creating a null aggregate. It is
+ /// illegal to call this method with a non-aggregate type.
+ static Constant *get(const Type *Ty);
+
+ /// isNullValue - Return true if this is the value that would be returned by
+ /// getNullValue.
+ 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 inline bool classof(const ConstantAggregateZero *) { return true; }
+ static bool classof(const Constant *CPV);
+ static inline bool classof(const Value *V) {
+ return isa<Constant>(V) && classof(cast<Constant>(V));
+ }
+};
+
//===---------------------------------------------------------------------------
/// ConstantArray - Constant Array Declarations
///
class ConstantArray : public Constant {
+ friend struct ConstantCreator<ConstantArray, ArrayType,
+ std::vector<Constant*> >;
ConstantArray(const ConstantArray &); // DO NOT IMPLEMENT
protected:
ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
- ~ConstantArray() {}
-
public:
/// get() - Static factory methods - Return objects of the specified value
- static ConstantArray *get(const ArrayType *T, const std::vector<Constant*> &);
- static ConstantArray *get(const std::string &Initializer);
+ static Constant *get(const ArrayType *T, const std::vector<Constant*> &);
+ static Constant *get(const std::string &Initializer);
/// getType - Specialize the getType() method to always return an ArrayType,
/// which reduces the amount of casting needed in parts of the compiler.
///
inline const ArrayType *getType() const {
- return (ArrayType*)Value::getType();
+ return reinterpret_cast<const ArrayType*>(Value::getType());
}
- /// getAsString - If the sub-element type of this array is either sbyte or
- /// ubyte, then this method converts the array to an std::string and returns
- /// it. Otherwise, it asserts out.
+ /// isString - This method returns true if the array is an array of sbyte or
+ /// ubyte, and if the elements of the array are all ConstantInt's.
+ bool isString() const;
+
+ /// getAsString - If this array is isString(), then this method converts the
+ /// array to an std::string and returns it. Otherwise, it asserts out.
///
std::string getAsString() const;
inline const std::vector<Use> &getValues() const { return Operands; }
/// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue.
- virtual bool isNullValue() const {
- // FIXME: This should be made to be MUCH faster. Just check against well
- // known null value!
- for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
- if (!cast<Constant>(getOperand(i))->isNullValue())
- return false;
- return true;
- }
+ /// getNullValue. This always returns false because zero arrays are always
+ /// created as ConstantAggregateZero objects.
+ virtual bool isNullValue() const { return false; }
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To);
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
+ bool DisableChecking = false);
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantArray *) { return true; }
// ConstantStruct - Constant Struct Declarations
//
class ConstantStruct : public Constant {
+ friend struct ConstantCreator<ConstantStruct, StructType,
+ std::vector<Constant*> >;
ConstantStruct(const ConstantStruct &); // DO NOT IMPLEMENT
protected:
ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
- ~ConstantStruct() {}
-
public:
/// get() - Static factory methods - Return objects of the specified value
- static ConstantStruct *get(const StructType *T,
- const std::vector<Constant*> &V);
+ static Constant *get(const StructType *T, const std::vector<Constant*> &V);
/// getType() specialization - Reduce amount of casting...
inline const StructType *getType() const {
- return (StructType*)Value::getType();
+ return reinterpret_cast<const StructType*>(Value::getType());
}
/// getValues - Return a vector of the component constants that make up this
inline const std::vector<Use> &getValues() const { return Operands; }
/// isNullValue - Return true if this is the value that would be returned by
- /// getNullValue.
+ /// getNullValue. This always returns false because zero structs are always
+ /// created as ConstantAggregateZero objects.
virtual bool isNullValue() const {
- // FIXME: This should be made to be MUCH faster. Just check against well
- // known null value!
- for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
- if (!cast<Constant>(getOperand(i))->isNullValue())
- return false;
- return true;
+ return false;
}
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To);
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
+ bool DisableChecking = false);
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantStruct *) { return true; }
};
//===---------------------------------------------------------------------------
-/// ConstantPointer - Constant Pointer Declarations
-///
-/// The ConstantPointer class represents a null pointer of a specific type. For
-/// a more specific/useful instance, a subclass of ConstantPointer should be
-/// used.
-///
-class ConstantPointer : public Constant {
- ConstantPointer(const ConstantPointer &); // DO NOT IMPLEMENT
-protected:
- inline ConstantPointer(const PointerType *T) : Constant((const Type*)T){}
- ~ConstantPointer() {}
-public:
- inline const PointerType *getType() const {
- return (PointerType*)Value::getType();
- }
-
- /// 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 ConstantPointer *) { return true; }
- static bool classof(const Constant *CPV); // defined in Constants.cpp
- static inline bool classof(const Value *V) {
- return isa<Constant>(V) && classof(cast<Constant>(V));
- }
-};
-
/// ConstantPointerNull - a constant pointer value that points to null
///
-class ConstantPointerNull : public ConstantPointer {
+class ConstantPointerNull : public Constant {
+ friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
protected:
- inline ConstantPointerNull(const PointerType *T) : ConstantPointer(T) {}
- inline ~ConstantPointerNull() {}
+ ConstantPointerNull(const PointerType *T)
+ : Constant(reinterpret_cast<const Type*>(T)) {}
+
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 inline bool classof(const ConstantPointer *P) {
- return (P->getNumOperands() == 0 && P->isNullValue());
- }
- static inline bool classof(const Constant *CPV) {
- return isa<ConstantPointer>(CPV) && classof(cast<ConstantPointer>(CPV));
- }
+ static bool classof(const Constant *CPV);
static inline bool classof(const Value *V) {
- return isa<ConstantPointer>(V) && classof(cast<ConstantPointer>(V));
+ return isa<Constant>(V) && classof(cast<Constant>(V));
}
};
+//===---------------------------------------------------------------------------
/// ConstantPointerRef - a constant pointer value that is initialized to
/// point to a global value, which lies at a constant, fixed address.
///
-class ConstantPointerRef : public ConstantPointer {
+class ConstantPointerRef : public Constant {
friend class Module; // Modules maintain these references
ConstantPointerRef(const ConstantPointerRef &); // DNI!
protected:
ConstantPointerRef(GlobalValue *GV);
- ~ConstantPointerRef() {}
public:
/// get() - Static factory methods - Return objects of the specified value
static ConstantPointerRef *get(GlobalValue *GV);
return cast<GlobalValue>(Operands[0].get());
}
+ /// isNullValue - Return true if this is the value that would be returned by
+ /// getNullValue.
+ virtual bool isNullValue() const { return false; }
+
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To);
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
+ bool DisableChecking = false);
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantPointerRef *) { return true; }
- static inline bool classof(const ConstantPointer *CPV) {
- // check for a single operand (the target value)
- return (CPV->getNumOperands() == 1);
- }
- static inline bool classof(const Constant *CPV) {
- return isa<ConstantPointer>(CPV) && classof(cast<ConstantPointer>(CPV));
- }
+ static bool classof(const Constant *CPV);
static inline bool classof(const Value *V) {
- return isa<ConstantPointer>(V) && classof(cast<ConstantPointer>(V));
+ return isa<Constant>(V) && classof(cast<Constant>(V));
}
};
-
-// 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.
+// 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.
//
class ConstantExpr : public Constant {
- unsigned iType; // Operation type
+ unsigned iType; // Operation type (an Instruction opcode)
+ friend struct ConstantCreator<ConstantExpr,Type,
+ std::pair<unsigned, std::vector<Constant*> > >;
+ friend struct ConvertConstantType<ConstantExpr, Type>;
protected:
- ConstantExpr(unsigned Opcode, Constant *C, const Type *Ty);
+ // 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() {}
+
+ // 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 *getSelectTy(const Type *Ty,
+ Constant *C1, Constant *C2, Constant *C3);
+ static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
+ const std::vector<Constant*> &IdxList);
public:
- // Static methods to construct a ConstantExpr of different kinds.
+ // 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 ConstantExpr *getCast(Constant *C, const Type *Ty);
+ ///
+ static Constant *getCast(Constant *C, const Type *Ty);
+
+ /// Select constant expr
+ ///
+ static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
+ return getSelectTy(V1->getType(), C, V1, V2);
+ }
+
- /// Binary constant expr - Use with binary operators...
- static ConstantExpr *get(unsigned Opcode, Constant *C1, Constant *C2);
+ /// ConstantExpr::get - Return a binary or shift operator constant expression,
+ /// folding if possible.
+ ///
+ static Constant *get(unsigned Opcode, Constant *C1, Constant *C2) {
+ return getTy(C1->getType(), Opcode, C1, C2);
+ }
/// Getelementptr form...
- static ConstantExpr *getGetElementPtr(Constant *C,
- const std::vector<Constant*> &IdxList);
+ ///
+ static Constant *getGetElementPtr(Constant *C,
+ const std::vector<Constant*> &IdxList);
/// isNullValue - Return true if this is the value that would be returned by
/// getNullValue.
virtual bool isConstantExpr() const { return true; }
virtual void destroyConstant();
- virtual void replaceUsesOfWithOnConstant(Value *From, Value *To);
+ virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
+ bool DisableChecking = false);
+ /// Override methods to provide more type information...
+ 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 Constant *CPV) {
}
};
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff