LLDB mainline
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
lldb_private::process_freebsd::NativeProcessFreeBSD Class Reference

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

#include <NativeProcessFreeBSD.h>

Inheritance diagram for lldb_private::process_freebsd::NativeProcessFreeBSD:
Inheritance graph
[legend]

Classes

class  Manager
 

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.
 
Status Interrupt () override
 Tells a process to interrupt all operations as if by a Ctrl-C.
 
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
 
size_t UpdateThreads () override
 
const ArchSpecGetArchitecture () const override
 
Status SetBreakpoint (lldb::addr_t addr, uint32_t size, bool hardware) override
 
Status GetLoadedModuleFileSpec (const char *module_path, FileSpec &file_spec) override
 
Status GetFileLoadAddress (const llvm::StringRef &file_name, lldb::addr_t &load_addr) override
 
llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > GetAuxvData () const override
 
bool SupportHardwareSingleStepping () const
 
llvm::Expected< std::string > SaveCore (llvm::StringRef path_hint) override
 Write a core dump (without crashing the program).
 
- Public Member Functions inherited from lldb_private::NativeProcessELF
std::optional< uint64_t > GetAuxValue (enum AuxVector::EntryType type)
 
- Public Member Functions inherited from lldb_private::NativeProcessProtocol
virtual ~NativeProcessProtocol ()=default
 
virtual Status Resume (const ResumeActionList &resume_actions)=0
 
virtual Status Halt ()=0
 
virtual Status Detach ()=0
 
virtual Status Signal (int signo)=0
 Sends a process a UNIX signal signal.
 
virtual Status Interrupt ()
 Tells a process to interrupt all operations as if by a Ctrl-C.
 
virtual Status Kill ()=0
 
virtual Status IgnoreSignals (llvm::ArrayRef< int > signals)
 
virtual Status GetMemoryRegionInfo (lldb::addr_t load_addr, MemoryRegionInfo &range_info)
 
virtual Status ReadMemory (lldb::addr_t addr, void *buf, size_t size, size_t &bytes_read)=0
 
Status ReadMemoryWithoutTrap (lldb::addr_t addr, void *buf, size_t size, size_t &bytes_read)
 
virtual Status ReadMemoryTags (int32_t type, lldb::addr_t addr, size_t len, std::vector< uint8_t > &tags)
 
virtual Status WriteMemoryTags (int32_t type, lldb::addr_t addr, size_t len, const std::vector< uint8_t > &tags)
 
llvm::Expected< llvm::StringRef > ReadCStringFromMemory (lldb::addr_t addr, char *buffer, size_t max_size, size_t &total_bytes_read)
 Reads a null terminated string from memory.
 
virtual Status WriteMemory (lldb::addr_t addr, const void *buf, size_t size, size_t &bytes_written)=0
 
virtual llvm::Expected< lldb::addr_tAllocateMemory (size_t size, uint32_t permissions)
 
virtual llvm::Error DeallocateMemory (lldb::addr_t addr)
 
virtual lldb::addr_t GetSharedLibraryInfoAddress ()=0
 
virtual llvm::Expected< std::vector< SVR4LibraryInfo > > GetLoadedSVR4Libraries ()
 
virtual bool IsAlive () const
 
virtual size_t UpdateThreads ()=0
 
virtual const ArchSpecGetArchitecture () const =0
 
virtual Status SetBreakpoint (lldb::addr_t addr, uint32_t size, bool hardware)=0
 
virtual Status RemoveBreakpoint (lldb::addr_t addr, bool hardware=false)
 
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 std::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
 
uint32_t GetAddressByteSize () const
 
virtual llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > GetAuxvData () const =0
 
virtual std::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 () const
 
NativeThreadProtocolGetCurrentThread ()
 
ThreadIterable Threads () const
 
virtual int GetTerminalFileDescriptor ()
 
uint32_t GetStopID () const
 
virtual Status GetLoadedModuleFileSpec (const char *module_path, FileSpec &file_spec)=0
 
virtual Status GetFileLoadAddress (const llvm::StringRef &file_name, lldb::addr_t &load_addr)=0
 
virtual void NotifyTracersProcessWillResume ()
 Notify tracers that the target process will resume.
 
virtual void NotifyTracersProcessDidStop ()
 Notify tracers that the target process just stopped.
 
