lib/Analysis/LazyValueInfo.cpp

   1 //===- LazyValueInfo.cpp - Value constraint analysis ----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the interface for lazy computation of value constraint
  11 // information.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  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"
  29 using namespace llvm;
  30
  31 char LazyValueInfo::ID = 0;
  32 INITIALIZE_PASS(LazyValueInfo, "lazy-value-info",
  33                 "Lazy Value Information Analysis", false, true);
  34
  35 namespace llvm {
  36   FunctionPass *createLazyValueInfoPass() { return new LazyValueInfo(); }
  37 }
  38
  39
  40 //===----------------------------------------------------------------------===//
  41 //                               LVILatticeVal
  42 //===----------------------------------------------------------------------===//
  43
  44 /// LVILatticeVal - This is the information tracked by LazyValueInfo for each
  45 /// value.
  46 ///
  47 /// FIXME: This is basically just for bringup, this can be made a lot more rich
  48 /// in the future.
  49 ///
  50 namespace {
  51 class LVILatticeVal {
  52   enum LatticeValueTy {
  53     /// undefined - This LLVM Value has no known value yet.
  54     undefined,
  55
  56     /// constant - This LLVM Value has a specific constant value.
  57     constant,
  58     /// notconstant - This LLVM value is known to not have the specified value.
  59     notconstant,
  60
  61     /// constantrange
  62     constantrange,
  63
  64     /// overdefined - This instruction is not known to be constant, and we know
  65     /// it has a value.
  66     overdefined
  67   };
  68
  69   /// Val: This stores the current lattice value along with the Constant* for
  70   /// the constant if this is a 'constant' or 'notconstant' value.
  71   LatticeValueTy Tag;
  72   Constant *Val;
  73   ConstantRange Range;
  74
  75 public:
  76   LVILatticeVal() : Tag(undefined), Val(0), Range(1, true) {}
  77
  78   static LVILatticeVal get(Constant *C) {
  79     LVILatticeVal Res;
  80     if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
  81       Res.markConstantRange(ConstantRange(CI->getValue(), CI->getValue()+1));
  82     else if (!isa<UndefValue>(C))
  83       Res.markConstant(C);
  84     return Res;
  85   }
  86   static LVILatticeVal getNot(Constant *C) {
  87     LVILatticeVal Res;
  88     if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
  89       Res.markConstantRange(ConstantRange(CI->getValue()+1, CI->getValue()));
  90     else
  91       Res.markNotConstant(C);
  92     return Res;
  93   }
  94   static LVILatticeVal getRange(ConstantRange CR) {
  95     LVILatticeVal Res;
  96     Res.markConstantRange(CR);
  97     return Res;
  98   }
  99
 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; }
 105
 106   Constant *getConstant() const {
 107     assert(isConstant() && "Cannot get the constant of a non-constant!");
 108     return Val;
 109   }
 110
 111   Constant *getNotConstant() const {
 112     assert(isNotConstant() && "Cannot get the constant of a non-notconstant!");
 113     return Val;
 114   }
 115
 116   ConstantRange getConstantRange() const {
 117     assert(isConstantRange() &&
 118            "Cannot get the constant-range of a non-constant-range!");
 119     return Range;
 120   }
 121
 122   /// markOverdefined - Return true if this is a change in status.
 123   bool markOverdefined() {
 124     if (isOverdefined())
 125       return false;
 126     Tag = overdefined;
 127     return true;
 128   }
 129
 130   /// markConstant - Return true if this is a change in status.
 131   bool markConstant(Constant *V) {
 132     if (isConstant()) {
 133       assert(getConstant() == V && "Marking constant with different value");
 134       return false;
 135     }
 136
 137     assert(isUndefined());
 138     Tag = constant;
 139     assert(V && "Marking constant with NULL");
 140     Val = V;
 141     return true;
 142   }
 143
 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");
 148       return false;
 149     }
 150
 151     if (isConstant())
 152       assert(getConstant() != V && "Marking not constant with different value");
 153     else
 154       assert(isUndefined());
 155
 156     Tag = notconstant;
 157     assert(V && "Marking constant with NULL");
 158     Val = V;
 159     return true;
 160   }
 161
 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();
 167
 168       bool changed = Range == NewR;
 169       Range = NewR;
 170       return changed;
 171     }
 172
 173     assert(isUndefined());
 174     if (NewR.isEmptySet())
 175       return markOverdefined();
 176     else if (NewR.isFullSet()) {
 177       Tag = undefined;
 178       return true;
 179     }
 180
 181     Tag = constantrange;
 182     Range = NewR;
 183     return true;
 184   }
 185
 186   /// mergeIn - Merge the specified lattice value into this one, updating this
 187   /// one and returning true if anything changed.
 188   bool mergeIn(const LVILatticeVal &RHS) {
 189     if (RHS.isUndefined() || isOverdefined()) return false;
 190     if (RHS.isOverdefined()) return markOverdefined();
 191
 192     if (RHS.isNotConstant()) {
 193       if (isNotConstant()) {
 194         if (getNotConstant() != RHS.getNotConstant() ||
 195             isa<ConstantExpr>(getNotConstant()) ||
 196             isa<ConstantExpr>(RHS.getNotConstant()))
 197           return markOverdefined();
 198         return false;
 199       }
 200       if (isConstant()) {
 201         if (getConstant() == RHS.getNotConstant() ||
 202             isa<ConstantExpr>(RHS.getNotConstant()) ||
 203             isa<ConstantExpr>(getConstant()))
 204           return markOverdefined();
 205         return markNotConstant(RHS.getNotConstant());
 206       }
 207
 208       assert(isUndefined() && "Unexpected lattice");
 209       return markNotConstant(RHS.getNotConstant());
 210     }
 211
 212     if (RHS.isConstantRange()) {
 213       if (isConstantRange()) {
 214         ConstantRange NewR = Range.unionWith(RHS.getConstantRange());
 215         if (NewR.isFullSet())
 216           return markOverdefined();
 217         else
 218           return markConstantRange(NewR);
 219       }
 220
 221       assert(isUndefined() && "Unexpected lattice");
 222       return markConstantRange(RHS.getConstantRange());
 223     }
 224
 225     // RHS must be a constant, we must be undef, constant, or notconstant.
 226     assert(!isConstantRange() &&
 227            "Constant and ConstantRange cannot be merged.");
 228
 229     if (isUndefined())
 230       return markConstant(RHS.getConstant());
 231
 232     if (isConstant()) {
 233       if (getConstant() != RHS.getConstant())
 234         return markOverdefined();
 235       return false;
 236     }
 237
 238     // If we are known "!=4" and RHS is "==5", stay at "!=4".
 239     if (getNotConstant() == RHS.getConstant() ||
 240         isa<ConstantExpr>(getNotConstant()) ||
 241         isa<ConstantExpr>(RHS.getConstant()))
 242       return markOverdefined();
 243     return false;
 244   }
 245
 246 };
 247
 248 } // end anonymous namespace.
 249
 250 namespace llvm {
 251 raw_ostream &operator<<(raw_ostream &OS, const LVILatticeVal &Val) {
 252   if (Val.isUndefined())
 253     return OS << "undefined";
 254   if (Val.isOverdefined())
 255     return OS << "overdefined";
 256
 257   if (Val.isNotConstant())
 258     return OS << "notconstant<" << *Val.getNotConstant() << '>';
 259   else if (Val.isConstantRange())
 260     return OS << "constantrange<" << Val.getConstantRange().getLower() << ", "
 261               << Val.getConstantRange().getUpper() << '>';
 262   return OS << "constant<" << *Val.getConstant() << '>';
 263 }
 264 }
 265
 266 //===----------------------------------------------------------------------===//
 267 //                          LazyValueInfoCache Decl
 268 //===----------------------------------------------------------------------===//
 269
 270 namespace {
 271   /// LazyValueInfoCache - This is the cache kept by LazyValueInfo which
 272   /// maintains information about queries across the clients' queries.
 273   class LazyValueInfoCache {
 274   public:
 275     /// BlockCacheEntryTy - This is a computed lattice value at the end of the
 276     /// specified basic block for a Value* that depends on context.
 277     typedef std::pair<AssertingVH<BasicBlock>, LVILatticeVal> BlockCacheEntryTy;
 278
 279     /// ValueCacheEntryTy - This is all of the cached block information for
 280     /// exactly one Value*.  The entries are sorted by the BasicBlock* of the
 281     /// entries, allowing us to do a lookup with a binary search.
 282     typedef std::map<AssertingVH<BasicBlock>, LVILatticeVal> ValueCacheEntryTy;
 283
 284   private:
 285      /// LVIValueHandle - A callback value handle update the cache when
 286      /// values are erased.
 287     struct LVIValueHandle : public CallbackVH {
 288       LazyValueInfoCache *Parent;
 289
 290       LVIValueHandle(Value *V, LazyValueInfoCache *P)
 291         : CallbackVH(V), Parent(P) { }
 292
 293       void deleted();
 294       void allUsesReplacedWith(Value* V) {
 295         deleted();
 296       }
 297
 298       LVIValueHandle &operator=(Value *V) {
 299         return *this = LVIValueHandle(V, Parent);
 300       }
 301     };
 302
 303     /// ValueCache - This is all of the cached information for all values,
 304     /// mapped from Value* to key information.
 305     std::map<LVIValueHandle, ValueCacheEntryTy> ValueCache;
 306
 307     /// OverDefinedCache - This tracks, on a per-block basis, the set of
 308     /// values that are over-defined at the end of that block.  This is required
 309     /// for cache updating.
 310     std::set<std::pair<AssertingVH<BasicBlock>, Value*> > OverDefinedCache;
 311
 312   public:
 313
 314     /// getValueInBlock - This is the query interface to determine the lattice
 315     /// value for the specified Value* at the end of the specified block.
 316     LVILatticeVal getValueInBlock(Value *V, BasicBlock *BB);
 317
 318     /// getValueOnEdge - This is the query interface to determine the lattice
 319     /// value for the specified Value* that is true on the specified edge.
 320     LVILatticeVal getValueOnEdge(Value *V, BasicBlock *FromBB,BasicBlock *ToBB);
 321
 322     /// threadEdge - This is the update interface to inform the cache that an
 323     /// edge from PredBB to OldSucc has been threaded to be from PredBB to
 324     /// NewSucc.
 325     void threadEdge(BasicBlock *PredBB,BasicBlock *OldSucc,BasicBlock *NewSucc);
 326
 327     /// eraseBlock - This is part of the update interface to inform the cache
 328     /// that a block has been deleted.
 329     void eraseBlock(BasicBlock *BB);
 330
 331     /// clear - Empty the cache.
 332     void clear() {
 333       ValueCache.clear();
 334       OverDefinedCache.clear();
 335     }
 336   };
 337 } // end anonymous namespace
 338
 339 //===----------------------------------------------------------------------===//
 340 //                              LVIQuery Impl
 341 //===----------------------------------------------------------------------===//
 342
 343 namespace {
 344   /// LVIQuery - This is a transient object that exists while a query is
 345   /// being performed.
 346   ///
 347   /// TODO: Reuse LVIQuery instead of recreating it for every query, this avoids
 348   /// reallocation of the densemap on every query.
 349   class LVIQuery {
 350     typedef LazyValueInfoCache::BlockCacheEntryTy BlockCacheEntryTy;
 351     typedef LazyValueInfoCache::ValueCacheEntryTy ValueCacheEntryTy;
 352
 353     /// This is the current value being queried for.
 354     Value *Val;
 355
 356     /// This is a pointer to the owning cache, for recursive queries.
 357     LazyValueInfoCache &Parent;
 358
 359     /// This is all of the cached information about this value.
 360     ValueCacheEntryTy &Cache;
 361
 362     /// This tracks, for each block, what values are overdefined.
 363     std::set<std::pair<AssertingVH<BasicBlock>, Value*> > &OverDefinedCache;
 364
 365     ///  NewBlocks - This is a mapping of the new BasicBlocks which have been
 366     /// added to cache but that are not in sorted order.
 367     DenseSet<BasicBlock*> NewBlockInfo;
 368   public:
 369
 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) {
 374     }
 375
 376     ~LVIQuery() {
 377       // When the query is done, insert the newly discovered facts into the
 378       // cache in sorted order.
 379       if (NewBlockInfo.empty()) return;
 380
 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));
 385       }
 386     }
 387
 388     LVILatticeVal getBlockValue(BasicBlock *BB);
 389     LVILatticeVal getEdgeValue(BasicBlock *FromBB, BasicBlock *ToBB);
 390
 391   private:
 392     LVILatticeVal getCachedEntryForBlock(BasicBlock *BB);
 393   };
 394 } // end anonymous namespace
 395
 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();
 400        I != E; ) {
 401     std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator tmp = I;
 402     ++I;
 403     if (tmp->second == getValPtr())
 404       Parent->OverDefinedCache.erase(tmp);
 405   }
 406
 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);
 410 }
 411
 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;
 416     ++I;
 417     if (tmp->first == BB)
 418       OverDefinedCache.erase(tmp);
 419   }
 420
 421   for (std::map<LVIValueHandle, ValueCacheEntryTy>::iterator
 422        I = ValueCache.begin(), E = ValueCache.end(); I != E; ++I)
 423     I->second.erase(BB);
 424 }
 425
 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);
 430   return Cache[BB];
 431 }
 432
 433 LVILatticeVal LVIQuery::getBlockValue(BasicBlock *BB) {
 434   // See if we already have a value for this block.
 435   LVILatticeVal BBLV = getCachedEntryForBlock(BB);
 436
 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');
 440     return BBLV;
 441   }
 442
 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();
 447   Cache[BB] = BBLV;
 448
 449   // If V is live into BB, see if our predecessors know anything about it.
 450   Instruction *BBI = dyn_cast<Instruction>(Val);
 451   if (BBI == 0 || BBI->getParent() != BB) {
 452     LVILatticeVal Result;  // Start Undefined.
 453     unsigned NumPreds = 0;
 454
 455     // Loop over all of our predecessors, merging what we know from them into
 456     // result.
 457     for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
 458       Result.mergeIn(getEdgeValue(*PI, BB));
 459
 460       // If we hit overdefined, exit early.  The BlockVals entry is already set
 461       // to overdefined.
 462       if (Result.isOverdefined()) {
 463         DEBUG(dbgs() << " compute BB '" << BB->getName()
 464                      << "' - overdefined because of pred.\n");
 465         return Result;
 466       }
 467       ++NumPreds;
 468     }
 469
 470     // If this is the entry block, we must be asking about an argument.  The
 471     // value is overdefined.
 472     if (NumPreds == 0 && BB == &BB->getParent()->front()) {
 473       assert(isa<Argument>(Val) && "Unknown live-in to the entry block");
 474       Result.markOverdefined();
 475       return Result;
 476     }
 477
 478     // Return the merged value, which is more precise than 'overdefined'.
 479     assert(!Result.isOverdefined());
 480     return Cache[BB] = Result;
 481   }
 482
 483   // If this value is defined by an instruction in this block, we have to
 484   // process it here somehow or return overdefined.
 485   if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
 486     LVILatticeVal Result;  // Start Undefined.
 487
 488     // Loop over all of our predecessors, merging what we know from them into
 489     // result.
 490     for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
 491       Value* PhiVal = PN->getIncomingValueForBlock(*PI);
 492       Result.mergeIn(Parent.getValueOnEdge(PhiVal, *PI, BB));
 493
 494       // If we hit overdefined, exit early.  The BlockVals entry is already set
 495       // to overdefined.
 496       if (Result.isOverdefined()) {
 497         DEBUG(dbgs() << " compute BB '" << BB->getName()
 498                      << "' - overdefined because of pred.\n");
 499         return Result;
 500       }
 501     }
 502
 503     // Return the merged value, which is more precise than 'overdefined'.
 504     assert(!Result.isOverdefined());
 505     return Cache[BB] = Result;
 506   } else {
 507
 508   }
 509
 510   LVILatticeVal Result;
 511   Result.markOverdefined();
 512   return Result;
 513 }
 514
 515
 516 /// getEdgeValue - This method attempts to infer more complex
 517 LVILatticeVal LVIQuery::getEdgeValue(BasicBlock *BBFrom, BasicBlock *BBTo) {
 518   // TODO: Handle more complex conditionals.  If (v == 0 || v2 < 1) is false, we
 519   // know that v != 0.
 520   if (BranchInst *BI = dyn_cast<BranchInst>(BBFrom->getTerminator())) {
 521     // If this is a conditional branch and only one successor goes to BBTo, then
 522     // we maybe able to infer something from the condition.
 523     if (BI->isConditional() &&
 524         BI->getSuccessor(0) != BI->getSuccessor(1)) {
 525       bool isTrueDest = BI->getSuccessor(0) == BBTo;
 526       assert(BI->getSuccessor(!isTrueDest) == BBTo &&
 527              "BBTo isn't a successor of BBFrom");
 528
 529       // If V is the condition of the branch itself, then we know exactly what
 530       // it is.
 531       if (BI->getCondition() == Val)
 532         return LVILatticeVal::get(ConstantInt::get(
 533                               Type::getInt1Ty(Val->getContext()), isTrueDest));
 534
 535       // If the condition of the branch is an equality comparison, we may be
 536       // able to infer the value.
 537       ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition());
 538       if (ICI && ICI->getOperand(0) == Val &&
 539           isa<Constant>(ICI->getOperand(1))) {
 540         if (ICI->isEquality()) {
 541           // We know that V has the RHS constant if this is a true SETEQ or
 542           // false SETNE.
 543           if (isTrueDest == (ICI->getPredicate() == ICmpInst::ICMP_EQ))
 544             return LVILatticeVal::get(cast<Constant>(ICI->getOperand(1)));
 545           return LVILatticeVal::getNot(cast<Constant>(ICI->getOperand(1)));
 546         }
 547
 548         if (ConstantInt *CI = dyn_cast<ConstantInt>(ICI->getOperand(1))) {
 549           // Calculate the range of values that would satisfy the comparison.
 550           ConstantRange CmpRange(CI->getValue(), CI->getValue()+1);
 551           ConstantRange TrueValues =
 552             ConstantRange::makeICmpRegion(ICI->getPredicate(), CmpRange);
 553
 554           // If we're interested in the false dest, invert the condition.
 555           if (!isTrueDest) TrueValues = TrueValues.inverse();
 556
 557           // Figure out the possible values of the query BEFORE this branch.
 558           LVILatticeVal InBlock = getBlockValue(BBFrom);
 559           if (!InBlock.isConstantRange()) return InBlock;
 560
 561           // Find all potential values that satisfy both the input and output
 562           // conditions.
 563           ConstantRange PossibleValues =
 564             TrueValues.intersectWith(InBlock.getConstantRange());
 565
 566           return LVILatticeVal::getRange(PossibleValues);
 567         }
 568       }
 569     }
 570   }
 571
 572   // If the edge was formed by a switch on the value, then we may know exactly
 573   // what it is.
 574   if (SwitchInst *SI = dyn_cast<SwitchInst>(BBFrom->getTerminator())) {
 575     // If BBTo is the default destination of the switch, we don't know anything.
 576     // Given a more powerful range analysis we could know stuff.
 577     if (SI->getCondition() == Val && SI->getDefaultDest() != BBTo) {
 578       // We only know something if there is exactly one value that goes from
 579       // BBFrom to BBTo.
 580       unsigned NumEdges = 0;
 581       ConstantInt *EdgeVal = 0;
 582       for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
 583         if (SI->getSuccessor(i) != BBTo) continue;
 584         if (NumEdges++) break;
 585         EdgeVal = SI->getCaseValue(i);
 586       }
 587       assert(EdgeVal && "Missing successor?");
 588       if (NumEdges == 1)
 589         return LVILatticeVal::get(EdgeVal);
 590     }
 591   }
 592
 593   // Otherwise see if the value is known in the block.
 594   return getBlockValue(BBFrom);
 595 }
 596
 597
 598 //===----------------------------------------------------------------------===//
 599 //                         LazyValueInfoCache Impl
 600 //===----------------------------------------------------------------------===//
 601
 602 LVILatticeVal LazyValueInfoCache::getValueInBlock(Value *V, BasicBlock *BB) {
 603   // If already a constant, there is nothing to compute.
 604   if (Constant *VC = dyn_cast<Constant>(V))
 605     return LVILatticeVal::get(VC);
 606
 607   DEBUG(dbgs() << "LVI Getting block end value " << *V << " at '"
 608         << BB->getName() << "'\n");
 609
 610   LVILatticeVal Result = LVIQuery(V, *this,
 611                                   ValueCache[LVIValueHandle(V, this)],
 612                                   OverDefinedCache).getBlockValue(BB);
 613
 614   DEBUG(dbgs() << "  Result = " << Result << "\n");
 615   return Result;
 616 }
 617
 618 LVILatticeVal LazyValueInfoCache::
 619 getValueOnEdge(Value *V, BasicBlock *FromBB, BasicBlock *ToBB) {
 620   // If already a constant, there is nothing to compute.
 621   if (Constant *VC = dyn_cast<Constant>(V))
 622     return LVILatticeVal::get(VC);
 623
 624   DEBUG(dbgs() << "LVI Getting edge value " << *V << " from '"
 625         << FromBB->getName() << "' to '" << ToBB->getName() << "'\n");
 626
 627   LVILatticeVal Result =
 628     LVIQuery(V, *this, ValueCache[LVIValueHandle(V, this)],
 629              OverDefinedCache).getEdgeValue(FromBB, ToBB);
 630
 631   DEBUG(dbgs() << "  Result = " << Result << "\n");
 632
 633   return Result;
 634 }
 635
 636 void LazyValueInfoCache::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
 637                                     BasicBlock *NewSucc) {
 638   // When an edge in the graph has been threaded, values that we could not
 639   // determine a value for before (i.e. were marked overdefined) may be possible
 640   // to solve now.  We do NOT try to proactively update these values.  Instead,
 641   // we clear their entries from the cache, and allow lazy updating to recompute
 642   // them when needed.
 643
 644   // The updating process is fairly simple: we need to dropped cached info
 645   // for all values that were marked overdefined in OldSucc, and for those same
 646   // values in any successor of OldSucc (except NewSucc) in which they were
 647   // also marked overdefined.
 648   std::vector<BasicBlock*> worklist;
 649   worklist.push_back(OldSucc);
 650
 651   DenseSet<Value*> ClearSet;
 652   for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
 653        I = OverDefinedCache.begin(), E = OverDefinedCache.end(); I != E; ++I) {
 654     if (I->first == OldSucc)
 655       ClearSet.insert(I->second);
 656   }
 657
 658   // Use a worklist to perform a depth-first search of OldSucc's successors.
 659   // NOTE: We do not need a visited list since any blocks we have already
 660   // visited will have had their overdefined markers cleared already, and we
 661   // thus won't loop to their successors.
 662   while (!worklist.empty()) {
 663     BasicBlock *ToUpdate = worklist.back();
 664     worklist.pop_back();
 665
 666     // Skip blocks only accessible through NewSucc.
 667     if (ToUpdate == NewSucc) continue;
 668
 669     bool changed = false;
 670     for (DenseSet<Value*>::iterator I = ClearSet.begin(),E = ClearSet.end();
 671          I != E; ++I) {
 672       // If a value was marked overdefined in OldSucc, and is here too...
 673       std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator OI =
 674         OverDefinedCache.find(std::make_pair(ToUpdate, *I));
 675       if (OI == OverDefinedCache.end()) continue;
 676
 677       // Remove it from the caches.
 678       ValueCacheEntryTy &Entry = ValueCache[LVIValueHandle(*I, this)];
 679       ValueCacheEntryTy::iterator CI = Entry.find(ToUpdate);
 680
 681       assert(CI != Entry.end() && "Couldn't find entry to update?");
 682       Entry.erase(CI);
 683       OverDefinedCache.erase(OI);
 684
 685       // If we removed anything, then we potentially need to update
 686       // blocks successors too.
 687       changed = true;
 688     }
 689
 690     if (!changed) continue;
 691
 692     worklist.insert(worklist.end(), succ_begin(ToUpdate), succ_end(ToUpdate));
 693   }
 694 }
 695
 696 //===----------------------------------------------------------------------===//
 697 //                            LazyValueInfo Impl
 698 //===----------------------------------------------------------------------===//
 699
 700 /// getCache - This lazily constructs the LazyValueInfoCache.
 701 static LazyValueInfoCache &getCache(void *&PImpl) {
 702   if (!PImpl)
 703     PImpl = new LazyValueInfoCache();
 704   return *static_cast<LazyValueInfoCache*>(PImpl);
 705 }
 706
 707 bool LazyValueInfo::runOnFunction(Function &F) {
 708   if (PImpl)
 709     getCache(PImpl).clear();
 710
 711   TD = getAnalysisIfAvailable<TargetData>();
 712   // Fully lazy.
 713   return false;
 714 }
 715
 716 void LazyValueInfo::releaseMemory() {
 717   // If the cache was allocated, free it.
 718   if (PImpl) {
 719     delete &getCache(PImpl);
 720     PImpl = 0;
 721   }
 722 }
 723
 724 Constant *LazyValueInfo::getConstant(Value *V, BasicBlock *BB) {
 725   LVILatticeVal Result = getCache(PImpl).getValueInBlock(V, BB);
 726
 727   if (Result.isConstant())
 728     return Result.getConstant();
 729   return 0;
 730 }
 731
 732 /// getConstantOnEdge - Determine whether the specified value is known to be a
 733 /// constant on the specified edge.  Return null if not.
 734 Constant *LazyValueInfo::getConstantOnEdge(Value *V, BasicBlock *FromBB,
 735                                            BasicBlock *ToBB) {
 736   LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
 737
 738   if (Result.isConstant())
 739     return Result.getConstant();
 740   else if (Result.isConstantRange()) {
 741     ConstantRange CR = Result.getConstantRange();
 742     if (const APInt *SingleVal = CR.getSingleElement())
 743       return ConstantInt::get(V->getContext(), *SingleVal);
 744   }
 745   return 0;
 746 }
 747
 748 /// getPredicateOnEdge - Determine whether the specified value comparison
 749 /// with a constant is known to be true or false on the specified CFG edge.
 750 /// Pred is a CmpInst predicate.
 751 LazyValueInfo::Tristate
 752 LazyValueInfo::getPredicateOnEdge(unsigned Pred, Value *V, Constant *C,
 753                                   BasicBlock *FromBB, BasicBlock *ToBB) {
 754   LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
 755
 756   // If we know the value is a constant, evaluate the conditional.
 757   Constant *Res = 0;
 758   if (Result.isConstant()) {
 759     Res = ConstantFoldCompareInstOperands(Pred, Result.getConstant(), C, TD);
 760     if (ConstantInt *ResCI = dyn_cast_or_null<ConstantInt>(Res))
 761       return ResCI->isZero() ? False : True;
 762     return Unknown;
 763   }
 764
 765   if (Result.isConstantRange()) {
 766     ConstantInt *CI = cast<ConstantInt>(C);
 767     ConstantRange CR = Result.getConstantRange();
 768     if (Pred == ICmpInst::ICMP_EQ) {
 769       if (!CR.contains(CI->getValue()))
 770         return False;
 771
 772       if (CR.isSingleElement() && CR.contains(CI->getValue()))
 773         return True;
 774     } else if (Pred == ICmpInst::ICMP_NE) {
 775       if (!CR.contains(CI->getValue()))
 776         return True;
 777
 778       if (CR.isSingleElement() && CR.contains(CI->getValue()))
 779         return False;
 780     }
 781
 782     // Handle more complex predicates.
 783     ConstantRange RHS(CI->getValue(), CI->getValue()+1);
 784     ConstantRange TrueValues = ConstantRange::makeICmpRegion(Pred, RHS);
 785     if (CR.intersectWith(TrueValues).isEmptySet())
 786       return False;
 787     else if (TrueValues.contains(CR))
 788       return True;
 789
 790     return Unknown;
 791   }
 792
 793   if (Result.isNotConstant()) {
 794     // If this is an equality comparison, we can try to fold it knowing that
 795     // "V != C1".
 796     if (Pred == ICmpInst::ICMP_EQ) {
 797       // !C1 == C -> false iff C1 == C.
 798       Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
 799                                             Result.getNotConstant(), C, TD);
 800       if (Res->isNullValue())
 801         return False;
 802     } else if (Pred == ICmpInst::ICMP_NE) {
 803       // !C1 != C -> true iff C1 == C.
 804       Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
 805                                             Result.getNotConstant(), C, TD);
 806       if (Res->isNullValue())
 807         return True;
 808     }
 809     return Unknown;
 810   }
 811
 812   return Unknown;
 813 }
 814
 815 void LazyValueInfo::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
 816                                BasicBlock* NewSucc) {
 817   if (PImpl) getCache(PImpl).threadEdge(PredBB, OldSucc, NewSucc);
 818 }
 819
 820 void LazyValueInfo::eraseBlock(BasicBlock *BB) {
 821   if (PImpl) getCache(PImpl).eraseBlock(BB);
 822 }