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/InstrTypes.h"
  15 #include "llvm/SymbolTable.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Constant.h"
  18 #include "llvm/GlobalValue.h"
  19 #include "llvm/Support/LeakDetector.h"
  20 #include <algorithm>
  21 #include <iostream>
  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     std::cerr << "While deleting: " << *Ty << " %" << Name << "\n";
  54     for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
  55       std::cerr << "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 /// getNumUses - This method computes the number of uses of this Value.  This
  76 /// is a linear time operation.  Use hasOneUse or hasNUses to check for specific
  77 /// values.
  78 unsigned Value::getNumUses() const {
  79   return (unsigned)std::distance(use_begin(), use_end());
  80 }
  81
  82
  83 // uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
  84 // except that it doesn't have all of the asserts.  The asserts fail because we
  85 // are half-way done resolving types, which causes some types to exist as two
  86 // different Type*'s at the same time.  This is a sledgehammer to work around
  87 // this problem.
  88 //
  89 void Value::uncheckedReplaceAllUsesWith(Value *New) {
  90   while (!use_empty()) {
  91     Use &U = *UseList;
  92     // Must handle Constants specially, we cannot call replaceUsesOfWith on a
  93     // constant!
  94     if (Constant *C = dyn_cast<Constant>(U.getUser())) {
  95       if (!isa<GlobalValue>(C))
  96         C->replaceUsesOfWithOnConstant(this, New, true);
  97       else
  98         U.set(New);
  99     } else {
 100       U.set(New);
 101     }
 102   }
 103 }
 104
 105 void Value::replaceAllUsesWith(Value *New) {
 106   assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
 107   assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
 108   assert(New->getType() == getType() &&
 109          "replaceAllUses of value with new value of different type!");
 110
 111   uncheckedReplaceAllUsesWith(New);
 112 }
 113
 114 //===----------------------------------------------------------------------===//
 115 //                                 User Class
 116 //===----------------------------------------------------------------------===//
 117
 118 // replaceUsesOfWith - Replaces all references to the "From" definition with
 119 // references to the "To" definition.
 120 //
 121 void User::replaceUsesOfWith(Value *From, Value *To) {
 122   if (From == To) return;   // Duh what?
 123
 124   assert(!isa<Constant>(this) || isa<GlobalValue>(this) &&
 125          "Cannot call User::replaceUsesofWith on a constant!");
 126
 127   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
 128     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
 129       // The side effects of this setOperand call include linking to
 130       // "To", adding "this" to the uses list of To, and
 131       // most importantly, removing "this" from the use list of "From".
 132       setOperand(i, To); // Fix it now...
 133     }
 134 }
 135