1 //===-- Globals.cpp - Implement the GlobalValue & GlobalVariable class ----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the GlobalValue & GlobalVariable classes for the VMCore
13 //===----------------------------------------------------------------------===//
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"
27 //===----------------------------------------------------------------------===//
29 //===----------------------------------------------------------------------===//
31 /// removeDeadUsersOfConstant - If the specified constantexpr is dead, remove
32 /// it. This involves recursively eliminating any dead users of the
34 static bool removeDeadUsersOfConstant(const Constant *C) {
35 if (isa<GlobalValue>(C)) return false; // Cannot remove this
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
44 const_cast<Constant*>(C)->destroyConstant();
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;
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.
63 // If the constant was dead, then the iterator is invalidated.
64 if (LastNonDeadUser == E) {
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()!");
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());
94 //===----------------------------------------------------------------------===//
95 // GlobalVariable Implementation
96 //===----------------------------------------------------------------------===//
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) {
108 assert(InitVal->getType() == Ty &&
109 "Initializer should be the same type as the GlobalVariable!");
113 LeakDetector::addGarbageObject(this);
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(PointerType::get(Ty, AddressSpace), Value::GlobalVariableVal,
122 OperandTraits<GlobalVariable>::op_begin(this),
123 InitVal != 0, Link, Name),
124 isConstantGlobal(constant), isThreadLocalSymbol(ThreadLocal) {
126 assert(InitVal->getType() == Ty &&
127 "Initializer should be the same type as the GlobalVariable!");
131 LeakDetector::addGarbageObject(this);
134 Before->getParent()->getGlobalList().insert(Before, this);
136 M.getGlobalList().push_back(this);
139 void GlobalVariable::setParent(Module *parent) {
141 LeakDetector::addGarbageObject(this);
144 LeakDetector::removeGarbageObject(this);
147 void GlobalVariable::removeFromParent() {
148 getParent()->getGlobalList().remove(this);
151 void GlobalVariable::eraseFromParent() {
152 getParent()->getGlobalList().erase(this);
155 void GlobalVariable::replaceUsesOfWithOnConstant(Value *From, Value *To,
157 // If you call this, then you better know this GVar has a constant
158 // initializer worth replacing. Enforce that here.
159 assert(getNumOperands() == 1 &&
160 "Attempt to replace uses of Constants on a GVar with no initializer");
162 // And, since you know it has an initializer, the From value better be
163 // the initializer :)
164 assert(getOperand(0) == From &&
165 "Attempt to replace wrong constant initializer in GVar");
167 // And, you better have a constant for the replacement value
168 assert(isa<Constant>(To) &&
169 "Attempt to replace GVar initializer with non-constant");
171 // Okay, preconditions out of the way, replace the constant initializer.
172 this->setOperand(0, cast<Constant>(To));
175 /// copyAttributesFrom - copy all additional attributes (those not needed to
176 /// create a GlobalVariable) from the GlobalVariable Src to this one.
177 void GlobalVariable::copyAttributesFrom(const GlobalValue *Src) {
178 assert(isa<GlobalVariable>(Src) && "Expected a GlobalVariable!");
179 GlobalValue::copyAttributesFrom(Src);
180 const GlobalVariable *SrcVar = cast<GlobalVariable>(Src);
181 setThreadLocal(SrcVar->isThreadLocal());
185 //===----------------------------------------------------------------------===//
186 // GlobalAlias Implementation
187 //===----------------------------------------------------------------------===//
189 GlobalAlias::GlobalAlias(const Type *Ty, LinkageTypes Link,
190 const std::string &Name, Constant* aliasee,
191 Module *ParentModule)
192 : GlobalValue(Ty, Value::GlobalAliasVal, &Op<0>(), 1, Link, Name) {
193 LeakDetector::addGarbageObject(this);
196 assert(aliasee->getType() == Ty && "Alias and aliasee types should match!");
200 ParentModule->getAliasList().push_back(this);
203 void GlobalAlias::setParent(Module *parent) {
205 LeakDetector::addGarbageObject(this);
208 LeakDetector::removeGarbageObject(this);
211 void GlobalAlias::removeFromParent() {
212 getParent()->getAliasList().remove(this);
215 void GlobalAlias::eraseFromParent() {
216 getParent()->getAliasList().erase(this);
219 bool GlobalAlias::isDeclaration() const {
220 const GlobalValue* AV = getAliasedGlobal();
222 return AV->isDeclaration();
227 void GlobalAlias::setAliasee(Constant *Aliasee)
230 assert(Aliasee->getType() == getType() &&
231 "Alias and aliasee types should match!");
233 setOperand(0, Aliasee);
236 const GlobalValue *GlobalAlias::getAliasedGlobal() const {
237 const Constant *C = getAliasee();
239 if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
242 const ConstantExpr *CE = 0;
243 if ((CE = dyn_cast<ConstantExpr>(C)) &&
244 (CE->getOpcode() == Instruction::BitCast ||
245 CE->getOpcode() == Instruction::GetElementPtr))
246 return dyn_cast<GlobalValue>(CE->getOperand(0));
248 LLVM_UNREACHABLE("Unsupported aliasee");
254 const GlobalValue *GlobalAlias::resolveAliasedGlobal(bool stopOnWeak) const {
255 SmallPtrSet<const GlobalValue*, 3> Visited;
257 // Check if we need to stop early.
258 if (stopOnWeak && mayBeOverridden())
261 const GlobalValue *GV = getAliasedGlobal();
264 // Iterate over aliasing chain, stopping on weak alias if necessary.
265 while (const GlobalAlias *GA = dyn_cast<GlobalAlias>(GV)) {
266 if (stopOnWeak && GA->mayBeOverridden())
269 GV = GA->getAliasedGlobal();
271 if (!Visited.insert(GV))