From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E76172F39A9 for ; Wed, 5 Nov 2025 23:02:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.173 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1762383754; cv=none; b=f5Ux4rzsBMDfiHMg1ntY2+uHNfR9fEcI6QiREoyDcyb24ft6G4+xGCrwxeQWpQUkZ2jEpwOmazBEqrwpvPEmR+wNoZKwTon26ueWZIqK6owRlGLSP88eQWweNJGt0R6QTwSLCRcwjfQV2oJRsxojiETp/NC6z9LqC3GOSxJzsvw= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1762383754; c=relaxed/simple; bh=EZGO8S2GHg8ntWACzHd3jQtK+CxASeBX96N1M29X+1M=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=hTlk8S3k51PopUnPOK3WkuY8PVXsGiWUeAba6DfWrX+PVz2S2Ytbnd4jHt5sRvsyo0T1059v9+I6GPXnJ/4/MRf0ivH/NaVUJ4sx357Omi8dF6KnvRAWvPBXg0Qc7xhOTf5b94yOPIKWHMlWGe2ddBF+p9pMufI0lvy8rvOoS3g= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=RxUeG2Ec; arc=none smtp.client-ip=209.85.214.173 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="RxUeG2Ec" Received: by mail-pl1-f173.google.com with SMTP id d9443c01a7336-29633fdb2bcso3376675ad.3 for ; Wed, 05 Nov 2025 15:02:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1762383751; x=1762988551; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=TlxfvP2XGyBZ9ZWjp2nJWnVnTjycomxw0c/RHXKyKQo=; b=RxUeG2Ec73GJgoxDv1d9wyviqBFIv3j9rWkRJTlfugOJ2BLujwCYvEfWKvPZ1FeP2R +lD6bhJMXMvZes67JoKOp0htxZi/Xf+B2+GRPxLfsKhxGjMa0coG+1M56fL+gTHlA5Ex qyTTGg6eF+JIR5CTAne2mBx31wKIS3o17xwVDHXYv+lmtcy2Oz/VS6TrFeEOxdTM8unL R3RIHChbxcdWzGdDs0kZSAw3eak1OiXprCMH8lNSuaIEf+Es0TzMA7Rsf1RKAX+KRj8C Yvxb9kC5lsFL5UAQyhhETeuW3A9UhGPDPPfF96slqQ29LHUnl6jWC+XyJka72l3CZC/b IbRw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1762383751; x=1762988551; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=TlxfvP2XGyBZ9ZWjp2nJWnVnTjycomxw0c/RHXKyKQo=; b=hl3Fqr5uMo2GE4axkqLHPZgIRHz0PQPfhOERdKobkpzGsyPu2z81yxEIDfb7zh4GTU goE1i78fVpW0xZjDxojRTBD5uR1ygLmhMzdp6M+cfmIKOSYclAHpYekT7Quz95YWuBIQ zXBaw+rmyW7h7IUcUWKT38xdNHe1KO/mNRvn85xuzV9XLPQiXSO4FzMvPH83eKpKEx20 U/Xd6Djh59RmG0VU4y3mJaWNIYySA/VAFTpVIb0MvDYO9+CKu3V6Op9MuNL3wNTXYtms kZ0R3cuP5Xz4Ysy5GdMTvGEmdRYJGUUO8yOG9xYiZZcBjdUFBtO06xo7G32mcf8FNkRF tr2w== X-Forwarded-Encrypted: i=1; AJvYcCWuRHaW8evPXM4VKMjo34ZsI6fDiNE2cR+xecN4RJ3dK2kn8G061/Mi4aBplT6N7UGmWCuu1RSv9yAg5hE=@vger.kernel.org X-Gm-Message-State: AOJu0YzyptJCBjOb517agv0YflzbsFr4BZN2A/yDHaN8IVseKOqeHCWy lb9/bQHN+py/CD13gamAHGaXaVOEBtnPhiQIdG9byt5YZo+6ZFwQyZ3v X-Gm-Gg: ASbGncsNkFM18wMGF7216iVBFyqDAnmZyuf902kjOs5v53Fvu350lCMDyo4RoBCWDHN OmJ11NT2F7EX3docqHK3yu/qfDvaJHT5Ea7rrUZZ/2mCE9Dy0tON42rS1dfxM6sul8moh2XX/yZ q0+1eAM1FLSdSeaSUwfvZsvdrwneYn620k1odFhzl25g4K9/Qq48y6lp7uhfAykNcmqPPS3sGB6 yZStYhRBGNa79zWQ44mmVuON6+Wa/RNp260uMHFWsjS00q0ABLfPsRqDEmDG6KrjPW5368Ev0Vq gJB89xvvjbgXPlvCGrR2PosLunpX441Vwy6Lgav7LCjiOMGvMmWl2zqnglcN4oEqhlc4IZJ1aad IFbqj7ZcUBjvJqBRkiA75C494FHrvz9JZJ1ohg+8YqU3PiEXz7QKqAfITi0ZBAi1i/XF3/VWh7e uRldUuTHcWzDuXNbpI1j4oZTJT2twN1rYywA== X-Google-Smtp-Source: AGHT+IEtcWPd7dB7RyrIUrheYv6CSgAxUf5dQTAqNss54XpxzEwcb9AjvOpQDtFIWbEWDoKZJmhUyw== X-Received: by 2002:a17:903:1aa7:b0:295:98a1:7ddb with SMTP id d9443c01a7336-2962ade3309mr64506435ad.61.1762383750699; Wed, 05 Nov 2025 15:02:30 -0800 (PST) Received: from mitchelllevy.localdomain ([131.107.147.147]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2965096839asm6325645ad.13.2025.11.05.15.02.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 05 Nov 2025 15:02:30 -0800 (PST) From: Mitchell Levy Date: Wed, 05 Nov 2025 15:01:16 -0800 Subject: [PATCH v4 4/9] rust: percpu: introduce a rust API for static per-CPU variables Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20251105-rust-percpu-v4-4-984b1470adcb@gmail.com> References: <20251105-rust-percpu-v4-0-984b1470adcb@gmail.com> In-Reply-To: <20251105-rust-percpu-v4-0-984b1470adcb@gmail.com> To: Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Andreas Hindborg , Alice Ryhl , Trevor Gross , Andrew Morton , Dennis Zhou , Tejun Heo , Christoph Lameter , Danilo Krummrich , Benno Lossin , Yury Norov , Viresh Kumar Cc: Tyler Hicks , Allen Pais , linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-mm@kvack.org, Mitchell Levy X-Mailer: b4 0.14.0 X-Developer-Signature: v=1; a=ed25519-sha256; t=1762383744; l=25644; i=levymitchell0@gmail.com; s=20240719; h=from:subject:message-id; bh=EZGO8S2GHg8ntWACzHd3jQtK+CxASeBX96N1M29X+1M=; b=VY87PCbOUQoIFarob7CleTCefLCX58T7Xi/O86w4FVkbK2dRHCYn55PyyLKrH1P8O+5VJk7sb KrXKjVUVQrzDb3qkJZBuLWCNge7F1wC5APDoK+DQXjg7loYU4SbbEUS X-Developer-Key: i=levymitchell0@gmail.com; a=ed25519; pk=n6kBmUnb+UNmjVkTnDwrLwTJAEKUfs2e8E+MFPZI93E= Per-CPU variables are an important tool for reducing lock contention, especially in systems with many processors. They also provide a convenient way to handle data that are logically associated with a particular CPU (e.g., the currently running task). Therefore, add a Rust API to make use of statically-allocated per-CPU variables. Add a RAII `CpuGuard` type for disabling CPU preemption. Introduce unifying abstractions that can be reused for a Rust API for dynamically-allocated per-CPU variables. Co-developed-by: Boqun Feng Signed-off-by: Boqun Feng Signed-off-by: Mitchell Levy --- Using `rustc` 1.83.0, I can confirm that the symbols `__INIT_$id` are optimized out by the compiler and do not appear in the final `.ko` file when compiling `samples/rust/rust_percpu.rs` (introduced in a later patch in this series). --- rust/kernel/lib.rs | 3 + rust/kernel/percpu.rs | 250 ++++++++++++++++++++++++++++++++++++++++ rust/kernel/percpu/cpu_guard.rs | 36 ++++++ rust/kernel/percpu/static_.rs | 218 +++++++++++++++++++++++++++++++++++ 4 files changed, 507 insertions(+) diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index f910a5ab80ba..2fdb194aa068 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -108,6 +108,9 @@ pub mod page; #[cfg(CONFIG_PCI)] pub mod pci; +// Only x86_64 is supported by percpu for now +#[cfg(CONFIG_X86_64)] +pub mod percpu; pub mod pid_namespace; pub mod platform; pub mod prelude; diff --git a/rust/kernel/percpu.rs b/rust/kernel/percpu.rs new file mode 100644 index 000000000000..2fba9a165636 --- /dev/null +++ b/rust/kernel/percpu.rs @@ -0,0 +1,250 @@ +// SPDX-License-Identifier: GPL-2.0 +//! Per-CPU variables. +//! +//! See the [`crate::define_per_cpu!`] macro and the [`PerCpu`] trait. + +pub mod cpu_guard; +mod static_; + +#[doc(inline)] +pub use static_::*; + +use crate::declare_extern_per_cpu; +use crate::percpu::cpu_guard::CpuGuard; +use crate::types::Opaque; + +use core::arch::asm; +use core::cell::{Cell, RefCell, UnsafeCell}; +use core::mem::MaybeUninit; + +use ffi::c_void; + +/// A per-CPU pointer; that is, an offset into the per-CPU area. +/// +/// Note that this type is NOT a smart pointer, it does not manage the allocation. +pub struct PerCpuPtr(*mut MaybeUninit); + +/// Represents exclusive access to the memory location pointed at by a particular [`PerCpu`]. +pub struct PerCpuToken<'a, T> { + // INVARIANT: the current CPU's memory location associated with the per-CPU variable pointed at + // by `ptr` (i.e., the entry in the per-CPU area on the current CPU) has been initialized. + _guard: CpuGuard, + ptr: &'a PerCpuPtr, +} + +/// Represents access to the memory location pointed at by a particular [`PerCpu`] where the +/// type `T` manages access to the underlying memory to avoid aliaising troubles. +/// +/// For example, `T` might be a [`Cell`] or [`RefCell`]. +pub struct CheckedPerCpuToken<'a, T> { + // INVARIANT: the current CPU's memory location associated with the per-CPU variable pointed at + // by `ptr` (i.e., the entry in the per-CPU area on the current CPU) has been initialized. + _guard: CpuGuard, + ptr: &'a PerCpuPtr, +} + +impl PerCpuPtr { + /// Makes a new [`PerCpuPtr`] from a raw per-CPU pointer. + /// + /// Note that the returned [`PerCpuPtr`] is valid only as long as the given pointer is. This + /// also requires that the allocation pointed to by `ptr` must be correctly sized and aligned + /// to hold a `T`. + pub fn new(ptr: *mut MaybeUninit) -> Self { + Self(ptr) + } + + /// Get a [`&mut MaybeUninit`](MaybeUninit) to the per-CPU variable on the current CPU + /// represented by `&self` + /// + /// # Safety + /// + /// The returned `&mut T` must follow Rust's aliasing rules. That is, no other `&(mut) T` may + /// exist that points to the same location in memory. In practice, this means that + /// [`Self::get_ref`] and [`Self::get_mut_ref`] must not be called on another [`PerCpuPtr`] + /// that is a copy/clone of `&self` for as long as the returned reference lives. If the per-CPU + /// variable represented by `&self` is available to C, the caller of this function must ensure + /// that the C code does not modify the variable for as long as this reference lives. + /// + /// `self` must point to a live allocation correctly sized and aligned to hold a `T`. + /// + /// CPU preemption must be disabled before calling this function and for the lifetime of the + /// returned reference. Otherwise, the returned reference might end up being a reference to a + /// different CPU's per-CPU area, causing the potential for a data race. + #[allow(clippy::mut_from_ref)] // Safety requirements prevent aliasing issues + pub unsafe fn get_mut_ref(&self) -> &mut MaybeUninit { + // SAFETY: `self.get_ptr()` returns a valid pointer to a `MaybeUninit` by its contract, + // and the safety requirements of this function ensure that the returned reference is + // exclusive. + unsafe { &mut *(self.get_ptr()) } + } + + /// Get a [`&mut MaybeUninit`](MaybeUninit) to the per-CPU variable on the current CPU + /// represented by `&self` + /// + /// # Safety + /// + /// The returned `&T` must follow Rust's aliasing rules. That is, no `&mut T` may exist that + /// points to the same location in memory. In practice, this means that [`Self::get_mut_ref`] + /// must not be called on another [`PerCpuPtr`] that is a copy/clone of `&self` for as long + /// as the returned reference lives. If the per-CPU variable represented by `&self` is + /// available to C, the caller of this function must ensure that the C code does not modify the + /// variable for as long as this reference lives. + /// + /// `self` must point to a live allocation correctly sized and aligned to hold a `T`. + /// + /// CPU preemption must be disabled before calling this function and for the lifetime of the + /// returned reference. Otherwise, the returned reference might end up being a reference to a + /// different CPU's per-CPU area, causing the potential for a data race. + pub unsafe fn get_ref(&self) -> &MaybeUninit { + // SAFETY: `self.get_ptr()` returns a valid pointer to a `MaybeUninit` by its contract. + // The safety requirements of this function ensure that the returned reference isn't + // aliased by a `&mut MaybeUninit`. + unsafe { &*self.get_ptr() } + } + + /// Get a [`*mut MaybeUninit`](MaybeUninit) to the per-CPU variable on the current CPU + /// represented by `&self`. Note that if CPU preemption is not disabled before calling this + /// function, use of the returned pointer may cause a data race without some other + /// synchronization mechanism. Buyer beware! + pub fn get_ptr(&self) -> *mut MaybeUninit { + let this_cpu_off_pcpu = ExternStaticPerCpuSymbol::ptr(&raw const this_cpu_off); + let mut this_cpu_area: *mut c_void; + // SAFETY: gs + this_cpu_off_pcpu is guaranteed to be a valid pointer because `gs` points + // to the per-CPU area and this_cpu_off_pcpu is a valid per-CPU allocation. + unsafe { + asm!( + "mov {out}, gs:[{off_val}]", + off_val = in(reg) this_cpu_off_pcpu.0, + out = out(reg) this_cpu_area, + ) + }; + + // This_cpu_area + self.0 is guaranteed to be a valid pointer by the per-CPU subsystem and + // the invariant that self.0 is a valid offset into the per-CPU area. + (this_cpu_area).wrapping_add(self.0 as usize).cast() + } +} + +// SAFETY: Sending a [`PerCpuPtr`] to another thread is safe because as soon as it's sent, the +// pointer is logically referring to a different place in memory in the other CPU's per-CPU area. +// In particular, this means that there are no restrictions on the type `T`. +unsafe impl Send for PerCpuPtr {} + +// SAFETY: Two threads concurrently making use of a [`PerCpuPtr`] will each see the `T` in their +// own per-CPU area, so there's no potential for a data race (regardless of whether `T` is itself +// `Sync`). +unsafe impl Sync for PerCpuPtr {} + +impl Clone for PerCpuPtr { + fn clone(&self) -> Self { + *self + } +} + +/// [`PerCpuPtr`] is just a wrapper around a pointer. +impl Copy for PerCpuPtr {} + +/// A trait representing a per-CPU variable. +/// +/// This is implemented for [`StaticPerCpu`]. The main usage of this trait is to call +/// [`Self::get_mut`] to get a [`PerCpuToken`] that can be used to access the underlying per-CPU +/// variable. +/// +/// See [`PerCpuToken::with`]. +pub trait PerCpu { + /// Produces a token, asserting that the holder has exclusive access to the underlying memory + /// pointed to by `self` + /// + /// # Safety + /// + /// No other [`PerCpuToken`] or [`CheckedPerCpuToken`] may exist on the current CPU (which is a + /// sensible notion, since we keep a [`CpuGuard`] around) that is derived from the same + /// [`PerCpu`] or a clone thereof. + unsafe fn get_mut(&mut self, guard: CpuGuard) -> PerCpuToken<'_, T>; +} + +/// A marker trait for types that are interior mutable. Types that implement this trait can be used +/// to create "checked" per-CPU variables. See [`CheckedPerCpu`]. +pub trait InteriorMutable {} + +impl InteriorMutable for Cell {} +impl InteriorMutable for RefCell {} +impl InteriorMutable for UnsafeCell {} +impl InteriorMutable for Opaque {} + +/// A trait representing a per-CPU variable that is usable via a `&T`. +/// +/// The unsafety of [`PerCpu`] stems from the fact that the holder of a [`PerCpuToken`] can use +/// it to get a `&mut T` to the underlying per-CPU variable. This is problematic because the +/// existence of aliaising `&mut T` is undefined behavior in Rust. This type avoids that issue by +/// only allowing access via a `&T`, with the tradeoff that then `T` must be interior mutable or +/// the underlying per-CPU variable must be a constant for the lifetime of any corresponding +/// [`CheckedPerCpuToken`]. +/// +/// Currently, only the case where `T` is interior mutable has first-class support, though a custom +/// implementation of [`PerCpu`]/[`CheckedPerCpu`] could be created for the const case. +pub trait CheckedPerCpu: PerCpu { + /// Produces a token via which the holder can access the underlying per-CPU variable. + fn get(&mut self, guard: CpuGuard) -> CheckedPerCpuToken<'_, T>; +} + +impl<'a, T> PerCpuToken<'a, T> { + /// Asserts that the holder has exclusive access to the initialized underlying memory pointed + /// to by `ptr` on the current CPU, producing a token. + /// + /// # Safety + /// + /// No other [`PerCpuToken`] or [`CheckedPerCpuToken`] may exist on the current CPU (which is a + /// sensible notion, since we keep a `CpuGuard` around) that uses the same [`PerCpuPtr`]. + /// + /// The current CPU's memory location associated with the per-CPU variable pointed at by `ptr` + /// (i.e., the entry in the per-CPU area on this CPU) must be initialized; `ptr` must be valid + /// (that is, pointing at a live per-CPU allocation correctly sized and aligned to hold a `T`) + /// for `'a`. + pub unsafe fn new(guard: CpuGuard, ptr: &'a PerCpuPtr) -> PerCpuToken<'a, T> { + Self { _guard: guard, ptr } + } + + /// Immediately invokes `func` with a `&mut T` that points at the underlying per-CPU variable + /// that `&mut self` represents. + pub fn with(&mut self, func: U) + where + U: FnOnce(&mut T), + { + // SAFETY: The existence of a PerCpuToken means that the requirements for get_mut_ref are + // satisfied. Likewise, the requirements for assume_init_mut are satisfied because the + // invariants of this type ensure that on the current CPU (which is a sensible notion + // because we have a CpuGuard), the memory location pointed to by `ptr` is initialized. + func(unsafe { self.ptr.get_mut_ref().assume_init_mut() }); + } +} + +impl<'a, T> CheckedPerCpuToken<'a, T> { + /// Asserts that the memory pointed to by `ptr` is initialized on the current CPU, producing a + /// token. + /// + /// # Safety + /// + /// The current CPU's memory location associated with the per-CPU variable pointed at by `ptr` + /// (i.e., the entry in the per-CPU area on this CPU) must be initialized; `ptr` must be valid + /// (that is, pointing at a live per-CPU allocation correctly sized and aligned to hold a `T`) + /// for `'a`. + pub unsafe fn new(guard: CpuGuard, ptr: &'a PerCpuPtr) -> CheckedPerCpuToken<'a, T> { + Self { _guard: guard, ptr } + } + + /// Immediately invokes `func` with a `&T` that points at the underlying per-CPU variable that + /// `&mut self` represents. + pub fn with(&mut self, func: U) + where + U: FnOnce(&T), + { + // SAFETY: The existence of a CheckedPerCpuToken means that the requirements for get_ref + // are satisfied. Likewise, the requirements for assume_init_ref are satisfied because the + // invariants of this type ensure that on the current CPU (which is a sensible notion + // because we have a CpuGuard), the memory location pointed to by `ptr` is initialized. + func(unsafe { self.ptr.get_ref().assume_init_ref() }); + } +} + +declare_extern_per_cpu!(this_cpu_off: *mut c_void); diff --git a/rust/kernel/percpu/cpu_guard.rs b/rust/kernel/percpu/cpu_guard.rs new file mode 100644 index 000000000000..2fb4c9218922 --- /dev/null +++ b/rust/kernel/percpu/cpu_guard.rs @@ -0,0 +1,36 @@ +// SPDX-License-Identifier: GPL-2.0 +//! Contains abstractions for disabling CPU preemption. See [`CpuGuard`]. + +/// A RAII guard for `bindings::preempt_disable` and `bindings::preempt_enable`. +/// +/// Guarantees preemption is disabled for as long as this object exists. +pub struct CpuGuard { + // Don't make one without using new() + _phantom: (), +} + +impl CpuGuard { + /// Create a new [`CpuGuard`]. Disables preemption for its lifetime. + pub fn new() -> Self { + // SAFETY: There are no preconditions required to call preempt_disable + unsafe { + bindings::preempt_disable(); + } + CpuGuard { _phantom: () } + } +} + +impl Default for CpuGuard { + fn default() -> Self { + Self::new() + } +} + +impl Drop for CpuGuard { + fn drop(&mut self) { + // SAFETY: There are no preconditions required to call preempt_enable + unsafe { + bindings::preempt_enable(); + } + } +} diff --git a/rust/kernel/percpu/static_.rs b/rust/kernel/percpu/static_.rs new file mode 100644 index 000000000000..418fc2fa06f2 --- /dev/null +++ b/rust/kernel/percpu/static_.rs @@ -0,0 +1,218 @@ +// SPDX-License-Identifier: GPL-2.0 +//! Statically allocated per-CPU variables. + +use super::*; + +/// A wrapper used for declaring static per-CPU variables. +/// +/// These symbols are "virtual" in that the linker uses them to generate offsets into each CPU's +/// per-CPU area, but shouldn't be read from/written to directly. The fact that the statics are +/// immutable prevents them being written to (generally), this struct having _val be non-public +/// prevents reading from them. +/// +/// The end-user of the per-CPU API should make use of the [`crate::define_per_cpu!`] macro instead +/// of declaring variables of this type directly. All instances of this type must be `static` and +/// `#[link_section = ".data..percpu"]` (which the macro handles). +#[repr(transparent)] +pub struct StaticPerCpuSymbol { + _val: T, // generate a correctly sized type +} + +/// A wrapper for per-CPU variables declared in C. +/// +/// As with [`StaticPerCpuSymbol`], this type should not be used directly. Instead, use the +/// [`crate::declare_extern_per_cpu!`] macro. +#[repr(transparent)] +pub struct ExternStaticPerCpuSymbol(StaticPerCpuSymbol); + +/// Holds a statically-allocated per-CPU variable. +#[derive(Clone)] +pub struct StaticPerCpu(pub(super) PerCpuPtr); + +impl StaticPerCpuSymbol { + /// Removes the per-CPU marker type from a static per-CPU symbol. + /// + /// To declare a static per-CPU variable, Rust requires that the variable be `Sync`. However, + /// in the case of per-CPU variables, this is silly. See [`PerCpuSyncMarkerType`]. Thus, our + /// statics are actually of type `StaticPerCpuSymbol>`, and this + /// produces a `StaticPerCpuSymbol`. + pub fn forward(ptr: *const Self) -> *const StaticPerCpuSymbol { + ptr.cast() + } +} + +impl ExternStaticPerCpuSymbol { + /// Gets a [`PerCpuPtr`] to the per-CPU variable. + /// + /// Usage of this [`PerCpuPtr`] must be very careful to keep in mind what's happening in C. In + /// particular, the C code cannot modify the variable while any reference derived from the + /// returned pointer is live. + pub fn ptr(ptr: *const Self) -> PerCpuPtr { + // These casts are OK because, ExternStaticPerCpuSymbol, StaticPerCpuSymbol, and + // MaybeUninit are transparent, everything is just a `T` from a memory layout perspective. + // Casting to `mut` is OK because any usage of the returned pointer must satisfy the + // soundness requirements for using it as such. + PerCpuPtr::new(ptr.cast::>().cast_mut().cast()) + } +} + +impl StaticPerCpu { + /// Creates a [`StaticPerCpu`] from a [`StaticPerCpuSymbol`]. + /// + /// Users should probably declare static per-CPU variables with [`crate::define_per_cpu!`] and + /// then get instances of [`StaticPerCpu`] using [`crate::get_static_per_cpu!`]. + /// + /// # Safety + /// You should probably be using [`crate::get_static_per_cpu!`] instead. + /// + /// `ptr` must be a valid offset into the per-CPU area, sized and aligned for access to a `T`; + /// typically this is the address of a static in the `.data..percpu` section, which is managed + /// by the per-CPU subsystem. + pub unsafe fn new(ptr: *const StaticPerCpuSymbol) -> StaticPerCpu { + let pcpu_ptr = PerCpuPtr::new(ptr.cast_mut().cast()); + Self(pcpu_ptr) + } +} + +impl PerCpu for StaticPerCpu { + unsafe fn get_mut(&mut self, guard: CpuGuard) -> PerCpuToken<'_, T> { + // SAFETY: + // 1. By the requirements of `PerCpu::get_mut`, no other `[Checked]PerCpuToken` exists on + // the current CPU. + // 2. The per-CPU subsystem guarantees that each CPU's instance of a statically allocated + // variable begins with a copy of the contents of the corresponding symbol in + // `.data..percpu` and is therefore initialized. + // 3. The per-CPU subsystem guarantees that `self.0` is correctly aligned for a `T`. + // 4. The per-CPU subsystem guarantees that `self.0` is lives forever as a per-CPU + // allocation, and that this allocation is the proper size for a `T`. + unsafe { PerCpuToken::new(guard, &self.0) } + } +} + +impl CheckedPerCpu for StaticPerCpu { + fn get(&mut self, guard: CpuGuard) -> CheckedPerCpuToken<'_, T> { + // SAFETY: + // 1. The per-CPU subsystem guarantees that each CPU's instance of a statically allocated + // variable begins with a copy of the contents of the corresponding symbol in + // `.data..percpu` and is therefore initialized. + // 2. The per-CPU subsystem guarantees that `self.0` is correctly aligned for a `T`. + // 3. The per-CPU subsystem guarantees that `self.0` is lives forever as a per-CPU + // allocation, and that this allocation is the proper size for a `T`. + unsafe { CheckedPerCpuToken::new(guard, &self.0) } + } +} + +/// Gets a [`StaticPerCpu`] from a symbol declared with [`crate::define_per_cpu!`]. +/// +/// # Arguments +/// +/// * `ident` - The identifier declared +#[macro_export] +macro_rules! get_static_per_cpu { + ($id:ident) => { + unsafe { + // SAFETY: The signature of `StaticPerCpuSymbol::forward` guarantees that `&raw const + // $id` is a `*const StaticPerCpuSymbol>` if the macro + // invocation compiles. + // + // Values of type `StaticPerCpuSymbol` must be created via `define_per_cpu`, and so + // the per-CPU subsystem guarantees that the requirements for `StaticPerCpu::new` are + // satisfied. + $crate::percpu::StaticPerCpu::new($crate::percpu::StaticPerCpuSymbol::forward( + &raw const $id, + )) + } + }; +} + +/// Declares an [`ExternStaticPerCpuSymbol`] corresponding to a per-CPU variable defined in C. +#[macro_export] +macro_rules! declare_extern_per_cpu { + ($id:ident: $ty:ty) => { + extern "C" { + static $id: ExternStaticPerCpuSymbol<$ty>; + } + }; +} + +/// A trait implemented by static per-CPU wrapper types. +/// +/// Internally, static per-CPU variables are declared as `static` variables. However, Rust doesn't +/// allow you to declare statics of a `!Sync` type. This trait is implemented by the marker type +/// that is declared as `Sync` and used to declare the static. See [`crate::define_per_cpu!`] for +/// the gory details. +/// +/// # Safety +/// +/// Implementations must be `#[repr(transparent)]` wrappers around an `Inner`. This trait should +/// only be used from the [`crate::define_per_cpu!`] macro. +pub unsafe trait PerCpuSyncMarkerType { + /// The "true" type of the per-CPU variable. It must always be valid to cast a `*const Self` to + /// a `*const Self::Inner`, which is guarnateed by this trait's safety requirement. + type Inner; +} + +/// Declares and initializes a static per-CPU variable. +/// +/// Analogous to the C `DEFINE_PER_CPU` macro. +/// +/// See also [`crate::get_static_per_cpu!`] for how to get a [`StaticPerCpu`] from this +/// declaration. +/// +/// # Example +/// ``` +/// use kernel::define_per_cpu; +/// use kernel::percpu::StaticPerCpuSymbol; +/// +/// define_per_cpu!(pub MY_PERCPU: u64 = 0); +/// ``` +#[macro_export] +macro_rules! define_per_cpu { + ($vis:vis $id:ident: $ty:ty = $expr:expr) => { + $crate::macros::paste! { + // We might want to have a per-CPU variable that doesn't implement `Sync` (not paying + // sync overhead costs is part of the point), but Rust won't let us declare a static of + // a `!Sync` type. Of course, we don't actually have any synchronization issues, since + // each CPU will see its own copy of the variable, so we cheat a little bit and tell + // Rust it's fine. + #[doc(hidden)] + #[allow(non_camel_case_types)] + #[repr(transparent)] // It needs to be the same size as $ty + struct [<__PRIVATE_TYPE_ $id>]($ty); + + // SAFETY: [<__PRIVATE_TYPE_ $id>] is a `#[repr(transparent)]` wrapper around a `$ty`. + unsafe impl PerCpuSyncMarkerType for [<__PRIVATE_TYPE_ $id>] { + type Inner = $ty; + } + + impl [<__PRIVATE_TYPE_ $id>] { + #[doc(hidden)] + const fn new(val: $ty) -> Self { + Self(val) + } + } + + // Expand $expr outside of the unsafe block to avoid silently allowing unsafe code to be + // used without a user-facing unsafe block + #[doc(hidden)] + static [<__INIT_ $id>]: [<__PRIVATE_TYPE_ $id>] = [<__PRIVATE_TYPE_ $id>]::new($expr); + + // SAFETY: This type will ONLY ever be used to declare a `StaticPerCpuSymbol` + // (which we then only ever use as input to `&raw`). Reading from the symbol is + // already UB, so we won't ever actually have any variables of this type where + // synchronization is a concern. + #[doc(hidden)] + unsafe impl Sync for [<__PRIVATE_TYPE_ $id>] {} + + // SAFETY: StaticPerCpuSymbol is #[repr(transparent)], so we can freely convert from + // [<__PRIVATE_TYPE_ $id>], which is also `#[repr(transparent)]` (i.e., everything is + // just a `$ty` from a memory layout perspective). + #[link_section = ".data..percpu"] + $vis static $id: StaticPerCpuSymbol<[<__PRIVATE_TYPE_ $id>]> = unsafe { + core::mem::transmute_copy::< + [<__PRIVATE_TYPE_ $id>], StaticPerCpuSymbol<[<__PRIVATE_TYPE_ $id>]> + >(&[<__INIT_ $id>]) + }; + } + }; +} -- 2.34.1