autd3-rs 0.9.0

Core async client library for the AUTD3 phased-array kit.
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
use std::collections::VecDeque;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};

use std::sync::mpsc::{Receiver, TryRecvError};

use autd3_rs_core::rt::oneshot;

use crate::error::{Error, LinkCause};
use crate::link::Link;
use crate::protocol::{Cmd, RX_FRAME_BYTES, RxFrame, Seq, TX_FRAME_BYTES, TxFrame};
use crate::response::Response;

use autd3_cpu_wire::Mode;
use autd3_cpu_wire::payload::SetModePayload;
use zerocopy::FromBytes;

use super::completion::CompletionSender;
use super::config::{ClientConfig, MAX_DEVICES};
use super::pool::Slot;

pub(super) struct CmdMessage {
    pub(super) frame: Slot,
    pub(super) response_tx: CompletionSender,
    pub(super) exclusive: bool,
}

struct Inflight {
    seq: Seq,
    frame: Slot,
    acked: u128,
    age: u32,
    exclusive: bool,
    response_tx: CompletionSender,
}

fn stage_frame(seq: Seq, frame: &Slot, tx_bufs: &mut [[u8; TX_FRAME_BYTES]]) {
    for (device, buf) in tx_bufs.iter_mut().enumerate() {
        buf[0] = seq.get();
        buf[1] = frame.cmd_for(device).as_u8();
        buf[2..].copy_from_slice(frame.payload_for(device));
    }
}

enum HeadAction {
    None,
    Reset,
    GiveUp,
}

#[derive(Default)]
struct ResyncState {
    active: bool,
    rounds: u32,
    reset_tried: bool,
}

impl ResyncState {
    fn reset(&mut self) {
        *self = Self::default();
    }

    fn on_ack_progress(&mut self, pending: &mut VecDeque<Inflight>) {
        if self.active {
            tracing::debug!("ack progress during resync");
            self.rounds = 0;
            self.reset_tried = false;
            if let Some(head) = pending.front_mut() {
                head.age = 0;
            }
        }
    }

    fn advance_head(
        &mut self,
        pending: &mut VecDeque<Inflight>,
        config: &ClientConfig,
    ) -> HeadAction {
        let Some(head) = pending.front_mut() else {
            if self.active {
                self.reset();
                tracing::debug!("resync complete");
            }
            return HeadAction::None;
        };
        head.age = head.age.saturating_add(1);
        if head.age < config.timeout_cycles.get() {
            return HeadAction::None;
        }
        head.age = 0;
        if !self.active {
            self.active = true;
            self.rounds = 0;
            tracing::debug!(
                seq = head.seq.get(),
                "head frame unacked past timeout; entering resync"
            );
            return HeadAction::None;
        }
        self.rounds += 1;
        if self.rounds < config.max_resync_rounds.get() {
            return HeadAction::None;
        }
        self.rounds = 0;
        if self.reset_tried {
            HeadAction::GiveUp
        } else {
            self.reset_tried = true;
            tracing::warn!(
                seq = head.seq.get(),
                "resync rounds exhausted; resetting sequence"
            );
            HeadAction::Reset
        }
    }
}

fn handshake_failed<E: core::error::Error + Send + Sync + 'static>(e: E) -> LinkCause {
    tracing::error!("handshake failed: {e}");
    LinkCause::new(e)
}

pub(super) fn run_rt_thread<L: Link>(
    link: L,
    cmd_rx: Receiver<CmdMessage>,
    config: ClientConfig,
    hs_done_tx: oneshot::Sender<Result<(), LinkCause>>,
    done_tx: oneshot::Sender<Option<LinkCause>>,
    closed: Arc<AtomicBool>,
) {
    let cause = run_rt_loop(link, cmd_rx, config, hs_done_tx, closed);
    let _ = done_tx.send(cause);
}

fn run_rt_loop<L: Link>(
    link: L,
    cmd_rx: Receiver<CmdMessage>,
    config: ClientConfig,
    hs_done_tx: oneshot::Sender<Result<(), LinkCause>>,
    closed: Arc<AtomicBool>,
) -> Option<LinkCause> {
    autd3_rs_core::apply_thread_tuning(autd3_rs_core::RtThreadTuning {
        priority: config.rt_priority,
        policy: config.rt_policy,
        affinity: config.rt_affinity,
    });
    let mut rt = RtThread::new(link, cmd_rx, config, closed);
    match rt.handshake() {
        Ok(()) => {}
        Err(e) => {
            let _ = hs_done_tx.send(Err(e));
            return rt.close_link();
        }
    }
    if hs_done_tx.send(Ok(())).is_err() {
        return rt.close_link();
    }
    let link_error = rt.run();
    let closed = rt.close_link();
    link_error.or(closed)
}

struct RtThread<L: Link> {
    link: L,
    cmd_rx: Receiver<CmdMessage>,
    config: ClientConfig,
    closed: Arc<AtomicBool>,

    all_acked: u128,
    tx_bufs: Vec<[u8; TX_FRAME_BYTES]>,
    rx_bufs: Vec<[u8; RX_FRAME_BYTES]>,

