1 //===-- Value.cpp - Implement the Value class -----------------------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Value and User classes.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Constant.h"
15 #include "llvm/DerivedTypes.h"
16 #include "llvm/InstrTypes.h"
17 #include "llvm/Module.h"
18 #include "llvm/ValueSymbolTable.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/LeakDetector.h"
24 //===----------------------------------------------------------------------===//
26 //===----------------------------------------------------------------------===//
28 static inline const Type *checkType(const Type *Ty) {
29 assert(Ty && "Value defined with a null type: Error!");
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!");
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
52 if (use_begin() != use_end()) {
53 DOUT << "While deleting: " << *Ty << " %" << Name << "\n";
54 for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
55 DOUT << "Use still stuck around after Def is destroyed:"
59 assert(use_begin() == use_end() && "Uses remain when a value is destroyed!");
61 // There should be no uses of this object anymore, remove it.
62 LeakDetector::removeGarbageObject(this);
65 /// hasNUses - Return true if this Value has exactly N users.
67 bool Value::hasNUses(unsigned N) const {
68 use_const_iterator UI = use_begin(), E = use_end();
71 if (UI == E) return false; // Too few.
75 /// hasNUsesOrMore - Return true if this value has N users or more. This is
76 /// logically equivalent to getNumUses() >= N.
78 bool Value::hasNUsesOrMore(unsigned N) const {
79 use_const_iterator UI = use_begin(), E = use_end();
82 if (UI == E) return false; // Too few.
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
91 unsigned Value::getNumUses() const {
92 return (unsigned)std::distance(use_begin(), use_end());
95 static bool getSymTab(Value *V, ValueSymbolTable *&ST) {
96 if (Instruction *I = dyn_cast<Instruction>(V)) {
97 if (BasicBlock *P = I->getParent())
98 if (Function *PP = P->getParent())
99 ST = &PP->getValueSymbolTable();
100 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
101 if (Function *P = BB->getParent())
102 ST = &P->getValueSymbolTable();
103 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
104 if (Module *P = GV->getParent())
105 ST = &P->getValueSymbolTable();
106 } else if (Argument *A = dyn_cast<Argument>(V)) {
107 if (Function *P = A->getParent())
108 ST = &P->getValueSymbolTable();
110 assert(isa<Constant>(V) && "Unknown value type!");
111 return true; // no name is setable for this.
116 void Value::setName(const std::string &name) {
117 if (Name == name) return; // Name is already set.
119 // Get the symbol table to update for this object.
120 ValueSymbolTable *ST;
121 if (getSymTab(this, ST))
122 return; // Cannot set a name on this value (e.g. constant).
124 if (!ST) // No symbol table to update? Just do the change.
126 else if (hasName()) {
127 if (!name.empty()) { // Replacing name.
131 } else { // Transitioning from hasName -> noname.
135 } else { // Transitioning from noname -> hasName.
141 /// takeName - transfer the name from V to this value, setting V's name to
142 /// empty. It is an error to call V->takeName(V).
143 void Value::takeName(Value *V) {
144 std::string Name = V->getName();
150 // uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
151 // except that it doesn't have all of the asserts. The asserts fail because we
152 // are half-way done resolving types, which causes some types to exist as two
153 // different Type*'s at the same time. This is a sledgehammer to work around
156 void Value::uncheckedReplaceAllUsesWith(Value *New) {
157 while (!use_empty()) {
159 // Must handle Constants specially, we cannot call replaceUsesOfWith on a
161 if (Constant *C = dyn_cast<Constant>(U.getUser())) {
162 if (!isa<GlobalValue>(C))
163 C->replaceUsesOfWithOnConstant(this, New, &U);
172 void Value::replaceAllUsesWith(Value *New) {
173 assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
174 assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
175 assert(New->getType() == getType() &&
176 "replaceAllUses of value with new value of different type!");
178 uncheckedReplaceAllUsesWith(New);
181 //===----------------------------------------------------------------------===//
183 //===----------------------------------------------------------------------===//
185 // replaceUsesOfWith - Replaces all references to the "From" definition with
186 // references to the "To" definition.
188 void User::replaceUsesOfWith(Value *From, Value *To) {
189 if (From == To) return; // Duh what?
191 assert(!isa<Constant>(this) || isa<GlobalValue>(this) &&
192 "Cannot call User::replaceUsesofWith on a constant!");
194 for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
195 if (getOperand(i) == From) { // Is This operand is pointing to oldval?
196 // The side effects of this setOperand call include linking to
197 // "To", adding "this" to the uses list of To, and
198 // most importantly, removing "this" from the use list of "From".
199 setOperand(i, To); // Fix it now...