Manages communication with the inferior (debugee) process. More...

#include <NativeProcessLinux.h>

Inheritance diagram for lldb_private::process_linux::NativeProcessLinux:

Collaboration diagram for lldb_private::process_linux::NativeProcessLinux:

Classes
class	Factory

Public Member Functions
Status	Resume (const ResumeActionList &resume_actions) override

Status	Halt () override

Status	Detach () override

Status	Signal (int signo) override
	Sends a process a UNIX signal signal. More...

Status	Interrupt () override
	Tells a process to interrupt all operations as if by a Ctrl-C. More...

Status	Kill () override

Status	GetMemoryRegionInfo (lldb::addr_t load_addr, MemoryRegionInfo &range_info) override

Status	ReadMemory (lldb::addr_t addr, void *buf, size_t size, size_t &bytes_read) override

Status	WriteMemory (lldb::addr_t addr, const void *buf, size_t size, size_t &bytes_written) override

Status	AllocateMemory (size_t size, uint32_t permissions, lldb::addr_t &addr) override

Status	DeallocateMemory (lldb::addr_t addr) override

lldb::addr_t	GetSharedLibraryInfoAddress () override

size_t	UpdateThreads () override

const ArchSpec &	GetArchitecture () const override

Status	SetBreakpoint (lldb::addr_t addr, uint32_t size, bool hardware) override

Status	RemoveBreakpoint (lldb::addr_t addr, bool hardware=false) override

void	DoStopIDBumped (uint32_t newBumpId) override

Status	GetLoadedModuleFileSpec (const char *module_path, FileSpec &file_spec) override

Status	GetFileLoadAddress (const llvm::StringRef &file_name, lldb::addr_t &load_addr) override

NativeThreadLinux *	GetThreadByID (lldb::tid_t id)

llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > >	GetAuxvData () const override

lldb::user_id_t	StartTrace (const TraceOptions &config, Status &error) override
	StartTracing API for starting a tracing instance with the TraceOptions on a specific thread or process. More...

Status	StopTrace (lldb::user_id_t traceid, lldb::tid_t thread) override
	StopTracing API as the name suggests stops a tracing instance. More...

Status	GetData (lldb::user_id_t traceid, lldb::tid_t thread, llvm::MutableArrayRef< uint8_t > &buffer, size_t offset=0) override
	This API provides the trace data collected in the form of raw data. More...

Status	GetMetaData (lldb::user_id_t traceid, lldb::tid_t thread, llvm::MutableArrayRef< uint8_t > &buffer, size_t offset=0) override
	Similar API as above except it aims to provide any extra data useful for decoding the actual trace data. More...

Status	GetTraceConfig (lldb::user_id_t traceid, TraceOptions &config) override
	API to query the TraceOptions for a given user id. More...

bool	SupportHardwareSingleStepping () const

Public Member Functions inherited from lldb_private::NativeProcessProtocol
virtual	~NativeProcessProtocol ()

virtual Status	IgnoreSignals (llvm::ArrayRef< int > signals)

Status	ReadMemoryWithoutTrap (lldb::addr_t addr, void *buf, size_t size, size_t &bytes_read)

virtual bool	IsAlive () const

virtual const HardwareBreakpointMap &	GetHardwareBreakpointMap () const

virtual Status	SetHardwareBreakpoint (lldb::addr_t addr, size_t size)

virtual Status	RemoveHardwareBreakpoint (lldb::addr_t addr)

virtual const NativeWatchpointList::WatchpointMap &	GetWatchpointMap () const

virtual llvm::Optional< std::pair< uint32_t, uint32_t > >	GetHardwareDebugSupportInfo () const

virtual Status	SetWatchpoint (lldb::addr_t addr, size_t size, uint32_t watch_flags, bool hardware)

virtual Status	RemoveWatchpoint (lldb::addr_t addr)

lldb::pid_t	GetID () const

lldb::StateType	GetState () const

bool	IsRunning () const

bool	IsStepping () const

bool	CanResume () const

lldb::ByteOrder	GetByteOrder () const

virtual llvm::Optional< WaitStatus >	GetExitStatus ()

virtual bool	SetExitStatus (WaitStatus status, bool bNotifyStateChange)

NativeThreadProtocol *	GetThreadAtIndex (uint32_t idx)

NativeThreadProtocol *	GetThreadByID (lldb::tid_t tid)

void	SetCurrentThreadID (lldb::tid_t tid)

lldb::tid_t	GetCurrentThreadID ()

NativeThreadProtocol *	GetCurrentThread ()

virtual int	GetTerminalFileDescriptor ()

