diff options
| author | Dario Nieuwenhuis <[email protected]> | 2023-03-30 17:55:55 +0200 |
|---|---|---|
| committer | Dario Nieuwenhuis <[email protected]> | 2023-03-30 17:55:55 +0200 |
| commit | 80972f1e0e6b6d409cc4d86202608c22e5ee3e5a (patch) | |
| tree | 3465f890980bdcb8b296cadb8d0aa0fc4c0cace4 /embassy-sync/src/waitqueue/atomic_waker.rs | |
| parent | 754bb802ba377c19be97d092c4b2afe542de20b5 (diff) | |
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.
Diffstat (limited to 'embassy-sync/src/waitqueue/atomic_waker.rs')
| -rw-r--r-- | embassy-sync/src/waitqueue/atomic_waker.rs | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/embassy-sync/src/waitqueue/atomic_waker.rs b/embassy-sync/src/waitqueue/atomic_waker.rs new file mode 100644 index 000000000..63fe04a6e --- /dev/null +++ b/embassy-sync/src/waitqueue/atomic_waker.rs | |||
| @@ -0,0 +1,41 @@ | |||
| 1 | use core::cell::Cell; | ||
| 2 | use core::task::Waker; | ||
| 3 | |||
| 4 | use crate::blocking_mutex::raw::CriticalSectionRawMutex; | ||
| 5 | use crate::blocking_mutex::Mutex; | ||
| 6 | |||
| 7 | /// Utility struct to register and wake a waker. | ||
| 8 | pub struct AtomicWaker { | ||
| 9 | waker: Mutex<CriticalSectionRawMutex, Cell<Option<Waker>>>, | ||
| 10 | } | ||
| 11 | |||
| 12 | impl AtomicWaker { | ||
| 13 | /// Create a new `AtomicWaker`. | ||
| 14 | pub const fn new() -> Self { | ||
| 15 | Self { | ||
| 16 | waker: Mutex::const_new(CriticalSectionRawMutex::new(), Cell::new(None)), | ||
| 17 | } | ||
| 18 | } | ||
| 19 | |||
| 20 | /// Register a waker. Overwrites the previous waker, if any. | ||
| 21 | pub fn register(&self, w: &Waker) { | ||
| 22 | critical_section::with(|cs| { | ||
| 23 | let cell = self.waker.borrow(cs); | ||
| 24 | cell.set(match cell.replace(None) { | ||
| 25 | Some(w2) if (w2.will_wake(w)) => Some(w2), | ||
| 26 | _ => Some(w.clone()), | ||
| 27 | }) | ||
| 28 | }) | ||
| 29 | } | ||
| 30 | |||
| 31 | /// Wake the registered waker, if any. | ||
| 32 | pub fn wake(&self) { | ||
| 33 | critical_section::with(|cs| { | ||
| 34 | let cell = self.waker.borrow(cs); | ||
| 35 | if let Some(w) = cell.replace(None) { | ||
| 36 | w.wake_by_ref(); | ||
| 37 | cell.set(Some(w)); | ||
| 38 | } | ||
| 39 | }) | ||
| 40 | } | ||
| 41 | } | ||
