From: Alice Ryhl <aliceryhl@google.com>
To: rust-for-linux@vger.kernel.org
Cc: "Miguel Ojeda" <ojeda@kernel.org>,
"Wedson Almeida Filho" <wedsonaf@gmail.com>,
"Tejun Heo" <tj@kernel.org>,
"Lai Jiangshan" <jiangshanlai@gmail.com>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Alice Ryhl" <aliceryhl@google.com>,
linux-kernel@vger.kernel.org, patches@lists.linux.dev
Subject: [PATCH v2 7/8] rust: workqueue: add `try_spawn` helper method
Date: Thu, 1 Jun 2023 13:49:45 +0000 [thread overview]
Message-ID: <20230601134946.3887870-8-aliceryhl@google.com> (raw)
In-Reply-To: <20230601134946.3887870-1-aliceryhl@google.com>
This adds a convenience method that lets you spawn a closure for
execution on a workqueue. This will be the most convenient way to use
workqueues, but it is fallible because it needs to allocate memory.
Co-developed-by: Gary Guo <gary@garyguo.net>
Signed-off-by: Gary Guo <gary@garyguo.net>
Signed-off-by: Alice Ryhl <aliceryhl@google.com>
---
rust/kernel/workqueue.rs | 43 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/rust/kernel/workqueue.rs b/rust/kernel/workqueue.rs
index f06a2f036d8b..c302e8b8624b 100644
--- a/rust/kernel/workqueue.rs
+++ b/rust/kernel/workqueue.rs
@@ -29,6 +29,7 @@
//! C header: [`include/linux/workqueue.h`](../../../../include/linux/workqueue.h)
use crate::{bindings, prelude::*, sync::Arc, types::Opaque};
+use alloc::alloc::AllocError;
use alloc::boxed::Box;
use core::marker::{PhantomData, PhantomPinned};
use core::pin::Pin;
@@ -87,6 +88,44 @@ pub fn enqueue<W, const ID: u64>(&self, w: W) -> W::EnqueueOutput
})
}
}
+
+ /// Tries to spawn the given function or closure as a work item.
+ ///
+ /// This method can fail because it allocates memory to store the work item.
+ pub fn try_spawn<T: 'static + Send + FnOnce()>(&self, func: T) -> Result<(), AllocError> {
+ let init = pin_init!(ClosureWork {
+ work <- Work::new(),
+ func: Some(func),
+ });
+
+ self.enqueue(Box::pin_init(init).map_err(|_| AllocError)?);
+ Ok(())
+ }
+}
+
+/// A helper type used in `try_spawn`.
+#[pin_data]
+struct ClosureWork<T> {
+ #[pin]
+ work: Work<ClosureWork<T>>,
+ func: Option<T>,
+}
+
+impl<T> ClosureWork<T> {
+ fn project(self: Pin<&mut Self>) -> &mut Option<T> {
+ // SAFETY: The `func` field is not structurally pinned.
+ unsafe { &mut self.get_unchecked_mut().func }
+ }
+}
+
+impl<T: FnOnce()> WorkItem for ClosureWork<T> {
+ type Pointer = Pin<Box<Self>>;
+
+ fn run(mut this: Pin<Box<Self>>) {
+ if let Some(func) = this.as_mut().project().take() {
+ (func)()
+ }
+ }
}
/// A raw work item.
@@ -325,6 +364,10 @@ unsafe fn raw_get_work(ptr: *mut Self) -> *mut $crate::workqueue::Work<$work_typ
)*};
}
+impl_has_work! {
+ impl<T> HasWork<Self> for ClosureWork<T> { self.work }
+}
+
unsafe impl<T, const ID: u64> WorkItemPointer<ID> for Arc<T>
where
T: WorkItem<ID, Pointer = Self>,
--
2.41.0.rc0.172.g3f132b7071-goog
next prev parent reply other threads:[~2023-06-01 13:56 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-01 13:49 [PATCH v2 0/8] rust: workqueue: add bindings for the workqueue Alice Ryhl
2023-06-01 13:49 ` [PATCH v2 1/8] rust: workqueue: add low-level workqueue bindings Alice Ryhl
2023-06-01 14:29 ` Martin Rodriguez Reboredo
2023-06-02 14:39 ` Andreas Hindborg (Samsung)
2023-06-06 23:36 ` Boqun Feng
2023-06-07 15:18 ` Alice Ryhl
2023-06-11 15:45 ` Benno Lossin
2023-06-01 13:49 ` [PATCH v2 2/8] rust: add offset_of! macro Alice Ryhl
2023-06-01 17:17 ` Gary Guo
2023-06-02 10:33 ` Andreas Hindborg (Samsung)
2023-06-07 15:15 ` Alice Ryhl
2023-06-11 15:47 ` Benno Lossin
2023-06-01 13:49 ` [PATCH v2 3/8] rust: sync: add `Arc::{from_raw, into_raw}` Alice Ryhl
2023-06-01 17:26 ` Gary Guo
2023-06-02 10:51 ` Andreas Hindborg (Samsung)
2023-06-05 14:31 ` Gary Guo
2023-06-05 14:49 ` Andreas Hindborg (Samsung)
2023-06-05 15:00 ` Boqun Feng
2023-06-05 15:20 ` Boqun Feng
2023-06-05 18:34 ` Andreas Hindborg (Samsung)
2023-06-11 15:48 ` Benno Lossin
2023-06-01 13:49 ` [PATCH v2 4/8] rust: workqueue: define built-in queues Alice Ryhl
2023-06-01 17:30 ` Gary Guo
2023-06-01 17:52 ` Martin Rodriguez Reboredo
2023-06-02 8:32 ` Alice Ryhl
2023-06-02 14:46 ` Andreas Hindborg (Samsung)
2023-06-11 15:49 ` Benno Lossin
2023-06-01 13:49 ` [PATCH v2 5/8] rust: workqueue: add helper for defining work_struct fields Alice Ryhl
2023-06-01 14:50 ` Martin Rodriguez Reboredo
2023-06-01 18:44 ` Boqun Feng
2023-06-02 8:38 ` Alice Ryhl
2023-06-02 16:32 ` Boqun Feng
2023-06-01 21:09 ` Boqun Feng
2023-06-02 9:37 ` Alice Ryhl
2023-06-02 14:41 ` Andreas Hindborg (Samsung)
2023-06-11 15:59 ` Benno Lossin
2023-06-27 8:42 ` Alice Ryhl
2023-06-01 13:49 ` [PATCH v2 6/8] rust: workqueue: implement `WorkItemPointer` for pointer types Alice Ryhl
2023-06-01 14:51 ` Martin Rodriguez Reboredo
2023-06-02 14:42 ` Andreas Hindborg (Samsung)
2023-06-11 16:01 ` Benno Lossin
2023-06-01 13:49 ` Alice Ryhl [this message]
2023-06-01 14:53 ` [PATCH v2 7/8] rust: workqueue: add `try_spawn` helper method Martin Rodriguez Reboredo
2023-06-02 14:43 ` Andreas Hindborg (Samsung)
2023-06-11 16:10 ` Benno Lossin
2023-06-01 13:49 ` [PATCH v2 8/8] rust: workqueue: add examples Alice Ryhl
2023-06-01 14:58 ` Martin Rodriguez Reboredo
2023-06-01 17:32 ` Gary Guo
2023-06-02 9:39 ` Alice Ryhl
2023-06-02 14:44 ` Andreas Hindborg (Samsung)
2023-06-02 14:48 ` Andreas Hindborg (Samsung)
2023-06-11 16:15 ` Benno Lossin
2023-06-27 8:38 ` Alice Ryhl
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230601134946.3887870-8-aliceryhl@google.com \
--to=aliceryhl@google.com \
--cc=alex.gaynor@gmail.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=gary@garyguo.net \
--cc=jiangshanlai@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=patches@lists.linux.dev \
--cc=rust-for-linux@vger.kernel.org \
--cc=tj@kernel.org \
--cc=wedsonaf@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).