#include <EmulateInstructionRISCV.h>

Inheritance diagram for lldb_private::EmulateInstructionRISCV:

Public Member Functions
	EmulateInstructionRISCV (const ArchSpec &arch)

llvm::StringRef	GetPluginName () override

bool	SupportsEmulatingInstructionsOfType (InstructionType inst_type) override

bool	SetTargetTriple (const ArchSpec &arch) override

bool	ReadInstruction () override

std::optional< uint32_t >	GetLastInstrSize () override

bool	EvaluateInstruction (uint32_t options) override

bool	TestEmulation (Stream &out_stream, ArchSpec &arch, OptionValueDictionary *test_data) override

std::optional< RegisterInfo >	GetRegisterInfo (lldb::RegisterKind reg_kind, uint32_t reg_num) override

std::optional< lldb::addr_t >	ReadPC ()

bool	WritePC (lldb::addr_t pc)

std::optional< DecodeResult >	ReadInstructionAt (lldb::addr_t addr)

std::optional< DecodeResult >	Decode (uint32_t inst)

bool	Execute (DecodeResult inst, bool ignore_cond)

template<typename T >
std::enable_if_t< std::is_integral_v< T >, std::optional< T > >	ReadMem (uint64_t addr)

template<typename T >
bool	WriteMem (uint64_t addr, uint64_t value)

llvm::RoundingMode	GetRoundingMode ()

bool	SetAccruedExceptions (llvm::APFloatBase::opStatus)

Public Member Functions inherited from lldb_private::EmulateInstruction
	EmulateInstruction (const ArchSpec &arch)

	~EmulateInstruction () override=default

virtual bool	SupportsEmulatingInstructionsOfType (InstructionType inst_type)=0

virtual bool	SetTargetTriple (const ArchSpec &arch)=0

virtual bool	ReadInstruction ()=0

virtual std::optional< uint32_t >	GetLastInstrSize ()

virtual bool	EvaluateInstruction (uint32_t evaluate_options)=0

virtual InstructionCondition	GetInstructionCondition ()

virtual bool	TestEmulation (Stream &out_stream, ArchSpec &arch, OptionValueDictionary *test_data)=0

virtual std::optional< RegisterInfo >	GetRegisterInfo (lldb::RegisterKind reg_kind, uint32_t reg_num)=0

virtual bool	SetInstruction (const Opcode &insn_opcode, const Address &inst_addr, Target *target)

virtual bool	CreateFunctionEntryUnwind (UnwindPlan &unwind_plan)

std::optional< RegisterValue >	ReadRegister (const RegisterInfo &reg_info)

uint64_t	ReadRegisterUnsigned (const RegisterInfo &reg_info, uint64_t fail_value, bool *success_ptr)

bool	WriteRegister (const Context &context, const RegisterInfo &ref_info, const RegisterValue &reg_value)

bool	WriteRegisterUnsigned (const Context &context, const RegisterInfo &reg_info, uint64_t reg_value)

bool	ReadRegister (lldb::RegisterKind reg_kind, uint32_t reg_num, RegisterValue &reg_value)

bool	WriteRegister (const Context &context, lldb::RegisterKind reg_kind, uint32_t reg_num, const RegisterValue &reg_value)

uint64_t	ReadRegisterUnsigned (lldb::RegisterKind reg_kind, uint32_t reg_num, uint64_t fail_value, bool *success_ptr)

bool	WriteRegisterUnsigned (const Context &context, lldb::RegisterKind reg_kind, uint32_t reg_num, uint64_t reg_value)

size_t	ReadMemory (const Context &context, lldb::addr_t addr, void *dst, size_t dst_len)

uint64_t	ReadMemoryUnsigned (const Context &context, lldb::addr_t addr, size_t byte_size, uint64_t fail_value, bool *success_ptr)

bool	WriteMemory (const Context &context, lldb::addr_t addr, const void *src, size_t src_len)

bool	WriteMemoryUnsigned (const Context &context, lldb::addr_t addr, uint64_t uval, size_t uval_byte_size)

uint32_t	GetAddressByteSize () const

lldb::ByteOrder	GetByteOrder () const

const Opcode &	GetOpcode () const

lldb::addr_t	GetAddress () const

const ArchSpec &	GetArchitecture () const

void	SetBaton (void *baton)

void	SetCallbacks (ReadMemoryCallback read_mem_callback, WriteMemoryCallback write_mem_callback, ReadRegisterCallback read_reg_callback, WriteRegisterCallback write_reg_callback)

void	SetReadMemCallback (ReadMemoryCallback read_mem_callback)

