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