LLDB mainline
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
lldb_private::ABI Class Referenceabstract

#include <ABI.h>

Inheritance diagram for lldb_private::ABI:
[legend]

Classes

struct  CallArgument
struct  MemoryPermissions

Public Member Functions

 ~ABI () override
virtual size_t GetRedZoneSize () const =0
virtual bool PrepareTrivialCall (lldb_private::Thread &thread, lldb::addr_t sp, lldb::addr_t functionAddress, lldb::addr_t returnAddress, llvm::ArrayRef< lldb::addr_t > args) const =0
virtual bool PrepareTrivialCall (lldb_private::Thread &thread, lldb::addr_t sp, lldb::addr_t functionAddress, lldb::addr_t returnAddress, llvm::Type &prototype, llvm::ArrayRef< CallArgument > args) const
virtual bool GetArgumentValues (Thread &thread, ValueList &values) const =0
lldb::ValueObjectSP GetReturnValueObject (Thread &thread, CompilerType &type, bool persistent=true) const
lldb::ValueObjectSP GetReturnValueObject (Thread &thread, llvm::Type &type, bool persistent=true) const
virtual Status SetReturnValueObject (lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value)=0
virtual lldb::UnwindPlanSP CreateFunctionEntryUnwindPlan ()=0
virtual lldb::UnwindPlanSP CreateDefaultUnwindPlan ()=0
virtual bool RegisterIsVolatile (const RegisterInfo *reg_info)=0
virtual bool GetFallbackRegisterLocation (const RegisterInfo *reg_info, UnwindPlan::Row::AbstractRegisterLocation &unwind_regloc)
virtual bool CallFrameAddressIsValid (lldb::addr_t cfa)=0
virtual bool CodeAddressIsValid (lldb::addr_t pc)=0
virtual lldb::addr_t FixAnyAddress (lldb::addr_t pc)
 Use this method when you do not know, or do not care what kind of address you are fixing.
llvm::MCRegisterInfo & GetMCRegisterInfo ()
virtual void AugmentRegisterInfo (std::vector< DynamicRegisterInfo::Register > &regs)=0
virtual bool GetPointerReturnRegister (const char *&name)
virtual uint64_t GetStackFrameSize ()
virtual std::optional< MemoryPermissions > GetMemoryPermissions (lldb_private::RegisterContext &reg_ctx, unsigned protection_key, uint32_t original_permissions)
 Get the effective memory permissions that result when the permissions referred to by a protection key are applied to the original permissions.
virtual lldb::addr_t FixCodeAddress (lldb::addr_t pc)
 Some targets might use bits in a code address to indicate a mode switch.
virtual lldb::addr_t FixDataAddress (lldb::addr_t pc)
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 lldb::ABISP FindPlugin (lldb::ProcessSP process_sp, const ArchSpec &arch)

Protected Member Functions

virtual lldb::ValueObjectSP GetReturnValueObjectImpl (Thread &thread, CompilerType &ast_type) const =0
virtual lldb::ValueObjectSP GetReturnValueObjectImpl (Thread &thread, llvm::Type &ir_type) const
lldb::ProcessSP GetProcessSP () const
 Request to get a Process shared pointer.
 ABI (lldb::ProcessSP process_sp, std::unique_ptr< llvm::MCRegisterInfo > info_up)

Static Protected Member Functions

static std::unique_ptr< llvm::MCRegisterInfo > MakeMCRegisterInfo (const ArchSpec &arch)
 Utility function to construct a MCRegisterInfo using the ArchSpec triple.

Protected Attributes

lldb::ProcessWP m_process_wp
std::unique_ptr< llvm::MCRegisterInfo > m_mc_register_info_up

Private Member Functions

 ABI (const ABI &)=delete
const ABI & operator= (const ABI &)=delete

Detailed Description

Definition at line 28 of file ABI.h.

Constructor & Destructor Documentation

◆ ~ABI()

ABI::~ABI ( )
overridedefault

◆ ABI() [1/2]

lldb_private::ABI::ABI ( lldb::ProcessSP process_sp,
std::unique_ptr< llvm::MCRegisterInfo > info_up )
inlineprotected

Definition at line 183 of file ABI.h.

References m_mc_register_info_up, and m_process_wp.

Referenced by ABI(), and operator=().

◆ ABI() [2/2]

lldb_private::ABI::ABI ( const ABI & )
privatedelete

References ABI().

Member Function Documentation

◆ AugmentRegisterInfo()

virtual void lldb_private::ABI::AugmentRegisterInfo ( std::vector< DynamicRegisterInfo::Register > & regs)
pure virtual

