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