Merge pull request #9 from asder8215/thread_pin

Thread pin

Author: asder8215

.github/workflows/rust.yml

@@ -11,7 +11,7 @@ env:
 
 jobs:
   build_and_test:
-    name: lf-shardedringbuf
+    name: sharded_ringbuf
     runs-on: ubuntu-latest
 
     steps:
@@ -40,6 +40,3 @@ jobs:
 
       - name: Install nightly toolchain
         run: rustup toolchain install nightly
-
-      - name: Run benchmark
-        run: cargo +nightly bench | tee output.txt

CHANGELOG.md

@@ -1,9 +1,18 @@
+# Change for shardedringbuf:
+
+## In v0.1.0:
+* A new policy has been made called `CFT` (or Completely Fair Tasks). See `src/task_local_spawn.rs` for more details.
+* Spawn functions have been refactored to specifically call on enqueue and dequeue functions
+of `ShardedRingBuf<T>` (as a result, the async enqueue and dequeue functions for the buffer is private)
+* Updated doc comments on spawn function and Shard Policies and various other places.
+* No new benchmarking details have been updated as of now due (though benchmarking code
+is being modularized currently).
+
 # Change Log for lf-shardedringbuf:
 
 ## In v4.1.0:
-* A new policy has been made called `CFT` (or Completely Fair Tasks). See `src/task_local_spawn.rs` for more details. Note that the shard policies might be refactored in the future (alongside all the other policies) to be as part of one of `LFShardedRingBuf<T>` functions.
-* Updated doc comments on spawn function and Shard Policies and various other places.
-* No new benchmarking details have been updated as of now due.
+* Crate has been deprecated and moved to `sharded_ringbuf` due to high number of version changes and the crate name is a misnomer because it technically uses locks with the key feature of this buffer being that it has shards.
+* There have been other changes here before it was marked deprecated like `CFT` (Completely Fair Tasks) being implemented, which is why the major version change has been updated here instead of patch version.
 
 ## In v3.1.0:
 * Metadata in `LFShardedRingBuf<T>` is once again refactored such that everything uses atomic primitives (i.e. `Box<[UnsafeCell<MaybeUninit<T>>]>` -> `Box<[AtomicPtr<MaybeUninit<T>>]>`). It implement `Send` and `Sync` by default now!

Cargo.lock

@@ -1,33 +1,72 @@
 [package]
-name = "lf-shardedringbuf"
-version = "3.1.0"
+name = "sharded_ringbuf"
+version = "0.1.0"
 edition = "2024"
 rust-version="1.87.0"
 description = """
-An async, lock-free, sharded, cache-aware SPSC/MPSC/MPMC ring buffer in Rust.
+A Tokio async, sharded SPSC/MPSC/MPMC ring buffer in Rust.
 """
 authors= ["Mahdi Ali-Raihan mma2268@columbia.edu"]
 license = "MIT"
 keywords = ["sharding", "async", "ring-buffer", "mpmc", "spsc"]
-categories = ["concurrency"]
+categories = ["concurrency", "async"]
 readme = "README.md"
-repository = "https://github.com/asder8215/lf-shardedringbuf"
-homepage = "https://github.com/asder8215/lf-shardedringbuf"
-documentation = "https://docs.rs/lf-shardedringbuf/latest/lf_shardedringbuf/"
+repository = "https://github.com/asder8215/sharded_ringbuf"
+homepage = "https://github.com/asder8215/sharded_ringbuf"
+documentation = "https://docs.rs/sharded_ringbuf/latest/sharded_ringbuf/"
 
 [dependencies]
 crossbeam-utils = "^0.8.21"
 fastrand = "^2.3.0"
 futures-util = "0.3.31"
-tokio = {version = "^1.45.1", features = ["rt"] }
+tokio = {version = "^1.45.1", features = ["rt", "sync"] }
 
 [dev-dependencies]
 criterion = {version = "^0.6.0", features =["async_tokio"] }
 tokio = {version = "^1.45.1", features = ["sync", "macros", "rt-multi-thread"] }
 kanal = "^0.1.1"
+async-channel = "2.5.0"
+crossbeam = "0.8"
+flume = {version="0.11", features= ["async"] }
 
 [[bench]]
-name = "rb_benchmarks"
+name = "srb_shiftby"
+harness = false
+
+[[bench]]
+name = "srb_sweep"
+harness = false
+
+[[bench]]
+name = "srb_randomsweep"
+harness = false
+
+[[bench]]
+name = "srb_cft"
+harness = false
+
+[[bench]]
+name = "srb_pin"
+harness = false
+
+[[bench]]
+name = "flume"
+harness = false
+
+[[bench]]
+name = "tokio"
+harness = false
+
+[[bench]]
+name = "crossbeam"
+harness = false
+
+[[bench]]
+name = "crossfire"
+harness = false
+
+[[bench]]
+name = "kanal_async"
 harness = false
 
 [profile.dev]