This commit provides code for the Windows CE 3.0 Pocket PC
[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 class BPATCH_DLL_EXPORT BPatch {
78     friend class BPatch_thread;
79     friend class process;
80
81     BPatch_libInfo      *info;
82
83     BPatchErrorCallback         errorHandler;
84     BPatchDynLibraryCallback    dynLibraryCallback;
85     BPatchForkCallback          postForkCallback;
86     BPatchForkCallback          preForkCallback;
87     BPatchExecCallback          execCallback;
88     BPatchExitCallback          exitCallback;
89     bool        typeCheckOn;
90     int         lastError;
91     bool        debugParseOn;
92
93     bool        getThreadEvent(bool block);
94     bool        havePendingEvent();
95
96     /* If true, trampolines can recurse to their heart's content.
97        Defaults to false */
98     bool        trampRecursiveOn;
99     bool        forceRelocation_NP;
100
101 public:
102     static BPatch                *bpatch;
103
104     BPatch_builtInTypeCollection *builtInTypes;
105     BPatch_typeCollection        *stdTypes;
106     BPatch_typeCollection        *APITypes; //API/User defined types
107     BPatch_type                  *type_Error;
108     BPatch_type                  *type_Untyped;
109 #ifdef mips_unknown_ce2_11 //ccw 28 july 2000
110         remoteDevice *rDevice;  //the ctor sets up the connection here and
111                                 //gets the tramptemplate from the CE device.
112 #endif
113
114  
115     bool isTypeChecked() { return typeCheckOn; }
116     bool parseDebugInfo() { return debugParseOn; }
117     bool isTrampRecursive() { return trampRecursiveOn; }
118     bool hasForcedRelocation_NP() { return forceRelocation_NP; }
119
120     // The following are only to be called by the library:
121     void registerProvisionalThread(int pid);
122     void registerForkedThread(int parentPid, int childPid, process *proc);
123     void registerExec(BPatch_thread *thread);
124     void registerExit(BPatch_thread *thread, int code);
125     void registerThread(BPatch_thread *thread);
126     void unRegisterThread(int pid);
127
128     BPatch_thread *getThreadByPid(int pid, bool *exists = NULL);
129
130     static void reportError(BPatchErrorLevel severity, int number, const char *str);
131
132     void clearError() { lastError = 0; }
133     int getLastError() { return lastError; }
134     // End of functions that are for internal use only
135
136     BPatch();
137     ~BPatch();
138
139     static const char *getEnglishErrorString(int number);
140     static void formatErrorString(char *dst, int size,
141                                   const char *fmt, const char **params);
142     BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
143     BPatchDynLibraryCallback registerDynLibraryCallback(BPatchDynLibraryCallback function);
144     BPatchForkCallback registerPostForkCallback(BPatchForkCallback func);
145     BPatchForkCallback registerPreForkCallback(BPatchForkCallback func);
146     BPatchExecCallback registerExecCallback(BPatchExecCallback func);
147     BPatchExitCallback registerExitCallback(BPatchExitCallback func);
148
149     BPatch_Vector<BPatch_thread*> *getThreads();
150
151     void setDebugParsing(bool x) { debugParseOn = x; }
152     void setTypeChecking(bool x) { typeCheckOn = x; }
153     void setTrampRecursive(bool x) { trampRecursiveOn = x; }
154     void setForcedRelocation_NP(bool x) { forceRelocation_NP = x; }
155
156     BPatch_thread *createProcess(char *path, char *argv[], 
157         char *envp[] = NULL, int stdin_fd=0, int stdout_fd=1, int stderr_fd=2);
158     BPatch_thread *attachProcess(char *path, int pid);
159
160     // Create Enum types. 
161     BPatch_type * createEnum(const char * name, 
162         BPatch_Vector<char *> elementNames,
163         BPatch_Vector<int> elementIds);
164     
165     // API selects elemetIds
166     BPatch_type * createEnum(const char * name, 
167         BPatch_Vector<char *> elementNames);
168
169     // Create Struct types. 
170     BPatch_type * createStruct( const char * name,
171                                 BPatch_Vector<char *> fieldNames,
172                                 BPatch_Vector<BPatch_type *> fieldTypes);
173
174     // Create Union types. 
175     BPatch_type * createUnion( const char * name, 
176                                 BPatch_Vector<char *> fieldNames,
177                                 BPatch_Vector<BPatch_type *> fieldTypes);
178  
179     // Creates BPatch_array type or symtyperanges ( scalars with upper and
180    //lower bound).
181     BPatch_type * createArray( const char * name, BPatch_type * ptr,
182                                unsigned int low, unsigned int hi );
183
184     // Creates BPatch_pointer types      
185     BPatch_type * createPointer( const char * name, BPatch_type * ptr,
186                                  int size = sizeof(void *));
187
188     // Creates BPatch_scalar types
189     BPatch_type * createScalar( const char * name, int size );
190     
191     // Creates typedefs.
192     BPatch_type * createTypedef( const char * name, BPatch_type * ptr );
193          
194     bool        pollForStatusChange();
195     bool        waitForStatusChange();
196 };
197
198 #endif /* _BPatch_h_ */