Implemented in ABIAArch64, ABISysV_loongarch, ABISysV_riscv, ABIX86, lldb_private::MCBasedABI, and lldb_private::RegInfoBasedABI.

◆ CallFrameAddressIsValid()

virtual bool lldb_private::ABI::CallFrameAddressIsValid ( lldb::addr_t cfa)
pure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Referenced by lldb_private::UnwindLLDB::GetOneMoreFrame().

◆ CodeAddressIsValid()

virtual bool lldb_private::ABI::CodeAddressIsValid ( lldb::addr_t pc)
pure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

References pc.

Referenced by lldb_private::UnwindLLDB::GetOneMoreFrame().

◆ CreateDefaultUnwindPlan()

virtual lldb::UnwindPlanSP lldb_private::ABI::CreateDefaultUnwindPlan ( )
pure virtual

Implemented in ABIAArch64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Referenced by lldb_private::RegisterContextUnwind::GetFullUnwindPlanForFrame().

◆ CreateFunctionEntryUnwindPlan()

virtual lldb::UnwindPlanSP lldb_private::ABI::CreateFunctionEntryUnwindPlan ( )
pure virtual

Implemented in ABIAArch64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Referenced by lldb_private::RegisterContextUnwind::GetFullUnwindPlanForFrame().

◆ FindPlugin()

ABISP ABI::FindPlugin ( lldb::ProcessSP process_sp,
const ArchSpec & arch )
static

Definition at line 27 of file ABI.cpp.

References lldb_private::PluginManager::GetABICreateCallbacks().

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::AddRemoteRegisters(), lldb_private::VariableAnnotator::AnnotateStructured(), lldb_private::Address::Dump(), lldb_private::Variable::Dump(), lldb_private::Variable::DumpLocations(), lldb_private::Process::GetABI(), lldb_private::Target::GetABIName(), and lldb::SBTarget::GetStackRedZoneSize().

◆ FixAnyAddress()

virtual lldb::addr_t lldb_private::ABI::FixAnyAddress ( lldb::addr_t pc)
inlinevirtual

Use this method when you do not know, or do not care what kind of address you are fixing.

On platforms where there would be a difference between the two types, it will pick the safest option.

Its purpose is to signal that no specific choice was made and provide an alternative to randomly picking FixCode/FixData address. Which could break platforms where there is a difference (only Arm Thumb at this time).

Definition at line 137 of file ABI.h.

References FixDataAddress(), and pc.

◆ FixCodeAddress()

addr_t ABI::FixCodeAddress ( lldb::addr_t pc)
virtual

Some targets might use bits in a code address to indicate a mode switch.

ARM uses bit zero to signify a code address is thumb, so any ARM ABI plug-ins would strip those bits.

Reimplemented in ABIAArch64, ABIMacOSX_arm64, ABIMacOSX_arm, ABISysV_arm64, and ABISysV_arm.

Definition at line 141 of file ABI.cpp.

References GetProcessSP(), LLDB_INVALID_ADDRESS_MASK, and pc.

Referenced by CommandObjectTargetModulesShowUnwind::DoExecute().

◆ FixDataAddress()

addr_t ABI::FixDataAddress ( lldb::addr_t pc)
virtual

Reimplemented in ABIAArch64, ABIMacOSX_arm64, and ABISysV_arm64.

Definition at line 158 of file ABI.cpp.

References GetProcessSP(), LLDB_INVALID_ADDRESS_MASK, and pc.

Referenced by FixAnyAddress().

◆ GetArgumentValues()

virtual bool lldb_private::ABI::GetArgumentValues ( Thread & thread,
ValueList & values ) const
pure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Referenced by lldb_private::AppleObjCTrampolineHandler::GetStepThroughDispatchPlan(), lldb_private::ThreadPlanAssemblyTracer::Log(), and lldb_private::AppleObjCTrampolineHandler::AppleObjCVTables::RefreshTrampolines().

◆ GetFallbackRegisterLocation()

bool ABI::GetFallbackRegisterLocation ( const RegisterInfo * reg_info,
UnwindPlan::Row::AbstractRegisterLocation & unwind_regloc )
virtual

Reimplemented in ABISysV_s390x.

Definition at line 202 of file ABI.cpp.

References lldb::eRegisterKindGeneric, lldb_private::RegisterInfo::kinds, LLDB_REGNUM_GENERIC_SP, RegisterIsVolatile(), lldb_private::UnwindPlan::Row::AbstractRegisterLocation::SetIsCFAPlusOffset(), and lldb_private::UnwindPlan::Row::AbstractRegisterLocation::SetUndefined().

