itm 0.3.1

//! Parse ITM packets from bytes and streams.

use std::io::{self, Cursor, Read};

use failure;

use packet::{self, Instrumentation, Packet};
use Error;

/// Parses ITM packets.
pub struct Decoder<R: Read> {
    inner: R,
    follow: bool,
}

// Copy&Paste from std::io::Read::read_exact
fn read_exact_gently<R: Read>(
    reader: &mut R,
    mut buf: &mut [u8],
    keep_reading: bool,
) -> ::std::io::Result<()> {
    use std::io::{Error, ErrorKind};
    while !buf.is_empty() {
        match reader.read(buf) {
            Ok(0) if !keep_reading => break,
            Ok(0) if keep_reading => continue,
            Ok(n) => {
                let tmp = buf;
                buf = &mut tmp[n..];
            }
            Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
            Err(e) => return Err(e),
        }
    }
    if !buf.is_empty() {
        Err(Error::new(
            ErrorKind::UnexpectedEof,
            "failed to fill whole buffer",
        ))
    } else {
        Ok(())
    }
}

impl<R: Read> Decoder<R> {
    /// Construct a new `Decoder` that reads encoded packets from
    /// `inner`.
    pub fn new(inner: R, follow: bool) -> Decoder<R> {
        Decoder::<R> {
            inner: inner,
            follow: follow,
        }
    }

    // TODO: If we need config for the Decoder, my plan is to:
    // * Add a Config struct with private fields that can be used with
    //   `serde`, built with a builder pattern (`derive_builder` is
    //   great), or built with a Default implementation.
    // * Add a method Decoder.with_config(inner: R, config: Config).

    /// Read a single packet from the inner `Read`. This will block
    /// for input if no full packet is currently an available.
    pub fn read_packet(&mut self) -> Result<Packet, failure::Error> {
        let mut header = [0; 1];
        match self.inner.read_exact(&mut header) {
            Err(ref e) if e.kind() == io::ErrorKind::UnexpectedEof => {
                return Err(Error::EofBeforePacket.into())
            }
            Err(e) => return Err(e.into()),
            Ok(_) => (),
        };
        let header = header[0];
        match header & 0b111 {
            0b001 | 0b010 | 0b011 => {
                // Instrumentation packet.
                let payload_len = match header & 0b11 {
                    0b01 => 1,
                    0b10 => 2,
                    0b11 => 4,
                    _ => unreachable!(), // Contradicts match on last 3 bits.
                };

                let mut ud = Instrumentation {
                    payload: [0; packet::MAX_PAYLOAD_SIZE],
                    payload_len: payload_len,
                    port: header >> 3,
                };

                {
                    // Scope the mutable borrow on buf to satisfy borrow checker.
                    let buf = &mut ud.payload[0..payload_len];
                    match read_exact_gently(&mut self.inner, buf, self.follow) {
                        Err(ref e) if e.kind() == io::ErrorKind::UnexpectedEof => {
                            return Err(Error::EofDuringPacket.into());
                        }
                        Err(e) => return Err(e.into()),
                        Ok(_) => (),
                    };
                }

                Ok(Packet {
                    header: header,
                    kind: packet::Kind::Instrumentation(ud),
                })
            }
            _ => Err(Error::UnknownHeader { byte: header }.into()),
        }
    }
}

/// Decode a single packet from a slice of bytes.
pub fn from_slice(s: &[u8]) -> Result<Packet, failure::Error> {
    let mut d = Decoder::new(Cursor::new(Vec::from(s)), false);
    d.read_packet()
}

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

    use failure;

    use packet::{Kind, Packet};
    use Error;

    #[test]
    fn header() {
        let p = decode_one(&[0x01, 0x11]);
        assert_eq!(p.header, 0x01);
    }

    #[test]
    fn instrumentation_payload_1_byte() {
        let p = decode_one(&[0x01, 0x11]);
        match p.kind {
            Kind::Instrumentation(ref i) => {
                assert_eq!(i.payload(), [0x11]);
            }
            _ => panic!(),
        }
    }

    #[test]
    fn instrumentation_payload_2_bytes() {
        let p = decode_one(&[0x02, 0x11, 0x12]);
        match p.kind {
            Kind::Instrumentation(ref i) => {
                assert_eq!(i.payload(), [0x11, 0x12]);
            }
            _ => panic!(),
        }
    }

    #[test]
    fn instrumentation_payload_4_bytes() {
        let p = decode_one(&[0x03, 0x11, 0x12, 0x13, 0x14]);
        match p.kind {
            Kind::Instrumentation(ref i) => {
                assert_eq!(i.payload(), [0x11, 0x12, 0x13, 0x14]);
            }
            _ => panic!(),
        }
    }

    #[test]
    fn instrumentation_stim_port() {
        let p = decode_one(&[0b00000_001, 0x11]);
        match p.kind {
            Kind::Instrumentation(ref i) => {
                assert_eq!(i.port(), 0);
            }
            _ => panic!(),
        }

        let p = decode_one(&[0b11111_001, 0x11]);
        match p.kind {
            Kind::Instrumentation(ref i) => {
                assert_eq!(i.port(), 31);
            }
            _ => panic!(),
        }
    }

    #[test]
    fn unknown_header() {
        if let Err(e) = try_decode_one(&[0x00]) {
            match e.downcast_ref::<Error>() {
                Some(Error::UnknownHeader { byte: 0 }) => return (),
                _ => {}
            }
        }

        panic!()
    }

    #[test]
    fn eof_before_payload() {
        if let Err(e) = try_decode_one(&[0x01 /* Missing payload bytes */]) {
            match e.downcast_ref::<Error>() {
                Some(Error::EofDuringPacket) => return (),
                _ => {}
            }
        }

        panic!()
    }

    #[test]
    fn eof_before_packet() {
        if let Err(e) = try_decode_one(&[/* Missing packet bytes */]) {
            match e.downcast_ref::<Error>() {
                Some(Error::EofBeforePacket) => return (),
                _ => {}
            }
        }

        panic!()
    }

    fn decode_one(data: &[u8]) -> Packet {
        try_decode_one(data).unwrap()
    }

    fn try_decode_one(data: &[u8]) -> Result<Packet, failure::Error> {
        let p = from_slice(data);
        println!("{:#?}", p);
        p
    }
}