uint32_t	GetStopID () const

bool	RegisterNativeDelegate (NativeDelegate &native_delegate)
	Register a native delegate. More...

bool	UnregisterNativeDelegate (NativeDelegate &native_delegate)
	Unregister a native delegate previously registered. More...

Static Public Member Functions
static Status	PtraceWrapper (int req, lldb::pid_t pid, void addr=nullptr, void data=nullptr, size_t data_size=0, long *result=nullptr)

Protected Member Functions
llvm::Expected< llvm::ArrayRef< uint8_t > >	GetSoftwareBreakpointTrapOpcode (size_t size_hint) override

Protected Member Functions inherited from lldb_private::NativeProcessProtocol
	NativeProcessProtocol (lldb::pid_t pid, int terminal_fd, NativeDelegate &delegate)

void	SetState (lldb::StateType state, bool notify_delegates=true)

Status	SetSoftwareBreakpoint (lldb::addr_t addr, uint32_t size_hint)

Status	RemoveSoftwareBreakpoint (lldb::addr_t addr)

virtual size_t	GetSoftwareBreakpointPCOffset ()
	Return the offset of the PC relative to the software breakpoint that was hit. More...

void	FixupBreakpointPCAsNeeded (NativeThreadProtocol &thread)

void	NotifyDidExec ()
	Notify the delegate that an exec occurred. More...

NativeThreadProtocol *	GetThreadByIDUnlocked (lldb::tid_t tid)

Additional Inherited Members
Protected Attributes inherited from lldb_private::NativeProcessProtocol
std::unordered_map< lldb::addr_t, SoftwareBreakpoint >	m_software_breakpoints

lldb::pid_t	m_pid

std::vector< std::unique_ptr< NativeThreadProtocol > >	m_threads

lldb::tid_t	m_current_thread_id = LLDB_INVALID_THREAD_ID

std::recursive_mutex	m_threads_mutex

lldb::StateType	m_state = lldb::eStateInvalid

std::recursive_mutex	m_state_mutex

llvm::Optional< WaitStatus >	m_exit_status

std::recursive_mutex	m_delegates_mutex

std::vector< NativeDelegate * >	m_delegates

NativeWatchpointList	m_watchpoint_list

HardwareBreakpointMap	m_hw_breakpoints_map

int	m_terminal_fd

uint32_t	m_stop_id = 0

llvm::DenseSet< int >	m_signals_to_ignore

Detailed Description

Manages communication with the inferior (debugee) process.

Upon construction, this class prepares and launches an inferior process for debugging.

Changes in the inferior process state are broadcasted.

Definition at line 39 of file NativeProcessLinux.h.

Member Function Documentation

◆ AllocateMemory()

Status NativeProcessLinux::AllocateMemory	(	size_t	size,
		uint32_t	permissions,
		lldb::addr_t &	addr
	)

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1361 of file NativeProcessLinux.cpp.

References lldb_private::eMmapFlagsAnon, lldb_private::eMmapFlagsPrivate, lldb_private::eMmapProtExec, lldb_private::eMmapProtRead, lldb_private::eMmapProtWrite, lldb_private::GetPermissionsAsCString(), lldb_private::InferiorCallMmap(), and LLDB_INVALID_ADDRESS.

◆ DeallocateMemory()

Status NativeProcessLinux::DeallocateMemory ( lldb::addr_t addr )

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1394 of file NativeProcessLinux.cpp.

◆ Detach()

Status NativeProcessLinux::Detach ( )

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1116 of file NativeProcessLinux.cpp.

References lldb_private::Status::Fail(), lldb_private::NativeThreadProtocol::GetID(), LLDB_INVALID_PROCESS_ID, and LLDB_INVALID_UID.

Referenced by GetAuxvData().

◆ DoStopIDBumped()

void NativeProcessLinux::DoStopIDBumped ( uint32_t newBumpId )

overridevirtual

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1353 of file NativeProcessLinux.cpp.

References lldb_private::GetLogIfAllCategoriesSet(), LLDB_LOG, and POSIX_LOG_PROCESS.

Referenced by GetArchitecture().

◆ GetArchitecture()

const ArchSpec& lldb_private::process_linux::NativeProcessLinux::GetArchitecture ( ) const

inlineoverridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 83 of file NativeProcessLinux.h.

References DoStopIDBumped(), GetFileLoadAddress(), GetLoadedModuleFileSpec(), GetThreadByID(), RemoveBreakpoint(), and SetBreakpoint().

◆ GetAuxvData()

llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer> > lldb_private::process_linux::NativeProcessLinux::GetAuxvData ( ) const

inlineoverridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 101 of file NativeProcessLinux.h.

References lldb_private::process_linux::NativeProcessLinux::Factory::Attach(), Detach(), lldb_private::eLazyBoolCalculate, GetData(), lldb_private::NativeProcessProtocol::GetID(), GetMetaData(), lldb_private::getProcFile(), GetSoftwareBreakpointTrapOpcode(), GetTraceConfig(), LLDB_INVALID_THREAD_ID, LLDB_INVALID_UID, PtraceWrapper(), StartTrace(), StopTrace(), and SupportHardwareSingleStepping().

◆ GetData()

Status NativeProcessLinux::GetData	(	lldb::user_id_t	traceid,
		lldb::tid_t	thread,
		llvm::MutableArrayRef< uint8_t > &	buffer,
		size_t	offset = `0`
	)

overridevirtual

This API provides the trace data collected in the form of raw data.

Parameters

[in]	traceid	thread The traceid and thread provide the context for the trace instance.
[in]	buffer	The buffer provides the destination buffer where the trace data would be read to. The buffer should be truncated to the filled length by this function.
[in]	offset	There is possibility to read partially the trace data from a specified offset where in such cases the buffer provided may be smaller than the internal trace collection container.

Returns: The size of the data actually read.

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1878 of file NativeProcessLinux.cpp.

References lldb_private::GetLogIfAllCategoriesSet(), LLDB_LOG, and POSIX_LOG_PTRACE.

Referenced by GetAuxvData().

◆ GetFileLoadAddress()

Status NativeProcessLinux::GetFileLoadAddress	(	const llvm::StringRef &	file_name,
		lldb::addr_t &	load_addr
	)

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1649 of file NativeProcessLinux.cpp.

References lldb_private::Status::Fail(), and LLDB_INVALID_ADDRESS.

Referenced by GetArchitecture().

◆ GetLoadedModuleFileSpec()

Status NativeProcessLinux::GetLoadedModuleFileSpec	(	const char *	module_path,
		FileSpec &	file_spec
	)

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1629 of file NativeProcessLinux.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::FileSpec::Clear(), lldb_private::Status::Fail(), and lldb_private::FileSpec::GetFilename().

Referenced by GetArchitecture().

◆ GetMemoryRegionInfo()

Status NativeProcessLinux::GetMemoryRegionInfo	(	lldb::addr_t	load_addr,
		MemoryRegionInfo &	range_info
	)

overridevirtual

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1231 of file NativeProcessLinux.cpp.

References lldb_private::Range< B, S >::Contains(), lldb_private::eLazyBoolNo, lldb_private::eLazyBoolYes, lldb_private::Status::Fail(), lldb_private::ConstString::GetCString(), lldb_private::GetLogIfAllCategoriesSet(), lldb_private::MemoryRegionInfo::GetName(), lldb_private::getProcFile(), lldb_private::MemoryRegionInfo::GetRange(), lldb_private::Range< B, S >::GetRangeBase(), LLDB_INVALID_ADDRESS, LLDB_LOG, lldb_private::ParseLinuxMapRegions(), POSIX_LOG_PROCESS, lldb_private::Range< B, S >::SetByteSize(), lldb_private::MemoryRegionInfo::SetExecutable(), lldb_private::MemoryRegionInfo::SetMapped(), lldb_private::Range< B, S >::SetRangeBase(), lldb_private::Range< B, S >::SetRangeEnd(), lldb_private::MemoryRegionInfo::SetReadable(), lldb_private::MemoryRegionInfo::SetWritable(), and UNUSED_IF_ASSERT_DISABLED.

◆ GetMetaData()

Status NativeProcessLinux::GetMetaData	(	lldb::user_id_t	traceid,
		lldb::tid_t	thread,
		llvm::MutableArrayRef< uint8_t > &	buffer,
		size_t	offset = `0`
	)

overridevirtual

Similar API as above except it aims to provide any extra data useful for decoding the actual trace data.

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1858 of file NativeProcessLinux.cpp.

References lldb_private::GetLogIfAllCategoriesSet(), LLDB_LOG, and POSIX_LOG_PTRACE.

Referenced by GetAuxvData().

◆ GetSharedLibraryInfoAddress()

lldb::addr_t NativeProcessLinux::GetSharedLibraryInfoAddress ( )

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1400 of file NativeProcessLinux.cpp.

References LLDB_INVALID_ADDRESS.

◆ GetSoftwareBreakpointTrapOpcode()

