* [PATCH v4 0/3] rust: add SRCU abstraction
@ 2026-05-25 17:55 Onur Özkan
2026-05-25 17:55 ` [PATCH v4 1/3] rust: helpers: add SRCU helpers Onur Özkan
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Onur Özkan @ 2026-05-25 17:55 UTC (permalink / raw)
To: rcu, rust-for-linux, linux-kernel
Cc: ojeda, boqun, gary, bjorn3_gh, lossin, a.hindborg, aliceryhl,
tmgross, dakr, peterz, fujita.tomonori, tamird, jiangshanlai,
paulmck, josh, rostedt, mathieu.desnoyers, Onur Özkan
The immediate motivation is the Tyr reset infrastructure [1] which needs
to serialize reset sensitive hardware access against reset and teardown
paths. That reset series started to require many independent dependencies
so this SRCU support is split out as a standalone Rust API to keep the
reset series focused on the reset logic and easier to review, rebase and
land.
Changes since v3 (which are for Sashiko notes [2]):
- Added rust helpers for srcu_barrier() and synchronize_srcu_expedited()
so the abstraction builds with CONFIG_TINY_SRCU, where these are
static inline functions.
- Added missing INVARIANT comment in Srcu::new() about why the type
invariants hold after successful initialization.
Changes since v2:
- Removed closure-based API.
- Added #[doc(hidden)] on new_srcu macro.
- Added #[must_use..] on srcu::Guard.
- Improved the clean-up path (PinnedDrop implementation) which
eventually made read_lock safe with leaked guards.
v2: https://lore.kernel.org/all/20260502162833.34334-1-work@onurozkan.dev
Changes since v1:
- Made the owned SRCU read-side guard API unsafe and added a safe closure
based helper for callers that do not need to keep the guard. This is to
avoid UB on the C side cleanup_srcu_struct where the SRCU struct is freed
while there are still active guards, which can happen if the caller leaks
the guard e.g., with mem::forget().
- Improved doc comments.
v1: https://lore.kernel.org/all/20260428103437.156236-1-work@onurozkan.dev
[1]: https://lore.kernel.org/all/20260416171728.205141-1-work@onurozkan.dev
[2]: https://sashiko.dev/#/patchset/20260522054228.114814-1-work@onurozkan.dev?part=2
Onur Özkan (3):
rust: helpers: add SRCU helpers
rust: sync: add SRCU abstraction
MAINTAINERS: add Rust SRCU files to SRCU entry
MAINTAINERS | 3 +
rust/helpers/helpers.c | 1 +
rust/helpers/srcu.c | 34 +++++++++
rust/kernel/sync.rs | 2 +
rust/kernel/sync/srcu.rs | 158 +++++++++++++++++++++++++++++++++++++++
5 files changed, 198 insertions(+)
create mode 100644 rust/helpers/srcu.c
create mode 100644 rust/kernel/sync/srcu.rs
--
2.51.2
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v4 1/3] rust: helpers: add SRCU helpers
2026-05-25 17:55 [PATCH v4 0/3] rust: add SRCU abstraction Onur Özkan
@ 2026-05-25 17:55 ` Onur Özkan
2026-05-25 17:55 ` [PATCH v4 2/3] rust: sync: add SRCU abstraction Onur Özkan
2026-05-25 17:55 ` [PATCH v4 3/3] MAINTAINERS: add Rust SRCU files to SRCU entry Onur Özkan
2 siblings, 0 replies; 6+ messages in thread
From: Onur Özkan @ 2026-05-25 17:55 UTC (permalink / raw)
To: rcu, rust-for-linux, linux-kernel
Cc: ojeda, boqun, gary, bjorn3_gh, lossin, a.hindborg, aliceryhl,
tmgross, dakr, peterz, fujita.tomonori, tamird, jiangshanlai,
paulmck, josh, rostedt, mathieu.desnoyers, Onur Özkan
Add helper wrappers for SRCU functions that are exposed to Rust
through generated bindings.
Signed-off-by: Onur Özkan <work@onurozkan.dev>
---
rust/helpers/helpers.c | 1 +
rust/helpers/srcu.c | 24 ++++++++++++++++++++++++
2 files changed, 25 insertions(+)
create mode 100644 rust/helpers/srcu.c
diff --git a/rust/helpers/helpers.c b/rust/helpers/helpers.c
index 625921e27dfb..f3562d3b3888 100644
--- a/rust/helpers/helpers.c
+++ b/rust/helpers/helpers.c
@@ -88,6 +88,7 @@
#include "signal.c"
#include "slab.c"
#include "spinlock.c"
+#include "srcu.c"
#include "sync.c"
#include "task.c"
#include "time.c"
diff --git a/rust/helpers/srcu.c b/rust/helpers/srcu.c
new file mode 100644
index 000000000000..e9f723d7f8c9
--- /dev/null
+++ b/rust/helpers/srcu.c
@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#include <linux/srcu.h>
+
+__rust_helper int rust_helper_init_srcu_struct_with_key(struct srcu_struct *ssp,
+ const char *name,
+ struct lock_class_key *key)
+{
+#ifdef CONFIG_DEBUG_LOCK_ALLOC
+ return __init_srcu_struct(ssp, name, key);
+#else /* !CONFIG_DEBUG_LOCK_ALLOC */
+ return init_srcu_struct(ssp);
+#endif /* CONFIG_DEBUG_LOCK_ALLOC */
+}
+
+__rust_helper int rust_helper_srcu_read_lock(struct srcu_struct *ssp)
+{
+ return srcu_read_lock(ssp);
+}
+
+__rust_helper void rust_helper_srcu_read_unlock(struct srcu_struct *ssp, int idx)
+{
+ srcu_read_unlock(ssp, idx);
+}
--
2.51.2
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v4 2/3] rust: sync: add SRCU abstraction
2026-05-25 17:55 [PATCH v4 0/3] rust: add SRCU abstraction Onur Özkan
2026-05-25 17:55 ` [PATCH v4 1/3] rust: helpers: add SRCU helpers Onur Özkan
@ 2026-05-25 17:55 ` Onur Özkan
2026-05-26 15:33 ` Boqun Feng
2026-05-25 17:55 ` [PATCH v4 3/3] MAINTAINERS: add Rust SRCU files to SRCU entry Onur Özkan
2 siblings, 1 reply; 6+ messages in thread
From: Onur Özkan @ 2026-05-25 17:55 UTC (permalink / raw)
To: rcu, rust-for-linux, linux-kernel
Cc: ojeda, boqun, gary, bjorn3_gh, lossin, a.hindborg, aliceryhl,
tmgross, dakr, peterz, fujita.tomonori, tamird, jiangshanlai,
paulmck, josh, rostedt, mathieu.desnoyers, Onur Özkan
Add a Rust abstraction for sleepable RCU (SRCU), backed by C srcu_struct.
Provide FFI helpers and a safe wrapper with a guard-based API for read-side
critical sections.
Cleanup is handled via `PinnedDrop`, which explicitly drains pending grace
periods and callbacks via `synchronize_srcu` and `srcu_barrier` before
executing `cleanup_srcu_struct` to guarantee memory safety e.g. when there
are leaked guards (via `mem::forget($guard)`).
Signed-off-by: Onur Özkan <work@onurozkan.dev>
---
rust/helpers/srcu.c | 10 +++
rust/kernel/sync.rs | 2 +
rust/kernel/sync/srcu.rs | 158 +++++++++++++++++++++++++++++++++++++++
3 files changed, 170 insertions(+)
create mode 100644 rust/kernel/sync/srcu.rs
diff --git a/rust/helpers/srcu.c b/rust/helpers/srcu.c
index e9f723d7f8c9..79dd24a104ef 100644
--- a/rust/helpers/srcu.c
+++ b/rust/helpers/srcu.c
@@ -22,3 +22,13 @@ __rust_helper void rust_helper_srcu_read_unlock(struct srcu_struct *ssp, int idx
{
srcu_read_unlock(ssp, idx);
}
+
+__rust_helper void rust_helper_srcu_barrier(struct srcu_struct *ssp)
+{
+ srcu_barrier(ssp);
+}
+
+__rust_helper void rust_helper_synchronize_srcu_expedited(struct srcu_struct *ssp)
+{
+ synchronize_srcu_expedited(ssp);
+}
diff --git a/rust/kernel/sync.rs b/rust/kernel/sync.rs
index 993dbf2caa0e..0d6a5f1300c3 100644
--- a/rust/kernel/sync.rs
+++ b/rust/kernel/sync.rs
@@ -21,6 +21,7 @@
pub mod rcu;
mod refcount;
mod set_once;
+pub mod srcu;
pub use arc::{Arc, ArcBorrow, UniqueArc};
pub use completion::Completion;
@@ -31,6 +32,7 @@
pub use locked_by::LockedBy;
pub use refcount::Refcount;
pub use set_once::SetOnce;
+pub use srcu::Srcu;
/// Represents a lockdep class.
///
diff --git a/rust/kernel/sync/srcu.rs b/rust/kernel/sync/srcu.rs
new file mode 100644
index 000000000000..655ecddd1320
--- /dev/null
+++ b/rust/kernel/sync/srcu.rs
@@ -0,0 +1,158 @@
+// SPDX-License-Identifier: GPL-2.0
+
+//! Sleepable read-copy update (SRCU) support.
+//!
+//! C header: [`include/linux/srcu.h`](srctree/include/linux/srcu.h)
+
+use crate::{
+ bindings,
+ error::to_result,
+ prelude::*,
+ sync::LockClassKey,
+ types::{
+ NotThreadSafe,
+ Opaque, //
+ },
+};
+
+use pin_init::pin_data;
+
+/// Creates an [`Srcu`] initialiser with the given name and a newly-created lock class.
+#[doc(hidden)]
+#[macro_export]
+macro_rules! new_srcu {
+ ($($name:literal)?) => {
+ $crate::sync::Srcu::new($crate::optional_name!($($name)?), $crate::static_lock_class!())
+ };
+}
+pub use new_srcu;
+
+/// Sleepable read-copy update primitive.
+///
+/// SRCU readers may sleep while holding the read-side guard.
+///
+/// The destructor waits for active readers and callbacks, so it may sleep.
+/// If a read-side guard has been leaked, dropping an [`Srcu`] may never return.
+///
+/// # Invariants
+///
+/// This represents a valid `struct srcu_struct` initialized by the C SRCU API
+/// and it remains pinned and valid until the pinned destructor runs.
+#[repr(transparent)]
+#[pin_data(PinnedDrop)]
+pub struct Srcu {
+ #[pin]
+ inner: Opaque<bindings::srcu_struct>,
+}
+
+impl Srcu {
+ /// Creates a new SRCU instance.
+ #[inline]
+ pub fn new(name: &'static CStr, key: Pin<&'static LockClassKey>) -> impl PinInit<Self, Error> {
+ try_pin_init!(Self {
+ // INVARIANT: On success, the C initializer creates a valid `srcu_struct` and
+ // it remains pinned until `PinnedDrop` runs.
+ inner <- Opaque::try_ffi_init(|ptr: *mut bindings::srcu_struct| {
+ // SAFETY: `ptr` points to valid uninitialised memory for a `srcu_struct`.
+ to_result(unsafe {
+ bindings::init_srcu_struct_with_key(ptr, name.as_char_ptr(), key.as_ptr())
+ })
+ }),
+ })
+ }
+
+ /// Enters an SRCU read-side critical section.
+ ///
+ /// Leaking the returned [`Guard`] leaves the SRCU read-side critical
+ /// section active and makes `drop` sleep forever.
+ #[inline]
+ pub fn read_lock(&self) -> Guard<'_> {
+ // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
+ let idx = unsafe { bindings::srcu_read_lock(self.inner.get()) };
+
+ // INVARIANT: `idx` was returned by `srcu_read_lock()` for this `Srcu`.
+ Guard {
+ srcu: self,
+ idx,
+ _not_send: NotThreadSafe,
+ }
+ }
+
+ /// Waits until all pre-existing SRCU readers have completed.
+ #[inline]
+ pub fn synchronize(&self) {
+ // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
+ unsafe { bindings::synchronize_srcu(self.inner.get()) };
+ }
+
+ /// Waits until all pre-existing SRCU readers have completed, expedited.
+ ///
+ /// This requests a lower-latency grace period than [`Srcu::synchronize`] typically
+ /// at the cost of higher system-wide overhead. Prefer [`Srcu::synchronize`] by default
+ /// and use this variant only when reducing reset or teardown latency is more important
+ /// than the extra cost.
+ #[inline]
+ pub fn synchronize_expedited(&self) {
+ // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
+ unsafe { bindings::synchronize_srcu_expedited(self.inner.get()) };
+ }
+}
+
+#[pinned_drop]
+impl PinnedDrop for Srcu {
+ fn drop(self: Pin<&mut Self>) {
+ let ptr = self.inner.get();
+
+ // `cleanup_srcu_struct()` may return early if readers are still active. Because `Srcu`
+ // owns the embedded `srcu_struct`, returning from `drop` in that state could free memory
+ // that is still referenced by the C side.
+ //
+ // Wait for all readers to complete first. If any `Guard` was leaked, `synchronize_srcu()`
+ // will sleep forever.
+ //
+ // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
+ unsafe { bindings::synchronize_srcu(ptr) };
+
+ // Ensure all SRCU callbacks have been finished before freeing.
+ // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
+ unsafe { bindings::srcu_barrier(ptr) };
+
+ // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
+ unsafe { bindings::cleanup_srcu_struct(ptr) };
+ }
+}
+
+// SAFETY: `srcu_struct` may be shared and used across threads.
+unsafe impl Send for Srcu {}
+// SAFETY: `srcu_struct` may be shared and used concurrently.
+unsafe impl Sync for Srcu {}
+
+/// Guard for an active SRCU read-side critical section on a particular [`Srcu`].
+///
+/// Leaking this guard with [`core::mem::forget`] leaves the SRCU read-side
+/// critical section active and makes dropping the associated [`Srcu`] sleep forever.
+///
+/// # Invariants
+///
+/// `idx` is the index returned by `srcu_read_lock()` for `srcu`.
+#[must_use = "if unused, the lock will be immediately unlocked"]
+pub struct Guard<'a> {
+ srcu: &'a Srcu,
+ idx: i32,
+ _not_send: NotThreadSafe,
+}
+
+impl Guard<'_> {
+ /// Explicitly releases the SRCU read-side critical section.
+ #[inline]
+ pub fn unlock(self) {}
+}
+
+impl Drop for Guard<'_> {
+ #[inline]
+ fn drop(&mut self) {
+ // SAFETY: `Guard` is only constructible through `Srcu::read_lock()`,
+ // which returns a valid index for the SRCU instance.
+ unsafe { bindings::srcu_read_unlock(self.srcu.inner.get(), self.idx) };
+ }
+}
--
2.51.2
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v4 3/3] MAINTAINERS: add Rust SRCU files to SRCU entry
2026-05-25 17:55 [PATCH v4 0/3] rust: add SRCU abstraction Onur Özkan
2026-05-25 17:55 ` [PATCH v4 1/3] rust: helpers: add SRCU helpers Onur Özkan
2026-05-25 17:55 ` [PATCH v4 2/3] rust: sync: add SRCU abstraction Onur Özkan
@ 2026-05-25 17:55 ` Onur Özkan
2 siblings, 0 replies; 6+ messages in thread
From: Onur Özkan @ 2026-05-25 17:55 UTC (permalink / raw)
To: rcu, rust-for-linux, linux-kernel
Cc: ojeda, boqun, gary, bjorn3_gh, lossin, a.hindborg, aliceryhl,
tmgross, dakr, peterz, fujita.tomonori, tamird, jiangshanlai,
paulmck, josh, rostedt, mathieu.desnoyers, Onur Özkan
Include Rust side implementation files to the SRCU maintainer
entry.
Signed-off-by: Onur Özkan <work@onurozkan.dev>
---
MAINTAINERS | 3 +++
1 file changed, 3 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index e0b307b2108c..7739a435f258 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -24624,6 +24624,7 @@ SLEEPABLE READ-COPY UPDATE (SRCU)
M: Lai Jiangshan <jiangshanlai@gmail.com>
M: "Paul E. McKenney" <paulmck@kernel.org>
M: Josh Triplett <josh@joshtriplett.org>
+M: Onur Özkan <work@onurozkan.dev> (RUST)
R: Steven Rostedt <rostedt@goodmis.org>
R: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
L: rcu@vger.kernel.org
@@ -24632,6 +24633,8 @@ W: http://www.rdrop.com/users/paulmck/RCU/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/rcu/linux.git rcu/dev
F: include/linux/srcu*.h
F: kernel/rcu/srcu*.c
+F: rust/helpers/srcu.c
+F: rust/kernel/sync/srcu.rs
SMACK SECURITY MODULE
M: Casey Schaufler <casey@schaufler-ca.com>
--
2.51.2
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v4 2/3] rust: sync: add SRCU abstraction
2026-05-25 17:55 ` [PATCH v4 2/3] rust: sync: add SRCU abstraction Onur Özkan
@ 2026-05-26 15:33 ` Boqun Feng
2026-05-27 9:00 ` Onur Özkan
0 siblings, 1 reply; 6+ messages in thread
From: Boqun Feng @ 2026-05-26 15:33 UTC (permalink / raw)
To: Onur Özkan
Cc: rcu, rust-for-linux, linux-kernel, ojeda, gary, bjorn3_gh,
lossin, a.hindborg, aliceryhl, tmgross, dakr, peterz,
fujita.tomonori, tamird, jiangshanlai, paulmck, josh, rostedt,
mathieu.desnoyers
On Mon, May 25, 2026 at 08:55:50PM +0300, Onur Özkan wrote:
> Add a Rust abstraction for sleepable RCU (SRCU), backed by C srcu_struct.
> Provide FFI helpers and a safe wrapper with a guard-based API for read-side
> critical sections.
>
> Cleanup is handled via `PinnedDrop`, which explicitly drains pending grace
> periods and callbacks via `synchronize_srcu` and `srcu_barrier` before
> executing `cleanup_srcu_struct` to guarantee memory safety e.g. when there
> are leaked guards (via `mem::forget($guard)`).
>
> Signed-off-by: Onur Özkan <work@onurozkan.dev>
> ---
> rust/helpers/srcu.c | 10 +++
> rust/kernel/sync.rs | 2 +
> rust/kernel/sync/srcu.rs | 158 +++++++++++++++++++++++++++++++++++++++
> 3 files changed, 170 insertions(+)
> create mode 100644 rust/kernel/sync/srcu.rs
>
> diff --git a/rust/helpers/srcu.c b/rust/helpers/srcu.c
> index e9f723d7f8c9..79dd24a104ef 100644
> --- a/rust/helpers/srcu.c
> +++ b/rust/helpers/srcu.c
> @@ -22,3 +22,13 @@ __rust_helper void rust_helper_srcu_read_unlock(struct srcu_struct *ssp, int idx
> {
> srcu_read_unlock(ssp, idx);
> }
> +
> +__rust_helper void rust_helper_srcu_barrier(struct srcu_struct *ssp)
> +{
> + srcu_barrier(ssp);
> +}
> +
> +__rust_helper void rust_helper_synchronize_srcu_expedited(struct srcu_struct *ssp)
> +{
> + synchronize_srcu_expedited(ssp);
> +}
> diff --git a/rust/kernel/sync.rs b/rust/kernel/sync.rs
> index 993dbf2caa0e..0d6a5f1300c3 100644
> --- a/rust/kernel/sync.rs
> +++ b/rust/kernel/sync.rs
> @@ -21,6 +21,7 @@
> pub mod rcu;
> mod refcount;
> mod set_once;
> +pub mod srcu;
>
> pub use arc::{Arc, ArcBorrow, UniqueArc};
> pub use completion::Completion;
> @@ -31,6 +32,7 @@
> pub use locked_by::LockedBy;
> pub use refcount::Refcount;
> pub use set_once::SetOnce;
> +pub use srcu::Srcu;
>
> /// Represents a lockdep class.
> ///
> diff --git a/rust/kernel/sync/srcu.rs b/rust/kernel/sync/srcu.rs
> new file mode 100644
> index 000000000000..655ecddd1320
> --- /dev/null
> +++ b/rust/kernel/sync/srcu.rs
> @@ -0,0 +1,158 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +//! Sleepable read-copy update (SRCU) support.
> +//!
> +//! C header: [`include/linux/srcu.h`](srctree/include/linux/srcu.h)
> +
> +use crate::{
> + bindings,
> + error::to_result,
> + prelude::*,
> + sync::LockClassKey,
> + types::{
> + NotThreadSafe,
> + Opaque, //
> + },
> +};
> +
> +use pin_init::pin_data;
> +
> +/// Creates an [`Srcu`] initialiser with the given name and a newly-created lock class.
> +#[doc(hidden)]
> +#[macro_export]
> +macro_rules! new_srcu {
> + ($($name:literal)?) => {
> + $crate::sync::Srcu::new($crate::optional_name!($($name)?), $crate::static_lock_class!())
> + };
> +}
> +pub use new_srcu;
> +
> +/// Sleepable read-copy update primitive.
> +///
> +/// SRCU readers may sleep while holding the read-side guard.
> +///
> +/// The destructor waits for active readers and callbacks, so it may sleep.
> +/// If a read-side guard has been leaked, dropping an [`Srcu`] may never return.
> +///
> +/// # Invariants
> +///
> +/// This represents a valid `struct srcu_struct` initialized by the C SRCU API
> +/// and it remains pinned and valid until the pinned destructor runs.
> +#[repr(transparent)]
> +#[pin_data(PinnedDrop)]
> +pub struct Srcu {
> + #[pin]
> + inner: Opaque<bindings::srcu_struct>,
> +}
> +
> +impl Srcu {
> + /// Creates a new SRCU instance.
> + #[inline]
> + pub fn new(name: &'static CStr, key: Pin<&'static LockClassKey>) -> impl PinInit<Self, Error> {
> + try_pin_init!(Self {
> + // INVARIANT: On success, the C initializer creates a valid `srcu_struct` and
> + // it remains pinned until `PinnedDrop` runs.
> + inner <- Opaque::try_ffi_init(|ptr: *mut bindings::srcu_struct| {
> + // SAFETY: `ptr` points to valid uninitialised memory for a `srcu_struct`.
> + to_result(unsafe {
> + bindings::init_srcu_struct_with_key(ptr, name.as_char_ptr(), key.as_ptr())
> + })
> + }),
> + })
> + }
> +
> + /// Enters an SRCU read-side critical section.
> + ///
> + /// Leaking the returned [`Guard`] leaves the SRCU read-side critical
> + /// section active and makes `drop` sleep forever.
> + #[inline]
> + pub fn read_lock(&self) -> Guard<'_> {
> + // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
> + let idx = unsafe { bindings::srcu_read_lock(self.inner.get()) };
> +
> + // INVARIANT: `idx` was returned by `srcu_read_lock()` for this `Srcu`.
> + Guard {
> + srcu: self,
> + idx,
> + _not_send: NotThreadSafe,
> + }
> + }
> +
> + /// Waits until all pre-existing SRCU readers have completed.
> + #[inline]
> + pub fn synchronize(&self) {
> + // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
> + unsafe { bindings::synchronize_srcu(self.inner.get()) };
> + }
> +
> + /// Waits until all pre-existing SRCU readers have completed, expedited.
> + ///
> + /// This requests a lower-latency grace period than [`Srcu::synchronize`] typically
> + /// at the cost of higher system-wide overhead. Prefer [`Srcu::synchronize`] by default
> + /// and use this variant only when reducing reset or teardown latency is more important
> + /// than the extra cost.
> + #[inline]
> + pub fn synchronize_expedited(&self) {
> + // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
> + unsafe { bindings::synchronize_srcu_expedited(self.inner.get()) };
> + }
> +}
> +
> +#[pinned_drop]
> +impl PinnedDrop for Srcu {
> + fn drop(self: Pin<&mut Self>) {
> + let ptr = self.inner.get();
> +
> + // `cleanup_srcu_struct()` may return early if readers are still active. Because `Srcu`
> + // owns the embedded `srcu_struct`, returning from `drop` in that state could free memory
> + // that is still referenced by the C side.
> + //
> + // Wait for all readers to complete first. If any `Guard` was leaked, `synchronize_srcu()`
> + // will sleep forever.
> + //
> + // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
> + unsafe { bindings::synchronize_srcu(ptr) };
Sorry for being slow on this. But I think your approach is the right one
here. However, even though this makes Srcu safe, it's still undesired if
an Srcu::drop() blocks forever *silently*. I think we should call
srcu_active_readers() here and throw a warning if a leaked `Guard` is
detected.
The rest of the patch set looks good to me.
Regards,
Boqun
> +
> + // Ensure all SRCU callbacks have been finished before freeing.
> + // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
> + unsafe { bindings::srcu_barrier(ptr) };
> +
> + // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
> + unsafe { bindings::cleanup_srcu_struct(ptr) };
> + }
> +}
> +
> +// SAFETY: `srcu_struct` may be shared and used across threads.
> +unsafe impl Send for Srcu {}
> +// SAFETY: `srcu_struct` may be shared and used concurrently.
> +unsafe impl Sync for Srcu {}
> +
> +/// Guard for an active SRCU read-side critical section on a particular [`Srcu`].
> +///
> +/// Leaking this guard with [`core::mem::forget`] leaves the SRCU read-side
> +/// critical section active and makes dropping the associated [`Srcu`] sleep forever.
> +///
> +/// # Invariants
> +///
> +/// `idx` is the index returned by `srcu_read_lock()` for `srcu`.
> +#[must_use = "if unused, the lock will be immediately unlocked"]
> +pub struct Guard<'a> {
> + srcu: &'a Srcu,
> + idx: i32,
> + _not_send: NotThreadSafe,
> +}
> +
> +impl Guard<'_> {
> + /// Explicitly releases the SRCU read-side critical section.
> + #[inline]
> + pub fn unlock(self) {}
> +}
> +
> +impl Drop for Guard<'_> {
> + #[inline]
> + fn drop(&mut self) {
> + // SAFETY: `Guard` is only constructible through `Srcu::read_lock()`,
> + // which returns a valid index for the SRCU instance.
> + unsafe { bindings::srcu_read_unlock(self.srcu.inner.get(), self.idx) };
> + }
> +}
> --
> 2.51.2
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v4 2/3] rust: sync: add SRCU abstraction
2026-05-26 15:33 ` Boqun Feng
@ 2026-05-27 9:00 ` Onur Özkan
0 siblings, 0 replies; 6+ messages in thread
From: Onur Özkan @ 2026-05-27 9:00 UTC (permalink / raw)
To: Boqun Feng
Cc: rcu, rust-for-linux, linux-kernel, ojeda, gary, bjorn3_gh,
lossin, a.hindborg, aliceryhl, tmgross, dakr, peterz,
fujita.tomonori, tamird, jiangshanlai, paulmck, josh, rostedt,
mathieu.desnoyers
On Tue, 26 May 2026 08:33:58 -0700
Boqun Feng <boqun@kernel.org> wrote:
> On Mon, May 25, 2026 at 08:55:50PM +0300, Onur Özkan wrote:
> > Add a Rust abstraction for sleepable RCU (SRCU), backed by C srcu_struct.
> > Provide FFI helpers and a safe wrapper with a guard-based API for read-side
> > critical sections.
> >
> > Cleanup is handled via `PinnedDrop`, which explicitly drains pending grace
> > periods and callbacks via `synchronize_srcu` and `srcu_barrier` before
> > executing `cleanup_srcu_struct` to guarantee memory safety e.g. when there
> > are leaked guards (via `mem::forget($guard)`).
> >
> > Signed-off-by: Onur Özkan <work@onurozkan.dev>
> > ---
> > rust/helpers/srcu.c | 10 +++
> > rust/kernel/sync.rs | 2 +
> > rust/kernel/sync/srcu.rs | 158 +++++++++++++++++++++++++++++++++++++++
> > 3 files changed, 170 insertions(+)
> > create mode 100644 rust/kernel/sync/srcu.rs
> >
> > diff --git a/rust/helpers/srcu.c b/rust/helpers/srcu.c
> > index e9f723d7f8c9..79dd24a104ef 100644
> > --- a/rust/helpers/srcu.c
> > +++ b/rust/helpers/srcu.c
> > @@ -22,3 +22,13 @@ __rust_helper void rust_helper_srcu_read_unlock(struct srcu_struct *ssp, int idx
> > {
> > srcu_read_unlock(ssp, idx);
> > }
> > +
> > +__rust_helper void rust_helper_srcu_barrier(struct srcu_struct *ssp)
> > +{
> > + srcu_barrier(ssp);
> > +}
> > +
> > +__rust_helper void rust_helper_synchronize_srcu_expedited(struct srcu_struct *ssp)
> > +{
> > + synchronize_srcu_expedited(ssp);
> > +}
> > diff --git a/rust/kernel/sync.rs b/rust/kernel/sync.rs
> > index 993dbf2caa0e..0d6a5f1300c3 100644
> > --- a/rust/kernel/sync.rs
> > +++ b/rust/kernel/sync.rs
> > @@ -21,6 +21,7 @@
> > pub mod rcu;
> > mod refcount;
> > mod set_once;
> > +pub mod srcu;
> >
> > pub use arc::{Arc, ArcBorrow, UniqueArc};
> > pub use completion::Completion;
> > @@ -31,6 +32,7 @@
> > pub use locked_by::LockedBy;
> > pub use refcount::Refcount;
> > pub use set_once::SetOnce;
> > +pub use srcu::Srcu;
> >
> > /// Represents a lockdep class.
> > ///
> > diff --git a/rust/kernel/sync/srcu.rs b/rust/kernel/sync/srcu.rs
> > new file mode 100644
> > index 000000000000..655ecddd1320
> > --- /dev/null
> > +++ b/rust/kernel/sync/srcu.rs
> > @@ -0,0 +1,158 @@
> > +// SPDX-License-Identifier: GPL-2.0
> > +
> > +//! Sleepable read-copy update (SRCU) support.
> > +//!
> > +//! C header: [`include/linux/srcu.h`](srctree/include/linux/srcu.h)
> > +
> > +use crate::{
> > + bindings,
> > + error::to_result,
> > + prelude::*,
> > + sync::LockClassKey,
> > + types::{
> > + NotThreadSafe,
> > + Opaque, //
> > + },
> > +};
> > +
> > +use pin_init::pin_data;
> > +
> > +/// Creates an [`Srcu`] initialiser with the given name and a newly-created lock class.
> > +#[doc(hidden)]
> > +#[macro_export]
> > +macro_rules! new_srcu {
> > + ($($name:literal)?) => {
> > + $crate::sync::Srcu::new($crate::optional_name!($($name)?), $crate::static_lock_class!())
> > + };
> > +}
> > +pub use new_srcu;
> > +
> > +/// Sleepable read-copy update primitive.
> > +///
> > +/// SRCU readers may sleep while holding the read-side guard.
> > +///
> > +/// The destructor waits for active readers and callbacks, so it may sleep.
> > +/// If a read-side guard has been leaked, dropping an [`Srcu`] may never return.
> > +///
> > +/// # Invariants
> > +///
> > +/// This represents a valid `struct srcu_struct` initialized by the C SRCU API
> > +/// and it remains pinned and valid until the pinned destructor runs.
> > +#[repr(transparent)]
> > +#[pin_data(PinnedDrop)]
> > +pub struct Srcu {
> > + #[pin]
> > + inner: Opaque<bindings::srcu_struct>,
> > +}
> > +
> > +impl Srcu {
> > + /// Creates a new SRCU instance.
> > + #[inline]
> > + pub fn new(name: &'static CStr, key: Pin<&'static LockClassKey>) -> impl PinInit<Self, Error> {
> > + try_pin_init!(Self {
> > + // INVARIANT: On success, the C initializer creates a valid `srcu_struct` and
> > + // it remains pinned until `PinnedDrop` runs.
> > + inner <- Opaque::try_ffi_init(|ptr: *mut bindings::srcu_struct| {
> > + // SAFETY: `ptr` points to valid uninitialised memory for a `srcu_struct`.
> > + to_result(unsafe {
> > + bindings::init_srcu_struct_with_key(ptr, name.as_char_ptr(), key.as_ptr())
> > + })
> > + }),
> > + })
> > + }
> > +
> > + /// Enters an SRCU read-side critical section.
> > + ///
> > + /// Leaking the returned [`Guard`] leaves the SRCU read-side critical
> > + /// section active and makes `drop` sleep forever.
> > + #[inline]
> > + pub fn read_lock(&self) -> Guard<'_> {
> > + // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
> > + let idx = unsafe { bindings::srcu_read_lock(self.inner.get()) };
> > +
> > + // INVARIANT: `idx` was returned by `srcu_read_lock()` for this `Srcu`.
> > + Guard {
> > + srcu: self,
> > + idx,
> > + _not_send: NotThreadSafe,
> > + }
> > + }
> > +
> > + /// Waits until all pre-existing SRCU readers have completed.
> > + #[inline]
> > + pub fn synchronize(&self) {
> > + // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
> > + unsafe { bindings::synchronize_srcu(self.inner.get()) };
> > + }
> > +
> > + /// Waits until all pre-existing SRCU readers have completed, expedited.
> > + ///
> > + /// This requests a lower-latency grace period than [`Srcu::synchronize`] typically
> > + /// at the cost of higher system-wide overhead. Prefer [`Srcu::synchronize`] by default
> > + /// and use this variant only when reducing reset or teardown latency is more important
> > + /// than the extra cost.
> > + #[inline]
> > + pub fn synchronize_expedited(&self) {
> > + // SAFETY: By the type invariants, `self` contains a valid `struct srcu_struct`.
> > + unsafe { bindings::synchronize_srcu_expedited(self.inner.get()) };
> > + }
> > +}
> > +
> > +#[pinned_drop]
> > +impl PinnedDrop for Srcu {
> > + fn drop(self: Pin<&mut Self>) {
> > + let ptr = self.inner.get();
> > +
> > + // `cleanup_srcu_struct()` may return early if readers are still active. Because `Srcu`
> > + // owns the embedded `srcu_struct`, returning from `drop` in that state could free memory
> > + // that is still referenced by the C side.
> > + //
> > + // Wait for all readers to complete first. If any `Guard` was leaked, `synchronize_srcu()`
> > + // will sleep forever.
> > + //
> > + // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
> > + unsafe { bindings::synchronize_srcu(ptr) };
>
> Sorry for being slow on this. But I think your approach is the right one
> here. However, even though this makes Srcu safe, it's still undesired if
> an Srcu::drop() blocks forever *silently*. I think we should call
> srcu_active_readers() here and throw a warning if a leaked `Guard` is
> detected.
Sure, makes sense. I will send another version with this change.
Thanks,
Onur
>
> The rest of the patch set looks good to me.
>
> Regards,
> Boqun
>
> > +
> > + // Ensure all SRCU callbacks have been finished before freeing.
> > + // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
> > + unsafe { bindings::srcu_barrier(ptr) };
> > +
> > + // SAFETY: By the type invariants, `self` contains a valid and pinned `struct srcu_struct`.
> > + unsafe { bindings::cleanup_srcu_struct(ptr) };
> > + }
> > +}
> > +
> > +// SAFETY: `srcu_struct` may be shared and used across threads.
> > +unsafe impl Send for Srcu {}
> > +// SAFETY: `srcu_struct` may be shared and used concurrently.
> > +unsafe impl Sync for Srcu {}
> > +
> > +/// Guard for an active SRCU read-side critical section on a particular [`Srcu`].
> > +///
> > +/// Leaking this guard with [`core::mem::forget`] leaves the SRCU read-side
> > +/// critical section active and makes dropping the associated [`Srcu`] sleep forever.
> > +///
> > +/// # Invariants
> > +///
> > +/// `idx` is the index returned by `srcu_read_lock()` for `srcu`.
> > +#[must_use = "if unused, the lock will be immediately unlocked"]
> > +pub struct Guard<'a> {
> > + srcu: &'a Srcu,
> > + idx: i32,
> > + _not_send: NotThreadSafe,
> > +}
> > +
> > +impl Guard<'_> {
> > + /// Explicitly releases the SRCU read-side critical section.
> > + #[inline]
> > + pub fn unlock(self) {}
> > +}
> > +
> > +impl Drop for Guard<'_> {
> > + #[inline]
> > + fn drop(&mut self) {
> > + // SAFETY: `Guard` is only constructible through `Srcu::read_lock()`,
> > + // which returns a valid index for the SRCU instance.
> > + unsafe { bindings::srcu_read_unlock(self.srcu.inner.get(), self.idx) };
> > + }
> > +}
> > --
> > 2.51.2
> >
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2026-05-27 9:00 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-05-25 17:55 [PATCH v4 0/3] rust: add SRCU abstraction Onur Özkan
2026-05-25 17:55 ` [PATCH v4 1/3] rust: helpers: add SRCU helpers Onur Özkan
2026-05-25 17:55 ` [PATCH v4 2/3] rust: sync: add SRCU abstraction Onur Özkan
2026-05-26 15:33 ` Boqun Feng
2026-05-27 9:00 ` Onur Özkan
2026-05-25 17:55 ` [PATCH v4 3/3] MAINTAINERS: add Rust SRCU files to SRCU entry Onur Özkan
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®