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