1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
//! Aims to provide a simple pipe-like functionality for async code.
//!
//! # Example
//!
//! ```rust
//! # #[tokio::main]
//! # async fn main() {
//! #    use tokio::io::{AsyncWriteExt, AsyncReadExt};
//!     let (mut reader, mut writer) = simple_async_pipe::pipe(64);
//!
//!     let message = b"hello world";
//!     writer.write_all(message).await.unwrap();
//!
//!     let mut buffer = vec![0u8; message.len()];
//!     reader.read_exact(&mut buffer).await.unwrap();
//!     assert_eq!(&buffer, message);
//! # }
//! ```

use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::{Context, Poll, Waker};

use tokio::io::{AsyncRead, AsyncWrite, ReadBuf};
use tokio::sync::mpsc;
use tokio::sync::mpsc::error::TrySendError;

pub struct PipeWrite {
    sender: mpsc::Sender<Vec<u8>>,
    shared: Arc<Mutex<PipeShared>>,
}

pub struct PipeRead {
    read_remaining: Vec<u8>,
    receiver: mpsc::Receiver<Vec<u8>>,
    shared: Arc<Mutex<PipeShared>>,
}

struct PipeShared {
    read_waker: Option<Waker>,
    write_waker: Option<Waker>,
}

/// Creates a in-memory pipe. [PipeWrite] will not succeed instant if the internal buffer is full.
pub fn pipe(buffer: usize) -> (PipeRead, PipeWrite) {
    let (sender, receiver) = mpsc::channel(buffer);
    let shared = Arc::new(Mutex::new(PipeShared {
        read_waker: Default::default(),
        write_waker: Default::default(),
    }));

    let read = PipeRead {
        receiver,
        read_remaining: Default::default(),
        shared: shared.clone(),
    };
    let write = PipeWrite {
        sender,
        shared: shared.clone(),
    };

    (read, write)
}

impl AsyncWrite for PipeWrite {
    fn poll_write(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<Result<usize, std::io::Error>> {
        match self.sender.try_send(buf.to_vec()) {
            Ok(_) => {
                if let Some(read_waker) = self.shared.lock().unwrap().read_waker.take() {
                    read_waker.wake();
                }
                Poll::Ready(Ok(buf.len()))
            }
            Err(e) => match e {
                TrySendError::Full(_) => {
                    self.shared.lock().unwrap().write_waker = Some(cx.waker().clone());
                    Poll::Pending
                }
                TrySendError::Closed(_) => Poll::Ready(Err(std::io::Error::new(
                    std::io::ErrorKind::BrokenPipe,
                    "receiver closed",
                ))),
            },
        }
    }

    fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), std::io::Error>> {
        // TODO: Implement kind of flushing
        Poll::Ready(Ok(()))
    }

    fn poll_shutdown(
        self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
    ) -> Poll<Result<(), std::io::Error>> {
        // TODO: Check if there is something to do. Maybe drop sender?
        Poll::Ready(Ok(()))
    }
}

impl AsyncRead for PipeRead {
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<std::io::Result<()>> {
        let mut write_to_buf = |vec: &[u8]| -> Vec<u8> {
            let end = std::cmp::min(buf.remaining(), vec.len());
            let slice_to_write = &vec[0..end];
            buf.put_slice(slice_to_write);

            let rest_of_vec = &vec[end..];
            rest_of_vec.to_vec()
        };

        if self.read_remaining.len() > 0 {
            self.read_remaining = write_to_buf(&mut self.read_remaining);
            return Poll::Ready(Ok(()));
        }

        match self.receiver.poll_recv(cx) {
            Poll::Ready(v) => match v {
                None => Poll::Ready(Err(std::io::Error::new(
                    std::io::ErrorKind::BrokenPipe,
                    "sender closed",
                ))),
                Some(v) => {
                    self.read_remaining = write_to_buf(&v);
                    if let Some(waker) = self.shared.lock().unwrap().write_waker.take() {
                        waker.wake();
                    }
                    Poll::Ready(Ok(()))
                }
            },
            Poll::Pending => Poll::Pending,
        }
    }
}

#[cfg(test)]
mod tests {
    use tokio::io::{AsyncReadExt, AsyncWriteExt};

    use super::*;

    #[tokio::test]
    async fn test_single_write() {
        let (mut reader, mut writer) = pipe(512);

        let to_send = b"hello world";
        writer.write_all(to_send).await.expect("error writing");

        let mut buffer = vec![0u8; to_send.len()];
        reader.read_exact(&mut buffer).await.expect("error reading");

        assert_eq!(&buffer, to_send);
    }

    #[tokio::test]
    async fn test_multi_write() {
        let (mut reader, mut writer) = pipe(512);

        let to_send = b"hello world";
        writer.write_all(b"hello").await.expect("error writing");
        writer.write_all(b" world").await.expect("error writing");

        let mut buffer = vec![0u8; to_send.len()];
        reader.read_exact(&mut buffer).await.expect("error reading");

        assert_eq!(&buffer, to_send);
    }

    #[tokio::test]
    async fn test_write_more_than_buffer() {
        let (mut reader, mut writer) = pipe(2);

        let to_send = b"hello world";
        tokio::spawn(async move {
            writer.write_all(b"hello").await.expect("error writing");
            writer.write_all(b" world").await.expect("error writing");
        });

        let mut buffer = vec![0u8; to_send.len()];
        reader.read_exact(&mut buffer).await.expect("error reading");

        assert_eq!(&buffer, to_send);
    }
}