warp.warp module¶

Class	Description
`binaryninja.warp.warp.BasicBlockGUID`
`binaryninja.warp.warp.ConstraintGUID`
`binaryninja.warp.warp.FunctionGUID`
`binaryninja.warp.warp.Source`
`binaryninja.warp.warp.TypeGUID`
`binaryninja.warp.warp.WarpConstraint`
`binaryninja.warp.warp.WarpContainer`
`binaryninja.warp.warp.WarpContainerResponse`
`binaryninja.warp.warp.WarpContainerSearchItem`
`binaryninja.warp.warp.WarpContainerSearchQuery`
`binaryninja.warp.warp.WarpFunction`
`binaryninja.warp.warp.WarpFunctionComment`
`binaryninja.warp.warp.WarpTarget`
`binaryninja.warp.warp.WarpUUID`

Function	Description
`binaryninja.warp.warp.get_basic_block_guid`
`binaryninja.warp.warp.get_function_guid`
`binaryninja.warp.warp.is_instruction_blacklisted`
`binaryninja.warp.warp.is_instruction_computed_variant`	Checks to see if the instruction is variant due to some computed value. Must use LLIL.
`binaryninja.warp.warp.is_instruction_variant`
`binaryninja.warp.warp.run_matcher`

BasicBlockGUID¶

class BasicBlockGUID[source]¶: Bases: WarpUUID

ConstraintGUID¶

class ConstraintGUID[source]¶: Bases: WarpUUID

FunctionGUID¶

class FunctionGUID[source]¶: Bases: WarpUUID

Source¶

class Source[source]¶: Bases: WarpUUID

TypeGUID¶

class TypeGUID[source]¶: Bases: WarpUUID

WarpConstraint¶

class WarpConstraint[source]¶

Bases: object

WarpConstraint(guid: binaryninja.warp.warp.ConstraintGUID, offset: Optional[int])

__init__(guid: ConstraintGUID, offset: int | None) → None¶

Parameters:

guid (ConstraintGUID) –
offset (int | None) –

Return type:

None

static from_api(constraint: BNWARPConstraint) → WarpConstraint[source]¶

Parameters:: constraint (BNWARPConstraint) –
Return type:: WarpConstraint

guid: ConstraintGUID¶

offset: int | None¶

WarpContainer¶

class WarpContainer[source]¶

Bases: object

__init__(handle: BNWARPContainer)[source]¶

Parameters:: handle (BNWARPContainer) –

add_functions(target: WarpTarget, source: Source, functions: List[Function]) → bool[source]¶

Parameters:

target (WarpTarget) –
source (Source) –
functions (List[Function]) –

Return type:

bool

add_source(source_path: str) → Source | None[source]¶

Parameters:: source_path (str) –
Return type:: Source | None

add_types(view: BinaryView, source: Source, types: List[Type]) → bool[source]¶

Parameters:

view (BinaryView) –
source (Source) –
types (List[Type]) –

Return type:

bool

static all() → List[WarpContainer][source]¶

Return type:: List[WarpContainer]

static by_name(name: str) → WarpContainer | None[source]¶

Parameters:: name (str) –
Return type:: WarpContainer | None

commit_source(source: Source) → bool[source]¶

Parameters:: source (Source) –
Return type:: bool

fetch_functions(target: WarpTarget, guids: List[FunctionGUID], source_tags: List[str] | None = None)[source]¶

Parameters:

target (WarpTarget) –
guids (List[FunctionGUID]) –
source_tags (List[str] | None) –

get_functions_with_guid(target: WarpTarget, source: Source, guid: FunctionGUID) → List[Function][source]¶

Parameters:

target (WarpTarget) –
source (Source) –
guid (FunctionGUID) –

Return type:

List[Function]

get_source_path(source: Source) → str | None[source]¶

Parameters:: source (Source) –
Return type:: str | None

get_sources_with_function_guid(target: WarpTarget, guid: FunctionGUID) → List[Source][source]¶

Parameters:

target (WarpTarget) –
guid (FunctionGUID) –

Return type:

List[Source]

get_sources_with_type_guid(guid: TypeGUID) → List[Source][source]¶

Parameters:: guid (TypeGUID) –
Return type:: List[Source]

get_type_guids_with_name(source: Source, name: str) → List[TypeGUID][source]¶

Parameters:

source (Source) –
name (str) –

Return type:

List[TypeGUID]

get_type_with_guid(arch: Architecture, source: Source, guid: TypeGUID) → Type | None[source]¶

Parameters:

arch (Architecture) –
source (Source) –
guid (TypeGUID) –

Return type:

Type | None

is_source_uncommitted(source: Source) → bool[source]¶

Parameters:: source (Source) –
Return type:: bool

is_source_writable(source: Source) → bool[source]¶

Parameters:: source (Source) –
Return type:: bool

remove_functions(target: WarpTarget, source: Source, functions: List[Function]) → bool[source]¶

Parameters:

target (WarpTarget) –
source (Source) –
functions (List[Function]) –

Return type:

bool

remove_types(source: Source, guids: List[TypeGUID]) → bool[source]¶

Parameters:

source (Source) –
guids (List[TypeGUID]) –

Return type:

bool

search(query: WarpContainerSearchQuery) → WarpContainerResponse | None[source]¶

Parameters:: query (WarpContainerSearchQuery) –
Return type:: WarpContainerResponse | None

property name: str¶

property sources: List[Source]¶

WarpContainerResponse¶

class WarpContainerResponse[source]¶

Bases: object

__init__(items: List[WarpContainerSearchItem], offset: int, total: int)[source]¶

Parameters:

items (List[WarpContainerSearchItem]) –
offset (int) –
total (int) –

static from_api(response: BNWARPContainerSearchResponse) → WarpContainerResponse[source]¶

Parameters:: response (BNWARPContainerSearchResponse) –
Return type:: WarpContainerResponse

WarpContainerSearchItem¶

class WarpContainerSearchItem[source]¶

Bases: object

__init__(handle: BNWARPContainerSearchItem)[source]¶

Parameters:: handle (BNWARPContainerSearchItem) –

get_type(arch: Architecture) → Type | None[source]¶

Parameters:: arch (Architecture) –
Return type:: Type | None

property function: WarpFunction | None¶

property kind: WARPContainerSearchItemKind¶

property name: str¶

property source: Source¶

WarpContainerSearchQuery¶

class WarpContainerSearchQuery[source]¶

Bases: object

__init__(query: str, offset: int | None = None, limit: int | None = None, source: Source | None = None, source_tags: List[str] | None = None)[source]¶