#include <Platform.h>

Collaboration diagram for lldb_private::PlatformList:

[legend]

Public Member Functions
	PlatformList ()=default

	~PlatformList ()=default

void	Append (const lldb::PlatformSP &platform_sp, bool set_selected)

size_t	GetSize ()

lldb::PlatformSP	GetAtIndex (uint32_t idx)

lldb::PlatformSP	GetSelectedPlatform ()
	Select the active platform.

void	SetSelectedPlatform (const lldb::PlatformSP &platform_sp)

lldb::PlatformSP	GetOrCreate (llvm::StringRef name)

lldb::PlatformSP	GetOrCreate (const ArchSpec &arch, const ArchSpec &process_host_arch, ArchSpec *platform_arch_ptr, Status &error)

lldb::PlatformSP	GetOrCreate (const ArchSpec &arch, const ArchSpec &process_host_arch, ArchSpec *platform_arch_ptr)

lldb::PlatformSP	GetOrCreate (llvm::ArrayRef< ArchSpec > archs, const ArchSpec &process_host_arch, std::vector< lldb::PlatformSP > &candidates)
	Get the platform for the given list of architectures.

lldb::PlatformSP	Create (llvm::StringRef name)

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.

Protected Types
typedef std::vector< lldb::PlatformSP >	collection

Protected Attributes
std::recursive_mutex	m_mutex

collection	m_platforms

lldb::PlatformSP	m_selected_platform_sp

Private Member Functions
	PlatformList (const PlatformList &)=delete

const PlatformList &	operator= (const PlatformList &)=delete

Detailed Description

Definition at line 975 of file Platform.h.

Member Typedef Documentation

◆ collection

typedef std::vector<lldb::PlatformSP> lldb_private::PlatformList::collection

protected

Definition at line 1085 of file Platform.h.

Constructor & Destructor Documentation

◆ PlatformList() [1/2]

lldb_private::PlatformList::PlatformList ( )

default

◆ ~PlatformList()

lldb_private::PlatformList::~PlatformList ( )

default

◆ PlatformList() [2/2]

lldb_private::PlatformList::PlatformList ( const PlatformList & )

privatedelete

Member Function Documentation

◆ Append()

void lldb_private::PlatformList::Append	(	const lldb::PlatformSP &	platform_sp,
		bool	set_selected
	)

inline

Definition at line 981 of file Platform.h.

References m_mutex, m_platforms, and m_selected_platform_sp.

Referenced by lldb_private::Debugger::Debugger().

◆ Create()

PlatformSP PlatformList::Create ( llvm::StringRef name )

Definition at line 2091 of file Platform.cpp.

References lldb_private::Platform::Create(), m_mutex, and m_platforms.

Referenced by lldb_private::OptionGroupPlatform::CreatePlatformWithOptions(), DynamicLoaderDarwinKernel::DynamicLoaderDarwinKernel(), and GetOrCreate().

◆ GetAtIndex()

lldb::PlatformSP lldb_private::PlatformList::GetAtIndex ( uint32_t idx )

inline

Definition at line 993 of file Platform.h.

References m_mutex, and m_platforms.

◆ GetOrCreate() [1/4]

PlatformSP PlatformList::GetOrCreate	(	const ArchSpec &	arch,
		const ArchSpec &	process_host_arch,
		ArchSpec *	platform_arch_ptr
	)

Definition at line 2030 of file Platform.cpp.

References error(), GetOrCreate(), and lldb_private::ArchSpec::IsValid().

◆ GetOrCreate() [2/4]

PlatformSP PlatformList::GetOrCreate	(	const ArchSpec &	arch,
		const ArchSpec &	process_host_arch,
		ArchSpec *	platform_arch_ptr,
		Status &	error
	)

Definition at line 1979 of file Platform.cpp.

References lldb_private::ArchSpec::Clear(), lldb_private::ArchSpec::CompatibleMatch, lldb_private::ArchSpec::ExactMatch, lldb_private::PluginManager::GetPlatformCreateCallbackAtIndex(), m_mutex, and m_platforms.

◆ GetOrCreate() [3/4]

lldb::PlatformSP lldb_private::PlatformList::GetOrCreate	(	llvm::ArrayRef< ArchSpec >	archs,
		const ArchSpec &	process_host_arch,
		std::vector< lldb::PlatformSP > &	candidates
	)

Get the platform for the given list of architectures.

The algorithm works a follows:

Returns the selected platform if it matches any of the architectures.
Returns the host platform if it matches any of the architectures.
Returns the platform that matches all the architectures.

If none of the above apply, this function returns a default platform. The candidates output argument differentiates between either no platforms supporting the given architecture or multiple platforms supporting the given architecture.

◆ GetOrCreate() [4/4]

