Ported the Dyninst API to Windows NT.
[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_thread;
61
62
63 /*
64  * Used to specify whether a snippet is to be called before the instructions
65  * at the point where it is inserted, or after.
66  */
67 typedef enum {
68     BPatch_callBefore,
69     BPatch_callAfter
70 } BPatch_callWhen;
71
72
73 /*
74  * Used to specify whether a snippet should be installed before other snippets
75  * that have previously been inserted at the same point, or after.
76  */
77 typedef enum {
78     BPatch_firstSnippet,
79     BPatch_lastSnippet
80 } BPatch_snippetOrder;
81
82
83 /*
84  * Contains information about the code that was inserted by an earlier call to
85  * Bpatch_thread::insertSnippet.
86  */
87 class BPatchSnippetHandle {
88 private:
89     BPatch_Vector<instInstance *> instance;
90 public:
91     process *proc;
92
93     BPatchSnippetHandle(process *_proc) : proc(_proc) {};
94     ~BPatchSnippetHandle();
95
96     void add(instInstance *pointInstance);
97 };
98
99
100 /*
101  * Represents a thread of execution.
102  */
103 class BPatch_thread {
104     friend bool pollForStatusChange();
105
106     process             *proc;
107     BPatch_image        *image;
108     int                 lastSignal;
109     bool                mutationsActive;
110     bool                createdViaAttach;
111     bool                detached;
112
113 public:
114     BPatch_thread(char *path, char *argv[], char *envp[] = NULL);
115     BPatch_thread(char *path, int pid);
116     ~BPatch_thread();
117
118     BPatch_image *getImage() { return image; }
119
120     int         getPid();
121
122     bool        stopExecution();
123     bool        continueExecution();
124     bool        terminateExecution();
125
126     bool        isStopped();
127     int         stopSignal();
128     bool        isTerminated();
129
130     void        detach(bool cont);
131
132     bool        dumpCore(const char *file, bool terminate);
133
134     BPatch_variableExpr *malloc(int n);
135     BPatch_variableExpr *malloc(const BPatch_type &type);
136     void        free(const BPatch_variableExpr &ptr);
137
138     BPatchSnippetHandle *insertSnippet(
139                             const BPatch_snippet &expr,
140                             const BPatch_point &point,
141                             BPatch_callWhen when = BPatch_callBefore,
142                             BPatch_snippetOrder order = BPatch_firstSnippet);
143     BPatchSnippetHandle *insertSnippet(
144                             const BPatch_snippet &expr,
145                             const BPatch_Vector<BPatch_point *> &points,
146                             BPatch_callWhen when = BPatch_callBefore,
147                             BPatch_snippetOrder order = BPatch_firstSnippet);
148
149     bool        deleteSnippet(BPatchSnippetHandle *handle);
150
151     void        setMutationsActive(bool activate);
152
153     bool        replaceFunctionCall(BPatch_point &point,
154                                     BPatch_function &newFunc);
155     bool        removeFunctionCall(BPatch_point &point);
156 };
157
158 #endif /* BPatch_thread_h_ */