//===-- 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
+// 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 "Support/DataTypes.h"
namespace llvm {
class ArrayType;
class StructType;
class PointerType;
+class PackedType;
template<class ConstantClass, class TypeClass, class ValType>
struct ConstantCreator;
template<class ConstantClass, class TypeClass>
struct ConvertConstantType;
-
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantIntegral - Shared superclass of boolean and integer constants.
///
/// This class just defines some common interfaces to be implemented.
int64_t Signed;
uint64_t Unsigned;
} Val;
- ConstantIntegral(const Type *Ty, uint64_t V);
+ 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.
+ inline uint64_t getZExtValue() const {
+ unsigned Size = getType()->getPrimitiveSizeInBits();
+ return Val.Unsigned & (~0ULL >> (64-Size));
+ }
+ /// getSExtValue - Return the constant sign extended as appropriate for this
+ /// type.
+ inline int64_t getSExtValue() const {
+ unsigned Size = getType()->getPrimitiveSizeInBits();
+ return (Val.Signed << (64-Size)) >> (64-Size);
+ }
+
/// isNullValue - Return true if this is the value that would be returned by
/// getNullValue.
///
/// 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();
+ return V->getValueType() == ConstantBoolVal ||
+ V->getValueType() == ConstantSIntVal ||
+ V->getValueType() == ConstantUIntVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantBool - Boolean Values
///
class ConstantBool : public ConstantIntegral {
/// 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 V->getValueType() == ConstantBoolVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// 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);
+ ConstantInt(const Type *Ty, ValueTy VT, 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
/// 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();
+ return V->getValueType() == ConstantSIntVal ||
+ V->getValueType() == ConstantUIntVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantSInt - Signed Integer Values [sbyte, short, int, long]
///
class ConstantSInt : public ConstantInt {
///
static inline bool classof(const ConstantSInt *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->isSigned();
+ return V->getValueType() == ConstantSIntVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantUInt - Unsigned Integer Values [ubyte, ushort, uint, ulong]
///
class ConstantUInt : public ConstantInt {
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const ConstantUInt *) { return true; }
static bool classof(const Value *V) {
- return V->getValueType() == SimpleConstantVal &&
- V->getType()->isUnsigned();
+ return V->getValueType() == ConstantUIntVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantFP - Floating Point Values [float, double]
///
class ConstantFP : public Constant {
/// 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;
/// 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;
- }
+ bool isExactlyValue(double V) const;
/// 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->getValueType() == ConstantFPVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantAggregateZero - All zero aggregate value
///
class ConstantAggregateZero : public Constant {
ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
protected:
ConstantAggregateZero(const Type *Ty)
- : Constant(Ty, ConstantAggregateZeroVal) {}
+ : Constant(Ty, ConstantAggregateZeroVal, 0, 0) {}
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:
///
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantArray - Constant Array Declarations
///
class ConstantArray : public 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 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.
///
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->getValueType() == ConstantArrayVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
// ConstantStruct - Constant Struct Declarations
//
class ConstantStruct : public 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
///
}
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->getValueType() == ConstantStructVal;
+ }
+};
+
+//===----------------------------------------------------------------------===//
+/// ConstantPacked - Constant Packed Declarations
+///
+class ConstantPacked : public Constant {
+ friend struct ConstantCreator<ConstantPacked, PackedType,
+ std::vector<Constant*> >;
+ ConstantPacked(const ConstantPacked &); // DO NOT IMPLEMENT
+protected:
+ ConstantPacked(const PackedType *T, const std::vector<Constant*> &Val);
+ ~ConstantPacked();
+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 std::vector<Constant*> &V);
+
+ /// getType - Specialize the getType() method to always return an PackedType,
+ /// which reduces the amount of casting needed in parts of the compiler.
+ ///
+ inline const PackedType *getType() const {
+ return reinterpret_cast<const PackedType*>(Value::getType());
+ }
+
+ /// isNullValue - Return true if this is the value that would be returned by
+ /// 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, Use *U);
+
+ /// Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const ConstantPacked *) { return true; }
+ static bool classof(const Value *V) {
+ return V->getValueType() == ConstantPackedVal;
}
};
-//===---------------------------------------------------------------------------
+//===----------------------------------------------------------------------===//
/// ConstantPointerNull - a constant pointer value that points to null
///
class ConstantPointerNull : public Constant {
ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
protected:
ConstantPointerNull(const PointerType *T)
- : Constant(reinterpret_cast<const Type*>(T)) {}
+ : Constant(reinterpret_cast<const Type*>(T),
+ Value::ConstantPointerNullVal, 0, 0) {}
public:
/// 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->getValueType() == 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.
-//
+/// ConstantExpr - a constant value that is initialized with an expression using
+/// 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 *getSelectTy(const Type *Ty,
Constant *C1, Constant *C2, Constant *C3);
static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
- const std::vector<Constant*> &IdxList);
-
+ const std::vector<Value*> &IdxList);
+ 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);
+
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);
return getSelectTy(V1->getType(), C, V1, V2);
}
+ /// 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).
+ ///
+ 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 *getUShr(Constant *C1, Constant *C2); // unsigned shr
static Constant *getSShr(Constant *C1, Constant *C2); // signed shr
- /// Getelementptr form...
+ /// 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);
+ static Constant *getGetElementPtr(Constant *C,
+ const std::vector<Value*> &IdxList);
+
+ 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 iType; }
+ unsigned getOpcode() const { return SubclassData; }
/// getOpcodeName - Return a string representation for an opcode.
const char *getOpcodeName() 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; }
}
};
+
+//===----------------------------------------------------------------------===//
+/// UndefValue - 'undef' values are things that do not have specified contents.
+/// These are used for a variety of purposes, including global variable
+/// initializers and operands to instructions. 'undef' values can occur with
+/// any type.
+///
+class UndefValue : public Constant {
+ friend struct ConstantCreator<UndefValue, Type, char>;
+ UndefValue(const UndefValue &); // DO NOT IMPLEMENT
+protected:
+ UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
+public:
+ /// get() - Static factory methods - Return an 'undef' object of the specified
+ /// type.
+ ///
+ static UndefValue *get(const Type *T);
+
+ /// isNullValue - Return true if this is the value that would be returned by
+ /// getNullValue.
+ virtual bool isNullValue() const { return false; }
+
+ virtual void destroyConstant();
+
+ /// 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;
+ }
+};
+
} // End llvm namespace
#endif