sark-h2 0.28.5

Fiber-free HTTP/2 protocol primitives and manifold server for sark
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
use std::num::NonZero;

use o3::{
    depot,
    depot::{
        index::Initialized,
        map::direct,
        queue::{indexed::keyed, links},
    },
};
use sark_core::{
    body,
    body::{
        credit,
        stream::{Admission, Drive, Stream},
    },
    decode::{request, state},
};
use variant::Variant;

use crate::{
    server::{
        state::exchange,
        task::{Built, ingress::entry::Entry},
    },
    stream,
};

type Occupied<'a, 'd, P, F, B, Q = ()> = direct::Occupied<'a, stream::Key, Entry<'d, P, F, B>, Q>;
type Vacancy<'a, 'd, P, F, B, Q = ()> = direct::Vacant<'a, stream::Key, Entry<'d, P, F, B>, Q>;
type Removed<S, T, Q> = (S, T, keyed::Link<stream::Key, Q>);

mod data;
pub(in crate::server::task) mod entry;
pub(super) mod errors;
pub(super) mod raw;
mod states;
mod variant;

pub(super) use data::{Data, Discard, Progress, Route, Schedule};
pub(in crate::server::task) use states::{Buffered, Receiving};

pub(super) struct Routes<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>> {
    entries: &'a direct::Table<stream::Key, Entry<'d, P, F, B>>,
    selected: (stream::Key, &'a keyed::Link<stream::Key, entry::Admission>),
    queue: &'a mut keyed::Fifo<stream::Key, entry::Admission>,
}

pub(super) struct Streams<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>> {
    entries: &'a direct::Table<stream::Key, Entry<'d, P, F, B>>,
    selected: (stream::Key, &'a keyed::Link<stream::Key, entry::Build>),
    queue: &'a mut keyed::Fifo<stream::Key, entry::Build>,
}

impl<'d, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>> Routes<'_, 'd, P, F, B> {
    fn insert(
        vacant: Vacancy<'_, 'd, P, F, B>,
        queue: &mut keyed::Fifo<stream::Key, entry::Admission>,
        state: exchange::Routed<'d, P, F>,
    ) {
        use links::Index;
        let key = vacant.key();
        let link = keyed::Link::from(Index::from(key));
        let owner = Routes {
            entries: vacant.table(),
            selected: (key, &link),
            queue,
        };
        // SAFETY: the new link is vacant; this exclusive admission root owns its neighbors.
        unsafe { keyed::Slot::<_, _, false>::from_source(depot::raw::Proof::new(owner)) }
            .push::<false>();
        vacant.insert(Entry::Routed { state, link });
    }

