Added option to supress parsing debug info
[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_Vector.h"
47 #include "BPatch_thread.h"
48 #include "BPatch_type.h"
49
50 class BPatch_typeCollection;
51 class BPatch_libInfo;
52 class BPatch_module;
53
54 typedef enum {
55     BPatchFatal, BPatchSerious, BPatchWarning, BPatchInfo
56 } BPatchErrorLevel;
57
58 typedef void (*BPatchErrorCallback)(BPatchErrorLevel severity,
59                                     int number,
60                                     const char **params);
61
62 typedef void (*BPatchDynLibraryCallback)(BPatch_thread *thr,
63                                          BPatch_module *mod,
64                                          bool load);
65
66 class BPatch {
67     friend class BPatch_thread;
68     friend class process;
69
70     BPatch_libInfo      *info;
71
72     BPatchErrorCallback      errorHandler;
73     BPatchDynLibraryCallback dynLibraryCallback;
74     bool        typeCheckOn;
75     int         lastError;
76     bool        debugParseOn;
77
78     bool        getThreadEvent(bool block);
79     bool        havePendingEvent();
80
81 public:
82     static BPatch                *bpatch;
83
84     BPatch_builtInTypeCollection *builtInTypes;
85     BPatch_typeCollection        *stdTypes;
86     BPatch_typeCollection        *APITypes; //API/User defined types
87     BPatch_type                  *type_Error;
88     BPatch_type                  *type_Untyped;
89     
90     // The following are only to be called by the library:
91     bool isTypeChecked() { return typeCheckOn; }
92     bool parseDebugInfo() { return debugParseOn; }
93
94     void registerProvisionalThread(int pid);
95     void registerThread(BPatch_thread *thread);
96     void unRegisterThread(int pid);
97
98     BPatch_thread *getThreadByPid(int pid, bool *exists = NULL);
99
100     static void reportError(BPatchErrorLevel severity, int number, const char *str);
101
102     void clearError() { lastError = 0; }
103     int getLastError() { return lastError; }
104     // End of functions that are for internal use only
105
106     BPatch();
107     ~BPatch();
108
109     static const char *getEnglishErrorString(int number);
110     static void formatErrorString(char *dst, int size,
111                                   const char *fmt, const char **params);
112     BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
113     BPatchDynLibraryCallback registerDynLibraryCallback(BPatchDynLibraryCallback function);
114     BPatch_Vector<BPatch_thread*> *getThreads();
115
116     void setDebugParsing(bool x) { debugParseOn = x; }
117     void setTypeChecking(bool x) { typeCheckOn = x; }
118
119     BPatch_thread *createProcess(char *path, char *argv[], char *envp[] = NULL);
120     BPatch_thread *attachProcess(char *path, int pid);
121
122     // Create Enum types. 
123     BPatch_type * createEnum(const char * name, 
124         BPatch_Vector<char *> elementNames,
125         BPatch_Vector<int> elementIds);
126     
127     // API selects elemetIds
128     BPatch_type * createEnum(const char * name, 
129         BPatch_Vector<char *> elementNames);
130
131     // Create Struct types. 
132     BPatch_type * createStruct( const char * name,
133                                 BPatch_Vector<char *> fieldNames,
134                                 BPatch_Vector<BPatch_type *> fieldTypes);
135
136     // Create Union types. 
137     BPatch_type * createUnion( const char * name, 
138                                 BPatch_Vector<char *> fieldNames,
139                                 BPatch_Vector<BPatch_type *> fieldTypes);
140  
141     // Creates BPatch_array type or symtyperanges ( scalars with upper and
142    //lower bound).
143     BPatch_type * createArray( const char * name, BPatch_type * ptr,
144                                unsigned int low, unsigned int hi );
145
146     // Creates BPatch_pointer types      
147     BPatch_type * createPointer( const char * name, BPatch_type * ptr,
148                                  int size = sizeof(void *));
149
150     // Creates BPatch_scalar types
151     BPatch_type * createScalar( const char * name, int size );
152     
153     // Creates typedefs.
154     BPatch_type * createTypedef( const char * name, BPatch_type * ptr );
155          
156     bool        pollForStatusChange();
157     bool        waitForStatusChange();
158 };
159
160 #endif /* _BPatch_h_ */