Fix instrumentation regressions for libc-2.29 on ARM (#653)
[dyninst.git] / dyninstAPI / src / pcEventHandler.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #ifndef PCEVENTHANDLER_H
32 #define PCEVENTHANDLER_H
33
34 #include "Event.h"
35 #include "dyninstAPI/h/BPatch_process.h"
36
37 #include <unordered_map>
38 #include "common/src/Types.h"
39 #include "common/src/dthread.h"
40
41 #include "syscallNotification.h"
42
43 #include <queue>
44 #include <set>
45
46 class PCProcess;
47 class inferiorRPCinProgress;
48 class PCEventMuxer;
49
50 /*
51  * pcEventHandler.h
52  *
53  * The entry point for event and callback handling.
54  *
55  * 1:1 class with PCProcess that encapsulates all event handling, including waiting for
56  * events and callbacks. 
57  */
58
59 class PCEventHandler {
60         typedef ProcControlAPI::Event::const_ptr EventPtr;
61         // Why syscallNotification is a friend:
62     //
63     // It is a friend because it reaches in to determine whether to install
64     // breakpoints at specific system calls. I didn't want to expose this to
65     // the rest of Dyninst.
66     
67     friend class syscallNotification;
68         friend class PCEventMuxer;
69 public:
70
71         static PCEventHandler &handler() { return handler_; }
72         static bool handle(EventPtr ev);
73
74 protected:
75     PCEventHandler();
76
77         bool handle_internal(EventPtr ev);
78
79     bool handleExit(ProcControlAPI::EventExit::const_ptr ev, PCProcess *evProc) const;
80     bool handleFork(ProcControlAPI::EventFork::const_ptr ev, PCProcess *evProc) const;
81     bool handleExec(ProcControlAPI::EventExec::const_ptr ev, PCProcess *&evProc) const;
82     bool handleCrash(ProcControlAPI::EventCrash::const_ptr ev, PCProcess *evProc) const;
83     bool handleForceTerminate(ProcControlAPI::EventForceTerminate::const_ptr ev, PCProcess *evProc) const;
84     bool handleThreadCreate(ProcControlAPI::EventNewThread::const_ptr ev, PCProcess *evProc) const;
85     bool handleThreadDestroy(ProcControlAPI::EventThreadDestroy::const_ptr ev, PCProcess *evProc) const;
86     bool handleSignal(ProcControlAPI::EventSignal::const_ptr ev, PCProcess *evProc) const;
87     bool handleLibrary(ProcControlAPI::EventLibrary::const_ptr ev, PCProcess *evProc) const;
88     bool handleBreakpoint(ProcControlAPI::EventBreakpoint::const_ptr ev, PCProcess *evProc) const;
89     bool handleRPC(ProcControlAPI::EventRPC::const_ptr ev, PCProcess *evProc) const;
90
91     enum RTBreakpointVal {
92         NoRTBreakpoint,
93         NormalRTBreakpoint,
94         SoftRTBreakpoint
95     };
96
97     bool handleRTBreakpoint(ProcControlAPI::EventBreakpoint::const_ptr ev, PCProcess *evProc) const;
98     bool handleStopThread(PCProcess *evProc, Address rt_arg) const;
99     bool handleUserMessage(PCProcess *evProc, BPatch_process *bpProc, Address rt_arg) const;
100     bool handleDynFuncCall(PCProcess *evProc, BPatch_process *bpProc, Address rt_arg) const;
101
102     // platform-specific
103     static bool shouldStopForSignal(int signal);
104     static bool isValidRTSignal(int signal, RTBreakpointVal breakpointVal, Address arg1, int status);
105     static bool isCrashSignal(int signal);
106     static bool isKillSignal(int signal);
107
108         static PCEventHandler handler_;
109 };
110
111 #endif