Implement function/variable/symbol address changing methods.
[dyninst.git] / symtabAPI / src / Aggregate.C
1 /*
2  * Copyright (c) 1996-2007 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
30  */
31
32 #include "Annotatable.h"
33 #include "common/h/serialize.h"
34
35 #include "Symtab.h"
36 #include "symutil.h"
37 #include "Module.h"
38 #include "Collections.h"
39
40 #include "Function.h"
41 #include "Variable.h"
42
43 #include "symtabAPI/src/Object.h"
44
45
46 #include "Aggregate.h"
47 #include "Symbol.h"
48
49 using namespace std;
50 using namespace Dyninst;
51 using namespace Dyninst::SymtabAPI;
52
53 Aggregate::Aggregate(Symbol *sym) :
54     module_(NULL)
55 {
56     assert(sym);
57     module_ = sym->getModule();
58     symbols_.push_back(sym);
59     mangledNames_.push_back(sym->getMangledName());
60     prettyNames_.push_back(sym->getPrettyName());
61     typedNames_.push_back(sym->getTypedName());
62 }
63
64
65 const vector<std::string> &Aggregate::getAllMangledNames() {
66     return mangledNames_;
67 }
68 const vector<std::string> &Aggregate::getAllPrettyNames() {
69     return prettyNames_;
70 }
71 const vector<std::string> &Aggregate::getAllTypedNames() {
72     return typedNames_;
73 }
74
75 bool Aggregate::addSymbol(Symbol *sym) {
76
77     // We keep a "primary" module, which is defined as "anything not DEFAULT_MODULE".
78     if (module_ == NULL) {
79         module_ = sym->getModule();
80     }
81     else if (module_->fileName() == "DEFAULT_MODULE") {
82         module_ = sym->getModule();
83     }
84     // else keep current module.
85
86     symbols_.push_back(sym);
87
88     // We need to add the symbol names (if they aren't there already)
89     // We can have multiple identical names - for example, there are
90     // often two symbols for main (static and dynamic symbol table)
91     
92     bool found = false;
93     for (unsigned j = 0; j < mangledNames_.size(); j++) {
94         if (sym->getMangledName() == mangledNames_[j]) {
95             found = true;
96             break;
97         }
98     }
99     if (!found) mangledNames_.push_back(sym->getMangledName());
100
101     found = false;
102
103     for (unsigned j = 0; j < prettyNames_.size(); j++) {
104         if (sym->getPrettyName() == prettyNames_[j]) {
105             found = true;
106             break;
107         }
108     }
109     if (!found) prettyNames_.push_back(sym->getPrettyName());
110
111     found = false;
112     for (unsigned j = 0; j < typedNames_.size(); j++) {
113         if (sym->getTypedName() == typedNames_[j]) {
114             found = true;
115             break;
116         }
117     }
118     if (!found) typedNames_.push_back(sym->getTypedName());;
119
120     return true;
121 }
122
123 bool Aggregate::removeSymbolInt(Symbol *sym) {
124     std::vector<Symbol *>::iterator iter;
125     for (iter = symbols_.begin(); iter != symbols_.end(); iter++) {
126         if ((*iter) == sym) {
127             symbols_.erase(iter);
128             break;
129         }
130     }
131     return true;
132 }
133
134 bool Aggregate::getSymbols(std::vector<Symbol *> &syms) const 
135 {
136     syms = symbols_;
137     return true;
138 }
139
140 Symbol * Aggregate::getFirstSymbol() const
141 {
142     assert( symbols_.size()>0 );
143     return symbols_[0];
144 }
145
146 SYMTAB_EXPORT bool Aggregate::addMangledName(string name, bool isPrimary) 
147  {
148     // Check to see if we're duplicating
149     for (unsigned i = 0; i < mangledNames_.size(); i++) {
150         if (mangledNames_[i] == name)
151             return false;
152     }
153
154     if (isPrimary) {
155         std::vector<std::string>::iterator iter = mangledNames_.begin();
156         mangledNames_.insert(iter, name);
157     }
158     else
159         mangledNames_.push_back(name);
160
161     if (addMangledNameInt(name, isPrimary) == false) return false;
162      return true;
163  }                                                                                                                                      
164  
165  SYMTAB_EXPORT bool Aggregate::addPrettyName(string name, bool isPrimary) 
166  {
167     // Check to see if we're duplicating
168     for (unsigned i = 0; i < prettyNames_.size(); i++) {
169         if (prettyNames_[i] == name)
170             return false;
171     }
172
173     if (isPrimary) {
174         std::vector<std::string>::iterator iter = prettyNames_.begin();
175         prettyNames_.insert(iter, name);
176     }
177     else
178         prettyNames_.push_back(name);
179     if (addPrettyNameInt(name, isPrimary) == false) return false;
180      return true;
181  }                                                                                                                                      
182  
183  SYMTAB_EXPORT bool Aggregate::addTypedName(string name, bool isPrimary) 
184  {
185     // Check to see if we're duplicating
186     for (unsigned i = 0; i < typedNames_.size(); i++) {
187         if (typedNames_[i] == name)
188             return false;
189     }
190     if (addTypedNameInt(name, isPrimary) == false) return false;
191
192     if (isPrimary) {
193         std::vector<std::string>::iterator iter = typedNames_.begin();
194         typedNames_.insert(iter, name);
195     }
196     else
197         typedNames_.push_back(name);
198         return true;
199  }
200
201 bool Aggregate::addMangledNameInt(string name, bool isPrimary) {
202     // Check to see if we're duplicating
203     for (unsigned i = 0; i < mangledNames_.size(); i++) {
204         if (mangledNames_[i] == name)
205             return false;
206     }
207
208     if (isPrimary) {
209         std::vector<std::string>::iterator iter = mangledNames_.begin();
210         mangledNames_.insert(iter, name);
211     }
212     else
213         mangledNames_.push_back(name);
214     return true;
215 }
216
217 bool Aggregate::addPrettyNameInt(string name, bool isPrimary) {
218     // Check to see if we're duplicating
219     for (unsigned i = 0; i < prettyNames_.size(); i++) {
220         if (prettyNames_[i] == name)
221             return false;
222     }
223
224     if (isPrimary) {
225         std::vector<std::string>::iterator iter = prettyNames_.begin();
226         prettyNames_.insert(iter, name);
227     }
228     else
229         prettyNames_.push_back(name);
230     return true;
231 }
232
233 bool Aggregate::addTypedNameInt(string name, bool isPrimary) {
234     // Check to see if we're duplicating
235     for (unsigned i = 0; i < typedNames_.size(); i++) {
236         if (typedNames_[i] == name)
237             return false;
238     }
239
240     if (isPrimary) {
241         std::vector<std::string>::iterator iter = typedNames_.begin();
242         typedNames_.insert(iter, name);
243     }
244     else
245         typedNames_.push_back(name);
246     return true;
247 }
248
249 bool Aggregate::changeSymbolOffset(Symbol *sym) {
250     Offset oldOffset = getOffset();
251
252     removeSymbolInt(sym);
253
254     if (symbols_.empty()) {
255         // This was the only one; so add it back in and update our address
256         // in the Symtab.
257         symbols_.push_back(sym);
258         module_->exec()->changeAggregateOffset(this, oldOffset, getOffset());
259     }
260     else {
261         module_->exec()->addSymbolToAggregates(sym);
262     }
263     return true;
264 }