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