dope-core 0.15.1

The manifold runtime
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

use crate::{
    backend,
    driver::{self, ops::retirements, schedule},
    platform,
};

pub(crate) enum Returned {}
pub(crate) enum Fair {}

/// The only authority handed from common reactor maintenance to a backend.
pub(crate) struct Backend<'turn, 'd> {
    work: schedule::Reactor<'turn, 'd>,
}

impl<'turn, 'd> Backend<'turn, 'd> {
    pub(crate) fn prepare(
        context: &mut driver::Context<'_, 'd>,
        work: schedule::Reactor<'turn, 'd>,
    ) -> Self
    where
        backend::Backend: platform::Buffer,
    {
        Returned::reclaim(context, schedule::MAX_TURN_WORK_BUDGET);

        let total = work.remaining();
        let cursor = work.cursor();
        let backend_reserve = Fair::share::<{ schedule::REACTOR_LANES as usize }>(total, 1, cursor);

        let retirement_limit = work.remaining().saturating_sub(backend_reserve);
        {
            let mut retirement = work.budget::<retirements::Retirement>(retirement_limit);
            retirement.reclaim(context);
        }

        Self { work }
    }

    pub(crate) fn remaining(&self) -> usize {
        self.work.remaining()
    }

    pub(crate) fn budget<Lane>(&self, limit: usize) -> schedule::Budget<'_, 'd, Lane> {
        self.work.budget(limit)
    }
}

impl Fair {
    pub(crate) const fn share<const PARTICIPANTS: usize>(
        total: usize,
        lane: usize,
        cursor: usize,
    ) -> usize {
        assert!(PARTICIPANTS != 0);
        assert!(lane < PARTICIPANTS);
        let base = total / PARTICIPANTS;
        let extra = total % PARTICIPANTS;
        let distance = (lane + PARTICIPANTS - (cursor % PARTICIPANTS)) % PARTICIPANTS;
        base + if distance < extra { 1 } else { 0 }
    }
}

impl Returned {
    fn reclaim(context: &mut driver::Context<'_, '_>, limit: usize)
    where
        backend::Backend: platform::Buffer,
    {
        let mut reclaimed = 0;
        for _ in 0..limit {
            let Some(returned) = context.pop_returned_buffer() else {
                break;
            };
            platform::Buffer::release(context.backend(), returned);
            reclaimed += 1;
        }
        if reclaimed != 0 {
            context
                .driver_ref()
                .credits()
                .release_recv_buffers(reclaimed);
        }
    }

    pub(in crate::driver) fn reclaim_all(context: &mut driver::Context<'_, '_>)
    where
        backend::Backend: platform::Buffer,
    {
        while let Some(returned) = context.pop_returned_buffer() {
            platform::Buffer::release(context.backend(), returned);
        }
    }
}