CallingConvention

Detailed Description

Classes
class	BinaryNinja::CallingConvention
class	BinaryNinja::CoreCallingConvention

---

Class Documentation

BinaryNinja::CallingConvention

class BinaryNinja::CallingConvention

Public Member Functions
Ref< Architecture >	GetArchitecture () const
std::string	GetName () const
virtual std::vector< uint32_t >	GetCallerSavedRegisters ()
virtual std::vector< uint32_t >	GetCalleeSavedRegisters ()
virtual std::vector< uint32_t >	GetIntegerArgumentRegisters ()
virtual std::vector< uint32_t >	GetFloatArgumentRegisters ()
virtual std::vector< uint32_t >	GetRequiredArgumentRegisters ()
	Gets the set of registers that must be arguments for heuristic calling convention detection to consider this calling convention as a valid option.
virtual std::vector< uint32_t >	GetRequiredClobberedRegisters ()
	Gets the set of registers that must be clobbered for heuristic calling convention detection to consider this calling convention as a valid option.
virtual bool	AreArgumentRegistersSharedIndex ()
virtual bool	AreArgumentRegistersUsedForVarArgs ()
virtual bool	IsStackReservedForArgumentRegisters ()
virtual bool	IsStackAdjustedOnReturn ()
virtual bool	IsEligibleForHeuristics ()
virtual uint32_t	GetIntegerReturnValueRegister ()=0
virtual uint32_t	GetHighIntegerReturnValueRegister ()
virtual uint32_t	GetFloatReturnValueRegister ()
virtual uint32_t	GetGlobalPointerRegister ()
virtual std::vector< uint32_t >	GetImplicitlyDefinedRegisters ()
virtual RegisterValue	GetIncomingRegisterValue (uint32_t reg, Function *func)
virtual RegisterValue	GetIncomingFlagValue (uint32_t flag, Function *func)
virtual Variable	GetIncomingVariableForParameterVariable (const Variable &var, Function *func)
virtual Variable	GetParameterVariableForIncomingVariable (const Variable &var, Function *func)
Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNCallingConvention, BNNewCallingConventionReference, BNFreeCallingConvention >
	CoreRefCountObject ()
virtual	~CoreRefCountObject ()
BNCallingConvention *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	ReleaseForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()
Protected Member Functions
	CallingConvention (BNCallingConvention *cc)
	CallingConvention (Architecture *arch, const std::string &name)
Static Protected Member Functions
static void	FreeCallback (void *ctxt)
static uint32_t *	GetCallerSavedRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetCalleeSavedRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetIntegerArgumentRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetFloatArgumentRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetRequiredArgumentRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetRequiredClobberedRegistersCallback (void *ctxt, size_t *count)
static void	FreeRegisterListCallback (void *ctxt, uint32_t *regs, size_t len)
static bool	AreArgumentRegistersSharedIndexCallback (void *ctxt)
static bool	AreArgumentRegistersUsedForVarArgsCallback (void *ctxt)
static bool	IsStackReservedForArgumentRegistersCallback (void *ctxt)
static bool	IsStackAdjustedOnReturnCallback (void *ctxt)
static bool	IsEligibleForHeuristicsCallback (void *ctxt)
static uint32_t	GetIntegerReturnValueRegisterCallback (void *ctxt)
static uint32_t	GetHighIntegerReturnValueRegisterCallback (void *ctxt)
static uint32_t	GetFloatReturnValueRegisterCallback (void *ctxt)
static uint32_t	GetGlobalPointerRegisterCallback (void *ctxt)
static uint32_t *	GetImplicitlyDefinedRegistersCallback (void *ctxt, size_t *count)
static void	GetIncomingRegisterValueCallback (void *ctxt, uint32_t reg, BNFunction *func, BNRegisterValue *result)
static void	GetIncomingFlagValueCallback (void *ctxt, uint32_t reg, BNFunction *func, BNRegisterValue *result)
static void	GetIncomingVariableForParameterVariableCallback (void *ctxt, const BNVariable *var, BNFunction *func, BNVariable *result)
static void	GetParameterVariableForIncomingVariableCallback (void *ctxt, const BNVariable *var, BNFunction *func, BNVariable *result)

