Remove incorrect export declaration
[dyninst.git] / patchAPI / h / AddrSpace.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 /* Plugin Interface */
32
33 #ifndef PATCHAPI_H_ADDRSPACE_H_
34 #define PATCHAPI_H_ADDRSPACE_H_
35
36 #include "PatchCommon.h"
37
38 namespace Dyninst {
39 namespace PatchAPI {
40
41 /* Interface specification for the interation between a PatchMgr and
42    the address space */
43
44 class PATCHAPI_EXPORT AddrSpace {
45     friend class PatchMgr;
46     friend class PatchFunction;
47
48   public:
49     static AddrSpace* create(PatchObject* obj);
50     virtual ~AddrSpace();
51
52     // Write data in mutatee's address space
53     virtual bool write(PatchObject* /*obj*/, Address /*to*/,
54                                        Address /*from*/, size_t /*size*/);
55
56     // Memory allocation / reallocation / deallocation in mutatee's addressSpace
57     virtual Address malloc(PatchObject* /*obj*/, size_t /*size*/,
58                                            Address /*near*/);
59
60     virtual bool realloc(PatchObject* /*obj*/, Address /*orig*/,
61                                          size_t /*size*/);
62
63     virtual bool free(PatchObject* /*obj*/, Address /*orig*/);
64
65     // Load a binary oject into the address space
66     virtual bool loadObject(PatchObject* obj);
67
68     // Getters
69     typedef std::map<const ParseAPI::CodeObject*, PatchObject*> ObjMap;
70     ObjMap& objMap() { return obj_map_; }
71     PatchObject* findObject(const ParseAPI::CodeObject*) const;
72     template <class Iter> void objs(Iter iter); // EXPORTED
73     PatchObject* executable() { return first_object_; }
74     PatchMgrPtr mgr() const { return mgr_; }
75
76     std::string format() const;
77
78     bool consistency(const PatchMgr *mgr) const;
79
80   protected:
81     ObjMap obj_map_;
82     PatchObject* first_object_;
83     PatchMgrPtr mgr_;
84
85     bool init(PatchObject*);
86     AddrSpace() {}
87     explicit AddrSpace(AddrSpace*) {}
88 };
89
90 template <class Iter>
91    void AddrSpace::objs(Iter iter) {
92    for (ObjMap::iterator tmp = obj_map_.begin(); tmp != obj_map_.end(); ++tmp) {
93       *iter = tmp->second;
94       ++iter;
95    }
96 }
97
98
99
100 }
101 }
102
103 #endif /* PATCHAPI_H_ADDRSPACE_H_ */