aetherflow 0.1.0

A high-performance, thread-per-core actor runtime for Rust. Messages move with zero-copy ownership, mailboxes are lock-free, and isolation is proven at compile time — so the hot path has no locks, no GC, and no atomic refcounts. Flow at the speed of hardware.
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
//! ランタイム統合テスト: System → spawn → move 送信 → run-to-completion → shutdown。

use aetherflow::{
    Actor, ActorRef, AskError, Responder, RestartPolicy, SendError, System, TrySendError,
};
use std::sync::mpsc;
use std::time::Duration;

/// handler 内から同一コアの actor へ ask すると、ハングせず `WouldBlockCallingCore` で返る
/// (デッドロックガード)。沈黙のハングを明確なエラーに変える。
#[test]
fn ask_from_handler_to_same_core_returns_error_not_hang() {
    struct Callee;
    impl Actor for Callee {
        type Message = Responder<u64>;
        fn handle(&mut self, r: Responder<u64>) {
            r.reply(1);
        }
    }
    struct Caller {
        callee: ActorRef<Callee>,
        out: mpsc::Sender<Result<u64, AskError>>,
    }
    impl Actor for Caller {
        type Message = ();
        fn handle(&mut self, _m: ()) {
            // 同一コアの callee へ ask → ガードが Err を返す(ブロックしてハングしない)
            let r = self.callee.ask(|resp| resp);
            self.out.send(r).unwrap();
        }
    }

    let sys = System::with_cores(1);
    let callee = sys.spawn_on(0, Callee);
    let (out, rx) = mpsc::channel();
    let caller = sys.spawn_on(0, Caller {
        callee: callee.clone(),
        out,
    });
    caller.send_blocking(()).unwrap(); // main スレッドからは通常送信
    assert_eq!(rx.recv().unwrap(), Err(AskError::WouldBlockCallingCore));

    drop(caller);
    drop(callee);
    sys.shutdown();
}

/// 型隔離のおかげで、同一コアの 1 actor がパニックしても他 actor・コアは生き続ける
/// (Arc<Mutex> 系なら Mutex poison で続行不能になる所)。
#[test]
fn panic_in_one_actor_does_not_kill_others_on_same_core() {
    struct Bomb;
    impl Actor for Bomb {
        type Message = bool;
        fn handle(&mut self, boom: bool) {
            if boom {
                panic!("boom"); // stderr にパニック表示が出るのは想定内
            }
        }
    }
    struct Survivor {
        out: mpsc::Sender<u32>,
    }
    impl Actor for Survivor {
        type Message = u32;
        fn handle(&mut self, m: u32) {
            self.out.send(m).unwrap();
        }
    }

    let sys = System::with_cores(1);
    let bomb = sys.spawn_on(0, Bomb);
    let (out, rx) = mpsc::channel();
    let survivor = sys.spawn_on(0, Survivor { out }); // 同一コア

    bomb.send_blocking(true).unwrap(); // bomb を爆発させる → 切り離される
    survivor.send_blocking(42).unwrap(); // 爆発後も survivor は動く
    assert_eq!(rx.recv().unwrap(), 42);

    drop(bomb);
    drop(survivor);
    sys.shutdown();
}

/// 消滅した actor への `send_blocking` は永久スピンせず `Err(Closed)` で返る(元メッセージ付き)。
/// = actor 障害を送信側スレッドに panic 伝播させず、値として明示する。
#[test]
fn send_blocking_to_dead_actor_returns_closed_not_hang() {
    struct Bomb;
    impl Actor for Bomb {
        type Message = ();
        fn handle(&mut self, _m: ()) {
            panic!("die"); // 非 supervised → 切り離される
        }
    }
    let sys = System::with_cores(1);
    let addr = sys.spawn_on(0, Bomb);
    addr.send_blocking(()).unwrap(); // これは成功(mailbox に入り、処理で爆発 → detach)
    // detach 完了(consumer 消滅)まで待つ。以後の try_send は Closed を返す。
    loop {
        match addr.try_send(()) {
            Err(TrySendError::Closed(_)) => break,
            _ => std::hint::spin_loop(),
        }
    }
    // send_blocking も Closed を返す(永久スピンしない = 退行なら以下でハング)。
    assert!(matches!(addr.send_blocking(()), Err(SendError::Closed(_))));
    drop(addr);
    sys.shutdown();
}

