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/Analysis/ValueTracking.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Analysis/ConstantFolding.h"
  21 #include "llvm/Target/TargetData.h"
  22 #include "llvm/Support/CFG.h"
  23 #include "llvm/Support/ConstantRange.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Support/raw_ostream.h"
  26 #include "llvm/Support/ValueHandle.h"
  27 #include "llvm/ADT/DenseMap.h"
  28 #include "llvm/ADT/DenseSet.h"
  29 #include "llvm/ADT/STLExtras.h"
  30 #include <map>
  31 #include <set>
  32 #include <stack>
  33 using namespace llvm;
  34
  35 char LazyValueInfo::ID = 0;
  36 INITIALIZE_PASS(LazyValueInfo, "lazy-value-info",
  37                 "Lazy Value Information Analysis", false, true)
  38
  39 namespace llvm {
  40   FunctionPass *createLazyValueInfoPass() { return new LazyValueInfo(); }
  41 }
  42
  43
  44 //===----------------------------------------------------------------------===//
  45 //                               LVILatticeVal
  46 //===----------------------------------------------------------------------===//
  47
  48 /// LVILatticeVal - This is the information tracked by LazyValueInfo for each
  49 /// value.
  50 ///
  51 /// FIXME: This is basically just for bringup, this can be made a lot more rich
  52 /// in the future.
  53 ///
  54 namespace {
  55 class LVILatticeVal {
  56   enum LatticeValueTy {
  57     /// undefined - This Value has no known value yet.
  58     undefined,
  59
  60     /// constant - This Value has a specific constant value.
  61     constant,
  62     /// notconstant - This Value is known to not have the specified value.
  63     notconstant,
  64
  65     /// constantrange - The Value falls within this range.
  66     constantrange,
  67
  68     /// overdefined - This value is not known to be constant, and we know that
  69     /// it has a value.
  70     overdefined
  71   };
  72
  73   /// Val: This stores the current lattice value along with the Constant* for
  74   /// the constant if this is a 'constant' or 'notconstant' value.
  75   LatticeValueTy Tag;
  76   Constant *Val;
  77   ConstantRange Range;
  78
  79 public:
  80   LVILatticeVal() : Tag(undefined), Val(0), Range(1, true) {}
  81
  82   static LVILatticeVal get(Constant *C) {
  83     LVILatticeVal Res;
  84     if (!isa<UndefValue>(C))
  85       Res.markConstant(C);
  86     return Res;
  87   }
  88   static LVILatticeVal getNot(Constant *C) {
  89     LVILatticeVal Res;
  90     if (!isa<UndefValue>(C))
  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     assert(V && "Marking constant with NULL");
 133     if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
 134       return markConstantRange(ConstantRange(CI->getValue()));
 135     if (isa<UndefValue>(V))
 136       return false;
 137
 138     assert((!isConstant() || getConstant() == V) &&
 139            "Marking constant with different value");
 140     assert(isUndefined());
 141     Tag = constant;
 142     Val = V;
 143     return true;
 144   }
 145
 146   /// markNotConstant - Return true if this is a change in status.
 147   bool markNotConstant(Constant *V) {
 148     assert(V && "Marking constant with NULL");
 149     if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
 150       return markConstantRange(ConstantRange(CI->getValue()+1, CI->getValue()));
 151     if (isa<UndefValue>(V))
 152       return false;
 153
 154     assert((!isConstant() || getConstant() != V) &&
 155            "Marking constant !constant with same value");
 156     assert((!isNotConstant() || getNotConstant() == V) &&
 157            "Marking !constant with different value");
 158     assert(isUndefined() || isConstant());
 159     Tag = notconstant;
 160     Val = V;
 161     return true;
 162   }
 163
 164   /// markConstantRange - Return true if this is a change in status.
 165   bool markConstantRange(const ConstantRange NewR) {
 166     if (isConstantRange()) {
 167       if (NewR.isEmptySet())
 168         return markOverdefined();
 169
 170       bool changed = Range == NewR;
 171       Range = NewR;
 172       return changed;
 173     }
 174
 175     assert(isUndefined());
 176     if (NewR.isEmptySet())
 177       return markOverdefined();
 178
 179     Tag = constantrange;
 180     Range = NewR;
 181     return true;
 182   }
 183
 184   /// mergeIn - Merge the specified lattice value into this one, updating this
 185   /// one and returning true if anything changed.
 186   bool mergeIn(const LVILatticeVal &RHS) {
 187     if (RHS.isUndefined() || isOverdefined()) return false;
 188     if (RHS.isOverdefined()) return markOverdefined();
 189
 190     if (isUndefined()) {
 191       Tag = RHS.Tag;
 192       Val = RHS.Val;
 193       Range = RHS.Range;
 194       return true;
 195     }
 196
 197     if (isConstant()) {
 198       if (RHS.isConstant()) {
 199         if (Val == RHS.Val)
 200           return false;
 201         return markOverdefined();
 202       }
 203
 204       if (RHS.isNotConstant()) {
 205         if (Val == RHS.Val)
 206           return markOverdefined();
 207
 208         // Unless we can prove that the two Constants are different, we must
 209         // move to overdefined.
 210         // FIXME: use TargetData for smarter constant folding.
 211         if (ConstantInt *Res = dyn_cast<ConstantInt>(
 212                 ConstantFoldCompareInstOperands(CmpInst::ICMP_NE,
 213                                                 getConstant(),
 214                                                 RHS.getNotConstant())))
 215           if (Res->isOne())
 216             return markNotConstant(RHS.getNotConstant());
 217
 218         return markOverdefined();
 219       }
 220
 221       // RHS is a ConstantRange, LHS is a non-integer Constant.
 222
 223       // FIXME: consider the case where RHS is a range [1, 0) and LHS is
 224       // a function. The correct result is to pick up RHS.
 225
 226       return markOverdefined();
 227     }
 228
 229     if (isNotConstant()) {
 230       if (RHS.isConstant()) {
 231         if (Val == RHS.Val)
 232           return markOverdefined();
 233
 234         // Unless we can prove that the two Constants are different, we must
 235         // move to overdefined.
 236         // FIXME: use TargetData for smarter constant folding.
 237         if (ConstantInt *Res = dyn_cast<ConstantInt>(
 238                 ConstantFoldCompareInstOperands(CmpInst::ICMP_NE,
 239                                                 getNotConstant(),
 240                                                 RHS.getConstant())))
 241           if (Res->isOne())
 242             return false;
 243
 244         return markOverdefined();
 245       }
 246
 247       if (RHS.isNotConstant()) {
 248         if (Val == RHS.Val)
 249           return false;
 250         return markOverdefined();
 251       }
 252
 253       return markOverdefined();
 254     }
 255
 256     assert(isConstantRange() && "New LVILattice type?");
 257     if (!RHS.isConstantRange())
 258       return markOverdefined();
 259
 260     ConstantRange NewR = Range.unionWith(RHS.getConstantRange());
 261     if (NewR.isFullSet())
 262       return markOverdefined();
 263     return markConstantRange(NewR);
 264   }
 265 };
 266
 267 } // end anonymous namespace.
 268
 269 namespace llvm {
 270 raw_ostream &operator<<(raw_ostream &OS, const LVILatticeVal &Val) {
 271   if (Val.isUndefined())
 272     return OS << "undefined";
 273   if (Val.isOverdefined())
 274     return OS << "overdefined";
 275
 276   if (Val.isNotConstant())
 277     return OS << "notconstant<" << *Val.getNotConstant() << '>';
 278   else if (Val.isConstantRange())
 279     return OS << "constantrange<" << Val.getConstantRange().getLower() << ", "
 280               << Val.getConstantRange().getUpper() << '>';
 281   return OS << "constant<" << *Val.getConstant() << '>';
 282 }
 283 }
 284
 285 //===----------------------------------------------------------------------===//
 286 //                          LazyValueInfoCache Decl
 287 //===----------------------------------------------------------------------===//
 288
 289 namespace {
 290   /// LazyValueInfoCache - This is the cache kept by LazyValueInfo which
 291   /// maintains information about queries across the clients' queries.
 292   class LazyValueInfoCache {
 293   public:
 294     /// ValueCacheEntryTy - This is all of the cached block information for
 295     /// exactly one Value*.  The entries are sorted by the BasicBlock* of the
 296     /// entries, allowing us to do a lookup with a binary search.
 297     typedef std::map<AssertingVH<BasicBlock>, LVILatticeVal> ValueCacheEntryTy;
 298
 299   private:
 300     /// LVIValueHandle - A callback value handle update the cache when
 301     /// values are erased.
 302     struct LVIValueHandle : public CallbackVH {
 303       LazyValueInfoCache *Parent;
 304
 305       LVIValueHandle(Value *V, LazyValueInfoCache *P)
 306         : CallbackVH(V), Parent(P) { }
 307
 308       void deleted();
 309       void allUsesReplacedWith(Value *V) {
 310         deleted();
 311       }
 312     };
 313
 314     /// ValueCache - This is all of the cached information for all values,
 315     /// mapped from Value* to key information.
 316     std::map<LVIValueHandle, ValueCacheEntryTy> ValueCache;
 317
 318     /// OverDefinedCache - This tracks, on a per-block basis, the set of
 319     /// values that are over-defined at the end of that block.  This is required
 320     /// for cache updating.
 321     std::set<std::pair<AssertingVH<BasicBlock>, Value*> > OverDefinedCache;
 322
 323     LVILatticeVal getBlockValue(Value *Val, BasicBlock *BB);
 324     bool getEdgeValue(Value *V, BasicBlock *F, BasicBlock *T,
 325                       LVILatticeVal &Result);
 326     bool hasBlockValue(Value *Val, BasicBlock *BB);
 327
 328     // These methods process one work item and may add more. A false value
 329     // returned means that the work item was not completely processed and must
 330     // be revisited after going through the new items.
 331     bool solveBlockValue(Value *Val, BasicBlock *BB);
 332     bool solveBlockValueNonLocal(LVILatticeVal &BBLV,
 333                                  Value *Val, BasicBlock *BB);
 334     bool solveBlockValuePHINode(LVILatticeVal &BBLV,
 335                                 PHINode *PN, BasicBlock *BB);
 336     bool solveBlockValueConstantRange(LVILatticeVal &BBLV,
 337                                       Instruction *BBI, BasicBlock *BB);
 338
 339     void solve();
 340
 341     ValueCacheEntryTy &lookup(Value *V) {
 342       return ValueCache[LVIValueHandle(V, this)];
 343     }
 344
 345     LVILatticeVal setBlockValue(Value *V, BasicBlock *BB, LVILatticeVal L,
 346                                 ValueCacheEntryTy &Cache) {
 347       if (L.isOverdefined()) OverDefinedCache.insert(std::make_pair(BB, V));
 348       return Cache[BB] = L;
 349     }
 350     LVILatticeVal setBlockValue(Value *V, BasicBlock *BB, LVILatticeVal L) {
 351       return setBlockValue(V, BB, L, lookup(V));
 352     }
 353
 354     struct BlockStackEntry {
 355       BlockStackEntry(Value *Val, BasicBlock *BB) : Val(Val), BB(BB) {}
 356       Value *Val;
 357       BasicBlock *BB;
 358     };
 359     std::stack<BlockStackEntry> block_value_stack;
 360
 361   public:
 362     /// getValueInBlock - This is the query interface to determine the lattice
 363     /// value for the specified Value* at the end of the specified block.
 364     LVILatticeVal getValueInBlock(Value *V, BasicBlock *BB);
 365
 366     /// getValueOnEdge - This is the query interface to determine the lattice
 367     /// value for the specified Value* that is true on the specified edge.
 368     LVILatticeVal getValueOnEdge(Value *V, BasicBlock *FromBB,BasicBlock *ToBB);
 369
 370     /// threadEdge - This is the update interface to inform the cache that an
 371     /// edge from PredBB to OldSucc has been threaded to be from PredBB to
 372     /// NewSucc.
 373     void threadEdge(BasicBlock *PredBB,BasicBlock *OldSucc,BasicBlock *NewSucc);
 374
 375     /// eraseBlock - This is part of the update interface to inform the cache
 376     /// that a block has been deleted.
 377     void eraseBlock(BasicBlock *BB);
 378
 379     /// clear - Empty the cache.
 380     void clear() {
 381       ValueCache.clear();
 382       OverDefinedCache.clear();
 383     }
 384   };
 385 } // end anonymous namespace
 386
 387 void LazyValueInfoCache::LVIValueHandle::deleted() {
 388   for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
 389        I = Parent->OverDefinedCache.begin(),
 390        E = Parent->OverDefinedCache.end();
 391        I != E; ) {
 392     std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator tmp = I;
 393     ++I;
 394     if (tmp->second == getValPtr())
 395       Parent->OverDefinedCache.erase(tmp);
 396   }
 397
 398   // This erasure deallocates *this, so it MUST happen after we're done
 399   // using any and all members of *this.
 400   Parent->ValueCache.erase(*this);
 401 }
 402
 403 void LazyValueInfoCache::eraseBlock(BasicBlock *BB) {
 404   for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
 405        I = OverDefinedCache.begin(), E = OverDefinedCache.end(); I != E; ) {
 406     std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator tmp = I;
 407     ++I;
 408     if (tmp->first == BB)
 409       OverDefinedCache.erase(tmp);
 410   }
 411
 412   for (std::map<LVIValueHandle, ValueCacheEntryTy>::iterator
 413        I = ValueCache.begin(), E = ValueCache.end(); I != E; ++I)
 414     I->second.erase(BB);
 415 }
 416
 417 void LazyValueInfoCache::solve() {
 418   while (!block_value_stack.empty()) {
 419     BlockStackEntry &e = block_value_stack.top();
 420     if (solveBlockValue(e.Val, e.BB))
 421       block_value_stack.pop();
 422   }
 423 }
 424
 425 bool LazyValueInfoCache::hasBlockValue(Value *Val, BasicBlock *BB) {
 426   // If already a constant, there is nothing to compute.
 427   if (isa<Constant>(Val))
 428     return true;
 429
 430   return lookup(Val).count(BB);
 431 }
 432
 433 LVILatticeVal LazyValueInfoCache::getBlockValue(Value *Val, BasicBlock *BB) {
 434   // If already a constant, there is nothing to compute.
 435   if (Constant *VC = dyn_cast<Constant>(Val))
 436     return LVILatticeVal::get(VC);
 437
 438   return lookup(Val)[BB];
 439 }
 440
 441 bool LazyValueInfoCache::solveBlockValue(Value *Val, BasicBlock *BB) {
 442   if (isa<Constant>(Val))
 443     return true;
 444
 445   ValueCacheEntryTy &Cache = lookup(Val);
 446   LVILatticeVal &BBLV = Cache[BB];
 447
 448   // If we've already computed this block's value, return it.
 449   if (!BBLV.isUndefined()) {
 450     DEBUG(dbgs() << "  reuse BB '" << BB->getName() << "' val=" << BBLV <<'\n');
 451     return true;
 452   }
 453
 454   // Otherwise, this is the first time we're seeing this block.  Reset the
 455   // lattice value to overdefined, so that cycles will terminate and be
 456   // conservatively correct.
 457   BBLV.markOverdefined();
 458
 459   Instruction *BBI = dyn_cast<Instruction>(Val);
 460   if (BBI == 0 || BBI->getParent() != BB) {
 461     return solveBlockValueNonLocal(BBLV, Val, BB);
 462   }
 463
 464   if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
 465     return solveBlockValuePHINode(BBLV, PN, BB);
 466   }
 467
 468   // We can only analyze the definitions of certain classes of instructions
 469   // (integral binops and casts at the moment), so bail if this isn't one.
 470   LVILatticeVal Result;
 471   if ((!isa<BinaryOperator>(BBI) && !isa<CastInst>(BBI)) ||
 472      !BBI->getType()->isIntegerTy()) {
 473     DEBUG(dbgs() << " compute BB '" << BB->getName()
 474                  << "' - overdefined because inst def found.\n");
 475     BBLV.markOverdefined();
 476     return true;
 477   }
 478
 479   // FIXME: We're currently limited to binops with a constant RHS.  This should
 480   // be improved.
 481   BinaryOperator *BO = dyn_cast<BinaryOperator>(BBI);
 482   if (BO && !isa<ConstantInt>(BO->getOperand(1))) {
 483     DEBUG(dbgs() << " compute BB '" << BB->getName()
 484                  << "' - overdefined because inst def found.\n");
 485
 486     BBLV.markOverdefined();
 487     return true;
 488   }
 489
 490   return solveBlockValueConstantRange(BBLV, BBI, BB);
 491 }
 492
 493 static bool InstructionDereferencesPointer(Instruction *I, Value *Ptr) {
 494   if (LoadInst *L = dyn_cast<LoadInst>(I)) {
 495     return L->getPointerAddressSpace() == 0 &&
 496         GetUnderlyingObject(L->getPointerOperand()) ==
 497         GetUnderlyingObject(Ptr);
 498   }
 499   if (StoreInst *S = dyn_cast<StoreInst>(I)) {
 500     return S->getPointerAddressSpace() == 0 &&
 501         GetUnderlyingObject(S->getPointerOperand()) ==
 502         GetUnderlyingObject(Ptr);
 503   }
 504   // FIXME: llvm.memset, etc.
 505   return false;
 506 }
 507
 508 bool LazyValueInfoCache::solveBlockValueNonLocal(LVILatticeVal &BBLV,
 509                                                  Value *Val, BasicBlock *BB) {
 510   LVILatticeVal Result;  // Start Undefined.
 511
 512   // If this is a pointer, and there's a load from that pointer in this BB,
 513   // then we know that the pointer can't be NULL.
 514   bool NotNull = false;
 515   if (Val->getType()->isPointerTy()) {
 516     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();BI != BE;++BI){
 517       if (InstructionDereferencesPointer(BI, Val)) {
 518         NotNull = true;
 519         break;
 520       }
 521     }
 522   }
 523
 524   // If this is the entry block, we must be asking about an argument.  The
 525   // value is overdefined.
 526   if (BB == &BB->getParent()->getEntryBlock()) {
 527     assert(isa<Argument>(Val) && "Unknown live-in to the entry block");
 528     if (NotNull) {
 529       const PointerType *PTy = cast<PointerType>(Val->getType());
 530       Result = LVILatticeVal::getNot(ConstantPointerNull::get(PTy));
 531     } else {
 532       Result.markOverdefined();
 533     }
 534     BBLV = Result;
 535     return true;
 536   }
 537
 538   // Loop over all of our predecessors, merging what we know from them into
 539   // result.
 540   bool EdgesMissing = false;
 541   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
 542     LVILatticeVal EdgeResult;
 543     EdgesMissing |= !getEdgeValue(Val, *PI, BB, EdgeResult);
 544     if (EdgesMissing)
 545       continue;
 546
 547     Result.mergeIn(EdgeResult);
 548
 549     // If we hit overdefined, exit early.  The BlockVals entry is already set
 550     // to overdefined.
 551     if (Result.isOverdefined()) {
 552       DEBUG(dbgs() << " compute BB '" << BB->getName()
 553             << "' - overdefined because of pred.\n");
 554       // If we previously determined that this is a pointer that can't be null
 555       // then return that rather than giving up entirely.
 556       if (NotNull) {
 557         const PointerType *PTy = cast<PointerType>(Val->getType());
 558         Result = LVILatticeVal::getNot(ConstantPointerNull::get(PTy));
 559       }
 560
 561       BBLV = Result;
 562       return true;
 563     }
 564   }
 565   if (EdgesMissing)
 566     return false;
 567
 568   // Return the merged value, which is more precise than 'overdefined'.
 569   assert(!Result.isOverdefined());
 570   BBLV = Result;
 571   return true;
 572 }
 573
 574 bool LazyValueInfoCache::solveBlockValuePHINode(LVILatticeVal &BBLV,
 575                                                 PHINode *PN, BasicBlock *BB) {
 576   LVILatticeVal Result;  // Start Undefined.
 577
 578   // Loop over all of our predecessors, merging what we know from them into
 579   // result.
 580   bool EdgesMissing = false;
 581   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 582     BasicBlock *PhiBB = PN->getIncomingBlock(i);
 583     Value *PhiVal = PN->getIncomingValue(i);
 584     LVILatticeVal EdgeResult;
 585     EdgesMissing |= !getEdgeValue(PhiVal, PhiBB, BB, EdgeResult);
 586     if (EdgesMissing)
 587       continue;
 588
 589     Result.mergeIn(EdgeResult);
 590
 591     // If we hit overdefined, exit early.  The BlockVals entry is already set
 592     // to overdefined.
 593     if (Result.isOverdefined()) {
 594       DEBUG(dbgs() << " compute BB '" << BB->getName()
 595             << "' - overdefined because of pred.\n");
 596
 597       BBLV = Result;
 598       return true;
 599     }
 600   }
 601   if (EdgesMissing)
 602     return false;
 603
 604   // Return the merged value, which is more precise than 'overdefined'.
 605   assert(!Result.isOverdefined() && "Possible PHI in entry block?");
 606   BBLV = Result;
 607   return true;
 608 }
 609
 610 bool LazyValueInfoCache::solveBlockValueConstantRange(LVILatticeVal &BBLV,
 611                                                       Instruction *BBI,
 612                                                       BasicBlock *BB) {
 613   // Figure out the range of the LHS.  If that fails, bail.
 614   if (!hasBlockValue(BBI->getOperand(0), BB)) {
 615     block_value_stack.push(BlockStackEntry(BBI->getOperand(0), BB));
 616     return false;
 617   }
 618
 619   LVILatticeVal LHSVal = getBlockValue(BBI->getOperand(0), BB);
 620   if (!LHSVal.isConstantRange()) {
 621     BBLV.markOverdefined();
 622     return true;
 623   }
 624
 625   ConstantRange LHSRange = LHSVal.getConstantRange();
 626   ConstantRange RHSRange(1);
 627   const IntegerType *ResultTy = cast<IntegerType>(BBI->getType());
 628   if (isa<BinaryOperator>(BBI)) {
 629     if (ConstantInt *RHS = dyn_cast<ConstantInt>(BBI->getOperand(1))) {
 630       RHSRange = ConstantRange(RHS->getValue());
 631     } else {
 632       BBLV.markOverdefined();
 633       return true;
 634     }
 635   }
 636
 637   // NOTE: We're currently limited by the set of operations that ConstantRange
 638   // can evaluate symbolically.  Enhancing that set will allows us to analyze
 639   // more definitions.
 640   LVILatticeVal Result;
 641   switch (BBI->getOpcode()) {
 642   case Instruction::Add:
 643     Result.markConstantRange(LHSRange.add(RHSRange));
 644     break;
 645   case Instruction::Sub:
 646     Result.markConstantRange(LHSRange.sub(RHSRange));
 647     break;
 648   case Instruction::Mul:
 649     Result.markConstantRange(LHSRange.multiply(RHSRange));
 650     break;
 651   case Instruction::UDiv:
 652     Result.markConstantRange(LHSRange.udiv(RHSRange));
 653     break;
 654   case Instruction::Shl:
 655     Result.markConstantRange(LHSRange.shl(RHSRange));
 656     break;
 657   case Instruction::LShr:
 658     Result.markConstantRange(LHSRange.lshr(RHSRange));
 659     break;
 660   case Instruction::Trunc:
 661     Result.markConstantRange(LHSRange.truncate(ResultTy->getBitWidth()));
 662     break;
 663   case Instruction::SExt:
 664     Result.markConstantRange(LHSRange.signExtend(ResultTy->getBitWidth()));
 665     break;
 666   case Instruction::ZExt:
 667     Result.markConstantRange(LHSRange.zeroExtend(ResultTy->getBitWidth()));
 668     break;
 669   case Instruction::BitCast:
 670     Result.markConstantRange(LHSRange);
 671     break;
 672   case Instruction::And:
 673     Result.markConstantRange(LHSRange.binaryAnd(RHSRange));
 674     break;
 675   case Instruction::Or:
 676     Result.markConstantRange(LHSRange.binaryOr(RHSRange));
 677     break;
 678
 679   // Unhandled instructions are overdefined.
 680   default:
 681     DEBUG(dbgs() << " compute BB '" << BB->getName()
 682                  << "' - overdefined because inst def found.\n");
 683     Result.markOverdefined();
 684     break;
 685   }
 686
 687   BBLV = Result;
 688   return true;
 689 }
 690
 691 /// getEdgeValue - This method attempts to infer more complex
 692 bool LazyValueInfoCache::getEdgeValue(Value *Val, BasicBlock *BBFrom,
 693                                       BasicBlock *BBTo, LVILatticeVal &Result) {
 694   // If already a constant, there is nothing to compute.
 695   if (Constant *VC = dyn_cast<Constant>(Val)) {
 696     Result = LVILatticeVal::get(VC);
 697     return true;
 698   }
 699
 700   // TODO: Handle more complex conditionals.  If (v == 0 || v2 < 1) is false, we
 701   // know that v != 0.
 702   if (BranchInst *BI = dyn_cast<BranchInst>(BBFrom->getTerminator())) {
 703     // If this is a conditional branch and only one successor goes to BBTo, then
 704     // we maybe able to infer something from the condition.
 705     if (BI->isConditional() &&
 706         BI->getSuccessor(0) != BI->getSuccessor(1)) {
 707       bool isTrueDest = BI->getSuccessor(0) == BBTo;
 708       assert(BI->getSuccessor(!isTrueDest) == BBTo &&
 709              "BBTo isn't a successor of BBFrom");
 710
 711       // If V is the condition of the branch itself, then we know exactly what
 712       // it is.
 713       if (BI->getCondition() == Val) {
 714         Result = LVILatticeVal::get(ConstantInt::get(
 715                               Type::getInt1Ty(Val->getContext()), isTrueDest));
 716         return true;
 717       }
 718
 719       // If the condition of the branch is an equality comparison, we may be
 720       // able to infer the value.
 721       ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition());
 722       if (ICI && ICI->getOperand(0) == Val &&
 723           isa<Constant>(ICI->getOperand(1))) {
 724         if (ICI->isEquality()) {
 725           // We know that V has the RHS constant if this is a true SETEQ or
 726           // false SETNE.
 727           if (isTrueDest == (ICI->getPredicate() == ICmpInst::ICMP_EQ))
 728             Result = LVILatticeVal::get(cast<Constant>(ICI->getOperand(1)));
 729           else
 730             Result = LVILatticeVal::getNot(cast<Constant>(ICI->getOperand(1)));
 731           return true;
 732         }
 733
 734         if (ConstantInt *CI = dyn_cast<ConstantInt>(ICI->getOperand(1))) {
 735           // Calculate the range of values that would satisfy the comparison.
 736           ConstantRange CmpRange(CI->getValue(), CI->getValue()+1);
 737           ConstantRange TrueValues =
 738             ConstantRange::makeICmpRegion(ICI->getPredicate(), CmpRange);
 739
 740           // If we're interested in the false dest, invert the condition.
 741           if (!isTrueDest) TrueValues = TrueValues.inverse();
 742
 743           // Figure out the possible values of the query BEFORE this branch.
 744           LVILatticeVal InBlock = getBlockValue(Val, BBFrom);
 745           if (!InBlock.isConstantRange()) {
 746             Result = LVILatticeVal::getRange(TrueValues);
 747             return true;
 748           }
 749
 750           // Find all potential values that satisfy both the input and output
 751           // conditions.
 752           ConstantRange PossibleValues =
 753             TrueValues.intersectWith(InBlock.getConstantRange());
 754
 755           Result = LVILatticeVal::getRange(PossibleValues);
 756           return true;
 757         }
 758       }
 759     }
 760   }
 761
 762   // If the edge was formed by a switch on the value, then we may know exactly
 763   // what it is.
 764   if (SwitchInst *SI = dyn_cast<SwitchInst>(BBFrom->getTerminator())) {
 765     if (SI->getCondition() == Val) {
 766       // We don't know anything in the default case.
 767       if (SI->getDefaultDest() == BBTo) {
 768         Result.markOverdefined();
 769         return true;
 770       }
 771
 772       // We only know something if there is exactly one value that goes from
 773       // BBFrom to BBTo.
 774       unsigned NumEdges = 0;
 775       ConstantInt *EdgeVal = 0;
 776       for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
 777         if (SI->getSuccessor(i) != BBTo) continue;
 778         if (NumEdges++) break;
 779         EdgeVal = SI->getCaseValue(i);
 780       }
 781       assert(EdgeVal && "Missing successor?");
 782       if (NumEdges == 1) {
 783         Result = LVILatticeVal::get(EdgeVal);
 784         return true;
 785       }
 786     }
 787   }
 788
 789   // Otherwise see if the value is known in the block.
 790   if (hasBlockValue(Val, BBFrom)) {
 791     Result = getBlockValue(Val, BBFrom);
 792     return true;
 793   }
 794   block_value_stack.push(BlockStackEntry(Val, BBFrom));
 795   return false;
 796 }
 797
 798 LVILatticeVal LazyValueInfoCache::getValueInBlock(Value *V, BasicBlock *BB) {
 799   DEBUG(dbgs() << "LVI Getting block end value " << *V << " at '"
 800         << BB->getName() << "'\n");
 801
 802   block_value_stack.push(BlockStackEntry(V, BB));
 803   solve();
 804   LVILatticeVal Result = getBlockValue(V, BB);
 805
 806   DEBUG(dbgs() << "  Result = " << Result << "\n");
 807   return Result;
 808 }
 809
 810 LVILatticeVal LazyValueInfoCache::
 811 getValueOnEdge(Value *V, BasicBlock *FromBB, BasicBlock *ToBB) {
 812   DEBUG(dbgs() << "LVI Getting edge value " << *V << " from '"
 813         << FromBB->getName() << "' to '" << ToBB->getName() << "'\n");
 814
 815   LVILatticeVal Result;
 816   if (!getEdgeValue(V, FromBB, ToBB, Result)) {
 817     solve();
 818     bool WasFastQuery = getEdgeValue(V, FromBB, ToBB, Result);
 819     (void)WasFastQuery;
 820     assert(WasFastQuery && "More work to do after problem solved?");
 821   }
 822
 823   DEBUG(dbgs() << "  Result = " << Result << "\n");
 824   return Result;
 825 }
 826
 827 void LazyValueInfoCache::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
 828                                     BasicBlock *NewSucc) {
 829   // When an edge in the graph has been threaded, values that we could not
 830   // determine a value for before (i.e. were marked overdefined) may be possible
 831   // to solve now.  We do NOT try to proactively update these values.  Instead,
 832   // we clear their entries from the cache, and allow lazy updating to recompute
 833   // them when needed.
 834
 835   // The updating process is fairly simple: we need to dropped cached info
 836   // for all values that were marked overdefined in OldSucc, and for those same
 837   // values in any successor of OldSucc (except NewSucc) in which they were
 838   // also marked overdefined.
 839   std::vector<BasicBlock*> worklist;
 840   worklist.push_back(OldSucc);
 841
 842   DenseSet<Value*> ClearSet;
 843   for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
 844        I = OverDefinedCache.begin(), E = OverDefinedCache.end(); I != E; ++I) {
 845     if (I->first == OldSucc)
 846       ClearSet.insert(I->second);
 847   }
 848
 849   // Use a worklist to perform a depth-first search of OldSucc's successors.
 850   // NOTE: We do not need a visited list since any blocks we have already
 851   // visited will have had their overdefined markers cleared already, and we
 852   // thus won't loop to their successors.
 853   while (!worklist.empty()) {
 854     BasicBlock *ToUpdate = worklist.back();
 855     worklist.pop_back();
 856
 857     // Skip blocks only accessible through NewSucc.
 858     if (ToUpdate == NewSucc) continue;
 859
 860     bool changed = false;
 861     for (DenseSet<Value*>::iterator I = ClearSet.begin(), E = ClearSet.end();
 862          I != E; ++I) {
 863       // If a value was marked overdefined in OldSucc, and is here too...
 864       std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator OI =
 865         OverDefinedCache.find(std::make_pair(ToUpdate, *I));
 866       if (OI == OverDefinedCache.end()) continue;
 867
 868       // Remove it from the caches.
 869       ValueCacheEntryTy &Entry = ValueCache[LVIValueHandle(*I, this)];
 870       ValueCacheEntryTy::iterator CI = Entry.find(ToUpdate);
 871
 872       assert(CI != Entry.end() && "Couldn't find entry to update?");
 873       Entry.erase(CI);
 874       OverDefinedCache.erase(OI);
 875
 876       // If we removed anything, then we potentially need to update
 877       // blocks successors too.
 878       changed = true;
 879     }
 880
 881     if (!changed) continue;
 882
 883     worklist.insert(worklist.end(), succ_begin(ToUpdate), succ_end(ToUpdate));
 884   }
 885 }
 886
 887 //===----------------------------------------------------------------------===//
 888 //                            LazyValueInfo Impl
 889 //===----------------------------------------------------------------------===//
 890
 891 /// getCache - This lazily constructs the LazyValueInfoCache.
 892 static LazyValueInfoCache &getCache(void *&PImpl) {
 893   if (!PImpl)
 894     PImpl = new LazyValueInfoCache();
 895   return *static_cast<LazyValueInfoCache*>(PImpl);
 896 }
 897
 898 bool LazyValueInfo::runOnFunction(Function &F) {
 899   if (PImpl)
 900     getCache(PImpl).clear();
 901
 902   TD = getAnalysisIfAvailable<TargetData>();
 903   // Fully lazy.
 904   return false;
 905 }
 906
 907 void LazyValueInfo::releaseMemory() {
 908   // If the cache was allocated, free it.
 909   if (PImpl) {
 910     delete &getCache(PImpl);
 911     PImpl = 0;
 912   }
 913 }
 914
 915 Constant *LazyValueInfo::getConstant(Value *V, BasicBlock *BB) {
 916   LVILatticeVal Result = getCache(PImpl).getValueInBlock(V, BB);
 917
 918   if (Result.isConstant())
 919     return Result.getConstant();
 920   if (Result.isConstantRange()) {
 921     ConstantRange CR = Result.getConstantRange();
 922     if (const APInt *SingleVal = CR.getSingleElement())
 923       return ConstantInt::get(V->getContext(), *SingleVal);
 924   }
 925   return 0;
 926 }
 927
 928 /// getConstantOnEdge - Determine whether the specified value is known to be a
 929 /// constant on the specified edge.  Return null if not.
 930 Constant *LazyValueInfo::getConstantOnEdge(Value *V, BasicBlock *FromBB,
 931                                            BasicBlock *ToBB) {
 932   LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
 933
 934   if (Result.isConstant())
 935     return Result.getConstant();
 936   if (Result.isConstantRange()) {
 937     ConstantRange CR = Result.getConstantRange();
 938     if (const APInt *SingleVal = CR.getSingleElement())
 939       return ConstantInt::get(V->getContext(), *SingleVal);
 940   }
 941   return 0;
 942 }
 943
 944 /// getPredicateOnEdge - Determine whether the specified value comparison
 945 /// with a constant is known to be true or false on the specified CFG edge.
 946 /// Pred is a CmpInst predicate.
 947 LazyValueInfo::Tristate
 948 LazyValueInfo::getPredicateOnEdge(unsigned Pred, Value *V, Constant *C,
 949                                   BasicBlock *FromBB, BasicBlock *ToBB) {
 950   LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
 951
 952   // If we know the value is a constant, evaluate the conditional.
 953   Constant *Res = 0;
 954   if (Result.isConstant()) {
 955     Res = ConstantFoldCompareInstOperands(Pred, Result.getConstant(), C, TD);
 956     if (ConstantInt *ResCI = dyn_cast<ConstantInt>(Res))
 957       return ResCI->isZero() ? False : True;
 958     return Unknown;
 959   }
 960
 961   if (Result.isConstantRange()) {
 962     ConstantInt *CI = dyn_cast<ConstantInt>(C);
 963     if (!CI) return Unknown;
 964
 965     ConstantRange CR = Result.getConstantRange();
 966     if (Pred == ICmpInst::ICMP_EQ) {
 967       if (!CR.contains(CI->getValue()))
 968         return False;
 969
 970       if (CR.isSingleElement() && CR.contains(CI->getValue()))
 971         return True;
 972     } else if (Pred == ICmpInst::ICMP_NE) {
 973       if (!CR.contains(CI->getValue()))
 974         return True;
 975
 976       if (CR.isSingleElement() && CR.contains(CI->getValue()))
 977         return False;
 978     }
 979
 980     // Handle more complex predicates.
 981     ConstantRange TrueValues =
 982         ICmpInst::makeConstantRange((ICmpInst::Predicate)Pred, CI->getValue());
 983     if (TrueValues.contains(CR))
 984       return True;
 985     if (TrueValues.inverse().contains(CR))
 986       return False;
 987     return Unknown;
 988   }
 989
 990   if (Result.isNotConstant()) {
 991     // If this is an equality comparison, we can try to fold it knowing that
 992     // "V != C1".
 993     if (Pred == ICmpInst::ICMP_EQ) {
 994       // !C1 == C -> false iff C1 == C.
 995       Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
 996                                             Result.getNotConstant(), C, TD);
 997       if (Res->isNullValue())
 998         return False;
 999     } else if (Pred == ICmpInst::ICMP_NE) {
1000       // !C1 != C -> true iff C1 == C.
1001       Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
1002                                             Result.getNotConstant(), C, TD);
1003       if (Res->isNullValue())
1004         return True;
1005     }
1006     return Unknown;
1007   }
1008
1009   return Unknown;
1010 }
1011
1012 void LazyValueInfo::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
1013                                BasicBlock *NewSucc) {
1014   if (PImpl) getCache(PImpl).threadEdge(PredBB, OldSucc, NewSucc);
1015 }
1016
1017 void LazyValueInfo::eraseBlock(BasicBlock *BB) {
1018   if (PImpl) getCache(PImpl).eraseBlock(BB);
1019 }