Skip to content

Commit e278e89

Browse files
committed
connection: keep sends out while try_recv reads nonblocking
TCP and UDP readers and writers are clones of one socket and share its nonblocking flag. try_recv flipped that flag with only the reader lock held, so a concurrent send under backpressure could fail with WouldBlock, for TCP after part of a frame was already written. try_recv now also holds the writer lock (reader then writer; send only takes the writer) for transports that share a socket. Adds a TCP test that sends 20,000 FILE_TRANSFER_PROTOCOL frames while another thread polls try_recv; before this change it failed on send 616 with WouldBlock (os error 10035 on Windows). Fixes #570
1 parent cfebc0f commit e278e89

4 files changed

Lines changed: 87 additions & 0 deletions

File tree

‎mavlink-core/src/connection/sync.rs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,16 @@ pub(crate) trait SyncTransport: Send + Sync {
3434
false
3535
}
3636

37+
/// Locks out senders while `try_recv` has the reader in nonblocking mode.
38+
///
39+
/// Transports whose reader and writer are clones of one socket share its
40+
/// nonblocking flag, so a send that ran while the flag is set could fail with
41+
/// `WouldBlock` partway through a frame. Such transports return their writer
42+
/// lock here. `None` by default.
43+
fn lock_writer_for_nonblocking_read(&self) -> Option<MutexGuard<'_, Self::Writer>> {
44+
None
45+
}
46+
3747
/// Toggles nonblocking reads for `try_recv`. Does nothing by default.
3848
fn set_nonblocking(
3949
&self,
@@ -206,6 +216,8 @@ impl<D: Dialect + Send + Sync> MavConnection<D::Message> for DialectConnection<D
206216
fn try_recv(&self) -> Result<(MavHeader, D::Message), MessageReadError> {
207217
dispatch_transport!(&self.transport, |transport| {
208218
let mut reader = transport.reader();
219+
// Lock order is reader then writer; `send` only takes the writer.
220+
let _send_lock = transport.lock_writer_for_nonblocking_read();
209221
transport.set_nonblocking(&mut reader, true)?;
210222
let result = read_message_with_dialect(&mut reader, &self.state, &self.dialect);
211223
transport.set_nonblocking(&mut reader, false)?;

‎mavlink-core/src/connection/tcp/sync.rs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ impl SyncTransport for TcpConnection {
5959
Some(self.writer.lock().unwrap())
6060
}
6161

62+
fn lock_writer_for_nonblocking_read(&self) -> Option<std::sync::MutexGuard<'_, Self::Writer>> {
63+
Some(self.writer.lock().unwrap())
64+
}
65+
6266
fn set_nonblocking(
6367
&self,
6468
reader: &mut MavlinkReader<Self::Reader>,

‎mavlink-core/src/connection/udp/sync.rs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ impl SyncTransport for UdpConnection {
9999
has_destination.then_some(writer)
100100
}
101101

102+
fn lock_writer_for_nonblocking_read(&self) -> Option<std::sync::MutexGuard<'_, Self::Writer>> {
103+
Some(self.writer.lock().unwrap())
104+
}
105+
102106
fn set_nonblocking(
103107
&self,
104108
reader: &mut MavlinkReader<Self::Reader>,
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
mod test_shared;
2+
3+
#[cfg(all(feature = "std", feature = "transport-tcp", feature = "dialect-common"))]
4+
mod tcp_try_recv_concurrent_send {
5+
use std::sync::Arc;
6+
use std::sync::atomic::{AtomicBool, Ordering};
7+
use std::thread;
8+
use std::time::Duration;
9+
10+
use mavlink::MavConnection;
11+
use mavlink::dialects::common::{FILE_TRANSFER_PROTOCOL_DATA, MavMessage};
12+
13+
const MESSAGES: usize = 20_000;
14+
15+
/// `try_recv` must not make a concurrent `send` fail under backpressure (#570).
16+
#[test]
17+
fn try_recv_does_not_break_concurrent_send() {
18+
let server = thread::spawn(|| {
19+
let server = mavlink::connect::<MavMessage>("tcpin:127.0.0.1:14571")
20+
.expect("Couldn't create server");
21+
// Let the client's socket buffers fill up before draining them.
22+
thread::sleep(Duration::from_millis(500));
23+
let mut received = 0;
24+
while received < MESSAGES {
25+
match server.recv() {
26+
Ok((_, MavMessage::FILE_TRANSFER_PROTOCOL(_))) => received += 1,
27+
Ok(_) => panic!("unexpected message"),
28+
Err(e) => panic!("receive failed after {received} messages: {e:?}"),
29+
}
30+
}
31+
received
32+
});
33+
34+
thread::sleep(Duration::from_millis(100));
35+
let client = Arc::new(
36+
mavlink::connect::<MavMessage>("tcpout:127.0.0.1:14571")
37+
.expect("Couldn't create client"),
38+
);
39+
40+
let done = Arc::new(AtomicBool::new(false));
41+
let poller = {
42+
let client = Arc::clone(&client);
43+
let done = Arc::clone(&done);
44+
thread::spawn(move || {
45+
while !done.load(Ordering::Relaxed) {
46+
let _ = client.try_recv();
47+
}
48+
})
49+
};
50+
51+
let msg = MavMessage::FILE_TRANSFER_PROTOCOL(FILE_TRANSFER_PROTOCOL_DATA {
52+
target_network: 0,
53+
target_system: 1,
54+
target_component: 1,
55+
payload: [0xA5; 251],
56+
});
57+
for i in 0..MESSAGES {
58+
client
59+
.send_default(&msg)
60+
.unwrap_or_else(|e| panic!("send {i} failed while try_recv was polling: {e:?}"));
61+
}
62+
63+
done.store(true, Ordering::Relaxed);
64+
poller.join().unwrap();
65+
assert_eq!(server.join().unwrap(), MESSAGES);
66+
}
67+
}

0 commit comments

Comments
 (0)