    next_seq: Seq,
    pending: VecDeque<Inflight>,
    held_exclusive: Option<CmdMessage>,
    resync: ResyncState,
    stale_run: u32,
    reset_remaining: u32,
    stale_limit: u32,
}

enum StageOutcome {
    Staged,
    Disconnected,
}

impl<L: Link> RtThread<L> {
    fn new(
        link: L,
        cmd_rx: Receiver<CmdMessage>,
        config: ClientConfig,
        closed: Arc<AtomicBool>,
    ) -> Self {
        let num_devices = link.num_devices();
        let all_acked: u128 = if num_devices == MAX_DEVICES {
            u128::MAX
        } else {
            (1u128 << num_devices) - 1
        };
        let stale_limit = config
            .timeout_cycles
            .get()
            .saturating_mul(config.max_resync_rounds.get());
        Self {
            link,
            cmd_rx,
            pending: VecDeque::with_capacity(config.max_inflight.get()),
            held_exclusive: None,
            config,
            closed,
            all_acked,
            tx_bufs: vec![[0u8; TX_FRAME_BYTES]; num_devices],
            rx_bufs: vec![[0u8; RX_FRAME_BYTES]; num_devices],
            next_seq: Seq::ZERO,
            resync: ResyncState::default(),
            stale_run: 0,
            reset_remaining: 0,
            stale_limit,
        }
    }

    fn handshake(&mut self) -> Result<(), LinkCause> {
        tracing::debug!(
            cycles = self.config.reset_resend_cycles.get(),
            low_latency = self.config.low_latency,
            "starting handshake"
        );
        for buf in &mut self.tx_bufs {
            TxFrame::new(Seq::ZERO, Cmd::Reset).write_to(buf);
        }
        for _ in 0..self.config.reset_resend_cycles.get() {
            self.link
                .cycle(&self.tx_bufs, &mut self.rx_bufs)
                .map_err(handshake_failed)?;
        }

        self.next_seq = self.negotiate_mode()?;
        Ok(())
    }

    fn negotiate_mode(&mut self) -> Result<Seq, LinkCause> {
        let mode = if self.config.low_latency {
            Mode::LowLatency
        } else {
            Mode::Fifo
        };
        let mut frame = TxFrame::new(Seq::ZERO, Cmd::SetMode);
        let (p, _) = SetModePayload::mut_from_prefix(&mut frame.payload).unwrap();
        p.mode = mode.as_u8();
        for buf in &mut self.tx_bufs {
            frame.write_to(buf);
        }

        let bound = self.config.timeout_cycles.get().max(2);
        for _ in 0..bound {
            let rx_valid = self
                .link
                .cycle(&self.tx_bufs, &mut self.rx_bufs)
                .map_err(handshake_failed)?
                .rx_valid();
            if rx_valid && self.rx_bufs.iter().all(|rx| rx[0] == Seq::ZERO.get()) {
                tracing::info!(?mode, "frame processing mode established");
                return Ok(Seq::new(1));
            }
        }
        tracing::warn!(?mode, "frame processing mode negotiation failed");
        Ok(Seq::ZERO)
    }

    fn run(&mut self) -> Option<LinkCause> {
        let mut link_error: Option<LinkCause> = None;
        loop {
            if self.closed.load(Ordering::Acquire) {
                break;
            }

            self.link.wait_next_cycle();

            if matches!(self.stage_tx(), StageOutcome::Disconnected) {
                break;
            }

            let rx_valid = match self.link.cycle(&self.tx_bufs, &mut self.rx_bufs) {
                Ok(outcome) => outcome.rx_valid(),
                Err(e) => {
                    tracing::error!("link cycle failed: {e}");
                    link_error = Some(LinkCause::new(e));
                    break;
                }
            };

            if self.reset_remaining > 0 {
                self.advance_reset_phase();
            } else if rx_valid {
                self.handle_healthy();
            } else {
                self.handle_stale();
            }
        }

        self.teardown(link_error.as_ref());
        link_error
    }

    fn stage_tx(&mut self) -> StageOutcome {
        if self.reset_remaining > 0 {
            tracing::trace!(remaining = self.reset_remaining, "staging reset frame");
            for buf in &mut self.tx_bufs {
                TxFrame::new(Seq::ZERO, Cmd::Reset).write_to(buf);
            }
            return StageOutcome::Staged;
        }
        if self.resync.active {
            if let Some(front) = self.pending.front() {
                tracing::trace!(seq = front.seq.get(), "retransmitting head frame");
                stage_frame(front.seq, &front.frame, &mut self.tx_bufs);
            }
            return StageOutcome::Staged;
        }
        if self.held_exclusive.is_some() {
            if self.pending.is_empty() {
                let msg = self.held_exclusive.take().expect("just checked is_some");
                self.stage_new(msg);
            }
            return StageOutcome::Staged;
        }
        let exclusive_inflight = self.pending.front().is_some_and(|entry| entry.exclusive);
        if !exclusive_inflight && self.pending.len() < self.config.max_inflight.get() {
            match self.cmd_rx.try_recv() {
                Ok(msg) if msg.exclusive && !self.pending.is_empty() => {
                    tracing::trace!("holding exclusive frame until pending drains");
                    self.held_exclusive = Some(msg);
                }
                Ok(msg) => self.stage_new(msg),
                Err(TryRecvError::Empty) => {}
                Err(TryRecvError::Disconnected) => return StageOutcome::Disconnected,
            }
        }
        StageOutcome::Staged
    }

