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/Metadata.h"
  23 #include "llvm/ValueSymbolTable.h"
  24 #include "llvm/ADT/SmallString.h"
  25 #include "llvm/Support/Debug.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/Support/raw_ostream.h"
  31 #include "llvm/System/RWMutex.h"
  32 #include "llvm/System/Threading.h"
  33 #include "llvm/ADT/DenseMap.h"
  34 #include <algorithm>
  35 using namespace llvm;
  36
  37 //===----------------------------------------------------------------------===//
  38 //                                Value Class
  39 //===----------------------------------------------------------------------===//
  40
  41 static inline const Type *checkType(const Type *Ty) {
  42   assert(Ty && "Value defined with a null type: Error!");
  43   return Ty;
  44 }
  45
  46 Value::Value(const Type *ty, unsigned scid)
  47   : SubclassID(scid), HasValueHandle(0), SubclassOptionalData(0),
  48     SubclassData(0), VTy(checkType(ty)),
  49     UseList(0), Name(0) {
  50   if (isa<CallInst>(this) || isa<InvokeInst>(this))
  51     assert((VTy->isFirstClassType() ||
  52             VTy == Type::getVoidTy(ty->getContext()) ||
  53             isa<OpaqueType>(ty) || VTy->getTypeID() == Type::StructTyID) &&
  54            "invalid CallInst  type!");
  55   else if (!isa<Constant>(this) && !isa<BasicBlock>(this))
  56     assert((VTy->isFirstClassType() ||
  57             VTy == Type::getVoidTy(ty->getContext()) ||
  58            isa<OpaqueType>(ty)) &&
  59            "Cannot create non-first-class values except for constants!");
  60 }
  61
  62 Value::~Value() {
  63   // Notify all ValueHandles (if present) that this value is going away.
  64   if (HasValueHandle)
  65     ValueHandleBase::ValueIsDeleted(this);
  66
  67 #ifndef NDEBUG      // Only in -g mode...
  68   // Check to make sure that there are no uses of this value that are still
  69   // around when the value is destroyed.  If there are, then we have a dangling
  70   // reference and something is wrong.  This code is here to print out what is
  71   // still being referenced.  The value in question should be printed as
  72   // a <badref>
  73   //
  74   if (!use_empty()) {
  75     errs() << "While deleting: " << *VTy << " %" << getNameStr() << "\n";
  76     for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
  77       errs() << "Use still stuck around after Def is destroyed:"
  78            << **I << "\n";
  79   }
  80 #endif
  81   assert(use_empty() && "Uses remain when a value is destroyed!");
  82
  83   // If this value is named, destroy the name.  This should not be in a symtab
  84   // at this point.
  85   if (Name)
  86     Name->Destroy();
  87
  88   // There should be no uses of this object anymore, remove it.
  89   LeakDetector::removeGarbageObject(this);
  90 }
  91
  92 /// hasNUses - Return true if this Value has exactly N users.
  93 ///
  94 bool Value::hasNUses(unsigned N) const {
  95   use_const_iterator UI = use_begin(), E = use_end();
  96
  97   for (; N; --N, ++UI)
  98     if (UI == E) return false;  // Too few.
  99   return UI == E;
 100 }
 101
 102 /// hasNUsesOrMore - Return true if this value has N users or more.  This is
 103 /// logically equivalent to getNumUses() >= N.
 104 ///
 105 bool Value::hasNUsesOrMore(unsigned N) const {
 106   use_const_iterator UI = use_begin(), E = use_end();
 107
 108   for (; N; --N, ++UI)
 109     if (UI == E) return false;  // Too few.
 110
 111   return true;
 112 }
 113
 114 /// isUsedInBasicBlock - Return true if this value is used in the specified
 115 /// basic block.
 116 bool Value::isUsedInBasicBlock(const BasicBlock *BB) const {
 117   for (use_const_iterator I = use_begin(), E = use_end(); I != E; ++I) {
 118     const Instruction *User = dyn_cast<Instruction>(*I);
 119     if (User && User->getParent() == BB)
 120       return true;
 121   }
 122   return false;
 123 }
 124
 125
 126 /// getNumUses - This method computes the number of uses of this Value.  This
 127 /// is a linear time operation.  Use hasOneUse or hasNUses to check for specific
 128 /// values.
 129 unsigned Value::getNumUses() const {
 130   return (unsigned)std::distance(use_begin(), use_end());
 131 }
 132
 133 static bool getSymTab(Value *V, ValueSymbolTable *&ST) {
 134   ST = 0;
 135   if (Instruction *I = dyn_cast<Instruction>(V)) {
 136     if (BasicBlock *P = I->getParent())
 137       if (Function *PP = P->getParent())
 138         ST = &PP->getValueSymbolTable();
 139   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
 140     if (Function *P = BB->getParent())
 141       ST = &P->getValueSymbolTable();
 142   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 143     if (Module *P = GV->getParent())
 144       ST = &P->getValueSymbolTable();
 145   } else if (Argument *A = dyn_cast<Argument>(V)) {
 146     if (Function *P = A->getParent())
 147       ST = &P->getValueSymbolTable();
 148   } else if (NamedMDNode *N = dyn_cast<NamedMDNode>(V)) {
 149     if (Module *P = N->getParent()) {
 150       ST = &P->getValueSymbolTable();
 151     }
 152   } else if (isa<MDString>(V))
 153     return true;
 154   else {
 155     assert(isa<Constant>(V) && "Unknown value type!");
 156     return true;  // no name is setable for this.
 157   }
 158   return false;
 159 }
 160
 161 StringRef Value::getName() const {
 162   // Make sure the empty string is still a C string. For historical reasons,
 163   // some clients want to call .data() on the result and expect it to be null
 164   // terminated.
 165   if (!Name) return StringRef("", 0);
 166   return Name->getKey();
 167 }
 168
 169 std::string Value::getNameStr() const {
 170   return getName().str();
 171 }
 172
 173 void Value::setName(const Twine &NewName) {
 174   SmallString<32> NameData;
 175   NewName.toVector(NameData);
 176
 177   const char *NameStr = NameData.data();
 178   unsigned NameLen = NameData.size();
 179
 180   // Name isn't changing?
 181   if (getName() == StringRef(NameStr, NameLen))
 182     return;
 183
 184   assert(getType() != Type::getVoidTy(getContext()) &&
 185          "Cannot assign a name to void values!");
 186
 187   // Get the symbol table to update for this object.
 188   ValueSymbolTable *ST;
 189   if (getSymTab(this, ST))
 190     return;  // Cannot set a name on this value (e.g. constant).
 191
 192   if (!ST) { // No symbol table to update?  Just do the change.
 193     if (NameLen == 0) {
 194       // Free the name for this value.
 195       Name->Destroy();
 196       Name = 0;
 197       return;
 198     }
 199
 200     if (Name)
 201       Name->Destroy();
 202
 203     // NOTE: Could optimize for the case the name is shrinking to not deallocate
 204     // then reallocated.
 205
 206     // Create the new name.
 207     Name = ValueName::Create(NameStr, NameStr+NameLen);
 208     Name->setValue(this);
 209     return;
 210   }
 211
 212   // NOTE: Could optimize for the case the name is shrinking to not deallocate
 213   // then reallocated.
 214   if (hasName()) {
 215     // Remove old name.
 216     ST->removeValueName(Name);
 217     Name->Destroy();
 218     Name = 0;
 219
 220     if (NameLen == 0)
 221       return;
 222   }
 223
 224   // Name is changing to something new.
 225   Name = ST->createValueName(StringRef(NameStr, NameLen), this);
 226 }
 227
 228
 229 /// takeName - transfer the name from V to this value, setting V's name to
 230 /// empty.  It is an error to call V->takeName(V).
 231 void Value::takeName(Value *V) {
 232   ValueSymbolTable *ST = 0;
 233   // If this value has a name, drop it.
 234   if (hasName()) {
 235     // Get the symtab this is in.
 236     if (getSymTab(this, ST)) {
 237       // We can't set a name on this value, but we need to clear V's name if
 238       // it has one.
 239       if (V->hasName()) V->setName("");
 240       return;  // Cannot set a name on this value (e.g. constant).
 241     }
 242
 243     // Remove old name.
 244     if (ST)
 245       ST->removeValueName(Name);
 246     Name->Destroy();
 247     Name = 0;
 248   }
 249
 250   // Now we know that this has no name.
 251
 252   // If V has no name either, we're done.
 253   if (!V->hasName()) return;
 254
 255   // Get this's symtab if we didn't before.
 256   if (!ST) {
 257     if (getSymTab(this, ST)) {
 258       // Clear V's name.
 259       V->setName("");
 260       return;  // Cannot set a name on this value (e.g. constant).
 261     }
 262   }
 263
 264   // Get V's ST, this should always succed, because V has a name.
 265   ValueSymbolTable *VST;
 266   bool Failure = getSymTab(V, VST);
 267   assert(!Failure && "V has a name, so it should have a ST!"); Failure=Failure;
 268
 269   // If these values are both in the same symtab, we can do this very fast.
 270   // This works even if both values have no symtab yet.
 271   if (ST == VST) {
 272     // Take the name!
 273     Name = V->Name;
 274     V->Name = 0;
 275     Name->setValue(this);
 276     return;
 277   }
 278
 279   // Otherwise, things are slightly more complex.  Remove V's name from VST and
 280   // then reinsert it into ST.
 281
 282   if (VST)
 283     VST->removeValueName(V->Name);
 284   Name = V->Name;
 285   V->Name = 0;
 286   Name->setValue(this);
 287
 288   if (ST)
 289     ST->reinsertValue(this);
 290 }
 291
 292
 293 // uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
 294 // except that it doesn't have all of the asserts.  The asserts fail because we
 295 // are half-way done resolving types, which causes some types to exist as two
 296 // different Type*'s at the same time.  This is a sledgehammer to work around
 297 // this problem.
 298 //
 299 void Value::uncheckedReplaceAllUsesWith(Value *New) {
 300   // Notify all ValueHandles (if present) that this value is going away.
 301   if (HasValueHandle)
 302     ValueHandleBase::ValueIsRAUWd(this, New);
 303
 304   while (!use_empty()) {
 305     Use &U = *UseList;
 306     // Must handle Constants specially, we cannot call replaceUsesOfWith on a
 307     // constant because they are uniqued.
 308     if (Constant *C = dyn_cast<Constant>(U.getUser())) {
 309       if (!isa<GlobalValue>(C)) {
 310         C->replaceUsesOfWithOnConstant(this, New, &U);
 311         continue;
 312       }
 313     }
 314
 315     U.set(New);
 316   }
 317 }
 318
 319 void Value::replaceAllUsesWith(Value *New) {
 320   assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
 321   assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
 322   assert(New->getType() == getType() &&
 323          "replaceAllUses of value with new value of different type!");
 324
 325   uncheckedReplaceAllUsesWith(New);
 326 }
 327
 328 Value *Value::stripPointerCasts() {
 329   if (!isa<PointerType>(getType()))
 330     return this;
 331   Value *V = this;
 332   do {
 333     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 334       if (!GEP->hasAllZeroIndices())
 335         return V;
 336       V = GEP->getPointerOperand();
 337     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 338       V = cast<Operator>(V)->getOperand(0);
 339     } else {
 340       return V;
 341     }
 342     assert(isa<PointerType>(V->getType()) && "Unexpected operand type!");
 343   } while (1);
 344 }
 345
 346 Value *Value::getUnderlyingObject() {
 347   if (!isa<PointerType>(getType()))
 348     return this;
 349   Value *V = this;
 350   unsigned MaxLookup = 6;
 351   do {
 352     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 353       V = GEP->getPointerOperand();
 354     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 355       V = cast<Operator>(V)->getOperand(0);
 356     } else {
 357       return V;
 358     }
 359     assert(isa<PointerType>(V->getType()) && "Unexpected operand type!");
 360   } while (--MaxLookup);
 361   return V;
 362 }
 363
 364 /// DoPHITranslation - If this value is a PHI node with CurBB as its parent,
 365 /// return the value in the PHI node corresponding to PredBB.  If not, return
 366 /// ourself.  This is useful if you want to know the value something has in a
 367 /// predecessor block.
 368 Value *Value::DoPHITranslation(const BasicBlock *CurBB,
 369                                const BasicBlock *PredBB) {
 370   PHINode *PN = dyn_cast<PHINode>(this);
 371   if (PN && PN->getParent() == CurBB)
 372     return PN->getIncomingValueForBlock(PredBB);
 373   return this;
 374 }
 375
 376 LLVMContext &Value::getContext() const { return VTy->getContext(); }
 377
 378 //===----------------------------------------------------------------------===//
 379 //                             ValueHandleBase Class
 380 //===----------------------------------------------------------------------===//
 381
 382 /// AddToExistingUseList - Add this ValueHandle to the use list for VP, where
 383 /// List is known to point into the existing use list.
 384 void ValueHandleBase::AddToExistingUseList(ValueHandleBase **List) {
 385   assert(List && "Handle list is null?");
 386
 387   // Splice ourselves into the list.
 388   Next = *List;
 389   *List = this;
 390   setPrevPtr(List);
 391   if (Next) {
 392     Next->setPrevPtr(&Next);
 393     assert(VP == Next->VP && "Added to wrong list?");
 394   }
 395 }
 396
 397 /// AddToUseList - Add this ValueHandle to the use list for VP.
 398 void ValueHandleBase::AddToUseList() {
 399   assert(VP && "Null pointer doesn't have a use list!");
 400
 401   LLVMContextImpl *pImpl = VP->getContext().pImpl;
 402
 403   if (VP->HasValueHandle) {
 404     // If this value already has a ValueHandle, then it must be in the
 405     // ValueHandles map already.
 406     ValueHandleBase *&Entry = pImpl->ValueHandles[VP];
 407     assert(Entry != 0 && "Value doesn't have any handles?");
 408     AddToExistingUseList(&Entry);
 409     return;
 410   }
 411
 412   // Ok, it doesn't have any handles yet, so we must insert it into the
 413   // DenseMap.  However, doing this insertion could cause the DenseMap to
 414   // reallocate itself, which would invalidate all of the PrevP pointers that
 415   // point into the old table.  Handle this by checking for reallocation and
 416   // updating the stale pointers only if needed.
 417   DenseMap<Value*, ValueHandleBase*> &Handles = pImpl->ValueHandles;
 418   const void *OldBucketPtr = Handles.getPointerIntoBucketsArray();
 419
 420   ValueHandleBase *&Entry = Handles[VP];
 421   assert(Entry == 0 && "Value really did already have handles?");
 422   AddToExistingUseList(&Entry);
 423   VP->HasValueHandle = true;
 424
 425   // If reallocation didn't happen or if this was the first insertion, don't
 426   // walk the table.
 427   if (Handles.isPointerIntoBucketsArray(OldBucketPtr) ||
 428       Handles.size() == 1) {
 429     return;
 430   }
 431
 432   // Okay, reallocation did happen.  Fix the Prev Pointers.
 433   for (DenseMap<Value*, ValueHandleBase*>::iterator I = Handles.begin(),
 434        E = Handles.end(); I != E; ++I) {
 435     assert(I->second && I->first == I->second->VP && "List invariant broken!");
 436     I->second->setPrevPtr(&I->second);
 437   }
 438 }
 439
 440 /// RemoveFromUseList - Remove this ValueHandle from its current use list.
 441 void ValueHandleBase::RemoveFromUseList() {
 442   assert(VP && VP->HasValueHandle && "Pointer doesn't have a use list!");
 443
 444   // Unlink this from its use list.
 445   ValueHandleBase **PrevPtr = getPrevPtr();
 446   assert(*PrevPtr == this && "List invariant broken");
 447
 448   *PrevPtr = Next;
 449   if (Next) {
 450     assert(Next->getPrevPtr() == &Next && "List invariant broken");
 451     Next->setPrevPtr(PrevPtr);
 452     return;
 453   }
 454
 455   // If the Next pointer was null, then it is possible that this was the last
 456   // ValueHandle watching VP.  If so, delete its entry from the ValueHandles
 457   // map.
 458   LLVMContextImpl *pImpl = VP->getContext().pImpl;
 459   DenseMap<Value*, ValueHandleBase*> &Handles = pImpl->ValueHandles;
 460   if (Handles.isPointerIntoBucketsArray(PrevPtr)) {
 461     Handles.erase(VP);
 462     VP->HasValueHandle = false;
 463   }
 464 }
 465
 466
 467 void ValueHandleBase::ValueIsDeleted(Value *V) {
 468   assert(V->HasValueHandle && "Should only be called if ValueHandles present");
 469
 470   // Get the linked list base, which is guaranteed to exist since the
 471   // HasValueHandle flag is set.
 472   LLVMContextImpl *pImpl = V->getContext().pImpl;
 473   ValueHandleBase *Entry = pImpl->ValueHandles[V];
 474   assert(Entry && "Value bit set but no entries exist");
 475
 476   while (Entry) {
 477     // Advance pointer to avoid invalidation.
 478     ValueHandleBase *ThisNode = Entry;
 479     Entry = Entry->Next;
 480
 481     switch (ThisNode->getKind()) {
 482     case Assert:
 483 #ifndef NDEBUG      // Only in -g mode...
 484       errs() << "While deleting: " << *V->getType() << " %" << V->getNameStr()
 485              << "\n";
 486 #endif
 487       llvm_unreachable("An asserting value handle still pointed to this"
 488                        " value!");
 489     case Weak:
 490       // Weak just goes to null, which will unlink it from the list.
 491       ThisNode->operator=(0);
 492       break;
 493     case Callback:
 494       // Forward to the subclass's implementation.
 495       static_cast<CallbackVH*>(ThisNode)->deleted();
 496       break;
 497     }
 498   }
 499
 500   // All callbacks and weak references should be dropped by now.
 501   assert(!V->HasValueHandle && "All references to V were not removed?");
 502 }
 503
 504
 505 void ValueHandleBase::ValueIsRAUWd(Value *Old, Value *New) {
 506   assert(Old->HasValueHandle &&"Should only be called if ValueHandles present");
 507   assert(Old != New && "Changing value into itself!");
 508
 509   // Get the linked list base, which is guaranteed to exist since the
 510   // HasValueHandle flag is set.
 511   LLVMContextImpl *pImpl = Old->getContext().pImpl;
 512   ValueHandleBase *Entry = pImpl->ValueHandles[Old];
 513
 514   assert(Entry && "Value bit set but no entries exist");
 515
 516   while (Entry) {
 517     // Advance pointer to avoid invalidation.
 518     ValueHandleBase *ThisNode = Entry;
 519     Entry = Entry->Next;
 520
 521     switch (ThisNode->getKind()) {
 522     case Assert:
 523       // Asserting handle does not follow RAUW implicitly.
 524       break;
 525     case Weak:
 526       // Weak goes to the new value, which will unlink it from Old's list.
 527       ThisNode->operator=(New);
 528       break;
 529     case Callback:
 530       // Forward to the subclass's implementation.
 531       static_cast<CallbackVH*>(ThisNode)->allUsesReplacedWith(New);
 532       break;
 533     }
 534   }
 535 }
 536
 537 /// ~CallbackVH. Empty, but defined here to avoid emitting the vtable
 538 /// more than once.
 539 CallbackVH::~CallbackVH() {}
 540
 541
 542 //===----------------------------------------------------------------------===//
 543 //                                 User Class
 544 //===----------------------------------------------------------------------===//
 545
 546 // replaceUsesOfWith - Replaces all references to the "From" definition with
 547 // references to the "To" definition.
 548 //
 549 void User::replaceUsesOfWith(Value *From, Value *To) {
 550   if (From == To) return;   // Duh what?
 551
 552   assert((!isa<Constant>(this) || isa<GlobalValue>(this)) &&
 553          "Cannot call User::replaceUsesOfWith on a constant!");
 554
 555   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
 556     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
 557       // The side effects of this setOperand call include linking to
 558       // "To", adding "this" to the uses list of To, and
 559       // most importantly, removing "this" from the use list of "From".
 560       setOperand(i, To); // Fix it now...
 561     }
 562 }