// This is mostly stubs #![allow(unused_variables, dead_code)] //! Virtual pipes. //! //! These types provide easy implementations of `WasiFile` that mimic much of the behavior of Unix //! pipes. These are particularly helpful for redirecting WASI stdio handles to destinations other //! than OS files. //! //! Some convenience constructors are included for common backing types like `Vec` and `String`, //! but the virtual pipes can be instantiated with any `Read` or `Write` type. //! use crate::{ file::{Advice, FdFlags, FileType, Filestat, WasiFile}, Error, ErrorExt, SystemTimeSpec, }; use std::any::Any; use std::convert::TryInto; use std::io::{self, Read, Write}; use std::sync::{Arc, RwLock}; /// A virtual pipe read end. /// /// A variety of `From` impls are provided so that common pipe types are easy to create. For example: /// /// ```no_run /// # use std::rc::Rc; /// # use std::cell::RefCell; /// use wasi_common::{pipe::ReadPipe, WasiCtx, Table}; /// let stdin = ReadPipe::from("hello from stdin!"); /// // Brint these instances from elsewhere (e.g. wasi-cap-std-sync): /// let random = todo!(); /// let clocks = todo!(); /// let sched = todo!(); /// let table = Rc::new(RefCell::new(Table::new())); /// let mut ctx = WasiCtx::new(random, clocks, sched, table); /// ctx.set_stdin(Box::new(stdin.clone())); /// ``` #[derive(Debug)] pub struct ReadPipe { reader: Arc>, } impl Clone for ReadPipe { fn clone(&self) -> Self { Self { reader: self.reader.clone(), } } } impl ReadPipe { /// Create a new pipe from a `Read` type. /// /// All `Handle` read operations delegate to reading from this underlying reader. pub fn new(r: R) -> Self { Self::from_shared(Arc::new(RwLock::new(r))) } /// Create a new pipe from a shareable `Read` type. /// /// All `Handle` read operations delegate to reading from this underlying reader. pub fn from_shared(reader: Arc>) -> Self { Self { reader } } /// Try to convert this `ReadPipe` back to the underlying `R` type. /// /// This will fail with `Err(self)` if multiple references to the underlying `R` exist. pub fn try_into_inner(mut self) -> Result { match Arc::try_unwrap(self.reader) { Ok(rc) => Ok(RwLock::into_inner(rc).unwrap()), Err(reader) => { self.reader = reader; Err(self) } } } fn borrow(&self) -> std::sync::RwLockWriteGuard { RwLock::write(&self.reader).unwrap() } } impl From> for ReadPipe>> { fn from(r: Vec) -> Self { Self::new(io::Cursor::new(r)) } } impl From<&[u8]> for ReadPipe>> { fn from(r: &[u8]) -> Self { Self::from(r.to_vec()) } } impl From for ReadPipe> { fn from(r: String) -> Self { Self::new(io::Cursor::new(r)) } } impl From<&str> for ReadPipe> { fn from(r: &str) -> Self { Self::from(r.to_string()) } } #[wiggle::async_trait] impl WasiFile for ReadPipe { fn as_any(&self) -> &dyn Any { self } async fn datasync(&self) -> Result<(), Error> { Ok(()) // trivial: no implementation needed } async fn sync(&self) -> Result<(), Error> { Ok(()) // trivial } async fn get_filetype(&self) -> Result { Ok(FileType::Pipe) } async fn get_fdflags(&self) -> Result { Ok(FdFlags::empty()) } async fn set_fdflags(&mut self, _fdflags: FdFlags) -> Result<(), Error> { Err(Error::badf()) } async fn get_filestat(&self) -> Result { Ok(Filestat { device_id: 0, inode: 0, filetype: self.get_filetype().await?, nlink: 0, size: 0, // XXX no way to get a size out of a Read :( atim: None, mtim: None, ctim: None, }) } async fn set_filestat_size(&self, _size: u64) -> Result<(), Error> { Err(Error::badf()) } async fn advise(&self, offset: u64, len: u64, advice: Advice) -> Result<(), Error> { Err(Error::badf()) } async fn allocate(&self, offset: u64, len: u64) -> Result<(), Error> { Err(Error::badf()) } async fn read_vectored<'a>(&self, bufs: &mut [io::IoSliceMut<'a>]) -> Result { let n = self.borrow().read_vectored(bufs)?; Ok(n.try_into()?) } async fn read_vectored_at<'a>( &self, bufs: &mut [io::IoSliceMut<'a>], offset: u64, ) -> Result { Err(Error::badf()) } async fn write_vectored<'a>(&self, bufs: &[io::IoSlice<'a>]) -> Result { Err(Error::badf()) } async fn write_vectored_at<'a>( &self, bufs: &[io::IoSlice<'a>], offset: u64, ) -> Result { Err(Error::badf()) } async fn seek(&self, pos: std::io::SeekFrom) -> Result { Err(Error::badf()) } async fn peek(&self, buf: &mut [u8]) -> Result { Err(Error::badf()) } async fn set_times( &self, atime: Option, mtime: Option, ) -> Result<(), Error> { Err(Error::badf()) } async fn num_ready_bytes(&self) -> Result { Ok(0) } async fn readable(&mut self) -> Result<(), Error> { Err(Error::badf()) } async fn writable(&mut self) -> Result<(), Error> { Err(Error::badf()) } } /// A virtual pipe write end. /// /// ```no_run /// # use std::rc::Rc; /// # use std::cell::RefCell; /// use wasi_common::{pipe::WritePipe, WasiCtx, Table}; /// let stdout = WritePipe::new_in_memory(); /// // Brint these instances from elsewhere (e.g. wasi-cap-std-sync): /// let random = todo!(); /// let clocks = todo!(); /// let sched = todo!(); /// let table = Rc::new(RefCell::new(Table::new())); /// let mut ctx = WasiCtx::new(random, clocks, sched, table); /// ctx.set_stdout(Box::new(stdout.clone())); /// // use ctx in an instance, then make sure it is dropped: /// drop(ctx); /// let contents: Vec = stdout.try_into_inner().expect("sole remaining reference to WritePipe").into_inner(); /// println!("contents of stdout: {:?}", contents); /// ``` #[derive(Debug)] pub struct WritePipe { writer: Arc>, } impl Clone for WritePipe { fn clone(&self) -> Self { Self { writer: self.writer.clone(), } } } impl WritePipe { /// Create a new pipe from a `Write` type. /// /// All `Handle` write operations delegate to writing to this underlying writer. pub fn new(w: W) -> Self { Self::from_shared(Arc::new(RwLock::new(w))) } /// Create a new pipe from a shareable `Write` type. /// /// All `Handle` write operations delegate to writing to this underlying writer. pub fn from_shared(writer: Arc>) -> Self { Self { writer } } /// Try to convert this `WritePipe` back to the underlying `W` type. /// /// This will fail with `Err(self)` if multiple references to the underlying `W` exist. pub fn try_into_inner(mut self) -> Result { match Arc::try_unwrap(self.writer) { Ok(rc) => Ok(RwLock::into_inner(rc).unwrap()), Err(writer) => { self.writer = writer; Err(self) } } } fn borrow(&self) -> std::sync::RwLockWriteGuard { RwLock::write(&self.writer).unwrap() } } impl WritePipe>> { /// Create a new writable virtual pipe backed by a `Vec` buffer. pub fn new_in_memory() -> Self { Self::new(io::Cursor::new(vec![])) } } #[wiggle::async_trait] impl WasiFile for WritePipe { fn as_any(&self) -> &dyn Any { self } async fn datasync(&self) -> Result<(), Error> { Ok(()) } async fn sync(&self) -> Result<(), Error> { Ok(()) } async fn get_filetype(&self) -> Result { Ok(FileType::Pipe) } async fn get_fdflags(&self) -> Result { Ok(FdFlags::APPEND) } async fn set_fdflags(&mut self, _fdflags: FdFlags) -> Result<(), Error> { Err(Error::badf()) } async fn get_filestat(&self) -> Result { Ok(Filestat { device_id: 0, inode: 0, filetype: self.get_filetype().await?, nlink: 0, size: 0, // XXX no way to get a size out of a Write :( atim: None, mtim: None, ctim: None, }) } async fn set_filestat_size(&self, _size: u64) -> Result<(), Error> { Err(Error::badf()) } async fn advise(&self, offset: u64, len: u64, advice: Advice) -> Result<(), Error> { Err(Error::badf()) } async fn allocate(&self, offset: u64, len: u64) -> Result<(), Error> { Err(Error::badf()) } async fn read_vectored<'a>(&self, bufs: &mut [io::IoSliceMut<'a>]) -> Result { Err(Error::badf()) } async fn read_vectored_at<'a>( &self, bufs: &mut [io::IoSliceMut<'a>], offset: u64, ) -> Result { Err(Error::badf()) } async fn write_vectored<'a>(&self, bufs: &[io::IoSlice<'a>]) -> Result { let n = self.borrow().write_vectored(bufs)?; Ok(n.try_into()?) } async fn write_vectored_at<'a>( &self, bufs: &[io::IoSlice<'a>], offset: u64, ) -> Result { Err(Error::badf()) } async fn seek(&self, pos: std::io::SeekFrom) -> Result { Err(Error::badf()) } async fn peek(&self, buf: &mut [u8]) -> Result { Err(Error::badf()) } async fn set_times( &self, atime: Option, mtime: Option, ) -> Result<(), Error> { Err(Error::badf()) } async fn num_ready_bytes(&self) -> Result { Ok(0) } async fn readable(&mut self) -> Result<(), Error> { Err(Error::badf()) } async fn writable(&mut self) -> Result<(), Error> { Err(Error::badf()) } }