Binary Ninja API C++: High Level IL

Classes
class	BinaryNinja::HighLevelILFunction
class	BinaryNinja::LanguageRepresentationFunction
	LanguageRepresentationFunction represents a single function in a registered high level language. More...
class	BinaryNinja::CoreLanguageRepresentationFunction
class	BinaryNinja::LanguageRepresentationFunctionType
	LanguageRepresentationFunctionType represents a custom language representation function type. More...
class	BinaryNinja::HighLevelILTokenEmitter
	HighLevelILTokenEmitter contains methods for emitting text tokens for High Level IL instructions. More...
class	BinaryNinja::HighLevelILTokenEmitter::CurrentExprGuard
class	BinaryNinja::HighLevelILInstructionAccessException
class	BinaryNinja::HighLevelILIntegerList
class	BinaryNinja::HighLevelILIndexList
class	BinaryNinja::HighLevelILInstructionList
class	BinaryNinja::HighLevelILSSAVariableList
struct	BinaryNinja::HighLevelILInstructionBase
struct	BinaryNinja::HighLevelILInstruction
class	BinaryNinja::HighLevelILOperand
class	BinaryNinja::HighLevelILOperandList
struct	BinaryNinja::HighLevelILConstantInstruction
struct	BinaryNinja::HighLevelILConstantDataInstruction
struct	BinaryNinja::HighLevelILOneOperandInstruction
struct	BinaryNinja::HighLevelILTwoOperandInstruction
struct	BinaryNinja::HighLevelILTwoOperandWithCarryInstruction

Enumerations
enum	BinaryNinja::HighLevelILOperandType { BinaryNinja::IntegerHighLevelOperand , BinaryNinja::ConstantDataHighLevelOperand , BinaryNinja::IndexHighLevelOperand , BinaryNinja::IntrinsicHighLevelOperand , BinaryNinja::ExprHighLevelOperand , BinaryNinja::VariableHighLevelOperand , BinaryNinja::SSAVariableHighLevelOperand , BinaryNinja::ExprListHighLevelOperand , BinaryNinja::SSAVariableListHighLevelOperand , BinaryNinja::IndexListHighLevelOperand }
enum	BinaryNinja::HighLevelILOperandUsage { BinaryNinja::SourceExprHighLevelOperandUsage , BinaryNinja::VariableHighLevelOperandUsage , BinaryNinja::DestVariableHighLevelOperandUsage , BinaryNinja::SSAVariableHighLevelOperandUsage , BinaryNinja::DestSSAVariableHighLevelOperandUsage , BinaryNinja::DestExprHighLevelOperandUsage , BinaryNinja::LeftExprHighLevelOperandUsage , BinaryNinja::RightExprHighLevelOperandUsage , BinaryNinja::CarryExprHighLevelOperandUsage , BinaryNinja::IndexExprHighLevelOperandUsage , BinaryNinja::ConditionExprHighLevelOperandUsage , BinaryNinja::ConditionPhiExprHighLevelOperandUsage , BinaryNinja::TrueExprHighLevelOperandUsage , BinaryNinja::FalseExprHighLevelOperandUsage , BinaryNinja::LoopExprHighLevelOperandUsage , BinaryNinja::InitExprHighLevelOperandUsage , BinaryNinja::UpdateExprHighLevelOperandUsage , BinaryNinja::DefaultExprHighLevelOperandUsage , BinaryNinja::HighExprHighLevelOperandUsage , BinaryNinja::LowExprHighLevelOperandUsage , BinaryNinja::OffsetHighLevelOperandUsage , BinaryNinja::MemberIndexHighLevelOperandUsage , BinaryNinja::ConstantHighLevelOperandUsage , BinaryNinja::ConstantDataHighLevelOperandUsage , BinaryNinja::VectorHighLevelOperandUsage , BinaryNinja::IntrinsicHighLevelOperandUsage , BinaryNinja::TargetHighLevelOperandUsage , BinaryNinja::ParameterExprsHighLevelOperandUsage , BinaryNinja::SourceExprsHighLevelOperandUsage , BinaryNinja::DestExprsHighLevelOperandUsage , BinaryNinja::BlockExprsHighLevelOperandUsage , BinaryNinja::CasesHighLevelOperandUsage , BinaryNinja::ValueExprsHighLevelOperandUsage , BinaryNinja::SourceSSAVariablesHighLevelOperandUsage , BinaryNinja::SourceMemoryVersionHighLevelOperandUsage , BinaryNinja::SourceMemoryVersionsHighLevelOperandUsage , BinaryNinja::DestMemoryVersionHighLevelOperandUsage }

◆ BinaryNinja::HighLevelILFunction

class BinaryNinja::HighLevelILFunction

Public Member Functions
	HighLevelILFunction (Architecture arch, Function func=nullptr)
	HighLevelILFunction (BNHighLevelILFunction *func)
