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