1 //===-- RemoteAwarePlatform.h -----------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef LLDB_TARGET_REMOTEAWAREPLATFORM_H
10 #define LLDB_TARGET_REMOTEAWAREPLATFORM_H
12 #include "lldb/Target/Platform.h"
14 namespace lldb_private {
16 /// A base class for platforms which automatically want to be able to forward
17 /// operations to a remote platform instance (such as PlatformRemoteGDBServer).
18 class RemoteAwarePlatform : public Platform {
20 using Platform::Platform;
22 bool GetModuleSpec(const FileSpec &module_file_spec, const ArchSpec &arch,
23 ModuleSpec &module_spec) override;
25 lldb::user_id_t OpenFile(const FileSpec &file_spec, File::OpenOptions flags,
26 uint32_t mode, Status &error) override;
28 bool CloseFile(lldb::user_id_t fd, Status &error) override;
30 uint64_t ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst,
31 uint64_t dst_len, Status &error) override;
33 uint64_t WriteFile(lldb::user_id_t fd, uint64_t offset, const void *src,
34 uint64_t src_len, Status &error) override;
36 lldb::user_id_t GetFileSize(const FileSpec &file_spec) override;
38 Status CreateSymlink(const FileSpec &src, const FileSpec &dst) override;
40 bool GetFileExists(const FileSpec &file_spec) override;
42 Status Unlink(const FileSpec &file_spec) override;
44 FileSpec GetRemoteWorkingDirectory() override;
46 bool SetRemoteWorkingDirectory(const FileSpec &working_dir) override;
48 Status MakeDirectory(const FileSpec &file_spec, uint32_t mode) override;
50 Status GetFilePermissions(const FileSpec &file_spec,
51 uint32_t &file_permissions) override;
53 Status SetFilePermissions(const FileSpec &file_spec,
54 uint32_t file_permissions) override;
56 bool CalculateMD5(const FileSpec &file_spec, uint64_t &low,
57 uint64_t &high) override;
59 Status GetFileWithUUID(const FileSpec &platform_file, const UUID *uuid,
60 FileSpec &local_file) override;
62 bool GetRemoteOSVersion() override;
63 bool GetRemoteOSBuildString(std::string &s) override;
64 bool GetRemoteOSKernelDescription(std::string &s) override;
65 ArchSpec GetRemoteSystemArchitecture() override;
67 Status RunShellCommand(const char *command, const FileSpec &working_dir,
68 int *status_ptr, int *signo_ptr,
69 std::string *command_output,
70 const Timeout<std::micro> &timeout) override;
72 const char *GetHostname() override;
73 UserIDResolver &GetUserIDResolver() override;
74 lldb_private::Environment GetEnvironment() override;
76 bool IsConnected() const override;
78 bool GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &proc_info) override;
79 uint32_t FindProcesses(const ProcessInstanceInfoMatch &match_info,
80 ProcessInstanceInfoList &process_infos) override;
82 lldb::ProcessSP ConnectProcess(llvm::StringRef connect_url,
83 llvm::StringRef plugin_name,
84 Debugger &debugger, Target *target,
85 Status &error) override;
87 Status LaunchProcess(ProcessLaunchInfo &launch_info) override;
89 Status KillProcess(const lldb::pid_t pid) override;
92 lldb::PlatformSP m_remote_platform_sp;
95 } // namespace lldb_private
97 #endif // LLDB_TARGET_REMOTEAWAREPLATFORM_H