Removed iostream #includes. Replaced std::cerr with DOUT.
[oota-llvm.git] / lib / VMCore / Value.cpp
index a41262d0c64caa3ff0077bab7e88d9a107cc70ea..0d9dc07fa074441c8ac2bb7af458e7e04b9062be 100644 (file)
@@ -1,27 +1,44 @@
 //===-- Value.cpp - Implement the Value class -----------------------------===//
 //
-// This file implements the Value, User, and SymTabValue classes. 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file implements the Value and User classes.
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/ValueHolderImpl.h"
+#include "llvm/Constant.h"
+#include "llvm/DerivedTypes.h"
 #include "llvm/InstrTypes.h"
+#include "llvm/Module.h"
 #include "llvm/SymbolTable.h"
-#include "llvm/SymTabValue.h"
-#include "llvm/ConstPoolVals.h"
-#include "llvm/Type.h"
-#ifndef NDEBUG      // Only in -g mode...
-#include "llvm/Assembly/Writer.h"
-#endif
+#include "llvm/Support/Debug.h"
+#include "llvm/Support/LeakDetector.h"
 #include <algorithm>
+using namespace llvm;
 
 //===----------------------------------------------------------------------===//
 //                                Value Class
 //===----------------------------------------------------------------------===//
 
-Value::Value(const Type *ty, ValueTy vty, const string &name = "")
-  : Name(name), Ty(ty, this) {
-  VTy = vty;
+static inline const Type *checkType(const Type *Ty) {
+  assert(Ty && "Value defined with a null type: Error!");
+  return Ty;
+}
+
+Value::Value(const Type *ty, unsigned scid, const std::string &name)
+  : SubclassID(scid), SubclassData(0), Ty(checkType(ty)),
+    UseList(0), Name(name) {
+  if (!isa<Constant>(this) && !isa<BasicBlock>(this))
+    assert((Ty->isFirstClassType() || Ty == Type::VoidTy ||
+           isa<OpaqueType>(ty)) &&
+           "Cannot create non-first-class values except for constants!");
+  if (ty == Type::VoidTy)
+    assert(name.empty() && "Cannot have named void values!");
 }
 
 Value::~Value() {
@@ -29,75 +46,132 @@ Value::~Value() {
   // Check to make sure that there are no uses of this value that are still
   // around when the value is destroyed.  If there are, then we have a dangling
   // reference and something is wrong.  This code is here to print out what is
-  // still being referenced.  The value in question should be printed as 
+  // still being referenced.  The value in question should be printed as
   // a <badref>
   //
-  if (Uses.begin() != Uses.end()) {
-    for (use_const_iterator I = Uses.begin(); I != Uses.end(); ++I)
-      cerr << "Use still stuck around after Def is destroyed:" << *I << endl;
+  if (use_begin() != use_end()) {
+    DOUT << "While deleting: " << *Ty << " %" << Name << "\n";
+    for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
+      DOUT << "Use still stuck around after Def is destroyed:"
+           << **I << "\n";
   }
 #endif
-  assert(Uses.begin() == Uses.end());
+  assert(use_begin() == use_end() && "Uses remain when a value is destroyed!");
+
+  // There should be no uses of this object anymore, remove it.
+  LeakDetector::removeGarbageObject(this);
 }
 
-void Value::replaceAllUsesWith(Value *D) {
-  assert(D && "Value::replaceAllUsesWith(<null>) is invalid!");
-  assert(D != this && "V->replaceAllUsesWith(V) is NOT valid!");
-  while (!Uses.empty()) {
-    User *Use = Uses.back();
-#ifndef NDEBUG
-    unsigned NumUses = Uses.size();
-#endif
-    Use->replaceUsesOfWith(this, D);
+/// hasNUses - Return true if this Value has exactly N users.
+///
+bool Value::hasNUses(unsigned N) const {
+  use_const_iterator UI = use_begin(), E = use_end();
 
-#ifndef NDEBUG      // only in -g mode...
-    if (Uses.size() == NumUses)
-      cerr << "Use: " << Use << "replace with: " << D; 
-#endif
-    assert(Uses.size() != NumUses && "Didn't remove definition!");
-  }
+  for (; N; --N, ++UI)
+    if (UI == E) return false;  // Too few.
+  return UI == E;
 }
 
-// refineAbstractType - This function is implemented because we use
-// potentially abstract types, and these types may be resolved to more
-// concrete types after we are constructed.  For the value class, we simply
-// change Ty to point to the right type.  :)
-//
-void Value::refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
-  assert(Ty.get() == (const Type*)OldTy &&"Can't refine anything but my type!");
-  Ty = NewTy;
+/// hasNUsesOrMore - Return true if this value has N users or more.  This is
+/// logically equivalent to getNumUses() >= N.
+///
+bool Value::hasNUsesOrMore(unsigned N) const {
+  use_const_iterator UI = use_begin(), E = use_end();
+
+  for (; N; --N, ++UI)
+    if (UI == E) return false;  // Too few.
+
+  return true;
 }
 
-void Value::killUse(User *i) {
-  if (i == 0) return;
-  use_iterator I = find(Uses.begin(), Uses.end(), i);
 
-  assert(I != Uses.end() && "Use not in uses list!!");
-  Uses.erase(I);
+/// getNumUses - This method computes the number of uses of this Value.  This
+/// is a linear time operation.  Use hasOneUse or hasNUses to check for specific
+/// values.
+unsigned Value::getNumUses() const {
+  return (unsigned)std::distance(use_begin(), use_end());
 }
 
-User *Value::use_remove(use_iterator &I) {
-  assert(I != Uses.end() && "Trying to remove the end of the use list!!!");
-  User *i = *I;
-  I = Uses.erase(I);
-  return i;
+
+void Value::setName(const std::string &name) {
+  if (Name == name) return;   // Name is already set.
+
+  // Get the symbol table to update for this object.
+  SymbolTable *ST = 0;
+  if (Instruction *I = dyn_cast<Instruction>(this)) {
+    if (BasicBlock *P = I->getParent())
+      if (Function *PP = P->getParent())
+        ST = &PP->getSymbolTable();
+  } else if (BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
+    if (Function *P = BB->getParent()) ST = &P->getSymbolTable();
+  } else if (GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
+    if (Module *P = GV->getParent()) ST = &P->getSymbolTable();
+  } else if (Argument *A = dyn_cast<Argument>(this)) {
+    if (Function *P = A->getParent()) ST = &P->getSymbolTable();
+  } else {
+    assert(isa<Constant>(this) && "Unknown value type!");
+    return;  // no name is setable for this.
+  }
+
+  if (!ST)  // No symbol table to update?  Just do the change.
+    Name = name;
+  else if (hasName()) {
+    if (!name.empty()) {    // Replacing name.
+      ST->changeName(this, name);
+    } else {                // Transitioning from hasName -> noname.
+      ST->remove(this);
+      Name.clear();
+    }
+  } else {                  // Transitioning from noname -> hasName.
+    Name = name;
+    ST->insert(this);
+  }
 }
 
+// uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
+// except that it doesn't have all of the asserts.  The asserts fail because we
+// are half-way done resolving types, which causes some types to exist as two
+// different Type*'s at the same time.  This is a sledgehammer to work around
+// this problem.
+//
+void Value::uncheckedReplaceAllUsesWith(Value *New) {
+  while (!use_empty()) {
+    Use &U = *UseList;
+    // Must handle Constants specially, we cannot call replaceUsesOfWith on a
+    // constant!
+    if (Constant *C = dyn_cast<Constant>(U.getUser())) {
+      if (!isa<GlobalValue>(C))
+        C->replaceUsesOfWithOnConstant(this, New, &U);
+      else
+        U.set(New);
+    } else {
+      U.set(New);
+    }
+  }
+}
+
+void Value::replaceAllUsesWith(Value *New) {
+  assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
+  assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
+  assert(New->getType() == getType() &&
+         "replaceAllUses of value with new value of different type!");
+
+  uncheckedReplaceAllUsesWith(New);
+}
 
 //===----------------------------------------------------------------------===//
 //                                 User Class
 //===----------------------------------------------------------------------===//
 
-User::User(const Type *Ty, ValueTy vty, const string &name) 
-  : Value(Ty, vty, name) {
-}
-
 // replaceUsesOfWith - Replaces all references to the "From" definition with
 // references to the "To" definition.
 //
 void User::replaceUsesOfWith(Value *From, Value *To) {
   if (From == To) return;   // Duh what?
 
+  assert(!isa<Constant>(this) || isa<GlobalValue>(this) &&
+         "Cannot call User::replaceUsesofWith on a constant!");
+
   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
       // The side effects of this setOperand call include linking to
@@ -107,43 +181,3 @@ void User::replaceUsesOfWith(Value *From, Value *To) {
     }
 }
 
-
-//===----------------------------------------------------------------------===//
-//                             SymTabValue Class
-//===----------------------------------------------------------------------===//
-
-SymTabValue::SymTabValue(Value *p) : ValueParent(p) { 
-  assert(ValueParent && "SymTavValue without parent!?!");
-  ParentSymTab = SymTab = 0;
-}
-
-
-SymTabValue::~SymTabValue() {
-  delete SymTab;
-}
-
-void SymTabValue::setParentSymTab(SymbolTable *ST) {
-  ParentSymTab = ST;
-  if (SymTab) 
-    SymTab->setParentSymTab(ST);
-}
-
-SymbolTable *SymTabValue::getSymbolTableSure() {
-  if (!SymTab) SymTab = new SymbolTable(ParentSymTab);
-  return SymTab;
-}
-
-// hasSymbolTable() - Returns true if there is a symbol table allocated to
-// this object AND if there is at least one name in it!
-//
-bool SymTabValue::hasSymbolTable() const {
-  if (!SymTab) return false;
-
-  for (SymbolTable::const_iterator I = SymTab->begin(); 
-       I != SymTab->end(); ++I) {
-    if (I->second.begin() != I->second.end())
-      return true;                                // Found nonempty type plane!
-  }
-  
-  return false;
-}