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