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(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 static ConstantInt *getTrue(LLVMContext &Context);
59 static ConstantInt *getFalse(LLVMContext &Context);
60 static Constant *getTrue(const Type *Ty);
61 static Constant *getFalse(const 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(const 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(const 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(const IntegerType *Ty, int64_t V);
82 static Constant *getSigned(const 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(const 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(const 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 const IntegerType *getType() const {
137 return reinterpret_cast<const 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(const Type *Ty, uint64_t V);
150 static bool isValueValidForType(const Type *Ty, int64_t V);
152 /// This function will return true iff this constant represents the "null"
153 /// value that would be returned by the getNullValue method.
154 /// @returns true if this is the null integer value.
155 /// @brief Determine if the value is null.
156 virtual bool isNullValue() const {
160 /// This is just a convenience method to make client code smaller for a
161 /// common code. It also correctly performs the comparison without the
162 /// potential for an assertion from getZExtValue().
163 bool isZero() const {
167 /// This is just a convenience method to make client code smaller for a
168 /// common case. It also correctly performs the comparison without the
169 /// potential for an assertion from getZExtValue().
170 /// @brief Determine if the value is one.
175 /// This function will return true iff every bit in this constant is set
177 /// @returns true iff this constant's bits are all set to true.
178 /// @brief Determine if the value is all ones.
179 bool isAllOnesValue() const {
180 return Val.isAllOnesValue();
183 /// This function will return true iff this constant represents the largest
184 /// value that may be represented by the constant's type.
185 /// @returns true iff this is the largest value that may be represented
187 /// @brief Determine if the value is maximal.
188 bool isMaxValue(bool isSigned) const {
190 return Val.isMaxSignedValue();
192 return Val.isMaxValue();
195 /// This function will return true iff this constant represents the smallest
196 /// value that may be represented by this constant's type.
197 /// @returns true if this is the smallest value that may be represented by
199 /// @brief Determine if the value is minimal.
200 bool isMinValue(bool isSigned) const {
202 return Val.isMinSignedValue();
204 return Val.isMinValue();
207 /// This function will return true iff this constant represents a value with
208 /// active bits bigger than 64 bits or a value greater than the given uint64_t
210 /// @returns true iff this constant is greater or equal to the given number.
211 /// @brief Determine if the value is greater or equal to the given number.
212 bool uge(uint64_t Num) {
213 return Val.getActiveBits() > 64 || Val.getZExtValue() >= Num;
216 /// getLimitedValue - If the value is smaller than the specified limit,
217 /// return it, otherwise return the limit value. This causes the value
218 /// to saturate to the limit.
219 /// @returns the min of the value of the constant and the specified value
220 /// @brief Get the constant's value with a saturation limit
221 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
222 return Val.getLimitedValue(Limit);
225 /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
226 static inline bool classof(const ConstantInt *) { return true; }
227 static bool classof(const Value *V) {
228 return V->getValueID() == ConstantIntVal;
233 //===----------------------------------------------------------------------===//
234 /// ConstantFP - Floating Point Values [float, double]
236 class ConstantFP : public Constant {
238 void *operator new(size_t, unsigned);// DO NOT IMPLEMENT
239 ConstantFP(const ConstantFP &); // DO NOT IMPLEMENT
240 friend class LLVMContextImpl;
242 ConstantFP(const Type *Ty, const APFloat& V);
244 // allocate space for exactly zero operands
245 void *operator new(size_t s) {
246 return User::operator new(s, 0);
249 /// Floating point negation must be implemented with f(x) = -0.0 - x. This
250 /// method returns the negative zero constant for floating point or vector
251 /// floating point types; for all other types, it returns the null value.
252 static Constant *getZeroValueForNegation(const Type *Ty);
254 /// get() - This returns a ConstantFP, or a vector containing a splat of a
255 /// ConstantFP, for the specified value in the specified type. This should
256 /// only be used for simple constant values like 2.0/1.0 etc, that are
257 /// known-valid both as host double and as the target format.
258 static Constant *get(const Type* Ty, double V);
259 static Constant *get(const Type* Ty, StringRef Str);
260 static ConstantFP *get(LLVMContext &Context, const APFloat &V);
261 static ConstantFP *getNegativeZero(const Type* Ty);
262 static ConstantFP *getInfinity(const Type *Ty, bool Negative = false);
264 /// isValueValidForType - return true if Ty is big enough to represent V.
265 static bool isValueValidForType(const Type *Ty, const APFloat &V);
266 inline const APFloat& getValueAPF() const { return Val; }
268 /// isNullValue - Return true if this is the value that would be returned by
269 /// getNullValue. For ConstantFP, this is +0.0, but not -0.0. To handle the
270 /// two the same, use isZero().
271 virtual bool isNullValue() const;
273 /// isNegativeZeroValue - Return true if the value is what would be returned
274 /// by getZeroValueForNegation.
275 virtual bool isNegativeZeroValue() const {
276 return Val.isZero() && Val.isNegative();
279 /// isZero - Return true if the value is positive or negative zero.
280 bool isZero() const { return Val.isZero(); }
282 /// isNaN - Return true if the value is a NaN.
283 bool isNaN() const { return Val.isNaN(); }
285 /// isExactlyValue - We don't rely on operator== working on double values, as
286 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
287 /// As such, this method can be used to do an exact bit-for-bit comparison of
288 /// two floating point values. The version with a double operand is retained
289 /// because it's so convenient to write isExactlyValue(2.0), but please use
290 /// it only for simple constants.
291 bool isExactlyValue(const APFloat &V) const;
293 bool isExactlyValue(double V) const {
295 // convert is not supported on this type
296 if (&Val.getSemantics() == &APFloat::PPCDoubleDouble)
299 FV.convert(Val.getSemantics(), APFloat::rmNearestTiesToEven, &ignored);
300 return isExactlyValue(FV);
302 /// Methods for support type inquiry through isa, cast, and dyn_cast:
303 static inline bool classof(const ConstantFP *) { return true; }
304 static bool classof(const Value *V) {
305 return V->getValueID() == ConstantFPVal;
309 //===----------------------------------------------------------------------===//
310 /// ConstantAggregateZero - All zero aggregate value
312 class ConstantAggregateZero : public Constant {
313 friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
314 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
315 ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
317 explicit ConstantAggregateZero(const Type *ty)
318 : Constant(ty, ConstantAggregateZeroVal, 0, 0) {}
320 // allocate space for exactly zero operands
321 void *operator new(size_t s) {
322 return User::operator new(s, 0);
325 static ConstantAggregateZero* get(const Type *Ty);
327 /// isNullValue - Return true if this is the value that would be returned by
329 virtual bool isNullValue() const { return true; }
331 virtual void destroyConstant();
333 /// Methods for support type inquiry through isa, cast, and dyn_cast:
335 static bool classof(const ConstantAggregateZero *) { return true; }
336 static bool classof(const Value *V) {
337 return V->getValueID() == ConstantAggregateZeroVal;
342 //===----------------------------------------------------------------------===//
343 /// ConstantArray - Constant Array Declarations
345 class ConstantArray : public Constant {
346 friend struct ConstantCreator<ConstantArray, ArrayType,
347 std::vector<Constant*> >;
348 ConstantArray(const ConstantArray &); // DO NOT IMPLEMENT
350 ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
352 // ConstantArray accessors
353 static Constant *get(const ArrayType *T, const std::vector<Constant*> &V);
354 static Constant *get(const ArrayType *T, Constant *const *Vals,
357 /// This method constructs a ConstantArray and initializes it with a text
358 /// string. The default behavior (AddNull==true) causes a null terminator to
359 /// be placed at the end of the array. This effectively increases the length
360 /// of the array by one (you've been warned). However, in some situations
361 /// this is not desired so if AddNull==false then the string is copied without
362 /// null termination.
363 static Constant *get(LLVMContext &Context, StringRef Initializer,
364 bool AddNull = true);
366 /// Transparently provide more efficient getOperand methods.
367 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
369 /// getType - Specialize the getType() method to always return an ArrayType,
370 /// which reduces the amount of casting needed in parts of the compiler.
372 inline const ArrayType *getType() const {
373 return reinterpret_cast<const ArrayType*>(Value::getType());
376 /// isString - This method returns true if the array is an array of i8 and
377 /// the elements of the array are all ConstantInt's.
378 bool isString() const;
380 /// isCString - This method returns true if the array is a string (see
382 /// isString) and it ends in a null byte \0 and does not contains any other
384 /// null bytes except its terminator.
385 bool isCString() const;
387 /// getAsString - If this array is isString(), then this method converts the
388 /// array to an std::string and returns it. Otherwise, it asserts out.
390 std::string getAsString() const;
392 /// isNullValue - Return true if this is the value that would be returned by
393 /// getNullValue. This always returns false because zero arrays are always
394 /// created as ConstantAggregateZero objects.
395 virtual bool isNullValue() const { return false; }
397 virtual void destroyConstant();
398 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
400 /// Methods for support type inquiry through isa, cast, and dyn_cast:
401 static inline bool classof(const ConstantArray *) { return true; }
402 static bool classof(const Value *V) {
403 return V->getValueID() == ConstantArrayVal;
408 struct OperandTraits<ConstantArray> :
409 public VariadicOperandTraits<ConstantArray> {
412 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantArray, Constant)
414 //===----------------------------------------------------------------------===//
415 // ConstantStruct - Constant Struct Declarations
417 class ConstantStruct : public Constant {
418 friend struct ConstantCreator<ConstantStruct, StructType,
419 std::vector<Constant*> >;
420 ConstantStruct(const ConstantStruct &); // DO NOT IMPLEMENT
422 ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
424 // ConstantStruct accessors
425 static Constant *get(const StructType *T, const std::vector<Constant*> &V);
426 static Constant *get(LLVMContext &Context,
427 const std::vector<Constant*> &V, bool Packed);
428 static Constant *get(LLVMContext &Context,
429 Constant *const *Vals, unsigned NumVals, bool Packed);
430 static Constant *get(LLVMContext &Context, bool Packed,
431 Constant * Val, ...) END_WITH_NULL;
433 /// Transparently provide more efficient getOperand methods.
434 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
436 /// getType() specialization - Reduce amount of casting...
438 inline const StructType *getType() const {
439 return reinterpret_cast<const StructType*>(Value::getType());
442 /// isNullValue - Return true if this is the value that would be returned by
443 /// getNullValue. This always returns false because zero structs are always
444 /// created as ConstantAggregateZero objects.
445 virtual bool isNullValue() const {
449 virtual void destroyConstant();
450 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
452 /// Methods for support type inquiry through isa, cast, and dyn_cast:
453 static inline bool classof(const ConstantStruct *) { return true; }
454 static bool classof(const Value *V) {
455 return V->getValueID() == ConstantStructVal;
460 struct OperandTraits<ConstantStruct> :
461 public VariadicOperandTraits<ConstantStruct> {
464 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantStruct, Constant)
467 //===----------------------------------------------------------------------===//
468 /// ConstantVector - Constant Vector Declarations
470 class ConstantVector : public Constant {
471 friend struct ConstantCreator<ConstantVector, VectorType,
472 std::vector<Constant*> >;
473 ConstantVector(const ConstantVector &); // DO NOT IMPLEMENT
475 ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
477 // ConstantVector accessors
478 static Constant *get(ArrayRef<Constant*> V);
479 // FIXME: Eliminate this constructor form.
480 static Constant *get(const VectorType *T, const std::vector<Constant*> &V);
482 /// Transparently provide more efficient getOperand methods.
483 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
485 /// getType - Specialize the getType() method to always return a VectorType,
486 /// which reduces the amount of casting needed in parts of the compiler.
488 inline const VectorType *getType() const {
489 return reinterpret_cast<const VectorType*>(Value::getType());
492 /// isNullValue - Return true if this is the value that would be returned by
493 /// getNullValue. This always returns false because zero vectors are always
494 /// created as ConstantAggregateZero objects.
495 virtual bool isNullValue() const { return false; }
497 /// This function will return true iff every element in this vector constant
498 /// is set to all ones.
499 /// @returns true iff this constant's emements are all set to all ones.
500 /// @brief Determine if the value is all ones.
501 bool isAllOnesValue() const;
503 /// getSplatValue - If this is a splat constant, meaning that all of the
504 /// elements have the same value, return that value. Otherwise return NULL.
505 Constant *getSplatValue() const;
507 virtual void destroyConstant();
508 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
510 /// Methods for support type inquiry through isa, cast, and dyn_cast:
511 static inline bool classof(const ConstantVector *) { return true; }
512 static bool classof(const Value *V) {
513 return V->getValueID() == ConstantVectorVal;
518 struct OperandTraits<ConstantVector> :
519 public VariadicOperandTraits<ConstantVector> {
522 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantVector, Constant)
524 //===----------------------------------------------------------------------===//
525 /// ConstantPointerNull - a constant pointer value that points to null
527 class ConstantPointerNull : public Constant {
528 friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
529 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
530 ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
532 explicit ConstantPointerNull(const PointerType *T)
533 : Constant(reinterpret_cast<const Type*>(T),
534 Value::ConstantPointerNullVal, 0, 0) {}
537 // allocate space for exactly zero operands
538 void *operator new(size_t s) {
539 return User::operator new(s, 0);
542 /// get() - Static factory methods - Return objects of the specified value
543 static ConstantPointerNull *get(const PointerType *T);
545 /// isNullValue - Return true if this is the value that would be returned by
547 virtual bool isNullValue() const { return true; }
549 virtual void destroyConstant();
551 /// getType - Specialize the getType() method to always return an PointerType,
552 /// which reduces the amount of casting needed in parts of the compiler.
554 inline const PointerType *getType() const {
555 return reinterpret_cast<const PointerType*>(Value::getType());
558 /// Methods for support type inquiry through isa, cast, and dyn_cast:
559 static inline bool classof(const ConstantPointerNull *) { return true; }
560 static bool classof(const Value *V) {
561 return V->getValueID() == ConstantPointerNullVal;
565 /// BlockAddress - The address of a basic block.
567 class BlockAddress : public Constant {
568 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
569 void *operator new(size_t s) { return User::operator new(s, 2); }
570 BlockAddress(Function *F, BasicBlock *BB);
572 /// get - Return a BlockAddress for the specified function and basic block.
573 static BlockAddress *get(Function *F, BasicBlock *BB);
575 /// get - Return a BlockAddress for the specified basic block. The basic
576 /// block must be embedded into a function.
577 static BlockAddress *get(BasicBlock *BB);
579 /// Transparently provide more efficient getOperand methods.
580 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
582 Function *getFunction() const { return (Function*)Op<0>().get(); }
583 BasicBlock *getBasicBlock() const { return (BasicBlock*)Op<1>().get(); }
585 /// isNullValue - Return true if this is the value that would be returned by
587 virtual bool isNullValue() const { return false; }
589 virtual void destroyConstant();
590 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
592 /// Methods for support type inquiry through isa, cast, and dyn_cast:
593 static inline bool classof(const BlockAddress *) { return true; }
594 static inline bool classof(const Value *V) {
595 return V->getValueID() == BlockAddressVal;
600 struct OperandTraits<BlockAddress> :
601 public FixedNumOperandTraits<BlockAddress, 2> {
604 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(BlockAddress, Value)
607 //===----------------------------------------------------------------------===//
608 /// ConstantExpr - a constant value that is initialized with an expression using
609 /// other constant values.
611 /// This class uses the standard Instruction opcodes to define the various
612 /// constant expressions. The Opcode field for the ConstantExpr class is
613 /// maintained in the Value::SubclassData field.
614 class ConstantExpr : public Constant {
615 friend struct ConstantCreator<ConstantExpr,Type,
616 std::pair<unsigned, std::vector<Constant*> > >;
617 friend struct ConvertConstantType<ConstantExpr, Type>;
620 ConstantExpr(const Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
621 : Constant(ty, ConstantExprVal, Ops, NumOps) {
622 // Operation type (an Instruction opcode) is stored as the SubclassData.
623 setValueSubclassData(Opcode);
626 // These private methods are used by the type resolution code to create
627 // ConstantExprs in intermediate forms.
628 static Constant *getTy(const Type *Ty, unsigned Opcode,
629 Constant *C1, Constant *C2,
631 static Constant *getCompareTy(unsigned short pred, Constant *C1,
633 static Constant *getSelectTy(const Type *Ty,
634 Constant *C1, Constant *C2, Constant *C3);
635 template<typename IndexTy>
636 static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
637 IndexTy const *Idxs, unsigned NumIdxs,
639 static Constant *getExtractElementTy(const Type *Ty, Constant *Val,
641 static Constant *getInsertElementTy(const Type *Ty, Constant *Val,
642 Constant *Elt, Constant *Idx);
643 static Constant *getShuffleVectorTy(const Type *Ty, Constant *V1,
644 Constant *V2, Constant *Mask);
645 static Constant *getExtractValueTy(const Type *Ty, Constant *Agg,
646 const unsigned *Idxs, unsigned NumIdxs);
647 static Constant *getInsertValueTy(const Type *Ty, Constant *Agg,
649 const unsigned *Idxs, unsigned NumIdxs);
650 template<typename IndexTy>
651 static Constant *getGetElementPtrImpl(Constant *C,
652 IndexTy const *IdxList,
653 unsigned NumIdx, bool InBounds);
656 // Static methods to construct a ConstantExpr of different kinds. Note that
657 // these methods may return a object that is not an instance of the
658 // ConstantExpr class, because they will attempt to fold the constant
659 // expression into something simpler if possible.
661 /// getAlignOf constant expr - computes the alignment of a type in a target
662 /// independent way (Note: the return type is an i64).
663 static Constant *getAlignOf(const Type *Ty);
665 /// getSizeOf constant expr - computes the (alloc) size of a type (in
666 /// address-units, not bits) in a target independent way (Note: the return
669 static Constant *getSizeOf(const Type *Ty);
671 /// getOffsetOf constant expr - computes the offset of a struct field in a
672 /// target independent way (Note: the return type is an i64).
674 static Constant *getOffsetOf(const StructType *STy, unsigned FieldNo);
676 /// getOffsetOf constant expr - This is a generalized form of getOffsetOf,
677 /// which supports any aggregate type, and any Constant index.
679 static Constant *getOffsetOf(const Type *Ty, Constant *FieldNo);
681 static Constant *getNeg(Constant *C, bool HasNUW = false, bool HasNSW =false);
682 static Constant *getFNeg(Constant *C);
683 static Constant *getNot(Constant *C);
684 static Constant *getAdd(Constant *C1, Constant *C2,
685 bool HasNUW = false, bool HasNSW = false);
686 static Constant *getFAdd(Constant *C1, Constant *C2);
687 static Constant *getSub(Constant *C1, Constant *C2,
688 bool HasNUW = false, bool HasNSW = false);
689 static Constant *getFSub(Constant *C1, Constant *C2);
690 static Constant *getMul(Constant *C1, Constant *C2,
691 bool HasNUW = false, bool HasNSW = false);
692 static Constant *getFMul(Constant *C1, Constant *C2);
693 static Constant *getUDiv(Constant *C1, Constant *C2, bool isExact = false);
694 static Constant *getSDiv(Constant *C1, Constant *C2, bool isExact = false);
695 static Constant *getFDiv(Constant *C1, Constant *C2);
696 static Constant *getURem(Constant *C1, Constant *C2);
697 static Constant *getSRem(Constant *C1, Constant *C2);
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 *getShl(Constant *C1, Constant *C2,
703 bool HasNUW = false, bool HasNSW = false);
704 static Constant *getLShr(Constant *C1, Constant *C2, bool isExact = false);
705 static Constant *getAShr(Constant *C1, Constant *C2, bool isExact = false);
706 static Constant *getTrunc (Constant *C, const Type *Ty);
707 static Constant *getSExt (Constant *C, const Type *Ty);
708 static Constant *getZExt (Constant *C, const Type *Ty);
709 static Constant *getFPTrunc (Constant *C, const Type *Ty);
710 static Constant *getFPExtend(Constant *C, const Type *Ty);
711 static Constant *getUIToFP (Constant *C, const Type *Ty);
712 static Constant *getSIToFP (Constant *C, const Type *Ty);
713 static Constant *getFPToUI (Constant *C, const Type *Ty);
714 static Constant *getFPToSI (Constant *C, const Type *Ty);
715 static Constant *getPtrToInt(Constant *C, const Type *Ty);
716 static Constant *getIntToPtr(Constant *C, const Type *Ty);
717 static Constant *getBitCast (Constant *C, const Type *Ty);
719 static Constant *getNSWNeg(Constant *C) { return getNeg(C, false, true); }
720 static Constant *getNUWNeg(Constant *C) { return getNeg(C, true, false); }
721 static Constant *getNSWAdd(Constant *C1, Constant *C2) {
722 return getAdd(C1, C2, false, true);
724 static Constant *getNUWAdd(Constant *C1, Constant *C2) {
725 return getAdd(C1, C2, true, false);
727 static Constant *getNSWSub(Constant *C1, Constant *C2) {
728 return getSub(C1, C2, false, true);
730 static Constant *getNUWSub(Constant *C1, Constant *C2) {
731 return getSub(C1, C2, true, false);
733 static Constant *getNSWMul(Constant *C1, Constant *C2) {
734 return getMul(C1, C2, false, true);
736 static Constant *getNUWMul(Constant *C1, Constant *C2) {
737 return getMul(C1, C2, true, false);
739 static Constant *getNSWShl(Constant *C1, Constant *C2) {
740 return getShl(C1, C2, false, true);
742 static Constant *getNUWShl(Constant *C1, Constant *C2) {
743 return getShl(C1, C2, true, false);
745 static Constant *getExactSDiv(Constant *C1, Constant *C2) {
746 return getSDiv(C1, C2, true);
748 static Constant *getExactUDiv(Constant *C1, Constant *C2) {
749 return getUDiv(C1, C2, true);
751 static Constant *getExactAShr(Constant *C1, Constant *C2) {
752 return getAShr(C1, C2, true);
754 static Constant *getExactLShr(Constant *C1, Constant *C2) {
755 return getLShr(C1, C2, true);
758 /// Transparently provide more efficient getOperand methods.
759 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
761 // @brief Convenience function for getting one of the casting operations
762 // using a CastOps opcode.
763 static Constant *getCast(
764 unsigned ops, ///< The opcode for the conversion
765 Constant *C, ///< The constant to be converted
766 const Type *Ty ///< The type to which the constant is converted
769 // @brief Create a ZExt or BitCast cast constant expression
770 static Constant *getZExtOrBitCast(
771 Constant *C, ///< The constant to zext or bitcast
772 const Type *Ty ///< The type to zext or bitcast C to
775 // @brief Create a SExt or BitCast cast constant expression
776 static Constant *getSExtOrBitCast(
777 Constant *C, ///< The constant to sext or bitcast
778 const Type *Ty ///< The type to sext or bitcast C to
781 // @brief Create a Trunc or BitCast cast constant expression
782 static Constant *getTruncOrBitCast(
783 Constant *C, ///< The constant to trunc or bitcast
784 const Type *Ty ///< The type to trunc or bitcast C to
787 /// @brief Create a BitCast or a PtrToInt cast constant expression
788 static Constant *getPointerCast(
789 Constant *C, ///< The pointer value to be casted (operand 0)
790 const Type *Ty ///< The type to which cast should be made
793 /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
794 static Constant *getIntegerCast(
795 Constant *C, ///< The integer constant to be casted
796 const Type *Ty, ///< The integer type to cast to
797 bool isSigned ///< Whether C should be treated as signed or not
800 /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
801 static Constant *getFPCast(
802 Constant *C, ///< The integer constant to be casted
803 const Type *Ty ///< The integer type to cast to
806 /// @brief Return true if this is a convert constant expression
809 /// @brief Return true if this is a compare constant expression
810 bool isCompare() const;
812 /// @brief Return true if this is an insertvalue or extractvalue expression,
813 /// and the getIndices() method may be used.
814 bool hasIndices() const;
816 /// @brief Return true if this is a getelementptr expression and all
817 /// the index operands are compile-time known integers within the
818 /// corresponding notional static array extents. Note that this is
819 /// not equivalant to, a subset of, or a superset of the "inbounds"
821 bool isGEPWithNoNotionalOverIndexing() const;
823 /// Select constant expr
825 static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
826 return getSelectTy(V1->getType(), C, V1, V2);
829 /// get - Return a binary or shift operator constant expression,
830 /// folding if possible.
832 static Constant *get(unsigned Opcode, Constant *C1, Constant *C2,
835 /// @brief Return an ICmp or FCmp comparison operator constant expression.
836 static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
838 /// get* - Return some common constants without having to
839 /// specify the full Instruction::OPCODE identifier.
841 static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
842 static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
844 /// Getelementptr form. Value* is only accepted for convenience;
845 /// all elements must be Constant's.
847 static Constant *getGetElementPtr(Constant *C,
848 Constant *const *IdxList, unsigned NumIdx,
849 bool InBounds = false);
850 static Constant *getGetElementPtr(Constant *C,
851 Value *const *IdxList, unsigned NumIdx,
852 bool InBounds = false);
854 /// Create an "inbounds" getelementptr. See the documentation for the
855 /// "inbounds" flag in LangRef.html for details.
856 static Constant *getInBoundsGetElementPtr(Constant *C,
857 Constant *const *IdxList,
859 return getGetElementPtr(C, IdxList, NumIdx, true);
861 static Constant *getInBoundsGetElementPtr(Constant *C,
862 Value* const *IdxList,
864 return getGetElementPtr(C, IdxList, NumIdx, true);
867 static Constant *getExtractElement(Constant *Vec, Constant *Idx);
868 static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
869 static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
870 static Constant *getExtractValue(Constant *Agg,
871 const unsigned *IdxList, unsigned NumIdx);
872 static Constant *getInsertValue(Constant *Agg, Constant *Val,
873 const unsigned *IdxList, unsigned NumIdx);
875 /// isNullValue - Return true if this is the value that would be returned by
877 virtual bool isNullValue() const { return false; }
879 /// getOpcode - Return the opcode at the root of this constant expression
880 unsigned getOpcode() const { return getSubclassDataFromValue(); }
882 /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
883 /// not an ICMP or FCMP constant expression.
884 unsigned getPredicate() const;
886 /// getIndices - Assert that this is an insertvalue or exactvalue
887 /// expression and return the list of indices.
888 ArrayRef<unsigned> getIndices() const;
890 /// getOpcodeName - Return a string representation for an opcode.
891 const char *getOpcodeName() const;
893 /// getWithOperandReplaced - Return a constant expression identical to this
894 /// one, but with the specified operand set to the specified value.
895 Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
897 /// getWithOperands - This returns the current constant expression with the
898 /// operands replaced with the specified values. The specified operands must
899 /// match count and type with the existing ones.
900 Constant *getWithOperands(ArrayRef<Constant*> Ops) const;
902 virtual void destroyConstant();
903 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
905 /// Methods for support type inquiry through isa, cast, and dyn_cast:
906 static inline bool classof(const ConstantExpr *) { return true; }
907 static inline bool classof(const Value *V) {
908 return V->getValueID() == ConstantExprVal;
912 // Shadow Value::setValueSubclassData with a private forwarding method so that
913 // subclasses cannot accidentally use it.
914 void setValueSubclassData(unsigned short D) {
915 Value::setValueSubclassData(D);
920 struct OperandTraits<ConstantExpr> :
921 public VariadicOperandTraits<ConstantExpr, 1> {
924 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantExpr, Constant)
926 //===----------------------------------------------------------------------===//
927 /// UndefValue - 'undef' values are things that do not have specified contents.
928 /// These are used for a variety of purposes, including global variable
929 /// initializers and operands to instructions. 'undef' values can occur with
930 /// any first-class type.
932 /// Undef values aren't exactly constants; if they have multiple uses, they
933 /// can appear to have different bit patterns at each use. See
934 /// LangRef.html#undefvalues for details.
936 class UndefValue : public Constant {
937 friend struct ConstantCreator<UndefValue, Type, char>;
938 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
939 UndefValue(const UndefValue &); // DO NOT IMPLEMENT
941 explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
943 // allocate space for exactly zero operands
944 void *operator new(size_t s) {
945 return User::operator new(s, 0);
948 /// get() - Static factory methods - Return an 'undef' object of the specified
951 static UndefValue *get(const Type *T);
953 /// isNullValue - Return true if this is the value that would be returned by
955 virtual bool isNullValue() const { return false; }
957 virtual void destroyConstant();
959 /// Methods for support type inquiry through isa, cast, and dyn_cast:
960 static inline bool classof(const UndefValue *) { return true; }
961 static bool classof(const Value *V) {
962 return V->getValueID() == UndefValueVal;
966 } // End llvm namespace