lib/VMCore/Globals.cpp

   1 //===-- Globals.cpp - Implement the GlobalValue & GlobalVariable 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 GlobalValue & GlobalVariable classes for the VMCore
  11 // library.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Constants.h"
  16 #include "llvm/GlobalVariable.h"
  17 #include "llvm/GlobalAlias.h"
  18 #include "llvm/DerivedTypes.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/Support/LeakDetector.h"
  21 using namespace llvm;
  22
  23 //===----------------------------------------------------------------------===//
  24 //                            GlobalValue Class
  25 //===----------------------------------------------------------------------===//
  26
  27 /// removeDeadUsersOfConstant - If the specified constantexpr is dead, remove
  28 /// it.  This involves recursively eliminating any dead users of the
  29 /// constantexpr.
  30 static bool removeDeadUsersOfConstant(Constant *C) {
  31   if (isa<GlobalValue>(C)) return false; // Cannot remove this
  32
  33   while (!C->use_empty()) {
  34     Constant *User = dyn_cast<Constant>(C->use_back());
  35     if (!User) return false; // Non-constant usage;
  36     if (!removeDeadUsersOfConstant(User))
  37       return false; // Constant wasn't dead
  38   }
  39
  40   C->destroyConstant();
  41   return true;
  42 }
  43
  44 /// removeDeadConstantUsers - If there are any dead constant users dangling
  45 /// off of this global value, remove them.  This method is useful for clients
  46 /// that want to check to see if a global is unused, but don't want to deal
  47 /// with potentially dead constants hanging off of the globals.
  48 void GlobalValue::removeDeadConstantUsers() {
  49   Value::use_iterator I = use_begin(), E = use_end();
  50   Value::use_iterator LastNonDeadUser = E;
  51   while (I != E) {
  52     if (Constant *User = dyn_cast<Constant>(*I)) {
  53       if (!removeDeadUsersOfConstant(User)) {
  54         // If the constant wasn't dead, remember that this was the last live use
  55         // and move on to the next constant.
  56         LastNonDeadUser = I;
  57         ++I;
  58       } else {
  59         // If the constant was dead, then the iterator is invalidated.
  60         if (LastNonDeadUser == E) {
  61           I = use_begin();
  62           if (I == E) break;
  63         } else {
  64           I = LastNonDeadUser;
  65           ++I;
  66         }
  67       }
  68     } else {
  69       LastNonDeadUser = I;
  70       ++I;
  71     }
  72   }
  73 }
  74
  75 /// Override destroyConstant to make sure it doesn't get called on
  76 /// GlobalValue's because they shouldn't be treated like other constants.
  77 void GlobalValue::destroyConstant() {
  78   assert(0 && "You can't GV->destroyConstant()!");
  79   abort();
  80 }
  81
  82 //===----------------------------------------------------------------------===//
  83 // GlobalVariable Implementation
  84 //===----------------------------------------------------------------------===//
  85
  86 GlobalVariable::GlobalVariable(const Type *Ty, bool constant, LinkageTypes Link,
  87                                Constant *InitVal, const std::string &Name,
  88                                Module *ParentModule, bool ThreadLocal,
  89                                unsigned AddressSpace)
  90   : GlobalValue(PointerType::get(Ty, AddressSpace), Value::GlobalVariableVal,
  91                 &Initializer, InitVal != 0, Link, Name),
  92     isConstantGlobal(constant), isThreadLocalSymbol(ThreadLocal) {
  93   if (InitVal) {
  94     assert(InitVal->getType() == Ty &&
  95            "Initializer should be the same type as the GlobalVariable!");
  96     Initializer.init(InitVal, this);
  97   } else {
  98     Initializer.init(0, this);
  99   }
 100
 101   LeakDetector::addGarbageObject(this);
 102
 103   if (ParentModule)
 104     ParentModule->getGlobalList().push_back(this);
 105 }
 106
 107 GlobalVariable::GlobalVariable(const Type *Ty, bool constant, LinkageTypes Link,
 108                                Constant *InitVal, const std::string &Name,
 109                                GlobalVariable *Before, bool ThreadLocal,
 110                                unsigned AddressSpace)
 111   : GlobalValue(PointerType::get(Ty, AddressSpace), Value::GlobalVariableVal,
 112                 &Initializer, InitVal != 0, Link, Name),
 113     isConstantGlobal(constant), isThreadLocalSymbol(ThreadLocal) {
 114   if (InitVal) {
 115     assert(InitVal->getType() == Ty &&
 116            "Initializer should be the same type as the GlobalVariable!");
 117     Initializer.init(InitVal, this);
 118   } else {
 119     Initializer.init(0, this);
 120   }
 121
 122   LeakDetector::addGarbageObject(this);
 123
 124   if (Before)
 125     Before->getParent()->getGlobalList().insert(Before, this);
 126 }
 127
 128 void GlobalVariable::setParent(Module *parent) {
 129   if (getParent())
 130     LeakDetector::addGarbageObject(this);
 131   Parent = parent;
 132   if (getParent())
 133     LeakDetector::removeGarbageObject(this);
 134 }
 135
 136 void GlobalVariable::removeFromParent() {
 137   getParent()->getGlobalList().remove(this);
 138 }
 139
 140 void GlobalVariable::eraseFromParent() {
 141   getParent()->getGlobalList().erase(this);
 142 }
 143
 144 void GlobalVariable::replaceUsesOfWithOnConstant(Value *From, Value *To,
 145                                                  Use *U) {
 146   // If you call this, then you better know this GVar has a constant
 147   // initializer worth replacing. Enforce that here.
 148   assert(getNumOperands() == 1 &&
 149          "Attempt to replace uses of Constants on a GVar with no initializer");
 150
 151   // And, since you know it has an initializer, the From value better be
 152   // the initializer :)
 153   assert(getOperand(0) == From &&
 154          "Attempt to replace wrong constant initializer in GVar");
 155
 156   // And, you better have a constant for the replacement value
 157   assert(isa<Constant>(To) &&
 158          "Attempt to replace GVar initializer with non-constant");
 159
 160   // Okay, preconditions out of the way, replace the constant initializer.
 161   this->setOperand(0, cast<Constant>(To));
 162 }
 163
 164 //===----------------------------------------------------------------------===//
 165 // GlobalAlias Implementation
 166 //===----------------------------------------------------------------------===//
 167
 168 GlobalAlias::GlobalAlias(const Type *Ty, LinkageTypes Link,
 169                          const std::string &Name, Constant* aliasee,
 170                          Module *ParentModule)
 171   : GlobalValue(Ty, Value::GlobalAliasVal, &Aliasee, 1, Link, Name) {
 172   LeakDetector::addGarbageObject(this);
 173
 174   if (aliasee)
 175     assert(aliasee->getType() == Ty && "Alias and aliasee types should match!");
 176   Aliasee.init(aliasee, this);
 177
 178   if (ParentModule)
 179     ParentModule->getAliasList().push_back(this);
 180 }
 181
 182 void GlobalAlias::setParent(Module *parent) {
 183   if (getParent())
 184     LeakDetector::addGarbageObject(this);
 185   Parent = parent;
 186   if (getParent())
 187     LeakDetector::removeGarbageObject(this);
 188 }
 189
 190 void GlobalAlias::removeFromParent() {
 191   getParent()->getAliasList().remove(this);
 192 }
 193
 194 void GlobalAlias::eraseFromParent() {
 195   getParent()->getAliasList().erase(this);
 196 }
 197
 198 bool GlobalAlias::isDeclaration() const {
 199   const GlobalValue* AV = getAliasedGlobal();
 200   if (AV)
 201     return AV->isDeclaration();
 202   else
 203     return false;
 204 }
 205
 206 void GlobalAlias::setAliasee(Constant *Aliasee)
 207 {
 208   if (Aliasee)
 209     assert(Aliasee->getType() == getType() &&
 210            "Alias and aliasee types should match!");
 211
 212   setOperand(0, Aliasee);
 213 }
 214
 215 const GlobalValue *GlobalAlias::getAliasedGlobal() const {
 216   const Constant *C = getAliasee();
 217   if (C) {
 218     if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
 219       return GV;
 220     else {
 221       const ConstantExpr *CE = 0;
 222       if ((CE = dyn_cast<ConstantExpr>(C)) &&
 223           (CE->getOpcode() == Instruction::BitCast ||
 224            CE->getOpcode() == Instruction::GetElementPtr))
 225         return dyn_cast<GlobalValue>(CE->getOperand(0));
 226       else
 227         assert(0 && "Unsupported aliasee");
 228     }
 229   }
 230   return 0;
 231 }
 232