From: Boqun Feng <boqun@kernel.org>
To: Gary Guo <gary@garyguo.net>
Cc: "Andreas Hindborg" <a.hindborg@kernel.org>,
"Peter Zijlstra" <peterz@infradead.org>,
"Ingo Molnar" <mingo@redhat.com>, "Will Deacon" <will@kernel.org>,
"Waiman Long" <longman@redhat.com>,
"Alice Ryhl" <aliceryhl@google.com>,
"Lyude Paul" <lyude@redhat.com>,
"Daniel Almeida" <daniel.almeida@collabora.com>,
"Onur Özkan" <work@onurozkan.dev>,
"Miguel Ojeda" <ojeda@kernel.org>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
"Tamir Duberstein" <tamird@kernel.org>,
"Alexandre Courbot" <acourbot@nvidia.com>,
linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org
Subject: Re: [PATCH v3] rust: sync: export lock::do_unlocked
Date: Wed, 18 Nov 2026 13:06:40 -0800 [thread overview]
Message-ID: <av4TYDj2-mEhIZS5@tardis.local> (raw)
In-Reply-To: <DLSPFJ7IF2XC.1KZBWTARDIG1I@garyguo.net>
On Wed, Sep 30, 2026 at 03:01:41PM +0100, Gary Guo wrote:
> On Wed Sep 30, 2026 at 2:45 PM BST, Boqun Feng wrote:
> > On Tue, Sep 29, 2026 at 08:03:20PM +0200, Andreas Hindborg wrote:
> >> "Gary Guo" <gary@garyguo.net> writes:
> >>
> >> > On Tue Sep 29, 2026 at 3:45 PM BST, Andreas Hindborg wrote:
> >> >> Export lock::do_unlocked publicly. Add documentation for the method.
> >> >>
> >> >> Reviewed-by: Benno Lossin <lossin@kernel.org>
> >> >> Reviewed-by: Alice Ryhl <aliceryhl@google.com>
> >> >> Signed-off-by: Andreas Hindborg <a.hindborg@kernel.org>
> >> >> ---
> >> >> Changes in v3:
> >> >> - Rebase on v7.3-rc5.
> >> >> - Do not import prelude in example (Alice).
> >> >> - Link to v2: https://msgid.link/20260605-export-do-unlocked-v2-1-e23001390231@kernel.org
> >> >>
> >> >> Changes in v2:
> >> >> - Drop spurious space before `guard.do_unlocked` in the doc example (Benno).
> >> >> - Un-hide the imports in the doc example so the rendered docs no longer have a spurious blank line after them (Alice).
> >> >> - Link to v1: https://msgid.link/20260215-export-do-unlocked-v1-1-f5cd2203b20f@kernel.org
> >> >> ---
> >> >> rust/kernel/sync/lock.rs | 26 +++++++++++++++++++++++++-
> >> >> 1 file changed, 25 insertions(+), 1 deletion(-)
> >> >>
> >> >> diff --git a/rust/kernel/sync/lock.rs b/rust/kernel/sync/lock.rs
> >> >> index 10b6b5e9b024..edfff9e10199 100644
> >> >> --- a/rust/kernel/sync/lock.rs
> >> >> +++ b/rust/kernel/sync/lock.rs
> >> >> @@ -238,7 +238,31 @@ pub fn lock_ref(&self) -> &'a Lock<T, B> {
> >> >> self.lock
> >> >> }
> >> >>
> >> >> - pub(crate) fn do_unlocked<U>(&mut self, cb: impl FnOnce() -> U) -> U {
> >> >> + /// Temporarily unlock the lock to execute the given closure.
> >> >> + ///
> >> >> + /// This method unlocks the lock before calling the closure `cb`, and re-locks it afterwards.
> >> >> + /// This is useful when you need to perform operations that are not allowed while holding
> >> >> + /// certain locks, such as allocating memory (which is prohibited while holding a spinlock).
> >> >> + ///
> >> >> + /// # Examples
> >> >> + ///
> >> >> + /// ```
> >> >> + /// use kernel::new_spinlock;
> >> >> + /// use pin_init::stack_pin_init;
> >> >> + ///
> >> >> + /// stack_pin_init!{
> >> >> + /// let lock = new_spinlock!(())
> >> >> + /// }
> >> >> + ///
> >> >> + /// let mut guard = lock.lock();
> >> >> + /// let mut buffer = KVec::new();
> >> >> + /// // Temporarily unlock to allocate memory, which should not be done while holding a spinlock.
> >> >> + /// guard.do_unlocked(|| {
> >> >> + /// buffer.push(5u32, GFP_KERNEL)
> >> >> + /// })?;
> >> >> + /// # Ok::<(), Error>(())
> >> >> + /// ```
> >> >> + pub fn do_unlocked<U>(&mut self, cb: impl FnOnce() -> U) -> U {
> >> >
> >> > Do we want to keep the name `do_unlocked` now this is public?
> >> >
> >> > I think we can drop "do_" and just call this `unlocked`, consistent with popular
> >> > Rust ecosystem crates like parking_lot and spin.
> >>
> >
> > I didn't find a unlocked() in spin. You mean
> > https://crates.io/crates/lock_api ?
>
> Right, both of them share the common interface via lock_api.
>
> > To me, `do_unlocked()` is better, since it indicates something is going
> > to be done after the lock being dropped.
>
> I think that indication is usually "with". So `guard.with_unlocked(|| action)`.
>
> From my experience in Rust code "do_" is quite commonly the internal helper for
> a public API.
>
After some thoughts and asking for suggestion, I do want to keep the
name as it is (i.e. using do_unlocked()), the major reason is
`unlockded()` is not necessary a better name. But of course, in kernel
we can always change the name later.
Regards,
Boqun
> Best,
> Gary
>
prev parent reply other threads:[~2026-11-18 21:06 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-29 14:45 [PATCH v3] rust: sync: export lock::do_unlocked Andreas Hindborg
2026-09-29 16:26 ` Gary Guo
2026-09-29 18:03 ` Andreas Hindborg
2026-09-30 13:45 ` Boqun Feng
2026-09-30 14:01 ` Gary Guo
2026-11-18 21:06 ` Boqun Feng [this message]
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=av4TYDj2-mEhIZS5@tardis.local \
--to=boqun@kernel.org \
--cc=a.hindborg@kernel.org \
--cc=acourbot@nvidia.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=dakr@kernel.org \
--cc=daniel.almeida@collabora.com \
--cc=gary@garyguo.net \
--cc=linux-kernel@vger.kernel.org \
--cc=longman@redhat.com \
--cc=lossin@kernel.org \
--cc=lyude@redhat.com \
--cc=mingo@redhat.com \
--cc=ojeda@kernel.org \
--cc=peterz@infradead.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tamird@kernel.org \
--cc=tmgross@umich.edu \
--cc=will@kernel.org \
--cc=work@onurozkan.dev \
/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