export more serializer interface to allow for finer grain testing
[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() :
54     module_(NULL)
55 {
56 }
57
58 Aggregate::Aggregate(Symbol *sym) :
59     module_(NULL)
60 {
61     assert(sym);
62     module_ = sym->getModule();
63     symbols_.push_back(sym);
64     mangledNames_.push_back(sym->getMangledName());
65     prettyNames_.push_back(sym->getPrettyName());
66     typedNames_.push_back(sym->getTypedName());
67 }
68
69
70 Offset Aggregate::getOffset() const 
71
72         return getFirstSymbol()->getOffset();
73 }
74
75 unsigned Aggregate::getSize() const 
76
77         return getFirstSymbol()->getSize(); 
78 }
79
80 Region * Aggregate::getRegion() const
81 {
82         return getFirstSymbol()->getRegion();
83 }
84
85 const vector<std::string> &Aggregate::getAllMangledNames() 
86 {
87     return mangledNames_;
88 }
89
90 const vector<std::string> &Aggregate::getAllPrettyNames() 
91 {
92     return prettyNames_;
93 }
94
95 const vector<std::string> &Aggregate::getAllTypedNames() 
96 {
97     return typedNames_;
98 }
99
100 bool Aggregate::addSymbol(Symbol *sym) {
101
102     // We keep a "primary" module, which is defined as "anything not DEFAULT_MODULE".
103     if (module_ == NULL) {
104         module_ = sym->getModule();
105     }
106     else if (module_->fileName() == "DEFAULT_MODULE") {
107         module_ = sym->getModule();
108     }
109     // else keep current module.
110
111     symbols_.push_back(sym);
112
113     // We need to add the symbol names (if they aren't there already)
114     // We can have multiple identical names - for example, there are
115     // often two symbols for main (static and dynamic symbol table)
116     
117     bool found = false;
118     for (unsigned j = 0; j < mangledNames_.size(); j++) {
119         if (sym->getMangledName() == mangledNames_[j]) {
120             found = true;
121             break;
122         }
123     }
124     if (!found) mangledNames_.push_back(sym->getMangledName());
125
126     found = false;
127
128     for (unsigned j = 0; j < prettyNames_.size(); j++) {
129         if (sym->getPrettyName() == prettyNames_[j]) {
130             found = true;
131             break;
132         }
133     }
134     if (!found) prettyNames_.push_back(sym->getPrettyName());
135
136     found = false;
137     for (unsigned j = 0; j < typedNames_.size(); j++) {
138         if (sym->getTypedName() == typedNames_[j]) {
139             found = true;
140             break;
141         }
142     }
143     if (!found) typedNames_.push_back(sym->getTypedName());;
144
145     return true;
146 }
147
148 bool Aggregate::removeSymbolInt(Symbol *sym) {
149     std::vector<Symbol *>::iterator iter;
150     for (iter = symbols_.begin(); iter != symbols_.end(); iter++) {
151         if ((*iter) == sym) {
152             symbols_.erase(iter);
153             break;
154         }
155     }
156     return true;
157 }
158
159 bool Aggregate::getSymbols(std::vector<Symbol *> &syms) const 
160 {
161     syms = symbols_;
162     return true;
163 }
164
165 Symbol * Aggregate::getFirstSymbol() const
166 {
167     assert( symbols_.size()>0 );
168     return symbols_[0];
169 }
170
171 SYMTAB_EXPORT bool Aggregate::addMangledName(string name, bool isPrimary) 
172  {
173     // Check to see if we're duplicating
174     for (unsigned i = 0; i < mangledNames_.size(); i++) {
175         if (mangledNames_[i] == name)
176             return false;
177     }
178
179     if (isPrimary) {
180         std::vector<std::string>::iterator iter = mangledNames_.begin();
181         mangledNames_.insert(iter, name);
182     }
183     else
184         mangledNames_.push_back(name);
185
186     if (addMangledNameInt(name, isPrimary) == false) return false;
187      return true;
188  }                                                                                                                                      
189  
190  SYMTAB_EXPORT bool Aggregate::addPrettyName(string name, bool isPrimary) 
191  {
192     // Check to see if we're duplicating
193     for (unsigned i = 0; i < prettyNames_.size(); i++) {
194         if (prettyNames_[i] == name)
195             return false;
196     }
197
198     if (isPrimary) {
199         std::vector<std::string>::iterator iter = prettyNames_.begin();
200         prettyNames_.insert(iter, name);
201     }
202     else
203         prettyNames_.push_back(name);
204     if (addPrettyNameInt(name, isPrimary) == false) return false;
205      return true;
206  }                                                                                                                                      
207  
208  SYMTAB_EXPORT bool Aggregate::addTypedName(string name, bool isPrimary) 
209  {
210     // Check to see if we're duplicating
211     for (unsigned i = 0; i < typedNames_.size(); i++) {
212         if (typedNames_[i] == name)
213             return false;
214     }
215     if (addTypedNameInt(name, isPrimary) == false) return false;
216
217     if (isPrimary) {
218         std::vector<std::string>::iterator iter = typedNames_.begin();
219         typedNames_.insert(iter, name);
220     }
221     else
222         typedNames_.push_back(name);
223         return true;
224  }
225
226 bool Aggregate::addMangledNameInt(string name, bool isPrimary) {
227     // Check to see if we're duplicating
228     for (unsigned i = 0; i < mangledNames_.size(); i++) {
229         if (mangledNames_[i] == name)
230             return false;
231     }
232
233     if (isPrimary) {
234         std::vector<std::string>::iterator iter = mangledNames_.begin();
235         mangledNames_.insert(iter, name);
236     }
237     else
238         mangledNames_.push_back(name);
239     return true;
240 }
241
242 bool Aggregate::addPrettyNameInt(string name, bool isPrimary) {
243     // Check to see if we're duplicating
244     for (unsigned i = 0; i < prettyNames_.size(); i++) {
245         if (prettyNames_[i] == name)
246             return false;
247     }
248
249     if (isPrimary) {
250         std::vector<std::string>::iterator iter = prettyNames_.begin();
251         prettyNames_.insert(iter, name);
252     }
253     else
254         prettyNames_.push_back(name);
255     return true;
256 }
257
258 bool Aggregate::addTypedNameInt(string name, bool isPrimary) {
259     // Check to see if we're duplicating
260     for (unsigned i = 0; i < typedNames_.size(); i++) {
261         if (typedNames_[i] == name)
262             return false;
263     }
264
265     if (isPrimary) {
266         std::vector<std::string>::iterator iter = typedNames_.begin();
267         typedNames_.insert(iter, name);
268     }
269     else
270         typedNames_.push_back(name);
271     return true;
272 }
273
274 bool Aggregate::changeSymbolOffset(Symbol *sym) 
275 {
276     Offset oldOffset = getOffset();
277
278     removeSymbolInt(sym);
279
280     if (symbols_.empty()) 
281         {
282         // This was the only one; so add it back in and update our address
283         // in the Symtab.
284         symbols_.push_back(sym);
285         module_->exec()->changeAggregateOffset(this, oldOffset, getOffset());
286     }
287     else 
288         {
289         module_->exec()->addSymbolToAggregates(sym);
290     }
291     return true;
292 }
293
294 void Aggregate::restore_type_by_id(SerializerBase *sb, Type *&t, 
295                 unsigned t_id) THROW_SPEC (SerializerError)
296 {
297         if (module_)
298         {
299                 typeCollection *tc = module_->getModuleTypesPrivate();
300                 if (tc)
301                 {
302                         t = tc->findType(t_id);
303                         if (!t)
304                         {
305                                 //fprintf(stderr, "%s[%d]: failed to find type in module(%s) collection\n", 
306                                 //              FILE__, __LINE__, module_->fileName().c_str());
307                         }
308                 }
309                 else
310                 {
311                         fprintf(stderr, "%s[%d]:  no types for module\n", FILE__, __LINE__);
312                 }
313         }
314         else
315         {
316                 fprintf(stderr, "%s[%d]:  bad deserialization order??\n", FILE__, __LINE__);
317                 //SER_ERR("FIXME");
318         }
319
320         if (!t)
321         {
322                 ScopedSerializerBase<Symtab> *ssb = dynamic_cast<ScopedSerializerBase<Symtab> *>(sb);
323
324                 if (!ssb)
325                 {
326                         fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
327                         SER_ERR("FIXME");
328                 }
329
330                 Symtab *st = ssb->getScope();
331
332                 if (!st)
333                 {
334                         fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
335                         SER_ERR("FIXME");
336                 }
337
338                 t = st->findType(t_id);
339
340                 if (!t)
341                 {
342                         //  This should probably throw, but let's play nice for now
343                         fprintf(stderr, "%s[%d]:  FIXME: cannot find type with id %d\n", FILE__, __LINE__, t_id);
344                         std::vector<Module *> mods;
345                         if (!st->getAllModules(mods))
346                         {
347                                 fprintf(stderr, "%s[%d]:  failed to get all modules\n", FILE__, __LINE__);
348                         }
349                         for (unsigned int i = 0; i < mods.size(); ++i)
350                         {
351                                 std::vector<Type *> *modtypes = mods[i]->getAllTypes();
352                                 fprintf(stderr, "%s[%d]:  module %s has %lu types\n", FILE__, __LINE__, mods[i]->fileName().c_str(), modtypes ? modtypes->size() : -1);
353                                 if (mods[i]->getModuleTypesPrivate()->findType(t_id))
354                                         fprintf(stderr, "%s[%d]:  found type %d in mod %s\n", FILE__, __LINE__, t_id, mods[i]->fileName().c_str());
355                         }
356                 }
357         }
358 }
359
360 void Aggregate::restore_module_by_name(SerializerBase *sb,  
361                 std::string &mname) THROW_SPEC (SerializerError)
362 {
363
364         if (!sb)
365         {
366                 fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
367                 SER_ERR("FIXME");
368         }
369
370         Dyninst::ScopedSerializerBase<Dyninst::SymtabAPI::Symtab> *ssb = dynamic_cast<Dyninst::ScopedSerializerBase<Dyninst::SymtabAPI::Symtab> *>(sb);
371
372         if (!ssb)
373         {
374                 fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME: %s\n", FILE__, __LINE__, typeid(sb).name());
375                 SER_ERR("FIXME");
376         }
377
378         Symtab *st = ssb->getScope();
379
380         if (!st)
381         {
382                 fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
383                 SER_ERR("FIXME");
384         }
385
386         if (!st->findModuleByName(module_, mname) || !(module_))
387         {
388                 //  This should probably throw, but let's play nice for now
389                 fprintf(stderr, "%s[%d]:  FIXME: aggregate w/out module\n", FILE__, __LINE__);
390         }
391 }
392
393 void Aggregate::rebuild_symbol_vector(SerializerBase *sb,  
394                 std::vector<Offset> *sym_offsets) THROW_SPEC (SerializerError)
395 {
396         ScopedSerializerBase<Symtab> *ssb = dynamic_cast<ScopedSerializerBase<Symtab> *>(sb);
397
398         if (!ssb)
399         {
400                 //fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
401                 SER_ERR("FIXME");
402         }
403
404         Symtab *st = ssb->getScope();
405
406         if (!st)
407         {
408                 //fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
409                 SER_ERR("FIXME");
410         }
411
412         if (!sym_offsets)
413         {
414                 //  can't have any aggregates w/out symbols
415                 //fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
416                 SER_ERR("FIXME");
417         }
418
419         if (!sym_offsets->size())
420         {
421                 //  can't have any aggregates w/out symbols
422                 //fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
423                 SER_ERR("FIXME");
424         }
425
426         symbols_.resize(sym_offsets->size());
427
428         for (unsigned int i = 0; i < sym_offsets->size(); ++i)
429         {
430                 std::vector<Symbol *> *syms = st->findSymbolByOffset((*sym_offsets)[i]);
431
432                 if (!syms)
433                 {
434                         //  Should throw here, but for now let's just scream
435                         //fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
436                 }
437                 else
438                 {
439                         if (syms->size() > 1)
440                         {
441                                 //fprintf(stderr, "%s[%d]:  SERIOUS:  FIXME\n", FILE__, __LINE__);
442                         }
443
444                         symbols_[i] = (*syms)[0];
445                 }
446
447         }
448 }
449
450 std::ostream &operator<<(std::ostream &os, const Dyninst::SymtabAPI::Aggregate &a)
451 {
452         std::string modname = a.module_ ? a.module_->fullName() : std::string("no_mod");
453         os   << "Aggregate{"
454                 << " Module=" << modname
455                 << " MangledNames=["; 
456                 for (unsigned int i = 0; i < a.mangledNames_.size(); ++i)
457                 {
458                         os << a.mangledNames_[i];
459                         if ((i + 1) < a.mangledNames_.size())
460                                 os << ", ";
461                 }
462                 os << "]";
463
464                 os << " PrettyNames=["; 
465                 for (unsigned int i = 0; i < a.prettyNames_.size(); ++i)
466                 {
467                         os << a.prettyNames_[i];
468                         if ((i + 1) < a.prettyNames_.size())
469                                 os << ", ";
470                 }
471                 os << "]";
472
473                 os << " TypedNames=["; 
474                 for (unsigned int i = 0; i < a.typedNames_.size(); ++i)
475                 {
476                         os << a.typedNames_[i];
477                         if ((i + 1) < a.typedNames_.size())
478                                 os << ", ";
479                 }
480                 os << "]";
481                 os << " }";
482
483                 return os;
484 }
485
486 void Aggregate::serialize_aggregate(SerializerBase * sb, const char * tag) THROW_SPEC (SerializerError)
487 {
488         std::string modname = module_ ? module_->fullName() : std::string("");
489         std::vector<Offset> sym_offsets;
490         sym_offsets.resize(symbols_.size());
491
492         //fprintf(stderr, "%s[%d]:  serialize_aggregate, module = %p\n", FILE__, __LINE__, module_);
493
494         for (unsigned int i = 0; i < symbols_.size(); ++i)
495         {
496                 assert(symbols_[i]);
497                 sym_offsets[i] = symbols_[i]->offset_;
498         }
499
500         try
501         {
502                 ifxml_start_element(sb, tag);
503                 gtranslate(sb, modname, "moduleName");
504                 //  Arguably we should be able to reconstruct these name lists from the set of 
505                 //  symbols, right?  
506                 gtranslate(sb, mangledNames_, "mangledNameList");
507                 gtranslate(sb, prettyNames_, "prettyNameList");
508                 gtranslate(sb, typedNames_, "typedNameList");
509                 gtranslate(sb, sym_offsets, "symbolOffsetList");
510                 ifxml_end_element(sb, tag);
511
512                 if (sb->isBin() && sb->isInput())
513                         restore_module_by_name(sb, modname);
514
515                 if (sb->isBin() && sb->isInput())
516                         rebuild_symbol_vector(sb, &sym_offsets);
517         }
518         SER_CATCH(tag);
519
520         //fprintf(stderr, "%s[%d]:  serialize_aggregate, module = %p\n", FILE__, __LINE__, module_);
521 }
522
523 bool Aggregate::operator==(const Aggregate &a)
524 {
525         if (mangledNames_.size() != a.mangledNames_.size()) return false;
526         if (prettyNames_.size() != a.prettyNames_.size()) return false;
527         if (typedNames_.size() != a.typedNames_.size()) return false;
528         if (symbols_.size() != a.symbols_.size()) return false;
529         if (module_ && !a.module_) return false;
530         if (!module_ && a.module_) return false;
531         if (module_ && (module_->fullName() != a.module_->fullName())) return false;
532
533         for (unsigned int i = 0; i < mangledNames_.size(); ++i)
534         {
535                 if (mangledNames_[i] != a.mangledNames_[i]) return false;
536         }
537         for (unsigned int i = 0; i < prettyNames_.size(); ++i)
538         {
539                 if (prettyNames_[i] != a.prettyNames_[i]) return false;
540         }
541         for (unsigned int i = 0; i < typedNames_.size(); ++i)
542         {
543                 if (typedNames_[i] != a.typedNames_[i]) return false;
544         }
545         for (unsigned int i = 0; i < symbols_.size(); ++i)
546         {
547                 Symbol *s1 = symbols_[i];
548                 Symbol *s2 = a.symbols_[i];
549                 if (s1 && !s2) return false;
550                 if (!s1 && s2) return false;
551                 if (!s1)
552                         fprintf(stderr, "%s[%d]:  WARN:  NULL Symbol pointer here\n", FILE__, __LINE__);
553                 else
554                 {
555                         //  just compare offset and a couple other params
556                         if (s1->getOffset() != s2->getOffset()) return false;
557                         if (s1->getType() != s2->getType()) return false;
558                         if (s1->getSize() != s2->getSize()) return false;
559                 }
560         }
561
562         return true;
563 }