Commit 4846300b authored by Benno Lossin's avatar Benno Lossin Committed by Miguel Ojeda
Browse files

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.

Signed-off-by: default avatarBenno Lossin <lossin@kernel.org>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
[ Formatted comment. - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 3c847e17

rust/bindgen_parameters

+4 −0
Original line number Diff line number Diff line
@@ -35,3 +35,7 @@ 
# recognized, block generation of the non-helper constants.

--blocklist-item ARCH_SLAB_MINALIGN

--blocklist-item ARCH_KMALLOC_MINALIGN



# Structs should implement `Zeroable` when all of their fields do.

--with-derive-custom-struct .*=MaybeZeroable

--with-derive-custom-union .*=MaybeZeroable

rust/bindings/lib.rs

+8 −0
Original line number Diff line number Diff line
@@ -31,11 +31,19 @@ 
#[allow(clippy::undocumented_unsafe_blocks)]

#[cfg_attr(CONFIG_RUSTC_HAS_UNNECESSARY_TRANSMUTES, allow(unnecessary_transmutes))]

mod bindings_raw {

    use pin_init::{MaybeZeroable, Zeroable};



    // Manual definition for blocklisted types.

    type __kernel_size_t = usize;

    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> Zeroable for __BindgenBitfieldUnit<Storage> where Storage: 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::*;

rust/uapi/lib.rs

+2 −0
Original line number Diff line number Diff line
@@ -34,4 +34,6 @@ 
type __kernel_ssize_t = isize;

type __kernel_ptrdiff_t = isize;



use pin_init::MaybeZeroable;



include!(concat!(env!("OBJTREE"), "/rust/uapi/uapi_generated.rs"));