hyperfile 0.3.2

A file-like interface abstraction layer provides random read and write capabilities for S3
Documentation
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
use std::io::{Result, Error, ErrorKind};
use std::io::SeekFrom;
use std::pin::Pin;
use std::task::{Context, Poll};
use tokio::sync::{oneshot, mpsc};
use tokio::io::ReadBuf;
use tokio::io::{AsyncRead, AsyncSeek, AsyncWrite};
use tokio::sync::mpsc::error::TryRecvError as MpscTryRecvError;
use tokio::sync::oneshot::error::TryRecvError as OneshotTryRecvError;
use aws_sdk_s3::Client;
use hyperfile_reactor::Reactor;
use crate::file::handler::{ChannelGroup, build_channel_group};
use crate::config::{HyperFileConfig, HyperFileMetaConfig, HyperFileRuntimeConfig};
use super::hyper::Hyper;
use super::flags::FileFlags;
use super::mode::FileMode;
use super::handler::{
    FileContext,
    FileRespGetAttr,
    FileRespRead,
    FileRespWrite,
    FileRespFlush,
    FileRespRelease
};

enum State {
    Idle(()),
    Busy(Operation),
}

enum Operation {
    Read((mpsc::Sender<FileRespRead>, mpsc::Receiver<FileRespRead>)),
    Write((mpsc::Sender<FileRespWrite>, mpsc::Receiver<FileRespWrite>)),
    WriteZero(()),
    Flush(oneshot::Receiver<FileRespFlush>),
    Release(oneshot::Receiver<FileRespRelease>),
    Seek(oneshot::Receiver<FileRespGetAttr>),
}

/// Reactor-mode handle that exposes the file through tokio's
/// `AsyncRead` / `AsyncWrite` / `AsyncSeek` traits. Owns its
/// internal reactor; one `HyperFileTokio` corresponds to one
/// open file.
///
/// # Security: hyperfile does not enforce POSIX permissions
///
/// The mode / uid / gid stored on the file are opaque metadata
/// — `read` / `write` / `seek` / `flush_ext` / `fdatasync_ext`
/// all proceed regardless of the bits. There is no
/// `PermissionDenied` / `EACCES` path. Enforce in your own
/// layer (FUSE, IAM); see `docs/posix.md`'s "Permissions and
/// ownership" section.
pub struct HyperFileTokio<'a> {
    inner: ChannelGroup<FileContext<'a>>,
    #[allow(dead_code)]
    _reactor: Reactor<FileContext<'a>, Hyper<'a>>,
    state: State,
    pos: u64,
    seek_target: SeekFrom,
    read_buf: Pin<Box<Vec<u8>>>,
}

