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
//! ITM protocol.

use crate::{
    output::{Output, Stream},
    PORTS_COUNT,
};
use anyhow::Result;
use log::{debug, warn};
use smallvec::SmallVec;
use std::{
    cell::{Cell, RefCell},
    ops::{Generator, GeneratorState},
    pin::Pin,
    rc::Rc,
};

/// ITM protocol parser.
pub struct Parser<'cli> {
    pipe: Rc<Cell<u8>>,
    gen: Pin<Box<dyn Generator<Yield = (), Return = Result<!>> + 'cli>>,
}

enum Timestamp {
    Local { tc: u8 },
    Global1,
    Global2,
}

type Streams<'cli> = SmallVec<[&'cli RefCell<Stream>; 2]>;

impl<'cli> Parser<'cli> {
    /// Creates a new [`Parser`].
    pub fn new(outputs: &'cli [Output<'cli>]) -> Result<Self> {
        let pipe = Rc::new(Cell::new(0));
        let gen = Box::pin(parser(outputs, Rc::clone(&pipe)));
        let mut parser = Self { pipe, gen };
        parser.resume()?;
        Ok(parser)
    }

    /// Feeds a byte to the parser.
    pub fn pump(&mut self, byte: u8) -> Result<()> {
        debug!("BYTE 0b{0:08b} 0x{0:02X} {1:?}", byte, char::from(byte));
        self.pipe.set(byte);
        self.resume()
    }

    fn resume(&mut self) -> Result<()> {
        match self.gen.as_mut().resume() {
            GeneratorState::Yielded(()) => Ok(()),
            GeneratorState::Complete(Err(err)) => Err(err),
        }
    }
}

fn outputs_map<'cli>(outputs: &'cli [Output<'cli>]) -> [Streams<'cli>; PORTS_COUNT] {
    let mut map: [Streams<'_>; PORTS_COUNT] = Default::default();
    for Output { ports, output } in outputs {
        if ports.is_empty() {
            for outputs in &mut map {
                outputs.push(output);
            }
        } else {
            for port in *ports {
                map[*port as usize].push(output);
            }
        }
    }
    map
}

#[allow(clippy::too_many_lines, clippy::cognitive_complexity)]
fn parser<'cli>(
    outputs: &'cli [Output<'cli>],
    pipe: Rc<Cell<u8>>,
) -> impl Generator<Yield = (), Return = Result<!>> + 'cli {
    let outputs = outputs_map(outputs);
    let mut bytes = SmallVec::<[u8; 16]>::new();
    macro_rules! next_byte {
        () => {{
            yield;
            pipe.get()
        }};
    }
    macro_rules! recycle {
        ($payload:ident) => {
            for &byte in $payload.iter().rev() {
                bytes.push(byte);
            }
        };
    }
    static move || loop {
        bytes.push(next_byte!());
        while let Some(byte) = bytes.pop() {
            if byte == 0 {
                let mut zeros = 8;
                let mut payload = SmallVec::<[u8; 8]>::new();
                loop {
                    let byte = next_byte!();
                    payload.push(byte);
                    zeros += byte.trailing_zeros();
                    if byte != 0 {
                        if zeros >= 47 {
                            synchronization_packet(zeros);
                        } else {
                            warn!("Bad synchronization packet with {} zeros", zeros);
                            recycle!(payload);
                        }
                        break;
                    }
                }
            } else if byte == 0b0111_0000 {
                warn!("Overflow");
            } else if byte & 0b0000_1011 == 0b0000_1000 {
                let sh = byte << 5 >> 7;
                let ex = byte << 1 >> 5;
                if byte >> 7 == 0 {
                    extension_packet(sh, ex, &[]);
                    continue;
                }
                let mut payload = SmallVec::<[u8; 4]>::with_capacity(4);
                loop {
                    let byte = next_byte!();
                    payload.push(byte);
                    if byte >> 7 == 0 {
                        extension_packet(sh, ex, &payload);
                        break;
                    } else if payload.len() == 4 {
                        warn!("Bad extension packet");
                        recycle!(payload);
                        break;
                    }
                }
            } else if byte & 0b0000_1011 == 0 {
                let kind = if byte & 0b1000_1111 == 0
                    && byte & 0b0111_0000 != 0b0000_0000
                    && byte & 0b0111_0000 != 0b0111_0000
                {
                    let payload = byte << 1 >> 5;
                    timestamp_packet(&Timestamp::Local { tc: 0 }, &[payload]);
                    continue;
                } else if byte & 0b1100_1111 == 0b1100_0000 {
                    let tc = byte << 2 >> 6;
                    Timestamp::Local { tc }
                } else if byte == 0b1001_0100 {
                    Timestamp::Global1
                } else if byte == 0b1011_0100 {
                    Timestamp::Global2
                } else {
                    warn!("Invalid header");
                    continue;
                };
                let mut payload = SmallVec::<[u8; 4]>::with_capacity(4);
                loop {
                    let byte = next_byte!();
                    payload.push(byte);
                    if byte >> 7 == 0 {
                        timestamp_packet(&kind, &payload);
                        break;
                    } else if payload.len() == 4 {
                        warn!("Bad local timestamp packet");
                        recycle!(payload);
                        break;
                    }
                }
            } else {
                let software = byte & 0b100 == 0;
                let address = byte >> 3;
                let size = match byte & 0b11 {
                    0b01 => 1,
                    0b10 => 2,
                    0b11 => 4,
                    _ => {
                        warn!("Invalid header");
                        continue;
                    }
                };
                let mut payload = SmallVec::<[u8; 4]>::with_capacity(size);
                while payload.len() < size {
                    let byte = next_byte!();
                    payload.push(byte);
                }
                source_packet(software, address, &payload, &outputs)?;
            }
        }
        bytes.shrink_to_fit();
    }
}

fn synchronization_packet(zeros: u32) {
    debug!("Synchronized with {} zeros", zeros);
}

fn extension_packet(sh: u8, ex: u8, payload: &[u8]) {
    debug!("Extension packet sh={}, ex={}, payload={:?}", sh, ex, payload);
}

fn timestamp_packet(timestamp: &Timestamp, payload: &[u8]) {
    match timestamp {
        Timestamp::Local { tc } => {
            debug!("Local timestamp tc={}, ts={:?}", tc, payload);
        }
        Timestamp::Global1 => {
            debug!("Global timestamp 1 ts={:?}", payload);
        }
        Timestamp::Global2 => {
            debug!("Global timestamp 2 ts={:?}", payload);
        }
    }
}

fn source_packet(software: bool, port: u8, payload: &[u8], outputs: &[Streams<'_>]) -> Result<()> {
    debug!(
        "{} packet {:?} {:?}",
        if software { "Software" } else { "Hardware" },
        payload,
        String::from_utf8_lossy(payload)
    );
    for output in &outputs[port as usize] {
        output.borrow_mut().write(payload)?;
    }
    Ok(())
}