nuclei 0.5.4

Proactive IO & runtime system
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
//! The side biased to its owner: the owner holds without the word, a foreign
//! take switches the side for good or leaves its work to the owner, and no
//! work left to the owner is lost. `proofs/tla/side_biased/` checks the
//! protocol; these run it on real threads. Where the process has no heavy
//! fence a side starts shared and the tests skip.

use std::sync::Arc;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::sync::mpsc;
use std::task::{Poll, Wake, Waker};
use std::time::{Duration, Instant};

use super::{After, Hooks, OwnerPoll, Side};

#[derive(Default)]
struct State {
    steps: u64,
    seen: u8,
    requests: u64,
}

/// A thread's hooks: `who` is its owner id (0 for a foreign thread), even as a shard's address
/// is; `runs`, the shard its thread runs wherever the side's source is homed.
struct Probe {
    who: usize,
    runs: usize,
}

impl Hooks<State> for Probe {
    fn serve(&self, _: &mut State, _: &mut After) {}

    fn deferred(&self, st: &mut State, bits: u8, _: &mut After) {
        st.seen |= bits;
    }

    fn requests(&self, st: &mut State, _: &mut After) {
        st.requests += 1;
    }

    fn owner(&self) -> usize {
        self.who
    }

    fn runs(&self) -> usize {
        self.runs
    }
}

const OWNER: Probe = Probe { who: 2, runs: 2 };
const FOREIGN: Probe = Probe { who: 0, runs: 0 };

fn biased() -> Option<Side<State>> {
    crate::rt::handoff::fence::available().then(|| Side::biased(State::default()))
}

struct Counted(AtomicUsize);

impl Wake for Counted {
    fn wake(self: Arc<Self>) {
        self.0.fetch_add(1, Ordering::SeqCst);
    }
}

fn counted() -> (Arc<Counted>, Waker) {
    let count = Arc::new(Counted(AtomicUsize::new(0)));
    let waker = Waker::from(Arc::clone(&count));
    (count, waker)
}

fn step(st: &mut State, _: &mut After) -> Poll<()> {
    st.steps += 1;
    Poll::Ready(())
}

/// Polls `side` as `hooks`' thread, running the wakes it left.
fn poll(side: &Side<State>, waker: &Waker, hooks: &impl Hooks<State>) -> Poll<()> {
    let mut after = After::default();
    let polled = side.poll(&mut after, waker, hooks, step);
    after.run();
    polled
}

fn defer(side: &Side<State>, bits: u8, hooks: &impl Hooks<State>) {
    let mut after = After::default();
    side.defer(bits, &mut after, hooks);
    after.run();
}

/// A request that needs the side: done by whoever holds it, here or at the
/// holder's release.
fn request(side: &Side<State>, hooks: &impl Hooks<State>) {
    let mut after = After::default();
    if let Some(held) = side.take_for_request(hooks) {
        held.release(&mut after, hooks);
    }
    after.run();
}

fn steps(side: &mut Side<State>) -> u64 {
    side.get_mut().steps
}

#[test]
fn the_owner_holds_a_biased_side_without_touching_the_word() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    let mut after = After::default();
    let polled = side.poll(&mut after, &waker, &OWNER, |st, _| {
        assert_eq!(side.words().0, 0, "the word was taken");
        st.steps += 1;
        Poll::Ready(())
    });
    after.run();
    assert!(polled.is_ready());
    assert!(!side.is_shared());
    assert_eq!(side.words(), (0, 0));
    defer(&side, 4, &OWNER);
    assert_eq!(side.words(), (0, 0), "a defer of the owner left a flag");
    assert_eq!(side.get_mut().seen, 4, "the owner's defer was not done");
    assert!(!side.is_shared());
}

#[test]
fn a_foreign_take_of_a_free_side_switches_it_for_good() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    assert!(poll(&side, &waker, &FOREIGN).is_ready());
    assert!(side.is_shared());
    // The owner takes through the word now.
    let mut after = After::default();
    let polled = side.poll(&mut after, &waker, &OWNER, |st, _| {
        assert_eq!(side.words().0, 1, "shared mode did not use the word");
        st.steps += 1;
        Poll::Ready(())
    });
    after.run();
    assert!(polled.is_ready());
    assert!(side.is_shared(), "shared mode went back");
    assert_eq!(steps(&mut side), 3);
}