Additional Inherited Members
Public Attributes inherited from BinaryNinja::CoreRefCountObject< BNCallingConvention, BNNewCallingConventionReference, BNFreeCallingConvention >
std::atomic< int >	m_refs
bool	m_registeredRef
BNCallingConvention *	m_object

Constructor & Destructor Documentation

CallingConvention() [1/2]

CallingConvention::CallingConvention ( BNCallingConvention * cc )

protected

CallingConvention() [2/2]

BinaryNinja::CallingConvention::CallingConvention ( Architecture * arch, const std::string & name )

protected

Member Function Documentation

FreeCallback()

void CallingConvention::FreeCallback ( void * ctxt )

staticprotected

GetCallerSavedRegistersCallback()

uint32_t * CallingConvention::GetCallerSavedRegistersCallback ( void * ctxt, size_t * count )

staticprotected

GetCalleeSavedRegistersCallback()

uint32_t * CallingConvention::GetCalleeSavedRegistersCallback ( void * ctxt, size_t * count )

staticprotected

GetIntegerArgumentRegistersCallback()

uint32_t * CallingConvention::GetIntegerArgumentRegistersCallback ( void * ctxt, size_t * count )

staticprotected

GetFloatArgumentRegistersCallback()

uint32_t * CallingConvention::GetFloatArgumentRegistersCallback ( void * ctxt, size_t * count )

staticprotected

GetRequiredArgumentRegistersCallback()

uint32_t * CallingConvention::GetRequiredArgumentRegistersCallback ( void * ctxt, size_t * count )

staticprotected

GetRequiredClobberedRegistersCallback()

uint32_t * CallingConvention::GetRequiredClobberedRegistersCallback ( void * ctxt, size_t * count )

staticprotected

FreeRegisterListCallback()

void CallingConvention::FreeRegisterListCallback ( void * ctxt, uint32_t * regs, size_t len )

staticprotected

AreArgumentRegistersSharedIndexCallback()

bool CallingConvention::AreArgumentRegistersSharedIndexCallback ( void * ctxt )

staticprotected

AreArgumentRegistersUsedForVarArgsCallback()

bool CallingConvention::AreArgumentRegistersUsedForVarArgsCallback ( void * ctxt )

staticprotected

IsStackReservedForArgumentRegistersCallback()

bool CallingConvention::IsStackReservedForArgumentRegistersCallback ( void * ctxt )

staticprotected

IsStackAdjustedOnReturnCallback()

bool CallingConvention::IsStackAdjustedOnReturnCallback ( void * ctxt )

staticprotected

IsEligibleForHeuristicsCallback()

bool CallingConvention::IsEligibleForHeuristicsCallback ( void * ctxt )

staticprotected

GetIntegerReturnValueRegisterCallback()

uint32_t CallingConvention::GetIntegerReturnValueRegisterCallback ( void * ctxt )

staticprotected

GetHighIntegerReturnValueRegisterCallback()

uint32_t CallingConvention::GetHighIntegerReturnValueRegisterCallback ( void * ctxt )

staticprotected

GetFloatReturnValueRegisterCallback()

uint32_t CallingConvention::GetFloatReturnValueRegisterCallback ( void * ctxt )

staticprotected

GetGlobalPointerRegisterCallback()

uint32_t CallingConvention::GetGlobalPointerRegisterCallback ( void * ctxt )

staticprotected

GetImplicitlyDefinedRegistersCallback()

uint32_t * CallingConvention::GetImplicitlyDefinedRegistersCallback ( void * ctxt, size_t * count )

staticprotected

GetIncomingRegisterValueCallback()

void CallingConvention::GetIncomingRegisterValueCallback ( void * ctxt, uint32_t reg, BNFunction * func, BNRegisterValue * result )

