Adds internal threads for event handling in dyninst
[dyninst.git] / dyninstAPI / src / BPatch_asyncEventHandler.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
43 #ifndef __BPATCH_ASYNC_EVENT_HANDLER_H__
44 #define __BPATCH_ASYNC_EVENT_HANDLER_H__
45
46 #if defined (os_osf)
47 #include <standards.h>
48 #endif
49
50 #include <errno.h>
51 #include <BPatch_eventLock.h>
52 #include <BPatch.h>
53 #include <BPatch_process.h>
54 #include <BPatch_image.h>
55 #include <BPatch_Vector.h>
56 #include "common/h/Pair.h"
57 #include "common/h/Vector.h"
58 #include "EventHandler.h"
59 #include "dyninstAPI_RT/h/dyninstAPI_RT.h" // for BPatch_asyncEventType
60                                            //  and BPatch_asyncEventRecord
61 #if defined(os_windows)
62
63 #include <winsock2.h>
64 #define ssize_t int
65 typedef SOCKET PDSOCKET;
66 #define DYNINST_ASYNC_PORT 28003
67 #define CLOSEPDSOCKET(s) closesocket(s)
68 #define PDSOCKET_ERRNO WSAGetLastError()
69 #define INVALID_PDSOCKET (INVALID_SOCKET)
70 #define PDSOCKET_ERROR SOCKET_ERROR
71 #define SOCKET_TYPE PF_INET
72 #define THREAD_RETURN void
73 #define DO_THREAD_RETURN return
74 #define SOCKLEN_T unsigned int
75
76 #else
77 #include <sys/types.h>
78 #include <sys/socket.h>
79 #include <pthread.h>
80 typedef int PDSOCKET;
81
82 #define CLOSEPDSOCKET(s) P_close(s)
83 #define PDSOCKET_ERRNO errno
84 #define INVALID_PDSOCKET (-1)
85 #define PDSOCKET_ERROR (-1)
86 #define SOCKET_TYPE PF_UNIX
87 #define THREAD_RETURN void *
88 #define DO_THREAD_RETURN return NULL
89 #if defined(os_osf)
90 #define SOCKLEN_T size_t 
91 #elif defined(os_irix)
92 #define SOCKLEN_T std::size_t 
93 #else
94 #define SOCKLEN_T socklen_t 
95 #endif
96 #endif
97
98 #if defined (os_windows)
99 #define THREAD_LIB_NAME "MSVCRT"
100 #elif defined (os_solaris)
101 #define THREAD_LIB_NAME "libthread"
102 #else
103 #define THREAD_LIB_NAME "libpthread"
104 #endif
105
106
107 typedef struct {
108     BPatchDynamicCallSiteCallback cb;
109     void *handle;
110     BPatch_point *pt;
111 } dyncall_cb_record;
112
113 typedef struct {
114     pdvector<BPatch_function *> *mutatee_side_cbs;
115     pdvector<BPatchSnippetHandle *> *handles;
116 } thread_event_cb_record;
117
118 typedef struct {
119   BPatch_process *process;
120   int fd;
121 } process_record;
122
123 const char *asyncEventType2Str(BPatch_asyncEventType evtype); 
124
125 #ifdef DYNINST_CLASS_NAME
126 #undef DYNINST_CLASS_NAME
127 #endif
128 #define DYNINST_CLASS_NAME BPatch_asyncEventHandler
129
130 class BPatch_asyncEventHandler : public EventHandler<EventRecord> {
131   friend THREAD_RETURN asyncHandlerWrapper(void *);
132   friend class BPatch;  // only BPatch constructs & does init
133   friend class BPatch_eventMailbox;
134   public:
135     //  BPatch_asyncEventHandler::connectToProcess()
136     //  Tells the async event handler that there is a new process
137     //  to listen for.
138     bool connectToProcess(BPatch_process *p);
139
140     //  BPatch_asyncEventHandler::detachFromProcess()
141     //  stop paying attention to events from specified process
142     bool detachFromProcess(BPatch_process *p);
143
144     bool startupThread();
145   private: 
146     BPatch_asyncEventHandler();
147     pdvector<EventRecord> event_queue;
148     bool initialize();  //  want to catch init errors, so we do most init here
149     virtual ~BPatch_asyncEventHandler();
150
151     //  BPatch_asyncEventHandler::shutDown()
152     //  Sets a flag that the async thread will check during its next iteration.
153     //  When set, the handler thread will shut itself down.
154     bool shutDown();
155
156
157     //  BPatch_asyncEventHandler::waitNextEvent()
158     //  Wait for the next event to come from a mutatee.  Essentially 
159     //  a big call to select().
160    virtual bool waitNextEvent(EventRecord &ev);
161
162     //  BPatch_asyncEventHandler::handleEvent()
163     //  called after waitNextEvent, obtains global lock and handles event.
164     //  Since event handling needs to be a locked operation (esp. if it 
165     //  requires accessing lower level dyninst data structures), this is
166     //  where it should be done.
167     virtual bool handleEvent(EventRecord &ev)
168          { LOCK_FUNCTION(bool, handleEventLocked, (ev)); }
169     bool handleEventLocked(EventRecord &ev);
170
171     //  BPatch_asyncEventHandler::readEvent()
172     //  Reads from the async fd connection to the mutatee
173     static bool readEvent(PDSOCKET fd, void *ev, ssize_t sz);
174     static bool readEvent(PDSOCKET fd, EventRecord &ev);
175
176     //  BPatch_asyncEventHandler::mutateeDetach()
177     //  use oneTimeCode to call a function in the mutatee to handle
178     //  closing of the comms socket.
179
180     bool mutateeDetach(BPatch_process *p);
181
182     //  BPatch_asyncEventHandler::cleanUpTerminatedProcs()
183     //  clean up any references to terminated processes in our lists
184     //  (including any user specified callbacks).
185     bool cleanUpTerminatedProcs();
186     //  BPatch_asyncEventHandler::instrumentThreadEvent
187     //  Associates a function in the thread library with a eventType
188     BPatchSnippetHandle *instrumentThreadEvent(BPatch_process *process,
189                                                BPatch_asyncEventType t,
190                                                BPatch_function *f);
191
192     //  These vars are only modified as part of init (before/while threads are
193     //  created) so we do not need to worry about locking them:
194     PDSOCKET sock;
195     bool shutDownFlag;
196 #if defined (os_windows)
197     unsigned int listen_port;
198     unsigned long handler_thread;
199 #else
200     pthread_t handler_thread;
201 #endif
202
203     //  The rest:  Data in this class that is not exclusively set during init
204     //   will have to be locked.  
205     pdvector<process_record> process_fds;
206
207     //  dyn_pts holds BPatch_point and callback info for dynamic call events.
208     //  XXX -- since this is linearly searched for each dynamic call event
209     //  it could get prohibitively slow in cases where there are a lot of
210     //  requests to monitor dynamic calls.  Maybe a (somewhat more complex)
211     //  data structure is necessary?
212     pdvector<dyncall_cb_record> dyn_pts;
213 };
214
215 BPatch_asyncEventHandler *getAsync();
216
217 #endif // __BPATCH_EVENT_HANDLER_H__