Added a public method to trigger the pre fork callback
[dyninst.git] / dyninstAPI / h / BPatch.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_h_
43 #define _BPatch_h_
44
45 #include <stdio.h>
46 #include "BPatch_dll.h"
47 #include "BPatch_Vector.h"
48 #include "BPatch_thread.h"
49 #include "BPatch_type.h"
50
51 #ifdef mips_unknown_ce2_11 //ccw 28 july 2000
52 #include "remoteDevice.h"
53 #endif
54
55 class BPatch_typeCollection;
56 class BPatch_libInfo;
57 class BPatch_module;
58
59 typedef enum {
60     BPatchFatal, BPatchSerious, BPatchWarning, BPatchInfo
61 } BPatchErrorLevel;
62
63 typedef void (*BPatchErrorCallback)(BPatchErrorLevel severity,
64                                     int number,
65                                     const char **params);
66
67 typedef void (*BPatchDynLibraryCallback)(BPatch_thread *thr,
68                                          BPatch_module *mod,
69                                          bool load);
70
71 typedef void (*BPatchForkCallback)(BPatch_thread *parent, BPatch_thread *child);
72
73 typedef void (*BPatchExecCallback)(BPatch_thread *proc);
74
75 typedef void (*BPatchExitCallback)(BPatch_thread *proc, int code);
76
77 typedef void (*BPatchSignalCallback)(BPatch_thread *proc, int sigNum);
78
79 typedef void (*BPatchOneTimeCodeCallback)(BPatch_thread *proc, void *userData, void *returnValue);
80
81 #ifdef IBM_BPATCH_COMPAT
82 typedef void *BPatch_Address;
83 typedef void (*BPatchLoggingCallback)(char *msg, int);
84 extern void setLogging_NP(BPatchLoggingCallback func, int);
85
86 typedef void (*BPatchThreadEventCallback)(BPatch_thread *thr, void *arg1, void *arg2);
87
88 #define BP_OK                   0
89 #define BP_Pending              1
90 #define BP_Delayed              2
91 #define BP_child                3
92 #define BP_state                4
93 #define BP_pthdbBadContext      5
94 #define BP_lastCode             6
95
96 extern int eCodes[BP_lastCode];
97
98 #endif
99
100 class BPATCH_DLL_EXPORT BPatch {
101     friend class BPatch_thread;
102     friend class process;
103
104     BPatch_libInfo      *info;
105
106     BPatchErrorCallback         errorHandler;
107     BPatchDynLibraryCallback    dynLibraryCallback;
108     BPatchForkCallback          postForkCallback;
109     BPatchForkCallback          preForkCallback;
110     BPatchExecCallback          execCallback;
111     BPatchExitCallback          exitCallback;
112     BPatchOneTimeCodeCallback   oneTimeCodeCallback;
113     bool        typeCheckOn;
114     int         lastError;
115     bool        debugParseOn;
116     bool        baseTrampDeletionOn;
117
118     bool        getThreadEvent(bool block);
119     bool        getThreadEventOnly(bool block);
120     bool        havePendingEvent();
121
122     /* If true, trampolines can recurse to their heart's content.
123        Defaults to false */
124     bool        trampRecursiveOn;
125     bool        forceRelocation_NP;
126
127 public:
128     static BPatch                *bpatch;
129
130     BPatch_builtInTypeCollection *builtInTypes;
131     BPatch_typeCollection        *stdTypes;
132     BPatch_typeCollection        *APITypes; //API/User defined types
133     BPatch_type                  *type_Error;
134     BPatch_type                  *type_Untyped;
135 #ifdef mips_unknown_ce2_11 //ccw 28 july 2000
136         remoteDevice *rDevice;  //the ctor sets up the connection here and
137                                 //gets the tramptemplate from the CE device.
138 #endif
139
140  
141     bool isTypeChecked() { return typeCheckOn; }
142     bool parseDebugInfo() { return debugParseOn; }
143     bool baseTrampDeletion() { return baseTrampDeletionOn; }
144     bool isTrampRecursive() { return trampRecursiveOn; }
145     bool hasForcedRelocation_NP() { return forceRelocation_NP; }
146
147     // The following are only to be called by the library:
148     void registerProvisionalThread(int pid);
149     void registerForkedThread(int parentPid, int childPid, process *proc);
150     void registerForkingThread(int forkingPid, process *proc);
151     void registerExec(BPatch_thread *thread);
152     void registerExit(BPatch_thread *thread, int code);
153     void registerThread(BPatch_thread *thread);
154     void unRegisterThread(int pid);
155     void launchDeferredOneTimeCode();
156
157     BPatch_thread *getThreadByPid(int pid, bool *exists = NULL);
158
159     static void reportError(BPatchErrorLevel severity, int number, const char *str);
160
161     void clearError() { lastError = 0; }
162     int getLastError() { return lastError; }
163     // End of functions that are for internal use only
164
165 #ifdef IBM_BPATCH_COMPAT
166     int getLastErrorCode() { return lastError; }
167
168     BPatchThreadEventCallback registerDetachDoneCallback(BPatchThreadEventCallback) { return NULL; }
169     BPatchThreadEventCallback registerSnippetRemovedCallback(BPatchThreadEventCallback) { return NULL; }
170     
171     BPatchExitCallback registerSignalCallback(BPatchThreadEventCallback func, int sigNum) {return NULL;}
172     BPatchExitCallback registerExitCallback(BPatchThreadEventCallback func);
173
174     BPatchThreadEventCallback registerRPCTerminationCallback(BPatchThreadEventCallback);
175     BPatchThreadEventCallback           RPCdoneCallback;
176 #endif
177
178     BPatch();
179     ~BPatch();
180
181     static const char *getEnglishErrorString(int number);
182     static void formatErrorString(char *dst, int size,
183                                   const char *fmt, const char **params);
184     BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
185     BPatchDynLibraryCallback registerDynLibraryCallback(BPatchDynLibraryCallback function);
186     BPatchForkCallback registerPostForkCallback(BPatchForkCallback func);
187     BPatchForkCallback registerPreForkCallback(BPatchForkCallback func);
188     BPatchExecCallback registerExecCallback(BPatchExecCallback func);
189     BPatchExitCallback registerExitCallback(BPatchExitCallback func);
190     BPatchOneTimeCodeCallback registerOneTimeCodeCallback(BPatchOneTimeCodeCallback func);
191
192     BPatch_Vector<BPatch_thread*> *getThreads();
193
194     void setDebugParsing(bool x) { debugParseOn = x; }
195     void setBaseTrampDeletion(bool x) { baseTrampDeletionOn = x; }
196     void setTypeChecking(bool x) { typeCheckOn = x; }
197     void setTrampRecursive(bool x) { trampRecursiveOn = x; }
198     void setForcedRelocation_NP(bool x) { forceRelocation_NP = x; }
199
200     BPatch_thread *createProcess(const char *path, char *argv[], 
201         char *envp[] = NULL, int stdin_fd=0, int stdout_fd=1, int stderr_fd=2);
202     BPatch_thread *attachProcess(const char *path, int pid);
203
204     // Create Enum types. 
205     BPatch_type * createEnum(const char * name, 
206         BPatch_Vector<char *> elementNames,
207         BPatch_Vector<int> elementIds);
208     
209     // API selects elemetIds
210     BPatch_type * createEnum(const char * name, 
211         BPatch_Vector<char *> elementNames);
212
213     // Create Struct types. 
214     BPatch_type * createStruct( const char * name,
215                                 BPatch_Vector<char *> fieldNames,
216                                 BPatch_Vector<BPatch_type *> fieldTypes);
217
218     // Create Union types. 
219     BPatch_type * createUnion( const char * name, 
220                                 BPatch_Vector<char *> fieldNames,
221                                 BPatch_Vector<BPatch_type *> fieldTypes);
222  
223     // Creates BPatch_array type or symtyperanges ( scalars with upper and
224    //lower bound).
225     BPatch_type * createArray( const char * name, BPatch_type * ptr,
226                                unsigned int low, unsigned int hi );
227
228     // Creates BPatch_pointer types      
229     BPatch_type * createPointer( const char * name, BPatch_type * ptr,
230                                  int size = sizeof(void *));
231
232     // Creates BPatch_scalar types
233     BPatch_type * createScalar( const char * name, int size );
234     
235     // Creates typedefs.
236     BPatch_type * createTypedef( const char * name, BPatch_type * ptr );
237          
238     bool        pollForStatusChange();
239     bool        waitForStatusChange();
240
241     bool waitUntilStopped(BPatch_thread *appThread);
242 };
243
244 #endif /* _BPatch_h_ */