1 //===- LazyValueInfo.cpp - Value constraint analysis ----------------------===//
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 #define DEBUG_TYPE "lazy-value-info"
16 #include "llvm/Analysis/LazyValueInfo.h"
17 #include "llvm/Constants.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/Analysis/ConstantFolding.h"
20 #include "llvm/Target/TargetData.h"
21 #include "llvm/Support/CFG.h"
22 #include "llvm/Support/ConstantRange.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Support/ValueHandle.h"
26 #include "llvm/ADT/DenseMap.h"
27 #include "llvm/ADT/DenseSet.h"
28 #include "llvm/ADT/STLExtras.h"
31 char LazyValueInfo::ID = 0;
32 INITIALIZE_PASS(LazyValueInfo, "lazy-value-info",
33 "Lazy Value Information Analysis", false, true);
36 FunctionPass *createLazyValueInfoPass() { return new LazyValueInfo(); }
40 //===----------------------------------------------------------------------===//
42 //===----------------------------------------------------------------------===//
44 /// LVILatticeVal - This is the information tracked by LazyValueInfo for each
47 /// FIXME: This is basically just for bringup, this can be made a lot more rich
53 /// undefined - This LLVM Value has no known value yet.
56 /// constant - This LLVM Value has a specific constant value.
58 /// notconstant - This LLVM value is known to not have the specified value.
64 /// overdefined - This instruction is not known to be constant, and we know
69 /// Val: This stores the current lattice value along with the Constant* for
70 /// the constant if this is a 'constant' or 'notconstant' value.
76 LVILatticeVal() : Tag(undefined), Val(0), Range(1, true) {}
78 static LVILatticeVal get(Constant *C) {
80 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
81 Res.markConstantRange(ConstantRange(CI->getValue(), CI->getValue()+1));
82 else if (!isa<UndefValue>(C))
86 static LVILatticeVal getNot(Constant *C) {
88 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
89 Res.markConstantRange(ConstantRange(CI->getValue()+1, CI->getValue()));
91 Res.markNotConstant(C);
94 static LVILatticeVal getRange(ConstantRange CR) {
96 Res.markConstantRange(CR);
100 bool isUndefined() const { return Tag == undefined; }
101 bool isConstant() const { return Tag == constant; }
102 bool isNotConstant() const { return Tag == notconstant; }
103 bool isConstantRange() const { return Tag == constantrange; }
104 bool isOverdefined() const { return Tag == overdefined; }
106 Constant *getConstant() const {
107 assert(isConstant() && "Cannot get the constant of a non-constant!");
111 Constant *getNotConstant() const {
112 assert(isNotConstant() && "Cannot get the constant of a non-notconstant!");
116 ConstantRange getConstantRange() const {
117 assert(isConstantRange() &&
118 "Cannot get the constant-range of a non-constant-range!");
122 /// markOverdefined - Return true if this is a change in status.
123 bool markOverdefined() {
130 /// markConstant - Return true if this is a change in status.
131 bool markConstant(Constant *V) {
133 assert(getConstant() == V && "Marking constant with different value");
137 assert(isUndefined());
139 assert(V && "Marking constant with NULL");
144 /// markNotConstant - Return true if this is a change in status.
145 bool markNotConstant(Constant *V) {
146 if (isNotConstant()) {
147 assert(getNotConstant() == V && "Marking !constant with different value");
152 assert(getConstant() != V && "Marking not constant with different value");
154 assert(isUndefined());
157 assert(V && "Marking constant with NULL");
162 /// markConstantRange - Return true if this is a change in status.
163 bool markConstantRange(const ConstantRange NewR) {
164 if (isConstantRange()) {
165 if (NewR.isEmptySet())
166 return markOverdefined();
168 bool changed = Range == NewR;
173 assert(isUndefined());
174 if (NewR.isEmptySet())
175 return markOverdefined();
182 /// mergeIn - Merge the specified lattice value into this one, updating this
183 /// one and returning true if anything changed.
184 bool mergeIn(const LVILatticeVal &RHS) {
185 if (RHS.isUndefined() || isOverdefined()) return false;
186 if (RHS.isOverdefined()) return markOverdefined();
188 if (RHS.isNotConstant()) {
189 if (isNotConstant()) {
190 if (getNotConstant() != RHS.getNotConstant() ||
191 isa<ConstantExpr>(getNotConstant()) ||
192 isa<ConstantExpr>(RHS.getNotConstant()))
193 return markOverdefined();
195 } else if (isConstant()) {
196 if (getConstant() == RHS.getNotConstant() ||
197 isa<ConstantExpr>(RHS.getNotConstant()) ||
198 isa<ConstantExpr>(getConstant()))
199 return markOverdefined();
200 return markNotConstant(RHS.getNotConstant());
201 } else if (isConstantRange()) {
202 return markOverdefined();
205 assert(isUndefined() && "Unexpected lattice");
206 return markNotConstant(RHS.getNotConstant());
209 if (RHS.isConstantRange()) {
210 if (isConstantRange()) {
211 ConstantRange NewR = Range.unionWith(RHS.getConstantRange());
212 if (NewR.isFullSet())
213 return markOverdefined();
215 return markConstantRange(NewR);
216 } else if (!isUndefined()) {
217 return markOverdefined();
220 assert(isUndefined() && "Unexpected lattice");
221 return markConstantRange(RHS.getConstantRange());
224 // RHS must be a constant, we must be undef, constant, or notconstant.
225 assert(!isConstantRange() &&
226 "Constant and ConstantRange cannot be merged.");
229 return markConstant(RHS.getConstant());
232 if (getConstant() != RHS.getConstant())
233 return markOverdefined();
237 // If we are known "!=4" and RHS is "==5", stay at "!=4".
238 if (getNotConstant() == RHS.getConstant() ||
239 isa<ConstantExpr>(getNotConstant()) ||
240 isa<ConstantExpr>(RHS.getConstant()))
241 return markOverdefined();
247 } // end anonymous namespace.
250 raw_ostream &operator<<(raw_ostream &OS, const LVILatticeVal &Val) {
251 if (Val.isUndefined())
252 return OS << "undefined";
253 if (Val.isOverdefined())
254 return OS << "overdefined";
256 if (Val.isNotConstant())
257 return OS << "notconstant<" << *Val.getNotConstant() << '>';
258 else if (Val.isConstantRange())
259 return OS << "constantrange<" << Val.getConstantRange().getLower() << ", "
260 << Val.getConstantRange().getUpper() << '>';
261 return OS << "constant<" << *Val.getConstant() << '>';
265 //===----------------------------------------------------------------------===//
266 // LazyValueInfoCache Decl
267 //===----------------------------------------------------------------------===//
270 /// LazyValueInfoCache - This is the cache kept by LazyValueInfo which
271 /// maintains information about queries across the clients' queries.
272 class LazyValueInfoCache {
274 /// BlockCacheEntryTy - This is a computed lattice value at the end of the
275 /// specified basic block for a Value* that depends on context.
276 typedef std::pair<AssertingVH<BasicBlock>, LVILatticeVal> BlockCacheEntryTy;
278 /// ValueCacheEntryTy - This is all of the cached block information for
279 /// exactly one Value*. The entries are sorted by the BasicBlock* of the
280 /// entries, allowing us to do a lookup with a binary search.
281 typedef std::map<AssertingVH<BasicBlock>, LVILatticeVal> ValueCacheEntryTy;
284 /// LVIValueHandle - A callback value handle update the cache when
285 /// values are erased.
286 struct LVIValueHandle : public CallbackVH {
287 LazyValueInfoCache *Parent;
289 LVIValueHandle(Value *V, LazyValueInfoCache *P)
290 : CallbackVH(V), Parent(P) { }
293 void allUsesReplacedWith(Value* V) {
297 LVIValueHandle &operator=(Value *V) {
298 return *this = LVIValueHandle(V, Parent);
302 /// ValueCache - This is all of the cached information for all values,
303 /// mapped from Value* to key information.
304 std::map<LVIValueHandle, ValueCacheEntryTy> ValueCache;
306 /// OverDefinedCache - This tracks, on a per-block basis, the set of
307 /// values that are over-defined at the end of that block. This is required
308 /// for cache updating.
309 std::set<std::pair<AssertingVH<BasicBlock>, Value*> > OverDefinedCache;
313 /// getValueInBlock - This is the query interface to determine the lattice
314 /// value for the specified Value* at the end of the specified block.
315 LVILatticeVal getValueInBlock(Value *V, BasicBlock *BB);
317 /// getValueOnEdge - This is the query interface to determine the lattice
318 /// value for the specified Value* that is true on the specified edge.
319 LVILatticeVal getValueOnEdge(Value *V, BasicBlock *FromBB,BasicBlock *ToBB);
321 /// threadEdge - This is the update interface to inform the cache that an
322 /// edge from PredBB to OldSucc has been threaded to be from PredBB to
324 void threadEdge(BasicBlock *PredBB,BasicBlock *OldSucc,BasicBlock *NewSucc);
326 /// eraseBlock - This is part of the update interface to inform the cache
327 /// that a block has been deleted.
328 void eraseBlock(BasicBlock *BB);
330 /// clear - Empty the cache.
333 OverDefinedCache.clear();
336 } // end anonymous namespace
338 //===----------------------------------------------------------------------===//
340 //===----------------------------------------------------------------------===//
343 /// LVIQuery - This is a transient object that exists while a query is
346 /// TODO: Reuse LVIQuery instead of recreating it for every query, this avoids
347 /// reallocation of the densemap on every query.
349 typedef LazyValueInfoCache::BlockCacheEntryTy BlockCacheEntryTy;
350 typedef LazyValueInfoCache::ValueCacheEntryTy ValueCacheEntryTy;
352 /// This is the current value being queried for.
355 /// This is a pointer to the owning cache, for recursive queries.
356 LazyValueInfoCache &Parent;
358 /// This is all of the cached information about this value.
359 ValueCacheEntryTy &Cache;
361 /// This tracks, for each block, what values are overdefined.
362 std::set<std::pair<AssertingVH<BasicBlock>, Value*> > &OverDefinedCache;
364 /// NewBlocks - This is a mapping of the new BasicBlocks which have been
365 /// added to cache but that are not in sorted order.
366 DenseSet<BasicBlock*> NewBlockInfo;
370 LVIQuery(Value *V, LazyValueInfoCache &P,
371 ValueCacheEntryTy &VC,
372 std::set<std::pair<AssertingVH<BasicBlock>, Value*> > &ODC)
373 : Val(V), Parent(P), Cache(VC), OverDefinedCache(ODC) {
377 // When the query is done, insert the newly discovered facts into the
378 // cache in sorted order.
379 if (NewBlockInfo.empty()) return;
381 for (DenseSet<BasicBlock*>::iterator I = NewBlockInfo.begin(),
382 E = NewBlockInfo.end(); I != E; ++I) {
383 if (Cache[*I].isOverdefined())
384 OverDefinedCache.insert(std::make_pair(*I, Val));
388 LVILatticeVal getBlockValue(BasicBlock *BB);
389 LVILatticeVal getEdgeValue(BasicBlock *FromBB, BasicBlock *ToBB);
392 LVILatticeVal getCachedEntryForBlock(BasicBlock *BB);
394 } // end anonymous namespace
396 void LazyValueInfoCache::LVIValueHandle::deleted() {
397 for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
398 I = Parent->OverDefinedCache.begin(),
399 E = Parent->OverDefinedCache.end();
401 std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator tmp = I;
403 if (tmp->second == getValPtr())
404 Parent->OverDefinedCache.erase(tmp);
407 // This erasure deallocates *this, so it MUST happen after we're done
408 // using any and all members of *this.
409 Parent->ValueCache.erase(*this);
412 void LazyValueInfoCache::eraseBlock(BasicBlock *BB) {
413 for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
414 I = OverDefinedCache.begin(), E = OverDefinedCache.end(); I != E; ) {
415 std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator tmp = I;
417 if (tmp->first == BB)
418 OverDefinedCache.erase(tmp);
421 for (std::map<LVIValueHandle, ValueCacheEntryTy>::iterator
422 I = ValueCache.begin(), E = ValueCache.end(); I != E; ++I)
426 /// getCachedEntryForBlock - See if we already have a value for this block. If
427 /// so, return it, otherwise create a new entry in the Cache map to use.
428 LVILatticeVal LVIQuery::getCachedEntryForBlock(BasicBlock *BB) {
429 NewBlockInfo.insert(BB);
433 LVILatticeVal LVIQuery::getBlockValue(BasicBlock *BB) {
434 // See if we already have a value for this block.
435 LVILatticeVal BBLV = getCachedEntryForBlock(BB);
437 // If we've already computed this block's value, return it.
438 if (!BBLV.isUndefined()) {
439 DEBUG(dbgs() << " reuse BB '" << BB->getName() << "' val=" << BBLV <<'\n');
443 // Otherwise, this is the first time we're seeing this block. Reset the
444 // lattice value to overdefined, so that cycles will terminate and be
445 // conservatively correct.
446 BBLV.markOverdefined();
449 Instruction *BBI = dyn_cast<Instruction>(Val);
450 if (BBI == 0 || BBI->getParent() != BB) {
451 LVILatticeVal Result; // Start Undefined.
453 // If this is a pointer, and there's a load from that pointer in this BB,
454 // then we know that the pointer can't be NULL.
455 if (Val->getType()->isPointerTy()) {
456 const PointerType *PTy = cast<PointerType>(Val->getType());
457 for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();BI != BE;++BI){
458 LoadInst *L = dyn_cast<LoadInst>(BI);
459 if (L && L->getPointerAddressSpace() == 0 &&
460 L->getPointerOperand()->getUnderlyingObject() ==
461 Val->getUnderlyingObject()) {
462 return LVILatticeVal::getNot(ConstantPointerNull::get(PTy));
467 unsigned NumPreds = 0;
468 // Loop over all of our predecessors, merging what we know from them into
470 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
471 Result.mergeIn(getEdgeValue(*PI, BB));
473 // If we hit overdefined, exit early. The BlockVals entry is already set
475 if (Result.isOverdefined()) {
476 DEBUG(dbgs() << " compute BB '" << BB->getName()
477 << "' - overdefined because of pred.\n");
483 // If this is the entry block, we must be asking about an argument. The
484 // value is overdefined.
485 if (NumPreds == 0 && BB == &BB->getParent()->front()) {
486 assert(isa<Argument>(Val) && "Unknown live-in to the entry block");
487 Result.markOverdefined();
491 // Return the merged value, which is more precise than 'overdefined'.
492 assert(!Result.isOverdefined());
493 return Cache[BB] = Result;
496 // If this value is defined by an instruction in this block, we have to
497 // process it here somehow or return overdefined.
498 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
499 LVILatticeVal Result; // Start Undefined.
501 // Loop over all of our predecessors, merging what we know from them into
503 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
504 Value* PhiVal = PN->getIncomingValueForBlock(*PI);
505 Result.mergeIn(Parent.getValueOnEdge(PhiVal, *PI, BB));
507 // If we hit overdefined, exit early. The BlockVals entry is already set
509 if (Result.isOverdefined()) {
510 DEBUG(dbgs() << " compute BB '" << BB->getName()
511 << "' - overdefined because of pred.\n");
516 // Return the merged value, which is more precise than 'overdefined'.
517 assert(!Result.isOverdefined());
518 return Cache[BB] = Result;
521 assert(Cache[BB].isOverdefined() && "Recursive query changed our cache?");
523 // We can only analyze the definitions of certain classes of instructions
524 // (integral binops and casts at the moment), so bail if this isn't one.
525 LVILatticeVal Result;
526 if ((!isa<BinaryOperator>(BBI) && !isa<CastInst>(BBI)) ||
527 !BBI->getType()->isIntegerTy()) {
528 DEBUG(dbgs() << " compute BB '" << BB->getName()
529 << "' - overdefined because inst def found.\n");
530 Result.markOverdefined();
534 // FIXME: We're currently limited to binops with a constant RHS. This should
536 BinaryOperator *BO = dyn_cast<BinaryOperator>(BBI);
537 if (BO && !isa<ConstantInt>(BO->getOperand(1))) {
538 DEBUG(dbgs() << " compute BB '" << BB->getName()
539 << "' - overdefined because inst def found.\n");
541 Result.markOverdefined();
545 // Figure out the range of the LHS. If that fails, bail.
546 LVILatticeVal LHSVal = Parent.getValueInBlock(BBI->getOperand(0), BB);
547 if (!LHSVal.isConstantRange()) {
548 Result.markOverdefined();
552 ConstantInt *RHS = 0;
553 ConstantRange LHSRange = LHSVal.getConstantRange();
554 ConstantRange RHSRange(1);
555 const IntegerType *ResultTy = cast<IntegerType>(BBI->getType());
556 if (isa<BinaryOperator>(BBI)) {
557 RHS = dyn_cast<ConstantInt>(BBI->getOperand(1));
559 Result.markOverdefined();
563 RHSRange = ConstantRange(RHS->getValue(), RHS->getValue()+1);
566 // NOTE: We're currently limited by the set of operations that ConstantRange
567 // can evaluate symbolically. Enhancing that set will allows us to analyze
569 switch (BBI->getOpcode()) {
570 case Instruction::Add:
571 Result.markConstantRange(LHSRange.add(RHSRange));
573 case Instruction::Sub:
574 Result.markConstantRange(LHSRange.sub(RHSRange));
576 case Instruction::Mul:
577 Result.markConstantRange(LHSRange.multiply(RHSRange));
579 case Instruction::UDiv:
580 Result.markConstantRange(LHSRange.udiv(RHSRange));
582 case Instruction::Shl:
583 Result.markConstantRange(LHSRange.shl(RHSRange));
585 case Instruction::LShr:
586 Result.markConstantRange(LHSRange.lshr(RHSRange));
588 case Instruction::Trunc:
589 Result.markConstantRange(LHSRange.truncate(ResultTy->getBitWidth()));
591 case Instruction::SExt:
592 Result.markConstantRange(LHSRange.signExtend(ResultTy->getBitWidth()));
594 case Instruction::ZExt:
595 Result.markConstantRange(LHSRange.zeroExtend(ResultTy->getBitWidth()));
597 case Instruction::BitCast:
598 Result.markConstantRange(LHSRange);
601 // Unhandled instructions are overdefined.
603 DEBUG(dbgs() << " compute BB '" << BB->getName()
604 << "' - overdefined because inst def found.\n");
605 Result.markOverdefined();
609 return Cache[BB] = Result;
613 /// getEdgeValue - This method attempts to infer more complex
614 LVILatticeVal LVIQuery::getEdgeValue(BasicBlock *BBFrom, BasicBlock *BBTo) {
615 // TODO: Handle more complex conditionals. If (v == 0 || v2 < 1) is false, we
617 if (BranchInst *BI = dyn_cast<BranchInst>(BBFrom->getTerminator())) {
618 // If this is a conditional branch and only one successor goes to BBTo, then
619 // we maybe able to infer something from the condition.
620 if (BI->isConditional() &&
621 BI->getSuccessor(0) != BI->getSuccessor(1)) {
622 bool isTrueDest = BI->getSuccessor(0) == BBTo;
623 assert(BI->getSuccessor(!isTrueDest) == BBTo &&
624 "BBTo isn't a successor of BBFrom");
626 // If V is the condition of the branch itself, then we know exactly what
628 if (BI->getCondition() == Val)
629 return LVILatticeVal::get(ConstantInt::get(
630 Type::getInt1Ty(Val->getContext()), isTrueDest));
632 // If the condition of the branch is an equality comparison, we may be
633 // able to infer the value.
634 ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition());
635 if (ICI && ICI->getOperand(0) == Val &&
636 isa<Constant>(ICI->getOperand(1))) {
637 if (ICI->isEquality()) {
638 // We know that V has the RHS constant if this is a true SETEQ or
640 if (isTrueDest == (ICI->getPredicate() == ICmpInst::ICMP_EQ))
641 return LVILatticeVal::get(cast<Constant>(ICI->getOperand(1)));
642 return LVILatticeVal::getNot(cast<Constant>(ICI->getOperand(1)));
645 if (ConstantInt *CI = dyn_cast<ConstantInt>(ICI->getOperand(1))) {
646 // Calculate the range of values that would satisfy the comparison.
647 ConstantRange CmpRange(CI->getValue(), CI->getValue()+1);
648 ConstantRange TrueValues =
649 ConstantRange::makeICmpRegion(ICI->getPredicate(), CmpRange);
651 // If we're interested in the false dest, invert the condition.
652 if (!isTrueDest) TrueValues = TrueValues.inverse();
654 // Figure out the possible values of the query BEFORE this branch.
655 LVILatticeVal InBlock = getBlockValue(BBFrom);
656 if (!InBlock.isConstantRange())
657 return LVILatticeVal::getRange(TrueValues);
659 // Find all potential values that satisfy both the input and output
661 ConstantRange PossibleValues =
662 TrueValues.intersectWith(InBlock.getConstantRange());
664 return LVILatticeVal::getRange(PossibleValues);
670 // If the edge was formed by a switch on the value, then we may know exactly
672 if (SwitchInst *SI = dyn_cast<SwitchInst>(BBFrom->getTerminator())) {
673 // If BBTo is the default destination of the switch, we know that it
674 // doesn't have the same value as any of the cases.
675 if (SI->getCondition() == Val) {
676 if (SI->getDefaultDest() == BBTo) {
677 const IntegerType *IT = cast<IntegerType>(Val->getType());
678 ConstantRange CR(IT->getBitWidth());
680 for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
681 const APInt CaseVal = SI->getCaseValue(i)->getValue();
682 ConstantRange CaseRange(CaseVal, CaseVal+1);
683 CaseRange = CaseRange.inverse();
684 CR = CR.intersectWith(CaseRange);
687 LVILatticeVal Result;
688 if (CR.isFullSet() || CR.isEmptySet())
689 Result.markOverdefined();
691 Result.markConstantRange(CR);
695 // We only know something if there is exactly one value that goes from
697 unsigned NumEdges = 0;
698 ConstantInt *EdgeVal = 0;
699 for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
700 if (SI->getSuccessor(i) != BBTo) continue;
701 if (NumEdges++) break;
702 EdgeVal = SI->getCaseValue(i);
704 assert(EdgeVal && "Missing successor?");
706 return LVILatticeVal::get(EdgeVal);
710 // Otherwise see if the value is known in the block.
711 return getBlockValue(BBFrom);
715 //===----------------------------------------------------------------------===//
716 // LazyValueInfoCache Impl
717 //===----------------------------------------------------------------------===//
719 LVILatticeVal LazyValueInfoCache::getValueInBlock(Value *V, BasicBlock *BB) {
720 // If already a constant, there is nothing to compute.
721 if (Constant *VC = dyn_cast<Constant>(V))
722 return LVILatticeVal::get(VC);
724 DEBUG(dbgs() << "LVI Getting block end value " << *V << " at '"
725 << BB->getName() << "'\n");
727 LVILatticeVal Result = LVIQuery(V, *this,
728 ValueCache[LVIValueHandle(V, this)],
729 OverDefinedCache).getBlockValue(BB);
731 DEBUG(dbgs() << " Result = " << Result << "\n");
735 LVILatticeVal LazyValueInfoCache::
736 getValueOnEdge(Value *V, BasicBlock *FromBB, BasicBlock *ToBB) {
737 // If already a constant, there is nothing to compute.
738 if (Constant *VC = dyn_cast<Constant>(V))
739 return LVILatticeVal::get(VC);
741 DEBUG(dbgs() << "LVI Getting edge value " << *V << " from '"
742 << FromBB->getName() << "' to '" << ToBB->getName() << "'\n");
744 LVILatticeVal Result =
745 LVIQuery(V, *this, ValueCache[LVIValueHandle(V, this)],
746 OverDefinedCache).getEdgeValue(FromBB, ToBB);
748 DEBUG(dbgs() << " Result = " << Result << "\n");
753 void LazyValueInfoCache::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
754 BasicBlock *NewSucc) {
755 // When an edge in the graph has been threaded, values that we could not
756 // determine a value for before (i.e. were marked overdefined) may be possible
757 // to solve now. We do NOT try to proactively update these values. Instead,
758 // we clear their entries from the cache, and allow lazy updating to recompute
761 // The updating process is fairly simple: we need to dropped cached info
762 // for all values that were marked overdefined in OldSucc, and for those same
763 // values in any successor of OldSucc (except NewSucc) in which they were
764 // also marked overdefined.
765 std::vector<BasicBlock*> worklist;
766 worklist.push_back(OldSucc);
768 DenseSet<Value*> ClearSet;
769 for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
770 I = OverDefinedCache.begin(), E = OverDefinedCache.end(); I != E; ++I) {
771 if (I->first == OldSucc)
772 ClearSet.insert(I->second);
775 // Use a worklist to perform a depth-first search of OldSucc's successors.
776 // NOTE: We do not need a visited list since any blocks we have already
777 // visited will have had their overdefined markers cleared already, and we
778 // thus won't loop to their successors.
779 while (!worklist.empty()) {
780 BasicBlock *ToUpdate = worklist.back();
783 // Skip blocks only accessible through NewSucc.
784 if (ToUpdate == NewSucc) continue;
786 bool changed = false;
787 for (DenseSet<Value*>::iterator I = ClearSet.begin(),E = ClearSet.end();
789 // If a value was marked overdefined in OldSucc, and is here too...
790 std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator OI =
791 OverDefinedCache.find(std::make_pair(ToUpdate, *I));
792 if (OI == OverDefinedCache.end()) continue;
794 // Remove it from the caches.
795 ValueCacheEntryTy &Entry = ValueCache[LVIValueHandle(*I, this)];
796 ValueCacheEntryTy::iterator CI = Entry.find(ToUpdate);
798 assert(CI != Entry.end() && "Couldn't find entry to update?");
800 OverDefinedCache.erase(OI);
802 // If we removed anything, then we potentially need to update
803 // blocks successors too.
807 if (!changed) continue;
809 worklist.insert(worklist.end(), succ_begin(ToUpdate), succ_end(ToUpdate));
813 //===----------------------------------------------------------------------===//
814 // LazyValueInfo Impl
815 //===----------------------------------------------------------------------===//
817 /// getCache - This lazily constructs the LazyValueInfoCache.
818 static LazyValueInfoCache &getCache(void *&PImpl) {
820 PImpl = new LazyValueInfoCache();
821 return *static_cast<LazyValueInfoCache*>(PImpl);
824 bool LazyValueInfo::runOnFunction(Function &F) {
826 getCache(PImpl).clear();
828 TD = getAnalysisIfAvailable<TargetData>();
833 void LazyValueInfo::releaseMemory() {
834 // If the cache was allocated, free it.
836 delete &getCache(PImpl);
841 Constant *LazyValueInfo::getConstant(Value *V, BasicBlock *BB) {
842 LVILatticeVal Result = getCache(PImpl).getValueInBlock(V, BB);
844 if (Result.isConstant())
845 return Result.getConstant();
846 else if (Result.isConstantRange()) {
847 ConstantRange CR = Result.getConstantRange();
848 if (const APInt *SingleVal = CR.getSingleElement())
849 return ConstantInt::get(V->getContext(), *SingleVal);
854 /// getConstantOnEdge - Determine whether the specified value is known to be a
855 /// constant on the specified edge. Return null if not.
856 Constant *LazyValueInfo::getConstantOnEdge(Value *V, BasicBlock *FromBB,
858 LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
860 if (Result.isConstant())
861 return Result.getConstant();
862 else if (Result.isConstantRange()) {
863 ConstantRange CR = Result.getConstantRange();
864 if (const APInt *SingleVal = CR.getSingleElement())
865 return ConstantInt::get(V->getContext(), *SingleVal);
870 /// getPredicateOnEdge - Determine whether the specified value comparison
871 /// with a constant is known to be true or false on the specified CFG edge.
872 /// Pred is a CmpInst predicate.
873 LazyValueInfo::Tristate
874 LazyValueInfo::getPredicateOnEdge(unsigned Pred, Value *V, Constant *C,
875 BasicBlock *FromBB, BasicBlock *ToBB) {
876 LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
878 // If we know the value is a constant, evaluate the conditional.
880 if (Result.isConstant()) {
881 Res = ConstantFoldCompareInstOperands(Pred, Result.getConstant(), C, TD);
882 if (ConstantInt *ResCI = dyn_cast_or_null<ConstantInt>(Res))
883 return ResCI->isZero() ? False : True;
887 if (Result.isConstantRange()) {
888 ConstantInt *CI = dyn_cast<ConstantInt>(C);
889 if (!CI) return Unknown;
891 ConstantRange CR = Result.getConstantRange();
892 if (Pred == ICmpInst::ICMP_EQ) {
893 if (!CR.contains(CI->getValue()))
896 if (CR.isSingleElement() && CR.contains(CI->getValue()))
898 } else if (Pred == ICmpInst::ICMP_NE) {
899 if (!CR.contains(CI->getValue()))
902 if (CR.isSingleElement() && CR.contains(CI->getValue()))
906 // Handle more complex predicates.
907 ConstantRange RHS(CI->getValue(), CI->getValue()+1);
908 ConstantRange TrueValues = ConstantRange::makeICmpRegion(Pred, RHS);
909 if (CR.intersectWith(TrueValues).isEmptySet())
911 else if (TrueValues.contains(CR))
917 if (Result.isNotConstant()) {
918 // If this is an equality comparison, we can try to fold it knowing that
920 if (Pred == ICmpInst::ICMP_EQ) {
921 // !C1 == C -> false iff C1 == C.
922 Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
923 Result.getNotConstant(), C, TD);
924 if (Res->isNullValue())
926 } else if (Pred == ICmpInst::ICMP_NE) {
927 // !C1 != C -> true iff C1 == C.
928 Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
929 Result.getNotConstant(), C, TD);
930 if (Res->isNullValue())
939 void LazyValueInfo::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
940 BasicBlock* NewSucc) {
941 if (PImpl) getCache(PImpl).threadEdge(PredBB, OldSucc, NewSucc);
944 void LazyValueInfo::eraseBlock(BasicBlock *BB) {
945 if (PImpl) getCache(PImpl).eraseBlock(BB);