Update copyright to LGPL on all files
[dyninst.git] / symtabAPI / src / addrtranslate.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 addrtranslate_h_
33 #define addrtranslate_h_
34
35 #include <string>
36 #include <vector>
37 #include <utility>
38
39 #include "common/h/Dictionary.h"
40 #include "common/h/Types.h"
41 #include "dynutil/h/dyntypes.h"
42 #include "symtabAPI/h/Symtab.h"
43 #include "symtabAPI/h/AddrLookup.h"
44
45 using namespace std;
46
47 namespace Dyninst {
48 namespace SymtabAPI {
49
50 class LoadedLib {
51    friend class AddressTranslate;
52  protected:
53    string name;
54    Address load_addr;
55    Address data_load_addr;
56    vector< pair<Address, unsigned long> > mapped_regions;
57    Symtab *symtable;
58
59  public:
60    LoadedLib(string name, Address load_addr);
61    void add_mapped_region(Address addr, unsigned long size);
62    
63    string getName() const;
64    void setDataLoadAddr(Address a);
65    vector< pair<Address, unsigned long> > *getMappedRegions();
66    virtual Symtab *getSymtab();
67    virtual ~LoadedLib();
68
69    virtual Address symToAddress(Symbol *sym);
70    virtual Address offToAddress(Offset off);
71    virtual Offset addrToOffset(Address addr);
72
73    virtual Address getCodeLoadAddr();
74    virtual Address getDataLoadAddr();
75    virtual void getOutputs(string &filename, Address &code, Address &data);
76 };
77
78 class AddressTranslate {
79  protected:
80    PID pid;
81    PROC_HANDLE phandle;
82    bool creation_error;
83
84    AddressTranslate(PID pid, PROC_HANDLE phand = INVALID_HANDLE_VALUE);
85    vector<LoadedLib *> libs;
86    LoadedLib *exec;
87  public:
88
89    static AddressTranslate *createAddressTranslator(PID pid_,
90                                                     ProcessReader *reader_ = NULL,
91                                                                                                         PROC_HANDLE phand = INVALID_HANDLE_VALUE);
92    static AddressTranslate *createAddressTranslator(ProcessReader *reader_ = NULL);
93    static AddressTranslate *createAddressTranslator(const std::vector<LoadedLibrary> &name_addrs);
94    
95    virtual bool refresh() = 0;
96    virtual ~AddressTranslate();
97   
98    PID getPid();
99    bool getLibAtAddress(Address addr, LoadedLib* &lib);
100    bool getLibs(vector<LoadedLib *> &libs_);
101    LoadedLib *getLoadedLib(std::string name);
102    LoadedLib *getLoadedLib(Symtab *sym);
103    LoadedLib *getExecutable();
104
105    virtual Address getLibraryTrapAddrSysV();
106 };
107
108 }
109 }
110
111 #endif