sark 0.6.0

Simple Asynchronous Rust webKit - Server
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
use dope::Driver;
use dope::manifold::listener;
use dope::manifold::listener::recv::ExtendOutcome;
use dope::manifold::listener::send::WRITE_BUF_CAP;
use dope::transport::link;
use dope::transport::wire::Wire;

use super::conn_state::{ConnState, ConsumeOutcome, DeferredAction, DispatchPermit, Outcome};
use super::routing::Routing;

const MAX_PIPELINE_BATCH: u32 = 32;
const WRITE_HEADROOM: usize = WRITE_BUF_CAP - 1024;
const RESERVE_CAP: usize = 64 * 1024;

struct LoopOutcome {
    off: usize,
    cursor: usize,
    batched: u32,
    final_action: Option<Outcome>,
    split: Option<(usize, o3::buffer::Shared)>,
    close_after: bool,
    head_pending: bool,
}

pub struct Pipeline;

impl Pipeline {
    fn absorb(state: &mut ConnState, core: &mut link::Core, bytes: &[u8]) -> bool {
        if bytes.is_empty() {
            return false;
        }
        if matches!(state.recv.extend_accum(bytes), ExtendOutcome::Overrun) {
            core.set_close_after();
            return true;
        }
        false
    }

    fn fast_path(state: &mut ConnState, core: &mut link::Core, bytes: &[u8]) -> Option<bool> {
        if state.recv.is_frozen() {
            Self::absorb(state, core, bytes);
            return Some(false);
        }
        if state.pipeline.stream_body_remaining > 0 {
            let take =
                (bytes.len() as u64).min(state.pipeline.stream_body_remaining as u64) as usize;
            state.pipeline.stream_body_remaining -= take as u32;
            if take < bytes.len() && Self::absorb(state, core, &bytes[take..]) {
                return Some(true);
            }
            return Some(false);
        }
        if core.is_send_inflight() || state.deferred_action.is_some() {
            let overrun = !bytes.is_empty()
                && matches!(state.recv.extend_accum(bytes), ExtendOutcome::Overrun);
            return Some(overrun);
        }
        None
    }

    fn batch<H: Routing>(
        state: &mut ConnState,
        app: &mut H,
        work_buf: &[u8],
        write_buf: &mut [u8],
        close_after: bool,
    ) -> LoopOutcome {
        let mut out = LoopOutcome {
            off: 0,
            cursor: 0,
            batched: 0,
            final_action: None,
            split: None,
            close_after,
            head_pending: false,
        };
        let mut permit = DispatchPermit::new();
        loop {
            if out.batched >= MAX_PIPELINE_BATCH || out.cursor > WRITE_HEADROOM || out.close_after {
                break;
            }
            let rest = &work_buf[out.off..];
            if rest.is_empty() {
                break;
            }
            let outcome = app.try_consume(permit, rest, &mut write_buf[out.cursor..], state);
            permit = match outcome {
                ConsumeOutcome::NeedMore { content_length, .. } => {
                    out.head_pending = content_length.is_none();
                    if let Some(total) = content_length
                        && state.pipeline.expected_total.is_none()
                        && total > work_buf.len()
                    {
                        state.pipeline.expected_total = Some(total.min(u32::MAX as usize) as u32);
                        state.recv.set_body_limit(total);
                        let _ = state.recv.reserve_accum(total.min(RESERVE_CAP));
                    }
                    break;
                }
                ConsumeOutcome::Done {
                    permit: p,
                    consumed,
                    written,
                    close,
                } => {
                    out.cursor += written;
                    out.close_after |= close;
                    out.off += consumed;
                    out.batched += 1;
                    p
                }
                ConsumeOutcome::DoneStatic {
                    permit: p,
                    consumed,
                    hdr_written,
                    body,
                    close,
                } => {
                    let body_start = out.cursor + hdr_written;
                    let body_end = body_start + body.len();
                    if body_end <= WRITE_BUF_CAP {
                        write_buf[body_start..body_end].copy_from_slice(body);
                        out.cursor = body_end;
                        out.close_after |= close;
                        out.off += consumed;
                        out.batched += 1;
                        p
                    } else if out.cursor == 0 {
                        out.close_after |= close;
                        out.off += consumed;
                        out.final_action = Some(Outcome::SendStatic {
                            hdr_written,
                            body,
                            close_after: close,
                        });
                        break;
                    } else {
                        break;
                    }
                }
                ConsumeOutcome::DoneSplit {
                    permit: _,
                    consumed,
                    hdr_written,
                    body,
                    close,
                } => {
                    out.close_after |= close;
                    out.off += consumed;
                    out.split = Some((hdr_written, body));
                    break;
                }
                ConsumeOutcome::Streamed {
                    consumed,
                    written,
                    close,
                } => {
                    out.close_after |= close;
                    out.cursor += written;
                    out.off += consumed;
                    out.final_action = Some(Outcome::Send {
                        written,
                        close_after: close,
                    });
                    break;
                }
                ConsumeOutcome::StreamArmed {
                    permit: _,
                    head_consumed,
                    body_total,
                    written,
                    close,
                } => {
                    out.cursor += written;
                    out.close_after |= close;
                    out.off += head_consumed;
                    let already_in_buf = work_buf.len().saturating_sub(out.off);
                    let body_pre = already_in_buf.min(body_total);
                    out.off += body_pre;
                    state.pipeline.stream_body_remaining =
                        (body_total - body_pre).min(u32::MAX as usize) as u32;
                    state.pipeline.expected_total = None;
                    state.recv.reset_limit();
                    state.recv.accum = None;
                    out.batched += 1;
                    out.final_action = Some(Outcome::Send {
                        written: out.cursor,
                        close_after: close,
                    });
                    break;
                }
                ConsumeOutcome::Park { consumed, close } => {
                    out.close_after |= close;
                    out.off += consumed;
                    out.final_action = Some(Outcome::Park);
                    break;
                }
                ConsumeOutcome::Close(reason) => {
                    out.final_action = Some(Outcome::Close(reason));
                    break;
                }
            };
        }
        out
    }

