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
 177     Tag = constantrange;
 178     Range = NewR;
 179     return true;
 180   }
 181
 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();
 187
 188     if (RHS.isNotConstant()) {
 189       if (isNotConstant()) {
 190         if (getNotConstant() != RHS.getNotConstant() ||
 191             isa<ConstantExpr>(getNotConstant()) ||
 192             isa<ConstantExpr>(RHS.getNotConstant()))
 193           return markOverdefined();
 194         return false;
 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();
 203       }
 204
 205       assert(isUndefined() && "Unexpected lattice");
 206       return markNotConstant(RHS.getNotConstant());
 207     }
 208
 209     if (RHS.isConstantRange()) {
 210       if (isConstantRange()) {
 211         ConstantRange NewR = Range.unionWith(RHS.getConstantRange());
 212         if (NewR.isFullSet())
 213           return markOverdefined();
 214         else
 215           return markConstantRange(NewR);
 216       } else if (!isUndefined()) {
 217         return markOverdefined();
 218       }
 219
 220       assert(isUndefined() && "Unexpected lattice");
 221       return markConstantRange(RHS.getConstantRange());
 222     }
 223
 224     // RHS must be a constant, we must be undef, constant, or notconstant.
 225     assert(!isConstantRange() &&
 226            "Constant and ConstantRange cannot be merged.");
 227
 228     if (isUndefined())
 229       return markConstant(RHS.getConstant());
 230
 231     if (isConstant()) {
 232       if (getConstant() != RHS.getConstant())
 233         return markOverdefined();
 234       return false;
 235     }
 236
 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();
 242     return false;
 243   }
 244
 245 };
 246
 247 } // end anonymous namespace.
 248
 249 namespace llvm {
 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";
 255
 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() << '>';
 262 }
 263 }
 264
 265 //===----------------------------------------------------------------------===//
 266 //                          LazyValueInfoCache Decl
 267 //===----------------------------------------------------------------------===//
 268
 269 namespace {
 270   /// LazyValueInfoCache - This is the cache kept by LazyValueInfo which
 271   /// maintains information about queries across the clients' queries.
 272   class LazyValueInfoCache {
 273   public:
 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;
 277
 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;
 282
 283   private:
 284      /// LVIValueHandle - A callback value handle update the cache when
 285      /// values are erased.
 286     struct LVIValueHandle : public CallbackVH {
 287       LazyValueInfoCache *Parent;
 288
 289       LVIValueHandle(Value *V, LazyValueInfoCache *P)
 290         : CallbackVH(V), Parent(P) { }
 291
 292       void deleted();
 293       void allUsesReplacedWith(Value* V) {
 294         deleted();
 295       }
 296     };
 297
 298     /// ValueCache - This is all of the cached information for all values,
 299     /// mapped from Value* to key information.
 300     std::map<LVIValueHandle, ValueCacheEntryTy> ValueCache;
 301
 302     /// OverDefinedCache - This tracks, on a per-block basis, the set of
 303     /// values that are over-defined at the end of that block.  This is required
 304     /// for cache updating.
 305     std::set<std::pair<AssertingVH<BasicBlock>, Value*> > OverDefinedCache;
 306
 307   public:
 308
 309     /// getValueInBlock - This is the query interface to determine the lattice
 310     /// value for the specified Value* at the end of the specified block.
 311     LVILatticeVal getValueInBlock(Value *V, BasicBlock *BB);
 312
 313     /// getValueOnEdge - This is the query interface to determine the lattice
 314     /// value for the specified Value* that is true on the specified edge.
 315     LVILatticeVal getValueOnEdge(Value *V, BasicBlock *FromBB,BasicBlock *ToBB);
 316
 317     /// threadEdge - This is the update interface to inform the cache that an
 318     /// edge from PredBB to OldSucc has been threaded to be from PredBB to
 319     /// NewSucc.
 320     void threadEdge(BasicBlock *PredBB,BasicBlock *OldSucc,BasicBlock *NewSucc);
 321
 322     /// eraseBlock - This is part of the update interface to inform the cache
 323     /// that a block has been deleted.
 324     void eraseBlock(BasicBlock *BB);
 325
 326     /// clear - Empty the cache.
 327     void clear() {
 328       ValueCache.clear();
 329       OverDefinedCache.clear();
 330     }
 331   };
 332 } // end anonymous namespace
 333
 334 //===----------------------------------------------------------------------===//
 335 //                              LVIQuery Impl
 336 //===----------------------------------------------------------------------===//
 337
 338 namespace {
 339   /// LVIQuery - This is a transient object that exists while a query is
 340   /// being performed.
 341   ///
 342   /// TODO: Reuse LVIQuery instead of recreating it for every query, this avoids
 343   /// reallocation of the densemap on every query.
 344   class LVIQuery {
 345     typedef LazyValueInfoCache::BlockCacheEntryTy BlockCacheEntryTy;
 346     typedef LazyValueInfoCache::ValueCacheEntryTy ValueCacheEntryTy;
 347
 348     /// This is the current value being queried for.
 349     Value *Val;
 350
 351     /// This is a pointer to the owning cache, for recursive queries.
 352     LazyValueInfoCache &Parent;
 353
 354     /// This is all of the cached information about this value.
 355     ValueCacheEntryTy &Cache;
 356
 357     /// This tracks, for each block, what values are overdefined.
 358     std::set<std::pair<AssertingVH<BasicBlock>, Value*> > &OverDefinedCache;
 359
 360     ///  NewBlocks - This is a mapping of the new BasicBlocks which have been
 361     /// added to cache but that are not in sorted order.
 362     DenseSet<BasicBlock*> NewBlockInfo;
 363
 364   public:
 365
 366     LVIQuery(Value *V, LazyValueInfoCache &P,
 367              ValueCacheEntryTy &VC,
 368              std::set<std::pair<AssertingVH<BasicBlock>, Value*> > &ODC)
 369       : Val(V), Parent(P), Cache(VC), OverDefinedCache(ODC) {
 370     }
 371
 372     ~LVIQuery() {
 373       // When the query is done, insert the newly discovered facts into the
 374       // cache in sorted order.
 375       if (NewBlockInfo.empty()) return;
 376
 377       for (DenseSet<BasicBlock*>::iterator I = NewBlockInfo.begin(),
 378            E = NewBlockInfo.end(); I != E; ++I) {
 379         if (Cache[*I].isOverdefined())
 380           OverDefinedCache.insert(std::make_pair(*I, Val));
 381       }
 382     }
 383
 384     LVILatticeVal getBlockValue(BasicBlock *BB);
 385     LVILatticeVal getEdgeValue(BasicBlock *FromBB, BasicBlock *ToBB);
 386
 387   private:
 388     LVILatticeVal getCachedEntryForBlock(BasicBlock *BB);
 389   };
 390 } // end anonymous namespace
 391
 392 void LazyValueInfoCache::LVIValueHandle::deleted() {
 393   for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
 394        I = Parent->OverDefinedCache.begin(),
 395        E = Parent->OverDefinedCache.end();
 396        I != E; ) {
 397     std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator tmp = I;
 398     ++I;
 399     if (tmp->second == getValPtr())
 400       Parent->OverDefinedCache.erase(tmp);
 401   }
 402
 403   // This erasure deallocates *this, so it MUST happen after we're done
 404   // using any and all members of *this.
 405   Parent->ValueCache.erase(*this);
 406 }
 407
 408 void LazyValueInfoCache::eraseBlock(BasicBlock *BB) {
 409   for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
 410        I = OverDefinedCache.begin(), E = OverDefinedCache.end(); I != E; ) {
 411     std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator tmp = I;
 412     ++I;
 413     if (tmp->first == BB)
 414       OverDefinedCache.erase(tmp);
 415   }
 416
 417   for (std::map<LVIValueHandle, ValueCacheEntryTy>::iterator
 418        I = ValueCache.begin(), E = ValueCache.end(); I != E; ++I)
 419     I->second.erase(BB);
 420 }
 421
 422 /// getCachedEntryForBlock - See if we already have a value for this block.  If
 423 /// so, return it, otherwise create a new entry in the Cache map to use.
 424 LVILatticeVal LVIQuery::getCachedEntryForBlock(BasicBlock *BB) {
 425   NewBlockInfo.insert(BB);
 426   return Cache[BB];
 427 }
 428
 429 LVILatticeVal LVIQuery::getBlockValue(BasicBlock *BB) {
 430   // See if we already have a value for this block.
 431   LVILatticeVal BBLV = getCachedEntryForBlock(BB);
 432
 433   // If we've already computed this block's value, return it.
 434   if (!BBLV.isUndefined()) {
 435     DEBUG(dbgs() << "  reuse BB '" << BB->getName() << "' val=" << BBLV <<'\n');
 436     return BBLV;
 437   }
 438
 439   // Otherwise, this is the first time we're seeing this block.  Reset the
 440   // lattice value to overdefined, so that cycles will terminate and be
 441   // conservatively correct.
 442   BBLV.markOverdefined();
 443   Cache[BB] = BBLV;
 444
 445   Instruction *BBI = dyn_cast<Instruction>(Val);
 446   if (BBI == 0 || BBI->getParent() != BB) {
 447     LVILatticeVal Result;  // Start Undefined.
 448
 449     // If this is a pointer, and there's a load from that pointer in this BB,
 450     // then we know that the pointer can't be NULL.
 451     bool NotNull = false;
 452     if (Val->getType()->isPointerTy()) {
 453       for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();BI != BE;++BI){
 454         LoadInst *L = dyn_cast<LoadInst>(BI);
 455         if (L && L->getPointerAddressSpace() == 0 &&
 456             L->getPointerOperand()->getUnderlyingObject() ==
 457               Val->getUnderlyingObject()) {
 458           NotNull = true;
 459           break;
 460         }
 461       }
 462     }
 463
 464     unsigned NumPreds = 0;
 465     // Loop over all of our predecessors, merging what we know from them into
 466     // result.
 467     for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
 468       Result.mergeIn(getEdgeValue(*PI, BB));
 469
 470       // If we hit overdefined, exit early.  The BlockVals entry is already set
 471       // to overdefined.
 472       if (Result.isOverdefined()) {
 473         DEBUG(dbgs() << " compute BB '" << BB->getName()
 474                      << "' - overdefined because of pred.\n");
 475         // If we previously determined that this is a pointer that can't be null
 476         // then return that rather than giving up entirely.
 477         if (NotNull) {
 478           const PointerType *PTy = cast<PointerType>(Val->getType());
 479           Result = LVILatticeVal::getNot(ConstantPointerNull::get(PTy));
 480         }
 481
 482         return Result;
 483       }
 484       ++NumPreds;
 485     }
 486
 487
 488     // If this is the entry block, we must be asking about an argument.  The
 489     // value is overdefined.
 490     if (NumPreds == 0 && BB == &BB->getParent()->front()) {
 491       assert(isa<Argument>(Val) && "Unknown live-in to the entry block");
 492       Result.markOverdefined();
 493       return Result;
 494     }
 495
 496     // Return the merged value, which is more precise than 'overdefined'.
 497     assert(!Result.isOverdefined());
 498     return Cache[BB] = Result;
 499   }
 500
 501   // If this value is defined by an instruction in this block, we have to
 502   // process it here somehow or return overdefined.
 503   if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
 504     LVILatticeVal Result;  // Start Undefined.
 505
 506     // Loop over all of our predecessors, merging what we know from them into
 507     // result.
 508     for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
 509       Value* PhiVal = PN->getIncomingValueForBlock(*PI);
 510       Result.mergeIn(Parent.getValueOnEdge(PhiVal, *PI, BB));
 511
 512       // If we hit overdefined, exit early.  The BlockVals entry is already set
 513       // to overdefined.
 514       if (Result.isOverdefined()) {
 515         DEBUG(dbgs() << " compute BB '" << BB->getName()
 516                      << "' - overdefined because of pred.\n");
 517         return Result;
 518       }
 519     }
 520
 521     // Return the merged value, which is more precise than 'overdefined'.
 522     assert(!Result.isOverdefined());
 523     return Cache[BB] = Result;
 524   }
 525
 526   assert(Cache[BB].isOverdefined() && "Recursive query changed our cache?");
 527
 528   // We can only analyze the definitions of certain classes of instructions
 529   // (integral binops and casts at the moment), so bail if this isn't one.
 530   LVILatticeVal Result;
 531   if ((!isa<BinaryOperator>(BBI) && !isa<CastInst>(BBI)) ||
 532      !BBI->getType()->isIntegerTy()) {
 533     DEBUG(dbgs() << " compute BB '" << BB->getName()
 534                  << "' - overdefined because inst def found.\n");
 535     Result.markOverdefined();
 536     return Result;
 537   }
 538
 539   // FIXME: We're currently limited to binops with a constant RHS.  This should
 540   // be improved.
 541   BinaryOperator *BO = dyn_cast<BinaryOperator>(BBI);
 542   if (BO && !isa<ConstantInt>(BO->getOperand(1))) {
 543     DEBUG(dbgs() << " compute BB '" << BB->getName()
 544                  << "' - overdefined because inst def found.\n");
 545
 546     Result.markOverdefined();
 547     return Result;
 548   }
 549
 550   // Figure out the range of the LHS.  If that fails, bail.
 551   LVILatticeVal LHSVal = Parent.getValueInBlock(BBI->getOperand(0), BB);
 552   if (!LHSVal.isConstantRange()) {
 553     Result.markOverdefined();
 554     return Result;
 555   }
 556
 557   ConstantInt *RHS = 0;
 558   ConstantRange LHSRange = LHSVal.getConstantRange();
 559   ConstantRange RHSRange(1);
 560   const IntegerType *ResultTy = cast<IntegerType>(BBI->getType());
 561   if (isa<BinaryOperator>(BBI)) {
 562     RHS = dyn_cast<ConstantInt>(BBI->getOperand(1));
 563     if (!RHS) {
 564       Result.markOverdefined();
 565       return Result;
 566     }
 567
 568     RHSRange = ConstantRange(RHS->getValue(), RHS->getValue()+1);
 569   }
 570
 571   // NOTE: We're currently limited by the set of operations that ConstantRange
 572   // can evaluate symbolically.  Enhancing that set will allows us to analyze
 573   // more definitions.
 574   switch (BBI->getOpcode()) {
 575   case Instruction::Add:
 576     Result.markConstantRange(LHSRange.add(RHSRange));
 577     break;
 578   case Instruction::Sub:
 579     Result.markConstantRange(LHSRange.sub(RHSRange));
 580     break;
 581   case Instruction::Mul:
 582     Result.markConstantRange(LHSRange.multiply(RHSRange));
 583     break;
 584   case Instruction::UDiv:
 585     Result.markConstantRange(LHSRange.udiv(RHSRange));
 586     break;
 587   case Instruction::Shl:
 588     Result.markConstantRange(LHSRange.shl(RHSRange));
 589     break;
 590   case Instruction::LShr:
 591     Result.markConstantRange(LHSRange.lshr(RHSRange));
 592     break;
 593   case Instruction::Trunc:
 594     Result.markConstantRange(LHSRange.truncate(ResultTy->getBitWidth()));
 595     break;
 596   case Instruction::SExt:
 597     Result.markConstantRange(LHSRange.signExtend(ResultTy->getBitWidth()));
 598     break;
 599   case Instruction::ZExt:
 600     Result.markConstantRange(LHSRange.zeroExtend(ResultTy->getBitWidth()));
 601     break;
 602   case Instruction::BitCast:
 603     Result.markConstantRange(LHSRange);
 604     break;
 605
 606   // Unhandled instructions are overdefined.
 607   default:
 608     DEBUG(dbgs() << " compute BB '" << BB->getName()
 609                  << "' - overdefined because inst def found.\n");
 610     Result.markOverdefined();
 611     break;
 612   }
 613
 614   return Cache[BB] = Result;
 615 }
 616
 617
 618 /// getEdgeValue - This method attempts to infer more complex
 619 LVILatticeVal LVIQuery::getEdgeValue(BasicBlock *BBFrom, BasicBlock *BBTo) {
 620   // TODO: Handle more complex conditionals.  If (v == 0 || v2 < 1) is false, we
 621   // know that v != 0.
 622   if (BranchInst *BI = dyn_cast<BranchInst>(BBFrom->getTerminator())) {
 623     // If this is a conditional branch and only one successor goes to BBTo, then
 624     // we maybe able to infer something from the condition.
 625     if (BI->isConditional() &&
 626         BI->getSuccessor(0) != BI->getSuccessor(1)) {
 627       bool isTrueDest = BI->getSuccessor(0) == BBTo;
 628       assert(BI->getSuccessor(!isTrueDest) == BBTo &&
 629              "BBTo isn't a successor of BBFrom");
 630
 631       // If V is the condition of the branch itself, then we know exactly what
 632       // it is.
 633       if (BI->getCondition() == Val)
 634         return LVILatticeVal::get(ConstantInt::get(
 635                               Type::getInt1Ty(Val->getContext()), isTrueDest));
 636
 637       // If the condition of the branch is an equality comparison, we may be
 638       // able to infer the value.
 639       ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition());
 640       if (ICI && ICI->getOperand(0) == Val &&
 641           isa<Constant>(ICI->getOperand(1))) {
 642         if (ICI->isEquality()) {
 643           // We know that V has the RHS constant if this is a true SETEQ or
 644           // false SETNE.
 645           if (isTrueDest == (ICI->getPredicate() == ICmpInst::ICMP_EQ))
 646             return LVILatticeVal::get(cast<Constant>(ICI->getOperand(1)));
 647           return LVILatticeVal::getNot(cast<Constant>(ICI->getOperand(1)));
 648         }
 649
 650         if (ConstantInt *CI = dyn_cast<ConstantInt>(ICI->getOperand(1))) {
 651           // Calculate the range of values that would satisfy the comparison.
 652           ConstantRange CmpRange(CI->getValue(), CI->getValue()+1);
 653           ConstantRange TrueValues =
 654             ConstantRange::makeICmpRegion(ICI->getPredicate(), CmpRange);
 655
 656           // If we're interested in the false dest, invert the condition.
 657           if (!isTrueDest) TrueValues = TrueValues.inverse();
 658
 659           // Figure out the possible values of the query BEFORE this branch.
 660           LVILatticeVal InBlock = getBlockValue(BBFrom);
 661           if (!InBlock.isConstantRange())
 662             return LVILatticeVal::getRange(TrueValues);
 663
 664           // Find all potential values that satisfy both the input and output
 665           // conditions.
 666           ConstantRange PossibleValues =
 667             TrueValues.intersectWith(InBlock.getConstantRange());
 668
 669           return LVILatticeVal::getRange(PossibleValues);
 670         }
 671       }
 672     }
 673   }
 674
 675   // If the edge was formed by a switch on the value, then we may know exactly
 676   // what it is.
 677   if (SwitchInst *SI = dyn_cast<SwitchInst>(BBFrom->getTerminator())) {
 678     if (SI->getCondition() == Val) {
 679       // We don't know anything in the default case.
 680       if (SI->getDefaultDest() == BBTo) {
 681         LVILatticeVal Result;
 682         Result.markOverdefined();
 683         return Result;
 684       }
 685
 686       // We only know something if there is exactly one value that goes from
 687       // BBFrom to BBTo.
 688       unsigned NumEdges = 0;
 689       ConstantInt *EdgeVal = 0;
 690       for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
 691         if (SI->getSuccessor(i) != BBTo) continue;
 692         if (NumEdges++) break;
 693         EdgeVal = SI->getCaseValue(i);
 694       }
 695       assert(EdgeVal && "Missing successor?");
 696       if (NumEdges == 1)
 697         return LVILatticeVal::get(EdgeVal);
 698     }
 699   }
 700
 701   // Otherwise see if the value is known in the block.
 702   return getBlockValue(BBFrom);
 703 }
 704
 705
 706 //===----------------------------------------------------------------------===//
 707 //                         LazyValueInfoCache Impl
 708 //===----------------------------------------------------------------------===//
 709
 710 LVILatticeVal LazyValueInfoCache::getValueInBlock(Value *V, BasicBlock *BB) {
 711   // If already a constant, there is nothing to compute.
 712   if (Constant *VC = dyn_cast<Constant>(V))
 713     return LVILatticeVal::get(VC);
 714
 715   DEBUG(dbgs() << "LVI Getting block end value " << *V << " at '"
 716         << BB->getName() << "'\n");
 717
 718   LVILatticeVal Result = LVIQuery(V, *this,
 719                                 ValueCache[LVIValueHandle(V, this)],
 720                                 OverDefinedCache).getBlockValue(BB);
 721
 722   DEBUG(dbgs() << "  Result = " << Result << "\n");
 723   return Result;
 724 }
 725
 726 LVILatticeVal LazyValueInfoCache::
 727 getValueOnEdge(Value *V, BasicBlock *FromBB, BasicBlock *ToBB) {
 728   // If already a constant, there is nothing to compute.
 729   if (Constant *VC = dyn_cast<Constant>(V))
 730     return LVILatticeVal::get(VC);
 731
 732   DEBUG(dbgs() << "LVI Getting edge value " << *V << " from '"
 733         << FromBB->getName() << "' to '" << ToBB->getName() << "'\n");
 734
 735   LVILatticeVal Result =
 736     LVIQuery(V, *this, ValueCache[LVIValueHandle(V, this)],
 737              OverDefinedCache).getEdgeValue(FromBB, ToBB);
 738
 739   DEBUG(dbgs() << "  Result = " << Result << "\n");
 740
 741   return Result;
 742 }
 743
 744 void LazyValueInfoCache::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
 745                                     BasicBlock *NewSucc) {
 746   // When an edge in the graph has been threaded, values that we could not
 747   // determine a value for before (i.e. were marked overdefined) may be possible
 748   // to solve now.  We do NOT try to proactively update these values.  Instead,
 749   // we clear their entries from the cache, and allow lazy updating to recompute
 750   // them when needed.
 751
 752   // The updating process is fairly simple: we need to dropped cached info
 753   // for all values that were marked overdefined in OldSucc, and for those same
 754   // values in any successor of OldSucc (except NewSucc) in which they were
 755   // also marked overdefined.
 756   std::vector<BasicBlock*> worklist;
 757   worklist.push_back(OldSucc);
 758
 759   DenseSet<Value*> ClearSet;
 760   for (std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator
 761        I = OverDefinedCache.begin(), E = OverDefinedCache.end(); I != E; ++I) {
 762     if (I->first == OldSucc)
 763       ClearSet.insert(I->second);
 764   }
 765
 766   // Use a worklist to perform a depth-first search of OldSucc's successors.
 767   // NOTE: We do not need a visited list since any blocks we have already
 768   // visited will have had their overdefined markers cleared already, and we
 769   // thus won't loop to their successors.
 770   while (!worklist.empty()) {
 771     BasicBlock *ToUpdate = worklist.back();
 772     worklist.pop_back();
 773
 774     // Skip blocks only accessible through NewSucc.
 775     if (ToUpdate == NewSucc) continue;
 776
 777     bool changed = false;
 778     for (DenseSet<Value*>::iterator I = ClearSet.begin(),E = ClearSet.end();
 779          I != E; ++I) {
 780       // If a value was marked overdefined in OldSucc, and is here too...
 781       std::set<std::pair<AssertingVH<BasicBlock>, Value*> >::iterator OI =
 782         OverDefinedCache.find(std::make_pair(ToUpdate, *I));
 783       if (OI == OverDefinedCache.end()) continue;
 784
 785       // Remove it from the caches.
 786       ValueCacheEntryTy &Entry = ValueCache[LVIValueHandle(*I, this)];
 787       ValueCacheEntryTy::iterator CI = Entry.find(ToUpdate);
 788
 789       assert(CI != Entry.end() && "Couldn't find entry to update?");
 790       Entry.erase(CI);
 791       OverDefinedCache.erase(OI);
 792
 793       // If we removed anything, then we potentially need to update
 794       // blocks successors too.
 795       changed = true;
 796     }
 797
 798     if (!changed) continue;
 799
 800     worklist.insert(worklist.end(), succ_begin(ToUpdate), succ_end(ToUpdate));
 801   }
 802 }
 803
 804 //===----------------------------------------------------------------------===//
 805 //                            LazyValueInfo Impl
 806 //===----------------------------------------------------------------------===//
 807
 808 /// getCache - This lazily constructs the LazyValueInfoCache.
 809 static LazyValueInfoCache &getCache(void *&PImpl) {
 810   if (!PImpl)
 811     PImpl = new LazyValueInfoCache();
 812   return *static_cast<LazyValueInfoCache*>(PImpl);
 813 }
 814
 815 bool LazyValueInfo::runOnFunction(Function &F) {
 816   if (PImpl)
 817     getCache(PImpl).clear();
 818
 819   TD = getAnalysisIfAvailable<TargetData>();
 820   // Fully lazy.
 821   return false;
 822 }
 823
 824 void LazyValueInfo::releaseMemory() {
 825   // If the cache was allocated, free it.
 826   if (PImpl) {
 827     delete &getCache(PImpl);
 828     PImpl = 0;
 829   }
 830 }
 831
 832 Constant *LazyValueInfo::getConstant(Value *V, BasicBlock *BB) {
 833   LVILatticeVal Result = getCache(PImpl).getValueInBlock(V, BB);
 834
 835   if (Result.isConstant())
 836     return Result.getConstant();
 837   else if (Result.isConstantRange()) {
 838     ConstantRange CR = Result.getConstantRange();
 839     if (const APInt *SingleVal = CR.getSingleElement())
 840       return ConstantInt::get(V->getContext(), *SingleVal);
 841   }
 842   return 0;
 843 }
 844
 845 /// getConstantOnEdge - Determine whether the specified value is known to be a
 846 /// constant on the specified edge.  Return null if not.
 847 Constant *LazyValueInfo::getConstantOnEdge(Value *V, BasicBlock *FromBB,
 848                                            BasicBlock *ToBB) {
 849   LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
 850
 851   if (Result.isConstant())
 852     return Result.getConstant();
 853   else if (Result.isConstantRange()) {
 854     ConstantRange CR = Result.getConstantRange();
 855     if (const APInt *SingleVal = CR.getSingleElement())
 856       return ConstantInt::get(V->getContext(), *SingleVal);
 857   }
 858   return 0;
 859 }
 860
 861 /// getPredicateOnEdge - Determine whether the specified value comparison
 862 /// with a constant is known to be true or false on the specified CFG edge.
 863 /// Pred is a CmpInst predicate.
 864 LazyValueInfo::Tristate
 865 LazyValueInfo::getPredicateOnEdge(unsigned Pred, Value *V, Constant *C,
 866                                   BasicBlock *FromBB, BasicBlock *ToBB) {
 867   LVILatticeVal Result = getCache(PImpl).getValueOnEdge(V, FromBB, ToBB);
 868
 869   // If we know the value is a constant, evaluate the conditional.
 870   Constant *Res = 0;
 871   if (Result.isConstant()) {
 872     Res = ConstantFoldCompareInstOperands(Pred, Result.getConstant(), C, TD);
 873     if (ConstantInt *ResCI = dyn_cast_or_null<ConstantInt>(Res))
 874       return ResCI->isZero() ? False : True;
 875     return Unknown;
 876   }
 877
 878   if (Result.isConstantRange()) {
 879     ConstantInt *CI = dyn_cast<ConstantInt>(C);
 880     if (!CI) return Unknown;
 881
 882     ConstantRange CR = Result.getConstantRange();
 883     if (Pred == ICmpInst::ICMP_EQ) {
 884       if (!CR.contains(CI->getValue()))
 885         return False;
 886
 887       if (CR.isSingleElement() && CR.contains(CI->getValue()))
 888         return True;
 889     } else if (Pred == ICmpInst::ICMP_NE) {
 890       if (!CR.contains(CI->getValue()))
 891         return True;
 892
 893       if (CR.isSingleElement() && CR.contains(CI->getValue()))
 894         return False;
 895     }
 896
 897     // Handle more complex predicates.
 898     ConstantRange RHS(CI->getValue(), CI->getValue()+1);
 899     ConstantRange TrueValues = ConstantRange::makeICmpRegion(Pred, RHS);
 900     if (CR.intersectWith(TrueValues).isEmptySet())
 901       return False;
 902     else if (TrueValues.contains(CR))
 903       return True;
 904
 905     return Unknown;
 906   }
 907
 908   if (Result.isNotConstant()) {
 909     // If this is an equality comparison, we can try to fold it knowing that
 910     // "V != C1".
 911     if (Pred == ICmpInst::ICMP_EQ) {
 912       // !C1 == C -> false iff C1 == C.
 913       Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
 914                                             Result.getNotConstant(), C, TD);
 915       if (Res->isNullValue())
 916         return False;
 917     } else if (Pred == ICmpInst::ICMP_NE) {
 918       // !C1 != C -> true iff C1 == C.
 919       Res = ConstantFoldCompareInstOperands(ICmpInst::ICMP_NE,
 920                                             Result.getNotConstant(), C, TD);
 921       if (Res->isNullValue())
 922         return True;
 923     }
 924     return Unknown;
 925   }
 926
 927   return Unknown;
 928 }
 929
 930 void LazyValueInfo::threadEdge(BasicBlock *PredBB, BasicBlock *OldSucc,
 931                                BasicBlock* NewSucc) {
 932   if (PImpl) getCache(PImpl).threadEdge(PredBB, OldSucc, NewSucc);
 933 }
 934
 935 void LazyValueInfo::eraseBlock(BasicBlock *BB) {
 936   if (PImpl) getCache(PImpl).eraseBlock(BB);
 937 }