1 //===-- PlatformRemoteGDBServer.h ----------------------------------------*- C++ 2 //-*-===// 3 // 4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 5 // See https://llvm.org/LICENSE.txt for license information. 6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 7 // 8 //===----------------------------------------------------------------------===// 9 10 #ifndef LLDB_SOURCE_PLUGINS_PLATFORM_GDB_SERVER_PLATFORMREMOTEGDBSERVER_H 11 #define LLDB_SOURCE_PLUGINS_PLATFORM_GDB_SERVER_PLATFORMREMOTEGDBSERVER_H 12 13 #include <string> 14 15 #include "Plugins/Process/Utility/GDBRemoteSignals.h" 16 #include "Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h" 17 #include "Plugins/Process/gdb-remote/GDBRemoteCommunicationReplayServer.h" 18 #include "lldb/Target/Platform.h" 19 20 namespace lldb_private { 21 namespace platform_gdb_server { 22 23 class PlatformRemoteGDBServer : public Platform, private UserIDResolver { 24 public: 25 static void Initialize(); 26 27 static void Terminate(); 28 29 static lldb::PlatformSP CreateInstance(bool force, const ArchSpec *arch); 30 31 static ConstString GetPluginNameStatic(); 32 33 static const char *GetDescriptionStatic(); 34 35 PlatformRemoteGDBServer(); 36 37 ~PlatformRemoteGDBServer() override; 38 39 // lldb_private::PluginInterface functions 40 ConstString GetPluginName() override { return GetPluginNameStatic(); } 41 42 uint32_t GetPluginVersion() override { return 1; } 43 44 // lldb_private::Platform functions 45 Status 46 ResolveExecutable(const ModuleSpec &module_spec, lldb::ModuleSP &module_sp, 47 const FileSpecList *module_search_paths_ptr) override; 48 49 bool GetModuleSpec(const FileSpec &module_file_spec, const ArchSpec &arch, 50 ModuleSpec &module_spec) override; 51 52 const char *GetDescription() override; 53 54 Status GetFileWithUUID(const FileSpec &platform_file, const UUID *uuid_ptr, 55 FileSpec &local_file) override; 56 57 bool GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &proc_info) override; 58 59 uint32_t FindProcesses(const ProcessInstanceInfoMatch &match_info, 60 ProcessInstanceInfoList &process_infos) override; 61 62 Status LaunchProcess(ProcessLaunchInfo &launch_info) override; 63 64 Status KillProcess(const lldb::pid_t pid) override; 65 66 lldb::ProcessSP DebugProcess(ProcessLaunchInfo &launch_info, 67 Debugger &debugger, 68 Target *target, // Can be NULL, if NULL create a 69 // new target, else use existing 70 // one 71 Status &error) override; 72 73 lldb::ProcessSP Attach(ProcessAttachInfo &attach_info, Debugger &debugger, 74 Target *target, // Can be NULL, if NULL create a new 75 // target, else use existing one 76 Status &error) override; 77 78 bool GetSupportedArchitectureAtIndex(uint32_t idx, ArchSpec &arch) override; 79 80 size_t GetSoftwareBreakpointTrapOpcode(Target &target, 81 BreakpointSite *bp_site) override; 82 83 bool GetRemoteOSVersion() override; 84 85 bool GetRemoteOSBuildString(std::string &s) override; 86 87 bool GetRemoteOSKernelDescription(std::string &s) override; 88 89 // Remote Platform subclasses need to override this function 90 ArchSpec GetRemoteSystemArchitecture() override; 91 92 FileSpec GetRemoteWorkingDirectory() override; 93 94 bool SetRemoteWorkingDirectory(const FileSpec &working_dir) override; 95 96 // Remote subclasses should override this and return a valid instance 97 // name if connected. 98 const char *GetHostname() override; 99 100 UserIDResolver &GetUserIDResolver() override { return *this; } 101 102 bool IsConnected() const override; 103 104 Status ConnectRemote(Args &args) override; 105 106 Status DisconnectRemote() override; 107 108 Status MakeDirectory(const FileSpec &file_spec, 109 uint32_t file_permissions) override; 110 111 Status GetFilePermissions(const FileSpec &file_spec, 112 uint32_t &file_permissions) override; 113 114 Status SetFilePermissions(const FileSpec &file_spec, 115 uint32_t file_permissions) override; 116 117 lldb::user_id_t OpenFile(const FileSpec &file_spec, File::OpenOptions flags, 118 uint32_t mode, Status &error) override; 119 120 bool CloseFile(lldb::user_id_t fd, Status &error) override; 121 122 uint64_t ReadFile(lldb::user_id_t fd, uint64_t offset, void *data_ptr, 123 uint64_t len, Status &error) override; 124 125 uint64_t WriteFile(lldb::user_id_t fd, uint64_t offset, const void *data, 126 uint64_t len, Status &error) override; 127 128 lldb::user_id_t GetFileSize(const FileSpec &file_spec) override; 129 130 void AutoCompleteDiskFileOrDirectory(CompletionRequest &request, 131 bool only_dir) override; 132 133 Status PutFile(const FileSpec &source, const FileSpec &destination, 134 uint32_t uid = UINT32_MAX, uint32_t gid = UINT32_MAX) override; 135 136 Status CreateSymlink(const FileSpec &src, const FileSpec &dst) override; 137 138 bool GetFileExists(const FileSpec &file_spec) override; 139 140 Status Unlink(const FileSpec &path) override; 141 142 Status RunShellCommand( 143 llvm::StringRef shell, llvm::StringRef command, 144 const FileSpec &working_dir, // Pass empty FileSpec to use the current 145 // working directory 146 int *status_ptr, // Pass NULL if you don't want the process exit status 147 int *signo_ptr, // Pass NULL if you don't want the signal that caused the 148 // process to exit 149 std::string 150 *command_output, // Pass NULL if you don't want the command output 151 const lldb_private::Timeout<std::micro> &timeout) override; 152 153 void CalculateTrapHandlerSymbolNames() override; 154 155 const lldb::UnixSignalsSP &GetRemoteUnixSignals() override; 156 157 size_t ConnectToWaitingProcesses(lldb_private::Debugger &debugger, 158 lldb_private::Status &error) override; 159 160 virtual size_t 161 GetPendingGdbServerList(std::vector<std::string> &connection_urls); 162 163 protected: 164 process_gdb_remote::GDBRemoteCommunicationClient m_gdb_client; 165 process_gdb_remote::GDBRemoteCommunicationReplayServer m_gdb_replay_server; 166 std::string m_platform_description; // After we connect we can get a more 167 // complete description of what we are 168 // connected to 169 std::string m_platform_scheme; 170 std::string m_platform_hostname; 171 172 lldb::UnixSignalsSP m_remote_signals_sp; 173 174 // Launch the debug server on the remote host - caller connects to launched 175 // debug server using connect_url. 176 // Subclasses should override this method if they want to do extra actions 177 // before or 178 // after launching the debug server. 179 virtual bool LaunchGDBServer(lldb::pid_t &pid, std::string &connect_url); 180 181 virtual bool KillSpawnedProcess(lldb::pid_t pid); 182 183 virtual std::string MakeUrl(const char *scheme, const char *hostname, 184 uint16_t port, const char *path); 185 186 private: 187 std::string MakeGdbServerUrl(const std::string &platform_scheme, 188 const std::string &platform_hostname, 189 uint16_t port, const char *socket_name); 190 191 llvm::Optional<std::string> DoGetUserName(UserIDResolver::id_t uid) override; 192 llvm::Optional<std::string> DoGetGroupName(UserIDResolver::id_t uid) override; 193 194 PlatformRemoteGDBServer(const PlatformRemoteGDBServer &) = delete; 195 const PlatformRemoteGDBServer & 196 operator=(const PlatformRemoteGDBServer &) = delete; 197 }; 198 199 } // namespace platform_gdb_server 200 } // namespace lldb_private 201 202 #endif // LLDB_SOURCE_PLUGINS_PLATFORM_GDB_SERVER_PLATFORMREMOTEGDBSERVER_H 203