Skip to content

Commit 64a8b92

Browse files
authored
feat: runtime loadable custom dialect support (#523)
* mavlink-core: add dialect-aware codec primitives * mavlink-core: route blocking connections through dialect core * mavlink-core: share tokio codec handling across transports * mavlink: add runtime-loaded dialect support * mavlink: reuse parser type size function * bless clippy and fix CI errors Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: return InvalidPayloadSize only for v1 Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink: simplify runtime dialect implementation Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: simplify transport handling Move send sequencing into shared connection state and acquire usable writers through lock_writer. Make try_recv nonblocking for all async transports. Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: use concrete connection types and avoid heap Store concrete transports in connection enums and return unboxed async futures. Use native serial port types and share generated and runtime dialect handling. Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink: zero-fill truncated dynamic fields Return field bytes through Cow, borrowing complete fields and restoring omitted zeros when needed. Preserve the original wire payload and cover partial and omitted fields in the existing roundtrip test. Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink: return errors for invalid runtime dialect paths Pass the canonical path directly to the XML parser so paths without a filename use its existing error handling. Keep the parent directory for resolving includes. Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink: remove redundant dynamic dialect doc cfg Signed-off-by: Onur Özkan <work@onurozkan.dev> * build: raise workspace MSRV to Rust 1.88 Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: separate encoding and parsing errors Use an associated error type to keep static encoding infallible. Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: simplify dialect signing checks Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: await reads in async try_recv Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: inline message decoding Signed-off-by: Onur Özkan <work@onurozkan.dev> * mavlink-core: remove redundant dialect bindings Signed-off-by: Onur Özkan <work@onurozkan.dev> --------- Signed-off-by: Onur Özkan <work@onurozkan.dev>
1 parent 7f8da25 commit 64a8b92

36 files changed

Lines changed: 2104 additions & 1320 deletions

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ bitflags = { version = "2.9.1", default-features = false }
1111

1212
[workspace.package]
1313
edition = "2024"
14-
rust-version = "1.85.0"
14+
rust-version = "1.88"
1515
keywords = ["mavlink", "parser", "protocol", "embedded"]
1616
categories = ["aerospace", "aerospace::protocols", "parsing", "embedded"]
1717

‎mavlink-bindgen/src/parser.rs‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -916,13 +916,13 @@ impl MavMessage {
916916

917917
#[inline(always)]
918918
fn emit_name_types(&self) -> (Vec<TokenStream>, usize) {
919-
let mut encoded_payload_len: usize = 0;
919+
let mut encoded_payload_size: usize = 0;
920920
let field_toks = self
921921
.fields
922922
.iter()
923923
.map(|field| {
924924
let nametype = field.emit_name_type();
925-
encoded_payload_len += field.mavtype.len();
925+
encoded_payload_size += field.mavtype.size();
926926

927927
let description = field.emit_description();
928928

@@ -960,7 +960,7 @@ impl MavMessage {
960960
}
961961
})
962962
.collect::<Vec<TokenStream>>();
963-
(field_toks, encoded_payload_len)
963+
(field_toks, encoded_payload_size)
964964
}
965965

966966
/// Generate description for the given message
@@ -1077,9 +1077,9 @@ impl MavMessage {
10771077
let id = self.id;
10781078
let name = self.name.clone();
10791079
let extra_crc = extra_crc(self);
1080-
let (name_types, payload_encoded_len) = self.emit_name_types();
1080+
let (name_types, payload_encoded_size) = self.emit_name_types();
10811081
assert!(
1082-
(1..=255).contains(&payload_encoded_len),
1082+
(1..=255).contains(&payload_encoded_size),
10831083
"payload length must be between 1 and 255 bytes"
10841084
);
10851085

@@ -1105,7 +1105,7 @@ impl MavMessage {
11051105
}
11061106

11071107
impl #msg_name {
1108-
pub const ENCODED_LEN: usize = #payload_encoded_len;
1108+
pub const ENCODED_LEN: usize = #payload_encoded_size;
11091109
#const_default
11101110

11111111
#[cfg(feature = "arbitrary")]
@@ -1126,7 +1126,7 @@ impl MavMessage {
11261126
const ID: u32 = #id;
11271127
const NAME: &'static str = #name;
11281128
const EXTRA_CRC: u8 = #extra_crc;
1129-
const ENCODED_LEN: usize = #payload_encoded_len;
1129+
const ENCODED_LEN: usize = #payload_encoded_size;
11301130

11311131
fn deser(_version: MavlinkVersion, __input: &[u8]) -> Result<Self, ::mavlink_core::error::ParserError> {
11321132
#deser_vars
@@ -1449,16 +1449,16 @@ impl MavType {
14491449
}
14501450
}
14511451

1452-
/// Size of a given Mavtype
1453-
fn len(&self) -> usize {
1452+
/// Encoded size of this MavType.
1453+
pub fn size(&self) -> usize {
14541454
use self::MavType::*;
14551455
match self {
14561456
UInt8MavlinkVersion | UInt8 | Int8 | Char => 1,
14571457
UInt16 | Int16 => 2,
14581458
UInt32 | Int32 | Float => 4,
14591459
UInt64 | Int64 | Double => 8,
14601460
CharArray(size) => *size,
1461-
Array(t, size) => t.len() * size,
1461+
Array(t, size) => t.size() * size,
14621462
}
14631463
}
14641464

@@ -1487,7 +1487,7 @@ impl MavType {
14871487
UInt16 | Int16 => 2,
14881488
UInt32 | Int32 | Float => 4,
14891489
UInt64 | Int64 | Double => 8,
1490-
Array(t, _) => t.len(),
1490+
Array(t, _) => t.size(),
14911491
}
14921492
}
14931493

@@ -1887,10 +1887,9 @@ pub fn parse_profile(
18871887
// Update field display if enum is a bitmask
18881888
if let Some(e) =
18891889
profile.enums.get(field.enumtype.as_ref().unwrap())
1890+
&& e.bitmask
18901891
{
1891-
if e.bitmask {
1892-
field.display = Some("bitmask".to_string());
1893-
}
1892+
field.display = Some("bitmask".to_string());
18941893
}
18951894
}
18961895
b"display" => {

‎mavlink-core/Cargo.toml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ categories.workspace = true
2020

2121
[dependencies]
2222
arbitrary = { version = "1.4", optional = true, features = ["derive"] }
23-
async-trait = { version = "0.1.18", optional = true }
2423
crc-any = { workspace = true, default-features = false }
2524
memchr = { workspace = true, default-features = false, optional = true }
2625
embedded-io = { version = "0.7", optional = true }
@@ -51,7 +50,6 @@ serde = ["dep:serde"]
5150
tokio = [
5251
"std",
5352
"dep:tokio",
54-
"dep:async-trait",
5553
"dep:tokio-serial",
5654
"dep:futures",
5755
]

‎mavlink-core/src/async_reader.rs‎

Lines changed: 134 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ use crate::{
55
error::MessageReadError,
66
frame_decoder::{FrameDecoder, VersionFilter},
77
reader::{try_decode_message, try_decode_raw_message},
8+
static_dialect::StaticDialect,
89
};
910

1011
#[cfg(feature = "tokio")]
11-
use crate::SigningData;
12+
use crate::{Dialect, SigningData};
1213

1314
#[cfg(all(feature = "embedded", not(feature = "std")))]
1415
use embedded_io_async::Read;
@@ -100,13 +101,32 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
100101
.await
101102
}
102103

104+
/// Like [`Self::read_message`], using `dialect` for CRC validation and decoding.
105+
pub async fn read_message_with_dialect<D: Dialect>(
106+
&mut self,
107+
dialect: &D,
108+
version: MavlinkVersion,
109+
) -> Result<(MavHeader, D::Message), MessageReadError> {
110+
self.read_message_with_dialect_inner(VersionFilter::Exact(version), dialect, None)
111+
.await
112+
}
113+
103114
/// Reads and parses the next CRC-valid MAVLink 1 or MAVLink 2 message.
104115
pub async fn read_any_message<M: Message>(
105116
&mut self,
106117
) -> Result<(MavHeader, M), MessageReadError> {
107118
self.read_message_inner(VersionFilter::Any, None).await
108119
}
109120

121+
/// Like [`Self::read_any_message`], using `dialect` for CRC validation and decoding.
122+
pub async fn read_any_message_with_dialect<D: Dialect>(
123+
&mut self,
124+
dialect: &D,
125+
) -> Result<(MavHeader, D::Message), MessageReadError> {
126+
self.read_message_with_dialect_inner(VersionFilter::Any, dialect, None)
127+
.await
128+
}
129+
110130
/// Reads the next CRC-valid raw message accepted by `version`.
111131
pub async fn read_raw_message<M: Message>(
112132
&mut self,
@@ -116,6 +136,16 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
116136
.await
117137
}
118138

139+
/// Like [`Self::read_raw_message`], using `dialect` for CRC validation and decoding.
140+
pub async fn read_raw_message_with_dialect<D: Dialect>(
141+
&mut self,
142+
dialect: &D,
143+
version: MavlinkVersion,
144+
) -> Result<MAVLinkMessageRaw, MessageReadError> {
145+
self.read_raw_message_with_dialect_inner(VersionFilter::Exact(version), dialect, None)
146+
.await
147+
}
148+
119149
/// Reads the next CRC-valid MAVLink 1 or MAVLink 2 raw message.
120150
pub async fn read_any_raw_message<M: Message>(
121151
&mut self,
@@ -124,6 +154,15 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
124154
.await
125155
}
126156

157+
/// Like [`Self::read_any_raw_message`], using `dialect` for CRC validation and decoding.
158+
pub async fn read_any_raw_message_with_dialect<D: Dialect>(
159+
&mut self,
160+
dialect: &D,
161+
) -> Result<MAVLinkMessageRaw, MessageReadError> {
162+
self.read_raw_message_with_dialect_inner(VersionFilter::Any, dialect, None)
163+
.await
164+
}
165+
127166
/// Reads, verifies, and parses the next message accepted by `version`.
128167
/// With signing data, MAVLink 1 and unsigned MAVLink 2 frames require
129168
/// `SigningConfig::allow_unsigned`; signed MAVLink 2 frames must have a valid
@@ -138,6 +177,18 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
138177
.await
139178
}
140179

180+
/// Like [`Self::read_message_signed`], using `dialect` for CRC validation and decoding.
181+
#[cfg(feature = "mav2-message-signing")]
182+
pub async fn read_message_signed_with_dialect<D: Dialect>(
183+
&mut self,
184+
dialect: &D,
185+
version: MavlinkVersion,
186+
signing_data: Option<&SigningData>,
187+
) -> Result<(MavHeader, D::Message), MessageReadError> {
188+
self.read_message_with_dialect_inner(VersionFilter::Exact(version), dialect, signing_data)
189+
.await
190+
}
191+
141192
/// Reads, verifies, and parses the next MAVLink 1 or MAVLink 2 message.
142193
/// With signing data, MAVLink 1 frames follow `SigningConfig::allow_unsigned`.
143194
/// With `None`, signature verification is skipped.
@@ -150,6 +201,17 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
150201
.await
151202
}
152203

204+
/// Like [`Self::read_any_message_signed`], using `dialect` for CRC validation and decoding.
205+
#[cfg(feature = "mav2-message-signing")]
206+
pub async fn read_any_message_signed_with_dialect<D: Dialect>(
207+
&mut self,
208+
dialect: &D,
209+
signing_data: Option<&SigningData>,
210+
) -> Result<(MavHeader, D::Message), MessageReadError> {
211+
self.read_message_with_dialect_inner(VersionFilter::Any, dialect, signing_data)
212+
.await
213+
}
214+
153215
/// Reads and verifies the next raw message accepted by `version`.
154216
/// With signing data, MAVLink 1 and unsigned MAVLink 2 frames require
155217
/// `SigningConfig::allow_unsigned`; signed MAVLink 2 frames must have a valid
@@ -164,6 +226,22 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
164226
.await
165227
}
166228

229+
/// Like [`Self::read_raw_message_signed`], using `dialect` for CRC validation and decoding.
230+
#[cfg(feature = "mav2-message-signing")]
231+
pub async fn read_raw_message_signed_with_dialect<D: Dialect>(
232+
&mut self,
233+
dialect: &D,
234+
version: MavlinkVersion,
235+
signing_data: Option<&SigningData>,
236+
) -> Result<MAVLinkMessageRaw, MessageReadError> {
237+
self.read_raw_message_with_dialect_inner(
238+
VersionFilter::Exact(version),
239+
dialect,
240+
signing_data,
241+
)
242+
.await
243+
}
244+
167245
/// Reads and verifies the next MAVLink 1 or MAVLink 2 raw message.
168246
/// With signing data, MAVLink 1 frames follow `SigningConfig::allow_unsigned`.
169247
/// With `None`, signature verification is skipped.
@@ -176,14 +254,38 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
176254
.await
177255
}
178256

