1 //===-- Constants.cpp - Implement Constant nodes --------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Constant* classes.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/IR/Constants.h"
15 #include "ConstantFold.h"
16 #include "LLVMContextImpl.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/FoldingSet.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/IR/DerivedTypes.h"
24 #include "llvm/IR/GetElementPtrTypeIterator.h"
25 #include "llvm/IR/GlobalValue.h"
26 #include "llvm/IR/Instructions.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/Operator.h"
29 #include "llvm/Support/Compiler.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/Support/ErrorHandling.h"
32 #include "llvm/Support/ManagedStatic.h"
33 #include "llvm/Support/MathExtras.h"
34 #include "llvm/Support/raw_ostream.h"
39 //===----------------------------------------------------------------------===//
41 //===----------------------------------------------------------------------===//
43 void Constant::anchor() { }
45 bool Constant::isNegativeZeroValue() const {
46 // Floating point values have an explicit -0.0 value.
47 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
48 return CFP->isZero() && CFP->isNegative();
50 // Equivalent for a vector of -0.0's.
51 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
52 if (ConstantFP *SplatCFP = dyn_cast_or_null<ConstantFP>(CV->getSplatValue()))
53 if (SplatCFP && SplatCFP->isZero() && SplatCFP->isNegative())
56 // We've already handled true FP case; any other FP vectors can't represent -0.0.
57 if (getType()->isFPOrFPVectorTy())
60 // Otherwise, just use +0.0.
64 // Return true iff this constant is positive zero (floating point), negative
65 // zero (floating point), or a null value.
66 bool Constant::isZeroValue() const {
67 // Floating point values have an explicit -0.0 value.
68 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
71 // Otherwise, just use +0.0.
75 bool Constant::isNullValue() const {
77 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
81 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
82 return CFP->isZero() && !CFP->isNegative();
84 // constant zero is zero for aggregates and cpnull is null for pointers.
85 return isa<ConstantAggregateZero>(this) || isa<ConstantPointerNull>(this);
88 bool Constant::isAllOnesValue() const {
89 // Check for -1 integers
90 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
91 return CI->isMinusOne();
93 // Check for FP which are bitcasted from -1 integers
94 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
95 return CFP->getValueAPF().bitcastToAPInt().isAllOnesValue();
97 // Check for constant vectors which are splats of -1 values.
98 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
99 if (Constant *Splat = CV->getSplatValue())
100 return Splat->isAllOnesValue();
102 // Check for constant vectors which are splats of -1 values.
103 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
104 if (Constant *Splat = CV->getSplatValue())
105 return Splat->isAllOnesValue();
110 bool Constant::isOneValue() const {
111 // Check for 1 integers
112 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
115 // Check for FP which are bitcasted from 1 integers
116 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
117 return CFP->getValueAPF().bitcastToAPInt() == 1;
119 // Check for constant vectors which are splats of 1 values.
120 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
121 if (Constant *Splat = CV->getSplatValue())
122 return Splat->isOneValue();
124 // Check for constant vectors which are splats of 1 values.
125 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
126 if (Constant *Splat = CV->getSplatValue())
127 return Splat->isOneValue();
132 bool Constant::isMinSignedValue() const {
133 // Check for INT_MIN integers
134 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
135 return CI->isMinValue(/*isSigned=*/true);
137 // Check for FP which are bitcasted from INT_MIN integers
138 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
139 return CFP->getValueAPF().bitcastToAPInt().isMinSignedValue();
141 // Check for constant vectors which are splats of INT_MIN values.
142 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
143 if (Constant *Splat = CV->getSplatValue())
144 return Splat->isMinSignedValue();
146 // Check for constant vectors which are splats of INT_MIN values.
147 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
148 if (Constant *Splat = CV->getSplatValue())
149 return Splat->isMinSignedValue();
154 bool Constant::isNotMinSignedValue() const {
155 // Check for INT_MIN integers
156 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
157 return !CI->isMinValue(/*isSigned=*/true);
159 // Check for FP which are bitcasted from INT_MIN integers
160 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
161 return !CFP->getValueAPF().bitcastToAPInt().isMinSignedValue();
163 // Check for constant vectors which are splats of INT_MIN values.
164 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
165 if (Constant *Splat = CV->getSplatValue())
166 return Splat->isNotMinSignedValue();
168 // Check for constant vectors which are splats of INT_MIN values.
169 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
170 if (Constant *Splat = CV->getSplatValue())
171 return Splat->isNotMinSignedValue();
173 // It *may* contain INT_MIN, we can't tell.
177 // Constructor to create a '0' constant of arbitrary type...
178 Constant *Constant::getNullValue(Type *Ty) {
179 switch (Ty->getTypeID()) {
180 case Type::IntegerTyID:
181 return ConstantInt::get(Ty, 0);
183 return ConstantFP::get(Ty->getContext(),
184 APFloat::getZero(APFloat::IEEEhalf));
185 case Type::FloatTyID:
186 return ConstantFP::get(Ty->getContext(),
187 APFloat::getZero(APFloat::IEEEsingle));
188 case Type::DoubleTyID:
189 return ConstantFP::get(Ty->getContext(),
190 APFloat::getZero(APFloat::IEEEdouble));
191 case Type::X86_FP80TyID:
192 return ConstantFP::get(Ty->getContext(),
193 APFloat::getZero(APFloat::x87DoubleExtended));
194 case Type::FP128TyID:
195 return ConstantFP::get(Ty->getContext(),
196 APFloat::getZero(APFloat::IEEEquad));
197 case Type::PPC_FP128TyID:
198 return ConstantFP::get(Ty->getContext(),
199 APFloat(APFloat::PPCDoubleDouble,
200 APInt::getNullValue(128)));
201 case Type::PointerTyID:
202 return ConstantPointerNull::get(cast<PointerType>(Ty));
203 case Type::StructTyID:
204 case Type::ArrayTyID:
205 case Type::VectorTyID:
206 return ConstantAggregateZero::get(Ty);
208 // Function, Label, or Opaque type?
209 llvm_unreachable("Cannot create a null constant of that type!");
213 Constant *Constant::getIntegerValue(Type *Ty, const APInt &V) {
214 Type *ScalarTy = Ty->getScalarType();
216 // Create the base integer constant.
217 Constant *C = ConstantInt::get(Ty->getContext(), V);
219 // Convert an integer to a pointer, if necessary.
220 if (PointerType *PTy = dyn_cast<PointerType>(ScalarTy))
221 C = ConstantExpr::getIntToPtr(C, PTy);
223 // Broadcast a scalar to a vector, if necessary.
224 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
225 C = ConstantVector::getSplat(VTy->getNumElements(), C);
230 Constant *Constant::getAllOnesValue(Type *Ty) {
231 if (IntegerType *ITy = dyn_cast<IntegerType>(Ty))
232 return ConstantInt::get(Ty->getContext(),
233 APInt::getAllOnesValue(ITy->getBitWidth()));
235 if (Ty->isFloatingPointTy()) {
236 APFloat FL = APFloat::getAllOnesValue(Ty->getPrimitiveSizeInBits(),
237 !Ty->isPPC_FP128Ty());
238 return ConstantFP::get(Ty->getContext(), FL);
241 VectorType *VTy = cast<VectorType>(Ty);
242 return ConstantVector::getSplat(VTy->getNumElements(),
243 getAllOnesValue(VTy->getElementType()));
246 /// getAggregateElement - For aggregates (struct/array/vector) return the
247 /// constant that corresponds to the specified element if possible, or null if
248 /// not. This can return null if the element index is a ConstantExpr, or if
249 /// 'this' is a constant expr.
250 Constant *Constant::getAggregateElement(unsigned Elt) const {
251 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(this))
252 return Elt < CS->getNumOperands() ? CS->getOperand(Elt) : nullptr;
254 if (const ConstantArray *CA = dyn_cast<ConstantArray>(this))
255 return Elt < CA->getNumOperands() ? CA->getOperand(Elt) : nullptr;
257 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
258 return Elt < CV->getNumOperands() ? CV->getOperand(Elt) : nullptr;
260 if (const ConstantAggregateZero *CAZ =dyn_cast<ConstantAggregateZero>(this))
261 return CAZ->getElementValue(Elt);
263 if (const UndefValue *UV = dyn_cast<UndefValue>(this))
264 return UV->getElementValue(Elt);
266 if (const ConstantDataSequential *CDS =dyn_cast<ConstantDataSequential>(this))
267 return Elt < CDS->getNumElements() ? CDS->getElementAsConstant(Elt)
272 Constant *Constant::getAggregateElement(Constant *Elt) const {
273 assert(isa<IntegerType>(Elt->getType()) && "Index must be an integer");
274 if (ConstantInt *CI = dyn_cast<ConstantInt>(Elt))
275 return getAggregateElement(CI->getZExtValue());
280 void Constant::destroyConstantImpl() {
281 // When a Constant is destroyed, there may be lingering
282 // references to the constant by other constants in the constant pool. These
283 // constants are implicitly dependent on the module that is being deleted,
284 // but they don't know that. Because we only find out when the CPV is
285 // deleted, we must now notify all of our users (that should only be
286 // Constants) that they are, in fact, invalid now and should be deleted.
288 while (!use_empty()) {
289 Value *V = user_back();
290 #ifndef NDEBUG // Only in -g mode...
291 if (!isa<Constant>(V)) {
292 dbgs() << "While deleting: " << *this
293 << "\n\nUse still stuck around after Def is destroyed: "
297 assert(isa<Constant>(V) && "References remain to Constant being destroyed");
298 cast<Constant>(V)->destroyConstant();
300 // The constant should remove itself from our use list...
301 assert((use_empty() || user_back() != V) && "Constant not removed!");
304 // Value has no outstanding references it is safe to delete it now...
308 static bool canTrapImpl(const Constant *C,
309 SmallPtrSetImpl<const ConstantExpr *> &NonTrappingOps) {
310 assert(C->getType()->isFirstClassType() && "Cannot evaluate aggregate vals!");
311 // The only thing that could possibly trap are constant exprs.
312 const ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
316 // ConstantExpr traps if any operands can trap.
317 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
318 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(CE->getOperand(i))) {
319 if (NonTrappingOps.insert(Op).second && canTrapImpl(Op, NonTrappingOps))
324 // Otherwise, only specific operations can trap.
325 switch (CE->getOpcode()) {
328 case Instruction::UDiv:
329 case Instruction::SDiv:
330 case Instruction::FDiv:
331 case Instruction::URem:
332 case Instruction::SRem:
333 case Instruction::FRem:
334 // Div and rem can trap if the RHS is not known to be non-zero.
335 if (!isa<ConstantInt>(CE->getOperand(1)) ||CE->getOperand(1)->isNullValue())
341 /// canTrap - Return true if evaluation of this constant could trap. This is
342 /// true for things like constant expressions that could divide by zero.
343 bool Constant::canTrap() const {
344 SmallPtrSet<const ConstantExpr *, 4> NonTrappingOps;
345 return canTrapImpl(this, NonTrappingOps);
348 /// Check if C contains a GlobalValue for which Predicate is true.
350 ConstHasGlobalValuePredicate(const Constant *C,
351 bool (*Predicate)(const GlobalValue *)) {
352 SmallPtrSet<const Constant *, 8> Visited;
353 SmallVector<const Constant *, 8> WorkList;
354 WorkList.push_back(C);
357 while (!WorkList.empty()) {
358 const Constant *WorkItem = WorkList.pop_back_val();
359 if (const auto *GV = dyn_cast<GlobalValue>(WorkItem))
362 for (const Value *Op : WorkItem->operands()) {
363 const Constant *ConstOp = dyn_cast<Constant>(Op);
366 if (Visited.insert(ConstOp).second)
367 WorkList.push_back(ConstOp);
373 /// Return true if the value can vary between threads.
374 bool Constant::isThreadDependent() const {
375 auto DLLImportPredicate = [](const GlobalValue *GV) {
376 return GV->isThreadLocal();
378 return ConstHasGlobalValuePredicate(this, DLLImportPredicate);
381 bool Constant::isDLLImportDependent() const {
382 auto DLLImportPredicate = [](const GlobalValue *GV) {
383 return GV->hasDLLImportStorageClass();
385 return ConstHasGlobalValuePredicate(this, DLLImportPredicate);
388 /// Return true if the constant has users other than constant exprs and other
390 bool Constant::isConstantUsed() const {
391 for (const User *U : users()) {
392 const Constant *UC = dyn_cast<Constant>(U);
393 if (!UC || isa<GlobalValue>(UC))
396 if (UC->isConstantUsed())
404 /// getRelocationInfo - This method classifies the entry according to
405 /// whether or not it may generate a relocation entry. This must be
406 /// conservative, so if it might codegen to a relocatable entry, it should say
407 /// so. The return values are:
409 /// NoRelocation: This constant pool entry is guaranteed to never have a
410 /// relocation applied to it (because it holds a simple constant like
412 /// LocalRelocation: This entry has relocations, but the entries are
413 /// guaranteed to be resolvable by the static linker, so the dynamic
414 /// linker will never see them.
415 /// GlobalRelocations: This entry may have arbitrary relocations.
417 /// FIXME: This really should not be in IR.
418 Constant::PossibleRelocationsTy Constant::getRelocationInfo() const {
419 if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
420 if (GV->hasLocalLinkage() || GV->hasHiddenVisibility())
421 return LocalRelocation; // Local to this file/library.
422 return GlobalRelocations; // Global reference.
425 if (const BlockAddress *BA = dyn_cast<BlockAddress>(this))
426 return BA->getFunction()->getRelocationInfo();
428 // While raw uses of blockaddress need to be relocated, differences between
429 // two of them don't when they are for labels in the same function. This is a
430 // common idiom when creating a table for the indirect goto extension, so we
431 // handle it efficiently here.
432 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(this))
433 if (CE->getOpcode() == Instruction::Sub) {
434 ConstantExpr *LHS = dyn_cast<ConstantExpr>(CE->getOperand(0));
435 ConstantExpr *RHS = dyn_cast<ConstantExpr>(CE->getOperand(1));
437 LHS->getOpcode() == Instruction::PtrToInt &&
438 RHS->getOpcode() == Instruction::PtrToInt &&
439 isa<BlockAddress>(LHS->getOperand(0)) &&
440 isa<BlockAddress>(RHS->getOperand(0)) &&
441 cast<BlockAddress>(LHS->getOperand(0))->getFunction() ==
442 cast<BlockAddress>(RHS->getOperand(0))->getFunction())
446 PossibleRelocationsTy Result = NoRelocation;
447 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
448 Result = std::max(Result,
449 cast<Constant>(getOperand(i))->getRelocationInfo());
454 /// removeDeadUsersOfConstant - If the specified constantexpr is dead, remove
455 /// it. This involves recursively eliminating any dead users of the
457 static bool removeDeadUsersOfConstant(const Constant *C) {
458 if (isa<GlobalValue>(C)) return false; // Cannot remove this
460 while (!C->use_empty()) {
461 const Constant *User = dyn_cast<Constant>(C->user_back());
462 if (!User) return false; // Non-constant usage;
463 if (!removeDeadUsersOfConstant(User))
464 return false; // Constant wasn't dead
467 const_cast<Constant*>(C)->destroyConstant();
472 /// removeDeadConstantUsers - If there are any dead constant users dangling
473 /// off of this constant, remove them. This method is useful for clients
474 /// that want to check to see if a global is unused, but don't want to deal
475 /// with potentially dead constants hanging off of the globals.
476 void Constant::removeDeadConstantUsers() const {
477 Value::const_user_iterator I = user_begin(), E = user_end();
478 Value::const_user_iterator LastNonDeadUser = E;
480 const Constant *User = dyn_cast<Constant>(*I);
487 if (!removeDeadUsersOfConstant(User)) {
488 // If the constant wasn't dead, remember that this was the last live use
489 // and move on to the next constant.
495 // If the constant was dead, then the iterator is invalidated.
496 if (LastNonDeadUser == E) {
508 //===----------------------------------------------------------------------===//
510 //===----------------------------------------------------------------------===//
512 void ConstantInt::anchor() { }
514 ConstantInt::ConstantInt(IntegerType *Ty, const APInt& V)
515 : Constant(Ty, ConstantIntVal, nullptr, 0), Val(V) {
516 assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
519 ConstantInt *ConstantInt::getTrue(LLVMContext &Context) {
520 LLVMContextImpl *pImpl = Context.pImpl;
521 if (!pImpl->TheTrueVal)
522 pImpl->TheTrueVal = ConstantInt::get(Type::getInt1Ty(Context), 1);
523 return pImpl->TheTrueVal;
526 ConstantInt *ConstantInt::getFalse(LLVMContext &Context) {
527 LLVMContextImpl *pImpl = Context.pImpl;
528 if (!pImpl->TheFalseVal)
529 pImpl->TheFalseVal = ConstantInt::get(Type::getInt1Ty(Context), 0);
530 return pImpl->TheFalseVal;
533 Constant *ConstantInt::getTrue(Type *Ty) {
534 VectorType *VTy = dyn_cast<VectorType>(Ty);
536 assert(Ty->isIntegerTy(1) && "True must be i1 or vector of i1.");
537 return ConstantInt::getTrue(Ty->getContext());
539 assert(VTy->getElementType()->isIntegerTy(1) &&
540 "True must be vector of i1 or i1.");
541 return ConstantVector::getSplat(VTy->getNumElements(),
542 ConstantInt::getTrue(Ty->getContext()));
545 Constant *ConstantInt::getFalse(Type *Ty) {
546 VectorType *VTy = dyn_cast<VectorType>(Ty);
548 assert(Ty->isIntegerTy(1) && "False must be i1 or vector of i1.");
549 return ConstantInt::getFalse(Ty->getContext());
551 assert(VTy->getElementType()->isIntegerTy(1) &&
552 "False must be vector of i1 or i1.");
553 return ConstantVector::getSplat(VTy->getNumElements(),
554 ConstantInt::getFalse(Ty->getContext()));
557 // Get a ConstantInt from an APInt.
558 ConstantInt *ConstantInt::get(LLVMContext &Context, const APInt &V) {
559 // get an existing value or the insertion position
560 LLVMContextImpl *pImpl = Context.pImpl;
561 ConstantInt *&Slot = pImpl->IntConstants[V];
563 // Get the corresponding integer type for the bit width of the value.
564 IntegerType *ITy = IntegerType::get(Context, V.getBitWidth());
565 Slot = new ConstantInt(ITy, V);
567 assert(Slot->getType() == IntegerType::get(Context, V.getBitWidth()));
571 Constant *ConstantInt::get(Type *Ty, uint64_t V, bool isSigned) {
572 Constant *C = get(cast<IntegerType>(Ty->getScalarType()), V, isSigned);
574 // For vectors, broadcast the value.
575 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
576 return ConstantVector::getSplat(VTy->getNumElements(), C);
581 ConstantInt *ConstantInt::get(IntegerType *Ty, uint64_t V,
583 return get(Ty->getContext(), APInt(Ty->getBitWidth(), V, isSigned));
586 ConstantInt *ConstantInt::getSigned(IntegerType *Ty, int64_t V) {
587 return get(Ty, V, true);
590 Constant *ConstantInt::getSigned(Type *Ty, int64_t V) {
591 return get(Ty, V, true);
594 Constant *ConstantInt::get(Type *Ty, const APInt& V) {
595 ConstantInt *C = get(Ty->getContext(), V);
596 assert(C->getType() == Ty->getScalarType() &&
597 "ConstantInt type doesn't match the type implied by its value!");
599 // For vectors, broadcast the value.
600 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
601 return ConstantVector::getSplat(VTy->getNumElements(), C);
606 ConstantInt *ConstantInt::get(IntegerType* Ty, StringRef Str,
608 return get(Ty->getContext(), APInt(Ty->getBitWidth(), Str, radix));
611 //===----------------------------------------------------------------------===//
613 //===----------------------------------------------------------------------===//
615 static const fltSemantics *TypeToFloatSemantics(Type *Ty) {
617 return &APFloat::IEEEhalf;
619 return &APFloat::IEEEsingle;
620 if (Ty->isDoubleTy())
621 return &APFloat::IEEEdouble;
622 if (Ty->isX86_FP80Ty())
623 return &APFloat::x87DoubleExtended;
624 else if (Ty->isFP128Ty())
625 return &APFloat::IEEEquad;
627 assert(Ty->isPPC_FP128Ty() && "Unknown FP format");
628 return &APFloat::PPCDoubleDouble;
631 void ConstantFP::anchor() { }
633 /// get() - This returns a constant fp for the specified value in the
634 /// specified type. This should only be used for simple constant values like
635 /// 2.0/1.0 etc, that are known-valid both as double and as the target format.
636 Constant *ConstantFP::get(Type *Ty, double V) {
637 LLVMContext &Context = Ty->getContext();
641 FV.convert(*TypeToFloatSemantics(Ty->getScalarType()),
642 APFloat::rmNearestTiesToEven, &ignored);
643 Constant *C = get(Context, FV);
645 // For vectors, broadcast the value.
646 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
647 return ConstantVector::getSplat(VTy->getNumElements(), C);
653 Constant *ConstantFP::get(Type *Ty, StringRef Str) {
654 LLVMContext &Context = Ty->getContext();
656 APFloat FV(*TypeToFloatSemantics(Ty->getScalarType()), Str);
657 Constant *C = get(Context, FV);
659 // For vectors, broadcast the value.
660 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
661 return ConstantVector::getSplat(VTy->getNumElements(), C);
666 Constant *ConstantFP::getNegativeZero(Type *Ty) {
667 const fltSemantics &Semantics = *TypeToFloatSemantics(Ty->getScalarType());
668 APFloat NegZero = APFloat::getZero(Semantics, /*Negative=*/true);
669 Constant *C = get(Ty->getContext(), NegZero);
671 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
672 return ConstantVector::getSplat(VTy->getNumElements(), C);
678 Constant *ConstantFP::getZeroValueForNegation(Type *Ty) {
679 if (Ty->isFPOrFPVectorTy())
680 return getNegativeZero(Ty);
682 return Constant::getNullValue(Ty);
686 // ConstantFP accessors.
687 ConstantFP* ConstantFP::get(LLVMContext &Context, const APFloat& V) {
688 LLVMContextImpl* pImpl = Context.pImpl;
690 ConstantFP *&Slot = pImpl->FPConstants[V];
694 if (&V.getSemantics() == &APFloat::IEEEhalf)
695 Ty = Type::getHalfTy(Context);
696 else if (&V.getSemantics() == &APFloat::IEEEsingle)
697 Ty = Type::getFloatTy(Context);
698 else if (&V.getSemantics() == &APFloat::IEEEdouble)
699 Ty = Type::getDoubleTy(Context);
700 else if (&V.getSemantics() == &APFloat::x87DoubleExtended)
701 Ty = Type::getX86_FP80Ty(Context);
702 else if (&V.getSemantics() == &APFloat::IEEEquad)
703 Ty = Type::getFP128Ty(Context);
705 assert(&V.getSemantics() == &APFloat::PPCDoubleDouble &&
706 "Unknown FP format");
707 Ty = Type::getPPC_FP128Ty(Context);
709 Slot = new ConstantFP(Ty, V);
715 Constant *ConstantFP::getInfinity(Type *Ty, bool Negative) {
716 const fltSemantics &Semantics = *TypeToFloatSemantics(Ty->getScalarType());
717 Constant *C = get(Ty->getContext(), APFloat::getInf(Semantics, Negative));
719 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
720 return ConstantVector::getSplat(VTy->getNumElements(), C);
725 ConstantFP::ConstantFP(Type *Ty, const APFloat& V)
726 : Constant(Ty, ConstantFPVal, nullptr, 0), Val(V) {
727 assert(&V.getSemantics() == TypeToFloatSemantics(Ty) &&
731 bool ConstantFP::isExactlyValue(const APFloat &V) const {
732 return Val.bitwiseIsEqual(V);
735 //===----------------------------------------------------------------------===//
736 // ConstantAggregateZero Implementation
737 //===----------------------------------------------------------------------===//
739 /// getSequentialElement - If this CAZ has array or vector type, return a zero
740 /// with the right element type.
741 Constant *ConstantAggregateZero::getSequentialElement() const {
742 return Constant::getNullValue(getType()->getSequentialElementType());
745 /// getStructElement - If this CAZ has struct type, return a zero with the
746 /// right element type for the specified element.
747 Constant *ConstantAggregateZero::getStructElement(unsigned Elt) const {
748 return Constant::getNullValue(getType()->getStructElementType(Elt));
751 /// getElementValue - Return a zero of the right value for the specified GEP
752 /// index if we can, otherwise return null (e.g. if C is a ConstantExpr).
753 Constant *ConstantAggregateZero::getElementValue(Constant *C) const {
754 if (isa<SequentialType>(getType()))
755 return getSequentialElement();
756 return getStructElement(cast<ConstantInt>(C)->getZExtValue());
759 /// getElementValue - Return a zero of the right value for the specified GEP
761 Constant *ConstantAggregateZero::getElementValue(unsigned Idx) const {
762 if (isa<SequentialType>(getType()))
763 return getSequentialElement();
764 return getStructElement(Idx);
768 //===----------------------------------------------------------------------===//
769 // UndefValue Implementation
770 //===----------------------------------------------------------------------===//
772 /// getSequentialElement - If this undef has array or vector type, return an
773 /// undef with the right element type.
774 UndefValue *UndefValue::getSequentialElement() const {
775 return UndefValue::get(getType()->getSequentialElementType());
778 /// getStructElement - If this undef has struct type, return a zero with the
779 /// right element type for the specified element.
780 UndefValue *UndefValue::getStructElement(unsigned Elt) const {
781 return UndefValue::get(getType()->getStructElementType(Elt));
784 /// getElementValue - Return an undef of the right value for the specified GEP
785 /// index if we can, otherwise return null (e.g. if C is a ConstantExpr).
786 UndefValue *UndefValue::getElementValue(Constant *C) const {
787 if (isa<SequentialType>(getType()))
788 return getSequentialElement();
789 return getStructElement(cast<ConstantInt>(C)->getZExtValue());
792 /// getElementValue - Return an undef of the right value for the specified GEP
794 UndefValue *UndefValue::getElementValue(unsigned Idx) const {
795 if (isa<SequentialType>(getType()))
796 return getSequentialElement();
797 return getStructElement(Idx);
802 //===----------------------------------------------------------------------===//
803 // ConstantXXX Classes
804 //===----------------------------------------------------------------------===//
806 template <typename ItTy, typename EltTy>
807 static bool rangeOnlyContains(ItTy Start, ItTy End, EltTy Elt) {
808 for (; Start != End; ++Start)
814 ConstantArray::ConstantArray(ArrayType *T, ArrayRef<Constant *> V)
815 : Constant(T, ConstantArrayVal,
816 OperandTraits<ConstantArray>::op_end(this) - V.size(),
818 assert(V.size() == T->getNumElements() &&
819 "Invalid initializer vector for constant array");
820 for (unsigned i = 0, e = V.size(); i != e; ++i)
821 assert(V[i]->getType() == T->getElementType() &&
822 "Initializer for array element doesn't match array element type!");
823 std::copy(V.begin(), V.end(), op_begin());
826 Constant *ConstantArray::get(ArrayType *Ty, ArrayRef<Constant*> V) {
827 if (Constant *C = getImpl(Ty, V))
829 return Ty->getContext().pImpl->ArrayConstants.getOrCreate(Ty, V);
831 Constant *ConstantArray::getImpl(ArrayType *Ty, ArrayRef<Constant*> V) {
832 // Empty arrays are canonicalized to ConstantAggregateZero.
834 return ConstantAggregateZero::get(Ty);
836 for (unsigned i = 0, e = V.size(); i != e; ++i) {
837 assert(V[i]->getType() == Ty->getElementType() &&
838 "Wrong type in array element initializer");
841 // If this is an all-zero array, return a ConstantAggregateZero object. If
842 // all undef, return an UndefValue, if "all simple", then return a
843 // ConstantDataArray.
845 if (isa<UndefValue>(C) && rangeOnlyContains(V.begin(), V.end(), C))
846 return UndefValue::get(Ty);
848 if (C->isNullValue() && rangeOnlyContains(V.begin(), V.end(), C))
849 return ConstantAggregateZero::get(Ty);
851 // Check to see if all of the elements are ConstantFP or ConstantInt and if
852 // the element type is compatible with ConstantDataVector. If so, use it.
853 if (ConstantDataSequential::isElementTypeCompatible(C->getType())) {
854 // We speculatively build the elements here even if it turns out that there
855 // is a constantexpr or something else weird in the array, since it is so
856 // uncommon for that to happen.
857 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
858 if (CI->getType()->isIntegerTy(8)) {
859 SmallVector<uint8_t, 16> Elts;
860 for (unsigned i = 0, e = V.size(); i != e; ++i)
861 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
862 Elts.push_back(CI->getZExtValue());
865 if (Elts.size() == V.size())
866 return ConstantDataArray::get(C->getContext(), Elts);
867 } else if (CI->getType()->isIntegerTy(16)) {
868 SmallVector<uint16_t, 16> Elts;
869 for (unsigned i = 0, e = V.size(); i != e; ++i)
870 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
871 Elts.push_back(CI->getZExtValue());
874 if (Elts.size() == V.size())
875 return ConstantDataArray::get(C->getContext(), Elts);
876 } else if (CI->getType()->isIntegerTy(32)) {
877 SmallVector<uint32_t, 16> Elts;
878 for (unsigned i = 0, e = V.size(); i != e; ++i)
879 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
880 Elts.push_back(CI->getZExtValue());
883 if (Elts.size() == V.size())
884 return ConstantDataArray::get(C->getContext(), Elts);
885 } else if (CI->getType()->isIntegerTy(64)) {
886 SmallVector<uint64_t, 16> Elts;
887 for (unsigned i = 0, e = V.size(); i != e; ++i)
888 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
889 Elts.push_back(CI->getZExtValue());
892 if (Elts.size() == V.size())
893 return ConstantDataArray::get(C->getContext(), Elts);
897 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
898 if (CFP->getType()->isFloatTy()) {
899 SmallVector<float, 16> Elts;
900 for (unsigned i = 0, e = V.size(); i != e; ++i)
901 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
902 Elts.push_back(CFP->getValueAPF().convertToFloat());
905 if (Elts.size() == V.size())
906 return ConstantDataArray::get(C->getContext(), Elts);
907 } else if (CFP->getType()->isDoubleTy()) {
908 SmallVector<double, 16> Elts;
909 for (unsigned i = 0, e = V.size(); i != e; ++i)
910 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
911 Elts.push_back(CFP->getValueAPF().convertToDouble());
914 if (Elts.size() == V.size())
915 return ConstantDataArray::get(C->getContext(), Elts);
920 // Otherwise, we really do want to create a ConstantArray.
924 /// getTypeForElements - Return an anonymous struct type to use for a constant
925 /// with the specified set of elements. The list must not be empty.
926 StructType *ConstantStruct::getTypeForElements(LLVMContext &Context,
927 ArrayRef<Constant*> V,
929 unsigned VecSize = V.size();
930 SmallVector<Type*, 16> EltTypes(VecSize);
931 for (unsigned i = 0; i != VecSize; ++i)
932 EltTypes[i] = V[i]->getType();
934 return StructType::get(Context, EltTypes, Packed);
938 StructType *ConstantStruct::getTypeForElements(ArrayRef<Constant*> V,
941 "ConstantStruct::getTypeForElements cannot be called on empty list");
942 return getTypeForElements(V[0]->getContext(), V, Packed);
946 ConstantStruct::ConstantStruct(StructType *T, ArrayRef<Constant *> V)
947 : Constant(T, ConstantStructVal,
948 OperandTraits<ConstantStruct>::op_end(this) - V.size(),
950 assert(V.size() == T->getNumElements() &&
951 "Invalid initializer vector for constant structure");
952 for (unsigned i = 0, e = V.size(); i != e; ++i)
953 assert((T->isOpaque() || V[i]->getType() == T->getElementType(i)) &&
954 "Initializer for struct element doesn't match struct element type!");
955 std::copy(V.begin(), V.end(), op_begin());
958 // ConstantStruct accessors.
959 Constant *ConstantStruct::get(StructType *ST, ArrayRef<Constant*> V) {
960 assert((ST->isOpaque() || ST->getNumElements() == V.size()) &&
961 "Incorrect # elements specified to ConstantStruct::get");
963 // Create a ConstantAggregateZero value if all elements are zeros.
965 bool isUndef = false;
968 isUndef = isa<UndefValue>(V[0]);
969 isZero = V[0]->isNullValue();
970 if (isUndef || isZero) {
971 for (unsigned i = 0, e = V.size(); i != e; ++i) {
972 if (!V[i]->isNullValue())
974 if (!isa<UndefValue>(V[i]))
980 return ConstantAggregateZero::get(ST);
982 return UndefValue::get(ST);
984 return ST->getContext().pImpl->StructConstants.getOrCreate(ST, V);
987 Constant *ConstantStruct::get(StructType *T, ...) {
989 SmallVector<Constant*, 8> Values;
991 while (Constant *Val = va_arg(ap, llvm::Constant*))
992 Values.push_back(Val);
994 return get(T, Values);
997 ConstantVector::ConstantVector(VectorType *T, ArrayRef<Constant *> V)
998 : Constant(T, ConstantVectorVal,
999 OperandTraits<ConstantVector>::op_end(this) - V.size(),
1001 for (size_t i = 0, e = V.size(); i != e; i++)
1002 assert(V[i]->getType() == T->getElementType() &&
1003 "Initializer for vector element doesn't match vector element type!");
1004 std::copy(V.begin(), V.end(), op_begin());
1007 // ConstantVector accessors.
1008 Constant *ConstantVector::get(ArrayRef<Constant*> V) {
1009 if (Constant *C = getImpl(V))
1011 VectorType *Ty = VectorType::get(V.front()->getType(), V.size());
1012 return Ty->getContext().pImpl->VectorConstants.getOrCreate(Ty, V);
1014 Constant *ConstantVector::getImpl(ArrayRef<Constant*> V) {
1015 assert(!V.empty() && "Vectors can't be empty");
1016 VectorType *T = VectorType::get(V.front()->getType(), V.size());
1018 // If this is an all-undef or all-zero vector, return a
1019 // ConstantAggregateZero or UndefValue.
1021 bool isZero = C->isNullValue();
1022 bool isUndef = isa<UndefValue>(C);
1024 if (isZero || isUndef) {
1025 for (unsigned i = 1, e = V.size(); i != e; ++i)
1027 isZero = isUndef = false;
1033 return ConstantAggregateZero::get(T);
1035 return UndefValue::get(T);
1037 // Check to see if all of the elements are ConstantFP or ConstantInt and if
1038 // the element type is compatible with ConstantDataVector. If so, use it.
1039 if (ConstantDataSequential::isElementTypeCompatible(C->getType())) {
1040 // We speculatively build the elements here even if it turns out that there
1041 // is a constantexpr or something else weird in the array, since it is so
1042 // uncommon for that to happen.
1043 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
1044 if (CI->getType()->isIntegerTy(8)) {
1045 SmallVector<uint8_t, 16> Elts;
1046 for (unsigned i = 0, e = V.size(); i != e; ++i)
1047 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1048 Elts.push_back(CI->getZExtValue());
1051 if (Elts.size() == V.size())
1052 return ConstantDataVector::get(C->getContext(), Elts);
1053 } else if (CI->getType()->isIntegerTy(16)) {
1054 SmallVector<uint16_t, 16> Elts;
1055 for (unsigned i = 0, e = V.size(); i != e; ++i)
1056 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1057 Elts.push_back(CI->getZExtValue());
1060 if (Elts.size() == V.size())
1061 return ConstantDataVector::get(C->getContext(), Elts);
1062 } else if (CI->getType()->isIntegerTy(32)) {
1063 SmallVector<uint32_t, 16> Elts;
1064 for (unsigned i = 0, e = V.size(); i != e; ++i)
1065 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1066 Elts.push_back(CI->getZExtValue());
1069 if (Elts.size() == V.size())
1070 return ConstantDataVector::get(C->getContext(), Elts);
1071 } else if (CI->getType()->isIntegerTy(64)) {
1072 SmallVector<uint64_t, 16> Elts;
1073 for (unsigned i = 0, e = V.size(); i != e; ++i)
1074 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1075 Elts.push_back(CI->getZExtValue());
1078 if (Elts.size() == V.size())
1079 return ConstantDataVector::get(C->getContext(), Elts);
1083 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
1084 if (CFP->getType()->isFloatTy()) {
1085 SmallVector<float, 16> Elts;
1086 for (unsigned i = 0, e = V.size(); i != e; ++i)
1087 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
1088 Elts.push_back(CFP->getValueAPF().convertToFloat());
1091 if (Elts.size() == V.size())
1092 return ConstantDataVector::get(C->getContext(), Elts);
1093 } else if (CFP->getType()->isDoubleTy()) {
1094 SmallVector<double, 16> Elts;
1095 for (unsigned i = 0, e = V.size(); i != e; ++i)
1096 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
1097 Elts.push_back(CFP->getValueAPF().convertToDouble());
1100 if (Elts.size() == V.size())
1101 return ConstantDataVector::get(C->getContext(), Elts);
1106 // Otherwise, the element type isn't compatible with ConstantDataVector, or
1107 // the operand list constants a ConstantExpr or something else strange.
1111 Constant *ConstantVector::getSplat(unsigned NumElts, Constant *V) {
1112 // If this splat is compatible with ConstantDataVector, use it instead of
1114 if ((isa<ConstantFP>(V) || isa<ConstantInt>(V)) &&
1115 ConstantDataSequential::isElementTypeCompatible(V->getType()))
1116 return ConstantDataVector::getSplat(NumElts, V);
1118 SmallVector<Constant*, 32> Elts(NumElts, V);
1123 // Utility function for determining if a ConstantExpr is a CastOp or not. This
1124 // can't be inline because we don't want to #include Instruction.h into
1126 bool ConstantExpr::isCast() const {
1127 return Instruction::isCast(getOpcode());
1130 bool ConstantExpr::isCompare() const {
1131 return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
1134 bool ConstantExpr::isGEPWithNoNotionalOverIndexing() const {
1135 if (getOpcode() != Instruction::GetElementPtr) return false;
1137 gep_type_iterator GEPI = gep_type_begin(this), E = gep_type_end(this);
1138 User::const_op_iterator OI = std::next(this->op_begin());
1140 // Skip the first index, as it has no static limit.
1144 // The remaining indices must be compile-time known integers within the
1145 // bounds of the corresponding notional static array types.
1146 for (; GEPI != E; ++GEPI, ++OI) {
1147 ConstantInt *CI = dyn_cast<ConstantInt>(*OI);
1148 if (!CI) return false;
1149 if (ArrayType *ATy = dyn_cast<ArrayType>(*GEPI))
1150 if (CI->getValue().getActiveBits() > 64 ||
1151 CI->getZExtValue() >= ATy->getNumElements())
1155 // All the indices checked out.
1159 bool ConstantExpr::hasIndices() const {
1160 return getOpcode() == Instruction::ExtractValue ||
1161 getOpcode() == Instruction::InsertValue;
1164 ArrayRef<unsigned> ConstantExpr::getIndices() const {
1165 if (const ExtractValueConstantExpr *EVCE =
1166 dyn_cast<ExtractValueConstantExpr>(this))
1167 return EVCE->Indices;
1169 return cast<InsertValueConstantExpr>(this)->Indices;
1172 unsigned ConstantExpr::getPredicate() const {
1173 assert(isCompare());
1174 return ((const CompareConstantExpr*)this)->predicate;
1177 /// getWithOperandReplaced - Return a constant expression identical to this
1178 /// one, but with the specified operand set to the specified value.
1180 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
1181 assert(Op->getType() == getOperand(OpNo)->getType() &&
1182 "Replacing operand with value of different type!");
1183 if (getOperand(OpNo) == Op)
1184 return const_cast<ConstantExpr*>(this);
1186 SmallVector<Constant*, 8> NewOps;
1187 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1188 NewOps.push_back(i == OpNo ? Op : getOperand(i));
1190 return getWithOperands(NewOps);
1193 /// getWithOperands - This returns the current constant expression with the
1194 /// operands replaced with the specified values. The specified array must
1195 /// have the same number of operands as our current one.
1196 Constant *ConstantExpr::getWithOperands(ArrayRef<Constant *> Ops, Type *Ty,
1197 bool OnlyIfReduced) const {
1198 assert(Ops.size() == getNumOperands() && "Operand count mismatch!");
1199 bool AnyChange = Ty != getType();
1200 for (unsigned i = 0; i != Ops.size(); ++i)
1201 AnyChange |= Ops[i] != getOperand(i);
1203 if (!AnyChange) // No operands changed, return self.
1204 return const_cast<ConstantExpr*>(this);
1206 Type *OnlyIfReducedTy = OnlyIfReduced ? Ty : nullptr;
1207 switch (getOpcode()) {
1208 case Instruction::Trunc:
1209 case Instruction::ZExt:
1210 case Instruction::SExt:
1211 case Instruction::FPTrunc:
1212 case Instruction::FPExt:
1213 case Instruction::UIToFP:
1214 case Instruction::SIToFP:
1215 case Instruction::FPToUI:
1216 case Instruction::FPToSI:
1217 case Instruction::PtrToInt:
1218 case Instruction::IntToPtr:
1219 case Instruction::BitCast:
1220 case Instruction::AddrSpaceCast:
1221 return ConstantExpr::getCast(getOpcode(), Ops[0], Ty, OnlyIfReduced);
1222 case Instruction::Select:
1223 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2], OnlyIfReducedTy);
1224 case Instruction::InsertElement:
1225 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2],
1227 case Instruction::ExtractElement:
1228 return ConstantExpr::getExtractElement(Ops[0], Ops[1], OnlyIfReducedTy);
1229 case Instruction::InsertValue:
1230 return ConstantExpr::getInsertValue(Ops[0], Ops[1], getIndices(),
1232 case Instruction::ExtractValue:
1233 return ConstantExpr::getExtractValue(Ops[0], getIndices(), OnlyIfReducedTy);
1234 case Instruction::ShuffleVector:
1235 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2],
1237 case Instruction::GetElementPtr:
1238 return ConstantExpr::getGetElementPtr(Ops[0], Ops.slice(1),
1239 cast<GEPOperator>(this)->isInBounds(),
1241 case Instruction::ICmp:
1242 case Instruction::FCmp:
1243 return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1],
1246 assert(getNumOperands() == 2 && "Must be binary operator?");
1247 return ConstantExpr::get(getOpcode(), Ops[0], Ops[1], SubclassOptionalData,
1253 //===----------------------------------------------------------------------===//
1254 // isValueValidForType implementations
1256 bool ConstantInt::isValueValidForType(Type *Ty, uint64_t Val) {
1257 unsigned NumBits = Ty->getIntegerBitWidth(); // assert okay
1258 if (Ty->isIntegerTy(1))
1259 return Val == 0 || Val == 1;
1261 return true; // always true, has to fit in largest type
1262 uint64_t Max = (1ll << NumBits) - 1;
1266 bool ConstantInt::isValueValidForType(Type *Ty, int64_t Val) {
1267 unsigned NumBits = Ty->getIntegerBitWidth();
1268 if (Ty->isIntegerTy(1))
1269 return Val == 0 || Val == 1 || Val == -1;
1271 return true; // always true, has to fit in largest type
1272 int64_t Min = -(1ll << (NumBits-1));
1273 int64_t Max = (1ll << (NumBits-1)) - 1;
1274 return (Val >= Min && Val <= Max);
1277 bool ConstantFP::isValueValidForType(Type *Ty, const APFloat& Val) {
1278 // convert modifies in place, so make a copy.
1279 APFloat Val2 = APFloat(Val);
1281 switch (Ty->getTypeID()) {
1283 return false; // These can't be represented as floating point!
1285 // FIXME rounding mode needs to be more flexible
1286 case Type::HalfTyID: {
1287 if (&Val2.getSemantics() == &APFloat::IEEEhalf)
1289 Val2.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &losesInfo);
1292 case Type::FloatTyID: {
1293 if (&Val2.getSemantics() == &APFloat::IEEEsingle)
1295 Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
1298 case Type::DoubleTyID: {
1299 if (&Val2.getSemantics() == &APFloat::IEEEhalf ||
1300 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1301 &Val2.getSemantics() == &APFloat::IEEEdouble)
1303 Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
1306 case Type::X86_FP80TyID:
1307 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1308 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1309 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1310 &Val2.getSemantics() == &APFloat::x87DoubleExtended;
1311 case Type::FP128TyID:
1312 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1313 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1314 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1315 &Val2.getSemantics() == &APFloat::IEEEquad;
1316 case Type::PPC_FP128TyID:
1317 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1318 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1319 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1320 &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
1325 //===----------------------------------------------------------------------===//
1326 // Factory Function Implementation
1328 ConstantAggregateZero *ConstantAggregateZero::get(Type *Ty) {
1329 assert((Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()) &&
1330 "Cannot create an aggregate zero of non-aggregate type!");
1332 ConstantAggregateZero *&Entry = Ty->getContext().pImpl->CAZConstants[Ty];
1334 Entry = new ConstantAggregateZero(Ty);
1339 /// destroyConstant - Remove the constant from the constant table.
1341 void ConstantAggregateZero::destroyConstant() {
1342 getContext().pImpl->CAZConstants.erase(getType());
1343 destroyConstantImpl();
1346 /// destroyConstant - Remove the constant from the constant table...
1348 void ConstantArray::destroyConstant() {
1349 getType()->getContext().pImpl->ArrayConstants.remove(this);
1350 destroyConstantImpl();
1354 //---- ConstantStruct::get() implementation...
1357 // destroyConstant - Remove the constant from the constant table...
1359 void ConstantStruct::destroyConstant() {
1360 getType()->getContext().pImpl->StructConstants.remove(this);
1361 destroyConstantImpl();
1364 // destroyConstant - Remove the constant from the constant table...
1366 void ConstantVector::destroyConstant() {
1367 getType()->getContext().pImpl->VectorConstants.remove(this);
1368 destroyConstantImpl();
1371 /// getSplatValue - If this is a splat vector constant, meaning that all of
1372 /// the elements have the same value, return that value. Otherwise return 0.
1373 Constant *Constant::getSplatValue() const {
1374 assert(this->getType()->isVectorTy() && "Only valid for vectors!");
1375 if (isa<ConstantAggregateZero>(this))
1376 return getNullValue(this->getType()->getVectorElementType());
1377 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
1378 return CV->getSplatValue();
1379 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
1380 return CV->getSplatValue();
1384 /// getSplatValue - If this is a splat constant, where all of the
1385 /// elements have the same value, return that value. Otherwise return null.
1386 Constant *ConstantVector::getSplatValue() const {
1387 // Check out first element.
1388 Constant *Elt = getOperand(0);
1389 // Then make sure all remaining elements point to the same value.
1390 for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1391 if (getOperand(I) != Elt)
1396 /// If C is a constant integer then return its value, otherwise C must be a
1397 /// vector of constant integers, all equal, and the common value is returned.
1398 const APInt &Constant::getUniqueInteger() const {
1399 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
1400 return CI->getValue();
1401 assert(this->getSplatValue() && "Doesn't contain a unique integer!");
1402 const Constant *C = this->getAggregateElement(0U);
1403 assert(C && isa<ConstantInt>(C) && "Not a vector of numbers!");
1404 return cast<ConstantInt>(C)->getValue();
1408 //---- ConstantPointerNull::get() implementation.
1411 ConstantPointerNull *ConstantPointerNull::get(PointerType *Ty) {
1412 ConstantPointerNull *&Entry = Ty->getContext().pImpl->CPNConstants[Ty];
1414 Entry = new ConstantPointerNull(Ty);
1419 // destroyConstant - Remove the constant from the constant table...
1421 void ConstantPointerNull::destroyConstant() {
1422 getContext().pImpl->CPNConstants.erase(getType());
1423 // Free the constant and any dangling references to it.
1424 destroyConstantImpl();
1428 //---- UndefValue::get() implementation.
1431 UndefValue *UndefValue::get(Type *Ty) {
1432 UndefValue *&Entry = Ty->getContext().pImpl->UVConstants[Ty];
1434 Entry = new UndefValue(Ty);
1439 // destroyConstant - Remove the constant from the constant table.
1441 void UndefValue::destroyConstant() {
1442 // Free the constant and any dangling references to it.
1443 getContext().pImpl->UVConstants.erase(getType());
1444 destroyConstantImpl();
1447 //---- BlockAddress::get() implementation.
1450 BlockAddress *BlockAddress::get(BasicBlock *BB) {
1451 assert(BB->getParent() && "Block must have a parent");
1452 return get(BB->getParent(), BB);
1455 BlockAddress *BlockAddress::get(Function *F, BasicBlock *BB) {
1457 F->getContext().pImpl->BlockAddresses[std::make_pair(F, BB)];
1459 BA = new BlockAddress(F, BB);
1461 assert(BA->getFunction() == F && "Basic block moved between functions");
1465 BlockAddress::BlockAddress(Function *F, BasicBlock *BB)
1466 : Constant(Type::getInt8PtrTy(F->getContext()), Value::BlockAddressVal,
1470 BB->AdjustBlockAddressRefCount(1);
1473 BlockAddress *BlockAddress::lookup(const BasicBlock *BB) {
1474 if (!BB->hasAddressTaken())
1477 const Function *F = BB->getParent();
1478 assert(F && "Block must have a parent");
1480 F->getContext().pImpl->BlockAddresses.lookup(std::make_pair(F, BB));
1481 assert(BA && "Refcount and block address map disagree!");
1485 // destroyConstant - Remove the constant from the constant table.
1487 void BlockAddress::destroyConstant() {
1488 getFunction()->getType()->getContext().pImpl
1489 ->BlockAddresses.erase(std::make_pair(getFunction(), getBasicBlock()));
1490 getBasicBlock()->AdjustBlockAddressRefCount(-1);
1491 destroyConstantImpl();
1494 void BlockAddress::replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) {
1495 // This could be replacing either the Basic Block or the Function. In either
1496 // case, we have to remove the map entry.
1497 Function *NewF = getFunction();
1498 BasicBlock *NewBB = getBasicBlock();
1501 NewF = cast<Function>(To->stripPointerCasts());
1503 NewBB = cast<BasicBlock>(To);
1505 // See if the 'new' entry already exists, if not, just update this in place
1506 // and return early.
1507 BlockAddress *&NewBA =
1508 getContext().pImpl->BlockAddresses[std::make_pair(NewF, NewBB)];
1510 replaceUsesOfWithOnConstantImpl(NewBA);
1514 getBasicBlock()->AdjustBlockAddressRefCount(-1);
1516 // Remove the old entry, this can't cause the map to rehash (just a
1517 // tombstone will get added).
1518 getContext().pImpl->BlockAddresses.erase(std::make_pair(getFunction(),
1521 setOperand(0, NewF);
1522 setOperand(1, NewBB);
1523 getBasicBlock()->AdjustBlockAddressRefCount(1);
1526 //---- ConstantExpr::get() implementations.
1529 /// This is a utility function to handle folding of casts and lookup of the
1530 /// cast in the ExprConstants map. It is used by the various get* methods below.
1531 static Constant *getFoldedCast(Instruction::CastOps opc, Constant *C, Type *Ty,
1532 bool OnlyIfReduced = false) {
1533 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1534 // Fold a few common cases
1535 if (Constant *FC = ConstantFoldCastInstruction(opc, C, Ty))
1541 LLVMContextImpl *pImpl = Ty->getContext().pImpl;
1543 // Look up the constant in the table first to ensure uniqueness.
1544 ConstantExprKeyType Key(opc, C);
1546 return pImpl->ExprConstants.getOrCreate(Ty, Key);
1549 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, Type *Ty,
1550 bool OnlyIfReduced) {
1551 Instruction::CastOps opc = Instruction::CastOps(oc);
1552 assert(Instruction::isCast(opc) && "opcode out of range");
1553 assert(C && Ty && "Null arguments to getCast");
1554 assert(CastInst::castIsValid(opc, C, Ty) && "Invalid constantexpr cast!");
1558 llvm_unreachable("Invalid cast opcode");
1559 case Instruction::Trunc:
1560 return getTrunc(C, Ty, OnlyIfReduced);
1561 case Instruction::ZExt:
1562 return getZExt(C, Ty, OnlyIfReduced);
1563 case Instruction::SExt:
1564 return getSExt(C, Ty, OnlyIfReduced);
1565 case Instruction::FPTrunc:
1566 return getFPTrunc(C, Ty, OnlyIfReduced);
1567 case Instruction::FPExt:
1568 return getFPExtend(C, Ty, OnlyIfReduced);
1569 case Instruction::UIToFP:
1570 return getUIToFP(C, Ty, OnlyIfReduced);
1571 case Instruction::SIToFP:
1572 return getSIToFP(C, Ty, OnlyIfReduced);
1573 case Instruction::FPToUI:
1574 return getFPToUI(C, Ty, OnlyIfReduced);
1575 case Instruction::FPToSI:
1576 return getFPToSI(C, Ty, OnlyIfReduced);
1577 case Instruction::PtrToInt:
1578 return getPtrToInt(C, Ty, OnlyIfReduced);
1579 case Instruction::IntToPtr:
1580 return getIntToPtr(C, Ty, OnlyIfReduced);
1581 case Instruction::BitCast:
1582 return getBitCast(C, Ty, OnlyIfReduced);
1583 case Instruction::AddrSpaceCast:
1584 return getAddrSpaceCast(C, Ty, OnlyIfReduced);
1588 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, Type *Ty) {
1589 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1590 return getBitCast(C, Ty);
1591 return getZExt(C, Ty);
1594 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, Type *Ty) {
1595 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1596 return getBitCast(C, Ty);
1597 return getSExt(C, Ty);
1600 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, Type *Ty) {
1601 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1602 return getBitCast(C, Ty);
1603 return getTrunc(C, Ty);
1606 Constant *ConstantExpr::getPointerCast(Constant *S, Type *Ty) {
1607 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
1608 assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
1611 if (Ty->isIntOrIntVectorTy())
1612 return getPtrToInt(S, Ty);
1614 unsigned SrcAS = S->getType()->getPointerAddressSpace();
1615 if (Ty->isPtrOrPtrVectorTy() && SrcAS != Ty->getPointerAddressSpace())
1616 return getAddrSpaceCast(S, Ty);
1618 return getBitCast(S, Ty);
1621 Constant *ConstantExpr::getPointerBitCastOrAddrSpaceCast(Constant *S,
1623 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
1624 assert(Ty->isPtrOrPtrVectorTy() && "Invalid cast");
1626 if (S->getType()->getPointerAddressSpace() != Ty->getPointerAddressSpace())
1627 return getAddrSpaceCast(S, Ty);
1629 return getBitCast(S, Ty);
1632 Constant *ConstantExpr::getIntegerCast(Constant *C, Type *Ty,
1634 assert(C->getType()->isIntOrIntVectorTy() &&
1635 Ty->isIntOrIntVectorTy() && "Invalid cast");
1636 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1637 unsigned DstBits = Ty->getScalarSizeInBits();
1638 Instruction::CastOps opcode =
1639 (SrcBits == DstBits ? Instruction::BitCast :
1640 (SrcBits > DstBits ? Instruction::Trunc :
1641 (isSigned ? Instruction::SExt : Instruction::ZExt)));
1642 return getCast(opcode, C, Ty);
1645 Constant *ConstantExpr::getFPCast(Constant *C, Type *Ty) {
1646 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1648 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1649 unsigned DstBits = Ty->getScalarSizeInBits();
1650 if (SrcBits == DstBits)
1651 return C; // Avoid a useless cast
1652 Instruction::CastOps opcode =
1653 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1654 return getCast(opcode, C, Ty);
1657 Constant *ConstantExpr::getTrunc(Constant *C, Type *Ty, bool OnlyIfReduced) {
1659 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1660 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1662 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1663 assert(C->getType()->isIntOrIntVectorTy() && "Trunc operand must be integer");
1664 assert(Ty->isIntOrIntVectorTy() && "Trunc produces only integral");
1665 assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1666 "SrcTy must be larger than DestTy for Trunc!");
1668 return getFoldedCast(Instruction::Trunc, C, Ty, OnlyIfReduced);
1671 Constant *ConstantExpr::getSExt(Constant *C, Type *Ty, bool OnlyIfReduced) {
1673 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1674 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1676 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1677 assert(C->getType()->isIntOrIntVectorTy() && "SExt operand must be integral");
1678 assert(Ty->isIntOrIntVectorTy() && "SExt produces only integer");
1679 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1680 "SrcTy must be smaller than DestTy for SExt!");
1682 return getFoldedCast(Instruction::SExt, C, Ty, OnlyIfReduced);
1685 Constant *ConstantExpr::getZExt(Constant *C, Type *Ty, bool OnlyIfReduced) {
1687 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1688 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1690 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1691 assert(C->getType()->isIntOrIntVectorTy() && "ZEXt operand must be integral");
1692 assert(Ty->isIntOrIntVectorTy() && "ZExt produces only integer");
1693 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1694 "SrcTy must be smaller than DestTy for ZExt!");
1696 return getFoldedCast(Instruction::ZExt, C, Ty, OnlyIfReduced);
1699 Constant *ConstantExpr::getFPTrunc(Constant *C, Type *Ty, bool OnlyIfReduced) {
1701 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1702 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1704 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1705 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1706 C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1707 "This is an illegal floating point truncation!");
1708 return getFoldedCast(Instruction::FPTrunc, C, Ty, OnlyIfReduced);
1711 Constant *ConstantExpr::getFPExtend(Constant *C, Type *Ty, bool OnlyIfReduced) {
1713 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1714 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1716 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1717 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1718 C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1719 "This is an illegal floating point extension!");
1720 return getFoldedCast(Instruction::FPExt, C, Ty, OnlyIfReduced);
1723 Constant *ConstantExpr::getUIToFP(Constant *C, Type *Ty, bool OnlyIfReduced) {
1725 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1726 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1728 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1729 assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1730 "This is an illegal uint to floating point cast!");
1731 return getFoldedCast(Instruction::UIToFP, C, Ty, OnlyIfReduced);
1734 Constant *ConstantExpr::getSIToFP(Constant *C, Type *Ty, bool OnlyIfReduced) {
1736 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1737 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1739 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1740 assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1741 "This is an illegal sint to floating point cast!");
1742 return getFoldedCast(Instruction::SIToFP, C, Ty, OnlyIfReduced);
1745 Constant *ConstantExpr::getFPToUI(Constant *C, Type *Ty, bool OnlyIfReduced) {
1747 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1748 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1750 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1751 assert(C->getType()->isFPOrFPVectorTy() && Ty->isIntOrIntVectorTy() &&
1752 "This is an illegal floating point to uint cast!");
1753 return getFoldedCast(Instruction::FPToUI, C, Ty, OnlyIfReduced);
1756 Constant *ConstantExpr::getFPToSI(Constant *C, Type *Ty, bool OnlyIfReduced) {
1758 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1759 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1761 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1762 assert(C->getType()->isFPOrFPVectorTy() && Ty->isIntOrIntVectorTy() &&
1763 "This is an illegal floating point to sint cast!");
1764 return getFoldedCast(Instruction::FPToSI, C, Ty, OnlyIfReduced);
1767 Constant *ConstantExpr::getPtrToInt(Constant *C, Type *DstTy,
1768 bool OnlyIfReduced) {
1769 assert(C->getType()->getScalarType()->isPointerTy() &&
1770 "PtrToInt source must be pointer or pointer vector");
1771 assert(DstTy->getScalarType()->isIntegerTy() &&
1772 "PtrToInt destination must be integer or integer vector");
1773 assert(isa<VectorType>(C->getType()) == isa<VectorType>(DstTy));
1774 if (isa<VectorType>(C->getType()))
1775 assert(C->getType()->getVectorNumElements()==DstTy->getVectorNumElements()&&
1776 "Invalid cast between a different number of vector elements");
1777 return getFoldedCast(Instruction::PtrToInt, C, DstTy, OnlyIfReduced);
1780 Constant *ConstantExpr::getIntToPtr(Constant *C, Type *DstTy,
1781 bool OnlyIfReduced) {
1782 assert(C->getType()->getScalarType()->isIntegerTy() &&
1783 "IntToPtr source must be integer or integer vector");
1784 assert(DstTy->getScalarType()->isPointerTy() &&
1785 "IntToPtr destination must be a pointer or pointer vector");
1786 assert(isa<VectorType>(C->getType()) == isa<VectorType>(DstTy));
1787 if (isa<VectorType>(C->getType()))
1788 assert(C->getType()->getVectorNumElements()==DstTy->getVectorNumElements()&&
1789 "Invalid cast between a different number of vector elements");
1790 return getFoldedCast(Instruction::IntToPtr, C, DstTy, OnlyIfReduced);
1793 Constant *ConstantExpr::getBitCast(Constant *C, Type *DstTy,
1794 bool OnlyIfReduced) {
1795 assert(CastInst::castIsValid(Instruction::BitCast, C, DstTy) &&
1796 "Invalid constantexpr bitcast!");
1798 // It is common to ask for a bitcast of a value to its own type, handle this
1800 if (C->getType() == DstTy) return C;
1802 return getFoldedCast(Instruction::BitCast, C, DstTy, OnlyIfReduced);
1805 Constant *ConstantExpr::getAddrSpaceCast(Constant *C, Type *DstTy,
1806 bool OnlyIfReduced) {
1807 assert(CastInst::castIsValid(Instruction::AddrSpaceCast, C, DstTy) &&
1808 "Invalid constantexpr addrspacecast!");
1810 // Canonicalize addrspacecasts between different pointer types by first
1811 // bitcasting the pointer type and then converting the address space.
1812 PointerType *SrcScalarTy = cast<PointerType>(C->getType()->getScalarType());
1813 PointerType *DstScalarTy = cast<PointerType>(DstTy->getScalarType());
1814 Type *DstElemTy = DstScalarTy->getElementType();
1815 if (SrcScalarTy->getElementType() != DstElemTy) {
1816 Type *MidTy = PointerType::get(DstElemTy, SrcScalarTy->getAddressSpace());
1817 if (VectorType *VT = dyn_cast<VectorType>(DstTy)) {
1818 // Handle vectors of pointers.
1819 MidTy = VectorType::get(MidTy, VT->getNumElements());
1821 C = getBitCast(C, MidTy);
1823 return getFoldedCast(Instruction::AddrSpaceCast, C, DstTy, OnlyIfReduced);
1826 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2,
1827 unsigned Flags, Type *OnlyIfReducedTy) {
1828 // Check the operands for consistency first.
1829 assert(Opcode >= Instruction::BinaryOpsBegin &&
1830 Opcode < Instruction::BinaryOpsEnd &&
1831 "Invalid opcode in binary constant expression");
1832 assert(C1->getType() == C2->getType() &&
1833 "Operand types in binary constant expression should match");
1837 case Instruction::Add:
1838 case Instruction::Sub:
1839 case Instruction::Mul:
1840 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1841 assert(C1->getType()->isIntOrIntVectorTy() &&
1842 "Tried to create an integer operation on a non-integer type!");
1844 case Instruction::FAdd:
1845 case Instruction::FSub:
1846 case Instruction::FMul:
1847 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1848 assert(C1->getType()->isFPOrFPVectorTy() &&
1849 "Tried to create a floating-point operation on a "
1850 "non-floating-point type!");
1852 case Instruction::UDiv:
1853 case Instruction::SDiv:
1854 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1855 assert(C1->getType()->isIntOrIntVectorTy() &&
1856 "Tried to create an arithmetic operation on a non-arithmetic type!");
1858 case Instruction::FDiv:
1859 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1860 assert(C1->getType()->isFPOrFPVectorTy() &&
1861 "Tried to create an arithmetic operation on a non-arithmetic type!");
1863 case Instruction::URem:
1864 case Instruction::SRem:
1865 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1866 assert(C1->getType()->isIntOrIntVectorTy() &&
1867 "Tried to create an arithmetic operation on a non-arithmetic type!");
1869 case Instruction::FRem:
1870 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1871 assert(C1->getType()->isFPOrFPVectorTy() &&
1872 "Tried to create an arithmetic operation on a non-arithmetic type!");
1874 case Instruction::And:
1875 case Instruction::Or:
1876 case Instruction::Xor:
1877 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1878 assert(C1->getType()->isIntOrIntVectorTy() &&
1879 "Tried to create a logical operation on a non-integral type!");
1881 case Instruction::Shl:
1882 case Instruction::LShr:
1883 case Instruction::AShr:
1884 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1885 assert(C1->getType()->isIntOrIntVectorTy() &&
1886 "Tried to create a shift operation on a non-integer type!");
1893 if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1894 return FC; // Fold a few common cases.
1896 if (OnlyIfReducedTy == C1->getType())
1899 Constant *ArgVec[] = { C1, C2 };
1900 ConstantExprKeyType Key(Opcode, ArgVec, 0, Flags);
1902 LLVMContextImpl *pImpl = C1->getContext().pImpl;
1903 return pImpl->ExprConstants.getOrCreate(C1->getType(), Key);
1906 Constant *ConstantExpr::getSizeOf(Type* Ty) {
1907 // sizeof is implemented as: (i64) gep (Ty*)null, 1
1908 // Note that a non-inbounds gep is used, as null isn't within any object.
1909 Constant *GEPIdx = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1910 Constant *GEP = getGetElementPtr(
1911 Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1912 return getPtrToInt(GEP,
1913 Type::getInt64Ty(Ty->getContext()));
1916 Constant *ConstantExpr::getAlignOf(Type* Ty) {
1917 // alignof is implemented as: (i64) gep ({i1,Ty}*)null, 0, 1
1918 // Note that a non-inbounds gep is used, as null isn't within any object.
1920 StructType::get(Type::getInt1Ty(Ty->getContext()), Ty, nullptr);
1921 Constant *NullPtr = Constant::getNullValue(AligningTy->getPointerTo(0));
1922 Constant *Zero = ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0);
1923 Constant *One = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1924 Constant *Indices[2] = { Zero, One };
1925 Constant *GEP = getGetElementPtr(NullPtr, Indices);
1926 return getPtrToInt(GEP,
1927 Type::getInt64Ty(Ty->getContext()));
1930 Constant *ConstantExpr::getOffsetOf(StructType* STy, unsigned FieldNo) {
1931 return getOffsetOf(STy, ConstantInt::get(Type::getInt32Ty(STy->getContext()),
1935 Constant *ConstantExpr::getOffsetOf(Type* Ty, Constant *FieldNo) {
1936 // offsetof is implemented as: (i64) gep (Ty*)null, 0, FieldNo
1937 // Note that a non-inbounds gep is used, as null isn't within any object.
1938 Constant *GEPIdx[] = {
1939 ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0),
1942 Constant *GEP = getGetElementPtr(
1943 Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1944 return getPtrToInt(GEP,
1945 Type::getInt64Ty(Ty->getContext()));
1948 Constant *ConstantExpr::getCompare(unsigned short Predicate, Constant *C1,
1949 Constant *C2, bool OnlyIfReduced) {
1950 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1952 switch (Predicate) {
1953 default: llvm_unreachable("Invalid CmpInst predicate");
1954 case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1955 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1956 case CmpInst::FCMP_ONE: case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1957 case CmpInst::FCMP_UEQ: case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1958 case CmpInst::FCMP_ULT: case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1959 case CmpInst::FCMP_TRUE:
1960 return getFCmp(Predicate, C1, C2, OnlyIfReduced);
1962 case CmpInst::ICMP_EQ: case CmpInst::ICMP_NE: case CmpInst::ICMP_UGT:
1963 case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1964 case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1965 case CmpInst::ICMP_SLE:
1966 return getICmp(Predicate, C1, C2, OnlyIfReduced);
1970 Constant *ConstantExpr::getSelect(Constant *C, Constant *V1, Constant *V2,
1971 Type *OnlyIfReducedTy) {
1972 assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1974 if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1975 return SC; // Fold common cases
1977 if (OnlyIfReducedTy == V1->getType())
1980 Constant *ArgVec[] = { C, V1, V2 };
1981 ConstantExprKeyType Key(Instruction::Select, ArgVec);
1983 LLVMContextImpl *pImpl = C->getContext().pImpl;
1984 return pImpl->ExprConstants.getOrCreate(V1->getType(), Key);
1987 Constant *ConstantExpr::getGetElementPtr(Constant *C, ArrayRef<Value *> Idxs,
1988 bool InBounds, Type *OnlyIfReducedTy) {
1989 assert(C->getType()->isPtrOrPtrVectorTy() &&
1990 "Non-pointer type for constant GetElementPtr expression");
1992 if (Constant *FC = ConstantFoldGetElementPtr(C, InBounds, Idxs))
1993 return FC; // Fold a few common cases.
1995 // Get the result type of the getelementptr!
1996 Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), Idxs);
1997 assert(Ty && "GEP indices invalid!");
1998 unsigned AS = C->getType()->getPointerAddressSpace();
1999 Type *ReqTy = Ty->getPointerTo(AS);
2000 if (VectorType *VecTy = dyn_cast<VectorType>(C->getType()))
2001 ReqTy = VectorType::get(ReqTy, VecTy->getNumElements());
2003 if (OnlyIfReducedTy == ReqTy)
2006 // Look up the constant in the table first to ensure uniqueness
2007 std::vector<Constant*> ArgVec;
2008 ArgVec.reserve(1 + Idxs.size());
2009 ArgVec.push_back(C);
2010 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2011 assert(Idxs[i]->getType()->isVectorTy() == ReqTy->isVectorTy() &&
2012 "getelementptr index type missmatch");
2013 assert((!Idxs[i]->getType()->isVectorTy() ||
2014 ReqTy->getVectorNumElements() ==
2015 Idxs[i]->getType()->getVectorNumElements()) &&
2016 "getelementptr index type missmatch");
2017 ArgVec.push_back(cast<Constant>(Idxs[i]));
2019 const ConstantExprKeyType Key(Instruction::GetElementPtr, ArgVec, 0,
2020 InBounds ? GEPOperator::IsInBounds : 0);
2022 LLVMContextImpl *pImpl = C->getContext().pImpl;
2023 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2026 Constant *ConstantExpr::getICmp(unsigned short pred, Constant *LHS,
2027 Constant *RHS, bool OnlyIfReduced) {
2028 assert(LHS->getType() == RHS->getType());
2029 assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
2030 pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
2032 if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
2033 return FC; // Fold a few common cases...
2038 // Look up the constant in the table first to ensure uniqueness
2039 Constant *ArgVec[] = { LHS, RHS };
2040 // Get the key type with both the opcode and predicate
2041 const ConstantExprKeyType Key(Instruction::ICmp, ArgVec, pred);
2043 Type *ResultTy = Type::getInt1Ty(LHS->getContext());
2044 if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
2045 ResultTy = VectorType::get(ResultTy, VT->getNumElements());
2047 LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
2048 return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
2051 Constant *ConstantExpr::getFCmp(unsigned short pred, Constant *LHS,
2052 Constant *RHS, bool OnlyIfReduced) {
2053 assert(LHS->getType() == RHS->getType());
2054 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
2056 if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
2057 return FC; // Fold a few common cases...
2062 // Look up the constant in the table first to ensure uniqueness
2063 Constant *ArgVec[] = { LHS, RHS };
2064 // Get the key type with both the opcode and predicate
2065 const ConstantExprKeyType Key(Instruction::FCmp, ArgVec, pred);
2067 Type *ResultTy = Type::getInt1Ty(LHS->getContext());
2068 if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
2069 ResultTy = VectorType::get(ResultTy, VT->getNumElements());
2071 LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
2072 return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
2075 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx,
2076 Type *OnlyIfReducedTy) {
2077 assert(Val->getType()->isVectorTy() &&
2078 "Tried to create extractelement operation on non-vector type!");
2079 assert(Idx->getType()->isIntegerTy() &&
2080 "Extractelement index must be an integer type!");
2082 if (Constant *FC = ConstantFoldExtractElementInstruction(Val, Idx))
2083 return FC; // Fold a few common cases.
2085 Type *ReqTy = Val->getType()->getVectorElementType();
2086 if (OnlyIfReducedTy == ReqTy)
2089 // Look up the constant in the table first to ensure uniqueness
2090 Constant *ArgVec[] = { Val, Idx };
2091 const ConstantExprKeyType Key(Instruction::ExtractElement, ArgVec);
2093 LLVMContextImpl *pImpl = Val->getContext().pImpl;
2094 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2097 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
2098 Constant *Idx, Type *OnlyIfReducedTy) {
2099 assert(Val->getType()->isVectorTy() &&
2100 "Tried to create insertelement operation on non-vector type!");
2101 assert(Elt->getType() == Val->getType()->getVectorElementType() &&
2102 "Insertelement types must match!");
2103 assert(Idx->getType()->isIntegerTy() &&
2104 "Insertelement index must be i32 type!");
2106 if (Constant *FC = ConstantFoldInsertElementInstruction(Val, Elt, Idx))
2107 return FC; // Fold a few common cases.
2109 if (OnlyIfReducedTy == Val->getType())
2112 // Look up the constant in the table first to ensure uniqueness
2113 Constant *ArgVec[] = { Val, Elt, Idx };
2114 const ConstantExprKeyType Key(Instruction::InsertElement, ArgVec);
2116 LLVMContextImpl *pImpl = Val->getContext().pImpl;
2117 return pImpl->ExprConstants.getOrCreate(Val->getType(), Key);
2120 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
2121 Constant *Mask, Type *OnlyIfReducedTy) {
2122 assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
2123 "Invalid shuffle vector constant expr operands!");
2125 if (Constant *FC = ConstantFoldShuffleVectorInstruction(V1, V2, Mask))
2126 return FC; // Fold a few common cases.
2128 unsigned NElts = Mask->getType()->getVectorNumElements();
2129 Type *EltTy = V1->getType()->getVectorElementType();
2130 Type *ShufTy = VectorType::get(EltTy, NElts);
2132 if (OnlyIfReducedTy == ShufTy)
2135 // Look up the constant in the table first to ensure uniqueness
2136 Constant *ArgVec[] = { V1, V2, Mask };
2137 const ConstantExprKeyType Key(Instruction::ShuffleVector, ArgVec);
2139 LLVMContextImpl *pImpl = ShufTy->getContext().pImpl;
2140 return pImpl->ExprConstants.getOrCreate(ShufTy, Key);
2143 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
2144 ArrayRef<unsigned> Idxs,
2145 Type *OnlyIfReducedTy) {
2146 assert(Agg->getType()->isFirstClassType() &&
2147 "Non-first-class type for constant insertvalue expression");
2149 assert(ExtractValueInst::getIndexedType(Agg->getType(),
2150 Idxs) == Val->getType() &&
2151 "insertvalue indices invalid!");
2152 Type *ReqTy = Val->getType();
2154 if (Constant *FC = ConstantFoldInsertValueInstruction(Agg, Val, Idxs))
2157 if (OnlyIfReducedTy == ReqTy)
2160 Constant *ArgVec[] = { Agg, Val };
2161 const ConstantExprKeyType Key(Instruction::InsertValue, ArgVec, 0, 0, Idxs);
2163 LLVMContextImpl *pImpl = Agg->getContext().pImpl;
2164 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2167 Constant *ConstantExpr::getExtractValue(Constant *Agg, ArrayRef<unsigned> Idxs,
2168 Type *OnlyIfReducedTy) {
2169 assert(Agg->getType()->isFirstClassType() &&
2170 "Tried to create extractelement operation on non-first-class type!");
2172 Type *ReqTy = ExtractValueInst::getIndexedType(Agg->getType(), Idxs);
2174 assert(ReqTy && "extractvalue indices invalid!");
2176 assert(Agg->getType()->isFirstClassType() &&
2177 "Non-first-class type for constant extractvalue expression");
2178 if (Constant *FC = ConstantFoldExtractValueInstruction(Agg, Idxs))
2181 if (OnlyIfReducedTy == ReqTy)
2184 Constant *ArgVec[] = { Agg };
2185 const ConstantExprKeyType Key(Instruction::ExtractValue, ArgVec, 0, 0, Idxs);
2187 LLVMContextImpl *pImpl = Agg->getContext().pImpl;
2188 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2191 Constant *ConstantExpr::getNeg(Constant *C, bool HasNUW, bool HasNSW) {
2192 assert(C->getType()->isIntOrIntVectorTy() &&
2193 "Cannot NEG a nonintegral value!");
2194 return getSub(ConstantFP::getZeroValueForNegation(C->getType()),
2198 Constant *ConstantExpr::getFNeg(Constant *C) {
2199 assert(C->getType()->isFPOrFPVectorTy() &&
2200 "Cannot FNEG a non-floating-point value!");
2201 return getFSub(ConstantFP::getZeroValueForNegation(C->getType()), C);
2204 Constant *ConstantExpr::getNot(Constant *C) {
2205 assert(C->getType()->isIntOrIntVectorTy() &&
2206 "Cannot NOT a nonintegral value!");
2207 return get(Instruction::Xor, C, Constant::getAllOnesValue(C->getType()));
2210 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2,
2211 bool HasNUW, bool HasNSW) {
2212 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2213 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2214 return get(Instruction::Add, C1, C2, Flags);
2217 Constant *ConstantExpr::getFAdd(Constant *C1, Constant *C2) {
2218 return get(Instruction::FAdd, C1, C2);
2221 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2,
2222 bool HasNUW, bool HasNSW) {
2223 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2224 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2225 return get(Instruction::Sub, C1, C2, Flags);
2228 Constant *ConstantExpr::getFSub(Constant *C1, Constant *C2) {
2229 return get(Instruction::FSub, C1, C2);
2232 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2,
2233 bool HasNUW, bool HasNSW) {
2234 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2235 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2236 return get(Instruction::Mul, C1, C2, Flags);
2239 Constant *ConstantExpr::getFMul(Constant *C1, Constant *C2) {
2240 return get(Instruction::FMul, C1, C2);
2243 Constant *ConstantExpr::getUDiv(Constant *C1, Constant *C2, bool isExact) {
2244 return get(Instruction::UDiv, C1, C2,
2245 isExact ? PossiblyExactOperator::IsExact : 0);
2248 Constant *ConstantExpr::getSDiv(Constant *C1, Constant *C2, bool isExact) {
2249 return get(Instruction::SDiv, C1, C2,
2250 isExact ? PossiblyExactOperator::IsExact : 0);
2253 Constant *ConstantExpr::getFDiv(Constant *C1, Constant *C2) {
2254 return get(Instruction::FDiv, C1, C2);
2257 Constant *ConstantExpr::getURem(Constant *C1, Constant *C2) {
2258 return get(Instruction::URem, C1, C2);
2261 Constant *ConstantExpr::getSRem(Constant *C1, Constant *C2) {
2262 return get(Instruction::SRem, C1, C2);
2265 Constant *ConstantExpr::getFRem(Constant *C1, Constant *C2) {
2266 return get(Instruction::FRem, C1, C2);
2269 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
2270 return get(Instruction::And, C1, C2);
2273 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
2274 return get(Instruction::Or, C1, C2);
2277 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
2278 return get(Instruction::Xor, C1, C2);
2281 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2,
2282 bool HasNUW, bool HasNSW) {
2283 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2284 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2285 return get(Instruction::Shl, C1, C2, Flags);
2288 Constant *ConstantExpr::getLShr(Constant *C1, Constant *C2, bool isExact) {
2289 return get(Instruction::LShr, C1, C2,
2290 isExact ? PossiblyExactOperator::IsExact : 0);
2293 Constant *ConstantExpr::getAShr(Constant *C1, Constant *C2, bool isExact) {
2294 return get(Instruction::AShr, C1, C2,
2295 isExact ? PossiblyExactOperator::IsExact : 0);
2298 /// getBinOpIdentity - Return the identity for the given binary operation,
2299 /// i.e. a constant C such that X op C = X and C op X = X for every X. It
2300 /// returns null if the operator doesn't have an identity.
2301 Constant *ConstantExpr::getBinOpIdentity(unsigned Opcode, Type *Ty) {
2304 // Doesn't have an identity.
2307 case Instruction::Add:
2308 case Instruction::Or:
2309 case Instruction::Xor:
2310 return Constant::getNullValue(Ty);
2312 case Instruction::Mul:
2313 return ConstantInt::get(Ty, 1);
2315 case Instruction::And:
2316 return Constant::getAllOnesValue(Ty);
2320 /// getBinOpAbsorber - Return the absorbing element for the given binary
2321 /// operation, i.e. a constant C such that X op C = C and C op X = C for
2322 /// every X. For example, this returns zero for integer multiplication.
2323 /// It returns null if the operator doesn't have an absorbing element.
2324 Constant *ConstantExpr::getBinOpAbsorber(unsigned Opcode, Type *Ty) {
2327 // Doesn't have an absorber.
2330 case Instruction::Or:
2331 return Constant::getAllOnesValue(Ty);
2333 case Instruction::And:
2334 case Instruction::Mul:
2335 return Constant::getNullValue(Ty);
2339 // destroyConstant - Remove the constant from the constant table...
2341 void ConstantExpr::destroyConstant() {
2342 getType()->getContext().pImpl->ExprConstants.remove(this);
2343 destroyConstantImpl();
2346 const char *ConstantExpr::getOpcodeName() const {
2347 return Instruction::getOpcodeName(getOpcode());
2352 GetElementPtrConstantExpr::
2353 GetElementPtrConstantExpr(Constant *C, ArrayRef<Constant*> IdxList,
2355 : ConstantExpr(DestTy, Instruction::GetElementPtr,
2356 OperandTraits<GetElementPtrConstantExpr>::op_end(this)
2357 - (IdxList.size()+1), IdxList.size()+1) {
2359 for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
2360 OperandList[i+1] = IdxList[i];
2363 //===----------------------------------------------------------------------===//
2364 // ConstantData* implementations
2366 void ConstantDataArray::anchor() {}
2367 void ConstantDataVector::anchor() {}
2369 /// getElementType - Return the element type of the array/vector.
2370 Type *ConstantDataSequential::getElementType() const {
2371 return getType()->getElementType();
2374 StringRef ConstantDataSequential::getRawDataValues() const {
2375 return StringRef(DataElements, getNumElements()*getElementByteSize());
2378 /// isElementTypeCompatible - Return true if a ConstantDataSequential can be
2379 /// formed with a vector or array of the specified element type.
2380 /// ConstantDataArray only works with normal float and int types that are
2381 /// stored densely in memory, not with things like i42 or x86_f80.
2382 bool ConstantDataSequential::isElementTypeCompatible(const Type *Ty) {
2383 if (Ty->isFloatTy() || Ty->isDoubleTy()) return true;
2384 if (const IntegerType *IT = dyn_cast<IntegerType>(Ty)) {
2385 switch (IT->getBitWidth()) {
2397 /// getNumElements - Return the number of elements in the array or vector.
2398 unsigned ConstantDataSequential::getNumElements() const {
2399 if (ArrayType *AT = dyn_cast<ArrayType>(getType()))
2400 return AT->getNumElements();
2401 return getType()->getVectorNumElements();
2405 /// getElementByteSize - Return the size in bytes of the elements in the data.
2406 uint64_t ConstantDataSequential::getElementByteSize() const {
2407 return getElementType()->getPrimitiveSizeInBits()/8;
2410 /// getElementPointer - Return the start of the specified element.
2411 const char *ConstantDataSequential::getElementPointer(unsigned Elt) const {
2412 assert(Elt < getNumElements() && "Invalid Elt");
2413 return DataElements+Elt*getElementByteSize();
2417 /// isAllZeros - return true if the array is empty or all zeros.
2418 static bool isAllZeros(StringRef Arr) {
2419 for (StringRef::iterator I = Arr.begin(), E = Arr.end(); I != E; ++I)
2425 /// getImpl - This is the underlying implementation of all of the
2426 /// ConstantDataSequential::get methods. They all thunk down to here, providing
2427 /// the correct element type. We take the bytes in as a StringRef because
2428 /// we *want* an underlying "char*" to avoid TBAA type punning violations.
2429 Constant *ConstantDataSequential::getImpl(StringRef Elements, Type *Ty) {
2430 assert(isElementTypeCompatible(Ty->getSequentialElementType()));
2431 // If the elements are all zero or there are no elements, return a CAZ, which
2432 // is more dense and canonical.
2433 if (isAllZeros(Elements))
2434 return ConstantAggregateZero::get(Ty);
2436 // Do a lookup to see if we have already formed one of these.
2439 .pImpl->CDSConstants.insert(std::make_pair(Elements, nullptr))
2442 // The bucket can point to a linked list of different CDS's that have the same
2443 // body but different types. For example, 0,0,0,1 could be a 4 element array
2444 // of i8, or a 1-element array of i32. They'll both end up in the same
2445 /// StringMap bucket, linked up by their Next pointers. Walk the list.
2446 ConstantDataSequential **Entry = &Slot.second;
2447 for (ConstantDataSequential *Node = *Entry; Node;
2448 Entry = &Node->Next, Node = *Entry)
2449 if (Node->getType() == Ty)
2452 // Okay, we didn't get a hit. Create a node of the right class, link it in,
2454 if (isa<ArrayType>(Ty))
2455 return *Entry = new ConstantDataArray(Ty, Slot.first().data());
2457 assert(isa<VectorType>(Ty));
2458 return *Entry = new ConstantDataVector(Ty, Slot.first().data());
2461 void ConstantDataSequential::destroyConstant() {
2462 // Remove the constant from the StringMap.
2463 StringMap<ConstantDataSequential*> &CDSConstants =
2464 getType()->getContext().pImpl->CDSConstants;
2466 StringMap<ConstantDataSequential*>::iterator Slot =
2467 CDSConstants.find(getRawDataValues());
2469 assert(Slot != CDSConstants.end() && "CDS not found in uniquing table");
2471 ConstantDataSequential **Entry = &Slot->getValue();
2473 // Remove the entry from the hash table.
2474 if (!(*Entry)->Next) {
2475 // If there is only one value in the bucket (common case) it must be this
2476 // entry, and removing the entry should remove the bucket completely.
2477 assert((*Entry) == this && "Hash mismatch in ConstantDataSequential");
2478 getContext().pImpl->CDSConstants.erase(Slot);
2480 // Otherwise, there are multiple entries linked off the bucket, unlink the
2481 // node we care about but keep the bucket around.
2482 for (ConstantDataSequential *Node = *Entry; ;
2483 Entry = &Node->Next, Node = *Entry) {
2484 assert(Node && "Didn't find entry in its uniquing hash table!");
2485 // If we found our entry, unlink it from the list and we're done.
2487 *Entry = Node->Next;
2493 // If we were part of a list, make sure that we don't delete the list that is
2494 // still owned by the uniquing map.
2497 // Finally, actually delete it.
2498 destroyConstantImpl();
2501 /// get() constructors - Return a constant with array type with an element
2502 /// count and element type matching the ArrayRef passed in. Note that this
2503 /// can return a ConstantAggregateZero object.
2504 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint8_t> Elts) {
2505 Type *Ty = ArrayType::get(Type::getInt8Ty(Context), Elts.size());
2506 const char *Data = reinterpret_cast<const char *>(Elts.data());
2507 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*1), Ty);
2509 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint16_t> Elts){
2510 Type *Ty = ArrayType::get(Type::getInt16Ty(Context), Elts.size());
2511 const char *Data = reinterpret_cast<const char *>(Elts.data());
2512 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*2), Ty);
2514 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint32_t> Elts){
2515 Type *Ty = ArrayType::get(Type::getInt32Ty(Context), Elts.size());
2516 const char *Data = reinterpret_cast<const char *>(Elts.data());
2517 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2519 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint64_t> Elts){
2520 Type *Ty = ArrayType::get(Type::getInt64Ty(Context), Elts.size());
2521 const char *Data = reinterpret_cast<const char *>(Elts.data());
2522 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2524 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<float> Elts) {
2525 Type *Ty = ArrayType::get(Type::getFloatTy(Context), Elts.size());
2526 const char *Data = reinterpret_cast<const char *>(Elts.data());
2527 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2529 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<double> Elts) {
2530 Type *Ty = ArrayType::get(Type::getDoubleTy(Context), Elts.size());
2531 const char *Data = reinterpret_cast<const char *>(Elts.data());
2532 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2535 /// getString - This method constructs a CDS and initializes it with a text
2536 /// string. The default behavior (AddNull==true) causes a null terminator to
2537 /// be placed at the end of the array (increasing the length of the string by
2538 /// one more than the StringRef would normally indicate. Pass AddNull=false
2539 /// to disable this behavior.
2540 Constant *ConstantDataArray::getString(LLVMContext &Context,
2541 StringRef Str, bool AddNull) {
2543 const uint8_t *Data = reinterpret_cast<const uint8_t *>(Str.data());
2544 return get(Context, makeArrayRef(const_cast<uint8_t *>(Data),
2548 SmallVector<uint8_t, 64> ElementVals;
2549 ElementVals.append(Str.begin(), Str.end());
2550 ElementVals.push_back(0);
2551 return get(Context, ElementVals);
2554 /// get() constructors - Return a constant with vector type with an element
2555 /// count and element type matching the ArrayRef passed in. Note that this
2556 /// can return a ConstantAggregateZero object.
2557 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint8_t> Elts){
2558 Type *Ty = VectorType::get(Type::getInt8Ty(Context), Elts.size());
2559 const char *Data = reinterpret_cast<const char *>(Elts.data());
2560 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*1), Ty);
2562 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint16_t> Elts){
2563 Type *Ty = VectorType::get(Type::getInt16Ty(Context), Elts.size());
2564 const char *Data = reinterpret_cast<const char *>(Elts.data());
2565 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*2), Ty);
2567 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint32_t> Elts){
2568 Type *Ty = VectorType::get(Type::getInt32Ty(Context), Elts.size());
2569 const char *Data = reinterpret_cast<const char *>(Elts.data());
2570 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2572 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint64_t> Elts){
2573 Type *Ty = VectorType::get(Type::getInt64Ty(Context), Elts.size());
2574 const char *Data = reinterpret_cast<const char *>(Elts.data());
2575 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2577 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<float> Elts) {
2578 Type *Ty = VectorType::get(Type::getFloatTy(Context), Elts.size());
2579 const char *Data = reinterpret_cast<const char *>(Elts.data());
2580 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2582 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<double> Elts) {
2583 Type *Ty = VectorType::get(Type::getDoubleTy(Context), Elts.size());
2584 const char *Data = reinterpret_cast<const char *>(Elts.data());
2585 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2588 Constant *ConstantDataVector::getSplat(unsigned NumElts, Constant *V) {
2589 assert(isElementTypeCompatible(V->getType()) &&
2590 "Element type not compatible with ConstantData");
2591 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
2592 if (CI->getType()->isIntegerTy(8)) {
2593 SmallVector<uint8_t, 16> Elts(NumElts, CI->getZExtValue());
2594 return get(V->getContext(), Elts);
2596 if (CI->getType()->isIntegerTy(16)) {
2597 SmallVector<uint16_t, 16> Elts(NumElts, CI->getZExtValue());
2598 return get(V->getContext(), Elts);
2600 if (CI->getType()->isIntegerTy(32)) {
2601 SmallVector<uint32_t, 16> Elts(NumElts, CI->getZExtValue());
2602 return get(V->getContext(), Elts);
2604 assert(CI->getType()->isIntegerTy(64) && "Unsupported ConstantData type");
2605 SmallVector<uint64_t, 16> Elts(NumElts, CI->getZExtValue());
2606 return get(V->getContext(), Elts);
2609 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2610 if (CFP->getType()->isFloatTy()) {
2611 SmallVector<float, 16> Elts(NumElts, CFP->getValueAPF().convertToFloat());
2612 return get(V->getContext(), Elts);
2614 if (CFP->getType()->isDoubleTy()) {
2615 SmallVector<double, 16> Elts(NumElts,
2616 CFP->getValueAPF().convertToDouble());
2617 return get(V->getContext(), Elts);
2620 return ConstantVector::getSplat(NumElts, V);
2624 /// getElementAsInteger - If this is a sequential container of integers (of
2625 /// any size), return the specified element in the low bits of a uint64_t.
2626 uint64_t ConstantDataSequential::getElementAsInteger(unsigned Elt) const {
2627 assert(isa<IntegerType>(getElementType()) &&
2628 "Accessor can only be used when element is an integer");
2629 const char *EltPtr = getElementPointer(Elt);
2631 // The data is stored in host byte order, make sure to cast back to the right
2632 // type to load with the right endianness.
2633 switch (getElementType()->getIntegerBitWidth()) {
2634 default: llvm_unreachable("Invalid bitwidth for CDS");
2636 return *const_cast<uint8_t *>(reinterpret_cast<const uint8_t *>(EltPtr));
2638 return *const_cast<uint16_t *>(reinterpret_cast<const uint16_t *>(EltPtr));
2640 return *const_cast<uint32_t *>(reinterpret_cast<const uint32_t *>(EltPtr));
2642 return *const_cast<uint64_t *>(reinterpret_cast<const uint64_t *>(EltPtr));
2646 /// getElementAsAPFloat - If this is a sequential container of floating point
2647 /// type, return the specified element as an APFloat.
2648 APFloat ConstantDataSequential::getElementAsAPFloat(unsigned Elt) const {
2649 const char *EltPtr = getElementPointer(Elt);
2651 switch (getElementType()->getTypeID()) {
2653 llvm_unreachable("Accessor can only be used when element is float/double!");
2654 case Type::FloatTyID: {
2655 const float *FloatPrt = reinterpret_cast<const float *>(EltPtr);
2656 return APFloat(*const_cast<float *>(FloatPrt));
2658 case Type::DoubleTyID: {
2659 const double *DoublePtr = reinterpret_cast<const double *>(EltPtr);
2660 return APFloat(*const_cast<double *>(DoublePtr));
2665 /// getElementAsFloat - If this is an sequential container of floats, return
2666 /// the specified element as a float.
2667 float ConstantDataSequential::getElementAsFloat(unsigned Elt) const {
2668 assert(getElementType()->isFloatTy() &&
2669 "Accessor can only be used when element is a 'float'");
2670 const float *EltPtr = reinterpret_cast<const float *>(getElementPointer(Elt));
2671 return *const_cast<float *>(EltPtr);
2674 /// getElementAsDouble - If this is an sequential container of doubles, return
2675 /// the specified element as a float.
2676 double ConstantDataSequential::getElementAsDouble(unsigned Elt) const {
2677 assert(getElementType()->isDoubleTy() &&
2678 "Accessor can only be used when element is a 'float'");
2679 const double *EltPtr =
2680 reinterpret_cast<const double *>(getElementPointer(Elt));
2681 return *const_cast<double *>(EltPtr);
2684 /// getElementAsConstant - Return a Constant for a specified index's element.
2685 /// Note that this has to compute a new constant to return, so it isn't as
2686 /// efficient as getElementAsInteger/Float/Double.
2687 Constant *ConstantDataSequential::getElementAsConstant(unsigned Elt) const {
2688 if (getElementType()->isFloatTy() || getElementType()->isDoubleTy())
2689 return ConstantFP::get(getContext(), getElementAsAPFloat(Elt));
2691 return ConstantInt::get(getElementType(), getElementAsInteger(Elt));
2694 /// isString - This method returns true if this is an array of i8.
2695 bool ConstantDataSequential::isString() const {
2696 return isa<ArrayType>(getType()) && getElementType()->isIntegerTy(8);
2699 /// isCString - This method returns true if the array "isString", ends with a
2700 /// nul byte, and does not contains any other nul bytes.
2701 bool ConstantDataSequential::isCString() const {
2705 StringRef Str = getAsString();
2707 // The last value must be nul.
2708 if (Str.back() != 0) return false;
2710 // Other elements must be non-nul.
2711 return Str.drop_back().find(0) == StringRef::npos;
2714 /// getSplatValue - If this is a splat constant, meaning that all of the
2715 /// elements have the same value, return that value. Otherwise return nullptr.
2716 Constant *ConstantDataVector::getSplatValue() const {
2717 const char *Base = getRawDataValues().data();
2719 // Compare elements 1+ to the 0'th element.
2720 unsigned EltSize = getElementByteSize();
2721 for (unsigned i = 1, e = getNumElements(); i != e; ++i)
2722 if (memcmp(Base, Base+i*EltSize, EltSize))
2725 // If they're all the same, return the 0th one as a representative.
2726 return getElementAsConstant(0);
2729 //===----------------------------------------------------------------------===//
2730 // replaceUsesOfWithOnConstant implementations
2732 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2733 /// 'From' to be uses of 'To'. This must update the uniquing data structures
2736 /// Note that we intentionally replace all uses of From with To here. Consider
2737 /// a large array that uses 'From' 1000 times. By handling this case all here,
2738 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2739 /// single invocation handles all 1000 uses. Handling them one at a time would
2740 /// work, but would be really slow because it would have to unique each updated
2743 void Constant::replaceUsesOfWithOnConstantImpl(Constant *Replacement) {
2744 // I do need to replace this with an existing value.
2745 assert(Replacement != this && "I didn't contain From!");
2747 // Everyone using this now uses the replacement.
2748 replaceAllUsesWith(Replacement);
2750 // Delete the old constant!
2754 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2756 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2757 Constant *ToC = cast<Constant>(To);
2759 SmallVector<Constant*, 8> Values;
2760 Values.reserve(getNumOperands()); // Build replacement array.
2762 // Fill values with the modified operands of the constant array. Also,
2763 // compute whether this turns into an all-zeros array.
2764 unsigned NumUpdated = 0;
2766 // Keep track of whether all the values in the array are "ToC".
2767 bool AllSame = true;
2768 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2769 Constant *Val = cast<Constant>(O->get());
2774 Values.push_back(Val);
2775 AllSame &= Val == ToC;
2778 if (AllSame && ToC->isNullValue()) {
2779 replaceUsesOfWithOnConstantImpl(ConstantAggregateZero::get(getType()));
2782 if (AllSame && isa<UndefValue>(ToC)) {
2783 replaceUsesOfWithOnConstantImpl(UndefValue::get(getType()));
2787 // Check for any other type of constant-folding.
2788 if (Constant *C = getImpl(getType(), Values)) {
2789 replaceUsesOfWithOnConstantImpl(C);
2793 // Update to the new value.
2794 if (Constant *C = getContext().pImpl->ArrayConstants.replaceOperandsInPlace(
2795 Values, this, From, ToC, NumUpdated, U - OperandList))
2796 replaceUsesOfWithOnConstantImpl(C);
2799 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2801 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2802 Constant *ToC = cast<Constant>(To);
2804 unsigned OperandToUpdate = U-OperandList;
2805 assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2807 SmallVector<Constant*, 8> Values;
2808 Values.reserve(getNumOperands()); // Build replacement struct.
2810 // Fill values with the modified operands of the constant struct. Also,
2811 // compute whether this turns into an all-zeros struct.
2812 bool isAllZeros = false;
2813 bool isAllUndef = false;
2814 if (ToC->isNullValue()) {
2816 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2817 Constant *Val = cast<Constant>(O->get());
2818 Values.push_back(Val);
2819 if (isAllZeros) isAllZeros = Val->isNullValue();
2821 } else if (isa<UndefValue>(ToC)) {
2823 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2824 Constant *Val = cast<Constant>(O->get());
2825 Values.push_back(Val);
2826 if (isAllUndef) isAllUndef = isa<UndefValue>(Val);
2829 for (Use *O = OperandList, *E = OperandList + getNumOperands(); O != E; ++O)
2830 Values.push_back(cast<Constant>(O->get()));
2832 Values[OperandToUpdate] = ToC;
2835 replaceUsesOfWithOnConstantImpl(ConstantAggregateZero::get(getType()));
2839 replaceUsesOfWithOnConstantImpl(UndefValue::get(getType()));
2843 // Update to the new value.
2844 if (Constant *C = getContext().pImpl->StructConstants.replaceOperandsInPlace(
2845 Values, this, From, ToC))
2846 replaceUsesOfWithOnConstantImpl(C);
2849 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2851 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2852 Constant *ToC = cast<Constant>(To);
2854 SmallVector<Constant*, 8> Values;
2855 Values.reserve(getNumOperands()); // Build replacement array...
2856 unsigned NumUpdated = 0;
2857 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2858 Constant *Val = getOperand(i);
2863 Values.push_back(Val);
2866 if (Constant *C = getImpl(Values)) {
2867 replaceUsesOfWithOnConstantImpl(C);
2871 // Update to the new value.
2872 if (Constant *C = getContext().pImpl->VectorConstants.replaceOperandsInPlace(
2873 Values, this, From, ToC, NumUpdated, U - OperandList))
2874 replaceUsesOfWithOnConstantImpl(C);
2877 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2879 assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2880 Constant *To = cast<Constant>(ToV);
2882 SmallVector<Constant*, 8> NewOps;
2883 unsigned NumUpdated = 0;
2884 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2885 Constant *Op = getOperand(i);
2890 NewOps.push_back(Op);
2892 assert(NumUpdated && "I didn't contain From!");
2894 if (Constant *C = getWithOperands(NewOps, getType(), true)) {
2895 replaceUsesOfWithOnConstantImpl(C);
2899 // Update to the new value.
2900 if (Constant *C = getContext().pImpl->ExprConstants.replaceOperandsInPlace(
2901 NewOps, this, From, To, NumUpdated, U - OperandList))
2902 replaceUsesOfWithOnConstantImpl(C);
2905 Instruction *ConstantExpr::getAsInstruction() {
2906 SmallVector<Value*,4> ValueOperands;
2907 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
2908 ValueOperands.push_back(cast<Value>(I));
2910 ArrayRef<Value*> Ops(ValueOperands);
2912 switch (getOpcode()) {
2913 case Instruction::Trunc:
2914 case Instruction::ZExt:
2915 case Instruction::SExt:
2916 case Instruction::FPTrunc:
2917 case Instruction::FPExt:
2918 case Instruction::UIToFP:
2919 case Instruction::SIToFP:
2920 case Instruction::FPToUI:
2921 case Instruction::FPToSI:
2922 case Instruction::PtrToInt:
2923 case Instruction::IntToPtr:
2924 case Instruction::BitCast:
2925 case Instruction::AddrSpaceCast:
2926 return CastInst::Create((Instruction::CastOps)getOpcode(),
2928 case Instruction::Select:
2929 return SelectInst::Create(Ops[0], Ops[1], Ops[2]);
2930 case Instruction::InsertElement:
2931 return InsertElementInst::Create(Ops[0], Ops[1], Ops[2]);
2932 case Instruction::ExtractElement:
2933 return ExtractElementInst::Create(Ops[0], Ops[1]);
2934 case Instruction::InsertValue:
2935 return InsertValueInst::Create(Ops[0], Ops[1], getIndices());
2936 case Instruction::ExtractValue:
2937 return ExtractValueInst::Create(Ops[0], getIndices());
2938 case Instruction::ShuffleVector:
2939 return new ShuffleVectorInst(Ops[0], Ops[1], Ops[2]);
2941 case Instruction::GetElementPtr:
2942 if (cast<GEPOperator>(this)->isInBounds())
2943 return GetElementPtrInst::CreateInBounds(Ops[0], Ops.slice(1));
2945 return GetElementPtrInst::Create(Ops[0], Ops.slice(1));
2947 case Instruction::ICmp:
2948 case Instruction::FCmp:
2949 return CmpInst::Create((Instruction::OtherOps)getOpcode(),
2950 getPredicate(), Ops[0], Ops[1]);
2953 assert(getNumOperands() == 2 && "Must be binary operator?");
2954 BinaryOperator *BO =
2955 BinaryOperator::Create((Instruction::BinaryOps)getOpcode(),
2957 if (isa<OverflowingBinaryOperator>(BO)) {
2958 BO->setHasNoUnsignedWrap(SubclassOptionalData &
2959 OverflowingBinaryOperator::NoUnsignedWrap);
2960 BO->setHasNoSignedWrap(SubclassOptionalData &
2961 OverflowingBinaryOperator::NoSignedWrap);
2963 if (isa<PossiblyExactOperator>(BO))
2964 BO->setIsExact(SubclassOptionalData & PossiblyExactOperator::IsExact);