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