rust: configfs abstractions
Subsystems (4)
Andreas Hindborg
maintainerv3 cover rust: configfs abstractions
This series adds a safe Rust API that allows Rust modules to interface the configfs machinery.
The series contains an example for the samples folder to demonstrate usage of the API. As such, there is no inline example in the documentation.
The last patch adds a maintainer entry for the Rust configfs abstractions, to make it absolutely clear that I will commit to maintain these abstractions, if required. Feel free to drop this patch if this is not required.
The series is a dependency of rnull, the Rust null block driver. Please see [1] for initial configfs support in rnull.
[1] https://github.com/metaspace/linux/tree/9ac53130f5fb05b9b3074fa261b445b8fde547dd/drivers/block/rnull
---
Joel, Christoph: please let me know how you would like to proceed with maintenance and whether you would like to pick these patches through the configfs tree or not.
To: Danilo Krummrich <[email protected]>
To: Miguel Ojeda <[email protected]>
To: Alex Gaynor <[email protected]>
To: Boqun Feng <[email protected]>
To: Gary Guo <[email protected]>
To: Björn Roy Baron <[email protected]>
To: Benno Lossin <[email protected]>
To: Alice Ryhl <[email protected]>
To: Trevor Gross <[email protected]>
To: Joel Becker <[email protected]>
To: Christoph Hellwig <[email protected]>
To: Peter Zijlstra <[email protected]>
To: Ingo Molnar <[email protected]>
To: Will Deacon <[email protected]>
To: Waiman Long <[email protected]>
To: Fiona Behrens <[email protected]>
To: Charalampos Mitrodimas <[email protected]>
---
Changes in v3:
- Allow trailing commas in invocation of configfs_attrs!.
- Use a more suitable C initialization function when initializing Subsystem.
- Split sample into separate patch.
- Add an inline example.
The remaining changes in this version are style fixes, documentation improvements and typo fixes. They are enumerated below:
- Consolidate paste macro calls.
- Do not hard code page size in example.
- Remove prefix of c_str! in sample.
- Use a more descriptive variable name in into_foreign.
- Improve code formatting in macros invocations.
- Add comment related to null terminator in configfs_attrs!
- Move attributes below docstrings.
- Remove a rogue todo.
- Remove trait bound from struct definition GroupOperationsVTable.
- Remove as _ casts.
- Remove GroupOprations::Parent associated type.
- General documentation improvements.
- Explicitly use ArcBorrow for drop_item parameter type.
- Add a comment describing expansion to a call to Attribute::add.
- Add a comment explaining bound check in Attribute::add.
- Link to v2: https://lore.kernel.org/r/[email protected]
Changes in v2:
- Remove generalization over pointer type and enforce use of Arc.
- Use type system to enforce connection between ItemType and Subsystem or Group. Differentiate construction of vtables on this type difference.
- Move drop logic of child nodes from parent to child.
- Pick ForeignOwnable::PointedTo patch as dependency instead of including it here.
- Fix some rustdoc warnings.
- Use CamelCase for generic type parameter declaration.
- Destroy mutex in Subsystem::drop.
- Move GroupOperationsVTable struct definition next to implementation.
- Rebase on v6.14-rc1.
- Link to v1: https://lore.kernel.org/r/[email protected]
---
Andreas Hindborg (4):
rust: sync: change <Arc<T> as ForeignOwnable>::PointedTo to T
rust: configfs: introduce rust support for configfs
rust: configfs: add a sample demonstrating configfs usage
MAINTAINERS: add entry for configfs Rust abstractions
MAINTAINERS | 7 + rust/bindings/bindings_helper.h | 1 + rust/helpers/mutex.c | 5 + rust/kernel/configfs.rs | 938 ++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 2 + rust/kernel/sync/arc.rs | 21 +- samples/rust/Kconfig | 11 + samples/rust/Makefile | 1 + samples/rust/rust_configfs.rs | 179 ++++++++ 9 files changed, 1160 insertions(+), 5 deletions(-)
---
base-commit: 379487e17ca406b47392e7ab6cf35d1c3bacb371
change-id: 20250131-configfs-b888cd82d84a
prerequisite-patch-id: 275efe8e08839e3a0de28ed26e8de80be9852024
Best regards,
Signature · 1 line
Andreas Hindborg <[email protected]>
Andreas Hindborg
maintainerPATCH v3 1/4 rust: sync: change `<Arc<T> as ForeignOwnable>::PointedTo` to `T`
Using ArcInner as PoinedTo in the ForeignOwnable implementation for Arc is a bit unfortunate. Using T as PointedTo does not remove any functionality, but allows ArcInner to be private. Further, it allows downstream users to write code that is generic over Box and Arc, when downstream users need access to T after calling into_foreign.
---
This patch is a dependency for Rust configfs abstractions. It allows both Box and Arc to be used as pointer types in the configfs hierarchy.
--- rust/kernel/sync/arc.rs | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-)
rust/kernel/sync/arc.rs +16 -5
@@ -143,7 +143,7 @@ pub struct Arc<T: ?Sized> {#[doc(hidden)] #[pin_data] #[repr( C )] -pub struct ArcInner <T : ?Sized > { +struct ArcInner <T : ?Sized > { refcount:Opaque <bindings::refcount_t >, data:T , }
@@ -345,18 +345,25 @@ pub fn into_unique_or_drop(self) -> Option<Pin<UniqueArc<T>>> {// SAFETY: The `into_foreign` function returns a pointer that is well-aligned. unsafe impl <T : 'static>ForeignOwnable for Arc <T > { -type PointedTo =ArcInner <T >; +type PointedTo =T ;type Borrowed <'a> =ArcBorrow <'a,T >;type BorrowedMut <'a> =Self ::Borrowed <'a>;fn into_foreign (self) -> *mut Self ::PointedTo { -ManuallyDrop ::new (self).ptr.as_ptr () +let this =ManuallyDrop ::new (self).ptr.as_ptr (); +// SAFETY: `x` is a valid pointer to `Self` so the projection below is +// in bounds of the allocation. +unsafe { core::ptr::addr_of_mut!((*this).data) } }unsafe fn from_foreign (ptr: *mut Self ::PointedTo ) ->Self { +// SAFETY: We did the reverse offset calculation in `into_foreign`, so +// the offset calculation below is in bounds of the allocation. +let inner_ptr =unsafe { kernel::container_of!(ptr,ArcInner <T >, data).cast_mut () }; +// SAFETY: The safety requirements of this function ensure that `ptr` comes from a previous // call to `Self::into_foreign`. -let inner =unsafe {NonNull ::new_unchecked (ptr) }; +let inner =unsafe {NonNull ::new_unchecked (inner_ptr) };// SAFETY: By the safety requirement of this function, we know that `ptr` came from // a previous call to `Arc::into_foreign`, which guarantees that `ptr` is valid and
@@ -365,9 +372,13 @@ unsafe fn from_foreign(ptr: *mut Self::PointedTo) -> Self { }unsafe fn borrow <'a>(ptr: *mut Self ::PointedTo ) ->ArcBorrow <'a,T > { +// SAFETY: We did the reverse offset calculation in `into_foreign`, so +// the offset calculation below is in bounds of the allocation. +let inner_ptr =unsafe { kernel::container_of!(ptr,ArcInner <T >, data).cast_mut () }; +// SAFETY: The safety requirements of this function ensure that `ptr` comes from a previous // call to `Self::into_foreign`. -let inner =unsafe {NonNull ::new_unchecked (ptr) }; +let inner =unsafe {NonNull ::new_unchecked (inner_ptr) };// SAFETY: The safety requirements of `from_foreign` ensure that the object remains alive // for the lifetime of the returned value.
Signature · 1 line
2.47.0
Andreas Hindborg
maintainerPATCH v3 2/4 rust: configfs: introduce rust support for configfs
In reply to Andreas HindborgThis patch adds a rust API for configfs, thus allowing rust modules to use configfs for configuration. The implementation is a shim on top of the C configfs implementation allowing safe use of the C infrastructure from rust.
The patch enables the const_mut_refs feature on compilers before rustc 1.83. The feature was stabilized in rustc 1.83 and is not required to be explicitly enabled on later versions.
---
This patch is a direct dependency for rnull, the rust null block driver.
--- rust/bindings/bindings_helper.h | 1 + rust/helpers/mutex.c | 5 + rust/kernel/configfs.rs | 938 ++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 2 + 4 files changed, 946 insertions(+)
rust/bindings/bindings_helper.h +1 -0
@@ -10,6 +10,7 @@#include <linux/blk-mq.h> #include <linux/blk_types.h> #include <linux/blkdev.h> +#include <linux/configfs.h> #include <linux/cred.h> #include <linux/errname.h> #include <linux/ethtool.h>
rust/helpers/mutex.c +5 -0
@@ -17,3 +17,8 @@ void rust_helper_mutex_assert_is_held(struct mutex *mutex) {lockdep_assert_held (mutex); } + +void rust_helper_mutex_destroy (struct mutex *lock) +{ +mutex_destroy (lock); +}
rust/kernel/configfs.rs new file +938 -0
938 lines not on this page · raw message
rust/kernel/lib.rs +2 -0
@@ -40,6 +40,8 @@pub mod block;#[doc(hidden)] pub mod build_assert; +#[cfg( CONFIG_CONFIGFS_FS )] +pub mod configfs;pub mod cred;pub mod device;pub mod device_id;
Signature · 1 line
2.47.0
Andreas Hindborg
maintainerPATCH v3 3/4 rust: configfs: add a sample demonstrating configfs usage
In reply to Andreas HindborgAdd a sample to the samples folder, demonstrating the intended use of the rust configfs API.
--- samples/rust/Kconfig | 11 +++ samples/rust/Makefile | 1 + samples/rust/rust_configfs.rs | 179 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 191 insertions(+)
samples/rust/Kconfig +11 -0
@@ -10,6 +10,17 @@ menuconfig SAMPLES_RUST if SAMPLES_RUST +config SAMPLE_RUST_CONFIGFS + tristate "Configfs sample" + depends on CONFIGFS_FS + help + This option builds the Rust configfs sample. + + To compile this as a module, choose M here: + the module will be called rust_configfs. + + If unsure, say N. + config SAMPLE_RUST_MINIMAL tristate "Minimal" help
samples/rust/Makefile +1 -0
@@ -6,6 +6,7 @@ obj-$(CONFIG_SAMPLE_RUST_MISC_DEVICE) += rust_misc_device.o obj-$(CONFIG_SAMPLE_RUST_PRINT) += rust_print.o obj-$(CONFIG_SAMPLE_RUST_DRIVER_PCI) += rust_driver_pci.o obj-$(CONFIG_SAMPLE_RUST_DRIVER_PLATFORM) += rust_driver_platform.o +obj-$(CONFIG_SAMPLE_RUST_CONFIGFS) += rust_configfs.o rust_print-y := rust_print_main.o rust_print_events.o
samples/rust/rust_configfs.rs new file +179 -0
179 lines not on this page · raw message
Signature · 1 line
2.47.0
Andreas Hindborg
maintainerPATCH v3 4/4 MAINTAINERS: add entry for configfs Rust abstractions
In reply to Andreas HindborgUpdate MAINTAINERS with entry for Rust configfs abstractions.
--- MAINTAINERS | 7 +++++++ 1 file changed, 7 insertions(+)
MAINTAINERS +7 -0
@@ -5870,6 +5870,13 @@ F: fs/configfs/ F: include/linux/configfs.h F: samples/configfs/ +CONFIGFS [RUST] +M: Andreas Hindborg <[email protected]> +L: [email protected] +S: Supported +F: rust/kernel/configfs.rs +F: samples/rust/rust_configfs.rs + CONGATEC BOARD CONTROLLER MFD DRIVER M: Thomas Richard <[email protected]> S: Maintained
Signature · 1 line
2.47.0
Daniel Almeida
reviewerHi Andreas,
Quoted 14 lines · Andreas Hindborg
This series adds a safe Rust API that allows Rust modules to interface the
configfsmachinery.The series contains an example for the samples folder to demonstrate usage of the API. As such, there is no inline example in the documentation.
The last patch adds a maintainer entry for the Rust configfs abstractions, to make it absolutely clear that I will commit to maintain these abstractions, if required. Feel free to drop this patch if this is not required.
Quoted 5 lines
The series is a dependency of
rnull, the Rust null block driver. Please see [1] for initialconfigfssupport inrnull.[1] https://github.com/metaspace/linux/tree/9ac53130f5fb05b9b3074fa261b445b8fde547dd/drivers/block/rnull
I am trying to test this before reviewing, but I get this error:
```
error[E0308]: mismatched types
--> linux/rust/kernel/miscdevice.rs:300:62
|
300 | let device = unsafe { <T::Ptr as ForeignOwnable>::borrow(private) };
| ---------------------------------- ^^^^^^^ expected `*mut <... as ForeignOwnable>::PointedTo`, found `*mut c_void`
| |
| arguments to this function are incorrect
|
= note: expected raw pointer `*mut <<T as miscdevice::MiscDevice>::Ptr as types::ForeignOwnable>::PointedTo`
found raw pointer `*mut ffi::c_void`
= help: consider constraining the associated type `<<T as miscdevice::MiscDevice>::Ptr as types::ForeignOwnable>::PointedTo` to `ffi::c_void` or calling a method that returns `<<T as miscdevice::MiscDevice>::Ptr as types::ForeignOwnable>::PointedTo`
= note: for more information, visit https://doc.rust-lang.org/book/ch19-03-advanced-traits.html
note: associated function defined here
--> /home/dwls/dev/linux/rust/kernel/types.rs:98:15
|
98 | unsafe fn borrow<'a>(ptr: *mut Self::PointedTo) -> Self::Borrowed<'a>;
| ^^^^^^
error: aborting due to 1 previous error
```— Daniel
Andreas Hindborg
maintainerQuoted 38 lines · Daniel Almeida
Hi Andreas,
Quoted 14 lines · Andreas Hindborg
This series adds a safe Rust API that allows Rust modules to interface the
configfsmachinery.The series contains an example for the samples folder to demonstrate usage of the API. As such, there is no inline example in the documentation.
The last patch adds a maintainer entry for the Rust configfs abstractions, to make it absolutely clear that I will commit to maintain these abstractions, if required. Feel free to drop this patch if this is not required.
Quoted 5 lines
The series is a dependency of
rnull, the Rust null block driver. Please see [1] for initialconfigfssupport inrnull.[1] https://github.com/metaspace/linux/tree/9ac53130f5fb05b9b3074fa261b445b8fde547dd/drivers/block/rnull
I am trying to test this before reviewing, but I get this error:
``` error[E0308]: mismatched types --> linux/rust/kernel/miscdevice.rs:300:62 | 300 | let device = unsafe { <T::Ptr as ForeignOwnable>::borrow(private) }; | ---------------------------------- ^^^^^^^ expected `*mut <... as ForeignOwnable>::PointedTo`, found `*mut c_void` | | | arguments to this function are incorrect | = note: expected raw pointer `*mut <<T as miscdevice::MiscDevice>::Ptr as types::ForeignOwnable>::PointedTo` found raw pointer `*mut ffi::c_void` = help: consider constraining the associated type `<<T as miscdevice::MiscDevice>::Ptr as types::ForeignOwnable>::PointedTo` to `ffi::c_void` or calling a method that returns `<<T as miscdevice::MiscDevice>::Ptr as types::ForeignOwnable>::PointedTo` = note: for more information, visit https://doc.rust-lang.org/book/ch19-03-advanced-traits.html
Quoted 8 lines
note: associated function defined here
--> /home/dwls/dev/linux/rust/kernel/types.rs:98:15
|
98 | unsafe fn borrow<'a>(ptr: *mut Self::PointedTo) -> Self::Borrowed<'a>;
| ^^^^^^
error: aborting due to 1 previous error
```Thanks for testing! It seems there is a bug in the patch "rust: sync:
change <Arc<T> as ForeignOwnable>::PointedTo to T". If you would like to test now, could you either:
- add .cast() on private in miscdevice.rs:300
- or drop patch 1/4 and pick [1] as a dependency instead
- or build with CONFIG_COMPAT=n
Or wait for me to send a new version where I add a dependency on the fixed patch.
Best regards,
Andreas Hindborg