eonix/src/kernel/chardev.rs

use super::{
    block::make_device,
    console::get_console,
    constants::{EEXIST, EIO},
    task::{ProcessList, Thread},
    terminal::Terminal,
    vfs::{
        file::{File, TerminalFile},
        DevId,
    },
};
use crate::{io::Buffer, prelude::*};
use alloc::{
    boxed::Box,
    collections::btree_map::{BTreeMap, Entry},
    sync::Arc,
};
use eonix_sync::AsProof as _;

pub trait VirtualCharDevice: Send + Sync {
    fn read(&self, buffer: &mut dyn Buffer) -> KResult<usize>;
    fn write(&self, data: &[u8]) -> KResult<usize>;
}

pub enum CharDeviceType {
    Terminal(Arc<Terminal>),
    Virtual(Box<dyn VirtualCharDevice>),
}

#[allow(dead_code)]
pub struct CharDevice {
    name: Arc<str>,
    device: CharDeviceType,
}

static CHAR_DEVICES: Spin<BTreeMap<DevId, Arc<CharDevice>>> = Spin::new(BTreeMap::new());

impl CharDevice {
    pub fn read(&self, buffer: &mut dyn Buffer) -> KResult<usize> {
        match &self.device {
            CharDeviceType::Terminal(terminal) => terminal.read(buffer),
            CharDeviceType::Virtual(device) => device.read(buffer),
        }
    }

    pub fn write(&self, data: &[u8]) -> KResult<usize> {
        match &self.device {
            CharDeviceType::Virtual(device) => device.write(data),
            CharDeviceType::Terminal(terminal) => {
                for &ch in data.iter() {
                    terminal.show_char(ch);
                }
                Ok(data.len())
            }
        }
    }

    pub fn get(devid: DevId) -> Option<Arc<CharDevice>> {
        CHAR_DEVICES.lock().get(&devid).cloned()
    }

    pub fn register(devid: DevId, name: Arc<str>, device: CharDeviceType) -> KResult<()> {
        match CHAR_DEVICES.lock().entry(devid) {
            Entry::Vacant(entry) => {
                entry.insert(Arc::new(CharDevice { name, device }));
                Ok(())
            }
            Entry::Occupied(_) => Err(EEXIST),
        }
    }

    pub fn open(self: &Arc<Self>) -> KResult<Arc<File>> {
        Ok(match &self.device {
            CharDeviceType::Terminal(terminal) => {
                let procs = ProcessList::get().read();
                let current = Thread::current();
                let session = current.process.session(procs.prove());
                // We only set the control terminal if the process is the session leader.
                if session.sid == Thread::current().process.pid {
                    // Silently fail if we can't set the control terminal.
                    dont_check!(session.set_control_terminal(&terminal, false, procs.prove()));
                }

                TerminalFile::new(terminal.clone())
            }
            CharDeviceType::Virtual(_) => Arc::new(File::CharDev(self.clone())),
        })
    }
}

struct NullDevice;
impl VirtualCharDevice for NullDevice {
    fn read(&self, _buffer: &mut dyn Buffer) -> KResult<usize> {
        Ok(0)
    }

    fn write(&self, _data: &[u8]) -> KResult<usize> {
        Ok(_data.len())
    }
}

struct ZeroDevice;
impl VirtualCharDevice for ZeroDevice {
    fn read(&self, buffer: &mut dyn Buffer) -> KResult<usize> {
        // TODO: Copy from empty page.
        while let false = buffer.fill(&[0; 16])?.should_stop() {}
        Ok(buffer.wrote())
    }

    fn write(&self, _data: &[u8]) -> KResult<usize> {
        Ok(_data.len())
    }
}

struct ConsoleDevice;
impl VirtualCharDevice for ConsoleDevice {
    fn read(&self, buffer: &mut dyn Buffer) -> KResult<usize> {
        let console_terminal = get_console().ok_or(EIO)?;
        console_terminal.read(buffer)
    }

    fn write(&self, data: &[u8]) -> KResult<usize> {
        let console_terminal = get_console().ok_or(EIO)?;
        for &ch in data.iter() {
            console_terminal.show_char(ch);
        }
        Ok(data.len())
    }
}

impl CharDevice {
    pub fn init() -> KResult<()> {
        Self::register(
            make_device(1, 3),
            Arc::from("null"),
            CharDeviceType::Virtual(Box::new(NullDevice)),
        )?;

        Self::register(
            make_device(1, 5),
            Arc::from("zero"),
            CharDeviceType::Virtual(Box::new(ZeroDevice)),
        )?;

        Self::register(
            make_device(5, 1),
            Arc::from("console"),
            CharDeviceType::Virtual(Box::new(ConsoleDevice)),
        )?;

        Ok(())
    }
}