cpu/io/

dev_petr.rs

//! Photoelectric Paper tape reader, unit 52
//!
//! The paper tape reader has 7 channels.
//!
//! Tape movement can occur in either of two directions, in the bin
//! direction and in the reel direction.  Tape reads occur in the
//! "reel" direction.  The modes of operation of the motor in the
//! "bin" direction both stop and reverse direction when the END MARK
//! is detected.  In other words, this is analogous to rewinding to the
//! beginning-of-file in preparation for reading the file.
//!
//! The reader can read both strip tape and reel tape, and does so at
//! different speeds (because of the different levels of rubustness of
//! the two types of tape), but we operate as if all tapes are read
//! at the same speed.
//!
//! We do not currently simulate acceleration/deceleration of the
//! tape.  On start, reading begins immediately at full speed, and on
//! stop, the tape movement stops immediately.  This will likely
//! change in the future.
//!
//! Lincoln Lab Group Report 51-8 "The Lincoln Writer" states (page
//! 13) that the "END MARK" punched by the LW is the 6-bit code octal
//! 72 without a 7th hole punched on the tape.
use std::fmt::Write;
use std::fmt::{self, Debug, Display, Formatter};
use std::time::Duration;

use base::prelude::*;
use std::cmp;

use conv::*;
use tracing::{Level, event};

use crate::diagnostics::CurrentInstructionDiagnostics;

use super::*;
use super::{TransferFailed, Unit, UnitStatus};

/// Is the tape motor running?
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
enum Activity {
    Stopped,
    Started,
}

impl Display for Activity {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), fmt::Error> {
        f.write_str(match self {
            Activity::Stopped => "stopped",
            Activity::Started => "running",
        })
    }
}

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
enum Direction {
    // Capstan drive is running in the bin direction (as in
    // immediately after IOS 30104, before END MARK has been read).
    Bin,

    // Capstan drive is running in the reel direction (as in after IOS
    // 30104, after END MARK has been read).
    Reel,
}

impl Display for Direction {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), fmt::Error> {
        f.write_str(match self {
            Direction::Bin => "bin",
            Direction::Reel => "reel",
        })
    }
}

fn next_line_time(direction: Direction, system_time: &Duration) -> Duration {
    // The reader reads at between 400 and 2500 lines per second.
    //
    // We don't want to avoidably generate missing data alarms, so
    // for now, we simulate data reading at the slowest speed and
    // non-reading tape movements at the highest speed.
    *system_time
        + match direction {
            Direction::Bin => {
                // At 2500 lines per second, the interval between
                // lines is 1s / 2500 = 400 microseconds.
                Duration::from_micros(400)
            }
            Direction::Reel => {
                // At 400 lines per second, the interval between lines
                // is 1s / 400 = 2500 microseconds.
                Duration::from_micros(2500)
            }
        }
}

pub(crate) struct Petr {
    // Activity and direction cannot just be left encoded in mode,
    // because we need to be able to start/stop the motor and change
    // direction without changing the mode value (since the programmer
    // controls that).
    activity: Activity,
    direction: Direction,
    tape_data: Vec<u8>,
    tape_pos: usize,
    data: Option<u8>,
    already_warned_eof: bool,
    read_failed: bool,
    overrun: bool,
    time_of_next_read: Option<Duration>,
    connected_at_system_time: Option<Duration>,
    connected_at_elapsed_time: Option<Duration>,
    rewind_line_counter: usize,
    mode: Unsigned12Bit,
}

impl Debug for Petr {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), fmt::Error> {
        f.debug_struct("Petr")
            .field("activity", &self.activity)
            .field("direction", &self.direction)
            .field("tape_data", &self.tape_data)
            .field("tape_pos", &self.tape_pos)
            .field("data", &self.data)
            .field("already_warned_eof", &self.already_warned_eof)
            .field("read_failed", &self.read_failed)
            .field("overrun", &self.overrun)
            .field("time_of_next_read", &self.time_of_next_read)
            .field("connected_at_system_time", &self.connected_at_system_time)
            .field("connected_at_elapsed_time", &self.connected_at_elapsed_time)
            .field("rewind_line_counter", &self.rewind_line_counter)
            .field("mode", &self.mode)
            .finish_non_exhaustive()
    }
}

impl Petr {
    pub(crate) fn new() -> Petr {
        Petr {
            activity: Activity::Stopped,
            direction: Direction::Bin,
            tape_data: Vec::new(),
            tape_pos: 0,
            data: None,
            already_warned_eof: false,
            read_failed: false,
            overrun: false,
            time_of_next_read: None,
            connected_at_system_time: None,
            connected_at_elapsed_time: None,
            rewind_line_counter: 0,
            mode: Unsigned12Bit::ZERO,
        }
    }