/// Starts a thread that holds the side as its owner until the test lets it
/// go: `held` says it holds, `go` lets it go.
fn hold_until(
    side: &Arc<Side<State>>,
) -> (
    mpsc::Receiver<()>,
    mpsc::Sender<()>,
    std::thread::JoinHandle<()>,
) {
    let (held_tx, held_rx) = mpsc::channel();
    let (go_tx, go_rx) = mpsc::channel::<()>();
    let side = Arc::clone(side);
    let thread = std::thread::spawn(move || {
        let (_, waker) = counted();
        let mut after = After::default();
        let polled = side.poll(&mut after, &waker, &OWNER, |st, _| {
            st.steps += 1;
            held_tx.send(()).unwrap();
            go_rx.recv_timeout(Duration::from_secs(10)).unwrap();
            Poll::Ready(())
        });
        after.run();
        assert!(polled.is_ready());
    });
    (held_rx, go_tx, thread)
}

#[test]
fn a_foreign_poll_while_the_owner_holds_is_woken_at_its_release() {
    let Some(side) = biased() else { return };
    let side = Arc::new(side);
    let (held, go, owner) = hold_until(&side);
    held.recv_timeout(Duration::from_secs(10)).unwrap();
    let (woke, waker) = counted();
    assert!(poll(&side, &waker, &FOREIGN).is_pending());
    assert_eq!(woke.0.load(Ordering::SeqCst), 0);
    go.send(()).unwrap();
    owner.join().unwrap();
    assert_eq!(
        woke.0.load(Ordering::SeqCst),
        1,
        "the waiting poll was not woken"
    );
    assert!(poll(&side, &waker, &FOREIGN).is_ready());
}

#[test]
fn work_a_foreign_thread_left_the_owner_is_done_at_its_release() {
    let Some(side) = biased() else { return };
    let side = Arc::new(side);
    let (held, go, owner) = hold_until(&side);
    held.recv_timeout(Duration::from_secs(10)).unwrap();
    defer(&side, 4, &FOREIGN);
    request(&side, &FOREIGN);
    go.send(()).unwrap();
    owner.join().unwrap();
    let mut side = Arc::into_inner(side).unwrap();
    assert_eq!(side.get_mut().seen, 4, "the deferred work was lost");
    assert_eq!(side.get_mut().requests, 1, "the request was lost");
    assert_eq!(side.words(), (0, 0));
}

#[test]
fn the_owner_calling_again_under_its_own_hold_leaves_its_work_for_its_release() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    let mut after = After::default();
    let polled = side.poll(&mut after, &waker, &OWNER, |st, after| {
        defer(&side, 2, &OWNER);
        assert_eq!(st.seen, 0, "the nested call held the side too");
        st.steps += 1;
        let _ = after;
        Poll::Ready(())
    });
    after.run();
    assert!(polled.is_ready());
    assert_eq!(side.get_mut().seen, 2, "the nested call's work was lost");
    assert_eq!(side.words(), (0, 0));
}

struct Parker {
    thread: std::thread::Thread,
    woken: AtomicBool,
}

impl Wake for Parker {
    fn wake(self: Arc<Self>) {
        self.woken.store(true, Ordering::SeqCst);
        self.thread.unpark();
    }
}

thread_local! {
    /// One waker per thread, as one task has one: a contended set tells its
    /// tasks apart by their wakers' addresses.
    static PARKER: Arc<Parker> = Arc::new(Parker {
        thread: std::thread::current(),
        woken: AtomicBool::new(false),
    });
}

/// Polls `side` until its step ran, sleeping until woken between polls: a
/// wake that never comes fails the test.
fn poll_until_done(side: &Side<State>, hooks: &impl Hooks<State>) {
    let parker = PARKER.with(Arc::clone);
    let waker = Waker::from(Arc::clone(&parker));
    let deadline = Instant::now() + Duration::from_secs(20);
    while poll(side, &waker, hooks).is_pending() {
        while !parker.woken.swap(false, Ordering::SeqCst) {
            assert!(
                Instant::now() < deadline,
                "a wake was lost: word {:?}, shared {}, own {}, intent {}",
                side.words(),
                side.is_shared(),
                side.own.load(Ordering::SeqCst),
                side.intent.load(Ordering::SeqCst)
            );
            std::thread::park_timeout(Duration::from_millis(20));
        }
    }
}

