LLDB mainline
Public Member Functions | Protected Attributes | List of all members
lldb_private::RemoteAwarePlatform Class Reference

A base class for platforms which automatically want to be able to forward operations to a remote platform instance (such as PlatformRemoteGDBServer). More...

#include <RemoteAwarePlatform.h>

Inheritance diagram for lldb_private::RemoteAwarePlatform:
Inheritance graph
[legend]

Public Member Functions

bool GetModuleSpec (const FileSpec &module_file_spec, const ArchSpec &arch, ModuleSpec &module_spec) override
 
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.
 
lldb::user_id_t OpenFile (const FileSpec &file_spec, File::OpenOptions flags, uint32_t mode, Status &error) override
 
bool CloseFile (lldb::user_id_t fd, Status &error) override
 
uint64_t ReadFile (lldb::user_id_t fd, uint64_t offset, void *dst, uint64_t dst_len, Status &error) override
 
uint64_t WriteFile (lldb::user_id_t fd, uint64_t offset, const void *src, uint64_t src_len, Status &error) override
 
lldb::user_id_t GetFileSize (const FileSpec &file_spec) override
 
Status CreateSymlink (const FileSpec &src, const FileSpec &dst) override
 
bool GetFileExists (const FileSpec &file_spec) override
 
Status Unlink (const FileSpec &file_spec) override
 
FileSpec GetRemoteWorkingDirectory () override
 
bool SetRemoteWorkingDirectory (const FileSpec &working_dir) override
 
Status MakeDirectory (const FileSpec &file_spec, uint32_t mode) override
 
Status GetFilePermissions (const FileSpec &file_spec, uint32_t &file_permissions) override
 
Status SetFilePermissions (const FileSpec &file_spec, uint32_t file_permissions) override
 
bool CalculateMD5 (const FileSpec &file_spec, uint64_t &low, uint64_t &high) override
 
Status GetFileWithUUID (const FileSpec &platform_file, const UUID *uuid, FileSpec &local_file) override
 Locate a file for a platform.
 
bool GetRemoteOSVersion () override
 
std::optional< std::string > GetRemoteOSBuildString () override
 
std::optional< std::string > GetRemoteOSKernelDescription () override
 
ArchSpec GetRemoteSystemArchitecture () 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 RunShellCommand (llvm::StringRef interpreter, llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout) override
 
const char * GetHostname () override
 
UserIDResolverGetUserIDResolver () override
 
lldb_private::Environment GetEnvironment () override
 
bool IsConnected () const override
 
bool GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &proc_info) override
 
uint32_t FindProcesses (const ProcessInstanceInfoMatch &match_info, ProcessInstanceInfoList &process_infos) override
 Attach to an existing process by process name.
 
lldb::ProcessSP ConnectProcess (llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Target *target, Status &error) 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 process.
 
Status KillProcess (const lldb::pid_t pid) override
 Kill process on a platform.
 
size_t ConnectToWaitingProcesses (Debugger &debugger, Status &error) override
 Connect to all processes waiting for a debugger to attach.
 
 Platform (bool is_host_platform)
 Default Constructor.
 
- Public Member Functions inherited from lldb_private::Platform
 Platform (bool is_host_platform)
 Default Constructor.
 
 ~Platform () override
 The destructor is virtual since this class is designed to be inherited from by the plug-in instance.
 
virtual Status ResolveExecutable (const ModuleSpec &module_spec, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr)
 Find a platform plugin for a given process.
 
virtual Status ResolveSymbolFile (Target &target, const ModuleSpec &sym_spec, FileSpec &sym_file)
 Find a symbol file given a symbol file module specification.
 
virtual bool ResolveRemotePath (const FileSpec &platform_path, FileSpec &resolved_platform_path)
 Resolves the FileSpec to a (possibly) remote path.
 
virtual llvm::VersionTuple GetOSVersion (Process *process=nullptr)
 Get the OS version from a connected platform.
 
bool SetOSVersion (llvm::VersionTuple os_version)
 
std::optional< std::string > GetOSBuildString ()
 
std::optional< std::string > GetOSKernelDescription ()
 
llvm::StringRef GetName ()
 
virtual const char * GetHostname ()
 
