lib/VMCore/Value.cpp

   1 //===-- Value.cpp - Implement the Value class -----------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the Value and User classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Constant.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/InstrTypes.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/ValueSymbolTable.h"
  19 #include "llvm/Support/Debug.h"
  20 #include "llvm/Support/LeakDetector.h"
  21 #include <algorithm>
  22 using namespace llvm;
  23
  24 //===----------------------------------------------------------------------===//
  25 //                                Value Class
  26 //===----------------------------------------------------------------------===//
  27
  28 static inline const Type *checkType(const Type *Ty) {
  29   assert(Ty && "Value defined with a null type: Error!");
  30   return Ty;
  31 }
  32
  33 Value::Value(const Type *ty, unsigned scid, const std::string &name)
  34   : SubclassID(scid), SubclassData(0), Ty(checkType(ty)),
  35     UseList(0), Name(name) {
  36   if (!isa<Constant>(this) && !isa<BasicBlock>(this))
  37     assert((Ty->isFirstClassType() || Ty == Type::VoidTy ||
  38            isa<OpaqueType>(ty)) &&
  39            "Cannot create non-first-class values except for constants!");
  40   if (ty == Type::VoidTy)
  41     assert(name.empty() && "Cannot have named void values!");
  42 }
  43
  44 Value::~Value() {
  45 #ifndef NDEBUG      // Only in -g mode...
  46   // Check to make sure that there are no uses of this value that are still
  47   // around when the value is destroyed.  If there are, then we have a dangling
  48   // reference and something is wrong.  This code is here to print out what is
  49   // still being referenced.  The value in question should be printed as
  50   // a <badref>
  51   //
  52   if (use_begin() != use_end()) {
  53     DOUT << "While deleting: " << *Ty << " %" << Name << "\n";
  54     for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
  55       DOUT << "Use still stuck around after Def is destroyed:"
  56            << **I << "\n";
  57   }
  58 #endif
  59   assert(use_begin() == use_end() && "Uses remain when a value is destroyed!");
  60
  61   // There should be no uses of this object anymore, remove it.
  62   LeakDetector::removeGarbageObject(this);
  63 }
  64
  65 /// hasNUses - Return true if this Value has exactly N users.
  66 ///
  67 bool Value::hasNUses(unsigned N) const {
  68   use_const_iterator UI = use_begin(), E = use_end();
  69
  70   for (; N; --N, ++UI)
  71     if (UI == E) return false;  // Too few.
  72   return UI == E;
  73 }
  74
  75 /// hasNUsesOrMore - Return true if this value has N users or more.  This is
  76 /// logically equivalent to getNumUses() >= N.
  77 ///
  78 bool Value::hasNUsesOrMore(unsigned N) const {
  79   use_const_iterator UI = use_begin(), E = use_end();
  80
  81   for (; N; --N, ++UI)
  82     if (UI == E) return false;  // Too few.
  83
  84   return true;
  85 }
  86
  87
  88 /// getNumUses - This method computes the number of uses of this Value.  This
  89 /// is a linear time operation.  Use hasOneUse or hasNUses to check for specific
  90 /// values.
  91 unsigned Value::getNumUses() const {
  92   return (unsigned)std::distance(use_begin(), use_end());
  93 }
  94
  95 static bool getSymTab(Value *V, ValueSymbolTable *&ST) {
  96   ST = 0;
  97   if (Instruction *I = dyn_cast<Instruction>(V)) {
  98     if (BasicBlock *P = I->getParent())
  99       if (Function *PP = P->getParent())
 100         ST = &PP->getValueSymbolTable();
 101   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
 102     if (Function *P = BB->getParent())
 103       ST = &P->getValueSymbolTable();
 104   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 105     if (Module *P = GV->getParent())
 106       ST = &P->getValueSymbolTable();
 107   } else if (Argument *A = dyn_cast<Argument>(V)) {
 108     if (Function *P = A->getParent())
 109       ST = &P->getValueSymbolTable();
 110   } else {
 111     assert(isa<Constant>(V) && "Unknown value type!");
 112     return true;  // no name is setable for this.
 113   }
 114   return false;
 115 }
 116
 117 void Value::setName(const std::string &name) {
 118   if (Name == name) return;   // Name is already set.
 119
 120   // Get the symbol table to update for this object.
 121   ValueSymbolTable *ST;
 122   if (getSymTab(this, ST))
 123     return;  // Cannot set a name on this value (e.g. constant).
 124
 125   if (!ST)  // No symbol table to update?  Just do the change.
 126     Name = name;
 127   else if (hasName()) {
 128     if (!name.empty()) {    // Replacing name.
 129       ST->remove(this);
 130       Name = name;
 131       ST->insert(this);
 132     } else {                // Transitioning from hasName -> noname.
 133       ST->remove(this);
 134       Name.clear();
 135     }
 136   } else {                  // Transitioning from noname -> hasName.
 137     Name = name;
 138     ST->insert(this);
 139   }
 140 }
 141
 142 /// takeName - transfer the name from V to this value, setting V's name to
 143 /// empty.  It is an error to call V->takeName(V).
 144 void Value::takeName(Value *V) {
 145   if (!V->hasName()) {
 146     if (hasName())
 147       setName("");
 148     return;
 149   }
 150
 151   std::string Name = V->getName();
 152   V->setName("");
 153   setName(Name);
 154 }
 155
 156
 157 // uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
 158 // except that it doesn't have all of the asserts.  The asserts fail because we
 159 // are half-way done resolving types, which causes some types to exist as two
 160 // different Type*'s at the same time.  This is a sledgehammer to work around
 161 // this problem.
 162 //
 163 void Value::uncheckedReplaceAllUsesWith(Value *New) {
 164   while (!use_empty()) {
 165     Use &U = *UseList;
 166     // Must handle Constants specially, we cannot call replaceUsesOfWith on a
 167     // constant!
 168     if (Constant *C = dyn_cast<Constant>(U.getUser())) {
 169       if (!isa<GlobalValue>(C))
 170         C->replaceUsesOfWithOnConstant(this, New, &U);
 171       else
 172         U.set(New);
 173     } else {
 174       U.set(New);
 175     }
 176   }
 177 }
 178
 179 void Value::replaceAllUsesWith(Value *New) {
 180   assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
 181   assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
 182   assert(New->getType() == getType() &&
 183          "replaceAllUses of value with new value of different type!");
 184
 185   uncheckedReplaceAllUsesWith(New);
 186 }
 187
 188 //===----------------------------------------------------------------------===//
 189 //                                 User Class
 190 //===----------------------------------------------------------------------===//
 191
 192 // replaceUsesOfWith - Replaces all references to the "From" definition with
 193 // references to the "To" definition.
 194 //
 195 void User::replaceUsesOfWith(Value *From, Value *To) {
 196   if (From == To) return;   // Duh what?
 197
 198   assert(!isa<Constant>(this) || isa<GlobalValue>(this) &&
 199          "Cannot call User::replaceUsesofWith on a constant!");
 200
 201   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
 202     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
 203       // The side effects of this setOperand call include linking to
 204       // "To", adding "this" to the uses list of To, and
 205       // most importantly, removing "this" from the use list of "From".
 206       setOperand(i, To); // Fix it now...
 207     }
 208 }
 209