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
use ahash::RandomState;
use libafl::{bolts::tuples::Named, executors::ExitKind, observers::Observer, Error};
use serde::{Deserialize, Serialize};
use std::cmp::Eq;
use std::collections::{HashMap, HashSet};
use std::fmt::{Debug, Write};
use std::hash::Hash;

#[inline]
fn pack_transition(from: u32, to: u32) -> u64 {
    (from as u64) << 32 | (to as u64)
}

#[inline]
fn unpack_transition(transition: u64) -> (u32, u32) {
    ((transition >> 32) as u32, transition as u32)
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(bound = "PS: serde::Serialize + for<'a> serde::Deserialize<'a>")]
struct StateGraph<PS>
where
    PS: Clone + Debug + Eq + Hash,
{
    nodes: HashMap<PS, u32, RandomState>,
    edges: HashSet<u64, RandomState>,
    last_node: Option<u32>,
    new_transitions: bool,
}
impl<PS> StateGraph<PS>
where
    PS: Clone + Debug + Eq + Hash + Serialize + for<'a> Deserialize<'a>,
{
    fn new() -> Self {
        Self {
            nodes: HashMap::<PS, u32, RandomState>::default(),
            edges: HashSet::<u64, RandomState>::default(),
            last_node: None,
            new_transitions: false,
        }
    }

    fn reset(&mut self) {
        self.last_node = None;
        self.new_transitions = false;
    }

    fn add_node(&mut self, state: &PS) -> u32 {
        match self.nodes.get(state) {
            Some(id) => *id,
            None => {
                let next_id = self.nodes.len() as u32;
                assert!(self.nodes.insert(state.clone(), next_id).is_none());
                next_id
            },
        }
    }

    fn add_edge(&mut self, id: u32) {
        self.new_transitions |= match self.last_node.take() {
            Some(old_id) => {
                if old_id != id {
                    self.edges.insert(pack_transition(old_id, id))
                } else {
                    false
                }
            },
            None => false,
        };

        self.last_node = Some(id);
    }

    fn write_dot<S>(&self, stream: &mut S)
    where
        S: Write,
    {
        let _ = write!(stream, "digraph IMPLEMENTED_STATE_MACHINE {{");

        for value in &self.edges {
            let (from, to) = unpack_transition(*value);
            let _ = write!(stream, "\"{}\"->\"{}\";", from, to);
        }

        let _ = write!(stream, "}}");
    }
}

/// An observer that builds a state-graph.
///
/// The states that this observer stores must implement
/// the following traits: [`Eq`](core::cmp::Eq), [`Hash`](std::hash::Hash), [`Debug`](core::fmt::Debug), [`Clone`](core::clone::Clone), [`Serialize`](serde::Serialize), [`Deserialize`](serde::Deserialize).
/// Most commonly used state types are u64, u32 or [u8; N] with N <= 32.
///
/// When you create a StateObserver always specify `PS` manually:
/// ```
/// type State = u64;
/// let observer = StateObserver::<State>::new("state observer");
/// ```
///
/// The executor is responsible for calling [`StateObserver::record()`](crate::StateObserver::record)
/// with states inferred from the fuzz target.
#[derive(Debug, Serialize, Deserialize)]
#[serde(bound = "PS: serde::Serialize + for<'a> serde::Deserialize<'a>")]
pub struct StateObserver<PS>
where
    PS: Clone + Debug + Eq + Hash,
{
    name: String,
    graph: StateGraph<PS>,
}

impl<PS> StateObserver<PS>
where
    PS: Clone + Debug + Eq + Hash + Serialize + for<'a> Deserialize<'a>,
{
    /// Create a new StateObserver with a given name.
    pub fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
            graph: StateGraph::<PS>::new(),
        }
    }

    /// Tell the observer that the target has entered state `state`.
    pub fn record(&mut self, state: &PS) {
        let node = self.graph.add_node(state);
        self.graph.add_edge(node);
    }

    /// Returns whether any new edges were created in the state-graph during the last run.
    /// Used by [`StateFeedback`](crate::StateFeedback).
    pub fn had_new_transitions(&self) -> bool {
        self.graph.new_transitions
    }

    /// Returns the number of vertices and edges in the state-graph.
    /// Used by [`StateFeedback`](crate::StateFeedback).
    pub fn info(&self) -> (usize, usize) {
        (self.graph.nodes.len(), self.graph.edges.len())
    }

    /// Returns a DOT representation of the statemachine.
    pub fn get_statemachine(&self) -> String {
        let mut s = String::with_capacity(1024);
        self.graph.write_dot(&mut s);
        s
    }
}

impl<PS> Named for StateObserver<PS>
where
    PS: Clone + Debug + Hash + Eq + Serialize + for<'a> Deserialize<'a>,
{
    fn name(&self) -> &str {
        &self.name
    }
}

impl<PS, I, S> Observer<I, S> for StateObserver<PS>
where
    PS: Clone + Debug + Hash + Eq + Serialize + for<'a> Deserialize<'a>,
{
    fn pre_exec(&mut self, _state: &mut S, _input: &I) -> Result<(), Error> {
        self.graph.reset();
        Ok(())
    }

    fn post_exec(&mut self, _state: &mut S, _input: &I, _exit_kind: &ExitKind) -> Result<(), Error> {
        Ok(())
    }
}

#[cfg(test)]
mod benchmarks {
    extern crate test;
    use super::*;
    use test::Bencher;

    type State = [u8; 32];

    fn state(n: usize) -> State {
        let mut state = State::default();
        state[0..8].copy_from_slice(&n.to_le_bytes());
        state
    }

    #[bench]
    fn bench_duplicates(b: &mut Bencher) {
        let mut graph = StateGraph::<State>::new();
        b.iter(|| {
            let node = graph.add_node(&State::default());
            graph.add_edge(node);
        });
    }

    #[bench]
    fn bench_insertions(b: &mut Bencher) {
        let mut graph = StateGraph::<State>::new();
        let mut i: usize = 0;
        b.iter(|| {
            let node = graph.add_node(&state(i));
            graph.add_edge(node);
            i += 1;
        });
    }

    #[bench]
    #[ignore]
    fn memory_footprint(_: &mut Bencher) {
        let mut graph = StateGraph::<State>::new();
        let limit: usize = 24576;

        for i in 0..limit {
            let i_node = graph.add_node(&state(i));

            for j in 0..limit {
                let j_node = graph.add_node(&state(j));
                graph.add_edge(i_node);
                graph.add_edge(j_node);
                graph.reset();
            }
        }

        println!("nodes = {}", graph.nodes.len());
        println!("edges = {}", graph.edges.len());

        loop {}
    }
}