staticprotected

GetIncomingFlagValueCallback()

void CallingConvention::GetIncomingFlagValueCallback ( void * ctxt, uint32_t reg, BNFunction * func, BNRegisterValue * result )

staticprotected

GetIncomingVariableForParameterVariableCallback()

void CallingConvention::GetIncomingVariableForParameterVariableCallback ( void * ctxt, const BNVariable * var, BNFunction * func, BNVariable * result )

staticprotected

GetParameterVariableForIncomingVariableCallback()

void CallingConvention::GetParameterVariableForIncomingVariableCallback ( void * ctxt, const BNVariable * var, BNFunction * func, BNVariable * result )

staticprotected

GetArchitecture()

Ref< Architecture > CallingConvention::GetArchitecture

(

)

const

GetName()

string CallingConvention::GetName

(

)

const

GetCallerSavedRegisters()

vector< uint32_t > CallingConvention::GetCallerSavedRegisters ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetCalleeSavedRegisters()

vector< uint32_t > CallingConvention::GetCalleeSavedRegisters ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetIntegerArgumentRegisters()

vector< uint32_t > CallingConvention::GetIntegerArgumentRegisters ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetFloatArgumentRegisters()

vector< uint32_t > CallingConvention::GetFloatArgumentRegisters ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetRequiredArgumentRegisters()

vector< uint32_t > CallingConvention::GetRequiredArgumentRegisters ( )

virtual

Gets the set of registers that must be arguments for heuristic calling convention detection to consider this calling convention as a valid option.

Returns

The set of registers that must be arguments

Reimplemented in BinaryNinja::CoreCallingConvention.

GetRequiredClobberedRegisters()

vector< uint32_t > CallingConvention::GetRequiredClobberedRegisters ( )

virtual

Gets the set of registers that must be clobbered for heuristic calling convention detection to consider this calling convention as a valid option.

Returns

The set of registers that must be clobbered

Reimplemented in BinaryNinja::CoreCallingConvention.

AreArgumentRegistersSharedIndex()

bool CallingConvention::AreArgumentRegistersSharedIndex ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

AreArgumentRegistersUsedForVarArgs()

bool CallingConvention::AreArgumentRegistersUsedForVarArgs ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

IsStackReservedForArgumentRegisters()

bool CallingConvention::IsStackReservedForArgumentRegisters ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

IsStackAdjustedOnReturn()

bool CallingConvention::IsStackAdjustedOnReturn ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

IsEligibleForHeuristics()

bool CallingConvention::IsEligibleForHeuristics ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetIntegerReturnValueRegister()

virtual uint32_t BinaryNinja::CallingConvention::GetIntegerReturnValueRegister ( )

pure virtual

Implemented in BinaryNinja::CoreCallingConvention.

GetHighIntegerReturnValueRegister()

uint32_t CallingConvention::GetHighIntegerReturnValueRegister ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetFloatReturnValueRegister()

uint32_t CallingConvention::GetFloatReturnValueRegister ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetGlobalPointerRegister()

uint32_t CallingConvention::GetGlobalPointerRegister ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetImplicitlyDefinedRegisters()

vector< uint32_t > CallingConvention::GetImplicitlyDefinedRegisters ( )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetIncomingRegisterValue()

RegisterValue CallingConvention::GetIncomingRegisterValue ( uint32_t reg, Function * func )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetIncomingFlagValue()

RegisterValue CallingConvention::GetIncomingFlagValue ( uint32_t flag, Function * func )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetIncomingVariableForParameterVariable()

Variable CallingConvention::GetIncomingVariableForParameterVariable ( const Variable & var, Function * func )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

GetParameterVariableForIncomingVariable()

Variable CallingConvention::GetParameterVariableForIncomingVariable ( const Variable & var, Function * func )

virtual

Reimplemented in BinaryNinja::CoreCallingConvention.

BinaryNinja::CoreCallingConvention

