angr/tests/gui/test_decompilation_workflows.py
Fish 02c374b5b4
DecompilationCache: Serialization support. (#6624)
Also,

- Refactored variable_kb into kb.dec_variables.

- Spill decompilation cache into RuntimeDb.

- Save decompilation cache into angrDb. Decompilation results can be preserved across runs.

- No longer check in _pb2.py files; they are generated during build.
2026-07-22 03:03:40 -07:00

121 lines
5.1 KiB
Python

# pylint:disable=no-self-use
from __future__ import annotations
__package__ = __package__ or "tests.gui.decompilation_workflows" # pylint:disable=redefined-builtin
import os
import unittest
import angr
from angr.sim_type import SimTypeInt, TypeRef
from tests.common import bin_location, print_decompilation_result
test_location = os.path.join(bin_location, "tests")
class TestDecompilationWorkflows(unittest.TestCase):
"""
Tests for decompilation workflows in angr management (or any other GUI if anyone cares enough to create).
"""
def test_decompiling_a_function_multiple_times(self):
bin_path = os.path.join(test_location, "x86_64", "decompiler", "struct_access")
proj = angr.Project(bin_path, auto_load_libs=False)
proj.analyses.CFGFast(normalize=True)
func = proj.kb.functions["main"]
dec = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec.codegen is not None and dec.codegen.text is not None
print_decompilation_result(dec)
# decompile again, using decompilation cache
dec_2 = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec_2.codegen is not None and dec_2.codegen.text is not None
print_decompilation_result(dec_2)
assert dec.codegen.text == dec_2.codegen.text, "Decompilation results should be identical on multiple runs."
def test_decompiling_function_with_renamed_struct_name(self):
bin_path = os.path.join(test_location, "x86_64", "decompiler", "struct_access")
proj = angr.Project(bin_path, auto_load_libs=False)
proj.analyses.CFGFast(normalize=True)
func = proj.kb.functions["main"]
dec = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec.codegen is not None and dec.codegen.text is not None
print_decompilation_result(dec)
assert dec.func.addr in dec.kb.dec_variables
types = dec.kb.dec_variables["main"].types
# let's rename a struct field
new_type_name = "my_awesome_type"
t = types["struct_0"]
assert isinstance(t, TypeRef)
assert len(t.type.fields) == 2
t.type.name = new_type_name
# decompile again, using decompilation cache
dec_2 = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec_2.codegen is not None and dec_2.codegen.text is not None
print_decompilation_result(dec_2)
assert new_type_name in dec_2.codegen.text, "Decompilation results should reflect the renamed struct type."
def test_decompiling_function_with_renamed_struct_fields(self):
bin_path = os.path.join(test_location, "x86_64", "decompiler", "struct_access")
proj = angr.Project(bin_path, auto_load_libs=False)
proj.analyses.CFGFast(normalize=True)
func = proj.kb.functions["main"]
dec = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec.codegen is not None and dec.codegen.text is not None
print_decompilation_result(dec)
assert dec.func.addr in dec.kb.dec_variables
types = dec.kb.dec_variables["main"].types
# let's rename a struct field
t = types["struct_0"]
assert isinstance(t, TypeRef)
assert len(t.type.fields) == 2
new_field_name = "my_new_field_120"
t.type.fields[new_field_name] = t.type.fields["field_120"]
del t.type.fields["field_120"]
# decompile again, using decompilation cache
dec_2 = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec_2.codegen is not None and dec_2.codegen.text is not None
print_decompilation_result(dec_2)
assert new_field_name in dec_2.codegen.text, "Decompilation results should reflect the renamed struct field."
def test_decompiling_function_with_retyped_struct_field(self):
bin_path = os.path.join(test_location, "x86_64", "decompiler", "struct_access")
proj = angr.Project(bin_path, auto_load_libs=False)
proj.analyses.CFGFast(normalize=True)
func = proj.kb.functions["main"]
dec = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec.codegen is not None and dec.codegen.text is not None
print_decompilation_result(dec)
assert "struct struct_1 *field_120;" in dec.codegen.text
assert dec.func.addr in dec.kb.dec_variables
types = dec.kb.dec_variables["main"].types
# let's type a struct field
t = types["struct_0"]
assert isinstance(t, TypeRef)
assert len(t.type.fields) == 2
assert "field_120" in t.type.fields
t.type.fields["field_120"] = SimTypeInt(signed=True).with_arch(proj.arch)
# decompile again, using decompilation cache
dec_2 = proj.analyses.Decompiler(func, cfg=proj.kb.cfgs["CFGFast"])
assert dec_2.codegen is not None and dec_2.codegen.text is not None
print_decompilation_result(dec_2)
assert "int field_120;" in dec_2.codegen.text, "Decompilation results should reflect the retyped struct field."
assert "struct_1" not in dec_2.codegen.text
if __name__ == "__main__":
unittest.main()