[PATCH v15 0/3] rust: xarray: Add a minimal abstraction for XArray

From: Tamir Duberstein
Date: Thu Feb 06 2025 - 11:25:05 EST


This is a reimagining relative to earlier versions[0] by Asahi Lina and
Maíra Canal.

It is needed to support rust-binder, though this version only provides
enough machinery to support rnull.

Link: https://lore.kernel.org/rust-for-linux/20240309235927.168915-2-mcanal@xxxxxxxxxx/ [0]
---
Changes in v15:
- Rebase on v6.14-rc1.
- Add MAINTAINERS entry.
- Link to v14: https://lore.kernel.org/r/20241217-rust-xarray-bindings-v14-0-9fef3cefcb41@xxxxxxxxx

Changes in v14:
- Remove TODO made stale by Gary Guo's FFI type series.
- Link: https://lore.kernel.org/all/20240913213041.395655-5-gary@xxxxxxxxxxx/
- Link to v13: https://lore.kernel.org/r/20241213-rust-xarray-bindings-v13-0-8655164e624f@xxxxxxxxx

Changes in v13:
- Replace `bool::then` with `if`. (Miguel Ojeda)
- Replace `match` with `let` + `if`. (Miguel Ojeda)
- Link to v12: https://lore.kernel.org/r/20241212-rust-xarray-bindings-v12-0-59ab9b1f4d2e@xxxxxxxxx

Changes in v12:
- Import `core::ptr::NonNull`. (Alice Ryhl)
- Introduce `StoreError` to allow `?` to be used with `Guard::store`.
(Alice Ryhl)
- Replace `{crate,core}::ffi::c_ulong` and clarify TODO with respect to
`usize`. (Alice Ryhl)
- Drop `T: Sync` bound on `impl Sync for XArray<T>`. (Alice Ryhl)
- Reword `Send` and `Sync` safety comments to match the style used in
`lock.rs`. (Alice Ryhl and Andreas
Hindborg)
- Link to v11: https://lore.kernel.org/r/20241203-rust-xarray-bindings-v11-0-58a95d137ec2@xxxxxxxxx

Changes in v11:
- Consolidate imports. (Alice Ryhl)
- Use literal `0` rather than `MIN`. (Alice Ryhl)
- Use bulleted list in SAFETY comment. (Alice Ryhl)
- Document (un)locking behavior of `Guard::store`. (Alice Ryhl)
- Document Normal API behavior WRT `XA_ZERO_ENTRY`. (Alice Ryhl)
- Rewrite `unsafe impl Sync` SAFETY comment. (Andreas Hindborg)
- Link to v10: https://lore.kernel.org/r/20241120-rust-xarray-bindings-v10-0-a25b2b0bf582@xxxxxxxxx

Changes in v10:
- Guard::get takes &self instead of &mut self. (Andreas Hindborg)
- Guard is !Send. (Boqun Feng)
- Add Inspired-by tags. (Maíra Canal and Asahi Lina)
- Rebase on linux-next, use NotThreadSafe. (Alice Ryhl)
- Link to v9: https://lore.kernel.org/r/20241118-rust-xarray-bindings-v9-0-3219cdb53685@xxxxxxxxx

---
Tamir Duberstein (3):
rust: types: add `ForeignOwnable::PointedTo`
rust: xarray: Add an abstraction for XArray
MAINTAINERS: add entry for Rust XArray API

MAINTAINERS | 11 ++
rust/bindings/bindings_helper.h | 6 +
rust/helpers/helpers.c | 1 +
rust/helpers/xarray.c | 28 ++++
rust/kernel/alloc.rs | 5 +
rust/kernel/alloc/kbox.rs | 38 +++---
rust/kernel/lib.rs | 1 +
rust/kernel/miscdevice.rs | 7 +-
rust/kernel/pci.rs | 5 +-
rust/kernel/platform.rs | 5 +-
rust/kernel/sync/arc.rs | 21 +--
rust/kernel/types.rs | 46 ++++---
rust/kernel/xarray.rs | 279 ++++++++++++++++++++++++++++++++++++++++
13 files changed, 408 insertions(+), 45 deletions(-)
---
base-commit: e47e7490144c9fb26590447f73d90538e0934a75
change-id: 20241020-rust-xarray-bindings-bef514142968

Best regards,
--
Tamir Duberstein <tamird@xxxxxxxxx>