virtual ConstString GetFullNameForDylib (ConstString basename)
 
virtual llvm::StringRef GetDescription ()=0
 
virtual void GetStatus (Stream &strm)
 Report the current status for this platform.
 
virtual bool GetRemoteOSVersion ()
 
virtual std::optional< std::string > GetRemoteOSBuildString ()
 
virtual std::optional< std::string > GetRemoteOSKernelDescription ()
 
virtual ArchSpec GetRemoteSystemArchitecture ()
 
virtual FileSpec GetRemoteWorkingDirectory ()
 
virtual bool SetRemoteWorkingDirectory (const FileSpec &working_dir)
 
virtual UserIDResolverGetUserIDResolver ()
 
virtual Status GetFileWithUUID (const FileSpec &platform_file, const UUID *uuid_ptr, FileSpec &local_file)
 Locate a file for a platform.
 
virtual FileSpecList LocateExecutableScriptingResources (Target *target, Module &module, Stream &feedback_stream)
 
virtual Status GetSharedModule (const ModuleSpec &module_spec, Process *process, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr, llvm::SmallVectorImpl< lldb::ModuleSP > *old_modules, bool *did_create_ptr)
 
void CallLocateModuleCallbackIfSet (const ModuleSpec &module_spec, lldb::ModuleSP &module_sp, FileSpec &symbol_file_spec, bool *did_create_ptr)
 
virtual bool GetModuleSpec (const FileSpec &module_file_spec, const ArchSpec &arch, ModuleSpec &module_spec)
 
virtual Status ConnectRemote (Args &args)
 
virtual Status DisconnectRemote ()
 
virtual std::vector< ArchSpecGetSupportedArchitectures (const ArchSpec &process_host_arch)=0
 Get the platform's supported architectures in the order in which they should be searched.
 
virtual size_t GetSoftwareBreakpointTrapOpcode (Target &target, BreakpointSite *bp_site)
 
virtual Status LaunchProcess (ProcessLaunchInfo &launch_info)
 Launch a new process on a platform, not necessarily for debugging, it could be just for running the process.
 
virtual Status ShellExpandArguments (ProcessLaunchInfo &launch_info)
 Perform expansion of the command-line for this launch info This can potentially involve wildcard expansion environment variable replacement, and whatever other argument magic the platform defines as part of its typical user experience.
 
virtual Status KillProcess (const lldb::pid_t pid)
 Kill process on a platform.
 
virtual bool IsCompatibleArchitecture (const ArchSpec &arch, const ArchSpec &process_host_arch, ArchSpec::MatchType match, ArchSpec *compatible_arch_ptr)
 Lets a platform answer if it is compatible with a given architecture and the target triple contained within.
 
virtual bool CanDebugProcess ()
 Not all platforms will support debugging a process by spawning somehow halted for a debugger (specified using the "eLaunchFlagDebug" launch flag) and then attaching.
 
virtual lldb::ProcessSP DebugProcess (ProcessLaunchInfo &launch_info, Debugger &debugger, Target &target, Status &error)
 Subclasses do not need to implement this function as it uses the Platform::LaunchProcess() followed by Platform::Attach ().
 
virtual lldb::ProcessSP ConnectProcess (llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Target *target, Status &error)
 
virtual lldb::ProcessSP ConnectProcessSynchronous (llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Stream &stream, Target *target, Status &error)
 
virtual lldb::ProcessSP Attach (ProcessAttachInfo &attach_info, Debugger &debugger, Target *target, Status &error)=0
 Attach to an existing process using a process ID.
 
virtual uint32_t FindProcesses (const ProcessInstanceInfoMatch &match_info, ProcessInstanceInfoList &proc_infos)
 Attach to an existing process by process name.
 
ProcessInstanceInfoList GetAllProcesses ()
 
virtual bool GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &proc_info)
 
virtual lldb::BreakpointSP SetThreadCreationBreakpoint (Target &target)
 
virtual lldb_private::ConstString GetSDKDirectory (lldb_private::Target &target)
 
const std::string & GetRemoteURL () const
 
bool IsHost () const
 
bool IsRemote () const
 
virtual bool IsConnected () const
 
