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 /// 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
  96 // uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
  97 // except that it doesn't have all of the asserts.  The asserts fail because we
  98 // are half-way done resolving types, which causes some types to exist as two
  99 // different Type*'s at the same time.  This is a sledgehammer to work around
 100 // this problem.
 101 //
 102 void Value::uncheckedReplaceAllUsesWith(Value *New) {
 103   while (!use_empty()) {
 104     Use &U = *UseList;
 105     // Must handle Constants specially, we cannot call replaceUsesOfWith on a
 106     // constant!
 107     if (Constant *C = dyn_cast<Constant>(U.getUser())) {
 108       if (!isa<GlobalValue>(C))
 109         C->replaceUsesOfWithOnConstant(this, New, true);
 110       else
 111         U.set(New);
 112     } else {
 113       U.set(New);
 114     }
 115   }
 116 }
 117
 118 void Value::replaceAllUsesWith(Value *New) {
 119   assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
 120   assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
 121   assert(New->getType() == getType() &&
 122          "replaceAllUses of value with new value of different type!");
 123
 124   uncheckedReplaceAllUsesWith(New);
 125 }
 126
 127 //===----------------------------------------------------------------------===//
 128 //                                 User Class
 129 //===----------------------------------------------------------------------===//
 130
 131 // replaceUsesOfWith - Replaces all references to the "From" definition with
 132 // references to the "To" definition.
 133 //
 134 void User::replaceUsesOfWith(Value *From, Value *To) {
 135   if (From == To) return;   // Duh what?
 136
 137   assert(!isa<Constant>(this) || isa<GlobalValue>(this) &&
 138          "Cannot call User::replaceUsesofWith on a constant!");
 139
 140   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
 141     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
 142       // The side effects of this setOperand call include linking to
 143       // "To", adding "this" to the uses list of To, and
 144       // most importantly, removing "this" from the use list of "From".
 145       setOperand(i, To); // Fix it now...
 146     }
 147 }
 148