angr.analyses.decompiler.structured_codegen¶

class angr.analyses.decompiler.structured_codegen.BaseStructuredCodeGenerator

Bases: object

__init__(flavor=None, notes=None, expr_comments=None, stmt_comments=None, const_formats=None)

map_ast_to_pos: dict[SimVariable, set[PositionMappingElement]] | None

expr_comments: dict[int, str]

stmt_comments: dict[int, str]

const_formats: dict[tuple[int, int, str], dict[str, bool]]

version: str

timestamp: int

ident_counters: dict[str, count]

static adjust_mapping_positions(offset, pos_to_node, pos_to_addr, addr_to_pos)

Adjust positions in the mappings to account for the notes that are prepended to the text.

Parameters:

offset (int) – The length of the notes to prepend.
pos_to_node (PositionMapping) – The position to node mapping.
pos_to_addr (PositionMapping) – The position to address mapping.
addr_to_pos (InstructionMapping) – The address to position mapping.

Return type:

tuple[PositionMapping, PositionMapping, InstructionMapping]

Returns:

Adjusted mappings.

reapply_options(options)

regenerate_text()

Return type:: None

reload_variable_types()

Return type:: None

next_ident(key)

Return type:: str
Parameters:: key (str)

reset_ident_counters()

Return type:: None

next_node_idx()

Return type:: int

class angr.analyses.decompiler.structured_codegen.BinaryOpNode: Bases: CodegenNode

class angr.analyses.decompiler.structured_codegen.CStructuredCodeGenerator

Bases: BaseStructuredCodeGenerator, Analysis, Serializable

__init__(func, sequence, indent=0, cfg=None, func_args=None, binop_depth_cutoff=16, show_casts=True, braces_on_own_lines=True, use_compound_assignments=True, show_local_types=True, comment_gotos=False, cstyle_null_cmp=True, flavor=None, stmt_comments=None, expr_comments=None, show_externs=True, externs=None, const_formats=None, show_demangled_name=True, show_disambiguated_name=True, ail_graph=None, simplify_else_scope=True, cstyle_ifs=True, omit_func_header=False, display_block_addrs=False, display_vvar_ids=False, min_data_addr=4194304, notes=None, display_notes=True, max_str_len=None, prettify_thiscall=False, cstyle_void_param=True, indent_size=4, variable_map=None, stl_accessor_calls=False, func_prototype=None)

Parameters:

func (Function)
func_args (list[SimVariable] | None)
binop_depth_cutoff (int)
min_data_addr (int)
display_notes (bool)
max_str_len (int | None)
prettify_thiscall (bool)
cstyle_void_param (bool)
indent_size (int)
variable_map (VariableMap | None)
stl_accessor_calls (bool)
func_prototype (SimTypeFunction | None)

ailexpr2cnode: dict[tuple[Expression, bool, bool], CExpression] | None

cnode2ailexpr: dict[CExpression, Expression] | None

map_ast_to_pos: dict[SimVariable, set[PositionMappingElement]] | None

map_addr_to_label: dict[tuple[int, int | None], CLabel]

cfunc: CFunction | None

cexterns: set[CVariable] | None

reapply_options(options)

cleanup(): Remove existing rendering results.

regenerate_text()

Re-render text and re-generate all sorts of mapping information.

Return type:: None

render_text(cfunc)

Return type:: RenderResult
Parameters:: cfunc (CFunction)

render_notes()

Render decompilation notes.

Return type:: str
Returns:: A string containing all notes.

reload_variable_types()

Return type:: None

default_simtype_from_bits(n, signed=True)

Return type:

SimType

Parameters:

n (int)
signed (bool)

variables_unify(v1, v2)

Return type:

bool

Parameters:

v1 (VirtualVariable)
v2 (VirtualVariable)

ERRNO_LOCATION_FUNCS = frozenset({'__errno', '__errno_location', '__error', '_errno'})¶: The libc functions that return &errno. errno is a macro that dereferences one of them, so it never survives into a binary as a symbol; what reaches decompilation is *(__errno_location()), which is both correct and unreadable.

class angr.analyses.decompiler.structured_codegen.CStructuredCodeWalker

Bases: object

handle(obj)

handle_default(obj)