llvm::Expected< llvm::ArrayRef< uint8_t > > NativeProcessLinux::GetSoftwareBreakpointTrapOpcode ( size_t size_hint )

overrideprotectedvirtual

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1428 of file NativeProcessLinux.cpp.

Referenced by GetAuxvData().

◆ GetThreadByID()

NativeThreadLinux * NativeProcessLinux::GetThreadByID ( lldb::tid_t id )

◆ GetTraceConfig()

Status NativeProcessLinux::GetTraceConfig	(	lldb::user_id_t	traceid,
		TraceOptions &	config
	)

overridevirtual

API to query the TraceOptions for a given user id.

Parameters

[in]	traceid	The user id of the tracing instance.
[in]	config	The thread id of the tracing instance, in case configuration for a specific thread is needed should be specified in the config.
[out]	error	Status indicates what went wrong.
[out]	config	The actual configuration being used for tracing.

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1896 of file NativeProcessLinux.cpp.

References lldb::eTraceTypeProcessorTrace, lldb_private::GetLogIfAllCategoriesSet(), lldb_private::TraceOptions::getThreadID(), lldb_private::TraceOptions::getType(), LLDB_INVALID_THREAD_ID, LLDB_INVALID_UID, LLDB_LOG, POSIX_LOG_PTRACE, and lldb_private::Status::SetErrorString().

Referenced by GetAuxvData().

◆ Halt()

Status NativeProcessLinux::Halt ( )

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1107 of file NativeProcessLinux.cpp.

References lldb_private::Status::SetErrorToErrno(), and SIGSTOP.

◆ Interrupt()

Status NativeProcessLinux::Interrupt ( )

overridevirtual

Tells a process to interrupt all operations as if by a Ctrl-C.

The default implementation will send a local host's equivalent of a SIGSTOP to the process via the NativeProcessProtocol::Signal() operation.

Returns: Returns an error object.

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1152 of file NativeProcessLinux.cpp.

References lldb::eStateRunning, lldb::eStateStepping, lldb_private::NativeThreadProtocol::GetID(), lldb_private::GetLogIfAllCategoriesSet(), lldb_private::process_linux::NativeThreadLinux::GetState(), LLDB_LOG, POSIX_LOG_PROCESS, and lldb_private::StateIsStoppedState().

◆ Kill()

Status NativeProcessLinux::Kill ( )

overridevirtual

◆ PtraceWrapper()

Status NativeProcessLinux::PtraceWrapper	(	int	req,
		lldb::pid_t	pid,
		void *	addr = `nullptr`,
		void *	data = `nullptr`,
		size_t	data_size = `0`,
		long *	result = `nullptr`
	)

static

Definition at line 1804 of file NativeProcessLinux.cpp.

References lldb_private::Status::Fail(), lldb_private::GetLogIfAllCategoriesSet(), LLDB_INVALID_THREAD_ID, LLDB_LOG, POSIX_LOG_PTRACE, PTRACE_GETREGSET, PTRACE_SETREGSET, lldb_private::Status::SetErrorToErrno(), and lldb_private::Status::ToError().

◆ ReadMemory()

Status NativeProcessLinux::ReadMemory	(	lldb::addr_t	addr,
		void *	buf,
		size_t	size,
		size_t &	bytes_read
	)

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1450 of file NativeProcessLinux.cpp.

References lldb_private::Status::Fail(), lldb_private::GetLogIfAllCategoriesSet(), LLDB_LOG, POSIX_LOG_MEMORY, POSIX_LOG_PROCESS, process_vm_readv(), ProcessVmReadvSupported(), and PtraceWrapper().

◆ RemoveBreakpoint()

Status NativeProcessLinux::RemoveBreakpoint	(	lldb::addr_t	addr,
		bool	hardware = `false`
	)

overridevirtual

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1420 of file NativeProcessLinux.cpp.

Referenced by GetArchitecture().

◆ Resume()

Status NativeProcessLinux::Resume ( const ResumeActionList & resume_actions )

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1043 of file NativeProcessLinux.cpp.

References lldb::eStateRunning, lldb::eStateStepping, lldb::eStateStopped, lldb::eStateSuspended, lldb_private::Status::Fail(), lldb_private::ResumeActionList::GetActionForThread(), lldb_private::NativeThreadProtocol::GetID(), lldb_private::GetLogIfAllCategoriesSet(), LLDB_LOG, POSIX_LOG_PROCESS, lldb_private::ResumeAction::signal, lldb_private::ResumeAction::state, and lldb_private::StateAsCString().

◆ SetBreakpoint()

