dope-net 0.43.0

Owned network transports for dope
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
use std::{marker, mem, ops};

use dope_core::{
    driver,
    driver::{
        result,
        route::{self, Identity, KeyTag, table},
    },
    io::{
        event::net::{connect, socket::Completion},
        fd::outbound,
        socket,
        socket::{Open, option, pending},
    },
};
use o3::{
    alloc::{self, array},
    buffer::storage,
    depot::{self, arena::slab, capacity, index::Initialized},
};
use table::conn;

use crate::{
    link::{
        duplex,
        egress::{data, reserve::demand},
        event,
        pool::{self, change::opening, pending::Vacancy, recv::input},
        setup,
        slot::types,
    },
    wire::{
        self,
        open::{self, Runtime as _},
    },
};

pub struct Outbound<
    'p,
    'w,
    'd,
    ID: Identity + 'w,
    T: crate::Transport,
    W: wire::Spec,
    S,
    M: input::Mode<W>,
    B = storage::Shared,
    const IOV: usize = 32,
    D: demand::Mode = demand::Fallible,
> where
    'd: 'w,
{
    pub(super) storage: pool::Connections<'p, 'w, 'd, ID, T, W, S, M, B, IOV, D>,
    pub(super) outbound: outbound::Reserved<'d, ID>,
    pub(super) addresses: AddressTable<'d, ID, T::Prepared>,
}

impl<'p, 'w, 'd, ID: Identity + 'w, T, W, S, M, B, const IOV: usize, D> ops::Deref
    for Outbound<'p, 'w, 'd, ID, T, W, S, M, B, IOV, D>
where
    'd: 'w,
    T: crate::Transport,
    W: wire::Spec,
    M: input::Mode<W>,
    D: demand::Mode,
{
    type Target = pool::Connections<'p, 'w, 'd, ID, T, W, S, M, B, IOV, D>;

    fn deref(&self) -> &Self::Target {
        &self.storage
    }
}

impl<'p, 'w, 'd: 'w, ID: Identity + 'w, T, W, S, M, B, const IOV: usize, D> ops::DerefMut
    for Outbound<'p, 'w, 'd, ID, T, W, S, M, B, IOV, D>
where
    T: crate::Transport,
    W: wire::Spec,
    M: input::Mode<W>,
    D: demand::Mode,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.storage
    }
}

impl<'p, 'w, 'd, ID: Identity + 'w, T, W, S, M, B, const IOV: usize, D>
    Outbound<'p, 'w, 'd, ID, T, W, S, M, B, IOV, D>