handle_CFunction(obj)

handle_CStatements(obj)

handle_CWhileLoop(obj)

handle_CDoWhileLoop(obj)

handle_CForLoop(obj)

handle_CIfElse(obj)

handle_CIfBreak(obj)

handle_CSwitchCase(obj)

handle_CAssignment(obj)

handle_CExpressionStatement(obj)

handle_CFunctionCall(obj)

handle_CReturn(obj)

handle_CGoto(obj)

handle_CIndexedVariable(obj)

handle_CVariableField(obj)

handle_CUnaryOp(obj)

handle_CBinaryOp(obj)

handle_CTypeCast(obj)

handle_CITE(obj)

handle_CMultiStatementExpression(obj)

handle_CVectorConvert(obj)

handle_CVEXCCallExpression(obj)

handle_CDirtyExpression(obj)

class angr.analyses.decompiler.structured_codegen.ClosingObjectNode

Bases: CodegenNode

A closing bracket, brace, or parenthesis.

class angr.analyses.decompiler.structured_codegen.CodegenNode

Bases: object

Marker base of every structured-codegen node kind shared across flavors.

class angr.analyses.decompiler.structured_codegen.ConstantNode

Bases: CodegenNode

A constant; has value and reference_values.

class angr.analyses.decompiler.structured_codegen.DummyStructuredCodeGenerator

Bases: BaseStructuredCodeGenerator, Serializable

A dummy structured code generator that only stores user-specified information.

__init__(flavor, expr_comments=None, stmt_comments=None, configuration=None, const_formats=None)

Parameters:: flavor (str)

class angr.analyses.decompiler.structured_codegen.ExpressionNode: Bases: CodegenNode

class angr.analyses.decompiler.structured_codegen.FunctionCallNode

Bases: CodegenNode

A call; has callee_func (a Function or None) and callee_target.

class angr.analyses.decompiler.structured_codegen.FunctionNode

Bases: CodegenNode

The function being decompiled; has addr and name.

class angr.analyses.decompiler.structured_codegen.GoStructuredCodeGenerator

Bases: BaseStructuredCodeGenerator, Analysis, Serializable

__init__(func, sequence, indent=0, cfg=None, func_args=None, binop_depth_cutoff=16, show_casts=True, braces_on_own_lines=False, use_compound_assignments=True, show_local_types=True, comment_gotos=False, cstyle_null_cmp=True, flavor=None, stmt_comments=None, expr_comments=None, show_externs=True, externs=None, const_formats=None, show_demangled_name=True, show_disambiguated_name=True, ail_graph=None, simplify_else_scope=True, cstyle_ifs=True, omit_func_header=False, display_block_addrs=False, display_vvar_ids=False, min_data_addr=4194304, notes=None, display_notes=True, max_str_len=None, prettify_thiscall=False, cstyle_void_param=True, indent_size=4, variable_map=None, stl_accessor_calls=False)

Parameters:

func_args (list[SimVariable] | None)
binop_depth_cutoff (int)
min_data_addr (int)
display_notes (bool)
max_str_len (int | None)
prettify_thiscall (bool)
cstyle_void_param (bool)
indent_size (int)
variable_map (VariableMap | None)
stl_accessor_calls (bool)

reapply_options(options)

cleanup(): Remove existing rendering results.

regenerate_text()

Re-render text and re-generate all sorts of mapping information.

Return type:: None

render_text(cfunc)

Return type:: RenderResult
Parameters:: cfunc (GoFunction)

render_notes()

Render decompilation notes.

Return type:: str
Returns:: A string containing all notes.

reload_variable_types()

Return type:: None

default_simtype_from_bits(n, signed=True)

Return type:

SimType

Parameters:

n (int)
signed (bool)

variables_unify(v1, v2)

Return type:

bool

Parameters:

v1 (VirtualVariable)
v2 (VirtualVariable)

property map_ast_to_pos: dict[Any, set[PositionMappingElement]] | None

resolve_callee(addr)

The function at addr for a parsed call, the same object for every call to it.

Return type:: Function | None
Parameters:: addr (int)

class angr.analyses.decompiler.structured_codegen.ImportSourceCode

Bases: BaseStructuredCodeGenerator, Analysis