class BinaryNinja::CoreCallingConvention

Public Member Functions
	CoreCallingConvention (BNCallingConvention *cc)
virtual std::vector< uint32_t >	GetCallerSavedRegisters () override
virtual std::vector< uint32_t >	GetCalleeSavedRegisters () override
virtual std::vector< uint32_t >	GetIntegerArgumentRegisters () override
virtual std::vector< uint32_t >	GetFloatArgumentRegisters () override
virtual std::vector< uint32_t >	GetRequiredArgumentRegisters () override
	Gets the set of registers that must be arguments for heuristic calling convention detection to consider this calling convention as a valid option.
virtual std::vector< uint32_t >	GetRequiredClobberedRegisters () override
	Gets the set of registers that must be clobbered for heuristic calling convention detection to consider this calling convention as a valid option.
virtual bool	AreArgumentRegistersSharedIndex () override
virtual bool	AreArgumentRegistersUsedForVarArgs () override
virtual bool	IsStackReservedForArgumentRegisters () override
virtual bool	IsStackAdjustedOnReturn () override
virtual bool	IsEligibleForHeuristics () override
virtual uint32_t	GetIntegerReturnValueRegister () override
virtual uint32_t	GetHighIntegerReturnValueRegister () override
virtual uint32_t	GetFloatReturnValueRegister () override
virtual uint32_t	GetGlobalPointerRegister () override
virtual std::vector< uint32_t >	GetImplicitlyDefinedRegisters () override
virtual RegisterValue	GetIncomingRegisterValue (uint32_t reg, Function *func) override
virtual RegisterValue	GetIncomingFlagValue (uint32_t flag, Function *func) override
virtual Variable	GetIncomingVariableForParameterVariable (const Variable &var, Function *func) override
virtual Variable	GetParameterVariableForIncomingVariable (const Variable &var, Function *func) override
Public Member Functions inherited from BinaryNinja::CallingConvention
Ref< Architecture >	GetArchitecture () const
std::string	GetName () const
Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNCallingConvention, BNNewCallingConventionReference, BNFreeCallingConvention >
	CoreRefCountObject ()
virtual	~CoreRefCountObject ()
BNCallingConvention *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	ReleaseForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()

Additional Inherited Members
Public Attributes inherited from BinaryNinja::CoreRefCountObject< BNCallingConvention, BNNewCallingConventionReference, BNFreeCallingConvention >
std::atomic< int >	m_refs
bool	m_registeredRef
BNCallingConvention *	m_object
Protected Member Functions inherited from BinaryNinja::CallingConvention
	CallingConvention (BNCallingConvention *cc)
	CallingConvention (Architecture *arch, const std::string &name)
Static Protected Member Functions inherited from BinaryNinja::CallingConvention
static void	FreeCallback (void *ctxt)
static uint32_t *	GetCallerSavedRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetCalleeSavedRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetIntegerArgumentRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetFloatArgumentRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetRequiredArgumentRegistersCallback (void *ctxt, size_t *count)
static uint32_t *	GetRequiredClobberedRegistersCallback (void *ctxt, size_t *count)
static void	FreeRegisterListCallback (void *ctxt, uint32_t *regs, size_t len)
static bool	AreArgumentRegistersSharedIndexCallback (void *ctxt)
static bool	AreArgumentRegistersUsedForVarArgsCallback (void *ctxt)
static bool	IsStackReservedForArgumentRegistersCallback (void *ctxt)
static bool	IsStackAdjustedOnReturnCallback (void *ctxt)
static bool	IsEligibleForHeuristicsCallback (void *ctxt)
static uint32_t	GetIntegerReturnValueRegisterCallback (void *ctxt)
static uint32_t	GetHighIntegerReturnValueRegisterCallback (void *ctxt)
static uint32_t	GetFloatReturnValueRegisterCallback (void *ctxt)
static uint32_t	GetGlobalPointerRegisterCallback (void *ctxt)
static uint32_t *	GetImplicitlyDefinedRegistersCallback (void *ctxt, size_t *count)
static void	GetIncomingRegisterValueCallback (void *ctxt, uint32_t reg, BNFunction *func, BNRegisterValue *result)
static void	GetIncomingFlagValueCallback (void *ctxt, uint32_t reg, BNFunction *func, BNRegisterValue *result)
static void	GetIncomingVariableForParameterVariableCallback (void *ctxt, const BNVariable *var, BNFunction *func, BNVariable *result)
static void	GetParameterVariableForIncomingVariableCallback (void *ctxt, const BNVariable *var, BNFunction *func, BNVariable *result)