const ArchSpecGetSystemArchitecture ()
 
void SetSystemArchitecture (const ArchSpec &arch)
 
ArchSpec GetAugmentedArchSpec (llvm::StringRef triple)
 If the triple contains not specify the vendor, os, and environment parts, we "augment" these using information from the platform and return the resulting ArchSpec object.
 
size_t GetMaxUserIDNameLength () const
 
size_t GetMaxGroupIDNameLength () const
 
const std::string & GetSDKRootDirectory () const
 
void SetSDKRootDirectory (std::string dir)
 
const std::string & GetSDKBuild () const
 
void SetSDKBuild (std::string sdk_build)
 
virtual bool SupportsModules ()
 
virtual void AddClangModuleCompilationOptions (Target *target, std::vector< std::string > &options)
 
FileSpec GetWorkingDirectory ()
 
bool SetWorkingDirectory (const FileSpec &working_dir)
 
virtual bool ModuleIsExcludedForUnconstrainedSearches (Target &target, const lldb::ModuleSP &module_sp)
 
virtual Status MakeDirectory (const FileSpec &file_spec, uint32_t permissions)
 
virtual Status GetFilePermissions (const FileSpec &file_spec, uint32_t &file_permissions)
 
virtual Status SetFilePermissions (const FileSpec &file_spec, uint32_t file_permissions)
 
virtual lldb::user_id_t OpenFile (const FileSpec &file_spec, File::OpenOptions flags, uint32_t mode, Status &error)
 
virtual bool CloseFile (lldb::user_id_t fd, Status &error)
 
virtual lldb::user_id_t GetFileSize (const FileSpec &file_spec)
 
virtual void AutoCompleteDiskFileOrDirectory (CompletionRequest &request, bool only_dir)
 
virtual uint64_t ReadFile (lldb::user_id_t fd, uint64_t offset, void *dst, uint64_t dst_len, Status &error)
 
virtual uint64_t WriteFile (lldb::user_id_t fd, uint64_t offset, const void *src, uint64_t src_len, Status &error)
 
virtual Status GetFile (const FileSpec &source, const FileSpec &destination)
 
virtual Status PutFile (const FileSpec &source, const FileSpec &destination, uint32_t uid=UINT32_MAX, uint32_t gid=UINT32_MAX)
 
virtual Status CreateSymlink (const FileSpec &src, const FileSpec &dst)
 
virtual Status Install (const FileSpec &src, const FileSpec &dst)
 Install a file or directory to the remote system.
 
virtual Environment GetEnvironment ()
 
virtual bool GetFileExists (const lldb_private::FileSpec &file_spec)
 
virtual Status Unlink (const FileSpec &file_spec)
 
virtual MmapArgList GetMmapArgumentList (const ArchSpec &arch, lldb::addr_t addr, lldb::addr_t length, unsigned prot, unsigned flags, lldb::addr_t fd, lldb::addr_t offset)
 
virtual bool GetSupportsRSync ()
 
virtual void SetSupportsRSync (bool flag)
 
virtual const char * GetRSyncOpts ()
 
virtual void SetRSyncOpts (const char *opts)
 
virtual const char * GetRSyncPrefix ()
 
virtual void SetRSyncPrefix (const char *prefix)
 
virtual bool GetSupportsSSH ()
 
virtual void SetSupportsSSH (bool flag)
 
virtual const char * GetSSHOpts ()
 
virtual void SetSSHOpts (const char *opts)
 
virtual bool GetIgnoresRemoteHostname ()
 
virtual void SetIgnoresRemoteHostname (bool flag)
 
virtual lldb_private::OptionGroupOptionsGetConnectionOptions (CommandInterpreter &interpreter)
 
virtual lldb_private::Status RunShellCommand (llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout)
 
virtual lldb_private::Status RunShellCommand (llvm::StringRef shell, llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout)
 
virtual void SetLocalCacheDirectory (const char *local)
 
virtual const char * GetLocalCacheDirectory ()
 
virtual std::string GetPlatformSpecificConnectionInformation ()
 
virtual bool CalculateMD5 (const FileSpec &file_spec, uint64_t &low, uint64_t &high)
 