__init__(function, flavor='source', source_root=None, encoding='utf-8')

regenerate_text()

class angr.analyses.decompiler.structured_codegen.IndexedVariableNode: Bases: CodegenNode

class angr.analyses.decompiler.structured_codegen.InstructionMapping

Bases: object

__init__()

items()

values()

add_mapping(ins_addr, posmap_pos)

get_nearest_pos(ins_addr)

Return type:: int | None
Parameters:: ins_addr (int)

class angr.analyses.decompiler.structured_codegen.InstructionMappingElement

Bases: object

__init__(ins_addr, posmap_pos)

ins_addr: int

posmap_pos: int

class angr.analyses.decompiler.structured_codegen.LabelNode: Bases: CodegenNode

class angr.analyses.decompiler.structured_codegen.PositionMapping

Bases: object

DUPLICATION_CHECK = True¶

__init__()

items()

values()

add_mapping(start_pos, length, obj)

get_node(pos)

Parameters:: pos (int)

get_element(pos)

Return type:: PositionMappingElement | None
Parameters:: pos (int)

class angr.analyses.decompiler.structured_codegen.PositionMappingElement

Bases: object

__init__(start, length, obj)

start: int

length: int

obj

class angr.analyses.decompiler.structured_codegen.RustStructuredCodeGenerator

Bases: BaseStructuredCodeGenerator, Analysis

__init__(func, sequence, indent=0, cfg=None, func_args=None, binop_depth_cutoff=16, show_casts=True, braces_on_own_lines=False, use_compound_assignments=True, show_local_types=False, comment_gotos=False, cstyle_null_cmp=True, flavor=None, stmt_comments=None, expr_comments=None, show_externs=False, externs=None, const_formats=None, show_demangled_name=True, show_disambiguated_name=True, ail_graph=None, simplify_else_scope=True, cstyle_ifs=True, omit_func_header=False, display_block_addrs=False, display_vvar_ids=False, min_data_addr=4194304, notes=None, display_notes=True, max_str_len=None, prettify_thiscall=False, cstyle_void_param=True, indent_size=4, variable_map=None, stl_accessor_calls=False)

Parameters:

func_args (list[SimVariable] | None)
binop_depth_cutoff (int)
min_data_addr (int)
display_notes (bool)
max_str_len (int | None)
prettify_thiscall (bool)
cstyle_void_param (bool)
indent_size (int)
variable_map (VariableMap | None)
stl_accessor_calls (bool)

reapply_options(options)

cleanup(): Remove existing rendering results.

regenerate_text()

Re-render text and re-generate all sorts of mapping information.

Return type:: None

RENDER_TYPE: alias of tuple[str, PositionMapping, PositionMapping, InstructionMapping, dict[Any, set[Any]]]

render_text(rust_func)

Return type:: tuple[str, PositionMapping, PositionMapping, InstructionMapping, dict[Any, set[Any]]]
Parameters:: rust_func (RustFunction)

render_notes()

Render decompilation notes.

Return type:: str
Returns:: A string containing all notes.

reload_variable_types()

Return type:: None

default_simtype_from_size(n, signed=True)

Return type:

RustSimTypeInt

Parameters:

n (int)
signed (bool)

class angr.analyses.decompiler.structured_codegen.StructFieldNode

Bases: CodegenNode

A struct field name; has struct_type, offset, and field.

class angr.analyses.decompiler.structured_codegen.UnaryOpNode: Bases: CodegenNode

class angr.analyses.decompiler.structured_codegen.VariableFieldNode: Bases: CodegenNode

class angr.analyses.decompiler.structured_codegen.VariableNode

Bases: CodegenNode

A variable access; has variable and unified_variable.

Submodules

`base`
`c`
`c_serialize`	Protobuf serialization helpers for the C AST defined in `c`.
`dummy`
`dwarf_import`
`go`	Go-flavored structured code generator.
`go_serialize`	Protobuf serialization for the Go AST defined in `go`.
`rust`
`sse_intrinsics`	Intel-intrinsics view of 128-bit SSE vector AIL: lane kinds of variables, `_mm_*` names of lane-wise ops, and the `pshufd` lane shuffles that VEX spells out as CONCAT trees of 32-bit lane extractions.
`utils`