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