virtual uint32_t GetResumeCountForLaunchInfo (ProcessLaunchInfo &launch_info)
 
virtual const lldb::UnixSignalsSPGetRemoteUnixSignals ()
 
lldb::UnixSignalsSP GetUnixSignals ()
 
virtual std::string GetQueueNameForThreadQAddress (Process *process, lldb::addr_t dispatch_qaddr)
 Locate a queue name given a thread's qaddr.
 
virtual lldb::queue_id_t GetQueueIDForThreadQAddress (Process *process, lldb::addr_t dispatch_qaddr)
 Locate a queue ID given a thread's qaddr.
 
virtual const std::vector< ConstString > & GetTrapHandlerSymbolNames ()
 Provide a list of trap handler function names for this platform.
 
virtual lldb::UnwindPlanSP GetTrapHandlerUnwindPlan (const llvm::Triple &triple, ConstString name)
 Try to get a specific unwind plan for a named trap handler.
 
virtual FileSpec LocateExecutable (const char *basename)
 Find a support executable that may not live within in the standard locations related to LLDB.
 
virtual uint32_t GetDefaultMemoryCacheLineSize ()
 Allow the platform to set preferred memory cache line size.
 
uint32_t LoadImage (lldb_private::Process *process, const lldb_private::FileSpec &local_file, const lldb_private::FileSpec &remote_file, lldb_private::Status &error)
 Load a shared library into this process.
 
uint32_t LoadImageUsingPaths (lldb_private::Process *process, const lldb_private::FileSpec &library_name, const std::vector< std::string > &paths, lldb_private::Status &error, lldb_private::FileSpec *loaded_path)
 Load a shared library specified by base name into this process, looking by hand along a set of paths.
 
virtual uint32_t DoLoadImage (lldb_private::Process *process, const lldb_private::FileSpec &remote_file, const std::vector< std::string > *paths, lldb_private::Status &error, lldb_private::FileSpec *loaded_path=nullptr)
 
virtual Status UnloadImage (lldb_private::Process *process, uint32_t image_token)
 
virtual size_t ConnectToWaitingProcesses (lldb_private::Debugger &debugger, lldb_private::Status &error)
 Connect to all processes waiting for a debugger to attach.
 
virtual llvm::Expected< StructuredData::DictionarySPFetchExtendedCrashInformation (lldb_private::Process &process)
 Gather all of crash informations into a structured data dictionary.
 
virtual bool LoadPlatformBinaryAndSetup (Process *process, lldb::addr_t addr, bool notify)
 Detect a binary in memory that will determine which Platform and DynamicLoader should be used in this target/process, and update the Platform/DynamicLoader.
 
virtual CompilerType GetSiginfoType (const llvm::Triple &triple)
 
virtual Args GetExtraStartupCommands ()
 
void SetLocateModuleCallback (LocateModuleCallback callback)
 Set locate module callback.
 
LocateModuleCallback GetLocateModuleCallback () const
 
- Public Member Functions inherited from lldb_private::PluginInterface
 PluginInterface ()=default
 
virtual ~PluginInterface ()=default
 
virtual llvm::StringRef GetPluginName ()=0
 
 PluginInterface (const PluginInterface &)=delete
 
PluginInterfaceoperator= (const PluginInterface &)=delete
 

Protected Attributes

lldb::PlatformSP m_remote_platform_sp
 
- Protected Attributes inherited from lldb_private::Platform
bool m_is_host
 
bool m_os_version_set_while_connected
 
bool m_system_arch_set_while_connected
 
std::string m_sdk_sysroot
 
std::string m_sdk_build
 
FileSpec m_working_dir
 
std::string m_remote_url
 
std::string m_hostname
 
llvm::VersionTuple m_os_version
 
ArchSpec m_system_arch
 
std::mutex m_mutex
 
size_t m_max_uid_name_len
 
size_t m_max_gid_name_len
 
bool m_supports_rsync
 
std::string m_rsync_opts
 
std::string m_rsync_prefix
 
bool m_supports_ssh
 
std::string m_ssh_opts
 
bool m_ignores_remote_hostname
 
std::string m_local_cache_directory
 
std::vector< ConstStringm_trap_handlers
 