impl<'a: 'static> HyperFileTokio<'a> {
    pub async fn create(client: &Client, uri: &str, flags: FileFlags, mode: FileMode) -> Result<Self>
    {
        let hyper = Hyper::fs_create(client, uri, flags, mode).await?;
        let reactor: Reactor<FileContext<'_>, Hyper<'_>> = Reactor::new_current()
            .map_err(|e| Error::new(ErrorKind::Other, format!("reactor init failed: {}", e)))?;
        let (builder, finish) = build_channel_group();
        let handler = reactor.spawn_async(hyper, builder).await
            .map_err(|_| Error::new(ErrorKind::BrokenPipe, "reactor thread is gone"))?;
        Ok(Self { inner: finish(handler), _reactor: reactor, state: State::Idle(()), pos: 0, seek_target: SeekFrom::Start(0), read_buf: Pin::new(Box::new(Vec::new())), })
    }
    pub async fn create_opt(client: &Client, uri: &str, flags: FileFlags, mode: FileMode,
            meta_config: &HyperFileMetaConfig, runtime_config: &HyperFileRuntimeConfig) -> Result<Self>
    {
        let hyper = Hyper::fs_create_opt(client, uri, flags, mode, meta_config, runtime_config).await?;
        let reactor: Reactor<FileContext<'_>, Hyper<'_>> = Reactor::new_current()
            .map_err(|e| Error::new(ErrorKind::Other, format!("reactor init failed: {}", e)))?;
        let (builder, finish) = build_channel_group();
        let handler = reactor.spawn_async(hyper, builder).await
            .map_err(|_| Error::new(ErrorKind::BrokenPipe, "reactor thread is gone"))?;
        Ok(Self { inner: finish(handler), _reactor: reactor, state: State::Idle(()), pos: 0, seek_target: SeekFrom::Start(0), read_buf: Pin::new(Box::new(Vec::new())), })
    }

    pub async fn open(client: &Client, uri: &str, flags: FileFlags) -> Result<Self>
    {
        let hyper = Hyper::fs_open(client, uri, flags).await?;
        let reactor: Reactor<FileContext<'_>, Hyper<'_>> = Reactor::new_current()
            .map_err(|e| Error::new(ErrorKind::Other, format!("reactor init failed: {}", e)))?;
        let (builder, finish) = build_channel_group();
        let handler = reactor.spawn_async(hyper, builder).await
            .map_err(|_| Error::new(ErrorKind::BrokenPipe, "reactor thread is gone"))?;
        Ok(Self { inner: finish(handler), _reactor: reactor, state: State::Idle(()), pos: 0, seek_target: SeekFrom::Start(0), read_buf: Pin::new(Box::new(Vec::new())), })
    }

    pub async fn open_opt(client: &Client, uri: &str, flags: FileFlags,
            runtime_config: &HyperFileRuntimeConfig) -> Result<Self>
    {
        let hyper = Hyper::fs_open_opt(client, uri, flags, runtime_config).await?;
        let reactor: Reactor<FileContext<'_>, Hyper<'_>> = Reactor::new_current()
            .map_err(|e| Error::new(ErrorKind::Other, format!("reactor init failed: {}", e)))?;
        let (builder, finish) = build_channel_group();
        let handler = reactor.spawn_async(hyper, builder).await
            .map_err(|_| Error::new(ErrorKind::BrokenPipe, "reactor thread is gone"))?;
        Ok(Self { inner: finish(handler), _reactor: reactor, state: State::Idle(()), pos: 0, seek_target: SeekFrom::Start(0), read_buf: Pin::new(Box::new(Vec::new())), })
    }

    pub async fn open_or_create_with_default_opt(client: &Client, uri: &str, flags: FileFlags, mode: FileMode) -> Result<Self>
    {
        let hyper = Hyper::fs_open_or_create_with_default_opt(client, uri, flags, mode).await?;
        let reactor: Reactor<FileContext<'_>, Hyper<'_>> = Reactor::new_current()
            .map_err(|e| Error::new(ErrorKind::Other, format!("reactor init failed: {}", e)))?;
        let (builder, finish) = build_channel_group();
        let handler = reactor.spawn_async(hyper, builder).await
            .map_err(|_| Error::new(ErrorKind::BrokenPipe, "reactor thread is gone"))?;
        Ok(Self { inner: finish(handler), _reactor: reactor, state: State::Idle(()), pos: 0, seek_target: SeekFrom::Start(0), read_buf: Pin::new(Box::new(Vec::new())), })
    }

    pub async fn open_or_create_with_config(client: &Client, config: HyperFileConfig, flags: FileFlags, mode: FileMode) -> Result<Self>
    {
        let hyper = Hyper::fs_open_or_create_with_config(client, config, flags, mode).await?;
        let reactor: Reactor<FileContext<'_>, Hyper<'_>> = Reactor::new_current()
            .map_err(|e| Error::new(ErrorKind::Other, format!("reactor init failed: {}", e)))?;
        let (builder, finish) = build_channel_group();
        let handler = reactor.spawn_async(hyper, builder).await
            .map_err(|_| Error::new(ErrorKind::BrokenPipe, "reactor thread is gone"))?;
        Ok(Self { inner: finish(handler), _reactor: reactor, state: State::Idle(()), pos: 0, seek_target: SeekFrom::Start(0), read_buf: Pin::new(Box::new(Vec::new())), })
    }

    pub async fn set_len(&self, size: u64) -> Result<()> {
        let (ctx, rx) = FileContext::new_trunc(size as usize);
        self.inner.send(ctx)?;
        rx.await.map_err(|_| std::io::Error::new(std::io::ErrorKind::BrokenPipe, "reactor handler task died"))?
    }

    pub async fn metadata(&self) -> Result<libc::stat> {
        let (ctx, rx) = FileContext::new_getattr();
        self.inner.send(ctx)?;
        rx.await.map_err(|_| std::io::Error::new(std::io::ErrorKind::BrokenPipe, "reactor handler task died"))?
    }

    pub async fn last_cno(&self) -> Result<u64> {
        let (ctx, rx) = FileContext::new_last_cno();
        self.inner.send(ctx)?;
        rx.await.map_err(|_| std::io::Error::new(std::io::ErrorKind::BrokenPipe, "reactor handler task died"))
    }

    pub async fn flush_ext(&self) -> Result<u64> {
        let (ctx, rx) = FileContext::new_flush(self.inner.clone());
        self.inner.send(ctx)?;
        rx.await.map_err(|_| std::io::Error::new(std::io::ErrorKind::BrokenPipe, "reactor handler task died"))?
    }

    /// POSIX-`fdatasync` flavoured flush — see
    /// `Hyper::fs_fdatasync` for semantics. Provided as an
    /// extension method on top of the tokio AsyncWrite/AsyncRead
    /// surface.
    pub async fn fdatasync_ext(&self) -> Result<u64> {
        let (ctx, rx) = FileContext::new_flush_data(self.inner.clone());
        self.inner.send(ctx)?;
        rx.await.map_err(|_| std::io::Error::new(std::io::ErrorKind::BrokenPipe, "reactor handler task died"))?
    }

    pub async fn write_zero(&mut self, len: usize) -> Result<usize> {
        loop {
            match self.state {
                State::Busy(_) => {
                    tokio::task::yield_now().await;
                },
                State::Idle(_) => {
                    let (ctx, tx, mut rx) = FileContext::new_write_zero(self.pos as usize, len, self.inner.clone());
                    self.inner.send(ctx)?;
                    self.state = State::Busy(Operation::WriteZero(()));
                    let res = rx.recv().await.ok_or_else(|| std::io::Error::new(std::io::ErrorKind::BrokenPipe, "reactor handler task died"))?;
                    drop(tx);
                    self.state = State::Idle(());
                    return res;
                },
            }
        }
    }
}

