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