Added BPatch_thread::oneTimeCode, BPatch_thread::loadLibrary, and other
[dyninst.git] / dyninstAPI / h / BPatch_thread.h
1 /*
2  * Copyright (c) 1996 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  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 #ifndef _BPatch_thread_h_
43 #define _BPatch_thread_h_
44
45 /*
46  * The following is a kludge so that the functions that refer to signals (such
47  * as BPatch_thread::stopSignal) can emulate the Unix behavior on Windows NT.
48  */
49 #include <signal.h>
50 #ifndef SIGTRAP
51 #define SIGTRAP         5
52 #endif
53
54 #include "BPatch_Vector.h"
55 #include "BPatch_image.h"
56 #include "BPatch_snippet.h"
57
58 class process;
59 class instInstance;
60 class BPatch;
61 class BPatch_thread;
62
63
64 /*
65  * Used to specify whether a snippet is to be called before the instructions
66  * at the point where it is inserted, or after.
67  */
68 typedef enum {
69     BPatch_callBefore,
70     BPatch_callAfter
71 } BPatch_callWhen;
72
73
74 /*
75  * Used to specify whether a snippet should be installed before other snippets
76  * that have previously been inserted at the same point, or after.
77  */
78 typedef enum {
79     BPatch_firstSnippet,
80     BPatch_lastSnippet
81 } BPatch_snippetOrder;
82
83
84 /*
85  * Contains information about the code that was inserted by an earlier call to
86  * Bpatch_thread::insertSnippet.
87  */
88 class BPatchSnippetHandle {
89 private:
90     BPatch_Vector<instInstance *> instance;
91 public:
92     process *proc;
93
94     BPatchSnippetHandle(process *_proc) : proc(_proc) {};
95     ~BPatchSnippetHandle();
96
97     void add(instInstance *pointInstance);
98 };
99
100 /*
101  * Represents a thread of execution.
102  */
103 class BPatch_thread {
104     friend class BPatch;
105     friend bool pollForStatusChange();
106
107     process             *proc;
108     BPatch_image        *image;
109     int                 lastSignal;
110     bool                mutationsActive;
111     bool                createdViaAttach;
112     bool                detached;
113
114     bool                waitingForOneTimeCode;
115     unsigned            lastOneTimeCodeReturnValue;
116
117     bool                unreportedStop;
118     bool                unreportedTermination;
119
120     void                setUnreportedStop(bool new_value)
121                                 { unreportedStop = new_value; }
122     void                setUnreportedTermination(bool new_value)
123                                 { unreportedTermination = new_value; }
124
125     bool                pendingUnreportedStop()
126                                 { return unreportedStop; }
127     bool                pendingUnreportedTermination()
128                                 { return unreportedTermination; }
129
130     bool                statusIsStopped();
131     bool                statusIsTerminated();
132
133     static void         oneTimeCodeCallbackDispatch(process *theProc,
134                                                     void *userData,
135                                                     unsigned returnValue);
136
137     void                oneTimeCodeCallback(void *userData,
138                                             unsigned returnValue);
139
140     int                 oneTimeCodeInternal(const BPatch_snippet &expr);
141 protected:
142     BPatch_thread(char *path, char *argv[], char *envp[] = NULL);
143     BPatch_thread(char *path, int pid);
144
145 public:
146     ~BPatch_thread();
147
148     BPatch_image *getImage() { return image; }
149
150     int         getPid();
151
152     bool        stopExecution();
153     bool        continueExecution();
154     bool        terminateExecution();
155
156     bool        isStopped();
157     int         stopSignal();
158     bool        isTerminated();
159
160     void        detach(bool cont);
161
162     bool        dumpCore(const char *file, bool terminate);
163     bool        dumpImage(const char *file);
164
165     BPatch_variableExpr *malloc(int n);
166     BPatch_variableExpr *malloc(const BPatch_type &type);
167     void        free(const BPatch_variableExpr &ptr);
168
169     BPatchSnippetHandle *insertSnippet(
170                             const BPatch_snippet &expr,
171                             const BPatch_point &point,
172                             BPatch_callWhen when = BPatch_callBefore,
173                             BPatch_snippetOrder order = BPatch_firstSnippet);
174     BPatchSnippetHandle *insertSnippet(
175                             const BPatch_snippet &expr,
176                             const BPatch_Vector<BPatch_point *> &points,
177                             BPatch_callWhen when = BPatch_callBefore,
178                             BPatch_snippetOrder order = BPatch_firstSnippet);
179
180     bool        deleteSnippet(BPatchSnippetHandle *handle);
181
182     void        setMutationsActive(bool activate);
183
184     bool        replaceFunctionCall(BPatch_point &point,
185                                     BPatch_function &newFunc);
186     bool        removeFunctionCall(BPatch_point &point);
187
188     void        oneTimeCode(const BPatch_snippet &expr) {
189                         oneTimeCodeInternal(expr);
190                     };
191
192     bool        loadLibrary(char *libname);
193 };
194
195 #endif /* BPatch_thread_h_ */