BPatch functions that block are now locked (on a finer grain than the rest of the...
[dyninst.git] / dyninstAPI / src / signalhandler.h
1 /*
2  * Copyright (c) 1996-2004 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 /* $Id: signalhandler.h,v 1.12 2005/02/25 07:04:47 jaw Exp $
43  */
44
45 /*
46  * This file describes the entry points to the signal handling
47  * routines. This is meant to provide a single interface to bother
48  * the varied UNIX-style handlers and the NT debug event system.
49  * Further platform-specific details can be found in the
50  * signalhandler-unix.h and signalhandler-winnt.h files.
51  */
52
53 #ifndef _SIGNAL_HANDLER_H
54 #define _SIGNAL_HANDLER_H
55
56 #if defined(i386_unknown_nt4_0)
57 #include "dyninstAPI/src/signalhandler-winnt.h"
58 #else
59 #include "dyninstAPI/src/signalhandler-unix.h"
60 #endif
61
62 class process;
63 class dyn_lwp;
64
65
66 // Return code:
67 // 0: no event
68 // 1: event fount
69
70 // pid: -1 for all processes
71 // why: Why the process stopped (return parameter)
72 // what: what caused the stop (return parameter)
73 // block: block waiting for a signal?
74 // waitProcs replacement
75
76 class signalHandler {
77    int handleProcessEventInternal(const procevent &event);
78
79  public:
80    signalHandler() { }
81
82    // checks for process events and handles any events that were found
83    // Returns whatever it doesn't know how to handle
84    pdvector <procevent *> checkForAndHandleProcessEvents(bool block);
85
86    // checkForProcessEvents: check whether there is an event on any process
87    // we're debugging. If one is found decode it and return.  Returns true if
88    // found events, otherwise false.
89    // If timeout is -1, this function will block.
90    // Otherwise, it will return after waiting for specified timeout (in ms)
91    // timeout will be set to 0 if the function timed out.
92    bool checkForProcessEvents(pdvector<procevent *> *events,
93                               int wait_arg, int &timeout);
94
95    // handles process events, unlocks locked processes, deletes proc events
96    // Returns events it doesn't know what to do with
97    pdvector <procevent *> handleProcessEvents(pdvector<procevent *> &foundEvents);
98    int handleProcessEvent(const procevent &event);
99 };
100
101 extern signalHandler *global_sh;
102 signalHandler *getSH();
103
104 /////////////////////
105 // Callbacks.
106 /////////////////////
107
108 // Note: Replace with BPatch callbacks when Paradyn can use them
109 // Fork entry
110 typedef void (*forkEntryCallback_t)(process *p, void *data);
111 // Fork exit: include new pid
112 typedef void (*forkExitCallback_t)(process *p, void *data, process *child);
113 // Exec entry: include program argument
114 typedef void (*execEntryCallback_t)(process *p, void *data, char *arg0);
115 // Exec exit
116 typedef void (*execExitCallback_t)(process *p, void *data);
117 // Exit entry: include exit code
118 typedef void (*exitEntryCallback_t)(process *p, void *data, int code);
119
120
121 #endif
122
123