binaryninja.function.Function

class binaryninja.function.Function(view, handle)[source]
__init__(view, handle)[source]

Methods

__init__(view, handle)
apply_auto_discovered_type(func_type)
apply_imported_types(sym)
create_auto_stack_var(offset, var_type, name)
create_auto_var(var, var_type, name[, ...])
create_graph()
create_user_stack_var(offset, var_type, name)
create_user_var(var, var_type, name[, ...])
delete_auto_stack_var(offset)
delete_auto_var(var)
delete_user_stack_var(offset)
delete_user_var(var)
get_basic_block_at(addr[, arch]) get_basic_block_at returns the BasicBlock of the optionally specified Architecture arch at the given
get_block_annotations(addr[, arch])
get_comment_at(addr)
get_constants_referenced_by(addr[, arch])
get_flags_read_by_lifted_il_instruction(i)
get_flags_written_by_lifted_il_instruction(i)
get_indirect_branches_at(addr[, arch])
get_instr_highlight(addr[, arch])
Example:
get_int_display_type(instr_addr, value, operand)
get_lifted_il_at(addr[, arch])
get_lifted_il_flag_definitions_for_use(i, flag)
get_lifted_il_flag_uses_for_definition(i, flag)
get_low_level_il_at(addr[, arch]) get_low_level_il_at gets the LowLevelILInstruction corresponding to the given virtual address
get_low_level_il_exits_at(addr[, arch])
get_parameter_at(addr, func_type, i[, arch])
get_parameter_at_low_level_il_instruction(...)
get_reg_value_after(addr, reg[, arch]) get_reg_value_after gets the value instruction address corresponding to the given virtual address
get_reg_value_at(addr, reg[, arch]) get_reg_value_at gets the value the provided string register address corresponding to the given virtual address
get_regs_read_by(addr[, arch])
get_regs_written_by(addr[, arch])
get_stack_contents_after(addr, offset, size)
get_stack_contents_at(addr, offset, size[, arch]) get_stack_contents_at returns the RegisterValue for the item on the stack in the current function at the
get_stack_var_at_frame_offset(offset, addr)
get_stack_vars_referenced_by(addr[, arch])
mark_recent_use()
reanalyze() reanalyze causes this functions to be reanalyzed. This function does not wait for the analysis to finish.
release_advanced_analysis_data()
request_advanced_analysis_data()
set_auto_indirect_branches(source, branches)
set_auto_instr_highlight(addr, color[, arch]) set_auto_instr_highlight highlights the instruction at the specified address with the supplied color
set_auto_type(value)
set_comment(addr, comment)
set_default_session_data(name, value)
set_int_display_type(instr_addr, value, ...)
param int instr_addr:
 
set_user_indirect_branches(source, branches)
set_user_instr_highlight(addr, color[, arch]) set_user_instr_highlight highlights the instruction at the specified address with the supplied color
set_user_type(value)

Attributes

analysis_performance_info
arch Function architecture (read-only)
auto Whether function was automatically discovered (read-only)
basic_blocks List of basic blocks (read-only)
can_return Whether function can return (read-only)
comments Dict of comments (read-only)
explicitly_defined_type Whether function has explicitly defined types (read-only)
function_type Function type object
indirect_branches List of indirect branches (read-only)
lifted_il returns LowLevelILFunction used to represent lifted IL (read-only)
low_level_il returns LowLevelILFunction used to represent Function low level IL (read-only)
medium_level_il Function medium level IL (read-only)
name Symbol name for the function
needs_update Whether the function has analysis that needs to be updated (read-only)
platform Function platform (read-only)
session_data Dictionary object where plugins can store arbitrary data associated with the function
stack_layout List of function stack variables (read-only)
start Function start (read-only)
symbol Function symbol(read-only)
vars List of function variables (read-only)
view Function view (read-only)