From db18c00c00deb146478de1b0f94f8181300c47ce Mon Sep 17 00:00:00 2001 From: Emil Fresk Date: Wed, 14 Jun 2023 20:07:21 +0200 Subject: [PATCH] rtic-sync: Fix possible UB in make_channel! --- rtic-sync/CHANGELOG.md | 6 ++++++ rtic-sync/Cargo.toml | 2 +- rtic-sync/src/channel.rs | 21 +++++++++++++++++++++ 3 files changed, 28 insertions(+), 1 deletion(-) diff --git a/rtic-sync/CHANGELOG.md b/rtic-sync/CHANGELOG.md index d3a9d846ee..65dd0a3944 100644 --- a/rtic-sync/CHANGELOG.md +++ b/rtic-sync/CHANGELOG.md @@ -13,4 +13,10 @@ For each category, *Added*, *Changed*, *Fixed* add new entries at the top! ### Fixed +## [v1.0.1] + +### Fixed + +- `make_channel` could be UB + ## [v1.0.0] - 2023-xx-xx diff --git a/rtic-sync/Cargo.toml b/rtic-sync/Cargo.toml index ccb6cab5ef..f01cfbe4ab 100644 --- a/rtic-sync/Cargo.toml +++ b/rtic-sync/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "rtic-sync" -version = "1.0.0" +version = "1.0.1" edition = "2021" authors = [ diff --git a/rtic-sync/src/channel.rs b/rtic-sync/src/channel.rs index 8c9f861d2e..06a6639b0e 100644 --- a/rtic-sync/src/channel.rs +++ b/rtic-sync/src/channel.rs @@ -106,6 +106,16 @@ macro_rules! make_channel { static mut CHANNEL: $crate::channel::Channel<$type, $size> = $crate::channel::Channel::new(); + static CHECK: ::core::sync::atomic::AtomicU8 = ::core::sync::atomic::AtomicU8::new(0); + + critical_section::with(|_| { + if CHECK.load(::core::sync::atomic::Ordering::Relaxed) != 0 { + panic!("call to the same `make_channel` instance twice"); + } + + CHECK.store(1, ::core::sync::atomic::Ordering::Relaxed); + }); + // SAFETY: This is safe as we hide the static mut from others to access it. // Only this point is where the mutable access happens. unsafe { CHANNEL.split() } @@ -573,4 +583,15 @@ mod tests { v.await.unwrap(); } } + + fn make() { + let _ = make_channel!(u32, 10); + } + + #[test] + #[should_panic] + fn double_make_channel() { + make(); + make(); + } }