/// An owner and two foreign threads call on one side without pause, taking
/// it, leaving work and waking each other: every step runs once, every
/// deferred bit and request is done, no wake is lost and no flag is left.
#[test]
fn an_owner_and_two_foreign_threads_lose_no_step_wake_or_work() {
    let Some(side) = biased() else { return };
    let side = Arc::new(side);
    const ROUNDS: u64 = 20_000;
    let foreign = |bit: u8| {
        let side = Arc::clone(&side);
        std::thread::spawn(move || {
            for round in 0..ROUNDS {
                match round % 3 {
                    0 => poll_until_done(&side, &FOREIGN),
                    1 => {
                        defer(&side, bit, &FOREIGN);
                        poll_until_done(&side, &FOREIGN);
                    }
                    _ => {
                        request(&side, &FOREIGN);
                        poll_until_done(&side, &FOREIGN);
                    }
                }
            }
        })
    };
    let a = foreign(1);
    let b = foreign(2);
    for round in 0..ROUNDS {
        if round % 2 == 0 {
            poll_until_done(&side, &OWNER);
        } else {
            defer(&side, 4, &OWNER);
            poll_until_done(&side, &OWNER);
        }
        if round % 64 == 0 {
            std::thread::yield_now();
        }
    }
    a.join().unwrap();
    b.join().unwrap();
    let mut side = Arc::into_inner(side).unwrap();
    assert_eq!(
        steps(&mut side),
        3 * ROUNDS,
        "a step ran twice or not at all"
    );
    assert_eq!(side.get_mut().seen, 7, "deferred work was lost");
    assert!(side.get_mut().requests > 0, "requests were lost");
    assert_eq!(side.words(), (0, 0), "a flag was left up");
}

/// Fresh sides, each raced by an owner and two foreign threads arriving as
/// the owner takes and lets go: the window in which a foreign thread's work
/// meets the owner's release. Every side ends with all its steps run, its
/// work done and no flag up.
#[test]
fn a_foreign_thread_arriving_as_the_owner_lets_go_loses_nothing() {
    if biased().is_none() {
        return;
    }
    const SIDES: usize = 3_000;
    const OWNER_OPS: u64 = 6;
    let sides: Arc<Vec<Side<State>>> =
        Arc::new((0..SIDES).map(|_| Side::biased(State::default())).collect());
    let gate = Arc::new(std::sync::Barrier::new(3));
    let foreign = |bit: u8| {
        let (sides, gate) = (Arc::clone(&sides), Arc::clone(&gate));
        std::thread::spawn(move || {
            for side in sides.iter() {
                gate.wait();
                match bit {
                    1 => poll_until_done(side, &FOREIGN),
                    _ => {
                        defer(side, bit, &FOREIGN);
                        request(side, &FOREIGN);
                        poll_until_done(side, &FOREIGN);
                    }
                }
            }
        })
    };
    let (a, b) = (foreign(1), foreign(2));
    for side in sides.iter() {
        gate.wait();
        for _ in 0..OWNER_OPS {
            poll_until_done(side, &OWNER);
            defer(side, 4, &OWNER);
        }
    }
    a.join().unwrap();
    b.join().unwrap();
    let mut sides = Arc::into_inner(sides).unwrap();
    for (i, side) in sides.iter_mut().enumerate() {
        assert_eq!(side.words(), (0, 0), "side {i} kept a flag");
        let st = side.get_mut();
        assert_eq!(st.steps, OWNER_OPS + 2, "side {i} lost or repeated a step");
        assert_eq!(st.seen, 6, "side {i} lost deferred work");
    }
    assert!(
        super::WITNESS[2].load(Ordering::Relaxed) > 0,
        "the owner never met a foreign thread's intent"
    );
}

/// A foreign thread whose heavy fence fails: it asks the owner to touch the
/// side by counting its nudges.
struct Fenceless<'a>(&'a AtomicUsize);

impl Hooks<State> for Fenceless<'_> {
    fn serve(&self, _: &mut State, _: &mut After) {}

    fn nudge(&self) {
        self.0.fetch_add(1, Ordering::SeqCst);
    }
}

