hibana 0.9.5

Choreography-derived runtime enforcement kernel for no_std Rust multiparty 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
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
use super::super::{
    BlobPtr, LaneSetView, LaneStepLayout, LaneSteps, PackedLaneRange, PackedRollScopeRow,
    RoleCompiledCounts, RoleImageColumns, RoleImageRef, RoleLaneImage, RuntimeRoleFacts,
    RuntimeRoleFootprint, lane_byte_count,
};
use super::lane_image::invalid_resident_descriptor;
use super::metadata::{
    derive_active_lane_metadata, lane_columns_are_coherent, roll_scope_columns_are_coherent,
    route_commit_capacity_is_exact,
};
use crate::global::typestate::{LocalAction, LocalDependency, LocalNode, PackedEventConflict};

#[inline(always)]
const fn compact_count(value: usize) -> u16 {
    if value > u16::MAX as usize {
        panic!("role descriptor fact overflow");
    }
    value as u16
}

impl RuntimeRoleFacts {
    const MAX_ROUTE_COMMIT_COUNT: usize = 0;
    const LOCAL_STEP_COUNT: usize = 1;
    const ROUTE_SCOPE_COUNT: usize = 2;
    const ACTIVE_LANE_COUNT: usize = 3;
    const ENDPOINT_LANE_SLOT_COUNT: usize = 4;
    const LOGICAL_LANE_COUNT: usize = 5;

    #[inline(always)]
    pub(crate) const fn from_counts(counts: RoleCompiledCounts) -> Self {
        Self {
            words: [
                compact_count(counts.max_route_commit_count),
                compact_count(counts.local_step_count),
                compact_count(counts.route_scope_count),
                compact_count(counts.active_lane_count),
                compact_count(counts.endpoint_lane_slot_count),
                compact_count(counts.logical_lane_count),
            ],
        }
    }

    #[inline(always)]
    pub(crate) const fn footprint(self) -> RuntimeRoleFootprint {
        RuntimeRoleFootprint {
            max_route_commit_count: self.words[Self::MAX_ROUTE_COMMIT_COUNT] as usize,
            route_arm_state_capacity: 0,
            local_step_count: self.words[Self::LOCAL_STEP_COUNT] as usize,
            route_scope_count: self.words[Self::ROUTE_SCOPE_COUNT] as usize,
            active_lane_count: self.words[Self::ACTIVE_LANE_COUNT] as usize,
            endpoint_lane_slot_count: self.words[Self::ENDPOINT_LANE_SLOT_COUNT] as usize,
            logical_lane_count: self.words[Self::LOGICAL_LANE_COUNT] as usize,
        }
    }
}

impl RoleImageRef {
    pub(crate) const fn new<const N: usize>(
        program: &'static crate::global::compiled::images::CompiledProgramRef,
        role: u8,
        facts: RuntimeRoleFacts,
        columns: RoleImageColumns,
        bytes: &'static [u8; N],
    ) -> Self {
        let blob = BlobPtr::from_array(bytes, columns.blob_len());
        let footprint = facts.footprint();
        let active_lane_row = if footprint.active_lane_count == 0 {
            PackedLaneRange::new(0, 0)
        } else {
            PackedLaneRange::new(0, lane_byte_count(footprint.logical_lane_count))
        };
        let metadata = match derive_active_lane_metadata(bytes, columns.lane_bits, active_lane_row)
        {
            Some(metadata) => metadata,
            None => invalid_resident_descriptor(),
        };
        let image = Self {
            program,
            role,
            facts,
            columns,
            blob,
            active_lane_row,
            first_active_lane: metadata.first_active_lane,
        };
        if metadata.active_lane_count != footprint.active_lane_count
            || metadata.logical_lane_count != footprint.logical_lane_count
            || metadata.logical_lane_count != footprint.endpoint_lane_slot_count
        {
            invalid_resident_descriptor();
        }
        if !lane_columns_are_coherent(bytes, columns, active_lane_row, footprint) {
            invalid_resident_descriptor();
        }
        if !roll_scope_columns_are_coherent(bytes, columns.roll_scopes, footprint.local_step_count)
        {
            invalid_resident_descriptor();
        }
        if !route_commit_capacity_is_exact(
            bytes,
            columns.route_commit_ranges,
            columns.route_commit_rows.len as usize,
            footprint.max_route_commit_count,
        ) {
            invalid_resident_descriptor();
        }
        image
    }