/// ライフサイクルフックも障害境界に含まれる: on_start がパニックしても、その actor が
/// 捨てられるだけでコアスレッドは死なず、同一コアの他 actor は動き続ける。
#[test]
fn panic_in_on_start_does_not_kill_core() {
    struct StartBomb;
    impl Actor for StartBomb {
        type Message = ();
        fn on_start(&mut self) {
            panic!("on_start boom"); // 想定内(stderr に出る)
        }
        fn handle(&mut self, _m: ()) {}
    }
    struct Survivor {
        out: mpsc::Sender<u32>,
    }
    impl Actor for Survivor {
        type Message = u32;
        fn handle(&mut self, m: u32) {
            self.out.send(m).unwrap();
        }
    }

    let sys = System::with_cores(1);
    let bomb = sys.spawn_on(0, StartBomb); // on_start パニック → 捨てられる(コアは生存)
    let (out, rx) = mpsc::channel();
    let survivor = sys.spawn_on(0, Survivor { out }); // 同一コア

    survivor.send_blocking(7).unwrap(); // コアが生きていれば処理される(死んでいれば recv がハング)
    assert_eq!(rx.recv().unwrap(), 7);

    drop(bomb);
    drop(survivor);
    sys.shutdown();
}

/// ビルダーで instrumented にすると processing-latency が取れ、非 instrumented は None(ゼロコスト既定)。
#[test]
fn instrumented_builder_records_latency() {
    struct Work;
    impl Actor for Work {
        type Message = u64;
        fn handle(&mut self, _m: u64) {}
    }
    let sys = System::with_cores(2);

    let addr = sys.build(|| Work).core(0).instrumented().spawn();
    assert!(addr.latency().is_some());
    const N: usize = 5_000;
    for i in 0..N {
        addr.send_blocking(i as u64).unwrap();
    }
    // total_processed()=mailbox の dequeue 数は handle/記録の *前* に増える近似値。
    // これで待つと最後の1通が「取り出し済み・未記録」のまま assert して flaky になる。
    // 記録は handle の後なので、histogram の count が N に達するまで待つのが正しい同期点。
    while addr.total_processed() < N {
        std::hint::spin_loop();
    }
    while addr.latency().unwrap().count < N as u64 {
        std::hint::spin_loop();
    }
    let snap = addr.latency().unwrap();
    assert_eq!(snap.count, N as u64);

    // 非 instrumented は latency 無し(既定ゼロコスト)。
    let plain = sys.spawn_on(1, Work);
    assert!(plain.latency().is_none());

    drop(addr);
    drop(plain);
    sys.shutdown();
}

/// observability カウンタ(送信総数 / 処理総数 / 滞留数)が正しく、hot path 追加コストなしで読める。
#[test]
fn observability_counters() {
    struct Nop;
    impl Actor for Nop {
        type Message = u64;
        fn handle(&mut self, _m: u64) {}
    }
    let sys = System::with_cores(1);
    let addr = sys.spawn_on(0, Nop);
    const N: usize = 10_000;
    for i in 0..N {
        addr.send_blocking(i as u64).unwrap();
    }
    assert_eq!(addr.total_sent(), N);
    while addr.total_processed() < N {
        std::hint::spin_loop();
    }
    assert_eq!(addr.total_processed(), N);
    assert_eq!(addr.mailbox_depth(), 0);
    drop(addr);
    sys.shutdown();
}

