Add debugging to make a more useful message if a value gets constructed with a null...
[oota-llvm.git] / lib / VMCore / Value.cpp
1 //===-- Value.cpp - Implement the Value class -----------------------------===//
2 //
3 // This file implements the Value, User, and SymTabValue classes. 
4 //
5 //===----------------------------------------------------------------------===//
6
7 #include "llvm/ValueHolderImpl.h"
8 #include "llvm/InstrTypes.h"
9 #include "llvm/SymbolTable.h"
10 #include "llvm/SymTabValue.h"
11 #include "llvm/Type.h"
12 #ifndef NDEBUG      // Only in -g mode...
13 #include "llvm/Assembly/Writer.h"
14 #endif
15 #include <algorithm>
16
17 //===----------------------------------------------------------------------===//
18 //                                Value Class
19 //===----------------------------------------------------------------------===//
20
21 static inline const Type *checkType(const Type *Ty) {
22   assert(Ty && "Value defined with a null type: Error!");
23   return Ty;
24 }
25
26 Value::Value(const Type *ty, ValueTy vty, const string &name = "")
27   : Name(name), Ty(checkType(ty), this) {
28   VTy = vty;
29 }
30
31 Value::~Value() {
32 #ifndef NDEBUG      // Only in -g mode...
33   // Check to make sure that there are no uses of this value that are still
34   // around when the value is destroyed.  If there are, then we have a dangling
35   // reference and something is wrong.  This code is here to print out what is
36   // still being referenced.  The value in question should be printed as 
37   // a <badref>
38   //
39   if (Uses.begin() != Uses.end()) {
40     cerr << "While deleting: " << this;
41     for (use_const_iterator I = Uses.begin(); I != Uses.end(); ++I)
42       cerr << "Use still stuck around after Def is destroyed:" << *I << endl;
43   }
44 #endif
45   assert(Uses.begin() == Uses.end());
46 }
47
48 void Value::replaceAllUsesWith(Value *D) {
49   assert(D && "Value::replaceAllUsesWith(<null>) is invalid!");
50   assert(D != this && "V->replaceAllUsesWith(V) is NOT valid!");
51   while (!Uses.empty()) {
52     User *Use = Uses.back();
53 #ifndef NDEBUG
54     unsigned NumUses = Uses.size();
55 #endif
56     Use->replaceUsesOfWith(this, D);
57
58 #ifndef NDEBUG      // only in -g mode...
59     if (Uses.size() == NumUses)
60       cerr << "Use: " << Use << "replace with: " << D; 
61 #endif
62     assert(Uses.size() != NumUses && "Didn't remove definition!");
63   }
64 }
65
66 // refineAbstractType - This function is implemented because we use
67 // potentially abstract types, and these types may be resolved to more
68 // concrete types after we are constructed.  For the value class, we simply
69 // change Ty to point to the right type.  :)
70 //
71 void Value::refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
72   assert(Ty.get() == (const Type*)OldTy &&"Can't refine anything but my type!");
73   Ty = NewTy;
74 }
75
76 void Value::killUse(User *i) {
77   if (i == 0) return;
78   use_iterator I = find(Uses.begin(), Uses.end(), i);
79
80   assert(I != Uses.end() && "Use not in uses list!!");
81   Uses.erase(I);
82 }
83
84 User *Value::use_remove(use_iterator &I) {
85   assert(I != Uses.end() && "Trying to remove the end of the use list!!!");
86   User *i = *I;
87   I = Uses.erase(I);
88   return i;
89 }
90
91 #ifndef NDEBUG      // Only in -g mode...
92 void Value::dump() const {
93   cerr << this;
94 }
95 #endif
96
97 //===----------------------------------------------------------------------===//
98 //                                 User Class
99 //===----------------------------------------------------------------------===//
100
101 User::User(const Type *Ty, ValueTy vty, const string &name) 
102   : Value(Ty, vty, name) {
103 }
104
105 // replaceUsesOfWith - Replaces all references to the "From" definition with
106 // references to the "To" definition.
107 //
108 void User::replaceUsesOfWith(Value *From, Value *To) {
109   if (From == To) return;   // Duh what?
110
111   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
112     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
113       // The side effects of this setOperand call include linking to
114       // "To", adding "this" to the uses list of To, and
115       // most importantly, removing "this" from the use list of "From".
116       setOperand(i, To); // Fix it now...
117     }
118 }
119
120
121 //===----------------------------------------------------------------------===//
122 //                             SymTabValue Class
123 //===----------------------------------------------------------------------===//
124
125 SymTabValue::SymTabValue(Value *p) : ValueParent(p) { 
126   assert(ValueParent && "SymTavValue without parent!?!");
127   ParentSymTab = SymTab = 0;
128 }
129
130
131 SymTabValue::~SymTabValue() {
132   delete SymTab;
133 }
134
135 void SymTabValue::setParentSymTab(SymbolTable *ST) {
136   ParentSymTab = ST;
137   if (SymTab) 
138     SymTab->setParentSymTab(ST);
139 }
140
141 SymbolTable *SymTabValue::getSymbolTableSure() {
142   if (!SymTab) SymTab = new SymbolTable(ParentSymTab);
143   return SymTab;
144 }
145
146 // hasSymbolTable() - Returns true if there is a symbol table allocated to
147 // this object AND if there is at least one name in it!
148 //
149 bool SymTabValue::hasSymbolTable() const {
150   if (!SymTab) return false;
151
152   for (SymbolTable::const_iterator I = SymTab->begin(); 
153        I != SymTab->end(); ++I) {
154     if (I->second.begin() != I->second.end())
155       return true;                                // Found nonempty type plane!
156   }
157   
158   return false;
159 }