Rename the symbol reader getRegions to getSegments, since the desired return is an...
[dyninst.git] / dynutil / h / SymReader.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 #if !defined SYM_READER_H_
31 #define SYM_READER_H_
32
33 #include "dyntypes.h"
34 #include <string>
35
36 namespace Dyninst
37 {
38
39 class SymbolReaderFactory;
40
41 /**
42  * Symbol_t is an anonymous struct that any SymReader can use for a symbol 
43  * handle.  Some symbol readers may not want to store the objects behind a 
44  * 'void*' on the heap, so we're making Symbol_t big enough that it could 
45  * act as a full symbol handle.  Or a SymReader could just choose fill in one
46  * of the void pointers as a handle to a heap object, if it's comfortable
47  * doing so.
48  **/
49 struct Symbol_t {
50    void *v1;
51    void *v2;
52    int i1;
53    int i2;
54 };
55
56 struct Section_t {
57    void *v1;
58    void *v2;
59    int i1;
60    int i2;
61 };
62
63 struct SymSegment {
64    Dyninst::Offset file_offset;
65    Dyninst::Address mem_addr;
66    size_t file_size;
67    size_t mem_size;
68    int type;
69    int perms;
70 };
71
72 /**
73  * This may seem like a clunky interface in places, but it was designed such 
74  * that the underlying implementation could be made re-enterant safe (so it 
75  * could be called from a signal handler).
76  **/
77 class COMMON_EXPORT SymReader
78 {
79  protected:
80    SymReader() {}
81    virtual ~SymReader() {}
82  public:
83    virtual Symbol_t getSymbolByName(std::string symname) = 0;
84    virtual Symbol_t getContainingSymbol(Dyninst::Offset offset) = 0;
85    virtual std::string getInterpreterName() = 0;
86    virtual unsigned getAddressWidth() = 0;
87    
88    virtual unsigned numSegments() = 0;
89    virtual bool getSegment(unsigned num, SymSegment &reg) = 0; 
90
91    virtual Dyninst::Offset getSymbolOffset(const Symbol_t &sym) = 0;
92    virtual std::string getSymbolName(const Symbol_t &sym) = 0;
93    virtual std::string getDemangledName(const Symbol_t &sym) = 0;
94    virtual unsigned long getSymbolSize(const Symbol_t &sym) = 0;
95    virtual bool isValidSymbol(const Symbol_t &sym) = 0;
96
97    virtual Section_t getSectionByName(std::string name) = 0;
98    virtual Section_t getSectionByAddress(Dyninst::Address addr) = 0;
99    virtual Dyninst::Address getSectionAddress(Section_t sec) = 0;
100    virtual std::string getSectionName(Section_t sec) = 0;
101    virtual bool isValidSection(Section_t sec) = 0;
102
103    virtual Dyninst::Offset imageOffset() = 0;
104    virtual Dyninst::Offset dataOffset() = 0;
105
106    virtual void *getElfHandle() { return NULL; }
107    virtual int getFD() 
108    {
109      return 0;
110    }
111    
112 };
113
114 class COMMON_EXPORT SymbolReaderFactory
115 {
116  public:
117    SymbolReaderFactory() {}
118    virtual ~SymbolReaderFactory() {}
119    virtual SymReader *openSymbolReader(std::string pathname) = 0;
120    virtual SymReader *openSymbolReader(const char *buffer, unsigned long size) = 0;
121    virtual bool closeSymbolReader(SymReader *sr) = 0;
122 };
123
124 }
125
126 extern "C" {
127    Dyninst::SymbolReaderFactory *getSymReaderFactory();
128 }
129
130 #endif