/// supervised actor はパニック後に工場で作り直され、mailbox を保ったまま継続する(restart)。
/// 新品なので状態はリセットされる = 隔離ゆえ壊れた状態が残らないことの証拠。
#[test]
fn supervised_actor_restarts_after_panic() {
    struct Counter {
        n: u64,
        out: mpsc::Sender<u64>,
    }
    impl Actor for Counter {
        type Message = bool; // true = 爆発
        fn handle(&mut self, boom: bool) {
            if boom {
                panic!("boom");
            }
            self.n += 1;
            self.out.send(self.n).unwrap();
        }
    }

    let sys = System::with_cores(1);
    let (out, rx) = mpsc::channel();
    let addr = sys.spawn_on_supervised(0, move || Counter { n: 0, out: out.clone() });

    addr.send_blocking(false).unwrap(); // n=1
    addr.send_blocking(false).unwrap(); // n=2
    assert_eq!(rx.recv().unwrap(), 1);
    assert_eq!(rx.recv().unwrap(), 2);

    addr.send_blocking(true).unwrap(); // パニック → restart(状態リセット)
    addr.send_blocking(false).unwrap(); // 新品: n=1 に戻る
    assert_eq!(rx.recv().unwrap(), 1); // 状態リセットの証拠

    drop(addr);
    sys.shutdown();
}

/// restart 上限: 毎回パニックする supervised actor は、上限(ここでは 2 回)を超えたら
/// 無限に再起動せず停止・切り離される(= restart-loop でコアを焼き続けない)。
/// 上限が効いていなければ actor は永久に restart し、下の Closed 待ちがハングして退行を検出する。
#[test]
fn supervised_restart_limit_stops_after_exceeding() {
    struct AlwaysPanic;
    impl Actor for AlwaysPanic {
        type Message = ();
        fn handle(&mut self, _m: ()) {
            panic!("always"); // 毎回爆発 → 毎回 restart 要求
        }
    }
    let sys = System::with_cores(1);
    let addr = sys
        .build(|| AlwaysPanic)
        .core(0)
        .restart_policy(RestartPolicy::Limited {
            max_restarts: 2,
            within: Duration::from_secs(10),
        })
        .spawn();
    for _ in 0..5 {
        let _ = addr.try_send(()); // 何度も爆発させる
    }
    // 上限超過で detach → 以後の送信は Closed(無制限なら永久 restart でここがハング)。
    loop {
        match addr.try_send(()) {
            Err(TrySendError::Closed(_)) => break,
            _ => std::hint::spin_loop(),
        }
    }
    drop(addr);
    sys.shutdown();
}

/// パニックする actor へ ask すると、Responder が返信前に drop されて呼び出し側は
/// デッドロックせず NoReply で起きる(ask とパニック分離の合成)。
#[test]
fn ask_to_panicking_actor_returns_no_reply() {
    struct Panicker;
    impl Actor for Panicker {
        type Message = Responder<u64>;
        fn handle(&mut self, _resp: Responder<u64>) {
            panic!("nope");
        }
    }
    let sys = System::with_cores(1);
    let addr = sys.spawn_on(0, Panicker);
    assert_eq!(addr.ask(|resp| resp), Err(AskError::NoReply));
    drop(addr);
    sys.shutdown();
}

/// 状態を持つ actor がメッセージを順序どおり処理し、`&mut self` をロック無しで更新する。
#[test]
fn stateful_actor_processes_in_order() {
    struct Counter {
        total: u64,
        out: mpsc::Sender<u64>,
    }
    impl Actor for Counter {
        type Message = u64;
        fn handle(&mut self, msg: u64) {
            self.total += msg;
            self.out.send(self.total).unwrap();
        }
    }

    let sys = System::with_cores(1);
    let (out, results) = mpsc::channel();
    let addr = sys.spawn_on(0, Counter { total: 0, out });

    for i in 1..=100u64 {
        addr.send_blocking(i).unwrap();
    }
    drop(addr);
    sys.shutdown();

    let mut expected = 0u64;
    for i in 1..=100u64 {
        expected += i;
        assert_eq!(results.recv().unwrap(), expected);
    }
    assert!(results.recv().is_err());
}

