Skip to contentSkip to conversation

rust: add `pin-init` as a dependency to `bindings` and `uapi`

PATCH In review Benno Lossin 3 participants 6 messages May 20, 2025 Rust

lore
Share & tools
lore

Benno Lossin

author reviewer
#0 lore raw

PATCH 1/2 rust: add `pin-init` as a dependency to `bindings` and `uapi`

This allows bindings and uapi to implement Zeroable and use other items from pin-init.

---
 rust/Makefile | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
rust/Makefile +4 -2
index 3aca903a7d08..1bee11ad5452 100644
@@ -513,17 +513,19 @@ $(obj)/ffi.o: private skip_gendwarfksyms = 1
 $(obj)/ffi.o: $(src)/ffi.rs $(obj)/compiler_builtins.o FORCE
 	+$(call if_changed_rule,rustc_library)
 
-$(obj)/bindings.o: private rustc_target_flags = --extern ffi
+$(obj)/bindings.o: private rustc_target_flags = --extern ffi --extern pin_init
 $(obj)/bindings.o: $(src)/bindings/lib.rs \
     $(obj)/ffi.o \
+    $(obj)/pin_init.o \
     $(obj)/bindings/bindings_generated.rs \
     $(obj)/bindings/bindings_helpers_generated.rs FORCE
 	+$(call if_changed_rule,rustc_library)
 
-$(obj)/uapi.o: private rustc_target_flags = --extern ffi
+$(obj)/uapi.o: private rustc_target_flags = --extern ffi --extern pin_init
 $(obj)/uapi.o: private skip_gendwarfksyms = 1
 $(obj)/uapi.o: $(src)/uapi/lib.rs \
     $(obj)/ffi.o \
+    $(obj)/pin_init.o \
     $(obj)/uapi/uapi_generated.rs FORCE
 	+$(call if_changed_rule,rustc_library)
 

base-commit: 22c3335c5dcd33063fe1894676a3a6ff1008d506

Signature · 1 line
2.49.0
author reviewer
#1 lore raw

PATCH 2/2 rust: derive `Zeroable` for all structs & unions generated by bindgen where possible

Using the --with-derive-custom-{struct,union} option of bindgen, add #[derive(MaybeZeroable)] to every struct & union. This makes those types implement Zeroable if all their fields implement it.

Sadly bindgen doesn't add custom derives to the __BindgenBitfieldUnit struct. So manually implement Zeroable for that.

---

This came from a discussion at [1]. The relevant parts for pin-init already got merged into rust-next for v6.16, so we only need to enable them for bindgen.

I'm not sure on the impact of build times and rust-analyzer. We're adding a derive macro to every struct and union emitted by bindgen. Building using my test-config took 28.6s before and 29.1s after this change, but those are only two runs.

Maybe we have to reevaluate this when more C code is scanned by bindgen.

[1]: https://rust-for-linux.zulipchat.com/#narrow/channel/291565-Help/topic/Zeroable.20trait.20for.20C.20structs/with/509711564

---
 rust/bindgen_parameters | 4 ++++
 rust/bindings/lib.rs    | 9 +++++++++
 2 files changed, 13 insertions(+)
rust/bindgen_parameters +4 -0
index 0f96af8b9a7f..fa4c61ba028f 100644
@@ -34,3 +34,7 @@
 # We use const helpers to aid bindgen, to avoid conflicts when constants are
 # recognized, block generation of the non-helper constants.
 --blocklist-item ARCH_SLAB_MINALIGN