impl AsyncRead for HyperFileTokio<'_> {
    fn poll_read(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>) -> Poll<Result<()>> {
        let me = self.get_mut();
        match me.state {
            State::Idle(_) => {
                // prepare data buf for read
                let mut data_buf = Vec::with_capacity(buf.remaining());
                data_buf.resize(buf.remaining(), 0);
                me.read_buf = Pin::new(Box::new(data_buf));
                let buf_mut_ref = unsafe {
                    std::slice::from_raw_parts_mut(me.read_buf.as_ptr() as *mut u8, me.read_buf.len())
                };
                let (ctx, tx, rx) = FileContext::new_read(buf_mut_ref, me.pos as usize, me.inner.clone());
                if let Err(e) = me.inner.send(ctx) { return Poll::Ready(Err(e)); }
                me.state = State::Busy(Operation::Read((tx, rx)));
                cx.waker().wake_by_ref();
                Poll::Pending
            },
            State::Busy(ref mut op) => {
                match op {
                    Operation::Read((_, rx)) => {
                        match rx.try_recv() {
                            Ok(res) => {
                                if res.is_err() {
                                    me.state = State::Idle(());
                                    return Poll::Ready(Err(res.err().unwrap()));
                                }
                                let read_size = res.unwrap();
                                assert!(buf.capacity() == read_size);
                                buf.put_slice(&me.read_buf);
                                assert!(buf.remaining() == 0);
                                me.read_buf.truncate(0);
                                me.pos += read_size as u64;
                                me.state = State::Idle(());
                                return Poll::Ready(Ok(()));
                            },
                            Err(MpscTryRecvError::Disconnected) => {
                                me.state = State::Idle(());
                                return Poll::Ready(Err(Error::new(ErrorKind::Other, "handler channel disconnected")));
                            },
                            Err(MpscTryRecvError::Empty) => {},
                        }
                    },
                    _ => {},
                }
                cx.waker().wake_by_ref();
                Poll::Pending
            },
        }
    }
}

impl AsyncSeek for HyperFileTokio<'_> {
    fn start_seek(self: Pin<&mut Self>, pos: SeekFrom) -> Result<()> {
        let me = self.get_mut();
        match me.state {
            State::Busy(_) => Err(Error::new(ErrorKind::Other, "Other file operation is pending")),
            State::Idle(_) => {
                me.seek_target = pos;
                let (ctx, rx) = FileContext::new_getattr();
                me.inner.send(ctx)?;
                me.state = State::Busy(Operation::Seek(rx));
                Ok(())
            },
        } 
    }

    fn poll_complete(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<u64>> {
        let me = self.get_mut();
        match me.state {
            State::Idle(_) => Poll::Ready(Ok(me.pos)),
            State::Busy(ref mut op) => {
                match op {
                    Operation::Seek(rx) => {
                        match rx.try_recv() {
                            Ok(res) => {
                                if res.is_err() {
                                    me.state = State::Idle(());
                                    return Poll::Ready(Err(res.err().unwrap()));
                                }
                                let stat = res.unwrap();
                                // TODO: anything need to check for current file size
                                match me.seek_target {
                                    SeekFrom::Start(start) => { me.pos = start; },
                                    SeekFrom::Current(curr) => {
                                        let pos = me.pos as i64;
                                        me.pos = (pos + curr) as u64;
                                    },
                                    SeekFrom::End(end) => {
                                        let size = stat.st_size as i64;
                                        me.pos = (size + end) as u64;
                                    },
                                }
                                me.state = State::Idle(());
                                return Poll::Ready(Ok(me.pos));
                            },
                            Err(OneshotTryRecvError::Closed) => {
                                me.state = State::Idle(());
                                return Poll::Ready(Err(Error::new(ErrorKind::Other, "handler channel closed")));
                            },
                            Err(OneshotTryRecvError::Empty) => {},
                        }
                    },
                    _ => {},
                }
                cx.waker().wake_by_ref();
                Poll::Pending
            },
        }
    }
}

