hibana 0.3.0

Const-projected Affine Multiparty Session Types for choreography-first Rust protocols
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

use crate::control::cap::mint::{CAP_HANDLE_LEN, CapError};
#[cfg(test)]
use crate::control::types::{Lane, SessionId};

/// Handle payload for topology-control operations.
///
/// Encoding layout (big-endian):
/// ```text
/// [ 0..2 )  src_rv
/// [ 2..4 )  dst_rv
/// [ 4..6 )  src_lane
/// [ 6..8 )  dst_lane
/// [ 8..10)  old_gen
/// [10..12)  new_gen
/// [12..16)  seq_tx
/// [16..20)  seq_rx
/// [20..22)  reserved, must be zero
/// ```
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub(crate) struct TopologyHandle {
    pub src_rv: u16,
    pub dst_rv: u16,
    pub src_lane: u16,
    pub dst_lane: u16,
    pub old_gen: u16,
    pub new_gen: u16,
    pub seq_tx: u32,
    pub seq_rx: u32,
}

impl TopologyHandle {
    pub(crate) fn encode(self) -> [u8; CAP_HANDLE_LEN] {
        let mut buf = [0u8; CAP_HANDLE_LEN];
        buf[0..2].copy_from_slice(&self.src_rv.to_be_bytes());
        buf[2..4].copy_from_slice(&self.dst_rv.to_be_bytes());
        buf[4..6].copy_from_slice(&self.src_lane.to_be_bytes());
        buf[6..8].copy_from_slice(&self.dst_lane.to_be_bytes());
        buf[8..10].copy_from_slice(&self.old_gen.to_be_bytes());
        buf[10..12].copy_from_slice(&self.new_gen.to_be_bytes());
        buf[12..16].copy_from_slice(&self.seq_tx.to_be_bytes());
        buf[16..20].copy_from_slice(&self.seq_rx.to_be_bytes());
        buf
    }

    pub(crate) fn decode(data: [u8; CAP_HANDLE_LEN]) -> Result<Self, CapError> {
        let flags = u16::from_be_bytes([data[20], data[21]]);
        if flags != 0 {
            return Err(CapError::Mismatch);
        }
        Ok(Self {
            src_rv: u16::from_be_bytes([data[0], data[1]]),
            dst_rv: u16::from_be_bytes([data[2], data[3]]),
            src_lane: u16::from_be_bytes([data[4], data[5]]),
            dst_lane: u16::from_be_bytes([data[6], data[7]]),
            old_gen: u16::from_be_bytes([data[8], data[9]]),
            new_gen: u16::from_be_bytes([data[10], data[11]]),
            seq_tx: u32::from_be_bytes([data[12], data[13], data[14], data[15]]),
            seq_rx: u32::from_be_bytes([data[16], data[17], data[18], data[19]]),
        })
    }
}

/// Handle payload for delegation operations.
///
/// Encoding layout (big-endian):
/// ```text
/// [ 0..2 )  src_rv
/// [ 2..4 )  dst_rv
/// [ 4..6 )  src_lane
/// [ 6..8 )  dst_lane
/// [ 8..12)  seq_tx
/// [12..16)  seq_rx
/// [16..20)  shard / policy metadata
/// [20..22)  flags
/// ```
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub(crate) struct DelegationHandle {
    pub src_rv: u16,
    pub dst_rv: u16,
    pub src_lane: u16,
    pub dst_lane: u16,
    pub seq_tx: u32,
    pub seq_rx: u32,
    pub shard: u32,
    pub flags: u16,
}

