B2R2


RegisterBay Type

RegisterBay provides a useful interface for accessing register information in a platform-agnostic manner.

Constructors

Constructor Description

RegisterBay()

Full Usage: RegisterBay()

Returns: RegisterBay
Returns: RegisterBay

Instance members

Instance member Description

this.FramePointer

Full Usage: this.FramePointer

Returns: RegisterID option
Modifiers: abstract

Return a frame pointer register for a given BinHandle.

Returns: RegisterID option

this.GetAllRegExprs()

Full Usage: this.GetAllRegExprs()

Returns: Expr list
Modifiers: abstract

Return all register expressions.

Returns: Expr list

this.GetAllRegNames()

Full Usage: this.GetAllRegNames()

Returns: string list
Modifiers: abstract

Return all register names.

Returns: string list

this.GetGeneralRegExprs()

Full Usage: this.GetGeneralRegExprs()

Returns: Expr list
Modifiers: abstract

Return all general register expressions excluding FPU registers, vector registers, etc.

Returns: Expr list

this.GetRegisterAliases(arg1)

Full Usage: this.GetRegisterAliases(arg1)

Parameters:
Returns: RegisterID[]
Modifiers: abstract

Return an array of aliases of a given register based on the current architecture of BinHandle.

arg0 : RegisterID
Returns: RegisterID[]

this.IsFramePointer(arg1)

Full Usage: this.IsFramePointer(arg1)

Parameters:
Returns: bool
Modifiers: abstract

Check if the given RegisterID represents a frame pointer.

arg0 : RegisterID
Returns: bool

this.IsProgramCounter(arg1)

Full Usage: this.IsProgramCounter(arg1)

Parameters:
Returns: bool
Modifiers: abstract

Check if the given RegisterID represents PC.

arg0 : RegisterID
Returns: bool

this.IsStackPointer(arg1)

Full Usage: this.IsStackPointer(arg1)

Parameters:
Returns: bool
Modifiers: abstract

Check if the given RegisterID represents a stack pointer.

arg0 : RegisterID
Returns: bool

this.ProgramCounter

Full Usage: this.ProgramCounter

Returns: RegisterID
Modifiers: abstract

Return a program counter register for a given BinHandle.

Returns: RegisterID

this.RegIDFromRegExpr(arg1)

Full Usage: this.RegIDFromRegExpr(arg1)

Parameters:
Returns: RegisterID
Modifiers: abstract

Return RegID from a given RegExpr.

arg0 : Expr
Returns: RegisterID

this.RegIDFromString(arg1)

Full Usage: this.RegIDFromString(arg1)

Parameters:
    arg0 : string

Returns: RegisterID
Modifiers: abstract

Return RegisterID from a given register string. Depending on the underlying architecture of the BinHandle, we may have different RegisterID.

arg0 : string
Returns: RegisterID

this.RegIDToRegExpr(arg1)

Full Usage: this.RegIDToRegExpr(arg1)

Parameters:
Returns: Expr
Modifiers: abstract

Return RegExpr from a given RegID.

arg0 : RegisterID
Returns: Expr

this.RegIDToRegType(arg1)

Full Usage: this.RegIDToRegType(arg1)

Parameters:
Returns: RegType
Modifiers: abstract

Return a RegType from a given RegisterID.

arg0 : RegisterID
Returns: RegType

this.RegIDToString(arg1)

Full Usage: this.RegIDToString(arg1)

Parameters:
Returns: string
Modifiers: abstract

Return a register string from a given RegisterID. Depending on the underlying architecture of the BinHandle, we may have a different string result.

arg0 : RegisterID
Returns: string

this.RegTypeFromRegExpr(e)

Full Usage: this.RegTypeFromRegExpr(e)

Parameters:
Returns: RegType

Return RegType from a given RegExpr.

e : Expr
Returns: RegType

this.StackPointer

Full Usage: this.StackPointer

Returns: RegisterID option
Modifiers: abstract

Return a stack pointer register for a given BinHandle.

Returns: RegisterID option

this.StrToRegExpr(arg1)

Full Usage: this.StrToRegExpr(arg1)

Parameters:
    arg0 : string

Returns: Expr
Modifiers: abstract

Return RegExpr from a string.

arg0 : string
Returns: Expr