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/LLVMContext.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/ADT/SmallPtrSet.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/Support/LeakDetector.h"
  24 #include "llvm/Support/Streams.h"
  25 using namespace llvm;
  26
  27 //===----------------------------------------------------------------------===//
  28 //                            GlobalValue Class
  29 //===----------------------------------------------------------------------===//
  30
  31 /// removeDeadUsersOfConstant - If the specified constantexpr is dead, remove
  32 /// it.  This involves recursively eliminating any dead users of the
  33 /// constantexpr.
  34 static bool removeDeadUsersOfConstant(const Constant *C) {
  35   if (isa<GlobalValue>(C)) return false; // Cannot remove this
  36
  37   while (!C->use_empty()) {
  38     const Constant *User = dyn_cast<Constant>(C->use_back());
  39     if (!User) return false; // Non-constant usage;
  40     if (!removeDeadUsersOfConstant(User))
  41       return false; // Constant wasn't dead
  42   }
  43
  44   const_cast<Constant*>(C)->destroyConstant();
  45   return true;
  46 }
  47
  48 /// removeDeadConstantUsers - If there are any dead constant users dangling
  49 /// off of this global value, remove them.  This method is useful for clients
  50 /// that want to check to see if a global is unused, but don't want to deal
  51 /// with potentially dead constants hanging off of the globals.
  52 void GlobalValue::removeDeadConstantUsers() const {
  53   Value::use_const_iterator I = use_begin(), E = use_end();
  54   Value::use_const_iterator LastNonDeadUser = E;
  55   while (I != E) {
  56     if (const Constant *User = dyn_cast<Constant>(*I)) {
  57       if (!removeDeadUsersOfConstant(User)) {
  58         // If the constant wasn't dead, remember that this was the last live use
  59         // and move on to the next constant.
  60         LastNonDeadUser = I;
  61         ++I;
  62       } else {
  63         // If the constant was dead, then the iterator is invalidated.
  64         if (LastNonDeadUser == E) {
  65           I = use_begin();
  66           if (I == E) break;
  67         } else {
  68           I = LastNonDeadUser;
  69           ++I;
  70         }
  71       }
  72     } else {
  73       LastNonDeadUser = I;
  74       ++I;
  75     }
  76   }
  77 }
  78
  79 /// Override destroyConstant to make sure it doesn't get called on
  80 /// GlobalValue's because they shouldn't be treated like other constants.
  81 void GlobalValue::destroyConstant() {
  82   llvm_unreachable("You can't GV->destroyConstant()!");
  83 }
  84
  85 /// copyAttributesFrom - copy all additional attributes (those not needed to
  86 /// create a GlobalValue) from the GlobalValue Src to this one.
  87 void GlobalValue::copyAttributesFrom(const GlobalValue *Src) {
  88   setAlignment(Src->getAlignment());
  89   setSection(Src->getSection());
  90   setVisibility(Src->getVisibility());
  91 }
  92
  93
  94 //===----------------------------------------------------------------------===//
  95 // GlobalVariable Implementation
  96 //===----------------------------------------------------------------------===//
  97
  98 GlobalVariable::GlobalVariable(LLVMContext &Context, const Type *Ty,
  99                                bool constant, LinkageTypes Link,
 100                                Constant *InitVal, const std::string &Name,
 101                                bool ThreadLocal, unsigned AddressSpace)
 102   : GlobalValue(Context.getPointerType(Ty, AddressSpace),
 103                 Value::GlobalVariableVal,
 104                 OperandTraits<GlobalVariable>::op_begin(this),
 105                 InitVal != 0, Link, Name),
 106     isConstantGlobal(constant), isThreadLocalSymbol(ThreadLocal) {
 107   if (InitVal) {
 108     assert(InitVal->getType() == Ty &&
 109            "Initializer should be the same type as the GlobalVariable!");
 110     Op<0>() = InitVal;
 111   }
 112
 113   LeakDetector::addGarbageObject(this);
 114 }
 115
 116 GlobalVariable::GlobalVariable(Module &M, const Type *Ty, bool constant,
 117                                LinkageTypes Link, Constant *InitVal,
 118                                const std::string &Name,
 119                                GlobalVariable *Before, bool ThreadLocal,
 120                                unsigned AddressSpace)
 121   : GlobalValue(M.getContext().getPointerType(Ty, AddressSpace),
 122                 Value::GlobalVariableVal,
 123                 OperandTraits<GlobalVariable>::op_begin(this),
 124                 InitVal != 0, Link, Name),
 125     isConstantGlobal(constant), isThreadLocalSymbol(ThreadLocal) {
 126   if (InitVal) {
 127     assert(InitVal->getType() == Ty &&
 128            "Initializer should be the same type as the GlobalVariable!");
 129     Op<0>() = InitVal;
 130   }
 131
 132   LeakDetector::addGarbageObject(this);
 133
 134   if (Before)
 135     Before->getParent()->getGlobalList().insert(Before, this);
 136   else
 137     M.getGlobalList().push_back(this);
 138 }
 139
 140 void GlobalVariable::setParent(Module *parent) {
 141   if (getParent())
 142     LeakDetector::addGarbageObject(this);
 143   Parent = parent;
 144   if (getParent())
 145     LeakDetector::removeGarbageObject(this);
 146 }
 147
 148 void GlobalVariable::removeFromParent() {
 149   getParent()->getGlobalList().remove(this);
 150 }
 151
 152 void GlobalVariable::eraseFromParent() {
 153   getParent()->getGlobalList().erase(this);
 154 }
 155
 156 void GlobalVariable::replaceUsesOfWithOnConstant(Value *From, Value *To,
 157                                                  Use *U) {
 158   // If you call this, then you better know this GVar has a constant
 159   // initializer worth replacing. Enforce that here.
 160   assert(getNumOperands() == 1 &&
 161          "Attempt to replace uses of Constants on a GVar with no initializer");
 162
 163   // And, since you know it has an initializer, the From value better be
 164   // the initializer :)
 165   assert(getOperand(0) == From &&
 166          "Attempt to replace wrong constant initializer in GVar");
 167
 168   // And, you better have a constant for the replacement value
 169   assert(isa<Constant>(To) &&
 170          "Attempt to replace GVar initializer with non-constant");
 171
 172   // Okay, preconditions out of the way, replace the constant initializer.
 173   this->setOperand(0, cast<Constant>(To));
 174 }
 175
 176 /// copyAttributesFrom - copy all additional attributes (those not needed to
 177 /// create a GlobalVariable) from the GlobalVariable Src to this one.
 178 void GlobalVariable::copyAttributesFrom(const GlobalValue *Src) {
 179   assert(isa<GlobalVariable>(Src) && "Expected a GlobalVariable!");
 180   GlobalValue::copyAttributesFrom(Src);
 181   const GlobalVariable *SrcVar = cast<GlobalVariable>(Src);
 182   setThreadLocal(SrcVar->isThreadLocal());
 183 }
 184
 185
 186 //===----------------------------------------------------------------------===//
 187 // GlobalAlias Implementation
 188 //===----------------------------------------------------------------------===//
 189
 190 GlobalAlias::GlobalAlias(const Type *Ty, LinkageTypes Link,
 191                          const std::string &Name, Constant* aliasee,
 192                          Module *ParentModule)
 193   : GlobalValue(Ty, Value::GlobalAliasVal, &Op<0>(), 1, Link, Name) {
 194   LeakDetector::addGarbageObject(this);
 195
 196   if (aliasee)
 197     assert(aliasee->getType() == Ty && "Alias and aliasee types should match!");
 198   Op<0>() = aliasee;
 199
 200   if (ParentModule)
 201     ParentModule->getAliasList().push_back(this);
 202 }
 203
 204 void GlobalAlias::setParent(Module *parent) {
 205   if (getParent())
 206     LeakDetector::addGarbageObject(this);
 207   Parent = parent;
 208   if (getParent())
 209     LeakDetector::removeGarbageObject(this);
 210 }
 211
 212 void GlobalAlias::removeFromParent() {
 213   getParent()->getAliasList().remove(this);
 214 }
 215
 216 void GlobalAlias::eraseFromParent() {
 217   getParent()->getAliasList().erase(this);
 218 }
 219
 220 bool GlobalAlias::isDeclaration() const {
 221   const GlobalValue* AV = getAliasedGlobal();
 222   if (AV)
 223     return AV->isDeclaration();
 224   else
 225     return false;
 226 }
 227
 228 void GlobalAlias::setAliasee(Constant *Aliasee)
 229 {
 230   if (Aliasee)
 231     assert(Aliasee->getType() == getType() &&
 232            "Alias and aliasee types should match!");
 233
 234   setOperand(0, Aliasee);
 235 }
 236
 237 const GlobalValue *GlobalAlias::getAliasedGlobal() const {
 238   const Constant *C = getAliasee();
 239   if (C) {
 240     if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
 241       return GV;
 242     else {
 243       const ConstantExpr *CE = 0;
 244       if ((CE = dyn_cast<ConstantExpr>(C)) &&
 245           (CE->getOpcode() == Instruction::BitCast ||
 246            CE->getOpcode() == Instruction::GetElementPtr))
 247         return dyn_cast<GlobalValue>(CE->getOperand(0));
 248       else
 249         llvm_unreachable("Unsupported aliasee");
 250     }
 251   }
 252   return 0;
 253 }
 254
 255 const GlobalValue *GlobalAlias::resolveAliasedGlobal(bool stopOnWeak) const {
 256   SmallPtrSet<const GlobalValue*, 3> Visited;
 257
 258   // Check if we need to stop early.
 259   if (stopOnWeak && mayBeOverridden())
 260     return this;
 261
 262   const GlobalValue *GV = getAliasedGlobal();
 263   Visited.insert(GV);
 264
 265   // Iterate over aliasing chain, stopping on weak alias if necessary.
 266   while (const GlobalAlias *GA = dyn_cast<GlobalAlias>(GV)) {
 267     if (stopOnWeak && GA->mayBeOverridden())
 268       break;
 269
 270     GV = GA->getAliasedGlobal();
 271
 272     if (!Visited.insert(GV))
 273       return NULL;
 274   }
 275
 276   return GV;
 277 }