platform module

binaryninja.platform.CorePlatform(handle)
binaryninja.platform.Platform([arch, handle])	class Platform contains all information related to the execution environment of the binary, mainly the calling conventions used.

class CorePlatform(handle: BNPlatform)

Bases: Platform

Parameters:

handle (BNPlatform) –

adjust_type_parser_input(parser: TypeParser, arguments: List[str], source_files: List[Tuple[str, str]]) → Tuple[List[str], List[Tuple[str, str]]]

Modify the arguments passed to the Type Parser with Platform-specific features.

Parameters:

• parser (TypeParser) – Type Parser instance

• arguments (List[str]) – Default arguments passed to the parser

• source_files (List[Tuple[str, str]]) – Source file names and contents

Returns:

A tuple of (modified arguments, modified source files)

Return type:

Tuple[List[str], List[Tuple[str, str]]]

class Platform(arch: Architecture | None = None, handle=None)

Bases: object

class Platform contains all information related to the execution environment of the binary, mainly the calling conventions used.

Parameters:

arch (Architecture | None) –

add_related_platform(arch, platform)

adjust_type_parser_input(parser: TypeParser, arguments: List[str], source_files: List[Tuple[str, str]]) → Tuple[List[str], List[Tuple[str, str]]]

Modify the arguments passed to the Type Parser with Platform-specific features.

Parameters:

• parser (TypeParser) – Type Parser instance

• arguments (List[str]) – Default arguments passed to the parser

• source_files (List[Tuple[str, str]]) – Source file names and contents

Returns:

A tuple of (modified arguments, modified source files)

Return type:

Tuple[List[str], List[Tuple[str, str]]]

generate_auto_platform_type_id(name)

generate_auto_platform_type_ref(type_class, name)

get_associated_platform_by_address(addr)

get_auto_platform_type_id_source()

get_function_by_name(name, exactMatch=False)

get_global_register_type(reg: architecture.RegisterType)

Parameters:

reg (architecture.RegisterType) –

classmethod get_list(os=None, arch=None)

get_related_platform(arch)

get_related_platforms() → List[Platform]

get_related_platforms returns a list of all related platforms for a given platform

Returns:

Return type:

List[Platform]

get_system_call_name(number)

get_system_call_type(number)

get_type_by_name(name)

get_type_libraries_by_name(name) → List[TypeLibrary]

Return type:

List[TypeLibrary]

get_variable_by_name(name)

parse_types_from_source(source, filename=None, include_dirs: List[str] | None = None, auto_type_source=None)

parse_types_from_source parses the source string and any needed headers searching for them in the optional list of directories provided in include_dirs. Note that this API does not allow the source to rely on existing types that only exist in a specific view. Use BinaryView.parse_type_string instead.

Parameters:

• source (str) – source string to be parsed

• filename (str) – optional source filename

• include_dirs (list(str)) – optional list of string filename include directories

• auto_type_source (str) – optional source of types if used for automatically generated types

Returns:

BasicTypeParserResult (a SyntaxError is thrown on parse error)

Return type:

BasicTypeParserResult

Example:

>>> platform.parse_types_from_source('int foo;\nint bar(int x);\nstruct bas{int x,y;};\n')
({types: {'bas': <type: struct bas>}, variables: {'foo': <type: int32_t>}, functions:{'bar':
<type: int32_t(int32_t x)>}}, '')
>>>

parse_types_from_source_file(filename, include_dirs: List[str] | None = None, auto_type_source=None)

parse_types_from_source_file parses the source file filename and any needed headers searching for them in the optional list of directories provided in include_dirs. Note that this API does not allow the source to rely on existing types that only exist in a specific view. Use BinaryView.parse_type_string instead.

Parameters:

• filename (str) – filename of file to be parsed

• include_dirs (list(str)) – optional list of string filename include directories

• auto_type_source (str) – optional source of types if used for automatically generated types

Returns:

BasicTypeParserResult (a SyntaxError is thrown on parse error)

Return type:

BasicTypeParserResult

Example:

>>> file = "/Users/binja/tmp.c"
>>> open(file).read()
'int foo;\nint bar(int x);\nstruct bas{int x,y;};\n'
>>> platform.parse_types_from_source_file(file)
({types: {'bas': <type: struct bas>}, variables: {'foo': <type: int32_t>}, functions:
{'bar': <type: int32_t(int32_t x)>}}, '')
>>>

register(os)

register registers the platform for given OS name.

Parameters:

os (str) – OS name to register

Return type:

None

register_calling_convention(cc)

register_calling_convention register a new calling convention.

Parameters:

cc (CallingConvention) – a CallingConvention object to register

Return type:

None

view_init(view)

property arch

property calling_conventions

List of platform CallingConvention objects (read-only)

Getter:

returns the list of supported CallingConvention objects

Type:

list(CallingConvention)

property cdecl_calling_convention

CallingConvention object for the cdecl calling convention

property default_calling_convention

Default calling convention.

Getter:

returns a CallingConvention object for the default calling convention.

Setter:

sets the default calling convention

Type:

CallingConvention

property fastcall_calling_convention

CallingConvention object for the fastcall calling convention

property functions

List of platform-specific function definitions (read-only)

global_reg_types = {}

global_regs = []

property name: str

class property os_list: List[str]

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

property stdcall_calling_convention

CallingConvention object for the stdcall calling convention

property system_call_convention

CallingConvention object for the system call convention

property system_calls

List of system calls for this platform (read-only)

property type_container: TypeContainer

Type Container for all registered types in the Platform. :return: Platform types Type Container

type_file_path = None

type_include_dirs = []

property type_libraries: List[TypeLibrary]

property types

List of platform-specific types (read-only)

property variables

List of platform-specific variable definitions (read-only)