void	SetWriteMemCallback (WriteMemoryCallback write_mem_callback)

void	SetReadRegCallback (ReadRegisterCallback read_reg_callback)

void	SetWriteRegCallback (WriteRegisterCallback write_reg_callback)

Public Member Functions inherited from lldb_private::PluginInterface
	PluginInterface ()=default

virtual	~PluginInterface ()=default

virtual llvm::StringRef	GetPluginName ()=0

	PluginInterface (const PluginInterface &)=delete

PluginInterface &	operator= (const PluginInterface &)=delete

Static Public Member Functions
static llvm::StringRef	GetPluginNameStatic ()

static llvm::StringRef	GetPluginDescriptionStatic ()

static bool	SupportsThisInstructionType (InstructionType inst_type)

static bool	SupportsThisArch (const ArchSpec &arch)

static lldb_private::EmulateInstruction *	CreateInstance (const lldb_private::ArchSpec &arch, InstructionType inst_type)

static void	Initialize ()

static void	Terminate ()

Static Public Member Functions inherited from lldb_private::EmulateInstruction
static EmulateInstruction *	FindPlugin (const ArchSpec &arch, InstructionType supported_inst_type, const char *plugin_name)

static const char *	TranslateRegister (lldb::RegisterKind reg_kind, uint32_t reg_num, std::string &reg_name)

static size_t	ReadMemoryFrame (EmulateInstruction instruction, void baton, const Context &context, lldb::addr_t addr, void *dst, size_t length)

static size_t	WriteMemoryFrame (EmulateInstruction instruction, void baton, const Context &context, lldb::addr_t addr, const void *dst, size_t length)

static bool	ReadRegisterFrame (EmulateInstruction instruction, void baton, const RegisterInfo *reg_info, RegisterValue &reg_value)

static bool	WriteRegisterFrame (EmulateInstruction instruction, void baton, const Context &context, const RegisterInfo *reg_info, const RegisterValue &reg_value)

static size_t	ReadMemoryDefault (EmulateInstruction instruction, void baton, const Context &context, lldb::addr_t addr, void *dst, size_t length)

static size_t	WriteMemoryDefault (EmulateInstruction instruction, void baton, const Context &context, lldb::addr_t addr, const void *dst, size_t length)

static bool	ReadRegisterDefault (EmulateInstruction instruction, void baton, const RegisterInfo *reg_info, RegisterValue &reg_value)

static bool	WriteRegisterDefault (EmulateInstruction instruction, void baton, const Context &context, const RegisterInfo *reg_info, const RegisterValue &reg_value)

static bool	GetBestRegisterKindAndNumber (const RegisterInfo *reg_info, lldb::RegisterKind &reg_kind, uint32_t &reg_num)

static uint32_t	GetInternalRegisterNumber (RegisterContext *reg_ctx, const RegisterInfo &reg_info)

Private Attributes
DecodeResult	m_decoded
	Last decoded instruction from m_opcode.

std::optional< uint32_t >	m_last_size
	Last decoded instruction size estimate.

Additional Inherited Members
Public Types inherited from lldb_private::EmulateInstruction
enum	ContextType { eContextInvalid = 0 , eContextReadOpcode , eContextImmediate , eContextPushRegisterOnStack , eContextPopRegisterOffStack , eContextAdjustStackPointer , eContextSetFramePointer , eContextRestoreStackPointer , eContextAdjustBaseRegister , eContextAdjustPC , eContextRegisterPlusOffset , eContextRegisterStore , eContextRegisterLoad , eContextRelativeBranchImmediate , eContextAbsoluteBranchRegister , eContextSupervisorCall , eContextTableBranchReadMemory , eContextWriteRegisterRandomBits , eContextWriteMemoryRandomBits , eContextArithmetic , eContextAdvancePC , eContextReturnFromException }

enum	InfoType { eInfoTypeRegisterPlusOffset , eInfoTypeRegisterPlusIndirectOffset , eInfoTypeRegisterToRegisterPlusOffset , eInfoTypeRegisterToRegisterPlusIndirectOffset , eInfoTypeRegisterRegisterOperands , eInfoTypeOffset , eInfoTypeRegister , eInfoTypeImmediate , eInfoTypeImmediateSigned , eInfoTypeAddress , eInfoTypeISAAndImmediate , eInfoTypeISAAndImmediateSigned , eInfoTypeISA , eInfoTypeNoArgs }

typedef size_t(*	ReadMemoryCallback) (EmulateInstruction instruction, void baton, const Context &context, lldb::addr_t addr, void *dst, size_t length)

