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