Referenced by lldb_private::RegisterContextUnwind::GetAbstractRegisterLocation().

◆ GetMCRegisterInfo()

llvm::MCRegisterInfo & lldb_private::ABI::GetMCRegisterInfo ( )
inline

Definition at line 144 of file ABI.h.

References m_mc_register_info_up.

Referenced by lldb_private::DWARFExpression::DumpLocation().

◆ GetMemoryPermissions()

virtual std::optional< MemoryPermissions > lldb_private::ABI::GetMemoryPermissions ( lldb_private::RegisterContext & reg_ctx,
unsigned protection_key,
uint32_t original_permissions )
inlinevirtual

Get the effective memory permissions that result when the permissions referred to by a protection key are applied to the original permissions.

This is intended for architectures that have some sort of permission overlay system. Where the protection key is used to look up a set of permissions that modifies the original permissions.

Returns
the overlay permissions (that the protection key refers to) and the effective permissions. If the target does not have an overlay system, or it does and the protection key is invalid, returns nullopt.

Reimplemented in ABISysV_arm64.

Definition at line 177 of file ABI.h.

◆ GetPointerReturnRegister()

virtual bool lldb_private::ABI::GetPointerReturnRegister ( const char *& name)
inlinevirtual

Reimplemented in ABISysV_arm64, ABISysV_x86_64, and ABIWindows_x86_64.

Definition at line 149 of file ABI.h.

◆ GetProcessSP()

lldb::ProcessSP lldb_private::ABI::GetProcessSP ( ) const
inlineprotected

Request to get a Process shared pointer.

This ABI object may not have been created with a Process object, or the Process object may no longer be alive. Be sure to handle the case where the shared pointer returned does not have an object inside it.

Definition at line 97 of file ABI.h.

References m_process_wp.

Referenced by ABIX86::AugmentRegisterInfo(), ABISysV_riscv::CallFrameAddressIsValid(), ABISysV_riscv::CodeAddressIsValid(), ABIAArch64::FixCodeAddress(), ABIMacOSX_arm64::FixCodeAddress(), ABISysV_arm64::FixCodeAddress(), FixCodeAddress(), ABIAArch64::FixDataAddress(), ABIMacOSX_arm64::FixDataAddress(), ABISysV_arm64::FixDataAddress(), FixDataAddress(), ABISysV_ppc64::GetByteOrder(), ABIMacOSX_arm::IsArmv7kProcess(), ABISysV_arm64::PrepareTrivialCall(), ABISysV_loongarch::RegisterIsCalleeSaved(), and ABISysV_riscv::RegisterIsCalleeSaved().

◆ GetRedZoneSize()

virtual size_t lldb_private::ABI::GetRedZoneSize ( ) const
pure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Referenced by lldb_private::ThreadPlanCallFunction::ConstructorSetup().

◆ GetReturnValueObject() [1/2]

ValueObjectSP ABI::GetReturnValueObject ( Thread & thread,
CompilerType & type,
bool persistent = true ) const

Definition at line 61 of file ABI.cpp.

References lldb_private::Target::CalculateTarget(), lldb_private::PersistentExpressionState::CreatePersistentVariable(), lldb_private::ExpressionVariable::EVIsFreezeDried, lldb_private::ExpressionVariable::EVIsLLDBAllocated, lldb_private::ExpressionVariable::EVIsProgramReference, lldb_private::ExpressionVariable::EVNeedsAllocation, lldb_private::Value::FileAddress, lldb_private::CompilerType::GetMinimumLanguage(), lldb_private::PersistentExpressionState::GetNextPersistentVariableName(), lldb_private::Target::GetPersistentExpressionStateForLanguage(), GetReturnValueObjectImpl(), lldb_private::Value::GetValueType(), lldb_private::Value::HostAddress, lldb_private::Value::Invalid, lldb_private::CompilerType::IsValid(), lldb_private::Value::LoadAddress, and lldb_private::Value::Scalar.

Referenced by lldb_private::ThreadPlanCallFunction::SetReturnValue(), and lldb_private::ThreadPlanCallFunctionUsingABI::SetReturnValue().

◆ GetReturnValueObject() [2/2]

ValueObjectSP ABI::GetReturnValueObject ( Thread & thread,
llvm::Type & type,
bool persistent = true ) const

Definition at line 174 of file ABI.cpp.

References GetReturnValueObjectImpl().

◆ GetReturnValueObjectImpl() [1/2]