impl AsyncWrite for HyperFileTokio<'_> {
    fn poll_write(self: Pin<&mut Self>, cx: &mut Context<'_>, src: &[u8],) -> Poll<Result<usize>> {
        let me = self.get_mut();
        match me.state {
            State::Idle(_) => {
                let b = unsafe {
                    std::slice::from_raw_parts(src.as_ptr() as *const u8, src.len())
                };
                let (ctx, tx, rx) = FileContext::new_write(b, me.pos as usize, me.inner.clone());
                if let Err(e) = me.inner.send(ctx) { return Poll::Ready(Err(e)); }
                me.state = State::Busy(Operation::Write((tx, rx)));
                cx.waker().wake_by_ref();
                Poll::Pending
            },
            State::Busy(ref mut op) => {
                match op {
                    Operation::Write((_, rx)) => {
                        match rx.try_recv() {
                            Ok(res) => {
                                if res.is_err() {
                                    me.state = State::Idle(());
                                    return Poll::Ready(Err(res.err().unwrap()));
                                }
                                let write_size = res.unwrap();
                                me.pos += write_size as u64;
                                me.state = State::Idle(());
                                return Poll::Ready(Ok(write_size));
                            },
                            Err(MpscTryRecvError::Disconnected) => {
                                me.state = State::Idle(());
                                return Poll::Ready(Err(Error::new(ErrorKind::Other, "handler channel disconnected")));
                            },
                            Err(MpscTryRecvError::Empty) => {},
                        }
                    },
                    _ => {},
                }
                cx.waker().wake_by_ref();
                Poll::Pending
            },
        }
    }

    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
        let me = self.get_mut();
        match me.state {
            State::Idle(_) => {
                let (ctx, rx) = FileContext::new_flush(me.inner.clone());
                if let Err(e) = me.inner.send(ctx) { return Poll::Ready(Err(e)); }
                me.state = State::Busy(Operation::Flush(rx));
                cx.waker().wake_by_ref();
                Poll::Pending
            },
            State::Busy(ref mut op) => {
                match op {
                    Operation::Flush(rx) => {
                        match rx.try_recv() {
                            Ok(res) => {
                                if res.is_err() {
                                    me.state = State::Idle(());
                                    return Poll::Ready(Err(res.err().unwrap()));
                                }
                                me.state = State::Idle(());
                                return Poll::Ready(Ok(()));
                            },
                            Err(OneshotTryRecvError::Closed) => {
                                me.state = State::Idle(());
                                return Poll::Ready(Err(Error::new(ErrorKind::Other, "handler channel disconnected")));
                            },
                            Err(OneshotTryRecvError::Empty) => {},
                        }
                    },
                    _ => {},
                }
                cx.waker().wake_by_ref();
                Poll::Pending
            },
        }
    }

    fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
        let me = self.get_mut();
        match me.state {
            State::Idle(_) => {
                let (ctx, rx) = FileContext::new_release(me.inner.clone());
                if let Err(e) = me.inner.send(ctx) { return Poll::Ready(Err(e)); }
                me.state = State::Busy(Operation::Release(rx));
                cx.waker().wake_by_ref();
                Poll::Pending
            },
            State::Busy(ref mut op) => {
                match op {
                    Operation::Release(rx) => {
                        match rx.try_recv() {
                            Ok(res) => {
                                if res.is_err() {
                                    me.state = State::Idle(());
                                    return Poll::Ready(Err(res.err().unwrap()));
                                }
                                me.state = State::Idle(());
                                return Poll::Ready(Ok(()));
                            },
                            Err(OneshotTryRecvError::Closed) => {
                                me.state = State::Idle(());
                                return Poll::Ready(Err(Error::new(ErrorKind::Other, "handler channel disconnected")));
                            },
                            Err(OneshotTryRecvError::Empty) => {},
                        }
                    },
                    _ => {},
                }
                cx.waker().wake_by_ref();
                Poll::Pending
            },
        }
    }
}