where
    'd: 'w,
    T: crate::Transport,
    W: wire::Spec,
    M: input::Mode<W>,
    D: demand::Mode,
{
    pub fn fds(&self) -> &outbound::Reserved<'d, ID> {
        &self.outbound
    }

    /// Returns the retained target and its established connection state.
    pub fn target(&self, key: pool::Key<'d, ID>) -> Option<(T::Prepared, &S)> {
        let view = self.storage.inspect();
        let slot = view.get(key)?;
        slot.engine.establish.connected()?;
        Some((*self.addresses.prepared(slot), &slot.state))
    }

    pub fn send_slot(
        &mut self,
        key: pool::Key<'d, ID>,
    ) -> pool::Sending<'_, 'p, 'w, 'd, ID, W, S, B, IOV, D>
    where
        B: data::raw::Payload<'d>,
    {
        let (egress, queued) = self.storage.sender_with_recv(key)?;
        if egress.connection.engine.operations.lifecycle.is_closing() {
            return None;
        }
        Some((egress, queued))
    }

    pub fn open<P, R>(
        &mut self,
        capacity: conn::Capacity,
        socket: socket::StreamSpec,
        input: P,
        make: impl FnOnce(&P) -> (S, T::Prepared),
        complete: impl FnOnce(&types::Connection<'w, 'd, ID, W, S>) -> R,
        driver: &mut driver::Context<'_, 'd>,
    ) -> opening::Attempt<'d, ID, P, R, open::Error<'w, W>> {
        use pool::pending::{Admission, Grant};

        let keys = *self.storage.keys;
        let grant = match self.storage.prepared.pending.admit(
            &mut self.storage.prepared.slab,
            keys,
            capacity,
        ) {
            Admission::Ready(grant) => grant,
            Admission::Busy | Admission::Full => {
                return opening::Attempt::Deferred {
                    cause: opening::Deferred::Capacity,
                    input,
                };
            }
            Admission::Exhausted => {
                return opening::Attempt::Failed {
                    error: opening::Failure::IdentityExhausted,
                };
            }
        };
        let lease = Grant::reserve(grant);
        let key = lease.key();
        let fd = match self.outbound.bind(lease.key().target()) {
            Ok(fd) => fd,
            Err(slab::Vacancy::Full) => {
                return opening::Attempt::Deferred {
                    cause: opening::Deferred::Capacity,
                    input,
                };
            }
            Err(slab::Vacancy::IdentityExhausted) => {
                return opening::Attempt::Failed {
                    error: opening::Failure::IdentityExhausted,
                };
            }
        };
        let address = self.addresses.vacancy(&lease);
        let opened = self.storage.prepared.runtime.open((), |(), wire, send| {
            let open = match Open::try_new(driver, &self.storage.prepared.flights, fd, socket) {
                Ok(open) => open.commit(),
                Err(error) => {
                    let outcome = match error.cause() {
                        result::SubmitCause::Full => opening::Attempt::Deferred {
                            cause: opening::Deferred::Submission(error),
                            input: (),
                        },
                        result::SubmitCause::IdentityExhausted => opening::Attempt::Failed {
                            error: opening::Failure::Submission(error),
                        },
                    };
                    return open::Disposition::retry(outcome, wire, send);
                }
            };
            let (state, target) = make(&input);
            let stored = address.commit(target);
            let engine = duplex::Duplex::targeted(open, stored);
            engine.ready_handle().set_target(key.target().dispatch());
            let output = lease.commit_with(|key| {
                let slot = types::Connection::<ID, W, S> {
                    control: types::Control::new(engine, wire, send, key),
                    state,
                };
                let output = complete(&slot);
                (slot, output)
            });
            open::Disposition::Commit(opening::Attempt::Submitted { key, output })
        });
        match opened {
            open::Outcome::Unavailable(()) => opening::Attempt::Deferred {
                cause: opening::Deferred::WireBackpressure,
                input,
            },
            open::Outcome::Failed { context: (), cause } => opening::Attempt::Failed {
                error: opening::Failure::Wire(cause),
            },
            open::Outcome::Opened(opening::Attempt::Deferred { cause, input: () }) => {
                opening::Attempt::Deferred { cause, input }
            }
            open::Outcome::Opened(opening::Attempt::Submitted { key, output }) => {
                opening::Attempt::Submitted { key, output }
            }
            open::Outcome::Opened(opening::Attempt::Failed { error }) => {
                opening::Attempt::Failed { error }
            }
        }
    }

    pub fn finish_open<X>(
        &mut self,
        done: Completion<'d>,
        driver: &mut driver::Context<'_, 'd>,
        make: impl for<'slot> FnOnce(&'slot types::Connection<'w, 'd, ID, W, S>) -> (X, option::Set),
    ) -> event::Socket<'d, ID, X> {
        use dope_core::io::event::net::socket::{Failure, Outcome};

        let (target, done) = done.into_parts();
        let conns = &mut self.storage;
        let addrs = &self.addresses;
        let key = match conns.keys.parse(target) {
            Ok(key) => key,
            Err(_) => return event::Socket::Stale,
        };
        let prepared = &mut conns.prepared;
        let slots = &prepared.flights;
        let slab = &mut prepared.slab;
        let Some(mut entry) = slab.access().occupied(key.parts()) else {
            return event::Socket::Stale;
        };
        let done = match done {
            Outcome::Created(made) => Ok(made),
            Outcome::Failed(Failure::Create(error)) => Err(error),
            Outcome::Failed(Failure::Retired) => return event::Socket::Stale,
        };
        let (owner, opts) = make(entry.get());
        let cause = match done {
            Err(error) => event::ConnectError::Create(error),
            Ok(made) => {
                let addr = addrs.prepared(entry.get());
                match entry.get_mut().control.engine.created(
                    made,
                    opts,
                    addr,
                    key.target(),
                    slots,
                    driver,
                ) {
                    setup::Submission::Pending => return event::Socket::Pending,
                    setup::Submission::Failed(cause) => match cause {
                        pending::Cause::Submit(error) => event::ConnectError::Admission(error),
                        pending::Cause::Option(error) => event::ConnectError::Option(error),
                    },
                }
            }
        };
        event::Socket::Failed {
            key: key.connection(),
            attempt: owner,
            cause,
        }
    }

    fn complete<X, P>(
        &mut self,
        done: connect::Completion<'d>,
        driver: &mut driver::Context<'_, 'd>,
        peek: impl for<'slot> FnOnce(&'slot types::Connection<'w, 'd, ID, W, S>) -> X,
        peer: impl FnOnce(&AddressTable<'d, ID, T::Prepared>, &types::Connection<'w, 'd, ID, W, S>) -> P,
    ) -> Result<event::Connect<'d, ID, X, P>, connect::Completion<'d>> {
        let key = match self.storage.keys.parse(done.token()) {
            Ok(key) => key,
            Err(_) => return Err(done),
        };
        let prepared = &mut self.storage.prepared;
        let slots = &prepared.flights;
        let slab = &mut prepared.slab;
        let Ok((mut entry, mut recv)) = slab.try_entry(key.parts()) else {
            return Err(done);
        };
        let close = entry.get().engine.operations.lifecycle.is_closing();
        let progress = entry.get_mut().control.engine.complete(done);
        let key = key.connection();
        Ok(match progress {
            setup::Completion::Stale(done) => return Err(done),
            setup::Completion::Failed(error) => event::Connect::Failed {
                key,
                attempt: peek(entry.get()),
                cause: match error {
                    connect::Error::Option(errno) => event::ConnectError::Option(errno),
                    connect::Error::Connect(errno) => event::ConnectError::Connect(errno),
                },
            },
            setup::Completion::Cancelled => event::Connect::Cancelled { key },
            setup::Completion::Ready => {
                if close {
                    return Ok(event::Connect::Cancelled { key });
                }
                let slot = entry.get_mut();
                let attempt = peek(&*slot);
                if let Err(failure) = recv.rearm.submitted(slot.submit_recv(slots, driver)) {
                    return Ok(event::Connect::Failed {
                        key: failure.key,
                        attempt,
                        cause: event::ConnectError::Admission(failure.cause),
                    });
                }
                event::Connect::Connected {
                    key,
                    attempt,
                    peer: peer(&self.addresses, slot),
                }
            }
        })
    }

    pub fn try_finish<X>(
        &mut self,
        done: connect::Completion<'d>,
        driver: &mut driver::Context<'_, 'd>,
        peek: impl for<'slot> FnOnce(&'slot types::Connection<'w, 'd, ID, W, S>) -> X,
    ) -> Result<event::Connect<'d, ID, X, socket::Addr>, connect::Completion<'d>> {
        self.complete(done, driver, peek, |addrs, slot| {
            socket::Addr::copy_from(addrs.prepared(slot))
        })
    }

    pub fn try_attach<X>(
        &mut self,
        done: connect::Completion<'d>,
        driver: &mut driver::Context<'_, 'd>,
        peek: impl for<'slot> FnOnce(&'slot types::Connection<'w, 'd, ID, W, S>) -> X,
    ) -> Result<event::Connect<'d, ID, X, ()>, connect::Completion<'d>> {
        self.complete(done, driver, peek, |_, _| ())
    }
}