+
+# Structs should implement Zeroable when all of their fields do.
+--with-derive-custom-struct .*=pin_init::MaybeZeroable
+--with-derive-custom-union .*=pin_init::MaybeZeroable
rust/bindings/lib.rs +9 -0
index a08eb5518cac..38615c5b090d 100644
@@ -33,6 +33,15 @@ mod bindings_raw {
     type __kernel_ssize_t = isize;
     type __kernel_ptrdiff_t = isize;
 
+    // `bindgen` doesn't automatically do this, see
+    // <https://github.com/rust-lang/rust-bindgen/issues/3196>
+    //
+    // SAFETY: `__BindgenBitfieldUnit<Storage>` is a newtype around `Storage`.
+    unsafe impl<Storage> pin_init::Zeroable for __BindgenBitfieldUnit<Storage> where
+        Storage: pin_init::Zeroable
+    {
+    }
+
     // Use glob import here to expose all helpers.
     // Symbols defined within the module will take precedence to the glob import.
     pub use super::bindings_helper::*;
Signature · 1 line
2.49.0
reviewer
#2 lore raw

Re: [PATCH 2/2] rust: derive `Zeroable` for all structs & unions generated by bindgen where possible

Quoted 4 lines · Benno Lossin

Using the --with-derive-custom-{struct,union} option of bindgen, add #[derive(MaybeZeroable)] to every struct & union. This makes those types implement Zeroable if all their fields implement it.

I think this is a great idea.

Quoted 29 lines

Sadly bindgen doesn't add custom derives to the __BindgenBitfieldUnit struct. So manually implement Zeroable for that.

---

This came from a discussion at [1]. The relevant parts for pin-init already got merged into rust-next for v6.16, so we only need to enable them for bindgen.

I'm not sure on the impact of build times and rust-analyzer. We're adding a derive macro to every struct and union emitted by bindgen. Building using my test-config took 28.6s before and 29.1s after this change, but those are only two runs.

Maybe we have to reevaluate this when more C code is scanned by bindgen.

[1]: https://rust-for-linux.zulipchat.com/#narrow/channel/291565-Help/topic/Zeroable.20trait.20for.20C.20structs/with/509711564

---
 rust/bindgen_parameters | 4 ++++
 rust/bindings/lib.rs    | 9 +++++++++
 2 files changed, 13 insertions(+)
rust/bindgen_parameters +0 -0
index 0f96af8b9a7f..fa4c61ba028f 100644

rust/bindgen_parameters line 40

Quoted 7 lines
rust/bindgen_parameters +4 -0
@@ -34,3 +34,7 @@
 # We use const helpers to aid bindgen, to avoid conflicts when constants are
 # recognized, block generation of the non-helper constants.
 --blocklist-item ARCH_SLAB_MINALIGN
+
+# Structs should implement Zeroable when all of their fields do.
+--with-derive-custom-struct .*=pin_init::MaybeZeroable
+--with-derive-custom-union .*=pin_init::MaybeZeroable

Maybe add an import in bindings/lib.rs and use it directly? Seems a bit nicer to read without the prefix.

Quoted 23 lines
rust/bindings/lib.rs +9 -1
index a08eb5518cac..38615c5b090d 100644
@@ -33,6 +33,15 @@ mod bindings_raw {
     type __kernel_ssize_t = isize;
     type __kernel_ptrdiff_t = isize;
 
+    // `bindgen` doesn't automatically do this, see
+    // <https://github.com/rust-lang/rust-bindgen/issues/3196>
+    //
+    // SAFETY: `__BindgenBitfieldUnit<Storage>` is a newtype around `Storage`.
+    unsafe impl<Storage> pin_init::Zeroable for __BindgenBitfieldUnit<Storage> where
+        Storage: pin_init::Zeroable
+    {
+    }
+
     // Use glob import here to expose all helpers.
     // Symbols defined within the module will take precedence to the glob import.
     pub use super::bindings_helper::*;
--

2.49.0

author reviewer
#3 lore raw

Re: [PATCH 2/2] rust: derive `Zeroable` for all structs & unions generated by bindgen where possible

Quoted 16 lines · Alice Ryhl

rust/bindgen_parameters line 40

Quoted 12 lines · Benno Lossin
rust/bindgen_parameters +4 -0
index 0f96af8b9a7f..fa4c61ba028f 100644
@@ -34,3 +34,7 @@
 # We use const helpers to aid bindgen, to avoid conflicts when constants are
 # recognized, block generation of the non-helper constants.
 --blocklist-item ARCH_SLAB_MINALIGN
+
+# Structs should implement Zeroable when all of their fields do.
+--with-derive-custom-struct .*=pin_init::MaybeZeroable
+--with-derive-custom-union .*=pin_init::MaybeZeroable

Maybe add an import in bindings/lib.rs and use it directly? Seems a bit nicer to read without the prefix.

I don't mind doing this, but I don't really see the value in it. I view the generated bindings from time to time, but having the extra path wouldn't bother me.

I'll add it to the changes on the next version, but if you have some better justification, I'd love to hear it.

---
Cheers,
Benno

author reviewer
#5 lore raw
In reply to Benno Lossin
Quoted 7 lines · Benno Lossin

This allows bindings and uapi to implement Zeroable and use other items from pin-init.

---
 rust/Makefile | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

I also forgot to add this:

Will add it with the new version that also fixes rust-analyzer.

---
Cheers,
Benno