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 //===----------------------------------------------------------------------===//
11 /// This file contains the declarations for the subclasses of Constant,
12 /// which represent the different flavors of constant values that live in LLVM.
13 /// Note that Constants are immutable (once created they never change) and are
14 /// fully shared by structural equivalence. This means that two structurally
15 /// equivalent constants will always have the same address. Constant's are
16 /// created on demand as needed and never deleted: thus clients don't have to
17 /// worry about the lifetime of the objects.
19 //===----------------------------------------------------------------------===//
21 #ifndef LLVM_CONSTANTS_H
22 #define LLVM_CONSTANTS_H
24 #include "llvm/Constant.h"
25 #include "llvm/Type.h"
26 #include "llvm/OperandTraits.h"
27 #include "llvm/ADT/APInt.h"
28 #include "llvm/ADT/APFloat.h"
29 #include "llvm/ADT/SmallVector.h"
38 template<class ConstantClass, class TypeClass, class ValType>
39 struct ConstantCreator;
40 template<class ConstantClass, class TypeClass>
41 struct ConvertConstant;
43 //===----------------------------------------------------------------------===//
44 /// This is the shared class of boolean and integer constants. This class
45 /// represents both boolean and integral constants.
46 /// @brief Class for constant integers.
47 class ConstantInt : public Constant {
48 static ConstantInt *TheTrueVal, *TheFalseVal;
49 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
50 ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
51 ConstantInt(const IntegerType *Ty, const APInt& V);
54 // allocate space for exactly zero operands
55 void *operator new(size_t s) {
56 return User::operator new(s, 0);
59 static ConstantInt* getTrue(LLVMContext &Context);
60 static ConstantInt* getFalse(LLVMContext &Context);
62 /// If Ty is a vector type, return a Constant with a splat of the given
63 /// value. Otherwise return a ConstantInt for the given value.
64 static Constant* get(const Type* Ty, uint64_t V, bool isSigned = false);
66 /// Return a ConstantInt with the specified integer value for the specified
67 /// type. If the type is wider than 64 bits, the value will be zero-extended
68 /// to fit the type, unless isSigned is true, in which case the value will
69 /// be interpreted as a 64-bit signed integer and sign-extended to fit
71 /// @brief Get a ConstantInt for a specific value.
72 static ConstantInt* get(const IntegerType* Ty, uint64_t V,
73 bool isSigned = false);
75 /// Return a ConstantInt with the specified value for the specified type. The
76 /// value V will be canonicalized to a an unsigned APInt. Accessing it with
77 /// either getSExtValue() or getZExtValue() will yield a correctly sized and
78 /// signed value for the type Ty.
79 /// @brief Get a ConstantInt for a specific signed value.
80 static ConstantInt* getSigned(const IntegerType* Ty, int64_t V);
81 static Constant *getSigned(const Type *Ty, int64_t V);
83 /// Return a ConstantInt with the specified value and an implied Type. The
84 /// type is the integer type that corresponds to the bit width of the value.
85 static ConstantInt* get(LLVMContext &Context, const APInt& V);
87 /// If Ty is a vector type, return a Constant with a splat of the given
88 /// value. Otherwise return a ConstantInt for the given value.
89 static Constant* get(const Type* Ty, const APInt& V);
91 /// Return the constant as an APInt value reference. This allows clients to
92 /// obtain a copy of the value, with all its precision in tact.
93 /// @brief Return the constant's value.
94 inline const APInt& getValue() const {
98 /// getBitWidth - Return the bitwidth of this constant.
99 unsigned getBitWidth() const { return Val.getBitWidth(); }
101 /// Return the constant as a 64-bit unsigned integer value after it
102 /// has been zero extended as appropriate for the type of this constant. Note
103 /// that this method can assert if the value does not fit in 64 bits.
105 /// @brief Return the zero extended value.
106 inline uint64_t getZExtValue() const {
107 return Val.getZExtValue();
110 /// Return the constant as a 64-bit integer value after it has been sign
111 /// extended as appropriate for the type of this constant. Note that
112 /// this method can assert if the value does not fit in 64 bits.
114 /// @brief Return the sign extended value.
115 inline int64_t getSExtValue() const {
116 return Val.getSExtValue();
119 /// A helper method that can be used to determine if the constant contained
120 /// within is equal to a constant. This only works for very small values,
121 /// because this is all that can be represented with all types.
122 /// @brief Determine if this constant's value is same as an unsigned char.
123 bool equalsInt(uint64_t V) const {
127 /// getType - Specialize the getType() method to always return an IntegerType,
128 /// which reduces the amount of casting needed in parts of the compiler.
130 inline const IntegerType *getType() const {
131 return reinterpret_cast<const IntegerType*>(Value::getType());
134 /// This static method returns true if the type Ty is big enough to
135 /// represent the value V. This can be used to avoid having the get method
136 /// assert when V is larger than Ty can represent. Note that there are two
137 /// versions of this method, one for unsigned and one for signed integers.
138 /// Although ConstantInt canonicalizes everything to an unsigned integer,
139 /// the signed version avoids callers having to convert a signed quantity
140 /// to the appropriate unsigned type before calling the method.
141 /// @returns true if V is a valid value for type Ty
142 /// @brief Determine if the value is in range for the given type.
143 static bool isValueValidForType(const Type *Ty, uint64_t V);
144 static bool isValueValidForType(const Type *Ty, int64_t V);
146 /// This function will return true iff this constant represents the "null"
147 /// value that would be returned by the getNullValue method.
148 /// @returns true if this is the null integer value.
149 /// @brief Determine if the value is null.
150 virtual bool isNullValue() const {
154 /// This is just a convenience method to make client code smaller for a
155 /// common code. It also correctly performs the comparison without the
156 /// potential for an assertion from getZExtValue().
157 bool isZero() const {
161 /// This is just a convenience method to make client code smaller for a
162 /// common case. It also correctly performs the comparison without the
163 /// potential for an assertion from getZExtValue().
164 /// @brief Determine if the value is one.
169 /// This function will return true iff every bit in this constant is set
171 /// @returns true iff this constant's bits are all set to true.
172 /// @brief Determine if the value is all ones.
173 bool isAllOnesValue() const {
174 return Val.isAllOnesValue();
177 /// This function will return true iff this constant represents the largest
178 /// value that may be represented by the constant's type.
179 /// @returns true iff this is the largest value that may be represented
181 /// @brief Determine if the value is maximal.
182 bool isMaxValue(bool isSigned) const {
184 return Val.isMaxSignedValue();
186 return Val.isMaxValue();
189 /// This function will return true iff this constant represents the smallest
190 /// value that may be represented by this constant's type.
191 /// @returns true if this is the smallest value that may be represented by
193 /// @brief Determine if the value is minimal.
194 bool isMinValue(bool isSigned) const {
196 return Val.isMinSignedValue();
198 return Val.isMinValue();
201 /// This function will return true iff this constant represents a value with
202 /// active bits bigger than 64 bits or a value greater than the given uint64_t
204 /// @returns true iff this constant is greater or equal to the given number.
205 /// @brief Determine if the value is greater or equal to the given number.
206 bool uge(uint64_t Num) {
207 return Val.getActiveBits() > 64 || Val.getZExtValue() >= Num;
210 /// getLimitedValue - If the value is smaller than the specified limit,
211 /// return it, otherwise return the limit value. This causes the value
212 /// to saturate to the limit.
213 /// @returns the min of the value of the constant and the specified value
214 /// @brief Get the constant's value with a saturation limit
215 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
216 return Val.getLimitedValue(Limit);
219 /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
220 static inline bool classof(const ConstantInt *) { return true; }
221 static bool classof(const Value *V) {
222 return V->getValueID() == ConstantIntVal;
227 //===----------------------------------------------------------------------===//
228 /// ConstantFP - Floating Point Values [float, double]
230 class ConstantFP : public Constant {
232 void *operator new(size_t, unsigned);// DO NOT IMPLEMENT
233 ConstantFP(const ConstantFP &); // DO NOT IMPLEMENT
234 friend class LLVMContextImpl;
236 ConstantFP(const Type *Ty, const APFloat& V);
238 // allocate space for exactly zero operands
239 void *operator new(size_t s) {
240 return User::operator new(s, 0);
243 /// Floating point negation must be implemented with f(x) = -0.0 - x. This
244 /// method returns the negative zero constant for floating point or vector
245 /// floating point types; for all other types, it returns the null value.
246 static Constant* getZeroValueForNegation(const Type* Ty);
248 /// get() - This returns a ConstantFP, or a vector containing a splat of a
249 /// ConstantFP, for the specified value in the specified type. This should
250 /// only be used for simple constant values like 2.0/1.0 etc, that are
251 /// known-valid both as host double and as the target format.
252 static Constant* get(const Type* Ty, double V);
253 static ConstantFP* get(LLVMContext &Context, const APFloat& V);
254 static ConstantFP* getNegativeZero(const Type* Ty);
256 /// isValueValidForType - return true if Ty is big enough to represent V.
257 static bool isValueValidForType(const Type *Ty, const APFloat& V);
258 inline const APFloat& getValueAPF() const { return Val; }
260 /// isNullValue - Return true if this is the value that would be returned by
261 /// getNullValue. Don't depend on == for doubles to tell us it's zero, it
262 /// considers -0.0 to be null as well as 0.0. :(
263 virtual bool isNullValue() const;
265 /// isNegativeZeroValue - Return true if the value is what would be returned
266 /// by getZeroValueForNegation.
267 virtual bool isNegativeZeroValue() const {
268 return Val.isZero() && Val.isNegative();
271 /// isExactlyValue - We don't rely on operator== working on double values, as
272 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
273 /// As such, this method can be used to do an exact bit-for-bit comparison of
274 /// two floating point values. The version with a double operand is retained
275 /// because it's so convenient to write isExactlyValue(2.0), but please use
276 /// it only for simple constants.
277 bool isExactlyValue(const APFloat& V) const;
279 bool isExactlyValue(double V) const {
281 // convert is not supported on this type
282 if (&Val.getSemantics() == &APFloat::PPCDoubleDouble)
285 FV.convert(Val.getSemantics(), APFloat::rmNearestTiesToEven, &ignored);
286 return isExactlyValue(FV);
288 /// Methods for support type inquiry through isa, cast, and dyn_cast:
289 static inline bool classof(const ConstantFP *) { return true; }
290 static bool classof(const Value *V) {
291 return V->getValueID() == ConstantFPVal;
295 //===----------------------------------------------------------------------===//
296 /// ConstantAggregateZero - All zero aggregate value
298 class ConstantAggregateZero : public Constant {
299 friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
300 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
301 ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
303 explicit ConstantAggregateZero(const Type *ty)
304 : Constant(ty, ConstantAggregateZeroVal, 0, 0) {}
306 // allocate space for exactly zero operands
307 void *operator new(size_t s) {
308 return User::operator new(s, 0);
311 static ConstantAggregateZero* get(const Type* Ty);
313 /// isNullValue - Return true if this is the value that would be returned by
315 virtual bool isNullValue() const { return true; }
317 virtual void destroyConstant();
319 /// Methods for support type inquiry through isa, cast, and dyn_cast:
321 static bool classof(const ConstantAggregateZero *) { return true; }
322 static bool classof(const Value *V) {
323 return V->getValueID() == ConstantAggregateZeroVal;
328 //===----------------------------------------------------------------------===//
329 /// ConstantArray - Constant Array Declarations
331 class ConstantArray : public Constant {
332 friend struct ConstantCreator<ConstantArray, ArrayType,
333 std::vector<Constant*> >;
334 ConstantArray(const ConstantArray &); // DO NOT IMPLEMENT
336 ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
338 // ConstantArray accessors
339 static Constant* get(const ArrayType* T, const std::vector<Constant*>& V);
340 static Constant* get(const ArrayType* T, Constant* const* Vals,
343 /// This method constructs a ConstantArray and initializes it with a text
344 /// string. The default behavior (AddNull==true) causes a null terminator to
345 /// be placed at the end of the array. This effectively increases the length
346 /// of the array by one (you've been warned). However, in some situations
347 /// this is not desired so if AddNull==false then the string is copied without
348 /// null termination.
349 static Constant* get(const StringRef &Initializer, bool AddNull = true);
351 /// Transparently provide more efficient getOperand methods.
352 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
354 /// getType - Specialize the getType() method to always return an ArrayType,
355 /// which reduces the amount of casting needed in parts of the compiler.
357 inline const ArrayType *getType() const {
358 return reinterpret_cast<const ArrayType*>(Value::getType());
361 /// isString - This method returns true if the array is an array of i8 and
362 /// the elements of the array are all ConstantInt's.
363 bool isString() const;
365 /// isCString - This method returns true if the array is a string (see
367 /// isString) and it ends in a null byte \0 and does not contains any other
369 /// null bytes except its terminator.
370 bool isCString() const;
372 /// getAsString - If this array is isString(), then this method converts the
373 /// array to an std::string and returns it. Otherwise, it asserts out.
375 std::string getAsString() const;
377 /// isNullValue - Return true if this is the value that would be returned by
378 /// getNullValue. This always returns false because zero arrays are always
379 /// created as ConstantAggregateZero objects.
380 virtual bool isNullValue() const { return false; }
382 virtual void destroyConstant();
383 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
385 /// Methods for support type inquiry through isa, cast, and dyn_cast:
386 static inline bool classof(const ConstantArray *) { return true; }
387 static bool classof(const Value *V) {
388 return V->getValueID() == ConstantArrayVal;
393 struct OperandTraits<ConstantArray> : VariadicOperandTraits<> {
396 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantArray, Constant)
398 //===----------------------------------------------------------------------===//
399 // ConstantStruct - Constant Struct Declarations
401 class ConstantStruct : public Constant {
402 friend struct ConstantCreator<ConstantStruct, StructType,
403 std::vector<Constant*> >;
404 ConstantStruct(const ConstantStruct &); // DO NOT IMPLEMENT
406 ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
408 // ConstantStruct accessors
409 static Constant* get(const StructType* T, const std::vector<Constant*>& V);
410 static Constant* get(LLVMContext &Context,
411 const std::vector<Constant*>& V, bool Packed = false);
412 static Constant* get(LLVMContext &Context,
413 Constant* const *Vals, unsigned NumVals,
414 bool Packed = false);
416 /// Transparently provide more efficient getOperand methods.
417 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
419 /// getType() specialization - Reduce amount of casting...
421 inline const StructType *getType() const {
422 return reinterpret_cast<const StructType*>(Value::getType());
425 /// isNullValue - Return true if this is the value that would be returned by
426 /// getNullValue. This always returns false because zero structs are always
427 /// created as ConstantAggregateZero objects.
428 virtual bool isNullValue() const {
432 virtual void destroyConstant();
433 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
435 /// Methods for support type inquiry through isa, cast, and dyn_cast:
436 static inline bool classof(const ConstantStruct *) { return true; }
437 static bool classof(const Value *V) {
438 return V->getValueID() == ConstantStructVal;
443 struct OperandTraits<ConstantStruct> : VariadicOperandTraits<> {
446 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantStruct, Constant)
448 //===----------------------------------------------------------------------===//
449 /// ConstantVector - Constant Vector Declarations
451 class ConstantVector : public Constant {
452 friend struct ConstantCreator<ConstantVector, VectorType,
453 std::vector<Constant*> >;
454 ConstantVector(const ConstantVector &); // DO NOT IMPLEMENT
456 ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
458 // ConstantVector accessors
459 static Constant* get(const VectorType* T, const std::vector<Constant*>& V);
460 static Constant* get(const std::vector<Constant*>& V);
461 static Constant* get(Constant* const* Vals, unsigned NumVals);
463 /// Transparently provide more efficient getOperand methods.
464 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
466 /// getType - Specialize the getType() method to always return a VectorType,
467 /// which reduces the amount of casting needed in parts of the compiler.
469 inline const VectorType *getType() const {
470 return reinterpret_cast<const VectorType*>(Value::getType());
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 ConvertConstant<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
595 /// getAlignOf constant expr - computes the alignment of a type in a target
596 /// independent way (Note: the return type is an i32; Note: assumes that i8
597 /// is byte aligned).
598 static Constant* getAlignOf(const Type* Ty);
600 /// getSizeOf constant expr - computes the size of a type in a target
601 /// independent way (Note: the return type is an i64).
603 static Constant* getSizeOf(const Type* Ty);
605 static Constant* getNeg(Constant* C);
606 static Constant* getFNeg(Constant* C);
607 static Constant* getNot(Constant* C);
608 static Constant* getAdd(Constant* C1, Constant* C2);
609 static Constant* getFAdd(Constant* C1, Constant* C2);
610 static Constant* getSub(Constant* C1, Constant* C2);
611 static Constant* getFSub(Constant* C1, Constant* C2);
612 static Constant* getMul(Constant* C1, Constant* C2);
613 static Constant* getFMul(Constant* C1, Constant* C2);
614 static Constant* getUDiv(Constant* C1, Constant* C2);
615 static Constant* getSDiv(Constant* C1, Constant* C2);
616 static Constant* getFDiv(Constant* C1, Constant* C2);
617 static Constant* getURem(Constant* C1, Constant* C2);
618 static Constant* getSRem(Constant* C1, Constant* C2);
619 static Constant* getFRem(Constant* C1, Constant* C2);
620 static Constant* getAnd(Constant* C1, Constant* C2);
621 static Constant* getOr(Constant* C1, Constant* C2);
622 static Constant* getXor(Constant* C1, Constant* C2);
623 static Constant* getShl(Constant* C1, Constant* C2);
624 static Constant* getLShr(Constant* C1, Constant* C2);
625 static Constant* getAShr(Constant* C1, Constant* C2);
626 static Constant *getTrunc (Constant *C, const Type *Ty);
627 static Constant *getSExt (Constant *C, const Type *Ty);
628 static Constant *getZExt (Constant *C, const Type *Ty);
629 static Constant *getFPTrunc (Constant *C, const Type *Ty);
630 static Constant *getFPExtend(Constant *C, const Type *Ty);
631 static Constant *getUIToFP (Constant *C, const Type *Ty);
632 static Constant *getSIToFP (Constant *C, const Type *Ty);
633 static Constant *getFPToUI (Constant *C, const Type *Ty);
634 static Constant *getFPToSI (Constant *C, const Type *Ty);
635 static Constant *getPtrToInt(Constant *C, const Type *Ty);
636 static Constant *getIntToPtr(Constant *C, const Type *Ty);
637 static Constant *getBitCast (Constant *C, const Type *Ty);
639 static Constant* getExactSDiv(Constant* C1, Constant* C2);
641 /// Transparently provide more efficient getOperand methods.
642 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
644 // @brief Convenience function for getting one of the casting operations
645 // using a CastOps opcode.
646 static Constant *getCast(
647 unsigned ops, ///< The opcode for the conversion
648 Constant *C, ///< The constant to be converted
649 const Type *Ty ///< The type to which the constant is converted
652 // @brief Create a ZExt or BitCast cast constant expression
653 static Constant *getZExtOrBitCast(
654 Constant *C, ///< The constant to zext or bitcast
655 const Type *Ty ///< The type to zext or bitcast C to
658 // @brief Create a SExt or BitCast cast constant expression
659 static Constant *getSExtOrBitCast(
660 Constant *C, ///< The constant to sext or bitcast
661 const Type *Ty ///< The type to sext or bitcast C to
664 // @brief Create a Trunc or BitCast cast constant expression
665 static Constant *getTruncOrBitCast(
666 Constant *C, ///< The constant to trunc or bitcast
667 const Type *Ty ///< The type to trunc or bitcast C to
670 /// @brief Create a BitCast or a PtrToInt cast constant expression
671 static Constant *getPointerCast(
672 Constant *C, ///< The pointer value to be casted (operand 0)
673 const Type *Ty ///< The type to which cast should be made
676 /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
677 static Constant *getIntegerCast(
678 Constant *C, ///< The integer constant to be casted
679 const Type *Ty, ///< The integer type to cast to
680 bool isSigned ///< Whether C should be treated as signed or not
683 /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
684 static Constant *getFPCast(
685 Constant *C, ///< The integer constant to be casted
686 const Type *Ty ///< The integer type to cast to
689 /// @brief Return true if this is a convert constant expression
692 /// @brief Return true if this is a compare constant expression
693 bool isCompare() const;
695 /// @brief Return true if this is an insertvalue or extractvalue expression,
696 /// and the getIndices() method may be used.
697 bool hasIndices() const;
699 /// Select constant expr
701 static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
702 return getSelectTy(V1->getType(), C, V1, V2);
705 /// get - Return a binary or shift operator constant expression,
706 /// folding if possible.
708 static Constant *get(unsigned Opcode, Constant *C1, Constant *C2);
710 /// @brief Return an ICmp or FCmp comparison operator constant expression.
711 static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
713 /// get* - Return some common constants without having to
714 /// specify the full Instruction::OPCODE identifier.
716 static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
717 static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
719 /// Getelementptr form. std::vector<Value*> is only accepted for convenience:
720 /// all elements must be Constant's.
722 static Constant *getGetElementPtr(Constant *C,
723 Constant* const *IdxList, unsigned NumIdx);
724 static Constant *getGetElementPtr(Constant *C,
725 Value* const *IdxList, unsigned NumIdx);
727 static Constant *getExtractElement(Constant *Vec, Constant *Idx);
728 static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
729 static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
730 static Constant *getExtractValue(Constant *Agg,
731 const unsigned *IdxList, unsigned NumIdx);
732 static Constant *getInsertValue(Constant *Agg, Constant *Val,
733 const unsigned *IdxList, unsigned NumIdx);
735 /// isNullValue - Return true if this is the value that would be returned by
737 virtual bool isNullValue() const { return false; }
739 /// getOpcode - Return the opcode at the root of this constant expression
740 unsigned getOpcode() const { return SubclassData; }
742 /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
743 /// not an ICMP or FCMP constant expression.
744 unsigned getPredicate() const;
746 /// getIndices - Assert that this is an insertvalue or exactvalue
747 /// expression and return the list of indices.
748 const SmallVector<unsigned, 4> &getIndices() const;
750 /// getOpcodeName - Return a string representation for an opcode.
751 const char *getOpcodeName() const;
753 /// getWithOperandReplaced - Return a constant expression identical to this
754 /// one, but with the specified operand set to the specified value.
755 Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
757 /// getWithOperands - This returns the current constant expression with the
758 /// operands replaced with the specified values. The specified operands must
759 /// match count and type with the existing ones.
760 Constant *getWithOperands(const std::vector<Constant*> &Ops) const {
761 return getWithOperands(&Ops[0], (unsigned)Ops.size());
763 Constant *getWithOperands(Constant* const *Ops, unsigned NumOps) const;
765 virtual void destroyConstant();
766 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
768 /// Methods for support type inquiry through isa, cast, and dyn_cast:
769 static inline bool classof(const ConstantExpr *) { return true; }
770 static inline bool classof(const Value *V) {
771 return V->getValueID() == ConstantExprVal;
776 struct OperandTraits<ConstantExpr> : VariadicOperandTraits<1> {
779 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantExpr, Constant)
781 //===----------------------------------------------------------------------===//
782 /// UndefValue - 'undef' values are things that do not have specified contents.
783 /// These are used for a variety of purposes, including global variable
784 /// initializers and operands to instructions. 'undef' values can occur with
787 class UndefValue : public Constant {
788 friend struct ConstantCreator<UndefValue, Type, char>;
789 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
790 UndefValue(const UndefValue &); // DO NOT IMPLEMENT
792 explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
794 // allocate space for exactly zero operands
795 void *operator new(size_t s) {
796 return User::operator new(s, 0);
799 /// get() - Static factory methods - Return an 'undef' object of the specified
802 static UndefValue *get(const Type *T);
804 /// isNullValue - Return true if this is the value that would be returned by
806 virtual bool isNullValue() const { return false; }
808 virtual void destroyConstant();
810 /// Methods for support type inquiry through isa, cast, and dyn_cast:
811 static inline bool classof(const UndefValue *) { return true; }
812 static bool classof(const Value *V) {
813 return V->getValueID() == UndefValueVal;
816 } // End llvm namespace