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 // Constructor to create a '0' constant of arbitrary type...
155 Constant *Constant::getNullValue(Type *Ty) {
156 switch (Ty->getTypeID()) {
157 case Type::IntegerTyID:
158 return ConstantInt::get(Ty, 0);
160 return ConstantFP::get(Ty->getContext(),
161 APFloat::getZero(APFloat::IEEEhalf));
162 case Type::FloatTyID:
163 return ConstantFP::get(Ty->getContext(),
164 APFloat::getZero(APFloat::IEEEsingle));
165 case Type::DoubleTyID:
166 return ConstantFP::get(Ty->getContext(),
167 APFloat::getZero(APFloat::IEEEdouble));
168 case Type::X86_FP80TyID:
169 return ConstantFP::get(Ty->getContext(),
170 APFloat::getZero(APFloat::x87DoubleExtended));
171 case Type::FP128TyID:
172 return ConstantFP::get(Ty->getContext(),
173 APFloat::getZero(APFloat::IEEEquad));
174 case Type::PPC_FP128TyID:
175 return ConstantFP::get(Ty->getContext(),
176 APFloat(APFloat::PPCDoubleDouble,
177 APInt::getNullValue(128)));
178 case Type::PointerTyID:
179 return ConstantPointerNull::get(cast<PointerType>(Ty));
180 case Type::StructTyID:
181 case Type::ArrayTyID:
182 case Type::VectorTyID:
183 return ConstantAggregateZero::get(Ty);
185 // Function, Label, or Opaque type?
186 llvm_unreachable("Cannot create a null constant of that type!");
190 Constant *Constant::getIntegerValue(Type *Ty, const APInt &V) {
191 Type *ScalarTy = Ty->getScalarType();
193 // Create the base integer constant.
194 Constant *C = ConstantInt::get(Ty->getContext(), V);
196 // Convert an integer to a pointer, if necessary.
197 if (PointerType *PTy = dyn_cast<PointerType>(ScalarTy))
198 C = ConstantExpr::getIntToPtr(C, PTy);
200 // Broadcast a scalar to a vector, if necessary.
201 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
202 C = ConstantVector::getSplat(VTy->getNumElements(), C);
207 Constant *Constant::getAllOnesValue(Type *Ty) {
208 if (IntegerType *ITy = dyn_cast<IntegerType>(Ty))
209 return ConstantInt::get(Ty->getContext(),
210 APInt::getAllOnesValue(ITy->getBitWidth()));
212 if (Ty->isFloatingPointTy()) {
213 APFloat FL = APFloat::getAllOnesValue(Ty->getPrimitiveSizeInBits(),
214 !Ty->isPPC_FP128Ty());
215 return ConstantFP::get(Ty->getContext(), FL);
218 VectorType *VTy = cast<VectorType>(Ty);
219 return ConstantVector::getSplat(VTy->getNumElements(),
220 getAllOnesValue(VTy->getElementType()));
223 /// getAggregateElement - For aggregates (struct/array/vector) return the
224 /// constant that corresponds to the specified element if possible, or null if
225 /// not. This can return null if the element index is a ConstantExpr, or if
226 /// 'this' is a constant expr.
227 Constant *Constant::getAggregateElement(unsigned Elt) const {
228 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(this))
229 return Elt < CS->getNumOperands() ? CS->getOperand(Elt) : nullptr;
231 if (const ConstantArray *CA = dyn_cast<ConstantArray>(this))
232 return Elt < CA->getNumOperands() ? CA->getOperand(Elt) : nullptr;
234 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
235 return Elt < CV->getNumOperands() ? CV->getOperand(Elt) : nullptr;
237 if (const ConstantAggregateZero *CAZ =dyn_cast<ConstantAggregateZero>(this))
238 return CAZ->getElementValue(Elt);
240 if (const UndefValue *UV = dyn_cast<UndefValue>(this))
241 return UV->getElementValue(Elt);
243 if (const ConstantDataSequential *CDS =dyn_cast<ConstantDataSequential>(this))
244 return Elt < CDS->getNumElements() ? CDS->getElementAsConstant(Elt)
249 Constant *Constant::getAggregateElement(Constant *Elt) const {
250 assert(isa<IntegerType>(Elt->getType()) && "Index must be an integer");
251 if (ConstantInt *CI = dyn_cast<ConstantInt>(Elt))
252 return getAggregateElement(CI->getZExtValue());
257 void Constant::destroyConstantImpl() {
258 // When a Constant is destroyed, there may be lingering
259 // references to the constant by other constants in the constant pool. These
260 // constants are implicitly dependent on the module that is being deleted,
261 // but they don't know that. Because we only find out when the CPV is
262 // deleted, we must now notify all of our users (that should only be
263 // Constants) that they are, in fact, invalid now and should be deleted.
265 while (!use_empty()) {
266 Value *V = user_back();
267 #ifndef NDEBUG // Only in -g mode...
268 if (!isa<Constant>(V)) {
269 dbgs() << "While deleting: " << *this
270 << "\n\nUse still stuck around after Def is destroyed: "
274 assert(isa<Constant>(V) && "References remain to Constant being destroyed");
275 cast<Constant>(V)->destroyConstant();
277 // The constant should remove itself from our use list...
278 assert((use_empty() || user_back() != V) && "Constant not removed!");
281 // Value has no outstanding references it is safe to delete it now...
285 static bool canTrapImpl(const Constant *C,
286 SmallPtrSet<const ConstantExpr *, 4> &NonTrappingOps) {
287 assert(C->getType()->isFirstClassType() && "Cannot evaluate aggregate vals!");
288 // The only thing that could possibly trap are constant exprs.
289 const ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
293 // ConstantExpr traps if any operands can trap.
294 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
295 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(CE->getOperand(i))) {
296 if (NonTrappingOps.insert(Op) && canTrapImpl(Op, NonTrappingOps))
301 // Otherwise, only specific operations can trap.
302 switch (CE->getOpcode()) {
305 case Instruction::UDiv:
306 case Instruction::SDiv:
307 case Instruction::FDiv:
308 case Instruction::URem:
309 case Instruction::SRem:
310 case Instruction::FRem:
311 // Div and rem can trap if the RHS is not known to be non-zero.
312 if (!isa<ConstantInt>(CE->getOperand(1)) ||CE->getOperand(1)->isNullValue())
318 /// canTrap - Return true if evaluation of this constant could trap. This is
319 /// true for things like constant expressions that could divide by zero.
320 bool Constant::canTrap() const {
321 SmallPtrSet<const ConstantExpr *, 4> NonTrappingOps;
322 return canTrapImpl(this, NonTrappingOps);
325 /// Check if C contains a GlobalValue for which Predicate is true.
327 ConstHasGlobalValuePredicate(const Constant *C,
328 bool (*Predicate)(const GlobalValue *)) {
329 SmallPtrSet<const Constant *, 8> Visited;
330 SmallVector<const Constant *, 8> WorkList;
331 WorkList.push_back(C);
334 while (!WorkList.empty()) {
335 const Constant *WorkItem = WorkList.pop_back_val();
336 if (const auto *GV = dyn_cast<GlobalValue>(WorkItem))
339 for (const Value *Op : WorkItem->operands()) {
340 const Constant *ConstOp = dyn_cast<Constant>(Op);
343 if (Visited.insert(ConstOp))
344 WorkList.push_back(ConstOp);
350 /// Return true if the value can vary between threads.
351 bool Constant::isThreadDependent() const {
352 auto DLLImportPredicate = [](const GlobalValue *GV) {
353 return GV->isThreadLocal();
355 return ConstHasGlobalValuePredicate(this, DLLImportPredicate);
358 bool Constant::isDLLImportDependent() const {
359 auto DLLImportPredicate = [](const GlobalValue *GV) {
360 return GV->hasDLLImportStorageClass();
362 return ConstHasGlobalValuePredicate(this, DLLImportPredicate);
365 /// Return true if the constant has users other than constant exprs and other
367 bool Constant::isConstantUsed() const {
368 for (const User *U : users()) {
369 const Constant *UC = dyn_cast<Constant>(U);
370 if (!UC || isa<GlobalValue>(UC))
373 if (UC->isConstantUsed())
381 /// getRelocationInfo - This method classifies the entry according to
382 /// whether or not it may generate a relocation entry. This must be
383 /// conservative, so if it might codegen to a relocatable entry, it should say
384 /// so. The return values are:
386 /// NoRelocation: This constant pool entry is guaranteed to never have a
387 /// relocation applied to it (because it holds a simple constant like
389 /// LocalRelocation: This entry has relocations, but the entries are
390 /// guaranteed to be resolvable by the static linker, so the dynamic
391 /// linker will never see them.
392 /// GlobalRelocations: This entry may have arbitrary relocations.
394 /// FIXME: This really should not be in IR.
395 Constant::PossibleRelocationsTy Constant::getRelocationInfo() const {
396 if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
397 if (GV->hasLocalLinkage() || GV->hasHiddenVisibility())
398 return LocalRelocation; // Local to this file/library.
399 return GlobalRelocations; // Global reference.
402 if (const BlockAddress *BA = dyn_cast<BlockAddress>(this))
403 return BA->getFunction()->getRelocationInfo();
405 // While raw uses of blockaddress need to be relocated, differences between
406 // two of them don't when they are for labels in the same function. This is a
407 // common idiom when creating a table for the indirect goto extension, so we
408 // handle it efficiently here.
409 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(this))
410 if (CE->getOpcode() == Instruction::Sub) {
411 ConstantExpr *LHS = dyn_cast<ConstantExpr>(CE->getOperand(0));
412 ConstantExpr *RHS = dyn_cast<ConstantExpr>(CE->getOperand(1));
414 LHS->getOpcode() == Instruction::PtrToInt &&
415 RHS->getOpcode() == Instruction::PtrToInt &&
416 isa<BlockAddress>(LHS->getOperand(0)) &&
417 isa<BlockAddress>(RHS->getOperand(0)) &&
418 cast<BlockAddress>(LHS->getOperand(0))->getFunction() ==
419 cast<BlockAddress>(RHS->getOperand(0))->getFunction())
423 PossibleRelocationsTy Result = NoRelocation;
424 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
425 Result = std::max(Result,
426 cast<Constant>(getOperand(i))->getRelocationInfo());
431 /// removeDeadUsersOfConstant - If the specified constantexpr is dead, remove
432 /// it. This involves recursively eliminating any dead users of the
434 static bool removeDeadUsersOfConstant(const Constant *C) {
435 if (isa<GlobalValue>(C)) return false; // Cannot remove this
437 while (!C->use_empty()) {
438 const Constant *User = dyn_cast<Constant>(C->user_back());
439 if (!User) return false; // Non-constant usage;
440 if (!removeDeadUsersOfConstant(User))
441 return false; // Constant wasn't dead
444 const_cast<Constant*>(C)->destroyConstant();
449 /// removeDeadConstantUsers - If there are any dead constant users dangling
450 /// off of this constant, remove them. This method is useful for clients
451 /// that want to check to see if a global is unused, but don't want to deal
452 /// with potentially dead constants hanging off of the globals.
453 void Constant::removeDeadConstantUsers() const {
454 Value::const_user_iterator I = user_begin(), E = user_end();
455 Value::const_user_iterator LastNonDeadUser = E;
457 const Constant *User = dyn_cast<Constant>(*I);
464 if (!removeDeadUsersOfConstant(User)) {
465 // If the constant wasn't dead, remember that this was the last live use
466 // and move on to the next constant.
472 // If the constant was dead, then the iterator is invalidated.
473 if (LastNonDeadUser == E) {
485 //===----------------------------------------------------------------------===//
487 //===----------------------------------------------------------------------===//
489 void ConstantInt::anchor() { }
491 ConstantInt::ConstantInt(IntegerType *Ty, const APInt& V)
492 : Constant(Ty, ConstantIntVal, nullptr, 0), Val(V) {
493 assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
496 ConstantInt *ConstantInt::getTrue(LLVMContext &Context) {
497 LLVMContextImpl *pImpl = Context.pImpl;
498 if (!pImpl->TheTrueVal)
499 pImpl->TheTrueVal = ConstantInt::get(Type::getInt1Ty(Context), 1);
500 return pImpl->TheTrueVal;
503 ConstantInt *ConstantInt::getFalse(LLVMContext &Context) {
504 LLVMContextImpl *pImpl = Context.pImpl;
505 if (!pImpl->TheFalseVal)
506 pImpl->TheFalseVal = ConstantInt::get(Type::getInt1Ty(Context), 0);
507 return pImpl->TheFalseVal;
510 Constant *ConstantInt::getTrue(Type *Ty) {
511 VectorType *VTy = dyn_cast<VectorType>(Ty);
513 assert(Ty->isIntegerTy(1) && "True must be i1 or vector of i1.");
514 return ConstantInt::getTrue(Ty->getContext());
516 assert(VTy->getElementType()->isIntegerTy(1) &&
517 "True must be vector of i1 or i1.");
518 return ConstantVector::getSplat(VTy->getNumElements(),
519 ConstantInt::getTrue(Ty->getContext()));
522 Constant *ConstantInt::getFalse(Type *Ty) {
523 VectorType *VTy = dyn_cast<VectorType>(Ty);
525 assert(Ty->isIntegerTy(1) && "False must be i1 or vector of i1.");
526 return ConstantInt::getFalse(Ty->getContext());
528 assert(VTy->getElementType()->isIntegerTy(1) &&
529 "False must be vector of i1 or i1.");
530 return ConstantVector::getSplat(VTy->getNumElements(),
531 ConstantInt::getFalse(Ty->getContext()));
535 // Get a ConstantInt from an APInt. Note that the value stored in the DenseMap
536 // as the key, is a DenseMapAPIntKeyInfo::KeyTy which has provided the
537 // operator== and operator!= to ensure that the DenseMap doesn't attempt to
538 // compare APInt's of different widths, which would violate an APInt class
539 // invariant which generates an assertion.
540 ConstantInt *ConstantInt::get(LLVMContext &Context, const APInt &V) {
541 // Get the corresponding integer type for the bit width of the value.
542 IntegerType *ITy = IntegerType::get(Context, V.getBitWidth());
543 // get an existing value or the insertion position
544 LLVMContextImpl *pImpl = Context.pImpl;
545 ConstantInt *&Slot = pImpl->IntConstants[DenseMapAPIntKeyInfo::KeyTy(V, ITy)];
546 if (!Slot) Slot = new ConstantInt(ITy, V);
550 Constant *ConstantInt::get(Type *Ty, uint64_t V, bool isSigned) {
551 Constant *C = get(cast<IntegerType>(Ty->getScalarType()), V, isSigned);
553 // For vectors, broadcast the value.
554 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
555 return ConstantVector::getSplat(VTy->getNumElements(), C);
560 ConstantInt *ConstantInt::get(IntegerType *Ty, uint64_t V,
562 return get(Ty->getContext(), APInt(Ty->getBitWidth(), V, isSigned));
565 ConstantInt *ConstantInt::getSigned(IntegerType *Ty, int64_t V) {
566 return get(Ty, V, true);
569 Constant *ConstantInt::getSigned(Type *Ty, int64_t V) {
570 return get(Ty, V, true);
573 Constant *ConstantInt::get(Type *Ty, const APInt& V) {
574 ConstantInt *C = get(Ty->getContext(), V);
575 assert(C->getType() == Ty->getScalarType() &&
576 "ConstantInt type doesn't match the type implied by its value!");
578 // For vectors, broadcast the value.
579 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
580 return ConstantVector::getSplat(VTy->getNumElements(), C);
585 ConstantInt *ConstantInt::get(IntegerType* Ty, StringRef Str,
587 return get(Ty->getContext(), APInt(Ty->getBitWidth(), Str, radix));
590 //===----------------------------------------------------------------------===//
592 //===----------------------------------------------------------------------===//
594 static const fltSemantics *TypeToFloatSemantics(Type *Ty) {
596 return &APFloat::IEEEhalf;
598 return &APFloat::IEEEsingle;
599 if (Ty->isDoubleTy())
600 return &APFloat::IEEEdouble;
601 if (Ty->isX86_FP80Ty())
602 return &APFloat::x87DoubleExtended;
603 else if (Ty->isFP128Ty())
604 return &APFloat::IEEEquad;
606 assert(Ty->isPPC_FP128Ty() && "Unknown FP format");
607 return &APFloat::PPCDoubleDouble;
610 void ConstantFP::anchor() { }
612 /// get() - This returns a constant fp for the specified value in the
613 /// specified type. This should only be used for simple constant values like
614 /// 2.0/1.0 etc, that are known-valid both as double and as the target format.
615 Constant *ConstantFP::get(Type *Ty, double V) {
616 LLVMContext &Context = Ty->getContext();
620 FV.convert(*TypeToFloatSemantics(Ty->getScalarType()),
621 APFloat::rmNearestTiesToEven, &ignored);
622 Constant *C = get(Context, FV);
624 // For vectors, broadcast the value.
625 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
626 return ConstantVector::getSplat(VTy->getNumElements(), C);
632 Constant *ConstantFP::get(Type *Ty, StringRef Str) {
633 LLVMContext &Context = Ty->getContext();
635 APFloat FV(*TypeToFloatSemantics(Ty->getScalarType()), Str);
636 Constant *C = get(Context, FV);
638 // For vectors, broadcast the value.
639 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
640 return ConstantVector::getSplat(VTy->getNumElements(), C);
645 Constant *ConstantFP::getNegativeZero(Type *Ty) {
646 const fltSemantics &Semantics = *TypeToFloatSemantics(Ty->getScalarType());
647 APFloat NegZero = APFloat::getZero(Semantics, /*Negative=*/true);
648 Constant *C = get(Ty->getContext(), NegZero);
650 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
651 return ConstantVector::getSplat(VTy->getNumElements(), C);
657 Constant *ConstantFP::getZeroValueForNegation(Type *Ty) {
658 if (Ty->isFPOrFPVectorTy())
659 return getNegativeZero(Ty);
661 return Constant::getNullValue(Ty);
665 // ConstantFP accessors.
666 ConstantFP* ConstantFP::get(LLVMContext &Context, const APFloat& V) {
667 LLVMContextImpl* pImpl = Context.pImpl;
669 ConstantFP *&Slot = pImpl->FPConstants[DenseMapAPFloatKeyInfo::KeyTy(V)];
673 if (&V.getSemantics() == &APFloat::IEEEhalf)
674 Ty = Type::getHalfTy(Context);
675 else if (&V.getSemantics() == &APFloat::IEEEsingle)
676 Ty = Type::getFloatTy(Context);
677 else if (&V.getSemantics() == &APFloat::IEEEdouble)
678 Ty = Type::getDoubleTy(Context);
679 else if (&V.getSemantics() == &APFloat::x87DoubleExtended)
680 Ty = Type::getX86_FP80Ty(Context);
681 else if (&V.getSemantics() == &APFloat::IEEEquad)
682 Ty = Type::getFP128Ty(Context);
684 assert(&V.getSemantics() == &APFloat::PPCDoubleDouble &&
685 "Unknown FP format");
686 Ty = Type::getPPC_FP128Ty(Context);
688 Slot = new ConstantFP(Ty, V);
694 Constant *ConstantFP::getInfinity(Type *Ty, bool Negative) {
695 const fltSemantics &Semantics = *TypeToFloatSemantics(Ty->getScalarType());
696 Constant *C = get(Ty->getContext(), APFloat::getInf(Semantics, Negative));
698 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
699 return ConstantVector::getSplat(VTy->getNumElements(), C);
704 ConstantFP::ConstantFP(Type *Ty, const APFloat& V)
705 : Constant(Ty, ConstantFPVal, nullptr, 0), Val(V) {
706 assert(&V.getSemantics() == TypeToFloatSemantics(Ty) &&
710 bool ConstantFP::isExactlyValue(const APFloat &V) const {
711 return Val.bitwiseIsEqual(V);
714 //===----------------------------------------------------------------------===//
715 // ConstantAggregateZero Implementation
716 //===----------------------------------------------------------------------===//
718 /// getSequentialElement - If this CAZ has array or vector type, return a zero
719 /// with the right element type.
720 Constant *ConstantAggregateZero::getSequentialElement() const {
721 return Constant::getNullValue(getType()->getSequentialElementType());
724 /// getStructElement - If this CAZ has struct type, return a zero with the
725 /// right element type for the specified element.
726 Constant *ConstantAggregateZero::getStructElement(unsigned Elt) const {
727 return Constant::getNullValue(getType()->getStructElementType(Elt));
730 /// getElementValue - Return a zero of the right value for the specified GEP
731 /// index if we can, otherwise return null (e.g. if C is a ConstantExpr).
732 Constant *ConstantAggregateZero::getElementValue(Constant *C) const {
733 if (isa<SequentialType>(getType()))
734 return getSequentialElement();
735 return getStructElement(cast<ConstantInt>(C)->getZExtValue());
738 /// getElementValue - Return a zero of the right value for the specified GEP
740 Constant *ConstantAggregateZero::getElementValue(unsigned Idx) const {
741 if (isa<SequentialType>(getType()))
742 return getSequentialElement();
743 return getStructElement(Idx);
747 //===----------------------------------------------------------------------===//
748 // UndefValue Implementation
749 //===----------------------------------------------------------------------===//
751 /// getSequentialElement - If this undef has array or vector type, return an
752 /// undef with the right element type.
753 UndefValue *UndefValue::getSequentialElement() const {
754 return UndefValue::get(getType()->getSequentialElementType());
757 /// getStructElement - If this undef has struct type, return a zero with the
758 /// right element type for the specified element.
759 UndefValue *UndefValue::getStructElement(unsigned Elt) const {
760 return UndefValue::get(getType()->getStructElementType(Elt));
763 /// getElementValue - Return an undef of the right value for the specified GEP
764 /// index if we can, otherwise return null (e.g. if C is a ConstantExpr).
765 UndefValue *UndefValue::getElementValue(Constant *C) const {
766 if (isa<SequentialType>(getType()))
767 return getSequentialElement();
768 return getStructElement(cast<ConstantInt>(C)->getZExtValue());
771 /// getElementValue - Return an undef of the right value for the specified GEP
773 UndefValue *UndefValue::getElementValue(unsigned Idx) const {
774 if (isa<SequentialType>(getType()))
775 return getSequentialElement();
776 return getStructElement(Idx);
781 //===----------------------------------------------------------------------===//
782 // ConstantXXX Classes
783 //===----------------------------------------------------------------------===//
785 template <typename ItTy, typename EltTy>
786 static bool rangeOnlyContains(ItTy Start, ItTy End, EltTy Elt) {
787 for (; Start != End; ++Start)
793 ConstantArray::ConstantArray(ArrayType *T, ArrayRef<Constant *> V)
794 : Constant(T, ConstantArrayVal,
795 OperandTraits<ConstantArray>::op_end(this) - V.size(),
797 assert(V.size() == T->getNumElements() &&
798 "Invalid initializer vector for constant array");
799 for (unsigned i = 0, e = V.size(); i != e; ++i)
800 assert(V[i]->getType() == T->getElementType() &&
801 "Initializer for array element doesn't match array element type!");
802 std::copy(V.begin(), V.end(), op_begin());
805 Constant *ConstantArray::get(ArrayType *Ty, ArrayRef<Constant*> V) {
806 if (Constant *C = getImpl(Ty, V))
808 return Ty->getContext().pImpl->ArrayConstants.getOrCreate(Ty, V);
810 Constant *ConstantArray::getImpl(ArrayType *Ty, ArrayRef<Constant*> V) {
811 // Empty arrays are canonicalized to ConstantAggregateZero.
813 return ConstantAggregateZero::get(Ty);
815 for (unsigned i = 0, e = V.size(); i != e; ++i) {
816 assert(V[i]->getType() == Ty->getElementType() &&
817 "Wrong type in array element initializer");
820 // If this is an all-zero array, return a ConstantAggregateZero object. If
821 // all undef, return an UndefValue, if "all simple", then return a
822 // ConstantDataArray.
824 if (isa<UndefValue>(C) && rangeOnlyContains(V.begin(), V.end(), C))
825 return UndefValue::get(Ty);
827 if (C->isNullValue() && rangeOnlyContains(V.begin(), V.end(), C))
828 return ConstantAggregateZero::get(Ty);
830 // Check to see if all of the elements are ConstantFP or ConstantInt and if
831 // the element type is compatible with ConstantDataVector. If so, use it.
832 if (ConstantDataSequential::isElementTypeCompatible(C->getType())) {
833 // We speculatively build the elements here even if it turns out that there
834 // is a constantexpr or something else weird in the array, since it is so
835 // uncommon for that to happen.
836 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
837 if (CI->getType()->isIntegerTy(8)) {
838 SmallVector<uint8_t, 16> Elts;
839 for (unsigned i = 0, e = V.size(); i != e; ++i)
840 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
841 Elts.push_back(CI->getZExtValue());
844 if (Elts.size() == V.size())
845 return ConstantDataArray::get(C->getContext(), Elts);
846 } else if (CI->getType()->isIntegerTy(16)) {
847 SmallVector<uint16_t, 16> Elts;
848 for (unsigned i = 0, e = V.size(); i != e; ++i)
849 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
850 Elts.push_back(CI->getZExtValue());
853 if (Elts.size() == V.size())
854 return ConstantDataArray::get(C->getContext(), Elts);
855 } else if (CI->getType()->isIntegerTy(32)) {
856 SmallVector<uint32_t, 16> Elts;
857 for (unsigned i = 0, e = V.size(); i != e; ++i)
858 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
859 Elts.push_back(CI->getZExtValue());
862 if (Elts.size() == V.size())
863 return ConstantDataArray::get(C->getContext(), Elts);
864 } else if (CI->getType()->isIntegerTy(64)) {
865 SmallVector<uint64_t, 16> Elts;
866 for (unsigned i = 0, e = V.size(); i != e; ++i)
867 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
868 Elts.push_back(CI->getZExtValue());
871 if (Elts.size() == V.size())
872 return ConstantDataArray::get(C->getContext(), Elts);
876 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
877 if (CFP->getType()->isFloatTy()) {
878 SmallVector<float, 16> Elts;
879 for (unsigned i = 0, e = V.size(); i != e; ++i)
880 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
881 Elts.push_back(CFP->getValueAPF().convertToFloat());
884 if (Elts.size() == V.size())
885 return ConstantDataArray::get(C->getContext(), Elts);
886 } else if (CFP->getType()->isDoubleTy()) {
887 SmallVector<double, 16> Elts;
888 for (unsigned i = 0, e = V.size(); i != e; ++i)
889 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
890 Elts.push_back(CFP->getValueAPF().convertToDouble());
893 if (Elts.size() == V.size())
894 return ConstantDataArray::get(C->getContext(), Elts);
899 // Otherwise, we really do want to create a ConstantArray.
903 /// getTypeForElements - Return an anonymous struct type to use for a constant
904 /// with the specified set of elements. The list must not be empty.
905 StructType *ConstantStruct::getTypeForElements(LLVMContext &Context,
906 ArrayRef<Constant*> V,
908 unsigned VecSize = V.size();
909 SmallVector<Type*, 16> EltTypes(VecSize);
910 for (unsigned i = 0; i != VecSize; ++i)
911 EltTypes[i] = V[i]->getType();
913 return StructType::get(Context, EltTypes, Packed);
917 StructType *ConstantStruct::getTypeForElements(ArrayRef<Constant*> V,
920 "ConstantStruct::getTypeForElements cannot be called on empty list");
921 return getTypeForElements(V[0]->getContext(), V, Packed);
925 ConstantStruct::ConstantStruct(StructType *T, ArrayRef<Constant *> V)
926 : Constant(T, ConstantStructVal,
927 OperandTraits<ConstantStruct>::op_end(this) - V.size(),
929 assert(V.size() == T->getNumElements() &&
930 "Invalid initializer vector for constant structure");
931 for (unsigned i = 0, e = V.size(); i != e; ++i)
932 assert((T->isOpaque() || V[i]->getType() == T->getElementType(i)) &&
933 "Initializer for struct element doesn't match struct element type!");
934 std::copy(V.begin(), V.end(), op_begin());
937 // ConstantStruct accessors.
938 Constant *ConstantStruct::get(StructType *ST, ArrayRef<Constant*> V) {
939 assert((ST->isOpaque() || ST->getNumElements() == V.size()) &&
940 "Incorrect # elements specified to ConstantStruct::get");
942 // Create a ConstantAggregateZero value if all elements are zeros.
944 bool isUndef = false;
947 isUndef = isa<UndefValue>(V[0]);
948 isZero = V[0]->isNullValue();
949 if (isUndef || isZero) {
950 for (unsigned i = 0, e = V.size(); i != e; ++i) {
951 if (!V[i]->isNullValue())
953 if (!isa<UndefValue>(V[i]))
959 return ConstantAggregateZero::get(ST);
961 return UndefValue::get(ST);
963 return ST->getContext().pImpl->StructConstants.getOrCreate(ST, V);
966 Constant *ConstantStruct::get(StructType *T, ...) {
968 SmallVector<Constant*, 8> Values;
970 while (Constant *Val = va_arg(ap, llvm::Constant*))
971 Values.push_back(Val);
973 return get(T, Values);
976 ConstantVector::ConstantVector(VectorType *T, ArrayRef<Constant *> V)
977 : Constant(T, ConstantVectorVal,
978 OperandTraits<ConstantVector>::op_end(this) - V.size(),
980 for (size_t i = 0, e = V.size(); i != e; i++)
981 assert(V[i]->getType() == T->getElementType() &&
982 "Initializer for vector element doesn't match vector element type!");
983 std::copy(V.begin(), V.end(), op_begin());
986 // ConstantVector accessors.
987 Constant *ConstantVector::get(ArrayRef<Constant*> V) {
988 if (Constant *C = getImpl(V))
990 VectorType *Ty = VectorType::get(V.front()->getType(), V.size());
991 return Ty->getContext().pImpl->VectorConstants.getOrCreate(Ty, V);
993 Constant *ConstantVector::getImpl(ArrayRef<Constant*> V) {
994 assert(!V.empty() && "Vectors can't be empty");
995 VectorType *T = VectorType::get(V.front()->getType(), V.size());
997 // If this is an all-undef or all-zero vector, return a
998 // ConstantAggregateZero or UndefValue.
1000 bool isZero = C->isNullValue();
1001 bool isUndef = isa<UndefValue>(C);
1003 if (isZero || isUndef) {
1004 for (unsigned i = 1, e = V.size(); i != e; ++i)
1006 isZero = isUndef = false;
1012 return ConstantAggregateZero::get(T);
1014 return UndefValue::get(T);
1016 // Check to see if all of the elements are ConstantFP or ConstantInt and if
1017 // the element type is compatible with ConstantDataVector. If so, use it.
1018 if (ConstantDataSequential::isElementTypeCompatible(C->getType())) {
1019 // We speculatively build the elements here even if it turns out that there
1020 // is a constantexpr or something else weird in the array, since it is so
1021 // uncommon for that to happen.
1022 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
1023 if (CI->getType()->isIntegerTy(8)) {
1024 SmallVector<uint8_t, 16> Elts;
1025 for (unsigned i = 0, e = V.size(); i != e; ++i)
1026 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1027 Elts.push_back(CI->getZExtValue());
1030 if (Elts.size() == V.size())
1031 return ConstantDataVector::get(C->getContext(), Elts);
1032 } else if (CI->getType()->isIntegerTy(16)) {
1033 SmallVector<uint16_t, 16> Elts;
1034 for (unsigned i = 0, e = V.size(); i != e; ++i)
1035 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1036 Elts.push_back(CI->getZExtValue());
1039 if (Elts.size() == V.size())
1040 return ConstantDataVector::get(C->getContext(), Elts);
1041 } else if (CI->getType()->isIntegerTy(32)) {
1042 SmallVector<uint32_t, 16> Elts;
1043 for (unsigned i = 0, e = V.size(); i != e; ++i)
1044 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1045 Elts.push_back(CI->getZExtValue());
1048 if (Elts.size() == V.size())
1049 return ConstantDataVector::get(C->getContext(), Elts);
1050 } else if (CI->getType()->isIntegerTy(64)) {
1051 SmallVector<uint64_t, 16> Elts;
1052 for (unsigned i = 0, e = V.size(); i != e; ++i)
1053 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1054 Elts.push_back(CI->getZExtValue());
1057 if (Elts.size() == V.size())
1058 return ConstantDataVector::get(C->getContext(), Elts);
1062 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
1063 if (CFP->getType()->isFloatTy()) {
1064 SmallVector<float, 16> Elts;
1065 for (unsigned i = 0, e = V.size(); i != e; ++i)
1066 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
1067 Elts.push_back(CFP->getValueAPF().convertToFloat());
1070 if (Elts.size() == V.size())
1071 return ConstantDataVector::get(C->getContext(), Elts);
1072 } else if (CFP->getType()->isDoubleTy()) {
1073 SmallVector<double, 16> Elts;
1074 for (unsigned i = 0, e = V.size(); i != e; ++i)
1075 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
1076 Elts.push_back(CFP->getValueAPF().convertToDouble());
1079 if (Elts.size() == V.size())
1080 return ConstantDataVector::get(C->getContext(), Elts);
1085 // Otherwise, the element type isn't compatible with ConstantDataVector, or
1086 // the operand list constants a ConstantExpr or something else strange.
1090 Constant *ConstantVector::getSplat(unsigned NumElts, Constant *V) {
1091 // If this splat is compatible with ConstantDataVector, use it instead of
1093 if ((isa<ConstantFP>(V) || isa<ConstantInt>(V)) &&
1094 ConstantDataSequential::isElementTypeCompatible(V->getType()))
1095 return ConstantDataVector::getSplat(NumElts, V);
1097 SmallVector<Constant*, 32> Elts(NumElts, V);
1102 // Utility function for determining if a ConstantExpr is a CastOp or not. This
1103 // can't be inline because we don't want to #include Instruction.h into
1105 bool ConstantExpr::isCast() const {
1106 return Instruction::isCast(getOpcode());
1109 bool ConstantExpr::isCompare() const {
1110 return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
1113 bool ConstantExpr::isGEPWithNoNotionalOverIndexing() const {
1114 if (getOpcode() != Instruction::GetElementPtr) return false;
1116 gep_type_iterator GEPI = gep_type_begin(this), E = gep_type_end(this);
1117 User::const_op_iterator OI = std::next(this->op_begin());
1119 // Skip the first index, as it has no static limit.
1123 // The remaining indices must be compile-time known integers within the
1124 // bounds of the corresponding notional static array types.
1125 for (; GEPI != E; ++GEPI, ++OI) {
1126 ConstantInt *CI = dyn_cast<ConstantInt>(*OI);
1127 if (!CI) return false;
1128 if (ArrayType *ATy = dyn_cast<ArrayType>(*GEPI))
1129 if (CI->getValue().getActiveBits() > 64 ||
1130 CI->getZExtValue() >= ATy->getNumElements())
1134 // All the indices checked out.
1138 bool ConstantExpr::hasIndices() const {
1139 return getOpcode() == Instruction::ExtractValue ||
1140 getOpcode() == Instruction::InsertValue;
1143 ArrayRef<unsigned> ConstantExpr::getIndices() const {
1144 if (const ExtractValueConstantExpr *EVCE =
1145 dyn_cast<ExtractValueConstantExpr>(this))
1146 return EVCE->Indices;
1148 return cast<InsertValueConstantExpr>(this)->Indices;
1151 unsigned ConstantExpr::getPredicate() const {
1152 assert(isCompare());
1153 return ((const CompareConstantExpr*)this)->predicate;
1156 /// getWithOperandReplaced - Return a constant expression identical to this
1157 /// one, but with the specified operand set to the specified value.
1159 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
1160 assert(Op->getType() == getOperand(OpNo)->getType() &&
1161 "Replacing operand with value of different type!");
1162 if (getOperand(OpNo) == Op)
1163 return const_cast<ConstantExpr*>(this);
1165 SmallVector<Constant*, 8> NewOps;
1166 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1167 NewOps.push_back(i == OpNo ? Op : getOperand(i));
1169 return getWithOperands(NewOps);
1172 /// getWithOperands - This returns the current constant expression with the
1173 /// operands replaced with the specified values. The specified array must
1174 /// have the same number of operands as our current one.
1175 Constant *ConstantExpr::
1176 getWithOperands(ArrayRef<Constant*> Ops, Type *Ty) const {
1177 assert(Ops.size() == getNumOperands() && "Operand count mismatch!");
1178 bool AnyChange = Ty != getType();
1179 for (unsigned i = 0; i != Ops.size(); ++i)
1180 AnyChange |= Ops[i] != getOperand(i);
1182 if (!AnyChange) // No operands changed, return self.
1183 return const_cast<ConstantExpr*>(this);
1185 switch (getOpcode()) {
1186 case Instruction::Trunc:
1187 case Instruction::ZExt:
1188 case Instruction::SExt:
1189 case Instruction::FPTrunc:
1190 case Instruction::FPExt:
1191 case Instruction::UIToFP:
1192 case Instruction::SIToFP:
1193 case Instruction::FPToUI:
1194 case Instruction::FPToSI:
1195 case Instruction::PtrToInt:
1196 case Instruction::IntToPtr:
1197 case Instruction::BitCast:
1198 case Instruction::AddrSpaceCast:
1199 return ConstantExpr::getCast(getOpcode(), Ops[0], Ty);
1200 case Instruction::Select:
1201 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
1202 case Instruction::InsertElement:
1203 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
1204 case Instruction::ExtractElement:
1205 return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
1206 case Instruction::InsertValue:
1207 return ConstantExpr::getInsertValue(Ops[0], Ops[1], getIndices());
1208 case Instruction::ExtractValue:
1209 return ConstantExpr::getExtractValue(Ops[0], getIndices());
1210 case Instruction::ShuffleVector:
1211 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
1212 case Instruction::GetElementPtr:
1213 return ConstantExpr::getGetElementPtr(Ops[0], Ops.slice(1),
1214 cast<GEPOperator>(this)->isInBounds());
1215 case Instruction::ICmp:
1216 case Instruction::FCmp:
1217 return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
1219 assert(getNumOperands() == 2 && "Must be binary operator?");
1220 return ConstantExpr::get(getOpcode(), Ops[0], Ops[1], SubclassOptionalData);
1225 //===----------------------------------------------------------------------===//
1226 // isValueValidForType implementations
1228 bool ConstantInt::isValueValidForType(Type *Ty, uint64_t Val) {
1229 unsigned NumBits = Ty->getIntegerBitWidth(); // assert okay
1230 if (Ty->isIntegerTy(1))
1231 return Val == 0 || Val == 1;
1233 return true; // always true, has to fit in largest type
1234 uint64_t Max = (1ll << NumBits) - 1;
1238 bool ConstantInt::isValueValidForType(Type *Ty, int64_t Val) {
1239 unsigned NumBits = Ty->getIntegerBitWidth();
1240 if (Ty->isIntegerTy(1))
1241 return Val == 0 || Val == 1 || Val == -1;
1243 return true; // always true, has to fit in largest type
1244 int64_t Min = -(1ll << (NumBits-1));
1245 int64_t Max = (1ll << (NumBits-1)) - 1;
1246 return (Val >= Min && Val <= Max);
1249 bool ConstantFP::isValueValidForType(Type *Ty, const APFloat& Val) {
1250 // convert modifies in place, so make a copy.
1251 APFloat Val2 = APFloat(Val);
1253 switch (Ty->getTypeID()) {
1255 return false; // These can't be represented as floating point!
1257 // FIXME rounding mode needs to be more flexible
1258 case Type::HalfTyID: {
1259 if (&Val2.getSemantics() == &APFloat::IEEEhalf)
1261 Val2.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &losesInfo);
1264 case Type::FloatTyID: {
1265 if (&Val2.getSemantics() == &APFloat::IEEEsingle)
1267 Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
1270 case Type::DoubleTyID: {
1271 if (&Val2.getSemantics() == &APFloat::IEEEhalf ||
1272 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1273 &Val2.getSemantics() == &APFloat::IEEEdouble)
1275 Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
1278 case Type::X86_FP80TyID:
1279 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1280 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1281 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1282 &Val2.getSemantics() == &APFloat::x87DoubleExtended;
1283 case Type::FP128TyID:
1284 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1285 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1286 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1287 &Val2.getSemantics() == &APFloat::IEEEquad;
1288 case Type::PPC_FP128TyID:
1289 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1290 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1291 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1292 &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
1297 //===----------------------------------------------------------------------===//
1298 // Factory Function Implementation
1300 ConstantAggregateZero *ConstantAggregateZero::get(Type *Ty) {
1301 assert((Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()) &&
1302 "Cannot create an aggregate zero of non-aggregate type!");
1304 ConstantAggregateZero *&Entry = Ty->getContext().pImpl->CAZConstants[Ty];
1306 Entry = new ConstantAggregateZero(Ty);
1311 /// destroyConstant - Remove the constant from the constant table.
1313 void ConstantAggregateZero::destroyConstant() {
1314 getContext().pImpl->CAZConstants.erase(getType());
1315 destroyConstantImpl();
1318 /// destroyConstant - Remove the constant from the constant table...
1320 void ConstantArray::destroyConstant() {
1321 getType()->getContext().pImpl->ArrayConstants.remove(this);
1322 destroyConstantImpl();
1326 //---- ConstantStruct::get() implementation...
1329 // destroyConstant - Remove the constant from the constant table...
1331 void ConstantStruct::destroyConstant() {
1332 getType()->getContext().pImpl->StructConstants.remove(this);
1333 destroyConstantImpl();
1336 // destroyConstant - Remove the constant from the constant table...
1338 void ConstantVector::destroyConstant() {
1339 getType()->getContext().pImpl->VectorConstants.remove(this);
1340 destroyConstantImpl();
1343 /// getSplatValue - If this is a splat vector constant, meaning that all of
1344 /// the elements have the same value, return that value. Otherwise return 0.
1345 Constant *Constant::getSplatValue() const {
1346 assert(this->getType()->isVectorTy() && "Only valid for vectors!");
1347 if (isa<ConstantAggregateZero>(this))
1348 return getNullValue(this->getType()->getVectorElementType());
1349 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
1350 return CV->getSplatValue();
1351 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
1352 return CV->getSplatValue();
1356 /// getSplatValue - If this is a splat constant, where all of the
1357 /// elements have the same value, return that value. Otherwise return null.
1358 Constant *ConstantVector::getSplatValue() const {
1359 // Check out first element.
1360 Constant *Elt = getOperand(0);
1361 // Then make sure all remaining elements point to the same value.
1362 for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1363 if (getOperand(I) != Elt)
1368 /// If C is a constant integer then return its value, otherwise C must be a
1369 /// vector of constant integers, all equal, and the common value is returned.
1370 const APInt &Constant::getUniqueInteger() const {
1371 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
1372 return CI->getValue();
1373 assert(this->getSplatValue() && "Doesn't contain a unique integer!");
1374 const Constant *C = this->getAggregateElement(0U);
1375 assert(C && isa<ConstantInt>(C) && "Not a vector of numbers!");
1376 return cast<ConstantInt>(C)->getValue();
1380 //---- ConstantPointerNull::get() implementation.
1383 ConstantPointerNull *ConstantPointerNull::get(PointerType *Ty) {
1384 ConstantPointerNull *&Entry = Ty->getContext().pImpl->CPNConstants[Ty];
1386 Entry = new ConstantPointerNull(Ty);
1391 // destroyConstant - Remove the constant from the constant table...
1393 void ConstantPointerNull::destroyConstant() {
1394 getContext().pImpl->CPNConstants.erase(getType());
1395 // Free the constant and any dangling references to it.
1396 destroyConstantImpl();
1400 //---- UndefValue::get() implementation.
1403 UndefValue *UndefValue::get(Type *Ty) {
1404 UndefValue *&Entry = Ty->getContext().pImpl->UVConstants[Ty];
1406 Entry = new UndefValue(Ty);
1411 // destroyConstant - Remove the constant from the constant table.
1413 void UndefValue::destroyConstant() {
1414 // Free the constant and any dangling references to it.
1415 getContext().pImpl->UVConstants.erase(getType());
1416 destroyConstantImpl();
1419 //---- BlockAddress::get() implementation.
1422 BlockAddress *BlockAddress::get(BasicBlock *BB) {
1423 assert(BB->getParent() && "Block must have a parent");
1424 return get(BB->getParent(), BB);
1427 BlockAddress *BlockAddress::get(Function *F, BasicBlock *BB) {
1429 F->getContext().pImpl->BlockAddresses[std::make_pair(F, BB)];
1431 BA = new BlockAddress(F, BB);
1433 assert(BA->getFunction() == F && "Basic block moved between functions");
1437 BlockAddress::BlockAddress(Function *F, BasicBlock *BB)
1438 : Constant(Type::getInt8PtrTy(F->getContext()), Value::BlockAddressVal,
1442 BB->AdjustBlockAddressRefCount(1);
1445 BlockAddress *BlockAddress::lookup(const BasicBlock *BB) {
1446 if (!BB->hasAddressTaken())
1449 const Function *F = BB->getParent();
1450 assert(F && "Block must have a parent");
1452 F->getContext().pImpl->BlockAddresses.lookup(std::make_pair(F, BB));
1453 assert(BA && "Refcount and block address map disagree!");
1457 // destroyConstant - Remove the constant from the constant table.
1459 void BlockAddress::destroyConstant() {
1460 getFunction()->getType()->getContext().pImpl
1461 ->BlockAddresses.erase(std::make_pair(getFunction(), getBasicBlock()));
1462 getBasicBlock()->AdjustBlockAddressRefCount(-1);
1463 destroyConstantImpl();
1466 void BlockAddress::replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) {
1467 // This could be replacing either the Basic Block or the Function. In either
1468 // case, we have to remove the map entry.
1469 Function *NewF = getFunction();
1470 BasicBlock *NewBB = getBasicBlock();
1473 NewF = cast<Function>(To->stripPointerCasts());
1475 NewBB = cast<BasicBlock>(To);
1477 // See if the 'new' entry already exists, if not, just update this in place
1478 // and return early.
1479 BlockAddress *&NewBA =
1480 getContext().pImpl->BlockAddresses[std::make_pair(NewF, NewBB)];
1482 replaceUsesOfWithOnConstantImpl(NewBA);
1486 getBasicBlock()->AdjustBlockAddressRefCount(-1);
1488 // Remove the old entry, this can't cause the map to rehash (just a
1489 // tombstone will get added).
1490 getContext().pImpl->BlockAddresses.erase(std::make_pair(getFunction(),
1493 setOperand(0, NewF);
1494 setOperand(1, NewBB);
1495 getBasicBlock()->AdjustBlockAddressRefCount(1);
1498 //---- ConstantExpr::get() implementations.
1501 /// This is a utility function to handle folding of casts and lookup of the
1502 /// cast in the ExprConstants map. It is used by the various get* methods below.
1503 static inline Constant *getFoldedCast(
1504 Instruction::CastOps opc, Constant *C, Type *Ty) {
1505 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1506 // Fold a few common cases
1507 if (Constant *FC = ConstantFoldCastInstruction(opc, C, Ty))
1510 LLVMContextImpl *pImpl = Ty->getContext().pImpl;
1512 // Look up the constant in the table first to ensure uniqueness.
1513 ConstantExprKeyType Key(opc, C);
1515 return pImpl->ExprConstants.getOrCreate(Ty, Key);
1518 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, Type *Ty) {
1519 Instruction::CastOps opc = Instruction::CastOps(oc);
1520 assert(Instruction::isCast(opc) && "opcode out of range");
1521 assert(C && Ty && "Null arguments to getCast");
1522 assert(CastInst::castIsValid(opc, C, Ty) && "Invalid constantexpr cast!");
1526 llvm_unreachable("Invalid cast opcode");
1527 case Instruction::Trunc: return getTrunc(C, Ty);
1528 case Instruction::ZExt: return getZExt(C, Ty);
1529 case Instruction::SExt: return getSExt(C, Ty);
1530 case Instruction::FPTrunc: return getFPTrunc(C, Ty);
1531 case Instruction::FPExt: return getFPExtend(C, Ty);
1532 case Instruction::UIToFP: return getUIToFP(C, Ty);
1533 case Instruction::SIToFP: return getSIToFP(C, Ty);
1534 case Instruction::FPToUI: return getFPToUI(C, Ty);
1535 case Instruction::FPToSI: return getFPToSI(C, Ty);
1536 case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1537 case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1538 case Instruction::BitCast: return getBitCast(C, Ty);
1539 case Instruction::AddrSpaceCast: return getAddrSpaceCast(C, Ty);
1543 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, Type *Ty) {
1544 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1545 return getBitCast(C, Ty);
1546 return getZExt(C, Ty);
1549 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, Type *Ty) {
1550 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1551 return getBitCast(C, Ty);
1552 return getSExt(C, Ty);
1555 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, Type *Ty) {
1556 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1557 return getBitCast(C, Ty);
1558 return getTrunc(C, Ty);
1561 Constant *ConstantExpr::getPointerCast(Constant *S, Type *Ty) {
1562 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
1563 assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
1566 if (Ty->isIntOrIntVectorTy())
1567 return getPtrToInt(S, Ty);
1569 unsigned SrcAS = S->getType()->getPointerAddressSpace();
1570 if (Ty->isPtrOrPtrVectorTy() && SrcAS != Ty->getPointerAddressSpace())
1571 return getAddrSpaceCast(S, Ty);
1573 return getBitCast(S, Ty);
1576 Constant *ConstantExpr::getPointerBitCastOrAddrSpaceCast(Constant *S,
1578 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
1579 assert(Ty->isPtrOrPtrVectorTy() && "Invalid cast");
1581 if (S->getType()->getPointerAddressSpace() != Ty->getPointerAddressSpace())
1582 return getAddrSpaceCast(S, Ty);
1584 return getBitCast(S, Ty);
1587 Constant *ConstantExpr::getIntegerCast(Constant *C, Type *Ty,
1589 assert(C->getType()->isIntOrIntVectorTy() &&
1590 Ty->isIntOrIntVectorTy() && "Invalid cast");
1591 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1592 unsigned DstBits = Ty->getScalarSizeInBits();
1593 Instruction::CastOps opcode =
1594 (SrcBits == DstBits ? Instruction::BitCast :
1595 (SrcBits > DstBits ? Instruction::Trunc :
1596 (isSigned ? Instruction::SExt : Instruction::ZExt)));
1597 return getCast(opcode, C, Ty);
1600 Constant *ConstantExpr::getFPCast(Constant *C, Type *Ty) {
1601 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1603 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1604 unsigned DstBits = Ty->getScalarSizeInBits();
1605 if (SrcBits == DstBits)
1606 return C; // Avoid a useless cast
1607 Instruction::CastOps opcode =
1608 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1609 return getCast(opcode, C, Ty);
1612 Constant *ConstantExpr::getTrunc(Constant *C, Type *Ty) {
1614 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1615 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1617 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1618 assert(C->getType()->isIntOrIntVectorTy() && "Trunc operand must be integer");
1619 assert(Ty->isIntOrIntVectorTy() && "Trunc produces only integral");
1620 assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1621 "SrcTy must be larger than DestTy for Trunc!");
1623 return getFoldedCast(Instruction::Trunc, C, Ty);
1626 Constant *ConstantExpr::getSExt(Constant *C, Type *Ty) {
1628 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1629 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1631 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1632 assert(C->getType()->isIntOrIntVectorTy() && "SExt operand must be integral");
1633 assert(Ty->isIntOrIntVectorTy() && "SExt produces only integer");
1634 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1635 "SrcTy must be smaller than DestTy for SExt!");
1637 return getFoldedCast(Instruction::SExt, C, Ty);
1640 Constant *ConstantExpr::getZExt(Constant *C, Type *Ty) {
1642 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1643 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1645 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1646 assert(C->getType()->isIntOrIntVectorTy() && "ZEXt operand must be integral");
1647 assert(Ty->isIntOrIntVectorTy() && "ZExt produces only integer");
1648 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1649 "SrcTy must be smaller than DestTy for ZExt!");
1651 return getFoldedCast(Instruction::ZExt, C, Ty);
1654 Constant *ConstantExpr::getFPTrunc(Constant *C, Type *Ty) {
1656 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1657 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1659 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1660 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1661 C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1662 "This is an illegal floating point truncation!");
1663 return getFoldedCast(Instruction::FPTrunc, C, Ty);
1666 Constant *ConstantExpr::getFPExtend(Constant *C, Type *Ty) {
1668 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1669 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1671 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1672 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1673 C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1674 "This is an illegal floating point extension!");
1675 return getFoldedCast(Instruction::FPExt, C, Ty);
1678 Constant *ConstantExpr::getUIToFP(Constant *C, Type *Ty) {
1680 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1681 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1683 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1684 assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1685 "This is an illegal uint to floating point cast!");
1686 return getFoldedCast(Instruction::UIToFP, C, Ty);
1689 Constant *ConstantExpr::getSIToFP(Constant *C, Type *Ty) {
1691 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1692 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1694 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1695 assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1696 "This is an illegal sint to floating point cast!");
1697 return getFoldedCast(Instruction::SIToFP, C, Ty);
1700 Constant *ConstantExpr::getFPToUI(Constant *C, Type *Ty) {
1702 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1703 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1705 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1706 assert(C->getType()->isFPOrFPVectorTy() && Ty->isIntOrIntVectorTy() &&
1707 "This is an illegal floating point to uint cast!");
1708 return getFoldedCast(Instruction::FPToUI, C, Ty);
1711 Constant *ConstantExpr::getFPToSI(Constant *C, Type *Ty) {
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->isIntOrIntVectorTy() &&
1718 "This is an illegal floating point to sint cast!");
1719 return getFoldedCast(Instruction::FPToSI, C, Ty);
1722 Constant *ConstantExpr::getPtrToInt(Constant *C, Type *DstTy) {
1723 assert(C->getType()->getScalarType()->isPointerTy() &&
1724 "PtrToInt source must be pointer or pointer vector");
1725 assert(DstTy->getScalarType()->isIntegerTy() &&
1726 "PtrToInt destination must be integer or integer vector");
1727 assert(isa<VectorType>(C->getType()) == isa<VectorType>(DstTy));
1728 if (isa<VectorType>(C->getType()))
1729 assert(C->getType()->getVectorNumElements()==DstTy->getVectorNumElements()&&
1730 "Invalid cast between a different number of vector elements");
1731 return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1734 Constant *ConstantExpr::getIntToPtr(Constant *C, Type *DstTy) {
1735 assert(C->getType()->getScalarType()->isIntegerTy() &&
1736 "IntToPtr source must be integer or integer vector");
1737 assert(DstTy->getScalarType()->isPointerTy() &&
1738 "IntToPtr destination must be a pointer or pointer vector");
1739 assert(isa<VectorType>(C->getType()) == isa<VectorType>(DstTy));
1740 if (isa<VectorType>(C->getType()))
1741 assert(C->getType()->getVectorNumElements()==DstTy->getVectorNumElements()&&
1742 "Invalid cast between a different number of vector elements");
1743 return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1746 Constant *ConstantExpr::getBitCast(Constant *C, Type *DstTy) {
1747 assert(CastInst::castIsValid(Instruction::BitCast, C, DstTy) &&
1748 "Invalid constantexpr bitcast!");
1750 // It is common to ask for a bitcast of a value to its own type, handle this
1752 if (C->getType() == DstTy) return C;
1754 return getFoldedCast(Instruction::BitCast, C, DstTy);
1757 Constant *ConstantExpr::getAddrSpaceCast(Constant *C, Type *DstTy) {
1758 assert(CastInst::castIsValid(Instruction::AddrSpaceCast, C, DstTy) &&
1759 "Invalid constantexpr addrspacecast!");
1761 // Canonicalize addrspacecasts between different pointer types by first
1762 // bitcasting the pointer type and then converting the address space.
1763 PointerType *SrcScalarTy = cast<PointerType>(C->getType()->getScalarType());
1764 PointerType *DstScalarTy = cast<PointerType>(DstTy->getScalarType());
1765 Type *DstElemTy = DstScalarTy->getElementType();
1766 if (SrcScalarTy->getElementType() != DstElemTy) {
1767 Type *MidTy = PointerType::get(DstElemTy, SrcScalarTy->getAddressSpace());
1768 if (VectorType *VT = dyn_cast<VectorType>(DstTy)) {
1769 // Handle vectors of pointers.
1770 MidTy = VectorType::get(MidTy, VT->getNumElements());
1772 C = getBitCast(C, MidTy);
1774 return getFoldedCast(Instruction::AddrSpaceCast, C, DstTy);
1777 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2,
1779 // Check the operands for consistency first.
1780 assert(Opcode >= Instruction::BinaryOpsBegin &&
1781 Opcode < Instruction::BinaryOpsEnd &&
1782 "Invalid opcode in binary constant expression");
1783 assert(C1->getType() == C2->getType() &&
1784 "Operand types in binary constant expression should match");
1788 case Instruction::Add:
1789 case Instruction::Sub:
1790 case Instruction::Mul:
1791 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1792 assert(C1->getType()->isIntOrIntVectorTy() &&
1793 "Tried to create an integer operation on a non-integer type!");
1795 case Instruction::FAdd:
1796 case Instruction::FSub:
1797 case Instruction::FMul:
1798 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1799 assert(C1->getType()->isFPOrFPVectorTy() &&
1800 "Tried to create a floating-point operation on a "
1801 "non-floating-point type!");
1803 case Instruction::UDiv:
1804 case Instruction::SDiv:
1805 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1806 assert(C1->getType()->isIntOrIntVectorTy() &&
1807 "Tried to create an arithmetic operation on a non-arithmetic type!");
1809 case Instruction::FDiv:
1810 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1811 assert(C1->getType()->isFPOrFPVectorTy() &&
1812 "Tried to create an arithmetic operation on a non-arithmetic type!");
1814 case Instruction::URem:
1815 case Instruction::SRem:
1816 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1817 assert(C1->getType()->isIntOrIntVectorTy() &&
1818 "Tried to create an arithmetic operation on a non-arithmetic type!");
1820 case Instruction::FRem:
1821 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1822 assert(C1->getType()->isFPOrFPVectorTy() &&
1823 "Tried to create an arithmetic operation on a non-arithmetic type!");
1825 case Instruction::And:
1826 case Instruction::Or:
1827 case Instruction::Xor:
1828 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1829 assert(C1->getType()->isIntOrIntVectorTy() &&
1830 "Tried to create a logical operation on a non-integral type!");
1832 case Instruction::Shl:
1833 case Instruction::LShr:
1834 case Instruction::AShr:
1835 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1836 assert(C1->getType()->isIntOrIntVectorTy() &&
1837 "Tried to create a shift operation on a non-integer type!");
1844 if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1845 return FC; // Fold a few common cases.
1847 Constant *ArgVec[] = { C1, C2 };
1848 ConstantExprKeyType Key(Opcode, ArgVec, 0, Flags);
1850 LLVMContextImpl *pImpl = C1->getContext().pImpl;
1851 return pImpl->ExprConstants.getOrCreate(C1->getType(), Key);
1854 Constant *ConstantExpr::getSizeOf(Type* Ty) {
1855 // sizeof is implemented as: (i64) gep (Ty*)null, 1
1856 // Note that a non-inbounds gep is used, as null isn't within any object.
1857 Constant *GEPIdx = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1858 Constant *GEP = getGetElementPtr(
1859 Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1860 return getPtrToInt(GEP,
1861 Type::getInt64Ty(Ty->getContext()));
1864 Constant *ConstantExpr::getAlignOf(Type* Ty) {
1865 // alignof is implemented as: (i64) gep ({i1,Ty}*)null, 0, 1
1866 // Note that a non-inbounds gep is used, as null isn't within any object.
1868 StructType::get(Type::getInt1Ty(Ty->getContext()), Ty, NULL);
1869 Constant *NullPtr = Constant::getNullValue(AligningTy->getPointerTo(0));
1870 Constant *Zero = ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0);
1871 Constant *One = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1872 Constant *Indices[2] = { Zero, One };
1873 Constant *GEP = getGetElementPtr(NullPtr, Indices);
1874 return getPtrToInt(GEP,
1875 Type::getInt64Ty(Ty->getContext()));
1878 Constant *ConstantExpr::getOffsetOf(StructType* STy, unsigned FieldNo) {
1879 return getOffsetOf(STy, ConstantInt::get(Type::getInt32Ty(STy->getContext()),
1883 Constant *ConstantExpr::getOffsetOf(Type* Ty, Constant *FieldNo) {
1884 // offsetof is implemented as: (i64) gep (Ty*)null, 0, FieldNo
1885 // Note that a non-inbounds gep is used, as null isn't within any object.
1886 Constant *GEPIdx[] = {
1887 ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0),
1890 Constant *GEP = getGetElementPtr(
1891 Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1892 return getPtrToInt(GEP,
1893 Type::getInt64Ty(Ty->getContext()));
1896 Constant *ConstantExpr::getCompare(unsigned short Predicate,
1897 Constant *C1, Constant *C2) {
1898 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1900 switch (Predicate) {
1901 default: llvm_unreachable("Invalid CmpInst predicate");
1902 case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1903 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1904 case CmpInst::FCMP_ONE: case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1905 case CmpInst::FCMP_UEQ: case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1906 case CmpInst::FCMP_ULT: case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1907 case CmpInst::FCMP_TRUE:
1908 return getFCmp(Predicate, C1, C2);
1910 case CmpInst::ICMP_EQ: case CmpInst::ICMP_NE: case CmpInst::ICMP_UGT:
1911 case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1912 case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1913 case CmpInst::ICMP_SLE:
1914 return getICmp(Predicate, C1, C2);
1918 Constant *ConstantExpr::getSelect(Constant *C, Constant *V1, Constant *V2) {
1919 assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1921 if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1922 return SC; // Fold common cases
1924 Constant *ArgVec[] = { C, V1, V2 };
1925 ConstantExprKeyType Key(Instruction::Select, ArgVec);
1927 LLVMContextImpl *pImpl = C->getContext().pImpl;
1928 return pImpl->ExprConstants.getOrCreate(V1->getType(), Key);
1931 Constant *ConstantExpr::getGetElementPtr(Constant *C, ArrayRef<Value *> Idxs,
1933 assert(C->getType()->isPtrOrPtrVectorTy() &&
1934 "Non-pointer type for constant GetElementPtr expression");
1936 if (Constant *FC = ConstantFoldGetElementPtr(C, InBounds, Idxs))
1937 return FC; // Fold a few common cases.
1939 // Get the result type of the getelementptr!
1940 Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), Idxs);
1941 assert(Ty && "GEP indices invalid!");
1942 unsigned AS = C->getType()->getPointerAddressSpace();
1943 Type *ReqTy = Ty->getPointerTo(AS);
1944 if (VectorType *VecTy = dyn_cast<VectorType>(C->getType()))
1945 ReqTy = VectorType::get(ReqTy, VecTy->getNumElements());
1947 // Look up the constant in the table first to ensure uniqueness
1948 std::vector<Constant*> ArgVec;
1949 ArgVec.reserve(1 + Idxs.size());
1950 ArgVec.push_back(C);
1951 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
1952 assert(Idxs[i]->getType()->isVectorTy() == ReqTy->isVectorTy() &&
1953 "getelementptr index type missmatch");
1954 assert((!Idxs[i]->getType()->isVectorTy() ||
1955 ReqTy->getVectorNumElements() ==
1956 Idxs[i]->getType()->getVectorNumElements()) &&
1957 "getelementptr index type missmatch");
1958 ArgVec.push_back(cast<Constant>(Idxs[i]));
1960 const ConstantExprKeyType Key(Instruction::GetElementPtr, ArgVec, 0,
1961 InBounds ? GEPOperator::IsInBounds : 0);
1963 LLVMContextImpl *pImpl = C->getContext().pImpl;
1964 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1968 ConstantExpr::getICmp(unsigned short pred, Constant *LHS, Constant *RHS) {
1969 assert(LHS->getType() == RHS->getType());
1970 assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
1971 pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1973 if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1974 return FC; // Fold a few common cases...
1976 // Look up the constant in the table first to ensure uniqueness
1977 Constant *ArgVec[] = { LHS, RHS };
1978 // Get the key type with both the opcode and predicate
1979 const ConstantExprKeyType Key(Instruction::ICmp, ArgVec, pred);
1981 Type *ResultTy = Type::getInt1Ty(LHS->getContext());
1982 if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
1983 ResultTy = VectorType::get(ResultTy, VT->getNumElements());
1985 LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
1986 return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
1990 ConstantExpr::getFCmp(unsigned short pred, Constant *LHS, Constant *RHS) {
1991 assert(LHS->getType() == RHS->getType());
1992 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1994 if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1995 return FC; // Fold a few common cases...
1997 // Look up the constant in the table first to ensure uniqueness
1998 Constant *ArgVec[] = { LHS, RHS };
1999 // Get the key type with both the opcode and predicate
2000 const ConstantExprKeyType Key(Instruction::FCmp, ArgVec, pred);
2002 Type *ResultTy = Type::getInt1Ty(LHS->getContext());
2003 if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
2004 ResultTy = VectorType::get(ResultTy, VT->getNumElements());
2006 LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
2007 return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
2010 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
2011 assert(Val->getType()->isVectorTy() &&
2012 "Tried to create extractelement operation on non-vector type!");
2013 assert(Idx->getType()->isIntegerTy() &&
2014 "Extractelement index must be an integer type!");
2016 if (Constant *FC = ConstantFoldExtractElementInstruction(Val, Idx))
2017 return FC; // Fold a few common cases.
2019 // Look up the constant in the table first to ensure uniqueness
2020 Constant *ArgVec[] = { Val, Idx };
2021 const ConstantExprKeyType Key(Instruction::ExtractElement, ArgVec);
2023 LLVMContextImpl *pImpl = Val->getContext().pImpl;
2024 Type *ReqTy = Val->getType()->getVectorElementType();
2025 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2028 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
2030 assert(Val->getType()->isVectorTy() &&
2031 "Tried to create insertelement operation on non-vector type!");
2032 assert(Elt->getType() == Val->getType()->getVectorElementType() &&
2033 "Insertelement types must match!");
2034 assert(Idx->getType()->isIntegerTy() &&
2035 "Insertelement index must be i32 type!");
2037 if (Constant *FC = ConstantFoldInsertElementInstruction(Val, Elt, Idx))
2038 return FC; // Fold a few common cases.
2039 // Look up the constant in the table first to ensure uniqueness
2040 Constant *ArgVec[] = { Val, Elt, Idx };
2041 const ConstantExprKeyType Key(Instruction::InsertElement, ArgVec);
2043 LLVMContextImpl *pImpl = Val->getContext().pImpl;
2044 return pImpl->ExprConstants.getOrCreate(Val->getType(), Key);
2047 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
2049 assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
2050 "Invalid shuffle vector constant expr operands!");
2052 if (Constant *FC = ConstantFoldShuffleVectorInstruction(V1, V2, Mask))
2053 return FC; // Fold a few common cases.
2055 unsigned NElts = Mask->getType()->getVectorNumElements();
2056 Type *EltTy = V1->getType()->getVectorElementType();
2057 Type *ShufTy = VectorType::get(EltTy, NElts);
2059 // Look up the constant in the table first to ensure uniqueness
2060 Constant *ArgVec[] = { V1, V2, Mask };
2061 const ConstantExprKeyType Key(Instruction::ShuffleVector, ArgVec);
2063 LLVMContextImpl *pImpl = ShufTy->getContext().pImpl;
2064 return pImpl->ExprConstants.getOrCreate(ShufTy, Key);
2067 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
2068 ArrayRef<unsigned> Idxs) {
2069 assert(Agg->getType()->isFirstClassType() &&
2070 "Non-first-class type for constant insertvalue expression");
2072 assert(ExtractValueInst::getIndexedType(Agg->getType(),
2073 Idxs) == Val->getType() &&
2074 "insertvalue indices invalid!");
2075 Type *ReqTy = Val->getType();
2077 if (Constant *FC = ConstantFoldInsertValueInstruction(Agg, Val, Idxs))
2080 Constant *ArgVec[] = { Agg, Val };
2081 const ConstantExprKeyType Key(Instruction::InsertValue, ArgVec, 0, 0, Idxs);
2083 LLVMContextImpl *pImpl = Agg->getContext().pImpl;
2084 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2087 Constant *ConstantExpr::getExtractValue(Constant *Agg,
2088 ArrayRef<unsigned> Idxs) {
2089 assert(Agg->getType()->isFirstClassType() &&
2090 "Tried to create extractelement operation on non-first-class type!");
2092 Type *ReqTy = ExtractValueInst::getIndexedType(Agg->getType(), Idxs);
2094 assert(ReqTy && "extractvalue indices invalid!");
2096 assert(Agg->getType()->isFirstClassType() &&
2097 "Non-first-class type for constant extractvalue expression");
2098 if (Constant *FC = ConstantFoldExtractValueInstruction(Agg, Idxs))
2101 Constant *ArgVec[] = { Agg };
2102 const ConstantExprKeyType Key(Instruction::ExtractValue, ArgVec, 0, 0, Idxs);
2104 LLVMContextImpl *pImpl = Agg->getContext().pImpl;
2105 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2108 Constant *ConstantExpr::getNeg(Constant *C, bool HasNUW, bool HasNSW) {
2109 assert(C->getType()->isIntOrIntVectorTy() &&
2110 "Cannot NEG a nonintegral value!");
2111 return getSub(ConstantFP::getZeroValueForNegation(C->getType()),
2115 Constant *ConstantExpr::getFNeg(Constant *C) {
2116 assert(C->getType()->isFPOrFPVectorTy() &&
2117 "Cannot FNEG a non-floating-point value!");
2118 return getFSub(ConstantFP::getZeroValueForNegation(C->getType()), C);
2121 Constant *ConstantExpr::getNot(Constant *C) {
2122 assert(C->getType()->isIntOrIntVectorTy() &&
2123 "Cannot NOT a nonintegral value!");
2124 return get(Instruction::Xor, C, Constant::getAllOnesValue(C->getType()));
2127 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2,
2128 bool HasNUW, bool HasNSW) {
2129 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2130 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2131 return get(Instruction::Add, C1, C2, Flags);
2134 Constant *ConstantExpr::getFAdd(Constant *C1, Constant *C2) {
2135 return get(Instruction::FAdd, C1, C2);
2138 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2,
2139 bool HasNUW, bool HasNSW) {
2140 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2141 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2142 return get(Instruction::Sub, C1, C2, Flags);
2145 Constant *ConstantExpr::getFSub(Constant *C1, Constant *C2) {
2146 return get(Instruction::FSub, C1, C2);
2149 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2,
2150 bool HasNUW, bool HasNSW) {
2151 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2152 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2153 return get(Instruction::Mul, C1, C2, Flags);
2156 Constant *ConstantExpr::getFMul(Constant *C1, Constant *C2) {
2157 return get(Instruction::FMul, C1, C2);
2160 Constant *ConstantExpr::getUDiv(Constant *C1, Constant *C2, bool isExact) {
2161 return get(Instruction::UDiv, C1, C2,
2162 isExact ? PossiblyExactOperator::IsExact : 0);
2165 Constant *ConstantExpr::getSDiv(Constant *C1, Constant *C2, bool isExact) {
2166 return get(Instruction::SDiv, C1, C2,
2167 isExact ? PossiblyExactOperator::IsExact : 0);
2170 Constant *ConstantExpr::getFDiv(Constant *C1, Constant *C2) {
2171 return get(Instruction::FDiv, C1, C2);
2174 Constant *ConstantExpr::getURem(Constant *C1, Constant *C2) {
2175 return get(Instruction::URem, C1, C2);
2178 Constant *ConstantExpr::getSRem(Constant *C1, Constant *C2) {
2179 return get(Instruction::SRem, C1, C2);
2182 Constant *ConstantExpr::getFRem(Constant *C1, Constant *C2) {
2183 return get(Instruction::FRem, C1, C2);
2186 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
2187 return get(Instruction::And, C1, C2);
2190 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
2191 return get(Instruction::Or, C1, C2);
2194 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
2195 return get(Instruction::Xor, C1, C2);
2198 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2,
2199 bool HasNUW, bool HasNSW) {
2200 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2201 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2202 return get(Instruction::Shl, C1, C2, Flags);
2205 Constant *ConstantExpr::getLShr(Constant *C1, Constant *C2, bool isExact) {
2206 return get(Instruction::LShr, C1, C2,
2207 isExact ? PossiblyExactOperator::IsExact : 0);
2210 Constant *ConstantExpr::getAShr(Constant *C1, Constant *C2, bool isExact) {
2211 return get(Instruction::AShr, C1, C2,
2212 isExact ? PossiblyExactOperator::IsExact : 0);
2215 /// getBinOpIdentity - Return the identity for the given binary operation,
2216 /// i.e. a constant C such that X op C = X and C op X = X for every X. It
2217 /// returns null if the operator doesn't have an identity.
2218 Constant *ConstantExpr::getBinOpIdentity(unsigned Opcode, Type *Ty) {
2221 // Doesn't have an identity.
2224 case Instruction::Add:
2225 case Instruction::Or:
2226 case Instruction::Xor:
2227 return Constant::getNullValue(Ty);
2229 case Instruction::Mul:
2230 return ConstantInt::get(Ty, 1);
2232 case Instruction::And:
2233 return Constant::getAllOnesValue(Ty);
2237 /// getBinOpAbsorber - Return the absorbing element for the given binary
2238 /// operation, i.e. a constant C such that X op C = C and C op X = C for
2239 /// every X. For example, this returns zero for integer multiplication.
2240 /// It returns null if the operator doesn't have an absorbing element.
2241 Constant *ConstantExpr::getBinOpAbsorber(unsigned Opcode, Type *Ty) {
2244 // Doesn't have an absorber.
2247 case Instruction::Or:
2248 return Constant::getAllOnesValue(Ty);
2250 case Instruction::And:
2251 case Instruction::Mul:
2252 return Constant::getNullValue(Ty);
2256 // destroyConstant - Remove the constant from the constant table...
2258 void ConstantExpr::destroyConstant() {
2259 getType()->getContext().pImpl->ExprConstants.remove(this);
2260 destroyConstantImpl();
2263 const char *ConstantExpr::getOpcodeName() const {
2264 return Instruction::getOpcodeName(getOpcode());
2269 GetElementPtrConstantExpr::
2270 GetElementPtrConstantExpr(Constant *C, ArrayRef<Constant*> IdxList,
2272 : ConstantExpr(DestTy, Instruction::GetElementPtr,
2273 OperandTraits<GetElementPtrConstantExpr>::op_end(this)
2274 - (IdxList.size()+1), IdxList.size()+1) {
2276 for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
2277 OperandList[i+1] = IdxList[i];
2280 //===----------------------------------------------------------------------===//
2281 // ConstantData* implementations
2283 void ConstantDataArray::anchor() {}
2284 void ConstantDataVector::anchor() {}
2286 /// getElementType - Return the element type of the array/vector.
2287 Type *ConstantDataSequential::getElementType() const {
2288 return getType()->getElementType();
2291 StringRef ConstantDataSequential::getRawDataValues() const {
2292 return StringRef(DataElements, getNumElements()*getElementByteSize());
2295 /// isElementTypeCompatible - Return true if a ConstantDataSequential can be
2296 /// formed with a vector or array of the specified element type.
2297 /// ConstantDataArray only works with normal float and int types that are
2298 /// stored densely in memory, not with things like i42 or x86_f80.
2299 bool ConstantDataSequential::isElementTypeCompatible(const Type *Ty) {
2300 if (Ty->isFloatTy() || Ty->isDoubleTy()) return true;
2301 if (const IntegerType *IT = dyn_cast<IntegerType>(Ty)) {
2302 switch (IT->getBitWidth()) {
2314 /// getNumElements - Return the number of elements in the array or vector.
2315 unsigned ConstantDataSequential::getNumElements() const {
2316 if (ArrayType *AT = dyn_cast<ArrayType>(getType()))
2317 return AT->getNumElements();
2318 return getType()->getVectorNumElements();
2322 /// getElementByteSize - Return the size in bytes of the elements in the data.
2323 uint64_t ConstantDataSequential::getElementByteSize() const {
2324 return getElementType()->getPrimitiveSizeInBits()/8;
2327 /// getElementPointer - Return the start of the specified element.
2328 const char *ConstantDataSequential::getElementPointer(unsigned Elt) const {
2329 assert(Elt < getNumElements() && "Invalid Elt");
2330 return DataElements+Elt*getElementByteSize();
2334 /// isAllZeros - return true if the array is empty or all zeros.
2335 static bool isAllZeros(StringRef Arr) {
2336 for (StringRef::iterator I = Arr.begin(), E = Arr.end(); I != E; ++I)
2342 /// getImpl - This is the underlying implementation of all of the
2343 /// ConstantDataSequential::get methods. They all thunk down to here, providing
2344 /// the correct element type. We take the bytes in as a StringRef because
2345 /// we *want* an underlying "char*" to avoid TBAA type punning violations.
2346 Constant *ConstantDataSequential::getImpl(StringRef Elements, Type *Ty) {
2347 assert(isElementTypeCompatible(Ty->getSequentialElementType()));
2348 // If the elements are all zero or there are no elements, return a CAZ, which
2349 // is more dense and canonical.
2350 if (isAllZeros(Elements))
2351 return ConstantAggregateZero::get(Ty);
2353 // Do a lookup to see if we have already formed one of these.
2354 StringMap<ConstantDataSequential*>::MapEntryTy &Slot =
2355 Ty->getContext().pImpl->CDSConstants.GetOrCreateValue(Elements);
2357 // The bucket can point to a linked list of different CDS's that have the same
2358 // body but different types. For example, 0,0,0,1 could be a 4 element array
2359 // of i8, or a 1-element array of i32. They'll both end up in the same
2360 /// StringMap bucket, linked up by their Next pointers. Walk the list.
2361 ConstantDataSequential **Entry = &Slot.getValue();
2362 for (ConstantDataSequential *Node = *Entry; Node;
2363 Entry = &Node->Next, Node = *Entry)
2364 if (Node->getType() == Ty)
2367 // Okay, we didn't get a hit. Create a node of the right class, link it in,
2369 if (isa<ArrayType>(Ty))
2370 return *Entry = new ConstantDataArray(Ty, Slot.getKeyData());
2372 assert(isa<VectorType>(Ty));
2373 return *Entry = new ConstantDataVector(Ty, Slot.getKeyData());
2376 void ConstantDataSequential::destroyConstant() {
2377 // Remove the constant from the StringMap.
2378 StringMap<ConstantDataSequential*> &CDSConstants =
2379 getType()->getContext().pImpl->CDSConstants;
2381 StringMap<ConstantDataSequential*>::iterator Slot =
2382 CDSConstants.find(getRawDataValues());
2384 assert(Slot != CDSConstants.end() && "CDS not found in uniquing table");
2386 ConstantDataSequential **Entry = &Slot->getValue();
2388 // Remove the entry from the hash table.
2389 if (!(*Entry)->Next) {
2390 // If there is only one value in the bucket (common case) it must be this
2391 // entry, and removing the entry should remove the bucket completely.
2392 assert((*Entry) == this && "Hash mismatch in ConstantDataSequential");
2393 getContext().pImpl->CDSConstants.erase(Slot);
2395 // Otherwise, there are multiple entries linked off the bucket, unlink the
2396 // node we care about but keep the bucket around.
2397 for (ConstantDataSequential *Node = *Entry; ;
2398 Entry = &Node->Next, Node = *Entry) {
2399 assert(Node && "Didn't find entry in its uniquing hash table!");
2400 // If we found our entry, unlink it from the list and we're done.
2402 *Entry = Node->Next;
2408 // If we were part of a list, make sure that we don't delete the list that is
2409 // still owned by the uniquing map.
2412 // Finally, actually delete it.
2413 destroyConstantImpl();
2416 /// get() constructors - Return a constant with array type with an element
2417 /// count and element type matching the ArrayRef passed in. Note that this
2418 /// can return a ConstantAggregateZero object.
2419 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint8_t> Elts) {
2420 Type *Ty = ArrayType::get(Type::getInt8Ty(Context), Elts.size());
2421 const char *Data = reinterpret_cast<const char *>(Elts.data());
2422 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*1), Ty);
2424 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint16_t> Elts){
2425 Type *Ty = ArrayType::get(Type::getInt16Ty(Context), Elts.size());
2426 const char *Data = reinterpret_cast<const char *>(Elts.data());
2427 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*2), Ty);
2429 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint32_t> Elts){
2430 Type *Ty = ArrayType::get(Type::getInt32Ty(Context), Elts.size());
2431 const char *Data = reinterpret_cast<const char *>(Elts.data());
2432 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2434 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint64_t> Elts){
2435 Type *Ty = ArrayType::get(Type::getInt64Ty(Context), Elts.size());
2436 const char *Data = reinterpret_cast<const char *>(Elts.data());
2437 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2439 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<float> Elts) {
2440 Type *Ty = ArrayType::get(Type::getFloatTy(Context), Elts.size());
2441 const char *Data = reinterpret_cast<const char *>(Elts.data());
2442 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2444 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<double> Elts) {
2445 Type *Ty = ArrayType::get(Type::getDoubleTy(Context), Elts.size());
2446 const char *Data = reinterpret_cast<const char *>(Elts.data());
2447 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2450 /// getString - This method constructs a CDS and initializes it with a text
2451 /// string. The default behavior (AddNull==true) causes a null terminator to
2452 /// be placed at the end of the array (increasing the length of the string by
2453 /// one more than the StringRef would normally indicate. Pass AddNull=false
2454 /// to disable this behavior.
2455 Constant *ConstantDataArray::getString(LLVMContext &Context,
2456 StringRef Str, bool AddNull) {
2458 const uint8_t *Data = reinterpret_cast<const uint8_t *>(Str.data());
2459 return get(Context, ArrayRef<uint8_t>(const_cast<uint8_t *>(Data),
2463 SmallVector<uint8_t, 64> ElementVals;
2464 ElementVals.append(Str.begin(), Str.end());
2465 ElementVals.push_back(0);
2466 return get(Context, ElementVals);
2469 /// get() constructors - Return a constant with vector type with an element
2470 /// count and element type matching the ArrayRef passed in. Note that this
2471 /// can return a ConstantAggregateZero object.
2472 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint8_t> Elts){
2473 Type *Ty = VectorType::get(Type::getInt8Ty(Context), Elts.size());
2474 const char *Data = reinterpret_cast<const char *>(Elts.data());
2475 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*1), Ty);
2477 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint16_t> Elts){
2478 Type *Ty = VectorType::get(Type::getInt16Ty(Context), Elts.size());
2479 const char *Data = reinterpret_cast<const char *>(Elts.data());
2480 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*2), Ty);
2482 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint32_t> Elts){
2483 Type *Ty = VectorType::get(Type::getInt32Ty(Context), Elts.size());
2484 const char *Data = reinterpret_cast<const char *>(Elts.data());
2485 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2487 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint64_t> Elts){
2488 Type *Ty = VectorType::get(Type::getInt64Ty(Context), Elts.size());
2489 const char *Data = reinterpret_cast<const char *>(Elts.data());
2490 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2492 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<float> Elts) {
2493 Type *Ty = VectorType::get(Type::getFloatTy(Context), Elts.size());
2494 const char *Data = reinterpret_cast<const char *>(Elts.data());
2495 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2497 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<double> Elts) {
2498 Type *Ty = VectorType::get(Type::getDoubleTy(Context), Elts.size());
2499 const char *Data = reinterpret_cast<const char *>(Elts.data());
2500 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2503 Constant *ConstantDataVector::getSplat(unsigned NumElts, Constant *V) {
2504 assert(isElementTypeCompatible(V->getType()) &&
2505 "Element type not compatible with ConstantData");
2506 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
2507 if (CI->getType()->isIntegerTy(8)) {
2508 SmallVector<uint8_t, 16> Elts(NumElts, CI->getZExtValue());
2509 return get(V->getContext(), Elts);
2511 if (CI->getType()->isIntegerTy(16)) {
2512 SmallVector<uint16_t, 16> Elts(NumElts, CI->getZExtValue());
2513 return get(V->getContext(), Elts);
2515 if (CI->getType()->isIntegerTy(32)) {
2516 SmallVector<uint32_t, 16> Elts(NumElts, CI->getZExtValue());
2517 return get(V->getContext(), Elts);
2519 assert(CI->getType()->isIntegerTy(64) && "Unsupported ConstantData type");
2520 SmallVector<uint64_t, 16> Elts(NumElts, CI->getZExtValue());
2521 return get(V->getContext(), Elts);
2524 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2525 if (CFP->getType()->isFloatTy()) {
2526 SmallVector<float, 16> Elts(NumElts, CFP->getValueAPF().convertToFloat());
2527 return get(V->getContext(), Elts);
2529 if (CFP->getType()->isDoubleTy()) {
2530 SmallVector<double, 16> Elts(NumElts,
2531 CFP->getValueAPF().convertToDouble());
2532 return get(V->getContext(), Elts);
2535 return ConstantVector::getSplat(NumElts, V);
2539 /// getElementAsInteger - If this is a sequential container of integers (of
2540 /// any size), return the specified element in the low bits of a uint64_t.
2541 uint64_t ConstantDataSequential::getElementAsInteger(unsigned Elt) const {
2542 assert(isa<IntegerType>(getElementType()) &&
2543 "Accessor can only be used when element is an integer");
2544 const char *EltPtr = getElementPointer(Elt);
2546 // The data is stored in host byte order, make sure to cast back to the right
2547 // type to load with the right endianness.
2548 switch (getElementType()->getIntegerBitWidth()) {
2549 default: llvm_unreachable("Invalid bitwidth for CDS");
2551 return *const_cast<uint8_t *>(reinterpret_cast<const uint8_t *>(EltPtr));
2553 return *const_cast<uint16_t *>(reinterpret_cast<const uint16_t *>(EltPtr));
2555 return *const_cast<uint32_t *>(reinterpret_cast<const uint32_t *>(EltPtr));
2557 return *const_cast<uint64_t *>(reinterpret_cast<const uint64_t *>(EltPtr));
2561 /// getElementAsAPFloat - If this is a sequential container of floating point
2562 /// type, return the specified element as an APFloat.
2563 APFloat ConstantDataSequential::getElementAsAPFloat(unsigned Elt) const {
2564 const char *EltPtr = getElementPointer(Elt);
2566 switch (getElementType()->getTypeID()) {
2568 llvm_unreachable("Accessor can only be used when element is float/double!");
2569 case Type::FloatTyID: {
2570 const float *FloatPrt = reinterpret_cast<const float *>(EltPtr);
2571 return APFloat(*const_cast<float *>(FloatPrt));
2573 case Type::DoubleTyID: {
2574 const double *DoublePtr = reinterpret_cast<const double *>(EltPtr);
2575 return APFloat(*const_cast<double *>(DoublePtr));
2580 /// getElementAsFloat - If this is an sequential container of floats, return
2581 /// the specified element as a float.
2582 float ConstantDataSequential::getElementAsFloat(unsigned Elt) const {
2583 assert(getElementType()->isFloatTy() &&
2584 "Accessor can only be used when element is a 'float'");
2585 const float *EltPtr = reinterpret_cast<const float *>(getElementPointer(Elt));
2586 return *const_cast<float *>(EltPtr);
2589 /// getElementAsDouble - If this is an sequential container of doubles, return
2590 /// the specified element as a float.
2591 double ConstantDataSequential::getElementAsDouble(unsigned Elt) const {
2592 assert(getElementType()->isDoubleTy() &&
2593 "Accessor can only be used when element is a 'float'");
2594 const double *EltPtr =
2595 reinterpret_cast<const double *>(getElementPointer(Elt));
2596 return *const_cast<double *>(EltPtr);
2599 /// getElementAsConstant - Return a Constant for a specified index's element.
2600 /// Note that this has to compute a new constant to return, so it isn't as
2601 /// efficient as getElementAsInteger/Float/Double.
2602 Constant *ConstantDataSequential::getElementAsConstant(unsigned Elt) const {
2603 if (getElementType()->isFloatTy() || getElementType()->isDoubleTy())
2604 return ConstantFP::get(getContext(), getElementAsAPFloat(Elt));
2606 return ConstantInt::get(getElementType(), getElementAsInteger(Elt));
2609 /// isString - This method returns true if this is an array of i8.
2610 bool ConstantDataSequential::isString() const {
2611 return isa<ArrayType>(getType()) && getElementType()->isIntegerTy(8);
2614 /// isCString - This method returns true if the array "isString", ends with a
2615 /// nul byte, and does not contains any other nul bytes.
2616 bool ConstantDataSequential::isCString() const {
2620 StringRef Str = getAsString();
2622 // The last value must be nul.
2623 if (Str.back() != 0) return false;
2625 // Other elements must be non-nul.
2626 return Str.drop_back().find(0) == StringRef::npos;
2629 /// getSplatValue - If this is a splat constant, meaning that all of the
2630 /// elements have the same value, return that value. Otherwise return NULL.
2631 Constant *ConstantDataVector::getSplatValue() const {
2632 const char *Base = getRawDataValues().data();
2634 // Compare elements 1+ to the 0'th element.
2635 unsigned EltSize = getElementByteSize();
2636 for (unsigned i = 1, e = getNumElements(); i != e; ++i)
2637 if (memcmp(Base, Base+i*EltSize, EltSize))
2640 // If they're all the same, return the 0th one as a representative.
2641 return getElementAsConstant(0);
2644 //===----------------------------------------------------------------------===//
2645 // replaceUsesOfWithOnConstant implementations
2647 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2648 /// 'From' to be uses of 'To'. This must update the uniquing data structures
2651 /// Note that we intentionally replace all uses of From with To here. Consider
2652 /// a large array that uses 'From' 1000 times. By handling this case all here,
2653 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2654 /// single invocation handles all 1000 uses. Handling them one at a time would
2655 /// work, but would be really slow because it would have to unique each updated
2658 void Constant::replaceUsesOfWithOnConstantImpl(Constant *Replacement) {
2659 // I do need to replace this with an existing value.
2660 assert(Replacement != this && "I didn't contain From!");
2662 // Everyone using this now uses the replacement.
2663 replaceAllUsesWith(Replacement);
2665 // Delete the old constant!
2669 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2671 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2672 Constant *ToC = cast<Constant>(To);
2674 LLVMContextImpl *pImpl = getType()->getContext().pImpl;
2676 SmallVector<Constant*, 8> Values;
2677 Values.reserve(getNumOperands()); // Build replacement array.
2679 // Fill values with the modified operands of the constant array. Also,
2680 // compute whether this turns into an all-zeros array.
2681 unsigned NumUpdated = 0;
2683 // Keep track of whether all the values in the array are "ToC".
2684 bool AllSame = true;
2685 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2686 Constant *Val = cast<Constant>(O->get());
2691 Values.push_back(Val);
2692 AllSame &= Val == ToC;
2695 if (AllSame && ToC->isNullValue()) {
2696 replaceUsesOfWithOnConstantImpl(ConstantAggregateZero::get(getType()));
2699 if (AllSame && isa<UndefValue>(ToC)) {
2700 replaceUsesOfWithOnConstantImpl(UndefValue::get(getType()));
2704 // Check for any other type of constant-folding.
2705 if (Constant *C = getImpl(getType(), Values)) {
2706 replaceUsesOfWithOnConstantImpl(C);
2710 // Check to see if we have this array type already.
2711 LLVMContextImpl::ArrayConstantsTy::LookupKey Lookup(
2712 cast<ArrayType>(getType()), makeArrayRef(Values));
2713 LLVMContextImpl::ArrayConstantsTy::MapTy::iterator I =
2714 pImpl->ArrayConstants.find(Lookup);
2716 if (I != pImpl->ArrayConstants.map_end()) {
2717 replaceUsesOfWithOnConstantImpl(I->first);
2721 // Okay, the new shape doesn't exist in the system yet. Instead of
2722 // creating a new constant array, inserting it, replaceallusesof'ing the
2723 // old with the new, then deleting the old... just update the current one
2725 pImpl->ArrayConstants.remove(this);
2727 // Update to the new value. Optimize for the case when we have a single
2728 // operand that we're changing, but handle bulk updates efficiently.
2729 if (NumUpdated == 1) {
2730 unsigned OperandToUpdate = U - OperandList;
2731 assert(getOperand(OperandToUpdate) == From &&
2732 "ReplaceAllUsesWith broken!");
2733 setOperand(OperandToUpdate, ToC);
2735 for (unsigned I = 0, E = getNumOperands(); I != E; ++I)
2736 if (getOperand(I) == From)
2739 pImpl->ArrayConstants.insert(this);
2742 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2744 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2745 Constant *ToC = cast<Constant>(To);
2747 unsigned OperandToUpdate = U-OperandList;
2748 assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2750 SmallVector<Constant*, 8> Values;
2751 Values.reserve(getNumOperands()); // Build replacement struct.
2753 // Fill values with the modified operands of the constant struct. Also,
2754 // compute whether this turns into an all-zeros struct.
2755 bool isAllZeros = false;
2756 bool isAllUndef = false;
2757 if (ToC->isNullValue()) {
2759 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2760 Constant *Val = cast<Constant>(O->get());
2761 Values.push_back(Val);
2762 if (isAllZeros) isAllZeros = Val->isNullValue();
2764 } else if (isa<UndefValue>(ToC)) {
2766 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2767 Constant *Val = cast<Constant>(O->get());
2768 Values.push_back(Val);
2769 if (isAllUndef) isAllUndef = isa<UndefValue>(Val);
2772 for (Use *O = OperandList, *E = OperandList + getNumOperands(); O != E; ++O)
2773 Values.push_back(cast<Constant>(O->get()));
2775 Values[OperandToUpdate] = ToC;
2777 LLVMContextImpl *pImpl = getContext().pImpl;
2780 replaceUsesOfWithOnConstantImpl(ConstantAggregateZero::get(getType()));
2784 replaceUsesOfWithOnConstantImpl(UndefValue::get(getType()));
2788 // Check to see if we have this struct type already.
2789 LLVMContextImpl::StructConstantsTy::LookupKey Lookup(
2790 cast<StructType>(getType()), makeArrayRef(Values));
2791 LLVMContextImpl::StructConstantsTy::MapTy::iterator I =
2792 pImpl->StructConstants.find(Lookup);
2794 if (I != pImpl->StructConstants.map_end()) {
2795 replaceUsesOfWithOnConstantImpl(I->first);
2799 // Okay, the new shape doesn't exist in the system yet. Instead of
2800 // creating a new constant struct, inserting it, replaceallusesof'ing the
2801 // old with the new, then deleting the old... just update the current one
2803 pImpl->StructConstants.remove(this);
2805 // Update to the new value.
2806 setOperand(OperandToUpdate, ToC);
2807 pImpl->StructConstants.insert(this);
2810 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2812 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2813 Constant *ToC = cast<Constant>(To);
2815 SmallVector<Constant*, 8> Values;
2816 Values.reserve(getNumOperands()); // Build replacement array...
2817 unsigned NumUpdated = 0;
2818 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2819 Constant *Val = getOperand(i);
2824 Values.push_back(Val);
2827 if (Constant *C = getImpl(Values)) {
2828 replaceUsesOfWithOnConstantImpl(C);
2832 // Update to the new value. Optimize for the case when we have a single
2833 // operand that we're changing, but handle bulk updates efficiently.
2834 auto &pImpl = getType()->getContext().pImpl;
2835 pImpl->VectorConstants.remove(this);
2837 if (NumUpdated == 1) {
2838 unsigned OperandToUpdate = U - OperandList;
2839 assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2840 setOperand(OperandToUpdate, ToC);
2842 for (unsigned I = 0, E = getNumOperands(); I != E; ++I)
2843 if (getOperand(I) == From)
2847 pImpl->VectorConstants.insert(this);
2850 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2852 assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2853 Constant *To = cast<Constant>(ToV);
2855 SmallVector<Constant*, 8> NewOps;
2856 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2857 Constant *Op = getOperand(i);
2858 NewOps.push_back(Op == From ? To : Op);
2861 Constant *Replacement = getWithOperands(NewOps);
2862 assert(Replacement != this && "I didn't contain From!");
2864 // Check if Replacement has no users (and is the same type). Ideally, this
2865 // check would be done *before* creating Replacement, but threading this
2866 // through constant-folding isn't trivial.
2867 if (canBecomeReplacement(Replacement)) {
2868 // Avoid unnecessary RAUW traffic.
2869 auto &ExprConstants = getType()->getContext().pImpl->ExprConstants;
2870 ExprConstants.remove(this);
2872 auto *CE = cast<ConstantExpr>(Replacement);
2873 for (unsigned I = 0, E = getNumOperands(); I != E; ++I)
2874 // Only set the operands that have actually changed.
2875 if (getOperand(I) != CE->getOperand(I))
2876 setOperand(I, CE->getOperand(I));
2878 CE->destroyConstant();
2879 ExprConstants.insert(this);
2883 // Everyone using this now uses the replacement.
2884 replaceAllUsesWith(Replacement);
2886 // Delete the old constant!
2890 bool ConstantExpr::canBecomeReplacement(const Constant *Replacement) const {
2891 // If Replacement already has users, use it regardless.
2892 if (!Replacement->use_empty())
2895 // Check for anything that could have changed during constant-folding.
2896 if (getValueID() != Replacement->getValueID())
2898 const auto *CE = cast<ConstantExpr>(Replacement);
2899 if (getOpcode() != CE->getOpcode())
2901 if (getNumOperands() != CE->getNumOperands())
2903 if (getRawSubclassOptionalData() != CE->getRawSubclassOptionalData())
2906 if (getPredicate() != CE->getPredicate())
2909 if (getIndices() != CE->getIndices())
2915 Instruction *ConstantExpr::getAsInstruction() {
2916 SmallVector<Value*,4> ValueOperands;
2917 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
2918 ValueOperands.push_back(cast<Value>(I));
2920 ArrayRef<Value*> Ops(ValueOperands);
2922 switch (getOpcode()) {
2923 case Instruction::Trunc:
2924 case Instruction::ZExt:
2925 case Instruction::SExt:
2926 case Instruction::FPTrunc:
2927 case Instruction::FPExt:
2928 case Instruction::UIToFP:
2929 case Instruction::SIToFP:
2930 case Instruction::FPToUI:
2931 case Instruction::FPToSI:
2932 case Instruction::PtrToInt:
2933 case Instruction::IntToPtr:
2934 case Instruction::BitCast:
2935 case Instruction::AddrSpaceCast:
2936 return CastInst::Create((Instruction::CastOps)getOpcode(),
2938 case Instruction::Select:
2939 return SelectInst::Create(Ops[0], Ops[1], Ops[2]);
2940 case Instruction::InsertElement:
2941 return InsertElementInst::Create(Ops[0], Ops[1], Ops[2]);
2942 case Instruction::ExtractElement:
2943 return ExtractElementInst::Create(Ops[0], Ops[1]);
2944 case Instruction::InsertValue:
2945 return InsertValueInst::Create(Ops[0], Ops[1], getIndices());
2946 case Instruction::ExtractValue:
2947 return ExtractValueInst::Create(Ops[0], getIndices());
2948 case Instruction::ShuffleVector:
2949 return new ShuffleVectorInst(Ops[0], Ops[1], Ops[2]);
2951 case Instruction::GetElementPtr:
2952 if (cast<GEPOperator>(this)->isInBounds())
2953 return GetElementPtrInst::CreateInBounds(Ops[0], Ops.slice(1));
2955 return GetElementPtrInst::Create(Ops[0], Ops.slice(1));
2957 case Instruction::ICmp:
2958 case Instruction::FCmp:
2959 return CmpInst::Create((Instruction::OtherOps)getOpcode(),
2960 getPredicate(), Ops[0], Ops[1]);
2963 assert(getNumOperands() == 2 && "Must be binary operator?");
2964 BinaryOperator *BO =
2965 BinaryOperator::Create((Instruction::BinaryOps)getOpcode(),
2967 if (isa<OverflowingBinaryOperator>(BO)) {
2968 BO->setHasNoUnsignedWrap(SubclassOptionalData &
2969 OverflowingBinaryOperator::NoUnsignedWrap);
2970 BO->setHasNoSignedWrap(SubclassOptionalData &
2971 OverflowingBinaryOperator::NoSignedWrap);
2973 if (isa<PossiblyExactOperator>(BO))
2974 BO->setIsExact(SubclassOptionalData & PossiblyExactOperator::IsExact);