    fn next_poll_time(&mut self, system_time: &Duration) -> Duration {
        match self.time_of_next_read {
            Some(t) => {
                let result = cmp::max(t, *system_time);
                if let Some(interval) = result.checked_sub(*system_time) {
                    event!(
                        Level::DEBUG,
                        "next_poll_time: please poll after {interval:?} at system time {t:?}"
                    );
                }
                result
            }
            None => {
                let interval = Duration::from_secs(1);
                let next = *system_time + interval;
                event!(
                    Level::DEBUG,
                    "next_poll_time: time_of_next_read is None, using default {system_time:?}+{interval:?}={:?}; self={:?}",
                    next,
                    &self
                );
                next
            }
        }
    }

    fn do_rewind(&mut self) {
        match self.rewind_line_counter.checked_sub(1) {
            None | Some(0) => {
                // We reached - or were already at - the END MARK,
                // reverse direction.
                event!(Level::INFO, "reached the end mark, reversing direction");
                assert!(self.direction == Direction::Bin);
                self.direction = Direction::Reel;
            }
            Some(reduced_by_1) => {
                self.rewind_line_counter = reduced_by_1;
                event!(
                    Level::DEBUG,
                    "rewound over a line: {} more to go",
                    self.rewind_line_counter
                );
            }
        }
    }

    fn do_read(&mut self) {
        // A line of the simulated tape should have appeared under the
        // read head.
        match self.tape_data.get(self.tape_pos) {
            None => {
                // At EOF.  We don't stop the motor, but if the
                // real PETR device can detect when the whole tape
                // has already passed through, perhaps we should.
                if self.already_warned_eof {
                    event!(
                        Level::DEBUG,
                        "reading again at end-of-file at position {}",
                        self.tape_pos
                    );
                } else {
                    self.already_warned_eof = true;
                    event!(
                        Level::WARN,
                        "end-of-file on tape input file at position {}",
                        self.tape_pos
                    );
                }
                self.time_of_next_read = None;
            }
            Some(byte) => {
                event!(
                    Level::DEBUG,
                    "read a byte at file position {}: {:?}",
                    self.tape_pos,
                    byte
                );
                self.already_warned_eof = false;
                if !self.overrun {
                    self.overrun = self.data.is_some();
                    if self.overrun {
                        event!(Level::WARN, "PETR input overrun");
                    }
                }
                self.data = Some(*byte);
                self.tape_pos += 1;
            }
        }
    }

    fn maybe_simulate_event(&mut self, system_time: &Duration) {
        event!(
            Level::TRACE,
            "maybe_simulate_event: activity={:?}",
            &self.activity
        );
        match self.activity {
            Activity::Started => {
                if let Some(t) = self.time_of_next_read
                    && t > *system_time
                {
                    // The next line has not yet appeared under the read
                    // head.
                    let to_wait = || t - *system_time;
                    event!(
                        Level::TRACE,
                        "motor running ({}) but next line will not be read for {:?} yet",
                        self.direction,
                        to_wait()
                    );
                    return;
                }
                match self.direction {
                    Direction::Bin => {
                        event!(Level::TRACE, "motor running, doing rewind action");
                        self.do_rewind();
                    }
                    Direction::Reel => {
                        event!(Level::TRACE, "motor running, doing read action");
                        self.do_read();
                    }
                }
                // do_read may have stopped the motor, so take account
                // of that.
                self.time_of_next_read = match self.activity {
                    Activity::Started => Some(next_line_time(self.direction, system_time)),
                    Activity::Stopped => None,
                }
            }
            Activity::Stopped => {
                // The motor is not running.  So no events (of lines
                // passing under the photodetector) will happen.
                event!(Level::TRACE, "motor stopped, nothing more to simulate");
                self.time_of_next_read = None;
            }
        }
    }

    fn transfer_mode(&self) -> TransferMode {
        if self.mode & 0o02 != 0 {
            TransferMode::Assembly
        } else {
            TransferMode::Exchange
        }
    }
}

struct Throughput {
    lines_per_second: f64,
    total_seconds: f64,
}

fn compute_throughput(
    pos: usize,
    connect_time: Option<Duration>,
    now: Duration,
) -> Option<Throughput> {
    if let Some(connected_at) = connect_time
        && let Some(elapsed) = now.checked_sub(connected_at)
    {
        let elapsed = elapsed.as_secs_f64();

        // It seems that in a WASM build, f64::value_from(usize)
        // is irrefutable.  But clippy doesn't warn about it in
        // non-WASM builds because it's not always irrefutable.
        #[allow(irrefutable_let_patterns)]
        if let Ok(n) = f64::value_from(pos) {
            let throughput = n / elapsed;
            return Some(Throughput {
                lines_per_second: throughput,
                total_seconds: elapsed,
            });
        }
    }
    None
}

impl Unit for Petr {
    fn poll(&mut self, ctx: &Context) -> UnitStatus {
        let system_time = &ctx.simulated_time;
        event!(Level::TRACE, "poll called at system time  {system_time:?}");

        self.maybe_simulate_event(system_time);
        let data_ready: bool = self.data.is_some();
        let poll_after = self.next_poll_time(system_time);
        event!(Level::TRACE, "PETR poll: poll_after={poll_after:?}");
        UnitStatus {
            special: Unsigned12Bit::ZERO,
            change_flag: if data_ready {
                Some(FlagChange::Raise("data is ready"))
            } else {
                None
            },
            buffer_available_to_cpu: data_ready,
            inability: self.read_failed,
            missed_data: self.overrun,
            mode: self.mode,
            poll_after,
            is_input_unit: true,
        }
    }