/// on_start / on_stop が起動時・停止時に 1 回ずつ呼ばれる。
#[test]
fn lifecycle_hooks_fire_once() {
    struct L {
        out: mpsc::Sender<&'static str>,
    }
    impl Actor for L {
        type Message = ();
        fn handle(&mut self, _msg: ()) {
            self.out.send("handle").unwrap();
        }
        fn on_start(&mut self) {
            self.out.send("start").unwrap();
        }
        fn on_stop(&mut self) {
            self.out.send("stop").unwrap();
        }
    }

    let sys = System::with_cores(1);
    let (out, ev) = mpsc::channel();
    let addr = sys.spawn_on(0, L { out });
    addr.send_blocking(()).unwrap();
    drop(addr);
    sys.shutdown();

    assert_eq!(ev.recv().unwrap(), "start");
    assert_eq!(ev.recv().unwrap(), "handle");
    assert_eq!(ev.recv().unwrap(), "stop");
}

/// 非 Copy 型を move で受け取る。
#[test]
fn moves_owned_non_copy_messages() {
    struct Sink {
        out: mpsc::Sender<String>,
    }
    impl Actor for Sink {
        type Message = String;
        fn handle(&mut self, msg: String) {
            self.out.send(msg).unwrap();
        }
    }

    let sys = System::with_cores(1);
    let (out, results) = mpsc::channel();
    let addr = sys.spawn_on(0, Sink { out });
    addr.send_blocking(String::from("owned")).unwrap();
    addr.send_blocking(String::from("moved")).unwrap();
    drop(addr);
    sys.shutdown();
    assert_eq!(results.recv().unwrap(), "owned");
    assert_eq!(results.recv().unwrap(), "moved");
}

/// 複数コアに actor を配置し、actor 間で **コアを跨いで** routing する。
/// source(コア0) → worker×3(round-robin 配置) → aggregator(コア0)。
#[test]
fn cross_core_routing() {
    let sys = System::with_cores(4);

    // aggregator: worker からの部分和を集めて合計、最後に外へ出す。
    struct Aggregator {
        remaining: u32,
        total: u64,
        out: mpsc::Sender<u64>,
    }
    impl Actor for Aggregator {
        type Message = u64;
        fn handle(&mut self, partial: u64) {
            self.total += partial;
            self.remaining -= 1;
            if self.remaining == 0 {
                self.out.send(self.total).unwrap();
            }
        }
    }

    // worker: 受けた数を 2 倍して aggregator に転送(handler 内 → try_send)。
    struct Worker {
        agg: aetherflow::ActorRef<Aggregator>,
    }
    impl Actor for Worker {
        type Message = u64;
        fn handle(&mut self, n: u64) {
            let _ = self.agg.try_send(n * 2);
        }
    }

    let (out, result) = mpsc::channel();
    // aggregator はコア0。worker が 12 個の値を送るので remaining=12。
    let agg = sys.spawn_on(0, Aggregator {
        remaining: 12,
        total: 0,
        out,
    });

    // worker を 3 個、別コアへ。
    let workers: Vec<_> = (0..3)
        .map(|k| sys.spawn_on(k + 1, Worker { agg: agg.clone() }))
        .collect();

    // 各 worker に 1..=4 を送る(worker が 2 倍 → aggregator へ)。合計 = 2*(1+2+3+4)*3 = 60。
    for w in &workers {
        for n in 1..=4u64 {
            w.send_blocking(n).unwrap();
        }
    }

    let total = result.recv().unwrap();
    assert_eq!(total, 60);

    drop(workers);
    drop(agg);
    sys.shutdown();
}

/// round-robin の `spawn` が全コアに散らばる(配置が偏らない)。
#[test]
fn round_robin_placement_runs() {
    struct Echo {
        out: mpsc::Sender<u32>,
    }
    impl Actor for Echo {
        type Message = u32;
        fn handle(&mut self, m: u32) {
            self.out.send(m).unwrap();
        }
    }

    let sys = System::with_cores(3);
    let (out, results) = mpsc::channel();
    let addrs: Vec<_> = (0..9).map(|_| sys.spawn(Echo { out: out.clone() })).collect();
    for (i, a) in addrs.iter().enumerate() {
        a.send_blocking(i as u32).unwrap();
    }
    drop(addrs);
    drop(out);
    sys.shutdown();

    let mut got: Vec<u32> = results.iter().collect();
    got.sort_unstable();
    assert_eq!(got, (0..9).collect::<Vec<_>>());
}