pub(super) struct AddressTable<'d, ID: Identity, A: socket::Prepared> {
    pub(super) slots: array::Block<mem::MaybeUninit<A>, capacity::Count>,
    route: marker::PhantomData<route::Target<'d, ID>>,
}

/// One address lane exclusively borrowed for an exact connection vacancy.
struct AddressGrant<'a, 'd, ID: Identity, A: socket::Prepared> {
    slot: &'a mut mem::MaybeUninit<A>,
    route: marker::PhantomData<route::Target<'d, ID>>,
}

pub(in crate::link) struct Stored<'d, ID: Identity> {
    route: marker::PhantomData<route::Target<'d, ID>>,
}

impl<'d, ID: Identity, A: socket::Prepared> AddressTable<'d, ID, A> {
    pub(in crate::link::pool) fn try_new(capacity: table::Capacity) -> Result<Self, alloc::Error> {
        Ok(Self {
            slots: array::Block::try_new(capacity.count(), ())?,
            route: marker::PhantomData,
        })
    }

    fn prepared<'w, W: wire::Spec + 'w, S>(&self, conn: &types::Connection<'w, 'd, ID, W, S>) -> &A
    where
        'd: 'w,
        ID: 'w,
    {
        // SAFETY: these callers retain the live connection from this Outbound's
        // uniquely leased route. Its matching address was committed before publication,
        // and this address-table loan prevents that lane from being recycled.
        unsafe {
            depot::raw::Proof::<_, Initialized<Stored<'d, ID>>>::new((
                self,
                conn.key.index().into_usize(),
            ))
        }
        .into()
    }

    /// Retains the paired physical lane admitted by this exact connection vacancy.
    fn vacancy<'a, U>(
        &'a mut self,
        vacancy: &Vacancy<'_, 'd, ID, U>,
    ) -> AddressGrant<'a, 'd, ID, A> {
        let route = self.route;
        // SAFETY: construction pairs immutable extents; the exact connection
        // vacancy admits this address cell while this loan prevents recycling.
        let slot = unsafe {
            depot::raw::Proof::<_, Initialized<()>>::new((self, vacancy.key().index().into_usize()))
        }
        .into();
        AddressGrant { slot, route }
    }
}

impl<'a, 'd, ID: Identity, A: socket::Prepared> AddressGrant<'a, 'd, ID, A> {
    /// Publishes one prepared address into the granted lane.
    fn commit(self, addr: A) -> Stored<'d, ID> {
        self.slot.write(addr);
        Stored { route: self.route }
    }
}

const _: () = assert!(mem::size_of::<Stored<'static, KeyTag<0>>>() == 0);