typedef size_t(*	WriteMemoryCallback) (EmulateInstruction instruction, void baton, const Context &context, lldb::addr_t addr, const void *dst, size_t length)

typedef bool(*	ReadRegisterCallback) (EmulateInstruction instruction, void baton, const RegisterInfo *reg_info, RegisterValue &reg_value)

typedef bool(*	WriteRegisterCallback) (EmulateInstruction instruction, void baton, const Context &context, const RegisterInfo *reg_info, const RegisterValue &reg_value)

typedef uint32_t	InstructionCondition

Static Public Attributes inherited from lldb_private::EmulateInstruction
static const InstructionCondition	UnconditionalCondition = UINT32_MAX

Protected Attributes inherited from lldb_private::EmulateInstruction
ArchSpec	m_arch

void *	m_baton = nullptr

ReadMemoryCallback	m_read_mem_callback = &ReadMemoryDefault

WriteMemoryCallback	m_write_mem_callback = &WriteMemoryDefault

ReadRegisterCallback	m_read_reg_callback = &ReadRegisterDefault

WriteRegisterCallback	m_write_reg_callback = &WriteRegisterDefault

lldb::addr_t	m_addr = LLDB_INVALID_ADDRESS

Opcode	m_opcode

Detailed Description

Definition at line 23 of file EmulateInstructionRISCV.h.

Constructor & Destructor Documentation

◆ EmulateInstructionRISCV()

lldb_private::EmulateInstructionRISCV::EmulateInstructionRISCV ( const ArchSpec & arch )

inline

Definition at line 53 of file EmulateInstructionRISCV.h.

Member Function Documentation

◆ CreateInstance()

lldb_private::EmulateInstruction * lldb_private::EmulateInstructionRISCV::CreateInstance	(	const lldb_private::ArchSpec &	arch,
		InstructionType	inst_type
	)

static

Definition at line 1781 of file EmulateInstructionRISCV.cpp.

References SupportsThisArch(), and SupportsThisInstructionType().

Referenced by Initialize(), and Terminate().

◆ Decode()

std::optional< DecodeResult > lldb_private::EmulateInstructionRISCV::Decode ( uint32_t inst )

Definition at line 621 of file EmulateInstructionRISCV.cpp.

References lldb_private::ArchSpec::eCore_riscv32, lldb_private::ArchSpec::GetCore(), lldb_private::GetLog(), LLDB_LOGF, lldb_private::EmulateInstruction::m_addr, lldb_private::EmulateInstruction::m_arch, m_last_size, lldb_private::PATTERNS, lldb_private::RV32, lldb_private::RV64, and lldb_private::Unwind.

Referenced by ReadInstructionAt().

◆ EvaluateInstruction()

bool lldb_private::EmulateInstructionRISCV::EvaluateInstruction ( uint32_t options )

overridevirtual

Implements lldb_private::EmulateInstruction.

Definition at line 1605 of file EmulateInstructionRISCV.cpp.

References Execute(), lldb_private::DecodeResult::is_rvc, m_decoded, ReadPC(), lldb_private::Executor::size(), and WritePC().

◆ Execute()

bool lldb_private::EmulateInstructionRISCV::Execute	(	DecodeResult	inst,
		bool	ignore_cond
	)

Definition at line 1601 of file EmulateInstructionRISCV.cpp.

References lldb_private::DecodeResult::decoded, and lldb_private::DecodeResult::is_rvc.

Referenced by EvaluateInstruction().

◆ GetLastInstrSize()

std::optional< uint32_t > lldb_private::EmulateInstructionRISCV::GetLastInstrSize ( )

inlineoverridevirtual

Reimplemented from lldb_private::EmulateInstruction.

Definition at line 63 of file EmulateInstructionRISCV.h.

References m_last_size.

◆ GetPluginDescriptionStatic()

static llvm::StringRef lldb_private::EmulateInstructionRISCV::GetPluginDescriptionStatic ( )

inlinestatic

Definition at line 27 of file EmulateInstructionRISCV.h.

Referenced by Initialize().

◆ GetPluginName()

llvm::StringRef lldb_private::EmulateInstructionRISCV::GetPluginName ( )

inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 55 of file EmulateInstructionRISCV.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

static llvm::StringRef lldb_private::EmulateInstructionRISCV::GetPluginNameStatic ( )

inlinestatic

Definition at line 25 of file EmulateInstructionRISCV.h.

Referenced by GetPluginName(), and Initialize().

◆ GetRegisterInfo()

std::optional< RegisterInfo > lldb_private::EmulateInstructionRISCV::GetRegisterInfo	(	lldb::RegisterKind	reg_kind,
		uint32_t	reg_num
	)

