summaryrefslogtreecommitdiff
path: root/rust/tests/language_representation.rs
blob: 78af7d7f16a74fb8c8238b7934998aa1a7a2ff44 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
use std::path::PathBuf;

use binaryninja::architecture::CoreArchitecture;
use binaryninja::binary_view::BinaryView;
use binaryninja::disassembly::{
    DisassemblySettings, DisassemblyTextLine, InstructionTextToken, InstructionTextTokenKind,
};
use binaryninja::function::Function;
use binaryninja::headless::Session;
use binaryninja::high_level_il::token_emitter::HighLevelILTokenEmitter;
use binaryninja::high_level_il::{HighLevelExpressionIndex, HighLevelILFunction};
use binaryninja::language_representation::{
    register_language_representation_function_type, CoreLanguageRepresentationFunction,
    CoreLanguageRepresentationFunctionType, LanguageRepresentationFunction,
    LanguageRepresentationFunctionType, OperatorPrecedence,
};
use binaryninja::rc::Ref;

struct MyLangReprType {
    core: CoreLanguageRepresentationFunctionType,
}

impl LanguageRepresentationFunctionType for MyLangReprType {
    fn create(
        &self,
        arch: &CoreArchitecture,
        func: &Function,
        high_level_il: &HighLevelILFunction,
    ) -> Ref<CoreLanguageRepresentationFunction> {
        CoreLanguageRepresentationFunction::new(
            &self.core,
            MyLangRepr {},
            arch,
            func,
            high_level_il,
        )
    }

    fn is_valid(&self, _view: &BinaryView) -> bool {
        true
    }

    fn function_type_tokens(
        &self,
        _func: &Function,
        _settings: &DisassemblySettings,
    ) -> Vec<DisassemblyTextLine> {
        todo!()
    }
}

unsafe impl Send for MyLangReprType {}
unsafe impl Sync for MyLangReprType {}

struct MyLangRepr;

impl LanguageRepresentationFunction for MyLangRepr {
    fn on_token_emitter_init(&self, _tokens: &HighLevelILTokenEmitter) {}

    fn expr_text(
        &self,
        il: &HighLevelILFunction,
        expr_index: HighLevelExpressionIndex,
        tokens: &HighLevelILTokenEmitter,
        _settings: &DisassemblySettings,
        _as_full_ast: bool,
        _precedence: OperatorPrecedence,
        _statement: bool,
    ) {
        let instr = il.instruction_from_expr_index(expr_index).unwrap();
        let instr = instr.lift();
        use binaryninja::high_level_il::HighLevelILLiftedInstructionKind::*;
        match &instr.kind {
            Block(block) => {
                tokens.append(InstructionTextToken::new(
                    format!("block {}\n", block.body.len()),
                    InstructionTextTokenKind::Text,
                ));
                for block_inst in &block.body {
                    self.expr_text(
                        il,
                        block_inst.expr_index,
                        tokens,
                        _settings,
                        _as_full_ast,
                        _precedence,
                        _statement,
                    );
                }
            }
            Unimpl | Unreachable | Undef => panic!(),
            _kind => {
                tokens.append(InstructionTextToken::new(
                    format!("other instr 0x{:x}\n", instr.address),
                    InstructionTextTokenKind::Text,
                ));
            }
        }
    }

    fn begin_lines(
        &self,
        _il: &HighLevelILFunction,
        _expr_index: HighLevelExpressionIndex,
        _tokens: &HighLevelILTokenEmitter,
    ) {
    }

    fn end_lines(
        &self,
        _il: &HighLevelILFunction,
        _expr_index: HighLevelExpressionIndex,
        _tokens: &HighLevelILTokenEmitter,
    ) {
    }

    fn comment_start_string(&self) -> &str {
        "/* "
    }

    fn comment_end_string(&self) -> &str {
        " */"
    }

    fn annotation_start_string(&self) -> &str {
        "{"
    }

    fn annotation_end_string(&self) -> &str {
        "}"
    }
}

#[test]
fn test_custom_language_representation() {
    const LANG_REPR_NAME: &str = "test_lang_repr";
    let _session = Session::new().expect("Failed to initialize session");
    let out_dir = env!("OUT_DIR").parse::<PathBuf>().unwrap();

    let my_repr = register_language_representation_function_type(
        |core| MyLangReprType { core },
        LANG_REPR_NAME,
    );
    let view = binaryninja::load(out_dir.join("atox.obj")).expect("Failed to create view");
    let func = view
        .function_at(&view.default_platform().unwrap(), 0x36760)
        .unwrap();
    let _repr = my_repr.create(&func);
    let il = func.high_level_il(false).unwrap();

    let settings = DisassemblySettings::new();
    let root_idx = il.root_expression_index();
    let result = _repr.linear_lines(&il, root_idx, &settings, false);
    let output: String = result.iter().map(|dis| dis.to_string()).collect();
    assert_eq!(
        format!("{output}"),
        "block 26
other instr 0x36775
other instr 0x3679e
other instr 0x3679e
other instr 0x367ba
other instr 0x367e6
other instr 0x3682f
other instr 0x3682f
other instr 0x36834
other instr 0x3683e
other instr 0x3684e
other instr 0x36867
other instr 0x36881
other instr 0x36881
other instr 0x36881
other instr 0x36896
other instr 0x368a0
other instr 0x368bb
other instr 0x368d2
other instr 0x3694a
other instr 0x36960
other instr 0x369e1
other instr 0x369ec
other instr 0x36a2e
other instr 0x36ab5
other instr 0x36abd
other instr 0x36ac2
"
    );
}