small step towards migrating BPatch_asyncEventHandler down to the process layer,...
[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 #if 0
52 #include <BPatch_eventLock.h>
53 #include <BPatch.h>
54 #include <BPatch_image.h>
55 #include <BPatch_Vector.h>
56 #endif
57
58 #include "os.h"
59 #include "EventHandler.h"
60 #include "process.h"
61 #include <BPatch_process.h> // for BPatch_asyncEventType
62 #include "dyninstAPI_RT/h/dyninstAPI_RT.h" // for BPatch_asyncEventRecord
63 #include "common/h/Pair.h"
64 #include "common/h/Vector.h"
65
66 #if 0
67 typedef struct {
68     pdvector<BPatch_function *> *mutatee_side_cbs;
69     pdvector<BPatchSnippetHandle *> *handles;
70 } thread_event_cb_record;
71 #endif
72
73 typedef struct {
74   process *proc;
75   int fd;
76   PDSOCKET sock;
77 } process_record;
78
79 #if 0
80 typedef enum {
81         BPatch_nullEvent,
82         BPatch_newConnectionEvent,
83         BPatch_internalShutDownEvent,
84         BPatch_threadCreateEvent,
85         BPatch_threadDestroyEvent,
86         BPatch_dynamicCallEvent,
87         BPatch_userEvent,
88         BPatch_errorEvent,
89         BPatch_dynLibraryEvent,
90         BPatch_preForkEvent,
91         BPatch_postForkEvent,
92         BPatch_execEvent,
93         BPatch_exitEvent,
94         BPatch_signalEvent,
95         BPatch_oneTimeCodeEvent
96 } BPatch_asyncEventType;
97 #endif
98
99 const char *asyncEventType2Str(BPatch_asyncEventType evtype); 
100
101 #ifdef DYNINST_CLASS_NAME
102 #undef DYNINST_CLASS_NAME
103 #endif
104 #define DYNINST_CLASS_NAME BPatch_asyncEventHandler
105
106 class BPatch_asyncEventHandler : public EventHandler<EventRecord> {
107         friend THREAD_RETURN asyncHandlerWrapper(void *);
108         friend class BPatch;  // only BPatch constructs & does init
109         friend class BPatch_eventMailbox;
110         public:
111         //  BPatch_asyncEventHandler::connectToProcess()
112         //  Tells the async event handler that there is a new process
113         //  to listen for.
114         bool connectToProcess(process *p);
115
116         //  BPatch_asyncEventHandler::detachFromProcess()
117         //  stop paying attention to events from specified process
118         bool detachFromProcess(process *p);
119
120         bool startupThread();
121
122     bool registerMonitoredPoint(BPatch_point *);
123   private: 
124     BPatch_asyncEventHandler();
125     pdvector<EventRecord> event_queue;
126     bool initialize();  //  want to catch init errors, so we do most init here
127     virtual ~BPatch_asyncEventHandler();
128         PDSOCKET setup_socket(int mutatee_pid, std::string &sock_fname);
129
130     //  BPatch_asyncEventHandler::shutDown()
131     //  Sets a flag that the async thread will check during its next iteration.
132     //  When set, the handler thread will shut itself down.
133     bool shutDown();
134
135
136     //  BPatch_asyncEventHandler::waitNextEvent()
137     //  Wait for the next event to come from a mutatee.  Essentially 
138     //  a big call to select().
139    virtual bool waitNextEvent(EventRecord &ev);
140
141     //  BPatch_asyncEventHandler::handleEvent()
142     //  called after waitNextEvent, obtains global lock and handles event.
143     //  Since event handling needs to be a locked operation (esp. if it 
144     //  requires accessing lower level dyninst data structures), this is
145     //  where it should be done.
146     virtual bool handleEvent(EventRecord &ev)
147        { __LOCK; bool ret = handleEventLocked(ev); __UNLOCK; return ret; }
148     bool handleEventLocked(EventRecord &ev);
149
150     //  BPatch_asyncEventHandler::readEvent()
151     //  Reads from the async fd connection to the mutatee
152     //static asyncReadReturnValue_t readEvent(PDSOCKET fd, void *ev, ssize_t sz);
153     static readReturnValue_t readEvent(PDSOCKET fd, EventRecord &ev);
154
155     //  BPatch_asyncEventHandler::mutateeDetach()
156     //  use oneTimeCode to call a function in the mutatee to handle
157     //  closing of the comms socket.
158
159     bool mutateeDetach(process *p);
160
161     //  BPatch_asyncEventHandler::cleanUpTerminatedProcs()
162     //  clean up any references to terminated processes in our lists
163     //  (including any user specified callbacks).
164     bool cleanUpTerminatedProcs();
165
166     //  BPatch_asyncEventHandler::cleanupProc(process *p)
167     //  remove a particular process without detaching. Used in 
168     //  exec.
169     bool cleanupProc(process *p);
170
171 #if 0
172     //  BPatch_asyncEventHandler::instrumentThreadEvent
173     //  Associates a function in the thread library with a eventType
174     BPatchSnippetHandle *instrumentThreadEvent(BPatch_process *process,
175                                                BPatch_asyncEventType t,
176                                                BPatch_function *f);
177 #endif
178
179 #if defined (os_windows)
180     //  These vars are only modified as part of init (before/while threads are
181     //  created) so we do not need to worry about locking them:
182     PDSOCKET windows_sock;
183     unsigned int listen_port;
184 #else
185         int control_pipe_read, control_pipe_write;
186 #endif
187     bool shutDownFlag;
188
189     //  The rest:  Data in this class that is not exclusively set during init
190     //   will have to be locked.  
191     pdvector<process_record> process_fds;
192
193     dictionary_hash<Address, BPatch_point *> monitored_points;
194 };
195
196 BPatch_asyncEventHandler *getAsync();
197
198 #endif // __BPATCH_EVENT_HANDLER_H__