virtual llvm::Error TraceStart (llvm::StringRef json_params, llvm::StringRef type)
 Start tracing a process or its threads.
 
virtual llvm::Error TraceStop (const TraceStopRequest &request)
 Stop tracing a live process or its threads.
 
virtual llvm::Expected< llvm::json::Value > TraceGetState (llvm::StringRef type)
 Get the current tracing state of the process and its threads.
 
virtual llvm::Expected< std::vector< uint8_t > > TraceGetBinaryData (const TraceGetBinaryDataRequest &request)
 Get binary data given a trace technology and a data identifier.
 
virtual llvm::Expected< TraceSupportedResponseTraceSupported ()
 Get the processor tracing type supported for this process.
 
virtual void SetEnabledExtensions (Extension flags)
 Method called in order to propagate the bitmap of protocol extensions supported by the client.
 
virtual llvm::Expected< std::string > SaveCore (llvm::StringRef path_hint)
 Write a core dump (without crashing the program).
 

Static Public Member Functions

static Status PtraceWrapper (int req, lldb::pid_t pid, void *addr=nullptr, int data=0, int *result=nullptr)
 
- Static Public Member Functions inherited from lldb_private::NativeProcessProtocol
template<typename I >
static NativeThreadProtocolthread_list_adapter (I &iter)
 

Protected Member Functions

llvm::Expected< llvm::ArrayRef< uint8_t > > GetSoftwareBreakpointTrapOpcode (size_t size_hint) override
 
- Protected Member Functions inherited from lldb_private::NativeProcessELF
lldb::addr_t GetSharedLibraryInfoAddress () override
 
template<typename ELF_EHDR , typename ELF_PHDR , typename ELF_DYN >
lldb::addr_t GetELFImageInfoAddress ()
 
llvm::Expected< std::vector< SVR4LibraryInfo > > GetLoadedSVR4Libraries () override
 
template<typename T >
llvm::Expected< SVR4LibraryInfoReadSVR4LibraryInfo (lldb::addr_t link_map_addr)
 
void NotifyDidExec () override
 Notify the delegate that an exec occurred.
 
- Protected Member Functions inherited from lldb_private::NativeProcessProtocol
 NativeProcessProtocol (lldb::pid_t pid, int terminal_fd, NativeDelegate &delegate)
 
void SetID (lldb::pid_t pid)
 
void SetState (lldb::StateType state, bool notify_delegates=true)
 
virtual void DoStopIDBumped (uint32_t newBumpId)
 
Status SetSoftwareBreakpoint (lldb::addr_t addr, uint32_t size_hint)
 
Status RemoveSoftwareBreakpoint (lldb::addr_t addr)
 
virtual llvm::Expected< llvm::ArrayRef< uint8_t > > GetSoftwareBreakpointTrapOpcode (size_t size_hint)
 
virtual size_t GetSoftwareBreakpointPCOffset ()
 Return the offset of the PC relative to the software breakpoint that was hit.
 
void FixupBreakpointPCAsNeeded (NativeThreadProtocol &thread)
 
virtual void NotifyDidExec ()
 Notify the delegate that an exec occurred.
 
NativeThreadProtocolGetThreadByIDUnlocked (lldb::tid_t tid)
 

Private Member Functions

 NativeProcessFreeBSD (::pid_t pid, int terminal_fd, NativeDelegate &delegate, const ArchSpec &arch, MainLoop &mainloop)
 
bool HasThreadNoLock (lldb::tid_t thread_id)
 
NativeThreadFreeBSDAddThread (lldb::tid_t thread_id)
 
void RemoveThread (lldb::tid_t thread_id)
 
void MonitorCallback (lldb::pid_t pid, int signal)
 
void MonitorExited (lldb::pid_t pid, WaitStatus status)
 
void MonitorSIGSTOP (lldb::pid_t pid)
 
void MonitorSIGTRAP (lldb::pid_t pid)
 
void MonitorSignal (lldb::pid_t pid, int signal)
 
void MonitorClone (::pid_t child_pid, bool is_vfork, NativeThreadFreeBSD &parent_thread)
 
Status PopulateMemoryRegionCache ()
 
void SigchldHandler ()
 
Status Attach ()
 
Status SetupTrace ()
 