/// A heavy fence that fails leaves a foreign call's work, and its nudge makes
/// the owner serve it: the poll is woken and completes, with no read of
/// `own` and no switch of the side.
#[test]
fn a_foreign_poll_without_a_fence_is_served_by_the_owner_it_nudges() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    // The owner took and let go once: it is claimed, and holds nothing.
    assert!(poll(&side, &waker, &OWNER).is_ready());
    crate::rt::handoff::fence::inject_failure(true);
    let nudges = AtomicUsize::new(0);
    let (woke, fwaker) = counted();
    assert!(poll(&side, &fwaker, &Fenceless(&nudges)).is_pending());
    assert_eq!(nudges.load(Ordering::SeqCst), 1, "the owner was not asked");
    assert!(!side.is_shared(), "the side switched without a fence");
    assert_eq!(woke.0.load(Ordering::SeqCst), 0);
    // The owner's thread does what the nudge asks: a take and a release.
    defer(&side, 0, &OWNER);
    assert_eq!(woke.0.load(Ordering::SeqCst), 1, "the poll was not woken");
    crate::rt::handoff::fence::inject_failure(false);
    assert!(poll(&side, &fwaker, &FOREIGN).is_ready());
    assert_eq!(steps(&mut side), 2);
}

/// With no owner claimed a foreign call without a fence takes the side
/// through the word.
#[test]
fn a_foreign_call_without_a_fence_on_an_unclaimed_side_goes_shared() {
    let Some(side) = biased() else { return };
    crate::rt::handoff::fence::inject_failure(true);
    let nudges = AtomicUsize::new(0);
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &Fenceless(&nudges)).is_ready());
    assert!(side.is_shared());
    assert_eq!(nudges.load(Ordering::SeqCst), 0);
    crate::rt::handoff::fence::inject_failure(false);
}

/// A thread whose heavy fence fails, as a hook that counts its nudges and runs the shard `runs`.
struct FencelessOn<'a>(&'a AtomicUsize, usize);

impl Hooks<State> for FencelessOn<'_> {
    fn serve(&self, _: &mut State, _: &mut After) {}

    fn runs(&self) -> usize {
        self.1
    }

    fn nudge(&self) {
        self.0.fetch_add(1, Ordering::SeqCst);
    }
}

/// The claimant gave its claim up as its shard let go of the source: a foreign call whose fence
/// fails takes the side itself, shared from then on, and asks nobody.
#[test]
fn a_fenceless_call_on_a_side_whose_claimant_gave_it_up_takes_it_itself() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    let mut after = After::default();
    side.give_up(OWNER.who, &mut after, &OWNER);
    after.run();
    assert!(
        !side.is_shared(),
        "a claim given up with no work left switched the side"
    );
    crate::rt::handoff::fence::inject_failure(true);
    let nudges = AtomicUsize::new(0);
    assert!(poll(&side, &waker, &Fenceless(&nudges)).is_ready());
    crate::rt::handoff::fence::inject_failure(false);
    assert_eq!(
        nudges.load(Ordering::SeqCst),
        0,
        "a claimant that left was asked"
    );
    assert!(side.is_shared());
    assert_eq!(steps(&mut side), 2);
}

/// A foreign call whose fence failed left its work and asked the claimant, whose shard then lets
/// go of the source: giving the claim up, the claimant does that work, and the poll is woken.
#[test]
fn a_claimant_giving_its_claim_up_serves_what_a_fenceless_call_left() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    crate::rt::handoff::fence::inject_failure(true);
    let nudges = AtomicUsize::new(0);
    let (woke, fwaker) = counted();
    assert!(poll(&side, &fwaker, &Fenceless(&nudges)).is_pending());
    assert_eq!(nudges.load(Ordering::SeqCst), 1);
    crate::rt::handoff::fence::inject_failure(false);
    let mut after = After::default();
    side.give_up(OWNER.who, &mut after, &OWNER);
    after.run();
    assert_eq!(
        woke.0.load(Ordering::SeqCst),
        1,
        "the poll left was not woken"
    );
    assert!(side.is_shared());
    assert!(poll(&side, &fwaker, &FOREIGN).is_ready());
    assert_eq!(steps(&mut side), 2);
}

