#include <UnixSignals.h>

Inheritance diagram for lldb_private::UnixSignals:

[legend]

Classes
struct	Signal

struct	SignalCode

Public Types
enum	SignalCodePrintOption { None , Address , Bounds }

Public Member Functions
	UnixSignals ()

virtual	~UnixSignals ()

const char *	GetSignalAsCString (int32_t signo) const

std::string	GetSignalDescription (int32_t signo, std::optional< int32_t > code=std::nullopt, std::optional< lldb::addr_t > addr=std::nullopt, std::optional< lldb::addr_t > lower=std::nullopt, std::optional< lldb::addr_t > upper=std::nullopt) const

bool	SignalIsValid (int32_t signo) const

int32_t	GetSignalNumberFromName (const char *name) const

const char *	GetSignalInfo (int32_t signo, bool &should_suppress, bool &should_stop, bool &should_notify) const

bool	GetShouldSuppress (int32_t signo) const

bool	SetShouldSuppress (int32_t signo, bool value)

bool	SetShouldSuppress (const char *signal_name, bool value)

bool	GetShouldStop (int32_t signo) const

bool	SetShouldStop (int32_t signo, bool value)

bool	SetShouldStop (const char *signal_name, bool value)

bool	GetShouldNotify (int32_t signo) const

bool	SetShouldNotify (int32_t signo, bool value)

bool	SetShouldNotify (const char *signal_name, bool value)

bool	ResetSignal (int32_t signo, bool reset_stop=true, bool reset_notify=true, bool reset_suppress=true)

int32_t	GetFirstSignalNumber () const

int32_t	GetNextSignalNumber (int32_t current_signal) const

int32_t	GetNumSignals () const

int32_t	GetSignalAtIndex (int32_t index) const

ConstString	GetShortName (ConstString name) const

void	AddSignal (int signo, const char name, bool default_suppress, bool default_stop, bool default_notify, const char description, const char *alias=nullptr)

void	AddSignalCode (int signo, int code, const llvm::StringLiteral description, SignalCodePrintOption print_option=SignalCodePrintOption::None)

void	RemoveSignal (int signo)

void	IncrementSignalHitCount (int signo)
	Track how many times signals are hit as stop reasons.

llvm::json::Value	GetHitCountStatistics () const
	Get the hit count statistics for signals.

uint64_t	GetVersion () const

std::vector< int32_t >	GetFilteredSignals (std::optional< bool > should_suppress, std::optional< bool > should_stop, std::optional< bool > should_notify)

Static Public Member Functions
static lldb::UnixSignalsSP	Create (const ArchSpec &arch)

static lldb::UnixSignalsSP	CreateForHost ()

Protected Types
typedef std::map< int32_t, Signal >	collection

Protected Member Functions
virtual void	Reset ()

	UnixSignals (const UnixSignals &rhs)

const UnixSignals &	operator= (const UnixSignals &rhs)=delete

Protected Attributes
collection	m_signals

uint64_t	m_version = 0

Detailed Description

Definition at line 23 of file UnixSignals.h.

Member Typedef Documentation

◆ collection

typedef std::map<int32_t, Signal> lldb_private::UnixSignals::collection

protected

Definition at line 152 of file UnixSignals.h.

Member Enumeration Documentation

◆ SignalCodePrintOption

enum lldb_private::UnixSignals::SignalCodePrintOption

Enumerator
None
Address
Bounds

Definition at line 92 of file UnixSignals.h.

Constructor & Destructor Documentation

◆ UnixSignals() [1/2]

UnixSignals::UnixSignals ( )

Definition at line 55 of file UnixSignals.cpp.

References Reset().

◆ ~UnixSignals()

UnixSignals::~UnixSignals ( )

virtualdefault

◆ UnixSignals() [2/2]

UnixSignals::UnixSignals ( const UnixSignals & rhs )

protected

Definition at line 57 of file UnixSignals.cpp.

Member Function Documentation

◆ AddSignal()

void UnixSignals::AddSignal	(	int	signo,
		const char *	name,
		bool	default_suppress,
		bool	default_stop,
		bool	default_notify,
		const char *	description,
		const char *	alias = `nullptr`
	)

Definition at line 107 of file UnixSignals.cpp.

References m_signals, and m_version.

Referenced by Reset(), lldb_private::FreeBSDSignals::Reset(), lldb_private::GDBRemoteSignals::Reset(), lldb_private::LinuxSignals::Reset(), and lldb_private::NetBSDSignals::Reset().

◆ AddSignalCode()

void UnixSignals::AddSignalCode	(	int	signo,
		int	code,
		const llvm::StringLiteral	description,
		SignalCodePrintOption	print_option = `SignalCodePrintOption::None`
	)

Definition at line 116 of file UnixSignals.cpp.

References m_signals, and m_version.

◆ Create()

lldb::UnixSignalsSP UnixSignals::Create ( const ArchSpec & arch )

static

Definition at line 33 of file UnixSignals.cpp.

References lldb_private::ArchSpec::GetTriple().

