rsleigh 0.5.0

SLEIGH (.slaspec) parser and Rust decoder/P-code emitter codegen — Ghidra-compatible disassembly in pure Rust
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use proc_macro2::{Ident, TokenStream};
use quote::{format_ident, quote};

use super::{ConstructorStruct, Disassembler};
use crate::codegen::builder::formater::*;
use crate::codegen::builder::helper::PatternByte;
use crate::codegen::builder::ToLiteral;

pub struct TableEnum {
    //enum declaration ident
    pub name: Ident,
    //parse function ident
    pub parse_fun: Ident,
    //disassembly (pos) function ident
    //pub disassembly_fun: Ident,
    //display_extend function ident
    pub display_fun: Ident,
    //constructors are mapped from the sleigh_rs constructors by index
    pub constructors: Vec<ConstructorStruct>,
    pub table_id: crate::TableId,
}

impl TableEnum {
    pub fn new(
        sleigh: &crate::Sleigh,
        table: &crate::table::Table,
        table_id: crate::TableId,
    ) -> Self {
        let constructors = table
            .constructors()
            .iter()
            .enumerate()
            .map(|(index, constructor)| {
                ConstructorStruct::new(
                    sleigh,
                    table_id,
                    constructor,
                    crate::table::ConstructorId(index),
                    &from_sleigh(table.name()),
                    index,
                )
            })
            .collect();
        //only non root tables have a disassembly function
        Self {
            name: format_ident!("Table{}", from_sleigh(table.name())),
            parse_fun: format_ident!("parse"),
            //disassembly_fun: format_ident!("disassembly"),
            display_fun: format_ident!("display_extend"),
            constructors,
            table_id,
        }
    }

    /// Emit constructor structs into batches and the table enum separately.
    /// Returns (constructor_batches, table_enum_tokens).
    pub fn to_tokens_split(
        &self,
        max_constructors_per_batch: usize,
        disassembler: &Disassembler,
    ) -> (Vec<TokenStream>, TokenStream) {
        let max = max_constructors_per_batch.max(1);
        let mut batches: Vec<TokenStream> = Vec::new();
        let mut current = TokenStream::new();
        let mut count = 0;

        for constructor in &self.constructors {
            constructor.to_tokens(&mut current, disassembler);
            count += 1;
            if count >= max {
                batches.push(std::mem::take(&mut current));
                count = 0;
            }
        }
        if !current.is_empty() {
            batches.push(current);
        }

        // Generate the enum portion (without constructor structs)
        let mut enum_tokens = TokenStream::new();
        self.emit_enum_only(&mut enum_tokens, disassembler);

        (batches, enum_tokens)
    }

