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
use std::{fmt, io, ptr, task::Context, task::Poll};
use ntex_bytes::BytePages;
use ntex_util::time::sleep;
use crate::{Buffer, Flags, IoRef, IoTaskStatus, Readiness};
/// Context for io read task
pub struct IoContext(IoRef);
impl fmt::Debug for IoContext {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("IoContext").field("io", &self.0).finish()
}
}
impl IoContext {
pub(crate) fn new(io: IoRef) -> Self {
Self(io)
}
#[doc(hidden)]
#[inline]
pub fn id(&self) -> usize {
ptr::from_ref(self.0.0.as_ref()) as usize
}
#[inline]
/// Io tag
pub fn tag(&self) -> &'static str {
self.0.tag()
}
#[inline]
#[doc(hidden)]
/// Io flags
pub fn flags(&self) -> Flags {
self.0.flags()
}
#[inline]
/// Check readiness for read operations
pub fn poll_read_ready(&self, cx: &mut Context<'_>) -> Poll<Readiness> {
self.shutdown_filters(cx);
self.0.filter().poll_read_ready(cx)
}
#[inline]
/// Check readiness for write operations
pub fn poll_write_ready(&self, cx: &mut Context<'_>) -> Poll<Readiness> {
self.0.filter().poll_write_ready(cx)
}
#[inline]
/// Stop io
pub fn stop(&self, e: Option<io::Error>) {
self.0.0.io_stopped(e);
}
#[inline]
/// Check if Io stopped
pub fn is_stopped(&self) -> bool {
self.0.flags().is_stopped()
}
/// Wait when io get closed or preparing for close
pub fn shutdown(&self, flush: bool, cx: &mut Context<'_>) -> Poll<()> {
let st = &self.0.0;
if flush && !st.flags.is_stopped() {
if st.flags.is_write_paused() {
return Poll::Ready(());
}
st.flags.set_task_waiting_for_write();
st.write_task.register(cx.waker());
Poll::Pending
} else if !st.flags.is_closed() {
st.write_task.register(cx.waker());
Poll::Pending
} else {
Poll::Ready(())
}
}
/// Get read buffer
pub fn get_read_buf(&self) -> Buffer {
let st = &self.0.0;
let buf = if st.flags.is_read_buf_ready() {
// read buffer is still not read by dispatcher
// we cannot touch it
st.read_buf().get()
} else {
st.buffer
.get_read_buf()
.unwrap_or_else(|| st.read_buf().get())
};
Buffer::new(buf)
}
/// Resize read buffer
pub fn resize_read_buf(&self, buf: &mut Buffer) {
self.0.0.read_buf().resize(&mut buf.buf);
}
/// Set read buffer
pub fn release_read_buf(
&self,
buffer: Buffer,
result: Poll<Result<(), Option<io::Error>>>,
) -> IoTaskStatus {
let st = &self.0.0;
let hw = self.0.cfg().read_buf().high;
let nbytes = buffer.has_newbytes();
let read_buf = st.buffer.read_destination_size();
let mut full = false;
let st_res = if nbytes {
// handle buffer changes
match st.buffer.process_read_buf(&self.0, buffer.buf) {
Ok(()) => {
let buf_size = st.buffer.read_destination_size();
if buf_size > read_buf {
// dest buffer has new data, wake up dispatcher
if buf_size >= hw {
log::trace!(
"{}: Io read buffer is too large {}, enable read back-pressure",
self.tag(),
buf_size
);
full = true;
st.flags.set_rd_buf_ready_and_full();
} else {
st.flags.set_rd_buf_ready();
}
log::trace!(
"{}: New {} bytes available, wakeup dispatcher",
self.tag(),
buf_size
);
st.dispatch_task.wake();
} else {
if buf_size >= hw {
// read task is paused because of read back-pressure
// but there is no new data in top most read buffer
// so we need to wake up read task to read more data
// otherwise read task would sleep forever
full = true;
st.flags.unset_read_buf_ready();
}
if st.flags.is_waiting_for_read() {
// in case of "notify" we must wake up dispatch task
// if we read any data from source
st.dispatch_task.wake();
}
}
// while reading, filter wrote some data
// in that case filters need to process write buffers
// and potentialy wake write task
if st.flags.is_wants_write() {
st.flags.unset_wants_write();
st.buffer.process_write_buf_force(&self.0)
} else {
Ok(())
}
}
Err(err) => Err(err),
}
} else {
st.buffer.set_read_buf(&self.0, buffer.buf);
Ok(())
};
match result {
Poll::Ready(Ok(())) => {
if let Err(e) = st_res {
st.io_stopped(Some(e));
IoTaskStatus::Stop
} else if !nbytes {
st.io_stopped(None);
IoTaskStatus::Stop
} else if full {
IoTaskStatus::Pause
} else {
IoTaskStatus::Io
}
}
Poll::Ready(Err(e)) => {
st.io_stopped(e);
IoTaskStatus::Stop
}
Poll::Pending => {
if let Err(e) = st_res {
st.io_stopped(Some(e));
IoTaskStatus::Stop
} else if full {
IoTaskStatus::Pause
} else {
IoTaskStatus::Io
}
}
}
}
#[inline]
/// Get write buffer
pub fn with_write_buf<F, R>(&self, f: F) -> R
where
F: FnOnce(&mut BytePages) -> R,
{
// write buffer processing could be delayed,
// need to call filter chain for processing
if let Err(e) = self.0.0.buffer.process_write_buf(&self.0) {
self.0.0.io_stopped(Some(e));
}
// access to output write buffer
self.0.0.buffer.with_write_destination(|buffer| f(buffer))
}
/// Set write buffer
pub fn update_write_buf(&self, result: Poll<io::Result<()>>) -> IoTaskStatus {
let st = &self.0.0;
match result {
Poll::Pending => {
let len = st.buffer.write_destination_size();
// check write backpressure
if st.flags.is_wr_backpressure() && len < st.write_buf().half {
st.flags.unset_wr_backpressure();
st.dispatch_task.wake();
}
IoTaskStatus::Pause
}
Poll::Ready(Ok(())) => {
let len = st.buffer.write_destination_size();
// check write backpressure
if st.flags.is_wr_backpressure() && len < st.write_buf().half {
st.flags.unset_wr_backpressure();
st.dispatch_task.wake();
}
if st.flags.is_task_waiting_for_write() {
st.flags.set_task_waiting_for_write_is_done();
st.write_task.wake();
}
if st.flags.is_waiting_for_write() {
st.flags.unset_flush_and_backpressure();
st.dispatch_task.wake();
}
if self.is_stopped() {
IoTaskStatus::Stop
} else if len == 0 && st.buffer.write_source_size() == 0 {
// all data has been written
st.flags.set_write_paused();
IoTaskStatus::Pause
} else {
IoTaskStatus::Io
}
}
Poll::Ready(Err(e)) => {
st.io_stopped(Some(e));
IoTaskStatus::Stop
}
}
}
fn shutdown_filters(&self, cx: &mut Context<'_>) {
let io = &self.0;
let st = &self.0.0;
if st.flags.is_shutting_down_filters() {
match st.buffer.process_shutdown(io) {
Ok(Poll::Ready(())) => {
st.io_stopping();
}
Ok(Poll::Pending) => {
// check read buffer, if buffer is not consumed it is unlikely
// that filter will properly complete shutdown
if st.flags.is_read_paused() || st.flags.is_read_buf_ready_and_full() {
st.io_stopping();
} else {
// filter shutdown timeout
let timeout = st
.shutdown_timeout
.take()
.unwrap_or_else(|| sleep(io.cfg().disconnect_timeout()));
if timeout.poll_elapsed(cx).is_ready() {
st.io_stopping();
} else {
st.shutdown_timeout.set(Some(timeout));
}
}
if let Err(err) = st.buffer.process_write_buf(&self.0) {
st.io_stopped(Some(err));
}
}
Err(err) => {
st.io_stopped(Some(err));
}
}
}
}
}
impl Clone for IoContext {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{Io, testing::IoTest};
#[ntex::test]
async fn ctx_basics() {
let (_, server) = IoTest::create();
let state = Io::from(server);
let ctx = IoContext::new(state.get_ref());
let _ = ctx.flags();
assert!(ctx.id() != 0);
assert!(format!("{ctx:?}").contains("IoContext"));
}
}