/// The claimant's own thread, its source homed elsewhere now (its takes are foreign), calls with a
/// fence that fails: it holds nothing (its own store of `own` says so), so it takes the side
/// itself, rather than leave its work to itself and nudge itself for good.
#[test]
fn the_claimants_own_fenceless_call_on_a_side_homed_elsewhere_takes_it_itself() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    crate::rt::handoff::fence::inject_failure(true);
    let nudges = AtomicUsize::new(0);
    assert!(poll(&side, &waker, &FencelessOn(&nudges, OWNER.who)).is_ready());
    crate::rt::handoff::fence::inject_failure(false);
    assert_eq!(
        nudges.load(Ordering::SeqCst),
        0,
        "the claimant nudged itself"
    );
    assert!(side.is_shared());
    assert_eq!(steps(&mut side), 2);
}

/// A claimant that gave its claim up claims the side again at its next take as its owner, and
/// holds it biased, without the word.
#[test]
fn a_claimant_that_gave_its_claim_up_claims_the_side_again() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    let mut after = After::default();
    side.give_up(OWNER.who, &mut after, &OWNER);
    after.run();
    assert!(!side.claimed_by(OWNER.who));
    assert!(poll(&side, &waker, &OWNER).is_ready());
    assert!(
        side.claimed_by(OWNER.who),
        "the claimant did not claim the side again"
    );
    assert!(!side.is_shared());
    assert_eq!(side.words(), (0, 0), "the take went through the word");
    assert_eq!(steps(&mut side), 2);
}

/// After a fence failure, sides made on the thread start shared.
#[test]
fn sides_made_after_a_fence_failure_start_shared() {
    let Some(side) = biased() else { return };
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    assert!(!Side::biased(State::default()).is_shared());
    crate::rt::handoff::fence::inject_failure(true);
    let nudges = AtomicUsize::new(0);
    assert!(poll(&side, &waker, &Fenceless(&nudges)).is_pending());
    assert!(Side::biased(State::default()).is_shared());
    assert!(!crate::rt::handoff::fence::available());
    crate::rt::handoff::fence::inject_failure(false);
    assert!(crate::rt::handoff::fence::available());
}

/// A foreign thread with no fence and an owner calling without pause: never
/// two holders (a counter in the critical section), every foreign poll woken
/// and completed.
#[test]
fn foreign_polls_without_a_fence_never_share_the_side_and_are_all_served() {
    if biased().is_none() {
        return;
    }
    const ROUNDS: u64 = 2_000;
    let side = Arc::new(Side::biased(State::default()));
    let inside = Arc::new(AtomicUsize::new(0));
    let done = Arc::new(AtomicBool::new(false));
    let nudges = Arc::new(AtomicUsize::new(0));
    let cs = |inside: &AtomicUsize| {
        assert_eq!(inside.fetch_add(1, Ordering::SeqCst), 0, "two holders");
        std::hint::spin_loop();
        inside.fetch_sub(1, Ordering::SeqCst);
    };
    let foreign = {
        let (side, inside, done, nudges) = (
            Arc::clone(&side),
            Arc::clone(&inside),
            Arc::clone(&done),
            Arc::clone(&nudges),
        );
        std::thread::spawn(move || {
            crate::rt::handoff::fence::inject_failure(true);
            let hooks = Fenceless(&nudges);
            let parker = PARKER.with(Arc::clone);
            let waker = Waker::from(Arc::clone(&parker));
            let deadline = Instant::now() + Duration::from_secs(20);
            for _ in 0..ROUNDS {
                let mut after = After::default();
                while side
                    .poll(&mut after, &waker, &hooks, |st, _| {
                        cs(&inside);
                        st.steps += 1;
                        Poll::Ready(())
                    })
                    .is_pending()
                {
                    after.run();
                    after = After::default();
                    while !parker.woken.swap(false, Ordering::SeqCst) {
                        assert!(Instant::now() < deadline, "a wake was lost");
                        std::thread::park_timeout(Duration::from_millis(20));
                    }
                }
                after.run();
            }
            done.store(true, Ordering::SeqCst);
        })
    };
    let (_, waker) = counted();
    let mut handled = 0;
    let mut owner_steps = 0;
    while !done.load(Ordering::SeqCst) {
        let mut after = After::default();
        let polled = side.poll(&mut after, &waker, &OWNER, |st, _| {
            cs(&inside);
            st.steps += 1;
            Poll::Ready(())
        });
        after.run();
        owner_steps += u64::from(polled.is_ready());
        let asked = nudges.load(Ordering::SeqCst);
        if asked > handled {
            handled = asked;
            defer(&side, 0, &OWNER);
        }
    }
    foreign.join().unwrap();
    let mut side = Arc::into_inner(side).unwrap();
    assert_eq!(steps(&mut side), ROUNDS + owner_steps, "a step was lost");
    assert_eq!(side.words(), (0, 0), "a flag was left up");
}

