cotire
[dyninst.git] / symlite / h / SymLite-elf.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #include "common/h/SymReader.h"
32 #include "Elf_X.h"
33 #include "common/src/headers.h"
34
35 #include <map>
36
37 namespace Dyninst {
38
39 struct SYMLITE_EXPORT SymCacheEntry {
40    Dyninst::Offset symaddress;
41    void *symloc;
42    const char *demangled_name;
43 };
44
45 class SYMLITE_EXPORT SymElf : public Dyninst::SymReader
46 {
47    friend class SymElfFactory;
48  private:
49    Elf_X *elf;
50    int fd;
51    bool need_odp;
52    Elf_X_Shdr *odp_section;
53
54    std::string file;
55    const char *buffer;
56    unsigned long buffer_size;
57
58    SymElf(std::string file_);
59    SymElf(const char *buffer_, unsigned long size_);
60    virtual ~SymElf();
61
62    SymCacheEntry *cache;
63    unsigned cache_size;
64
65    Elf_X_Shdr *sym_sections;
66    unsigned sym_sections_size;
67    
68    void createSymCache();
69    Symbol_t lookupCachedSymbol(Dyninst::Offset offset);
70    
71    void init();
72    unsigned long getSymOffset(const Elf_X_Sym &symbol, unsigned idx);   
73    unsigned long getSymTOC(const Elf_X_Sym &symbol, unsigned idx);   
74  public:
75    virtual Symbol_t getSymbolByName(std::string symname);
76    virtual Symbol_t getContainingSymbol(Dyninst::Offset offset);
77    virtual std::string getInterpreterName();
78
79    virtual unsigned numSegments();
80    virtual bool getSegment(unsigned num, SymSegment &reg); 
81
82    virtual Dyninst::Offset getSymbolOffset(const Symbol_t &sym);
83    virtual Dyninst::Offset getSymbolTOC(const Symbol_t &sym);
84    virtual std::string getSymbolName(const Symbol_t &sym);
85    virtual std::string getDemangledName(const Symbol_t &sym);
86
87    virtual bool isValidSymbol(const Symbol_t &sym);
88    virtual unsigned getAddressWidth();
89    virtual bool getABIVersion(int &major, int &minor) const;
90    virtual bool isBigEndianDataEncoding() const;
91
92    virtual unsigned long getSymbolSize(const Symbol_t &sym);
93    virtual Section_t getSectionByName(std::string name);
94    virtual Section_t getSectionByAddress(Dyninst::Address addr);
95    virtual Dyninst::Address getSectionAddress(Section_t sec);
96    virtual std::string getSectionName(Section_t sec);
97    virtual bool isValidSection(Section_t sec);
98
99    virtual Dyninst::Offset imageOffset();
100    virtual Dyninst::Offset dataOffset();
101    int ref_count;
102    bool construction_error;
103    
104    void *getElfHandle();
105    int getFD();
106    
107 };
108
109 class SYMLITE_EXPORT SymElfFactory : public Dyninst::SymbolReaderFactory
110 {
111 private:
112    std::map<std::string, SymElf *> *open_symelfs;
113 public:
114    SymElfFactory();
115    virtual ~SymElfFactory();
116    virtual SymReader *openSymbolReader(std::string pathname);
117    virtual SymReader *openSymbolReader(const char *buffer, unsigned long size);
118    virtual bool closeSymbolReader(SymReader *sr);
119 };
120
121 }