overridevirtual

Implements lldb_private::EmulateInstruction.

Definition at line 1724 of file EmulateInstructionRISCV.cpp.

References lldb::eRegisterKindGeneric, lldb::eRegisterKindLLDB, RegisterInfoPOSIX_riscv64::eRegsetMaskAll, RegisterInfoPOSIX_riscv64::GetRegisterCount(), RegisterInfoPOSIX_riscv64::GetRegisterInfo(), gpr_fp_riscv, gpr_pc_riscv, gpr_ra_riscv, gpr_sp_riscv, LLDB_REGNUM_GENERIC_FP, LLDB_REGNUM_GENERIC_PC, LLDB_REGNUM_GENERIC_RA, LLDB_REGNUM_GENERIC_SP, and lldb_private::EmulateInstruction::m_arch.

◆ GetRoundingMode()

RoundingMode lldb_private::EmulateInstructionRISCV::GetRoundingMode ( )

Definition at line 1667 of file EmulateInstructionRISCV.cpp.

References lldb::eRegisterKindLLDB, fpr_fcsr_riscv, LLDB_INVALID_ADDRESS, and lldb_private::EmulateInstruction::ReadRegisterUnsigned().

Referenced by lldb_private::Executor::FusedMultiplyAdd().

◆ Initialize()

void lldb_private::EmulateInstructionRISCV::Initialize ( )

static

Definition at line 1771 of file EmulateInstructionRISCV.cpp.

References CreateInstance(), GetPluginDescriptionStatic(), GetPluginNameStatic(), and lldb_private::PluginManager::RegisterPlugin().

◆ ReadInstruction()

bool lldb_private::EmulateInstructionRISCV::ReadInstruction ( )

overridevirtual

Implements lldb_private::EmulateInstruction.

Definition at line 1636 of file EmulateInstructionRISCV.cpp.

References lldb_private::EmulateInstruction::GetByteOrder(), LLDB_INVALID_ADDRESS, lldb_private::EmulateInstruction::m_addr, m_decoded, lldb_private::EmulateInstruction::m_opcode, ReadInstructionAt(), ReadPC(), lldb_private::Opcode::SetOpcode16(), and lldb_private::Opcode::SetOpcode32().

◆ ReadInstructionAt()

std::optional< DecodeResult > lldb_private::EmulateInstructionRISCV::ReadInstructionAt ( lldb::addr_t addr )

Definition at line 1630 of file EmulateInstructionRISCV.cpp.

References Decode().

Referenced by lldb_private::AtomicSequence(), and ReadInstruction().

◆ ReadMem()

template<typename T >

std::enable_if_t< std::is_integral_v< T >, std::optional< T > > lldb_private::EmulateInstructionRISCV::ReadMem ( uint64_t addr )

inline

Definition at line 79 of file EmulateInstructionRISCV.h.

References lldb_private::EmulateInstruction::eContextRegisterLoad, lldb_private::EmulateInstruction::ReadMemoryUnsigned(), lldb_private::EmulateInstruction::Context::SetNoArgs(), and lldb_private::EmulateInstruction::Context::type.

Referenced by lldb_private::AtomicADD(), lldb_private::AtomicBitOperate(), lldb_private::AtomicCmp(), lldb_private::AtomicSwap(), and lldb_private::Load().

◆ ReadPC()

std::optional< addr_t > lldb_private::EmulateInstructionRISCV::ReadPC ( )

Definition at line 1652 of file EmulateInstructionRISCV.cpp.

References lldb::eRegisterKindGeneric, LLDB_INVALID_ADDRESS, LLDB_REGNUM_GENERIC_PC, and lldb_private::EmulateInstruction::ReadRegisterUnsigned().

Referenced by lldb_private::AtomicSequence(), EvaluateInstruction(), lldb_private::Executor::operator()(), and ReadInstruction().

◆ SetAccruedExceptions()

bool lldb_private::EmulateInstructionRISCV::SetAccruedExceptions ( llvm::APFloatBase::opStatus )

Definition at line 1691 of file EmulateInstructionRISCV.cpp.

References lldb_private::EmulateInstruction::eContextRegisterStore, lldb::eRegisterKindLLDB, fpr_fcsr_riscv, LLDB_INVALID_ADDRESS, lldb_private::EmulateInstruction::ReadRegisterUnsigned(), lldb_private::EmulateInstruction::Context::SetNoArgs(), lldb_private::EmulateInstruction::Context::type, and lldb_private::EmulateInstruction::WriteRegisterUnsigned().

Referenced by lldb_private::Executor::FusedMultiplyAdd().

◆ SetTargetTriple()

