LLDB  mainline
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
lldb_private::process_linux::NativeProcessLinux Class Reference

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

#include <NativeProcessLinux.h>

Inheritance diagram for lldb_private::process_linux::NativeProcessLinux:
Inheritance graph
[legend]
Collaboration diagram for lldb_private::process_linux::NativeProcessLinux:
Collaboration graph
[legend]

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 ArchSpecGetArchitecture () 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
 
NativeThreadLinuxGetThreadByID (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 HardwareBreakpointMapGetHardwareBreakpointMap () const
 
virtual Status SetHardwareBreakpoint (lldb::addr_t addr, size_t size)
 
virtual Status RemoveHardwareBreakpoint (lldb::addr_t addr)
 
virtual const NativeWatchpointList::WatchpointMapGetWatchpointMap () 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< WaitStatusGetExitStatus ()
 
virtual bool SetExitStatus (WaitStatus status, bool bNotifyStateChange)
 
NativeThreadProtocolGetThreadAtIndex (uint32_t idx)
 
NativeThreadProtocolGetThreadByID (lldb::tid_t tid)
 
void SetCurrentThreadID (lldb::tid_t tid)
 
lldb::tid_t GetCurrentThreadID ()
 
NativeThreadProtocolGetCurrentThread ()
 
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...
 
NativeThreadProtocolGetThreadByIDUnlocked (lldb::tid_t tid)
 

Additional Inherited Members

- Protected Attributes inherited from lldb_private::NativeProcessProtocol
std::unordered_map< lldb::addr_t, SoftwareBreakpointm_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< WaitStatusm_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

◆ 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

◆ DoStopIDBumped()

void NativeProcessLinux::DoStopIDBumped ( uint32_t  newBumpId)
overridevirtual

◆ GetArchitecture()

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

◆ GetAuxvData()

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

◆ 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]traceidthread The traceid and thread provide the context for the trace instance.
[in]bufferThe 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]offsetThere 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

◆ GetLoadedModuleFileSpec()

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

◆ GetMemoryRegionInfo()

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

◆ 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]traceidThe user id of the tracing instance.
[in]configThe thread id of the tracing instance, in case configuration for a specific thread is needed should be specified in the config.
[out]errorStatus indicates what went wrong.
[out]configThe 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

◆ 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

◆ ReadMemory()

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

◆ 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

◆ 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]configThe configuration to use when starting tracing.
[out]errorStatus 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]traceidThe 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]threadThread 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

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