diff --git a/CHANGELOG.md b/CHANGELOG.md index f80d90d..92e2d4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # Changelog +## 1.21.2 +- Relax success ordering from AcqRel to Release in `race`: [#278](https://github.com/matklad/once_cell/pull/278). + ## 1.21.1 - Reduce MSRV to 1.65: [#277](https://github.com/matklad/once_cell/pull/277). diff --git a/Cargo.lock.msrv b/Cargo.lock.msrv index 3dc9f9e..9c90a43 100644 --- a/Cargo.lock.msrv +++ b/Cargo.lock.msrv @@ -43,7 +43,7 @@ checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" [[package]] name = "once_cell" -version = "1.21.1" +version = "1.21.2" dependencies = [ "critical-section", "parking_lot_core", diff --git a/Cargo.toml b/Cargo.toml index 0ae49a1..b395717 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "once_cell" -version = "1.21.1" +version = "1.21.2" authors = ["Aleksey Kladov "] license = "MIT OR Apache-2.0" edition = "2021" diff --git a/src/race.rs b/src/race.rs index 838b841..27014d6 100644 --- a/src/race.rs +++ b/src/race.rs @@ -19,6 +19,14 @@ //! `Acquire` and `Release` have very little performance overhead on most //! architectures versus `Relaxed`. +// The "atomic orderings" section of the documentation above promises +// "happens-before" semantics. This drives the choice of orderings in the uses +// of `compare_exchange` below. On success, the value was zero/null, so there +// was nothing to acquire (there is never any `Ordering::Release` store of 0). +// On failure, the value was nonzero, so it was initialized previously (perhaps +// on another thread) using `Ordering::Release`, so we must use +// `Ordering::Acquire` to ensure that store "happens-before" this load. + #[cfg(not(feature = "portable-atomic"))] use core::sync::atomic; #[cfg(feature = "portable-atomic")] @@ -98,7 +106,7 @@ impl OnceNonZeroUsize { #[inline] pub fn set(&self, value: NonZeroUsize) -> Result<(), ()> { let exchange = - self.inner.compare_exchange(0, value.get(), Ordering::AcqRel, Ordering::Acquire); + self.inner.compare_exchange(0, value.get(), Ordering::Release, Ordering::Acquire); match exchange { Ok(_) => Ok(()), Err(_) => Err(()), @@ -144,7 +152,7 @@ impl OnceNonZeroUsize { #[inline(never)] fn init(&self, f: impl FnOnce() -> Result) -> Result { let mut val = f()?.get(); - let exchange = self.inner.compare_exchange(0, val, Ordering::AcqRel, Ordering::Acquire); + let exchange = self.inner.compare_exchange(0, val, Ordering::Release, Ordering::Acquire); if let Err(old) = exchange { val = old; } @@ -258,7 +266,7 @@ impl<'a, T> OnceRef<'a, T> { pub fn set(&self, value: &'a T) -> Result<(), ()> { let ptr = value as *const T as *mut T; let exchange = - self.inner.compare_exchange(ptr::null_mut(), ptr, Ordering::AcqRel, Ordering::Acquire); + self.inner.compare_exchange(ptr::null_mut(), ptr, Ordering::Release, Ordering::Acquire); match exchange { Ok(_) => Ok(()), Err(_) => Err(()), @@ -301,7 +309,7 @@ impl<'a, T> OnceRef<'a, T> { let exchange = self.inner.compare_exchange( ptr::null_mut(), ptr, - Ordering::AcqRel, + Ordering::Release, Ordering::Acquire, ); if let Err(old) = exchange { @@ -396,7 +404,7 @@ mod once_box { let exchange = self.inner.compare_exchange( ptr::null_mut(), ptr, - Ordering::AcqRel, + Ordering::Release, Ordering::Acquire, ); if exchange.is_err() { @@ -442,7 +450,7 @@ mod once_box { let exchange = self.inner.compare_exchange( ptr::null_mut(), ptr, - Ordering::AcqRel, + Ordering::Release, Ordering::Acquire, ); if let Err(old) = exchange {