contrib/llvm/tools/lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.h

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