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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
use crate::SliceCell;
use std::{
    io::{self, Read, Seek, SeekFrom, Write},
    vec::Vec,
};
#[cfg(feature = "tokio")]
use std::{
    pin::Pin,
    task::{Context, Poll},
};
#[cfg(feature = "tokio")]
use tokio::io::{AsyncRead, AsyncSeek, AsyncWrite, ReadBuf};

// mostly copied from stdlib: e.g. library/std/src/io/cursor.rs:281
// note that these *cannot* implement BufRead, since fill_buf returns a `&[u8]` which could be
// shared with another thread.

impl Write for &SliceCell<u8> {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        let write_len = std::cmp::min(self.len(), buf.len());
        if write_len > 0 {
            self[..write_len].copy_from_slice(buf);
            *self = self.split_at(write_len).1;
        }
        Ok(write_len)
    }

    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}

impl Read for &SliceCell<u8> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        let read_len = std::cmp::min(self.len(), buf.len());
        if read_len > 0 {
            self[..read_len].copy_into_slice(&mut buf[..read_len]);
            *self = self.split_at(read_len).1;
        }
        Ok(read_len)
    }
    fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
        let read_len = self.len();
        if read_len == 0 {
            return Ok(0);
        }
        buf.reserve(read_len);
        // SAFETY: cannot use `Vec::extend_from_slice`, since it calls `T::clone`, which is arbitrary user code.
        unsafe {
            let write_into = buf.spare_capacity_mut();
            debug_assert!(write_into.len() >= read_len);
            std::ptr::copy_nonoverlapping(
                self.as_ptr().cast::<u8>(),
                write_into.as_mut_ptr().cast(),
                read_len,
            );
            buf.set_len(buf.len() + read_len);
        }
        *self = self.split_at(read_len).1;
        Ok(read_len)
    }
}

pub struct Cursor<T> {
    inner: T,
    pos: u64,
}

// SAFETY: We do not allow access to the inner `T` by (pinned) reference.
impl<T> Unpin for Cursor<T> {}

impl<T> Cursor<T> {
    pub const fn new(inner: T) -> Self {
        Self { inner, pos: 0 }
    }

    pub fn into_inner(self) -> T {
        self.inner
    }

    pub fn position(&self) -> u64 {
        self.pos
    }

    pub fn set_position(&mut self, pos: u64) {
        self.pos = pos;
    }
}

impl<T: AsRef<SliceCell<u8>>> Cursor<T> {
    pub fn remaining_slice(&self) -> &SliceCell<u8> {
        let len = self.pos.min(self.inner.as_ref().len() as u64);
        &self.inner.as_ref()[(len as usize)..]
    }
}

impl<T: AsRef<SliceCell<u8>>> Write for Cursor<T> {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        let slice: &SliceCell<u8> = self.inner.as_ref();
        let pos = std::cmp::min(self.pos, slice.len() as u64);
        let amt = (&slice[(pos as usize)..]).write(buf)?;
        self.pos += amt as u64;
        Ok(amt)
    }

    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}

impl<T: AsRef<SliceCell<u8>>> Read for Cursor<T> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        let n = Read::read(&mut self.remaining_slice(), buf)?;
        self.pos += n as u64;
        Ok(n)
    }
    fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
        let n = buf.len();
        Read::read_exact(&mut self.remaining_slice(), buf)?;
        self.pos += n as u64;
        Ok(())
    }
}

impl<T: AsRef<SliceCell<u8>>> Seek for Cursor<T> {
    fn seek(&mut self, style: SeekFrom) -> io::Result<u64> {
        let (base_pos, offset) = match style {
            SeekFrom::Start(n) => {
                self.pos = n;
                return Ok(n);
            }
            SeekFrom::End(n) => (self.inner.as_ref().len() as u64, n),
            SeekFrom::Current(n) => (self.pos, n),
        };
        match base_pos.checked_add_signed(offset) {
            Some(n) => {
                self.pos = n;
                Ok(self.pos)
            }
            None => Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                "invalid seek to a negative or overflowing position",
            )),
        }
    }
}

