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 // Empty arrays are canonicalized to ConstantAggregateZero.
808 return ConstantAggregateZero::get(Ty);
810 for (unsigned i = 0, e = V.size(); i != e; ++i) {
811 assert(V[i]->getType() == Ty->getElementType() &&
812 "Wrong type in array element initializer");
814 LLVMContextImpl *pImpl = Ty->getContext().pImpl;
816 // If this is an all-zero array, return a ConstantAggregateZero object. If
817 // all undef, return an UndefValue, if "all simple", then return a
818 // ConstantDataArray.
820 if (isa<UndefValue>(C) && rangeOnlyContains(V.begin(), V.end(), C))
821 return UndefValue::get(Ty);
823 if (C->isNullValue() && rangeOnlyContains(V.begin(), V.end(), C))
824 return ConstantAggregateZero::get(Ty);
826 // Check to see if all of the elements are ConstantFP or ConstantInt and if
827 // the element type is compatible with ConstantDataVector. If so, use it.
828 if (ConstantDataSequential::isElementTypeCompatible(C->getType())) {
829 // We speculatively build the elements here even if it turns out that there
830 // is a constantexpr or something else weird in the array, since it is so
831 // uncommon for that to happen.
832 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
833 if (CI->getType()->isIntegerTy(8)) {
834 SmallVector<uint8_t, 16> Elts;
835 for (unsigned i = 0, e = V.size(); i != e; ++i)
836 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
837 Elts.push_back(CI->getZExtValue());
840 if (Elts.size() == V.size())
841 return ConstantDataArray::get(C->getContext(), Elts);
842 } else if (CI->getType()->isIntegerTy(16)) {
843 SmallVector<uint16_t, 16> Elts;
844 for (unsigned i = 0, e = V.size(); i != e; ++i)
845 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
846 Elts.push_back(CI->getZExtValue());
849 if (Elts.size() == V.size())
850 return ConstantDataArray::get(C->getContext(), Elts);
851 } else if (CI->getType()->isIntegerTy(32)) {
852 SmallVector<uint32_t, 16> Elts;
853 for (unsigned i = 0, e = V.size(); i != e; ++i)
854 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
855 Elts.push_back(CI->getZExtValue());
858 if (Elts.size() == V.size())
859 return ConstantDataArray::get(C->getContext(), Elts);
860 } else if (CI->getType()->isIntegerTy(64)) {
861 SmallVector<uint64_t, 16> Elts;
862 for (unsigned i = 0, e = V.size(); i != e; ++i)
863 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
864 Elts.push_back(CI->getZExtValue());
867 if (Elts.size() == V.size())
868 return ConstantDataArray::get(C->getContext(), Elts);
872 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
873 if (CFP->getType()->isFloatTy()) {
874 SmallVector<float, 16> Elts;
875 for (unsigned i = 0, e = V.size(); i != e; ++i)
876 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
877 Elts.push_back(CFP->getValueAPF().convertToFloat());
880 if (Elts.size() == V.size())
881 return ConstantDataArray::get(C->getContext(), Elts);
882 } else if (CFP->getType()->isDoubleTy()) {
883 SmallVector<double, 16> Elts;
884 for (unsigned i = 0, e = V.size(); i != e; ++i)
885 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
886 Elts.push_back(CFP->getValueAPF().convertToDouble());
889 if (Elts.size() == V.size())
890 return ConstantDataArray::get(C->getContext(), Elts);
895 // Otherwise, we really do want to create a ConstantArray.
896 return pImpl->ArrayConstants.getOrCreate(Ty, V);
899 /// getTypeForElements - Return an anonymous struct type to use for a constant
900 /// with the specified set of elements. The list must not be empty.
901 StructType *ConstantStruct::getTypeForElements(LLVMContext &Context,
902 ArrayRef<Constant*> V,
904 unsigned VecSize = V.size();
905 SmallVector<Type*, 16> EltTypes(VecSize);
906 for (unsigned i = 0; i != VecSize; ++i)
907 EltTypes[i] = V[i]->getType();
909 return StructType::get(Context, EltTypes, Packed);
913 StructType *ConstantStruct::getTypeForElements(ArrayRef<Constant*> V,
916 "ConstantStruct::getTypeForElements cannot be called on empty list");
917 return getTypeForElements(V[0]->getContext(), V, Packed);
921 ConstantStruct::ConstantStruct(StructType *T, ArrayRef<Constant *> V)
922 : Constant(T, ConstantStructVal,
923 OperandTraits<ConstantStruct>::op_end(this) - V.size(),
925 assert(V.size() == T->getNumElements() &&
926 "Invalid initializer vector for constant structure");
927 for (unsigned i = 0, e = V.size(); i != e; ++i)
928 assert((T->isOpaque() || V[i]->getType() == T->getElementType(i)) &&
929 "Initializer for struct element doesn't match struct element type!");
930 std::copy(V.begin(), V.end(), op_begin());
933 // ConstantStruct accessors.
934 Constant *ConstantStruct::get(StructType *ST, ArrayRef<Constant*> V) {
935 assert((ST->isOpaque() || ST->getNumElements() == V.size()) &&
936 "Incorrect # elements specified to ConstantStruct::get");
938 // Create a ConstantAggregateZero value if all elements are zeros.
940 bool isUndef = false;
943 isUndef = isa<UndefValue>(V[0]);
944 isZero = V[0]->isNullValue();
945 if (isUndef || isZero) {
946 for (unsigned i = 0, e = V.size(); i != e; ++i) {
947 if (!V[i]->isNullValue())
949 if (!isa<UndefValue>(V[i]))
955 return ConstantAggregateZero::get(ST);
957 return UndefValue::get(ST);
959 return ST->getContext().pImpl->StructConstants.getOrCreate(ST, V);
962 Constant *ConstantStruct::get(StructType *T, ...) {
964 SmallVector<Constant*, 8> Values;
966 while (Constant *Val = va_arg(ap, llvm::Constant*))
967 Values.push_back(Val);
969 return get(T, Values);
972 ConstantVector::ConstantVector(VectorType *T, ArrayRef<Constant *> V)
973 : Constant(T, ConstantVectorVal,
974 OperandTraits<ConstantVector>::op_end(this) - V.size(),
976 for (size_t i = 0, e = V.size(); i != e; i++)
977 assert(V[i]->getType() == T->getElementType() &&
978 "Initializer for vector element doesn't match vector element type!");
979 std::copy(V.begin(), V.end(), op_begin());
982 // ConstantVector accessors.
983 Constant *ConstantVector::get(ArrayRef<Constant*> V) {
984 assert(!V.empty() && "Vectors can't be empty");
985 VectorType *T = VectorType::get(V.front()->getType(), V.size());
986 LLVMContextImpl *pImpl = T->getContext().pImpl;
988 // If this is an all-undef or all-zero vector, return a
989 // ConstantAggregateZero or UndefValue.
991 bool isZero = C->isNullValue();
992 bool isUndef = isa<UndefValue>(C);
994 if (isZero || isUndef) {
995 for (unsigned i = 1, e = V.size(); i != e; ++i)
997 isZero = isUndef = false;
1003 return ConstantAggregateZero::get(T);
1005 return UndefValue::get(T);
1007 // Check to see if all of the elements are ConstantFP or ConstantInt and if
1008 // the element type is compatible with ConstantDataVector. If so, use it.
1009 if (ConstantDataSequential::isElementTypeCompatible(C->getType())) {
1010 // We speculatively build the elements here even if it turns out that there
1011 // is a constantexpr or something else weird in the array, since it is so
1012 // uncommon for that to happen.
1013 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
1014 if (CI->getType()->isIntegerTy(8)) {
1015 SmallVector<uint8_t, 16> Elts;
1016 for (unsigned i = 0, e = V.size(); i != e; ++i)
1017 if (ConstantInt *CI = dyn_cast<ConstantInt>(V[i]))
1018 Elts.push_back(CI->getZExtValue());
1021 if (Elts.size() == V.size())
1022 return ConstantDataVector::get(C->getContext(), Elts);
1023 } else if (CI->getType()->isIntegerTy(16)) {
1024 SmallVector<uint16_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(32)) {
1033 SmallVector<uint32_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(64)) {
1042 SmallVector<uint64_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);
1053 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
1054 if (CFP->getType()->isFloatTy()) {
1055 SmallVector<float, 16> Elts;
1056 for (unsigned i = 0, e = V.size(); i != e; ++i)
1057 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V[i]))
1058 Elts.push_back(CFP->getValueAPF().convertToFloat());
1061 if (Elts.size() == V.size())
1062 return ConstantDataVector::get(C->getContext(), Elts);
1063 } else if (CFP->getType()->isDoubleTy()) {
1064 SmallVector<double, 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().convertToDouble());
1070 if (Elts.size() == V.size())
1071 return ConstantDataVector::get(C->getContext(), Elts);
1076 // Otherwise, the element type isn't compatible with ConstantDataVector, or
1077 // the operand list constants a ConstantExpr or something else strange.
1078 return pImpl->VectorConstants.getOrCreate(T, V);
1081 Constant *ConstantVector::getSplat(unsigned NumElts, Constant *V) {
1082 // If this splat is compatible with ConstantDataVector, use it instead of
1084 if ((isa<ConstantFP>(V) || isa<ConstantInt>(V)) &&
1085 ConstantDataSequential::isElementTypeCompatible(V->getType()))
1086 return ConstantDataVector::getSplat(NumElts, V);
1088 SmallVector<Constant*, 32> Elts(NumElts, V);
1093 // Utility function for determining if a ConstantExpr is a CastOp or not. This
1094 // can't be inline because we don't want to #include Instruction.h into
1096 bool ConstantExpr::isCast() const {
1097 return Instruction::isCast(getOpcode());
1100 bool ConstantExpr::isCompare() const {
1101 return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
1104 bool ConstantExpr::isGEPWithNoNotionalOverIndexing() const {
1105 if (getOpcode() != Instruction::GetElementPtr) return false;
1107 gep_type_iterator GEPI = gep_type_begin(this), E = gep_type_end(this);
1108 User::const_op_iterator OI = std::next(this->op_begin());
1110 // Skip the first index, as it has no static limit.
1114 // The remaining indices must be compile-time known integers within the
1115 // bounds of the corresponding notional static array types.
1116 for (; GEPI != E; ++GEPI, ++OI) {
1117 ConstantInt *CI = dyn_cast<ConstantInt>(*OI);
1118 if (!CI) return false;
1119 if (ArrayType *ATy = dyn_cast<ArrayType>(*GEPI))
1120 if (CI->getValue().getActiveBits() > 64 ||
1121 CI->getZExtValue() >= ATy->getNumElements())
1125 // All the indices checked out.
1129 bool ConstantExpr::hasIndices() const {
1130 return getOpcode() == Instruction::ExtractValue ||
1131 getOpcode() == Instruction::InsertValue;
1134 ArrayRef<unsigned> ConstantExpr::getIndices() const {
1135 if (const ExtractValueConstantExpr *EVCE =
1136 dyn_cast<ExtractValueConstantExpr>(this))
1137 return EVCE->Indices;
1139 return cast<InsertValueConstantExpr>(this)->Indices;
1142 unsigned ConstantExpr::getPredicate() const {
1143 assert(isCompare());
1144 return ((const CompareConstantExpr*)this)->predicate;
1147 /// getWithOperandReplaced - Return a constant expression identical to this
1148 /// one, but with the specified operand set to the specified value.
1150 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
1151 assert(Op->getType() == getOperand(OpNo)->getType() &&
1152 "Replacing operand with value of different type!");
1153 if (getOperand(OpNo) == Op)
1154 return const_cast<ConstantExpr*>(this);
1156 SmallVector<Constant*, 8> NewOps;
1157 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1158 NewOps.push_back(i == OpNo ? Op : getOperand(i));
1160 return getWithOperands(NewOps);
1163 /// getWithOperands - This returns the current constant expression with the
1164 /// operands replaced with the specified values. The specified array must
1165 /// have the same number of operands as our current one.
1166 Constant *ConstantExpr::
1167 getWithOperands(ArrayRef<Constant*> Ops, Type *Ty) const {
1168 assert(Ops.size() == getNumOperands() && "Operand count mismatch!");
1169 bool AnyChange = Ty != getType();
1170 for (unsigned i = 0; i != Ops.size(); ++i)
1171 AnyChange |= Ops[i] != getOperand(i);
1173 if (!AnyChange) // No operands changed, return self.
1174 return const_cast<ConstantExpr*>(this);
1176 switch (getOpcode()) {
1177 case Instruction::Trunc:
1178 case Instruction::ZExt:
1179 case Instruction::SExt:
1180 case Instruction::FPTrunc:
1181 case Instruction::FPExt:
1182 case Instruction::UIToFP:
1183 case Instruction::SIToFP:
1184 case Instruction::FPToUI:
1185 case Instruction::FPToSI:
1186 case Instruction::PtrToInt:
1187 case Instruction::IntToPtr:
1188 case Instruction::BitCast:
1189 case Instruction::AddrSpaceCast:
1190 return ConstantExpr::getCast(getOpcode(), Ops[0], Ty);
1191 case Instruction::Select:
1192 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
1193 case Instruction::InsertElement:
1194 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
1195 case Instruction::ExtractElement:
1196 return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
1197 case Instruction::InsertValue:
1198 return ConstantExpr::getInsertValue(Ops[0], Ops[1], getIndices());
1199 case Instruction::ExtractValue:
1200 return ConstantExpr::getExtractValue(Ops[0], getIndices());
1201 case Instruction::ShuffleVector:
1202 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
1203 case Instruction::GetElementPtr:
1204 return ConstantExpr::getGetElementPtr(Ops[0], Ops.slice(1),
1205 cast<GEPOperator>(this)->isInBounds());
1206 case Instruction::ICmp:
1207 case Instruction::FCmp:
1208 return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
1210 assert(getNumOperands() == 2 && "Must be binary operator?");
1211 return ConstantExpr::get(getOpcode(), Ops[0], Ops[1], SubclassOptionalData);
1216 //===----------------------------------------------------------------------===//
1217 // isValueValidForType implementations
1219 bool ConstantInt::isValueValidForType(Type *Ty, uint64_t Val) {
1220 unsigned NumBits = Ty->getIntegerBitWidth(); // assert okay
1221 if (Ty->isIntegerTy(1))
1222 return Val == 0 || Val == 1;
1224 return true; // always true, has to fit in largest type
1225 uint64_t Max = (1ll << NumBits) - 1;
1229 bool ConstantInt::isValueValidForType(Type *Ty, int64_t Val) {
1230 unsigned NumBits = Ty->getIntegerBitWidth();
1231 if (Ty->isIntegerTy(1))
1232 return Val == 0 || Val == 1 || Val == -1;
1234 return true; // always true, has to fit in largest type
1235 int64_t Min = -(1ll << (NumBits-1));
1236 int64_t Max = (1ll << (NumBits-1)) - 1;
1237 return (Val >= Min && Val <= Max);
1240 bool ConstantFP::isValueValidForType(Type *Ty, const APFloat& Val) {
1241 // convert modifies in place, so make a copy.
1242 APFloat Val2 = APFloat(Val);
1244 switch (Ty->getTypeID()) {
1246 return false; // These can't be represented as floating point!
1248 // FIXME rounding mode needs to be more flexible
1249 case Type::HalfTyID: {
1250 if (&Val2.getSemantics() == &APFloat::IEEEhalf)
1252 Val2.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &losesInfo);
1255 case Type::FloatTyID: {
1256 if (&Val2.getSemantics() == &APFloat::IEEEsingle)
1258 Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
1261 case Type::DoubleTyID: {
1262 if (&Val2.getSemantics() == &APFloat::IEEEhalf ||
1263 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1264 &Val2.getSemantics() == &APFloat::IEEEdouble)
1266 Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
1269 case Type::X86_FP80TyID:
1270 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1271 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1272 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1273 &Val2.getSemantics() == &APFloat::x87DoubleExtended;
1274 case Type::FP128TyID:
1275 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1276 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1277 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1278 &Val2.getSemantics() == &APFloat::IEEEquad;
1279 case Type::PPC_FP128TyID:
1280 return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1281 &Val2.getSemantics() == &APFloat::IEEEsingle ||
1282 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1283 &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
1288 //===----------------------------------------------------------------------===//
1289 // Factory Function Implementation
1291 ConstantAggregateZero *ConstantAggregateZero::get(Type *Ty) {
1292 assert((Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()) &&
1293 "Cannot create an aggregate zero of non-aggregate type!");
1295 ConstantAggregateZero *&Entry = Ty->getContext().pImpl->CAZConstants[Ty];
1297 Entry = new ConstantAggregateZero(Ty);
1302 /// destroyConstant - Remove the constant from the constant table.
1304 void ConstantAggregateZero::destroyConstant() {
1305 getContext().pImpl->CAZConstants.erase(getType());
1306 destroyConstantImpl();
1309 /// destroyConstant - Remove the constant from the constant table...
1311 void ConstantArray::destroyConstant() {
1312 getType()->getContext().pImpl->ArrayConstants.remove(this);
1313 destroyConstantImpl();
1317 //---- ConstantStruct::get() implementation...
1320 // destroyConstant - Remove the constant from the constant table...
1322 void ConstantStruct::destroyConstant() {
1323 getType()->getContext().pImpl->StructConstants.remove(this);
1324 destroyConstantImpl();
1327 // destroyConstant - Remove the constant from the constant table...
1329 void ConstantVector::destroyConstant() {
1330 getType()->getContext().pImpl->VectorConstants.remove(this);
1331 destroyConstantImpl();
1334 /// getSplatValue - If this is a splat vector constant, meaning that all of
1335 /// the elements have the same value, return that value. Otherwise return 0.
1336 Constant *Constant::getSplatValue() const {
1337 assert(this->getType()->isVectorTy() && "Only valid for vectors!");
1338 if (isa<ConstantAggregateZero>(this))
1339 return getNullValue(this->getType()->getVectorElementType());
1340 if (const ConstantDataVector *CV = dyn_cast<ConstantDataVector>(this))
1341 return CV->getSplatValue();
1342 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
1343 return CV->getSplatValue();
1347 /// getSplatValue - If this is a splat constant, where all of the
1348 /// elements have the same value, return that value. Otherwise return null.
1349 Constant *ConstantVector::getSplatValue() const {
1350 // Check out first element.
1351 Constant *Elt = getOperand(0);
1352 // Then make sure all remaining elements point to the same value.
1353 for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1354 if (getOperand(I) != Elt)
1359 /// If C is a constant integer then return its value, otherwise C must be a
1360 /// vector of constant integers, all equal, and the common value is returned.
1361 const APInt &Constant::getUniqueInteger() const {
1362 if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
1363 return CI->getValue();
1364 assert(this->getSplatValue() && "Doesn't contain a unique integer!");
1365 const Constant *C = this->getAggregateElement(0U);
1366 assert(C && isa<ConstantInt>(C) && "Not a vector of numbers!");
1367 return cast<ConstantInt>(C)->getValue();
1371 //---- ConstantPointerNull::get() implementation.
1374 ConstantPointerNull *ConstantPointerNull::get(PointerType *Ty) {
1375 ConstantPointerNull *&Entry = Ty->getContext().pImpl->CPNConstants[Ty];
1377 Entry = new ConstantPointerNull(Ty);
1382 // destroyConstant - Remove the constant from the constant table...
1384 void ConstantPointerNull::destroyConstant() {
1385 getContext().pImpl->CPNConstants.erase(getType());
1386 // Free the constant and any dangling references to it.
1387 destroyConstantImpl();
1391 //---- UndefValue::get() implementation.
1394 UndefValue *UndefValue::get(Type *Ty) {
1395 UndefValue *&Entry = Ty->getContext().pImpl->UVConstants[Ty];
1397 Entry = new UndefValue(Ty);
1402 // destroyConstant - Remove the constant from the constant table.
1404 void UndefValue::destroyConstant() {
1405 // Free the constant and any dangling references to it.
1406 getContext().pImpl->UVConstants.erase(getType());
1407 destroyConstantImpl();
1410 //---- BlockAddress::get() implementation.
1413 BlockAddress *BlockAddress::get(BasicBlock *BB) {
1414 assert(BB->getParent() && "Block must have a parent");
1415 return get(BB->getParent(), BB);
1418 BlockAddress *BlockAddress::get(Function *F, BasicBlock *BB) {
1420 F->getContext().pImpl->BlockAddresses[std::make_pair(F, BB)];
1422 BA = new BlockAddress(F, BB);
1424 assert(BA->getFunction() == F && "Basic block moved between functions");
1428 BlockAddress::BlockAddress(Function *F, BasicBlock *BB)
1429 : Constant(Type::getInt8PtrTy(F->getContext()), Value::BlockAddressVal,
1433 BB->AdjustBlockAddressRefCount(1);
1436 BlockAddress *BlockAddress::lookup(const BasicBlock *BB) {
1437 if (!BB->hasAddressTaken())
1440 const Function *F = BB->getParent();
1441 assert(F && "Block must have a parent");
1443 F->getContext().pImpl->BlockAddresses.lookup(std::make_pair(F, BB));
1444 assert(BA && "Refcount and block address map disagree!");
1448 // destroyConstant - Remove the constant from the constant table.
1450 void BlockAddress::destroyConstant() {
1451 getFunction()->getType()->getContext().pImpl
1452 ->BlockAddresses.erase(std::make_pair(getFunction(), getBasicBlock()));
1453 getBasicBlock()->AdjustBlockAddressRefCount(-1);
1454 destroyConstantImpl();
1457 void BlockAddress::replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) {
1458 // This could be replacing either the Basic Block or the Function. In either
1459 // case, we have to remove the map entry.
1460 Function *NewF = getFunction();
1461 BasicBlock *NewBB = getBasicBlock();
1464 NewF = cast<Function>(To->stripPointerCasts());
1466 NewBB = cast<BasicBlock>(To);
1468 // See if the 'new' entry already exists, if not, just update this in place
1469 // and return early.
1470 BlockAddress *&NewBA =
1471 getContext().pImpl->BlockAddresses[std::make_pair(NewF, NewBB)];
1473 getBasicBlock()->AdjustBlockAddressRefCount(-1);
1475 // Remove the old entry, this can't cause the map to rehash (just a
1476 // tombstone will get added).
1477 getContext().pImpl->BlockAddresses.erase(std::make_pair(getFunction(),
1480 setOperand(0, NewF);
1481 setOperand(1, NewBB);
1482 getBasicBlock()->AdjustBlockAddressRefCount(1);
1486 // Otherwise, I do need to replace this with an existing value.
1487 assert(NewBA != this && "I didn't contain From!");
1489 // Everyone using this now uses the replacement.
1490 replaceAllUsesWith(NewBA);
1495 //---- ConstantExpr::get() implementations.
1498 /// This is a utility function to handle folding of casts and lookup of the
1499 /// cast in the ExprConstants map. It is used by the various get* methods below.
1500 static inline Constant *getFoldedCast(
1501 Instruction::CastOps opc, Constant *C, Type *Ty) {
1502 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1503 // Fold a few common cases
1504 if (Constant *FC = ConstantFoldCastInstruction(opc, C, Ty))
1507 LLVMContextImpl *pImpl = Ty->getContext().pImpl;
1509 // Look up the constant in the table first to ensure uniqueness.
1510 ExprMapKeyType Key(opc, C);
1512 return pImpl->ExprConstants.getOrCreate(Ty, Key);
1515 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, Type *Ty) {
1516 Instruction::CastOps opc = Instruction::CastOps(oc);
1517 assert(Instruction::isCast(opc) && "opcode out of range");
1518 assert(C && Ty && "Null arguments to getCast");
1519 assert(CastInst::castIsValid(opc, C, Ty) && "Invalid constantexpr cast!");
1523 llvm_unreachable("Invalid cast opcode");
1524 case Instruction::Trunc: return getTrunc(C, Ty);
1525 case Instruction::ZExt: return getZExt(C, Ty);
1526 case Instruction::SExt: return getSExt(C, Ty);
1527 case Instruction::FPTrunc: return getFPTrunc(C, Ty);
1528 case Instruction::FPExt: return getFPExtend(C, Ty);
1529 case Instruction::UIToFP: return getUIToFP(C, Ty);
1530 case Instruction::SIToFP: return getSIToFP(C, Ty);
1531 case Instruction::FPToUI: return getFPToUI(C, Ty);
1532 case Instruction::FPToSI: return getFPToSI(C, Ty);
1533 case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1534 case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1535 case Instruction::BitCast: return getBitCast(C, Ty);
1536 case Instruction::AddrSpaceCast: return getAddrSpaceCast(C, Ty);
1540 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, Type *Ty) {
1541 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1542 return getBitCast(C, Ty);
1543 return getZExt(C, Ty);
1546 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, Type *Ty) {
1547 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1548 return getBitCast(C, Ty);
1549 return getSExt(C, Ty);
1552 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, Type *Ty) {
1553 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1554 return getBitCast(C, Ty);
1555 return getTrunc(C, Ty);
1558 Constant *ConstantExpr::getPointerCast(Constant *S, Type *Ty) {
1559 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
1560 assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
1563 if (Ty->isIntOrIntVectorTy())
1564 return getPtrToInt(S, Ty);
1566 unsigned SrcAS = S->getType()->getPointerAddressSpace();
1567 if (Ty->isPtrOrPtrVectorTy() && SrcAS != Ty->getPointerAddressSpace())
1568 return getAddrSpaceCast(S, Ty);
1570 return getBitCast(S, Ty);
1573 Constant *ConstantExpr::getPointerBitCastOrAddrSpaceCast(Constant *S,
1575 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
1576 assert(Ty->isPtrOrPtrVectorTy() && "Invalid cast");
1578 if (S->getType()->getPointerAddressSpace() != Ty->getPointerAddressSpace())
1579 return getAddrSpaceCast(S, Ty);
1581 return getBitCast(S, Ty);
1584 Constant *ConstantExpr::getIntegerCast(Constant *C, Type *Ty,
1586 assert(C->getType()->isIntOrIntVectorTy() &&
1587 Ty->isIntOrIntVectorTy() && "Invalid cast");
1588 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1589 unsigned DstBits = Ty->getScalarSizeInBits();
1590 Instruction::CastOps opcode =
1591 (SrcBits == DstBits ? Instruction::BitCast :
1592 (SrcBits > DstBits ? Instruction::Trunc :
1593 (isSigned ? Instruction::SExt : Instruction::ZExt)));
1594 return getCast(opcode, C, Ty);
1597 Constant *ConstantExpr::getFPCast(Constant *C, Type *Ty) {
1598 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1600 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1601 unsigned DstBits = Ty->getScalarSizeInBits();
1602 if (SrcBits == DstBits)
1603 return C; // Avoid a useless cast
1604 Instruction::CastOps opcode =
1605 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1606 return getCast(opcode, C, Ty);
1609 Constant *ConstantExpr::getTrunc(Constant *C, Type *Ty) {
1611 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1612 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1614 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1615 assert(C->getType()->isIntOrIntVectorTy() && "Trunc operand must be integer");
1616 assert(Ty->isIntOrIntVectorTy() && "Trunc produces only integral");
1617 assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1618 "SrcTy must be larger than DestTy for Trunc!");
1620 return getFoldedCast(Instruction::Trunc, C, Ty);
1623 Constant *ConstantExpr::getSExt(Constant *C, Type *Ty) {
1625 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1626 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1628 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1629 assert(C->getType()->isIntOrIntVectorTy() && "SExt operand must be integral");
1630 assert(Ty->isIntOrIntVectorTy() && "SExt produces only integer");
1631 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1632 "SrcTy must be smaller than DestTy for SExt!");
1634 return getFoldedCast(Instruction::SExt, C, Ty);
1637 Constant *ConstantExpr::getZExt(Constant *C, Type *Ty) {
1639 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1640 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1642 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1643 assert(C->getType()->isIntOrIntVectorTy() && "ZEXt operand must be integral");
1644 assert(Ty->isIntOrIntVectorTy() && "ZExt produces only integer");
1645 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1646 "SrcTy must be smaller than DestTy for ZExt!");
1648 return getFoldedCast(Instruction::ZExt, C, Ty);
1651 Constant *ConstantExpr::getFPTrunc(Constant *C, Type *Ty) {
1653 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1654 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1656 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1657 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1658 C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1659 "This is an illegal floating point truncation!");
1660 return getFoldedCast(Instruction::FPTrunc, C, Ty);
1663 Constant *ConstantExpr::getFPExtend(Constant *C, Type *Ty) {
1665 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1666 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1668 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1669 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1670 C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1671 "This is an illegal floating point extension!");
1672 return getFoldedCast(Instruction::FPExt, C, Ty);
1675 Constant *ConstantExpr::getUIToFP(Constant *C, Type *Ty) {
1677 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1678 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1680 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1681 assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1682 "This is an illegal uint to floating point cast!");
1683 return getFoldedCast(Instruction::UIToFP, C, Ty);
1686 Constant *ConstantExpr::getSIToFP(Constant *C, Type *Ty) {
1688 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1689 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1691 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1692 assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1693 "This is an illegal sint to floating point cast!");
1694 return getFoldedCast(Instruction::SIToFP, C, Ty);
1697 Constant *ConstantExpr::getFPToUI(Constant *C, Type *Ty) {
1699 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1700 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1702 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1703 assert(C->getType()->isFPOrFPVectorTy() && Ty->isIntOrIntVectorTy() &&
1704 "This is an illegal floating point to uint cast!");
1705 return getFoldedCast(Instruction::FPToUI, C, Ty);
1708 Constant *ConstantExpr::getFPToSI(Constant *C, Type *Ty) {
1710 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1711 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1713 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1714 assert(C->getType()->isFPOrFPVectorTy() && Ty->isIntOrIntVectorTy() &&
1715 "This is an illegal floating point to sint cast!");
1716 return getFoldedCast(Instruction::FPToSI, C, Ty);
1719 Constant *ConstantExpr::getPtrToInt(Constant *C, Type *DstTy) {
1720 assert(C->getType()->getScalarType()->isPointerTy() &&
1721 "PtrToInt source must be pointer or pointer vector");
1722 assert(DstTy->getScalarType()->isIntegerTy() &&
1723 "PtrToInt destination must be integer or integer vector");
1724 assert(isa<VectorType>(C->getType()) == isa<VectorType>(DstTy));
1725 if (isa<VectorType>(C->getType()))
1726 assert(C->getType()->getVectorNumElements()==DstTy->getVectorNumElements()&&
1727 "Invalid cast between a different number of vector elements");
1728 return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1731 Constant *ConstantExpr::getIntToPtr(Constant *C, Type *DstTy) {
1732 assert(C->getType()->getScalarType()->isIntegerTy() &&
1733 "IntToPtr source must be integer or integer vector");
1734 assert(DstTy->getScalarType()->isPointerTy() &&
1735 "IntToPtr destination must be a pointer or pointer vector");
1736 assert(isa<VectorType>(C->getType()) == isa<VectorType>(DstTy));
1737 if (isa<VectorType>(C->getType()))
1738 assert(C->getType()->getVectorNumElements()==DstTy->getVectorNumElements()&&
1739 "Invalid cast between a different number of vector elements");
1740 return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1743 Constant *ConstantExpr::getBitCast(Constant *C, Type *DstTy) {
1744 assert(CastInst::castIsValid(Instruction::BitCast, C, DstTy) &&
1745 "Invalid constantexpr bitcast!");
1747 // It is common to ask for a bitcast of a value to its own type, handle this
1749 if (C->getType() == DstTy) return C;
1751 return getFoldedCast(Instruction::BitCast, C, DstTy);
1754 Constant *ConstantExpr::getAddrSpaceCast(Constant *C, Type *DstTy) {
1755 assert(CastInst::castIsValid(Instruction::AddrSpaceCast, C, DstTy) &&
1756 "Invalid constantexpr addrspacecast!");
1758 // Canonicalize addrspacecasts between different pointer types by first
1759 // bitcasting the pointer type and then converting the address space.
1760 PointerType *SrcScalarTy = cast<PointerType>(C->getType()->getScalarType());
1761 PointerType *DstScalarTy = cast<PointerType>(DstTy->getScalarType());
1762 Type *DstElemTy = DstScalarTy->getElementType();
1763 if (SrcScalarTy->getElementType() != DstElemTy) {
1764 Type *MidTy = PointerType::get(DstElemTy, SrcScalarTy->getAddressSpace());
1765 if (VectorType *VT = dyn_cast<VectorType>(DstTy)) {
1766 // Handle vectors of pointers.
1767 MidTy = VectorType::get(MidTy, VT->getNumElements());
1769 C = getBitCast(C, MidTy);
1771 return getFoldedCast(Instruction::AddrSpaceCast, C, DstTy);
1774 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2,
1776 // Check the operands for consistency first.
1777 assert(Opcode >= Instruction::BinaryOpsBegin &&
1778 Opcode < Instruction::BinaryOpsEnd &&
1779 "Invalid opcode in binary constant expression");
1780 assert(C1->getType() == C2->getType() &&
1781 "Operand types in binary constant expression should match");
1785 case Instruction::Add:
1786 case Instruction::Sub:
1787 case Instruction::Mul:
1788 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1789 assert(C1->getType()->isIntOrIntVectorTy() &&
1790 "Tried to create an integer operation on a non-integer type!");
1792 case Instruction::FAdd:
1793 case Instruction::FSub:
1794 case Instruction::FMul:
1795 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1796 assert(C1->getType()->isFPOrFPVectorTy() &&
1797 "Tried to create a floating-point operation on a "
1798 "non-floating-point type!");
1800 case Instruction::UDiv:
1801 case Instruction::SDiv:
1802 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1803 assert(C1->getType()->isIntOrIntVectorTy() &&
1804 "Tried to create an arithmetic operation on a non-arithmetic type!");
1806 case Instruction::FDiv:
1807 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1808 assert(C1->getType()->isFPOrFPVectorTy() &&
1809 "Tried to create an arithmetic operation on a non-arithmetic type!");
1811 case Instruction::URem:
1812 case Instruction::SRem:
1813 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1814 assert(C1->getType()->isIntOrIntVectorTy() &&
1815 "Tried to create an arithmetic operation on a non-arithmetic type!");
1817 case Instruction::FRem:
1818 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1819 assert(C1->getType()->isFPOrFPVectorTy() &&
1820 "Tried to create an arithmetic operation on a non-arithmetic type!");
1822 case Instruction::And:
1823 case Instruction::Or:
1824 case Instruction::Xor:
1825 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1826 assert(C1->getType()->isIntOrIntVectorTy() &&
1827 "Tried to create a logical operation on a non-integral type!");
1829 case Instruction::Shl:
1830 case Instruction::LShr:
1831 case Instruction::AShr:
1832 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1833 assert(C1->getType()->isIntOrIntVectorTy() &&
1834 "Tried to create a shift operation on a non-integer type!");
1841 if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1842 return FC; // Fold a few common cases.
1844 Constant *ArgVec[] = { C1, C2 };
1845 ExprMapKeyType Key(Opcode, ArgVec, 0, Flags);
1847 LLVMContextImpl *pImpl = C1->getContext().pImpl;
1848 return pImpl->ExprConstants.getOrCreate(C1->getType(), Key);
1851 Constant *ConstantExpr::getSizeOf(Type* Ty) {
1852 // sizeof is implemented as: (i64) gep (Ty*)null, 1
1853 // Note that a non-inbounds gep is used, as null isn't within any object.
1854 Constant *GEPIdx = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1855 Constant *GEP = getGetElementPtr(
1856 Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1857 return getPtrToInt(GEP,
1858 Type::getInt64Ty(Ty->getContext()));
1861 Constant *ConstantExpr::getAlignOf(Type* Ty) {
1862 // alignof is implemented as: (i64) gep ({i1,Ty}*)null, 0, 1
1863 // Note that a non-inbounds gep is used, as null isn't within any object.
1865 StructType::get(Type::getInt1Ty(Ty->getContext()), Ty, NULL);
1866 Constant *NullPtr = Constant::getNullValue(AligningTy->getPointerTo(0));
1867 Constant *Zero = ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0);
1868 Constant *One = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1869 Constant *Indices[2] = { Zero, One };
1870 Constant *GEP = getGetElementPtr(NullPtr, Indices);
1871 return getPtrToInt(GEP,
1872 Type::getInt64Ty(Ty->getContext()));
1875 Constant *ConstantExpr::getOffsetOf(StructType* STy, unsigned FieldNo) {
1876 return getOffsetOf(STy, ConstantInt::get(Type::getInt32Ty(STy->getContext()),
1880 Constant *ConstantExpr::getOffsetOf(Type* Ty, Constant *FieldNo) {
1881 // offsetof is implemented as: (i64) gep (Ty*)null, 0, FieldNo
1882 // Note that a non-inbounds gep is used, as null isn't within any object.
1883 Constant *GEPIdx[] = {
1884 ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0),
1887 Constant *GEP = getGetElementPtr(
1888 Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1889 return getPtrToInt(GEP,
1890 Type::getInt64Ty(Ty->getContext()));
1893 Constant *ConstantExpr::getCompare(unsigned short Predicate,
1894 Constant *C1, Constant *C2) {
1895 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1897 switch (Predicate) {
1898 default: llvm_unreachable("Invalid CmpInst predicate");
1899 case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1900 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1901 case CmpInst::FCMP_ONE: case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1902 case CmpInst::FCMP_UEQ: case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1903 case CmpInst::FCMP_ULT: case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1904 case CmpInst::FCMP_TRUE:
1905 return getFCmp(Predicate, C1, C2);
1907 case CmpInst::ICMP_EQ: case CmpInst::ICMP_NE: case CmpInst::ICMP_UGT:
1908 case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1909 case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1910 case CmpInst::ICMP_SLE:
1911 return getICmp(Predicate, C1, C2);
1915 Constant *ConstantExpr::getSelect(Constant *C, Constant *V1, Constant *V2) {
1916 assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1918 if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1919 return SC; // Fold common cases
1921 Constant *ArgVec[] = { C, V1, V2 };
1922 ExprMapKeyType Key(Instruction::Select, ArgVec);
1924 LLVMContextImpl *pImpl = C->getContext().pImpl;
1925 return pImpl->ExprConstants.getOrCreate(V1->getType(), Key);
1928 Constant *ConstantExpr::getGetElementPtr(Constant *C, ArrayRef<Value *> Idxs,
1930 assert(C->getType()->isPtrOrPtrVectorTy() &&
1931 "Non-pointer type for constant GetElementPtr expression");
1933 if (Constant *FC = ConstantFoldGetElementPtr(C, InBounds, Idxs))
1934 return FC; // Fold a few common cases.
1936 // Get the result type of the getelementptr!
1937 Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), Idxs);
1938 assert(Ty && "GEP indices invalid!");
1939 unsigned AS = C->getType()->getPointerAddressSpace();
1940 Type *ReqTy = Ty->getPointerTo(AS);
1941 if (VectorType *VecTy = dyn_cast<VectorType>(C->getType()))
1942 ReqTy = VectorType::get(ReqTy, VecTy->getNumElements());
1944 // Look up the constant in the table first to ensure uniqueness
1945 std::vector<Constant*> ArgVec;
1946 ArgVec.reserve(1 + Idxs.size());
1947 ArgVec.push_back(C);
1948 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
1949 assert(Idxs[i]->getType()->isVectorTy() == ReqTy->isVectorTy() &&
1950 "getelementptr index type missmatch");
1951 assert((!Idxs[i]->getType()->isVectorTy() ||
1952 ReqTy->getVectorNumElements() ==
1953 Idxs[i]->getType()->getVectorNumElements()) &&
1954 "getelementptr index type missmatch");
1955 ArgVec.push_back(cast<Constant>(Idxs[i]));
1957 const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec, 0,
1958 InBounds ? GEPOperator::IsInBounds : 0);
1960 LLVMContextImpl *pImpl = C->getContext().pImpl;
1961 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1965 ConstantExpr::getICmp(unsigned short pred, Constant *LHS, Constant *RHS) {
1966 assert(LHS->getType() == RHS->getType());
1967 assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
1968 pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1970 if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1971 return FC; // Fold a few common cases...
1973 // Look up the constant in the table first to ensure uniqueness
1974 Constant *ArgVec[] = { LHS, RHS };
1975 // Get the key type with both the opcode and predicate
1976 const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
1978 Type *ResultTy = Type::getInt1Ty(LHS->getContext());
1979 if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
1980 ResultTy = VectorType::get(ResultTy, VT->getNumElements());
1982 LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
1983 return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
1987 ConstantExpr::getFCmp(unsigned short pred, Constant *LHS, Constant *RHS) {
1988 assert(LHS->getType() == RHS->getType());
1989 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1991 if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1992 return FC; // Fold a few common cases...
1994 // Look up the constant in the table first to ensure uniqueness
1995 Constant *ArgVec[] = { LHS, RHS };
1996 // Get the key type with both the opcode and predicate
1997 const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
1999 Type *ResultTy = Type::getInt1Ty(LHS->getContext());
2000 if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
2001 ResultTy = VectorType::get(ResultTy, VT->getNumElements());
2003 LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
2004 return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
2007 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
2008 assert(Val->getType()->isVectorTy() &&
2009 "Tried to create extractelement operation on non-vector type!");
2010 assert(Idx->getType()->isIntegerTy() &&
2011 "Extractelement index must be an integer type!");
2013 if (Constant *FC = ConstantFoldExtractElementInstruction(Val, Idx))
2014 return FC; // Fold a few common cases.
2016 // Look up the constant in the table first to ensure uniqueness
2017 Constant *ArgVec[] = { Val, Idx };
2018 const ExprMapKeyType Key(Instruction::ExtractElement, ArgVec);
2020 LLVMContextImpl *pImpl = Val->getContext().pImpl;
2021 Type *ReqTy = Val->getType()->getVectorElementType();
2022 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2025 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
2027 assert(Val->getType()->isVectorTy() &&
2028 "Tried to create insertelement operation on non-vector type!");
2029 assert(Elt->getType() == Val->getType()->getVectorElementType() &&
2030 "Insertelement types must match!");
2031 assert(Idx->getType()->isIntegerTy() &&
2032 "Insertelement index must be i32 type!");
2034 if (Constant *FC = ConstantFoldInsertElementInstruction(Val, Elt, Idx))
2035 return FC; // Fold a few common cases.
2036 // Look up the constant in the table first to ensure uniqueness
2037 Constant *ArgVec[] = { Val, Elt, Idx };
2038 const ExprMapKeyType Key(Instruction::InsertElement, ArgVec);
2040 LLVMContextImpl *pImpl = Val->getContext().pImpl;
2041 return pImpl->ExprConstants.getOrCreate(Val->getType(), Key);
2044 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
2046 assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
2047 "Invalid shuffle vector constant expr operands!");
2049 if (Constant *FC = ConstantFoldShuffleVectorInstruction(V1, V2, Mask))
2050 return FC; // Fold a few common cases.
2052 unsigned NElts = Mask->getType()->getVectorNumElements();
2053 Type *EltTy = V1->getType()->getVectorElementType();
2054 Type *ShufTy = VectorType::get(EltTy, NElts);
2056 // Look up the constant in the table first to ensure uniqueness
2057 Constant *ArgVec[] = { V1, V2, Mask };
2058 const ExprMapKeyType Key(Instruction::ShuffleVector, ArgVec);
2060 LLVMContextImpl *pImpl = ShufTy->getContext().pImpl;
2061 return pImpl->ExprConstants.getOrCreate(ShufTy, Key);
2064 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
2065 ArrayRef<unsigned> Idxs) {
2066 assert(Agg->getType()->isFirstClassType() &&
2067 "Non-first-class type for constant insertvalue expression");
2069 assert(ExtractValueInst::getIndexedType(Agg->getType(),
2070 Idxs) == Val->getType() &&
2071 "insertvalue indices invalid!");
2072 Type *ReqTy = Val->getType();
2074 if (Constant *FC = ConstantFoldInsertValueInstruction(Agg, Val, Idxs))
2077 Constant *ArgVec[] = { Agg, Val };
2078 const ExprMapKeyType Key(Instruction::InsertValue, ArgVec, 0, 0, Idxs);
2080 LLVMContextImpl *pImpl = Agg->getContext().pImpl;
2081 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2084 Constant *ConstantExpr::getExtractValue(Constant *Agg,
2085 ArrayRef<unsigned> Idxs) {
2086 assert(Agg->getType()->isFirstClassType() &&
2087 "Tried to create extractelement operation on non-first-class type!");
2089 Type *ReqTy = ExtractValueInst::getIndexedType(Agg->getType(), Idxs);
2091 assert(ReqTy && "extractvalue indices invalid!");
2093 assert(Agg->getType()->isFirstClassType() &&
2094 "Non-first-class type for constant extractvalue expression");
2095 if (Constant *FC = ConstantFoldExtractValueInstruction(Agg, Idxs))
2098 Constant *ArgVec[] = { Agg };
2099 const ExprMapKeyType Key(Instruction::ExtractValue, ArgVec, 0, 0, Idxs);
2101 LLVMContextImpl *pImpl = Agg->getContext().pImpl;
2102 return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
2105 Constant *ConstantExpr::getNeg(Constant *C, bool HasNUW, bool HasNSW) {
2106 assert(C->getType()->isIntOrIntVectorTy() &&
2107 "Cannot NEG a nonintegral value!");
2108 return getSub(ConstantFP::getZeroValueForNegation(C->getType()),
2112 Constant *ConstantExpr::getFNeg(Constant *C) {
2113 assert(C->getType()->isFPOrFPVectorTy() &&
2114 "Cannot FNEG a non-floating-point value!");
2115 return getFSub(ConstantFP::getZeroValueForNegation(C->getType()), C);
2118 Constant *ConstantExpr::getNot(Constant *C) {
2119 assert(C->getType()->isIntOrIntVectorTy() &&
2120 "Cannot NOT a nonintegral value!");
2121 return get(Instruction::Xor, C, Constant::getAllOnesValue(C->getType()));
2124 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2,
2125 bool HasNUW, bool HasNSW) {
2126 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2127 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2128 return get(Instruction::Add, C1, C2, Flags);
2131 Constant *ConstantExpr::getFAdd(Constant *C1, Constant *C2) {
2132 return get(Instruction::FAdd, C1, C2);
2135 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2,
2136 bool HasNUW, bool HasNSW) {
2137 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2138 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2139 return get(Instruction::Sub, C1, C2, Flags);
2142 Constant *ConstantExpr::getFSub(Constant *C1, Constant *C2) {
2143 return get(Instruction::FSub, C1, C2);
2146 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2,
2147 bool HasNUW, bool HasNSW) {
2148 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2149 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2150 return get(Instruction::Mul, C1, C2, Flags);
2153 Constant *ConstantExpr::getFMul(Constant *C1, Constant *C2) {
2154 return get(Instruction::FMul, C1, C2);
2157 Constant *ConstantExpr::getUDiv(Constant *C1, Constant *C2, bool isExact) {
2158 return get(Instruction::UDiv, C1, C2,
2159 isExact ? PossiblyExactOperator::IsExact : 0);
2162 Constant *ConstantExpr::getSDiv(Constant *C1, Constant *C2, bool isExact) {
2163 return get(Instruction::SDiv, C1, C2,
2164 isExact ? PossiblyExactOperator::IsExact : 0);
2167 Constant *ConstantExpr::getFDiv(Constant *C1, Constant *C2) {
2168 return get(Instruction::FDiv, C1, C2);
2171 Constant *ConstantExpr::getURem(Constant *C1, Constant *C2) {
2172 return get(Instruction::URem, C1, C2);
2175 Constant *ConstantExpr::getSRem(Constant *C1, Constant *C2) {
2176 return get(Instruction::SRem, C1, C2);
2179 Constant *ConstantExpr::getFRem(Constant *C1, Constant *C2) {
2180 return get(Instruction::FRem, C1, C2);
2183 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
2184 return get(Instruction::And, C1, C2);
2187 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
2188 return get(Instruction::Or, C1, C2);
2191 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
2192 return get(Instruction::Xor, C1, C2);
2195 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2,
2196 bool HasNUW, bool HasNSW) {
2197 unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
2198 (HasNSW ? OverflowingBinaryOperator::NoSignedWrap : 0);
2199 return get(Instruction::Shl, C1, C2, Flags);
2202 Constant *ConstantExpr::getLShr(Constant *C1, Constant *C2, bool isExact) {
2203 return get(Instruction::LShr, C1, C2,
2204 isExact ? PossiblyExactOperator::IsExact : 0);
2207 Constant *ConstantExpr::getAShr(Constant *C1, Constant *C2, bool isExact) {
2208 return get(Instruction::AShr, C1, C2,
2209 isExact ? PossiblyExactOperator::IsExact : 0);
2212 /// getBinOpIdentity - Return the identity for the given binary operation,
2213 /// i.e. a constant C such that X op C = X and C op X = X for every X. It
2214 /// returns null if the operator doesn't have an identity.
2215 Constant *ConstantExpr::getBinOpIdentity(unsigned Opcode, Type *Ty) {
2218 // Doesn't have an identity.
2221 case Instruction::Add:
2222 case Instruction::Or:
2223 case Instruction::Xor:
2224 return Constant::getNullValue(Ty);
2226 case Instruction::Mul:
2227 return ConstantInt::get(Ty, 1);
2229 case Instruction::And:
2230 return Constant::getAllOnesValue(Ty);
2234 /// getBinOpAbsorber - Return the absorbing element for the given binary
2235 /// operation, i.e. a constant C such that X op C = C and C op X = C for
2236 /// every X. For example, this returns zero for integer multiplication.
2237 /// It returns null if the operator doesn't have an absorbing element.
2238 Constant *ConstantExpr::getBinOpAbsorber(unsigned Opcode, Type *Ty) {
2241 // Doesn't have an absorber.
2244 case Instruction::Or:
2245 return Constant::getAllOnesValue(Ty);
2247 case Instruction::And:
2248 case Instruction::Mul:
2249 return Constant::getNullValue(Ty);
2253 // destroyConstant - Remove the constant from the constant table...
2255 void ConstantExpr::destroyConstant() {
2256 getType()->getContext().pImpl->ExprConstants.remove(this);
2257 destroyConstantImpl();
2260 const char *ConstantExpr::getOpcodeName() const {
2261 return Instruction::getOpcodeName(getOpcode());
2266 GetElementPtrConstantExpr::
2267 GetElementPtrConstantExpr(Constant *C, ArrayRef<Constant*> IdxList,
2269 : ConstantExpr(DestTy, Instruction::GetElementPtr,
2270 OperandTraits<GetElementPtrConstantExpr>::op_end(this)
2271 - (IdxList.size()+1), IdxList.size()+1) {
2273 for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
2274 OperandList[i+1] = IdxList[i];
2277 //===----------------------------------------------------------------------===//
2278 // ConstantData* implementations
2280 void ConstantDataArray::anchor() {}
2281 void ConstantDataVector::anchor() {}
2283 /// getElementType - Return the element type of the array/vector.
2284 Type *ConstantDataSequential::getElementType() const {
2285 return getType()->getElementType();
2288 StringRef ConstantDataSequential::getRawDataValues() const {
2289 return StringRef(DataElements, getNumElements()*getElementByteSize());
2292 /// isElementTypeCompatible - Return true if a ConstantDataSequential can be
2293 /// formed with a vector or array of the specified element type.
2294 /// ConstantDataArray only works with normal float and int types that are
2295 /// stored densely in memory, not with things like i42 or x86_f80.
2296 bool ConstantDataSequential::isElementTypeCompatible(const Type *Ty) {
2297 if (Ty->isFloatTy() || Ty->isDoubleTy()) return true;
2298 if (const IntegerType *IT = dyn_cast<IntegerType>(Ty)) {
2299 switch (IT->getBitWidth()) {
2311 /// getNumElements - Return the number of elements in the array or vector.
2312 unsigned ConstantDataSequential::getNumElements() const {
2313 if (ArrayType *AT = dyn_cast<ArrayType>(getType()))
2314 return AT->getNumElements();
2315 return getType()->getVectorNumElements();
2319 /// getElementByteSize - Return the size in bytes of the elements in the data.
2320 uint64_t ConstantDataSequential::getElementByteSize() const {
2321 return getElementType()->getPrimitiveSizeInBits()/8;
2324 /// getElementPointer - Return the start of the specified element.
2325 const char *ConstantDataSequential::getElementPointer(unsigned Elt) const {
2326 assert(Elt < getNumElements() && "Invalid Elt");
2327 return DataElements+Elt*getElementByteSize();
2331 /// isAllZeros - return true if the array is empty or all zeros.
2332 static bool isAllZeros(StringRef Arr) {
2333 for (StringRef::iterator I = Arr.begin(), E = Arr.end(); I != E; ++I)
2339 /// getImpl - This is the underlying implementation of all of the
2340 /// ConstantDataSequential::get methods. They all thunk down to here, providing
2341 /// the correct element type. We take the bytes in as a StringRef because
2342 /// we *want* an underlying "char*" to avoid TBAA type punning violations.
2343 Constant *ConstantDataSequential::getImpl(StringRef Elements, Type *Ty) {
2344 assert(isElementTypeCompatible(Ty->getSequentialElementType()));
2345 // If the elements are all zero or there are no elements, return a CAZ, which
2346 // is more dense and canonical.
2347 if (isAllZeros(Elements))
2348 return ConstantAggregateZero::get(Ty);
2350 // Do a lookup to see if we have already formed one of these.
2351 StringMap<ConstantDataSequential*>::MapEntryTy &Slot =
2352 Ty->getContext().pImpl->CDSConstants.GetOrCreateValue(Elements);
2354 // The bucket can point to a linked list of different CDS's that have the same
2355 // body but different types. For example, 0,0,0,1 could be a 4 element array
2356 // of i8, or a 1-element array of i32. They'll both end up in the same
2357 /// StringMap bucket, linked up by their Next pointers. Walk the list.
2358 ConstantDataSequential **Entry = &Slot.getValue();
2359 for (ConstantDataSequential *Node = *Entry; Node;
2360 Entry = &Node->Next, Node = *Entry)
2361 if (Node->getType() == Ty)
2364 // Okay, we didn't get a hit. Create a node of the right class, link it in,
2366 if (isa<ArrayType>(Ty))
2367 return *Entry = new ConstantDataArray(Ty, Slot.getKeyData());
2369 assert(isa<VectorType>(Ty));
2370 return *Entry = new ConstantDataVector(Ty, Slot.getKeyData());
2373 void ConstantDataSequential::destroyConstant() {
2374 // Remove the constant from the StringMap.
2375 StringMap<ConstantDataSequential*> &CDSConstants =
2376 getType()->getContext().pImpl->CDSConstants;
2378 StringMap<ConstantDataSequential*>::iterator Slot =
2379 CDSConstants.find(getRawDataValues());
2381 assert(Slot != CDSConstants.end() && "CDS not found in uniquing table");
2383 ConstantDataSequential **Entry = &Slot->getValue();
2385 // Remove the entry from the hash table.
2386 if (!(*Entry)->Next) {
2387 // If there is only one value in the bucket (common case) it must be this
2388 // entry, and removing the entry should remove the bucket completely.
2389 assert((*Entry) == this && "Hash mismatch in ConstantDataSequential");
2390 getContext().pImpl->CDSConstants.erase(Slot);
2392 // Otherwise, there are multiple entries linked off the bucket, unlink the
2393 // node we care about but keep the bucket around.
2394 for (ConstantDataSequential *Node = *Entry; ;
2395 Entry = &Node->Next, Node = *Entry) {
2396 assert(Node && "Didn't find entry in its uniquing hash table!");
2397 // If we found our entry, unlink it from the list and we're done.
2399 *Entry = Node->Next;
2405 // If we were part of a list, make sure that we don't delete the list that is
2406 // still owned by the uniquing map.
2409 // Finally, actually delete it.
2410 destroyConstantImpl();
2413 /// get() constructors - Return a constant with array type with an element
2414 /// count and element type matching the ArrayRef passed in. Note that this
2415 /// can return a ConstantAggregateZero object.
2416 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint8_t> Elts) {
2417 Type *Ty = ArrayType::get(Type::getInt8Ty(Context), Elts.size());
2418 const char *Data = reinterpret_cast<const char *>(Elts.data());
2419 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*1), Ty);
2421 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint16_t> Elts){
2422 Type *Ty = ArrayType::get(Type::getInt16Ty(Context), Elts.size());
2423 const char *Data = reinterpret_cast<const char *>(Elts.data());
2424 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*2), Ty);
2426 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint32_t> Elts){
2427 Type *Ty = ArrayType::get(Type::getInt32Ty(Context), Elts.size());
2428 const char *Data = reinterpret_cast<const char *>(Elts.data());
2429 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2431 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<uint64_t> Elts){
2432 Type *Ty = ArrayType::get(Type::getInt64Ty(Context), Elts.size());
2433 const char *Data = reinterpret_cast<const char *>(Elts.data());
2434 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2436 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<float> Elts) {
2437 Type *Ty = ArrayType::get(Type::getFloatTy(Context), Elts.size());
2438 const char *Data = reinterpret_cast<const char *>(Elts.data());
2439 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2441 Constant *ConstantDataArray::get(LLVMContext &Context, ArrayRef<double> Elts) {
2442 Type *Ty = ArrayType::get(Type::getDoubleTy(Context), Elts.size());
2443 const char *Data = reinterpret_cast<const char *>(Elts.data());
2444 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2447 /// getString - This method constructs a CDS and initializes it with a text
2448 /// string. The default behavior (AddNull==true) causes a null terminator to
2449 /// be placed at the end of the array (increasing the length of the string by
2450 /// one more than the StringRef would normally indicate. Pass AddNull=false
2451 /// to disable this behavior.
2452 Constant *ConstantDataArray::getString(LLVMContext &Context,
2453 StringRef Str, bool AddNull) {
2455 const uint8_t *Data = reinterpret_cast<const uint8_t *>(Str.data());
2456 return get(Context, ArrayRef<uint8_t>(const_cast<uint8_t *>(Data),
2460 SmallVector<uint8_t, 64> ElementVals;
2461 ElementVals.append(Str.begin(), Str.end());
2462 ElementVals.push_back(0);
2463 return get(Context, ElementVals);
2466 /// get() constructors - Return a constant with vector type with an element
2467 /// count and element type matching the ArrayRef passed in. Note that this
2468 /// can return a ConstantAggregateZero object.
2469 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint8_t> Elts){
2470 Type *Ty = VectorType::get(Type::getInt8Ty(Context), Elts.size());
2471 const char *Data = reinterpret_cast<const char *>(Elts.data());
2472 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*1), Ty);
2474 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint16_t> Elts){
2475 Type *Ty = VectorType::get(Type::getInt16Ty(Context), Elts.size());
2476 const char *Data = reinterpret_cast<const char *>(Elts.data());
2477 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*2), Ty);
2479 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint32_t> Elts){
2480 Type *Ty = VectorType::get(Type::getInt32Ty(Context), Elts.size());
2481 const char *Data = reinterpret_cast<const char *>(Elts.data());
2482 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2484 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<uint64_t> Elts){
2485 Type *Ty = VectorType::get(Type::getInt64Ty(Context), Elts.size());
2486 const char *Data = reinterpret_cast<const char *>(Elts.data());
2487 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2489 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<float> Elts) {
2490 Type *Ty = VectorType::get(Type::getFloatTy(Context), Elts.size());
2491 const char *Data = reinterpret_cast<const char *>(Elts.data());
2492 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*4), Ty);
2494 Constant *ConstantDataVector::get(LLVMContext &Context, ArrayRef<double> Elts) {
2495 Type *Ty = VectorType::get(Type::getDoubleTy(Context), Elts.size());
2496 const char *Data = reinterpret_cast<const char *>(Elts.data());
2497 return getImpl(StringRef(const_cast<char *>(Data), Elts.size()*8), Ty);
2500 Constant *ConstantDataVector::getSplat(unsigned NumElts, Constant *V) {
2501 assert(isElementTypeCompatible(V->getType()) &&
2502 "Element type not compatible with ConstantData");
2503 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
2504 if (CI->getType()->isIntegerTy(8)) {
2505 SmallVector<uint8_t, 16> Elts(NumElts, CI->getZExtValue());
2506 return get(V->getContext(), Elts);
2508 if (CI->getType()->isIntegerTy(16)) {
2509 SmallVector<uint16_t, 16> Elts(NumElts, CI->getZExtValue());
2510 return get(V->getContext(), Elts);
2512 if (CI->getType()->isIntegerTy(32)) {
2513 SmallVector<uint32_t, 16> Elts(NumElts, CI->getZExtValue());
2514 return get(V->getContext(), Elts);
2516 assert(CI->getType()->isIntegerTy(64) && "Unsupported ConstantData type");
2517 SmallVector<uint64_t, 16> Elts(NumElts, CI->getZExtValue());
2518 return get(V->getContext(), Elts);
2521 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2522 if (CFP->getType()->isFloatTy()) {
2523 SmallVector<float, 16> Elts(NumElts, CFP->getValueAPF().convertToFloat());
2524 return get(V->getContext(), Elts);
2526 if (CFP->getType()->isDoubleTy()) {
2527 SmallVector<double, 16> Elts(NumElts,
2528 CFP->getValueAPF().convertToDouble());
2529 return get(V->getContext(), Elts);
2532 return ConstantVector::getSplat(NumElts, V);
2536 /// getElementAsInteger - If this is a sequential container of integers (of
2537 /// any size), return the specified element in the low bits of a uint64_t.
2538 uint64_t ConstantDataSequential::getElementAsInteger(unsigned Elt) const {
2539 assert(isa<IntegerType>(getElementType()) &&
2540 "Accessor can only be used when element is an integer");
2541 const char *EltPtr = getElementPointer(Elt);
2543 // The data is stored in host byte order, make sure to cast back to the right
2544 // type to load with the right endianness.
2545 switch (getElementType()->getIntegerBitWidth()) {
2546 default: llvm_unreachable("Invalid bitwidth for CDS");
2548 return *const_cast<uint8_t *>(reinterpret_cast<const uint8_t *>(EltPtr));
2550 return *const_cast<uint16_t *>(reinterpret_cast<const uint16_t *>(EltPtr));
2552 return *const_cast<uint32_t *>(reinterpret_cast<const uint32_t *>(EltPtr));
2554 return *const_cast<uint64_t *>(reinterpret_cast<const uint64_t *>(EltPtr));
2558 /// getElementAsAPFloat - If this is a sequential container of floating point
2559 /// type, return the specified element as an APFloat.
2560 APFloat ConstantDataSequential::getElementAsAPFloat(unsigned Elt) const {
2561 const char *EltPtr = getElementPointer(Elt);
2563 switch (getElementType()->getTypeID()) {
2565 llvm_unreachable("Accessor can only be used when element is float/double!");
2566 case Type::FloatTyID: {
2567 const float *FloatPrt = reinterpret_cast<const float *>(EltPtr);
2568 return APFloat(*const_cast<float *>(FloatPrt));
2570 case Type::DoubleTyID: {
2571 const double *DoublePtr = reinterpret_cast<const double *>(EltPtr);
2572 return APFloat(*const_cast<double *>(DoublePtr));
2577 /// getElementAsFloat - If this is an sequential container of floats, return
2578 /// the specified element as a float.
2579 float ConstantDataSequential::getElementAsFloat(unsigned Elt) const {
2580 assert(getElementType()->isFloatTy() &&
2581 "Accessor can only be used when element is a 'float'");
2582 const float *EltPtr = reinterpret_cast<const float *>(getElementPointer(Elt));
2583 return *const_cast<float *>(EltPtr);
2586 /// getElementAsDouble - If this is an sequential container of doubles, return
2587 /// the specified element as a float.
2588 double ConstantDataSequential::getElementAsDouble(unsigned Elt) const {
2589 assert(getElementType()->isDoubleTy() &&
2590 "Accessor can only be used when element is a 'float'");
2591 const double *EltPtr =
2592 reinterpret_cast<const double *>(getElementPointer(Elt));
2593 return *const_cast<double *>(EltPtr);
2596 /// getElementAsConstant - Return a Constant for a specified index's element.
2597 /// Note that this has to compute a new constant to return, so it isn't as
2598 /// efficient as getElementAsInteger/Float/Double.
2599 Constant *ConstantDataSequential::getElementAsConstant(unsigned Elt) const {
2600 if (getElementType()->isFloatTy() || getElementType()->isDoubleTy())
2601 return ConstantFP::get(getContext(), getElementAsAPFloat(Elt));
2603 return ConstantInt::get(getElementType(), getElementAsInteger(Elt));
2606 /// isString - This method returns true if this is an array of i8.
2607 bool ConstantDataSequential::isString() const {
2608 return isa<ArrayType>(getType()) && getElementType()->isIntegerTy(8);
2611 /// isCString - This method returns true if the array "isString", ends with a
2612 /// nul byte, and does not contains any other nul bytes.
2613 bool ConstantDataSequential::isCString() const {
2617 StringRef Str = getAsString();
2619 // The last value must be nul.
2620 if (Str.back() != 0) return false;
2622 // Other elements must be non-nul.
2623 return Str.drop_back().find(0) == StringRef::npos;
2626 /// getSplatValue - If this is a splat constant, meaning that all of the
2627 /// elements have the same value, return that value. Otherwise return NULL.
2628 Constant *ConstantDataVector::getSplatValue() const {
2629 const char *Base = getRawDataValues().data();
2631 // Compare elements 1+ to the 0'th element.
2632 unsigned EltSize = getElementByteSize();
2633 for (unsigned i = 1, e = getNumElements(); i != e; ++i)
2634 if (memcmp(Base, Base+i*EltSize, EltSize))
2637 // If they're all the same, return the 0th one as a representative.
2638 return getElementAsConstant(0);
2641 //===----------------------------------------------------------------------===//
2642 // replaceUsesOfWithOnConstant implementations
2644 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2645 /// 'From' to be uses of 'To'. This must update the uniquing data structures
2648 /// Note that we intentionally replace all uses of From with To here. Consider
2649 /// a large array that uses 'From' 1000 times. By handling this case all here,
2650 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2651 /// single invocation handles all 1000 uses. Handling them one at a time would
2652 /// work, but would be really slow because it would have to unique each updated
2655 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2657 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2658 Constant *ToC = cast<Constant>(To);
2660 LLVMContextImpl *pImpl = getType()->getContext().pImpl;
2662 SmallVector<Constant*, 8> Values;
2663 LLVMContextImpl::ArrayConstantsTy::LookupKey Lookup;
2664 Lookup.first = cast<ArrayType>(getType());
2665 Values.reserve(getNumOperands()); // Build replacement array.
2667 // Fill values with the modified operands of the constant array. Also,
2668 // compute whether this turns into an all-zeros array.
2669 unsigned NumUpdated = 0;
2671 // Keep track of whether all the values in the array are "ToC".
2672 bool AllSame = true;
2673 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2674 Constant *Val = cast<Constant>(O->get());
2679 Values.push_back(Val);
2680 AllSame &= Val == ToC;
2683 Constant *Replacement = nullptr;
2684 if (AllSame && ToC->isNullValue()) {
2685 Replacement = ConstantAggregateZero::get(getType());
2686 } else if (AllSame && isa<UndefValue>(ToC)) {
2687 Replacement = UndefValue::get(getType());
2689 // Check to see if we have this array type already.
2690 Lookup.second = makeArrayRef(Values);
2691 LLVMContextImpl::ArrayConstantsTy::MapTy::iterator I =
2692 pImpl->ArrayConstants.find(Lookup);
2694 if (I != pImpl->ArrayConstants.map_end()) {
2695 Replacement = I->first;
2697 // Okay, the new shape doesn't exist in the system yet. Instead of
2698 // creating a new constant array, inserting it, replaceallusesof'ing the
2699 // old with the new, then deleting the old... just update the current one
2701 pImpl->ArrayConstants.remove(this);
2703 // Update to the new value. Optimize for the case when we have a single
2704 // operand that we're changing, but handle bulk updates efficiently.
2705 if (NumUpdated == 1) {
2706 unsigned OperandToUpdate = U - OperandList;
2707 assert(getOperand(OperandToUpdate) == From &&
2708 "ReplaceAllUsesWith broken!");
2709 setOperand(OperandToUpdate, ToC);
2711 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2712 if (getOperand(i) == From)
2715 pImpl->ArrayConstants.insert(this);
2720 // Otherwise, I do need to replace this with an existing value.
2721 assert(Replacement != this && "I didn't contain From!");
2723 // Everyone using this now uses the replacement.
2724 replaceAllUsesWith(Replacement);
2726 // Delete the old constant!
2730 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2732 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2733 Constant *ToC = cast<Constant>(To);
2735 unsigned OperandToUpdate = U-OperandList;
2736 assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2738 SmallVector<Constant*, 8> Values;
2739 LLVMContextImpl::StructConstantsTy::LookupKey Lookup;
2740 Lookup.first = cast<StructType>(getType());
2741 Values.reserve(getNumOperands()); // Build replacement struct.
2743 // Fill values with the modified operands of the constant struct. Also,
2744 // compute whether this turns into an all-zeros struct.
2745 bool isAllZeros = false;
2746 bool isAllUndef = false;
2747 if (ToC->isNullValue()) {
2749 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2750 Constant *Val = cast<Constant>(O->get());
2751 Values.push_back(Val);
2752 if (isAllZeros) isAllZeros = Val->isNullValue();
2754 } else if (isa<UndefValue>(ToC)) {
2756 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2757 Constant *Val = cast<Constant>(O->get());
2758 Values.push_back(Val);
2759 if (isAllUndef) isAllUndef = isa<UndefValue>(Val);
2762 for (Use *O = OperandList, *E = OperandList + getNumOperands(); O != E; ++O)
2763 Values.push_back(cast<Constant>(O->get()));
2765 Values[OperandToUpdate] = ToC;
2767 LLVMContextImpl *pImpl = getContext().pImpl;
2769 Constant *Replacement = nullptr;
2771 Replacement = ConstantAggregateZero::get(getType());
2772 } else if (isAllUndef) {
2773 Replacement = UndefValue::get(getType());
2775 // Check to see if we have this struct type already.
2776 Lookup.second = makeArrayRef(Values);
2777 LLVMContextImpl::StructConstantsTy::MapTy::iterator I =
2778 pImpl->StructConstants.find(Lookup);
2780 if (I != pImpl->StructConstants.map_end()) {
2781 Replacement = I->first;
2783 // Okay, the new shape doesn't exist in the system yet. Instead of
2784 // creating a new constant struct, inserting it, replaceallusesof'ing the
2785 // old with the new, then deleting the old... just update the current one
2787 pImpl->StructConstants.remove(this);
2789 // Update to the new value.
2790 setOperand(OperandToUpdate, ToC);
2791 pImpl->StructConstants.insert(this);
2796 assert(Replacement != this && "I didn't contain From!");
2798 // Everyone using this now uses the replacement.
2799 replaceAllUsesWith(Replacement);
2801 // Delete the old constant!
2805 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2807 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2809 SmallVector<Constant*, 8> Values;
2810 Values.reserve(getNumOperands()); // Build replacement array...
2811 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2812 Constant *Val = getOperand(i);
2813 if (Val == From) Val = cast<Constant>(To);
2814 Values.push_back(Val);
2817 Constant *Replacement = get(Values);
2818 assert(Replacement != this && "I didn't contain From!");
2820 // Everyone using this now uses the replacement.
2821 replaceAllUsesWith(Replacement);
2823 // Delete the old constant!
2827 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2829 assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2830 Constant *To = cast<Constant>(ToV);
2832 SmallVector<Constant*, 8> NewOps;
2833 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2834 Constant *Op = getOperand(i);
2835 NewOps.push_back(Op == From ? To : Op);
2838 Constant *Replacement = getWithOperands(NewOps);
2839 assert(Replacement != this && "I didn't contain From!");
2841 // Everyone using this now uses the replacement.
2842 replaceAllUsesWith(Replacement);
2844 // Delete the old constant!
2848 Instruction *ConstantExpr::getAsInstruction() {
2849 SmallVector<Value*,4> ValueOperands;
2850 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
2851 ValueOperands.push_back(cast<Value>(I));
2853 ArrayRef<Value*> Ops(ValueOperands);
2855 switch (getOpcode()) {
2856 case Instruction::Trunc:
2857 case Instruction::ZExt:
2858 case Instruction::SExt:
2859 case Instruction::FPTrunc:
2860 case Instruction::FPExt:
2861 case Instruction::UIToFP:
2862 case Instruction::SIToFP:
2863 case Instruction::FPToUI:
2864 case Instruction::FPToSI:
2865 case Instruction::PtrToInt:
2866 case Instruction::IntToPtr:
2867 case Instruction::BitCast:
2868 case Instruction::AddrSpaceCast:
2869 return CastInst::Create((Instruction::CastOps)getOpcode(),
2871 case Instruction::Select:
2872 return SelectInst::Create(Ops[0], Ops[1], Ops[2]);
2873 case Instruction::InsertElement:
2874 return InsertElementInst::Create(Ops[0], Ops[1], Ops[2]);
2875 case Instruction::ExtractElement:
2876 return ExtractElementInst::Create(Ops[0], Ops[1]);
2877 case Instruction::InsertValue:
2878 return InsertValueInst::Create(Ops[0], Ops[1], getIndices());
2879 case Instruction::ExtractValue:
2880 return ExtractValueInst::Create(Ops[0], getIndices());
2881 case Instruction::ShuffleVector:
2882 return new ShuffleVectorInst(Ops[0], Ops[1], Ops[2]);
2884 case Instruction::GetElementPtr:
2885 if (cast<GEPOperator>(this)->isInBounds())
2886 return GetElementPtrInst::CreateInBounds(Ops[0], Ops.slice(1));
2888 return GetElementPtrInst::Create(Ops[0], Ops.slice(1));
2890 case Instruction::ICmp:
2891 case Instruction::FCmp:
2892 return CmpInst::Create((Instruction::OtherOps)getOpcode(),
2893 getPredicate(), Ops[0], Ops[1]);
2896 assert(getNumOperands() == 2 && "Must be binary operator?");
2897 BinaryOperator *BO =
2898 BinaryOperator::Create((Instruction::BinaryOps)getOpcode(),
2900 if (isa<OverflowingBinaryOperator>(BO)) {
2901 BO->setHasNoUnsignedWrap(SubclassOptionalData &
2902 OverflowingBinaryOperator::NoUnsignedWrap);
2903 BO->setHasNoSignedWrap(SubclassOptionalData &
2904 OverflowingBinaryOperator::NoSignedWrap);
2906 if (isa<PossiblyExactOperator>(BO))
2907 BO->setIsExact(SubclassOptionalData & PossiblyExactOperator::IsExact);