virtual lldb::ValueObjectSP lldb_private::ABI::GetReturnValueObjectImpl ( Thread & thread,
CompilerType & ast_type ) const
protectedpure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Referenced by GetReturnValueObject(), and GetReturnValueObject().

◆ GetReturnValueObjectImpl() [2/2]

lldb::ValueObjectSP ABI::GetReturnValueObjectImpl ( Thread & thread,
llvm::Type & ir_type ) const
protectedvirtual

Reimplemented in ABISysV_arc, ABISysV_hexagon, and ABISysV_riscv.

Definition at line 185 of file ABI.cpp.

◆ GetStackFrameSize()

virtual uint64_t lldb_private::ABI::GetStackFrameSize ( )
inlinevirtual

Reimplemented in ABISysV_msp430.

Definition at line 151 of file ABI.h.

◆ MakeMCRegisterInfo()

std::unique_ptr< llvm::MCRegisterInfo > ABI::MakeMCRegisterInfo ( const ArchSpec & arch)
staticprotected

Utility function to construct a MCRegisterInfo using the ArchSpec triple.

Plugins wishing to customize the construction can construct the MCRegisterInfo themselves.

Definition at line 225 of file ABI.cpp.

References lldb_private::GetLog(), lldb_private::ArchSpec::GetTriple(), LLDB_LOG, and lldb_private::Process.

Referenced by ABIMacOSX_arm64::CreateInstance(), ABIMacOSX_arm::CreateInstance(), ABIMacOSX_i386::CreateInstance(), ABISysV_arc::CreateInstance(), ABISysV_arm64::CreateInstance(), ABISysV_arm::CreateInstance(), ABISysV_hexagon::CreateInstance(), ABISysV_i386::CreateInstance(), ABISysV_loongarch::CreateInstance(), ABISysV_mips64::CreateInstance(), ABISysV_mips::CreateInstance(), ABISysV_msp430::CreateInstance(), ABISysV_ppc64::CreateInstance(), ABISysV_ppc::CreateInstance(), ABISysV_riscv::CreateInstance(), ABISysV_s390x::CreateInstance(), ABISysV_x86_64::CreateInstance(), and ABIWindows_x86_64::CreateInstance().

◆ operator=()

const ABI & lldb_private::ABI::operator= ( const ABI & )
privatedelete

References ABI().

◆ PrepareTrivialCall() [1/2]

virtual bool lldb_private::ABI::PrepareTrivialCall ( lldb_private::Thread & thread,
lldb::addr_t sp,
lldb::addr_t functionAddress,
lldb::addr_t returnAddress,
llvm::ArrayRef< lldb::addr_t > args ) const
pure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

References sp.

Referenced by lldb_private::ThreadPlanCallFunctionUsingABI::ThreadPlanCallFunctionUsingABI().

◆ PrepareTrivialCall() [2/2]

virtual bool lldb_private::ABI::PrepareTrivialCall ( lldb_private::Thread & thread,
lldb::addr_t sp,
lldb::addr_t functionAddress,
lldb::addr_t returnAddress,
llvm::Type & prototype,
llvm::ArrayRef< CallArgument > args ) const
virtual

References sp.

◆ RegisterIsVolatile()

virtual bool lldb_private::ABI::RegisterIsVolatile ( const RegisterInfo * reg_info)
pure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Referenced by GetFallbackRegisterLocation().

◆ SetReturnValueObject()

virtual Status lldb_private::ABI::SetReturnValueObject ( lldb::StackFrameSP & frame_sp,
lldb::ValueObjectSP & new_value )
pure virtual

Implemented in ABIMacOSX_arm64, ABIMacOSX_arm, ABIMacOSX_i386, ABISysV_arc, ABISysV_arm64, ABISysV_arm, ABISysV_hexagon, ABISysV_i386, ABISysV_loongarch, ABISysV_mips64, ABISysV_mips, ABISysV_msp430, ABISysV_ppc64, ABISysV_ppc, ABISysV_riscv, ABISysV_s390x, ABISysV_x86_64, and ABIWindows_x86_64.

Member Data Documentation

◆ m_mc_register_info_up

std::unique_ptr<llvm::MCRegisterInfo> lldb_private::ABI::m_mc_register_info_up
protected

Definition at line 195 of file ABI.h.

Referenced by ABI(), lldb_private::MCBasedABI::GetEHAndDWARFNums(), and GetMCRegisterInfo().

◆ m_process_wp

lldb::ProcessWP lldb_private::ABI::m_process_wp
protected

Definition at line 194 of file ABI.h.

Referenced by ABI(), and GetProcessSP().

The documentation for this class was generated from the following files:
Generated on for LLDB by doxygen 1.14.0