sleigh 0.1.0

A SLEIGH decompiler
Documentation
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
406
407
408
409
410
411
412
use std::{collections::HashMap, pin::Pin};

use cxx::{let_cxx_string, UniquePtr};
use sleigh_sys::{RustAssemblyEmit, RustLoadImage, RustPCodeEmit};

pub mod sla;

pub type Opcode = sleigh_sys::Opcode;
pub type SpaceType = sleigh_sys::SpaceType;

#[derive(Debug)]
pub struct AddrSpace {
    pub name: String,
    pub ty: SpaceType,
}

#[derive(Debug)]
pub struct VarnodeData {
    pub space: AddrSpace,
    pub offset: u64,
    pub size: u32,
}

impl From<&sleigh_sys::ffi::VarnodeData> for VarnodeData {
    fn from(var: &sleigh_sys::ffi::VarnodeData) -> Self {
        let address = sleigh_sys::ffi::getVarnodeDataAddress(var);
        let offset = address.getOffset();
        let space = address.getSpace();
        let space = unsafe {
            let space = &*space;
            let ty = sleigh_sys::ffi::getAddrSpaceType(space);
            let ty = sleigh_sys::SpaceType::from_u32(ty).unwrap();
            let name = space.getName().to_string();
            AddrSpace { name, ty }
        };
        let size = sleigh_sys::ffi::getVarnodeSize(var);
        Self {
            space,
            offset,
            size,
        }
    }
}

#[derive(Debug)]
pub struct PCode {
    pub address: u64,
    pub opcode: Opcode,
    pub vars: Vec<VarnodeData>,
    pub outvar: Option<VarnodeData>,
}

#[derive(Debug)]
pub struct Instruction {
    pub address: u64,
    pub mnemonic: String,
    pub body: String,
}

struct AssemblyEmit {
    insts: Vec<Instruction>,
}

impl sleigh_sys::AssemblyEmit for AssemblyEmit {
    fn dump(&mut self, addr: &sleigh_sys::ffi::Address, mnem: &str, body: &str) {
        let address = addr.getOffset();
        let mnemonic = mnem.to_string();
        let body = body.to_string();
        self.insts.push(Instruction {
            address,
            mnemonic,
            body,
        });
    }
}

struct PCodeEmit {
    pcodes: Vec<PCode>,
}

impl sleigh_sys::PCodeEmit for PCodeEmit {
    fn dump(
        &mut self,
        address: &sleigh_sys::ffi::Address,
        opcode: sleigh_sys::Opcode,
        outvar: Option<&sleigh_sys::ffi::VarnodeData>,
        vars: &[sleigh_sys::ffi::VarnodeData],
    ) {
        let vars = vars.iter().map(VarnodeData::from).collect::<Vec<_>>();
        let outvar = outvar.map(VarnodeData::from);
        let address = address.getOffset();
        let pcode = PCode {
            address,
            opcode,
            vars,
            outvar,
        };
        self.pcodes.push(pcode);
    }
}

struct SliceLoader<'a> {
    start: u64,
    data: &'a [u8],
}

impl<'a> sleigh_sys::LoadImage for SliceLoader<'a> {
    fn load_fill(&mut self, ptr: &mut [u8], addr: &sleigh_sys::ffi::Address) {
        let addr = addr.getOffset();
        let len = self.data.len() as u64;
        let required = ptr.len() as u64;
        ptr.fill(0);

        if self.start <= addr {
            let fill_len = required.min(len) as usize;
            let offset = (addr - self.start) as usize;
            ptr[..fill_len].copy_from_slice(&self.data[offset..offset + fill_len]);
        }
    }
}

struct VectorLoader {
    start: u64,
    data: Vec<u8>,
}

impl sleigh_sys::LoadImage for VectorLoader {
    fn load_fill(&mut self, ptr: &mut [u8], addr: &sleigh_sys::ffi::Address) {
        let mut s = SliceLoader {
            start: self.start,
            data: &self.data,
        };
        s.load_fill(ptr, addr);
    }
}

pub enum X86Mode {
    Mode16,
    Mode32,
    Mode64,
}

