Switch ValueSymbolTable to use StringMap<Value*> instead of std::map<std::string...
[oota-llvm.git] / 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/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"
21 #include <algorithm>
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)
34   : SubclassID(scid), SubclassData(0), Ty(checkType(ty)),
35     UseList(0), Name(0) {
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 }
41
42 Value::~Value() {
43 #ifndef NDEBUG      // Only in -g mode...
44   // Check to make sure that there are no uses of this value that are still
45   // around when the value is destroyed.  If there are, then we have a dangling
46   // reference and something is wrong.  This code is here to print out what is
47   // still being referenced.  The value in question should be printed as
48   // a <badref>
49   //
50   if (use_begin() != use_end()) {
51     DOUT << "While deleting: " << *Ty << " %" << Name << "\n";
52     for (use_iterator I = use_begin(), E = use_end(); I != E; ++I)
53       DOUT << "Use still stuck around after Def is destroyed:"
54            << **I << "\n";
55   }
56 #endif
57   assert(use_begin() == use_end() && "Uses remain when a value is destroyed!");
58
59   // There should be no uses of this object anymore, remove it.
60   LeakDetector::removeGarbageObject(this);
61 }
62
63 /// hasNUses - Return true if this Value has exactly N users.
64 ///
65 bool Value::hasNUses(unsigned N) const {
66   use_const_iterator UI = use_begin(), E = use_end();
67
68   for (; N; --N, ++UI)
69     if (UI == E) return false;  // Too few.
70   return UI == E;
71 }
72
73 /// hasNUsesOrMore - Return true if this value has N users or more.  This is
74 /// logically equivalent to getNumUses() >= N.
75 ///
76 bool Value::hasNUsesOrMore(unsigned N) const {
77   use_const_iterator UI = use_begin(), E = use_end();
78
79   for (; N; --N, ++UI)
80     if (UI == E) return false;  // Too few.
81
82   return true;
83 }
84
85
86 /// getNumUses - This method computes the number of uses of this Value.  This
87 /// is a linear time operation.  Use hasOneUse or hasNUses to check for specific
88 /// values.
89 unsigned Value::getNumUses() const {
90   return (unsigned)std::distance(use_begin(), use_end());
91 }
92
93 static bool getSymTab(Value *V, ValueSymbolTable *&ST) {
94   ST = 0;
95   if (Instruction *I = dyn_cast<Instruction>(V)) {
96     if (BasicBlock *P = I->getParent())
97       if (Function *PP = P->getParent())
98         ST = &PP->getValueSymbolTable();
99   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
100     if (Function *P = BB->getParent()) 
101       ST = &P->getValueSymbolTable();
102   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
103     if (Module *P = GV->getParent()) 
104       ST = &P->getValueSymbolTable();
105   } else if (Argument *A = dyn_cast<Argument>(V)) {
106     if (Function *P = A->getParent()) 
107       ST = &P->getValueSymbolTable();
108   } else {
109     assert(isa<Constant>(V) && "Unknown value type!");
110     return true;  // no name is setable for this.
111   }
112   return false;
113 }
114
115 std::string Value::getName() const {
116   if (Name == 0) return "";
117   return std::string(Name->getKeyData(),
118                      Name->getKeyData()+Name->getKeyLength());
119 }
120
121 void Value::setName(const std::string &name) {
122   if (name.empty() && !hasName()) return;
123   if (getType() != Type::VoidTy && "Cannot assign a name to void values!");
124   
125   
126   // Get the symbol table to update for this object.
127   ValueSymbolTable *ST;
128   if (getSymTab(this, ST))
129     return;  // Cannot set a name on this value (e.g. constant).
130
131   if (!ST) { // No symbol table to update?  Just do the change.
132     if (name.empty()) {
133       // Free the name for this value.
134       Name->Destroy();
135       Name = 0;
136     } else {
137       if (Name) {
138         // Name isn't changing.
139         if (name.size() == Name->getKeyLength() &&
140             !memcmp(Name->getKeyData(), &name[0], name.size()))
141           return;
142         Name->Destroy();
143       }
144       
145       // Create the new name.
146       Name = ValueName::Create(&name[0], &name[name.size()]);
147       Name->setValue(this);
148     }
149     return;
150   }
151   
152   // NOTE: Could optimize for the case the name is shrinking to not deallocate
153   // then reallocated.
154   if (hasName()) {
155     // Name isn't changing?
156     if (name.size() == Name->getKeyLength() &&
157         !memcmp(Name->getKeyData(), &name[0], name.size()))
158       return;
159
160     // Remove old name.
161     ST->removeValueName(Name);
162     Name->Destroy();
163     Name = 0;
164
165     if (name.empty())
166        return;
167   }
168
169   // Name is changing to something new.
170   Name = ST->createValueName(&name[0], name.size(), this);
171 }
172
173 /// takeName - transfer the name from V to this value, setting V's name to
174 /// empty.  It is an error to call V->takeName(V). 
175 void Value::takeName(Value *V) {
176   if (!V->hasName()) {
177     if (hasName())
178       setName("");
179     return;
180   }
181   
182   std::string Name = V->getName();
183   V->setName("");
184   setName(Name);
185 }
186
187
188 // uncheckedReplaceAllUsesWith - This is exactly the same as replaceAllUsesWith,
189 // except that it doesn't have all of the asserts.  The asserts fail because we
190 // are half-way done resolving types, which causes some types to exist as two
191 // different Type*'s at the same time.  This is a sledgehammer to work around
192 // this problem.
193 //
194 void Value::uncheckedReplaceAllUsesWith(Value *New) {
195   while (!use_empty()) {
196     Use &U = *UseList;
197     // Must handle Constants specially, we cannot call replaceUsesOfWith on a
198     // constant!
199     if (Constant *C = dyn_cast<Constant>(U.getUser())) {
200       if (!isa<GlobalValue>(C))
201         C->replaceUsesOfWithOnConstant(this, New, &U);
202       else
203         U.set(New);
204     } else {
205       U.set(New);
206     }
207   }
208 }
209
210 void Value::replaceAllUsesWith(Value *New) {
211   assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
212   assert(New != this && "this->replaceAllUsesWith(this) is NOT valid!");
213   assert(New->getType() == getType() &&
214          "replaceAllUses of value with new value of different type!");
215
216   uncheckedReplaceAllUsesWith(New);
217 }
218
219 //===----------------------------------------------------------------------===//
220 //                                 User Class
221 //===----------------------------------------------------------------------===//
222
223 // replaceUsesOfWith - Replaces all references to the "From" definition with
224 // references to the "To" definition.
225 //
226 void User::replaceUsesOfWith(Value *From, Value *To) {
227   if (From == To) return;   // Duh what?
228
229   assert(!isa<Constant>(this) || isa<GlobalValue>(this) &&
230          "Cannot call User::replaceUsesofWith on a constant!");
231
232   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
233     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
234       // The side effects of this setOperand call include linking to
235       // "To", adding "this" to the uses list of To, and
236       // most importantly, removing "this" from the use list of "From".
237       setOperand(i, To); // Fix it now...
238     }
239 }
240