PlatformSP PlatformList::GetOrCreate ( llvm::StringRef name )

Definition at line 1970 of file Platform.cpp.

References Create(), m_mutex, and m_platforms.

Referenced by lldb_private::Process::CompleteAttach(), lldb_private::OptionGroupPlatform::CreatePlatformWithOptions(), lldb_private::TargetList::CreateTargetInternal(), GetOrCreate(), and lldb::SBDebugger::SetCurrentPlatform().

◆ GetSelectedPlatform()

lldb::PlatformSP lldb_private::PlatformList::GetSelectedPlatform ( )

inline

Select the active platform.

In order to debug remotely, other platform's can be remotely connected to and set as the selected platform for any subsequent debugging. This allows connection to remote targets and allows the ability to discover process info, launch and attach to remote processes.

Definition at line 1009 of file Platform.h.

References m_mutex, m_platforms, and m_selected_platform_sp.

Referenced by lldb_private::Target::Attach(), lldb_private::TargetList::CreateTargetInternal(), CommandObjectPlatformStatus::DoExecute(), CommandObjectPlatformProcessLaunch::DoExecute(), CommandObjectPlatformProcessList::DoExecute(), CommandObjectPlatformProcessInfo::DoExecute(), lldb_private::CommandInterpreter::GetPlatform(), lldb_private::CommandCompletions::RemoteDiskDirectories(), and lldb_private::CommandCompletions::RemoteDiskFiles().

◆ GetSize()

size_t lldb_private::PlatformList::GetSize ( )

inline

Definition at line 988 of file Platform.h.

References m_mutex, and m_platforms.

◆ LoadPlatformBinaryAndSetup()

bool PlatformList::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.

The binary will be loaded into the Target, or will be registered with the DynamicLoader so that it will be loaded at a later stage. Returns true to indicate that this is a platform binary and has been loaded/registered, no further action should be taken by the caller.

Parameters

[in]	process	Process read memory from, a Process must be provided.
[in]	addr	Address of a binary in memory.
[in]	notify	Whether ModulesDidLoad should be called, if a binary is loaded. Caller may prefer to call ModulesDidLoad for multiple binaries that were loaded at the same time.

Returns: Returns true if the binary was loaded in the target (or will be via a DynamicLoader). Returns false if the binary was not loaded/registered, and the caller must load it into the target.

Definition at line 2098 of file Platform.cpp.

References lldb_private::PluginManager::GetPlatformCreateCallbackAtIndex(), and m_mutex.

Referenced by ObjectFileMachO::LoadCoreFileImages().

◆ operator=()

const PlatformList & lldb_private::PlatformList::operator= ( const PlatformList & )

privatedelete

◆ SetSelectedPlatform()

void lldb_private::PlatformList::SetSelectedPlatform ( const lldb::PlatformSP & platform_sp )

inline

Definition at line 1017 of file Platform.h.

References m_mutex, m_platforms, and m_selected_platform_sp.

Referenced by lldb_private::OptionGroupPlatform::CreatePlatformWithOptions(), CommandObjectPlatformSelect::DoExecute(), and lldb::SBDebugger::SetCurrentPlatform().

Member Data Documentation

◆ m_mutex

std::recursive_mutex lldb_private::PlatformList::m_mutex

mutableprotected

Definition at line 1086 of file Platform.h.

Referenced by Append(), Create(), GetAtIndex(), GetOrCreate(), GetSelectedPlatform(), GetSize(), LoadPlatformBinaryAndSetup(), and SetSelectedPlatform().

◆ m_platforms

collection lldb_private::PlatformList::m_platforms

protected

Definition at line 1087 of file Platform.h.

Referenced by Append(), Create(), GetAtIndex(), GetOrCreate(), GetSelectedPlatform(), GetSize(), and SetSelectedPlatform().

◆ m_selected_platform_sp

lldb::PlatformSP lldb_private::PlatformList::m_selected_platform_sp

protected

Definition at line 1088 of file Platform.h.

Referenced by Append(), GetSelectedPlatform(), and SetSelectedPlatform().

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

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ collection

Constructor & Destructor Documentation

◆ PlatformList() [1/2]

◆ ~PlatformList()

◆ PlatformList() [2/2]

Member Function Documentation

◆ Append()

◆ Create()

◆ GetAtIndex()

◆ GetOrCreate() [1/4]

◆ GetOrCreate() [2/4]

◆ GetOrCreate() [3/4]

◆ GetOrCreate() [4/4]

◆ GetSelectedPlatform()

◆ GetSize()

◆ LoadPlatformBinaryAndSetup()

◆ operator=()

◆ SetSelectedPlatform()

Member Data Documentation

◆ m_mutex

◆ m_platforms

◆ m_selected_platform_sp