    fn constructor_span_method(&self, disassembler: &Disassembler) -> TokenStream {
        if self.table_id != disassembler.sleigh.instruction_table() {
            return TokenStream::new();
        }

        let table_id = self.table_id.0 as u32;
        let variants = self
            .constructors
            .iter()
            .map(|constructor| &constructor.enum_name);
        let constructor_ids = self
            .constructors
            .iter()
            .map(|constructor| constructor.constructor_id.0 as u32);
        let sources = self.constructors.iter().map(|constructor| {
            disassembler
                .sleigh
                .table(self.table_id)
                .constructor(constructor.constructor_id)
                .location
                .to_string()
        });

        quote! {
            #[inline(never)]
            pub fn constructor_span(&self) -> pcode_ir::ConstructorSpan {
                match self {
                    #(Self::#variants(_) => pcode_ir::ConstructorSpan {
                        constructor_id: #constructor_ids,
                        table_id: #table_id,
                        source: #sources,
                    }),*
                }
            }
        }
    }

    fn emit_enum_only(&self, tokens: &mut TokenStream, disassembler: &Disassembler) {
        let Self {
            name: enum_name,
            parse_fun,
            display_fun,
            constructors,
            table_id,
        } = self;
        let table = disassembler.sleigh.table(*table_id);
        let constructor_enum_name_1 = constructors.iter().map(|con| &con.enum_name);
        let constructor_enum_name_2 = constructor_enum_name_1.clone();
        let constructor_struct = constructors.iter().map(|con| &con.struct_name);
        let display_struct_name = &disassembler.display.name;
        let variant_lift_names: Vec<_> = constructors.iter().map(|c| &c.enum_name).collect();
        let variant_names = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].enum_name);
        let variant_structs = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].struct_name);
        let variant_display_fun = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].display_fun);
        let variants_parser_fun = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].parser_fun);
        let variants_min_len = table.matcher_order.iter().map(|matcher| {
            table
                .constructor(matcher.constructor)
                .pattern
                .len
                .min()
                .unsuffixed()
        });
        let variants_constraint = table.matcher_order.iter().map(|matcher| {
            (!disassembler.debug).then(|| {
                let constructor = table.constructor(matcher.constructor);
                let (context, token) = constructor.variant(matcher.variant_id);
                let context = PatternByte::from_bit_constraints(context);
                let token = PatternByte::from_bit_constraints(token);
                let (context_value, context_mask) = context.into_iter().enumerate().fold(
                    (0u128, 0u128),
                    |(acc_value, acc_mask), (byte_num, byte)| {
                        (
                            acc_value | ((byte.defined_value() as u128) << (byte_num * 8)),
                            acc_mask | ((byte.defined_bits() as u128) << (byte_num * 8)),
                        )
                    },
                );
                let pattern_constraint = token
                    .into_iter()
                    .enumerate()
                    .filter(|(_, byte)| byte.defined_bits() != 0)
                    .map(|(i, byte)| {
                        let i = i.unsuffixed();
                        let value = byte.defined_value().unsuffixed();
                        let mask = byte.defined_bits().unsuffixed();
                        quote! { (tokens_param[#i] & #mask) == #value}
                    });
                let context_constraint = (context_mask != 0)
                    .then(|| {
                        let context_value = context_value.unsuffixed();
                        let context_mask = context_mask.unsuffixed();
                        quote! { context_param.0 & #context_mask == #context_value }
                    })
                    .into_iter();
                context_constraint
                    .chain(pattern_constraint)
                    .fold(quote! {}, |mut acc, x| {
                        acc.extend(quote! {&& #x});
                        acc
                    })
            })
        });
        let addr_type = &disassembler.addr_type;
        let context_struct = &disassembler.context.name;
        let globalset_struct = &disassembler.context.globalset.name;
        let constructor_span_method = self.constructor_span_method(disassembler);
        tokens.extend(quote! {
            #[derive(Clone, Debug)]
            pub enum #enum_name {
                #(#constructor_enum_name_1(#constructor_struct)),*
            }
            impl #enum_name {
                pub fn #display_fun(
                    &self,
                    display: &mut Vec<#display_struct_name>,
                    context: &#context_struct,
                    inst_start: #addr_type,
                    inst_next: #addr_type,
                    global_set_param: &mut #globalset_struct,
                ) {
                    match self {
                        #(Self::#constructor_enum_name_2(x) => x.#variant_display_fun(
                              display, context, inst_start, inst_next, global_set_param,
                          )),*
                    }
                }
                pub fn lift(
                    &self,
                    inst_start: #addr_type,
                    inst_next: #addr_type,
                ) -> (Vec<pcode_ir::PcodeOp>, Option<pcode_ir::Varnode>, Option<(pcode_ir::AddressSpaceId, pcode_ir::Varnode, u32)>) {
                    match self {
                        #(Self::#variant_lift_names(x) => x.lift(inst_start, inst_next)),*
                    }
                }
                #constructor_span_method
                pub fn #parse_fun(
                    tokens_param: &[u8],
                    context_param: &mut #context_struct,
                    inst_start: #addr_type,
                ) -> Option<(#addr_type, Self)> {
                    let mut context_current = context_param.clone();
                    #(if tokens_param.len() >= #variants_min_len #variants_constraint {
                        if let Some((inst_len, parsed)) =
                          #variant_structs::#variants_parser_fun(
                            tokens_param, &mut context_current, inst_start,
                        ) {
                            *context_param = context_current;
                            return Some((inst_len, Self::#variant_names(parsed)));
                        }
                    })*
                    None
                }
            }
        })
    }

    pub fn to_tokens(&self, tokens: &mut TokenStream, disassembler: &Disassembler) {
        let Self {
            name: enum_name,
            parse_fun,
            display_fun,
            constructors,
            table_id,
        } = self;
        let table = disassembler.sleigh.table(*table_id);
        let constructors_structs = constructors.iter();
        let constructor_enum_name_1 = constructors.iter().map(|con| &con.enum_name);
        let constructor_enum_name_2 = constructor_enum_name_1.clone();
        let constructor_struct = constructors.iter().map(|con| &con.struct_name);
        let display_struct_name = &disassembler.display.name;
        let variant_lift_names: Vec<_> = constructors.iter().map(|c| &c.enum_name).collect();
        let variant_names = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].enum_name);
        let variant_structs = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].struct_name);
        let variant_display_fun = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].display_fun);
        let variants_parser_fun = table
            .matcher_order
            .iter()
            .map(|matcher| &self.constructors[matcher.constructor.0].parser_fun);
        let variants_min_len = table.matcher_order.iter().map(|matcher| {
            table
                .constructor(matcher.constructor)
                .pattern
                .len
                .min()
                .unsuffixed()
        });

        //only verify constructors byte_pattern if not in debug mode
        let variants_constraint = table.matcher_order.iter().map(|matcher| {
            (!disassembler.debug).then(|| {
                let constructor = table.constructor(matcher.constructor);
                let (context, token) = constructor.variant(matcher.variant_id);
                let context = PatternByte::from_bit_constraints(context);
                let token = PatternByte::from_bit_constraints(token);
                let (context_value, context_mask) = context.into_iter().enumerate().fold(
                    (0u128, 0u128),
                    |(acc_value, acc_mask), (byte_num, byte)| {
                        (
                            acc_value | ((byte.defined_value() as u128) << (byte_num * 8)),
                            acc_mask | ((byte.defined_bits() as u128) << (byte_num * 8)),
                        )
                    },
                );
                //only constraint if mask != 0
                let pattern_constraint = token
                    .into_iter()
                    .enumerate()
                    .filter(|(_, byte)| byte.defined_bits() != 0)
                    .map(|(i, byte)| {
                        let i = i.unsuffixed();
                        let value = byte.defined_value().unsuffixed();
                        let mask = byte.defined_bits().unsuffixed();
                        quote! { (tokens_param[#i] & #mask) == #value}
                    });
                let context_constraint = (context_mask != 0)
                    .then(|| {
                        let context_value = context_value.unsuffixed();
                        let context_mask = context_mask.unsuffixed();
                        quote! { context_param.0 & #context_mask == #context_value }
                    })
                    .into_iter();

                context_constraint
                    .chain(pattern_constraint)
                    .fold(quote! {}, |mut acc, x| {
                        acc.extend(quote! {&& #x});
                        acc
                    })
            })
        });
        let addr_type = &disassembler.addr_type;
        let context_struct = &disassembler.context.name;
        let globalset_struct = &disassembler.context.globalset.name;
        let constructor_span_method = self.constructor_span_method(disassembler);
        for constructor in constructors_structs {
            constructor.to_tokens(tokens, disassembler);
        }
        tokens.extend(quote! {
            #[derive(Clone, Debug)]
            pub enum #enum_name {
                #(#constructor_enum_name_1(#constructor_struct)),*
            }
            impl #enum_name {
                pub fn #display_fun(
                    &self,
                    display: &mut Vec<#display_struct_name>,
                    context: &#context_struct,
                    inst_start: #addr_type,
                    inst_next: #addr_type,
                    global_set_param: &mut #globalset_struct,
                ) {
                    match self {
                        #(Self::#constructor_enum_name_2(x) => x.#variant_display_fun(
                              display,
                              context,
                              inst_start,
                              inst_next,
                              global_set_param,
                          )),*
                    }
                }
                pub fn lift(
                    &self,
                    inst_start: #addr_type,
                    inst_next: #addr_type,
                ) -> (Vec<pcode_ir::PcodeOp>, Option<pcode_ir::Varnode>, Option<(pcode_ir::AddressSpaceId, pcode_ir::Varnode, u32)>) {
                    match self {
                        #(Self::#variant_lift_names(x) => x.lift(inst_start, inst_next)),*
                    }
                }
                #constructor_span_method
                pub fn #parse_fun(
                    tokens_param: &[u8],
                    context_param: &mut #context_struct,
                    inst_start: #addr_type,
                ) -> Option<(#addr_type, Self)> {
                    //clone context, so we updated it only if we found the
                    //correct match variant
                    let mut context_current = context_param.clone();
                    //try to parse each of the constructors, return if success
                    #(if tokens_param.len() >= #variants_min_len #variants_constraint {
                        if let Some((inst_len, parsed)) =
                          #variant_structs::#variants_parser_fun(
                            tokens_param,
                            &mut context_current,
                            inst_start,
                        ) {
                            *context_param = context_current;
                            return Some((inst_len, Self::#variant_names(parsed)));
                        }
                    })*
                    None
                }
            }
        })
    }
}