nuclei 0.4.3

Proactive IO & runtime system
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

use lever::prelude::*;
use std::fmt;
use std::{
    future::Future,
    io,
    ops::{Deref, DerefMut},
    pin::Pin,
    sync::Arc,
};

use crate::syscore::{CompletionChan, StoreFile};

///
/// Submitted async IO operation type
pub type AsyncOp<T> = Pin<Box<dyn Future<Output = io::Result<T>>>>;

///
/// Operation registrar for Proactive IO, represents the outer ring that will send & receive submissions and completions respectively.
pub trait HandleOpRegisterer {
    fn read_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>>;
    fn write_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>>;
}

///
/// Handle that manages IO submitted to proactor system.
///
/// This handle wraps io element, its' completion channel, if file, file buffers and input output operations
/// It is single handedly responsible for dispatching correct operations to IO driver.
/// Speed of IO bound to speed of executor, handle neither interferes with executor nor tightly coupled.
pub struct Handle<T> {
    /// IO task element
    pub(crate) io_task: Option<T>,
    /// Notification channel
    pub(crate) chan: Option<CompletionChan>,
    /// File operation storage
    pub(crate) store_file: Option<StoreFile>,
    /// Completion callback for read
    pub(crate) read: Arc<TTas<Option<AsyncOp<usize>>>>,
    /// Completion callback for write
    pub(crate) write: Arc<TTas<Option<AsyncOp<usize>>>>,
}

unsafe impl<T> Send for Handle<T> {}
unsafe impl<T> Sync for Handle<T> {}

impl<T> Handle<T> {
    pub fn get_ref(&self) -> &T {
        self.io_task.as_ref().unwrap()
    }

    pub fn get_mut(&mut self) -> &mut T {
        self.io_task.as_mut().unwrap()
    }

    pub fn into_inner(mut self) -> T {
        self.io_task.take().unwrap()
    }

    // #[cfg(all(feature = "iouring", target_os = "linux"))]
    // unsafe_unpinned!(store_file: Option<StoreFile>);
    //
    // pub(crate) fn get_file(mut self: Pin<&mut Self>) -> &mut Option<StoreFile> {
    //     self.store_file()
    // }
}

impl<T> HandleOpRegisterer for Handle<T> {
    fn read_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>> {
        self.read.clone()
    }

    fn write_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>> {
        self.write.clone()
    }
}

impl<T> HandleOpRegisterer for &Handle<T> {
    fn read_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>> {
        self.read.clone()
    }

    fn write_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>> {
        self.write.clone()
    }
}

impl<T> Deref for Handle<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        self.io_task.as_ref().unwrap()
    }
}

impl<T> DerefMut for Handle<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.io_task.as_mut().unwrap()
    }
}

impl<T: fmt::Debug> fmt::Debug for Handle<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Handle")
            .field("io_task", self.io_task.as_ref().unwrap())
            .finish()
    }
}