bool m_calculated_trap_handlers
 
const std::unique_ptr< ModuleCachem_module_cache
 
LocateModuleCallback m_locate_module_callback
 

Additional Inherited Members

- Public Types inherited from lldb_private::Platform
typedef std::function< Status(const ModuleSpec &module_spec, FileSpec &module_file_spec, FileSpec &symbol_file_spec)> LocateModuleCallback
 
- Static Public Member Functions inherited from lldb_private::Platform
static void Initialize ()
 
static void Terminate ()
 
static PlatformPropertiesGetGlobalPlatformProperties ()
 
static lldb::PlatformSP GetHostPlatform ()
 Get the native host platform plug-in.
 
static const char * GetHostPlatformName ()
 
static void SetHostPlatform (const lldb::PlatformSP &platform_sp)
 
static lldb::PlatformSP Create (llvm::StringRef name)
 
static ArchSpec GetAugmentedArchSpec (Platform *platform, llvm::StringRef triple)
 Augments the triple either with information from platform or the host system (if platform is null).
 
- Protected Types inherited from lldb_private::Platform
typedef std::map< uint32_t, ConstStringIDToNameMap
 
- Protected Member Functions inherited from lldb_private::Platform
lldb::ProcessSP DoConnectProcess (llvm::StringRef connect_url, llvm::StringRef plugin_name, Debugger &debugger, Stream *stream, Target *target, Status &error)
 Private implementation of connecting to a process.
 
virtual void CalculateTrapHandlerSymbolNames ()=0
 Ask the Platform subclass to fill in the list of trap handler names.
 
Status GetCachedExecutable (ModuleSpec &module_spec, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr)
 
virtual Status DownloadModuleSlice (const FileSpec &src_file_spec, const uint64_t src_offset, const uint64_t src_size, const FileSpec &dst_file_spec)
 
virtual Status DownloadSymbolFile (const lldb::ModuleSP &module_sp, const FileSpec &dst_file_spec)
 
virtual const char * GetCacheHostname ()
 
virtual Status ResolveRemoteExecutable (const ModuleSpec &module_spec, lldb::ModuleSP &exe_module_sp, const FileSpecList *module_search_paths_ptr)
 
- Static Protected Member Functions inherited from lldb_private::Platform
static std::vector< ArchSpecCreateArchList (llvm::ArrayRef< llvm::Triple::ArchType > archs, llvm::Triple::OSType os)
 Create a list of ArchSpecs with the given OS and a architectures.
 

Detailed Description

A base class for platforms which automatically want to be able to forward operations to a remote platform instance (such as PlatformRemoteGDBServer).

Definition at line 19 of file RemoteAwarePlatform.h.

Member Function Documentation

◆ CalculateMD5()

bool RemoteAwarePlatform::CalculateMD5 ( const FileSpec file_spec,
uint64_t &  low,
uint64_t &  high 
)
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 269 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::CalculateMD5(), and m_remote_platform_sp.

◆ CloseFile()

bool RemoteAwarePlatform::CloseFile ( lldb::user_id_t  fd,
Status error 
)
overridevirtual

◆ ConnectProcess()

lldb::ProcessSP RemoteAwarePlatform::ConnectProcess ( llvm::StringRef  connect_url,
llvm::StringRef  plugin_name,
Debugger debugger,
Target target,
Status error 
)
overridevirtual

◆ ConnectToWaitingProcesses()

size_t RemoteAwarePlatform::ConnectToWaitingProcesses ( Debugger debugger,
Status error 
)
overridevirtual

Connect to all processes waiting for a debugger to attach.

If the platform have a list of processes waiting for a debugger to connect to them then connect to all of these pending processes.

Parameters
[in]debuggerThe debugger used for the connect.
[out]errorIf an error occurred during the connect then this object will contain the error message.
Returns
The number of processes we are successfully connected to.

Reimplemented from lldb_private::Platform.

Definition at line 390 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::ConnectToWaitingProcesses(), error(), and m_remote_platform_sp.

◆ CreateSymlink()

Status RemoteAwarePlatform::CreateSymlink ( const FileSpec src,
const FileSpec dst 
)
overridevirtual

◆ FindProcesses()

