Merge branch 'master' of legendre@git.dyninst.org:/pub/dyninst
[dyninst.git] / symtabAPI / h / Symtab.h
1 /*
2  * Copyright (c) 1996-2009 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 #ifndef __SYMTAB_H__
33 #define __SYMTAB_H__
34
35 #include <set>
36
37 #include "Symbol.h"
38 #include "Module.h"
39 #include "Region.h"
40
41 #include "Annotatable.h"
42 #include "Serialization.h"
43
44 #include "ProcReader.h"
45
46 class MappedFile;
47
48 namespace Dyninst {
49 namespace SymtabAPI {
50
51 class Archive;
52 class builtInTypeCollection;
53
54 class ExceptionBlock;
55 class Object;
56 class localVar;
57 class relocationEntry;
58 class Type;
59
60 typedef Dyninst::ProcessReader MemRegReader;
61
62 class Symtab : public LookupInterface,
63                public Serializable,
64                public AnnotatableSparse
65 {
66
67    friend class Archive;
68    friend class Symbol;
69    friend class Function;
70    friend class Variable;
71    friend class Module;
72    friend class Region;
73    friend class emitElf;
74    friend class emitElf64;
75    friend class emitElfStatic;
76    friend class emitWin;
77    friend class Aggregate;
78    friend class relocationEntry;
79
80  public:
81
82    /***** Public Member Functions *****/
83    public:
84    SYMTAB_EXPORT Symtab(MappedFile *);
85
86    SYMTAB_EXPORT Symtab();
87
88    SYMTAB_EXPORT Symtab(const Symtab& obj);
89
90    SYMTAB_EXPORT static bool openFile(Symtab *&obj, std::string filename);
91    SYMTAB_EXPORT static bool openFile(Symtab *&obj,char *mem_image, size_t size);
92    SYMTAB_EXPORT static Symtab *findOpenSymtab(std::string filename);
93    SYMTAB_EXPORT static bool closeSymtab(Symtab *);
94
95    SYMTAB_EXPORT Serializable * serialize_impl(SerializerBase *sb, 
96                    const char *tag = "Symtab") THROW_SPEC (SerializerError);
97    void rebuild_symbol_hashes(SerializerBase *);
98    void rebuild_funcvar_hashes(SerializerBase *);
99    void rebuild_module_hashes(SerializerBase *);
100    void rebuild_region_indexes(SerializerBase *) THROW_SPEC(SerializerError);
101    static bool setup_module_up_ptrs(SerializerBase *,Symtab *st);
102    static bool fixup_relocation_symbols(SerializerBase *,Symtab *st);
103
104    SYMTAB_EXPORT bool exportXML(std::string filename);
105    SYMTAB_EXPORT bool exportBin(std::string filename);
106    static Symtab *importBin(std::string filename);
107    SYMTAB_EXPORT bool getRegValueAtFrame(Address pc, 
108                                      Dyninst::MachRegister reg, 
109                                      Dyninst::MachRegisterVal &reg_result,
110                                      MemRegReader *reader);
111    SYMTAB_EXPORT bool hasStackwalkDebugInfo();
112
113    /**************************************
114     *** LOOKUP FUNCTIONS *****************
115     **************************************/
116
117    // Symbol
118
119    SYMTAB_EXPORT virtual bool findSymbol(std::vector<Symbol *> &ret, 
120                                          const std::string name,
121                                          Symbol::SymbolType sType = Symbol::ST_UNKNOWN,
122                                          NameType nameType = anyName,
123                                          bool isRegex = false, 
124                                          bool checkCase = false);
125    SYMTAB_EXPORT virtual bool getAllSymbols(std::vector<Symbol *> &ret);
126    SYMTAB_EXPORT virtual bool getAllSymbolsByType(std::vector<Symbol *> &ret, 
127          Symbol::SymbolType sType);
128
129    std::vector<Symbol *> *findSymbolByOffset(Offset);
130
131    // Return all undefined symbols in the binary. Currently used for finding
132    // the .o's in a static archive that have definitions of these symbols
133    SYMTAB_EXPORT bool getAllUndefinedSymbols(std::vector<Symbol *> &ret);
134
135    // Inversely, return all non-undefined symbols in the binary
136    SYMTAB_EXPORT bool getAllDefinedSymbols(std::vector<Symbol *> &ret);
137
138    // Function
139
140    SYMTAB_EXPORT bool findFuncByEntryOffset(Function *&ret, const Offset offset);
141    SYMTAB_EXPORT bool findFunctionsByName(std::vector<Function *> &ret, const std::string name,
142                                           NameType nameType = anyName, 
143                                           bool isRegex = false,
144                                           bool checkCase = true);
145    SYMTAB_EXPORT bool getAllFunctions(std::vector<Function *>&ret);
146    SYMTAB_EXPORT bool getContainingFunction(Offset offset, Function* &func);
147
148    // Variable
149    SYMTAB_EXPORT bool findVariableByOffset(Variable *&ret, const Offset offset);
150    SYMTAB_EXPORT bool findVariablesByName(std::vector<Variable *> &ret, const std::string name,
151                                           NameType nameType = anyName, 
152                                           bool isRegex = false, 
153                                           bool checkCase = true);
154    SYMTAB_EXPORT bool getAllVariables(std::vector<Variable *> &ret);
155
156    // Module
157
158    SYMTAB_EXPORT bool getAllModules(std::vector<Module *>&ret);
159    SYMTAB_EXPORT bool findModuleByOffset(Module *&ret, Offset off);
160    SYMTAB_EXPORT bool findModuleByName(Module *&ret, const std::string name);
161    SYMTAB_EXPORT Module *getDefaultModule();
162
163    // Region
164
165    SYMTAB_EXPORT bool getCodeRegions(std::vector<Region *>&ret);
166    SYMTAB_EXPORT bool getDataRegions(std::vector<Region *>&ret);
167    SYMTAB_EXPORT bool getAllRegions(std::vector<Region *>&ret);
168    SYMTAB_EXPORT bool getAllNewRegions(std::vector<Region *>&ret);
169    //  change me to use a hash
170    SYMTAB_EXPORT bool findRegion(Region *&ret, std::string regname);
171    SYMTAB_EXPORT bool findRegion(Region *&ret, const Offset addr, const unsigned long size);
172    SYMTAB_EXPORT bool findRegionByEntry(Region *&ret, const Offset offset);
173    SYMTAB_EXPORT Region *findEnclosingRegion(const Offset offset);
174
175    // Exceptions
176    SYMTAB_EXPORT bool findException(ExceptionBlock &excp,Offset addr);
177    SYMTAB_EXPORT bool getAllExceptions(std::vector<ExceptionBlock *> &exceptions);
178    SYMTAB_EXPORT bool findCatchBlock(ExceptionBlock &excp, Offset addr, 
179          unsigned size = 0);
180
181    // Relocation entries
182    SYMTAB_EXPORT bool getFuncBindingTable(std::vector<relocationEntry> &fbt) const;
183    SYMTAB_EXPORT bool updateFuncBindingTable(Offset stub_addr, Offset plt_addr);
184
185    /**************************************
186     *** SYMBOL ADDING FUNCS **************
187     **************************************/
188
189    SYMTAB_EXPORT bool addSymbol(Symbol *newsym);
190    SYMTAB_EXPORT bool addSymbol(Symbol *newSym, Symbol *referringSymbol);
191    SYMTAB_EXPORT Function *createFunction(std::string name, Offset offset, size_t size, Module *mod = NULL);
192    SYMTAB_EXPORT Variable *createVariable(std::string name, Offset offset, size_t size, Module *mod = NULL);
193
194    SYMTAB_EXPORT bool deleteFunction(Function *func);
195    SYMTAB_EXPORT bool deleteVariable(Variable *var);
196
197
198    /*****Query Functions*****/
199    SYMTAB_EXPORT bool isExec() const;
200    SYMTAB_EXPORT bool isStripped();
201    SYMTAB_EXPORT ObjectType getObjectType() const;
202    SYMTAB_EXPORT Dyninst::Architecture getArchitecture();
203    SYMTAB_EXPORT bool isCode(const Offset where) const;
204    SYMTAB_EXPORT bool isData(const Offset where) const;
205    SYMTAB_EXPORT bool isValidOffset(const Offset where) const;
206
207    SYMTAB_EXPORT bool isNativeCompiler() const;
208    SYMTAB_EXPORT bool getMappedRegions(std::vector<Region *> &mappedRegs) const;
209
210    /***** Line Number Information *****/
211    SYMTAB_EXPORT bool getAddressRanges(std::vector<std::pair<Offset, Offset> >&ranges,
212          std::string lineSource, unsigned int LineNo);
213    SYMTAB_EXPORT bool getSourceLines(std::vector<Statement *> &lines, 
214          Offset addressInRange);
215    SYMTAB_EXPORT bool addLine(std::string lineSource, unsigned int lineNo,
216          unsigned int lineOffset, Offset lowInclAddr,
217          Offset highExclAddr);
218    SYMTAB_EXPORT bool addAddressRange(Offset lowInclAddr, Offset highExclAddr, std::string lineSource,
219          unsigned int lineNo, unsigned int lineOffset = 0);
220    SYMTAB_EXPORT void setTruncateLinePaths(bool value);
221    SYMTAB_EXPORT bool getTruncateLinePaths();
222
223    /***** Type Information *****/
224    SYMTAB_EXPORT virtual bool findType(Type *&type, std::string name);
225    SYMTAB_EXPORT virtual Type *findType(unsigned type_id);
226    SYMTAB_EXPORT virtual bool findVariableType(Type *&type, std::string name);
227
228    SYMTAB_EXPORT bool addType(Type *typ);
229
230    SYMTAB_EXPORT static std::vector<Type *> *getAllstdTypes();
231    SYMTAB_EXPORT static std::vector<Type *> *getAllbuiltInTypes();
232
233    SYMTAB_EXPORT void parseTypesNow();
234
235    /***** Local Variable Information *****/
236    SYMTAB_EXPORT bool findLocalVariable(std::vector<localVar *>&vars, std::string name);
237
238    /***** Relocation Sections *****/
239    SYMTAB_EXPORT bool hasRel() const;
240    SYMTAB_EXPORT bool hasRela() const;
241    SYMTAB_EXPORT bool hasReldyn() const;
242    SYMTAB_EXPORT bool hasReladyn() const;
243    SYMTAB_EXPORT bool hasRelplt() const;
244    SYMTAB_EXPORT bool hasRelaplt() const;
245    
246    SYMTAB_EXPORT bool isStaticBinary() const;
247
248    /***** Write Back binary functions *****/
249    SYMTAB_EXPORT bool emitSymbols(Object *linkedFile, std::string filename, unsigned flag = 0);
250    SYMTAB_EXPORT bool addRegion(Offset vaddr, void *data, unsigned int dataSize, 
251          std::string name, Region::RegionType rType_, bool loadable = false,
252          unsigned long memAlign = sizeof(unsigned), bool tls = false);
253    SYMTAB_EXPORT bool addRegion(Region *newreg);
254    SYMTAB_EXPORT bool emit(std::string filename, unsigned flag = 0);
255
256    SYMTAB_EXPORT void addDynLibSubstitution(std::string oldName, std::string newName);
257    SYMTAB_EXPORT std::string getDynLibSubstitution(std::string name);
258
259    SYMTAB_EXPORT bool getSegments(std::vector<Segment> &segs) const;
260    
261    SYMTAB_EXPORT void fixup_code_and_data(Offset newImageOffset,
262                                           Offset newImageLength,
263                                           Offset newDataOffset,
264                                           Offset newDataLength);
265    SYMTAB_EXPORT bool fixup_RegionAddr(const char* name, Offset memOffset, long memSize);
266    SYMTAB_EXPORT bool fixup_SymbolAddr(const char* name, Offset newOffset);
267    SYMTAB_EXPORT bool updateRegion(const char* name, void *buffer, unsigned size);
268    SYMTAB_EXPORT bool updateCode(void *buffer, unsigned size);
269    SYMTAB_EXPORT bool updateData(void *buffer, unsigned size);
270    SYMTAB_EXPORT Offset getFreeOffset(unsigned size);
271
272    SYMTAB_EXPORT bool addLibraryPrereq(std::string libname);
273    SYMTAB_EXPORT bool addSysVDynamic(long name, long value);
274
275    SYMTAB_EXPORT bool addLinkingResource(Archive *library);
276    SYMTAB_EXPORT bool getLinkingResources(std::vector<Archive *> &libs);
277
278    SYMTAB_EXPORT bool addExternalSymbolReference(Symbol *externalSym, Region *localRegion, relocationEntry localRel);
279
280    /***** Data Member Access *****/
281    SYMTAB_EXPORT std::string file() const;
282    SYMTAB_EXPORT std::string name() const;
283    SYMTAB_EXPORT std::string memberName() const;
284
285    SYMTAB_EXPORT char *mem_image() const;
286
287    SYMTAB_EXPORT Offset imageOffset() const;
288    SYMTAB_EXPORT Offset dataOffset() const;
289    SYMTAB_EXPORT Offset dataLength() const;
290    SYMTAB_EXPORT Offset imageLength() const;
291    //   SYMTAB_EXPORT char*  image_ptr ()  const;
292    //   SYMTAB_EXPORT char*  data_ptr ()  const;
293    SYMTAB_EXPORT Offset getInitOffset();
294    SYMTAB_EXPORT Offset getFiniOffset();
295
296    SYMTAB_EXPORT const char*  getInterpreterName() const;
297
298    SYMTAB_EXPORT unsigned getAddressWidth() const;
299    SYMTAB_EXPORT Offset getLoadOffset() const;
300    SYMTAB_EXPORT Offset getEntryOffset() const;
301    SYMTAB_EXPORT Offset getBaseOffset() const;
302    SYMTAB_EXPORT Offset getTOCoffset() const;
303    SYMTAB_EXPORT Address getLoadAddress();
304
305    SYMTAB_EXPORT std::string getDefaultNamespacePrefix() const;
306
307    SYMTAB_EXPORT unsigned getNumberofRegions() const;
308    SYMTAB_EXPORT unsigned getNumberofSymbols() const;
309
310    SYMTAB_EXPORT std::vector<std::string> &getDependencies();
311
312    SYMTAB_EXPORT Archive *getParentArchive() const;
313
314    /***** Error Handling *****/
315    SYMTAB_EXPORT static SymtabError getLastSymtabError();
316    SYMTAB_EXPORT static std::string printError(SymtabError serr);
317
318    SYMTAB_EXPORT ~Symtab();
319
320    bool delSymbol(Symbol *sym) { return deleteSymbol(sym); }
321    bool deleteSymbol(Symbol *sym); 
322
323    static builtInTypeCollection *builtInTypes;
324    static typeCollection *stdTypes;
325
326    Symbol *getSymbolByIndex(unsigned);
327    protected:
328    Symtab(std::string filename, std::string member_name, Offset offset, bool &err, void *base = NULL);
329    Symtab(char *img, size_t size, std::string member_name, Offset offset, bool &err, void *base = NULL);
330
331    /***** Private Member Functions *****/
332    private:
333    SYMTAB_EXPORT Symtab(std::string filename, bool &err); 
334    SYMTAB_EXPORT Symtab(char *mem_image, size_t image_size, bool &err);
335
336    SYMTAB_EXPORT bool extractInfo(Object *linkedFile);
337
338    // Parsing code
339
340    bool extractSymbolsFromFile(Object *linkedFile, std::vector<Symbol *> &raw_syms);
341    bool fixSymModules(std::vector<Symbol *> &raw_syms);
342    bool demangleSymbols(std::vector<Symbol *> &rawsyms);
343    bool createIndices(std::vector<Symbol *> &raw_syms);
344    bool createAggregates();
345
346    bool fixSymModule(Symbol *&sym);
347    bool demangleSymbol(Symbol *&sym);
348    bool addSymbolToIndices(Symbol *&sym);
349    bool addSymbolToAggregates(Symbol *&sym);
350    bool updateIndices(Symbol *sym, std::string newName, NameType nameType);
351
352
353    void setModuleLanguages(dyn_hash_map<std::string, supportedLanguages> *mod_langs);
354
355    void setupTypes();
356    static void setupStdTypes();
357
358    bool buildDemangledName( const std::string &mangled, 
359          std::string &pretty,
360          std::string &typed,
361          bool nativeCompiler, 
362          supportedLanguages lang );
363
364    // Change the type of a symbol after the fact
365    bool changeType(Symbol *sym, Symbol::SymbolType oldType);
366
367    bool changeSymbolOffset(Symbol *sym, Offset newOffset);
368    bool deleteSymbolFromIndices(Symbol *sym);
369
370    bool changeAggregateOffset(Aggregate *agg, Offset oldOffset, Offset newOffset);
371    bool deleteAggregate(Aggregate *agg);
372
373    // Used by binaryEdit.C...
374  public:
375    SYMTAB_EXPORT bool canBeShared();
376    SYMTAB_EXPORT Module *getOrCreateModule(const std::string &modName, 
377                                            const Offset modAddr);
378
379  public:
380    //Only valid on ELF formats
381    SYMTAB_EXPORT Offset getElfDynamicOffset();
382    
383  private:
384    void createDefaultModule();
385
386    Module *newModule(const std::string &name, const Offset addr, supportedLanguages lang);
387    
388    //bool buildFunctionLists(std::vector <Symbol *> &raw_funcs);
389    //void enterFunctionInTables(Symbol *func, bool wasSymtab);
390
391
392    bool addSymtabVariables();
393
394    void checkPPC64DescriptorSymbols(Object *linkedFile);
395
396
397    void parseLineInformation();
398    void parseTypes();
399    bool setDefaultNamespacePrefix(std::string &str);
400
401    bool addUserRegion(Region *newreg);
402    bool addUserType(Type *newtypeg);
403
404    /***** Private Data Members *****/
405    private:
406    std::string member_name_;
407    Offset member_offset_;
408    Archive * parentArchive_;
409    MappedFile *mf;
410    MappedFile *mfForDebugInfo;
411
412    Offset imageOffset_;
413    unsigned imageLen_;
414    Offset dataOffset_;
415    unsigned dataLen_;
416
417    bool is_a_out;
418    Offset main_call_addr_; // address of call to main()
419
420    bool nativeCompiler;
421
422    unsigned address_width_;
423    char *code_ptr_;
424    char *data_ptr_;
425    std::string interpreter_name_;
426    Offset entry_address_;
427    Offset base_address_;
428    Offset load_address_;
429    Offset toc_offset_;
430    ObjectType object_type_;
431    bool is_eel_;
432    std::vector<Segment> segments_;
433    //  make sure is_a_out is set before calling symbolsToFunctions
434
435    // A std::vector of all Symtabs. Used to avoid duplicating
436    // a Symtab that already exists.
437    static std::vector<Symtab *> allSymtabs;
438    std::string defaultNamespacePrefix;
439
440    //sections
441    unsigned no_of_sections;
442    std::vector<Region *> regions_;
443    std::vector<Region *> codeRegions_;
444    std::vector<Region *> dataRegions_;
445    dyn_hash_map <Offset, Region *> regionsByEntryAddr;
446
447    //Point where new loadable sections will be inserted
448    unsigned newSectionInsertPoint;
449
450    //symbols
451    unsigned no_of_symbols;
452
453    // Indices
454
455    std::vector<Symbol *> everyDefinedSymbol;
456    // Subset of the above
457    std::vector<Symbol *> userAddedSymbols;
458    // hashtable for looking up undefined symbols in the dynamic symbol
459    // tale. Entries are referred by the relocation table entries
460    // NOT a subset of everyDefinedSymbol
461    std::map <std::string, std::vector<Symbol *> > undefDynSyms;
462
463    // Symbols by offsets in the symbol table
464    dyn_hash_map <Offset, std::vector<Symbol *> > symsByOffset;
465
466    // The raw name from the symbol table
467    dyn_hash_map <std::string, std::vector<Symbol *> > symsByMangledName;
468
469    // The name after we've run it through the demangler
470    dyn_hash_map <std::string, std::vector<Symbol *> > symsByPrettyName;
471
472    // The name after we've derived the parameter types
473    dyn_hash_map <std::string, std::vector<Symbol *> > symsByTypedName;
474
475    // We also need per-Aggregate indices
476    bool sorted_everyFunction;
477    std::vector<Function *> everyFunction;
478    // Since Functions are unique by address we require this structure to
479    // efficiently track them.
480    dyn_hash_map <Offset, Function *> funcsByOffset;
481
482    // Similar for Variables
483    std::vector<Variable *> everyVariable;
484    dyn_hash_map <Offset, Variable *> varsByOffset;
485
486    // For now, skip the index-by-name structures. We can use the Symbol
487    // ones instead. 
488    /*
489    dyn_hash_map <std::string, std::vector<Function *> *> funcsByMangledName;
490    dyn_hash_map <std::string, std::vector<Function *> *> funcsByPrettyName;
491    dyn_hash_map <std::string, std::vector<Function *> *> funcsByTypedName;
492    */
493
494    //dyn_hash_map <Offset, std::vector<Function *> > funcsByEntryAddr;
495    // note, a prettyName is not unique, it may map to a function appearing
496    // in several modules.  Also only contains instrumentable functions....
497    //dyn_hash_map <std::string, std::vector<Function *>*> funcsByPretty;
498    // Hash table holding functions by mangled name.
499    // Should contain same functions as funcsByPretty....
500    //dyn_hash_map <std::string, std::vector<Function *>*> funcsByMangled;
501    // A way to iterate over all the functions efficiently
502    //std::vector<Symbol *> everyUniqueFunction;
503    //std::vector<Function *> allFunctions;
504    // And the counterpart "ones that are there right away"
505    //std::vector<Symbol *> exportedFunctions;
506
507    //dyn_hash_map <Address, Function *> funcsByAddr;
508    dyn_hash_map <std::string, Module *> modsByFileName;
509    dyn_hash_map <std::string, Module *> modsByFullName;
510    std::vector<Module *> _mods;
511
512    // Variables indexed by pretty (non-mangled) name
513    /*
514    dyn_hash_map <std::string, std::vector <Symbol *> *> varsByPretty;
515    dyn_hash_map <std::string, std::vector <Symbol *> *> varsByMangled;
516    dyn_hash_map <Offset, Symbol *> varsByAddr;
517    std::vector<Symbol *> everyUniqueVariable;
518    */
519
520    //dyn_hash_map <std::string, std::vector <Symbol *> *> modsByName;
521    //std::vector<Module *> _mods;
522
523
524    std::vector<relocationEntry > relocation_table_;
525    std::vector<ExceptionBlock *> excpBlocks;
526
527    std::vector<std::string> deps_;
528
529    // This set is used during static linking to satisfy dependencies
530    std::vector<Archive *> linkingResources_;
531
532    // This set represents Symtabs referenced by a new external Symbol
533    bool getExplicitSymtabRefs(std::set<Symtab *> &refs);
534    std::set<Symtab *> explicitSymtabRefs_;
535
536    //Line Information valid flag;
537    bool isLineInfoValid_;
538    //type info valid flag
539    bool isTypeInfoValid_;
540
541    int nlines_;
542    unsigned long fdptr_;
543    char *lines_;
544    char *stabstr_;
545    int nstabs_;
546    void *stabs_;
547    char *stringpool_;
548
549    //Relocation sections
550    bool hasRel_;
551    bool hasRela_;
552    bool hasReldyn_;
553    bool hasReladyn_;
554    bool hasRelplt_;
555    bool hasRelaplt_;
556
557    bool isStaticBinary_;
558
559
560    //Don't use obj_private, use getObject() instead.
561  public:
562    Object *getObject();
563  private:
564    Object *obj_private;
565
566    // dynamic library name substitutions
567    std::map <std::string, std::string> dynLibSubs;
568
569    public:
570    static Type *type_Error;
571    static Type *type_Untyped;
572
573  public:
574    /********************************************************************/
575    /**** DEPRECATED ****************************************************/
576    /********************************************************************/
577    dyn_hash_map <std::string, Module *> &getModsByFileName()
578    {
579       return modsByFileName;
580    }
581    dyn_hash_map <std::string, Module *> &getModsByFullName()
582    {
583       return modsByFullName;
584    }
585    
586    SYMTAB_EXPORT bool findFuncByEntryOffset(std::vector<Symbol *>&ret, const Offset offset);
587    SYMTAB_EXPORT virtual bool findSymbolByType(std::vector<Symbol *> &ret, 
588                                                const std::string name,
589                                                Symbol::SymbolType sType, 
590                                                bool isMangled = false,
591                                                bool isRegex = false, 
592                                                bool checkCase = false);
593 };
594
595 /**
596  * Used to represent something like a C++ try/catch block.  
597  * Currently only used on Linux/x86
598  **/
599 SYMTAB_EXPORT  std::ostream &operator<<(std::ostream &os, const ExceptionBlock &q);
600
601 class ExceptionBlock : public Serializable, public AnnotatableSparse {
602
603    public:
604           SYMTAB_EXPORT Serializable * serialize_impl(SerializerBase *sb, 
605                           const char *tag = "exceptionBlock") THROW_SPEC (SerializerError);
606       SYMTAB_EXPORT ExceptionBlock(Offset tStart, unsigned tSize, Offset cStart);
607       SYMTAB_EXPORT ExceptionBlock(Offset cStart);
608       SYMTAB_EXPORT ExceptionBlock(const ExceptionBlock &eb);
609       SYMTAB_EXPORT ~ExceptionBlock();
610       SYMTAB_EXPORT ExceptionBlock();
611
612       SYMTAB_EXPORT bool hasTry() const;
613       SYMTAB_EXPORT Offset tryStart() const;
614       SYMTAB_EXPORT Offset tryEnd() const;
615       SYMTAB_EXPORT Offset trySize() const;
616       SYMTAB_EXPORT Offset catchStart() const;
617       SYMTAB_EXPORT bool contains(Offset a) const;
618
619       friend SYMTAB_EXPORT std::ostream &operator<<(std::ostream &os, const ExceptionBlock &q);
620    private:
621       Offset tryStart_;
622       unsigned trySize_;
623       Offset catchStart_;
624       bool hasTry_;
625 };
626
627 // relocation information for calls to functions not in this image
628 // on sparc-solaris: target_addr_ = rel_addr_ = PLT entry addr
629 // on x86-solaris: target_addr_ = PLT entry addr
630 //                 rel_addr_ =  GOT entry addr  corr. to PLT_entry
631 SYMTAB_EXPORT std::ostream &operator<<(std::ostream &os, const relocationEntry &q);
632
633 class relocationEntry : public Serializable, public AnnotatableSparse {
634    public:
635
636       SYMTAB_EXPORT relocationEntry();
637       SYMTAB_EXPORT relocationEntry(Offset ta, Offset ra, Offset add, 
638                           std::string n, Symbol *dynref = NULL, unsigned long relType = 0);
639       SYMTAB_EXPORT relocationEntry(Offset ta, Offset ra, std::string n, 
640                           Symbol *dynref = NULL, unsigned long relType = 0);
641       SYMTAB_EXPORT relocationEntry(Offset ra, std::string n, Symbol *dynref = NULL, 
642                           unsigned long relType = 0, Region::RegionType rtype = Region::RT_REL);
643       SYMTAB_EXPORT relocationEntry(Offset ta, Offset ra, Offset add,
644                           std::string n, Symbol *dynref = NULL, unsigned long relType = 0,
645                           Region::RegionType rtype = Region::RT_REL);
646
647       SYMTAB_EXPORT const relocationEntry& operator= (const relocationEntry &ra);
648
649           SYMTAB_EXPORT Serializable * serialize_impl(SerializerBase *sb, 
650                           const char *tag = "relocationEntry") THROW_SPEC (SerializerError);
651
652       SYMTAB_EXPORT Offset target_addr() const;
653       SYMTAB_EXPORT Offset rel_addr() const;
654       SYMTAB_EXPORT Offset addend() const;
655       SYMTAB_EXPORT Region::RegionType regionType() const;
656       SYMTAB_EXPORT const std::string &name() const;
657       SYMTAB_EXPORT Symbol *getDynSym() const;
658       SYMTAB_EXPORT bool addDynSym(Symbol *dynref);
659       SYMTAB_EXPORT unsigned long getRelType() const;
660
661       SYMTAB_EXPORT void setTargetAddr(const Offset);
662       SYMTAB_EXPORT void setRelAddr(const Offset);
663       SYMTAB_EXPORT void setAddend(const Offset);
664       SYMTAB_EXPORT void setRegionType(const Region::RegionType);
665       SYMTAB_EXPORT void setName(const std::string &newName);
666
667       // dump output.  Currently setup as a debugging aid, not really
668       //  for object persistance....
669       //SYMTAB_EXPORT std::ostream & operator<<(std::ostream &s) const;
670       friend SYMTAB_EXPORT std::ostream &operator<<(std::ostream &os, const relocationEntry &q);
671
672       enum {pltrel = 1, dynrel = 2} relocationType;
673       SYMTAB_EXPORT bool operator==(const relocationEntry &) const;
674
675       // Architecture-specific functions
676       SYMTAB_EXPORT static unsigned long getGlobalRelType(unsigned addressWidth);
677       static const char *relType2Str(unsigned long r, unsigned addressWidth = sizeof(Address));
678
679    private:
680       Offset target_addr_;      // target address of call instruction 
681       Offset rel_addr_;         // address of corresponding relocation entry 
682       Offset addend_;       // addend (from RELA entries)
683       Region::RegionType rtype_;        // RT_REL vs. RT_RELA
684       std::string  name_;
685       Symbol *dynref_;
686       unsigned long relType_;
687 };
688
689 #if 1
690 #if 1
691 SYMTAB_EXPORT SerializerBase *nonpublic_make_bin_symtab_serializer(Symtab *t, std::string file);
692 SYMTAB_EXPORT SerializerBase *nonpublic_make_bin_symtab_deserializer(Symtab *t, std::string file);
693 SYMTAB_EXPORT void nonpublic_free_bin_symtab_serializer(SerializerBase *sb);
694 #else
695
696 template <class T>
697 SerializerBase *nonpublic_make_bin_serializer(T *t, std::string file)
698 {
699         SerializerBin<T> *ser;
700         ser = new SerializerBin<T>(t, "SerializerBin", file, sd_serialize, true);
701         T *test_st = ser->getScope();
702         assert(test_st == t);
703         return ser;
704 }
705
706 template <class T>
707 SerializerBase *nonpublic_make_bin_deserializer(T *t, std::string file)
708 {
709         SerializerBin<T> *ser;
710         ser = new SerializerBin<T>(t, "DeserializerBin", file, sd_deserialize, true);
711         T *test_st = ser->getScope();
712         assert(test_st == t);
713         return ser;
714 }
715
716 template <class T>
717 void nonpublic_free_bin_serializer(SerializerBase *sb)
718 {
719         SerializerBin<T> *sbin = dynamic_cast<SerializerBin<T> *>(sb);
720         if (sbin)
721         {
722                 delete(sbin);
723         }
724         else
725                 fprintf(stderr, "%s[%d]:  FIXME\n", FILE__, __LINE__);
726
727 }
728 #endif
729 #endif
730
731 }//namespace SymtabAPI
732
733 }//namespace Dyninst
734 #endif