pub enum X64Mode {
    Mode16,
    Mode32,
    Mode64,
}

pub enum ArmMode {
    Arm,
    Thumb,
}

pub enum ArmVersion {
    Arm4,
    Arm4t,
    Arm5,
    Arm5t,
    Arm6,
    Arm7,
    Arm8,
}

pub enum Endian {
    LittleEndian,
    BigEndian,
}

pub struct Image {
    pub base_addr: u64,
    pub data: Vec<u8>,
}

pub struct ArchState {
    spec: String,
    var: HashMap<String, u32>,
}

pub struct DecompilerBuilder<T> {
    state: T,
}

impl DecompilerBuilder<()> {
    pub fn x86(self, mode: X86Mode) -> DecompilerBuilder<ArchState> {
        let mut var = HashMap::new();
        let m = match mode {
            X86Mode::Mode16 => 0,
            X86Mode::Mode32 => 1,
            X86Mode::Mode64 => 2,
        };
        var.insert("addrsize".to_string(), m);
        var.insert("opsize".to_string(), m);
        let spec = match mode {
            X86Mode::Mode16 | X86Mode::Mode32 => sla::get_arch_sla("x86").unwrap(),
            X86Mode::Mode64 => sla::get_arch_sla("x86-64").unwrap(),
        };
        DecompilerBuilder {
            state: ArchState { spec, var },
        }
    }

    pub fn aarch64(self, endian: Endian) -> DecompilerBuilder<ArchState> {
        let e = match endian {
            Endian::LittleEndian => "",
            Endian::BigEndian => "BE",
        };

        let name = format!("AARCH64{}", e);
        let spec = sla::get_arch_sla(&name).unwrap();

        DecompilerBuilder {
            state: ArchState {
                spec,
                var: HashMap::new(),
            },
        }
    }

    pub fn arm(
        self,
        version: ArmVersion,
        endian: Endian,
        mode: ArmMode,
    ) -> DecompilerBuilder<ArchState> {
        let v = match version {
            ArmVersion::Arm4 => "4",
            ArmVersion::Arm5 => "5",
            ArmVersion::Arm6 => "6",
            ArmVersion::Arm7 => "7",
            ArmVersion::Arm8 => "8",
            ArmVersion::Arm4t => "4t",
            ArmVersion::Arm5t => "5t",
        };
        let e = match endian {
            Endian::LittleEndian => "le",
            Endian::BigEndian => "be",
        };

        let mut var = HashMap::new();
        let t = if let ArmMode::Thumb = mode { 1 } else { 0 };
        var.insert("TMode".to_string(), t);

        let name = format!("ARM{}_{}", v, e);
        let spec = sla::get_arch_sla(&name).unwrap();

        DecompilerBuilder {
            state: ArchState { spec, var },
        }
    }

    pub fn dalvik(self) -> DecompilerBuilder<ArchState> {
        DecompilerBuilder {
            state: ArchState {
                spec: sla::get_arch_sla("Dalvik").unwrap(),
                var: HashMap::new(),
            },
        }
    }

    pub fn jvm(self) -> DecompilerBuilder<ArchState> {
        DecompilerBuilder {
            state: ArchState {
                spec: sla::get_arch_sla("JVM").unwrap(),
                var: HashMap::new(),
            },
        }
    }
}

impl DecompilerBuilder<ArchState> {
    pub fn build(self) -> Decompiler {
        let_cxx_string!(spec = self.state.spec);
        let doc = sleigh_sys::ffi::newDocumentStorage(&spec);
        let loader = VectorLoader {
            start: 0,
            data: vec![],
        };
        let mut loader = Box::new(loader);

        unsafe {
            let rust_loader = Box::new(RustLoadImage::from_internal(std::mem::transmute::<
                _,
                &'static mut VectorLoader,
            >(loader.as_mut())));
            let rust_loader: *mut RustLoadImage<'static> = Box::leak(rust_loader);
            let mut inner = sleigh_sys::ffi::newDecompiler(rust_loader, doc);

            let ctx = inner.pin_mut().getContext();
            for (k, v) in self.state.var.iter() {
                let_cxx_string!(key = k);
                let val = *v;
                Pin::new_unchecked(&mut *ctx).setVariableDefault(&key, val)
            }

            Decompiler {
                loader,
                rust_loader,
                inner,
            }
        }
    }
}