/// The owner's poll of a side it claimed: [`Side::poll_owner`] runs the step once under the
/// biased hold, with the word untouched, and lets go with nothing left.
#[test]
fn the_owners_poll_runs_its_step_once_without_touching_the_word() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    assert!(
        !side.owned_by(OWNER.who),
        "a side nobody claimed has no owner"
    );
    assert!(poll(&side, &waker, &OWNER).is_ready());
    assert!(side.owned_by(OWNER.who) && !side.owned_by(OWNER.who + 2));
    let mut after = After::default();
    let done = matches!(
        side.poll_owner(&mut after, &OWNER, |st, _| {
            assert_eq!(side.words().0, 0, "the word was taken");
            assert!(
                !side.owned_by(OWNER.who),
                "the owner's own hold is not another owner's take"
            );
            st.steps += 1;
            Poll::Ready(())
        }),
        OwnerPoll::Done(Poll::Ready(()))
    );
    after.run();
    assert!(done);
    assert_eq!(steps(&mut side), 2);
    assert_eq!(side.words(), (0, 0));
    assert!(!side.is_shared());
}

/// Once a foreign thread came, the owner's poll is refused before its step runs, and the side
/// is polled as any other then.
#[test]
fn the_owners_poll_is_refused_once_a_foreign_thread_came() {
    let Some(side) = biased() else { return };
    let side = Arc::new(side);
    let (held, go, owner) = hold_until(&side);
    held.recv_timeout(Duration::from_secs(10)).unwrap();
    defer(&side, 4, &FOREIGN);
    go.send(()).unwrap();
    owner.join().unwrap();
    let mut side = Arc::into_inner(side).unwrap();
    assert!(
        side.owned_by(OWNER.who),
        "the foreign thread switched the side"
    );
    let mut after = After::default();
    let refused = matches!(
        side.poll_owner(&mut after, &OWNER, step),
        OwnerPoll::Refused
    );
    after.run();
    assert!(refused);
    assert_eq!(steps(&mut side), 1, "a refused poll ran its step");
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    assert_eq!(steps(&mut side), 2);
    assert_eq!(side.get_mut().seen, 4, "the foreign thread's work was lost");
    assert_eq!(side.words(), (0, 0));
}

/// Work a foreign thread leaves while the owner's poll holds keeps the side held as the
/// owner lets go: the caller finishes it with [`Held::finish_poll`](super::Held::finish_poll),
/// which does that work, and the step runs again after an edge's driver's part while it waits.
#[test]
fn work_left_during_the_owners_poll_is_finished_with_the_step_again() {
    let Some(mut side) = biased() else { return };
    let (_, waker) = counted();
    assert!(poll(&side, &waker, &OWNER).is_ready());
    let mut step = |st: &mut State, after: &mut After| {
        st.steps += 1;
        if st.steps > 2 {
            return Poll::Ready(());
        }
        defer(&side, 4, &FOREIGN);
        #[cfg(readiness)]
        side.drive(after, &FOREIGN, 0);
        let _ = after;
        Poll::Pending
    };
    let mut after = After::default();
    let polled = match side.poll_owner(&mut after, &OWNER, |st, after| step(st, after)) {
        OwnerPoll::Left(held, out) => held.finish_poll(out, &mut after, &OWNER, &mut step),
        OwnerPoll::Done(_) => panic!("the foreign thread's work was not seen"),
        OwnerPoll::Refused => panic!("the owner's poll was refused"),
    };
    after.run();
    assert_eq!(side.get_mut().seen, 4, "the work left was lost");
    #[cfg(readiness)]
    {
        assert!(
            polled.is_ready(),
            "the step did not run again after the edge"
        );
        assert_eq!(steps(&mut side), 3);
    }
    #[cfg(not(readiness))]
    {
        assert!(polled.is_pending());
        assert_eq!(steps(&mut side), 2);
    }
    assert_eq!(side.words(), (0, 0), "a flag was left up");
}