1) Cmake support for PPC64LE builds
[dyninst.git] / symtabAPI / h / SymtabReader.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 #if !defined SYMTAB_READER_H_
32 #define SYMTAB_READER_H_
33
34 #include "SymReader.h"
35 #include <string>
36 #include <vector>
37 //Some components (StackwalkerAPI, ProcControlAPI) use a SymReader (defined in dyn_util/h)
38 // to read symbols rather than a straight dependency on SymtabAPI.  A component can
39 // either define its own SymReader (as ProcControlAPI does) or it can use SymtabAPI as
40 // its symbol reader.  These SymtabReader and SymtabReaderFactory implement the SymReader
41 // interface with a SymtabAPI implementation.
42
43 namespace Dyninst {
44 namespace SymtabAPI {
45
46 class Symtab;
47 class Region;
48 class FastParser;
49
50 class SYMTAB_EXPORT SymtabReaderFactory : public SymbolReaderFactory
51 {
52   private:
53    std::map<std::string, SymReader *> open_syms;
54   public:
55    SymtabReaderFactory();
56    virtual ~SymtabReaderFactory();
57    virtual SymReader *openSymbolReader(std::string pathname);
58    virtual SymReader *openSymbolReader(const char *buffer, unsigned long size);
59    virtual bool closeSymbolReader(SymReader *sr);
60 };
61
62 class SYMTAB_EXPORT SymtabReader : public SymReader {
63    friend class SymtabReaderFactory;
64   protected:
65    Symtab *symtab;
66    int ref_count;
67    std::vector<SymSegment> segments;
68    bool ownsSymtab;
69
70   public:
71    SymtabReader(std::string file_);
72    SymtabReader(const char *buffer, unsigned long size);
73    SymtabReader(Symtab *s);
74    virtual ~SymtabReader();
75
76    virtual Symbol_t getSymbolByName(std::string symname);
77    virtual unsigned long getSymbolSize(const Symbol_t &sym);
78    virtual Symbol_t getContainingSymbol(Dyninst::Offset offset);
79    virtual std::string getInterpreterName();
80    virtual unsigned getAddressWidth();
81    virtual bool isBigEndianDataEncoding() const;
82    virtual int getABIVersion() const;
83    
84    virtual unsigned numSegments();
85    virtual bool getSegment(unsigned num, SymSegment &seg); 
86
87    virtual Dyninst::Offset getSymbolOffset(const Symbol_t &sym);
88    virtual Dyninst::Offset getSymbolTOC(const Symbol_t &sym);
89    virtual std::string getSymbolName(const Symbol_t &sym);
90    virtual std::string getDemangledName(const Symbol_t &sym);
91    virtual bool isValidSymbol(const Symbol_t &sym);
92
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
102    virtual void *getElfHandle();
103   private:
104    void buildSegments();
105 };
106
107 extern "C" {
108    SYMTAB_EXPORT SymbolReaderFactory *getSymtabReaderFactory();
109 }
110
111 }
112 }
113
114 #endif