From nobody Thu Oct 31 00:22:47 2024 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7004C161901 for ; Mon, 16 Sep 2024 21:30:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726522260; cv=none; b=NFnGzRjqHNx3a8f1NJfBAfr5YYNIH9C/DL+6Tcw82osXB9v3vjCiAgVcjxeCntdSDH5jQm+DTi4Jm0ldkdRD6F43TQ8siCJk1gKQDTIPE7z03hj44vgyvh00wezHSYXCw54zANlDFIfsrE4OsGps2rJ717HiLud6NGwEIeIhhbY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726522260; c=relaxed/simple; bh=DxfwT1900XZXuYGlBv1oxtMMt5z2k8aI1dGfwNKmF/A=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ERmdgKQZNR1p8IZYunEuISEKWeghjhLZI6MjaKFwm0L0ry9bGmytOKX0T1jaMoS1Yzn+KIikgxKCv1TwiFDw2AchHb9hpO6Vw3TtWK8ZeF7GQ/vmWbjPxQLXe5URYeZKH5LVYbQwYnCSxXxUO66p3s6kgE4jslXGB7Gu0zIz598= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=cryZY1Ao; arc=none smtp.client-ip=170.10.129.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="cryZY1Ao" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726522257; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=m8JtzXJd3Q6A2pTo2LhqKWBKCG8VcunU698ubws6Z9E=; b=cryZY1AoumzI2JnV+PiNchKIotRB4pGAM6T+nKshtzsRQEuOygZP04tZQC787NJEUdqyR2 o6mU+avx5qolCzR2jperPe46/PiDIImau3iU5W9Uuj4HSUt21FyzNduNVC5bF/7s3Y66rq +ftvY3ivll/sEKnhihPpQ1OXR5dL2Eo= Received: from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-649-VXhoRwXlPiKHNzlzJRhKIA-1; Mon, 16 Sep 2024 17:30:54 -0400 X-MC-Unique: VXhoRwXlPiKHNzlzJRhKIA-1 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 4BDE419560B5; Mon, 16 Sep 2024 21:30:51 +0000 (UTC) Received: from chopper.redhat.com (unknown [10.22.33.131]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A4A7019560AF; Mon, 16 Sep 2024 21:30:46 +0000 (UTC) From: Lyude Paul To: rust-for-linux@vger.kernel.org Cc: Danilo Krummrich , airlied@redhat.com, Ingo Molnar , Will Deacon , Waiman Long , Peter Zijlstra , Thomas Gleixner , linux-kernel@vger.kernel.org, Benno Lossin , Daniel Almeida , Gary Guo , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Andreas Hindborg , Alice Ryhl , Trevor Gross , FUJITA Tomonori , Valentin Obst Subject: [PATCH v6 1/3] rust: Introduce irq module Date: Mon, 16 Sep 2024 17:28:04 -0400 Message-ID: <20240916213025.477225-2-lyude@redhat.com> In-Reply-To: <20240916213025.477225-1-lyude@redhat.com> References: <20240916213025.477225-1-lyude@redhat.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Content-Type: text/plain; charset="utf-8" This introduces a module for dealing with interrupt-disabled contexts, including the ability to enable and disable interrupts (with_irqs_disabled()) - along with the ability to annotate functions as expecting that IRQs are already disabled on the local CPU. Signed-off-by: Lyude Paul Reviewed-by: Benno Lossin Reviewed-by: Daniel Almeida Reviewed-by: Gary Guo Reviewed-by: Boqun Feng Reviewed-by: Trevor Gross --- V2: * Actually make it so that we check whether or not we have interrupts disabled with debug assertions * Fix issues in the documentation (added suggestions, missing periods, made sure that all rustdoc examples compile properly) * Pass IrqDisabled by value, not reference * Ensure that IrqDisabled is !Send and !Sync using PhantomData<(&'a (), *mut ())> * Add all of the suggested derives from Benno Lossin V3: * Use `impl` for FnOnce bounds in with_irqs_disabled() * Use higher-ranked trait bounds for the lifetime of with_irqs_disabled() * Wording changes in the documentation for the module itself V4: * Use the actual unsafe constructor for IrqDisabled in with_irqs_disabled() * Fix comment style in with_irqs_disabled example * Check before calling local_irq_restore() in with_irqs_disabled that interrupts are still disabled. It would have been nice to do this from a Drop implementation like I hoped, but I realized rust doesn't allow that for types that implement Copy. * Document that interrupts can't be re-enabled within the `cb` provided to `with_irqs_disabled`, and link to the github issue I just filed about this that describes the solution for this. V5: * Rebase against rust-next for the helpers split * Fix typo (enabled -> disabled) - Dirk V6: * s/indicate/require/ in IrqDisabled docs * Reword comment above with_irqs_disabled in code example requested by Benno * Add paragraph to with_irqs_disabled docs requested by Benno * Apply the comments from Boqun's review for V4 that I missed * Document type invariants of `IrqDisabled` This patch depends on https://lore.kernel.org/rust-for-linux/ZuKNszXSw-LbgW1e@boqun-archlinux/ --- rust/helpers/helpers.c | 1 + rust/helpers/irq.c | 22 ++++++++++ rust/kernel/irq.rs | 96 ++++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 4 files changed, 120 insertions(+) create mode 100644 rust/helpers/irq.c create mode 100644 rust/kernel/irq.rs diff --git a/rust/helpers/helpers.c b/rust/helpers/helpers.c index 30f40149f3a96..0bb48df454bd8 100644 --- a/rust/helpers/helpers.c +++ b/rust/helpers/helpers.c @@ -12,6 +12,7 @@ #include "build_assert.c" #include "build_bug.c" #include "err.c" +#include "irq.c" #include "kunit.c" #include "mutex.c" #include "page.c" diff --git a/rust/helpers/irq.c b/rust/helpers/irq.c new file mode 100644 index 0000000000000..ec1e8d700a220 --- /dev/null +++ b/rust/helpers/irq.c @@ -0,0 +1,22 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include + +unsigned long rust_helper_local_irq_save(void) +{ + unsigned long flags; + + local_irq_save(flags); + + return flags; +} + +void rust_helper_local_irq_restore(unsigned long flags) +{ + local_irq_restore(flags); +} + +bool rust_helper_irqs_disabled(void) +{ + return irqs_disabled(); +} diff --git a/rust/kernel/irq.rs b/rust/kernel/irq.rs new file mode 100644 index 0000000000000..ee3a4549aa389 --- /dev/null +++ b/rust/kernel/irq.rs @@ -0,0 +1,96 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Interrupt controls +//! +//! This module allows Rust code to control processor interrupts. [`with_i= rqs_disabled()`] may be +//! used for nested disables of interrupts, whereas [`IrqDisabled`] can be= used for annotating code +//! that requires interrupts to be disabled. + +use bindings; +use core::marker::*; +use crate::types::NotThreadSafe; + +/// A token that is only available in contexts where IRQs are disabled. +/// +/// [`IrqDisabled`] is marker made available when interrupts are not activ= e. Certain functions take +/// an [`IrqDisabled`] in order to require that they may only be run in IR= Q-free contexts. +/// +/// This is a marker type; it has no size, and is simply used as a compile= -time guarantee that +/// interrupts are disabled where required. +/// +/// This token can be created by [`with_irqs_disabled`]. See [`with_irqs_d= isabled`] for examples and +/// further information. +/// +/// # Invariants +/// +/// IRQs are disabled when an object of this type exists. +#[derive(Copy, Clone, Debug, Ord, Eq, PartialOrd, PartialEq, Hash)] +pub struct IrqDisabled<'a>(PhantomData<(&'a (), NotThreadSafe)>); + +impl IrqDisabled<'_> { + /// Create a new [`IrqDisabled`] token in an interrupt disabled contex= t. + /// + /// This creates an [`IrqDisabled`] token, which can be passed to func= tions that must be run + /// without interrupts. If debug assertions are enabled, this function= will assert that + /// interrupts are disabled upon creation. Otherwise, it has no size o= r cost at runtime. + /// + /// # Panics + /// + /// If debug assertions are enabled, this function will panic if inter= rupts are not disabled + /// upon creation. + /// + /// # Safety + /// + /// This function must only be called in contexts where it is already = known that interrupts have + /// been disabled for the current CPU, and the user is making a promis= e that they will remain + /// disabled at least until this [`IrqDisabled`] is dropped. + pub unsafe fn new() -> Self { + // SAFETY: FFI call with no special requirements + debug_assert!(unsafe { bindings::irqs_disabled() }); + + // INVARIANT: The safety requirements of this function ensure that= IRQs are disabled. + Self(PhantomData) + } +} + +/// Run the closure `cb` with interrupts disabled on the local CPU. +/// +/// This disables interrupts, creates an [`IrqDisabled`] token and passes = it to `cb`. The previous +/// interrupt state will be restored once the closure completes. Note that= interrupts must be +/// disabled for the entire duration of `cb`, they cannot be re-enabled. I= n the future, this may be +/// expanded on [as documented here](https://github.com/Rust-for-Linux/lin= ux/issues/1115). +/// +/// # Examples +/// +/// Using [`with_irqs_disabled`] to call a function that can only be calle= d with interrupts +/// disabled: +/// +/// ``` +/// use kernel::irq::{IrqDisabled, with_irqs_disabled}; +/// +/// // Requiring interrupts be disabled to call a function +/// fn dont_interrupt_me(_irq: IrqDisabled<'_>) { +/// // When this token is available, IRQs are known to be disabled. Ac= tions that rely on this +/// // can be safely performed +/// } +/// +/// // Disables interrupts, their previous state will be restored once the= closure completes. +/// with_irqs_disabled(|irq| dont_interrupt_me(irq)); +/// ``` +#[inline] +pub fn with_irqs_disabled(cb: impl for<'a> FnOnce(IrqDisabled<'a>) -> T= ) -> T { + // SAFETY: FFI call with no special requirements + let flags =3D unsafe { bindings::local_irq_save() }; + + // SAFETY: We just disabled IRQs using `local_irq_save()` + let ret =3D cb(unsafe { IrqDisabled::new() }); + + // Confirm that IRQs are still disabled now that the callback has fini= shed + // SAFETY: FFI call with no special requirements + debug_assert!(unsafe { bindings::irqs_disabled() }); + + // SAFETY: `flags` comes from our previous call to local_irq_save + unsafe { bindings::local_irq_restore(flags) }; + + ret +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index f10b06a78b9d5..df10c58e95c19 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -36,6 +36,7 @@ pub mod firmware; pub mod init; pub mod ioctl; +pub mod irq; #[cfg(CONFIG_KUNIT)] pub mod kunit; pub mod list; --=20 2.46.0 From nobody Thu Oct 31 00:22:47 2024 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 917F9188584 for ; Mon, 16 Sep 2024 21:31:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726522267; cv=none; b=uwjpKw9YFQS8EEypqYF10Fy6HBkM9XG+F0QVPjTq23MI5diS5H8Fp3/7F3qxdqe/j1NBhRTWdEmcVrFJ9+CD1RXdgJCRRSFQEg0HCwnpHr5yBdMXWVEibdwEJd00VQPyKLDnkTbPZQULAi4UNMXyN1lwAiMr+DHlr78xL6f7Va0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726522267; c=relaxed/simple; bh=TfZJbpp9zXEoa+e6StsgG5WDca0qXx/l5uqKk5O50pI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=mLkIRyCgc2Zwd7vSLR/m4l/z9JkrfVHbN0XvwatVTyl2w4XSd8zNsPlBXkhyKjBMnkdQpHIexd1v6pmnl7YCUzk+vYUKjeC8PSVBJhs5pxnnNCZ/GQqahO5HGk4FXAQC3hLJUj0UyB7jCxr9NeME11IpWaiGk6+XSfQayYSk9Ow= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=bqKIMF1U; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="bqKIMF1U" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726522263; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ecVEOyaTeumZAX2Umi7O9C03HHNMLFdbxAe12DFyqkw=; b=bqKIMF1UIeCP1hfZbMys+wcbS7d6Z+qpfyE6Ox8W7B62h/udwcCyD/P3oxh8wWpAQrXORf +5PHGTH53tOKsyj5ftiqNDB+b/PTODAgrf/ZUeSo1XzF9xwVFllv8jHLo0Uf1JmyawbYDf c58tXqTiB5Kl4AMUYHEenz3V4RhNDHU= Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-450-wA-_0SKgO32ivfU7vDK4CQ-1; Mon, 16 Sep 2024 17:31:00 -0400 X-MC-Unique: wA-_0SKgO32ivfU7vDK4CQ-1 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5F5AA195608C; Mon, 16 Sep 2024 21:30:57 +0000 (UTC) Received: from chopper.redhat.com (unknown [10.22.33.131]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id C723F19560AA; Mon, 16 Sep 2024 21:30:52 +0000 (UTC) From: Lyude Paul To: rust-for-linux@vger.kernel.org Cc: Danilo Krummrich , airlied@redhat.com, Ingo Molnar , Will Deacon , Waiman Long , Peter Zijlstra , Thomas Gleixner , linux-kernel@vger.kernel.org, Benno Lossin , Daniel Almeida , Gary Guo , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Andreas Hindborg , Alice Ryhl , Trevor Gross , Martin Rodriguez Reboredo , Valentin Obst Subject: [PATCH v6 2/3] rust: sync: Introduce lock::Backend::Context Date: Mon, 16 Sep 2024 17:28:05 -0400 Message-ID: <20240916213025.477225-3-lyude@redhat.com> In-Reply-To: <20240916213025.477225-1-lyude@redhat.com> References: <20240916213025.477225-1-lyude@redhat.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Content-Type: text/plain; charset="utf-8" Now that we've introduced an `IrqDisabled` token for marking contexts in which IRQs are disabled, we need a way to be able to pass it to locks that require that IRQs are disabled. In order to continue using the `lock::Backend` type instead of inventing our own thing, we accomplish this by adding the associated Context type, along with a `lock_with()` function that can accept a Context when acquiring a lock. To allow current users of context-less locks to keep using the normal `lock()` method, we take an example from Wedson Almeida Filho's work and add a `where T<'a>: Default` bound to `lock()` so that it can only be called on lock types where the context is simply a placeholder value, then re-implement it through the new `lock_with()` function. Signed-off-by: Lyude Paul Reviewed-by: Benno Lossin Reviewed-by: Daniel Almeida Reviewed-by: Gary Guo Reviewed-by: Boqun Feng Reviewed-by: Trevor Gross --- V3: * Use explicit lifetimes in lock_with() to ensure self and _context have the same lifetime (Benno) * Use () for locks that don't need a Context instead of PhantomData (Benno) V4: * Fix typo (Dirk) --- rust/kernel/sync/lock.rs | 17 +++++++++++++++-- rust/kernel/sync/lock/mutex.rs | 1 + rust/kernel/sync/lock/spinlock.rs | 1 + 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/rust/kernel/sync/lock.rs b/rust/kernel/sync/lock.rs index d6e9bab114b87..cc39a3dc3f20b 100644 --- a/rust/kernel/sync/lock.rs +++ b/rust/kernel/sync/lock.rs @@ -43,6 +43,9 @@ pub unsafe trait Backend { /// [`unlock`]: Backend::unlock type GuardState; =20 + /// The context which must be provided to acquire the lock. + type Context<'a>; + /// Initialises the lock. /// /// # Safety @@ -125,14 +128,24 @@ pub fn new(t: T, name: &'static CStr, key: &'static L= ockClassKey) -> impl PinIni } =20 impl Lock { - /// Acquires the lock and gives the caller access to the data protecte= d by it. - pub fn lock(&self) -> Guard<'_, T, B> { + /// Acquires the lock with the given context and gives the caller acce= ss to the data protected + /// by it. + pub fn lock_with<'a>(&'a self, _context: B::Context<'a>) -> Guard<'a, = T, B> { // SAFETY: The constructor of the type calls `init`, so the existe= nce of the object proves // that `init` was called. let state =3D unsafe { B::lock(self.state.get()) }; // SAFETY: The lock was just acquired. unsafe { Guard::new(self, state) } } + + /// Acquires the lock and gives the caller access to the data protecte= d by it. + #[inline] + pub fn lock<'a>(&'a self) -> Guard<'a, T, B> + where + B::Context<'a>: Default, + { + self.lock_with(B::Context::default()) + } } =20 /// A lock guard. diff --git a/rust/kernel/sync/lock/mutex.rs b/rust/kernel/sync/lock/mutex.rs index 30632070ee670..7c2c239944931 100644 --- a/rust/kernel/sync/lock/mutex.rs +++ b/rust/kernel/sync/lock/mutex.rs @@ -93,6 +93,7 @@ macro_rules! new_mutex { unsafe impl super::Backend for MutexBackend { type State =3D bindings::mutex; type GuardState =3D (); + type Context<'a> =3D (); =20 unsafe fn init( ptr: *mut Self::State, diff --git a/rust/kernel/sync/lock/spinlock.rs b/rust/kernel/sync/lock/spin= lock.rs index ea5c5bc1ce12e..97d85a5576615 100644 --- a/rust/kernel/sync/lock/spinlock.rs +++ b/rust/kernel/sync/lock/spinlock.rs @@ -92,6 +92,7 @@ macro_rules! new_spinlock { unsafe impl super::Backend for SpinLockBackend { type State =3D bindings::spinlock_t; type GuardState =3D (); + type Context<'a> =3D (); =20 unsafe fn init( ptr: *mut Self::State, --=20 2.46.0 From nobody Thu Oct 31 00:22:47 2024 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 475BC188584 for ; Mon, 16 Sep 2024 21:31:11 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726522273; cv=none; b=HNzSh5nOGRUSPM0ix2yNG83g0iFmpFnljcBODZzi1gjps2aLd6986hZhVGOUgCdusAn5dwTzjxZGPsBmAAfh8AO+yNoUZjgvZdGoYR+e1dOA58EQBlDb8M/PfK0tIclDGFs0j1ackcW6tlqf2K+wJ4hUgytogI0QWDdWqriPYCM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726522273; c=relaxed/simple; bh=J+Kj5kWHLs8eu489PKMmCyDBzk9cLXe8MqLBnhAzMxY=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=B7XbPtYTmxIwIwadD1QcNnWwHe7VzeyDqUK+5iuCUAz0GrdV64j4QZLCbSDmMqf7dHQqjH0DoW3qPM+la0tUf0TjlrFDcFnA2bQ9TeDZ+Z2I+fjVNfXfGMcKPkJbI8ZhGY7Ef37wmuQ3o1Y+3Xx4dZx8ltp7IEaKF0bXSs9FiE8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=Nq8HVv43; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Nq8HVv43" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726522270; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=8oIvdAsWFPJzZrabfZBBzhpeBee144e8PLeqisrxPnQ=; b=Nq8HVv43RBaWeJkSvbfWJeNWf+jZdW9aLgIQjuU0+JU2sIQJYqy1dMgzAztvj/atNxVkux un10OprsTpccay3VHAI+KyoXwFoKayqgXfVprLFB9d0Vo+PcSYbTmAyJyxSZLtomF1jQ4Y NrG2os9tZB8+xOqFkQnMU+XY8IswRFY= Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-324-ZueokHCwNm2jw6RfDptEbA-1; Mon, 16 Sep 2024 17:31:05 -0400 X-MC-Unique: ZueokHCwNm2jw6RfDptEbA-1 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A9AAC1955DCC; Mon, 16 Sep 2024 21:31:02 +0000 (UTC) Received: from chopper.redhat.com (unknown [10.22.33.131]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 8484619560AF; Mon, 16 Sep 2024 21:30:58 +0000 (UTC) From: Lyude Paul To: rust-for-linux@vger.kernel.org Cc: Danilo Krummrich , airlied@redhat.com, Ingo Molnar , Will Deacon , Waiman Long , Peter Zijlstra , Thomas Gleixner , linux-kernel@vger.kernel.org, Benno Lossin , Daniel Almeida , Gary Guo , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Andreas Hindborg , Alice Ryhl , Trevor Gross , Martin Rodriguez Reboredo , Valentin Obst Subject: [PATCH v6 3/3] rust: sync: Add SpinLockIrq Date: Mon, 16 Sep 2024 17:28:06 -0400 Message-ID: <20240916213025.477225-4-lyude@redhat.com> In-Reply-To: <20240916213025.477225-1-lyude@redhat.com> References: <20240916213025.477225-1-lyude@redhat.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Content-Type: text/plain; charset="utf-8" A variant of SpinLock that is expected to be used in noirq contexts, and thus requires that the user provide an kernel::irq::IrqDisabled to prove they are in such a context upon lock acquisition. This is the rust equivalent of spin_lock_irqsave()/spin_lock_irqrestore(). Signed-off-by: Lyude Paul Reviewed-by: Benno Lossin Reviewed-by: Daniel Almeida Reviewed-by: Gary Guo Reviewed-by: Boqun Feng Reviewed-by: Trevor Gross --- V2: * s/IrqSpinLock/SpinLockIrq/ * Implement `lock::Backend` now that we have `Context` * Add missing periods * Make sure rustdoc examples compile correctly * Add documentation suggestions --- rust/kernel/sync.rs | 2 +- rust/kernel/sync/lock/spinlock.rs | 104 ++++++++++++++++++++++++++++++ 2 files changed, 105 insertions(+), 1 deletion(-) diff --git a/rust/kernel/sync.rs b/rust/kernel/sync.rs index 0ab20975a3b5d..b028ee325f2a6 100644 --- a/rust/kernel/sync.rs +++ b/rust/kernel/sync.rs @@ -15,7 +15,7 @@ pub use arc::{Arc, ArcBorrow, UniqueArc}; pub use condvar::{new_condvar, CondVar, CondVarTimeoutResult}; pub use lock::mutex::{new_mutex, Mutex}; -pub use lock::spinlock::{new_spinlock, SpinLock}; +pub use lock::spinlock::{new_spinlock, new_spinlock_irq, SpinLock, SpinLoc= kIrq}; pub use locked_by::LockedBy; =20 /// Represents a lockdep class. It's a wrapper around C's `lock_class_key`. diff --git a/rust/kernel/sync/lock/spinlock.rs b/rust/kernel/sync/lock/spin= lock.rs index 97d85a5576615..47c71d779062a 100644 --- a/rust/kernel/sync/lock/spinlock.rs +++ b/rust/kernel/sync/lock/spinlock.rs @@ -3,6 +3,7 @@ //! A kernel spinlock. //! //! This module allows Rust code to use the kernel's `spinlock_t`. +use kernel::irq::*; =20 /// Creates a [`SpinLock`] initialiser with the given name and a newly-cre= ated lock class. /// @@ -116,3 +117,106 @@ unsafe fn unlock(ptr: *mut Self::State, _guard_state:= &Self::GuardState) { unsafe { bindings::spin_unlock(ptr) } } } + +/// Creates a [`SpinLockIrq`] initialiser with the given name and a newly-= created lock class. +/// +/// It uses the name if one is given, otherwise it generates one based on = the file name and line +/// number. +#[macro_export] +macro_rules! new_spinlock_irq { + ($inner:expr $(, $name:literal)? $(,)?) =3D> { + $crate::sync::SpinLockIrq::new( + $inner, $crate::optional_name!($($name)?), $crate::static_lock= _class!()) + }; +} +pub use new_spinlock_irq; + +/// A spinlock that may be acquired when interrupts are disabled. +/// +/// A version of [`SpinLock`] that can only be used in contexts where inte= rrupts for the local CPU +/// are disabled. It requires that the user acquiring the lock provide pro= of that interrupts are +/// disabled through [`IrqDisabled`]. +/// +/// For more info, see [`SpinLock`]. +/// +/// # Examples +/// +/// The following example shows how to declare, allocate initialise and ac= cess a struct (`Example`) +/// that contains an inner struct (`Inner`) that is protected by a spinloc= k. +/// +/// ``` +/// use kernel::{ +/// sync::{new_spinlock_irq, SpinLockIrq}, +/// irq::{with_irqs_disabled, IrqDisabled} +/// }; +/// +/// struct Inner { +/// a: u32, +/// b: u32, +/// } +/// +/// #[pin_data] +/// struct Example { +/// c: u32, +/// #[pin] +/// d: SpinLockIrq, +/// } +/// +/// impl Example { +/// fn new() -> impl PinInit { +/// pin_init!(Self { +/// c: 10, +/// d <- new_spinlock_irq!(Inner { a: 20, b: 30 }), +/// }) +/// } +/// } +/// +/// // Accessing an `Example` from a function that can only be called in n= o-irq contexts +/// fn noirq_work(e: &Example, irq: IrqDisabled<'_>) { +/// assert_eq!(e.c, 10); +/// assert_eq!(e.d.lock_with(irq).a, 20); +/// } +/// +/// // Allocate a boxed `Example` +/// let e =3D Box::pin_init(Example::new(), GFP_KERNEL)?; +/// +/// // Accessing an `Example` from a context where IRQs may not be disable= d already. +/// let b =3D with_irqs_disabled(|irq| { +/// noirq_work(&e, irq); +/// e.d.lock_with(irq).b +/// }); +/// assert_eq!(b, 30); +/// # Ok::<(), Error>(()) +/// ``` +pub type SpinLockIrq =3D super::Lock; + +/// A kernel `spinlock_t` lock backend that is acquired in no-irq contexts. +pub struct SpinLockIrqBackend; + +unsafe impl super::Backend for SpinLockIrqBackend { + type State =3D bindings::spinlock_t; + type GuardState =3D (); + type Context<'a> =3D IrqDisabled<'a>; + + unsafe fn init( + ptr: *mut Self::State, + name: *const core::ffi::c_char, + key: *mut bindings::lock_class_key, + ) { + // SAFETY: The safety requirements ensure that `ptr` is valid for = writes, and `name` and + // `key` are valid for read indefinitely. + unsafe { bindings::__spin_lock_init(ptr, name, key) } + } + + unsafe fn lock(ptr: *mut Self::State) -> Self::GuardState { + // SAFETY: The safety requirements of this function ensure that `p= tr` points to valid + // memory, and that it has been initialised before. + unsafe { bindings::spin_lock(ptr) } + } + + unsafe fn unlock(ptr: *mut Self::State, _guard_state: &Self::GuardStat= e) { + // SAFETY: The safety requirements of this function ensure that `p= tr` is valid and that the + // caller is the owner of the spinlock. + unsafe { bindings::spin_unlock(ptr) } + } +} --=20 2.46.0