aboutsummaryrefslogtreecommitdiff
path: root/embassy-sync/src/waitqueue/atomic_waker_turbo.rs
diff options
context:
space:
mode:
authorDario Nieuwenhuis <[email protected]>2023-03-30 17:55:55 +0200
committerDario Nieuwenhuis <[email protected]>2023-03-30 17:55:55 +0200
commit80972f1e0e6b6d409cc4d86202608c22e5ee3e5a (patch)
tree3465f890980bdcb8b296cadb8d0aa0fc4c0cace4 /embassy-sync/src/waitqueue/atomic_waker_turbo.rs
parent754bb802ba377c19be97d092c4b2afe542de20b5 (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_turbo.rs')
-rw-r--r--embassy-sync/src/waitqueue/atomic_waker_turbo.rs30
1 files changed, 30 insertions, 0 deletions
diff --git a/embassy-sync/src/waitqueue/atomic_waker_turbo.rs b/embassy-sync/src/waitqueue/atomic_waker_turbo.rs
new file mode 100644
index 000000000..5c6a96ec8
--- /dev/null
+++ b/embassy-sync/src/waitqueue/atomic_waker_turbo.rs
@@ -0,0 +1,30 @@
1use core::ptr;
2use core::ptr::NonNull;
3use core::sync::atomic::{AtomicPtr, Ordering};
4use core::task::Waker;
5
6/// Utility struct to register and wake a waker.
7pub struct AtomicWaker {
8 waker: AtomicPtr<()>,
9}
10
11impl AtomicWaker {
12 /// Create a new `AtomicWaker`.
13 pub const fn new() -> Self {
14 Self {
15 waker: AtomicPtr::new(ptr::null_mut()),
16 }
17 }
18
19 /// Register a waker. Overwrites the previous waker, if any.
20 pub fn register(&self, w: &Waker) {
21 self.waker.store(w.as_turbo_ptr().as_ptr() as _, Ordering::Release);
22 }
23
24 /// Wake the registered waker, if any.
25 pub fn wake(&self) {
26 if let Some(ptr) = NonNull::new(self.waker.load(Ordering::Acquire)) {
27 unsafe { Waker::from_turbo_ptr(ptr) }.wake();
28 }
29 }
30}