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