Fix problem with DWARF adding line info to wrong modules
[dyninst.git] / symtabAPI / src / Module.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 * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
29  */
30
31 #include <string.h>
32
33 #include "Annotatable.h"
34 #include "Module.h"
35 #include "Symtab.h"
36 #include "Collections.h"
37 #include "Function.h"
38
39 #include "common/h/pathName.h"
40
41 using namespace Dyninst;
42 using namespace Dyninst::SymtabAPI;
43 using namespace std;
44
45 static AnnotationClass<LineInformation> ModuleLineInfoAnno(std::string("ModuleLineInfoAnno"));
46 static AnnotationClass<typeCollection> ModuleTypeInfoAnno(std::string("ModuleTypeInfoAnno"));
47 static SymtabError serr;
48
49 bool Module::findSymbolByType(std::vector<Symbol *> &found, 
50       const std::string name,
51       Symbol::SymbolType sType, 
52       bool isMangled,
53       bool isRegex, 
54       bool checkCase)
55 {
56    unsigned orig_size = found.size();
57    std::vector<Symbol *> obj_syms;
58
59    if (!exec()->findSymbolByType(obj_syms, name, sType, isMangled, isRegex, checkCase))
60    {
61       //fprintf(stderr, "%s[%d]:  no symbols matching %s found\n", FILE__, __LINE__, name.c_str());
62       return false;
63    }
64
65    for (unsigned i = 0; i < obj_syms.size(); i++)  
66    {
67       if (obj_syms[i]->getModule() == this)
68          found.push_back(obj_syms[i]);
69 #if 0
70       else 
71       {
72          if (obj_syms[i]->getName() == name) {
73             fprintf(stderr, "%s[%d]:  found symbol %s in different module %s not %s\n", 
74                   FILE__, __LINE__, name.c_str(), 
75                   obj_syms[i]->getModule()->fileName().c_str(), 
76                   this->fileName().c_str());
77          }
78       }
79 #endif
80    }
81
82    if (found.size() > orig_size) 
83       return true;
84
85    return false;        
86 }
87
88 const std::string &Module::fileName() const
89 {
90    return fileName_;
91 }
92
93 const std::string &Module::fullName() const
94 {
95    return fullName_;
96 }
97
98  Symtab *Module::exec() const
99 {
100    return exec_;
101 }
102
103 supportedLanguages Module::language() const
104 {
105    return language_;
106 }
107
108 bool Module::hasLineInformation()
109 {
110    LineInformation *li =  NULL;
111    if (getAnnotation(li, ModuleLineInfoAnno)) 
112    {
113       if (!li) 
114       {
115          fprintf(stderr, "%s[%d]:  weird inconsistency with getAnnotation here\n", 
116                FILE__, __LINE__);
117          return false;
118       }
119
120       if (li->getSize())
121       {
122          return true;
123       }
124    }
125
126    return false;
127 #if 0
128    Annotatable<LineInformation *, module_line_info_a,  true> &liA = *this;
129    return ( 0 != liA.size());
130 #endif
131 }
132
133 LineInformation *Module::getLineInformation()
134 {
135    if (!exec_->isLineInfoValid_)
136       exec_->parseLineInformation();
137
138    if (!exec_->isLineInfoValid_) 
139    {
140       return NULL;
141    }
142
143    LineInformation *li =  NULL;
144    if (getAnnotation(li, ModuleLineInfoAnno)) 
145    {
146       if (!li) 
147       {
148          fprintf(stderr, "%s[%d]:  weird inconsistency with getAnnotation here\n", 
149                FILE__, __LINE__);
150          return NULL;
151       }
152
153       if (!li->getSize())
154       {
155          return NULL;
156       }
157    }
158
159    return li;
160 }
161
162 bool Module::getAddressRanges(std::vector<pair<Offset, Offset> >&ranges,
163       std::string lineSource, unsigned int lineNo)
164 {
165    unsigned int originalSize = ranges.size();
166
167    LineInformation *lineInformation = getLineInformation();
168    if (lineInformation)
169       lineInformation->getAddressRanges( lineSource.c_str(), lineNo, ranges );
170
171    if ( ranges.size() != originalSize )
172       return true;
173
174    return false;
175 }
176
177 bool Module::getSourceLines(std::vector<LineNoTuple> &lines, Offset addressInRange)
178 {
179    unsigned int originalSize = lines.size();
180
181    LineInformation *lineInformation = getLineInformation();
182    if (lineInformation)
183       lineInformation->getSourceLines( addressInRange, lines );
184
185    if ( lines.size() != originalSize )
186       return true;
187
188    return false;
189 }
190
191 vector<Type *> *Module::getAllTypes()
192 {
193    typeCollection *tc = NULL;
194    if (!getAnnotation(tc, ModuleTypeInfoAnno))
195    {
196 #if 0
197       tc = new typeCollection();
198       if (!addAnnotation(tc, ModuleTypeInfoAnno))
199       {
200          fprintf(stderr, "%s[%d]:  failed to addAnnotation here\n", FILE__, __LINE__);
201          return NULL;
202       }
203 #endif
204       return NULL;
205    }
206    if (!tc)
207    {
208       fprintf(stderr, "%s[%d]:  failed to addAnnotation here\n", FILE__, __LINE__);
209       return NULL;
210    }
211
212    return tc->getAllTypes();
213 }
214
215 vector<pair<string, Type *> > *Module::getAllGlobalVars()
216 {
217
218    typeCollection *tc = NULL;
219    if (!getAnnotation(tc, ModuleTypeInfoAnno))
220    {
221 #if 0
222       tc = new typeCollection();
223       if (!addAnnotation(tc, ModuleTypeInfoAnno))
224       {
225          fprintf(stderr, "%s[%d]:  failed to addAnnotation here\n", FILE__, __LINE__);
226          return NULL;
227       }
228 #endif
229       return NULL;
230    }
231    if (!tc)
232    {
233       fprintf(stderr, "%s[%d]:  failed to addAnnotation here\n", FILE__, __LINE__);
234       return NULL;
235    }
236
237    return tc->getAllGlobalVariables();
238 }
239
240 typeCollection *Module::getModuleTypes()
241 {
242    typeCollection *tc = NULL;
243    if (!getAnnotation(tc, ModuleTypeInfoAnno))
244    {
245       //  add an empty type collection (to be filled in later)
246       tc = new typeCollection();
247       if (!addAnnotation(tc, ModuleTypeInfoAnno))
248       {
249          fprintf(stderr, "%s[%d]:  failed to addAnnotation here\n", FILE__, __LINE__);
250          return NULL;
251       }
252
253       return tc;
254    }
255
256    if (!tc)
257    {
258       fprintf(stderr, "%s[%d]:  failed to addAnnotation here\n", FILE__, __LINE__);
259       return NULL;
260    }
261
262    return tc;
263 }
264
265 bool Module::findType(Type *&type, std::string name)
266 {
267    exec_->parseTypesNow();
268    type = getModuleTypes()->findType(name);
269
270    if (type == NULL)
271       return false;
272
273    return true;
274 }
275
276 bool Module::findVariableType(Type *&type, std::string name)
277 {
278    exec_->parseTypesNow();
279    type = getModuleTypes()->findVariableType(name);
280
281    if (type == NULL)
282       return false;
283
284    return true;
285 }
286
287 void Symtab::parseTypesNow()
288 {
289    if (isTypeInfoValid_)
290       return;
291
292    parseTypes();
293 }
294
295 bool Module::setLineInfo(LineInformation *lineInfo)
296 {
297    LineInformation *li =  NULL;
298
299    if (!getAnnotation(li, ModuleLineInfoAnno)) 
300    {
301       if (li) 
302       {
303          return false;
304       }
305
306       if (!addAnnotation(lineInfo, ModuleLineInfoAnno))
307       {
308          return false;
309       }
310
311       return true;
312    }
313    if (li != lineInfo)
314      delete li;
315    
316    if (!addAnnotation(lineInfo, ModuleLineInfoAnno))
317    {
318      fprintf(stderr, "%s[%d]:  failed to add lineInfo annotation\n", FILE__, __LINE__);
319      return false;
320    }
321
322    return false;
323 }
324
325 bool Module::findLocalVariable(std::vector<localVar *>&vars, std::string name)
326 {
327    exec_->parseTypesNow();
328    std::vector<Function *>mod_funcs;
329
330    if (!exec_->getAllFunctions(mod_funcs))
331    {
332       return false;
333    }
334
335    unsigned origSize = vars.size();
336
337    for (unsigned int i = 0; i < mod_funcs.size(); i++)
338    {
339       mod_funcs[i]->findLocalVariable(vars, name);
340    }
341
342    if (vars.size() > origSize)
343       return true;
344
345    return false;
346 }
347
348 Module::Module(supportedLanguages lang, Offset adr,
349       std::string fullNm, Symtab *img) :
350    fullName_(fullNm),
351    language_(lang),
352    addr_(adr),
353    exec_(img)
354 {
355    fileName_ = extract_pathname_tail(fullNm);
356 }
357
358 Module::Module() :
359    fileName_(""),
360    fullName_(""),
361    language_(lang_Unknown),
362    addr_(0),
363    exec_(NULL)
364 {
365 }
366
367 Module::Module(const Module &mod) :
368    LookupInterface(),
369    Serializable(),
370    AnnotatableSparse(),
371    fileName_(mod.fileName_),
372    fullName_(mod.fullName_),
373    language_(mod.language_),
374    addr_(mod.addr_),
375    exec_(mod.exec_)
376 {
377    //  Copy annotations here or no?
378 }
379
380 Module::~Module()
381 {
382
383    //  individual deletion of annotations??
384
385 #if 0
386    if (!clearAnnotations()) 
387    {
388       fprintf(stderr, "%s[%d]:  failed to clear annotations\n", FILE__, __LINE__);
389    }
390 #endif
391    //fprintf(stderr, "%s[%d]:  FIXME:  need to clear annotations??\n", FILE__, __LINE__);
392
393 }
394
395 bool Module::isShared() const
396 {
397    return !exec_->isExec();
398 }
399
400 bool Module::getAllSymbolsByType(std::vector<Symbol *> &found, Symbol::SymbolType sType)
401 {
402    unsigned orig_size = found.size();
403    std::vector<Symbol *> obj_syms;
404
405    if (!exec()->getAllSymbolsByType(obj_syms, sType))
406       return false;
407
408    for (unsigned i = 0; i < obj_syms.size(); i++) 
409    {
410       if (obj_syms[i]->getModule() == this)
411          found.push_back(obj_syms[i]);
412    }
413
414    if (found.size() > orig_size)
415    {
416       return true;
417    }
418
419    serr = No_Such_Symbol;
420    return false;
421 }
422
423 bool Module::getAllFunctions(std::vector<Function *> &ret)
424 {
425     return exec()->getAllFunctions(ret);
426 }
427
428 bool Module::operator==(Module &mod) 
429 {
430    LineInformation *li =  NULL;
431    LineInformation *li_src =  NULL;
432    bool get_anno_res = false, get_anno_res_src = false;
433    get_anno_res = getAnnotation(li, ModuleLineInfoAnno);
434    get_anno_res_src = mod.getAnnotation(li_src, ModuleLineInfoAnno);
435
436    if (get_anno_res != get_anno_res_src)
437    {
438       fprintf(stderr, "%s[%d]:  weird inconsistency with getAnnotation here\n", 
439             FILE__, __LINE__);
440       return false;
441    }
442
443    if (li) 
444    {
445       if (!li_src) 
446       {
447          fprintf(stderr, "%s[%d]:  weird inconsistency with getAnnotation here\n", 
448                FILE__, __LINE__);
449          return false;
450       }
451
452       if (li->getSize() != li_src->getSize()) 
453          return false;
454
455       if ((li != li_src)) 
456          return false;
457    }
458    else
459    {
460       if (li_src) 
461       {
462          fprintf(stderr, "%s[%d]:  weird inconsistency with getAnnotation here\n", 
463                FILE__, __LINE__);
464          return false;
465       }
466    }
467
468    return (
469          (language_==mod.language_)
470          && (addr_==mod.addr_)
471          && (fullName_==mod.fullName_)
472          && (exec_==mod.exec_)
473          );
474 }
475
476 bool Module::setName(std::string newName)
477 {
478    fullName_ = newName;
479    fileName_ = extract_pathname_tail(fullName_);
480    return true;
481 }
482
483 void Module::setLanguage(supportedLanguages lang)
484 {
485    language_ = lang;
486 }
487
488 Offset Module::addr() const
489 {
490    return addr_;
491 }
492
493 bool Module::setDefaultNamespacePrefix(string str)
494 {
495     return exec_->setDefaultNamespacePrefix(str);
496 }
497
498 void Module::serialize(SerializerBase *sb, const char *tag)
499 {
500    ifxml_start_element(sb, tag);
501    gtranslate(sb, fileName_, "fileName");
502    gtranslate(sb, fullName_, "fullName");
503    gtranslate(sb, addr_, "Address");
504    gtranslate(sb, language_, supportedLanguages2Str, "Language");
505    ifxml_end_element(sb, tag);
506
507    //  Patch up exec_ (pointer to Symtab) at a higher level??
508    //if (getSD().iomode() == sd_deserialize)
509    //   param.exec_ = parent_symtab;
510 }
511