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
mod common;
#[path = "support/placement.rs"]
mod placement_support;
#[path = "support/runtime.rs"]
mod runtime_support;
#[path = "support/tls_mut.rs"]
mod tls_mut_support;
#[path = "support/tls_ref.rs"]
mod tls_ref_support;
use ::core::{
cell::UnsafeCell,
future::Future,
mem::{MaybeUninit, size_of, size_of_val},
task::{Context, Poll},
};
use common::TestTransport;
use hibana::g::{self, Msg};
use hibana::runtime::program::{RoleProgram, project};
use hibana::runtime::{SessionKitStorage, ids::SessionId};
use placement_support::write_value;
use runtime_support::with_runtime_workspace;
use tls_mut_support::with_tls_mut;
use tls_ref_support::with_resident_tls_ref;
type TestKitStorage = SessionKitStorage<'static, TestTransport>;
const ROUTE_BRANCH_BYTES_MAX: usize = 32;
const OFFER_FUTURE_BYTES_MAX: usize = 48;
const BRANCH_RECV_FUTURE_BYTES_MAX: usize = 48;
std::thread_local! {
static SESSION_SLOT: UnsafeCell<TestKitStorage> = const {
UnsafeCell::new(SessionKitStorage::uninit())
};
static CONTROLLER_ENDPOINT_SLOT: UnsafeCell<MaybeUninit<hibana::Endpoint<'static, 0>>> = const {
UnsafeCell::new(MaybeUninit::uninit())
};
static WORKER_ENDPOINT_SLOT: UnsafeCell<MaybeUninit<hibana::Endpoint<'static, 1>>> = const {
UnsafeCell::new(MaybeUninit::uninit())
};
}
fn controller_program() -> RoleProgram<0> {
let inner_route = g::route(
g::send::<0, 1, Msg<7, u32>>(),
g::send::<0, 1, Msg<8, u32>>(),
);
let outer_left = g::seq(g::send::<0, 1, Msg<5, u32>>(), inner_route);
let outer_right = g::send::<0, 1, Msg<6, u32>>();
let program = g::route(outer_left, outer_right);
project(&program)
}
fn worker_program() -> RoleProgram<1> {
let inner_route = g::route(
g::send::<0, 1, Msg<7, u32>>(),
g::send::<0, 1, Msg<8, u32>>(),
);
let outer_left = g::seq(g::send::<0, 1, Msg<5, u32>>(), inner_route);
let outer_right = g::send::<0, 1, Msg<6, u32>>();
let program = g::route(outer_left, outer_right);
project(&program)
}
// Test nested first-visible routes.
#[test]
fn nested_branch_commit_stack() {
with_runtime_workspace(|slab| {
with_resident_tls_ref(&SESSION_SLOT, |cluster| {
let transport = TestTransport::new();
let rv = cluster
.rendezvous(slab, transport.clone())
.expect("register rv");
let sid = SessionId::new(77);
let controller_program = controller_program();
let worker_program = worker_program();
with_tls_mut(
&CONTROLLER_ENDPOINT_SLOT,
|ptr| unsafe {
write_value(
ptr,
rv.enter(sid, &controller_program)
.expect("attach controller"),
);
},
|controller| {
with_tls_mut(
&WORKER_ENDPOINT_SLOT,
|ptr| unsafe {
write_value(
ptr,
rv.enter(sid, &worker_program).expect("attach worker"),
);
},
|worker| {
futures::executor::block_on(async {
// =========================================================================
// Outer route: Controller sends wire data to Worker
// =========================================================================
controller
.send::<Msg<5, u32>>(&1234)
.await
.expect("send outer left data");
// =========================================================================
// Outer route: Worker offers route arm, then receives selected data
// =========================================================================
let outer_branch = worker.offer().await.expect("offer outer route");
assert_eq!(
outer_branch.label(),
5,
"outer route should expose OuterLeftData"
);
let observed_outer = outer_branch
.recv::<Msg<5, u32>>()
.await
.expect("decode outer left data");
assert_eq!(observed_outer, 1234);
// =========================================================================
// Inner route: Controller sends wire data to Worker
// =========================================================================
controller
.send::<Msg<7, u32>>(&5678)
.await
.expect("send inner left data");
// =========================================================================
// Inner route: Worker offers route arm, then receives selected data
// =========================================================================
let inner_branch = worker.offer().await.expect("offer inner route");
assert_eq!(
inner_branch.label(),
7,
"inner route should expose InnerLeftData"
);
let observed_inner = inner_branch
.recv::<Msg<7, u32>>()
.await
.expect("decode inner left data");
assert_eq!(observed_inner, 5678);
})
},
);
},
);
});
});
}
#[test]
fn forgotten_started_offer_future_leaves_endpoint_fail_closed() {
with_runtime_workspace(|slab| {
with_resident_tls_ref(&SESSION_SLOT, |cluster| {
let transport = TestTransport::new();
let rv = cluster.rendezvous(slab, transport).expect("register rv");
let sid = SessionId::new(79);
let controller_program = controller_program();
let worker_program = worker_program();
with_tls_mut(
&CONTROLLER_ENDPOINT_SLOT,
|ptr| unsafe {
write_value(
ptr,
rv.enter(sid, &controller_program)
.expect("attach controller"),
);
},
|controller| {
core::hint::black_box(controller);
with_tls_mut(
&WORKER_ENDPOINT_SLOT,
|ptr| unsafe {
write_value(
ptr,
rv.enter(sid, &worker_program).expect("attach worker"),
);
},
|worker| {
let mut offer = Box::pin(worker.offer());
let waker = futures::task::noop_waker();
let mut cx = Context::from_waker(&waker);
if let Poll::Ready(result) = Future::poll(offer.as_mut(), &mut cx) {
match result {
Ok(_) => {
panic!("offer should wait before the route decision")
}
Err(error) => {
panic!("offer failed before the route decision: {error:?}")
}
}
}
core::mem::forget(offer);
let error = match futures::executor::block_on(worker.offer()) {
Ok(_) => panic!(
"forgotten pending offer must leave endpoint fail-closed"
),
Err(error) => error,
};
assert!(format!("{error:?}").contains("operation: \"offer\""));
let rendered = format!("{error:?}");
assert!(
rendered.contains("PhaseInvariant")
|| rendered.contains("ProgressInvariantViolated")
|| rendered.contains("SessionFault"),
"busy endpoint must preserve terminal progress evidence: {rendered}"
);
},
)
},
);
});
});
}
#[test]
fn localside_branch_recv_sizes_stay_compact() {
with_runtime_workspace(|slab| {
with_resident_tls_ref(&SESSION_SLOT, |cluster| {
let transport = TestTransport::new();
let rv = cluster.rendezvous(slab, transport).expect("register rv");
let sid = SessionId::new(78);
let controller_program = controller_program();
let worker_program = worker_program();
with_tls_mut(
&CONTROLLER_ENDPOINT_SLOT,
|ptr| unsafe {
write_value(
ptr,
rv.enter(sid, &controller_program)
.expect("attach controller"),
);
},
|controller| {
with_tls_mut(
&WORKER_ENDPOINT_SLOT,
|ptr| unsafe {
write_value(
ptr,
rv.enter(sid, &worker_program).expect("attach worker"),
);
},
|worker| {
let offer = worker.offer();
let offer_bytes = size_of_val(&offer);
drop(offer);
futures::executor::block_on(controller.send::<Msg<5, u32>>(&1234))
.expect("send outer left data");
let branch =
futures::executor::block_on(worker.offer()).expect("offer route");
let branch_bytes =
size_of::<hibana::RouteBranch<'static, 'static, 1>>();
assert_eq!(branch.label(), 5, "route should expose outer left arm");
let recv = branch.recv::<Msg<5, u32>>();
let recv_bytes = size_of_val(&recv);
drop(recv);
assert!(
branch_bytes <= ROUTE_BRANCH_BYTES_MAX,
"route branch handle regressed: {branch_bytes} > {ROUTE_BRANCH_BYTES_MAX}"
);
assert!(
offer_bytes <= OFFER_FUTURE_BYTES_MAX,
"offer future regressed: {offer_bytes} > {OFFER_FUTURE_BYTES_MAX}"
);
assert!(
recv_bytes <= BRANCH_RECV_FUTURE_BYTES_MAX,
"branch recv future regressed: {recv_bytes} > {BRANCH_RECV_FUTURE_BYTES_MAX}"
);
},
);
},
);
});
});
}