    #[inline(always)]
    pub(crate) const fn lanes(&self) -> RoleLaneImage<'_> {
        RoleLaneImage::new(&self.columns, self.blob)
    }

    #[inline(always)]
    pub(crate) const fn footprint(&self) -> RuntimeRoleFootprint {
        let mut footprint = self.facts.footprint();
        footprint.route_arm_state_capacity = self.columns.route_arm_lane_step_rows.len as usize;
        footprint
    }

    #[inline(always)]
    pub(crate) const fn local_step_count(&self) -> usize {
        self.footprint().local_step_count
    }

    #[inline(always)]
    pub(crate) const fn active_lane_set(&self) -> LaneSetView<'static> {
        let footprint = self.footprint();
        self.lanes()
            .lane_bit_view(self.active_lane_row, footprint.lane_word_count())
    }

    #[inline(always)]
    pub(crate) const fn resident_row_min_start(&self, idx: usize) -> Option<u16> {
        self.lanes().resident_row_min_start(idx)
    }

    pub(crate) const fn resident_row_lane_steps(
        &self,
        idx: usize,
        lane_idx: usize,
    ) -> Option<LaneSteps> {
        if lane_idx >= self.footprint().logical_lane_count {
            return None;
        }
        let lanes = self.lanes();
        if idx >= lanes.resident_row_count() {
            return None;
        }
        let row = lanes.resident_row_range(idx);
        if row.end() > self.local_step_count() {
            invalid_resident_descriptor();
        }
        let mut pos = row.start();
        let end = row.end();
        let mut first = None;
        let mut len = 0usize;
        let mut layout = LaneStepLayout::Contiguous;
        while pos < end {
            if matches!(self.local_step_lane(pos), Some(lane) if lane as usize == lane_idx) {
                match first {
                    Some(start) if pos != start + len => layout = LaneStepLayout::Sparse,
                    Some(_) => {}
                    None => first = Some(pos),
                }
                len += 1;
            }
            pos += 1;
        }
        let Some(first) = first else {
            return None;
        };
        if len > u16::MAX as usize {
            invalid_resident_descriptor();
        } else {
            Some(LaneSteps {
                start: first as u16,
                len: len as u16,
                layout,
            })
        }
    }

    #[inline(always)]
    pub(crate) const fn dependency_for_index(&self, current_idx: usize) -> Option<LocalDependency> {
        self.lanes().dependency_for_index(current_idx)
    }

    #[inline(always)]
    pub(crate) const fn event_conflict_for_index(&self, current_idx: usize) -> PackedEventConflict {
        self.lanes().event_conflict_for_index(current_idx)
    }

    #[inline(always)]
    pub(crate) const fn route_scope_conflict_by_slot(&self, slot: usize) -> PackedEventConflict {
        self.lanes().route_scope_conflict_by_slot(slot)
    }

    #[inline(always)]
    pub(crate) const fn route_commit_range_by_slot(&self, slot: usize, arm: u8) -> PackedLaneRange {
        self.lanes().route_commit_range_by_slot(slot, arm)
    }

    #[inline(always)]
    pub(crate) const fn route_commit_row_at(&self, idx: usize) -> PackedEventConflict {
        self.lanes().route_commit_row_at(idx)
    }

    #[inline(always)]
    pub(crate) const fn roll_scope_row(&self, slot: usize) -> Option<PackedRollScopeRow> {
        self.lanes().roll_scope_row(slot)
    }

    #[inline(always)]
    pub(crate) const fn route_scope_by_slot(
        &self,
        slot: usize,
    ) -> Option<crate::global::const_dsl::ScopeId> {
        self.lanes().route_scope_by_slot(slot)
    }

    #[inline(always)]
    pub(crate) const fn route_scope_slot(
        &self,
        scope: crate::global::const_dsl::ScopeId,
    ) -> Option<usize> {
        if self.columns.route_scopes.len as usize != self.footprint().route_scope_count {
            invalid_resident_descriptor();
        }
        self.lanes().route_scope_slot(scope)
    }

    #[inline(always)]
    pub(crate) const fn route_scope_reentry_by_slot(&self, slot: usize) -> bool {
        self.lanes().route_scope_reentry_by_slot(slot)
    }

    #[inline(always)]
    pub(crate) const fn passive_arm_child_ordinal_by_slot(
        &self,
        slot: usize,
        arm: u8,
    ) -> Option<u16> {
        self.lanes().passive_arm_child_ordinal_by_slot(slot, arm)
    }

    #[inline(always)]
    pub(crate) const fn route_arm_event_row_by_slot(
        &self,
        slot: usize,
        arm: u8,
    ) -> PackedLaneRange {
        self.lanes().route_arm_event_row_by_slot(slot, arm)
    }

    #[inline(always)]
    pub(crate) const fn local_step_lane(&self, step_idx: usize) -> Option<u8> {
        if step_idx >= self.local_step_count() {
            return None;
        }
        match self
            .lanes()
            .local_step_lane(step_idx, self.footprint().logical_lane_count)
        {
            Some(lane) => Some(lane),
            None => invalid_resident_descriptor(),
        }
    }

    pub(crate) const fn local_step_node(&self, step_idx: usize) -> Option<LocalNode> {
        if step_idx >= self.local_step_count() {
            None
        } else {
            let node = match self
                .lanes()
                .local_step_node(step_idx, self.role, self.program)
            {
                Some(node) => node,
                None => invalid_resident_descriptor(),
            };
            let Some(expected_lane) = self.local_step_lane(step_idx) else {
                invalid_resident_descriptor();
            };
            let actual_lane = match node.action() {
                LocalAction::Send { lane, .. }
                | LocalAction::Recv { lane, .. }
                | LocalAction::Local { lane, .. } => lane,
                LocalAction::Terminate => invalid_resident_descriptor(),
            };
            if actual_lane != expected_lane {
                invalid_resident_descriptor();
            }
            Some(node)
        }
    }

    pub(crate) const fn resident_row_lane_step_at(
        &self,
        idx: usize,
        lane_idx: usize,
        ordinal: usize,
    ) -> Option<u16> {
        if lane_idx >= self.footprint().logical_lane_count {
            return None;
        }
        let lanes = self.lanes();
        if idx >= lanes.resident_row_count() {
            return None;
        }
        let row = lanes.resident_row_range(idx);
        if row.end() > self.local_step_count() {
            invalid_resident_descriptor();
        }
        let mut pos = row.start();
        let end = row.end();
        let mut seen = 0usize;
        while pos < end {
            if matches!(self.local_step_lane(pos), Some(lane) if lane as usize == lane_idx) {
                if seen == ordinal {
                    if pos > u16::MAX as usize {
                        invalid_resident_descriptor();
                    }
                    return Some(pos as u16);
                }
                seen += 1;
            }
            pos += 1;
        }
        None
    }

    pub(crate) const fn resident_row_lane_step_ordinal(
        &self,
        idx: usize,
        lane_idx: usize,
        step_idx: usize,
    ) -> Option<u16> {
        if lane_idx >= self.footprint().logical_lane_count {
            return None;
        }
        let lanes = self.lanes();
        if idx >= lanes.resident_row_count() {
            return None;
        }
        let row = lanes.resident_row_range(idx);
        if row.end() > self.local_step_count() {
            invalid_resident_descriptor();
        }
        if step_idx < row.start() || step_idx >= row.end() {
            return None;
        }
        let mut pos = row.start();
        let end = row.end();
        let mut ordinal = 0usize;
        while pos < end {
            if matches!(self.local_step_lane(pos), Some(lane) if lane as usize == lane_idx) {
                if pos == step_idx {
                    if ordinal > u16::MAX as usize {
                        invalid_resident_descriptor();
                    }
                    return Some(ordinal as u16);
                }
                ordinal += 1;
            }
            pos += 1;
        }
        None
    }

    #[inline(always)]
    pub(crate) const fn first_active_lane(&self) -> Option<usize> {
        if self.first_active_lane == u16::MAX {
            None
        } else {
            Some(self.first_active_lane as usize)
        }
    }

    #[inline(always)]
    pub(crate) const fn route_scope_arm_lane_set_by_slot(
        &self,
        slot: usize,
        arm: u8,
    ) -> LaneSetView<'static> {
        self.lanes()
            .route_scope_arm_lane_set_by_slot(slot, arm, self.footprint().lane_word_count())
    }

    #[inline(always)]
    pub(crate) const fn route_scope_offer_lane_set_by_slot(
        &self,
        slot: usize,
    ) -> LaneSetView<'static> {
        self.lanes()
            .route_scope_offer_lane_set_by_slot(slot, self.footprint().lane_word_count())
    }

    #[inline(always)]
    pub(crate) const fn route_arm_lane_first_step_by_slot(
        &self,
        slot: usize,
        arm: u8,
        lane: u8,
    ) -> Option<u16> {
        self.lanes().route_arm_lane_first_step_by_slot(
            slot,
            arm,
            lane,
            self.footprint().logical_lane_count,
        )
    }

    #[inline(always)]
    pub(crate) const fn route_arm_lane_last_step_by_slot(
        &self,
        slot: usize,
        arm: u8,
        lane: u8,
    ) -> Option<u16> {
        self.lanes().route_arm_lane_last_step_by_slot(
            slot,
            arm,
            lane,
            self.footprint().logical_lane_count,
        )
    }
}