dope-core 0.33.1

Owned native I/O and completion driver for dope
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
438
439
440
441
442
443
444
use std::{cell, mem, num::NonZero};

use o3::depot::arena::slab::Vacancy;

use crate::{
    driver,
    driver::{
        route,
        route::{indices, indices::SlotIndex, table::Capacity},
    },
    io::{
        fd::{
            domain::{Domain, Lease, Prefix, State, resident},
            handles, identity, outbound,
            outbound::Error,
            states,
        },
        socket::install::slot,
    },
};

pub(crate) enum Create {
    Deliver,
    Retired,
}

pub(crate) enum Close {
    Submit,
    Settled,
    Released,
}

#[must_use = "a bound socket creation completion must succeed or fail"]
#[repr(transparent)]
pub(crate) struct Creation(handles::OutboundSlot);

impl AsRef<handles::OutboundSlot> for Creation {
    fn as_ref(&self) -> &handles::OutboundSlot {
        &self.0
    }
}

#[derive(Clone, Copy)]
#[repr(transparent)]
pub(crate) struct Outbound<'a>(pub(super) &'a Domain);

#[derive(Clone, Copy)]
#[repr(transparent)]
pub(crate) struct Closures<'a>(&'a Domain);

#[derive(Clone, Copy)]
#[repr(transparent)]
pub(super) struct Index(pub(super) indices::SlotIndex);

#[must_use = "a standalone slot must remain owned until it is returned to its partition"]
#[repr(transparent)]
pub(crate) struct Solo<T = handles::PhysicalSlot>(pub(super) T);

impl<'a> From<&'a Domain> for Outbound<'a> {
    fn from(domain: &'a Domain) -> Self {
        Self(domain)
    }
}

impl<'a> From<&'a Domain> for Closures<'a> {
    fn from(domain: &'a Domain) -> Self {
        Self(domain)
    }
}

impl<'d> Solo<identity::Identity<'d>> {
    pub(crate) fn physical(&self) -> handles::PhysicalSlot {
        self.0.slot()
    }

    pub(crate) fn into_id(self) -> identity::Identity<'d> {
        self.0
    }

    pub(crate) fn release(self) -> (identity::Identity<'d>, Solo) {
        let identity = self.0;
        let slot = Solo(identity.slot());
        (identity, slot)
    }
}

impl<'a> Outbound<'a> {
    pub(crate) fn try_map<B: route::Tag>(
        driver: driver::Reference<'a>,
        count: Capacity,
    ) -> Result<outbound::Reserved<'a, B>, outbound::Error> {
        Self::from(driver.descriptors().domain())
            .try_assign(route::OutboundKey::for_tag::<B>(), count)?;
        Ok(outbound::Reserved::new(driver))
    }
}

impl<'a> Outbound<'a> {
    pub(crate) fn slot(
        &self,
        owner: route::OutboundKey,
        local: indices::SlotIndex,
    ) -> Option<handles::OutboundSlot> {
        let table = &self.0.outbound;
        let lease = table.routes[owner.raw() as usize].get()?;
        let index = table.get(lease, local)?;
        Some(handles::OutboundSlot::new(index.0, owner))
    }

    pub(crate) fn creation(
        &self,
        owner: route::OutboundKey,
        local: indices::SlotIndex,
    ) -> Option<Creation> {
        self.slot(owner, local).map(Creation)
    }

    pub(crate) fn begin_create(&self, slot: handles::OutboundSlot) {
        self.0
            .resident
            .lifecycle(slot.physical())
            .set(states::SlotState::route(
                states::Phase::CREATING_ONE,
                slot.owner(),
            ));
    }

    pub(crate) fn created(&self, creation: Creation) -> Create {
        let slot = creation.0;
        let owner = slot.owner();
        let physical = slot.physical();
        let state = self.0.resident.lifecycle(physical);
        if state.get().phase() == states::Phase::CREATING_ONE {
            state.set(states::SlotState::route(states::Phase::OPEN_TWO, owner));
            Create::Deliver
        } else {
            state.set(states::SlotState::route(states::Phase::CLOSING_ZERO, owner));
            self.0.resident.retire().enqueue(physical);
            Create::Retired
        }
    }

    pub(crate) fn failed(&self, creation: Creation) {
        let slot = creation.0;
        let owner = slot.owner();
        let state = self.0.resident.lifecycle(slot.physical());
        if state.get().phase() == states::Phase::CREATING_ONE {
            state.set(states::SlotState::route(states::Phase::FAILED_ONE, owner));
        } else {
            self.0.release_slot(slot);
        }
    }

    pub(crate) fn activate(&self, slot: handles::OutboundSlot) {
        self.0
            .resident
            .lifecycle(slot.physical())
            .set(states::SlotState::route(
                states::Phase::OPEN_ONE,
                slot.owner(),
            ));
    }
}

