Add C helpers and Rust wrappers for the kernel hazard pointer API, to be used by revocable and other code.
Signed-off-by: Alvin Sun <[email protected]> --- rust/bindings/bindings_helper.h | 1 + rust/helpers/hazptr.c | 13 ++++++ rust/helpers/helpers.c | 1 + rust/kernel/sync.rs | 1 + rust/kernel/sync/hazptr.rs | 91 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 107 insertions(+) diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h index 9058b09a016ec..8ace50a3dc104 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -60,6 +60,7 @@ #include <linux/file.h> #include <linux/firmware.h> #include <linux/fs.h> +#include <linux/hazptr.h> #include <linux/i2c.h> #include <linux/interrupt.h> #include <linux/io-pgtable.h> diff --git a/rust/helpers/hazptr.c b/rust/helpers/hazptr.c new file mode 100644 index 0000000000000..aa53fbcd0da1d --- /dev/null +++ b/rust/helpers/hazptr.c @@ -0,0 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include <linux/hazptr.h> + +__rust_helper void *rust_helper_hazptr_acquire(struct hazptr_ctx *ctx, void *const *addr_p) +{ + return hazptr_acquire(ctx, addr_p); +} + +__rust_helper void rust_helper_hazptr_release(struct hazptr_ctx *ctx, void *addr) +{ + hazptr_release(ctx, addr); +} diff --git a/rust/helpers/helpers.c b/rust/helpers/helpers.c index f1ac40b0bd1a4..ed8cb74d394a3 100644 --- a/rust/helpers/helpers.c +++ b/rust/helpers/helpers.c @@ -34,6 +34,7 @@ #include "err.c" #include "irq.c" #include "fs.c" +#include "hazptr.c" #include "io.c" #include "jump_label.c" #include "kunit.c" diff --git a/rust/kernel/sync.rs b/rust/kernel/sync.rs index 993dbf2caa0e3..45da761eaee05 100644 --- a/rust/kernel/sync.rs +++ b/rust/kernel/sync.rs @@ -15,6 +15,7 @@ pub mod barrier; pub mod completion; mod condvar; +pub mod hazptr; pub mod lock; mod locked_by; pub mod poll; diff --git a/rust/kernel/sync/hazptr.rs b/rust/kernel/sync/hazptr.rs new file mode 100644 index 0000000000000..f94ae45dd3d66 --- /dev/null +++ b/rust/kernel/sync/hazptr.rs @@ -0,0 +1,91 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Hazard pointer support. +//! +//! C header: [`include/linux/hazptr.h`](srctree/include/linux/hazptr.h) + +use crate::{ + bindings, + ffi::c_void, + prelude::*, + types::Opaque, // +}; +use core::{ + ops::Deref, + ptr::NonNull, // +}; + +/// Per-thread context for one hazard-pointer acquire/release pair. +#[repr(transparent)] +pub struct HazptrCtx(Opaque<bindings::hazptr_ctx>); + +impl HazptrCtx { + /// Creates a new zero-initialized context for one acquire/release pair. + #[inline] + pub const fn new() -> Self { + Self(Opaque::zeroed()) + } + + /// Get the raw pointer. + #[inline] + pub fn as_raw(self: &Pin<&mut Self>) -> *mut bindings::hazptr_ctx { + self.0.get() + } +} + +impl Default for HazptrCtx { + fn default() -> Self { + Self::new() + } +} + +/// Guard holding a hazard-pointer-protected reference. +pub struct Guard<'a, T> { + ctx: Pin<&'a mut HazptrCtx>, + ptr: NonNull<T>, +} + +impl<'a, T> Guard<'a, T> { + #[inline] + fn new(ctx: Pin<&'a mut HazptrCtx>, ptr: NonNull<T>) -> Self { + Self { ctx, ptr } + } +} + +impl<T> Deref for Guard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &T { + // SAFETY: hazptr protocol keeps the pointer valid until release. + unsafe { self.ptr.as_ref() } + } +} + +impl<T> Drop for Guard<'_, T> { + #[inline] + fn drop(&mut self) { + // SAFETY: `self.ctx` and `self.ptr` are the same as the ones used in `acquire`. + unsafe { bindings::hazptr_release(self.ctx.as_raw().cast(), self.ptr.as_ptr().cast()) }; + } +} + +/// Acquires a hazard pointer for the pointer at `addr_p` and returns a guard. +/// +/// Returns `None` if the loaded value is null. +#[inline] +pub fn acquire<'a, T>( + ctx: Pin<&'a mut HazptrCtx>, + addr_p: *const *const T, +) -> Option<Guard<'a, T>> { + // SAFETY: ctx is valid and pinned, addr_p is a valid pointer to a pointer. + let ptr = unsafe { bindings::hazptr_acquire(ctx.as_raw().cast(), addr_p.cast()) }; + NonNull::new(ptr.cast()).map(|p| Guard::new(ctx, p)) +} + +/// Waits until no slot holds `addr`. +#[inline] +pub fn synchronize(addr: usize) { + // SAFETY: addr is only compared with slot values, not dereferenced. + unsafe { bindings::hazptr_synchronize(addr as *mut c_void) }; +} -- 2.43.0
