dope-net 0.20.0

Owned network transports 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

use std::{mem, task};

use dope_core::driver::schedule::ready;
use o3::{base::cell::region, buffer::resident::bound};

use crate::link::egress::{
    self,
    load::credit,
    metadata,
    reserve::{Bounds, Vacant, demand, error},
};

/// Queue-bound geometry proof reusable across capacity polls.
#[must_use]
pub struct Plan<'queue, 'p, 'd, B, D: demand::Mode = demand::Fallible> {
    queue: metadata::Queue<'queue, 'p, 'd, B, credit::Ready<'p, 'd>, D>,
    bounds: Bounds,
}

impl<'p, B, D: demand::Mode> Clone for Plan<'_, 'p, '_, B, D> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<'p, B, D: demand::Mode> Copy for Plan<'_, 'p, '_, B, D> {}

impl<'queue, 'p, 'd, B, D: demand::Mode> Plan<'queue, 'p, 'd, B, D> {
    pub(in crate::link::egress) fn new(
        queue: metadata::Queue<'queue, 'p, 'd, B, credit::Ready<'p, 'd>, D>,
        bounds: Bounds,
    ) -> Result<Self, error::Lane> {
        let amount = bounds.amount();
        if !queue.fits(amount) {
            return Err(error::Lane::new(bounds));
        }
        Ok(Self::proven(queue, bounds))
    }

    pub(in crate::link::egress) const fn proven(
        queue: metadata::Queue<'queue, 'p, 'd, B, credit::Ready<'p, 'd>, D>,
        bounds: Bounds,
    ) -> Self {
        Self { queue, bounds }
    }

    pub const fn bounds(self) -> Bounds {
        self.bounds
    }

    pub fn poll_reserve<'token>(
        self,
        token: &'token mut region::Token<region::Identity<'d>>,
        target: ready::Target<'d>,
    ) -> task::Poll<Result<Vacant<'queue, 'token, 'p, 'd, B, D>, egress::Admission>> {
        let Some(shape) = self.bounds.shape() else {
            return task::Poll::Ready(Ok(Vacant::empty(token, self.bounds)));
        };
        self.queue
            .poll_acquire(token, credit::Queued::from_bounds(self.bounds), target)
            .map(|permit| {
                let permit = permit.map_err(|cause| egress::Admission::Tickets {
                    lane: self.queue.lane,
                    cause,
                })?;
                Vacant::try_new(self.bounds, shape, token, permit)
            })
    }

    pub fn try_reserve<'token>(
        self,
        token: &'token mut region::Token<region::Identity<'d>>,
    ) -> Result<Vacant<'queue, 'token, 'p, 'd, B, D>, egress::Admission> {
        let Some(shape) = self.bounds.shape() else {
            return Ok(Vacant::empty(token, self.bounds));
        };
        let permit = self.queue.try_acquire(token, self.bounds.amount())?;
        Vacant::try_new(self.bounds, shape, token, permit)
    }
}

const _: () = {
    let word = mem::size_of::<usize>();
    assert!(mem::size_of::<Plan<'static, 'static, 'static, ()>>() == 6 * word);
    assert!(
        mem::size_of::<Plan<'static, 'static, 'static, (), demand::Guaranteed<bound::AtMost<0>, 1>>>(
        ) == 6 * word
    );
    assert!(
        mem::size_of::<
            Option<Plan<'static, 'static, 'static, (), demand::Guaranteed<bound::AtMost<0>, 1>>>,
        >() == 6 * word
    );
};