    fn remove<Q>(
        vacant: Vacancy<'_, 'd, P, F, B, Q>,
        link: &keyed::Link<stream::Key, entry::Admission>,
        queue: &mut keyed::Fifo<stream::Key, entry::Admission>,
    ) {
        let owner = Routes {
            entries: vacant.table(),
            selected: (vacant.key(), link),
            queue,
        };
        // SAFETY: every routed state is an admission member until this consuming removal.
        unsafe { keyed::Slot::from_source(depot::raw::Proof::new(owner)) }.remove();
    }
}

impl<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>>
    Streams<'a, 'd, P, F, B>
{
    fn new(
        vacant: &'a Vacancy<'_, 'd, P, F, B>,
        link: &'a keyed::Link<stream::Key, entry::Build>,
        queue: &'a mut keyed::Fifo<stream::Key, entry::Build>,
    ) -> Result<keyed::Slot<Self, entry::Build>, keyed::Slot<Self, entry::Build, false>> {
        let owner = Self {
            entries: vacant.table(),
            selected: (vacant.key(), link),
            queue,
        };
        keyed::Slot::try_new(owner)
    }

    pub(in crate::server::task) fn insert(
        vacant: Vacancy<'a, 'd, P, F, B>,
        queue: &mut keyed::Fifo<stream::Key, entry::Build>,
        body: Stream<'d, B>,
        schedule: Schedule,
    ) -> Occupied<'a, 'd, P, F, B> {
        use links::Index;
        let key = vacant.key();
        let link = keyed::Link::from(Index::from(key));
        if let Schedule::Ready = schedule {
            let owner = Streams {
                entries: vacant.table(),
                selected: (key, &link),
                queue,
            };
            // SAFETY: the new stream link is vacant in this original build root.
            unsafe { keyed::Slot::<_, _, false>::from_source(depot::raw::Proof::new(owner)) }
                .push::<false>();
        }
        vacant.insert(Entry::Streaming { body, link })
    }
}

// SAFETY: Build permanently pairs the streaming FIFO with its direct table.
unsafe impl<'d, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>>
    depot::raw::KeySource<entry::Build> for &mut Build<'_, 'd, P, F, B>
{
    type Key = stream::Key;
    fn fifo(&self) -> &keyed::Fifo<stream::Key, entry::Build> {
        self.ready
    }
}

// SAFETY: the selected link and original table loan remain borrowed until this admission turn ends.
unsafe impl<'d, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>>
    depot::raw::KeyOwner<entry::Admission> for Routes<'_, 'd, P, F, B>
{
    type Key = stream::Key;
    type Fifo = keyed::Fifo<stream::Key, entry::Admission>;
    fn parts(&self) -> (stream::Key, &keyed::Link<stream::Key, entry::Admission>) {
        self.selected
    }
    fn fifo(&self) -> &keyed::Fifo<stream::Key, entry::Admission> {
        self.queue
    }
    fn link(
        live: depot::raw::Proof<(&Self, links::Index), Initialized<entry::Admission>>,
    ) -> &keyed::Link<stream::Key, entry::Admission> {
        let live = unsafe { live.map(|(owner, index)| (owner.entries, index)) };
        Variant::<exchange::Routed<'d, P, F>, entry::Admission>::link(direct::Table::project(live))
    }
}

// SAFETY: the selected streaming link and original table loan retain the exact build plane.
unsafe impl<'d, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>>
    depot::raw::KeyOwner<entry::Build> for Streams<'_, 'd, P, F, B>
{
    type Key = stream::Key;
    type Fifo = keyed::Fifo<stream::Key, entry::Build>;
    fn parts(&self) -> (stream::Key, &keyed::Link<stream::Key, entry::Build>) {
        self.selected
    }
    fn fifo(&self) -> &keyed::Fifo<stream::Key, entry::Build> {
        self.queue
    }
    fn link(
        live: depot::raw::Proof<(&Self, links::Index), Initialized<entry::Build>>,
    ) -> &keyed::Link<stream::Key, entry::Build> {
        let live = unsafe { live.map(|(owner, index)| (owner.entries, index)) };
        Variant::<Stream<'d, B>, entry::Build>::link(direct::Table::project(live))
    }
}

pub(super) struct Turn<
    'a,
    'd,
    P: request::Prepared,
    F: state::Family<P>,
    B: body::Build<'d>,
    Q = (),
> {
    slot: Slot<'a, 'd, P, F, B, Q>,
    body: Stream<'d, B>,
}

struct Slot<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>, Q = ()> {
    vacant: Vacancy<'a, 'd, P, F, B, Q>,
    link: keyed::Link<stream::Key, entry::Build>,
    queue: &'a mut keyed::Fifo<stream::Key, entry::Build>,
}

impl<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>> Turn<'a, 'd, P, F, B> {
    fn try_new(
        occupied: Occupied<'a, 'd, P, F, B>,
        queue: &'a mut keyed::Fifo<stream::Key, entry::Build>,
    ) -> Option<Self> {
        let (vacant, value) = occupied.take();
        let Entry::Streaming { body, link } = value else {
            vacant.insert(value);
            return None;
        };
        let slot = Slot {
            vacant,
            link,
            queue,
        };
        match keyed::Slot::try_new(slot) {
            Ok(member) => Some(Self {
                slot: member.release(),
                body,
            }),
            Err(vacant) => {
                let (slot, link) = vacant.release();
                slot.insert(Entry::Streaming { body, link });
                None
            }
        }
    }
}

impl<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>, Q>
    Turn<'a, 'd, P, F, B, Q>
{
    fn drive<E: credit::Evidence>(
        self,
        credit: &mut credit::raw::Account,
        budget: NonZero<usize>,
        evidence: E,
    ) -> Built<'d, B> {
        let Self { slot, body } = self;
        let key = slot.vacant.key();
        credit.scope(|mut ledger| {
            // SAFETY: Turn retains the body selected from the incoming table that
            // its Build/Data root permanently pairs with this exact Book account.
            let body = unsafe { ledger.bind(body) };
            let (step, mut evidence) = body.try_drive(&mut ledger, evidence, budget);
            // SAFETY: the body transition retains the original slot, link, and FIFO membership.
            let member = unsafe { keyed::Slot::from_source(depot::raw::Proof::new(slot)) };
            match step {
                Drive::Pending(body) => {
                    // SAFETY: the pending builder returns to its original Book slot.
                    let body = unsafe { ledger.store(body) };
                    member.move_to_back().release().store(body);
                    body::BuildOutcome::Pending
                }
                Drive::NeedInput(body) => {
                    let (slot, link) = member.remove().release();
                    // SAFETY: the unscheduled builder returns to its original Book slot.
                    let body = unsafe { ledger.store(body) };
                    slot.insert(Entry::Streaming { body, link });
                    body::BuildOutcome::Pending
                }
                Drive::Ready(ready) => {
                    let (slot, _) = member.remove().release();
                    let key = slot.key();
                    match ready.try_admit(&mut ledger, evidence) {
                        Admission::Accepted(build) => body::BuildOutcome::Ready { key, build },
                        Admission::Rejected {
                            ready,
                            mut evidence,
                            error,
                        } => {
                            let release =
                                ready.discard(&mut ledger, &mut evidence).abandon(evidence);
                            body::BuildOutcome::Failed {
                                key,
                                error: errors::Build::rejected(error, release),
                            }
                        }
                    }
                }
                Drive::Failed {
                    stream: body,
                    error,
                } => {
                    // SAFETY: failure retains the original builder in its exact Book slot.
                    let body = unsafe { ledger.store(body) };
                    member.release().store(body);
                    body::BuildOutcome::Failed {
                        key,
                        error: errors::Build::Step(error),
                    }
                }
                Drive::Rejected {
                    stream: body,
                    error,
                } => {
                    let (slot, _) = member.remove().release();
                    let key = slot.key();
                    let release = body
                        .into_release()
                        .try_discard(&mut ledger, &mut evidence)
                        .abandon(evidence);
                    body::BuildOutcome::Failed {
                        key,
                        error: errors::Build::rejected(error, release),
                    }
                }
            }
        })
    }
}

