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