LLDB mainline
RemoteAwarePlatform.h
Go to the documentation of this file.
1//===-- RemoteAwarePlatform.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_TARGET_REMOTEAWAREPLATFORM_H
10#define LLDB_TARGET_REMOTEAWAREPLATFORM_H
11
13#include <optional>
14
15namespace lldb_private {
16
17/// A base class for platforms which automatically want to be able to forward
18/// operations to a remote platform instance (such as PlatformRemoteGDBServer).
20public:
22
23 bool GetModuleSpec(const FileSpec &module_file_spec, const ArchSpec &arch,
24 ModuleSpec &module_spec) override;
25
26 Status
27 ResolveExecutable(const ModuleSpec &module_spec, lldb::ModuleSP &module_sp,
28 const FileSpecList *module_search_paths_ptr) override;
29
30 lldb::user_id_t OpenFile(const FileSpec &file_spec, File::OpenOptions flags,
31 uint32_t mode, Status &error) override;
32
33 bool CloseFile(lldb::user_id_t fd, Status &error) override;
34
35 uint64_t ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst,
36 uint64_t dst_len, Status &error) override;
37
38 uint64_t WriteFile(lldb::user_id_t fd, uint64_t offset, const void *src,
39 uint64_t src_len, Status &error) override;
40
41 lldb::user_id_t GetFileSize(const FileSpec &file_spec) override;
42
43 Status CreateSymlink(const FileSpec &src, const FileSpec &dst) override;
44
45 bool GetFileExists(const FileSpec &file_spec) override;
46
47 Status Unlink(const FileSpec &file_spec) override;
48
50
51 bool SetRemoteWorkingDirectory(const FileSpec &working_dir) override;
52
53 Status MakeDirectory(const FileSpec &file_spec, uint32_t mode) override;
54
55 Status GetFilePermissions(const FileSpec &file_spec,
56 uint32_t &file_permissions) override;
57
58 Status SetFilePermissions(const FileSpec &file_spec,
59 uint32_t file_permissions) override;
60
61 llvm::ErrorOr<llvm::MD5::MD5Result>
62 CalculateMD5(const FileSpec &file_spec) override;
63
64 Status GetFileWithUUID(const FileSpec &platform_file, const UUID *uuid,
65 FileSpec &local_file) override;
66
67 bool GetRemoteOSVersion() override;
68 std::optional<std::string> GetRemoteOSBuildString() override;
69 std::optional<std::string> GetRemoteOSKernelDescription() override;
71
72 Status RunShellCommand(llvm::StringRef command, const FileSpec &working_dir,
73 int *status_ptr, int *signo_ptr,
74 std::string *command_output,
75 const Timeout<std::micro> &timeout) override;
76
77 Status RunShellCommand(llvm::StringRef interpreter, llvm::StringRef command,
78 const FileSpec &working_dir, int *status_ptr,
79 int *signo_ptr, std::string *command_output,
80 const Timeout<std::micro> &timeout) override;
81
82 const char *GetHostname() override;
85
86 bool IsConnected() const override;
87
88 bool GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &proc_info) override;
89 uint32_t FindProcesses(const ProcessInstanceInfoMatch &match_info,
90 ProcessInstanceInfoList &process_infos) override;
91
92 lldb::ProcessSP ConnectProcess(llvm::StringRef connect_url,
93 llvm::StringRef plugin_name,
94 Debugger &debugger, Target *target,
95 Status &error) override;
96
97 Status LaunchProcess(ProcessLaunchInfo &launch_info) override;
98
99 Status KillProcess(const lldb::pid_t pid) override;
100
101 size_t ConnectToWaitingProcesses(Debugger &debugger,
102 Status &error) override;
103
104protected:
106};
107
108} // namespace lldb_private
109
110#endif // LLDB_TARGET_REMOTEAWAREPLATFORM_H
static llvm::raw_ostream & error(Stream &strm)
An architecture specification class.
Definition: ArchSpec.h:31
A class to manage flag bits.
Definition: Debugger.h:80
A file collection class.
Definition: FileSpecList.h:85
A file utility class.
Definition: FileSpec.h:56
A plug-in interface definition class for debug platform that includes many platform abilities such as...
Definition: Platform.h:74
Platform(bool is_host_platform)
Default Constructor.
Definition: Platform.cpp:268
A base class for platforms which automatically want to be able to forward operations to a remote plat...
size_t ConnectToWaitingProcesses(Debugger &debugger, Status &error) override
Connect to all processes waiting for a debugger to attach.
Status ResolveExecutable(const ModuleSpec &module_spec, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr) override
Find a platform plugin for a given process.
uint64_t WriteFile(lldb::user_id_t fd, uint64_t offset, const void *src, uint64_t src_len, Status &error) override
uint64_t ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst, uint64_t dst_len, Status &error) override
bool CloseFile(lldb::user_id_t fd, Status &error) override
Status GetFileWithUUID(const FileSpec &platform_file, const UUID *uuid, FileSpec &local_file) override
Locate a file for a platform.
std::optional< std::string > GetRemoteOSBuildString() override
bool GetModuleSpec(const FileSpec &module_file_spec, const ArchSpec &arch, ModuleSpec &module_spec) override
llvm::ErrorOr< llvm::MD5::MD5Result > CalculateMD5(const FileSpec &file_spec) override
Status KillProcess(const lldb::pid_t pid) override
Kill process on a platform.
bool GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &proc_info) override
bool GetFileExists(const FileSpec &file_spec) override
std::optional< std::string > GetRemoteOSKernelDescription() override
Status SetFilePermissions(const FileSpec &file_spec, uint32_t file_permissions) override
lldb::ProcessSP ConnectProcess(llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Target *target, Status &error) override
Status MakeDirectory(const FileSpec &file_spec, uint32_t mode) override
lldb_private::Environment GetEnvironment() override
lldb::user_id_t OpenFile(const FileSpec &file_spec, File::OpenOptions flags, uint32_t mode, Status &error) override
Status RunShellCommand(llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout) override
Status LaunchProcess(ProcessLaunchInfo &launch_info) override
Launch a new process on a platform, not necessarily for debugging, it could be just for running the p...
Status GetFilePermissions(const FileSpec &file_spec, uint32_t &file_permissions) override
lldb::user_id_t GetFileSize(const FileSpec &file_spec) override
bool SetRemoteWorkingDirectory(const FileSpec &working_dir) override
Status Unlink(const FileSpec &file_spec) override
Status CreateSymlink(const FileSpec &src, const FileSpec &dst) override
UserIDResolver & GetUserIDResolver() override
uint32_t FindProcesses(const ProcessInstanceInfoMatch &match_info, ProcessInstanceInfoList &process_infos) override
Attach to an existing process by process name.
An error handling class.
Definition: Status.h:44
An abstract interface for things that know how to map numeric user/group IDs into names.
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
std::vector< ProcessInstanceInfo > ProcessInstanceInfoList
Definition: Host.h:32
std::shared_ptr< lldb_private::Platform > PlatformSP
Definition: lldb-forward.h:380
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:381
uint64_t pid_t
Definition: lldb-types.h:83
uint64_t user_id_t
Definition: lldb-types.h:82
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:365