1 //===- LazyValueInfo.cpp - Value constraint analysis ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the interface for lazy computation of value constraint
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Analysis/LazyValueInfo.h"
16 #include "llvm/ADT/DenseSet.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/Analysis/AssumptionCache.h"
19 #include "llvm/Analysis/ConstantFolding.h"
20 #include "llvm/Analysis/ValueTracking.h"
21 #include "llvm/IR/CFG.h"
22 #include "llvm/IR/ConstantRange.h"
23 #include "llvm/IR/Constants.h"
24 #include "llvm/IR/DataLayout.h"
25 #include "llvm/IR/Dominators.h"
26 #include "llvm/IR/Instructions.h"
27 #include "llvm/IR/IntrinsicInst.h"
28 #include "llvm/IR/PatternMatch.h"
29 #include "llvm/IR/ValueHandle.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/Support/raw_ostream.h"
32 #include "llvm/Target/TargetLibraryInfo.h"
36 using namespace PatternMatch;
38 #define DEBUG_TYPE "lazy-value-info"
40 char LazyValueInfo::ID = 0;
41 INITIALIZE_PASS_BEGIN(LazyValueInfo, "lazy-value-info",
42 "Lazy Value Information Analysis", false, true)
43 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
44 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
45 INITIALIZE_PASS_END(LazyValueInfo, "lazy-value-info",
46 "Lazy Value Information Analysis", false, true)
49 FunctionPass *createLazyValueInfoPass() { return new LazyValueInfo(); }
53 //===----------------------------------------------------------------------===//
55 //===----------------------------------------------------------------------===//
57 /// LVILatticeVal - This is the information tracked by LazyValueInfo for each
60 /// FIXME: This is basically just for bringup, this can be made a lot more rich
66 /// undefined - This Value has no known value yet.
69 /// constant - This Value has a specific constant value.
71 /// notconstant - This Value is known to not have the specified value.
74 /// constantrange - The Value falls within this range.
77 /// overdefined - This value is not known to be constant, and we know that
82 /// Val: This stores the current lattice value along with the Constant* for
83 /// the constant if this is a 'constant' or 'notconstant' value.
89 LVILatticeVal() : Tag(undefined), Val(nullptr), Range(1, true) {}
91 static LVILatticeVal get(Constant *C) {
93 if (!isa<UndefValue>(C))
97 static LVILatticeVal getNot(Constant *C) {
99 if (!isa<UndefValue>(C))
100 Res.markNotConstant(C);
103 static LVILatticeVal getRange(ConstantRange CR) {
105 Res.markConstantRange(CR);
109 bool isUndefined() const { return Tag == undefined; }
110 bool isConstant() const { return Tag == constant; }
111 bool isNotConstant() const { return Tag == notconstant; }
112 bool isConstantRange() const { return Tag == constantrange; }
113 bool isOverdefined() const { return Tag == overdefined; }
115 Constant *getConstant() const {
116 assert(isConstant() && "Cannot get the constant of a non-constant!");
120 Constant *getNotConstant() const {
121 assert(isNotConstant() && "Cannot get the constant of a non-notconstant!");
125 ConstantRange getConstantRange() const {
126 assert(isConstantRange() &&
127 "Cannot get the constant-range of a non-constant-range!");
131 /// markOverdefined - Return true if this is a change in status.
132 bool markOverdefined() {
139 /// markConstant - Return true if this is a change in status.
140 bool markConstant(Constant *V) {
141 assert(V && "Marking constant with NULL");
142 if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
143 return markConstantRange(ConstantRange(CI->getValue()));
144 if (isa<UndefValue>(V))
147 assert((!isConstant() || getConstant() == V) &&
148 "Marking constant with different value");
149 assert(isUndefined());
155 /// markNotConstant - Return true if this is a change in status.
156 bool markNotConstant(Constant *V) {
157 assert(V && "Marking constant with NULL");
158 if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
159 return markConstantRange(ConstantRange(CI->getValue()+1, CI->getValue()));
160 if (isa<UndefValue>(V))
163 assert((!isConstant() || getConstant() != V) &&
164 "Marking constant !constant with same value");
165 assert((!isNotConstant() || getNotConstant() == V) &&
166 "Marking !constant with different value");
167 assert(isUndefined() || isConstant());
173 /// markConstantRange - Return true if this is a change in status.
174 bool markConstantRange(const ConstantRange NewR) {
175 if (isConstantRange()) {
176 if (NewR.isEmptySet())
177 return markOverdefined();
179 bool changed = Range != NewR;
184 assert(isUndefined());
185 if (NewR.isEmptySet())
186 return markOverdefined();
193 /// mergeIn - Merge the specified lattice value into this one, updating this
194 /// one and returning true if anything changed.
195 bool mergeIn(const LVILatticeVal &RHS) {
196 if (RHS.isUndefined() || isOverdefined()) return false;
197 if (RHS.isOverdefined()) return markOverdefined();
207 if (RHS.isConstant()) {
210 return markOverdefined();
213 if (RHS.isNotConstant()) {
215 return markOverdefined();
217 // Unless we can prove that the two Constants are different, we must
218 // move to overdefined.
219 // FIXME: use DataLayout/TargetLibraryInfo for smarter constant folding.
220 if (ConstantInt *Res = dyn_cast<ConstantInt>(
221 ConstantFoldCompareInstOperands(CmpInst::ICMP_NE,
223 RHS.getNotConstant())))
225 return markNotConstant(RHS.getNotConstant());
227 return markOverdefined();
230 // RHS is a ConstantRange, LHS is a non-integer Constant.
232 // FIXME: consider the case where RHS is a range [1, 0) and LHS is
233 // a function. The correct result is to pick up RHS.
235 return markOverdefined();
238 if (isNotConstant()) {
239 if (RHS.isConstant()) {
241 return markOverdefined();
243 // Unless we can prove that the two Constants are different, we must
244 // move to overdefined.
245 // FIXME: use DataLayout/TargetLibraryInfo for smarter constant folding.
246 if (ConstantInt *Res = dyn_cast<ConstantInt>(
247 ConstantFoldCompareInstOperands(CmpInst::ICMP_NE,
253 return markOverdefined();
256 if (RHS.isNotConstant()) {
259 return markOverdefined();
262 return markOverdefined();
265 assert(isConstantRange() && "New LVILattice type?");
266 if (!RHS.isConstantRange())
267 return markOverdefined();
269 ConstantRange NewR = Range.unionWith(RHS.getConstantRange());
270 if (NewR.isFullSet())
271 return markOverdefined();
272 return markConstantRange(NewR);
276 } // end anonymous namespace.
279 raw_ostream &operator<<(raw_ostream &OS, const LVILatticeVal &Val)
281 raw_ostream &operator<<(raw_ostream &OS, const LVILatticeVal &Val) {
282 if (Val.isUndefined())
283 return OS << "undefined";
284 if (Val.isOverdefined())
285 return OS << "overdefined";
287 if (Val.isNotConstant())
288 return OS << "notconstant<" << *Val.getNotConstant() << '>';
289 else if (Val.isConstantRange())
290 return OS << "constantrange<" << Val.getConstantRange().getLower() << ", "
291 << Val.getConstantRange().getUpper() << '>';
292 return OS << "constant<" << *Val.getConstant() << '>';
296 //===----------------------------------------------------------------------===//
297 // LazyValueInfoCache Decl
298 //===----------------------------------------------------------------------===//
301 /// LVIValueHandle - A callback value handle updates the cache when
302 /// values are erased.
303 class LazyValueInfoCache;
304 struct LVIValueHandle : public CallbackVH {
305 LazyValueInfoCache *Parent;
307 LVIValueHandle(Value *V, LazyValueInfoCache *P)
308 : CallbackVH(V), Parent(P) { }
310 void deleted() override;
311 void allUsesReplacedWith(Value *V) override {
318 /// LazyValueInfoCache - This is the cache kept by LazyValueInfo which
319 /// maintains information about queries across the clients' queries.
320 class LazyValueInfoCache {
321 /// ValueCacheEntryTy - This is all of the cached block information for
322 /// exactly one Value*. The entries are sorted by the BasicBlock* of the
323 /// entries, allowing us to do a lookup with a binary search.
324 typedef std::map<AssertingVH<BasicBlock>, LVILatticeVal> ValueCacheEntryTy;
326 /// ValueCache - This is all of the cached information for all values,
327 /// mapped from Value* to key information.
328 std::map<LVIValueHandle, ValueCacheEntryTy> ValueCache;
330 /// OverDefinedCache - This tracks, on a per-block basis, the set of
331 /// values that are over-defined at the end of that block. This is required
332 /// for cache updating.
333 typedef std::pair<AssertingVH<BasicBlock>, Value*> OverDefinedPairTy;
334 DenseSet<OverDefinedPairTy> OverDefinedCache;
336 /// SeenBlocks - Keep track of all blocks that we have ever seen, so we
337 /// don't spend time removing unused blocks from our caches.
338 DenseSet<AssertingVH<BasicBlock> > SeenBlocks;
340 /// BlockValueStack - This stack holds the state of the value solver
341 /// during a query. It basically emulates the callstack of the naive
342 /// recursive value lookup process.
343 std::stack<std::pair<BasicBlock*, Value*> > BlockValueStack;
345 /// BlockValueSet - Keeps track of which block-value pairs are in
347 DenseSet<std::pair<BasicBlock*, Value*> > BlockValueSet;
349 /// pushBlockValue - Push BV onto BlockValueStack unless it's already in
350 /// there. Returns true on success.
351 bool pushBlockValue(const std::pair<BasicBlock *, Value *> &BV) {
352 if (BlockValueSet.count(BV))
353 return false; // It's already in the stack.
355 BlockValueStack.push(BV);
356 BlockValueSet.insert(BV);
360 /// A pointer to the cache of @llvm.assume calls.
362 /// An optional DL pointer.
363 const DataLayout *DL;
364 /// An optional DT pointer.
367 friend struct LVIValueHandle;
369 void insertResult(Value *Val, BasicBlock *BB, const LVILatticeVal &Result) {
370 SeenBlocks.insert(BB);
371 lookup(Val)[BB] = Result;
372 if (Result.isOverdefined())
373 OverDefinedCache.insert(std::make_pair(BB, Val));
376 LVILatticeVal getBlockValue(Value *Val, BasicBlock *BB);
377 bool getEdgeValue(Value *V, BasicBlock *F, BasicBlock *T,
378 LVILatticeVal &Result,
379 Instruction *CxtI = nullptr);
380 bool hasBlockValue(Value *Val, BasicBlock *BB);
382 // These methods process one work item and may add more. A false value
383 // returned means that the work item was not completely processed and must
384 // be revisited after going through the new items.
385 bool solveBlockValue(Value *Val, BasicBlock *BB);
386 bool solveBlockValueNonLocal(LVILatticeVal &BBLV,
387 Value *Val, BasicBlock *BB);
388 bool solveBlockValuePHINode(LVILatticeVal &BBLV,
389 PHINode *PN, BasicBlock *BB);
390 bool solveBlockValueConstantRange(LVILatticeVal &BBLV,
391 Instruction *BBI, BasicBlock *BB);
392 void mergeAssumeBlockValueConstantRange(Value *Val, LVILatticeVal &BBLV,
397 ValueCacheEntryTy &lookup(Value *V) {
398 return ValueCache[LVIValueHandle(V, this)];
402 /// getValueInBlock - This is the query interface to determine the lattice
403 /// value for the specified Value* at the end of the specified block.
404 LVILatticeVal getValueInBlock(Value *V, BasicBlock *BB,
405 Instruction *CxtI = nullptr);
407 /// getValueAt - This is the query interface to determine the lattice
408 /// value for the specified Value* at the specified instruction (generally
409 /// from an assume intrinsic).
410 LVILatticeVal getValueAt(Value *V, Instruction *CxtI);
412 /// getValueOnEdge - This is the query interface to determine the lattice
413 /// value for the specified Value* that is true on the specified edge.
414 LVILatticeVal getValueOnEdge(Value *V, BasicBlock *FromBB,BasicBlock *ToBB,
415 Instruction *CxtI = nullptr);
417 /// threadEdge - This is the update interface to inform the cache that an
418 /// edge from PredBB to OldSucc has been threaded to be from PredBB to
420 void threadEdge(BasicBlock *PredBB,BasicBlock *OldSucc,BasicBlock *NewSucc);
422 /// eraseBlock - This is part of the update interface to inform the cache
423 /// that a block has been deleted.
424 void eraseBlock(BasicBlock *BB);
426 /// clear - Empty the cache.
430 OverDefinedCache.clear();
433 LazyValueInfoCache(AssumptionCache *AC, const DataLayout *DL = nullptr,
434 DominatorTree *DT = nullptr)
435 : AC(AC), DL(DL), DT(DT) {}
437 } // end anonymous namespace
439 void LVIValueHandle::deleted() {
440 typedef std::pair<AssertingVH<BasicBlock>, Value*> OverDefinedPairTy;
442 SmallVector<OverDefinedPairTy, 4> ToErase;
443 for (const OverDefinedPairTy &P : Parent->OverDefinedCache)
444 if (P.second == getValPtr())
445 ToErase.push_back(P);
446 for (const OverDefinedPairTy &P : ToErase)
447 Parent->OverDefinedCache.erase(P);
449 // This erasure deallocates *this, so it MUST happen after we're done
450 // using any and all members of *this.
451 Parent->ValueCache.erase(*this);
454 void LazyValueInfoCache::eraseBlock(BasicBlock *BB) {
455 // Shortcut if we have never seen this block.
456 DenseSet<AssertingVH<BasicBlock> >::iterator I = SeenBlocks.find(BB);
457 if (I == SeenBlocks.end())
461 SmallVector<OverDefinedPairTy, 4> ToErase;
462 for (const OverDefinedPairTy& P : OverDefinedCache)
464 ToErase.push_back(P);
465 for (const OverDefinedPairTy &P : ToErase)
466 OverDefinedCache.erase(P);
468 for (std::map<LVIValueHandle, ValueCacheEntryTy>::iterator
469 I = ValueCache.begin(), E = ValueCache.end(); I != E; ++I)
473 void LazyValueInfoCache::solve() {
474 while (!BlockValueStack.empty()) {
475 std::pair<BasicBlock*, Value*> &e = BlockValueStack.top();
476 assert(BlockValueSet.count(e) && "Stack value should be in BlockValueSet!");
478 if (solveBlockValue(e.second, e.first)) {
479 // The work item was completely processed.
480 assert(BlockValueStack.top() == e && "Nothing should have been pushed!");
481 assert(lookup(e.second).count(e.first) && "Result should be in cache!");
483 BlockValueStack.pop();
484 BlockValueSet.erase(e);
486 // More work needs to be done before revisiting.
487 assert(BlockValueStack.top() != e && "Stack should have been pushed!");
492 bool LazyValueInfoCache::hasBlockValue(Value *Val, BasicBlock *BB) {
493 // If already a constant, there is nothing to compute.
494 if (isa<Constant>(Val))
497 LVIValueHandle ValHandle(Val, this);
498 std::map<LVIValueHandle, ValueCacheEntryTy>::iterator I =
499 ValueCache.find(ValHandle);
500 if (I == ValueCache.end()) return false;
501 return I->second.count(BB);
504 LVILatticeVal LazyValueInfoCache::getBlockValue(Value *Val, BasicBlock *BB) {
505 // If already a constant, there is nothing to compute.
506 if (Constant *VC = dyn_cast<Constant>(Val))
507 return LVILatticeVal::get(VC);
509 SeenBlocks.insert(BB);
510 return lookup(Val)[BB];
513 bool LazyValueInfoCache::solveBlockValue(Value *Val, BasicBlock *BB) {
514 if (isa<Constant>(Val))
517 if (lookup(Val).count(BB)) {
518 // If we have a cached value, use that.
519 DEBUG(dbgs() << " reuse BB '" << BB->getName()
520 << "' val=" << lookup(Val)[BB] << '\n');
522 // Since we're reusing a cached value, we don't need to update the
523 // OverDefinedCache. The cache will have been properly updated whenever the
524 // cached value was inserted.
528 // Hold off inserting this value into the Cache in case we have to return
529 // false and come back later.
532 Instruction *BBI = dyn_cast<Instruction>(Val);
533 if (!BBI || BBI->getParent() != BB) {
534 if (!solveBlockValueNonLocal(Res, Val, BB))
536 insertResult(Val, BB, Res);
540 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
541 if (!solveBlockValuePHINode(Res, PN, BB))
543 insertResult(Val, BB, Res);
547 if (AllocaInst *AI = dyn_cast<AllocaInst>(BBI)) {
548 Res = LVILatticeVal::getNot(ConstantPointerNull::get(AI->getType()));
549 insertResult(Val, BB, Res);
553 // We can only analyze the definitions of certain classes of instructions
554 // (integral binops and casts at the moment), so bail if this isn't one.
555 LVILatticeVal Result;
556 if ((!isa<BinaryOperator>(BBI) && !isa<CastInst>(BBI)) ||
557 !BBI->getType()->isIntegerTy()) {
558 DEBUG(dbgs() << " compute BB '" << BB->getName()
559 << "' - overdefined because inst def found.\n");
560 Res.markOverdefined();
561 insertResult(Val, BB, Res);
565 // FIXME: We're currently limited to binops with a constant RHS. This should
567 BinaryOperator *BO = dyn_cast<BinaryOperator>(BBI);
568 if (BO && !isa<ConstantInt>(BO->getOperand(1))) {
569 DEBUG(dbgs() << " compute BB '" << BB->getName()
570 << "' - overdefined because inst def found.\n");
572 Res.markOverdefined();
573 insertResult(Val, BB, Res);
577 if (!solveBlockValueConstantRange(Res, BBI, BB))
579 insertResult(Val, BB, Res);
583 static bool InstructionDereferencesPointer(Instruction *I, Value *Ptr) {
584 if (LoadInst *L = dyn_cast<LoadInst>(I)) {
585 return L->getPointerAddressSpace() == 0 &&
586 GetUnderlyingObject(L->getPointerOperand()) == Ptr;
588 if (StoreInst *S = dyn_cast<StoreInst>(I)) {
589 return S->getPointerAddressSpace() == 0 &&
590 GetUnderlyingObject(S->getPointerOperand()) == Ptr;
592 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(I)) {
593 if (MI->isVolatile()) return false;
595 // FIXME: check whether it has a valuerange that excludes zero?
596 ConstantInt *Len = dyn_cast<ConstantInt>(MI->getLength());
597 if (!Len || Len->isZero()) return false;
599 if (MI->getDestAddressSpace() == 0)
600 if (GetUnderlyingObject(MI->getRawDest()) == Ptr)
602 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(MI))
603 if (MTI->getSourceAddressSpace() == 0)
604 if (GetUnderlyingObject(MTI->getRawSource()) == Ptr)
610 bool LazyValueInfoCache::solveBlockValueNonLocal(LVILatticeVal &BBLV,
611 Value *Val, BasicBlock *BB) {
612 LVILatticeVal Result; // Start Undefined.
614 // If this is a pointer, and there's a load from that pointer in this BB,
615 // then we know that the pointer can't be NULL.
616 bool NotNull = false;
617 if (Val->getType()->isPointerTy()) {
618 if (isKnownNonNull(Val)) {
621 Value *UnderlyingVal = GetUnderlyingObject(Val);
622 // If 'GetUnderlyingObject' didn't converge, skip it. It won't converge
623 // inside InstructionDereferencesPointer either.
624 if (UnderlyingVal == GetUnderlyingObject(UnderlyingVal, nullptr, 1)) {
625 for (Instruction &I : *BB) {
626 if (InstructionDereferencesPointer(&I, UnderlyingVal)) {
635 // If this is the entry block, we must be asking about an argument. The
636 // value is overdefined.
637 if (BB == &BB->getParent()->getEntryBlock()) {
638 assert(isa<Argument>(Val) && "Unknown live-in to the entry block");
640 PointerType *PTy = cast<PointerType>(Val->getType());
641 Result = LVILatticeVal::getNot(ConstantPointerNull::get(PTy));
643 Result.markOverdefined();
649 // Loop over all of our predecessors, merging what we know from them into
651 bool EdgesMissing = false;
652 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
653 LVILatticeVal EdgeResult;
654 EdgesMissing |= !getEdgeValue(Val, *PI, BB, EdgeResult);
658 Result.mergeIn(EdgeResult);
660 // If we hit overdefined, exit early. The BlockVals entry is already set
662 if (Result.isOverdefined()) {
663 DEBUG(dbgs() << " compute BB '" << BB->getName()
664 << "' - overdefined because of pred.\n");
665 // If we previously determined that this is a pointer that can't be null
666 // then return that rather than giving up entirely.
668 PointerType *PTy = cast<PointerType>(Val->getType());
669 Result = LVILatticeVal::getNot(ConstantPointerNull::get(PTy));
679 // Return the merged value, which is more precise than 'overdefined'.
680 assert(!Result.isOverdefined());
685 bool LazyValueInfoCache::solveBlockValuePHINode(LVILatticeVal &BBLV,
686 PHINode *PN, BasicBlock *BB) {
687 LVILatticeVal Result; // Start Undefined.
689 // Loop over all of our predecessors, merging what we know from them into
691 bool EdgesMissing = false;
692 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
693 BasicBlock *PhiBB = PN->getIncomingBlock(i);
694 Value *PhiVal = PN->getIncomingValue(i);
695 LVILatticeVal EdgeResult;
696 // Note that we can provide PN as the context value to getEdgeValue, even
697 // though the results will be cached, because PN is the value being used as
698 // the cache key in the caller.
699 EdgesMissing |= !getEdgeValue(PhiVal, PhiBB, BB, EdgeResult, PN);
703 Result.mergeIn(EdgeResult);
705 // If we hit overdefined, exit early. The BlockVals entry is already set
707 if (Result.isOverdefined()) {
708 DEBUG(dbgs() << " compute BB '" << BB->getName()
709 << "' - overdefined because of pred.\n");
718 // Return the merged value, which is more precise than 'overdefined'.
719 assert(!Result.isOverdefined() && "Possible PHI in entry block?");
724 static bool getValueFromFromCondition(Value *Val, ICmpInst *ICI,
725 LVILatticeVal &Result,
726 bool isTrueDest = true);
728 // If we can determine a constant range for the value Val in the context
729 // provided by the instruction BBI, then merge it into BBLV. If we did find a
730 // constant range, return true.
731 void LazyValueInfoCache::mergeAssumeBlockValueConstantRange(Value *Val,
734 BBI = BBI ? BBI : dyn_cast<Instruction>(Val);
738 for (auto &AssumeVH : AC->assumptions()) {
741 auto *I = cast<CallInst>(AssumeVH);
742 if (!isValidAssumeForContext(I, BBI, DL, DT))
745 Value *C = I->getArgOperand(0);
746 if (ICmpInst *ICI = dyn_cast<ICmpInst>(C)) {
747 LVILatticeVal Result;
748 if (getValueFromFromCondition(Val, ICI, Result)) {
749 if (BBLV.isOverdefined())
752 BBLV.mergeIn(Result);
758 bool LazyValueInfoCache::solveBlockValueConstantRange(LVILatticeVal &BBLV,
761 // Figure out the range of the LHS. If that fails, bail.
762 if (!hasBlockValue(BBI->getOperand(0), BB)) {
763 if (pushBlockValue(std::make_pair(BB, BBI->getOperand(0))))
765 BBLV.markOverdefined();
769 LVILatticeVal LHSVal = getBlockValue(BBI->getOperand(0), BB);
770 mergeAssumeBlockValueConstantRange(BBI->getOperand(0), LHSVal, BBI);
771 if (!LHSVal.isConstantRange()) {
772 BBLV.markOverdefined();
776 ConstantRange LHSRange = LHSVal.getConstantRange();
777 ConstantRange RHSRange(1);
778 IntegerType *ResultTy = cast<IntegerType>(BBI->getType());
779 if (isa<BinaryOperator>(BBI)) {
780 if (ConstantInt *RHS = dyn_cast<ConstantInt>(BBI->getOperand(1))) {
781 RHSRange = ConstantRange(RHS->getValue());
783 BBLV.markOverdefined();
788 // NOTE: We're currently limited by the set of operations that ConstantRange
789 // can evaluate symbolically. Enhancing that set will allows us to analyze
791 LVILatticeVal Result;
792 switch (BBI->getOpcode()) {
793 case Instruction::Add:
794 Result.markConstantRange(LHSRange.add(RHSRange));
796 case Instruction::Sub:
797 Result.markConstantRange(LHSRange.sub(RHSRange));
799 case Instruction::Mul:
800 Result.markConstantRange(LHSRange.multiply(RHSRange));
802 case Instruction::UDiv:
803 Result.markConstantRange(LHSRange.udiv(RHSRange));
805 case Instruction::Shl:
806 Result.markConstantRange(LHSRange.shl(RHSRange));
808 case Instruction::LShr:
809 Result.markConstantRange(LHSRange.lshr(RHSRange));
811 case Instruction::Trunc:
812 Result.markConstantRange(LHSRange.truncate(ResultTy->getBitWidth()));
814 case Instruction::SExt:
815 Result.markConstantRange(LHSRange.signExtend(ResultTy->getBitWidth()));
817 case Instruction::ZExt:
818 Result.markConstantRange(LHSRange.zeroExtend(ResultTy->getBitWidth()));
820 case Instruction::BitCast:
821 Result.markConstantRange(LHSRange);
823 case Instruction::And:
824 Result.markConstantRange(LHSRange.binaryAnd(RHSRange));
826 case Instruction::Or:
827 Result.markConstantRange(LHSRange.binaryOr(RHSRange));
830 // Unhandled instructions are overdefined.
832 DEBUG(dbgs() << " compute BB '" << BB->getName()
833 << "' - overdefined because inst def found.\n");
834 Result.markOverdefined();
842 bool getValueFromFromCondition(Value *Val, ICmpInst *ICI,
843 LVILatticeVal &Result, bool isTrueDest) {
844 if (ICI && isa<Constant>(ICI->getOperand(1))) {
845 if (ICI->isEquality() && ICI->getOperand(0) == Val) {
846 // We know that V has the RHS constant if this is a true SETEQ or
848 if (isTrueDest == (ICI->getPredicate() == ICmpInst::ICMP_EQ))
849 Result = LVILatticeVal::get(cast<Constant>(ICI->getOperand(1)));
851 Result = LVILatticeVal::getNot(cast<Constant>(ICI->getOperand(1)));
855 // Recognize the range checking idiom that InstCombine produces.
856 // (X-C1) u< C2 --> [C1, C1+C2)
857 ConstantInt *NegOffset = nullptr;
858 if (ICI->getPredicate() == ICmpInst::ICMP_ULT)
859 match(ICI->getOperand(0), m_Add(m_Specific(Val),
860 m_ConstantInt(NegOffset)));
862 ConstantInt *CI = dyn_cast<ConstantInt>(ICI->getOperand(1));
863 if (CI && (ICI->getOperand(0) == Val || NegOffset)) {
864 // Calculate the range of values that would satisfy the comparison.
865 ConstantRange CmpRange(CI->getValue());
866 ConstantRange TrueValues =
867 ConstantRange::makeICmpRegion(ICI->getPredicate(), CmpRange);
869 if (NegOffset) // Apply the offset from above.
870 TrueValues = TrueValues.subtract(NegOffset->getValue());
872 // If we're interested in the false dest, invert the condition.
873 if (!isTrueDest) TrueValues = TrueValues.inverse();
875 Result = LVILatticeVal::getRange(TrueValues);
883 /// \brief Compute the value of Val on the edge BBFrom -> BBTo. Returns false if
884 /// Val is not constrained on the edge.
885 static bool getEdgeValueLocal(Value *Val, BasicBlock *BBFrom,
886 BasicBlock *BBTo, LVILatticeVal &Result) {
887 // TODO: Handle more complex conditionals. If (v == 0 || v2 < 1) is false, we
889 if (BranchInst *BI = dyn_cast<BranchInst>(BBFrom->getTerminator())) {
890 // If this is a conditional branch and only one successor goes to BBTo, then
891 // we maybe able to infer something from the condition.
892 if (BI->isConditional() &&
893 BI->getSuccessor(0) != BI->getSuccessor(1)) {
894 bool isTrueDest = BI->getSuccessor(0) == BBTo;
895 assert(BI->getSuccessor(!isTrueDest) == BBTo &&
896 "BBTo isn't a successor of BBFrom");
898 // If V is the condition of the branch itself, then we know exactly what
900 if (BI->getCondition() == Val) {
901 Result = LVILatticeVal::get(ConstantInt::get(
902 Type::getInt1Ty(Val->getContext()), isTrueDest));
906 // If the condition of the branch is an equality comparison, we may be
907 // able to infer the value.
908 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
909 if (getValueFromFromCondition(Val, ICI, Result, isTrueDest))
914 // If the edge was formed by a switch on the value, then we may know exactly
916 if (SwitchInst *SI = dyn_cast<SwitchInst>(BBFrom->getTerminator())) {
917 if (SI->getCondition() != Val)
920 bool DefaultCase = SI->getDefaultDest() == BBTo;
921 unsigned BitWidth = Val->getType()->getIntegerBitWidth();
922 ConstantRange EdgesVals(BitWidth, DefaultCase/*isFullSet*/);
924 for (SwitchInst::CaseIt i : SI->cases()) {
925 ConstantRange EdgeVal(i.getCaseValue()->getValue());
927 // It is possible that the default destination is the destination of
928 // some cases. There is no need to perform difference for those cases.
929 if (i.getCaseSuccessor() != BBTo)
930 EdgesVals = EdgesVals.difference(EdgeVal);
931 } else if (i.getCaseSuccessor() == BBTo)
932 EdgesVals = EdgesVals.unionWith(EdgeVal);
934 Result = LVILatticeVal::getRange(EdgesVals);
940 /// \brief Compute the value of Val on the edge BBFrom -> BBTo, or the value at
941 /// the basic block if the edge does not constraint Val.
942 bool LazyValueInfoCache::getEdgeValue(Value *Val, BasicBlock *BBFrom,
943 BasicBlock *BBTo, LVILatticeVal &Result,
945 // If already a constant, there is nothing to compute.
946 if (Constant *VC = dyn_cast<Constant>(Val)) {
947 Result = LVILatticeVal::get(VC);
951 if (getEdgeValueLocal(Val, BBFrom, BBTo, Result)) {
952 if (!Result.isConstantRange() ||
953 Result.getConstantRange().getSingleElement())
956 // FIXME: this check should be moved to the beginning of the function when
957 // LVI better supports recursive values. Even for the single value case, we
958 // can intersect to detect dead code (an empty range).
959 if (!hasBlockValue(Val, BBFrom)) {
960 if (pushBlockValue(std::make_pair(BBFrom, Val)))
962 Result.markOverdefined();
966 // Try to intersect ranges of the BB and the constraint on the edge.
967 LVILatticeVal InBlock = getBlockValue(Val, BBFrom);
968 mergeAssumeBlockValueConstantRange(Val, InBlock, BBFrom->getTerminator());
969 // See note on the use of the CxtI with mergeAssumeBlockValueConstantRange,
970 // and caching, below.
971 mergeAssumeBlockValueConstantRange(Val, InBlock, CxtI);
972 if (!InBlock.isConstantRange())
975 ConstantRange Range =
976 Result.getConstantRange().intersectWith(InBlock.getConstantRange());
977 Result = LVILatticeVal::getRange(Range);
981 if (!hasBlockValue(Val, BBFrom)) {
982 if (pushBlockValue(std::make_pair(BBFrom, Val)))
984 Result.markOverdefined();
988 // If we couldn't compute the value on the edge, use the value from the BB.
989 Result = getBlockValue(Val, BBFrom);
990 mergeAssumeBlockValueConstantRange(Val, Result, BBFrom->getTerminator());
991 // We can use the context instruction (generically the ultimate instruction
992 // the calling pass is trying to simplify) here, even though the result of
993 // this function is generally cached when called from the solve* functions
994 // (and that cached result might be used with queries using a different
995 // context instruction), because when this function is called from the solve*
996 // functions, the context instruction is not provided. When called from
997 // LazyValueInfoCache::getValueOnEdge, the context instruction is provided,
998 // but then the result is not cached.
999 mergeAssumeBlockValueConstantRange(Val, Result, CxtI);
1003 LVILatticeVal LazyValueInfoCache::getValueInBlock(Value *V, BasicBlock *BB,
1004 Instruction *CxtI) {
1005 DEBUG(dbgs() << "LVI Getting block end value " << *V << " at '"
1006 << BB->getName() << "'\n");
1008 assert(BlockValueStack.empty() && BlockValueSet.empty());
1009 pushBlockValue(std::make_pair(BB, V));
1012 LVILatticeVal Result = getBlockValue(V, BB);
1013 mergeAssumeBlockValueConstantRange(V, Result, CxtI);
1015 DEBUG(dbgs() << " Result = " << Result << "\n");
1019 LVILatticeVal LazyValueInfoCache::getValueAt(Value *V, Instruction *CxtI) {
1020 DEBUG(dbgs() << "LVI Getting value " << *V << " at '"
1021 << CxtI->getName() << "'\n");
1023 LVILatticeVal Result;
1024 mergeAssumeBlockValueConstantRange(V, Result, CxtI);
1026 DEBUG(dbgs() << " Result = " << Result << "\n");
1030 LVILatticeVal LazyValueInfoCache::
1031 getValueOnEdge(Value *V, BasicBlock *FromBB, BasicBlock *ToBB,
1032 Instruction *CxtI) {
1033 DEBUG(dbgs() << "LVI Getting edge value " << *V << " from '"
1034 << FromBB->getName() << "' to '" << ToBB->getName() << "'\n");
1036 LVILatticeVal Result;
1037 if (!getEdgeValue(V, FromBB, ToBB, Result, CxtI)) {
1039 bool WasFastQuery = getEdgeValue(V, FromBB, ToBB, Result, CxtI);
1041 assert(WasFastQuery && "More work to do after problem solved?");
1044 DEBUG(dbgs() << " Result = " << Result << "\n");
1048 void LazyValueInfoCache::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
1049 BasicBlock *NewSucc) {
1050 // When an edge in the graph has been threaded, values that we could not
1051 // determine a value for before (i.e. were marked overdefined) may be possible
1052 // to solve now. We do NOT try to proactively update these values. Instead,
1053 // we clear their entries from the cache, and allow lazy updating to recompute
1054 // them when needed.
1056 // The updating process is fairly simple: we need to drop cached info
1057 // for all values that were marked overdefined in OldSucc, and for those same
1058 // values in any successor of OldSucc (except NewSucc) in which they were
1059 // also marked overdefined.
1060 std::vector<BasicBlock*> worklist;
1061 worklist.push_back(OldSucc);
1063 DenseSet<Value*> ClearSet;
1064 for (OverDefinedPairTy &P : OverDefinedCache)
1065 if (P.first == OldSucc)
1066 ClearSet.insert(P.second);
1068 // Use a worklist to perform a depth-first search of OldSucc's successors.
1069 // NOTE: We do not need a visited list since any blocks we have already
1070 // visited will have had their overdefined markers cleared already, and we
1071 // thus won't loop to their successors.
1072 while (!worklist.empty()) {
1073 BasicBlock *ToUpdate = worklist.back();
1074 worklist.pop_back();
1076 // Skip blocks only accessible through NewSucc.
1077 if (ToUpdate == NewSucc) continue;
1079 bool changed = false;
1080 for (Value *V : ClearSet) {
1081 // If a value was marked overdefined in OldSucc, and is here too...
1082 DenseSet<OverDefinedPairTy>::iterator OI =
1083 OverDefinedCache.find(std::make_pair(ToUpdate, V));
1084 if (OI == OverDefinedCache.end()) continue;
1086 // Remove it from the caches.
1087 ValueCacheEntryTy &Entry = ValueCache[LVIValueHandle(V, this)];
1088 ValueCacheEntryTy::iterator CI = Entry.find(ToUpdate);
1090 assert(CI != Entry.end() && "Couldn't find entry to update?");
1092 OverDefinedCache.erase(OI);
1094 // If we removed anything, then we potentially need to update
1095 // blocks successors too.
1099 if (!changed) continue;
1101 worklist.insert(worklist.end(), succ_begin(ToUpdate), succ_end(ToUpdate));
1105 //===----------------------------------------------------------------------===//
1106 // LazyValueInfo Impl
1107 //===----------------------------------------------------------------------===//
1109 /// getCache - This lazily constructs the LazyValueInfoCache.
1110 static LazyValueInfoCache &getCache(void *&PImpl, AssumptionCache *AC,
1111 const DataLayout *DL = nullptr,
1112 DominatorTree *DT = nullptr) {
1114 PImpl = new LazyValueInfoCache(AC, DL, DT);
1115 return *static_cast<LazyValueInfoCache*>(PImpl);
1118 bool LazyValueInfo::runOnFunction(Function &F) {
1119 AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
1121 DominatorTreeWrapperPass *DTWP =
1122 getAnalysisIfAvailable<DominatorTreeWrapperPass>();
1123 DT = DTWP ? &DTWP->getDomTree() : nullptr;
1125 DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
1126 DL = DLP ? &DLP->getDataLayout() : nullptr;
1128 TLI = &getAnalysis<TargetLibraryInfo>();
1131 getCache(PImpl, AC, DL, DT).clear();
1137 void LazyValueInfo::getAnalysisUsage(AnalysisUsage &AU) const {
1138 AU.setPreservesAll();
1139 AU.addRequired<AssumptionCacheTracker>();
1140 AU.addRequired<TargetLibraryInfo>();
1143 void LazyValueInfo::releaseMemory() {
1144 // If the cache was allocated, free it.
1146 delete &getCache(PImpl, AC);
1151 Constant *LazyValueInfo::getConstant(Value *V, BasicBlock *BB,
1152 Instruction *CxtI) {
1153 LVILatticeVal Result =
1154 getCache(PImpl, AC, DL, DT).getValueInBlock(V, BB, CxtI);
1156 if (Result.isConstant())
1157 return Result.getConstant();
1158 if (Result.isConstantRange()) {
1159 ConstantRange CR = Result.getConstantRange();
1160 if (const APInt *SingleVal = CR.getSingleElement())
1161 return ConstantInt::get(V->getContext(), *SingleVal);
1166 /// getConstantOnEdge - Determine whether the specified value is known to be a
1167 /// constant on the specified edge. Return null if not.
1168 Constant *LazyValueInfo::getConstantOnEdge(Value *V, BasicBlock *FromBB,
1170 Instruction *CxtI) {
1171 LVILatticeVal Result =
1172 getCache(PImpl, AC, DL, DT).getValueOnEdge(V, FromBB, ToBB, CxtI);
1174 if (Result.isConstant())
1175 return Result.getConstant();
1176 if (Result.isConstantRange()) {
1177 ConstantRange CR = Result.getConstantRange();
1178 if (const APInt *SingleVal = CR.getSingleElement())
1179 return ConstantInt::get(V->getContext(), *SingleVal);
1184 static LazyValueInfo::Tristate
1185 getPredicateResult(unsigned Pred, Constant *C, LVILatticeVal &Result,
1186 const DataLayout *DL, TargetLibraryInfo *TLI) {
1188 // If we know the value is a constant, evaluate the conditional.
1189 Constant *Res = nullptr;
1190 if (Result.isConstant()) {
1191 Res = ConstantFoldCompareInstOperands(Pred, Result.getConstant(), C, DL,
1193 if (ConstantInt *ResCI = dyn_cast<ConstantInt>(Res))
1194 return ResCI->isZero() ? LazyValueInfo::False : LazyValueInfo::True;
1195 return LazyValueInfo::Unknown;
1198 if (Result.isConstantRange()) {
1199 ConstantInt *CI = dyn_cast<ConstantInt>(C);
1200 if (!CI) return LazyValueInfo::Unknown;
1202 ConstantRange CR = Result.getConstantRange();
1203 if (Pred == ICmpInst::ICMP_EQ) {
1204 if (!CR.contains(CI->getValue()))
1205 return LazyValueInfo::False;
1207 if (CR.isSingleElement() && CR.contains(CI->getValue()))
1208 return LazyValueInfo::True;
1209 } else if (Pred == ICmpInst::ICMP_NE) {
1210 if (!CR.contains(CI->getValue()))
1211 return LazyValueInfo::True;
1213 if (CR.isSingleElement() && CR.contains(CI->getValue()))
1214 return LazyValueInfo::False;
1217 // Handle more complex predicates.
1218 ConstantRange TrueValues =
1219 ICmpInst::makeConstantRange((ICmpInst::Predicate)Pred, CI->getValue());
1220 if (TrueValues.contains(CR))
1221 return LazyValueInfo::True;
1222 if (TrueValues.inverse().contains(CR))
1223 return LazyValueInfo::False;
1224 return LazyValueInfo::Unknown;
1227 if (Result.isNotConstant()) {
1228 // If this is an equality comparison, we can try to fold it knowing that
1230 if (Pred == ICmpInst::ICMP_EQ) {
1231 // !C1 == C -> false iff C1 == C.
1232 Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
1233 Result.getNotConstant(), C, DL,
1235 if (Res->isNullValue())
1236 return LazyValueInfo::False;
1237 } else if (Pred == ICmpInst::ICMP_NE) {
1238 // !C1 != C -> true iff C1 == C.
1239 Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
1240 Result.getNotConstant(), C, DL,
1242 if (Res->isNullValue())
1243 return LazyValueInfo::True;
1245 return LazyValueInfo::Unknown;
1248 return LazyValueInfo::Unknown;
1251 /// getPredicateOnEdge - Determine whether the specified value comparison
1252 /// with a constant is known to be true or false on the specified CFG edge.
1253 /// Pred is a CmpInst predicate.
1254 LazyValueInfo::Tristate
1255 LazyValueInfo::getPredicateOnEdge(unsigned Pred, Value *V, Constant *C,
1256 BasicBlock *FromBB, BasicBlock *ToBB,
1257 Instruction *CxtI) {
1258 LVILatticeVal Result =
1259 getCache(PImpl, AC, DL, DT).getValueOnEdge(V, FromBB, ToBB, CxtI);
1261 return getPredicateResult(Pred, C, Result, DL, TLI);
1264 LazyValueInfo::Tristate
1265 LazyValueInfo::getPredicateAt(unsigned Pred, Value *V, Constant *C,
1266 Instruction *CxtI) {
1267 LVILatticeVal Result = getCache(PImpl, AC, DL, DT).getValueAt(V, CxtI);
1269 return getPredicateResult(Pred, C, Result, DL, TLI);
1272 void LazyValueInfo::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
1273 BasicBlock *NewSucc) {
1275 getCache(PImpl, AC, DL, DT).threadEdge(PredBB, OldSucc, NewSucc);
1278 void LazyValueInfo::eraseBlock(BasicBlock *BB) {
1280 getCache(PImpl, AC, DL, DT).eraseBlock(BB);