o3 0.35.0

shared-nothing primitives
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

//! Rings that retain physical space for one fixed-size terminal write.
//! Ring allocation operations.

use std::{marker, mem, num};

pub use append::Append;
pub use error::Error;
pub use plan::Plan;
pub use prefix::Prefix;

use crate::{
    alloc::{self, array},
    base::marker::ThreadBound,
    buffer,
    depot::queue::ring::State,
};

mod append;
mod error;
mod plan;
mod prefix;

/// An owned ring whose open state always retains its terminal reservation.
pub struct Ring<const N: usize> {
    buf: array::Block<mem::MaybeUninit<u8>, num::NonZero<usize>>,
    thread: marker::PhantomData<ThreadBound>,
    state: State<usize>,
    closed: bool,
}

impl<const N: usize> Ring<N> {
    pub fn try_new(plan: Plan<N>) -> Result<Self, alloc::Exhausted> {
        Ok(Self {
            buf: plan.capacity.try_allocate(())?,
            thread: marker::PhantomData,
            state: State::EMPTY,
            closed: false,
        })
    }

    pub fn capacity(&self) -> usize {
        self.buf.len() - N
    }

    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    pub fn len(&self) -> usize {
        self.state.len()
    }

    pub fn as_slices(&self) -> (&[u8], &[u8]) {
        self.prefix(self.len())
    }

    fn prefix(&self, len: usize) -> (&[u8], &[u8]) {
        let (start, [front, back]) = self.state.prefix(self.buf.len(), len);
        let pointer = self.buf.as_ptr().cast::<u8>();
        // SAFETY: the ring exposes exactly its initialized front and back ranges
        // of this unchanged block allocation.
        unsafe {
            (
                buffer::raw::range(pointer, start, front),
                buffer::raw::range(pointer, 0, back),
            )
        }
    }

    /// Appends one admitted source at the logical tail.
    ///
    /// Admission proves that the source fits; this owner updates its tail and length.
    fn append(&mut self, src: &[u8]) {
        use buffer::raw::SliceExt as _;

        let mut next = self.state;
        // SAFETY: Append or the retained terminal reservation admitted this
        // complete source against the unchanged nonzero allocation capacity.
        let (start, [front, back]) = unsafe { next.extend(self.buf.len(), src.len()) };
        let (head, tail) = src.split_at(front);
        let pointer = self.buf.as_mut_ptr().cast::<u8>();
        // SAFETY: admission retains disjoint sources and enough vacant storage
        // for both slices in this unchanged block.
        unsafe { head.copy_to(pointer.add(start)) };
        if back != 0 {
            // SAFETY: the same admission leaves this disjoint back range vacant.
            unsafe { tail.copy_to(pointer) };
        }
        self.state = next;
    }

    fn consume(&mut self, len: usize) {
        // SAFETY: Prefix retains an admitted prefix of this exact owner.
        unsafe { self.state.consume(self.buf.len(), len) };
    }

    /// Publishes the reserved terminal bytes once, without capacity validation.
    pub fn finish(&mut self, source: &[u8; N]) {
        if !self.closed {
            self.append(source);
            self.closed = true;
        }
    }
}

const _: () = {
    assert!(size_of::<Ring<17>>() == 5 * size_of::<usize>());
    assert!(size_of::<Option<Ring<17>>>() == size_of::<Ring<17>>());
};