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