#include <SBPlatform.h>

Public Member Functions
	SBPlatform ()

	SBPlatform (const char *platform_name)

	SBPlatform (const SBPlatform &rhs)

SBPlatform &	operator= (const SBPlatform &rhs)

	~SBPlatform ()

	operator bool () const

bool	IsValid () const

void	Clear ()

const char *	GetWorkingDirectory ()

bool	SetWorkingDirectory (const char *path)

const char *	GetName ()

SBError	ConnectRemote (SBPlatformConnectOptions &connect_options)

void	DisconnectRemote ()

bool	IsConnected ()

const char *	GetTriple ()

const char *	GetHostname ()

const char *	GetOSBuild ()

const char *	GetOSDescription ()

uint32_t	GetOSMajorVersion ()

uint32_t	GetOSMinorVersion ()

uint32_t	GetOSUpdateVersion ()

void	SetSDKRoot (const char *sysroot)

SBError	Put (SBFileSpec &src, SBFileSpec &dst)

SBError	Get (SBFileSpec &src, SBFileSpec &dst)

SBError	Install (SBFileSpec &src, SBFileSpec &dst)

SBError	Run (SBPlatformShellCommand &shell_command)

SBError	Launch (SBLaunchInfo &launch_info)

SBProcess	Attach (SBAttachInfo &attach_info, const SBDebugger &debugger, SBTarget &target, SBError &error)

SBProcessInfoList	GetAllProcesses (SBError &error)

SBError	Kill (const lldb::pid_t pid)

SBError	MakeDirectory (const char *path, uint32_t file_permissions=eFilePermissionsDirectoryDefault)

uint32_t	GetFilePermissions (const char *path)

SBError	SetFilePermissions (const char *path, uint32_t file_permissions)

SBUnixSignals	GetUnixSignals () const

SBEnvironment	GetEnvironment ()
	Return the environment variables of the remote platform connection process.

SBError	SetLocateModuleCallback (lldb::SBPlatformLocateModuleCallback callback, void *callback_baton)
	Set a callback as an implementation for locating module in order to implement own module cache system.

Static Public Member Functions
static SBPlatform	GetHostPlatform ()

Protected Member Functions
lldb::PlatformSP	GetSP () const

void	SetSP (const lldb::PlatformSP &platform_sp)

SBError	ExecuteConnected (const std::function< lldb_private::Status(const lldb::PlatformSP &)> &func)

Protected Attributes
lldb::PlatformSP	m_opaque_sp

Friends
class	SBDebugger

class	SBTarget

Detailed Description

Definition at line 97 of file SBPlatform.h.

Constructor & Destructor Documentation

◆ SBPlatform() [1/3]

SBPlatform::SBPlatform ( )

Definition at line 294 of file SBPlatform.cpp.

References LLDB_INSTRUMENT_VA.

◆ SBPlatform() [2/3]

SBPlatform::SBPlatform ( const char * platform_name )

Definition at line 296 of file SBPlatform.cpp.