    fn emit<W: Wire>(
        slot: &mut link::Slot<W, listener::State<ConnState>>,
        aux: &mut listener::Aux,
        driver: &mut Driver,
        out: LoopOutcome,
        use_accum: bool,
        plaintext: &[u8],
    ) -> bool {
        let pending = slot.state.conn.async_state.pending_wake.is_some()
            || slot.state.conn.async_state.stream_slot.is_some();
        let will_freeze =
            pending && matches!(out.final_action, Some(Outcome::Park | Outcome::Send { .. }));

        if will_freeze {
            if !use_accum
                && Self::absorb(&mut slot.state.conn, &mut slot.core, &plaintext[out.off..])
            {
                return true;
            }
        } else if use_accum {
            if let Some(accum) = slot.state.conn.recv.accum.as_mut() {
                accum.advance(out.off);
                if accum.is_empty() {
                    slot.state.conn.recv.accum = None;
                } else {
                    accum.compact();
                }
            }
            if out.batched > 0 {
                slot.state.conn.pipeline.expected_total = None;
                slot.state.conn.recv.reset_limit();
            }
        } else if Self::absorb(&mut slot.state.conn, &mut slot.core, &plaintext[out.off..]) {
            return true;
        }

        if will_freeze {
            slot.state.conn.deferred_close = out.close_after;
            slot.state.conn.recv.freeze();
            match out.final_action {
                Some(Outcome::Send { written, .. }) => {
                    let buf = aux.write_buf_for(slot);
                    let ud = slot.token();
                    slot.submit_buffered(buf, written, ud, driver);
                }
                Some(Outcome::Park) => {
                    slot.park(driver);
                }
                _ => {}
            }
            return false;
        }

        if let Some((split_hdr, body)) = out.split {
            if out.close_after {
                slot.core.set_close_after();
            }
            let buf = aux.write_buf_for(slot);
            let ud = slot.token();
            slot.submit_split_shared(buf, out.cursor + split_hdr, body, ud, driver);
            false
        } else if out.cursor > 0 {
            if let Some(Outcome::Close(reason)) = out.final_action {
                slot.state.conn.deferred_action = Some(DeferredAction::Close(reason));
            }
            if out.close_after {
                slot.core.set_close_after();
            }
            let buf = aux.write_buf_for(slot);
            let ud = slot.token();
            slot.submit_buffered(buf, out.cursor, ud, driver);
            false
        } else if let Some(act) = out.final_action {
            let act = match act {
                Outcome::Send {
                    written,
                    close_after,
                } => Outcome::Send {
                    written,
                    close_after: out.close_after | close_after,
                },
                Outcome::SendStatic {
                    hdr_written,
                    body,
                    close_after,
                } => Outcome::SendStatic {
                    hdr_written,
                    body,
                    close_after: out.close_after | close_after,
                },
                other => other,
            };
            let close = matches!(act, Outcome::Close(r) if r.is_empty());
            act.apply(slot, aux, driver);
            close
        } else {
            false
        }
    }

