Remove incorrect export declaration
[dyninst.git] / patchAPI / h / Command.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 / Public Interface */
31
32 #ifndef PATCHAPI_COMMAND_H_
33 #define PATCHAPI_COMMAND_H_
34
35 #include "PatchCommon.h"
36
37 namespace Dyninst {
38 namespace PatchAPI {
39
40 /* Interface to support transactional semantics, by implementing an
41    instrumentation request (public interface) or an internal step of
42    instrumentation (plugin interface) */
43
44 class PATCHAPI_EXPORT Command {
45   public:
46     Command() {}
47     virtual ~Command() {}
48
49     virtual bool commit();
50
51     virtual bool run() = 0;
52     virtual bool undo() = 0;
53 };
54
55 /* A BatchCommand is in fact a list of Commands, and is to iterate all Commands
56    in the list to run() or undo(). */
57
58 class PATCHAPI_EXPORT BatchCommand : public Command {
59   public:
60     BatchCommand* create();
61     BatchCommand() {}
62     virtual ~BatchCommand() {}
63
64     virtual bool run();
65     virtual bool undo();
66
67     /* Add/Remove Commands to to_do_ list. */
68     typedef std::list<Command*> CommandList;
69     void add(Command*);
70     void remove(CommandList::iterator);
71
72   protected:
73     CommandList to_do_;
74     CommandList done_;
75
76 };
77
78 /* A Patcher is a special BatchCommand, which implicitly execute Instrumenter
79    after executing all Commands in its list. Instrumenter is for code relocation
80    and code generation. */
81
82 class PATCHAPI_EXPORT Patcher : public BatchCommand {
83   public:
84    static Patcher* create(Dyninst::PatchAPI::PatchMgrPtr mgr) {
85       return new Patcher(mgr);
86     }
87     Patcher(Dyninst::PatchAPI::PatchMgrPtr mgr) : mgr_(mgr) {}
88     virtual ~Patcher() {}
89
90     virtual bool run();
91   private:
92     Dyninst::PatchAPI::PatchMgrPtr mgr_;
93 };
94
95 /* Default implementation of some basic instrumentation Commands */
96
97 class PATCHAPI_EXPORT PushFrontCommand : public Command {
98   public:
99     static PushFrontCommand* create(Dyninst::PatchAPI::Point* pt,
100                       Dyninst::PatchAPI::SnippetPtr snip) {
101       return new PushFrontCommand(pt, snip);
102     }
103     PushFrontCommand(Dyninst::PatchAPI::Point* pt,
104                      Dyninst::PatchAPI::SnippetPtr snip) : pt_(pt), snip_(snip) {}
105     virtual ~PushFrontCommand() {}
106
107     virtual bool run();
108     virtual bool undo();
109     InstancePtr instance() { return instance_; }
110  private:
111    Dyninst::PatchAPI::Point* pt_;
112    Dyninst::PatchAPI::SnippetPtr snip_;
113    Dyninst::PatchAPI::InstancePtr instance_;
114 };
115
116 class PATCHAPI_EXPORT PushBackCommand : public Command {
117   public:
118     static PushBackCommand* create(Dyninst::PatchAPI::Point* pt,
119                       Dyninst::PatchAPI::SnippetPtr snip) {
120       return new PushBackCommand(pt, snip);
121     }
122     PushBackCommand(Dyninst::PatchAPI::Point* pt,
123                     Dyninst::PatchAPI::SnippetPtr snip)
124                     : pt_(pt), snip_(snip) {}
125     virtual ~PushBackCommand() {}
126
127     virtual bool run();
128     virtual bool undo();
129     InstancePtr instance() { return instance_; }
130
131   private:
132     Dyninst::PatchAPI::Point* pt_;
133     Dyninst::PatchAPI::SnippetPtr snip_;
134     Dyninst::PatchAPI::InstancePtr instance_;
135 };
136
137 class PATCHAPI_EXPORT RemoveSnippetCommand : public Command {
138   public:
139     static RemoveSnippetCommand* create(Dyninst::PatchAPI::InstancePtr instance) {
140       return new RemoveSnippetCommand(instance);
141     }
142     RemoveSnippetCommand(Dyninst::PatchAPI::InstancePtr instance)
143       : instance_(instance) {}
144     virtual ~RemoveSnippetCommand() {}
145
146     virtual bool run();
147     virtual bool undo();
148   private:
149     Dyninst::PatchAPI::InstancePtr instance_;
150 };
151
152 class PATCHAPI_EXPORT RemoveCallCommand : public Command {
153   public:
154     static RemoveCallCommand* create(Dyninst::PatchAPI::PatchMgrPtr mgr,
155                       Dyninst::PatchAPI::PatchBlock* call_block,
156                       Dyninst::PatchAPI::PatchFunction* context = NULL) {
157       return new RemoveCallCommand(mgr, call_block, context);
158     }
159     RemoveCallCommand(Dyninst::PatchAPI::PatchMgrPtr mgr,
160                       Dyninst::PatchAPI::PatchBlock* call_block,
161                       Dyninst::PatchAPI::PatchFunction* context)
162       : mgr_(mgr), call_block_(call_block), context_(context) {}
163     virtual ~RemoveCallCommand() {}
164
165     virtual bool run();
166     virtual bool undo();
167   private:
168     Dyninst::PatchAPI::PatchMgrPtr mgr_;
169     Dyninst::PatchAPI::PatchBlock* call_block_;
170     Dyninst::PatchAPI::PatchFunction* context_;
171 };
172
173 class PATCHAPI_EXPORT ReplaceCallCommand : public Command {
174   public:
175     static ReplaceCallCommand* create(Dyninst::PatchAPI::PatchMgrPtr mgr,
176                       Dyninst::PatchAPI::PatchBlock* call_block,
177                       Dyninst::PatchAPI::PatchFunction* new_callee,
178                       Dyninst::PatchAPI::PatchFunction* context) {
179       return new ReplaceCallCommand(mgr, call_block, new_callee, context);
180     }
181     ReplaceCallCommand(Dyninst::PatchAPI::PatchMgrPtr mgr,
182                        Dyninst::PatchAPI::PatchBlock* call_block,
183                        Dyninst::PatchAPI::PatchFunction* new_callee,
184                        Dyninst::PatchAPI::PatchFunction* context)
185       : mgr_(mgr), call_block_(call_block), new_callee_(new_callee), context_(context) {}
186     virtual ~ReplaceCallCommand() {}
187
188     virtual bool run();
189     virtual bool undo();
190   private:
191     Dyninst::PatchAPI::PatchMgrPtr mgr_;
192     Dyninst::PatchAPI::PatchBlock* call_block_;
193     Dyninst::PatchAPI::PatchFunction* new_callee_;
194     Dyninst::PatchAPI::PatchFunction* context_;
195 };
196
197 class PATCHAPI_EXPORT ReplaceFuncCommand : public Command {
198   public:
199     static ReplaceFuncCommand* create(Dyninst::PatchAPI::PatchMgrPtr mgr,
200                       Dyninst::PatchAPI::PatchFunction* old_func,
201                       Dyninst::PatchAPI::PatchFunction* new_func) {
202       return new ReplaceFuncCommand(mgr, old_func, new_func);
203     }
204     ReplaceFuncCommand(Dyninst::PatchAPI::PatchMgrPtr mgr,
205                        Dyninst::PatchAPI::PatchFunction* old_func,
206                        Dyninst::PatchAPI::PatchFunction* new_func)
207       : mgr_(mgr), old_func_(old_func), new_func_(new_func)  {}
208     virtual ~ReplaceFuncCommand() {}
209
210     virtual bool run();
211     virtual bool undo();
212   private:
213     Dyninst::PatchAPI::PatchMgrPtr mgr_;
214     Dyninst::PatchAPI::PatchFunction* old_func_;
215     Dyninst::PatchAPI::PatchFunction* new_func_;
216 };
217
218 }
219 }
220
221 #endif /* PATCHAPI_COMMAND_H_ */