impl Closures<'_> {
    pub(crate) fn direct(self, slot: handles::OutboundSlot) {
        self.0
            .resident
            .lifecycle(slot.physical())
            .set(states::SlotState::route(
                states::Phase::CLOSING_ZERO,
                slot.owner(),
            ));
    }

    pub(crate) fn creating(self, id: identity::Identity<'_, handles::OutboundSlot>) -> Close {
        let slot = id.slot();
        let owner = slot.owner();
        let state = self.0.resident.lifecycle(slot.physical());
        let phase = state.get().phase();
        if phase == states::Phase::CREATING_ONE {
            state.set(states::SlotState::route(
                states::Phase::CREATING_ZERO,
                owner,
            ));
            return Close::Settled;
        }
        Self::close(state, phase, owner)
    }

    pub(crate) fn created(self, slot: handles::OutboundSlot) -> Close {
        let owner = slot.owner();
        let state = self.0.resident.lifecycle(slot.physical());
        let phase = state.get().phase();
        Self::close(state, phase, owner)
    }

    fn close(
        state: resident::Lifecycle<'_>,
        phase: states::Phase,
        owner: route::OutboundKey,
    ) -> Close {
        if phase == states::Phase::OPEN_TWO {
            state.set(states::SlotState::route(states::Phase::CLOSING_ONE, owner));
            return Close::Submit;
        }
        if phase == states::Phase::CLOSING_ONE {
            state.set(states::SlotState::route(states::Phase::CLOSING_ZERO, owner));
            return Close::Settled;
        }
        Close::Released
    }

    pub(crate) fn complete(self, slot: handles::PhysicalSlot) {
        let state = self.0.resident.lifecycle(slot);
        let Some(owner) = state.get().owner() else {
            return;
        };
        let outbound = handles::OutboundSlot::new(SlotIndex::from(slot), owner);
        if state.get().phase() == states::Phase::CLOSING_ZERO {
            self.0.release_slot(outbound);
        } else {
            state.set(states::SlotState::route(states::Phase::CLOSED_ONE, owner));
        }
    }
}