Status NativeProcessLinux::SetBreakpoint	(	lldb::addr_t	addr,
		uint32_t	size,
		bool	hardware
	)

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1412 of file NativeProcessLinux.cpp.

Referenced by GetArchitecture().

◆ Signal()

Status NativeProcessLinux::Signal ( int signo )

overridevirtual

Sends a process a UNIX signal signal.

Returns: Returns an error object.

Implements lldb_private::NativeProcessProtocol.

Definition at line 1139 of file NativeProcessLinux.cpp.

References lldb_private::GetLogIfAllCategoriesSet(), LLDB_LOG, POSIX_LOG_PROCESS, and lldb_private::Status::SetErrorToErrno().

◆ StartTrace()

lldb::user_id_t NativeProcessLinux::StartTrace	(	const TraceOptions &	config,
		Status &	error
	)

overridevirtual

StartTracing API for starting a tracing instance with the TraceOptions on a specific thread or process.

Parameters

[in]	config	The configuration to use when starting tracing.
[out]	error	Status indicates what went wrong.

Returns: The API returns a user_id which can be used to get trace data, trace configuration or stopping the trace instance. The user_id is a key to identify and operate with a tracing instance. It may refer to the complete process or a single thread.

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1950 of file NativeProcessLinux.cpp.

References lldb::eTraceTypeProcessorTrace, lldb_private::GetLogIfAllCategoriesSet(), lldb_private::TraceOptions::getThreadID(), lldb_private::TraceOptions::getType(), LLDB_INVALID_THREAD_ID, LLDB_INVALID_UID, LLDB_LOG, POSIX_LOG_PTRACE, and lldb_private::Status::SetErrorString().

Referenced by GetAuxvData().

◆ StopTrace()

Status NativeProcessLinux::StopTrace	(	lldb::user_id_t	traceid,
		lldb::tid_t	thread
	)

overridevirtual

StopTracing API as the name suggests stops a tracing instance.

Parameters

[in]	traceid	The user id of the trace intended to be stopped. Now a user_id may map to multiple threads in which case this API could be used to stop the tracing for a specific thread by supplying its thread id.
[in]	thread	Thread is needed when the complete process is being traced and the user wishes to stop tracing on a particular thread.

Returns: Status indicating what went wrong.

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 2011 of file NativeProcessLinux.cpp.

References lldb::eTraceTypeProcessorTrace, lldb_private::Status::Fail(), lldb_private::GetLogIfAllCategoriesSet(), lldb_private::TraceOptions::getType(), LLDB_INVALID_THREAD_ID, LLDB_INVALID_UID, LLDB_LOG, POSIX_LOG_PTRACE, lldb_private::Status::SetErrorString(), and lldb_private::TraceOptions::setThreadID().

Referenced by GetAuxvData().

◆ SupportHardwareSingleStepping()

bool NativeProcessLinux::SupportHardwareSingleStepping ( ) const

Definition at line 1033 of file NativeProcessLinux.cpp.

Referenced by GetAuxvData().

◆ UpdateThreads()

size_t NativeProcessLinux::UpdateThreads ( )

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1405 of file NativeProcessLinux.cpp.

◆ WriteMemory()

Status NativeProcessLinux::WriteMemory	(	lldb::addr_t	addr,
		const void *	buf,
		size_t	size,
		size_t &	bytes_written
	)

overridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 1505 of file NativeProcessLinux.cpp.

References lldb_private::Status::Fail(), lldb_private::NativeThreadProtocol::GetID(), lldb_private::GetLogIfAllCategoriesSet(), LLDB_INVALID_THREAD_ID, LLDB_INVALID_UID, LLDB_LOG, POSIX_LOG_MEMORY, POSIX_LOG_THREAD, and PtraceWrapper().

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AllocateMemory()

◆ DeallocateMemory()

◆ Detach()

◆ DoStopIDBumped()

◆ GetArchitecture()

◆ GetAuxvData()

◆ GetData()

◆ GetFileLoadAddress()

◆ GetLoadedModuleFileSpec()

◆ GetMemoryRegionInfo()

◆ GetMetaData()

◆ GetSharedLibraryInfoAddress()

◆ GetSoftwareBreakpointTrapOpcode()

◆ GetThreadByID()

◆ GetTraceConfig()

◆ Halt()

◆ Interrupt()

◆ Kill()

◆ PtraceWrapper()

◆ ReadMemory()

◆ RemoveBreakpoint()

◆ Resume()

◆ SetBreakpoint()

◆ Signal()

◆ StartTrace()

◆ StopTrace()

◆ SupportHardwareSingleStepping()

◆ UpdateThreads()

◆ WriteMemory()