uint32_t RemoteAwarePlatform::FindProcesses ( const ProcessInstanceInfoMatch match_info,
ProcessInstanceInfoList proc_infos 
)
overridevirtual

Attach to an existing process by process name.

This function is not meant to be overridden by Process subclasses. It will first call Process::WillAttach (const char *) and if that returns true, Process::DoAttach (const char *) will be called to actually do the attach. If DoAttach returns true, then Process::DidAttach() will be called.

Parameters
[in]process_nameA process name to match against the current process list.
Returns
Returns pid if attaching was successful, or LLDB_INVALID_PROCESS_ID if attaching fails.

Reimplemented from lldb_private::Platform.

Reimplemented in lldb_private::PlatformAppleSimulator.

Definition at line 359 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::FindProcesses(), and m_remote_platform_sp.

◆ GetEnvironment()

Environment RemoteAwarePlatform::GetEnvironment ( )
overridevirtual

◆ GetFileExists()

bool RemoteAwarePlatform::GetFileExists ( const FileSpec file_spec)
overridevirtual

◆ GetFilePermissions()

Status RemoteAwarePlatform::GetFilePermissions ( const FileSpec file_spec,
uint32_t &  file_permissions 
)
overridevirtual

◆ GetFileSize()

lldb::user_id_t RemoteAwarePlatform::GetFileSize ( const FileSpec file_spec)
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 244 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::GetFileSize(), and m_remote_platform_sp.

◆ GetFileWithUUID()

Status RemoteAwarePlatform::GetFileWithUUID ( const FileSpec platform_file,
const UUID uuid_ptr,
FileSpec local_file 
)
overridevirtual

Locate a file for a platform.

The default implementation of this function will return the same file patch in local_file as was in platform_file.

Parameters
[in]platform_fileThe platform file path to locate and cache locally.
[in]uuid_ptrIf we know the exact UUID of the file we are looking for, it can be specified. If it is not specified, we might now know the exact file. The UUID is usually some sort of MD5 checksum for the file and is sometimes known by dynamic linkers/loaders. If the UUID is known, it is best to supply it to platform file queries to ensure we are finding the correct file, not just a file at the correct path.
[out]local_fileA locally cached version of the platform file. For platforms that describe the current host computer, this will just be the same file. For remote platforms, this file might come from and SDK directory, or might need to be sync'ed over to the current machine for efficient debugging access.
Returns
An error object.

Reimplemented from lldb_private::Platform.

Definition at line 289 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::IsRemote(), and m_remote_platform_sp.

◆ GetHostname()

const char * RemoteAwarePlatform::GetHostname ( )
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 327 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::GetHostname(), and m_remote_platform_sp.

Referenced by PlatformPOSIX::PutFile().

◆ GetModuleSpec()

bool RemoteAwarePlatform::GetModuleSpec ( const FileSpec module_file_spec,
const ArchSpec arch,
ModuleSpec module_spec 
)
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 22 of file RemoteAwarePlatform.cpp.

References m_remote_platform_sp.

◆ GetProcessInfo()

bool RemoteAwarePlatform::GetProcessInfo ( lldb::pid_t  pid,
ProcessInstanceInfo proc_info 
)
overridevirtual

◆ GetRemoteOSBuildString()

std::optional< std::string > RemoteAwarePlatform::GetRemoteOSBuildString ( )
overridevirtual

◆ GetRemoteOSKernelDescription()

std::optional< std::string > RemoteAwarePlatform::GetRemoteOSKernelDescription ( )
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 315 of file RemoteAwarePlatform.cpp.

References m_remote_platform_sp.

◆ GetRemoteOSVersion()

bool RemoteAwarePlatform::GetRemoteOSVersion ( )
overridevirtual

◆ GetRemoteSystemArchitecture()

ArchSpec RemoteAwarePlatform::GetRemoteSystemArchitecture ( )
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 321 of file RemoteAwarePlatform.cpp.

References m_remote_platform_sp.

◆ GetRemoteWorkingDirectory()

FileSpec RemoteAwarePlatform::GetRemoteWorkingDirectory ( )
overridevirtual

◆ GetUserIDResolver()

UserIDResolver & RemoteAwarePlatform::GetUserIDResolver ( )
overridevirtual