const _: () = {
    assert!(mem::size_of::<Creation>() == mem::size_of::<handles::OutboundSlot>());
    assert!(mem::align_of::<Creation>() == mem::align_of::<handles::OutboundSlot>());
    assert!(mem::size_of::<Closures<'_>>() == mem::size_of::<&Domain>());
    assert!(mem::size_of::<cell::Cell<Index>>() == mem::size_of::<cell::Cell<u32>>());
    assert!(mem::size_of::<Solo>() == mem::size_of::<handles::PhysicalSlot>());
    assert!(
        mem::size_of::<Solo<identity::Identity<'_>>>() == mem::size_of::<identity::Identity<'_>>()
    );
};

/// Access always selects the partition and resident state of the same Domain.
/// No prefix snapshot, lease, or unfinished transition can escape this module.
impl<'a> Outbound<'a> {
    /// Admits one mapping entry before extending the allocated prefix.
    pub(crate) fn try_reserve(self) -> Result<Solo<identity::Identity<'a>>, slot::Error> {
        let table = &self.0.outbound;
        let mut prefix = table.prefix.get();
        let Some(entry) = table.mapping.get(prefix.allocated as usize) else {
            return Err(if self.has_retiring() {
                slot::Error::Retiring { available: 0 }
            } else {
                slot::Error::Capacity { available: 0 }
            });
        };
        let index = entry.get();
        prefix.allocated += 1;
        table.prefix.set(prefix);
        let physical = handles::PhysicalSlot::from_index(index.0);
        let version = self.0.resident.claim(index, states::SlotState::STANDALONE);
        Ok(Solo(identity::Identity::new(physical, version)))
    }

    /// Consumes one still-counted admission from this driver's retained owner.
    pub(crate) fn release_one(&self, released: Solo) {
        let table = &self.0.outbound;
        let mut prefix = table.prefix.get();
        prefix.allocated -= 1;
        // SAFETY: the consumed admission belongs to this Domain's allocated
        // prefix, so its final position is inside the immutable mapping extent.
        let entry = unsafe { table.mapping.get_unchecked(prefix.allocated as usize) };
        entry.set(Index(released.0.into()));
        table.prefix.set(prefix);
        self.0
            .resident
            .lifecycle(released.0)
            .set(states::SlotState::FREE);
    }

    /// Admits a disjoint nonempty interval and both bounded prefix successors.
    fn try_assign(self, owner: route::OutboundKey, count: Capacity) -> Result<(), Error> {
        let Some(len) = count.span() else {
            return Err(Error::Empty);
        };
        let table = &self.0.outbound;
        let route = &table.routes[owner.raw() as usize];
        if route.get().is_some() {
            return Err(Error::Occupied);
        }
        let prefix = table.prefix.get();
        let avail = table.capacity.raw() - prefix.allocated;
        if len.get() > avail {
            return Err(if self.has_retiring() {
                Error::Retiring {
                    requested: len.get() as usize,
                    available: avail as usize,
                }
            } else {
                Error::Capacity {
                    requested: len.get() as usize,
                    available: avail as usize,
                }
            });
        }
        let lease = Lease {
            start: prefix.mapped,
            len,
            state: State::Live,
        };
        let next = Prefix {
            mapped: prefix.mapped + len.get(),
            allocated: prefix.allocated + len.get(),
        };
        table.rotate(
            prefix.mapped as usize,
            prefix.allocated as usize,
            next.allocated as usize,
        );
        for entry in table
            .mapping
            .iter()
            .skip(lease.start as usize)
            .take(len.get() as usize)
        {
            self.0
                .resident
                .mapped(entry.get())
                .set(states::SlotState::route(states::Phase::MAPPED, owner));
        }
        route.set(Some(lease));
        table.prefix.set(next);
        Ok(())
    }

    pub(crate) fn acquire(
        &self,
        owner: route::OutboundKey,
        local: indices::SlotIndex,
    ) -> Result<identity::Identity<'a, handles::OutboundSlot>, Vacancy> {
        let table = &self.0.outbound;
        let lease = table.routes[owner.raw() as usize]
            .get()
            .ok_or(Vacancy::Full)?;
        if matches!(lease.state, State::Retired(_)) {
            return Err(Vacancy::Full);
        }
        let index = table.get(lease, local).ok_or(Vacancy::Full)?;
        let state = self.0.resident.mapped(index);
        if state.is_exhausted() {
            return Err(Vacancy::IdentityExhausted);
        }
        if !state.get().is_state(states::Phase::MAPPED, owner) {
            return Err(Vacancy::Full);
        }
        let version = self.0.resident.claim(
            index,
            states::SlotState::route(states::Phase::UNOPENED_ONE, owner),
        );
        Ok(identity::Identity::outbound(
            handles::OutboundSlot::new(index.0, owner),
            version,
        ))
    }

    pub(crate) fn retire(&self, owner: route::OutboundKey) {
        let table = &self.0.outbound;
        let cell = &table.routes[owner.raw() as usize];
        let Some(mut lease) = cell.get() else {
            return;
        };
        let slots = lease.range();
        let remaining = table
            .mapping
            .iter()
            .skip(slots.start)
            .take(slots.len())
            .filter(|entry| {
                let state = self.0.resident.mapped(entry.get());
                !state.get().is_state(states::Phase::MAPPED, owner)
            })
            .count();
        if let Some(remaining) = NonZero::new(remaining as u32) {
            lease.state = State::Retired(remaining);
            cell.set(Some(lease));
        } else {
            self.reclaim(owner, lease);
        }
    }

    fn has_retiring(&self) -> bool {
        self.0.outbound.routes.iter().any(|route| {
            route
                .get()
                .is_some_and(|route| matches!(route.state, State::Retired(_)))
        }) || self.0.resident.has_retiring()
    }

    /// Removes a retired interval; backward compaction preserves unread entries.
    /// Exhausted slots retain anonymous allocations; only reusable slots enter the free suffix.
    pub(super) fn reclaim(&self, owner: route::OutboundKey, removed: Lease) {
        let table = &self.0.outbound;
        let cell = &table.routes[owner.raw() as usize];
        let slots = removed.range();
        let prefix = table.prefix.get();
        let mut next = Prefix {
            mapped: prefix.mapped - removed.len.get(),
            allocated: prefix.allocated,
        };
        table.rotate(slots.start, slots.end, prefix.allocated as usize);
        let released = table
            .mapping
            .iter()
            .take(prefix.allocated as usize)
            .skip((prefix.allocated - removed.len.get()) as usize);
        let reusable = released.clone().rev().filter_map(|entry| {
            let index = entry.get();
            let state = self.0.resident.mapped(index);
            if state.is_exhausted() {
                state.set(states::SlotState::STANDALONE);
                None
            } else {
                state.set(states::SlotState::FREE);
                Some(index)
            }
        });
        for (entry, index) in released.rev().zip(reusable) {
            entry.set(index);
            next.allocated -= 1;
        }
        table.reverse(next.allocated as usize..prefix.allocated as usize);
        for cell in &table.routes {
            if let Some(mut lease) = cell.get()
                && lease.start > removed.start
            {
                lease.start -= removed.len.get();
                cell.set(Some(lease));
            }
        }
        cell.set(None);
        table.prefix.set(next);
    }
}

const _: () = {
    assert!(std::mem::size_of::<Lease>() == 3 * std::mem::size_of::<u32>());
    assert!(std::mem::size_of::<Option<Lease>>() == std::mem::size_of::<Lease>());
};