rsleigh 0.3.0

SLEIGH (.slaspec) parser and Rust decoder/P-code emitter codegen — Ghidra-compatible disassembly in pure Rust
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

use crate::semantic::{AttachLiteralId, AttachNumberId, AttachVarnodeId, VarnodeId};
use crate::{Number, NumberNonZeroUnsigned, Sleigh};

use super::inner::execution::FieldSize;
use super::{PrintBase, ValueFmt};

/// The value is translated with a varnode using this value as index.
/// In Display, print the varnode name.
/// In Disassembly, TODO: is unknown.
/// In Execution, read/write are done on the underlying varnode.
#[derive(Clone, Debug)]
pub struct AttachVarnode(pub Box<[(usize, VarnodeId)]>);
impl AttachVarnode {
    pub fn find_value(&self, index: usize) -> Option<VarnodeId> {
        self.0
            .iter()
            .find(|(value_index, _value)| *value_index == index)
            .map(|(_, value)| *value)
    }

    pub fn len_bytes(&self, sleigh: &Sleigh) -> NumberNonZeroUnsigned {
        sleigh.varnode(self.0[0].1).len_bytes
    }
}

/// The Value is translated into this string. Only affect the value when it's
/// printed
#[derive(Clone, Debug)]
pub struct AttachLiteral(pub Box<[(usize, String)]>);
impl AttachLiteral {
    pub fn find_value(&self, index: usize) -> Option<&str> {
        self.0
            .iter()
            .find(|(value_index, _value)| *value_index == index)
            .map(|(_, value)| value.as_str())
    }
}

/// The Value is translated into a signed value with this Format.
/// In Display, print the translated value using this index.
/// In Disassembly, TODO: is unknown.
/// In Execution, the value is translanted and is automatically expanded to
/// the required len.
#[derive(Clone, Debug)]
pub struct AttachNumber(pub Box<[(usize, Number)]>);
impl AttachNumber {
    pub fn is_signed(&self) -> bool {
        self.0.iter().any(|(_i, v)| v.is_negative())
    }

    pub fn find_value(&self, index: usize) -> Option<Number> {
        self.0
            .iter()
            .find(|(value_index, _value)| *value_index == index)
            .map(|(_, value)| *value)
    }

    pub fn bits_required(&self) -> u32 {
        self.0
            .iter()
            .map(|(_value_index, value)| value.bits_required())
            .min()
            .unwrap()
    }
}

#[derive(Clone, Copy, Debug)]
pub enum Meaning {
    NoAttach(ValueFmt),
    Varnode(AttachVarnodeId),
    Literal(AttachLiteralId),
    Number(PrintBase, AttachNumberId),
}

impl Meaning {
    pub fn is_varnode(&self) -> bool {
        matches!(self, Self::Varnode(_))
    }
    pub fn is_literal(&self) -> bool {
        matches!(self, Self::Literal(_))
    }
    pub fn is_number(&self) -> bool {
        matches!(self, Self::Number(_, _))
    }
    #[deprecated]
    pub fn execution_len(&self, sleigh: &super::inner::Sleigh) -> Option<FieldSize> {
        match self {
            // name don't change the value size
            Meaning::NoAttach(_) | Meaning::Literal(_) => None,
            Meaning::Varnode(vars_id) => {
                let vars = sleigh.attach_varnode(*vars_id);
                let varnode_bits = sleigh.varnode(vars.0[0].1).len_bytes.get() * 8;
                Some(FieldSize::new_bits(varnode_bits.try_into().unwrap()))
            }
            Meaning::Number(_, values_id) => {
                let values = sleigh.attach_number(*values_id);
                let len_bits = values
                    .0
                    .iter()
                    .map(|(_i, v)| v.bits_required())
                    .max()
                    .unwrap();
                let len_bits = NumberNonZeroUnsigned::new(len_bits.into()).unwrap();
                Some(FieldSize::default().set_min_bits(len_bits).unwrap())
            }
        }
    }
}