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   llvm::Expected<TraceSupportedResponse> TraceSupported() override;
169 
170   llvm::Error TraceStop(const TraceStopRequest &request) override;
171 
172   llvm::Error TraceStart(const llvm::json::Value &request) override;
173 
174   llvm::Expected<std::string> TraceGetState(llvm::StringRef type) override;
175 
176   llvm::Expected<std::vector<uint8_t>>
177   TraceGetBinaryData(const TraceGetBinaryDataRequest &request) override;
178 
179   Status GetWatchpointSupportInfo(uint32_t &num, bool &after) override;
180 
181   bool StartNoticingNewThreads() override;
182 
183   bool StopNoticingNewThreads() override;
184 
185   GDBRemoteCommunicationClient &GetGDBRemote() { return m_gdb_comm; }
186 
187   Status SendEventData(const char *data) override;
188 
189   // Override DidExit so we can disconnect from the remote GDB server
190   void DidExit() override;
191 
192   void SetUserSpecifiedMaxMemoryTransferSize(uint64_t user_specified_max);
193 
194   bool GetModuleSpec(const FileSpec &module_file_spec, const ArchSpec &arch,
195                      ModuleSpec &module_spec) override;
196 
197   void PrefetchModuleSpecs(llvm::ArrayRef<FileSpec> module_file_specs,
198                            const llvm::Triple &triple) override;
199 
200   llvm::VersionTuple GetHostOSVersion() override;
201   llvm::VersionTuple GetHostMacCatalystVersion() override;
202 
203   llvm::Error LoadModules() override;
204 
205   llvm::Expected<LoadedModuleInfoList> GetLoadedModuleList() override;
206 
207   Status GetFileLoadAddress(const FileSpec &file, bool &is_loaded,
208                             lldb::addr_t &load_addr) override;
209 
210   void ModulesDidLoad(ModuleList &module_list) override;
211 
212   StructuredData::ObjectSP
213   GetLoadedDynamicLibrariesInfos(lldb::addr_t image_list_address,
214                                  lldb::addr_t image_count) override;
215 
216   Status
217   ConfigureStructuredData(ConstString type_name,
218                           const StructuredData::ObjectSP &config_sp) override;
219 
220   StructuredData::ObjectSP GetLoadedDynamicLibrariesInfos() override;
221 
222   StructuredData::ObjectSP GetLoadedDynamicLibrariesInfos(
223       const std::vector<lldb::addr_t> &load_addresses) override;
224 
225   StructuredData::ObjectSP
226   GetLoadedDynamicLibrariesInfos_sender(StructuredData::ObjectSP args);
227 
228   StructuredData::ObjectSP GetSharedCacheInfo() override;
229 
230   std::string HarmonizeThreadIdsForProfileData(
231       StringExtractorGDBRemote &inputStringExtractor);
232 
233   void DidFork(lldb::pid_t child_pid, lldb::tid_t child_tid) override;
234   void DidVFork(lldb::pid_t child_pid, lldb::tid_t child_tid) override;
235   void DidVForkDone() override;
236   void DidExec() override;
237 
238   llvm::Expected<bool> SaveCore(llvm::StringRef outfile) override;
239 
240 protected:
241   friend class ThreadGDBRemote;
242   friend class GDBRemoteCommunicationClient;
243   friend class GDBRemoteRegisterContext;
244 
245   bool SupportsMemoryTagging() override;
246 
247   /// Broadcaster event bits definitions.
248   enum {
249     eBroadcastBitAsyncContinue = (1 << 0),
250     eBroadcastBitAsyncThreadShouldExit = (1 << 1),
251     eBroadcastBitAsyncThreadDidExit = (1 << 2)
252   };
253 
254   GDBRemoteCommunicationClient m_gdb_comm;
255   GDBRemoteCommunicationReplayServer m_gdb_replay_server;
256   std::atomic<lldb::pid_t> m_debugserver_pid;
257   std::vector<StringExtractorGDBRemote> m_stop_packet_stack; // The stop packet
258                                                              // stack replaces
259                                                              // the last stop
260                                                              // packet variable
261   std::recursive_mutex m_last_stop_packet_mutex;
262   GDBRemoteDynamicRegisterInfoSP m_register_info_sp;
263   Broadcaster m_async_broadcaster;
264   lldb::ListenerSP m_async_listener_sp;
265   HostThread m_async_thread;
266   std::recursive_mutex m_async_thread_state_mutex;
267   typedef std::vector<lldb::tid_t> tid_collection;
268   typedef std::vector<std::pair<lldb::tid_t, int>> tid_sig_collection;
269   typedef std::map<lldb::addr_t, lldb::addr_t> MMapMap;
270   typedef std::map<uint32_t, std::string> ExpeditedRegisterMap;
271   tid_collection m_thread_ids; // Thread IDs for all threads. This list gets
272                                // updated after stopping
273   std::vector<lldb::addr_t> m_thread_pcs;     // PC values for all the threads.
274   StructuredData::ObjectSP m_jstopinfo_sp;    // Stop info only for any threads
275                                               // that have valid stop infos
276   StructuredData::ObjectSP m_jthreadsinfo_sp; // Full stop info, expedited
277                                               // registers and memory for all
278                                               // threads if "jThreadsInfo"
279                                               // packet is supported
280   tid_collection m_continue_c_tids;           // 'c' for continue
281   tid_sig_collection m_continue_C_tids;       // 'C' for continue with signal
282   tid_collection m_continue_s_tids;           // 's' for step
283   tid_sig_collection m_continue_S_tids;       // 'S' for step with signal
284   uint64_t m_max_memory_size; // The maximum number of bytes to read/write when
285                               // reading and writing memory
286   uint64_t m_remote_stub_max_memory_size; // The maximum memory size the remote
287                                           // gdb stub can handle
288   MMapMap m_addr_to_mmap_size;
289   lldb::BreakpointSP m_thread_create_bp_sp;
290   bool m_waiting_for_attach;
291   bool m_destroy_tried_resuming;
292   lldb::CommandObjectSP m_command_sp;
293   int64_t m_breakpoint_pc_offset;
294   lldb::tid_t m_initial_tid; // The initial thread ID, given by stub on attach
295   bool m_use_g_packet_for_reading;
296 
297   bool m_replay_mode;
298   bool m_allow_flash_writes;
299   using FlashRangeVector = lldb_private::RangeVector<lldb::addr_t, size_t>;
300   using FlashRange = FlashRangeVector::Entry;
301   FlashRangeVector m_erased_flash_ranges;
302 
303   bool m_vfork_in_progress;
304 
305   // Accessors
306   bool IsRunning(lldb::StateType state) {
307     return state == lldb::eStateRunning || IsStepping(state);
308   }
309 
310   bool IsStepping(lldb::StateType state) {
311     return state == lldb::eStateStepping;
312   }
313 
314   bool CanResume(lldb::StateType state) { return state == lldb::eStateStopped; }
315 
316   bool HasExited(lldb::StateType state) { return state == lldb::eStateExited; }
317 
318   bool ProcessIDIsValid() const;
319 
320   void Clear();
321 
322   bool DoUpdateThreadList(ThreadList &old_thread_list,
323                           ThreadList &new_thread_list) override;
324 
325   Status ConnectToReplayServer();
326 
327   Status EstablishConnectionIfNeeded(const ProcessInfo &process_info);
328 
329   Status LaunchAndConnectToDebugserver(const ProcessInfo &process_info);
330 
331   void KillDebugserverProcess();
332 
333   void BuildDynamicRegisterInfo(bool force);
334 
335   void SetLastStopPacket(const StringExtractorGDBRemote &response);
336 
337   bool ParsePythonTargetDefinition(const FileSpec &target_definition_fspec);
338 
339   DataExtractor GetAuxvData() override;
340 
341   StructuredData::ObjectSP GetExtendedInfoForThread(lldb::tid_t tid);
342 
343   void GetMaxMemorySize();
344 
345   bool CalculateThreadStopInfo(ThreadGDBRemote *thread);
346 
347   size_t UpdateThreadPCsFromStopReplyThreadsValue(std::string &value);
348 
349   size_t UpdateThreadIDsFromStopReplyThreadsValue(llvm::StringRef value);
350 
351   bool HandleNotifyPacket(StringExtractorGDBRemote &packet);
352 
353   bool StartAsyncThread();
354 
355   void StopAsyncThread();
356 
357   static lldb::thread_result_t AsyncThread(void *arg);
358 
359   static bool
360   MonitorDebugserverProcess(std::weak_ptr<ProcessGDBRemote> process_wp,
361                             lldb::pid_t pid, bool exited, int signo,
362                             int exit_status);
363 
364   lldb::StateType SetThreadStopInfo(StringExtractor &stop_packet);
365 
366   bool
367   GetThreadStopInfoFromJSON(ThreadGDBRemote *thread,
368                             const StructuredData::ObjectSP &thread_infos_sp);
369 
370   lldb::ThreadSP SetThreadStopInfo(StructuredData::Dictionary *thread_dict);
371 
372   lldb::ThreadSP
373   SetThreadStopInfo(lldb::tid_t tid,
374                     ExpeditedRegisterMap &expedited_register_map, uint8_t signo,
375                     const std::string &thread_name, const std::string &reason,
376                     const std::string &description, uint32_t exc_type,
377                     const std::vector<lldb::addr_t> &exc_data,
378                     lldb::addr_t thread_dispatch_qaddr, bool queue_vars_valid,
379                     lldb_private::LazyBool associated_with_libdispatch_queue,
380                     lldb::addr_t dispatch_queue_t, std::string &queue_name,
381                     lldb::QueueKind queue_kind, uint64_t queue_serial);
382 
383   void HandleStopReplySequence();
384 
385   void ClearThreadIDList();
386 
387   bool UpdateThreadIDList();
388 
389   void DidLaunchOrAttach(ArchSpec &process_arch);
390   void MaybeLoadExecutableModule();
391 
392   Status ConnectToDebugserver(llvm::StringRef host_port);
393 
394   const char *GetDispatchQueueNameForThread(lldb::addr_t thread_dispatch_qaddr,
395                                             std::string &dispatch_queue_name);
396 
397   DynamicLoader *GetDynamicLoader() override;
398 
399   bool GetGDBServerRegisterInfoXMLAndProcess(ArchSpec &arch_to_use,
400                                              std::string xml_filename,
401                                              uint32_t &cur_reg_remote,
402                                              uint32_t &cur_reg_local);
403 
404   // Query remote GDBServer for register information
405   bool GetGDBServerRegisterInfo(ArchSpec &arch);
406 
407   lldb::ModuleSP LoadModuleAtAddress(const FileSpec &file,
408                                      lldb::addr_t link_map,
409                                      lldb::addr_t base_addr,
410                                      bool value_is_offset);
411 
412   Status UpdateAutomaticSignalFiltering() override;
413 
414   Status FlashErase(lldb::addr_t addr, size_t size);
415 
416   Status FlashDone();
417 
418   bool HasErased(FlashRange range);
419 
420   llvm::Expected<std::vector<uint8_t>>
421   DoReadMemoryTags(lldb::addr_t addr, size_t len, int32_t type) override;
422 
423   Status DoWriteMemoryTags(lldb::addr_t addr, size_t len, int32_t type,
424                            const std::vector<uint8_t> &tags) override;
425 
426 private:
427   // For ProcessGDBRemote only
428   std::string m_partial_profile_data;
429   std::map<uint64_t, uint32_t> m_thread_id_to_used_usec_map;
430   uint64_t m_last_signals_version = 0;
431 
432   static bool NewThreadNotifyBreakpointHit(void *baton,
433                                            StoppointCallbackContext *context,
434                                            lldb::user_id_t break_id,
435                                            lldb::user_id_t break_loc_id);
436 
437   // ContinueDelegate interface
438   void HandleAsyncStdout(llvm::StringRef out) override;
439   void HandleAsyncMisc(llvm::StringRef data) override;
440   void HandleStopReply() override;
441   void HandleAsyncStructuredDataPacket(llvm::StringRef data) override;
442 
443   void SetThreadPc(const lldb::ThreadSP &thread_sp, uint64_t index);
444   using ModuleCacheKey = std::pair<std::string, std::string>;
445   // KeyInfo for the cached module spec DenseMap.
446   // The invariant is that all real keys will have the file and architecture
447   // set.
448   // The empty key has an empty file and an empty arch.
449   // The tombstone key has an invalid arch and an empty file.
450   // The comparison and hash functions take the file name and architecture
451   // triple into account.
452   struct ModuleCacheInfo {
453     static ModuleCacheKey getEmptyKey() { return ModuleCacheKey(); }
454 
455     static ModuleCacheKey getTombstoneKey() { return ModuleCacheKey("", "T"); }
456 
457     static unsigned getHashValue(const ModuleCacheKey &key) {
458       return llvm::hash_combine(key.first, key.second);
459     }
460 
461     static bool isEqual(const ModuleCacheKey &LHS, const ModuleCacheKey &RHS) {
462       return LHS == RHS;
463     }
464   };
465 
466   llvm::DenseMap<ModuleCacheKey, ModuleSpec, ModuleCacheInfo>
467       m_cached_module_specs;
468 
469   ProcessGDBRemote(const ProcessGDBRemote &) = delete;
470   const ProcessGDBRemote &operator=(const ProcessGDBRemote &) = delete;
471 
472   // fork helpers
473   void DidForkSwitchSoftwareBreakpoints(bool enable);
474   void DidForkSwitchHardwareTraps(bool enable);
475 };
476 
477 } // namespace process_gdb_remote
478 } // namespace lldb_private
479 
480 #endif // LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_PROCESSGDBREMOTE_H
481