    fn connect(&mut self, ctx: &Context, mode: Unsigned12Bit) {
        let system_time = &ctx.simulated_time;
        self.connected_at_elapsed_time = Some(ctx.real_elapsed_time);
        self.connected_at_system_time = Some(ctx.simulated_time);
        self.direction = if mode & 0o04 != 0 {
            Direction::Bin
        } else {
            Direction::Reel
        };
        self.activity = if mode & 0o100 != 0 {
            self.time_of_next_read = Some(next_line_time(self.direction, system_time));
            Activity::Started
        } else {
            // While the motor is not running, no data will arrive.
            self.time_of_next_read = None;
            Activity::Stopped
        };
        self.tape_pos = 0;
        self.mode = mode;
        let transfer_mode_name = match self.transfer_mode() {
            TransferMode::Assembly => "assembly",
            TransferMode::Exchange => "exchange",
        };
        event!(
            Level::INFO,
            "PETR connected; motor {}, direction {}; {} mode {:o} (time_of_next_read={:?})",
            self.activity,
            self.direction,
            transfer_mode_name,
            self.mode,
            self.time_of_next_read,
        );
    }

    fn transfer_mode(&self) -> TransferMode {
        self.transfer_mode()
    }

    fn read(
        &mut self,
        ctx: &Context,
        _diagnostics: &CurrentInstructionDiagnostics,
    ) -> Result<MaskedWord, TransferFailed> {
        let system_time = &ctx.simulated_time;
        match self.data.take() {
            None => {
                event!(Level::DEBUG, "no data is ready yet");
                Err(TransferFailed::BufferNotFree)
            }
            Some(byte) => {
                // This calculation of time_of_next_read is not right,
                // as the interval is between physical paper-tape
                // lines, not between I/O instrucitons.
                self.time_of_next_read = Some(next_line_time(self.direction, system_time));
                event!(Level::DEBUG, "read value {:03o}", byte & 0o77);
                Ok(MaskedWord {
                    bits: Unsigned36Bit::from(byte & 0o77),
                    mask: u36!(0o77),
                })
            }
        }
    }

    fn write(
        &mut self,
        _ctx: &Context,
        _source: Unsigned36Bit,
        diagnostics: &CurrentInstructionDiagnostics,
    ) -> Result<Option<OutputEvent>, TransferFailed> {
        unreachable!("attempted to write to the paper tape reader ({diagnostics})")
    }

    fn name(&self) -> String {
        "PETR photoelectric paper tape reader".to_string()
    }

    fn disconnect(&mut self, _ctx: &Context) {
        event!(Level::INFO, "PETR disconnecting");
        self.activity = Activity::Stopped;
    }

    fn on_input_event(
        &mut self,
        _ctx: &Context,
        event: InputEvent,
    ) -> Result<InputFlagRaised, InputEventError> {
        if let InputEvent::PetrMountPaperTape { data } = event {
            event!(Level::DEBUG, "Mounting a tape ({} bytes)", data.len());
            self.tape_data = data;
            // The input flag is raised only when input is actually
            // available.  That is, when a line passes under the
            // detector.
            Ok(InputFlagRaised::No)
        } else {
            Err(InputEventError::InputEventNotValidForDevice)
        }
    }

    fn text_info(&self, ctx: &Context) -> String {
        let build = || -> Result<String, std::fmt::Error> {
            let mut result = String::new();
            write!(result, "Motor {}", self.activity)?;
            match self.activity {
                Activity::Started => {
                    write!(result, " (direction {})", self.direction)?;
                }
                Activity::Stopped => (),
            }
            write!(result, ". ")?;
            if self.tape_data.is_empty() {
                write!(result, "No tape (or blank tape) loaded. ")?;
            } else {
                write!(
                    result,
                    "Loaded tape has {} lines, we have read {}. ",
                    self.tape_data.len(),
                    self.tape_pos
                )?;
                if let Some(throughput) = compute_throughput(
                    self.tape_pos,
                    self.connected_at_system_time,
                    ctx.simulated_time,
                ) {
                    write!(
                        result,
                        "Emulated duration {:.1} seconds, so emulated throughput is {:.1} lines/sec. ",
                        throughput.total_seconds, throughput.lines_per_second,
                    )?;
                }
                if let Some(throughput) = compute_throughput(
                    self.tape_pos,
                    self.connected_at_elapsed_time,
                    ctx.real_elapsed_time,
                ) {
                    write!(
                        result,
                        "Real duration {:.1} seconds, so real throughput is {:.1} lines/sec.",
                        throughput.total_seconds, throughput.lines_per_second,
                    )?;
                }
            }
            Ok(result)
        };
        build().expect("write! calls on a String should always succeed")
    }
}