Referenced by CreateForHost(), lldb_private::process_gdb_remote::ProcessGDBRemote::DidLaunchOrAttach(), ProcessElfCore::DoLoadCore(), lldb_private::minidump::ProcessMinidump::DoLoadCore(), and lldb_private::platform_gdb_server::PlatformRemoteGDBServer::GetRemoteUnixSignals().

◆ CreateForHost()

lldb::UnixSignalsSP UnixSignals::CreateForHost ( )

static

Definition at line 48 of file UnixSignals.cpp.

References Create().

Referenced by GetCrashReasonString(), lldb_private::Platform::GetUnixSignals(), and lldb_private::process_gdb_remote::GDBRemoteCommunicationServerPlatform::Handle_jSignalsInfo().

◆ GetFilteredSignals()

std::vector< int32_t > UnixSignals::GetFilteredSignals	(	std::optional< bool >	should_suppress,
		std::optional< bool >	should_stop,
		std::optional< bool >	should_notify
	)

Definition at line 343 of file UnixSignals.cpp.

References GetFirstSignalNumber(), GetNextSignalNumber(), GetSignalInfo(), and LLDB_INVALID_SIGNAL_NUMBER.

◆ GetFirstSignalNumber()

int32_t UnixSignals::GetFirstSignalNumber ( ) const

Definition at line 222 of file UnixSignals.cpp.

References LLDB_INVALID_SIGNAL_NUMBER, and m_signals.

Referenced by GetFilteredSignals().

◆ GetHitCountStatistics()

json::Value UnixSignals::GetHitCountStatistics ( ) const

Get the hit count statistics for signals.

Gettings statistics on the hit counts of signals can help explain why some debug sessions are slow since each stop takes a few hundred ms and some software use signals a lot and can cause slow debugging performance if they are used too often. Even if a signal is not stopped at, it will auto continue the process and a delay will happen.

Definition at line 379 of file UnixSignals.cpp.

References m_signals.

◆ GetNextSignalNumber()

int32_t UnixSignals::GetNextSignalNumber ( int32_t current_signal ) const

Definition at line 229 of file UnixSignals.cpp.

References LLDB_INVALID_SIGNAL_NUMBER, and m_signals.

Referenced by GetFilteredSignals().

◆ GetNumSignals()

int32_t UnixSignals::GetNumSignals ( ) const

Definition at line 330 of file UnixSignals.cpp.

References m_signals.

◆ GetShortName()

ConstString UnixSignals::GetShortName ( ConstString name ) const

Definition at line 198 of file UnixSignals.cpp.

References lldb_private::ConstString::GetStringRef().

Referenced by GetSignalNumberFromName().

◆ GetShouldNotify()

bool UnixSignals::GetShouldNotify ( int32_t signo ) const

Definition at line 306 of file UnixSignals.cpp.

References m_signals.

◆ GetShouldStop()

bool UnixSignals::GetShouldStop ( int32_t signo ) const

Definition at line 282 of file UnixSignals.cpp.

References m_signals.

◆ GetShouldSuppress()

bool UnixSignals::GetShouldSuppress ( int32_t signo ) const

Definition at line 258 of file UnixSignals.cpp.

References m_signals.

◆ GetSignalAsCString()

const char * UnixSignals::GetSignalAsCString ( int32_t signo ) const

Definition at line 134 of file UnixSignals.cpp.

References m_signals.

◆ GetSignalAtIndex()

int32_t UnixSignals::GetSignalAtIndex ( int32_t index ) const

Definition at line 332 of file UnixSignals.cpp.

References LLDB_INVALID_SIGNAL_NUMBER, and m_signals.

◆ GetSignalDescription()

std::string UnixSignals::GetSignalDescription	(	int32_t	signo,
		std::optional< int32_t >	code = `std::nullopt`,
		std::optional< lldb::addr_t >	addr = `std::nullopt`,
		std::optional< lldb::addr_t >	lower = `std::nullopt`,
		std::optional< lldb::addr_t >	upper = `std::nullopt`
	)		const

Definition at line 143 of file UnixSignals.cpp.

References Address, Bounds, lldb_private::UnixSignals::SignalCode::m_description, lldb_private::UnixSignals::SignalCode::m_print_option, m_signals, and None.

◆ GetSignalInfo()

const char * UnixSignals::GetSignalInfo	(	int32_t	signo,
		bool &	should_suppress,
		bool &	should_stop,
		bool &	should_notify
	)		const

Definition at line 243 of file UnixSignals.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::UnixSignals::Signal::m_name, lldb_private::UnixSignals::Signal::m_notify, m_signals, lldb_private::UnixSignals::Signal::m_stop, and lldb_private::UnixSignals::Signal::m_suppress.

Referenced by GetFilteredSignals().

◆ GetSignalNumberFromName()

int32_t UnixSignals::GetSignalNumberFromName ( const char * name ) const

Definition at line 204 of file UnixSignals.cpp.

References GetShortName(), LLDB_INVALID_SIGNAL_NUMBER, and m_signals.