Constructor & Destructor Documentation

CoreCallingConvention()

CoreCallingConvention::CoreCallingConvention

(

BNCallingConvention *

cc

)

Member Function Documentation

GetCallerSavedRegisters()

vector< uint32_t > CoreCallingConvention::GetCallerSavedRegisters ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetCalleeSavedRegisters()

vector< uint32_t > CoreCallingConvention::GetCalleeSavedRegisters ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetIntegerArgumentRegisters()

vector< uint32_t > CoreCallingConvention::GetIntegerArgumentRegisters ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetFloatArgumentRegisters()

vector< uint32_t > CoreCallingConvention::GetFloatArgumentRegisters ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetRequiredArgumentRegisters()

vector< uint32_t > CoreCallingConvention::GetRequiredArgumentRegisters ( )

overridevirtual

Gets the set of registers that must be arguments for heuristic calling convention detection to consider this calling convention as a valid option.

Returns

The set of registers that must be arguments

Reimplemented from BinaryNinja::CallingConvention.

GetRequiredClobberedRegisters()

vector< uint32_t > CoreCallingConvention::GetRequiredClobberedRegisters ( )

overridevirtual

Gets the set of registers that must be clobbered for heuristic calling convention detection to consider this calling convention as a valid option.

Returns

The set of registers that must be clobbered

Reimplemented from BinaryNinja::CallingConvention.

AreArgumentRegistersSharedIndex()

bool CoreCallingConvention::AreArgumentRegistersSharedIndex ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

AreArgumentRegistersUsedForVarArgs()

bool CoreCallingConvention::AreArgumentRegistersUsedForVarArgs ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

IsStackReservedForArgumentRegisters()

bool CoreCallingConvention::IsStackReservedForArgumentRegisters ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

IsStackAdjustedOnReturn()

bool CoreCallingConvention::IsStackAdjustedOnReturn ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

IsEligibleForHeuristics()

bool CoreCallingConvention::IsEligibleForHeuristics ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetIntegerReturnValueRegister()

uint32_t CoreCallingConvention::GetIntegerReturnValueRegister ( )

overridevirtual

Implements BinaryNinja::CallingConvention.

GetHighIntegerReturnValueRegister()

uint32_t CoreCallingConvention::GetHighIntegerReturnValueRegister ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetFloatReturnValueRegister()

uint32_t CoreCallingConvention::GetFloatReturnValueRegister ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetGlobalPointerRegister()

uint32_t CoreCallingConvention::GetGlobalPointerRegister ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetImplicitlyDefinedRegisters()

vector< uint32_t > CoreCallingConvention::GetImplicitlyDefinedRegisters ( )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetIncomingRegisterValue()

RegisterValue CoreCallingConvention::GetIncomingRegisterValue ( uint32_t reg, Function * func )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetIncomingFlagValue()

RegisterValue CoreCallingConvention::GetIncomingFlagValue ( uint32_t flag, Function * func )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetIncomingVariableForParameterVariable()

Variable CoreCallingConvention::GetIncomingVariableForParameterVariable ( const Variable & var, Function * func )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.

GetParameterVariableForIncomingVariable()

Variable CoreCallingConvention::GetParameterVariableForIncomingVariable ( const Variable & var, Function * func )

overridevirtual

Reimplemented from BinaryNinja::CallingConvention.