1 //===-- ProcessKDP.h --------------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef liblldb_ProcessKDP_h_
11 #define liblldb_ProcessKDP_h_
12 
13 // C Includes
14 
15 // C++ Includes
16 #include <list>
17 #include <vector>
18 
19 // Other libraries and framework includes
20 #include "lldb/Core/ArchSpec.h"
21 #include "lldb/Core/Broadcaster.h"
22 #include "lldb/Core/Error.h"
23 #include "lldb/Core/InputReader.h"
24 #include "lldb/Core/StreamString.h"
25 #include "lldb/Core/StringList.h"
26 #include "lldb/Core/ThreadSafeValue.h"
27 #include "lldb/Target/Process.h"
28 #include "lldb/Target/Thread.h"
29 
30 #include "CommunicationKDP.h"
31 #include "Utility/StringExtractor.h"
32 
33 class ThreadKDP;
34 
35 class ProcessKDP : public lldb_private::Process
36 {
37 public:
38     //------------------------------------------------------------------
39     // Constructors and Destructors
40     //------------------------------------------------------------------
41     static lldb::ProcessSP
42     CreateInstance (lldb_private::Target& target,
43                     lldb_private::Listener &listener,
44                     const lldb_private::FileSpec *crash_file_path);
45 
46     static void
47     Initialize();
48 
49     static void
50     Terminate();
51 
52     static const char *
53     GetPluginNameStatic();
54 
55     static const char *
56     GetPluginDescriptionStatic();
57 
58     //------------------------------------------------------------------
59     // Constructors and Destructors
60     //------------------------------------------------------------------
61     ProcessKDP(lldb_private::Target& target, lldb_private::Listener &listener);
62 
63     virtual
64     ~ProcessKDP();
65 
66     //------------------------------------------------------------------
67     // Check if a given Process
68     //------------------------------------------------------------------
69     virtual bool
70     CanDebug (lldb_private::Target &target,
71               bool plugin_specified_by_name);
72 
73     //    virtual uint32_t
74     //    ListProcessesMatchingName (const char *name, lldb_private::StringList &matches, std::vector<lldb::pid_t> &pids);
75 
76     //------------------------------------------------------------------
77     // Creating a new process, or attaching to an existing one
78     //------------------------------------------------------------------
79     virtual lldb_private::Error
80     WillLaunch (lldb_private::Module* module);
81 
82     virtual lldb_private::Error
83     DoLaunch (lldb_private::Module *exe_module,
84               const lldb_private::ProcessLaunchInfo &launch_info);
85 
86     virtual lldb_private::Error
87     WillAttachToProcessWithID (lldb::pid_t pid);
88 
89     virtual lldb_private::Error
90     WillAttachToProcessWithName (const char *process_name, bool wait_for_launch);
91 
92     virtual lldb_private::Error
93     DoConnectRemote (const char *remote_url);
94 
95     virtual lldb_private::Error
96     DoAttachToProcessWithID (lldb::pid_t pid);
97 
98     virtual lldb_private::Error
99     DoAttachToProcessWithID (lldb::pid_t pid, const lldb_private::ProcessAttachInfo &attach_info);
100 
101     virtual lldb_private::Error
102     DoAttachToProcessWithName (const char *process_name, bool wait_for_launch, const lldb_private::ProcessAttachInfo &attach_info);
103 
104     virtual void
105     DidAttach ();
106 
107     //------------------------------------------------------------------
108     // PluginInterface protocol
109     //------------------------------------------------------------------
110     virtual const char *
111     GetPluginName();
112 
113     virtual const char *
114     GetShortPluginName();
115 
116     virtual uint32_t
117     GetPluginVersion();
118 
119     //------------------------------------------------------------------
120     // Process Control
121     //------------------------------------------------------------------
122     virtual lldb_private::Error
123     WillResume ();
124 
125     virtual lldb_private::Error
126     DoResume ();
127 
128     virtual lldb_private::Error
129     DoHalt (bool &caused_stop);
130 
131     virtual lldb_private::Error
132     WillDetach ();
133 
134     virtual lldb_private::Error
135     DoDetach ();
136 
137     virtual lldb_private::Error
138     DoSignal (int signal);
139 
140     virtual lldb_private::Error
141     DoDestroy ();
142 
143     virtual void
144     RefreshStateAfterStop();
145 
146     //------------------------------------------------------------------
147     // Process Queries
148     //------------------------------------------------------------------
149     virtual bool
150     IsAlive ();
151 
152     //------------------------------------------------------------------
153     // Process Memory
154     //------------------------------------------------------------------
155     virtual size_t
156     DoReadMemory (lldb::addr_t addr, void *buf, size_t size, lldb_private::Error &error);
157 
158     virtual size_t
159     DoWriteMemory (lldb::addr_t addr, const void *buf, size_t size, lldb_private::Error &error);
160 
161     virtual lldb::addr_t
162     DoAllocateMemory (size_t size, uint32_t permissions, lldb_private::Error &error);
163 
164     virtual lldb_private::Error
165     DoDeallocateMemory (lldb::addr_t ptr);
166 
167     //----------------------------------------------------------------------
168     // Process Breakpoints
169     //----------------------------------------------------------------------
170     virtual lldb_private::Error
171     EnableBreakpoint (lldb_private::BreakpointSite *bp_site);
172 
173     virtual lldb_private::Error
174     DisableBreakpoint (lldb_private::BreakpointSite *bp_site);
175 
176     //----------------------------------------------------------------------
177     // Process Watchpoints
178     //----------------------------------------------------------------------
179     virtual lldb_private::Error
180     EnableWatchpoint (lldb_private::Watchpoint *wp);
181 
182     virtual lldb_private::Error
183     DisableWatchpoint (lldb_private::Watchpoint *wp);
184 
185     CommunicationKDP &
186     GetCommunication()
187     {
188         return m_comm;
189     }
190 
191 protected:
192     friend class ThreadKDP;
193     friend class CommunicationKDP;
194 
195     //----------------------------------------------------------------------
196     // Accessors
197     //----------------------------------------------------------------------
198     bool
199     IsRunning ( lldb::StateType state )
200     {
201         return    state == lldb::eStateRunning || IsStepping(state);
202     }
203 
204     bool
205     IsStepping ( lldb::StateType state)
206     {
207         return    state == lldb::eStateStepping;
208     }
209 
210     bool
211     CanResume ( lldb::StateType state)
212     {
213         return state == lldb::eStateStopped;
214     }
215 
216     bool
217     HasExited (lldb::StateType state)
218     {
219         return state == lldb::eStateExited;
220     }
221 
222     bool
223     ProcessIDIsValid ( ) const;
224 
225     //    static void
226     //    STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len);
227 
228     //    void
229     //    AppendSTDOUT (const char* s, size_t len);
230 
231     void
232     Clear ( );
233 
234     virtual bool
235     UpdateThreadList (lldb_private::ThreadList &old_thread_list,
236                       lldb_private::ThreadList &new_thread_list);
237 
238     enum
239     {
240         eBroadcastBitAsyncContinue                  = (1 << 0),
241         eBroadcastBitAsyncThreadShouldExit          = (1 << 1)
242     };
243 
244     lldb_private::Error
245     InterruptIfRunning (bool discard_thread_plans,
246                         bool catch_stop_event,
247                         lldb::EventSP &stop_event_sp);
248 
249     //------------------------------------------------------------------
250     /// Broadcaster event bits definitions.
251     //------------------------------------------------------------------
252     CommunicationKDP m_comm;
253     lldb_private::Broadcaster m_async_broadcaster;
254     lldb::thread_t m_async_thread;
255 
256     bool
257     StartAsyncThread ();
258 
259     void
260     StopAsyncThread ();
261 
262     static void *
263     AsyncThread (void *arg);
264 
265     lldb::StateType
266     SetThreadStopInfo (StringExtractor& stop_packet);
267 
268 private:
269     //------------------------------------------------------------------
270     // For ProcessKDP only
271     //------------------------------------------------------------------
272 
273     DISALLOW_COPY_AND_ASSIGN (ProcessKDP);
274 
275 };
276 
277 #endif  // liblldb_ProcessKDP_h_
278