1 //===-- GDBRemoteCommunicationClient.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_GDBRemoteCommunicationClient_h_
11 #define liblldb_GDBRemoteCommunicationClient_h_
12 
13 // C Includes
14 // C++ Includes
15 #include <vector>
16 
17 // Other libraries and framework includes
18 // Project includes
19 #include "lldb/Core/ArchSpec.h"
20 #include "lldb/Target/Process.h"
21 
22 #include "GDBRemoteCommunication.h"
23 
24 typedef enum
25 {
26     eBreakpointSoftware = 0,
27     eBreakpointHardware,
28     eWatchpointWrite,
29     eWatchpointRead,
30     eWatchpointReadWrite
31 } GDBStoppointType;
32 
33 class GDBRemoteCommunicationClient : public GDBRemoteCommunication
34 {
35 public:
36     //------------------------------------------------------------------
37     // Constructors and Destructors
38     //------------------------------------------------------------------
39     GDBRemoteCommunicationClient(bool is_platform);
40 
41     virtual
42     ~GDBRemoteCommunicationClient();
43 
44     //------------------------------------------------------------------
45     // After connecting, send the handshake to the server to make sure
46     // we are communicating with it.
47     //------------------------------------------------------------------
48     bool
49     HandshakeWithServer (lldb_private::Error *error_ptr);
50 
51     size_t
52     SendPacketAndWaitForResponse (const char *send_payload,
53                                   StringExtractorGDBRemote &response,
54                                   bool send_async);
55 
56     size_t
57     SendPacketAndWaitForResponse (const char *send_payload,
58                                   size_t send_length,
59                                   StringExtractorGDBRemote &response,
60                                   bool send_async);
61 
62     lldb::StateType
63     SendContinuePacketAndWaitForResponse (ProcessGDBRemote *process,
64                                           const char *packet_payload,
65                                           size_t packet_length,
66                                           StringExtractorGDBRemote &response);
67 
68     virtual bool
69     GetThreadSuffixSupported ();
70 
71     void
72     QueryNoAckModeSupported ();
73 
74     void
75     GetListThreadsInStopReplySupported ();
76 
77     bool
78     SendAsyncSignal (int signo);
79 
80     bool
81     SendInterrupt (lldb_private::Mutex::Locker &locker,
82                    uint32_t seconds_to_wait_for_stop,
83                    bool &timed_out);
84 
85     lldb::pid_t
86     GetCurrentProcessID ();
87 
88     bool
89     GetLaunchSuccess (std::string &error_str);
90 
91     uint16_t
92     LaunchGDBserverAndGetPort ();
93 
94     //------------------------------------------------------------------
95     /// Sends a GDB remote protocol 'A' packet that delivers program
96     /// arguments to the remote server.
97     ///
98     /// @param[in] argv
99     ///     A NULL terminated array of const C strings to use as the
100     ///     arguments.
101     ///
102     /// @return
103     ///     Zero if the response was "OK", a positive value if the
104     ///     the response was "Exx" where xx are two hex digits, or
105     ///     -1 if the call is unsupported or any other unexpected
106     ///     response was received.
107     //------------------------------------------------------------------
108     int
109     SendArgumentsPacket (char const *argv[]);
110 
111     //------------------------------------------------------------------
112     /// Sends a "QEnvironment:NAME=VALUE" packet that will build up the
113     /// environment that will get used when launching an application
114     /// in conjunction with the 'A' packet. This function can be called
115     /// multiple times in a row in order to pass on the desired
116     /// environment that the inferior should be launched with.
117     ///
118     /// @param[in] name_equal_value
119     ///     A NULL terminated C string that contains a single environment
120     ///     in the format "NAME=VALUE".
121     ///
122     /// @return
123     ///     Zero if the response was "OK", a positive value if the
124     ///     the response was "Exx" where xx are two hex digits, or
125     ///     -1 if the call is unsupported or any other unexpected
126     ///     response was received.
127     //------------------------------------------------------------------
128     int
129     SendEnvironmentPacket (char const *name_equal_value);
130 
131     int
132     SendLaunchArchPacket (const char *arch);
133     //------------------------------------------------------------------
134     /// Sends a "vAttach:PID" where PID is in hex.
135     ///
136     /// @param[in] pid
137     ///     A process ID for the remote gdb server to attach to.
138     ///
139     /// @param[out] response
140     ///     The response received from the gdb server. If the return
141     ///     value is zero, \a response will contain a stop reply
142     ///     packet.
143     ///
144     /// @return
145     ///     Zero if the attach was successful, or an error indicating
146     ///     an error code.
147     //------------------------------------------------------------------
148     int
149     SendAttach (lldb::pid_t pid,
150                 StringExtractorGDBRemote& response);
151 
152 
153     //------------------------------------------------------------------
154     /// Sets the path to use for stdin/out/err for a process
155     /// that will be launched with the 'A' packet.
156     ///
157     /// @param[in] path
158     ///     The path to use for stdin/out/err
159     ///
160     /// @return
161     ///     Zero if the for success, or an error code for failure.
162     //------------------------------------------------------------------
163     int
164     SetSTDIN (char const *path);
165     int
166     SetSTDOUT (char const *path);
167     int
168     SetSTDERR (char const *path);
169 
170     //------------------------------------------------------------------
171     /// Sets the disable ASLR flag to \a enable for a process that will
172     /// be launched with the 'A' packet.
173     ///
174     /// @param[in] enable
175     ///     A boolean value indicating wether to disable ASLR or not.
176     ///
177     /// @return
178     ///     Zero if the for success, or an error code for failure.
179     //------------------------------------------------------------------
180     int
181     SetDisableASLR (bool enable);
182 
183     //------------------------------------------------------------------
184     /// Sets the working directory to \a path for a process that will
185     /// be launched with the 'A' packet.
186     ///
187     /// @param[in] path
188     ///     The path to a directory to use when launching our processs
189     ///
190     /// @return
191     ///     Zero if the for success, or an error code for failure.
192     //------------------------------------------------------------------
193     int
194     SetWorkingDir (char const *path);
195 
196     lldb::addr_t
197     AllocateMemory (size_t size, uint32_t permissions);
198 
199     bool
200     DeallocateMemory (lldb::addr_t addr);
201 
202     bool
203     Detach ();
204 
205     lldb_private::Error
206     GetMemoryRegionInfo (lldb::addr_t addr,
207                         lldb_private::MemoryRegionInfo &range_info);
208 
209     lldb_private::Error
210     GetWatchpointSupportInfo (uint32_t &num);
211 
212     lldb_private::Error
213     GetWatchpointSupportInfo (uint32_t &num, bool& after);
214 
215     lldb_private::Error
216     GetWatchpointsTriggerAfterInstruction (bool &after);
217 
218     const lldb_private::ArchSpec &
219     GetHostArchitecture ();
220 
221     bool
222     GetVContSupported (char flavor);
223 
224     bool
225     GetVAttachOrWaitSupported ();
226 
227     bool
228     GetSyncThreadStateSupported();
229 
230     void
231     ResetDiscoverableSettings();
232 
233     bool
234     GetHostInfo (bool force = false);
235 
236     bool
237     GetOSVersion (uint32_t &major,
238                   uint32_t &minor,
239                   uint32_t &update);
240 
241     bool
242     GetOSBuildString (std::string &s);
243 
244     bool
245     GetOSKernelDescription (std::string &s);
246 
247     lldb_private::ArchSpec
248     GetSystemArchitecture ();
249 
250     bool
251     GetHostname (std::string &s);
252 
253     lldb::addr_t
254     GetShlibInfoAddr();
255 
256     bool
257     GetSupportsThreadSuffix ();
258 
259     bool
260     GetProcessInfo (lldb::pid_t pid,
261                     lldb_private::ProcessInstanceInfo &process_info);
262 
263     uint32_t
264     FindProcesses (const lldb_private::ProcessInstanceInfoMatch &process_match_info,
265                    lldb_private::ProcessInstanceInfoList &process_infos);
266 
267     bool
268     GetUserName (uint32_t uid, std::string &name);
269 
270     bool
271     GetGroupName (uint32_t gid, std::string &name);
272 
273     bool
274     HasFullVContSupport ()
275     {
276         return GetVContSupported ('A');
277     }
278 
279     bool
280     HasAnyVContSupport ()
281     {
282         return GetVContSupported ('a');
283     }
284 
285     uint32_t
286     SetPacketTimeout (uint32_t packet_timeout)
287     {
288         const uint32_t old_packet_timeout = m_packet_timeout;
289         m_packet_timeout = packet_timeout;
290         return old_packet_timeout;
291     }
292 
293     bool
294     GetStopReply (StringExtractorGDBRemote &response);
295 
296     bool
297     GetThreadStopInfo (uint32_t tid,
298                        StringExtractorGDBRemote &response);
299 
300     bool
301     SupportsGDBStoppointPacket (GDBStoppointType type)
302     {
303         switch (type)
304         {
305         case eBreakpointSoftware:   return m_supports_z0;
306         case eBreakpointHardware:   return m_supports_z1;
307         case eWatchpointWrite:      return m_supports_z2;
308         case eWatchpointRead:       return m_supports_z3;
309         case eWatchpointReadWrite:  return m_supports_z4;
310         default:                    break;
311         }
312         return false;
313     }
314     uint8_t
315     SendGDBStoppointTypePacket (GDBStoppointType type,   // Type of breakpoint or watchpoint
316                                 bool insert,              // Insert or remove?
317                                 lldb::addr_t addr,        // Address of breakpoint or watchpoint
318                                 uint32_t length);         // Byte Size of breakpoint or watchpoint
319 
320     void
321     TestPacketSpeed (const uint32_t num_packets);
322 
323     // This packet is for testing the speed of the interface only. Both
324     // the client and server need to support it, but this allows us to
325     // measure the packet speed without any other work being done on the
326     // other end and avoids any of that work affecting the packet send
327     // and response times.
328     bool
329     SendSpeedTestPacket (uint32_t send_size,
330                          uint32_t recv_size);
331 
332     bool
333     SetCurrentThread (int tid);
334 
335     bool
336     SetCurrentThreadForRun (int tid);
337 
338     lldb_private::LazyBool
339     SupportsAllocDeallocMemory () // const
340     {
341         // Uncomment this to have lldb pretend the debug server doesn't respond to alloc/dealloc memory packets.
342         // m_supports_alloc_dealloc_memory = lldb_private::eLazyBoolNo;
343         return m_supports_alloc_dealloc_memory;
344     }
345 
346     size_t
347     GetCurrentThreadIDs (std::vector<lldb::tid_t> &thread_ids,
348                          bool &sequence_mutex_unavailable);
349 
350     bool
351     GetInterruptWasSent () const
352     {
353         return m_interrupt_sent;
354     }
355 protected:
356 
357     //------------------------------------------------------------------
358     // Classes that inherit from GDBRemoteCommunicationClient can see and modify these
359     //------------------------------------------------------------------
360     lldb_private::LazyBool m_supports_not_sending_acks;
361     lldb_private::LazyBool m_supports_thread_suffix;
362     lldb_private::LazyBool m_supports_threads_in_stop_reply;
363     lldb_private::LazyBool m_supports_vCont_all;
364     lldb_private::LazyBool m_supports_vCont_any;
365     lldb_private::LazyBool m_supports_vCont_c;
366     lldb_private::LazyBool m_supports_vCont_C;
367     lldb_private::LazyBool m_supports_vCont_s;
368     lldb_private::LazyBool m_supports_vCont_S;
369     lldb_private::LazyBool m_qHostInfo_is_valid;
370     lldb_private::LazyBool m_supports_alloc_dealloc_memory;
371     lldb_private::LazyBool m_supports_memory_region_info;
372     lldb_private::LazyBool m_supports_watchpoint_support_info;
373     lldb_private::LazyBool m_watchpoints_trigger_after_instruction;
374     lldb_private::LazyBool m_attach_or_wait_reply;
375     lldb_private::LazyBool m_prepare_for_reg_writing_reply;
376 
377     bool
378         m_supports_qProcessInfoPID:1,
379         m_supports_qfProcessInfo:1,
380         m_supports_qUserName:1,
381         m_supports_qGroupName:1,
382         m_supports_qThreadStopInfo:1,
383         m_supports_z0:1,
384         m_supports_z1:1,
385         m_supports_z2:1,
386         m_supports_z3:1,
387         m_supports_z4:1;
388 
389 
390     lldb::tid_t m_curr_tid;         // Current gdb remote protocol thread index for all other operations
391     lldb::tid_t m_curr_tid_run;     // Current gdb remote protocol thread index for continue, step, etc
392 
393 
394     uint32_t m_num_supported_hardware_watchpoints;
395 
396     // If we need to send a packet while the target is running, the m_async_XXX
397     // member variables take care of making this happen.
398     lldb_private::Mutex m_async_mutex;
399     lldb_private::Predicate<bool> m_async_packet_predicate;
400     std::string m_async_packet;
401     StringExtractorGDBRemote m_async_response;
402     int m_async_signal; // We were asked to deliver a signal to the inferior process.
403     bool m_interrupt_sent;
404 
405     lldb_private::ArchSpec m_host_arch;
406     uint32_t m_os_version_major;
407     uint32_t m_os_version_minor;
408     uint32_t m_os_version_update;
409     std::string m_os_build;
410     std::string m_os_kernel;
411     std::string m_hostname;
412 
413     bool
414     DecodeProcessInfoResponse (StringExtractorGDBRemote &response,
415                                lldb_private::ProcessInstanceInfo &process_info);
416 private:
417     //------------------------------------------------------------------
418     // For GDBRemoteCommunicationClient only
419     //------------------------------------------------------------------
420     DISALLOW_COPY_AND_ASSIGN (GDBRemoteCommunicationClient);
421 };
422 
423 #endif  // liblldb_GDBRemoteCommunicationClient_h_
424