Merge branch 'main' into separate-producer-consumer

Author: ithinuel

.github/workflows/doctests.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 name: Documentation Tests
 
@@ -12,9 +12,6 @@ jobs:
     strategy:
       matrix:
         include:
-          - rust: stable
-            features: atomic
-            nodefault: "--no-default-features"
           - rust: stable
             features: thumbv6
             nodefault: "--no-default-features"

.github/workflows/embedded-builds.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 name: Embedded Builds
 
@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         include:
-          - feature: atomic
+          - features: ""
             target: thumbv7em-none-eabihf
             rust: stable
           - feature: thumbv6

.github/workflows/fmt.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 name: Formatting check
 

.github/workflows/full-test.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 name: Integration Tests
 

.github/workflows/tsan-test.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 name: TSAN Integration Test
 
@@ -22,13 +22,14 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
+          components: rust-src
           toolchain: ${{ matrix.rust }}
 
       - uses: actions-rs/cargo@v1
         with:
           command: test
           toolchain: nightly
-          args: ${{ matrix.build }} --features=short-potato --manifest-path bbqtest/Cargo.toml --target x86_64-unknown-linux-gnu -- --nocapture
+          args: ${{ matrix.build }} --features=short-potato --manifest-path bbqtest/Cargo.toml -Zbuild-std --target x86_64-unknown-linux-gnu -- --nocapture
         env:
           RUSTFLAGS: "-Z sanitizer=thread"
           RUST_TEST_THREADS: 1

README.md

@@ -23,7 +23,7 @@ block of contiguous memory, which can be filled (or emptied) by a DMA engine.
 
 ```rust
 // Create a buffer with six elements
-let bb: BBBuffer<U6> = BBBuffer::new();
+let bb: BBBuffer<6> = BBBuffer::new();
 let (mut prod, mut cons) = bb.try_split().unwrap();
 
 // Request space for one byte
@@ -48,9 +48,11 @@ rgr.release(1);
 
 ## Static usage
 
-```rust
+```rust, no_run
+use bbqueue::BBBuffer;
+
 // Create a buffer with six elements
-static BB: BBBuffer<U6> = BBBuffer( ConstBBBuffer::new() );
+static BB: BBBuffer<6> = BBBuffer::new();
 
 fn main() {
     // Split the bbqueue into producer and consumer halves.
@@ -90,10 +92,6 @@ By default BBQueue uses atomic operations which are available on most platforms.
 (mostly embedded) platforms atomic support is limited and with the default features you will get
 a compiler error about missing atomic methods.
 
-This crate contains special support for Cortex-M0(+) targets with the `thumbv6` feature. By
-enabling the feature, unsupported atomic operations will be replaced with critical sections
-implemented by disabling interrupts. The critical sections are very short, a few instructions at
-most, so they should make no difference to most applications.
 
 # License
 

bbqtest/Cargo.toml

@@ -10,18 +10,15 @@ bounded-spsc-queue = { version = "0.4.0", optional = true }
 
 [dependencies.bbqueue]
 path = "../core"
-features = ["std"]
 
-[dependencies.generic-array]
-version = "0.12"
 
 [dev-dependencies]
-rand = "0.6"
-criterion = "0.3"
-crossbeam-utils = "0.7"
-crossbeam = "0.7"
-heapless = "0.5"
-cfg-if = "0.1"
+rand = "0.8"
+criterion = "0.5"
+crossbeam-utils = "0.8"
+crossbeam = "0.8"
+heapless = "0.8"
+cfg-if = "1.0"
 
 [[bench]]
 name = "benches"

bbqtest/src/benches.rs

@@ -1,4 +1,4 @@
-use bbqueue::{consts::*, BBBuffer};
+use bbqueue::BBBuffer;
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
 use std::cmp::min;
 
@@ -17,7 +17,7 @@ pub fn criterion_benchmark(c: &mut Criterion) {
 
     c.bench_function("bbq 2048/4096", |bench| bench.iter(|| chunky(&data, 2048)));
 
-    let buffy: BBBuffer<U65536> = BBBuffer::new();
+    let buffy: BBBuffer<65536> = BBBuffer::new();
     let (mut prod, mut cons) = buffy.try_split().unwrap();
 
     c.bench_function("bbq 8192/65536", |bench| {
@@ -154,7 +154,7 @@ pub fn criterion_benchmark(c: &mut Criterion) {
 
     use heapless::spsc::Queue;
 
-    let mut queue: Queue<[u8; 8192], U8> = Queue::new();
+    let mut queue: Queue<[u8; 8192], 8> = Queue::new();
     let (mut prod, mut cons) = queue.split();
 
     c.bench_function("heapless spsc::Queue 8192/65536", |bench| {
@@ -196,7 +196,7 @@ pub fn criterion_benchmark(c: &mut Criterion) {
 
 use crossbeam_utils::thread;
 fn chunky(data: &[u8], chunksz: usize) {
-    let buffy: BBBuffer<U4096> = BBBuffer::new();
+    let buffy: BBBuffer<4096> = BBBuffer::new();
     let (mut prod, mut cons) = buffy.try_split().unwrap();
 
     thread::scope(|sc| {

bbqtest/src/framed.rs

@@ -1,10 +1,10 @@
 #[cfg(test)]
 mod tests {
-    use bbqueue::{consts::*, BBBuffer};
+    use bbqueue::BBBuffer;
 
     #[test]
     fn frame_wrong_size() {
-        let bb: BBBuffer<U256> = BBBuffer::new();
+        let bb: BBBuffer<256> = BBBuffer::new();
         let (mut prod, mut cons) = bb.try_split_framed().unwrap();
 
         // Create largeish grants
@@ -25,7 +25,7 @@ mod tests {
 
     #[test]
     fn full_size() {
-        let bb: BBBuffer<U256> = BBBuffer::new();
+        let bb: BBBuffer<256> = BBBuffer::new();
         let (mut prod, mut cons) = bb.try_split_framed().unwrap();
         let mut ctr = 0;
 
@@ -66,7 +66,7 @@ mod tests {
 
     #[test]
     fn frame_overcommit() {
-        let bb: BBBuffer<U256> = BBBuffer::new();
+        let bb: BBBuffer<256> = BBBuffer::new();
         let (mut prod, mut cons) = bb.try_split_framed().unwrap();
 
         // Create largeish grants
@@ -93,7 +93,7 @@ mod tests {
 
     #[test]
     fn frame_undercommit() {
-        let bb: BBBuffer<U512> = BBBuffer::new();
+        let bb: BBBuffer<512> = BBBuffer::new();
         let (mut prod, mut cons) = bb.try_split_framed().unwrap();
 
         for _ in 0..100_000 {
@@ -132,20 +132,24 @@ mod tests {
 
     #[test]
     fn frame_auto_commit_release() {
-        let bb: BBBuffer<U256> = BBBuffer::new();
+        let bb: BBBuffer<256> = BBBuffer::new();
         let (mut prod, mut cons) = bb.try_split_framed().unwrap();
 
         for _ in 0..100 {
             {
-                let mut wgr = prod.grant(64).unwrap().into_auto_commit();
+                let mut wgr = prod.grant(64).unwrap();
+                wgr.to_commit(64);
                 for (i, by) in wgr.iter_mut().enumerate() {
                     *by = i as u8;
                 }
                 // drop
             }
 
             {
-                let rgr = cons.read().unwrap().into_auto_release();
+                let mut rgr = cons.read().unwrap();
+                rgr.auto_release(true);
+                let rgr = rgr;
+
                 for (i, by) in rgr.iter().enumerate() {
                     assert_eq!(*by, i as u8);
                 }