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