Files
RedBear-OS/net/driver-network/src/lib.rs
T
2024-03-06 21:09:38 +01:00

276 lines
8.1 KiB
Rust

use std::collections::BTreeMap;
use std::fs::File;
use std::io::{ErrorKind, Read, Write};
use std::os::fd::{AsRawFd, FromRawFd, RawFd};
use std::{cmp, io};
use syscall::{
Error, EventFlags, Packet, Result, SchemeBlockMut, Stat, EACCES, EBADF, EINVAL, EWOULDBLOCK,
MODE_FILE, O_NONBLOCK,
};
pub trait NetworkAdapter {
/// The [MAC address](https://en.wikipedia.org/wiki/MAC_address) of this
/// network adapter.
fn mac_address(&mut self) -> [u8; 6];
/// The amount of network packets that can be read without blocking.
fn available_for_read(&mut self) -> usize;
/// Attempt to read a network packet without blocking.
///
/// Returns `Ok(None)` when there is no pending network packet.
fn read_packet(&mut self, buf: &mut [u8]) -> Result<Option<usize>>;
/// Write a single network packet.
// FIXME support back pressure on writes by returning EWOULDBLOCK or not
// returning from the write syscall until there is room.
fn write_packet(&mut self, buf: &[u8]) -> Result<usize>;
}
pub struct NetworkScheme<T: NetworkAdapter> {
adapter: T,
scheme_name: String,
scheme: File,
next_id: usize,
handles: BTreeMap<usize, Handle>,
todo_packets: Vec<Packet>,
}
#[derive(Copy, Clone)]
enum Handle {
Data { flags: usize },
Mac { offset: usize },
}
impl<T: NetworkAdapter> NetworkScheme<T> {
pub fn new(adapter: T, scheme_name: String) -> Self {
assert!(scheme_name.starts_with("network"));
let scheme_fd = syscall::open(
format!(":{scheme_name}"),
syscall::O_RDWR | syscall::O_CREAT | syscall::O_NONBLOCK,
)
.expect("failed to create network scheme");
let scheme = unsafe { File::from_raw_fd(scheme_fd as RawFd) };
NetworkScheme {
adapter,
scheme_name,
scheme,
next_id: 0,
handles: BTreeMap::new(),
todo_packets: vec![],
}
}
pub fn event_handle(&self) -> RawFd {
self.scheme.as_raw_fd()
}
pub fn adapter(&self) -> &T {
&self.adapter
}
pub fn adapter_mut(&mut self) -> &mut T {
&mut self.adapter
}
/// Process pending and new packets.
///
/// This needs to be called each time there is a new event on the scheme
/// file and each time a new network packet has been received by the
/// driver.
// FIXME maybe split into one method for events on the scheme fd and one
// to call when an irq is received to indicate that blocked packets can
// be processed.
pub fn tick(&mut self) -> io::Result<()> {
// Handle any blocked packets
let mut i = 0;
while i < self.todo_packets.len() {
let mut packet = self.todo_packets[i].clone();
if let Some(a) = self.handle(&packet) {
self.todo_packets.remove(i);
packet.a = a;
self.scheme.write(&packet)?;
} else {
i += 1;
}
}
// Handle new scheme packets
loop {
let mut packet = Packet::default();
match self.scheme.read(&mut packet) {
Ok(0) => {
return Err(io::Error::new(
ErrorKind::BrokenPipe,
"scheme has been closed by the kernel",
));
}
Ok(_) => {}
Err(err) if err.kind() == ErrorKind::WouldBlock => break,
Err(err) => {
return Err(err);
}
}
if let Some(a) = self.handle(&packet) {
packet.a = a;
self.scheme.write(&packet)?;
} else {
self.todo_packets.push(packet);
}
}
// Notify readers about incoming events
let available_for_read = self.adapter.available_for_read();
if available_for_read > 0 {
for &handle_id in self.handles.keys() {
self.scheme.write(&Packet {
id: 0,
pid: 0,
uid: 0,
gid: 0,
a: syscall::number::SYS_FEVENT,
b: handle_id,
c: syscall::flag::EVENT_READ.bits(),
d: available_for_read,
})?;
}
return Ok(());
}
Ok(())
}
}
impl<T: NetworkAdapter> SchemeBlockMut for NetworkScheme<T> {
fn open(&mut self, path: &str, flags: usize, uid: u32, _gid: u32) -> Result<Option<usize>> {
if uid != 0 {
return Err(Error::new(EACCES));
}
let handle = match path {
"" => Handle::Data { flags },
"mac" => Handle::Mac { offset: 0 },
_ => return Err(Error::new(EINVAL)),
};
self.next_id += 1;
self.handles.insert(self.next_id, handle);
Ok(Some(self.next_id))
}
fn dup(&mut self, id: usize, buf: &[u8]) -> Result<Option<usize>> {
if !buf.is_empty() {
return Err(Error::new(EINVAL));
}
let handle = *self.handles.get(&id).ok_or(Error::new(EBADF))?;
self.next_id += 1;
self.handles.insert(self.next_id, handle);
Ok(Some(self.next_id))
}
fn read(&mut self, id: usize, buf: &mut [u8]) -> Result<Option<usize>> {
let handle = self.handles.get_mut(&id).ok_or(Error::new(EBADF))?;
let flags = match *handle {
Handle::Data { flags } => flags,
Handle::Mac { ref mut offset } => {
let data = &self.adapter.mac_address()[*offset..];
let i = cmp::min(buf.len(), data.len());
buf[..i].copy_from_slice(&data[..i]);
*offset += i;
return Ok(Some(i));
}
};
match self.adapter.read_packet(buf)? {
Some(count) => Ok(Some(count)),
None => {
if flags & O_NONBLOCK == O_NONBLOCK {
Err(Error::new(EWOULDBLOCK))
} else {
Ok(None)
}
}
}
}
fn write(&mut self, id: usize, buf: &[u8]) -> Result<Option<usize>> {
let handle = self.handles.get(&id).ok_or(Error::new(EBADF))?;
match handle {
Handle::Data { .. } => {}
Handle::Mac { .. } => return Err(Error::new(EINVAL)),
}
Ok(Some(self.adapter.write_packet(buf)?))
}
fn fevent(&mut self, id: usize, _flags: EventFlags) -> Result<Option<EventFlags>> {
let _handle = self.handles.get(&id).ok_or(Error::new(EBADF))?;
Ok(Some(EventFlags::empty()))
}
fn fpath(&mut self, id: usize, buf: &mut [u8]) -> Result<Option<usize>> {
let handle = self.handles.get(&id).ok_or(Error::new(EBADF))?;
let mut i = 0;
let scheme_name = self.scheme_name.as_bytes();
let mut j = 0;
while i < buf.len() && j < scheme_name.len() {
buf[i] = scheme_name[j];
i += 1;
j += 1;
}
if i < buf.len() {
buf[i] = b':';
i += 1;
}
let path = match handle {
Handle::Data { .. } => &b""[..],
Handle::Mac { .. } => &b"mac"[..],
};
j = 0;
while i < buf.len() && j < path.len() {
buf[i] = path[j];
i += 1;
j += 1;
}
Ok(Some(i))
}
fn fstat(&mut self, id: usize, stat: &mut Stat) -> Result<Option<usize>> {
let handle = self.handles.get(&id).ok_or(Error::new(EBADF))?;
match handle {
Handle::Data { .. } => {
stat.st_mode = MODE_FILE | 0o700;
}
Handle::Mac { .. } => {
stat.st_mode = MODE_FILE | 0o400;
stat.st_size = 6;
}
}
Ok(Some(0))
}
fn fsync(&mut self, id: usize) -> Result<Option<usize>> {
let _handle = self.handles.get(&id).ok_or(Error::new(EBADF))?;
Ok(Some(0))
}
fn close(&mut self, id: usize) -> Result<Option<usize>> {
self.handles.remove(&id).ok_or(Error::new(EBADF))?;
Ok(Some(0))
}
}