◆ IsConnected()

bool RemoteAwarePlatform::IsConnected ( ) const
overridevirtual

◆ KillProcess()

Status RemoteAwarePlatform::KillProcess ( const lldb::pid_t  pid)
overridevirtual

Kill process on a platform.

Reimplemented from lldb_private::Platform.

Definition at line 384 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::KillProcess(), and m_remote_platform_sp.

◆ LaunchProcess()

Status RemoteAwarePlatform::LaunchProcess ( ProcessLaunchInfo launch_info)
overridevirtual

Launch a new process on a platform, not necessarily for debugging, it could be just for running the process.

Reimplemented from lldb_private::Platform.

Reimplemented in lldb_private::PlatformAppleSimulator, and lldb_private::PlatformDarwin.

Definition at line 378 of file RemoteAwarePlatform.cpp.

References lldb_private::Platform::LaunchProcess(), and m_remote_platform_sp.

◆ MakeDirectory()

Status RemoteAwarePlatform::MakeDirectory ( const FileSpec file_spec,
uint32_t  mode 
)
overridevirtual

◆ OpenFile()

lldb::user_id_t RemoteAwarePlatform::OpenFile ( const FileSpec file_spec,
File::OpenOptions  flags,
uint32_t  mode,
Status error 
)
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 214 of file RemoteAwarePlatform.cpp.

References error(), m_remote_platform_sp, and lldb_private::Platform::OpenFile().

Referenced by PlatformPOSIX::GetFile().

◆ Platform()

Platform::Platform ( bool  is_host_platform)

Default Constructor.

Definition at line 77 of file Platform.cpp.

◆ ReadFile()

uint64_t RemoteAwarePlatform::ReadFile ( lldb::user_id_t  fd,
uint64_t  offset,
void *  dst,
uint64_t  dst_len,
Status error 
)
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 228 of file RemoteAwarePlatform.cpp.

References error(), m_remote_platform_sp, and lldb_private::Platform::ReadFile().

Referenced by PlatformPOSIX::GetFile().

◆ ResolveExecutable()

Status RemoteAwarePlatform::ResolveExecutable ( const ModuleSpec module_spec,
lldb::ModuleSP module_sp,
const FileSpecList module_search_paths_ptr 
)
overridevirtual

Find a platform plugin for a given process.

Scans the installed Platform plug-ins and tries to find an instance that can be used for process

Parameters
[in]processThe process for which to try and locate a platform plug-in instance.
[in]plugin_nameAn optional name of a specific platform plug-in that should be used. If nullptr, pick the best plug-in. Set the target's executable based off of the existing architecture information in target given a path to an executable exe_file.

Each platform knows the architectures that it supports and can select the correct architecture slice within exe_file by inspecting the architecture in target. If the target had an architecture specified, then in can try and obey that request and optionally fail if the architecture doesn't match up. If no architecture is specified, the platform should select the default architecture from exe_file. Any application bundles or executable wrappers can also be inspected for the actual application binary within the bundle that should be used.

Returns
Returns true if this Platform plug-in was able to find a suitable executable, false otherwise.

Reimplemented from lldb_private::Platform.

Reimplemented in lldb_private::PlatformAppleSimulator, and lldb_private::PlatformRemoteDarwinDevice.

Definition at line 32 of file RemoteAwarePlatform.cpp.

References error(), lldb_private::ModuleSpec::GetArchitecture(), lldb_private::ArchSpec::GetArchitectureName(), lldb_private::Platform::GetCachedExecutable(), lldb_private::StreamString::GetData(), lldb_private::ModuleSpec::GetFileSpec(), lldb_private::FileSpec::GetPath(), lldb_private::FileSystem::GetPermissions(), lldb_private::PluginInterface::GetPluginName(), lldb_private::ModuleList::GetSharedModule(), lldb_private::Platform::GetSupportedArchitectures(), lldb_private::ArchSpec::GetTriple(), lldb_private::FileSystem::Instance(), lldb_private::Platform::IsHost(), lldb_private::ArchSpec::IsValid(), m_remote_platform_sp, PATH_MAX, lldb_private::FileSystem::Resolve(), lldb_private::Host::ResolveExecutableInBundle(), lldb_private::FileSystem::ResolveExecutableLocation(), and lldb_private::FileSpec::SetFile().