    pub fn run<'t, H, W>(
        app: &mut H,
        bytes: &[u8],
        slot: &mut link::Slot<W, listener::State<ConnState>>,
        aux: &mut listener::Aux,
        driver: &mut Driver,
    ) -> bool
    where
        H: Routing + crate::timer::TimerHost<'t>,
        W: Wire,
    {
        if let Some(ret) = Self::fast_path(&mut slot.state.conn, &mut slot.core, bytes) {
            return ret;
        }

        let use_accum = slot.state.conn.recv.accum.is_some();
        if use_accum
            && !bytes.is_empty()
            && matches!(
                slot.state.conn.recv.extend_existing(bytes),
                ExtendOutcome::Overrun
            )
        {
            slot.core.set_close_after();
            return true;
        }

        let peeked: Option<o3::buffer::Shared> = if use_accum {
            slot.state.conn.recv.accum.as_ref().and_then(|a| a.peek())
        } else {
            None
        };
        let work_buf: &[u8] = match &peeked {
            Some(s) => s.as_slice(),
            None => bytes,
        };

        let close_after = slot.core.close_after();
        let write_buf = aux.write_buf_for(slot);
        let out = Self::batch(&mut slot.state.conn, app, work_buf, write_buf, close_after);
        drop(peeked);

        let head_pending = out.head_pending;
        let overrun = Self::emit(slot, aux, driver, out, use_accum, bytes);
        Self::manage_head_deadline(app, slot, driver, head_pending);
        overrun
    }

    fn head_still_pending(state: &ConnState) -> bool {
        match state.recv.accum.as_ref().and_then(|a| a.peek()) {
            Some(s) => memchr::memmem::find(s.as_slice(), b"\r\n\r\n").is_none(),
            None => false,
        }
    }

    fn manage_head_deadline<'t, H, W>(
        app: &H,
        slot: &mut link::Slot<W, listener::State<ConnState>>,
        driver: &mut Driver,
        head_pending: bool,
    ) where
        H: crate::timer::TimerHost<'t>,
        W: Wire,
    {
        if head_pending && Self::head_still_pending(&slot.state.conn) {
            if slot.state.conn.head_deadline.is_none() {
                let waker = slot.make_waker(driver);
                let timer = crate::timer::TimerHost::timer(app);
                let deadline = std::time::Instant::now() + timer.head_timeout();
                if let Some(ticket) = timer.arm(deadline, &waker) {
                    slot.state.conn.head_deadline = Some(ticket);
                }
            }
        } else if let Some(ticket) = slot.state.conn.head_deadline.take() {
            crate::timer::TimerHost::timer(app).cancel(ticket);
        }
    }

    pub fn poll_head_deadline<'t, H, W>(
        app: &H,
        slot: &mut link::Slot<W, listener::State<ConnState>>,
        aux: &mut listener::Aux,
        driver: &mut Driver,
    ) -> bool
    where
        H: crate::timer::TimerHost<'t>,
        W: Wire,
    {
        let Some(ticket) = slot.state.conn.head_deadline else {
            return false;
        };
        let timer = crate::timer::TimerHost::timer(app);
        if !timer.is_fired(ticket) {
            return false;
        }
        slot.state.conn.head_deadline = None;
        timer.cancel(ticket);
        slot.core.set_close_after();
        let buf = aux.write_buf_for(slot);
        let ud = slot.token();
        slot.submit_split_static(buf, 0, crate::CANNED_408, ud, driver);
        true
    }

    pub fn on_send_complete<'t, H, W>(
        app: &mut H,
        _sent: usize,
        slot: &mut link::Slot<W, listener::State<ConnState>>,
        aux: &mut listener::Aux,
        driver: &mut Driver,
    ) where
        H: Routing + crate::timer::TimerHost<'t>,
        W: Wire,
    {
        if slot.state.conn.async_state.stream_slot.is_some() {
            return;
        }
        if let Some(DeferredAction::Close(reason)) = slot.state.conn.deferred_action.take() {
            slot.core.set_close_after();
            if !reason.is_empty() {
                let buf = aux.write_buf_for(slot);
                let ud = slot.token();
                slot.submit_split_static(buf, 0, reason, ud, driver);
            }
            return;
        }
        if slot.state.conn.recv.accum.is_some() && !slot.state.conn.recv.is_frozen() {
            let _ = Self::run(app, &[], slot, aux, driver);
        }
    }
}