    fn stage_new(&mut self, msg: CmdMessage) {
        let seq = self.next_seq;
        self.next_seq = self.next_seq.next();
        tracing::trace!(
            seq = seq.get(),
            cmd = ?msg.frame.cmd_for(0),
            exclusive = msg.exclusive,
            "staged frame"
        );
        stage_frame(seq, &msg.frame, &mut self.tx_bufs);
        self.pending.push_back(Inflight {
            seq,
            frame: msg.frame,
            acked: 0,
            age: 0,
            exclusive: msg.exclusive,
            response_tx: msg.response_tx,
        });
    }

    fn advance_reset_phase(&mut self) {
        self.reset_remaining -= 1;
        if self.reset_remaining == 0 {
            let mut seq = Seq::ZERO;
            for entry in &mut self.pending {
                entry.seq = seq;
                entry.acked = 0;
                entry.age = 0;
                seq = seq.next();
            }
            self.next_seq = seq;
            self.resync.active = !self.pending.is_empty();
            self.resync.rounds = 0;
            tracing::debug!(
                pending = self.pending.len(),
                "sequence reset complete; replaying pending frames"
            );
        }
    }

    fn handle_healthy(&mut self) {
        self.stale_run = 0;
        self.route_acks();
        match self.resync.advance_head(&mut self.pending, &self.config) {
            HeadAction::None => {}
            HeadAction::Reset => self.reset_remaining = self.config.reset_resend_cycles.get(),
            HeadAction::GiveUp => {
                tracing::warn!(
                    pending = self.pending.len(),
                    "sequence reset did not recover; failing pending frames with timeout"
                );
                self.fail_pending_timeout();
                self.resync.reset();
            }
        }
    }

    fn handle_stale(&mut self) {
        self.stale_run = self.stale_run.saturating_add(1);
        tracing::trace!(run = self.stale_run, "no valid rx this cycle");
        if self.stale_run >= self.stale_limit {
            if !self.pending.is_empty() {
                tracing::warn!(
                    pending = self.pending.len(),
                    cycles = self.stale_run,
                    "no valid rx from link; failing pending frames with timeout"
                );
            }
            self.fail_pending_timeout();
            self.resync.reset();
            self.stale_run = 0;
        }
    }

    fn route_acks(&mut self) {
        if self.pending.is_empty() {
            return;
        }
        let front_seq = self.pending.front().expect("non-empty").seq;
        let back_seq = self.pending.back().expect("non-empty").seq;
        let span = back_seq.distance_from(front_seq) as usize;
        for (device, rx_buf) in self.rx_bufs.iter().enumerate() {
            let rx = RxFrame::parse(rx_buf);
            let ack_offset = rx.ack.distance_from(front_seq) as usize;
            if ack_offset > span {
                continue;
            }
            let bit = 1u128 << device;
            for entry in self.pending.iter_mut().take(ack_offset + 1) {
                if entry.acked & bit == 0 {
                    tracing::trace!(device, seq = entry.seq.get(), "device acked frame");
                    entry.acked |= bit;
                    entry.frame.record_data(device, rx.data);
                }
            }
        }
        let mut progressed = false;
        while self
            .pending
            .front()
            .is_some_and(|entry| entry.acked == self.all_acked)
        {
            let entry = self.pending.pop_front().expect("just checked");
            tracing::trace!(seq = entry.seq.get(), "frame acked by all devices");
            entry
                .response_tx
                .send(Ok(Response::from_slice(entry.frame.data())));
            progressed = true;
        }
        if progressed {
            self.resync.on_ack_progress(&mut self.pending);
        }
    }

    fn fail_pending_timeout(&mut self) {
        for entry in self.pending.drain(..) {
            entry.response_tx.send(Err(Error::Timeout {
                cycles: self.config.timeout_cycles.get(),
            }));
        }
    }

    fn close_link(&mut self) -> Option<LinkCause> {
        match self.link.close() {
            Ok(()) => None,
            Err(e) => {
                tracing::error!("link close failed: {e}");
                Some(LinkCause::new(e))
            }
        }
    }

    fn teardown(&mut self, link_error: Option<&LinkCause>) {
        tracing::debug!(pending = self.pending.len(), "RT thread stopping");
        let cause = || link_error.map_or(Error::RtClosed, |cause| Error::Link(cause.clone()));
        if let Some(msg) = self.held_exclusive.take() {
            msg.response_tx.send(Err(cause()));
        }
        for entry in self.pending.drain(..) {
            entry.response_tx.send(Err(cause()));
        }
        while let Ok(msg) = self.cmd_rx.try_recv() {
            msg.response_tx.send(Err(cause()));
        }
    }
}