embassy/embassy-sync/src/waitqueue/mod.rs

//! Async low-level wait queues

#[cfg_attr(feature = "turbowakers", path = "atomic_waker_turbo.rs")]
mod atomic_waker;
pub use atomic_waker::*;

mod waker_registration;
pub use waker_registration::*;

mod multi_waker;
pub use multi_waker::*;
embassy: Refactor module structure to remove kitchen-sink `util`. 2021-09-11 01:53:53 +02:00			`//! Async low-level wait queues`

executor,sync: add support for turbo-wakers. This is a `core` patch to make wakers 1 word (the task pointer) instead of 2 (task pointer + vtable). It allows having the "waker optimization" we had a while back on `WakerRegistration/AtomicWaker`, but EVERYWHERE, without patching all crates. Advantages: - Less memory usage. - Faster. - `AtomicWaker` can actually use atomics to load/store the waker, No critical section needed. - No `dyn` call, which means `cargo-call-stack` can now see through wakes. Disadvantages: - You have to patch `core`... - Breaks all executors and other things that create wakers, unless they opt in to using the new `from_ptr` API. How to use: - Run this shell script to patch `core`. https://gist.github.com/Dirbaio/c67da7cf318515181539122c9d32b395 - Enable `build-std` - Enable `build-std-features = core/turbowakers` - Enable feature `turbowakers` in `embassy-executor`, `embassy-sync`. - Make sure you have no other crate creating wakers other than `embassy-executor`. These will panic at runtime. Note that the patched `core` is equivalent to the unpached one when the `turbowakers` feature is not enabled, so it should be fine to leave it there. 2023-03-30 17:55:55 +02:00			`#[cfg_attr(feature = "turbowakers", path = "atomic_waker_turbo.rs")]`
			`mod atomic_waker;`
			`pub use atomic_waker::*;`

			`mod waker_registration;`
			`pub use waker_registration::*;`
Added a function to WakerRegistration to check if it's occupied. Created a MultiWakerRegistration that can hold multiple wakers. Got rid of some options and the pub/sub_index 2022-06-17 13:54:34 +02:00
			`mod multi_waker;`
			`pub use multi_waker::*;`