#[cfg(feature = "tokio")]
impl AsyncRead for &SliceCell<u8> {
    fn poll_read(
        mut self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        let read_len = std::cmp::min(buf.remaining(), self.len());
        if read_len > 0 {
            if cfg!(feature = "tokio_assumptions") {
                // SAFETY: Assumes that `ReadBuf::put_slice` does not perform a
                // context switch, and that it only accesses itself and the slice
                // passed to it. (i.e. it does not access *self except through
                // the reference we pass to it)
                buf.put_slice(unsafe { &*self[..read_len].as_ptr() });
            } else {
                // SAFETY: we do not de-initialize any bytes of this buffer
                let unfilled = unsafe { buf.unfilled_mut() };
                debug_assert!(
                    read_len <= unfilled.len(),
                    "unfilled.len() should be == buf.remaining()"
                );
                // SAFETY: we are copying read_len bytes from `self` into `unfilled`.
                // We know they do not overlap, since `unfilled` is `&mut [u8]` and
                // `self` is a cell type.
                // We know we do not go off the end of either, since `read_len` is
                // the minimum of their lengths.
                unsafe {
                    std::ptr::copy_nonoverlapping(
                        self.as_ptr() as *const u8,
                        unfilled.as_mut_ptr().cast(),
                        read_len,
                    );
                }
                // SAFETY: we just wrote read_len bytes
                unsafe {
                    buf.assume_init(read_len);
                }
                buf.advance(read_len);
            }
            *self = self.split_at(read_len).1;
        }
        Poll::Ready(Ok(()))
    }
}

#[cfg(feature = "tokio")]
impl AsyncWrite for &SliceCell<u8> {
    fn poll_write(
        mut self: Pin<&mut Self>,
        _: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<Result<usize, io::Error>> {
        Poll::Ready(self.write(buf))
    }

    fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
        Poll::Ready(Ok(()))
    }

    fn poll_shutdown(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
        Poll::Ready(Ok(()))
    }
}

#[cfg(feature = "tokio")]
impl<T: AsRef<SliceCell<u8>>> AsyncRead for Cursor<T> {
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        let old_len = buf.filled().len();
        std::task::ready!(AsyncRead::poll_read(
            Pin::new(&mut self.remaining_slice()),
            cx,
            buf
        ))?;
        let new_len = buf.filled().len();
        self.pos += (new_len - old_len) as u64;
        Poll::Ready(Ok(()))
    }
}

#[cfg(feature = "tokio")]
impl<T: AsRef<SliceCell<u8>>> AsyncWrite for Cursor<T> {
    fn poll_write(
        mut self: Pin<&mut Self>,
        _: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<Result<usize, io::Error>> {
        Poll::Ready(self.write(buf))
    }

    fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
        Poll::Ready(Ok(()))
    }

    fn poll_shutdown(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
        Poll::Ready(Ok(()))
    }
}

#[cfg(feature = "tokio")]
impl<T: AsRef<SliceCell<u8>>> AsyncSeek for Cursor<T> {
    fn start_seek(mut self: Pin<&mut Self>, style: SeekFrom) -> io::Result<()> {
        self.seek(style)?;
        Ok(())
    }

    fn poll_complete(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<io::Result<u64>> {
        Poll::Ready(Ok(self.pos))
    }
}

#[cfg(test)]
mod tests {
    use crate::{io::Cursor, SliceCell};
    use alloc::boxed::Box;
    use std::io::{Read, Seek, Write};

    #[test]
    fn concurrent() {
        let data: Box<SliceCell<u8>> =
            SliceCell::new_boxed(std::vec![0u8; 2048].into_boxed_slice());
        let mut writer: Cursor<&SliceCell<u8>> = Cursor::new(&*data);
        let mut reader: Cursor<&SliceCell<u8>> = Cursor::new(&*data);
        let mut buf = [0u8; 14];

        writer.write(b"Hello, world!!").unwrap();

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"Hello, world!!");

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, [0u8; 14]);

        writer.write(b"Wonderful day!").unwrap();
        writer.write(b"wow, much cell").unwrap();

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"wow, much cell");

        reader.seek(std::io::SeekFrom::Start(0)).unwrap();

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"Hello, world!!");
        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"Wonderful day!");
        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"wow, much cell");
    }

    #[test]
    fn rc() {
        let data = SliceCell::try_new_rc(std::vec![0u8; 2048].into()).unwrap();
        let mut writer = Cursor::new(data.clone());
        let mut reader = Cursor::new(data.clone());
        drop(data);
        let mut buf = [0u8; 14];

        writer.write(b"Hello, world!!").unwrap();

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"Hello, world!!");

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, [0u8; 14]);

        writer.write(b"Wonderful day!").unwrap();
        writer.write(b"wow, much cell").unwrap();

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"wow, much cell");

        reader.seek(std::io::SeekFrom::Start(0)).unwrap();

        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"Hello, world!!");
        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"Wonderful day!");
        reader.read(&mut buf).unwrap();
        assert_eq!(buf, *b"wow, much cell");
    }
}