Remove incorrect export declaration
[dyninst.git] / patchAPI / h / Instrumenter.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 /* Plugin Interface */
31
32 #ifndef PATCHAPI_H_INSTRUMENTOR_H_
33 #define PATCHAPI_H_INSTRUMENTOR_H_
34
35 #include "PatchCommon.h"
36 #include "Point.h"
37 #include "AddrSpace.h"
38 #include "Command.h"
39
40 namespace Dyninst {
41 namespace PatchAPI {
42
43 /* Relocate the original code and generate snippet binary code in mutatee's
44    address space. */
45
46 class PATCHAPI_EXPORT Instrumenter : public BatchCommand {
47   public:
48     friend class Patcher;
49     static Instrumenter* create(AddrSpace* as);
50     virtual ~Instrumenter() {}
51
52     // Code Modification interfaces
53     // Function Replacement
54     virtual bool replaceFunction(PatchFunction* oldfunc,
55                                                  PatchFunction* newfunc);
56     virtual bool revertReplacedFunction(PatchFunction* oldfunc);
57     virtual FuncModMap& funcRepMap() { return functionReplacements_; }
58
59     // Function Wrapping
60     virtual bool wrapFunction(PatchFunction* oldfunc,
61                                               PatchFunction* newfunc,
62                                               std::string name);
63     virtual bool revertWrappedFunction(PatchFunction* oldfunc);
64     virtual FuncWrapMap& funcWrapMap() { return functionWraps_; }
65
66     // Call Modification
67     virtual bool modifyCall(PatchBlock *callBlock, PatchFunction *newCallee,
68                                     PatchFunction *context = NULL);
69     virtual bool revertModifiedCall(PatchBlock *callBlock, PatchFunction *context = NULL);
70     virtual bool removeCall(PatchBlock *callBlock, PatchFunction *context = NULL);
71     virtual CallModMap& callModMap() { return callModifications_; }
72
73     // Getters and setters
74     AddrSpace* as() const { return as_; }
75     void setAs(AddrSpace* as) { as_ = as; }
76     virtual bool isInstrumentable(PatchFunction* ) { return true; }
77   protected:
78     AddrSpace* as_;
79     CommandList user_commands_;
80     FuncModMap functionReplacements_;
81     FuncWrapMap functionWraps_;
82     CallModMap callModifications_;
83
84     explicit Instrumenter(AddrSpace* as) : as_(as) {}
85     Instrumenter() {}
86 };
87 }
88 }
89 #endif  // PATCHAPI_H_INSTRUMENTOR_H_