◆ RunShellCommand() [1/2]

Status RemoteAwarePlatform::RunShellCommand ( llvm::StringRef  command,
const FileSpec working_dir,
int *  status_ptr,
int *  signo_ptr,
std::string *  command_output,
const Timeout< std::micro > &  timeout 
)
overridevirtual

Reimplemented from lldb_private::Platform.

Definition at line 171 of file RemoteAwarePlatform.cpp.

References RunShellCommand().

Referenced by PlatformPOSIX::GetFile(), PlatformPOSIX::PutFile(), and RunShellCommand().

◆ RunShellCommand() [2/2]

Status RemoteAwarePlatform::RunShellCommand ( llvm::StringRef  interpreter,
llvm::StringRef  command,
const FileSpec working_dir,
int *  status_ptr,
int *  signo_ptr,
std::string *  command_output,
const Timeout< std::micro > &  timeout 
)
overridevirtual

◆ SetFilePermissions()

Status RemoteAwarePlatform::SetFilePermissions ( const FileSpec file_spec,
uint32_t  file_permissions 
)
overridevirtual

◆ SetRemoteWorkingDirectory()

bool RemoteAwarePlatform::SetRemoteWorkingDirectory ( const FileSpec working_dir)
overridevirtual

◆ Unlink()

Status RemoteAwarePlatform::Unlink ( const FileSpec file_spec)
overridevirtual

◆ WriteFile()

uint64_t RemoteAwarePlatform::WriteFile ( lldb::user_id_t  fd,
uint64_t  offset,
const void *  src,
uint64_t  src_len,
Status error 
)
overridevirtual

Member Data Documentation

◆ m_remote_platform_sp

lldb::PlatformSP lldb_private::RemoteAwarePlatform::m_remote_platform_sp
protected

Definition at line 105 of file RemoteAwarePlatform.h.

Referenced by PlatformPOSIX::Attach(), lldb_private::PlatformWindows::Attach(), CalculateMD5(), CloseFile(), ConnectProcess(), lldb_private::platform_android::PlatformAndroid::ConnectRemote(), PlatformPOSIX::ConnectRemote(), lldb_private::PlatformWindows::ConnectRemote(), ConnectToWaitingProcesses(), CreateSymlink(), PlatformPOSIX::DebugProcess(), lldb_private::PlatformWindows::DebugProcess(), lldb_private::PlatformDarwin::DebugProcess(), PlatformPOSIX::DisconnectRemote(), lldb_private::PlatformWindows::DisconnectRemote(), FindProcesses(), GetEnvironment(), lldb_private::platform_android::PlatformAndroid::GetFile(), PlatformPOSIX::GetFile(), GetFileExists(), GetFilePermissions(), GetFileSize(), GetFileWithUUID(), GetHostname(), GetModuleSpec(), GetProcessInfo(), GetRemoteOSBuildString(), GetRemoteOSKernelDescription(), GetRemoteOSVersion(), GetRemoteSystemArchitecture(), PlatformPOSIX::GetRemoteUnixSignals(), GetRemoteWorkingDirectory(), lldb_private::PlatformDarwin::GetSharedModule(), lldb_private::PlatformDarwinDevice::GetSharedModuleWithLocalCache(), lldb_private::platform_freebsd::PlatformFreeBSD::GetSupportedArchitectures(), lldb_private::platform_linux::PlatformLinux::GetSupportedArchitectures(), lldb_private::platform_netbsd::PlatformNetBSD::GetSupportedArchitectures(), lldb_private::platform_openbsd::PlatformOpenBSD::GetSupportedArchitectures(), GetUserIDResolver(), IsConnected(), KillProcess(), LaunchProcess(), MakeDirectory(), OpenFile(), lldb_private::platform_android::PlatformAndroid::PutFile(), PlatformPOSIX::PutFile(), ReadFile(), ResolveExecutable(), RunShellCommand(), SetFilePermissions(), SetRemoteWorkingDirectory(), Unlink(), and WriteFile().


The documentation for this class was generated from the following files: