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 "llvm/Constant.h"
  15 #include "llvm/Constants.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/InstrTypes.h"
  18 #include "llvm/Instructions.h"
  19 #include "llvm/Operator.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/Metadata.h"
  22 #include "llvm/ValueSymbolTable.h"
  23 #include "llvm/ADT/SmallString.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Support/ErrorHandling.h"
  26 #include "llvm/Support/LeakDetector.h"
  27 #include "llvm/Support/ManagedStatic.h"
  28 #include "llvm/Support/ValueHandle.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/System/RWMutex.h"
  31 #include "llvm/System/Threading.h"
  32 #include "llvm/ADT/DenseMap.h"
  33 #include <algorithm>
  34 using namespace llvm;
  35
  36 //===----------------------------------------------------------------------===//
  37 //                                Value Class
  38 //===----------------------------------------------------------------------===//
  39
  40 static inline const Type *checkType(const Type *Ty) {
  41   assert(Ty && "Value defined with a null type: Error!");
  42   return Ty;
  43 }
  44
  45 Value::Value(const Type *ty, unsigned scid)
  46   : SubclassID(scid), HasValueHandle(0), SubclassOptionalData(0),
  47     SubclassData(0), VTy(checkType(ty)),
  48     UseList(0), Name(0) {
  49   if (isa<CallInst>(this) || isa<InvokeInst>(this))
  50     assert((VTy->isFirstClassType() ||
  51             VTy == Type::getVoidTy(ty->getContext()) ||
  52             isa<OpaqueType>(ty) || VTy->getTypeID() == Type::StructTyID) &&
  53            "invalid CallInst  type!");
  54   else if (!isa<Constant>(this) && !isa<BasicBlock>(this))
  55     assert((VTy->isFirstClassType() ||
  56             VTy == Type::getVoidTy(ty->getContext()) ||
  57            isa<OpaqueType>(ty)) &&
  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     errs() << "While deleting: " << *VTy << " %" << getNameStr() << "\n";
  75     for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
  76       errs() << "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)
  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   use_const_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   use_const_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   for (use_const_iterator I = use_begin(), E = use_end(); I != E; ++I) {
 117     const Instruction *User = dyn_cast<Instruction>(*I);
 118     if (User && User->getParent() == BB)
 119       return true;
 120   }
 121   return false;
 122 }
 123
 124
 125 /// getNumUses - This method computes the number of uses of this Value.  This
 126 /// is a linear time operation.  Use hasOneUse or hasNUses to check for specific
 127 /// values.
 128 unsigned Value::getNumUses() const {
 129   return (unsigned)std::distance(use_begin(), use_end());
 130 }
 131
 132 static bool getSymTab(Value *V, ValueSymbolTable *&ST) {
 133   ST = 0;
 134   if (Instruction *I = dyn_cast<Instruction>(V)) {
 135     if (BasicBlock *P = I->getParent())
 136       if (Function *PP = P->getParent())
 137         ST = &PP->getValueSymbolTable();
 138   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
 139     if (Function *P = BB->getParent())
 140       ST = &P->getValueSymbolTable();
 141   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 142     if (Module *P = GV->getParent())
 143       ST = &P->getValueSymbolTable();
 144   } else if (Argument *A = dyn_cast<Argument>(V)) {
 145     if (Function *P = A->getParent())
 146       ST = &P->getValueSymbolTable();
 147   } else if (NamedMDNode *N = dyn_cast<NamedMDNode>(V)) {
 148     if (Module *P = N->getParent()) {
 149       ST = &P->getValueSymbolTable();
 150     }
 151   } else if (isa<MDString>(V))
 152     return true;
 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 StringRef Value::getName() const {
 161   // Make sure the empty string is still a C string. For historical reasons,
 162   // some clients want to call .data() on the result and expect it to be null
 163   // terminated.
 164   if (!Name) return StringRef("", 0);
 165   return Name->getKey();
 166 }
 167
 168 std::string Value::getNameStr() const {
 169   return getName().str();
 170 }
 171
 172 void Value::setName(const Twine &NewName) {
 173   SmallString<32> NameData;
 174   NewName.toVector(NameData);
 175
 176   const char *NameStr = NameData.data();
 177   unsigned NameLen = NameData.size();
 178
 179   // Name isn't changing?
 180   if (getName() == StringRef(NameStr, NameLen))
 181     return;
 182
 183   assert(getType() != Type::getVoidTy(getContext()) &&
 184          "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 (NameLen == 0) {
 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(NameStr, NameStr+NameLen);
 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 (NameLen == 0)
 220       return;
 221   }
 222
 223   // Name is changing to something new.
 224   Name = ST->createValueName(StringRef(NameStr, NameLen), 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!"); Failure=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 // uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
 293 // except that it doesn't have all of the asserts.  The asserts fail because we
 294 // are half-way done resolving types, which causes some types to exist as two
 295 // different Type*'s at the same time.  This is a sledgehammer to work around
 296 // this problem.
 297 //
 298 void Value::uncheckedReplaceAllUsesWith(Value *New) {
 299   // Notify all ValueHandles (if present) that this value is going away.
 300   if (HasValueHandle)
 301     ValueHandleBase::ValueIsRAUWd(this, New);
 302
 303   while (!use_empty()) {
 304     Use &U = *UseList;
 305     // Must handle Constants specially, we cannot call replaceUsesOfWith on a
 306     // constant because they are uniqued.
 307     if (Constant *C = dyn_cast<Constant>(U.getUser())) {
 308       if (!isa<GlobalValue>(C)) {
 309         C->replaceUsesOfWithOnConstant(this, New, &U);
 310         continue;
 311       }
 312     }
 313
 314     U.set(New);
 315   }
 316 }
 317
 318 void Value::replaceAllUsesWith(Value *New) {
 319   assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
 320   assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
 321   assert(New->getType() == getType() &&
 322          "replaceAllUses of value with new value of different type!");
 323
 324   uncheckedReplaceAllUsesWith(New);
 325 }
 326
 327 Value *Value::stripPointerCasts() {
 328   if (!isa<PointerType>(getType()))
 329     return this;
 330   Value *V = this;
 331   do {
 332     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 333       if (!GEP->hasAllZeroIndices())
 334         return V;
 335       V = GEP->getPointerOperand();
 336     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 337       V = cast<Operator>(V)->getOperand(0);
 338     } else {
 339       return V;
 340     }
 341     assert(isa<PointerType>(V->getType()) && "Unexpected operand type!");
 342   } while (1);
 343 }
 344
 345 Value *Value::getUnderlyingObject() {
 346   if (!isa<PointerType>(getType()))
 347     return this;
 348   Value *V = this;
 349   unsigned MaxLookup = 6;
 350   do {
 351     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 352       V = GEP->getPointerOperand();
 353     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 354       V = cast<Operator>(V)->getOperand(0);
 355     } else {
 356       return V;
 357     }
 358     assert(isa<PointerType>(V->getType()) && "Unexpected operand type!");
 359   } while (--MaxLookup);
 360   return V;
 361 }
 362
 363 /// DoPHITranslation - If this value is a PHI node with CurBB as its parent,
 364 /// return the value in the PHI node corresponding to PredBB.  If not, return
 365 /// ourself.  This is useful if you want to know the value something has in a
 366 /// predecessor block.
 367 Value *Value::DoPHITranslation(const BasicBlock *CurBB,
 368                                const BasicBlock *PredBB) {
 369   PHINode *PN = dyn_cast<PHINode>(this);
 370   if (PN && PN->getParent() == CurBB)
 371     return PN->getIncomingValueForBlock(PredBB);
 372   return this;
 373 }
 374
 375 LLVMContext &Value::getContext() const { return VTy->getContext(); }
 376
 377 //===----------------------------------------------------------------------===//
 378 //                             ValueHandleBase Class
 379 //===----------------------------------------------------------------------===//
 380
 381 /// ValueHandles - This map keeps track of all of the value handles that are
 382 /// watching a Value*.  The Value::HasValueHandle bit is used to know whether or
 383 /// not a value has an entry in this map.
 384 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
 385 static ManagedStatic<ValueHandlesTy> ValueHandles;
 386 static ManagedStatic<sys::SmartRWMutex<true> > ValueHandlesLock;
 387
 388 /// AddToExistingUseList - Add this ValueHandle to the use list for VP, where
 389 /// List is known to point into the existing use list.
 390 void ValueHandleBase::AddToExistingUseList(ValueHandleBase **List) {
 391   assert(List && "Handle list is null?");
 392
 393   // Splice ourselves into the list.
 394   Next = *List;
 395   *List = this;
 396   setPrevPtr(List);
 397   if (Next) {
 398     Next->setPrevPtr(&Next);
 399     assert(VP == Next->VP && "Added to wrong list?");
 400   }
 401 }
 402
 403 /// AddToUseList - Add this ValueHandle to the use list for VP.
 404 void ValueHandleBase::AddToUseList() {
 405   assert(VP && "Null pointer doesn't have a use list!");
 406   if (VP->HasValueHandle) {
 407     // If this value already has a ValueHandle, then it must be in the
 408     // ValueHandles map already.
 409     sys::SmartScopedReader<true> Reader(*ValueHandlesLock);
 410     ValueHandleBase *&Entry = (*ValueHandles)[VP];
 411     assert(Entry != 0 && "Value doesn't have any handles?");
 412     AddToExistingUseList(&Entry);
 413     return;
 414   }
 415
 416   // Ok, it doesn't have any handles yet, so we must insert it into the
 417   // DenseMap.  However, doing this insertion could cause the DenseMap to
 418   // reallocate itself, which would invalidate all of the PrevP pointers that
 419   // point into the old table.  Handle this by checking for reallocation and
 420   // updating the stale pointers only if needed.
 421   sys::SmartScopedWriter<true> Writer(*ValueHandlesLock);
 422   ValueHandlesTy &Handles = *ValueHandles;
 423   const void *OldBucketPtr = Handles.getPointerIntoBucketsArray();
 424
 425   ValueHandleBase *&Entry = Handles[VP];
 426   assert(Entry == 0 && "Value really did already have handles?");
 427   AddToExistingUseList(&Entry);
 428   VP->HasValueHandle = true;
 429
 430   // If reallocation didn't happen or if this was the first insertion, don't
 431   // walk the table.
 432   if (Handles.isPointerIntoBucketsArray(OldBucketPtr) ||
 433       Handles.size() == 1) {
 434     return;
 435   }
 436
 437   // Okay, reallocation did happen.  Fix the Prev Pointers.
 438   for (ValueHandlesTy::iterator I = Handles.begin(), E = Handles.end();
 439        I != E; ++I) {
 440     assert(I->second && I->first == I->second->VP && "List invariant broken!");
 441     I->second->setPrevPtr(&I->second);
 442   }
 443 }
 444
 445 /// RemoveFromUseList - Remove this ValueHandle from its current use list.
 446 void ValueHandleBase::RemoveFromUseList() {
 447   assert(VP && VP->HasValueHandle && "Pointer doesn't have a use list!");
 448
 449   // Unlink this from its use list.
 450   ValueHandleBase **PrevPtr = getPrevPtr();
 451   assert(*PrevPtr == this && "List invariant broken");
 452
 453   *PrevPtr = Next;
 454   if (Next) {
 455     assert(Next->getPrevPtr() == &Next && "List invariant broken");
 456     Next->setPrevPtr(PrevPtr);
 457     return;
 458   }
 459
 460   // If the Next pointer was null, then it is possible that this was the last
 461   // ValueHandle watching VP.  If so, delete its entry from the ValueHandles
 462   // map.
 463   sys::SmartScopedWriter<true> Writer(*ValueHandlesLock);
 464   ValueHandlesTy &Handles = *ValueHandles;
 465   if (Handles.isPointerIntoBucketsArray(PrevPtr)) {
 466     Handles.erase(VP);
 467     VP->HasValueHandle = false;
 468   }
 469 }
 470
 471
 472 void ValueHandleBase::ValueIsDeleted(Value *V) {
 473   assert(V->HasValueHandle && "Should only be called if ValueHandles present");
 474
 475   // Get the linked list base, which is guaranteed to exist since the
 476   // HasValueHandle flag is set.
 477   ValueHandlesLock->reader_acquire();
 478   ValueHandleBase *Entry = (*ValueHandles)[V];
 479   ValueHandlesLock->reader_release();
 480   assert(Entry && "Value bit set but no entries exist");
 481
 482   while (Entry) {
 483     // Advance pointer to avoid invalidation.
 484     ValueHandleBase *ThisNode = Entry;
 485     Entry = Entry->Next;
 486
 487     switch (ThisNode->getKind()) {
 488     case Assert:
 489 #ifndef NDEBUG      // Only in -g mode...
 490       errs() << "While deleting: " << *V->getType() << " %" << V->getNameStr()
 491              << "\n";
 492 #endif
 493       llvm_unreachable("An asserting value handle still pointed to this"
 494                        " value!");
 495     case Weak:
 496       // Weak just goes to null, which will unlink it from the list.
 497       ThisNode->operator=(0);
 498       break;
 499     case Callback:
 500       // Forward to the subclass's implementation.
 501       static_cast<CallbackVH*>(ThisNode)->deleted();
 502       break;
 503     }
 504   }
 505
 506   // All callbacks and weak references should be dropped by now.
 507   assert(!V->HasValueHandle && "All references to V were not removed?");
 508 }
 509
 510
 511 void ValueHandleBase::ValueIsRAUWd(Value *Old, Value *New) {
 512   assert(Old->HasValueHandle &&"Should only be called if ValueHandles present");
 513   assert(Old != New && "Changing value into itself!");
 514
 515   // Get the linked list base, which is guaranteed to exist since the
 516   // HasValueHandle flag is set.
 517   ValueHandlesLock->reader_acquire();
 518   ValueHandleBase *Entry = (*ValueHandles)[Old];
 519   ValueHandlesLock->reader_release();
 520   assert(Entry && "Value bit set but no entries exist");
 521
 522   while (Entry) {
 523     // Advance pointer to avoid invalidation.
 524     ValueHandleBase *ThisNode = Entry;
 525     Entry = Entry->Next;
 526
 527     switch (ThisNode->getKind()) {
 528     case Assert:
 529       // Asserting handle does not follow RAUW implicitly.
 530       break;
 531     case Weak:
 532       // Weak goes to the new value, which will unlink it from Old's list.
 533       ThisNode->operator=(New);
 534       break;
 535     case Callback:
 536       // Forward to the subclass's implementation.
 537       static_cast<CallbackVH*>(ThisNode)->allUsesReplacedWith(New);
 538       break;
 539     }
 540   }
 541 }
 542
 543 /// ~CallbackVH. Empty, but defined here to avoid emitting the vtable
 544 /// more than once.
 545 CallbackVH::~CallbackVH() {}
 546
 547
 548 //===----------------------------------------------------------------------===//
 549 //                                 User Class
 550 //===----------------------------------------------------------------------===//
 551
 552 // replaceUsesOfWith - Replaces all references to the "From" definition with
 553 // references to the "To" definition.
 554 //
 555 void User::replaceUsesOfWith(Value *From, Value *To) {
 556   if (From == To) return;   // Duh what?
 557
 558   assert((!isa<Constant>(this) || isa<GlobalValue>(this)) &&
 559          "Cannot call User::replaceUsesOfWith on a constant!");
 560
 561   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
 562     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
 563       // The side effects of this setOperand call include linking to
 564       // "To", adding "this" to the uses list of To, and
 565       // most importantly, removing "this" from the use list of "From".
 566       setOperand(i, To); // Fix it now...
 567     }
 568 }