bool lldb_private::EmulateInstructionRISCV::SetTargetTriple ( const ArchSpec & arch )

overridevirtual

Implements lldb_private::EmulateInstruction.

Definition at line 1762 of file EmulateInstructionRISCV.cpp.

References SupportsThisArch().

◆ SupportsEmulatingInstructionsOfType()

bool lldb_private::EmulateInstructionRISCV::SupportsEmulatingInstructionsOfType ( InstructionType inst_type )

inlineoverridevirtual

Implements lldb_private::EmulateInstruction.

Definition at line 57 of file EmulateInstructionRISCV.h.

References SupportsThisInstructionType().

◆ SupportsThisArch()

bool lldb_private::EmulateInstructionRISCV::SupportsThisArch ( const ArchSpec & arch )

static

Definition at line 1791 of file EmulateInstructionRISCV.cpp.

References lldb_private::ArchSpec::GetTriple().

Referenced by CreateInstance(), and SetTargetTriple().

◆ SupportsThisInstructionType()

static bool lldb_private::EmulateInstructionRISCV::SupportsThisInstructionType ( InstructionType inst_type )

inlinestatic

Definition at line 31 of file EmulateInstructionRISCV.h.

References lldb_private::eInstructionTypeAll, lldb_private::eInstructionTypeAny, lldb_private::eInstructionTypePCModifying, and lldb_private::eInstructionTypePrologueEpilogue.

Referenced by CreateInstance(), and SupportsEmulatingInstructionsOfType().

◆ Terminate()

void lldb_private::EmulateInstructionRISCV::Terminate ( )

static

Definition at line 1776 of file EmulateInstructionRISCV.cpp.

References CreateInstance(), and lldb_private::PluginManager::UnregisterPlugin().

◆ TestEmulation()

bool lldb_private::EmulateInstructionRISCV::TestEmulation	(	Stream &	out_stream,
		ArchSpec &	arch,
		OptionValueDictionary *	test_data
	)

overridevirtual

Implements lldb_private::EmulateInstruction.

Definition at line 1766 of file EmulateInstructionRISCV.cpp.

◆ WriteMem()

template<typename T >

bool lldb_private::EmulateInstructionRISCV::WriteMem	(	uint64_t	addr,
		uint64_t	value
	)

inline

Definition at line 90 of file EmulateInstructionRISCV.h.

References lldb_private::EmulateInstruction::eContextRegisterStore, lldb_private::EmulateInstruction::Context::SetNoArgs(), lldb_private::EmulateInstruction::Context::type, and lldb_private::EmulateInstruction::WriteMemoryUnsigned().

◆ WritePC()

bool lldb_private::EmulateInstructionRISCV::WritePC ( lldb::addr_t pc )

Definition at line 1659 of file EmulateInstructionRISCV.cpp.

References lldb_private::EmulateInstruction::eContextAdvancePC, lldb::eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC, pc, lldb_private::EmulateInstruction::Context::SetNoArgs(), lldb_private::EmulateInstruction::Context::type, and lldb_private::EmulateInstruction::WriteRegisterUnsigned().

Referenced by lldb_private::AtomicSequence(), and EvaluateInstruction().

Member Data Documentation

◆ m_decoded

DecodeResult lldb_private::EmulateInstructionRISCV::m_decoded

private

Last decoded instruction from m_opcode.

Definition at line 102 of file EmulateInstructionRISCV.h.

Referenced by EvaluateInstruction(), and ReadInstruction().

◆ m_last_size

std::optional<uint32_t> lldb_private::EmulateInstructionRISCV::m_last_size

private

Last decoded instruction size estimate.

Definition at line 104 of file EmulateInstructionRISCV.h.

Referenced by Decode(), and GetLastInstrSize().

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EmulateInstructionRISCV()

Member Function Documentation

◆ CreateInstance()

◆ Decode()

◆ EvaluateInstruction()

◆ Execute()

◆ GetLastInstrSize()

◆ GetPluginDescriptionStatic()

◆ GetPluginName()

◆ GetPluginNameStatic()

◆ GetRegisterInfo()

◆ GetRoundingMode()

◆ Initialize()

◆ ReadInstruction()

◆ ReadInstructionAt()

◆ ReadMem()

◆ ReadPC()

◆ SetAccruedExceptions()

◆ SetTargetTriple()

◆ SupportsEmulatingInstructionsOfType()

◆ SupportsThisArch()

◆ SupportsThisInstructionType()

◆ Terminate()

◆ TestEmulation()

◆ WriteMem()

◆ WritePC()

Member Data Documentation

◆ m_decoded

◆ m_last_size