Update copyright to LGPL on all files
[dyninst.git] / symtabAPI / h / AddrLookup.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 __AddrLookup_H__
33 #define __AddrLookup_H__
34
35 #include "Annotatable.h"
36
37 namespace Dyninst {
38 namespace SymtabAPI {
39
40 class AddressTranslate;
41 class LoadedLib;
42
43 //Needed for Linux and Solaris
44 class ProcessReader {
45  public:
46    PID pid;
47    const std::string executable;
48
49    ProcessReader(PID pid_, std::string exe="");
50    ProcessReader();
51
52    virtual bool start() = 0;
53    virtual bool readAddressSpace(Address inTraced, unsigned amount, 
54                                  void *inSelf) = 0;
55    virtual bool done() = 0;
56    virtual ~ProcessReader() {}
57 };
58
59 typedef struct {
60    std::string name;
61    Address codeAddr;
62    Address dataAddr;
63 } LoadedLibrary;
64
65 class AddressLookup : public AnnotatableSparse
66 {
67  private:
68    AddressTranslate *translator;
69    AddressLookup(AddressTranslate *trans);
70    static dyn_hash_map<std::string, std::vector<Symbol *> > syms;
71    int getSymsVector(std::string str);
72    std::vector<Symbol *> *getSymsVector(LoadedLib *lib);
73
74
75  public:
76    SYMTAB_EXPORT static AddressLookup *createAddressLookup(ProcessReader *reader = NULL);
77    SYMTAB_EXPORT static AddressLookup *createAddressLookup(PID pid, ProcessReader *reader = NULL);
78    SYMTAB_EXPORT static AddressLookup *createAddressLookup(const std::vector<LoadedLibrary> &name_addrs);
79    
80    SYMTAB_EXPORT bool getAddress(Symtab *tab, Symbol *sym, Address &addr);
81    SYMTAB_EXPORT bool getAddress(Symtab *tab, Offset off, Address &addr);
82
83    SYMTAB_EXPORT bool getSymbol(Address addr, Symbol* &sym, Symtab* &tab, bool close = false);
84    SYMTAB_EXPORT bool getOffset(Address addr, Symtab* &tab, Offset &off);
85    
86    SYMTAB_EXPORT bool getAllSymtabs(std::vector<Symtab *> &tabs);
87    SYMTAB_EXPORT bool getLoadAddress(Symtab* sym, Address &load_addr);
88    SYMTAB_EXPORT bool getDataLoadAddress(Symtab* sym, Address &load_addr);
89
90    SYMTAB_EXPORT bool getLoadAddresses(std::vector<LoadedLibrary> &name_addrs);
91    SYMTAB_EXPORT bool getExecutable(LoadedLibrary &lib);
92
93    SYMTAB_EXPORT bool refresh();
94
95    SYMTAB_EXPORT Address getLibraryTrapAddrSysV();
96
97    
98    SYMTAB_EXPORT virtual ~AddressLookup();
99 };
100
101 }
102 }
103
104 #endif