pub struct Decompiler {
    loader: Box<VectorLoader>,
    rust_loader: *mut RustLoadImage<'static>,
    inner: UniquePtr<sleigh_sys::ffi::Decompiler>,
}

impl Drop for Decompiler {
    fn drop(&mut self) {
        unsafe {
            let _ = Box::from_raw(self.rust_loader);
        }
    }
}

impl Decompiler {
    pub fn builder() -> DecompilerBuilder<()> {
        DecompilerBuilder { state: () }
    }

    pub fn translate(&mut self, code: &[u8], addr: u64) -> (usize, Vec<PCode>) {
        self.loader.data.clear();
        self.loader.data.extend_from_slice(code);
        self.loader.start = addr;
        let mut emit = PCodeEmit { pcodes: vec![] };
        unsafe {
            let mut rust_emit = RustPCodeEmit::from_internal(&mut emit);
            let n = self
                .inner
                .pin_mut()
                .translate(&mut rust_emit as *mut _, addr);
            (n as usize, emit.pcodes)
        }
    }

    pub fn disassemble(&mut self, code: &[u8], addr: u64) -> (usize, Vec<Instruction>) {
        self.loader.data.clear();
        self.loader.data.extend_from_slice(code);
        self.loader.start = addr;
        let mut emit = AssemblyEmit { insts: vec![] };
        unsafe {
            let mut rust_emit = RustAssemblyEmit::from_internal(&mut emit);
            let n = self.inner.pin_mut().disassemble(&mut rust_emit as _, addr);
            (n as usize, emit.insts)
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_loop() {
        let mut decompiler = Decompiler::builder()
            .arm(ArmVersion::Arm8, Endian::LittleEndian, ArmMode::Arm)
            .build();
        for _ in 0..100 {
            let (n, pcodes) = decompiler.translate(b"\x01\x00\x80\x00", 0x1000);
            println!("{} {:?}", n, pcodes);
            let (n, insts) = decompiler.disassemble(b"\x01\x00\x80\x00", 0x1000);
            println!("{} {:?}", n, insts);
        }
    }

    fn run(decompiler: &mut Decompiler, code: &[u8], addr: u64) {
        let (n, pcodes) = decompiler.translate(code, addr);
        println!("{} {:?}", n, pcodes);
        let (n, insts) = decompiler.disassemble(code, addr);
        println!("{} {:?}", n, insts);
    }

    #[test]
    fn test_concurrent() {
        let a = std::thread::spawn(test_x86);
        let b = std::thread::spawn(test_arm);
        a.join().unwrap();
        b.join().unwrap();
    }

    #[test]
    fn test_x86() {
        let mut decompiler = Decompiler::builder().x86(X86Mode::Mode32).build();
        run(&mut decompiler, b"\x05\x00\x10\x00\x00", 0x1000);
        let mut decompiler = Decompiler::builder().x86(X86Mode::Mode64).build();
        run(&mut decompiler, b"\x48\x31\xd8", 0x100010001);
    }

    #[test]
    fn test_arm() {
        let mut decompiler = Decompiler::builder()
            .arm(ArmVersion::Arm8, Endian::LittleEndian, ArmMode::Arm)
            .build();
        run(&mut decompiler, b"\x01\x00\x80\x00", 0x1000);
    }

    #[test]
    fn test_arm_thumb() {
        let mut decompiler = Decompiler::builder()
            .arm(ArmVersion::Arm5t, Endian::LittleEndian, ArmMode::Thumb)
            .build();
        run(&mut decompiler, b"\x11\x44\x11\x44", 0x1000);
    }

    #[test]
    fn test_dalvik() {
        let mut decompiler = Decompiler::builder().dalvik().build();
        run(&mut decompiler, b"\x90\x00\x02\x03", 0x1000);
    }
}