summaryrefslogtreecommitdiffstats
path: root/tokio/src/runtime/driver.rs
blob: af8e17a33ddb7e7dd07dffc45681cb6cdc5542d7 (plain)
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
//! Abstracts out the entire chain of runtime sub-drivers into common types.
use crate::park::{Park, ParkThread};
use std::io;
use std::time::Duration;

// ===== io driver =====

cfg_io_driver! {
    type IoDriver = crate::park::Either<crate::io::driver::Driver, crate::park::ParkThread>;
    pub(crate) type IoHandle = Option<crate::io::driver::Handle>;

    fn create_io_driver(enable: bool) -> io::Result<(IoDriver, IoHandle)> {
        use crate::park::Either;

        #[cfg(loom)]
        assert!(!enable);

        if enable {
            let driver = crate::io::driver::Driver::new()?;
            let handle = driver.handle();

            Ok((Either::A(driver), Some(handle)))
        } else {
            let driver = ParkThread::new();
            Ok((Either::B(driver), None))
        }
    }
}

cfg_not_io_driver! {
    type IoDriver = ParkThread;
    pub(crate) type IoHandle = ();

    fn create_io_driver(_enable: bool) -> io::Result<(IoDriver, IoHandle)> {
        let driver = ParkThread::new();
        Ok((driver, ()))
    }
}

// ===== signal driver =====

macro_rules! cfg_signal_internal_and_unix {
    ($($item:item)*) => {
        #[cfg(unix)]
        cfg_signal_internal! { $($item)* }
    }
}

cfg_signal_internal_and_unix! {
    type SignalDriver = crate::park::Either<crate::signal::unix::driver::Driver, IoDriver>;
    pub(crate) type SignalHandle = Option<crate::signal::unix::driver::Handle>;

    fn create_signal_driver(io_driver: IoDriver) -> io::Result<(SignalDriver, SignalHandle)> {
        use crate::park::Either;

        // Enable the signal driver if IO is also enabled
        match io_driver {
            Either::A(io_driver) => {
                let driver = crate::signal::unix::driver::Driver::new(io_driver)?;
                let handle = driver.handle();
                Ok((Either::A(driver), Some(handle)))
            }
            Either::B(_) => Ok((Either::B(io_driver), None)),
        }
    }
}

cfg_not_signal_internal! {
    type SignalDriver = IoDriver;
    pub(crate) type SignalHandle = ();

    fn create_signal_driver(io_driver: IoDriver) -> io::Result<(SignalDriver, SignalHandle)> {
        Ok((io_driver, ()))
    }
}

// ===== process driver =====

cfg_process_driver! {
    type ProcessDriver = crate::park::Either<crate::process::unix::driver::Driver, SignalDriver>;

    fn create_process_driver(signal_driver: SignalDriver) -> io::Result<ProcessDriver> {
        use crate::park::Either;

        // Enable the signal driver if IO is also enabled
        match signal_driver {
            Either::A(signal_driver) => {
                let driver = crate::process::unix::driver::Driver::new(signal_driver)?;
                Ok(Either::A(driver))
            }
            Either::B(_) => Ok(Either::B(signal_driver)),
        }
    }
}

cfg_not_process_driver! {
    type ProcessDriver = SignalDriver;

    fn create_process_driver(signal_driver: SignalDriver) -> io::Result<ProcessDriver> {
        Ok(signal_driver)
    }
}

// ===== time driver =====

cfg_time! {
    type TimeDriver = crate::park::Either<crate::time::driver::Driver<ProcessDriver>, ProcessDriver>;

    pub(crate) type Clock = crate::time::Clock;
    pub(crate) type TimeHandle = Option<crate::time::driver::Handle>;

    fn create_clock() -> Clock {
        crate::time::Clock::new()
    }

    fn create_time_driver(
        enable: bool,
        process_driver: ProcessDriver,
        clock: Clock,
    ) -> (TimeDriver, TimeHandle) {
        use crate::park::Either;

        if enable {
            let driver = crate::time::driver::Driver::new(process_driver, clock);
            let handle = driver.handle();

            (Either::A(driver), Some(handle))
        } else {
            (Either::B(process_driver), None)
        }
    }
}

cfg_not_time! {
    type TimeDriver = ProcessDriver;

    pub(crate) type Clock = ();
    pub(crate) type TimeHandle = ();

    fn create_clock() -> Clock {
        ()
    }

    fn create_time_driver(
        _enable: bool,
        process_driver: ProcessDriver,
        _clock: Clock,
    ) -> (TimeDriver, TimeHandle) {
        (process_driver, ())
    }
}

// ===== runtime driver =====

#[derive(Debug)]
pub(crate) struct Driver {
    inner: TimeDriver,
}

pub(crate) struct Resources {
    pub(crate) io_handle: IoHandle,
    pub(crate) signal_handle: SignalHandle,
    pub(crate) time_handle: TimeHandle,
    pub(crate) clock: Clock,
}

pub(crate) struct Cfg {
    pub(crate) enable_io: bool,
    pub(crate) enable_time: bool,
}

impl Driver {
    pub(crate) fn new(cfg: Cfg) -> io::Result<(Self, Resources)> {
        let clock = create_clock();

        let (io_driver, io_handle) = create_io_driver(cfg.enable_io)?;
        let (signal_driver, signal_handle) = create_signal_driver(io_driver)?;
        let process_driver = create_process_driver(signal_driver)?;
        let (time_driver, time_handle) =
            create_time_driver(cfg.enable_time, process_driver, clock.clone());

        Ok((
            Self { inner: time_driver },
            Resources {
                io_handle,
                signal_handle,
                time_handle,
                clock,
            },
        ))
    }
}

impl Park for Driver {
    type Unpark = <TimeDriver as Park>::Unpark;
    type Error = <TimeDriver as Park>::Error;

    fn unpark(&self) -> Self::Unpark {
        self.inner.unpark()
    }

    fn park(&mut self) -> Result<(), Self::Error> {
        self.inner.park()
    }

    fn park_timeout(&mut self, duration: Duration) -> Result<(), Self::Error> {
        self.inner.park_timeout(duration)
    }

    fn shutdown(&mut self) {
        self.inner.shutdown()
    }
}