Ref< Function >	GetFunction () const
Ref< Architecture >	GetArchitecture () const
uint64_t	GetCurrentAddress () const
void	SetCurrentAddress (Architecture *arch, uint64_t addr)
HighLevelILInstruction	GetRootExpr ()
void	SetRootExpr (ExprId expr)
void	SetRootExpr (const HighLevelILInstruction &expr)
size_t	CachePossibleValueSet (const PossibleValueSet &pvs)
PossibleValueSet	GetCachedPossibleValueSet (size_t idx)
ExprId	AddExpr (BNHighLevelILOperation operation, size_t size, ExprId a=0, ExprId b=0, ExprId c=0, ExprId d=0, ExprId e=0)
ExprId	AddExprWithLocation (BNHighLevelILOperation operation, uint64_t addr, uint32_t sourceOperand, size_t size, ExprId a=0, ExprId b=0, ExprId c=0, ExprId d=0, ExprId e=0)
ExprId	AddExprWithLocation (BNHighLevelILOperation operation, const ILSourceLocation &loc, size_t size, ExprId a=0, ExprId b=0, ExprId c=0, ExprId d=0, ExprId e=0)
ExprId	Nop (const ILSourceLocation &loc=ILSourceLocation())
ExprId	Block (const std::vector< ExprId > &exprs, const ILSourceLocation &loc=ILSourceLocation())
ExprId	If (ExprId condition, ExprId trueExpr, ExprId falseExpr, const ILSourceLocation &loc=ILSourceLocation())
ExprId	While (ExprId condition, ExprId loopExpr, const ILSourceLocation &loc=ILSourceLocation())
ExprId	WhileSSA (ExprId conditionPhi, ExprId condition, ExprId loopExpr, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DoWhile (ExprId loopExpr, ExprId condition, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DoWhileSSA (ExprId loopExpr, ExprId conditionPhi, ExprId condition, const ILSourceLocation &loc=ILSourceLocation())
ExprId	For (ExprId initExpr, ExprId condition, ExprId updateExpr, ExprId loopExpr, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ForSSA (ExprId initExpr, ExprId conditionPhi, ExprId condition, ExprId updateExpr, ExprId loopExpr, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Switch (ExprId condition, ExprId defaultExpr, const std::vector< ExprId > &cases, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Case (const std::vector< ExprId > &condition, ExprId expr, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Break (const ILSourceLocation &loc=ILSourceLocation())
ExprId	Continue (const ILSourceLocation &loc=ILSourceLocation())
ExprId	Jump (ExprId dest, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Return (const std::vector< ExprId > &sources, const ILSourceLocation &loc=ILSourceLocation())
ExprId	NoReturn (const ILSourceLocation &loc=ILSourceLocation())
ExprId	Unreachable (const ILSourceLocation &loc=ILSourceLocation())
ExprId	Goto (uint64_t target, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Label (uint64_t target, const ILSourceLocation &loc=ILSourceLocation())
ExprId	VarDeclare (const Variable &var, const ILSourceLocation &loc=ILSourceLocation())
ExprId	VarInit (size_t size, const Variable &dest, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	VarInitSSA (size_t size, const SSAVariable &dest, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Assign (size_t size, ExprId dest, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	AssignUnpack (const std::vector< ExprId > &output, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	AssignMemSSA (size_t size, ExprId dest, size_t destMemVersion, ExprId src, size_t srcMemVersion, const ILSourceLocation &loc=ILSourceLocation())
ExprId	AssignUnpackMemSSA (const std::vector< ExprId > &output, size_t destMemVersion, ExprId src, size_t srcMemVersion, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ForceVer (size_t size, const Variable &dest, const Variable &src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ForceVerSSA (size_t size, const SSAVariable &dest, const SSAVariable &src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Assert (size_t size, const Variable &src, const PossibleValueSet &pvs, const ILSourceLocation &loc=ILSourceLocation())
ExprId	AssertSSA (size_t size, const SSAVariable &src, const PossibleValueSet &pvs, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Var (size_t size, const Variable &src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	VarSSA (size_t size, const SSAVariable &src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	VarPhi (const SSAVariable &dest, const std::vector< SSAVariable > &sources, const ILSourceLocation &loc=ILSourceLocation())
ExprId	MemPhi (size_t dest, const std::vector< size_t > &sources, const ILSourceLocation &loc=ILSourceLocation())
ExprId	StructField (size_t size, ExprId src, uint64_t offset, size_t memberIndex, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ArrayIndex (size_t size, ExprId src, ExprId idx, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ArrayIndexSSA (size_t size, ExprId src, size_t srcMemVersion, ExprId idx, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Split (size_t size, ExprId high, ExprId low, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Deref (size_t size, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DerefField (size_t size, ExprId src, uint64_t offset, size_t memberIndex, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DerefSSA (size_t size, ExprId src, size_t srcMemVersion, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DerefFieldSSA (size_t size, ExprId src, size_t srcMemVersion, uint64_t offset, size_t memberIndex, const ILSourceLocation &loc=ILSourceLocation())
ExprId	AddressOf (ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Const (size_t size, uint64_t val, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ConstPointer (size_t size, uint64_t val, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ExternPointer (size_t size, uint64_t val, uint64_t offset, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatConstRaw (size_t size, uint64_t val, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatConstSingle (float val, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatConstDouble (double val, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ImportedAddress (size_t size, uint64_t val, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ConstData (size_t size, const ConstantData &data, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Add (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	AddWithCarry (size_t size, ExprId left, ExprId right, ExprId carry, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Sub (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	SubWithBorrow (size_t size, ExprId left, ExprId right, ExprId carry, const ILSourceLocation &loc=ILSourceLocation())
ExprId	And (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Or (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Xor (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ShiftLeft (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	LogicalShiftRight (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ArithShiftRight (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	RotateLeft (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	RotateLeftCarry (size_t size, ExprId left, ExprId right, ExprId carry, const ILSourceLocation &loc=ILSourceLocation())
ExprId	RotateRight (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	RotateRightCarry (size_t size, ExprId left, ExprId right, ExprId carry, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Mult (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	MultDoublePrecSigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	MultDoublePrecUnsigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DivSigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DivUnsigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DivDoublePrecSigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	DivDoublePrecUnsigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ModSigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ModUnsigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ModDoublePrecSigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ModDoublePrecUnsigned (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Neg (size_t size, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Not (size_t size, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	SignExtend (size_t size, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	ZeroExtend (size_t size, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	LowPart (size_t size, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Call (ExprId dest, const std::vector< ExprId > &params, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Syscall (const std::vector< ExprId > &params, const ILSourceLocation &loc=ILSourceLocation())
ExprId	TailCall (ExprId dest, const std::vector< ExprId > &params, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CallSSA (ExprId dest, const std::vector< ExprId > &params, size_t destMemVersion, size_t srcMemVersion, const ILSourceLocation &loc=ILSourceLocation())
ExprId	SyscallSSA (const std::vector< ExprId > &params, size_t destMemVersion, size_t srcMemVersion, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareEqual (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareNotEqual (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareSignedLessThan (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareUnsignedLessThan (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareSignedLessEqual (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareUnsignedLessEqual (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareSignedGreaterEqual (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareUnsignedGreaterEqual (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareSignedGreaterThan (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	CompareUnsignedGreaterThan (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	TestBit (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	BoolToInt (size_t size, ExprId src, const ILSourceLocation &loc=ILSourceLocation())
ExprId	AddOverflow (size_t size, ExprId left, ExprId right, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Breakpoint (const ILSourceLocation &loc=ILSourceLocation())
ExprId	Trap (int64_t vector, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Intrinsic (uint32_t intrinsic, const std::vector< ExprId > &params, const ILSourceLocation &loc=ILSourceLocation())
ExprId	IntrinsicSSA (uint32_t intrinsic, const std::vector< ExprId > &params, size_t destMemVersion, size_t srcMemVersion, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Undefined (const ILSourceLocation &loc=ILSourceLocation())
ExprId	Unimplemented (const ILSourceLocation &loc=ILSourceLocation())
ExprId	UnimplementedMemoryRef (size_t size, ExprId target, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatAdd (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatSub (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatMult (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatDiv (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatSqrt (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatNeg (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatAbs (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatToInt (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	IntToFloat (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatConvert (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	RoundToInt (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Floor (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	Ceil (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatTrunc (size_t size, ExprId a, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareEqual (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareNotEqual (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareLessThan (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareLessEqual (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareGreaterEqual (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareGreaterThan (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareOrdered (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
ExprId	FloatCompareUnordered (size_t size, ExprId a, ExprId b, const ILSourceLocation &loc=ILSourceLocation())
std::vector< uint64_t >	GetOperandList (ExprId i, size_t listOperand)
ExprId	AddOperandList (const std::vector< ExprId > &operands)
ExprId	AddIndexList (const std::vector< size_t > &operands)
ExprId	AddSSAVariableList (const std::vector< SSAVariable > &vars)
BNHighLevelILInstruction	GetRawExpr (size_t i) const
BNHighLevelILInstruction	GetRawNonASTExpr (size_t i) const
HighLevelILInstruction	operator[] (size_t i)
HighLevelILInstruction	GetInstruction (size_t i)
HighLevelILInstruction	GetExpr (size_t i, bool asFullAst=true)
size_t	GetIndexForInstruction (size_t i) const
size_t	GetInstructionForExpr (size_t expr) const
size_t	GetInstructionCount () const
size_t	GetExprCount () const
std::vector< Ref< BasicBlock > >	GetBasicBlocks () const
Ref< BasicBlock >	GetBasicBlockForInstruction (size_t i) const
Ref< HighLevelILFunction >	GetSSAForm () const
Ref< HighLevelILFunction >	GetNonSSAForm () const
size_t	GetSSAInstructionIndex (size_t instr) const
size_t	GetNonSSAInstructionIndex (size_t instr) const
size_t	GetSSAExprIndex (size_t instr) const
size_t	GetNonSSAExprIndex (size_t instr) const
size_t	GetSSAVarDefinition (const SSAVariable &var) const
size_t	GetSSAMemoryDefinition (size_t version) const
std::set< size_t >	GetSSAVarUses (const SSAVariable &var) const
std::set< size_t >	GetSSAMemoryUses (size_t version) const
bool	IsSSAVarLive (const SSAVariable &var) const
bool	IsSSAVarLiveAt (const SSAVariable &var, const size_t instr) const
bool	IsVarLiveAt (const Variable &var, const size_t instr) const
std::set< size_t >	GetVariableSSAVersions (const Variable &var) const
std::set< size_t >	GetVariableDefinitions (const Variable &var) const
std::set< size_t >	GetVariableUses (const Variable &var) const
size_t	GetSSAVarVersionAtInstruction (const Variable &var, size_t instr) const
size_t	GetSSAMemoryVersionAtInstruction (size_t instr) const
Ref< MediumLevelILFunction >	GetMediumLevelIL () const
size_t	GetMediumLevelILExprIndex (size_t expr) const
std::set< size_t >	GetMediumLevelILExprIndexes (size_t expr) const
void	UpdateInstructionOperand (size_t i, size_t operandIndex, ExprId value)
void	ReplaceExpr (size_t expr, size_t newExpr)
void	SetExprAttributes (size_t expr, uint32_t attributes)
void	Finalize ()
void	GenerateSSAForm (const std::set< Variable > &aliases=std::set< Variable >())
std::vector< DisassemblyTextLine >	GetExprText (ExprId expr, bool asFullAst=true, DisassemblySettings *settings=nullptr)
std::vector< DisassemblyTextLine >	GetExprText (const HighLevelILInstruction &instr, DisassemblySettings *settings=nullptr)
std::vector< DisassemblyTextLine >	GetInstructionText (size_t i, DisassemblySettings *settings=nullptr)
Confidence< Ref< Type > >	GetExprType (size_t expr)
Confidence< Ref< Type > >	GetExprType (const HighLevelILInstruction &expr)
void	SetExprType (size_t expr, const Confidence< Ref< Type > > &type)
	SetExprType sets the type of a given expression.
void	SetExprType (const HighLevelILInstruction &expr, const Confidence< Ref< Type > > &type)
void	VisitAllExprs (const std::function< bool(const HighLevelILInstruction &expr)> &func)
Ref< FlowGraph >	CreateFunctionGraph (DisassemblySettings *settings=nullptr)
Ref< FlowGraph >	CreateFunctionGraphImmediate (DisassemblySettings *settings=nullptr)
size_t	GetExprIndexForLabel (uint64_t label)
std::set< size_t >	GetUsesForLabel (uint64_t label)
std::set< Variable >	GetVariables ()
std::set< Variable >	GetAliasedVariables ()
std::set< SSAVariable >	GetSSAVariables ()
void	SetDerivedStringReferenceForExpr (size_t expr, const DerivedString &str)
void	RemoveDerivedStringReferenceForExpr (size_t expr)
std::optional< DerivedString >	GetDerivedStringReferenceForExpr (size_t expr)
Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNHighLevelILFunction, BNNewHighLevelILFunctionReference, BNFreeHighLevelILFunction >
	CoreRefCountObject ()
virtual	~CoreRefCountObject ()
BNHighLevelILFunction *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	ReleaseForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()
Static Public Member Functions
static bool	HasSideEffects (const HighLevelILInstruction &instr)
static BNScopeType	GetExprScopeType (const HighLevelILInstruction &instr)

◆ HighLevelILFunction() [1/2]

◆ HighLevelILFunction() [2/2]

◆ GetFunction()

Ref< Function > HighLevelILFunction::GetFunction

(

)

const

◆ GetArchitecture()

◆ GetCurrentAddress()

uint64_t HighLevelILFunction::GetCurrentAddress

(

)

const

◆ SetCurrentAddress()

void HighLevelILFunction::SetCurrentAddress	(	Architecture *	arch,
		uint64_t	addr )

◆ GetRootExpr()

HighLevelILInstruction HighLevelILFunction::GetRootExpr

(

)

◆ SetRootExpr() [1/2]

void HighLevelILFunction::SetRootExpr

(

ExprId

expr

)

◆ SetRootExpr() [2/2]

void HighLevelILFunction::SetRootExpr

(

const HighLevelILInstruction &

expr

)

◆ CachePossibleValueSet()

size_t HighLevelILFunction::CachePossibleValueSet

(

const PossibleValueSet &

pvs

)

◆ GetCachedPossibleValueSet()

◆ AddExpr()

◆ AddExprWithLocation() [1/2]

◆ AddExprWithLocation() [2/2]

◆ Nop()

◆ Block()

◆ If()

◆ While()

◆ WhileSSA()

◆ DoWhile()

◆ DoWhileSSA()

◆ For()

◆ ForSSA()

◆ Switch()

◆ Case()

◆ Break()

◆ Continue()

◆ Jump()

◆ Return()

◆ NoReturn()

◆ Unreachable()

◆ Goto()

◆ Label()

◆ VarDeclare()

◆ VarInit()

◆ VarInitSSA()

◆ Assign()

◆ AssignUnpack()

◆ AssignMemSSA()

◆ AssignUnpackMemSSA()

◆ ForceVer()

◆ ForceVerSSA()

◆ Assert()

◆ AssertSSA()

◆ Var()

◆ VarSSA()

◆ VarPhi()

◆ MemPhi()

◆ StructField()

◆ ArrayIndex()

◆ ArrayIndexSSA()

◆ Split()

◆ Deref()

◆ DerefField()

◆ DerefSSA()

◆ DerefFieldSSA()

◆ AddressOf()

◆ Const()

◆ ConstPointer()

◆ ExternPointer()

◆ FloatConstRaw()

◆ FloatConstSingle()

◆ FloatConstDouble()

◆ ImportedAddress()

◆ ConstData()

◆ Add()

◆ AddWithCarry()

◆ Sub()

◆ SubWithBorrow()

◆ And()

◆ Or()

◆ Xor()

◆ ShiftLeft()

◆ LogicalShiftRight()

◆ ArithShiftRight()

◆ RotateLeft()

◆ RotateLeftCarry()

◆ RotateRight()

◆ RotateRightCarry()

◆ Mult()

◆ MultDoublePrecSigned()

◆ MultDoublePrecUnsigned()

◆ DivSigned()

◆ DivUnsigned()

◆ DivDoublePrecSigned()

◆ DivDoublePrecUnsigned()

◆ ModSigned()

◆ ModUnsigned()

◆ ModDoublePrecSigned()

◆ ModDoublePrecUnsigned()

◆ Neg()

◆ Not()

◆ SignExtend()

◆ ZeroExtend()

◆ LowPart()

◆ Call()

◆ Syscall()

◆ TailCall()

◆ CallSSA()

◆ SyscallSSA()

◆ CompareEqual()

◆ CompareNotEqual()

◆ CompareSignedLessThan()

◆ CompareUnsignedLessThan()

◆ CompareSignedLessEqual()

◆ CompareUnsignedLessEqual()

◆ CompareSignedGreaterEqual()

◆ CompareUnsignedGreaterEqual()

◆ CompareSignedGreaterThan()

◆ CompareUnsignedGreaterThan()

◆ TestBit()

◆ BoolToInt()

◆ AddOverflow()

◆ Breakpoint()

◆ Trap()

◆ Intrinsic()

◆ IntrinsicSSA()

◆ Undefined()

◆ Unimplemented()

◆ UnimplementedMemoryRef()

◆ FloatAdd()

◆ FloatSub()

◆ FloatMult()

◆ FloatDiv()

◆ FloatSqrt()

◆ FloatNeg()

◆ FloatAbs()

◆ FloatToInt()

◆ IntToFloat()

◆ FloatConvert()

◆ RoundToInt()

◆ Floor()

◆ Ceil()

◆ FloatTrunc()

◆ FloatCompareEqual()

◆ FloatCompareNotEqual()

◆ FloatCompareLessThan()

◆ FloatCompareLessEqual()

◆ FloatCompareGreaterEqual()

◆ FloatCompareGreaterThan()

◆ FloatCompareOrdered()

◆ FloatCompareUnordered()

◆ GetOperandList()

vector< uint64_t > HighLevelILFunction::GetOperandList	(	ExprId	i,
		size_t	listOperand )

◆ AddOperandList()

ExprId HighLevelILFunction::AddOperandList

(

const std::vector< ExprId > &

operands

)

◆ AddIndexList()

ExprId HighLevelILFunction::AddIndexList

(

const std::vector< size_t > &

operands

)

◆ AddSSAVariableList()

ExprId HighLevelILFunction::AddSSAVariableList

(

const std::vector< SSAVariable > &

vars

)

◆ GetRawExpr()

◆ GetRawNonASTExpr()

◆ operator[]()

HighLevelILInstruction HighLevelILFunction::operator[]

(

size_t

)

◆ GetInstruction()

HighLevelILInstruction HighLevelILFunction::GetInstruction

(

size_t

)

◆ GetExpr()

HighLevelILInstruction HighLevelILFunction::GetExpr	(	size_t	i,
		bool	asFullAst = true )

◆ GetIndexForInstruction()

size_t HighLevelILFunction::GetIndexForInstruction

(

size_t

)

const

◆ GetInstructionForExpr()

size_t HighLevelILFunction::GetInstructionForExpr

(

size_t

expr

)

const

◆ GetInstructionCount()

size_t HighLevelILFunction::GetInstructionCount

(

)

const

◆ GetExprCount()

size_t HighLevelILFunction::GetExprCount

(

)

const

◆ GetBasicBlocks()

vector< Ref< BasicBlock > > HighLevelILFunction::GetBasicBlocks

(

)

const

◆ GetBasicBlockForInstruction()

Ref< BasicBlock > HighLevelILFunction::GetBasicBlockForInstruction

(

size_t

)

const

◆ GetSSAForm()

Ref< HighLevelILFunction > HighLevelILFunction::GetSSAForm

(

)

const

◆ GetNonSSAForm()

Ref< HighLevelILFunction > HighLevelILFunction::GetNonSSAForm

(

)

const

◆ GetSSAInstructionIndex()

size_t HighLevelILFunction::GetSSAInstructionIndex

(

size_t

instr

)

const

◆ GetNonSSAInstructionIndex()

size_t HighLevelILFunction::GetNonSSAInstructionIndex

(

size_t

instr

)

const

◆ GetSSAExprIndex()

size_t HighLevelILFunction::GetSSAExprIndex

(

size_t

instr

)

const

◆ GetNonSSAExprIndex()

size_t HighLevelILFunction::GetNonSSAExprIndex

(

size_t

instr

)

const

◆ GetSSAVarDefinition()

size_t HighLevelILFunction::GetSSAVarDefinition

(

const SSAVariable &

var

)

const

◆ GetSSAMemoryDefinition()

size_t HighLevelILFunction::GetSSAMemoryDefinition

(

size_t

version

)

const

◆ GetSSAVarUses()

set< size_t > HighLevelILFunction::GetSSAVarUses

(

const SSAVariable &

var

)

const

◆ GetSSAMemoryUses()

set< size_t > HighLevelILFunction::GetSSAMemoryUses

(

size_t

version

)

const

◆ IsSSAVarLive()

bool HighLevelILFunction::IsSSAVarLive

(

const SSAVariable &

var

)

const

◆ IsSSAVarLiveAt()

bool HighLevelILFunction::IsSSAVarLiveAt	(	const SSAVariable &	var,
		const size_t	instr ) const

◆ IsVarLiveAt()

bool HighLevelILFunction::IsVarLiveAt	(	const Variable &	var,
		const size_t	instr ) const

◆ HasSideEffects()

bool HighLevelILFunction::HasSideEffects

(

const HighLevelILInstruction &

instr

)

static

◆ GetExprScopeType()

BNScopeType HighLevelILFunction::GetExprScopeType

(

const HighLevelILInstruction &

instr

)

static

◆ GetVariableSSAVersions()

set< size_t > HighLevelILFunction::GetVariableSSAVersions

(

const Variable &

var

)

const

◆ GetVariableDefinitions()

set< size_t > HighLevelILFunction::GetVariableDefinitions

(

const Variable &

var

)

const

◆ GetVariableUses()

set< size_t > HighLevelILFunction::GetVariableUses

(

const Variable &

var

)

const

◆ GetSSAVarVersionAtInstruction()

size_t HighLevelILFunction::GetSSAVarVersionAtInstruction	(	const Variable &	var,
		size_t	instr ) const

◆ GetSSAMemoryVersionAtInstruction()

size_t HighLevelILFunction::GetSSAMemoryVersionAtInstruction

(

size_t

instr

)

const

◆ GetMediumLevelIL()

◆ GetMediumLevelILExprIndex()

size_t HighLevelILFunction::GetMediumLevelILExprIndex

(

size_t

expr

)

const

◆ GetMediumLevelILExprIndexes()

set< size_t > HighLevelILFunction::GetMediumLevelILExprIndexes

(

size_t

expr

)

const

◆ UpdateInstructionOperand()

void HighLevelILFunction::UpdateInstructionOperand	(	size_t	i,
		size_t	operandIndex,
		ExprId	value )

◆ ReplaceExpr()

void HighLevelILFunction::ReplaceExpr	(	size_t	expr,
		size_t	newExpr )

◆ SetExprAttributes()

void HighLevelILFunction::SetExprAttributes	(	size_t	expr,
		uint32_t	attributes )

◆ Finalize()

void HighLevelILFunction::Finalize

(

)

◆ GenerateSSAForm()

void HighLevelILFunction::GenerateSSAForm

(

const std::set< Variable > &

aliases = std::set<Variable>()

)

◆ GetExprText() [1/2]

◆ GetExprText() [2/2]

◆ GetInstructionText()

◆ GetExprType() [1/2]

◆ GetExprType() [2/2]

◆ SetExprType() [1/2]

void HighLevelILFunction::SetExprType	(	size_t	expr,
		const Confidence< Ref< Type > > &	type )

SetExprType sets the type of a given expression.

Warning: This method is only meant for workflows or for debugging purposes, since the changes they make are not persistent and get lost after a database save and reload. To make persistent changes to the analysis, one should use other APIs to, for example, change the type of variables. The analysis will then propagate the type of the variable and update the type of related expressions.

Parameters

expr	index of the expression to set
type	new type of the expression

◆ SetExprType() [2/2]

◆ VisitAllExprs()

void HighLevelILFunction::VisitAllExprs

(

const std::function< bool(const HighLevelILInstruction &expr)> &

func

)

◆ CreateFunctionGraph()

◆ CreateFunctionGraphImmediate()

◆ GetExprIndexForLabel()

size_t HighLevelILFunction::GetExprIndexForLabel

(

uint64_t

label

)

◆ GetUsesForLabel()

set< size_t > HighLevelILFunction::GetUsesForLabel

(

uint64_t

label

)

◆ GetVariables()

set< Variable > HighLevelILFunction::GetVariables

(

)

◆ GetAliasedVariables()

set< Variable > HighLevelILFunction::GetAliasedVariables

(

)

◆ GetSSAVariables()

set< SSAVariable > HighLevelILFunction::GetSSAVariables

(

)

◆ SetDerivedStringReferenceForExpr()

void HighLevelILFunction::SetDerivedStringReferenceForExpr	(	size_t	expr,
		const DerivedString &	str )

◆ RemoveDerivedStringReferenceForExpr()

void HighLevelILFunction::RemoveDerivedStringReferenceForExpr

(

size_t

expr

)

◆ GetDerivedStringReferenceForExpr()

optional< DerivedString > HighLevelILFunction::GetDerivedStringReferenceForExpr

(

size_t

expr

)

◆ BinaryNinja::LanguageRepresentationFunction

class BinaryNinja::LanguageRepresentationFunction

LanguageRepresentationFunction represents a single function in a registered high level language.

Public Member Functions
	LanguageRepresentationFunction (LanguageRepresentationFunctionType type, Architecture arch, Function func, HighLevelILFunction highLevelIL)
	LanguageRepresentationFunction (BNLanguageRepresentationFunction *func)
std::vector< DisassemblyTextLine >	GetExprText (const HighLevelILInstruction &instr, DisassemblySettings *settings, BNOperatorPrecedence precedence=TopLevelOperatorPrecedence, bool statement=false)
	Gets the lines of tokens for a given High Level IL instruction.
std::vector< DisassemblyTextLine >	GetLinearLines (const HighLevelILInstruction &instr, DisassemblySettings *settings)
	Generates lines for the given High Level IL instruction in the style of the linear view.
std::vector< DisassemblyTextLine >	GetBlockLines (BasicBlock block, DisassemblySettings settings)
	Generates lines for a single High Level IL basic block.
BNHighlightColor	GetHighlight (BasicBlock *block)
	Gets the highlight color for a given basic block.
Ref< LanguageRepresentationFunctionType >	GetLanguage () const
Ref< Architecture >	GetArchitecture () const
Ref< Function >	GetFunction () const
Ref< HighLevelILFunction >	GetHighLevelILFunction () const
virtual std::string	GetCommentStartString () const
	Gets the string representing the start of a comment.
virtual std::string	GetCommentEndString () const
	Gets the string representing the end of a comment.
virtual std::string	GetAnnotationStartString () const
	Gets the string representing the start of an annotation.
virtual std::string	GetAnnotationEndString () const
	Gets the string representing the end of an annotation.
Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNLanguageRepresentationFunction, BNNewLanguageRepresentationFunctionReference, BNFreeLanguageRepresentationFunction >
	CoreRefCountObject ()
virtual	~CoreRefCountObject ()
BNLanguageRepresentationFunction *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	ReleaseForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()
Protected Member Functions
virtual void	InitTokenEmitter (HighLevelILTokenEmitter &tokens)
	Override this method to initialize the options for the token emitter before it is used.
virtual void	GetExprText (const HighLevelILInstruction &instr, HighLevelILTokenEmitter &tokens, DisassemblySettings *settings, BNOperatorPrecedence precedence=TopLevelOperatorPrecedence, bool statement=false)=0
	This method must be overridden by all language representation plugins.
virtual void	BeginLines (const HighLevelILInstruction &instr, HighLevelILTokenEmitter &tokens)
	This method can be overridden to emit tokens at the start of a function.
virtual void	EndLines (const HighLevelILInstruction &instr, HighLevelILTokenEmitter &tokens)
	This method can be overridden to emit tokens at the end of a function.

◆ LanguageRepresentationFunction() [1/2]

LanguageRepresentationFunction::LanguageRepresentationFunction	(	LanguageRepresentationFunctionType *	type,
		Architecture *	arch,
		Function *	func,
		HighLevelILFunction *	highLevelIL )

◆ LanguageRepresentationFunction() [2/2]

◆ GetExprText() [1/2]

Gets the lines of tokens for a given High Level IL instruction.

Parameters

instr	The instruction to emit lines for.
settings	The settings for disassembly (optional).
precedence	The current operator precedence level.
statement	Whether the instruction is a statement or an expression.

Returns: A list of lines of tokens for the instruction.

◆ GetLinearLines()

Generates lines for the given High Level IL instruction in the style of the linear view.

To get the lines for the entire function, pass the root instruction of a HighLevelILFunction.

Parameters

instr	The instruction to emit lines for.
settings	The settings for disassembly (optional).

Returns: A list of lines of tokens for the instruction.

◆ GetBlockLines()

Generates lines for a single High Level IL basic block.

Parameters

block	The basic block to emit lines for.
settings	The settings for disassembly (optional).

Returns: A list of lines of tokens for the basic block.

◆ GetHighlight()

Gets the highlight color for a given basic block.

Parameters

block

The basic block to get the highlight color for.

Returns: The highlight color for the basic block.

◆ GetLanguage()

Ref< LanguageRepresentationFunctionType > LanguageRepresentationFunction::GetLanguage

(

)

const

◆ GetArchitecture()

Ref< Architecture > LanguageRepresentationFunction::GetArchitecture

(

)

const

◆ GetFunction()

Ref< Function > LanguageRepresentationFunction::GetFunction

(

)

const

◆ GetHighLevelILFunction()

Ref< HighLevelILFunction > LanguageRepresentationFunction::GetHighLevelILFunction

(

)

const

◆ GetCommentStartString()

virtual std::string BinaryNinja::LanguageRepresentationFunction::GetCommentStartString

(

)

const

inlinevirtual

Gets the string representing the start of a comment.

Returns: The string representing the start of a comment.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunction.

◆ GetCommentEndString()

virtual std::string BinaryNinja::LanguageRepresentationFunction::GetCommentEndString

(

)

const

inlinevirtual

Gets the string representing the end of a comment.

Returns: The string representing the end of a comment.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunction.

◆ GetAnnotationStartString()

virtual std::string BinaryNinja::LanguageRepresentationFunction::GetAnnotationStartString

(

)

const

inlinevirtual

Gets the string representing the start of an annotation.

Returns: The string representing the start of an annotation.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunction.

◆ GetAnnotationEndString()

virtual std::string BinaryNinja::LanguageRepresentationFunction::GetAnnotationEndString

(

)

const

inlinevirtual

Gets the string representing the end of an annotation.

Returns: The string representing the end of an annotation.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunction.

◆ InitTokenEmitter()

void LanguageRepresentationFunction::InitTokenEmitter

(

HighLevelILTokenEmitter &

tokens

)

protectedvirtual

Override this method to initialize the options for the token emitter before it is used.

Parameters

tokens

The token emitter to initialize.

◆ GetExprText() [2/2]

This method must be overridden by all language representation plugins.

This method is called to emit the tokens for a given High Level IL instruction.

Parameters

instr	The instruction to emit tokens for.
tokens	The token emitter to use.
settings	The disassembly settings to use (may be NULL).
precedence	The current operator precedence level.
statement	Whether the instruction is a statement or an expression.

Implemented in BinaryNinja::CoreLanguageRepresentationFunction.

◆ BeginLines()

void LanguageRepresentationFunction::BeginLines	(	const HighLevelILInstruction &	instr,
		HighLevelILTokenEmitter &	tokens )

protectedvirtual

This method can be overridden to emit tokens at the start of a function.

Parameters

instr	The root instruction of the function.
tokens	The token emitter to use.

◆ EndLines()

void LanguageRepresentationFunction::EndLines	(	const HighLevelILInstruction &	instr,
		HighLevelILTokenEmitter &	tokens )

protectedvirtual

This method can be overridden to emit tokens at the end of a function.

Parameters

instr	The root instruction of the function.
tokens	The token emitter to use.

◆ BinaryNinja::CoreLanguageRepresentationFunction

class BinaryNinja::CoreLanguageRepresentationFunction

Public Member Functions
	CoreLanguageRepresentationFunction (BNLanguageRepresentationFunction *func)
std::string	GetCommentStartString () const override
	Gets the string representing the start of a comment.
std::string	GetCommentEndString () const override
	Gets the string representing the end of a comment.
std::string	GetAnnotationStartString () const override
	Gets the string representing the start of an annotation.
std::string	GetAnnotationEndString () const override
	Gets the string representing the end of an annotation.
Public Member Functions inherited from BinaryNinja::LanguageRepresentationFunction
	LanguageRepresentationFunction (LanguageRepresentationFunctionType type, Architecture arch, Function func, HighLevelILFunction highLevelIL)
	LanguageRepresentationFunction (BNLanguageRepresentationFunction *func)
std::vector< DisassemblyTextLine >	GetExprText (const HighLevelILInstruction &instr, DisassemblySettings *settings, BNOperatorPrecedence precedence=TopLevelOperatorPrecedence, bool statement=false)
	Gets the lines of tokens for a given High Level IL instruction.
std::vector< DisassemblyTextLine >	GetLinearLines (const HighLevelILInstruction &instr, DisassemblySettings *settings)
	Generates lines for the given High Level IL instruction in the style of the linear view.
std::vector< DisassemblyTextLine >	GetBlockLines (BasicBlock block, DisassemblySettings settings)
	Generates lines for a single High Level IL basic block.
BNHighlightColor	GetHighlight (BasicBlock *block)
	Gets the highlight color for a given basic block.
Ref< LanguageRepresentationFunctionType >	GetLanguage () const
Ref< Architecture >	GetArchitecture () const
Ref< Function >	GetFunction () const
Ref< HighLevelILFunction >	GetHighLevelILFunction () const
Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNLanguageRepresentationFunction, BNNewLanguageRepresentationFunctionReference, BNFreeLanguageRepresentationFunction >
	CoreRefCountObject ()
virtual	~CoreRefCountObject ()
BNLanguageRepresentationFunction *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	ReleaseForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()
Protected Member Functions
void	GetExprText (const HighLevelILInstruction &instr, HighLevelILTokenEmitter &tokens, DisassemblySettings *settings, BNOperatorPrecedence precedence=TopLevelOperatorPrecedence, bool statement=false) override
	This method must be overridden by all language representation plugins.
Protected Member Functions inherited from BinaryNinja::LanguageRepresentationFunction
virtual void	InitTokenEmitter (HighLevelILTokenEmitter &tokens)
	Override this method to initialize the options for the token emitter before it is used.
virtual void	BeginLines (const HighLevelILInstruction &instr, HighLevelILTokenEmitter &tokens)
	This method can be overridden to emit tokens at the start of a function.
virtual void	EndLines (const HighLevelILInstruction &instr, HighLevelILTokenEmitter &tokens)
	This method can be overridden to emit tokens at the end of a function.

◆ CoreLanguageRepresentationFunction()

◆ GetCommentStartString()

string CoreLanguageRepresentationFunction::GetCommentStartString

(

)

const

overridevirtual

Gets the string representing the start of a comment.

Returns: The string representing the start of a comment.

Reimplemented from BinaryNinja::LanguageRepresentationFunction.

◆ GetCommentEndString()

string CoreLanguageRepresentationFunction::GetCommentEndString

(

)

const

overridevirtual

Gets the string representing the end of a comment.

Returns: The string representing the end of a comment.

Reimplemented from BinaryNinja::LanguageRepresentationFunction.

◆ GetAnnotationStartString()

string CoreLanguageRepresentationFunction::GetAnnotationStartString

(

)

const

overridevirtual

Gets the string representing the start of an annotation.

Returns: The string representing the start of an annotation.

Reimplemented from BinaryNinja::LanguageRepresentationFunction.

◆ GetAnnotationEndString()

string CoreLanguageRepresentationFunction::GetAnnotationEndString

(

)

const

overridevirtual

Gets the string representing the end of an annotation.

Returns: The string representing the end of an annotation.

Reimplemented from BinaryNinja::LanguageRepresentationFunction.

◆ GetExprText()

This method must be overridden by all language representation plugins.

This method is called to emit the tokens for a given High Level IL instruction.

Parameters

instr	The instruction to emit tokens for.
tokens	The token emitter to use.
settings	The disassembly settings to use (may be NULL).
precedence	The current operator precedence level.
statement	Whether the instruction is a statement or an expression.

Implements BinaryNinja::LanguageRepresentationFunction.

◆ BinaryNinja::LanguageRepresentationFunctionType

class BinaryNinja::LanguageRepresentationFunctionType

LanguageRepresentationFunctionType represents a custom language representation function type.

This class provides methods to create LanguageRepresentationFunction instances for functions, as well as manage the printing and parsing of types.

Public Member Functions
	LanguageRepresentationFunctionType (const std::string &name)
	LanguageRepresentationFunctionType (BNLanguageRepresentationFunctionType *type)
std::string	GetName () const
virtual Ref< LanguageRepresentationFunction >	Create (Architecture arch, Function owner, HighLevelILFunction *highLevelIL)=0
	This method must be overridden.
virtual bool	IsValid (BinaryView *view)
	Returns whether the language is valid for the given binary view.
virtual Ref< TypePrinter >	GetTypePrinter ()
	Returns the type printer for displaying types in this language.
virtual Ref< TypeParser >	GetTypeParser ()
	Returns the type parser for parsing types in this language.
virtual Ref< LineFormatter >	GetLineFormatter ()
	Returns the line formatter for formatting code in this language.
virtual std::vector< DisassemblyTextLine >	GetFunctionTypeTokens (Function func, DisassemblySettings settings=nullptr)
	Returns a list of lines representing a function prototype in this language.
Public Member Functions inherited from BinaryNinja::StaticCoreRefCountObject< BNLanguageRepresentationFunctionType >
	StaticCoreRefCountObject ()
virtual	~StaticCoreRefCountObject ()
BNLanguageRepresentationFunctionType *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()
Static Public Member Functions
static void	Register (LanguageRepresentationFunctionType *type)
	Registers the language representation function type.
static Ref< LanguageRepresentationFunctionType >	GetByName (const std::string &name)
static bool	IsValidByName (const std::string &name, BinaryView *view)
static std::vector< Ref< LanguageRepresentationFunctionType > >	GetTypes ()

◆ LanguageRepresentationFunctionType() [1/2]

LanguageRepresentationFunctionType::LanguageRepresentationFunctionType

(

const std::string &

name

)

◆ LanguageRepresentationFunctionType() [2/2]

◆ GetName()

string LanguageRepresentationFunctionType::GetName

(

)

const

◆ Create()

virtual Ref< LanguageRepresentationFunction > BinaryNinja::LanguageRepresentationFunctionType::Create	(	Architecture *	arch,
		Function *	owner,
		HighLevelILFunction *	highLevelIL )

pure virtual

This method must be overridden.

This creates the LanguageRepresentationFunction object for the given architecture, owner function, and High Level IL function.

Parameters

arch	The architecture of the function.
owner	The associated function.
highLevelIL	The High Level IL for the function.

Returns: A LanguageRepresentationFunction instance for the given function.

Implemented in BinaryNinja::CoreLanguageRepresentationFunctionType.

◆ IsValid()

bool LanguageRepresentationFunctionType::IsValid

(

BinaryView *

view

)

virtual

Returns whether the language is valid for the given binary view.

Parameters

view	The binary view to check the validity for.

Returns: True if the language is valid for the given binary view, false otherwise.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunctionType.

◆ GetTypePrinter()

virtual Ref< TypePrinter > BinaryNinja::LanguageRepresentationFunctionType::GetTypePrinter

(

)

inlinevirtual

Returns the type printer for displaying types in this language.

If NULL is returned, the default type printer will be used.

Returns: The optional type printer for displaying types in this language.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunctionType.

◆ GetTypeParser()

virtual Ref< TypeParser > BinaryNinja::LanguageRepresentationFunctionType::GetTypeParser

(

)

inlinevirtual

Returns the type parser for parsing types in this language.

If NULL is returned, the default type parser will be used.

Returns: The optional type parser for parsing types in this language.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunctionType.

◆ GetLineFormatter()

virtual Ref< LineFormatter > BinaryNinja::LanguageRepresentationFunctionType::GetLineFormatter

(

)

inlinevirtual

Returns the line formatter for formatting code in this language.

If NULL is returned, the default formatter will be used.

Returns: The optional formatter for formatting code in this language.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunctionType.

◆ GetFunctionTypeTokens()

Returns a list of lines representing a function prototype in this language.

If no lines are returned, the default C-style prototype will be used.

Parameters

func	The function to get the prototype lines for.
settings	The disassembly settings to use (may be NULL).

Returns: An optional vector of lines representing the function prototype.

Reimplemented in BinaryNinja::CoreLanguageRepresentationFunctionType.

◆ Register()

void LanguageRepresentationFunctionType::Register

(

LanguageRepresentationFunctionType *

type

)

static

Registers the language representation function type.

Parameters

type	The language representation function type to register.

◆ GetByName()

Ref< LanguageRepresentationFunctionType > LanguageRepresentationFunctionType::GetByName

(

const std::string &

name

)

static

◆ IsValidByName()

bool LanguageRepresentationFunctionType::IsValidByName	(	const std::string &	name,
		BinaryView *	view )

static

◆ GetTypes()

vector< Ref< LanguageRepresentationFunctionType > > LanguageRepresentationFunctionType::GetTypes

(

)

static

◆ BinaryNinja::HighLevelILTokenEmitter

class BinaryNinja::HighLevelILTokenEmitter

HighLevelILTokenEmitter contains methods for emitting text tokens for High Level IL instructions.

Methods are provided for typical patterns found in various high level languages.

This class cannot be instantiated directly. An instance of the class will be provided when the methods in LanguageRepresentationFunction are called.

Public Member Functions
	HighLevelILTokenEmitter (BNHighLevelILTokenEmitter *emitter)
template<typename... Args>
void	Append (Args &&... args)
	Appends a token to the output.
void	PrependCollapseIndicator ()
void	PrependCollapseIndicator (Ref< Function > function, const HighLevelILInstruction &instr, uint64_t designator=0)
void	PrependCollapseIndicator (BNInstructionTextTokenContext context, uint64_t hash)
bool	HasCollapsableRegions ()
void	SetHasCollapsableRegions (bool state)
void	InitLine ()
	Starts a new line in the output.
void	NewLine ()
	Starts a new line in the output.
void	IncreaseIndent ()
	Increases the indentation level by one.
void	DecreaseIndent ()
	Decreases the indentation level by one.
void	ScopeSeparator ()
	Indicates that visual separation of scopes is desirable at the current position.
void	BeginScope (BNScopeType scopeType)
	Begins a new scope.
void	EndScope (BNScopeType scopeType)
	Ends the current scope.
void	ScopeContinuation (bool forceSameLine)
	Continues the previous scope with a new associated scope.
void	FinalizeScope ()
	Finalizes the previous scope, indicating that there are no more associated scopes.
void	NoIndentForThisLine ()
	Forces there to be no indentation for the next line.
void	BeginForceZeroConfidence ()
	Begins a region of tokens that always have zero confidence.
void	EndForceZeroConfidence ()
	Ends a region of tokens that always have zero confidence.
CurrentExprGuard	SetCurrentExpr (const HighLevelILInstruction &expr)
	Sets the current expression.
void	Finalize ()
	Finalizes the outputted lines.
void	AppendOpenParen ()
void	AppendCloseParen ()
void	AppendOpenBracket ()
void	AppendCloseBracket ()
void	AppendOpenBrace ()
void	AppendCloseBrace ()
void	AppendSemicolon ()
std::vector< InstructionTextToken >	GetCurrentTokens () const
	Returns the list of tokens on the current line.
void	SetCurrentTokens (const std::vector< InstructionTextToken > &newTokens)
	Set the list of tokens on the current line.
void	SetBraceRequirement (BNBraceRequirement required)
	Sets the requirement for insertion of braces around scopes in the output.
void	SetBracesAroundSwitchCases (bool braces)
	Sets whether cases within switch statements should always have braces around them.
void	SetDefaultBracesOnSameLine (bool sameLine)
	Sets whether braces should default to being on the same line as the statement that begins the scope.
void	SetSimpleScopeAllowed (bool allowed)
	Sets whether omitting braces around single-line scopes is allowed.
BNBraceRequirement	GetBraceRequirement () const
bool	HasBracesAroundSwitchCases () const
bool	GetDefaultBracesOnSameLine () const
size_t	GetMaxTernarySimplificationTokens () const
	Gets the maximum number of tokens to emit as a ternary operation.
bool	IsSimpleScopeAllowed () const
std::vector< DisassemblyTextLine >	GetLines () const
	Gets the list of lines in the output.
void	AppendSizeToken (size_t size, BNInstructionTextTokenType type)
	Appends a size token for the given size in the High Level IL syntax.
void	AppendFloatSizeToken (size_t size, BNInstructionTextTokenType type)
	Appends a floating point size token for the given size in the High Level IL syntax.
void	AppendVarTextToken (const Variable &var, const HighLevelILInstruction &instr, size_t size)
	Appends tokens for access to a variable.
void	AppendIntegerTextToken (const HighLevelILInstruction &instr, int64_t val, size_t size)
	Appends tokens for a constant intenger value.
void	AppendArrayIndexToken (const HighLevelILInstruction &instr, int64_t val, size_t size, uint64_t address=0)
	Appends tokens for accessing an array by constant index.
BNSymbolDisplayResult	AppendPointerTextToken (const HighLevelILInstruction &instr, int64_t val, DisassemblySettings *settings, BNSymbolDisplayType symbolDisplay, BNOperatorPrecedence precedence, bool allowShortString=false)
	Appends tokens for displaying a constant pointer value.
void	AppendConstantTextToken (const HighLevelILInstruction &instr, int64_t val, size_t size, DisassemblySettings *settings, BNOperatorPrecedence precedence)
	Appends tokens for a constant value.
Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNHighLevelILTokenEmitter, BNNewHighLevelILTokenEmitterReference, BNFreeHighLevelILTokenEmitter >
	CoreRefCountObject ()
virtual	~CoreRefCountObject ()
BNHighLevelILTokenEmitter *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	ReleaseForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()
Static Public Member Functions
static void	AddNamesForOuterStructureMembers (BinaryView data, Type type, const HighLevelILInstruction &var, std::vector< std::string > &nameList)
	Prepends the list of names for the outer structure members when accessing a structure member.

◆ HighLevelILTokenEmitter()

◆ Append()

template<typename... Args>

void BinaryNinja::HighLevelILTokenEmitter::Append

(

Args &&...

args

)

inline

Appends a token to the output.

◆ PrependCollapseIndicator() [1/3]

void HighLevelILTokenEmitter::PrependCollapseIndicator

(

)

◆ PrependCollapseIndicator() [2/3]

void HighLevelILTokenEmitter::PrependCollapseIndicator	(	Ref< Function >	function,
		const HighLevelILInstruction &	instr,
		uint64_t	designator = 0 )

◆ PrependCollapseIndicator() [3/3]

◆ HasCollapsableRegions()

bool HighLevelILTokenEmitter::HasCollapsableRegions

(

)

◆ SetHasCollapsableRegions()

void HighLevelILTokenEmitter::SetHasCollapsableRegions

(

bool

state

)

◆ InitLine()

void HighLevelILTokenEmitter::InitLine

(

)

Starts a new line in the output.

◆ NewLine()

void HighLevelILTokenEmitter::NewLine

(

)

Starts a new line in the output.

◆ IncreaseIndent()

void HighLevelILTokenEmitter::IncreaseIndent

(

)

Increases the indentation level by one.

◆ DecreaseIndent()

void HighLevelILTokenEmitter::DecreaseIndent

(

)

Decreases the indentation level by one.

◆ ScopeSeparator()

void HighLevelILTokenEmitter::ScopeSeparator

(

)

Indicates that visual separation of scopes is desirable at the current position.

By default, this will insert a blank line, but this can be configured by the user.

◆ BeginScope()

void HighLevelILTokenEmitter::BeginScope

(

BNScopeType

scopeType

)

Begins a new scope.

Insertion of newlines and braces will be handled using the current settings.

Parameters

scopeType

Type of scope to be started.

◆ EndScope()

void HighLevelILTokenEmitter::EndScope

(

BNScopeType

scopeType

)

Ends the current scope.

Parameters

scopeType

Type of scope passed to BeginScope.

◆ ScopeContinuation()

void HighLevelILTokenEmitter::ScopeContinuation

(

bool

forceSameLine

)

Continues the previous scope with a new associated scope.

This is most commonly used for else statements.

Parameters

forceSameLine

If true, the continuation will always be placed on the same line as the previous scope.

◆ FinalizeScope()

void HighLevelILTokenEmitter::FinalizeScope

(

)

Finalizes the previous scope, indicating that there are no more associated scopes.

◆ NoIndentForThisLine()

void HighLevelILTokenEmitter::NoIndentForThisLine

(

)

Forces there to be no indentation for the next line.

◆ BeginForceZeroConfidence()

void HighLevelILTokenEmitter::BeginForceZeroConfidence

(

)

Begins a region of tokens that always have zero confidence.

◆ EndForceZeroConfidence()

void HighLevelILTokenEmitter::EndForceZeroConfidence

(

)

Ends a region of tokens that always have zero confidence.

◆ SetCurrentExpr()

HighLevelILTokenEmitter::CurrentExprGuard HighLevelILTokenEmitter::SetCurrentExpr

(

const HighLevelILInstruction &

expr

)

Sets the current expression.

When the returned guard object goes out of scope, the previously set expression becomes active again.

Parameters

expr	Expression to set as the current expression.

Returns: Guard object to manage the current expression.

◆ Finalize()

void HighLevelILTokenEmitter::Finalize

(

)

Finalizes the outputted lines.

◆ AppendOpenParen()

void HighLevelILTokenEmitter::AppendOpenParen

(

)

◆ AppendCloseParen()

void HighLevelILTokenEmitter::AppendCloseParen

(

)

◆ AppendOpenBracket()

void HighLevelILTokenEmitter::AppendOpenBracket

(

)

◆ AppendCloseBracket()

void HighLevelILTokenEmitter::AppendCloseBracket

(

)

◆ AppendOpenBrace()

void HighLevelILTokenEmitter::AppendOpenBrace

(

)

◆ AppendCloseBrace()

void HighLevelILTokenEmitter::AppendCloseBrace

(

)

◆ AppendSemicolon()

void HighLevelILTokenEmitter::AppendSemicolon

(

)

◆ GetCurrentTokens()

Returns the list of tokens on the current line.

◆ SetCurrentTokens()

void HighLevelILTokenEmitter::SetCurrentTokens

(

const std::vector< InstructionTextToken > &

newTokens

)

Set the list of tokens on the current line.

◆ SetBraceRequirement()

Sets the requirement for insertion of braces around scopes in the output.

◆ SetBracesAroundSwitchCases()

void HighLevelILTokenEmitter::SetBracesAroundSwitchCases

(

bool

braces

)

Sets whether cases within switch statements should always have braces around them.

◆ SetDefaultBracesOnSameLine()

void HighLevelILTokenEmitter::SetDefaultBracesOnSameLine

(

bool

sameLine

)

Sets whether braces should default to being on the same line as the statement that begins the scope.

If the user has explicitly set a preference, this setting will be ignored and the user's preference will be used instead.

◆ SetSimpleScopeAllowed()

void HighLevelILTokenEmitter::SetSimpleScopeAllowed

(

bool

allowed

)

Sets whether omitting braces around single-line scopes is allowed.

◆ GetBraceRequirement()

◆ HasBracesAroundSwitchCases()

bool HighLevelILTokenEmitter::HasBracesAroundSwitchCases

(

)

const

◆ GetDefaultBracesOnSameLine()

bool HighLevelILTokenEmitter::GetDefaultBracesOnSameLine

(

)

const

◆ GetMaxTernarySimplificationTokens()

size_t HighLevelILTokenEmitter::GetMaxTernarySimplificationTokens

(

)

const

Gets the maximum number of tokens to emit as a ternary operation.

◆ IsSimpleScopeAllowed()

bool HighLevelILTokenEmitter::IsSimpleScopeAllowed

(

)

const

◆ GetLines()

Gets the list of lines in the output.

◆ AppendSizeToken()

Appends a size token for the given size in the High Level IL syntax.

Parameters

size	Size in bytes.
type	Token type to append.

◆ AppendFloatSizeToken()

Appends a floating point size token for the given size in the High Level IL syntax.

Parameters

size	Size in bytes.
type	Token type to append.

◆ AppendVarTextToken()

void HighLevelILTokenEmitter::AppendVarTextToken	(	const Variable &	var,
		const HighLevelILInstruction &	instr,
		size_t	size )

Appends tokens for access to a variable.

Parameters

var	Variable to access.
instr	Instruction that accesses the variable.
size	Size in bytes.

◆ AppendIntegerTextToken()

void HighLevelILTokenEmitter::AppendIntegerTextToken	(	const HighLevelILInstruction &	instr,
		int64_t	val,
		size_t	size )

Appends tokens for a constant intenger value.

Parameters

instr	Instruction that references the value.
val	Integer value.
size	Size in bytes.

◆ AppendArrayIndexToken()

void HighLevelILTokenEmitter::AppendArrayIndexToken	(	const HighLevelILInstruction &	instr,
		int64_t	val,
		size_t	size,
		uint64_t	address = 0 )

Appends tokens for accessing an array by constant index.

Parameters

instr	Instruction that accesses the array.
val	Index value.
size	Size in bytes.
address	Optional address override.

◆ AppendPointerTextToken()

Appends tokens for displaying a constant pointer value.

Parameters

instr	Instruction that references the pointer.
val	Pointer value.
settings	Settings for disassembly (may be NULL).
symbolDisplay	Symbol display type.
precedence	Current operator precedence level.
allowShortString	If true, show as a string even if it is short.

Returns: Type of symbol resolved if any.

◆ AppendConstantTextToken()

Appends tokens for a constant value.

Parameters

instr	Instruction that references the value.
val	Constant value.
size	Size in bytes.
settings	Settings for disassembly (may be NULL).
precedence	Current operator precedence level.

◆ AddNamesForOuterStructureMembers()

void HighLevelILTokenEmitter::AddNamesForOuterStructureMembers	(	BinaryView *	data,
		Type *	type,
		const HighLevelILInstruction &	var,
		std::vector< std::string > &	nameList )

static

Prepends the list of names for the outer structure members when accessing a structure member.

This list can be passed as the list of type names in tokens.

Parameters

data	Binary view associated with the type.
type	Structure Type being accessed.
var	Structure variable.
nameList	Existing list of member names. This list will be updated with the outer structure member names.

◆ BinaryNinja::HighLevelILTokenEmitter::CurrentExprGuard

class BinaryNinja::HighLevelILTokenEmitter::CurrentExprGuard

◆ CurrentExprGuard()

HighLevelILTokenEmitter::CurrentExprGuard::CurrentExprGuard	(	HighLevelILTokenEmitter &	parent,
		const BNTokenEmitterExpr &	expr )

◆ ~CurrentExprGuard()

HighLevelILTokenEmitter::CurrentExprGuard::~CurrentExprGuard

(

)

◆ BinaryNinja::HighLevelILInstructionAccessException

class BinaryNinja::HighLevelILInstructionAccessException

◆ BinaryNinja::HighLevelILIntegerList

class BinaryNinja::HighLevelILIntegerList

Public Types
typedef ListIterator	const_iterator
Public Member Functions
	HighLevelILIntegerList (HighLevelILFunction *func, const BNHighLevelILInstruction &instr, size_t count)
const_iterator	begin () const
const_iterator	end () const
size_t	size () const
uint64_t	operator[] (size_t i) const
	operator std::vector< uint64_t > () const

◆ const_iterator

◆ HighLevelILIntegerList()

◆ begin()

HighLevelILIntegerList::const_iterator HighLevelILIntegerList::begin

(

)

const

◆ end()

HighLevelILIntegerList::const_iterator HighLevelILIntegerList::end

(

)

const

◆ size()

size_t HighLevelILIntegerList::size

(

)

const

◆ operator[]()

uint64_t HighLevelILIntegerList::operator[]

(

size_t

)

const

◆ operator std::vector< uint64_t >()

BinaryNinja::HighLevelILIntegerList::operator std::vector< uint64_t >

(

)

const

◆ BinaryNinja::HighLevelILIndexList

class BinaryNinja::HighLevelILIndexList

Public Types
typedef ListIterator	const_iterator
Public Member Functions
	HighLevelILIndexList (HighLevelILFunction *func, const BNHighLevelILInstruction &instr, size_t count)
const_iterator	begin () const
const_iterator	end () const
size_t	size () const
size_t	operator[] (size_t i) const
	operator std::vector< size_t > () const

◆ const_iterator

◆ HighLevelILIndexList()

◆ begin()

HighLevelILIndexList::const_iterator HighLevelILIndexList::begin

(

)

const

◆ end()

HighLevelILIndexList::const_iterator HighLevelILIndexList::end

(

)

const

◆ size()

size_t HighLevelILIndexList::size

(

)

const

◆ operator[]()

size_t HighLevelILIndexList::operator[]

(

size_t

)

const

◆ operator std::vector< size_t >()

BinaryNinja::HighLevelILIndexList::operator std::vector< size_t >

(

)

const

◆ BinaryNinja::HighLevelILInstructionList

class BinaryNinja::HighLevelILInstructionList

Public Types
typedef ListIterator	const_iterator
Public Member Functions
	HighLevelILInstructionList (HighLevelILFunction *func, const BNHighLevelILInstruction &instr, size_t count, bool asFullAst, size_t instructionIndex)
const_iterator	begin () const
const_iterator	end () const
size_t	size () const
const HighLevelILInstruction	operator[] (size_t i) const
	operator std::vector< HighLevelILInstruction > () const

◆ const_iterator

◆ HighLevelILInstructionList()

HighLevelILInstructionList::HighLevelILInstructionList	(	HighLevelILFunction *	func,
		const BNHighLevelILInstruction &	instr,
		size_t	count,
		bool	asFullAst,
		size_t	instructionIndex )

◆ begin()

HighLevelILInstructionList::const_iterator HighLevelILInstructionList::begin

(

)

const

◆ end()

HighLevelILInstructionList::const_iterator HighLevelILInstructionList::end

(

)

const

◆ size()

size_t HighLevelILInstructionList::size

(

)

const

◆ operator[]()

const HighLevelILInstruction HighLevelILInstructionList::operator[]

(

size_t

)

const

◆ operator std::vector< HighLevelILInstruction >()

BinaryNinja::HighLevelILInstructionList::operator std::vector< HighLevelILInstruction >

(

)

const

◆ BinaryNinja::HighLevelILSSAVariableList

class BinaryNinja::HighLevelILSSAVariableList

Public Types
typedef ListIterator	const_iterator
Public Member Functions
	HighLevelILSSAVariableList (HighLevelILFunction *func, const BNHighLevelILInstruction &instr, size_t count)
const_iterator	begin () const
const_iterator	end () const
size_t	size () const
const SSAVariable	operator[] (size_t i) const
	operator std::vector< SSAVariable > () const

◆ const_iterator

◆ HighLevelILSSAVariableList()

◆ begin()

HighLevelILSSAVariableList::const_iterator HighLevelILSSAVariableList::begin

(

)

const

◆ end()

HighLevelILSSAVariableList::const_iterator HighLevelILSSAVariableList::end

(

)

const

◆ size()

size_t HighLevelILSSAVariableList::size

(

)

const

◆ operator[]()

const SSAVariable HighLevelILSSAVariableList::operator[]

(

size_t

)

const

◆ operator std::vector< SSAVariable >()

BinaryNinja::HighLevelILSSAVariableList::operator std::vector< SSAVariable >

(

)

const

◆ BinaryNinja::HighLevelILInstructionBase

struct BinaryNinja::HighLevelILInstructionBase

Public Member Functions
HighLevelILOperandList	GetOperands () const
uint64_t	GetRawOperandAsInteger (size_t operand) const
ConstantData	GetRawOperandAsConstantData (size_t operand) const
size_t	GetRawOperandAsIndex (size_t operand) const
HighLevelILInstruction	GetRawOperandAsExpr (size_t operand) const
Variable	GetRawOperandAsVariable (size_t operand) const
SSAVariable	GetRawOperandAsSSAVariable (size_t operand) const
HighLevelILInstructionList	GetRawOperandAsExprList (size_t operand) const
HighLevelILSSAVariableList	GetRawOperandAsSSAVariableList (size_t operand) const
HighLevelILIndexList	GetRawOperandAsIndexList (size_t operand) const
PossibleValueSet	GetRawOperandAsPossibleValueSet (size_t operand) const
void	UpdateRawOperand (size_t operandIndex, ExprId value)
void	UpdateRawOperandAsInteger (size_t operandIndex, uint64_t value)
void	UpdateRawOperandAsSSAVariableList (size_t operandIndex, const std::vector< SSAVariable > &vars)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< HighLevelILInstruction > &exprs)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< size_t > &exprs)
RegisterValue	GetValue () const
PossibleValueSet	GetPossibleValues (const std::set< BNDataFlowQueryOption > &options=std::set< BNDataFlowQueryOption >()) const
Confidence< Ref< Type > >	GetType () const
size_t	GetSSAExprIndex () const
size_t	GetNonSSAExprIndex () const
HighLevelILInstruction	GetSSAForm () const
HighLevelILInstruction	GetNonSSAForm () const
size_t	GetMediumLevelILExprIndex () const
bool	HasMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelILSSAForm () const
char *	Dump () const
void	Replace (ExprId expr)
void	SetAttributes (uint32_t attributes)
void	SetAttribute (BNILInstructionAttribute attribute, bool state=true)
void	ClearAttribute (BNILInstructionAttribute attribute)
std::optional< DerivedString >	GetDerivedStringReference () const
void	SetDerivedStringReference (const DerivedString &str)
void	RemoveDerivedStringReference ()
size_t	GetInstructionIndex () const
HighLevelILInstruction	GetInstruction () const
HighLevelILInstruction	AsAST () const
HighLevelILInstruction	AsNonAST () const
bool	HasParent () const
HighLevelILInstruction	GetParent () const
uint64_t	GetInstructionHash (size_t discriminator=0) const
template<BNHighLevelILOperation N>
HighLevelILInstructionAccessor< N > &	As ()
HighLevelILOneOperandInstruction &	AsOneOperand ()
HighLevelILTwoOperandInstruction &	AsTwoOperand ()
HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry ()
template<BNHighLevelILOperation N>
const HighLevelILInstructionAccessor< N > &	As () const
const HighLevelILConstantInstruction &	AsConstant () const
const HighLevelILConstantDataInstruction &	AsConstantData () const
const HighLevelILOneOperandInstruction &	AsOneOperand () const
const HighLevelILTwoOperandInstruction &	AsTwoOperand () const
const HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry () const
Public Attributes
Ref< HighLevelILFunction >	function = nullptr
size_t	exprIndex
size_t	instructionIndex
bool	ast
Public Attributes inherited from BNHighLevelILInstruction
BNHighLevelILOperation	operation
uint32_t	attributes
uint32_t	sourceOperand
size_t	size
uint64_t	operands [5]
uint64_t	address
size_t	parent
Static Public Attributes
static std::unordered_map< HighLevelILOperandUsage, HighLevelILOperandType >	operandTypeForUsage
static std::unordered_map< BNHighLevelILOperation, std::vector< HighLevelILOperandUsage > >	operationOperandUsage
static std::unordered_map< BNHighLevelILOperation, std::unordered_map< HighLevelILOperandUsage, size_t > >	operationOperandIndex = GetOperandIndexForOperandUsages()

◆ GetOperands()

HighLevelILOperandList HighLevelILInstructionBase::GetOperands

(

)

const

◆ GetRawOperandAsInteger()

uint64_t HighLevelILInstructionBase::GetRawOperandAsInteger

(

size_t

operand

)

const

◆ GetRawOperandAsConstantData()

ConstantData HighLevelILInstructionBase::GetRawOperandAsConstantData

(

size_t

operand

)

const

◆ GetRawOperandAsIndex()

size_t HighLevelILInstructionBase::GetRawOperandAsIndex

(

size_t

operand

)

const

◆ GetRawOperandAsExpr()

HighLevelILInstruction HighLevelILInstructionBase::GetRawOperandAsExpr

(

size_t

operand

)

const

◆ GetRawOperandAsVariable()

Variable HighLevelILInstructionBase::GetRawOperandAsVariable

(

size_t

operand

)

const

◆ GetRawOperandAsSSAVariable()

SSAVariable HighLevelILInstructionBase::GetRawOperandAsSSAVariable

(

size_t

operand

)

const

◆ GetRawOperandAsExprList()

HighLevelILInstructionList HighLevelILInstructionBase::GetRawOperandAsExprList

(

size_t

operand

)

const

◆ GetRawOperandAsSSAVariableList()

HighLevelILSSAVariableList HighLevelILInstructionBase::GetRawOperandAsSSAVariableList

(

size_t

operand

)

const

◆ GetRawOperandAsIndexList()

HighLevelILIndexList HighLevelILInstructionBase::GetRawOperandAsIndexList

(

size_t

operand

)

const

◆ GetRawOperandAsPossibleValueSet()

PossibleValueSet HighLevelILInstructionBase::GetRawOperandAsPossibleValueSet

(

size_t

operand

)

const

◆ UpdateRawOperand()

void HighLevelILInstructionBase::UpdateRawOperand	(	size_t	operandIndex,
		ExprId	value )

◆ UpdateRawOperandAsInteger()

void HighLevelILInstructionBase::UpdateRawOperandAsInteger	(	size_t	operandIndex,
		uint64_t	value )

◆ UpdateRawOperandAsSSAVariableList()

void HighLevelILInstructionBase::UpdateRawOperandAsSSAVariableList	(	size_t	operandIndex,
		const std::vector< SSAVariable > &	vars )

◆ UpdateRawOperandAsExprList() [1/2]

void BinaryNinja::HighLevelILInstructionBase::UpdateRawOperandAsExprList	(	size_t	operandIndex,
		const std::vector< HighLevelILInstruction > &	exprs )

◆ UpdateRawOperandAsExprList() [2/2]

void BinaryNinja::HighLevelILInstructionBase::UpdateRawOperandAsExprList	(	size_t	operandIndex,
		const std::vector< size_t > &	exprs )

◆ GetValue()

◆ GetPossibleValues()

◆ GetType()

◆ GetSSAExprIndex()

size_t HighLevelILInstructionBase::GetSSAExprIndex

(

)

const

◆ GetNonSSAExprIndex()

size_t HighLevelILInstructionBase::GetNonSSAExprIndex

(

)

const

◆ GetSSAForm()

HighLevelILInstruction HighLevelILInstructionBase::GetSSAForm

(

)

const

◆ GetNonSSAForm()

HighLevelILInstruction HighLevelILInstructionBase::GetNonSSAForm

(

)

const

◆ GetMediumLevelILExprIndex()

size_t HighLevelILInstructionBase::GetMediumLevelILExprIndex

(

)

const

◆ HasMediumLevelIL()

bool HighLevelILInstructionBase::HasMediumLevelIL

(

)

const

◆ GetMediumLevelIL()

◆ GetMediumLevelILSSAForm()

◆ Dump()

char * HighLevelILInstructionBase::Dump

(

)

const

◆ Replace()

void HighLevelILInstructionBase::Replace

(

ExprId

expr

)

◆ SetAttributes()

void HighLevelILInstructionBase::SetAttributes

(

uint32_t

attributes

)

◆ SetAttribute()

◆ ClearAttribute()

◆ GetDerivedStringReference()

std::optional< DerivedString > HighLevelILInstructionBase::GetDerivedStringReference

(

)

const

◆ SetDerivedStringReference()

void HighLevelILInstructionBase::SetDerivedStringReference

(

const DerivedString &

str

)

◆ RemoveDerivedStringReference()

void HighLevelILInstructionBase::RemoveDerivedStringReference

(

)

◆ GetInstructionIndex()

size_t HighLevelILInstructionBase::GetInstructionIndex

(

)

const

◆ GetInstruction()

HighLevelILInstruction HighLevelILInstructionBase::GetInstruction

(

)

const

◆ AsAST()

HighLevelILInstruction HighLevelILInstructionBase::AsAST

(

)

const

◆ AsNonAST()

HighLevelILInstruction HighLevelILInstructionBase::AsNonAST

(

)

const

◆ HasParent()

bool HighLevelILInstructionBase::HasParent

(

)

const

◆ GetParent()

HighLevelILInstruction HighLevelILInstructionBase::GetParent

(

)

const

◆ GetInstructionHash()

uint64_t BinaryNinja::HighLevelILInstructionBase::GetInstructionHash

(

size_t

discriminator = 0

)

const

inline

◆ As() [1/2]

HighLevelILInstructionAccessor< N > & BinaryNinja::HighLevelILInstructionBase::As

(

)

inline

◆ AsOneOperand() [1/2]

HighLevelILOneOperandInstruction & BinaryNinja::HighLevelILInstructionBase::AsOneOperand

(

)

inline

◆ AsTwoOperand() [1/2]

HighLevelILTwoOperandInstruction & BinaryNinja::HighLevelILInstructionBase::AsTwoOperand

(

)

inline

◆ AsTwoOperandWithCarry() [1/2]

HighLevelILTwoOperandWithCarryInstruction & BinaryNinja::HighLevelILInstructionBase::AsTwoOperandWithCarry

(

)

inline

◆ As() [2/2]

const HighLevelILInstructionAccessor< N > & BinaryNinja::HighLevelILInstructionBase::As

(

)

const

inline

◆ AsConstant()

const HighLevelILConstantInstruction & BinaryNinja::HighLevelILInstructionBase::AsConstant

(

)

const

inline

◆ AsConstantData()

const HighLevelILConstantDataInstruction & BinaryNinja::HighLevelILInstructionBase::AsConstantData

(

)

const

inline

◆ AsOneOperand() [2/2]

const HighLevelILOneOperandInstruction & BinaryNinja::HighLevelILInstructionBase::AsOneOperand

(

)

const

inline

◆ AsTwoOperand() [2/2]

const HighLevelILTwoOperandInstruction & BinaryNinja::HighLevelILInstructionBase::AsTwoOperand

(

)

const

inline

◆ AsTwoOperandWithCarry() [2/2]

const HighLevelILTwoOperandWithCarryInstruction & BinaryNinja::HighLevelILInstructionBase::AsTwoOperandWithCarry

(

)

const

inline

◆ function

Ref<HighLevelILFunction> BinaryNinja::HighLevelILInstructionBase::function = nullptr

◆ exprIndex

size_t BinaryNinja::HighLevelILInstructionBase::exprIndex

◆ instructionIndex

size_t BinaryNinja::HighLevelILInstructionBase::instructionIndex

◆ ast

bool BinaryNinja::HighLevelILInstructionBase::ast

◆ operandTypeForUsage

unordered_map< HighLevelILOperandUsage, HighLevelILOperandType > HighLevelILInstructionBase::operandTypeForUsage

static

◆ operationOperandUsage

◆ operationOperandIndex

unordered_map< BNHighLevelILOperation, unordered_map< HighLevelILOperandUsage, size_t > > HighLevelILInstructionBase::operationOperandIndex = GetOperandIndexForOperandUsages()

static

◆ BinaryNinja::HighLevelILInstruction

struct BinaryNinja::HighLevelILInstruction

Public Member Functions
	HighLevelILInstruction ()
	HighLevelILInstruction (HighLevelILFunction *func, const BNHighLevelILInstruction &instr, size_t expr, bool asFullAst, size_t instructionIndex)
	HighLevelILInstruction (const HighLevelILInstructionBase &instr)
void	CollectSubExprs (std::stack< size_t > &toProcess) const
void	VisitExprs (const std::function< bool(const HighLevelILInstruction &expr)> &func) const
void	VisitExprs (const std::function< bool(const HighLevelILInstruction &expr)> &preFunc, const std::function< void(const HighLevelILInstruction &expr)> &postFunc) const
ExprId	CopyTo (HighLevelILFunction *dest) const
ExprId	CopyTo (HighLevelILFunction *dest, const std::function< ExprId(const HighLevelILInstruction &subExpr)> &subExprHandler) const
bool	operator< (const HighLevelILInstruction &other) const
bool	operator== (const HighLevelILInstruction &other) const
bool	operator!= (const HighLevelILInstruction &other) const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetSourceExpr () const
template<BNHighLevelILOperation N>
Variable	GetVariable () const
template<BNHighLevelILOperation N>
Variable	GetDestVariable () const
template<BNHighLevelILOperation N>
SSAVariable	GetSSAVariable () const
template<BNHighLevelILOperation N>
SSAVariable	GetDestSSAVariable () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetDestExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetLeftExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetRightExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetCarryExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetIndexExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetConditionPhiExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetConditionExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetTrueExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetFalseExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetLoopExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetInitExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetUpdateExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetDefaultExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetHighExpr () const
template<BNHighLevelILOperation N>
HighLevelILInstruction	GetLowExpr () const
template<BNHighLevelILOperation N>
uint64_t	GetOffset () const
template<BNHighLevelILOperation N>
size_t	GetMemberIndex () const
template<BNHighLevelILOperation N>
int64_t	GetConstant () const
template<BNHighLevelILOperation N>
ConstantData	GetConstantData () const
template<BNHighLevelILOperation N>
int64_t	GetVector () const
template<BNHighLevelILOperation N>
uint32_t	GetIntrinsic () const
template<BNHighLevelILOperation N>
uint64_t	GetTarget () const
template<BNHighLevelILOperation N>
HighLevelILInstructionList	GetParameterExprs () const
template<BNHighLevelILOperation N>
HighLevelILInstructionList	GetSourceExprs () const
template<BNHighLevelILOperation N>
HighLevelILInstructionList	GetDestExprs () const
template<BNHighLevelILOperation N>
HighLevelILInstructionList	GetBlockExprs () const
template<BNHighLevelILOperation N>
HighLevelILInstructionList	GetCases () const
template<BNHighLevelILOperation N>
HighLevelILInstructionList	GetValueExprs () const
template<BNHighLevelILOperation N>
HighLevelILSSAVariableList	GetSourceSSAVariables () const
template<BNHighLevelILOperation N>
size_t	GetSourceMemoryVersion () const
template<BNHighLevelILOperation N>
HighLevelILIndexList	GetSourceMemoryVersions () const
template<BNHighLevelILOperation N>
size_t	GetDestMemoryVersion () const
template<BNHighLevelILOperation N>
PossibleValueSet	GetConstraint () const
template<BNHighLevelILOperation N>
void	SetSSAVersion (size_t version)
template<BNHighLevelILOperation N>
void	SetDestSSAVersion (size_t version)
template<BNHighLevelILOperation N>
void	SetParameterExprs (const std::vector< MediumLevelILInstruction > &params)
template<BNHighLevelILOperation N>
void	SetParameterExprs (const std::vector< ExprId > &params)
template<BNHighLevelILOperation N>
void	SetSourceExprs (const std::vector< MediumLevelILInstruction > &params)
template<BNHighLevelILOperation N>
void	SetSourceExprs (const std::vector< ExprId > &params)
template<BNHighLevelILOperation N>
void	SetDestExprs (const std::vector< MediumLevelILInstruction > &params)
template<BNHighLevelILOperation N>
void	SetDestExprs (const std::vector< ExprId > &params)
template<BNHighLevelILOperation N>
void	SetBlockExprs (const std::vector< MediumLevelILInstruction > &params)
template<BNHighLevelILOperation N>
void	SetBlockExprs (const std::vector< ExprId > &params)
template<BNHighLevelILOperation N>
void	SetCases (const std::vector< MediumLevelILInstruction > &params)
template<BNHighLevelILOperation N>
void	SetCases (const std::vector< ExprId > &params)
template<BNHighLevelILOperation N>
void	SetSourceSSAVariables (const std::vector< SSAVariable > &vars)
template<BNHighLevelILOperation N>
void	SetSourceMemoryVersion (size_t version)
template<BNHighLevelILOperation N>
void	SetDestMemoryVersion (size_t version)
template<BNHighLevelILOperation N>
void	SetTarget (uint64_t target)
bool	GetOperandIndexForUsage (HighLevelILOperandUsage usage, size_t &operandIndex) const
HighLevelILInstruction	GetSourceExpr () const
Variable	GetVariable () const
Variable	GetDestVariable () const
SSAVariable	GetSSAVariable () const
SSAVariable	GetDestSSAVariable () const
HighLevelILInstruction	GetDestExpr () const
HighLevelILInstruction	GetLeftExpr () const
HighLevelILInstruction	GetRightExpr () const
HighLevelILInstruction	GetCarryExpr () const
HighLevelILInstruction	GetIndexExpr () const
HighLevelILInstruction	GetConditionExpr () const
HighLevelILInstruction	GetConditionPhiExpr () const
HighLevelILInstruction	GetTrueExpr () const
HighLevelILInstruction	GetFalseExpr () const
HighLevelILInstruction	GetLoopExpr () const
HighLevelILInstruction	GetInitExpr () const
HighLevelILInstruction	GetUpdateExpr () const
HighLevelILInstruction	GetDefaultExpr () const
HighLevelILInstruction	GetHighExpr () const
HighLevelILInstruction	GetLowExpr () const
uint64_t	GetOffset () const
size_t	GetMemberIndex () const
int64_t	GetConstant () const
ConstantData	GetConstantData () const
int64_t	GetVector () const
uint32_t	GetIntrinsic () const
uint64_t	GetTarget () const
HighLevelILInstructionList	GetParameterExprs () const
HighLevelILInstructionList	GetSourceExprs () const
HighLevelILInstructionList	GetDestExprs () const
HighLevelILInstructionList	GetBlockExprs () const
HighLevelILInstructionList	GetCases () const
HighLevelILInstructionList	GetValueExprs () const
HighLevelILSSAVariableList	GetSourceSSAVariables () const
size_t	GetSourceMemoryVersion () const
HighLevelILIndexList	GetSourceMemoryVersions () const
size_t	GetDestMemoryVersion () const
Public Member Functions inherited from BinaryNinja::HighLevelILInstructionBase
HighLevelILOperandList	GetOperands () const
uint64_t	GetRawOperandAsInteger (size_t operand) const
ConstantData	GetRawOperandAsConstantData (size_t operand) const
size_t	GetRawOperandAsIndex (size_t operand) const
HighLevelILInstruction	GetRawOperandAsExpr (size_t operand) const
Variable	GetRawOperandAsVariable (size_t operand) const
SSAVariable	GetRawOperandAsSSAVariable (size_t operand) const
HighLevelILInstructionList	GetRawOperandAsExprList (size_t operand) const
HighLevelILSSAVariableList	GetRawOperandAsSSAVariableList (size_t operand) const
HighLevelILIndexList	GetRawOperandAsIndexList (size_t operand) const
PossibleValueSet	GetRawOperandAsPossibleValueSet (size_t operand) const
void	UpdateRawOperand (size_t operandIndex, ExprId value)
void	UpdateRawOperandAsInteger (size_t operandIndex, uint64_t value)
void	UpdateRawOperandAsSSAVariableList (size_t operandIndex, const std::vector< SSAVariable > &vars)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< HighLevelILInstruction > &exprs)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< size_t > &exprs)
RegisterValue	GetValue () const
PossibleValueSet	GetPossibleValues (const std::set< BNDataFlowQueryOption > &options=std::set< BNDataFlowQueryOption >()) const
Confidence< Ref< Type > >	GetType () const
size_t	GetSSAExprIndex () const
size_t	GetNonSSAExprIndex () const
HighLevelILInstruction	GetSSAForm () const
HighLevelILInstruction	GetNonSSAForm () const
size_t	GetMediumLevelILExprIndex () const
bool	HasMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelILSSAForm () const
char *	Dump () const
void	Replace (ExprId expr)
void	SetAttributes (uint32_t attributes)
void	SetAttribute (BNILInstructionAttribute attribute, bool state=true)
void	ClearAttribute (BNILInstructionAttribute attribute)
std::optional< DerivedString >	GetDerivedStringReference () const
void	SetDerivedStringReference (const DerivedString &str)
void	RemoveDerivedStringReference ()
size_t	GetInstructionIndex () const
HighLevelILInstruction	GetInstruction () const
HighLevelILInstruction	AsAST () const
HighLevelILInstruction	AsNonAST () const
bool	HasParent () const
HighLevelILInstruction	GetParent () const
uint64_t	GetInstructionHash (size_t discriminator=0) const
template<BNHighLevelILOperation N>
HighLevelILInstructionAccessor< N > &	As ()
HighLevelILOneOperandInstruction &	AsOneOperand ()
HighLevelILTwoOperandInstruction &	AsTwoOperand ()
HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry ()
template<BNHighLevelILOperation N>
const HighLevelILInstructionAccessor< N > &	As () const
const HighLevelILConstantInstruction &	AsConstant () const
const HighLevelILConstantDataInstruction &	AsConstantData () const
const HighLevelILOneOperandInstruction &	AsOneOperand () const
const HighLevelILTwoOperandInstruction &	AsTwoOperand () const
const HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry () const
Static Public Member Functions
static bool	CanCollapse (int operand)

Additional Inherited Members
Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
Ref< HighLevelILFunction >	function = nullptr
size_t	exprIndex
size_t	instructionIndex
bool	ast
Public Attributes inherited from BNHighLevelILInstruction
BNHighLevelILOperation	operation
uint32_t	attributes
uint32_t	sourceOperand
size_t	size
uint64_t	operands [5]
uint64_t	address
size_t	parent
Static Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
static std::unordered_map< HighLevelILOperandUsage, HighLevelILOperandType >	operandTypeForUsage
static std::unordered_map< BNHighLevelILOperation, std::vector< HighLevelILOperandUsage > >	operationOperandUsage
static std::unordered_map< BNHighLevelILOperation, std::unordered_map< HighLevelILOperandUsage, size_t > >	operationOperandIndex = GetOperandIndexForOperandUsages()

◆ HighLevelILInstruction() [1/3]

HighLevelILInstruction::HighLevelILInstruction

(

)

◆ HighLevelILInstruction() [2/3]

HighLevelILInstruction::HighLevelILInstruction	(	HighLevelILFunction *	func,
		const BNHighLevelILInstruction &	instr,
		size_t	expr,
		bool	asFullAst,
		size_t	instructionIndex )

◆ HighLevelILInstruction() [3/3]

HighLevelILInstruction::HighLevelILInstruction

(

const HighLevelILInstructionBase &

instr

)

◆ CollectSubExprs()

void HighLevelILInstruction::CollectSubExprs

(

std::stack< size_t > &

toProcess

)

const

◆ VisitExprs() [1/2]

void HighLevelILInstruction::VisitExprs

(

const std::function< bool(const HighLevelILInstruction &expr)> &

func

)

const

◆ VisitExprs() [2/2]

void HighLevelILInstruction::VisitExprs	(	const std::function< bool(const HighLevelILInstruction &expr)> &	preFunc,
		const std::function< void(const HighLevelILInstruction &expr)> &	postFunc ) const

◆ CopyTo() [1/2]

ExprId HighLevelILInstruction::CopyTo

(

HighLevelILFunction *

dest

)

const

◆ CopyTo() [2/2]

ExprId HighLevelILInstruction::CopyTo	(	HighLevelILFunction *	dest,
		const std::function< ExprId(const HighLevelILInstruction &subExpr)> &	subExprHandler ) const

◆ operator<()

bool HighLevelILInstruction::operator<

(

const HighLevelILInstruction &

other

)

const

◆ operator==()

bool HighLevelILInstruction::operator==

(

const HighLevelILInstruction &

other

)

const

◆ operator!=()

bool HighLevelILInstruction::operator!=

(

const HighLevelILInstruction &

other

)

const

◆ GetSourceExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetSourceExpr

(

)

const

inline

◆ GetVariable() [1/2]

Variable BinaryNinja::HighLevelILInstruction::GetVariable

(

)

const

inline

◆ GetDestVariable() [1/2]

Variable BinaryNinja::HighLevelILInstruction::GetDestVariable

(

)

const

inline

◆ GetSSAVariable() [1/2]

SSAVariable BinaryNinja::HighLevelILInstruction::GetSSAVariable

(

)

const

inline

◆ GetDestSSAVariable() [1/2]

SSAVariable BinaryNinja::HighLevelILInstruction::GetDestSSAVariable

(

)

const

inline

◆ GetDestExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetDestExpr

(

)

const

inline

◆ GetLeftExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetLeftExpr

(

)

const

inline

◆ GetRightExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetRightExpr

(

)

const

inline

◆ GetCarryExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetCarryExpr

(

)

const

inline

◆ GetIndexExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetIndexExpr

(

)

const

inline

◆ GetConditionPhiExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetConditionPhiExpr

(

)

const

inline

◆ GetConditionExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetConditionExpr

(

)

const

inline

◆ GetTrueExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetTrueExpr

(

)

const

inline

◆ GetFalseExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetFalseExpr

(

)

const

inline

◆ GetLoopExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetLoopExpr

(

)

const

inline

◆ GetInitExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetInitExpr

(

)

const

inline

◆ GetUpdateExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetUpdateExpr

(

)

const

inline

◆ GetDefaultExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetDefaultExpr

(

)

const

inline

◆ GetHighExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetHighExpr

(

)

const

inline

◆ GetLowExpr() [1/2]

HighLevelILInstruction BinaryNinja::HighLevelILInstruction::GetLowExpr

(

)

const

inline

◆ GetOffset() [1/2]

uint64_t BinaryNinja::HighLevelILInstruction::GetOffset

(

)

const

inline

◆ GetMemberIndex() [1/2]

size_t BinaryNinja::HighLevelILInstruction::GetMemberIndex

(

)

const

inline

◆ GetConstant() [1/2]

int64_t BinaryNinja::HighLevelILInstruction::GetConstant

(

)

const

inline

◆ GetConstantData() [1/2]

ConstantData BinaryNinja::HighLevelILInstruction::GetConstantData

(

)

const

inline

◆ GetVector() [1/2]

int64_t BinaryNinja::HighLevelILInstruction::GetVector

(

)

const

inline

◆ GetIntrinsic() [1/2]

uint32_t BinaryNinja::HighLevelILInstruction::GetIntrinsic

(

)

const

inline

◆ GetTarget() [1/2]

uint64_t BinaryNinja::HighLevelILInstruction::GetTarget

(

)

const

inline

◆ GetParameterExprs() [1/2]

HighLevelILInstructionList BinaryNinja::HighLevelILInstruction::GetParameterExprs

(

)

const

inline

◆ GetSourceExprs() [1/2]

HighLevelILInstructionList BinaryNinja::HighLevelILInstruction::GetSourceExprs

(

)

const

inline

◆ GetDestExprs() [1/2]

HighLevelILInstructionList BinaryNinja::HighLevelILInstruction::GetDestExprs

(

)

const

inline

◆ GetBlockExprs() [1/2]

HighLevelILInstructionList BinaryNinja::HighLevelILInstruction::GetBlockExprs

(

)

const

inline

◆ GetCases() [1/2]

HighLevelILInstructionList BinaryNinja::HighLevelILInstruction::GetCases

(

)

const

inline

◆ GetValueExprs() [1/2]

HighLevelILInstructionList BinaryNinja::HighLevelILInstruction::GetValueExprs

(

)

const

inline

◆ GetSourceSSAVariables() [1/2]

HighLevelILSSAVariableList BinaryNinja::HighLevelILInstruction::GetSourceSSAVariables

(

)

const

inline

◆ GetSourceMemoryVersion() [1/2]

size_t BinaryNinja::HighLevelILInstruction::GetSourceMemoryVersion

(

)

const

inline

◆ GetSourceMemoryVersions() [1/2]

HighLevelILIndexList BinaryNinja::HighLevelILInstruction::GetSourceMemoryVersions

(

)

const

inline

◆ GetDestMemoryVersion() [1/2]

size_t BinaryNinja::HighLevelILInstruction::GetDestMemoryVersion

(

)

const

inline

◆ GetConstraint()

PossibleValueSet BinaryNinja::HighLevelILInstruction::GetConstraint

(

)

const

inline

◆ SetSSAVersion()

void BinaryNinja::HighLevelILInstruction::SetSSAVersion

(

size_t

version

)

inline

◆ SetDestSSAVersion()

void BinaryNinja::HighLevelILInstruction::SetDestSSAVersion

(

size_t

version

)

inline

◆ SetParameterExprs() [1/2]

void BinaryNinja::HighLevelILInstruction::SetParameterExprs

(

const std::vector< MediumLevelILInstruction > &

params

)

inline

◆ SetParameterExprs() [2/2]

void BinaryNinja::HighLevelILInstruction::SetParameterExprs

(

const std::vector< ExprId > &

params

)

inline

◆ SetSourceExprs() [1/2]

void BinaryNinja::HighLevelILInstruction::SetSourceExprs

(

const std::vector< MediumLevelILInstruction > &

params

)

inline

◆ SetSourceExprs() [2/2]

void BinaryNinja::HighLevelILInstruction::SetSourceExprs

(

const std::vector< ExprId > &

params

)

inline

◆ SetDestExprs() [1/2]

◆ SetDestExprs() [2/2]

void BinaryNinja::HighLevelILInstruction::SetDestExprs

(

const std::vector< ExprId > &

params

)

inline

◆ SetBlockExprs() [1/2]

void BinaryNinja::HighLevelILInstruction::SetBlockExprs

(

const std::vector< MediumLevelILInstruction > &

params

)

inline

◆ SetBlockExprs() [2/2]

void BinaryNinja::HighLevelILInstruction::SetBlockExprs

(

const std::vector< ExprId > &

params

)

inline

◆ SetCases() [1/2]

◆ SetCases() [2/2]

void BinaryNinja::HighLevelILInstruction::SetCases

(

const std::vector< ExprId > &

params

)

inline

◆ SetSourceSSAVariables()

void BinaryNinja::HighLevelILInstruction::SetSourceSSAVariables

(

const std::vector< SSAVariable > &

vars

)

inline

◆ SetSourceMemoryVersion()

void BinaryNinja::HighLevelILInstruction::SetSourceMemoryVersion

(

size_t

version

)

inline

◆ SetDestMemoryVersion()

void BinaryNinja::HighLevelILInstruction::SetDestMemoryVersion

(

size_t

version

)

inline

◆ SetTarget()

void BinaryNinja::HighLevelILInstruction::SetTarget

(

uint64_t

target

)

inline

◆ GetOperandIndexForUsage()

bool HighLevelILInstruction::GetOperandIndexForUsage	(	HighLevelILOperandUsage	usage,
		size_t &	operandIndex ) const

◆ GetSourceExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetSourceExpr

(

)

const

◆ GetVariable() [2/2]

Variable HighLevelILInstruction::GetVariable

(

)

const

◆ GetDestVariable() [2/2]

Variable HighLevelILInstruction::GetDestVariable

(

)

const

◆ GetSSAVariable() [2/2]

SSAVariable HighLevelILInstruction::GetSSAVariable

(

)

const

◆ GetDestSSAVariable() [2/2]

SSAVariable HighLevelILInstruction::GetDestSSAVariable

(

)

const

◆ GetDestExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetDestExpr

(

)

const

◆ GetLeftExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetLeftExpr

(

)

const

◆ GetRightExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetRightExpr

(

)

const

◆ GetCarryExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetCarryExpr

(

)

const

◆ GetIndexExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetIndexExpr

(

)

const

◆ GetConditionExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetConditionExpr

(

)

const

◆ GetConditionPhiExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetConditionPhiExpr

(

)

const

◆ GetTrueExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetTrueExpr

(

)

const

◆ GetFalseExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetFalseExpr

(

)

const

◆ GetLoopExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetLoopExpr

(

)

const

◆ GetInitExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetInitExpr

(

)

const

◆ GetUpdateExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetUpdateExpr

(

)

const

◆ GetDefaultExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetDefaultExpr

(

)

const

◆ GetHighExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetHighExpr

(

)

const

◆ GetLowExpr() [2/2]

HighLevelILInstruction HighLevelILInstruction::GetLowExpr

(

)

const

◆ GetOffset() [2/2]

uint64_t HighLevelILInstruction::GetOffset

(

)

const

◆ GetMemberIndex() [2/2]

size_t HighLevelILInstruction::GetMemberIndex

(

)

const

◆ GetConstant() [2/2]

int64_t HighLevelILInstruction::GetConstant

(

)

const

◆ GetConstantData() [2/2]

ConstantData HighLevelILInstruction::GetConstantData

(

)

const

◆ GetVector() [2/2]

int64_t HighLevelILInstruction::GetVector

(

)

const

◆ GetIntrinsic() [2/2]

uint32_t HighLevelILInstruction::GetIntrinsic

(

)

const

◆ GetTarget() [2/2]

uint64_t HighLevelILInstruction::GetTarget

(

)

const

◆ GetParameterExprs() [2/2]

HighLevelILInstructionList HighLevelILInstruction::GetParameterExprs

(

)

const

◆ GetSourceExprs() [2/2]

HighLevelILInstructionList HighLevelILInstruction::GetSourceExprs

(

)

const

◆ GetDestExprs() [2/2]

HighLevelILInstructionList HighLevelILInstruction::GetDestExprs

(

)

const

◆ GetBlockExprs() [2/2]

HighLevelILInstructionList HighLevelILInstruction::GetBlockExprs

(

)

const

◆ GetCases() [2/2]

HighLevelILInstructionList HighLevelILInstruction::GetCases

(

)

const

◆ GetValueExprs() [2/2]

HighLevelILInstructionList HighLevelILInstruction::GetValueExprs

(

)

const

◆ GetSourceSSAVariables() [2/2]

HighLevelILSSAVariableList HighLevelILInstruction::GetSourceSSAVariables

(

)

const

◆ GetSourceMemoryVersion() [2/2]

size_t HighLevelILInstruction::GetSourceMemoryVersion

(

)

const

◆ GetSourceMemoryVersions() [2/2]

HighLevelILIndexList HighLevelILInstruction::GetSourceMemoryVersions

(

)

const

◆ GetDestMemoryVersion() [2/2]

size_t HighLevelILInstruction::GetDestMemoryVersion

(

)

const

◆ CanCollapse()

bool HighLevelILInstruction::CanCollapse

(

int

operand

)

static

◆ BinaryNinja::HighLevelILOperand

class BinaryNinja::HighLevelILOperand

Public Member Functions
	HighLevelILOperand (const HighLevelILInstruction &instr, HighLevelILOperandUsage usage, size_t operandIndex)
HighLevelILOperandType	GetType () const
HighLevelILOperandUsage	GetUsage () const
uint64_t	GetInteger () const
ConstantData	GetConstantData () const
size_t	GetIndex () const
uint32_t	GetIntrinsic () const
HighLevelILInstruction	GetExpr () const
Variable	GetVariable () const
SSAVariable	GetSSAVariable () const
HighLevelILInstructionList	GetExprList () const
HighLevelILSSAVariableList	GetSSAVariableList () const
HighLevelILIndexList	GetIndexList () const

◆ HighLevelILOperand()

HighLevelILOperand::HighLevelILOperand	(	const HighLevelILInstruction &	instr,
		HighLevelILOperandUsage	usage,
		size_t	operandIndex )

◆ GetType()

HighLevelILOperandType BinaryNinja::HighLevelILOperand::GetType

(

)

const

inline

◆ GetUsage()

HighLevelILOperandUsage BinaryNinja::HighLevelILOperand::GetUsage

(

)

const

inline

◆ GetInteger()

uint64_t HighLevelILOperand::GetInteger

(

)

const

◆ GetConstantData()

◆ GetIndex()

size_t HighLevelILOperand::GetIndex

(

)

const

◆ GetIntrinsic()

uint32_t HighLevelILOperand::GetIntrinsic

(

)

const

◆ GetExpr()

HighLevelILInstruction HighLevelILOperand::GetExpr

(

)

const

◆ GetVariable()

Variable HighLevelILOperand::GetVariable

(

)

const

◆ GetSSAVariable()

SSAVariable HighLevelILOperand::GetSSAVariable

(

)

const

◆ GetExprList()

HighLevelILInstructionList HighLevelILOperand::GetExprList

(

)

const

◆ GetSSAVariableList()

HighLevelILSSAVariableList HighLevelILOperand::GetSSAVariableList

(

)

const

◆ GetIndexList()

HighLevelILIndexList HighLevelILOperand::GetIndexList

(

)

const

◆ BinaryNinja::HighLevelILOperandList

class BinaryNinja::HighLevelILOperandList

Public Types
typedef ListIterator	const_iterator
Public Member Functions
	HighLevelILOperandList (const HighLevelILInstruction &instr, const std::vector< HighLevelILOperandUsage > &usageList, const std::unordered_map< HighLevelILOperandUsage, size_t > &operandIndexMap)
const_iterator	begin () const
const_iterator	end () const
size_t	size () const
const HighLevelILOperand	operator[] (size_t i) const
	operator std::vector< HighLevelILOperand > () const

◆ const_iterator

◆ HighLevelILOperandList()

HighLevelILOperandList::HighLevelILOperandList	(	const HighLevelILInstruction &	instr,
		const std::vector< HighLevelILOperandUsage > &	usageList,
		const std::unordered_map< HighLevelILOperandUsage, size_t > &	operandIndexMap )

◆ begin()

HighLevelILOperandList::const_iterator HighLevelILOperandList::begin

(

)

const

◆ end()

HighLevelILOperandList::const_iterator HighLevelILOperandList::end

(

)

const

◆ size()

size_t HighLevelILOperandList::size

(

)

const

◆ operator[]()

const HighLevelILOperand HighLevelILOperandList::operator[]

(

size_t

)

const

◆ operator std::vector< HighLevelILOperand >()

BinaryNinja::HighLevelILOperandList::operator std::vector< HighLevelILOperand >

(

)

const

◆ BinaryNinja::HighLevelILConstantInstruction

struct BinaryNinja::HighLevelILConstantInstruction

Public Member Functions
int64_t	GetConstant () const
Public Member Functions inherited from BinaryNinja::HighLevelILInstructionBase
HighLevelILOperandList	GetOperands () const
uint64_t	GetRawOperandAsInteger (size_t operand) const
ConstantData	GetRawOperandAsConstantData (size_t operand) const
size_t	GetRawOperandAsIndex (size_t operand) const
HighLevelILInstruction	GetRawOperandAsExpr (size_t operand) const
Variable	GetRawOperandAsVariable (size_t operand) const
SSAVariable	GetRawOperandAsSSAVariable (size_t operand) const
HighLevelILInstructionList	GetRawOperandAsExprList (size_t operand) const
HighLevelILSSAVariableList	GetRawOperandAsSSAVariableList (size_t operand) const
HighLevelILIndexList	GetRawOperandAsIndexList (size_t operand) const
PossibleValueSet	GetRawOperandAsPossibleValueSet (size_t operand) const
void	UpdateRawOperand (size_t operandIndex, ExprId value)
void	UpdateRawOperandAsInteger (size_t operandIndex, uint64_t value)
void	UpdateRawOperandAsSSAVariableList (size_t operandIndex, const std::vector< SSAVariable > &vars)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< HighLevelILInstruction > &exprs)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< size_t > &exprs)
RegisterValue	GetValue () const
PossibleValueSet	GetPossibleValues (const std::set< BNDataFlowQueryOption > &options=std::set< BNDataFlowQueryOption >()) const
Confidence< Ref< Type > >	GetType () const
size_t	GetSSAExprIndex () const
size_t	GetNonSSAExprIndex () const
HighLevelILInstruction	GetSSAForm () const
HighLevelILInstruction	GetNonSSAForm () const
size_t	GetMediumLevelILExprIndex () const
bool	HasMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelILSSAForm () const
char *	Dump () const
void	Replace (ExprId expr)
void	SetAttributes (uint32_t attributes)
void	SetAttribute (BNILInstructionAttribute attribute, bool state=true)
void	ClearAttribute (BNILInstructionAttribute attribute)
std::optional< DerivedString >	GetDerivedStringReference () const
void	SetDerivedStringReference (const DerivedString &str)
void	RemoveDerivedStringReference ()
size_t	GetInstructionIndex () const
HighLevelILInstruction	GetInstruction () const
HighLevelILInstruction	AsAST () const
HighLevelILInstruction	AsNonAST () const
bool	HasParent () const
HighLevelILInstruction	GetParent () const
uint64_t	GetInstructionHash (size_t discriminator=0) const
template<BNHighLevelILOperation N>
HighLevelILInstructionAccessor< N > &	As ()
HighLevelILOneOperandInstruction &	AsOneOperand ()
HighLevelILTwoOperandInstruction &	AsTwoOperand ()
HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry ()
template<BNHighLevelILOperation N>
const HighLevelILInstructionAccessor< N > &	As () const
const HighLevelILConstantInstruction &	AsConstant () const
const HighLevelILConstantDataInstruction &	AsConstantData () const
const HighLevelILOneOperandInstruction &	AsOneOperand () const
const HighLevelILTwoOperandInstruction &	AsTwoOperand () const
const HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry () const

Additional Inherited Members
Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
Ref< HighLevelILFunction >	function = nullptr
size_t	exprIndex
size_t	instructionIndex
bool	ast
Public Attributes inherited from BNHighLevelILInstruction
BNHighLevelILOperation	operation
uint32_t	attributes
uint32_t	sourceOperand
size_t	size
uint64_t	operands [5]
uint64_t	address
size_t	parent
Static Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
static std::unordered_map< HighLevelILOperandUsage, HighLevelILOperandType >	operandTypeForUsage
static std::unordered_map< BNHighLevelILOperation, std::vector< HighLevelILOperandUsage > >	operationOperandUsage
static std::unordered_map< BNHighLevelILOperation, std::unordered_map< HighLevelILOperandUsage, size_t > >	operationOperandIndex = GetOperandIndexForOperandUsages()

◆ GetConstant()

int64_t BinaryNinja::HighLevelILConstantInstruction::GetConstant

(

)

const

inline

◆ BinaryNinja::HighLevelILConstantDataInstruction

struct BinaryNinja::HighLevelILConstantDataInstruction

Public Member Functions
ConstantData	GetConstantData () const
Public Member Functions inherited from BinaryNinja::HighLevelILInstructionBase
HighLevelILOperandList	GetOperands () const
uint64_t	GetRawOperandAsInteger (size_t operand) const
ConstantData	GetRawOperandAsConstantData (size_t operand) const
size_t	GetRawOperandAsIndex (size_t operand) const
HighLevelILInstruction	GetRawOperandAsExpr (size_t operand) const
Variable	GetRawOperandAsVariable (size_t operand) const
SSAVariable	GetRawOperandAsSSAVariable (size_t operand) const
HighLevelILInstructionList	GetRawOperandAsExprList (size_t operand) const
HighLevelILSSAVariableList	GetRawOperandAsSSAVariableList (size_t operand) const
HighLevelILIndexList	GetRawOperandAsIndexList (size_t operand) const
PossibleValueSet	GetRawOperandAsPossibleValueSet (size_t operand) const
void	UpdateRawOperand (size_t operandIndex, ExprId value)
void	UpdateRawOperandAsInteger (size_t operandIndex, uint64_t value)
void	UpdateRawOperandAsSSAVariableList (size_t operandIndex, const std::vector< SSAVariable > &vars)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< HighLevelILInstruction > &exprs)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< size_t > &exprs)
RegisterValue	GetValue () const
PossibleValueSet	GetPossibleValues (const std::set< BNDataFlowQueryOption > &options=std::set< BNDataFlowQueryOption >()) const
Confidence< Ref< Type > >	GetType () const
size_t	GetSSAExprIndex () const
size_t	GetNonSSAExprIndex () const
HighLevelILInstruction	GetSSAForm () const
HighLevelILInstruction	GetNonSSAForm () const
size_t	GetMediumLevelILExprIndex () const
bool	HasMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelILSSAForm () const
char *	Dump () const
void	Replace (ExprId expr)
void	SetAttributes (uint32_t attributes)
void	SetAttribute (BNILInstructionAttribute attribute, bool state=true)
void	ClearAttribute (BNILInstructionAttribute attribute)
std::optional< DerivedString >	GetDerivedStringReference () const
void	SetDerivedStringReference (const DerivedString &str)
void	RemoveDerivedStringReference ()
size_t	GetInstructionIndex () const
HighLevelILInstruction	GetInstruction () const
HighLevelILInstruction	AsAST () const
HighLevelILInstruction	AsNonAST () const
bool	HasParent () const
HighLevelILInstruction	GetParent () const
uint64_t	GetInstructionHash (size_t discriminator=0) const
template<BNHighLevelILOperation N>
HighLevelILInstructionAccessor< N > &	As ()
HighLevelILOneOperandInstruction &	AsOneOperand ()
HighLevelILTwoOperandInstruction &	AsTwoOperand ()
HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry ()
template<BNHighLevelILOperation N>
const HighLevelILInstructionAccessor< N > &	As () const
const HighLevelILConstantInstruction &	AsConstant () const
const HighLevelILConstantDataInstruction &	AsConstantData () const
const HighLevelILOneOperandInstruction &	AsOneOperand () const
const HighLevelILTwoOperandInstruction &	AsTwoOperand () const
const HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry () const

Additional Inherited Members
Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
Ref< HighLevelILFunction >	function = nullptr
size_t	exprIndex
size_t	instructionIndex
bool	ast
Public Attributes inherited from BNHighLevelILInstruction
BNHighLevelILOperation	operation
uint32_t	attributes
uint32_t	sourceOperand
size_t	size
uint64_t	operands [5]
uint64_t	address
size_t	parent
Static Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
static std::unordered_map< HighLevelILOperandUsage, HighLevelILOperandType >	operandTypeForUsage
static std::unordered_map< BNHighLevelILOperation, std::vector< HighLevelILOperandUsage > >	operationOperandUsage
static std::unordered_map< BNHighLevelILOperation, std::unordered_map< HighLevelILOperandUsage, size_t > >	operationOperandIndex = GetOperandIndexForOperandUsages()

◆ GetConstantData()

ConstantData BinaryNinja::HighLevelILConstantDataInstruction::GetConstantData

(

)

const

inline

◆ BinaryNinja::HighLevelILOneOperandInstruction

struct BinaryNinja::HighLevelILOneOperandInstruction

Public Member Functions
HighLevelILInstruction	GetSourceExpr () const
Public Member Functions inherited from BinaryNinja::HighLevelILInstructionBase
HighLevelILOperandList	GetOperands () const
uint64_t	GetRawOperandAsInteger (size_t operand) const
ConstantData	GetRawOperandAsConstantData (size_t operand) const
size_t	GetRawOperandAsIndex (size_t operand) const
HighLevelILInstruction	GetRawOperandAsExpr (size_t operand) const
Variable	GetRawOperandAsVariable (size_t operand) const
SSAVariable	GetRawOperandAsSSAVariable (size_t operand) const
HighLevelILInstructionList	GetRawOperandAsExprList (size_t operand) const
HighLevelILSSAVariableList	GetRawOperandAsSSAVariableList (size_t operand) const
HighLevelILIndexList	GetRawOperandAsIndexList (size_t operand) const
PossibleValueSet	GetRawOperandAsPossibleValueSet (size_t operand) const
void	UpdateRawOperand (size_t operandIndex, ExprId value)
void	UpdateRawOperandAsInteger (size_t operandIndex, uint64_t value)
void	UpdateRawOperandAsSSAVariableList (size_t operandIndex, const std::vector< SSAVariable > &vars)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< HighLevelILInstruction > &exprs)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< size_t > &exprs)
RegisterValue	GetValue () const
PossibleValueSet	GetPossibleValues (const std::set< BNDataFlowQueryOption > &options=std::set< BNDataFlowQueryOption >()) const
Confidence< Ref< Type > >	GetType () const
size_t	GetSSAExprIndex () const
size_t	GetNonSSAExprIndex () const
HighLevelILInstruction	GetSSAForm () const
HighLevelILInstruction	GetNonSSAForm () const
size_t	GetMediumLevelILExprIndex () const
bool	HasMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelILSSAForm () const
char *	Dump () const
void	Replace (ExprId expr)
void	SetAttributes (uint32_t attributes)
void	SetAttribute (BNILInstructionAttribute attribute, bool state=true)
void	ClearAttribute (BNILInstructionAttribute attribute)
std::optional< DerivedString >	GetDerivedStringReference () const
void	SetDerivedStringReference (const DerivedString &str)
void	RemoveDerivedStringReference ()
size_t	GetInstructionIndex () const
HighLevelILInstruction	GetInstruction () const
HighLevelILInstruction	AsAST () const
HighLevelILInstruction	AsNonAST () const
bool	HasParent () const
HighLevelILInstruction	GetParent () const
uint64_t	GetInstructionHash (size_t discriminator=0) const
template<BNHighLevelILOperation N>
HighLevelILInstructionAccessor< N > &	As ()
HighLevelILOneOperandInstruction &	AsOneOperand ()
HighLevelILTwoOperandInstruction &	AsTwoOperand ()
HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry ()
template<BNHighLevelILOperation N>
const HighLevelILInstructionAccessor< N > &	As () const
const HighLevelILConstantInstruction &	AsConstant () const
const HighLevelILConstantDataInstruction &	AsConstantData () const
const HighLevelILOneOperandInstruction &	AsOneOperand () const
const HighLevelILTwoOperandInstruction &	AsTwoOperand () const
const HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry () const

Additional Inherited Members
Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
Ref< HighLevelILFunction >	function = nullptr
size_t	exprIndex
size_t	instructionIndex
bool	ast
Public Attributes inherited from BNHighLevelILInstruction
BNHighLevelILOperation	operation
uint32_t	attributes
uint32_t	sourceOperand
size_t	size
uint64_t	operands [5]
uint64_t	address
size_t	parent
Static Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
static std::unordered_map< HighLevelILOperandUsage, HighLevelILOperandType >	operandTypeForUsage
static std::unordered_map< BNHighLevelILOperation, std::vector< HighLevelILOperandUsage > >	operationOperandUsage
static std::unordered_map< BNHighLevelILOperation, std::unordered_map< HighLevelILOperandUsage, size_t > >	operationOperandIndex = GetOperandIndexForOperandUsages()

◆ GetSourceExpr()

HighLevelILInstruction BinaryNinja::HighLevelILOneOperandInstruction::GetSourceExpr

(

)

const

inline

◆ BinaryNinja::HighLevelILTwoOperandInstruction

struct BinaryNinja::HighLevelILTwoOperandInstruction

Public Member Functions
HighLevelILInstruction	GetLeftExpr () const
HighLevelILInstruction	GetRightExpr () const
Public Member Functions inherited from BinaryNinja::HighLevelILInstructionBase
HighLevelILOperandList	GetOperands () const
uint64_t	GetRawOperandAsInteger (size_t operand) const
ConstantData	GetRawOperandAsConstantData (size_t operand) const
size_t	GetRawOperandAsIndex (size_t operand) const
HighLevelILInstruction	GetRawOperandAsExpr (size_t operand) const
Variable	GetRawOperandAsVariable (size_t operand) const
SSAVariable	GetRawOperandAsSSAVariable (size_t operand) const
HighLevelILInstructionList	GetRawOperandAsExprList (size_t operand) const
HighLevelILSSAVariableList	GetRawOperandAsSSAVariableList (size_t operand) const
HighLevelILIndexList	GetRawOperandAsIndexList (size_t operand) const
PossibleValueSet	GetRawOperandAsPossibleValueSet (size_t operand) const
void	UpdateRawOperand (size_t operandIndex, ExprId value)
void	UpdateRawOperandAsInteger (size_t operandIndex, uint64_t value)
void	UpdateRawOperandAsSSAVariableList (size_t operandIndex, const std::vector< SSAVariable > &vars)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< HighLevelILInstruction > &exprs)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< size_t > &exprs)
RegisterValue	GetValue () const
PossibleValueSet	GetPossibleValues (const std::set< BNDataFlowQueryOption > &options=std::set< BNDataFlowQueryOption >()) const
Confidence< Ref< Type > >	GetType () const
size_t	GetSSAExprIndex () const
size_t	GetNonSSAExprIndex () const
HighLevelILInstruction	GetSSAForm () const
HighLevelILInstruction	GetNonSSAForm () const
size_t	GetMediumLevelILExprIndex () const
bool	HasMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelILSSAForm () const
char *	Dump () const
void	Replace (ExprId expr)
void	SetAttributes (uint32_t attributes)
void	SetAttribute (BNILInstructionAttribute attribute, bool state=true)
void	ClearAttribute (BNILInstructionAttribute attribute)
std::optional< DerivedString >	GetDerivedStringReference () const
void	SetDerivedStringReference (const DerivedString &str)
void	RemoveDerivedStringReference ()
size_t	GetInstructionIndex () const
HighLevelILInstruction	GetInstruction () const
HighLevelILInstruction	AsAST () const
HighLevelILInstruction	AsNonAST () const
bool	HasParent () const
HighLevelILInstruction	GetParent () const
uint64_t	GetInstructionHash (size_t discriminator=0) const
template<BNHighLevelILOperation N>
HighLevelILInstructionAccessor< N > &	As ()
HighLevelILOneOperandInstruction &	AsOneOperand ()
HighLevelILTwoOperandInstruction &	AsTwoOperand ()
HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry ()
template<BNHighLevelILOperation N>
const HighLevelILInstructionAccessor< N > &	As () const
const HighLevelILConstantInstruction &	AsConstant () const
const HighLevelILConstantDataInstruction &	AsConstantData () const
const HighLevelILOneOperandInstruction &	AsOneOperand () const
const HighLevelILTwoOperandInstruction &	AsTwoOperand () const
const HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry () const

Additional Inherited Members
Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
Ref< HighLevelILFunction >	function = nullptr
size_t	exprIndex
size_t	instructionIndex
bool	ast
Public Attributes inherited from BNHighLevelILInstruction
BNHighLevelILOperation	operation
uint32_t	attributes
uint32_t	sourceOperand
size_t	size
uint64_t	operands [5]
uint64_t	address
size_t	parent
Static Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
static std::unordered_map< HighLevelILOperandUsage, HighLevelILOperandType >	operandTypeForUsage
static std::unordered_map< BNHighLevelILOperation, std::vector< HighLevelILOperandUsage > >	operationOperandUsage
static std::unordered_map< BNHighLevelILOperation, std::unordered_map< HighLevelILOperandUsage, size_t > >	operationOperandIndex = GetOperandIndexForOperandUsages()

◆ GetLeftExpr()

HighLevelILInstruction BinaryNinja::HighLevelILTwoOperandInstruction::GetLeftExpr

(

)

const

inline

◆ GetRightExpr()

HighLevelILInstruction BinaryNinja::HighLevelILTwoOperandInstruction::GetRightExpr

(

)

const

inline

◆ BinaryNinja::HighLevelILTwoOperandWithCarryInstruction

struct BinaryNinja::HighLevelILTwoOperandWithCarryInstruction

Public Member Functions
HighLevelILInstruction	GetLeftExpr () const
HighLevelILInstruction	GetRightExpr () const
HighLevelILInstruction	GetCarryExpr () const
Public Member Functions inherited from BinaryNinja::HighLevelILInstructionBase
HighLevelILOperandList	GetOperands () const
uint64_t	GetRawOperandAsInteger (size_t operand) const
ConstantData	GetRawOperandAsConstantData (size_t operand) const
size_t	GetRawOperandAsIndex (size_t operand) const
HighLevelILInstruction	GetRawOperandAsExpr (size_t operand) const
Variable	GetRawOperandAsVariable (size_t operand) const
SSAVariable	GetRawOperandAsSSAVariable (size_t operand) const
HighLevelILInstructionList	GetRawOperandAsExprList (size_t operand) const
HighLevelILSSAVariableList	GetRawOperandAsSSAVariableList (size_t operand) const
HighLevelILIndexList	GetRawOperandAsIndexList (size_t operand) const
PossibleValueSet	GetRawOperandAsPossibleValueSet (size_t operand) const
void	UpdateRawOperand (size_t operandIndex, ExprId value)
void	UpdateRawOperandAsInteger (size_t operandIndex, uint64_t value)
void	UpdateRawOperandAsSSAVariableList (size_t operandIndex, const std::vector< SSAVariable > &vars)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< HighLevelILInstruction > &exprs)
void	UpdateRawOperandAsExprList (size_t operandIndex, const std::vector< size_t > &exprs)
RegisterValue	GetValue () const
PossibleValueSet	GetPossibleValues (const std::set< BNDataFlowQueryOption > &options=std::set< BNDataFlowQueryOption >()) const
Confidence< Ref< Type > >	GetType () const
size_t	GetSSAExprIndex () const
size_t	GetNonSSAExprIndex () const
HighLevelILInstruction	GetSSAForm () const
HighLevelILInstruction	GetNonSSAForm () const
size_t	GetMediumLevelILExprIndex () const
bool	HasMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelIL () const
MediumLevelILInstruction	GetMediumLevelILSSAForm () const
char *	Dump () const
void	Replace (ExprId expr)
void	SetAttributes (uint32_t attributes)
void	SetAttribute (BNILInstructionAttribute attribute, bool state=true)
void	ClearAttribute (BNILInstructionAttribute attribute)
std::optional< DerivedString >	GetDerivedStringReference () const
void	SetDerivedStringReference (const DerivedString &str)
void	RemoveDerivedStringReference ()
size_t	GetInstructionIndex () const
HighLevelILInstruction	GetInstruction () const
HighLevelILInstruction	AsAST () const
HighLevelILInstruction	AsNonAST () const
bool	HasParent () const
HighLevelILInstruction	GetParent () const
uint64_t	GetInstructionHash (size_t discriminator=0) const
template<BNHighLevelILOperation N>
HighLevelILInstructionAccessor< N > &	As ()
HighLevelILOneOperandInstruction &	AsOneOperand ()
HighLevelILTwoOperandInstruction &	AsTwoOperand ()
HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry ()
template<BNHighLevelILOperation N>
const HighLevelILInstructionAccessor< N > &	As () const
const HighLevelILConstantInstruction &	AsConstant () const
const HighLevelILConstantDataInstruction &	AsConstantData () const
const HighLevelILOneOperandInstruction &	AsOneOperand () const
const HighLevelILTwoOperandInstruction &	AsTwoOperand () const
const HighLevelILTwoOperandWithCarryInstruction &	AsTwoOperandWithCarry () const

Additional Inherited Members
Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
Ref< HighLevelILFunction >	function = nullptr
size_t	exprIndex
size_t	instructionIndex
bool	ast
Public Attributes inherited from BNHighLevelILInstruction
BNHighLevelILOperation	operation
uint32_t	attributes
uint32_t	sourceOperand
size_t	size
uint64_t	operands [5]
uint64_t	address
size_t	parent
Static Public Attributes inherited from BinaryNinja::HighLevelILInstructionBase
static std::unordered_map< HighLevelILOperandUsage, HighLevelILOperandType >	operandTypeForUsage
static std::unordered_map< BNHighLevelILOperation, std::vector< HighLevelILOperandUsage > >	operationOperandUsage
static std::unordered_map< BNHighLevelILOperation, std::unordered_map< HighLevelILOperandUsage, size_t > >	operationOperandIndex = GetOperandIndexForOperandUsages()

◆ GetLeftExpr()

HighLevelILInstruction BinaryNinja::HighLevelILTwoOperandWithCarryInstruction::GetLeftExpr

(

)

const

inline

◆ GetRightExpr()

HighLevelILInstruction BinaryNinja::HighLevelILTwoOperandWithCarryInstruction::GetRightExpr

(

)

const

inline

◆ GetCarryExpr()

HighLevelILInstruction BinaryNinja::HighLevelILTwoOperandWithCarryInstruction::GetCarryExpr

(

)

const

inline

◆ HighLevelILOperandType

Enumerator
IntegerHighLevelOperand
ConstantDataHighLevelOperand
IndexHighLevelOperand
IntrinsicHighLevelOperand
ExprHighLevelOperand
VariableHighLevelOperand
SSAVariableHighLevelOperand
ExprListHighLevelOperand
SSAVariableListHighLevelOperand
IndexListHighLevelOperand

◆ HighLevelILOperandUsage

Enumerator
SourceExprHighLevelOperandUsage
VariableHighLevelOperandUsage
DestVariableHighLevelOperandUsage
SSAVariableHighLevelOperandUsage
DestSSAVariableHighLevelOperandUsage
DestExprHighLevelOperandUsage
LeftExprHighLevelOperandUsage
RightExprHighLevelOperandUsage
CarryExprHighLevelOperandUsage
IndexExprHighLevelOperandUsage
ConditionExprHighLevelOperandUsage
ConditionPhiExprHighLevelOperandUsage
TrueExprHighLevelOperandUsage
FalseExprHighLevelOperandUsage
LoopExprHighLevelOperandUsage
InitExprHighLevelOperandUsage
UpdateExprHighLevelOperandUsage
DefaultExprHighLevelOperandUsage
HighExprHighLevelOperandUsage
LowExprHighLevelOperandUsage
OffsetHighLevelOperandUsage
MemberIndexHighLevelOperandUsage
ConstantHighLevelOperandUsage
ConstantDataHighLevelOperandUsage
VectorHighLevelOperandUsage
IntrinsicHighLevelOperandUsage
TargetHighLevelOperandUsage
ParameterExprsHighLevelOperandUsage
SourceExprsHighLevelOperandUsage
DestExprsHighLevelOperandUsage
BlockExprsHighLevelOperandUsage
CasesHighLevelOperandUsage
ValueExprsHighLevelOperandUsage
SourceSSAVariablesHighLevelOperandUsage
SourceMemoryVersionHighLevelOperandUsage
SourceMemoryVersionsHighLevelOperandUsage
DestMemoryVersionHighLevelOperandUsage

Classes

Enumerations

◆ BinaryNinja::HighLevelILFunction

Public Member Functions

Static Public Member Functions

◆ HighLevelILFunction() [1/2]

◆ HighLevelILFunction() [2/2]

◆ GetFunction()

◆ GetArchitecture()

◆ GetCurrentAddress()

◆ SetCurrentAddress()

◆ GetRootExpr()

◆ SetRootExpr() [1/2]

◆ SetRootExpr() [2/2]

◆ CachePossibleValueSet()

◆ GetCachedPossibleValueSet()

◆ AddExpr()

◆ AddExprWithLocation() [1/2]

◆ AddExprWithLocation() [2/2]

◆ Nop()

◆ Block()

◆ If()

◆ While()

◆ WhileSSA()

◆ DoWhile()

◆ DoWhileSSA()

◆ For()

◆ ForSSA()

◆ Switch()

◆ Case()

◆ Break()

◆ Continue()

◆ Jump()

◆ Return()

◆ NoReturn()

◆ Unreachable()

◆ Goto()

◆ Label()

◆ VarDeclare()

◆ VarInit()

◆ VarInitSSA()

◆ Assign()

◆ AssignUnpack()

◆ AssignMemSSA()

◆ AssignUnpackMemSSA()

◆ ForceVer()

◆ ForceVerSSA()

◆ Assert()

◆ AssertSSA()

◆ Var()

◆ VarSSA()

◆ VarPhi()

◆ MemPhi()

◆ StructField()

◆ ArrayIndex()

◆ ArrayIndexSSA()

◆ Split()

◆ Deref()

◆ DerefField()

◆ DerefSSA()

◆ DerefFieldSSA()

◆ AddressOf()

◆ Const()

◆ ConstPointer()

◆ ExternPointer()

◆ FloatConstRaw()

◆ FloatConstSingle()

◆ FloatConstDouble()

◆ ImportedAddress()

◆ ConstData()

◆ Add()

◆ AddWithCarry()

◆ Sub()

◆ SubWithBorrow()

◆ And()

◆ Or()

◆ Xor()

◆ ShiftLeft()

◆ LogicalShiftRight()

◆ ArithShiftRight()