Status ReinitializeThreads ()
 
- Private Member Functions inherited from lldb_private::NativeProcessSoftwareSingleStep
Status SetupSoftwareSingleStepping (NativeThreadProtocol &thread)
 

Private Attributes

MainLoop::SignalHandleUP m_sigchld_handle
 
ArchSpec m_arch
 
MainLoopm_main_loop
 
LazyBool m_supports_mem_region = eLazyBoolCalculate
 
std::vector< std::pair< MemoryRegionInfo, FileSpec > > m_mem_region_cache
 
- Private Attributes inherited from lldb_private::NativeProcessSoftwareSingleStep
std::map< lldb::tid_t, lldb::addr_tm_threads_stepping_with_breakpoint
 

Additional Inherited Members

- Public Types inherited from lldb_private::NativeProcessProtocol
enum class  Extension {
  multiprocess = (1u << 0) , fork = (1u << 1) , vfork = (1u << 2) , pass_signals = (1u << 3) ,
  auxv = (1u << 4) , libraries_svr4 = (1u << 5) , memory_tagging = (1u << 6) , savecore = (1u << 7) ,
  siginfo_read = (1u << 8)
}
 Extension flag constants, returned by Manager::GetSupportedExtensions() and passed to SetEnabledExtension() More...
 
typedef std::vector< std::unique_ptr< NativeThreadProtocol > > thread_collection
 
typedef LockingAdaptedIterable< thread_collection, NativeThreadProtocol &, thread_list_adapter, std::recursive_mutex > ThreadIterable
 
- Protected Attributes inherited from lldb_private::NativeProcessELF
std::unique_ptr< AuxVectorm_aux_vector
 
std::optional< lldb::addr_tm_shared_library_info_addr
 
- 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
 
std::optional< WaitStatusm_exit_status
 
NativeDelegatem_delegate
 
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
 
Extension m_enabled_extensions
 

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 30 of file NativeProcessFreeBSD.h.

Constructor & Destructor Documentation

◆ NativeProcessFreeBSD()

NativeProcessFreeBSD::NativeProcessFreeBSD ( ::pid_t  pid,
int  terminal_fd,
NativeDelegate delegate,
const ArchSpec arch,
MainLoop mainloop 
)
private

Member Function Documentation

◆ AddThread()

NativeThreadFreeBSD & NativeProcessFreeBSD::AddThread ( lldb::tid_t  thread_id)
private

◆ Attach()

Status NativeProcessFreeBSD::Attach ( )
private

◆ Detach()

Status NativeProcessFreeBSD::Detach ( )
overridevirtual

◆ GetArchitecture()

const ArchSpec & lldb_private::process_freebsd::NativeProcessFreeBSD::GetArchitecture ( ) const
inlineoverridevirtual

Implements lldb_private::NativeProcessProtocol.

Definition at line 71 of file NativeProcessFreeBSD.h.

References m_arch.

Referenced by GetSoftwareBreakpointTrapOpcode().

◆ GetAuxvData()

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

◆ GetFileLoadAddress()

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

◆ GetLoadedModuleFileSpec()

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

◆ GetMemoryRegionInfo()

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

◆ GetSoftwareBreakpointTrapOpcode()

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

◆ Halt()

Status NativeProcessFreeBSD::Halt ( )
overridevirtual

◆ HasThreadNoLock()

bool NativeProcessFreeBSD::HasThreadNoLock ( lldb::tid_t  thread_id)
private

Definition at line 806 of file NativeProcessFreeBSD.cpp.

References lldb_private::NativeProcessProtocol::m_threads.

Referenced by AddThread(), and RemoveThread().

◆ Interrupt()

Status NativeProcessFreeBSD::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 550 of file NativeProcessFreeBSD.cpp.

References Halt().

◆ Kill()

Status NativeProcessFreeBSD::Kill ( )
overridevirtual

◆ MonitorCallback()

void NativeProcessFreeBSD::MonitorCallback ( lldb::pid_t  pid,
int  signal 
)
private

Definition at line 178 of file NativeProcessFreeBSD.cpp.

References MonitorSignal(), MonitorSIGSTOP(), MonitorSIGTRAP(), SIGSTOP, and SIGTRAP.

Referenced by SigchldHandler().

◆ MonitorClone()

