Added features to the dyninst API library, including an optional "else"
[dyninst.git] / dyninstAPI / src / BPatch.C
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 #include <stdio.h>
43 #include <assert.h>
44 #include <signal.h>
45 #include <sys/wait.h>
46
47 #include "BPatch.h"
48 #include "BPatch_type.h"
49 #include "BPatch_libInfo.h"
50 #include "process.h"
51
52 extern bool dyninstAPI_init();
53 extern int dyninstAPI_handleSigChild(int pid, int status);
54
55
56 BPatch *BPatch::bpatch = NULL;
57
58
59 /*
60  * BPatch::BPatch
61  *
62  * Constructor for BPatch.  Performs one-time initialization needed by the
63  * library.
64  */
65 BPatch::BPatch() : errorHandler(NULL), typeCheckOn(true)
66 {
67     extern bool init();
68     extern double cyclesPerSecond;
69     extern double timing_loop(const unsigned, const unsigned);
70
71     // Save a pointer to the one-and-only bpatch object.
72     if (bpatch == NULL)
73         bpatch = this;
74     /* XXX else
75      *  (indicate an error somehow)
76      */
77
78     // XXX dyninstAPI_init returns success/failure -- should pass on somehow
79     dyninstAPI_init();
80     cyclesPerSecond = timing_loop(1, 100000) * 1000000;
81
82     /*
83      * Create the library private info object.
84      */
85     info = new BPatch_libInfo;
86
87     /*
88      * Create the "error" and "untyped" types.
89      */
90     type_Error   = new BPatch_type("<error>", true);
91     type_Untyped = new BPatch_type("<no type>", true);
92
93     /*
94      * Initialize hash table of standard types.
95      */
96     stdTypes = new BPatch_typeCollection;
97     stdTypes->addType(new BPatch_type("int"));
98     stdTypes->addType(new BPatch_type("char *"));
99 }
100
101
102 /*
103  * BPatch::~BPatch
104  *
105  * Destructor for BPatch.  Free allocated memory.
106  */
107 BPatch::~BPatch()
108 {
109     delete info;
110
111     delete type_Error;
112     delete type_Untyped;
113
114     delete stdTypes;
115 }
116
117
118 /*
119  * BPatch::registerErrorCallback
120  *
121  * Registers a function that is to be called by the library when an error
122  * occurs or when there is status to report.  Returns the address of the
123  * previously registered error callback function.
124  *
125  * function     The function to be called.
126  */
127 BPatchErrorCallback BPatch::registerErrorCallback(BPatchErrorCallback function)
128 {
129     BPatchErrorCallback ret;
130
131     ret = errorHandler;
132     errorHandler = function;
133
134     return ret;
135 }
136
137
138 /*
139  * BPatch::getEnglishErrorString
140  *
141  * Returns the descriptive error string for the passed error number.
142  *
143  * number       The number that identifies the error.
144  */
145 const char *BPatch::getEnglishErrorString(int /* number */)
146 {
147     return "%s";
148 }
149
150
151 /*
152  * BPatch::reportError
153  *
154  * Report an error using the callback mechanism.
155  *
156  * severity     The severity level of the error.
157  * number       Identifies the error.
158  * str          A string to pass as the first element of the list of strings
159  *              given to the callback function.
160  */
161 void BPatch::reportError(BPatchErrorLevel severity, int number, const char *str)
162 {
163     if (errorHandler != NULL) {
164         errorHandler(severity, number, &str);
165     }
166 }
167
168
169 /*
170  * BPatch::formatErrorString
171  *
172  * Takes a format string with an error message (obtained from
173  * getEnglishErrorString) and an array of parameters that were passed to an
174  * error callback function, and creates a string with the parameters
175  * substituted into it.
176  *
177  * dst          The address into which the formatted string should be copied.
178  * size         If the formatted string is equal to or longer than this number
179  *              of characters, then it will be truncated to size-1 characters
180  *              and terminated with a nul ('\0').
181  * fmt          The format string (returned by a function such as
182  *              getEnglishErrorString).
183  * params       The array of parameters that were passed to an error callback
184  *              function.
185  */
186 void BPatch::formatErrorString(char *dst, int size,
187                                const char *fmt, const char **params)
188 {
189     int cur_param = 0;
190
191     while (size > 1 && *fmt) {
192         if (*fmt == '%') {
193             if (fmt[1] == '\0') {
194                 break;
195             } else if (fmt[1] == '%') {
196                 *dst++ = '%';
197                 size--;
198             } else if (fmt[1] == 's') {
199                 char *p = (char *)params[cur_param++];
200                 while (size > 1 && *p) {
201                     *dst++ = *p++;
202                     size--;
203                 }
204             } else {
205                 // Illegal specifier
206                 *dst++ = fmt[0];
207                 *dst++ = fmt[1];
208                 size -= 2;
209             }
210             fmt += 2;
211         } else {
212             *dst++ = *fmt++;
213             size--;
214         }
215     }
216     if (size > 0)
217         *dst = '\0';
218 }
219
220
221 /*
222  * BPatch::pidToThread
223  *
224  * Given a process ID, this function returns a pointer to the associated
225  * BPatch_thread object (or NULL if there is none).
226  */
227 BPatch_thread *BPatch::pidToThread(int pid)
228 {
229     if (info->threadsByPid.defines(pid))
230         return info->threadsByPid[pid];
231     else
232         return NULL;
233 }
234
235
236 /*
237  * BPatch::getThreads
238  *
239  * Returns a vector of all threads that are currently defined.  Includes
240  * threads created directly using the library and those created with UNIX fork
241  * or Windows NT spawn system calls.  The caller is responsible for deleting
242  * the vector when it is no longer needed.
243  */
244 BPatch_Vector<BPatch_thread *> *BPatch::getThreads()
245 {
246     BPatch_Vector<BPatch_thread *> *result = new BPatch_Vector<BPatch_thread *>;
247
248     dictionary_hash_iter<int, BPatch_thread *> ti(info->threadsByPid);
249
250     int pid;
251     BPatch_thread *thread;
252
253     while (ti.next(pid, thread))
254         result->push_back(thread);
255
256     return result;
257 }
258
259
260 /*
261  * pollForStatusChange
262  *
263  * Checks for changes in the state of any child process, and returns true if
264  * it discovers any such changes.  Also updates the process object
265  * representing each process for which a change is detected.
266  *
267  * This function is declared as a friend of BPatch_thread so that it can use
268  * the BPatch_thread::pidToThread call and so that it can set the lastSignal
269  * member of a BPatch_thread object.
270  */
271 bool pollForStatusChange()
272 {
273     bool        result = false;
274     int         pid, status;
275
276     while ((pid = process::waitProcs(&status)) > 0) {
277         // There's been a change in a child process
278         result = true;
279         assert(BPatch::bpatch != NULL);
280         BPatch_thread *thread = BPatch::bpatch->pidToThread(pid);
281         if (thread == NULL) {
282             fprintf(stderr, "Warning - wait returned status of an unknown process (%d)\n", pid);
283         }
284         if (thread != NULL) {
285             if (WIFSTOPPED(status))
286                 thread->lastSignal = WSTOPSIG(status);
287             else if (WIFSIGNALED(status))
288                 thread->lastSignal = WTERMSIG(status);
289             else if (WIFEXITED(status))
290                 thread->lastSignal = 0; /* XXX Make into some constant */
291         }
292         dyninstAPI_handleSigChild(pid, status);
293     }
294     return result;
295 }
296
297
298 /*
299  * BPatch::registerThread
300  *
301  * Register a new BPatch_thread object with the BPatch library (this function
302  * is called only by the constructor for BPatch_thread).
303  *
304  * thread       A pointer to the thread to register.
305  */
306 void BPatch::registerThread(BPatch_thread *thread)
307 {
308     assert(!info->threadsByPid.defines(thread->getPid()));
309     info->threadsByPid[thread->getPid()] = thread;
310 }
311
312
313 /*
314  * BPatch::unRegisterThread
315  *
316  * Remove the BPatch_thread associated with a given pid from the list of
317  * threads being managed by the library.
318  *
319  * pid          The pid of the thread to be removed.
320  */
321 void BPatch::unRegisterThread(int pid)
322 {
323     assert(info->threadsByPid.defines(pid));
324     info->threadsByPid.undef(pid);      
325 }