1 //===-- ProcessGDBRemote.h --------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_PROCESSGDBREMOTE_H
10 #define LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_PROCESSGDBREMOTE_H
11 
12 #include <atomic>
13 #include <map>
14 #include <mutex>
15 #include <string>
16 #include <vector>
17 
18 #include "lldb/Core/LoadedModuleInfoList.h"
19 #include "lldb/Core/ModuleSpec.h"
20 #include "lldb/Core/ThreadSafeValue.h"
21 #include "lldb/Host/HostThread.h"
22 #include "lldb/Target/Process.h"
23 #include "lldb/Target/Thread.h"
24 #include "lldb/Utility/ArchSpec.h"
25 #include "lldb/Utility/Broadcaster.h"
26 #include "lldb/Utility/ConstString.h"
27 #include "lldb/Utility/GDBRemote.h"
28 #include "lldb/Utility/Status.h"
29 #include "lldb/Utility/StreamString.h"
30 #include "lldb/Utility/StringExtractor.h"
31 #include "lldb/Utility/StringList.h"
32 #include "lldb/Utility/StructuredData.h"
33 #include "lldb/lldb-private-forward.h"
34 
35 #include "GDBRemoteCommunicationClient.h"
36 #include "GDBRemoteCommunicationReplayServer.h"
37 #include "GDBRemoteRegisterContext.h"
38 
39 #include "llvm/ADT/DenseMap.h"
40 
41 namespace lldb_private {
42 namespace repro {
43 class Loader;
44 }
45 namespace process_gdb_remote {
46 
47 class ThreadGDBRemote;
48 
49 class ProcessGDBRemote : public Process,
50                          private GDBRemoteClientBase::ContinueDelegate {
51 public:
52   ProcessGDBRemote(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp);
53 
54   ~ProcessGDBRemote() override;
55 
56   static lldb::ProcessSP CreateInstance(lldb::TargetSP target_sp,
57                                         lldb::ListenerSP listener_sp,
58                                         const FileSpec *crash_file_path,
59                                         bool can_connect);
60 
61   static void Initialize();
62 
63   static void DebuggerInitialize(Debugger &debugger);
64 
65   static void Terminate();
66 
67   static ConstString GetPluginNameStatic();
68 
69   static const char *GetPluginDescriptionStatic();
70 
71   static std::chrono::seconds GetPacketTimeout();
72 
73   // Check if a given Process
74   bool CanDebug(lldb::TargetSP target_sp,
75                 bool plugin_specified_by_name) override;
76 
77   CommandObject *GetPluginCommandObject() override;
78 
79   // Creating a new process, or attaching to an existing one
80   Status WillLaunch(Module *module) override;
81 
82   Status DoLaunch(Module *exe_module, ProcessLaunchInfo &launch_info) override;
83 
84   void DidLaunch() override;
85 
86   Status WillAttachToProcessWithID(lldb::pid_t pid) override;
87 
88   Status WillAttachToProcessWithName(const char *process_name,
89                                      bool wait_for_launch) override;
90 
91   Status DoConnectRemote(llvm::StringRef remote_url) override;
92 
93   Status WillLaunchOrAttach();
94 
95   Status DoAttachToProcessWithID(lldb::pid_t pid,
96                                  const ProcessAttachInfo &attach_info) override;
97 
98   Status
99   DoAttachToProcessWithName(const char *process_name,
100                             const ProcessAttachInfo &attach_info) override;
101 
102   void DidAttach(ArchSpec &process_arch) override;
103 
104   // PluginInterface protocol
105   ConstString GetPluginName() override;
106 
107   uint32_t GetPluginVersion() override;
108 
109   // Process Control
110   Status WillResume() override;
111 
112   Status DoResume() override;
113 
114   Status DoHalt(bool &caused_stop) override;
115 
116   Status DoDetach(bool keep_stopped) override;
117 
118   bool DetachRequiresHalt() override { return true; }
119 
120   Status DoSignal(int signal) override;
121 
122   Status DoDestroy() override;
123 
124   void RefreshStateAfterStop() override;
125 
126   void SetUnixSignals(const lldb::UnixSignalsSP &signals_sp);
127 
128   // Process Queries
129   bool IsAlive() override;
130 
131   lldb::addr_t GetImageInfoAddress() override;
132 
133   void WillPublicStop() override;
134 
135   // Process Memory
136   size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size,
137                       Status &error) override;
138 
139   Status
140   WriteObjectFile(std::vector<ObjectFile::LoadableData> entries) override;
141 
142   size_t DoWriteMemory(lldb::addr_t addr, const void *buf, size_t size,
143                        Status &error) override;
144 
145   lldb::addr_t DoAllocateMemory(size_t size, uint32_t permissions,
146                                 Status &error) override;
147 
148   Status GetMemoryRegionInfo(lldb::addr_t load_addr,
149                              MemoryRegionInfo &region_info) override;
150 
151   Status DoDeallocateMemory(lldb::addr_t ptr) override;
152 
153   // Process STDIO
154   size_t PutSTDIN(const char *buf, size_t buf_size, Status &error) override;
155 
156   // Process Breakpoints
157   Status EnableBreakpointSite(BreakpointSite *bp_site) override;
158 
159   Status DisableBreakpointSite(BreakpointSite *bp_site) override;
160 
161   // Process Watchpoints
162   Status EnableWatchpoint(Watchpoint *wp, bool notify = true) override;
163 
164   Status DisableWatchpoint(Watchpoint *wp, bool notify = true) override;
165 
166   Status GetWatchpointSupportInfo(uint32_t &num) override;
167 
168   lldb::user_id_t StartTrace(const TraceOptions &options,
169                              Status &error) override;
170 
171   Status StopTrace(lldb::user_id_t uid, lldb::tid_t thread_id) override;
172 
173   Status GetData(lldb::user_id_t uid, lldb::tid_t thread_id,
174                  llvm::MutableArrayRef<uint8_t> &buffer,
175                  size_t offset = 0) override;
176 
177   Status GetMetaData(lldb::user_id_t uid, lldb::tid_t thread_id,
178                      llvm::MutableArrayRef<uint8_t> &buffer,
179                      size_t offset = 0) override;
180 
181   llvm::Expected<TraceTypeInfo> GetSupportedTraceType() override;
182 
183   Status GetTraceConfig(lldb::user_id_t uid, TraceOptions &options) override;
184 
185   Status GetWatchpointSupportInfo(uint32_t &num, bool &after) override;
186 
187   bool StartNoticingNewThreads() override;
188 
189   bool StopNoticingNewThreads() override;
190 
191   GDBRemoteCommunicationClient &GetGDBRemote() { return m_gdb_comm; }
192 
193   Status SendEventData(const char *data) override;
194 
195   // Override DidExit so we can disconnect from the remote GDB server
196   void DidExit() override;
197 
198   void SetUserSpecifiedMaxMemoryTransferSize(uint64_t user_specified_max);
199 
200   bool GetModuleSpec(const FileSpec &module_file_spec, const ArchSpec &arch,
201                      ModuleSpec &module_spec) override;
202 
203   void PrefetchModuleSpecs(llvm::ArrayRef<FileSpec> module_file_specs,
204                            const llvm::Triple &triple) override;
205 
206   llvm::VersionTuple GetHostOSVersion() override;
207   llvm::VersionTuple GetHostMacCatalystVersion() override;
208 
209   llvm::Error LoadModules() override;
210 
211   llvm::Expected<LoadedModuleInfoList> GetLoadedModuleList() override;
212 
213   Status GetFileLoadAddress(const FileSpec &file, bool &is_loaded,
214                             lldb::addr_t &load_addr) override;
215 
216   void ModulesDidLoad(ModuleList &module_list) override;
217 
218   StructuredData::ObjectSP
219   GetLoadedDynamicLibrariesInfos(lldb::addr_t image_list_address,
220                                  lldb::addr_t image_count) override;
221 
222   Status
223   ConfigureStructuredData(ConstString type_name,
224                           const StructuredData::ObjectSP &config_sp) override;
225 
226   StructuredData::ObjectSP GetLoadedDynamicLibrariesInfos() override;
227 
228   StructuredData::ObjectSP GetLoadedDynamicLibrariesInfos(
229       const std::vector<lldb::addr_t> &load_addresses) override;
230 
231   StructuredData::ObjectSP
232   GetLoadedDynamicLibrariesInfos_sender(StructuredData::ObjectSP args);
233 
234   StructuredData::ObjectSP GetSharedCacheInfo() override;
235 
236   std::string HarmonizeThreadIdsForProfileData(
237       StringExtractorGDBRemote &inputStringExtractor);
238 
239 protected:
240   friend class ThreadGDBRemote;
241   friend class GDBRemoteCommunicationClient;
242   friend class GDBRemoteRegisterContext;
243 
244   /// Broadcaster event bits definitions.
245   enum {
246     eBroadcastBitAsyncContinue = (1 << 0),
247     eBroadcastBitAsyncThreadShouldExit = (1 << 1),
248     eBroadcastBitAsyncThreadDidExit = (1 << 2)
249   };
250 
251   GDBRemoteCommunicationClient m_gdb_comm;
252   GDBRemoteCommunicationReplayServer m_gdb_replay_server;
253   std::atomic<lldb::pid_t> m_debugserver_pid;
254   std::vector<StringExtractorGDBRemote> m_stop_packet_stack; // The stop packet
255                                                              // stack replaces
256                                                              // the last stop
257                                                              // packet variable
258   std::recursive_mutex m_last_stop_packet_mutex;
259   GDBRemoteDynamicRegisterInfoSP m_register_info_sp;
260   Broadcaster m_async_broadcaster;
261   lldb::ListenerSP m_async_listener_sp;
262   HostThread m_async_thread;
263   std::recursive_mutex m_async_thread_state_mutex;
264   typedef std::vector<lldb::tid_t> tid_collection;
265   typedef std::vector<std::pair<lldb::tid_t, int>> tid_sig_collection;
266   typedef std::map<lldb::addr_t, lldb::addr_t> MMapMap;
267   typedef std::map<uint32_t, std::string> ExpeditedRegisterMap;
268   tid_collection m_thread_ids; // Thread IDs for all threads. This list gets
269                                // updated after stopping
270   std::vector<lldb::addr_t> m_thread_pcs;     // PC values for all the threads.
271   StructuredData::ObjectSP m_jstopinfo_sp;    // Stop info only for any threads
272                                               // that have valid stop infos
273   StructuredData::ObjectSP m_jthreadsinfo_sp; // Full stop info, expedited
274                                               // registers and memory for all
275                                               // threads if "jThreadsInfo"
276                                               // packet is supported
277   tid_collection m_continue_c_tids;           // 'c' for continue
278   tid_sig_collection m_continue_C_tids;       // 'C' for continue with signal
279   tid_collection m_continue_s_tids;           // 's' for step
280   tid_sig_collection m_continue_S_tids;       // 'S' for step with signal
281   uint64_t m_max_memory_size; // The maximum number of bytes to read/write when
282                               // reading and writing memory
283   uint64_t m_remote_stub_max_memory_size; // The maximum memory size the remote
284                                           // gdb stub can handle
285   MMapMap m_addr_to_mmap_size;
286   lldb::BreakpointSP m_thread_create_bp_sp;
287   bool m_waiting_for_attach;
288   bool m_destroy_tried_resuming;
289   lldb::CommandObjectSP m_command_sp;
290   int64_t m_breakpoint_pc_offset;
291   lldb::tid_t m_initial_tid; // The initial thread ID, given by stub on attach
292   bool m_use_g_packet_for_reading;
293 
294   bool m_replay_mode;
295   bool m_allow_flash_writes;
296   using FlashRangeVector = lldb_private::RangeVector<lldb::addr_t, size_t>;
297   using FlashRange = FlashRangeVector::Entry;
298   FlashRangeVector m_erased_flash_ranges;
299 
300   // Accessors
301   bool IsRunning(lldb::StateType state) {
302     return state == lldb::eStateRunning || IsStepping(state);
303   }
304 
305   bool IsStepping(lldb::StateType state) {
306     return state == lldb::eStateStepping;
307   }
308 
309   bool CanResume(lldb::StateType state) { return state == lldb::eStateStopped; }
310 
311   bool HasExited(lldb::StateType state) { return state == lldb::eStateExited; }
312 
313   bool ProcessIDIsValid() const;
314 
315   void Clear();
316 
317   bool DoUpdateThreadList(ThreadList &old_thread_list,
318                           ThreadList &new_thread_list) override;
319 
320   Status ConnectToReplayServer();
321 
322   Status EstablishConnectionIfNeeded(const ProcessInfo &process_info);
323 
324   Status LaunchAndConnectToDebugserver(const ProcessInfo &process_info);
325 
326   void KillDebugserverProcess();
327 
328   void BuildDynamicRegisterInfo(bool force);
329 
330   void SetLastStopPacket(const StringExtractorGDBRemote &response);
331 
332   bool ParsePythonTargetDefinition(const FileSpec &target_definition_fspec);
333 
334   DataExtractor GetAuxvData() override;
335 
336   StructuredData::ObjectSP GetExtendedInfoForThread(lldb::tid_t tid);
337 
338   void GetMaxMemorySize();
339 
340   bool CalculateThreadStopInfo(ThreadGDBRemote *thread);
341 
342   size_t UpdateThreadPCsFromStopReplyThreadsValue(std::string &value);
343 
344   size_t UpdateThreadIDsFromStopReplyThreadsValue(std::string &value);
345 
346   bool HandleNotifyPacket(StringExtractorGDBRemote &packet);
347 
348   bool StartAsyncThread();
349 
350   void StopAsyncThread();
351 
352   static lldb::thread_result_t AsyncThread(void *arg);
353 
354   static bool
355   MonitorDebugserverProcess(std::weak_ptr<ProcessGDBRemote> process_wp,
356                             lldb::pid_t pid, bool exited, int signo,
357                             int exit_status);
358 
359   lldb::StateType SetThreadStopInfo(StringExtractor &stop_packet);
360 
361   bool
362   GetThreadStopInfoFromJSON(ThreadGDBRemote *thread,
363                             const StructuredData::ObjectSP &thread_infos_sp);
364 
365   lldb::ThreadSP SetThreadStopInfo(StructuredData::Dictionary *thread_dict);
366 
367   lldb::ThreadSP
368   SetThreadStopInfo(lldb::tid_t tid,
369                     ExpeditedRegisterMap &expedited_register_map, uint8_t signo,
370                     const std::string &thread_name, const std::string &reason,
371                     const std::string &description, uint32_t exc_type,
372                     const std::vector<lldb::addr_t> &exc_data,
373                     lldb::addr_t thread_dispatch_qaddr, bool queue_vars_valid,
374                     lldb_private::LazyBool associated_with_libdispatch_queue,
375                     lldb::addr_t dispatch_queue_t, std::string &queue_name,
376                     lldb::QueueKind queue_kind, uint64_t queue_serial);
377 
378   void HandleStopReplySequence();
379 
380   void ClearThreadIDList();
381 
382   bool UpdateThreadIDList();
383 
384   void DidLaunchOrAttach(ArchSpec &process_arch);
385   void MaybeLoadExecutableModule();
386 
387   Status ConnectToDebugserver(llvm::StringRef host_port);
388 
389   const char *GetDispatchQueueNameForThread(lldb::addr_t thread_dispatch_qaddr,
390                                             std::string &dispatch_queue_name);
391 
392   DynamicLoader *GetDynamicLoader() override;
393 
394   bool GetGDBServerRegisterInfoXMLAndProcess(ArchSpec &arch_to_use,
395                                              std::string xml_filename,
396                                              uint32_t &cur_reg_remote,
397                                              uint32_t &cur_reg_local);
398 
399   // Query remote GDBServer for register information
400   bool GetGDBServerRegisterInfo(ArchSpec &arch);
401 
402   lldb::ModuleSP LoadModuleAtAddress(const FileSpec &file,
403                                      lldb::addr_t link_map,
404                                      lldb::addr_t base_addr,
405                                      bool value_is_offset);
406 
407   Status UpdateAutomaticSignalFiltering() override;
408 
409   Status FlashErase(lldb::addr_t addr, size_t size);
410 
411   Status FlashDone();
412 
413   bool HasErased(FlashRange range);
414 
415 private:
416   // For ProcessGDBRemote only
417   std::string m_partial_profile_data;
418   std::map<uint64_t, uint32_t> m_thread_id_to_used_usec_map;
419   uint64_t m_last_signals_version = 0;
420 
421   static bool NewThreadNotifyBreakpointHit(void *baton,
422                                            StoppointCallbackContext *context,
423                                            lldb::user_id_t break_id,
424                                            lldb::user_id_t break_loc_id);
425 
426   // ContinueDelegate interface
427   void HandleAsyncStdout(llvm::StringRef out) override;
428   void HandleAsyncMisc(llvm::StringRef data) override;
429   void HandleStopReply() override;
430   void HandleAsyncStructuredDataPacket(llvm::StringRef data) override;
431 
432   void SetThreadPc(const lldb::ThreadSP &thread_sp, uint64_t index);
433   using ModuleCacheKey = std::pair<std::string, std::string>;
434   // KeyInfo for the cached module spec DenseMap.
435   // The invariant is that all real keys will have the file and architecture
436   // set.
437   // The empty key has an empty file and an empty arch.
438   // The tombstone key has an invalid arch and an empty file.
439   // The comparison and hash functions take the file name and architecture
440   // triple into account.
441   struct ModuleCacheInfo {
442     static ModuleCacheKey getEmptyKey() { return ModuleCacheKey(); }
443 
444     static ModuleCacheKey getTombstoneKey() { return ModuleCacheKey("", "T"); }
445 
446     static unsigned getHashValue(const ModuleCacheKey &key) {
447       return llvm::hash_combine(key.first, key.second);
448     }
449 
450     static bool isEqual(const ModuleCacheKey &LHS, const ModuleCacheKey &RHS) {
451       return LHS == RHS;
452     }
453   };
454 
455   llvm::DenseMap<ModuleCacheKey, ModuleSpec, ModuleCacheInfo>
456       m_cached_module_specs;
457 
458   ProcessGDBRemote(const ProcessGDBRemote &) = delete;
459   const ProcessGDBRemote &operator=(const ProcessGDBRemote &) = delete;
460 };
461 
462 } // namespace process_gdb_remote
463 } // namespace lldb_private
464 
465 #endif // LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_PROCESSGDBREMOTE_H
466