Merge #47

47: RingBuffer: put smaller atomic indices behind a Cargo feature r=japaric a=japaric

cc #40

Co-authored-by: Jorge Aparicio <[email protected]>

Author: bors[bot]

Cargo.toml

@@ -19,8 +19,9 @@ repository = "https://github.com/japaric/heapless"
 version = "0.3.6"
 
 [features]
-default = ["const-fn"]
+default = ["const-fn", "smaller-atomics"]
 const-fn = []
+smaller-atomics = []
 
 [dev-dependencies]
 scoped_threadpool = "0.1.8"

src/lib.rs

@@ -83,7 +83,7 @@
 #![deny(missing_docs)]
 #![deny(warnings)]
 #![cfg_attr(feature = "const-fn", feature(const_fn))]
-#![feature(core_intrinsics)]
+#![cfg_attr(feature = "smaller-atomics", feature(core_intrinsics))]
 #![feature(untagged_unions)]
 #![no_std]
 

src/ring_buffer/mod.rs

@@ -1,8 +1,12 @@
 //! Ring buffer
 
 use core::cell::UnsafeCell;
+#[cfg(feature = "smaller-atomics")]
+use core::intrinsics;
 use core::ops::Add;
-use core::{intrinsics, ptr};
+use core::ptr;
+#[cfg(not(feature = "smaller-atomics"))]
+use core::sync::atomic::{AtomicUsize, Ordering};
 
 use generic_array::typenum::{Sum, U1, Unsigned};
 use generic_array::{ArrayLength, GenericArray};
@@ -14,12 +18,53 @@ mod spsc;
 
 /// Types that can be used as `RingBuffer` indices: `u8`, `u16` and `usize
 ///
-/// Do not implement this trait yourself
-pub unsafe trait Uxx: Into<usize> + Send {
+/// This trait is sealed and cannot be implemented outside of `heapless`.
+pub unsafe trait Uxx: Into<usize> + Send + private::Sealed {
     #[doc(hidden)]
     fn truncate(x: usize) -> Self;
+
+    #[cfg(feature = "smaller-atomics")]
+    #[doc(hidden)]
+    fn load_acquire(x: *mut Self) -> Self {
+        unsafe { intrinsics::atomic_load_acq(x) }
+    }
+
+    #[cfg(not(feature = "smaller-atomics"))]
+    #[doc(hidden)]
+    fn load_acquire(x: *mut Self) -> Self;
+
+    #[cfg(feature = "smaller-atomics")]
+    #[doc(hidden)]
+    fn load_relaxed(x: *mut Self) -> Self {
+        unsafe { intrinsics::atomic_load_relaxed(x) }
+    }
+
+    #[cfg(not(feature = "smaller-atomics"))]
+    #[doc(hidden)]
+    fn load_relaxed(x: *mut Self) -> Self;
+
+    #[cfg(feature = "smaller-atomics")]
+    #[doc(hidden)]
+    fn store_release(x: *mut Self, val: Self) {
+        unsafe { intrinsics::atomic_store_rel(x, val) }
+    }
+
+    #[cfg(not(feature = "smaller-atomics"))]
+    #[doc(hidden)]
+    fn store_release(x: *mut Self, val: Self);
 }
 
+mod private {
+    pub trait Sealed {}
+
+    impl Sealed for usize {}
+    #[cfg(feature = "smaller-atomics")]
+    impl Sealed for u8 {}
+    #[cfg(feature = "smaller-atomics")]
+    impl Sealed for u16 {}
+}
+
+#[cfg(feature = "smaller-atomics")]
 unsafe impl Uxx for u8 {
     fn truncate(x: usize) -> Self {
         let max = ::core::u8::MAX;
@@ -31,6 +76,7 @@ unsafe impl Uxx for u8 {
     }
 }
 
+#[cfg(feature = "smaller-atomics")]
 unsafe impl Uxx for u16 {
     fn truncate(x: usize) -> Self {
         let max = ::core::u16::MAX;
@@ -46,6 +92,23 @@ unsafe impl Uxx for usize {
     fn truncate(x: usize) -> Self {
         x
     }
+
+    #[cfg(not(feature = "smaller-atomics"))]
+    fn load_acquire(x: *mut Self) -> Self {
+        unsafe { (*(x as *mut AtomicUsize)).load(Ordering::Acquire) }
+    }
+
+    #[cfg(not(feature = "smaller-atomics"))]
+    fn load_relaxed(x: *mut Self) -> Self {
+        unsafe { (*(x as *mut AtomicUsize)).load(Ordering::Relaxed) }
+    }
+
+    #[cfg(not(feature = "smaller-atomics"))]
+    fn store_release(x: *mut Self, val: Self) {
+        unsafe {
+            (*(x as *mut AtomicUsize)).store(val, Ordering::Release);
+        }
+    }
 }
 
 // Atomic{U8,U16, Usize} with no CAS operations that works on targets that have "no atomic support"
@@ -61,28 +124,26 @@ impl<U> Atomic<U>
 where
     U: Uxx,
 {
-    const_fn!(
-        const fn new(v: U) -> Atomic<U> {
-            Atomic {
-                v: UnsafeCell::new(v),
-            }
+    const_fn!(const fn new(v: U) -> Atomic<U> {
+        Atomic {
+            v: UnsafeCell::new(v),
         }
-    );
+    });
 
     fn get_mut(&mut self) -> &mut U {
         unsafe { &mut *self.v.get() }
     }
 
     fn load_acquire(&self) -> U {
-        unsafe { intrinsics::atomic_load_acq(self.v.get()) }
+        U::load_acquire(self.v.get())
     }
 
     fn load_relaxed(&self) -> U {
-        unsafe { intrinsics::atomic_load_relaxed(self.v.get()) }
+        U::load_relaxed(self.v.get())
     }
 
     fn store_release(&self, val: U) {
-        unsafe { intrinsics::atomic_store_rel(self.v.get(), val) }
+        U::store_release(self.v.get(), val)
     }
 }
 
@@ -269,7 +330,6 @@ macro_rules! impl_ {
             N: Add<U1> + Unsigned,
             Sum<N, U1>: ArrayLength<T>,
         {
-
             const_fn!(
                 /// Creates an empty ring buffer with a fixed capacity of `N`
                 pub const fn $uxx() -> Self {
@@ -357,7 +417,6 @@ where
     N: Add<U1> + Unsigned,
     Sum<N, U1>: ArrayLength<T>,
 {
-
     const_fn!(
         /// Alias for [`RingBuffer::usize`](struct.RingBuffer.html#method.usize)
         pub const fn new() -> Self {
@@ -366,7 +425,9 @@ where
     );
 }
 
+#[cfg(feature = "smaller-atomics")]
 impl_!(u8);
+#[cfg(feature = "smaller-atomics")]
 impl_!(u16);
 impl_!(usize);
 
@@ -548,6 +609,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg(feature = "smaller-atomics")]
     fn u8() {
         let mut rb: RingBuffer<u8, U256, _> = RingBuffer::u8();
 

src/ring_buffer/spsc.rs

@@ -196,7 +196,9 @@ macro_rules! impl_ {
     };
 }
 
+#[cfg(feature = "smaller-atomics")]
 impl_!(u8);
+#[cfg(feature = "smaller-atomics")]
 impl_!(u16);
 impl_!(usize);