From nobody Wed Dec 4 19:09:13 2024 Received: from mail-qk1-f174.google.com (mail-qk1-f174.google.com [209.85.222.174]) (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 C2AD21A2C0E; Wed, 20 Nov 2024 11:48:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.222.174 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732103306; cv=none; b=u6Ok5baCvS7o90b5GL6g+i6Wxga2imTNJNfZ8hDFmgvmjxQp/oB38A0uz52Y6gtfWSWBUlDXIN7u4bk7HngcTrg9hpshesGKOtWJ2NUeFVLeL5n3N54/UN+x23XUyzwR3ZSmQv9hNudNSjLu2usKU7cO+DEBtWZIhSVrNAzn1L4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732103306; c=relaxed/simple; bh=k0hWV6S9VV5ItwA9j1d+Sc4EUf5RLbdYOWfq/0sNAI8=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=UEC/srdvEWary4u8KvdqsRLKKhsfe2BdaaZz1mmuw67fsdPJLY+mSt456hzX7HULRU31ZUc1SvZiBawCxhximDEP5rDhob/d7VkuAQdfgR2wrI81VmhEiazdHnmZD2HFU57hrnMcoX3TZLRI10gHxwul4Fl1+NigOk4IRyOT82k= 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=fal/AOzj; arc=none smtp.client-ip=209.85.222.174 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="fal/AOzj" Received: by mail-qk1-f174.google.com with SMTP id af79cd13be357-7b13ff3141aso432035885a.1; Wed, 20 Nov 2024 03:48:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732103303; x=1732708103; 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=Ymy+PnTjcAKXJVO48YP5fGXzjUSaR1W9jpd/XF6yMgw=; b=fal/AOzjTsb+0obYMZ0RwpgOlF5lpprbiNC6sV5L42yM7kpG991Q+VqUviWOXSuvh8 z52wItspQ6IoxhWnqT0E9vwKHHjZc/uJKHPRzDGdjuzRFKkftY41Ri/1zRW2RBIV/72k N0GfR0Tv7qiz3307CStrC8WTOqo6k5ABBM4bRYOHyhxIyJk7whJNWvBoJB8z8+7WGvHc VNx7CkmHZIEdNRhuxen5KOLQ1Hl82UJpP6cV2vzkYMqbVwkiS5sY2nNb3AZ4KP+IevxH u/rIDoSeHjorWlooTcvCV3V004t9N0G7v80TdRti/8s+eqBAZzPngvnfxWtkR5iT9Jwg C4sg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732103303; x=1732708103; 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=Ymy+PnTjcAKXJVO48YP5fGXzjUSaR1W9jpd/XF6yMgw=; b=sHPUaCTXMit1dahhpSUhuOEiXY7LO65ULxIsYQUq9wyqv5DLEqp9DVN12tvs8YE7MM kSx1XRjIuEZHXeH1eGDpp1X+IUXdx7+HdXUn1XHV8NS5bsXvx0X8Qe+5pLtOK/XAAK6V MULhaqsiuCP7OxWUsw2nKJxbkI8qKw1F2iWAx+Vb21vKKQv/Sh7uNuY1RdJhhMQ2w6r+ ITHoqZ8prQtJjfc5JYzMQzBPP2WjgNRnR/872euHBjOvZWopGOpAmuZE77I+Swb4gu+N b8+fmT2tIfEtzU49ldKI1AmudAq3ugb/heBc4lnz5n+Wdta6Dxo7ybD5iNOwmUrEBAkF +Z1g== X-Forwarded-Encrypted: i=1; AJvYcCVXtWMgxALW6XSVrYj1aLDwMyumc68Q5Aum5+MxoOvdKhO0b4/KNCfjgtk99DDMGsLv6Pi0ssXM60BOmT7ym3E=@vger.kernel.org, AJvYcCVoez9CKH2XWiJUx6qQ2RDDKUtdDuFNfFmZbbMrPoWRMBFcoeMiwMCM488CQWs/EORP2wTCFR3lIkZqoNI=@vger.kernel.org X-Gm-Message-State: AOJu0YzkqYgyyhkSe+L01N511ww/6Vo44U93FMYeEnLJ2PuBumTZR0sM NDOhn0l06kfNzULmTGXc50cwnyClWCqz7imw2RKiBUAFZOuS7evj X-Google-Smtp-Source: AGHT+IEXWURCfzTr7f2pMRarVxO3+n7aE2dTfbjRwLY/JeXcUDJRWOb3a7XLvuMjgmLsiSvrYNXDYw== X-Received: by 2002:a05:620a:720d:b0:7b1:1d91:5cf1 with SMTP id af79cd13be357-7b42edad2e1mr286650285a.1.1732103303414; Wed, 20 Nov 2024 03:48:23 -0800 (PST) Received: from tamirs-macbook-pro.local ([2600:4041:5be7:7c00:8dca:61d2:c8fb:a544]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7b479d46e3esm85640885a.29.2024.11.20.03.48.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 03:48:22 -0800 (PST) From: Tamir Duberstein Date: Wed, 20 Nov 2024 06:48:18 -0500 Subject: [PATCH v10 2/2] rust: xarray: Add an abstraction for XArray 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: quoted-printable Message-Id: <20241120-rust-xarray-bindings-v10-2-a25b2b0bf582@gmail.com> References: <20241120-rust-xarray-bindings-v10-0-a25b2b0bf582@gmail.com> In-Reply-To: <20241120-rust-xarray-bindings-v10-0-a25b2b0bf582@gmail.com> To: Danilo Krummrich , Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross Cc: =?utf-8?q?Ma=C3=ADra_Canal?= , Asahi Lina , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Tamir Duberstein X-Mailer: b4 0.15-dev `XArray` is an efficient sparse array of pointers. Add a Rust abstraction for this type. This implementation bounds the element type on `ForeignOwnable` and requires explicit locking for all operations. Future work may leverage RCU to enable lockless operation. Inspired-by: Ma=C3=ADra Canal Inspired-by: Asahi Lina Signed-off-by: Tamir Duberstein --- rust/bindings/bindings_helper.h | 6 + rust/helpers/helpers.c | 1 + rust/helpers/xarray.c | 28 +++++ rust/kernel/alloc.rs | 5 + rust/kernel/lib.rs | 1 + rust/kernel/xarray.rs | 266 ++++++++++++++++++++++++++++++++++++= ++++ 6 files changed, 307 insertions(+) diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helpe= r.h index 5c4dfe22f41a5a106330e8c43ffbd342c69c4e0b..9f39d673b240281aed2759b5bd0= 76aa43fb54951 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -30,6 +30,7 @@ #include #include #include +#include #include =20 /* `bindgen` gets confused at certain things. */ @@ -43,3 +44,8 @@ const gfp_t RUST_CONST_HELPER___GFP_ZERO =3D __GFP_ZERO; const gfp_t RUST_CONST_HELPER___GFP_HIGHMEM =3D ___GFP_HIGHMEM; const gfp_t RUST_CONST_HELPER___GFP_NOWARN =3D ___GFP_NOWARN; const blk_features_t RUST_CONST_HELPER_BLK_FEAT_ROTATIONAL =3D BLK_FEAT_RO= TATIONAL; + +const xa_mark_t RUST_CONST_HELPER_XA_PRESENT =3D XA_PRESENT; + +const gfp_t RUST_CONST_HELPER_XA_FLAGS_ALLOC =3D XA_FLAGS_ALLOC; +const gfp_t RUST_CONST_HELPER_XA_FLAGS_ALLOC1 =3D XA_FLAGS_ALLOC1; diff --git a/rust/helpers/helpers.c b/rust/helpers/helpers.c index dcf827a61b52e71e46fd5378878602eef5e538b6..ff28340e78c53c79baf18e2927c= c90350d8ab513 100644 --- a/rust/helpers/helpers.c +++ b/rust/helpers/helpers.c @@ -30,3 +30,4 @@ #include "vmalloc.c" #include "wait.c" #include "workqueue.c" +#include "xarray.c" diff --git a/rust/helpers/xarray.c b/rust/helpers/xarray.c new file mode 100644 index 0000000000000000000000000000000000000000..60b299f11451d2c4a75e50e25de= c4dac13f143f4 --- /dev/null +++ b/rust/helpers/xarray.c @@ -0,0 +1,28 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include + +int rust_helper_xa_err(void *entry) +{ + return xa_err(entry); +} + +void rust_helper_xa_init_flags(struct xarray *xa, gfp_t flags) +{ + return xa_init_flags(xa, flags); +} + +int rust_helper_xa_trylock(struct xarray *xa) +{ + return xa_trylock(xa); +} + +void rust_helper_xa_lock(struct xarray *xa) +{ + return xa_lock(xa); +} + +void rust_helper_xa_unlock(struct xarray *xa) +{ + return xa_unlock(xa); +} diff --git a/rust/kernel/alloc.rs b/rust/kernel/alloc.rs index f2f7f3a53d298cf899e062346202ba3285ce3676..be9f164ece2e0fe71143e020124= 7d2b70c193c51 100644 --- a/rust/kernel/alloc.rs +++ b/rust/kernel/alloc.rs @@ -39,6 +39,11 @@ pub struct Flags(u32); =20 impl Flags { + /// Get a flags value with all bits unset. + pub fn empty() -> Self { + Self(0) + } + /// Get the raw representation of this flag. pub(crate) fn as_raw(self) -> u32 { self.0 diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index e1065a7551a39e68d6379031d80d4be336e652a3..9ca524b15920c525c7db419e60d= ec4c43522751d 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -68,6 +68,7 @@ pub mod types; pub mod uaccess; pub mod workqueue; +pub mod xarray; =20 #[doc(hidden)] pub use bindings; diff --git a/rust/kernel/xarray.rs b/rust/kernel/xarray.rs new file mode 100644 index 0000000000000000000000000000000000000000..acbac787dc9a38684538697d53f= 590880fa9903a --- /dev/null +++ b/rust/kernel/xarray.rs @@ -0,0 +1,266 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! XArray abstraction. +//! +//! C header: [`include/linux/xarray.h`](srctree/include/linux/xarray.h) + +use core::pin::Pin; + +use crate::{ + alloc, bindings, build_assert, build_error, + error::{Error, Result}, + init::PinInit, + pin_init, + types::{ForeignOwnable, NotThreadSafe, Opaque}, +}; +use core::{iter, marker::PhantomData, mem}; +use macros::{pin_data, pinned_drop}; + +/// An array which efficiently maps sparse integer indices to owned object= s. +/// +/// This is similar to a [`crate::alloc::kvec::Vec>`], but more = efficient when there are +/// holes in the index space, and can be efficiently grown. +/// +/// # Invariants +/// +/// `self.xa` is always an initialized and valid [`bindings::xarray`] whos= e entries are either +/// `XA_ZERO_ENTRY` or came from `T::into_foreign`. +/// +/// # Examples +/// +/// ```rust +/// use kernel::alloc::KBox; +/// use kernel::xarray::{AllocKind, XArray}; +/// +/// let xa =3D KBox::pin_init(XArray::new(AllocKind::Alloc1), GFP_KERNEL)?; +/// +/// let dead =3D KBox::new(0xdead, GFP_KERNEL)?; +/// let beef =3D KBox::new(0xbeef, GFP_KERNEL)?; +/// +/// let mut guard =3D xa.lock(); +/// +/// assert_eq!(guard.get(0), None); +/// +/// assert_eq!(guard.store(0, dead, GFP_KERNEL).unwrap().as_deref(), None); +/// assert_eq!(guard.get(0).copied(), Some(0xdead)); +/// +/// *guard.get_mut(0).unwrap() =3D 0xffff; +/// assert_eq!(guard.get(0).copied(), Some(0xffff)); +/// +/// assert_eq!(guard.store(0, beef, GFP_KERNEL).unwrap().as_deref().copied= (), Some(0xffff)); +/// assert_eq!(guard.get(0).copied(), Some(0xbeef)); +/// +/// guard.remove(0); +/// assert_eq!(guard.get(0), None); +/// +/// # Ok::<(), Error>(()) +/// ``` +#[pin_data(PinnedDrop)] +pub struct XArray { + #[pin] + xa: Opaque, + _p: PhantomData, +} + +#[pinned_drop] +impl PinnedDrop for XArray { + fn drop(self: Pin<&mut Self>) { + self.iter().for_each(|ptr| { + let ptr =3D ptr.as_ptr(); + // SAFETY: `ptr` came from `T::into_foreign`. + // + // INVARIANT: we own the only reference to the array which is = being dropped so the + // broken invariant is not observable on function exit. + drop(unsafe { T::from_foreign(ptr) }) + }); + + // SAFETY: `self.xa` is always valid by the type invariant. + unsafe { bindings::xa_destroy(self.xa.get()) }; + } +} + +/// Flags passed to [`XArray::new`] to configure the array's allocation tr= acking behavior. +pub enum AllocKind { + /// Consider the first element to be at index 0. + Alloc, + /// Consider the first element to be at index 1. + Alloc1, +} + +impl XArray { + /// Creates a new [`XArray`]. + pub fn new(kind: AllocKind) -> impl PinInit { + let flags =3D match kind { + AllocKind::Alloc =3D> bindings::XA_FLAGS_ALLOC, + AllocKind::Alloc1 =3D> bindings::XA_FLAGS_ALLOC1, + }; + pin_init!(Self { + // SAFETY: `xa` is valid while the closure is called. + xa <- Opaque::ffi_init(|xa| unsafe { + bindings::xa_init_flags(xa, flags) + }), + _p: PhantomData, + }) + } + + fn iter(&self) -> impl Iterator> + '_ { + // TODO: Remove when https://lore.kernel.org/all/20240913213041.39= 5655-5-gary@garyguo.net/ is applied. + const MIN: core::ffi::c_ulong =3D core::ffi::c_ulong::MIN; + const MAX: core::ffi::c_ulong =3D core::ffi::c_ulong::MAX; + + let mut index =3D MIN; + + // SAFETY: `self.xa` is always valid by the type invariant. + iter::once(unsafe { + bindings::xa_find(self.xa.get(), &mut index, MAX, bindings::XA= _PRESENT) + }) + .chain(iter::from_fn(move || { + // SAFETY: `self.xa` is always valid by the type invariant. + Some(unsafe { + bindings::xa_find_after(self.xa.get(), &mut index, MAX, bi= ndings::XA_PRESENT) + }) + })) + .map_while(|ptr| core::ptr::NonNull::new(ptr.cast())) + } + + /// Attempts to lock the [`XArray`] for exclusive access. + pub fn try_lock(&self) -> Option> { + // SAFETY: `self.xa` is always valid by the type invariant. + (unsafe { bindings::xa_trylock(self.xa.get()) } !=3D 0).then(|| Gu= ard { + xa: self, + _not_send: NotThreadSafe, + }) + } + + /// Locks the [`XArray`] for exclusive access. + pub fn lock(&self) -> Guard<'_, T> { + // SAFETY: `self.xa` is always valid by the type invariant. + unsafe { bindings::xa_lock(self.xa.get()) }; + + Guard { + xa: self, + _not_send: NotThreadSafe, + } + } +} + +/// A lock guard. +/// +/// The lock is unlocked when the guard goes out of scope. +#[must_use =3D "the lock unlocks immediately when the guard is unused"] +pub struct Guard<'a, T: ForeignOwnable> { + xa: &'a XArray, + _not_send: NotThreadSafe, +} + +impl Drop for Guard<'_, T> { + fn drop(&mut self) { + // SAFETY: `self.xa.xa` is always valid by the type invariant. + // + // SAFETY: The caller holds the lock, so it is safe to unlock it. + unsafe { bindings::xa_unlock(self.xa.xa.get()) }; + } +} + +// TODO: Remove when https://lore.kernel.org/all/20240913213041.395655-5-g= ary@garyguo.net/ is applied. +fn to_index(i: usize) -> core::ffi::c_ulong { + i.try_into() + .unwrap_or_else(|_| build_error!("cannot convert usize to c_ulong"= )) +} + +impl<'a, T: ForeignOwnable> Guard<'a, T> { + fn load(&self, index: usize, f: F) -> Option + where + F: FnOnce(core::ptr::NonNull) -> U, + { + // SAFETY: `self.xa.xa` is always valid by the type invariant. + let ptr =3D unsafe { bindings::xa_load(self.xa.xa.get(), to_index(= index)) }; + let ptr =3D core::ptr::NonNull::new(ptr.cast())?; + Some(f(ptr)) + } + + /// Loads an entry from the array. + /// + /// Returns the entry at the given index. + pub fn get(&self, index: usize) -> Option> { + self.load(index, |ptr| { + // SAFETY: `ptr` came from `T::into_foreign`. + unsafe { T::borrow(ptr.as_ptr()) } + }) + } + + /// Loads an entry from the array. + /// + /// Returns the entry at the given index. + pub fn get_mut(&mut self, index: usize) -> Option> { + self.load(index, |ptr| { + // SAFETY: `ptr` came from `T::into_foreign`. + unsafe { T::borrow_mut(ptr.as_ptr()) } + }) + } + + /// Erases an entry from the array. + /// + /// Returns the entry which was previously at the given index. + pub fn remove(&mut self, index: usize) -> Option { + // SAFETY: `self.xa.xa` is always valid by the type invariant. + // + // SAFETY: The caller holds the lock. + let ptr =3D unsafe { bindings::__xa_erase(self.xa.xa.get(), to_ind= ex(index)) }.cast(); + // SAFETY: `ptr` is either NULL or came from `T::into_foreign`. + unsafe { T::try_from_foreign(ptr) } + } + + /// Stores an entry in the array. + /// + /// On success, returns the entry which was previously at the given in= dex. + /// + /// On failure, returns the entry which was attempted to be stored. + pub fn store( + &mut self, + index: usize, + value: T, + gfp: alloc::Flags, + ) -> Result, (T, Error)> { + build_assert!( + mem::align_of::() >=3D 4, + "pointers stored in XArray must be 4-byte aligned" + ); + let new =3D value.into_foreign(); + + let old =3D { + let new =3D new.cast(); + // SAFETY: `self.xa.xa` is always valid by the type invariant. + // + // SAFETY: The caller holds the lock. + // + // INVARIANT: `new` came from `T::into_foreign`. + unsafe { bindings::__xa_store(self.xa.xa.get(), to_index(index= ), new, gfp.as_raw()) } + }; + + // SAFETY: `__xa_store` returns the old entry at this index on suc= cess or `xa_err` if an + // error happened. + match unsafe { bindings::xa_err(old) } { + 0 =3D> { + let old =3D old.cast(); + // SAFETY: `ptr` is either NULL or came from `T::into_fore= ign`. + Ok(unsafe { T::try_from_foreign(old) }) + } + errno =3D> { + // SAFETY: `new` came from `T::into_foreign` and `__xa_sto= re` does not take + // ownership of the value on error. + let value =3D unsafe { T::from_foreign(new) }; + Err((value, Error::from_errno(errno))) + } + } + } +} + +// SAFETY: It is safe to send `XArray` to another thread when the under= lying `T` is `Send` +// because XArray is thread-safe and all mutation operations are synchroni= zed. +unsafe impl Send for XArray {} + +// SAFETY: It is safe to send `&XArray` to another thread when the unde= rlying `T` is `Sync` +// because it effectively means sharing `&T` (which is safe because `T` is= `Sync`). Additionally, +// `T` is `Send` because XArray is thread-safe and all mutation operations= are internally locked. +unsafe impl Sync for XArray {} --=20 2.47.0