1 //===-- llvm/Constants.h - Constant class subclass definitions --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 /// @file This file contains the declarations for the subclasses of Constant,
11 /// which represent the different flavors of constant values that live in LLVM.
12 /// Note that Constants are immutable (once created they never change) and are
13 /// fully shared by structural equivalence. This means that two structurally
14 /// equivalent constants will always have the same address. Constant's are
15 /// created on demand as needed and never deleted: thus clients don't have to
16 /// worry about the lifetime of the objects.
18 //===----------------------------------------------------------------------===//
20 #ifndef LLVM_CONSTANTS_H
21 #define LLVM_CONSTANTS_H
23 #include "llvm/Constant.h"
24 #include "llvm/Type.h"
25 #include "llvm/OperandTraits.h"
26 #include "llvm/ADT/APInt.h"
27 #include "llvm/ADT/APFloat.h"
28 #include "llvm/ADT/SmallVector.h"
37 template<class ConstantClass, class TypeClass, class ValType>
38 struct ConstantCreator;
39 template<class ConstantClass, class TypeClass>
40 struct ConvertConstantType;
42 //===----------------------------------------------------------------------===//
43 /// This is the shared class of boolean and integer constants. This class
44 /// represents both boolean and integral constants.
45 /// @brief Class for constant integers.
46 class ConstantInt : public Constant {
47 static ConstantInt *TheTrueVal, *TheFalseVal;
48 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
49 ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
50 ConstantInt(const IntegerType *Ty, const APInt& V);
53 // allocate space for exactly zero operands
54 void *operator new(size_t s) {
55 return User::operator new(s, 0);
58 /// Return the constant as an APInt value reference. This allows clients to
59 /// obtain a copy of the value, with all its precision in tact.
60 /// @brief Return the constant's value.
61 inline const APInt& getValue() const {
65 /// getBitWidth - Return the bitwidth of this constant.
66 unsigned getBitWidth() const { return Val.getBitWidth(); }
68 /// Return the constant as a 64-bit unsigned integer value after it
69 /// has been zero extended as appropriate for the type of this constant. Note
70 /// that this method can assert if the value does not fit in 64 bits.
72 /// @brief Return the zero extended value.
73 inline uint64_t getZExtValue() const {
74 return Val.getZExtValue();
77 /// Return the constant as a 64-bit integer value after it has been sign
78 /// sign extended as appropriate for the type of this constant. Note that
79 /// this method can assert if the value does not fit in 64 bits.
81 /// @brief Return the sign extended value.
82 inline int64_t getSExtValue() const {
83 return Val.getSExtValue();
86 /// A helper method that can be used to determine if the constant contained
87 /// within is equal to a constant. This only works for very small values,
88 /// because this is all that can be represented with all types.
89 /// @brief Determine if this constant's value is same as an unsigned char.
90 bool equalsInt(uint64_t V) const {
94 /// getTrue/getFalse - Return the singleton true/false values.
95 static inline ConstantInt *getTrue() {
96 if (TheTrueVal) return TheTrueVal;
97 return CreateTrueFalseVals(true);
99 static inline ConstantInt *getFalse() {
100 if (TheFalseVal) return TheFalseVal;
101 return CreateTrueFalseVals(false);
104 /// Return a ConstantInt with the specified value for the specified type. The
105 /// value V will be canonicalized to a an unsigned APInt. Accessing it with
106 /// either getSExtValue() or getZExtValue() will yield a correctly sized and
107 /// signed value for the type Ty.
108 /// @brief Get a ConstantInt for a specific value.
109 static ConstantInt *get(const Type *Ty, uint64_t V, bool isSigned = false);
111 /// Return a ConstantInt with the specified value and an implied Type. The
112 /// type is the integer type that corresponds to the bit width of the value.
113 static ConstantInt *get(const APInt &V);
115 /// getType - Specialize the getType() method to always return an IntegerType,
116 /// which reduces the amount of casting needed in parts of the compiler.
118 inline const IntegerType *getType() const {
119 return reinterpret_cast<const IntegerType*>(Value::getType());
122 /// This static method returns true if the type Ty is big enough to
123 /// represent the value V. This can be used to avoid having the get method
124 /// assert when V is larger than Ty can represent. Note that there are two
125 /// versions of this method, one for unsigned and one for signed integers.
126 /// Although ConstantInt canonicalizes everything to an unsigned integer,
127 /// the signed version avoids callers having to convert a signed quantity
128 /// to the appropriate unsigned type before calling the method.
129 /// @returns true if V is a valid value for type Ty
130 /// @brief Determine if the value is in range for the given type.
131 static bool isValueValidForType(const Type *Ty, uint64_t V);
132 static bool isValueValidForType(const Type *Ty, int64_t V);
134 /// This function will return true iff this constant represents the "null"
135 /// value that would be returned by the getNullValue method.
136 /// @returns true if this is the null integer value.
137 /// @brief Determine if the value is null.
138 virtual bool isNullValue() const {
142 /// This is just a convenience method to make client code smaller for a
143 /// common code. It also correctly performs the comparison without the
144 /// potential for an assertion from getZExtValue().
145 bool isZero() const {
149 /// This is just a convenience method to make client code smaller for a
150 /// common case. It also correctly performs the comparison without the
151 /// potential for an assertion from getZExtValue().
152 /// @brief Determine if the value is one.
157 /// This function will return true iff every bit in this constant is set
159 /// @returns true iff this constant's bits are all set to true.
160 /// @brief Determine if the value is all ones.
161 bool isAllOnesValue() const {
162 return Val.isAllOnesValue();
165 /// This function will return true iff this constant represents the largest
166 /// value that may be represented by the constant's type.
167 /// @returns true iff this is the largest value that may be represented
169 /// @brief Determine if the value is maximal.
170 bool isMaxValue(bool isSigned) const {
172 return Val.isMaxSignedValue();
174 return Val.isMaxValue();
177 /// This function will return true iff this constant represents the smallest
178 /// value that may be represented by this constant's type.
179 /// @returns true if this is the smallest value that may be represented by
181 /// @brief Determine if the value is minimal.
182 bool isMinValue(bool isSigned) const {
184 return Val.isMinSignedValue();
186 return Val.isMinValue();
189 /// This function will return true iff this constant represents a value with
190 /// active bits bigger than 64 bits or a value greater than the given uint64_t
192 /// @returns true iff this constant is greater or equal to the given number.
193 /// @brief Determine if the value is greater or equal to the given number.
194 bool uge(uint64_t Num) {
195 return Val.getActiveBits() > 64 || Val.getZExtValue() >= Num;
198 /// @returns the 64-bit value of this constant if its active bits number is
199 /// not greater than 64, otherwise, just return the given uint64_t number.
200 /// @brief Get the constant's value if possible.
201 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
202 return Val.getLimitedValue(Limit);
205 /// @returns the value for an integer constant of the given type that has all
206 /// its bits set to true.
207 /// @brief Get the all ones value
208 static ConstantInt *getAllOnesValue(const Type *Ty);
210 /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
211 static inline bool classof(const ConstantInt *) { return true; }
212 static bool classof(const Value *V) {
213 return V->getValueID() == ConstantIntVal;
215 static void ResetTrueFalse() { TheTrueVal = TheFalseVal = 0; }
217 static ConstantInt *CreateTrueFalseVals(bool WhichOne);
221 //===----------------------------------------------------------------------===//
222 /// ConstantFP - Floating Point Values [float, double]
224 class ConstantFP : public Constant {
226 void *operator new(size_t, unsigned);// DO NOT IMPLEMENT
227 ConstantFP(const ConstantFP &); // DO NOT IMPLEMENT
229 ConstantFP(const Type *Ty, const APFloat& V);
231 // allocate space for exactly zero operands
232 void *operator new(size_t s) {
233 return User::operator new(s, 0);
236 /// get() - Static factory methods - Return objects of the specified value
237 static ConstantFP *get(const APFloat &V);
239 /// get() - This returns a constant fp for the specified value in the
240 /// specified type. This should only be used for simple constant values like
241 /// 2.0/1.0 etc, that are known-valid both as double and as the target format.
242 static ConstantFP *get(const Type *Ty, double V);
244 /// isValueValidForType - return true if Ty is big enough to represent V.
245 static bool isValueValidForType(const Type *Ty, const APFloat& V);
246 inline const APFloat& getValueAPF() const { return Val; }
248 /// isNullValue - Return true if this is the value that would be returned by
249 /// getNullValue. Don't depend on == for doubles to tell us it's zero, it
250 /// considers -0.0 to be null as well as 0.0. :(
251 virtual bool isNullValue() const;
253 // Get a negative zero.
254 static ConstantFP *getNegativeZero(const Type* Ty);
256 /// isExactlyValue - We don't rely on operator== working on double values, as
257 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
258 /// As such, this method can be used to do an exact bit-for-bit comparison of
259 /// two floating point values. The version with a double operand is retained
260 /// because it's so convenient to write isExactlyValue(2.0), but please use
261 /// it only for simple constants.
262 bool isExactlyValue(const APFloat& V) const;
264 bool isExactlyValue(double V) const {
266 // convert is not supported on this type
267 if (&Val.getSemantics() == &APFloat::PPCDoubleDouble)
270 FV.convert(Val.getSemantics(), APFloat::rmNearestTiesToEven, &ignored);
271 return isExactlyValue(FV);
273 /// Methods for support type inquiry through isa, cast, and dyn_cast:
274 static inline bool classof(const ConstantFP *) { return true; }
275 static bool classof(const Value *V) {
276 return V->getValueID() == ConstantFPVal;
280 //===----------------------------------------------------------------------===//
281 /// ConstantAggregateZero - All zero aggregate value
283 class ConstantAggregateZero : public Constant {
284 friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
285 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
286 ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
288 explicit ConstantAggregateZero(const Type *ty)
289 : Constant(ty, ConstantAggregateZeroVal, 0, 0) {}
291 // allocate space for exactly zero operands
292 void *operator new(size_t s) {
293 return User::operator new(s, 0);
296 /// get() - static factory method for creating a null aggregate. It is
297 /// illegal to call this method with a non-aggregate type.
298 static Constant *get(const Type *Ty);
300 /// isNullValue - Return true if this is the value that would be returned by
302 virtual bool isNullValue() const { return true; }
304 virtual void destroyConstant();
306 /// Methods for support type inquiry through isa, cast, and dyn_cast:
308 static bool classof(const ConstantAggregateZero *) { return true; }
309 static bool classof(const Value *V) {
310 return V->getValueID() == ConstantAggregateZeroVal;
315 //===----------------------------------------------------------------------===//
316 /// ConstantArray - Constant Array Declarations
318 class ConstantArray : public Constant {
319 friend struct ConstantCreator<ConstantArray, ArrayType,
320 std::vector<Constant*> >;
321 ConstantArray(const ConstantArray &); // DO NOT IMPLEMENT
323 ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
325 /// get() - Static factory methods - Return objects of the specified value
326 static Constant *get(const ArrayType *T, const std::vector<Constant*> &);
327 static Constant *get(const ArrayType *T,
328 Constant*const*Vals, unsigned NumVals) {
329 // FIXME: make this the primary ctor method.
330 return get(T, std::vector<Constant*>(Vals, Vals+NumVals));
333 /// This method constructs a ConstantArray and initializes it with a text
334 /// string. The default behavior (AddNull==true) causes a null terminator to
335 /// be placed at the end of the array. This effectively increases the length
336 /// of the array by one (you've been warned). However, in some situations
337 /// this is not desired so if AddNull==false then the string is copied without
338 /// null termination.
339 static Constant *get(const std::string &Initializer, bool AddNull = true);
341 /// Transparently provide more efficient getOperand methods.
342 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
344 /// getType - Specialize the getType() method to always return an ArrayType,
345 /// which reduces the amount of casting needed in parts of the compiler.
347 inline const ArrayType *getType() const {
348 return reinterpret_cast<const ArrayType*>(Value::getType());
351 /// isString - This method returns true if the array is an array of i8 and
352 /// the elements of the array are all ConstantInt's.
353 bool isString() const;
355 /// isCString - This method returns true if the array is a string (see
357 /// isString) and it ends in a null byte \0 and does not contains any other
359 /// null bytes except its terminator.
360 bool isCString() const;
362 /// getAsString - If this array is isString(), then this method converts the
363 /// array to an std::string and returns it. Otherwise, it asserts out.
365 std::string getAsString() const;
367 /// isNullValue - Return true if this is the value that would be returned by
368 /// getNullValue. This always returns false because zero arrays are always
369 /// created as ConstantAggregateZero objects.
370 virtual bool isNullValue() const { return false; }
372 virtual void destroyConstant();
373 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
375 /// Methods for support type inquiry through isa, cast, and dyn_cast:
376 static inline bool classof(const ConstantArray *) { return true; }
377 static bool classof(const Value *V) {
378 return V->getValueID() == ConstantArrayVal;
383 struct OperandTraits<ConstantArray> : VariadicOperandTraits<> {
386 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantArray, Constant)
388 //===----------------------------------------------------------------------===//
389 // ConstantStruct - Constant Struct Declarations
391 class ConstantStruct : public Constant {
392 friend struct ConstantCreator<ConstantStruct, StructType,
393 std::vector<Constant*> >;
394 ConstantStruct(const ConstantStruct &); // DO NOT IMPLEMENT
396 ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
398 /// get() - Static factory methods - Return objects of the specified value
400 static Constant *get(const StructType *T, const std::vector<Constant*> &V);
401 static Constant *get(const std::vector<Constant*> &V, bool Packed = false);
402 static Constant *get(Constant*const* Vals, unsigned NumVals,
403 bool Packed = false) {
404 // FIXME: make this the primary ctor method.
405 return get(std::vector<Constant*>(Vals, Vals+NumVals), Packed);
408 /// Transparently provide more efficient getOperand methods.
409 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
411 /// getType() specialization - Reduce amount of casting...
413 inline const StructType *getType() const {
414 return reinterpret_cast<const StructType*>(Value::getType());
417 /// isNullValue - Return true if this is the value that would be returned by
418 /// getNullValue. This always returns false because zero structs are always
419 /// created as ConstantAggregateZero objects.
420 virtual bool isNullValue() const {
424 virtual void destroyConstant();
425 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
427 /// Methods for support type inquiry through isa, cast, and dyn_cast:
428 static inline bool classof(const ConstantStruct *) { return true; }
429 static bool classof(const Value *V) {
430 return V->getValueID() == ConstantStructVal;
435 struct OperandTraits<ConstantStruct> : VariadicOperandTraits<> {
438 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantStruct, Constant)
440 //===----------------------------------------------------------------------===//
441 /// ConstantVector - Constant Vector Declarations
443 class ConstantVector : public Constant {
444 friend struct ConstantCreator<ConstantVector, VectorType,
445 std::vector<Constant*> >;
446 ConstantVector(const ConstantVector &); // DO NOT IMPLEMENT
448 ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
450 /// get() - Static factory methods - Return objects of the specified value
451 static Constant *get(const VectorType *T, const std::vector<Constant*> &);
452 static Constant *get(const std::vector<Constant*> &V);
453 static Constant *get(Constant*const* Vals, unsigned NumVals) {
454 // FIXME: make this the primary ctor method.
455 return get(std::vector<Constant*>(Vals, Vals+NumVals));
458 /// Transparently provide more efficient getOperand methods.
459 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
461 /// getType - Specialize the getType() method to always return a VectorType,
462 /// which reduces the amount of casting needed in parts of the compiler.
464 inline const VectorType *getType() const {
465 return reinterpret_cast<const VectorType*>(Value::getType());
468 /// @returns the value for a vector integer constant of the given type that
469 /// has all its bits set to true.
470 /// @brief Get the all ones value
471 static ConstantVector *getAllOnesValue(const VectorType *Ty);
473 /// isNullValue - Return true if this is the value that would be returned by
474 /// getNullValue. This always returns false because zero vectors are always
475 /// created as ConstantAggregateZero objects.
476 virtual bool isNullValue() const { return false; }
478 /// This function will return true iff every element in this vector constant
479 /// is set to all ones.
480 /// @returns true iff this constant's emements are all set to all ones.
481 /// @brief Determine if the value is all ones.
482 bool isAllOnesValue() const;
484 /// getSplatValue - If this is a splat constant, meaning that all of the
485 /// elements have the same value, return that value. Otherwise return NULL.
486 Constant *getSplatValue();
488 virtual void destroyConstant();
489 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
491 /// Methods for support type inquiry through isa, cast, and dyn_cast:
492 static inline bool classof(const ConstantVector *) { return true; }
493 static bool classof(const Value *V) {
494 return V->getValueID() == ConstantVectorVal;
499 struct OperandTraits<ConstantVector> : VariadicOperandTraits<> {
502 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantVector, Constant)
504 //===----------------------------------------------------------------------===//
505 /// ConstantPointerNull - a constant pointer value that points to null
507 class ConstantPointerNull : public Constant {
508 friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
509 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
510 ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
512 explicit ConstantPointerNull(const PointerType *T)
513 : Constant(reinterpret_cast<const Type*>(T),
514 Value::ConstantPointerNullVal, 0, 0) {}
517 // allocate space for exactly zero operands
518 void *operator new(size_t s) {
519 return User::operator new(s, 0);
522 /// get() - Static factory methods - Return objects of the specified value
523 static ConstantPointerNull *get(const PointerType *T);
525 /// isNullValue - Return true if this is the value that would be returned by
527 virtual bool isNullValue() const { return true; }
529 virtual void destroyConstant();
531 /// getType - Specialize the getType() method to always return an PointerType,
532 /// which reduces the amount of casting needed in parts of the compiler.
534 inline const PointerType *getType() const {
535 return reinterpret_cast<const PointerType*>(Value::getType());
538 /// Methods for support type inquiry through isa, cast, and dyn_cast:
539 static inline bool classof(const ConstantPointerNull *) { return true; }
540 static bool classof(const Value *V) {
541 return V->getValueID() == ConstantPointerNullVal;
546 /// ConstantExpr - a constant value that is initialized with an expression using
547 /// other constant values.
549 /// This class uses the standard Instruction opcodes to define the various
550 /// constant expressions. The Opcode field for the ConstantExpr class is
551 /// maintained in the Value::SubclassData field.
552 class ConstantExpr : public Constant {
553 friend struct ConstantCreator<ConstantExpr,Type,
554 std::pair<unsigned, std::vector<Constant*> > >;
555 friend struct ConvertConstantType<ConstantExpr, Type>;
558 ConstantExpr(const Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
559 : Constant(ty, ConstantExprVal, Ops, NumOps) {
560 // Operation type (an Instruction opcode) is stored as the SubclassData.
561 SubclassData = Opcode;
564 // These private methods are used by the type resolution code to create
565 // ConstantExprs in intermediate forms.
566 static Constant *getTy(const Type *Ty, unsigned Opcode,
567 Constant *C1, Constant *C2);
568 static Constant *getCompareTy(unsigned short pred, Constant *C1,
570 static Constant *getSelectTy(const Type *Ty,
571 Constant *C1, Constant *C2, Constant *C3);
572 static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
573 Value* const *Idxs, unsigned NumIdxs);
574 static Constant *getExtractElementTy(const Type *Ty, Constant *Val,
576 static Constant *getInsertElementTy(const Type *Ty, Constant *Val,
577 Constant *Elt, Constant *Idx);
578 static Constant *getShuffleVectorTy(const Type *Ty, Constant *V1,
579 Constant *V2, Constant *Mask);
580 static Constant *getExtractValueTy(const Type *Ty, Constant *Agg,
581 const unsigned *Idxs, unsigned NumIdxs);
582 static Constant *getInsertValueTy(const Type *Ty, Constant *Agg,
584 const unsigned *Idxs, unsigned NumIdxs);
587 // Static methods to construct a ConstantExpr of different kinds. Note that
588 // these methods may return a object that is not an instance of the
589 // ConstantExpr class, because they will attempt to fold the constant
590 // expression into something simpler if possible.
592 /// Cast constant expr
594 static Constant *getTrunc (Constant *C, const Type *Ty);
595 static Constant *getSExt (Constant *C, const Type *Ty);
596 static Constant *getZExt (Constant *C, const Type *Ty);
597 static Constant *getFPTrunc (Constant *C, const Type *Ty);
598 static Constant *getFPExtend(Constant *C, const Type *Ty);
599 static Constant *getUIToFP (Constant *C, const Type *Ty);
600 static Constant *getSIToFP (Constant *C, const Type *Ty);
601 static Constant *getFPToUI (Constant *C, const Type *Ty);
602 static Constant *getFPToSI (Constant *C, const Type *Ty);
603 static Constant *getPtrToInt(Constant *C, const Type *Ty);
604 static Constant *getIntToPtr(Constant *C, const Type *Ty);
605 static Constant *getBitCast (Constant *C, const Type *Ty);
607 /// Transparently provide more efficient getOperand methods.
608 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
610 // @brief Convenience function for getting one of the casting operations
611 // using a CastOps opcode.
612 static Constant *getCast(
613 unsigned ops, ///< The opcode for the conversion
614 Constant *C, ///< The constant to be converted
615 const Type *Ty ///< The type to which the constant is converted
618 // @brief Create a ZExt or BitCast cast constant expression
619 static Constant *getZExtOrBitCast(
620 Constant *C, ///< The constant to zext or bitcast
621 const Type *Ty ///< The type to zext or bitcast C to
624 // @brief Create a SExt or BitCast cast constant expression
625 static Constant *getSExtOrBitCast(
626 Constant *C, ///< The constant to sext or bitcast
627 const Type *Ty ///< The type to sext or bitcast C to
630 // @brief Create a Trunc or BitCast cast constant expression
631 static Constant *getTruncOrBitCast(
632 Constant *C, ///< The constant to trunc or bitcast
633 const Type *Ty ///< The type to trunc or bitcast C to
636 /// @brief Create a BitCast or a PtrToInt cast constant expression
637 static Constant *getPointerCast(
638 Constant *C, ///< The pointer value to be casted (operand 0)
639 const Type *Ty ///< The type to which cast should be made
642 /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
643 static Constant *getIntegerCast(
644 Constant *C, ///< The integer constant to be casted
645 const Type *Ty, ///< The integer type to cast to
646 bool isSigned ///< Whether C should be treated as signed or not
649 /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
650 static Constant *getFPCast(
651 Constant *C, ///< The integer constant to be casted
652 const Type *Ty ///< The integer type to cast to
655 /// @brief Return true if this is a convert constant expression
658 /// @brief Return true if this is a compare constant expression
659 bool isCompare() const;
661 /// @brief Return true if this is an insertvalue or extractvalue expression,
662 /// and the getIndices() method may be used.
663 bool hasIndices() const;
665 /// Select constant expr
667 static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
668 return getSelectTy(V1->getType(), C, V1, V2);
671 /// getSizeOf constant expr - computes the size of a type in a target
672 /// independent way (Note: the return type is an i64).
674 static Constant *getSizeOf(const Type *Ty);
676 /// ConstantExpr::get - Return a binary or shift operator constant expression,
677 /// folding if possible.
679 static Constant *get(unsigned Opcode, Constant *C1, Constant *C2);
681 /// @brief Return an ICmp, FCmp, VICmp, or VFCmp comparison operator constant
683 static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
685 /// ConstantExpr::get* - Return some common constants without having to
686 /// specify the full Instruction::OPCODE identifier.
688 static Constant *getNeg(Constant *C);
689 static Constant *getNot(Constant *C);
690 static Constant *getAdd(Constant *C1, Constant *C2);
691 static Constant *getSub(Constant *C1, Constant *C2);
692 static Constant *getMul(Constant *C1, Constant *C2);
693 static Constant *getUDiv(Constant *C1, Constant *C2);
694 static Constant *getSDiv(Constant *C1, Constant *C2);
695 static Constant *getFDiv(Constant *C1, Constant *C2);
696 static Constant *getURem(Constant *C1, Constant *C2); // unsigned rem
697 static Constant *getSRem(Constant *C1, Constant *C2); // signed rem
698 static Constant *getFRem(Constant *C1, Constant *C2);
699 static Constant *getAnd(Constant *C1, Constant *C2);
700 static Constant *getOr(Constant *C1, Constant *C2);
701 static Constant *getXor(Constant *C1, Constant *C2);
702 static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
703 static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
704 static Constant *getVICmp(unsigned short pred, Constant *LHS, Constant *RHS);
705 static Constant *getVFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
706 static Constant *getShl(Constant *C1, Constant *C2);
707 static Constant *getLShr(Constant *C1, Constant *C2);
708 static Constant *getAShr(Constant *C1, Constant *C2);
710 /// Getelementptr form. std::vector<Value*> is only accepted for convenience:
711 /// all elements must be Constant's.
713 static Constant *getGetElementPtr(Constant *C,
714 Constant* const *IdxList, unsigned NumIdx);
715 static Constant *getGetElementPtr(Constant *C,
716 Value* const *IdxList, unsigned NumIdx);
718 static Constant *getExtractElement(Constant *Vec, Constant *Idx);
719 static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
720 static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
721 static Constant *getExtractValue(Constant *Agg,
722 const unsigned *IdxList, unsigned NumIdx);
723 static Constant *getInsertValue(Constant *Agg, Constant *Val,
724 const unsigned *IdxList, unsigned NumIdx);
726 /// Floating point negation must be implemented with f(x) = -0.0 - x. This
727 /// method returns the negative zero constant for floating point or vector
728 /// floating point types; for all other types, it returns the null value.
729 static Constant *getZeroValueForNegationExpr(const Type *Ty);
731 /// isNullValue - Return true if this is the value that would be returned by
733 virtual bool isNullValue() const { return false; }
735 /// getOpcode - Return the opcode at the root of this constant expression
736 unsigned getOpcode() const { return SubclassData; }
738 /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
739 /// not an ICMP or FCMP constant expression.
740 unsigned getPredicate() const;
742 /// getIndices - Assert that this is an insertvalue or exactvalue
743 /// expression and return the list of indices.
744 const SmallVector<unsigned, 4> &getIndices() const;
746 /// getOpcodeName - Return a string representation for an opcode.
747 const char *getOpcodeName() const;
749 /// getWithOperandReplaced - Return a constant expression identical to this
750 /// one, but with the specified operand set to the specified value.
751 Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
753 /// getWithOperands - This returns the current constant expression with the
754 /// operands replaced with the specified values. The specified operands must
755 /// match count and type with the existing ones.
756 Constant *getWithOperands(const std::vector<Constant*> &Ops) const {
757 return getWithOperands(&Ops[0], (unsigned)Ops.size());
759 Constant *getWithOperands(Constant* const *Ops, unsigned NumOps) const;
761 virtual void destroyConstant();
762 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
764 /// Methods for support type inquiry through isa, cast, and dyn_cast:
765 static inline bool classof(const ConstantExpr *) { return true; }
766 static inline bool classof(const Value *V) {
767 return V->getValueID() == ConstantExprVal;
772 struct OperandTraits<ConstantExpr> : VariadicOperandTraits<1> {
775 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantExpr, Constant)
777 //===----------------------------------------------------------------------===//
778 /// UndefValue - 'undef' values are things that do not have specified contents.
779 /// These are used for a variety of purposes, including global variable
780 /// initializers and operands to instructions. 'undef' values can occur with
783 class UndefValue : public Constant {
784 friend struct ConstantCreator<UndefValue, Type, char>;
785 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
786 UndefValue(const UndefValue &); // DO NOT IMPLEMENT
788 explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
790 // allocate space for exactly zero operands
791 void *operator new(size_t s) {
792 return User::operator new(s, 0);
795 /// get() - Static factory methods - Return an 'undef' object of the specified
798 static UndefValue *get(const Type *T);
800 /// isNullValue - Return true if this is the value that would be returned by
802 virtual bool isNullValue() const { return false; }
804 virtual void destroyConstant();
806 /// Methods for support type inquiry through isa, cast, and dyn_cast:
807 static inline bool classof(const UndefValue *) { return true; }
808 static bool classof(const Value *V) {
809 return V->getValueID() == UndefValueVal;
813 } // End llvm namespace