257+
/// Like [`Self::read_any_raw_message_signed`], using `dialect` for CRC validation and decoding.
258+
#[cfg(feature = "mav2-message-signing")]
259+
pub async fn read_any_raw_message_signed_with_dialect<D: Dialect>(
260+
&mut self,
261+
dialect: &D,
262+
signing_data: Option<&SigningData>,
263+
) -> Result<MAVLinkMessageRaw, MessageReadError> {
264+
self.read_raw_message_with_dialect_inner(VersionFilter::Any, dialect, signing_data)
265+
.await
266+
}
267+
179268
#[inline]
180269
pub(crate) async fn read_message_inner<M: Message>(
181270
&mut self,
182271
filter: VersionFilter,
183272
signing_data: Option<&SigningData>,
184273
) -> Result<(MavHeader, M), MessageReadError> {
274+
self.read_message_with_dialect_inner(filter, &StaticDialect::<M>::new(), signing_data)
275+
.await
276+
}
277+
278+
#[inline]
279+
pub(crate) async fn read_message_with_dialect_inner<D: Dialect>(
280+
&mut self,
281+
filter: VersionFilter,
282+
dialect: &D,
283+
signing_data: Option<&SigningData>,
284+
) -> Result<(MavHeader, D::Message), MessageReadError> {
185285
loop {
186-
if let Some(result) = try_decode_message::<M>(&mut self.decoder, filter, signing_data) {
286+
if let Some(result) =
287+
try_decode_message(&mut self.decoder, filter, dialect, signing_data)
288+
{
187289
return result;
188290
}
189291
self.read_more().await?;
@@ -195,10 +297,21 @@ impl<R: AsyncRead + Unpin> AsyncMavlinkReader<R> {
195297
&mut self,
196298
filter: VersionFilter,
197299
signing_data: Option<&SigningData>,
300+
) -> Result<MAVLinkMessageRaw, MessageReadError> {
301+
self.read_raw_message_with_dialect_inner(filter, &StaticDialect::<M>::new(), signing_data)
302+
.await
303+
}
304+
305+
#[inline]
306+
pub(crate) async fn read_raw_message_with_dialect_inner<D: Dialect>(
307+
&mut self,
308+
filter: VersionFilter,
309+
dialect: &D,
310+
signing_data: Option<&SigningData>,
198311
) -> Result<MAVLinkMessageRaw, MessageReadError> {
199312
loop {
200313
if let Some(message) =
201-
try_decode_raw_message::<M>(&mut self.decoder, filter, signing_data)
314+
try_decode_raw_message(&mut self.decoder, filter, dialect, signing_data)
202315
{
203316
return Ok(message);
204317
}
@@ -235,7 +348,9 @@ impl<R: Read> AsyncMavlinkReader<R> {
235348
) -> Result<(MavHeader, M), MessageReadError> {
236349
let filter = VersionFilter::Exact(version);
237350
loop {
238-
if let Some(result) = try_decode_message::<M>(&mut self.decoder, filter, None) {
351+
if let Some(result) =
352+
try_decode_message(&mut self.decoder, filter, &StaticDialect::<M>::new(), None)
353+
{
239354
return result;
240355
}
241356
self.read_more().await?;
@@ -247,9 +362,12 @@ impl<R: Read> AsyncMavlinkReader<R> {
247362
&mut self,
248363
) -> Result<(MavHeader, M), MessageReadError> {
249364
loop {
250-
if let Some(result) =
251-
try_decode_message::<M>(&mut self.decoder, VersionFilter::Any, None)
252-
{
365+
if let Some(result) = try_decode_message(
366+
&mut self.decoder,
367+
VersionFilter::Any,
368+
&StaticDialect::<M>::new(),
369+
None,
370+
) {
253371
return result;
254372
}
255373
self.read_more().await?;
@@ -263,7 +381,9 @@ impl<R: Read> AsyncMavlinkReader<R> {
263381
) -> Result<MAVLinkMessageRaw, MessageReadError> {
264382
let filter = VersionFilter::Exact(version);
265383
loop {
266-
if let Some(message) = try_decode_raw_message::<M>(&mut self.decoder, filter, None) {
384+
if let Some(message) =
385+
try_decode_raw_message(&mut self.decoder, filter, &StaticDialect::<M>::new(), None)
386+
{
267387
return Ok(message);
268388
}
269389
self.read_more().await?;
@@ -275,9 +395,12 @@ impl<R: Read> AsyncMavlinkReader<R> {
275395
&mut self,
276396
) -> Result<MAVLinkMessageRaw, MessageReadError> {
277397
loop {
278-
if let Some(message) =
279-
try_decode_raw_message::<M>(&mut self.decoder, VersionFilter::Any, None)
280-
{
398+
if let Some(message) = try_decode_raw_message(
399+
&mut self.decoder,
400+
VersionFilter::Any,
401+
&StaticDialect::<M>::new(),
402+
None,
403+
) {
281404
return Ok(message);
282405
}
283406
self.read_more().await?;

0 commit comments

Comments
 (0)