jingle 0.5.4

SMT Modeling for Ghidra's PCODE
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

use crate::analysis::cpa::lattice::JoinSemiLattice;
use std::cmp::Ordering;
use std::fmt::{Debug, Display, Formatter, LowerHex};
use std::hash::Hash;

#[derive(PartialEq, Eq, Copy, Clone, Hash, Debug)]
pub enum FlatLattice<C> {
    Value(C),
    Top,
}

impl<C> From<C> for FlatLattice<C> {
    fn from(value: C) -> Self {
        FlatLattice::Value(value)
    }
}

impl<C> From<FlatLattice<C>> for Option<C> {
    fn from(value: FlatLattice<C>) -> Self {
        match value {
            FlatLattice::Top => None,
            FlatLattice::Value(a) => Some(a),
        }
    }
}

impl<T: PartialEq<T>> PartialEq<T> for FlatLattice<T> {
    fn eq(&self, other: &T) -> bool {
        match self {
            FlatLattice::Value(t) => t == other,
            FlatLattice::Top => false,
        }
    }
}

impl<C: Display> Display for FlatLattice<C> {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        match self {
            FlatLattice::Value(a) => f
                .debug_tuple("FlatLattice")
                .field(&format_args!("{a}"))
                .finish(),
            FlatLattice::Top => write!(f, "FlatLattice(Top)"),
        }
    }
}

impl<C: LowerHex> LowerHex for FlatLattice<C> {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        match self {
            FlatLattice::Value(a) => f
                .debug_tuple("FlatLattice")
                .field(&format_args!("{a:x}"))
                .finish(),
            FlatLattice::Top => write!(f, "FlatLattice(Top)"),
        }
    }
}

impl<C: PartialOrd + PartialEq + Clone> FlatLattice<C> {
    pub fn is_top(&self) -> bool {
        matches!(self, FlatLattice::Top)
    }

    pub fn value(&self) -> Option<&C> {
        match self {
            FlatLattice::Value(c) => Some(c),
            FlatLattice::Top => None,
        }
    }
}

impl<C: PartialOrd + PartialEq + Clone> PartialOrd for FlatLattice<C> {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        match (&self, &other) {
            (Self::Top, Self::Top) => Some(Ordering::Equal),
            (Self::Top, Self::Value(_)) => Some(Ordering::Greater),
            (Self::Value(_), Self::Top) => Some(Ordering::Less),
            (Self::Value(a), Self::Value(b)) => {
                if a == b {
                    Some(Ordering::Equal)
                } else {
                    None
                }
            }
        }
    }
}

impl<C: PartialOrd + Eq + Clone> JoinSemiLattice for FlatLattice<C> {
    fn join(&mut self, other: &Self) {
        match (&self, other) {
            (Self::Top, _) => *self = Self::Top,
            (_, Self::Top) => *self = Self::Top,
            (Self::Value(a), Self::Value(b)) => {
                if a == b {
                    // do nothing
                } else {
                    *self = Self::Top
                }
            }
        };
    }
}

#[cfg(test)]
mod tests {
    use crate::analysis::cpa::lattice::flat::FlatLattice;

    #[test]
    pub fn test_flat_lattice() {
        let val1 = FlatLattice::Value(4u64);
        let val2 = FlatLattice::Value(5u64);
        let top = FlatLattice::Top;
        assert_eq!(val1, val1);
        assert_eq!(val2, val2);
        assert_eq!(top, top);
        assert_ne!(val1, val2);
        assert_ne!(val1, top);
        assert!(top > val1);
        assert!(top > val2);
        assert!(val1.partial_cmp(&val2).is_none());
        assert!(val2.partial_cmp(&val1).is_none());
    }
}