void NativeProcessFreeBSD::MonitorClone ( ::pid_t  child_pid,
bool  is_vfork,
NativeThreadFreeBSD parent_thread 
)
private

◆ MonitorExited()

void NativeProcessFreeBSD::MonitorExited ( lldb::pid_t  pid,
WaitStatus  status 
)
private

◆ MonitorSignal()

void NativeProcessFreeBSD::MonitorSignal ( lldb::pid_t  pid,
int  signal 
)
private

◆ MonitorSIGSTOP()

void NativeProcessFreeBSD::MonitorSIGSTOP ( lldb::pid_t  pid)
private

◆ MonitorSIGTRAP()

void NativeProcessFreeBSD::MonitorSIGTRAP ( lldb::pid_t  pid)
private

◆ PopulateMemoryRegionCache()

Status NativeProcessFreeBSD::PopulateMemoryRegionCache ( )
private

◆ PtraceWrapper()

Status NativeProcessFreeBSD::PtraceWrapper ( int  req,
lldb::pid_t  pid,
void *  addr = nullptr,
int  data = 0,
int *  result = nullptr 
)
static

◆ ReadMemory()

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

◆ ReinitializeThreads()

Status NativeProcessFreeBSD::ReinitializeThreads ( )
private

◆ RemoveThread()

void NativeProcessFreeBSD::RemoveThread ( lldb::tid_t  thread_id)
private

◆ Resume()

Status NativeProcessFreeBSD::Resume ( const ResumeActionList resume_actions)
overridevirtual

◆ SaveCore()

llvm::Expected< std::string > NativeProcessFreeBSD::SaveCore ( llvm::StringRef  path_hint)
overridevirtual

Write a core dump (without crashing the program).

Parameters
[in]path_hintSuggested core dump path (optional, can be empty).
Returns
Path to the core dump if successfully written, an error otherwise.

Reimplemented from lldb_private::NativeProcessProtocol.

Definition at line 1058 of file NativeProcessFreeBSD.cpp.

References error(), lldb_private::NativeProcessProtocol::GetID(), pc, and PtraceWrapper().

◆ SetBreakpoint()

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

◆ SetupTrace()

Status NativeProcessFreeBSD::SetupTrace ( )
private

◆ SigchldHandler()

void NativeProcessFreeBSD::SigchldHandler ( )
private

◆ Signal()

Status NativeProcessFreeBSD::Signal ( int  signo)
overridevirtual

Sends a process a UNIX signal signal.

Returns
Returns an error object.

Implements lldb_private::NativeProcessProtocol.

Definition at line 541 of file NativeProcessFreeBSD.cpp.

References error(), and lldb_private::NativeProcessProtocol::GetID().

◆ SupportHardwareSingleStepping()

bool NativeProcessFreeBSD::SupportHardwareSingleStepping ( ) const

Definition at line 990 of file NativeProcessFreeBSD.cpp.

References lldb_private::ArchSpec::IsMIPS(), and m_arch.

◆ UpdateThreads()

size_t NativeProcessFreeBSD::UpdateThreads ( )
overridevirtual

◆ WriteMemory()

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

Member Data Documentation

◆ m_arch

ArchSpec lldb_private::process_freebsd::NativeProcessFreeBSD::m_arch
private

◆ m_main_loop

MainLoop& lldb_private::process_freebsd::NativeProcessFreeBSD::m_main_loop
private

Definition at line 104 of file NativeProcessFreeBSD.h.

Referenced by MonitorClone().

◆ m_mem_region_cache

std::vector<std::pair<MemoryRegionInfo, FileSpec> > lldb_private::process_freebsd::NativeProcessFreeBSD::m_mem_region_cache
private

◆ m_sigchld_handle

MainLoop::SignalHandleUP lldb_private::process_freebsd::NativeProcessFreeBSD::m_sigchld_handle
private

Definition at line 102 of file NativeProcessFreeBSD.h.

Referenced by Detach(), and NativeProcessFreeBSD().

◆ m_supports_mem_region

LazyBool lldb_private::process_freebsd::NativeProcessFreeBSD::m_supports_mem_region = eLazyBoolCalculate
private

Definition at line 105 of file NativeProcessFreeBSD.h.

Referenced by GetMemoryRegionInfo(), and PopulateMemoryRegionCache().


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