impl<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>, Q>
    Slot<'a, 'd, P, F, B, Q>
{
    fn store(self, body: Stream<'d, B>) {
        self.vacant.insert(Entry::Streaming {
            body,
            link: self.link,
        });
    }
}

// SAFETY: this capability retains the actual removed slot, link, and original FIFO loan.
unsafe impl<'d, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>, Q>
    depot::raw::KeyOwner<entry::Build> for Slot<'_, 'd, P, F, B, Q>
{
    type Key = stream::Key;
    type Fifo = keyed::Fifo<stream::Key, entry::Build>;
    fn parts(&self) -> (stream::Key, &keyed::Link<stream::Key, entry::Build>) {
        (self.vacant.key(), &self.link)
    }
    fn fifo(&self) -> &keyed::Fifo<stream::Key, entry::Build> {
        self.queue
    }
    fn link(
        live: depot::raw::Proof<(&Self, links::Index), Initialized<entry::Build>>,
    ) -> &keyed::Link<stream::Key, entry::Build> {
        let live = unsafe { live.map(|(owner, index)| (owner.vacant.table(), index)) };
        Variant::<Stream<'d, B>, entry::Build>::link(direct::Table::project(live))
    }
}

// SAFETY: only a committed cursor restores the membership capability.
unsafe impl<'d, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>, Q>
    depot::raw::KeyFinish<true, entry::Build> for Slot<'_, 'd, P, F, B, Q>
{
    type Output = Self;
    unsafe fn finish(self) -> Self {
        self
    }
}

// SAFETY: detachment releases the actual slot and its now-vacant link.
unsafe impl<'a, 'd, P: request::Prepared, F: state::Family<P>, B: body::Build<'d>, Q>
    depot::raw::KeyFinish<false, entry::Build> for Slot<'a, 'd, P, F, B, Q>
{
    type Output = (
        Vacancy<'a, 'd, P, F, B, Q>,
        keyed::Link<stream::Key, entry::Build>,
    );
    unsafe fn finish(self) -> Self::Output {
        (self.vacant, self.link)
    }
}

pub(super) struct Build<'a, 'd, P, F, B>
where
    P: request::Prepared,
    F: state::Family<P>,
    B: body::Build<'d>,
{
    entries: &'a mut direct::Table<stream::Key, Entry<'d, P, F, B>>,
    ready: &'a mut keyed::Fifo<stream::Key, entry::Build>,
    credit: &'a mut credit::raw::Account,
}

impl<'a, 'd, P, F, B> Build<'a, 'd, P, F, B>
where
    P: request::Prepared,
    F: state::Family<P>,
    B: body::Build<'d>,
{
    pub(in crate::server::task) fn drive<E, Map>(
        &mut self,
        budget: NonZero<usize>,
        evidence: Map,
    ) -> Built<'d, B>
    where
        E: credit::Evidence,
        Map: FnOnce(stream::Key) -> E,
    {
        let Some(live) = keyed::Fifo::first(self) else {
            return body::BuildOutcome::Idle;
        };
        // SAFETY: the original build root retains all disjoint loans and its exact queue plane.
        let live = unsafe {
            live.map(|(build, index)| {
                (
                    (&mut *build.entries, (&mut *build.ready, &mut *build.credit)),
                    index,
                )
            })
        };
        let (occupied, (queue, credit)) = direct::Occupied::from_live(live);
        let key = occupied.key();
        let (vacant, body, link) = Variant::<Stream<'d, B>, entry::Build>::take(occupied);
        Turn {
            slot: Slot {
                vacant,
                link,
                queue,
            },
            body,
        }
        .drive(credit, budget, evidence(key))
    }

    pub(in crate::server::task) fn drive_for<E: credit::Evidence>(
        &mut self,
        stream: stream::Key,
        budget: NonZero<usize>,
        evidence: E,
    ) -> Built<'d, B> {
        let occupied = match self.entries.entry(stream) {
            Some(occupied) => occupied,
            None => return body::BuildOutcome::Idle,
        };
        // SAFETY: these are the exact entry, queue, and account retained together
        // by this Build owner from its original Book selection.
        unsafe { raw::drive_entry(occupied, self.ready, self.credit, budget, evidence) }
    }
}