References lldb_private::Platform::Create(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ SBPlatform() [3/3]

SBPlatform::SBPlatform ( const SBPlatform & rhs )

Definition at line 302 of file SBPlatform.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ ~SBPlatform()

SBPlatform::~SBPlatform ( )

default

Member Function Documentation

◆ Attach()

SBProcess SBPlatform::Attach	(	SBAttachInfo &	attach_info,
		const SBDebugger &	debugger,
		SBTarget &	target,
		SBError &	error
	)

Definition at line 578 of file SBPlatform.cpp.

References error(), lldb_private::Status::FromErrorString(), GetSP(), lldb::SBTarget::GetSP(), LLDB_INSTRUMENT_VA, lldb::SBAttachInfo::ref(), and lldb::SBDebugger::ref().

◆ Clear()

void SBPlatform::Clear ( )

Definition at line 335 of file SBPlatform.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ ConnectRemote()

SBError SBPlatform::ConnectRemote ( SBPlatformConnectOptions & connect_options )

Definition at line 379 of file SBPlatform.cpp.

References lldb_private::Args::AppendArgument(), lldb_private::Status::FromErrorString(), GetSP(), lldb::SBPlatformConnectOptions::GetURL(), LLDB_INSTRUMENT_VA, and lldb::SBError::ref().

◆ DisconnectRemote()

void SBPlatform::DisconnectRemote ( )

Definition at line 394 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ ExecuteConnected()

SBError SBPlatform::ExecuteConnected ( const std::function< lldb_private::Status(const lldb::PlatformSP &)> & func )

protected

Definition at line 622 of file SBPlatform.cpp.

References lldb_private::Status::FromErrorString(), GetSP(), and lldb::SBError::ref().

Referenced by Install(), Kill(), Launch(), Put(), and Run().

◆ Get()

SBError SBPlatform::Get	(	SBFileSpec &	src,
		SBFileSpec &	dst
	)

Definition at line 498 of file SBPlatform.cpp.

References lldb_private::Status::FromErrorString(), GetSP(), LLDB_INSTRUMENT_VA, lldb::SBError::ref(), and lldb::SBFileSpec::ref().

◆ GetAllProcesses()

SBProcessInfoList SBPlatform::GetAllProcesses ( SBError & error )

Definition at line 601 of file SBPlatform.cpp.

References error(), lldb_private::Status::FromErrorString(), and GetSP().

◆ GetEnvironment()

SBEnvironment SBPlatform::GetEnvironment ( )

Return the environment variables of the remote platform connection process.

Returns: An lldb::SBEnvironment object which is a copy of the platform's environment.

Definition at line 687 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetFilePermissions()

uint32_t SBPlatform::GetFilePermissions ( const char * path )

Definition at line 651 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetHostname()

const char * SBPlatform::GetHostname ( )

Definition at line 456 of file SBPlatform.cpp.

References lldb_private::ConstString::GetCString(), GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetHostPlatform()

SBPlatform SBPlatform::GetHostPlatform ( )

static

Definition at line 317 of file SBPlatform.cpp.

References lldb_private::Platform::GetHostPlatform(), LLDB_INSTRUMENT, and m_opaque_sp.

◆ GetName()

const char * SBPlatform::GetName ( )

Definition at line 341 of file SBPlatform.cpp.

References lldb_private::ConstString::AsCString(), GetSP(), and LLDB_INSTRUMENT_VA.

Referenced by lldb::SBDebugger::GetSelectedPlatform(), and lldb::SBDebugger::SetSelectedPlatform().

◆ GetOSBuild()

const char * SBPlatform::GetOSBuild ( )

Definition at line 426 of file SBPlatform.cpp.

References lldb_private::ConstString::GetCString(), GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetOSDescription()

const char * SBPlatform::GetOSDescription ( )

Definition at line 441 of file SBPlatform.cpp.

References lldb_private::ConstString::GetCString(), GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetOSMajorVersion()

uint32_t SBPlatform::GetOSMajorVersion ( )

Definition at line 465 of file SBPlatform.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and UINT32_MAX.

◆ GetOSMinorVersion()

uint32_t SBPlatform::GetOSMinorVersion ( )

Definition at line 474 of file SBPlatform.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and UINT32_MAX.

◆ GetOSUpdateVersion()

uint32_t SBPlatform::GetOSUpdateVersion ( )

Definition at line 483 of file SBPlatform.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and UINT32_MAX.

◆ GetSP()

lldb::PlatformSP SBPlatform::GetSP ( ) const

protected

◆ GetTriple()

const char * SBPlatform::GetTriple ( )

Definition at line 411 of file SBPlatform.cpp.

References lldb_private::ConstString::GetCString(), GetSP(), lldb_private::ArchSpec::GetTriple(), lldb_private::ArchSpec::IsValid(), and LLDB_INSTRUMENT_VA.

◆ GetUnixSignals()

SBUnixSignals SBPlatform::GetUnixSignals ( ) const

Definition at line 678 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetWorkingDirectory()

const char * SBPlatform::GetWorkingDirectory ( )

Definition at line 356 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ Install()

SBError SBPlatform::Install	(	SBFileSpec &	src,
		SBFileSpec &	dst
	)

Definition at line 531 of file SBPlatform.cpp.

References error(), ExecuteConnected(), lldb::SBFileSpec::Exists(), lldb_private::Status::FromErrorStringWithFormat(), lldb_private::FileSpec::GetPath(), LLDB_INSTRUMENT_VA, and lldb::SBFileSpec::ref().

◆ IsConnected()

bool SBPlatform::IsConnected ( )

Definition at line 402 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ IsValid()

bool SBPlatform::IsValid ( ) const

Definition at line 325 of file SBPlatform.cpp.

References LLDB_INSTRUMENT_VA.

◆ Kill()

SBError SBPlatform::Kill ( const lldb::pid_t pid )

Definition at line 615 of file SBPlatform.cpp.

References ExecuteConnected(), and LLDB_INSTRUMENT_VA.

◆ Launch()

SBError SBPlatform::Launch ( SBLaunchInfo & launch_info )

Definition at line 568 of file SBPlatform.cpp.

References error(), ExecuteConnected(), LLDB_INSTRUMENT_VA, lldb::SBLaunchInfo::ref(), and lldb::SBLaunchInfo::set_ref().

◆ MakeDirectory()

SBError SBPlatform::MakeDirectory	(	const char *	path,
		uint32_t	file_permissions = `eFilePermissionsDirectoryDefault`
	)

Definition at line 637 of file SBPlatform.cpp.

References lldb_private::Status::FromErrorString(), GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBError::ref().

◆ operator bool()

SBPlatform::operator bool ( ) const

explicit

Definition at line 329 of file SBPlatform.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator=()

SBPlatform & SBPlatform::operator= ( const SBPlatform & rhs )

Definition at line 308 of file SBPlatform.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ Put()

SBError SBPlatform::Put	(	SBFileSpec &	src,
		SBFileSpec &	dst
	)

Definition at line 511 of file SBPlatform.cpp.

References ExecuteConnected(), lldb::SBFileSpec::Exists(), lldb_private::Status::FromErrorStringWithFormat(), lldb_private::FileSpec::GetPath(), LLDB_INSTRUMENT_VA, and lldb::SBFileSpec::ref().

◆ Run()

SBError SBPlatform::Run ( SBPlatformShellCommand & shell_command )

Definition at line 544 of file SBPlatform.cpp.

References ExecuteConnected(), lldb_private::Status::FromErrorString(), lldb::SBPlatformShellCommand::GetCommand(), lldb::SBPlatformShellCommand::GetWorkingDirectory(), LLDB_INSTRUMENT_VA, lldb::SBPlatformShellCommand::m_opaque_ptr, PlatformShellCommand::m_output, PlatformShellCommand::m_shell, PlatformShellCommand::m_signo, PlatformShellCommand::m_status, and PlatformShellCommand::m_timeout.

◆ SetFilePermissions()

SBError SBPlatform::SetFilePermissions	(	const char *	path,
		uint32_t	file_permissions
	)

Definition at line 663 of file SBPlatform.cpp.

References lldb_private::Status::FromErrorString(), GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBError::ref().

◆ SetLocateModuleCallback()

SBError SBPlatform::SetLocateModuleCallback	(	lldb::SBPlatformLocateModuleCallback	callback,
		void *	callback_baton
	)

Set a callback as an implementation for locating module in order to implement own module cache system.

For example, to leverage distributed build system, to bypass pulling files from remote platform, or to search symbol files from symbol servers. The target will call this callback to get a module file and a symbol file, and it will fallback to the LLDB implementation when this callback failed or returned non-existent file. This callback can set either module_file_spec or symbol_file_spec, or both module_file_spec and symbol_file_spec. The callback will be cleared if nullptr or None is set.

Definition at line 698 of file SBPlatform.cpp.

References error(), GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBFileSpec::ref().

◆ SetSDKRoot()

void SBPlatform::SetSDKRoot ( const char * sysroot )

Definition at line 492 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ SetSP()

void SBPlatform::SetSP ( const lldb::PlatformSP & platform_sp )

protected

Definition at line 352 of file SBPlatform.cpp.

References m_opaque_sp.

Referenced by lldb::SBDebugger::GetPlatformAtIndex(), and lldb::SBDebugger::GetSelectedPlatform().

◆ SetWorkingDirectory()

bool SBPlatform::SetWorkingDirectory ( const char * path )

Definition at line 365 of file SBPlatform.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

Friends And Related Function Documentation

◆ SBDebugger

friend class SBDebugger

friend

Definition at line 194 of file SBPlatform.h.

◆ SBTarget

friend class SBTarget

friend

Definition at line 195 of file SBPlatform.h.

Member Data Documentation

◆ m_opaque_sp

lldb::PlatformSP lldb::SBPlatform::m_opaque_sp

protected

Definition at line 205 of file SBPlatform.h.

Referenced by Clear(), GetHostPlatform(), lldb::SBTarget::GetPlatform(), GetSP(), operator=(), SBPlatform(), and SetSP().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SBPlatform() [1/3]

◆ SBPlatform() [2/3]

◆ SBPlatform() [3/3]

◆ ~SBPlatform()

Member Function Documentation

◆ Attach()

◆ Clear()

◆ ConnectRemote()

◆ DisconnectRemote()

◆ ExecuteConnected()

◆ Get()

◆ GetAllProcesses()

◆ GetEnvironment()

◆ GetFilePermissions()

◆ GetHostname()

◆ GetHostPlatform()

◆ GetName()

◆ GetOSBuild()

◆ GetOSDescription()

◆ GetOSMajorVersion()

◆ GetOSMinorVersion()

◆ GetOSUpdateVersion()

◆ GetSP()

◆ GetTriple()

◆ GetUnixSignals()

◆ GetWorkingDirectory()

◆ Install()

◆ IsConnected()

◆ IsValid()

◆ Kill()

◆ Launch()

◆ MakeDirectory()

◆ operator bool()

◆ operator=()

◆ Put()

◆ Run()

◆ SetFilePermissions()

◆ SetLocateModuleCallback()

◆ SetSDKRoot()

◆ SetSP()

◆ SetWorkingDirectory()

Friends And Related Function Documentation

◆ SBDebugger

◆ SBTarget

Member Data Documentation

◆ m_opaque_sp