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