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