Referenced by SetShouldNotify(), SetShouldStop(), SetShouldSuppress(), and lldb_private::process_gdb_remote::GDBRemoteClientBase::ShouldStop().

◆ GetVersion()

uint64_t UnixSignals::GetVersion ( ) const

Definition at line 340 of file UnixSignals.cpp.

References m_version.

◆ IncrementSignalHitCount()

void UnixSignals::IncrementSignalHitCount ( int signo )

Track how many times signals are hit as stop reasons.

Definition at line 373 of file UnixSignals.cpp.

References m_signals.

◆ operator=()

const UnixSignals & lldb_private::UnixSignals::operator= ( const UnixSignals & rhs )

protecteddelete

◆ RemoveSignal()

void UnixSignals::RemoveSignal ( int signo )

Definition at line 127 of file UnixSignals.cpp.

References m_signals, and m_version.

◆ Reset()

void UnixSignals::Reset ( )

protectedvirtual

Reimplemented in lldb_private::FreeBSDSignals, lldb_private::GDBRemoteSignals, lldb_private::LinuxSignals, and lldb_private::NetBSDSignals.

Definition at line 61 of file UnixSignals.cpp.

References AddSignal(), and m_signals.

Referenced by lldb_private::FreeBSDSignals::Reset(), lldb_private::NetBSDSignals::Reset(), and UnixSignals().

◆ ResetSignal()

bool UnixSignals::ResetSignal	(	int32_t	signo,
		bool	reset_stop = `true`,
		bool	reset_notify = `true`,
		bool	reset_suppress = `true`
	)

Definition at line 400 of file UnixSignals.cpp.

References m_signals.

◆ SetShouldNotify() [1/2]

bool UnixSignals::SetShouldNotify	(	const char *	signal_name,
		bool	value
	)

Definition at line 323 of file UnixSignals.cpp.

References GetSignalNumberFromName(), LLDB_INVALID_SIGNAL_NUMBER, and SetShouldNotify().

◆ SetShouldNotify() [2/2]

bool lldb_private::UnixSignals::SetShouldNotify	(	int32_t	signo,
		bool	value
	)

Referenced by SetShouldNotify().

◆ SetShouldStop() [1/2]

bool UnixSignals::SetShouldStop	(	const char *	signal_name,
		bool	value
	)

Definition at line 299 of file UnixSignals.cpp.

References GetSignalNumberFromName(), LLDB_INVALID_SIGNAL_NUMBER, and SetShouldStop().

◆ SetShouldStop() [2/2]

bool lldb_private::UnixSignals::SetShouldStop	(	int32_t	signo,
		bool	value
	)

Referenced by SetShouldStop().

◆ SetShouldSuppress() [1/2]

bool UnixSignals::SetShouldSuppress	(	const char *	signal_name,
		bool	value
	)

Definition at line 275 of file UnixSignals.cpp.

References GetSignalNumberFromName(), LLDB_INVALID_SIGNAL_NUMBER, and SetShouldSuppress().

◆ SetShouldSuppress() [2/2]

bool lldb_private::UnixSignals::SetShouldSuppress	(	int32_t	signo,
		bool	value
	)

Referenced by SetShouldSuppress().

◆ SignalIsValid()

bool UnixSignals::SignalIsValid ( int32_t signo ) const

Definition at line 194 of file UnixSignals.cpp.

References m_signals.

Member Data Documentation

◆ m_signals

collection lldb_private::UnixSignals::m_signals

protected

◆ m_version

uint64_t lldb_private::UnixSignals::m_version = 0

protected

Definition at line 160 of file UnixSignals.h.

Referenced by AddSignal(), AddSignalCode(), GetVersion(), and RemoveSignal().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ collection

Member Enumeration Documentation

◆ SignalCodePrintOption

Constructor & Destructor Documentation

◆ UnixSignals() [1/2]

◆ ~UnixSignals()

◆ UnixSignals() [2/2]

Member Function Documentation

◆ AddSignal()

◆ AddSignalCode()

◆ Create()

◆ CreateForHost()

◆ GetFilteredSignals()

◆ GetFirstSignalNumber()

◆ GetHitCountStatistics()

◆ GetNextSignalNumber()

◆ GetNumSignals()

◆ GetShortName()

◆ GetShouldNotify()

◆ GetShouldStop()

◆ GetShouldSuppress()

◆ GetSignalAsCString()

◆ GetSignalAtIndex()

◆ GetSignalDescription()

◆ GetSignalInfo()

◆ GetSignalNumberFromName()

◆ GetVersion()

◆ IncrementSignalHitCount()

◆ operator=()

◆ RemoveSignal()

◆ Reset()

◆ ResetSignal()

◆ SetShouldNotify() [1/2]

◆ SetShouldNotify() [2/2]

◆ SetShouldStop() [1/2]

◆ SetShouldStop() [2/2]

◆ SetShouldSuppress() [1/2]

◆ SetShouldSuppress() [2/2]

◆ SignalIsValid()

Member Data Documentation

◆ m_signals

◆ m_version