lib/IR/Value.cpp

   1 //===-- Value.cpp - Implement the Value class -----------------------------===//
   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 implements the Value, ValueHandle, and User classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/IR/Value.h"
  15 #include "LLVMContextImpl.h"
  16 #include "llvm/ADT/DenseMap.h"
  17 #include "llvm/ADT/SmallString.h"
  18 #include "llvm/IR/Constant.h"
  19 #include "llvm/IR/Constants.h"
  20 #include "llvm/IR/DerivedTypes.h"
  21 #include "llvm/IR/InstrTypes.h"
  22 #include "llvm/IR/Instructions.h"
  23 #include "llvm/IR/Module.h"
  24 #include "llvm/IR/Operator.h"
  25 #include "llvm/IR/ValueSymbolTable.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/Support/ErrorHandling.h"
  28 #include "llvm/Support/GetElementPtrTypeIterator.h"
  29 #include "llvm/Support/LeakDetector.h"
  30 #include "llvm/Support/ManagedStatic.h"
  31 #include "llvm/Support/ValueHandle.h"
  32 #include <algorithm>
  33 using namespace llvm;
  34
  35 //===----------------------------------------------------------------------===//
  36 //                                Value Class
  37 //===----------------------------------------------------------------------===//
  38
  39 static inline Type *checkType(Type *Ty) {
  40   assert(Ty && "Value defined with a null type: Error!");
  41   return const_cast<Type*>(Ty);
  42 }
  43
  44 Value::Value(Type *ty, unsigned scid)
  45   : SubclassID(scid), HasValueHandle(0),
  46     SubclassOptionalData(0), SubclassData(0), VTy((Type*)checkType(ty)),
  47     UseList(0), Name(0) {
  48   // FIXME: Why isn't this in the subclass gunk??
  49   // Note, we cannot call isa<CallInst> before the CallInst has been
  50   // constructed.
  51   if (SubclassID == Instruction::Call || SubclassID == Instruction::Invoke)
  52     assert((VTy->isFirstClassType() || VTy->isVoidTy() || VTy->isStructTy()) &&
  53            "invalid CallInst type!");
  54   else if (SubclassID != BasicBlockVal &&
  55            (SubclassID < ConstantFirstVal || SubclassID > ConstantLastVal))
  56     assert((VTy->isFirstClassType() || VTy->isVoidTy()) &&
  57            "Cannot create non-first-class values except for constants!");
  58 }
  59
  60 Value::~Value() {
  61   // Notify all ValueHandles (if present) that this value is going away.
  62   if (HasValueHandle)
  63     ValueHandleBase::ValueIsDeleted(this);
  64
  65 #ifndef NDEBUG      // Only in -g mode...
  66   // Check to make sure that there are no uses of this value that are still
  67   // around when the value is destroyed.  If there are, then we have a dangling
  68   // reference and something is wrong.  This code is here to print out what is
  69   // still being referenced.  The value in question should be printed as
  70   // a <badref>
  71   //
  72   if (!use_empty()) {
  73     dbgs() << "While deleting: " << *VTy << " %" << getName() << "\n";
  74     for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
  75       dbgs() << "Use still stuck around after Def is destroyed:"
  76            << **I << "\n";
  77   }
  78 #endif
  79   assert(use_empty() && "Uses remain when a value is destroyed!");
  80
  81   // If this value is named, destroy the name.  This should not be in a symtab
  82   // at this point.
  83   if (Name && SubclassID != MDStringVal)
  84     Name->Destroy();
  85
  86   // There should be no uses of this object anymore, remove it.
  87   LeakDetector::removeGarbageObject(this);
  88 }
  89
  90 /// hasNUses - Return true if this Value has exactly N users.
  91 ///
  92 bool Value::hasNUses(unsigned N) const {
  93   const_use_iterator UI = use_begin(), E = use_end();
  94
  95   for (; N; --N, ++UI)
  96     if (UI == E) return false;  // Too few.
  97   return UI == E;
  98 }
  99
 100 /// hasNUsesOrMore - Return true if this value has N users or more.  This is
 101 /// logically equivalent to getNumUses() >= N.
 102 ///
 103 bool Value::hasNUsesOrMore(unsigned N) const {
 104   const_use_iterator UI = use_begin(), E = use_end();
 105
 106   for (; N; --N, ++UI)
 107     if (UI == E) return false;  // Too few.
 108
 109   return true;
 110 }
 111
 112 /// isUsedInBasicBlock - Return true if this value is used in the specified
 113 /// basic block.
 114 bool Value::isUsedInBasicBlock(const BasicBlock *BB) const {
 115   // This can be computed either by scanning the instructions in BB, or by
 116   // scanning the use list of this Value. Both lists can be very long, but
 117   // usually one is quite short.
 118   //
 119   // Scan both lists simultaneously until one is exhausted. This limits the
 120   // search to the shorter list.
 121   BasicBlock::const_iterator BI = BB->begin(), BE = BB->end();
 122   const_use_iterator UI = use_begin(), UE = use_end();
 123   for (; BI != BE && UI != UE; ++BI, ++UI) {
 124     // Scan basic block: Check if this Value is used by the instruction at BI.
 125     if (std::find(BI->op_begin(), BI->op_end(), this) != BI->op_end())
 126       return true;
 127     // Scan use list: Check if the use at UI is in BB.
 128     const Instruction *User = dyn_cast<Instruction>(*UI);
 129     if (User && User->getParent() == BB)
 130       return true;
 131   }
 132   return false;
 133 }
 134
 135
 136 /// getNumUses - This method computes the number of uses of this Value.  This
 137 /// is a linear time operation.  Use hasOneUse or hasNUses to check for specific
 138 /// values.
 139 unsigned Value::getNumUses() const {
 140   return (unsigned)std::distance(use_begin(), use_end());
 141 }
 142
 143 static bool getSymTab(Value *V, ValueSymbolTable *&ST) {
 144   ST = 0;
 145   if (Instruction *I = dyn_cast<Instruction>(V)) {
 146     if (BasicBlock *P = I->getParent())
 147       if (Function *PP = P->getParent())
 148         ST = &PP->getValueSymbolTable();
 149   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
 150     if (Function *P = BB->getParent())
 151       ST = &P->getValueSymbolTable();
 152   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 153     if (Module *P = GV->getParent())
 154       ST = &P->getValueSymbolTable();
 155   } else if (Argument *A = dyn_cast<Argument>(V)) {
 156     if (Function *P = A->getParent())
 157       ST = &P->getValueSymbolTable();
 158   } else if (isa<MDString>(V))
 159     return true;
 160   else {
 161     assert(isa<Constant>(V) && "Unknown value type!");
 162     return true;  // no name is setable for this.
 163   }
 164   return false;
 165 }
 166
 167 StringRef Value::getName() const {
 168   // Make sure the empty string is still a C string. For historical reasons,
 169   // some clients want to call .data() on the result and expect it to be null
 170   // terminated.
 171   if (!Name) return StringRef("", 0);
 172   return Name->getKey();
 173 }
 174
 175 void Value::setName(const Twine &NewName) {
 176   assert(SubclassID != MDStringVal &&
 177          "Cannot set the name of MDString with this method!");
 178
 179   // Fast path for common IRBuilder case of setName("") when there is no name.
 180   if (NewName.isTriviallyEmpty() && !hasName())
 181     return;
 182
 183   SmallString<256> NameData;
 184   StringRef NameRef = NewName.toStringRef(NameData);
 185
 186   // Name isn't changing?
 187   if (getName() == NameRef)
 188     return;
 189
 190   assert(!getType()->isVoidTy() && "Cannot assign a name to void values!");
 191
 192   // Get the symbol table to update for this object.
 193   ValueSymbolTable *ST;
 194   if (getSymTab(this, ST))
 195     return;  // Cannot set a name on this value (e.g. constant).
 196
 197   if (Function *F = dyn_cast<Function>(this))
 198     getContext().pImpl->IntrinsicIDCache.erase(F);
 199
 200   if (!ST) { // No symbol table to update?  Just do the change.
 201     if (NameRef.empty()) {
 202       // Free the name for this value.
 203       Name->Destroy();
 204       Name = 0;
 205       return;
 206     }
 207
 208     if (Name)
 209       Name->Destroy();
 210
 211     // NOTE: Could optimize for the case the name is shrinking to not deallocate
 212     // then reallocated.
 213
 214     // Create the new name.
 215     Name = ValueName::Create(NameRef.begin(), NameRef.end());
 216     Name->setValue(this);
 217     return;
 218   }
 219
 220   // NOTE: Could optimize for the case the name is shrinking to not deallocate
 221   // then reallocated.
 222   if (hasName()) {
 223     // Remove old name.
 224     ST->removeValueName(Name);
 225     Name->Destroy();
 226     Name = 0;
 227
 228     if (NameRef.empty())
 229       return;
 230   }
 231
 232   // Name is changing to something new.
 233   Name = ST->createValueName(NameRef, this);
 234 }
 235
 236
 237 /// takeName - transfer the name from V to this value, setting V's name to
 238 /// empty.  It is an error to call V->takeName(V).
 239 void Value::takeName(Value *V) {
 240   assert(SubclassID != MDStringVal && "Cannot take the name of an MDString!");
 241
 242   ValueSymbolTable *ST = 0;
 243   // If this value has a name, drop it.
 244   if (hasName()) {
 245     // Get the symtab this is in.
 246     if (getSymTab(this, ST)) {
 247       // We can't set a name on this value, but we need to clear V's name if
 248       // it has one.
 249       if (V->hasName()) V->setName("");
 250       return;  // Cannot set a name on this value (e.g. constant).
 251     }
 252
 253     // Remove old name.
 254     if (ST)
 255       ST->removeValueName(Name);
 256     Name->Destroy();
 257     Name = 0;
 258   }
 259
 260   // Now we know that this has no name.
 261
 262   // If V has no name either, we're done.
 263   if (!V->hasName()) return;
 264
 265   // Get this's symtab if we didn't before.
 266   if (!ST) {
 267     if (getSymTab(this, ST)) {
 268       // Clear V's name.
 269       V->setName("");
 270       return;  // Cannot set a name on this value (e.g. constant).
 271     }
 272   }
 273
 274   // Get V's ST, this should always succed, because V has a name.
 275   ValueSymbolTable *VST;
 276   bool Failure = getSymTab(V, VST);
 277   assert(!Failure && "V has a name, so it should have a ST!"); (void)Failure;
 278
 279   // If these values are both in the same symtab, we can do this very fast.
 280   // This works even if both values have no symtab yet.
 281   if (ST == VST) {
 282     // Take the name!
 283     Name = V->Name;
 284     V->Name = 0;
 285     Name->setValue(this);
 286     return;
 287   }
 288
 289   // Otherwise, things are slightly more complex.  Remove V's name from VST and
 290   // then reinsert it into ST.
 291
 292   if (VST)
 293     VST->removeValueName(V->Name);
 294   Name = V->Name;
 295   V->Name = 0;
 296   Name->setValue(this);
 297
 298   if (ST)
 299     ST->reinsertValue(this);
 300 }
 301
 302
 303 void Value::replaceAllUsesWith(Value *New) {
 304   assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
 305   assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
 306   assert(New->getType() == getType() &&
 307          "replaceAllUses of value with new value of different type!");
 308
 309   // Notify all ValueHandles (if present) that this value is going away.
 310   if (HasValueHandle)
 311     ValueHandleBase::ValueIsRAUWd(this, New);
 312
 313   while (!use_empty()) {
 314     Use &U = *UseList;
 315     // Must handle Constants specially, we cannot call replaceUsesOfWith on a
 316     // constant because they are uniqued.
 317     if (Constant *C = dyn_cast<Constant>(U.getUser())) {
 318       if (!isa<GlobalValue>(C)) {
 319         C->replaceUsesOfWithOnConstant(this, New, &U);
 320         continue;
 321       }
 322     }
 323
 324     U.set(New);
 325   }
 326
 327   if (BasicBlock *BB = dyn_cast<BasicBlock>(this))
 328     BB->replaceSuccessorsPhiUsesWith(cast<BasicBlock>(New));
 329 }
 330
 331 namespace {
 332 // Various metrics for how much to strip off of pointers.
 333 enum PointerStripKind {
 334   PSK_ZeroIndices,
 335   PSK_ZeroIndicesAndAliases,
 336   PSK_InBoundsConstantIndices,
 337   PSK_InBounds
 338 };
 339
 340 template <PointerStripKind StripKind>
 341 static Value *stripPointerCastsAndOffsets(Value *V) {
 342   if (!V->getType()->isPointerTy())
 343     return V;
 344
 345   // Even though we don't look through PHI nodes, we could be called on an
 346   // instruction in an unreachable block, which may be on a cycle.
 347   SmallPtrSet<Value *, 4> Visited;
 348
 349   Visited.insert(V);
 350   do {
 351     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 352       switch (StripKind) {
 353       case PSK_ZeroIndicesAndAliases:
 354       case PSK_ZeroIndices:
 355         if (!GEP->hasAllZeroIndices())
 356           return V;
 357         break;
 358       case PSK_InBoundsConstantIndices:
 359         if (!GEP->hasAllConstantIndices())
 360           return V;
 361         // fallthrough
 362       case PSK_InBounds:
 363         if (!GEP->isInBounds())
 364           return V;
 365         break;
 366       }
 367       V = GEP->getPointerOperand();
 368     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 369       V = cast<Operator>(V)->getOperand(0);
 370     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
 371       if (StripKind == PSK_ZeroIndices || GA->mayBeOverridden())
 372         return V;
 373       V = GA->getAliasee();
 374     } else {
 375       return V;
 376     }
 377     assert(V->getType()->isPointerTy() && "Unexpected operand type!");
 378   } while (Visited.insert(V));
 379
 380   return V;
 381 }
 382 } // namespace
 383
 384 Value *Value::stripPointerCasts() {
 385   return stripPointerCastsAndOffsets<PSK_ZeroIndicesAndAliases>(this);
 386 }
 387
 388 Value *Value::stripPointerCastsNoFollowAliases() {
 389   return stripPointerCastsAndOffsets<PSK_ZeroIndices>(this);
 390 }
 391
 392 Value *Value::stripInBoundsConstantOffsets() {
 393   return stripPointerCastsAndOffsets<PSK_InBoundsConstantIndices>(this);
 394 }
 395
 396 Value *Value::stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL,
 397                                                         APInt &Offset) {
 398   if (!getType()->isPointerTy())
 399     return this;
 400
 401   assert(Offset.getBitWidth() == DL.getPointerSizeInBits(cast<PointerType>(
 402                                      getType())->getAddressSpace()) &&
 403          "The offset must have exactly as many bits as our pointer.");
 404
 405   // Even though we don't look through PHI nodes, we could be called on an
 406   // instruction in an unreachable block, which may be on a cycle.
 407   SmallPtrSet<Value *, 4> Visited;
 408   Visited.insert(this);
 409   Value *V = this;
 410   do {
 411     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 412       if (!GEP->isInBounds())
 413         return V;
 414       if (!GEP->accumulateConstantOffset(DL, Offset))
 415         return V;
 416       V = GEP->getPointerOperand();
 417     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 418       V = cast<Operator>(V)->getOperand(0);
 419     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
 420       V = GA->getAliasee();
 421     } else {
 422       return V;
 423     }
 424     assert(V->getType()->isPointerTy() && "Unexpected operand type!");
 425   } while (Visited.insert(V));
 426
 427   return V;
 428 }
 429
 430 Value *Value::stripInBoundsOffsets() {
 431   return stripPointerCastsAndOffsets<PSK_InBounds>(this);
 432 }
 433
 434 /// isDereferenceablePointer - Test if this value is always a pointer to
 435 /// allocated and suitably aligned memory for a simple load or store.
 436 static bool isDereferenceablePointer(const Value *V,
 437                                      SmallPtrSet<const Value *, 32> &Visited) {
 438   // Note that it is not safe to speculate into a malloc'd region because
 439   // malloc may return null.
 440   // It's also not always safe to follow a bitcast, for example:
 441   //   bitcast i8* (alloca i8) to i32*
 442   // would result in a 4-byte load from a 1-byte alloca. Some cases could
 443   // be handled using DataLayout to check sizes and alignments though.
 444
 445   // These are obviously ok.
 446   if (isa<AllocaInst>(V)) return true;
 447
 448   // Global variables which can't collapse to null are ok.
 449   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
 450     return !GV->hasExternalWeakLinkage();
 451
 452   // byval arguments are ok.
 453   if (const Argument *A = dyn_cast<Argument>(V))
 454     return A->hasByValAttr();
 455
 456   // For GEPs, determine if the indexing lands within the allocated object.
 457   if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 458     // Conservatively require that the base pointer be fully dereferenceable.
 459     if (!Visited.insert(GEP->getOperand(0)))
 460       return false;
 461     if (!isDereferenceablePointer(GEP->getOperand(0), Visited))
 462       return false;
 463     // Check the indices.
 464     gep_type_iterator GTI = gep_type_begin(GEP);
 465     for (User::const_op_iterator I = GEP->op_begin()+1,
 466          E = GEP->op_end(); I != E; ++I) {
 467       Value *Index = *I;
 468       Type *Ty = *GTI++;
 469       // Struct indices can't be out of bounds.
 470       if (isa<StructType>(Ty))
 471         continue;
 472       ConstantInt *CI = dyn_cast<ConstantInt>(Index);
 473       if (!CI)
 474         return false;
 475       // Zero is always ok.
 476       if (CI->isZero())
 477         continue;
 478       // Check to see that it's within the bounds of an array.
 479       ArrayType *ATy = dyn_cast<ArrayType>(Ty);
 480       if (!ATy)
 481         return false;
 482       if (CI->getValue().getActiveBits() > 64)
 483         return false;
 484       if (CI->getZExtValue() >= ATy->getNumElements())
 485         return false;
 486     }
 487     // Indices check out; this is dereferenceable.
 488     return true;
 489   }
 490
 491   // If we don't know, assume the worst.
 492   return false;
 493 }
 494
 495 /// isDereferenceablePointer - Test if this value is always a pointer to
 496 /// allocated and suitably aligned memory for a simple load or store.
 497 bool Value::isDereferenceablePointer() const {
 498   SmallPtrSet<const Value *, 32> Visited;
 499   return ::isDereferenceablePointer(this, Visited);
 500 }
 501
 502 /// DoPHITranslation - If this value is a PHI node with CurBB as its parent,
 503 /// return the value in the PHI node corresponding to PredBB.  If not, return
 504 /// ourself.  This is useful if you want to know the value something has in a
 505 /// predecessor block.
 506 Value *Value::DoPHITranslation(const BasicBlock *CurBB,
 507                                const BasicBlock *PredBB) {
 508   PHINode *PN = dyn_cast<PHINode>(this);
 509   if (PN && PN->getParent() == CurBB)
 510     return PN->getIncomingValueForBlock(PredBB);
 511   return this;
 512 }
 513
 514 LLVMContext &Value::getContext() const { return VTy->getContext(); }
 515
 516 //===----------------------------------------------------------------------===//
 517 //                             ValueHandleBase Class
 518 //===----------------------------------------------------------------------===//
 519
 520 /// AddToExistingUseList - Add this ValueHandle to the use list for VP, where
 521 /// List is known to point into the existing use list.
 522 void ValueHandleBase::AddToExistingUseList(ValueHandleBase **List) {
 523   assert(List && "Handle list is null?");
 524
 525   // Splice ourselves into the list.
 526   Next = *List;
 527   *List = this;
 528   setPrevPtr(List);
 529   if (Next) {
 530     Next->setPrevPtr(&Next);
 531     assert(VP.getPointer() == Next->VP.getPointer() && "Added to wrong list?");
 532   }
 533 }
 534
 535 void ValueHandleBase::AddToExistingUseListAfter(ValueHandleBase *List) {
 536   assert(List && "Must insert after existing node");
 537
 538   Next = List->Next;
 539   setPrevPtr(&List->Next);
 540   List->Next = this;
 541   if (Next)
 542     Next->setPrevPtr(&Next);
 543 }
 544
 545 /// AddToUseList - Add this ValueHandle to the use list for VP.
 546 void ValueHandleBase::AddToUseList() {
 547   assert(VP.getPointer() && "Null pointer doesn't have a use list!");
 548
 549   LLVMContextImpl *pImpl = VP.getPointer()->getContext().pImpl;
 550
 551   if (VP.getPointer()->HasValueHandle) {
 552     // If this value already has a ValueHandle, then it must be in the
 553     // ValueHandles map already.
 554     ValueHandleBase *&Entry = pImpl->ValueHandles[VP.getPointer()];
 555     assert(Entry != 0 && "Value doesn't have any handles?");
 556     AddToExistingUseList(&Entry);
 557     return;
 558   }
 559
 560   // Ok, it doesn't have any handles yet, so we must insert it into the
 561   // DenseMap.  However, doing this insertion could cause the DenseMap to
 562   // reallocate itself, which would invalidate all of the PrevP pointers that
 563   // point into the old table.  Handle this by checking for reallocation and
 564   // updating the stale pointers only if needed.
 565   DenseMap<Value*, ValueHandleBase*> &Handles = pImpl->ValueHandles;
 566   const void *OldBucketPtr = Handles.getPointerIntoBucketsArray();
 567
 568   ValueHandleBase *&Entry = Handles[VP.getPointer()];
 569   assert(Entry == 0 && "Value really did already have handles?");
 570   AddToExistingUseList(&Entry);
 571   VP.getPointer()->HasValueHandle = true;
 572
 573   // If reallocation didn't happen or if this was the first insertion, don't
 574   // walk the table.
 575   if (Handles.isPointerIntoBucketsArray(OldBucketPtr) ||
 576       Handles.size() == 1) {
 577     return;
 578   }
 579
 580   // Okay, reallocation did happen.  Fix the Prev Pointers.
 581   for (DenseMap<Value*, ValueHandleBase*>::iterator I = Handles.begin(),
 582        E = Handles.end(); I != E; ++I) {
 583     assert(I->second && I->first == I->second->VP.getPointer() &&
 584            "List invariant broken!");
 585     I->second->setPrevPtr(&I->second);
 586   }
 587 }
 588
 589 /// RemoveFromUseList - Remove this ValueHandle from its current use list.
 590 void ValueHandleBase::RemoveFromUseList() {
 591   assert(VP.getPointer() && VP.getPointer()->HasValueHandle &&
 592          "Pointer doesn't have a use list!");
 593
 594   // Unlink this from its use list.
 595   ValueHandleBase **PrevPtr = getPrevPtr();
 596   assert(*PrevPtr == this && "List invariant broken");
 597
 598   *PrevPtr = Next;
 599   if (Next) {
 600     assert(Next->getPrevPtr() == &Next && "List invariant broken");
 601     Next->setPrevPtr(PrevPtr);
 602     return;
 603   }
 604
 605   // If the Next pointer was null, then it is possible that this was the last
 606   // ValueHandle watching VP.  If so, delete its entry from the ValueHandles
 607   // map.
 608   LLVMContextImpl *pImpl = VP.getPointer()->getContext().pImpl;
 609   DenseMap<Value*, ValueHandleBase*> &Handles = pImpl->ValueHandles;
 610   if (Handles.isPointerIntoBucketsArray(PrevPtr)) {
 611     Handles.erase(VP.getPointer());
 612     VP.getPointer()->HasValueHandle = false;
 613   }
 614 }
 615
 616
 617 void ValueHandleBase::ValueIsDeleted(Value *V) {
 618   assert(V->HasValueHandle && "Should only be called if ValueHandles present");
 619
 620   // Get the linked list base, which is guaranteed to exist since the
 621   // HasValueHandle flag is set.
 622   LLVMContextImpl *pImpl = V->getContext().pImpl;
 623   ValueHandleBase *Entry = pImpl->ValueHandles[V];
 624   assert(Entry && "Value bit set but no entries exist");
 625
 626   // We use a local ValueHandleBase as an iterator so that ValueHandles can add
 627   // and remove themselves from the list without breaking our iteration.  This
 628   // is not really an AssertingVH; we just have to give ValueHandleBase a kind.
 629   // Note that we deliberately do not the support the case when dropping a value
 630   // handle results in a new value handle being permanently added to the list
 631   // (as might occur in theory for CallbackVH's): the new value handle will not
 632   // be processed and the checking code will mete out righteous punishment if
 633   // the handle is still present once we have finished processing all the other
 634   // value handles (it is fine to momentarily add then remove a value handle).
 635   for (ValueHandleBase Iterator(Assert, *Entry); Entry; Entry = Iterator.Next) {
 636     Iterator.RemoveFromUseList();
 637     Iterator.AddToExistingUseListAfter(Entry);
 638     assert(Entry->Next == &Iterator && "Loop invariant broken.");
 639
 640     switch (Entry->getKind()) {
 641     case Assert:
 642       break;
 643     case Tracking:
 644       // Mark that this value has been deleted by setting it to an invalid Value
 645       // pointer.
 646       Entry->operator=(DenseMapInfo<Value *>::getTombstoneKey());
 647       break;
 648     case Weak:
 649       // Weak just goes to null, which will unlink it from the list.
 650       Entry->operator=(0);
 651       break;
 652     case Callback:
 653       // Forward to the subclass's implementation.
 654       static_cast<CallbackVH*>(Entry)->deleted();
 655       break;
 656     }
 657   }
 658
 659   // All callbacks, weak references, and assertingVHs should be dropped by now.
 660   if (V->HasValueHandle) {
 661 #ifndef NDEBUG      // Only in +Asserts mode...
 662     dbgs() << "While deleting: " << *V->getType() << " %" << V->getName()
 663            << "\n";
 664     if (pImpl->ValueHandles[V]->getKind() == Assert)
 665       llvm_unreachable("An asserting value handle still pointed to this"
 666                        " value!");
 667
 668 #endif
 669     llvm_unreachable("All references to V were not removed?");
 670   }
 671 }
 672
 673
 674 void ValueHandleBase::ValueIsRAUWd(Value *Old, Value *New) {
 675   assert(Old->HasValueHandle &&"Should only be called if ValueHandles present");
 676   assert(Old != New && "Changing value into itself!");
 677
 678   // Get the linked list base, which is guaranteed to exist since the
 679   // HasValueHandle flag is set.
 680   LLVMContextImpl *pImpl = Old->getContext().pImpl;
 681   ValueHandleBase *Entry = pImpl->ValueHandles[Old];
 682
 683   assert(Entry && "Value bit set but no entries exist");
 684
 685   // We use a local ValueHandleBase as an iterator so that
 686   // ValueHandles can add and remove themselves from the list without
 687   // breaking our iteration.  This is not really an AssertingVH; we
 688   // just have to give ValueHandleBase some kind.
 689   for (ValueHandleBase Iterator(Assert, *Entry); Entry; Entry = Iterator.Next) {
 690     Iterator.RemoveFromUseList();
 691     Iterator.AddToExistingUseListAfter(Entry);
 692     assert(Entry->Next == &Iterator && "Loop invariant broken.");
 693
 694     switch (Entry->getKind()) {
 695     case Assert:
 696       // Asserting handle does not follow RAUW implicitly.
 697       break;
 698     case Tracking:
 699       // Tracking goes to new value like a WeakVH. Note that this may make it
 700       // something incompatible with its templated type. We don't want to have a
 701       // virtual (or inline) interface to handle this though, so instead we make
 702       // the TrackingVH accessors guarantee that a client never sees this value.
 703
 704       // FALLTHROUGH
 705     case Weak:
 706       // Weak goes to the new value, which will unlink it from Old's list.
 707       Entry->operator=(New);
 708       break;
 709     case Callback:
 710       // Forward to the subclass's implementation.
 711       static_cast<CallbackVH*>(Entry)->allUsesReplacedWith(New);
 712       break;
 713     }
 714   }
 715
 716 #ifndef NDEBUG
 717   // If any new tracking or weak value handles were added while processing the
 718   // list, then complain about it now.
 719   if (Old->HasValueHandle)
 720     for (Entry = pImpl->ValueHandles[Old]; Entry; Entry = Entry->Next)
 721       switch (Entry->getKind()) {
 722       case Tracking:
 723       case Weak:
 724         dbgs() << "After RAUW from " << *Old->getType() << " %"
 725                << Old->getName() << " to " << *New->getType() << " %"
 726                << New->getName() << "\n";
 727         llvm_unreachable("A tracking or weak value handle still pointed to the"
 728                          " old value!\n");
 729       default:
 730         break;
 731       }
 732 #endif
 733 }
 734
 735 // Default implementation for CallbackVH.
 736 void CallbackVH::allUsesReplacedWith(Value *) {}
 737
 738 void CallbackVH::deleted() {
 739   setValPtr(NULL);
 740 }