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/OperandTraits.h"
26 #include "llvm/ADT/APInt.h"
27 #include "llvm/ADT/APFloat.h"
28 #include "llvm/ADT/ArrayRef.h"
38 template<class ConstantClass, class TypeClass, class ValType>
39 struct ConstantCreator;
40 template<class ConstantClass, class TypeClass>
41 struct ConvertConstantType;
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 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
49 ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
50 ConstantInt(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 static ConstantInt *getTrue(LLVMContext &Context);
59 static ConstantInt *getFalse(LLVMContext &Context);
60 static Constant *getTrue(Type *Ty);
61 static Constant *getFalse(Type *Ty);
63 /// If Ty is a vector type, return a Constant with a splat of the given
64 /// value. Otherwise return a ConstantInt for the given value.
65 static Constant *get(Type *Ty, uint64_t V, bool isSigned = false);
67 /// Return a ConstantInt with the specified integer value for the specified
68 /// type. If the type is wider than 64 bits, the value will be zero-extended
69 /// to fit the type, unless isSigned is true, in which case the value will
70 /// be interpreted as a 64-bit signed integer and sign-extended to fit
72 /// @brief Get a ConstantInt for a specific value.
73 static ConstantInt *get(IntegerType *Ty, uint64_t V,
74 bool isSigned = false);
76 /// Return a ConstantInt with the specified value for the specified type. The
77 /// value V will be canonicalized to a an unsigned APInt. Accessing it with
78 /// either getSExtValue() or getZExtValue() will yield a correctly sized and
79 /// signed value for the type Ty.
80 /// @brief Get a ConstantInt for a specific signed value.
81 static ConstantInt *getSigned(IntegerType *Ty, int64_t V);
82 static Constant *getSigned(Type *Ty, int64_t V);
84 /// Return a ConstantInt with the specified value and an implied Type. The
85 /// type is the integer type that corresponds to the bit width of the value.
86 static ConstantInt *get(LLVMContext &Context, const APInt &V);
88 /// Return a ConstantInt constructed from the string strStart with the given
90 static ConstantInt *get(IntegerType *Ty, StringRef Str,
93 /// If Ty is a vector type, return a Constant with a splat of the given
94 /// value. Otherwise return a ConstantInt for the given value.
95 static Constant *get(Type* Ty, const APInt& V);
97 /// Return the constant as an APInt value reference. This allows clients to
98 /// obtain a copy of the value, with all its precision in tact.
99 /// @brief Return the constant's value.
100 inline const APInt &getValue() const {
104 /// getBitWidth - Return the bitwidth of this constant.
105 unsigned getBitWidth() const { return Val.getBitWidth(); }
107 /// Return the constant as a 64-bit unsigned integer value after it
108 /// has been zero extended as appropriate for the type of this constant. Note
109 /// that this method can assert if the value does not fit in 64 bits.
111 /// @brief Return the zero extended value.
112 inline uint64_t getZExtValue() const {
113 return Val.getZExtValue();
116 /// Return the constant as a 64-bit integer value after it has been sign
117 /// extended as appropriate for the type of this constant. Note that
118 /// this method can assert if the value does not fit in 64 bits.
120 /// @brief Return the sign extended value.
121 inline int64_t getSExtValue() const {
122 return Val.getSExtValue();
125 /// A helper method that can be used to determine if the constant contained
126 /// within is equal to a constant. This only works for very small values,
127 /// because this is all that can be represented with all types.
128 /// @brief Determine if this constant's value is same as an unsigned char.
129 bool equalsInt(uint64_t V) const {
133 /// getType - Specialize the getType() method to always return an IntegerType,
134 /// which reduces the amount of casting needed in parts of the compiler.
136 inline IntegerType *getType() const {
137 return reinterpret_cast<IntegerType*>(Value::getType());
140 /// This static method returns true if the type Ty is big enough to
141 /// represent the value V. This can be used to avoid having the get method
142 /// assert when V is larger than Ty can represent. Note that there are two
143 /// versions of this method, one for unsigned and one for signed integers.
144 /// Although ConstantInt canonicalizes everything to an unsigned integer,
145 /// the signed version avoids callers having to convert a signed quantity
146 /// to the appropriate unsigned type before calling the method.
147 /// @returns true if V is a valid value for type Ty
148 /// @brief Determine if the value is in range for the given type.
149 static bool isValueValidForType(Type *Ty, uint64_t V);
150 static bool isValueValidForType(Type *Ty, int64_t V);
152 bool isNegative() const { return Val.isNegative(); }
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 isMinusOne() 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) const {
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(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(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(Type* Ty, double V);
253 static Constant *get(Type* Ty, StringRef Str);
254 static ConstantFP *get(LLVMContext &Context, const APFloat &V);
255 static ConstantFP *getNegativeZero(Type* Ty);
256 static ConstantFP *getInfinity(Type *Ty, bool Negative = false);
258 /// isValueValidForType - return true if Ty is big enough to represent V.
259 static bool isValueValidForType(Type *Ty, const APFloat &V);
260 inline const APFloat &getValueAPF() const { return Val; }
262 /// isZero - Return true if the value is positive or negative zero.
263 bool isZero() const { return Val.isZero(); }
265 /// isNegative - Return true if the sign bit is set.
266 bool isNegative() const { return Val.isNegative(); }
268 /// isNaN - Return true if the value is a NaN.
269 bool isNaN() const { return Val.isNaN(); }
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(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(Type *Ty);
313 virtual void destroyConstant();
315 /// Methods for support type inquiry through isa, cast, and dyn_cast:
317 static bool classof(const ConstantAggregateZero *) { return true; }
318 static bool classof(const Value *V) {
319 return V->getValueID() == ConstantAggregateZeroVal;
324 //===----------------------------------------------------------------------===//
325 /// ConstantArray - Constant Array Declarations
327 class ConstantArray : public Constant {
328 friend struct ConstantCreator<ConstantArray, ArrayType,
329 std::vector<Constant*> >;
330 ConstantArray(const ConstantArray &); // DO NOT IMPLEMENT
332 ConstantArray(ArrayType *T, ArrayRef<Constant *> Val);
334 // ConstantArray accessors
335 static Constant *get(ArrayType *T, ArrayRef<Constant*> V);
337 /// This method constructs a ConstantArray and initializes it with a text
338 /// string. The default behavior (AddNull==true) causes a null terminator to
339 /// be placed at the end of the array. This effectively increases the length
340 /// of the array by one (you've been warned). However, in some situations
341 /// this is not desired so if AddNull==false then the string is copied without
342 /// null termination.
343 static Constant *get(LLVMContext &Context, StringRef Initializer,
344 bool AddNull = true);
346 /// Transparently provide more efficient getOperand methods.
347 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
349 /// getType - Specialize the getType() method to always return an ArrayType,
350 /// which reduces the amount of casting needed in parts of the compiler.
352 inline ArrayType *getType() const {
353 return reinterpret_cast<ArrayType*>(Value::getType());
356 /// isString - This method returns true if the array is an array of i8 and
357 /// the elements of the array are all ConstantInt's.
358 bool isString() const;
360 /// isCString - This method returns true if the array is a string (see
362 /// isString) and it ends in a null byte \0 and does not contains any other
364 /// null bytes except its terminator.
365 bool isCString() const;
367 /// getAsString - If this array is isString(), then this method converts the
368 /// array to an std::string and returns it. Otherwise, it asserts out.
370 std::string getAsString() const;
372 /// getAsCString - If this array is isCString(), then this method converts the
373 /// array (without the trailing null byte) to an std::string and returns it.
374 /// Otherwise, it asserts out.
376 std::string getAsCString() const;
378 virtual void destroyConstant();
379 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
381 /// Methods for support type inquiry through isa, cast, and dyn_cast:
382 static inline bool classof(const ConstantArray *) { return true; }
383 static bool classof(const Value *V) {
384 return V->getValueID() == ConstantArrayVal;
389 struct OperandTraits<ConstantArray> :
390 public VariadicOperandTraits<ConstantArray> {
393 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantArray, Constant)
395 //===----------------------------------------------------------------------===//
396 // ConstantStruct - Constant Struct Declarations
398 class ConstantStruct : public Constant {
399 friend struct ConstantCreator<ConstantStruct, StructType,
400 std::vector<Constant*> >;
401 ConstantStruct(const ConstantStruct &); // DO NOT IMPLEMENT
403 ConstantStruct(StructType *T, ArrayRef<Constant *> Val);
405 // ConstantStruct accessors
406 static Constant *get(StructType *T, ArrayRef<Constant*> V);
407 static Constant *get(StructType *T, ...) END_WITH_NULL;
409 /// getAnon - Return an anonymous struct that has the specified
410 /// elements. If the struct is possibly empty, then you must specify a
412 static Constant *getAnon(ArrayRef<Constant*> V, bool Packed = false) {
413 return get(getTypeForElements(V, Packed), V);
415 static Constant *getAnon(LLVMContext &Ctx,
416 ArrayRef<Constant*> V, bool Packed = false) {
417 return get(getTypeForElements(Ctx, V, Packed), V);
420 /// getTypeForElements - Return an anonymous struct type to use for a constant
421 /// with the specified set of elements. The list must not be empty.
422 static StructType *getTypeForElements(ArrayRef<Constant*> V,
423 bool Packed = false);
424 /// getTypeForElements - This version of the method allows an empty list.
425 static StructType *getTypeForElements(LLVMContext &Ctx,
426 ArrayRef<Constant*> V,
427 bool Packed = false);
429 /// Transparently provide more efficient getOperand methods.
430 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
432 /// getType() specialization - Reduce amount of casting...
434 inline StructType *getType() const {
435 return reinterpret_cast<StructType*>(Value::getType());
438 virtual void destroyConstant();
439 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
441 /// Methods for support type inquiry through isa, cast, and dyn_cast:
442 static inline bool classof(const ConstantStruct *) { return true; }
443 static bool classof(const Value *V) {
444 return V->getValueID() == ConstantStructVal;
449 struct OperandTraits<ConstantStruct> :
450 public VariadicOperandTraits<ConstantStruct> {
453 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantStruct, Constant)
456 //===----------------------------------------------------------------------===//
457 /// ConstantVector - Constant Vector Declarations
459 class ConstantVector : public Constant {
460 friend struct ConstantCreator<ConstantVector, VectorType,
461 std::vector<Constant*> >;
462 ConstantVector(const ConstantVector &); // DO NOT IMPLEMENT
464 ConstantVector(VectorType *T, ArrayRef<Constant *> Val);
466 // ConstantVector accessors
467 static Constant *get(ArrayRef<Constant*> V);
469 /// Transparently provide more efficient getOperand methods.
470 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
472 /// getType - Specialize the getType() method to always return a VectorType,
473 /// which reduces the amount of casting needed in parts of the compiler.
475 inline VectorType *getType() const {
476 return reinterpret_cast<VectorType*>(Value::getType());
479 /// getSplatValue - If this is a splat constant, meaning that all of the
480 /// elements have the same value, return that value. Otherwise return NULL.
481 Constant *getSplatValue() const;
483 virtual void destroyConstant();
484 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
486 /// Methods for support type inquiry through isa, cast, and dyn_cast:
487 static inline bool classof(const ConstantVector *) { return true; }
488 static bool classof(const Value *V) {
489 return V->getValueID() == ConstantVectorVal;
494 struct OperandTraits<ConstantVector> :
495 public VariadicOperandTraits<ConstantVector> {
498 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantVector, Constant)
500 //===----------------------------------------------------------------------===//
501 /// ConstantPointerNull - a constant pointer value that points to null
503 class ConstantPointerNull : public Constant {
504 friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
505 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
506 ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
508 explicit ConstantPointerNull(PointerType *T)
509 : Constant(reinterpret_cast<Type*>(T),
510 Value::ConstantPointerNullVal, 0, 0) {}
513 // allocate space for exactly zero operands
514 void *operator new(size_t s) {
515 return User::operator new(s, 0);
518 /// get() - Static factory methods - Return objects of the specified value
519 static ConstantPointerNull *get(PointerType *T);
521 virtual void destroyConstant();
523 /// getType - Specialize the getType() method to always return an PointerType,
524 /// which reduces the amount of casting needed in parts of the compiler.
526 inline PointerType *getType() const {
527 return reinterpret_cast<PointerType*>(Value::getType());
530 /// Methods for support type inquiry through isa, cast, and dyn_cast:
531 static inline bool classof(const ConstantPointerNull *) { return true; }
532 static bool classof(const Value *V) {
533 return V->getValueID() == ConstantPointerNullVal;
537 /// BlockAddress - The address of a basic block.
539 class BlockAddress : public Constant {
540 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
541 void *operator new(size_t s) { return User::operator new(s, 2); }
542 BlockAddress(Function *F, BasicBlock *BB);
544 /// get - Return a BlockAddress for the specified function and basic block.
545 static BlockAddress *get(Function *F, BasicBlock *BB);
547 /// get - Return a BlockAddress for the specified basic block. The basic
548 /// block must be embedded into a function.
549 static BlockAddress *get(BasicBlock *BB);
551 /// Transparently provide more efficient getOperand methods.
552 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
554 Function *getFunction() const { return (Function*)Op<0>().get(); }
555 BasicBlock *getBasicBlock() const { return (BasicBlock*)Op<1>().get(); }
557 virtual void destroyConstant();
558 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
560 /// Methods for support type inquiry through isa, cast, and dyn_cast:
561 static inline bool classof(const BlockAddress *) { return true; }
562 static inline bool classof(const Value *V) {
563 return V->getValueID() == BlockAddressVal;
568 struct OperandTraits<BlockAddress> :
569 public FixedNumOperandTraits<BlockAddress, 2> {
572 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BlockAddress, Value)
575 //===----------------------------------------------------------------------===//
576 /// ConstantExpr - a constant value that is initialized with an expression using
577 /// other constant values.
579 /// This class uses the standard Instruction opcodes to define the various
580 /// constant expressions. The Opcode field for the ConstantExpr class is
581 /// maintained in the Value::SubclassData field.
582 class ConstantExpr : public Constant {
583 friend struct ConstantCreator<ConstantExpr,Type,
584 std::pair<unsigned, std::vector<Constant*> > >;
585 friend struct ConvertConstantType<ConstantExpr, Type>;
588 ConstantExpr(Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
589 : Constant(ty, ConstantExprVal, Ops, NumOps) {
590 // Operation type (an Instruction opcode) is stored as the SubclassData.
591 setValueSubclassData(Opcode);
595 // Static methods to construct a ConstantExpr of different kinds. Note that
596 // these methods may return a object that is not an instance of the
597 // ConstantExpr class, because they will attempt to fold the constant
598 // expression into something simpler if possible.
600 /// getAlignOf constant expr - computes the alignment of a type in a target
601 /// independent way (Note: the return type is an i64).
602 static Constant *getAlignOf(Type *Ty);
604 /// getSizeOf constant expr - computes the (alloc) size of a type (in
605 /// address-units, not bits) in a target independent way (Note: the return
608 static Constant *getSizeOf(Type *Ty);
610 /// getOffsetOf constant expr - computes the offset of a struct field in a
611 /// target independent way (Note: the return type is an i64).
613 static Constant *getOffsetOf(StructType *STy, unsigned FieldNo);
615 /// getOffsetOf constant expr - This is a generalized form of getOffsetOf,
616 /// which supports any aggregate type, and any Constant index.
618 static Constant *getOffsetOf(Type *Ty, Constant *FieldNo);
620 static Constant *getNeg(Constant *C, bool HasNUW = false, bool HasNSW =false);
621 static Constant *getFNeg(Constant *C);
622 static Constant *getNot(Constant *C);
623 static Constant *getAdd(Constant *C1, Constant *C2,
624 bool HasNUW = false, bool HasNSW = false);
625 static Constant *getFAdd(Constant *C1, Constant *C2);
626 static Constant *getSub(Constant *C1, Constant *C2,
627 bool HasNUW = false, bool HasNSW = false);
628 static Constant *getFSub(Constant *C1, Constant *C2);
629 static Constant *getMul(Constant *C1, Constant *C2,
630 bool HasNUW = false, bool HasNSW = false);
631 static Constant *getFMul(Constant *C1, Constant *C2);
632 static Constant *getUDiv(Constant *C1, Constant *C2, bool isExact = false);
633 static Constant *getSDiv(Constant *C1, Constant *C2, bool isExact = false);
634 static Constant *getFDiv(Constant *C1, Constant *C2);
635 static Constant *getURem(Constant *C1, Constant *C2);
636 static Constant *getSRem(Constant *C1, Constant *C2);
637 static Constant *getFRem(Constant *C1, Constant *C2);
638 static Constant *getAnd(Constant *C1, Constant *C2);
639 static Constant *getOr(Constant *C1, Constant *C2);
640 static Constant *getXor(Constant *C1, Constant *C2);
641 static Constant *getShl(Constant *C1, Constant *C2,
642 bool HasNUW = false, bool HasNSW = false);
643 static Constant *getLShr(Constant *C1, Constant *C2, bool isExact = false);
644 static Constant *getAShr(Constant *C1, Constant *C2, bool isExact = false);
645 static Constant *getTrunc (Constant *C, Type *Ty);
646 static Constant *getSExt (Constant *C, Type *Ty);
647 static Constant *getZExt (Constant *C, Type *Ty);
648 static Constant *getFPTrunc (Constant *C, Type *Ty);
649 static Constant *getFPExtend(Constant *C, Type *Ty);
650 static Constant *getUIToFP (Constant *C, Type *Ty);
651 static Constant *getSIToFP (Constant *C, Type *Ty);
652 static Constant *getFPToUI (Constant *C, Type *Ty);
653 static Constant *getFPToSI (Constant *C, Type *Ty);
654 static Constant *getPtrToInt(Constant *C, Type *Ty);
655 static Constant *getIntToPtr(Constant *C, Type *Ty);
656 static Constant *getBitCast (Constant *C, Type *Ty);
658 static Constant *getNSWNeg(Constant *C) { return getNeg(C, false, true); }
659 static Constant *getNUWNeg(Constant *C) { return getNeg(C, true, false); }
660 static Constant *getNSWAdd(Constant *C1, Constant *C2) {
661 return getAdd(C1, C2, false, true);
663 static Constant *getNUWAdd(Constant *C1, Constant *C2) {
664 return getAdd(C1, C2, true, false);
666 static Constant *getNSWSub(Constant *C1, Constant *C2) {
667 return getSub(C1, C2, false, true);
669 static Constant *getNUWSub(Constant *C1, Constant *C2) {
670 return getSub(C1, C2, true, false);
672 static Constant *getNSWMul(Constant *C1, Constant *C2) {
673 return getMul(C1, C2, false, true);
675 static Constant *getNUWMul(Constant *C1, Constant *C2) {
676 return getMul(C1, C2, true, false);
678 static Constant *getNSWShl(Constant *C1, Constant *C2) {
679 return getShl(C1, C2, false, true);
681 static Constant *getNUWShl(Constant *C1, Constant *C2) {
682 return getShl(C1, C2, true, false);
684 static Constant *getExactSDiv(Constant *C1, Constant *C2) {
685 return getSDiv(C1, C2, true);
687 static Constant *getExactUDiv(Constant *C1, Constant *C2) {
688 return getUDiv(C1, C2, true);
690 static Constant *getExactAShr(Constant *C1, Constant *C2) {
691 return getAShr(C1, C2, true);
693 static Constant *getExactLShr(Constant *C1, Constant *C2) {
694 return getLShr(C1, C2, true);
697 /// Transparently provide more efficient getOperand methods.
698 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
700 // @brief Convenience function for getting one of the casting operations
701 // using a CastOps opcode.
702 static Constant *getCast(
703 unsigned ops, ///< The opcode for the conversion
704 Constant *C, ///< The constant to be converted
705 Type *Ty ///< The type to which the constant is converted
708 // @brief Create a ZExt or BitCast cast constant expression
709 static Constant *getZExtOrBitCast(
710 Constant *C, ///< The constant to zext or bitcast
711 Type *Ty ///< The type to zext or bitcast C to
714 // @brief Create a SExt or BitCast cast constant expression
715 static Constant *getSExtOrBitCast(
716 Constant *C, ///< The constant to sext or bitcast
717 Type *Ty ///< The type to sext or bitcast C to
720 // @brief Create a Trunc or BitCast cast constant expression
721 static Constant *getTruncOrBitCast(
722 Constant *C, ///< The constant to trunc or bitcast
723 Type *Ty ///< The type to trunc or bitcast C to
726 /// @brief Create a BitCast or a PtrToInt cast constant expression
727 static Constant *getPointerCast(
728 Constant *C, ///< The pointer value to be casted (operand 0)
729 Type *Ty ///< The type to which cast should be made
732 /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
733 static Constant *getIntegerCast(
734 Constant *C, ///< The integer constant to be casted
735 Type *Ty, ///< The integer type to cast to
736 bool isSigned ///< Whether C should be treated as signed or not
739 /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
740 static Constant *getFPCast(
741 Constant *C, ///< The integer constant to be casted
742 Type *Ty ///< The integer type to cast to
745 /// @brief Return true if this is a convert constant expression
748 /// @brief Return true if this is a compare constant expression
749 bool isCompare() const;
751 /// @brief Return true if this is an insertvalue or extractvalue expression,
752 /// and the getIndices() method may be used.
753 bool hasIndices() const;
755 /// @brief Return true if this is a getelementptr expression and all
756 /// the index operands are compile-time known integers within the
757 /// corresponding notional static array extents. Note that this is
758 /// not equivalant to, a subset of, or a superset of the "inbounds"
760 bool isGEPWithNoNotionalOverIndexing() const;
762 /// Select constant expr
764 static Constant *getSelect(Constant *C, Constant *V1, Constant *V2);
766 /// get - Return a binary or shift operator constant expression,
767 /// folding if possible.
769 static Constant *get(unsigned Opcode, Constant *C1, Constant *C2,
772 /// @brief Return an ICmp or FCmp comparison operator constant expression.
773 static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
775 /// get* - Return some common constants without having to
776 /// specify the full Instruction::OPCODE identifier.
778 static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
779 static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
781 /// Getelementptr form. Value* is only accepted for convenience;
782 /// all elements must be Constant's.
784 static Constant *getGetElementPtr(Constant *C,
785 ArrayRef<Constant *> IdxList,
786 bool InBounds = false) {
787 return getGetElementPtr(C, makeArrayRef((Value * const *)IdxList.data(),
791 static Constant *getGetElementPtr(Constant *C,
793 bool InBounds = false) {
794 // This form of the function only exists to avoid ambiguous overload
795 // warnings about whether to convert Idx to ArrayRef<Constant *> or
796 // ArrayRef<Value *>.
797 return getGetElementPtr(C, cast<Value>(Idx), InBounds);
799 static Constant *getGetElementPtr(Constant *C,
800 ArrayRef<Value *> IdxList,
801 bool InBounds = false);
803 /// Create an "inbounds" getelementptr. See the documentation for the
804 /// "inbounds" flag in LangRef.html for details.
805 static Constant *getInBoundsGetElementPtr(Constant *C,
806 ArrayRef<Constant *> IdxList) {
807 return getGetElementPtr(C, IdxList, true);
809 static Constant *getInBoundsGetElementPtr(Constant *C,
811 // This form of the function only exists to avoid ambiguous overload
812 // warnings about whether to convert Idx to ArrayRef<Constant *> or
813 // ArrayRef<Value *>.
814 return getGetElementPtr(C, Idx, true);
816 static Constant *getInBoundsGetElementPtr(Constant *C,
817 ArrayRef<Value *> IdxList) {
818 return getGetElementPtr(C, IdxList, true);
821 static Constant *getExtractElement(Constant *Vec, Constant *Idx);
822 static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
823 static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
824 static Constant *getExtractValue(Constant *Agg, ArrayRef<unsigned> Idxs);
825 static Constant *getInsertValue(Constant *Agg, Constant *Val,
826 ArrayRef<unsigned> Idxs);
828 /// getOpcode - Return the opcode at the root of this constant expression
829 unsigned getOpcode() const { return getSubclassDataFromValue(); }
831 /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
832 /// not an ICMP or FCMP constant expression.
833 unsigned getPredicate() const;
835 /// getIndices - Assert that this is an insertvalue or exactvalue
836 /// expression and return the list of indices.
837 ArrayRef<unsigned> getIndices() const;
839 /// getOpcodeName - Return a string representation for an opcode.
840 const char *getOpcodeName() const;
842 /// getWithOperandReplaced - Return a constant expression identical to this
843 /// one, but with the specified operand set to the specified value.
844 Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
846 /// getWithOperands - This returns the current constant expression with the
847 /// operands replaced with the specified values. The specified array must
848 /// have the same number of operands as our current one.
849 Constant *getWithOperands(ArrayRef<Constant*> Ops) const {
850 return getWithOperands(Ops, getType());
853 /// getWithOperands - This returns the current constant expression with the
854 /// operands replaced with the specified values and with the specified result
855 /// type. The specified array must have the same number of operands as our
857 Constant *getWithOperands(ArrayRef<Constant*> Ops, Type *Ty) const;
859 virtual void destroyConstant();
860 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
862 /// Methods for support type inquiry through isa, cast, and dyn_cast:
863 static inline bool classof(const ConstantExpr *) { return true; }
864 static inline bool classof(const Value *V) {
865 return V->getValueID() == ConstantExprVal;
869 // Shadow Value::setValueSubclassData with a private forwarding method so that
870 // subclasses cannot accidentally use it.
871 void setValueSubclassData(unsigned short D) {
872 Value::setValueSubclassData(D);
877 struct OperandTraits<ConstantExpr> :
878 public VariadicOperandTraits<ConstantExpr, 1> {
881 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantExpr, Constant)
883 //===----------------------------------------------------------------------===//
884 /// UndefValue - 'undef' values are things that do not have specified contents.
885 /// These are used for a variety of purposes, including global variable
886 /// initializers and operands to instructions. 'undef' values can occur with
887 /// any first-class type.
889 /// Undef values aren't exactly constants; if they have multiple uses, they
890 /// can appear to have different bit patterns at each use. See
891 /// LangRef.html#undefvalues for details.
893 class UndefValue : public Constant {
894 friend struct ConstantCreator<UndefValue, Type, char>;
895 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
896 UndefValue(const UndefValue &); // DO NOT IMPLEMENT
898 explicit UndefValue(Type *T) : Constant(T, UndefValueVal, 0, 0) {}
900 // allocate space for exactly zero operands
901 void *operator new(size_t s) {
902 return User::operator new(s, 0);
905 /// get() - Static factory methods - Return an 'undef' object of the specified
908 static UndefValue *get(Type *T);
910 virtual void destroyConstant();
912 /// Methods for support type inquiry through isa, cast, and dyn_cast:
913 static inline bool classof(const UndefValue *) { return true; }
914 static bool classof(const Value *V) {
915 return V->getValueID() == UndefValueVal;
919 } // End llvm namespace