impl DelegationHandle {
    pub(crate) fn encode(self) -> [u8; CAP_HANDLE_LEN] {
        let mut buf = [0u8; CAP_HANDLE_LEN];
        buf[0..2].copy_from_slice(&self.src_rv.to_be_bytes());
        buf[2..4].copy_from_slice(&self.dst_rv.to_be_bytes());
        buf[4..6].copy_from_slice(&self.src_lane.to_be_bytes());
        buf[6..8].copy_from_slice(&self.dst_lane.to_be_bytes());
        buf[8..12].copy_from_slice(&self.seq_tx.to_be_bytes());
        buf[12..16].copy_from_slice(&self.seq_rx.to_be_bytes());
        buf[16..20].copy_from_slice(&self.shard.to_be_bytes());
        buf[20..22].copy_from_slice(&self.flags.to_be_bytes());
        buf
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) struct SessionLaneHandle {
    sid: u32,
    lane: u16,
}

impl SessionLaneHandle {
    #[inline(always)]
    pub(crate) const fn new(sid: u32, lane: u16) -> Self {
        Self { sid, lane }
    }

    #[inline(always)]
    pub(crate) const fn sid(self) -> u32 {
        self.sid
    }

    #[inline(always)]
    pub(crate) const fn lane(self) -> u16 {
        self.lane
    }
}

#[cfg(test)]
pub(crate) const TAG_STATE_SNAPSHOT_CONTROL: u8 = 0x42;
#[cfg(test)]
pub(crate) const TAG_ABORT_BEGIN_CONTROL: u8 = 0x45;
#[cfg(test)]
pub(crate) const TAG_CAP_DELEGATE_CONTROL: u8 = 0x49;
#[cfg(test)]
pub(crate) const TAG_TOPOLOGY_BEGIN_CONTROL: u8 = 0x57;

#[cfg(test)]
#[inline]
pub(crate) fn encode_session_lane_handle(handle: SessionLaneHandle) -> [u8; CAP_HANDLE_LEN] {
    let mut buf = [0u8; CAP_HANDLE_LEN];
    buf[0..4].copy_from_slice(&handle.sid().to_le_bytes());
    buf[4..6].copy_from_slice(&handle.lane().to_le_bytes());
    buf
}

#[inline]
pub(crate) fn decode_session_lane_handle(
    data: [u8; CAP_HANDLE_LEN],
) -> Result<SessionLaneHandle, CapError> {
    if data[6..].iter().any(|byte| *byte != 0) {
        return Err(CapError::Mismatch);
    }
    let sid = u32::from_le_bytes([data[0], data[1], data[2], data[3]]);
    let lane = u16::from_le_bytes([data[4], data[5]]);
    Ok(SessionLaneHandle::new(sid, lane))
}

#[cfg(test)]
#[inline(always)]
pub(crate) const fn mint_session_lane_handle(sid: SessionId, lane: Lane) -> SessionLaneHandle {
    SessionLaneHandle::new(sid.raw(), lane.raw() as u16)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn topology_handle_rejects_reserved_flags() {
        let handle = TopologyHandle {
            src_rv: 1,
            dst_rv: 2,
            src_lane: 3,
            dst_lane: 4,
            old_gen: 5,
            new_gen: 6,
            seq_tx: 7,
            seq_rx: 8,
        };
        let encoded = handle.encode();
        assert_eq!(TopologyHandle::decode(encoded), Ok(handle));

        let mut flagged = encoded;
        flagged[21] = 1;
        assert_eq!(TopologyHandle::decode(flagged), Err(CapError::Mismatch));
    }

    #[test]
    fn topology_handle_has_no_flags_field() {
        let source = include_str!("atomic_codecs.rs");
        let start = source.find("struct TopologyHandle").unwrap();
        let end = source.find("impl TopologyHandle").unwrap();
        assert!(
            !source[start..end].contains("flags:"),
            "topology handle must keep [20..22) as reserved wire bytes, not a runtime field"
        );
    }

    #[test]
    fn session_lane_handle_rejects_reserved_tail() {
        let handle = mint_session_lane_handle(SessionId::new(11), Lane::new(3));
        let encoded = encode_session_lane_handle(handle);
        assert_eq!(decode_session_lane_handle(encoded), Ok(handle));

        let mut trailing = encoded;
        trailing[6] = 0xA5;
        assert_eq!(
            decode_session_lane_handle(trailing),
            Err(CapError::Mismatch)
        );
    }
}