Quality of life improvements for pin-init
Subsystems (2)
v4 cover Quality of life improvements for pin-init
This patch series adds several improvements to the pin-init api:
- a derive macro for the Zeroable trait,
- makes hygiene of fields in initializers behave like normal struct initializers would behave,
- prevent stackoverflow without optimizations
- add ..Zeroable::zeroed() syntax to zero missing fields,
- support arbitrary paths in initializer macros.
It is based on the rust-dev branch.
This is the fourth version of this patch series.
- v3: https://lore.kernel.org/rust-for-linux/[email protected]/
- v2: https://lore.kernel.org/rust-for-linux/[email protected]/
- v1: https://lore.kernel.org/rust-for-linux/[email protected]/
Changes not present on modified commits:
v3 -> v4:
No changes.
v2 -> v3:
- make #[pin_data] work better with #[cfg] attributes on fields.
v1 -> v2:
- implement Zeroable for Opaque,
- remove blanket impl of PinInit for Init and make it a supertrait instead,
- add {pin_}chain functions to execute code after initialization,
- update the example macro expansion.
Benno Lossin (13):
rust: init: consolidate init macros
rust: init: make #[pin_data] compatible with conditional compilation
of fields
rust: add derive macro for Zeroable
rust: init: make guards in the init macros hygienic
rust: init: wrap type checking struct initializers in a closure
rust: init: make initializer values inaccessible after initializing
rust: init: add ..Zeroable::zeroed() syntax for zeroing all missing
fields
rust: init: Add functions to create array initializers
rust: init: add support for arbitrary paths in init macros
rust: init: implement Zeroable for UnsafeCell<T> and Opaque<T>
rust: init: make PinInit<T, E> a supertrait of Init<T, E>
rust: init: add {pin_}chain functions to {Pin}Init<T, E>
rust: init: update expanded macro explanation
rust/kernel/init.rs | 646 ++++++++++++++------------------- rust/kernel/init/__internal.rs | 39 +- rust/kernel/init/macros.rs | 519 +++++++++++++++++++++++--- rust/kernel/prelude.rs | 2 +- rust/macros/lib.rs | 20 + rust/macros/quote.rs | 12 + rust/macros/zeroable.rs | 72 ++++ 7 files changed, 857 insertions(+), 453 deletions(-) create mode 100644 rust/macros/zeroable.rs
base-commit: e73e793b32b7c440a53fd4da75a34c062841b66f
Signature · 1 line
2.41.0
PATCH v4 1/13 rust: init: consolidate init macros
Merges the implementations of try_init! and try_pin_init!. These two macros are very similar, but use different traits. The new macro __init_internal! that is now the implementation for both takes these traits as parameters.
This change does not affect any users, as no public API has been changed, but it should simplify maintaining the init macros.
---
v3 -> v4:
No changes.
v2 -> v3:
- added Reviewed-by's from Martin and Alice.
v1 -> v2:
- added Reviewed-by from Björn.
rust/kernel/init.rs | 388 +++---------------------------------- rust/kernel/init/macros.rs | 237 +++++++++++++++++++++- 2 files changed, 259 insertions(+), 366 deletions(-)
rust/kernel/init.rs +24 -364
@@ -548,11 +548,14 @@ macro_rules! pin_init { ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { $($fields:tt)* }) => { - $crate::try_pin_init!( + $crate::__init_internal!( @this ($($this)?), @typ ($t $(::<$($generics),*>)?), @fields ($($fields)*), @error (::core::convert::Infallible ), + @data (PinData , use_data), + @has_data (HasPinData , __pin_data), + @construct_closure (pin_init_from_closure), ) }; }
@@ -601,205 +604,29 @@ macro_rules! try_pin_init { ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { $($fields:tt)* }) => { - $crate::try_pin_init!( + $crate::__init_internal!( @this($($this)?), @typ($t $(::<$($generics),*>)? ), @fields($($fields)*), @error($crate::error::Error), + @data(PinData, use_data), + @has_data(HasPinData, __pin_data), + @construct_closure(pin_init_from_closure), ) }; ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { $($fields:tt)* }? $err:ty) => { - $crate::try_pin_init!( + $crate::__init_internal!( @this($($this)?), @typ($t $(::<$($generics),*>)? ), @fields($($fields)*), @error($err), + @data(PinData, use_data), + @has_data(HasPinData, __pin_data), + @construct_closure(pin_init_from_closure), ) }; - ( - @this($($this:ident)?), - @typ($t:ident $(::<$($generics:ty),*>)?), - @fields($($fields:tt)*), - @error($err:ty), - ) => {{ - // We do not want to allow arbitrary returns, so we declare this type as the `Ok` return - // type and shadow it later when we insert the arbitrary user code. That way there will be - // no possibility of returning without `unsafe`. - struct __InitOk; - // Get the pin data from the supplied type. - let data = unsafe { - use $crate::init::__internal::HasPinData; - $t$(::<$($generics),*>)?::__pin_data() - }; - // Ensure that `data` really is of type `PinData` and help with type inference: - let init = $crate::init::__internal::PinData::make_closure::<_, __InitOk, $err>( - data, - move |slot| { - { - // Shadow the structure so it cannot be used to return early. - struct __InitOk; - // Create the `this` so it can be referenced by the user inside of the - // expressions creating the individual fields. - $(let $this = unsafe { ::core::ptr::NonNull::new_unchecked(slot) };)? - // Initialize every field. - $crate::try_pin_init!(init_slot: - @data(data), - @slot(slot), - @munch_fields($($fields)*,), - ); - // We use unreachable code to ensure that all fields have been mentioned exactly - // once, this struct initializer will still be type-checked and complain with a - // very natural error message if a field is forgotten/mentioned more than once. - #[allow(unreachable_code, clippy::diverging_sub_expression)] - if false { - $crate::try_pin_init!(make_initializer: - @slot(slot), - @type_name($t), - @munch_fields($($fields)*,), - @acc(), - ); - } - // Forget all guards, since initialization was a success. - $crate::try_pin_init!(forget_guards: - @munch_fields($($fields)*,), - ); - } - Ok(__InitOk) - } - ); - let init = move |slot| -> ::core::result::Result<(), $err> { - init(slot).map(|__InitOk| ()) - }; - let init = unsafe { $crate::init::pin_init_from_closure::<_, $err>(init) }; - init - }}; - (init_slot: - @data($data:ident), - @slot($slot:ident), - @munch_fields($(,)?), - ) => { - // Endpoint of munching, no fields are left. - }; - (init_slot: - @data($data:ident), - @slot($slot:ident), - // In-place initialization syntax. - @munch_fields($field:ident <- $val:expr, $($rest:tt)*), - ) => { - let $field = $val; - // Call the initializer. - // - // SAFETY: `slot` is valid, because we are inside of an initializer closure, we - // return when an error/panic occurs. - // We also use the `data` to require the correct trait (`Init` or `PinInit`) for `$field`. - unsafe { $data.$field(::core::ptr::addr_of_mut!((*$slot).$field), $field)? }; - // Create the drop guard. - // - // We only give access to `&DropGuard`, so it cannot be forgotten via safe code. - // - // SAFETY: We forget the guard later when initialization has succeeded. - let $field = &unsafe { - $crate::init::__internal::DropGuard::new(::core::ptr::addr_of_mut!((*$slot).$field)) - }; - - $crate::try_pin_init!(init_slot: - @data($data), - @slot($slot), - @munch_fields($($rest)*), - ); - }; - (init_slot: - @data($data:ident), - @slot($slot:ident), - // Direct value init, this is safe for every field. - @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), - ) => { - $(let $field = $val;)? - // Initialize the field. - // - // SAFETY: The memory at `slot` is uninitialized. - unsafe { ::core::ptr::write(::core::ptr::addr_of_mut!((*$slot).$field), $field) }; - // Create the drop guard: - // - // We only give access to `&DropGuard`, so it cannot be accidentally forgotten. - // - // SAFETY: We forget the guard later when initialization has succeeded. - let $field = &unsafe { - $crate::init::__internal::DropGuard::new(::core::ptr::addr_of_mut!((*$slot).$field)) - }; - - $crate::try_pin_init!(init_slot: - @data($data), - @slot($slot), - @munch_fields($($rest)*), - ); - }; - (make_initializer: - @slot($slot:ident), - @type_name($t:ident), - @munch_fields($(,)?), - @acc($($acc:tt)*), - ) => { - // Endpoint, nothing more to munch, create the initializer. - // Since we are in the `if false` branch, this will never get executed. We abuse `slot` to - // get the correct type inference here: - unsafe { - ::core::ptr::write($slot, $t { - $($acc)* - }); - } - }; - (make_initializer: - @slot($slot:ident), - @type_name($t:ident), - @munch_fields($field:ident <- $val:expr, $($rest:tt)*), - @acc($($acc:tt)*), - ) => { - $crate::try_pin_init!(make_initializer: - @slot($slot), - @type_name($t), - @munch_fields($($rest)*), - @acc($($acc)* $field: ::core::panic!(),), - ); - }; - (make_initializer: - @slot($slot:ident), - @type_name($t:ident), - @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), - @acc($($acc:tt)*), - ) => { - $crate::try_pin_init!(make_initializer: - @slot($slot), - @type_name($t), - @munch_fields($($rest)*), - @acc($($acc)* $field: ::core::panic!(),), - ); - }; - (forget_guards: - @munch_fields($(,)?), - ) => { - // Munching finished. - }; - (forget_guards: - @munch_fields($field:ident <- $val:expr, $($rest:tt)*), - ) => { - unsafe { $crate::init::__internal::DropGuard::forget($field) }; - - $crate::try_pin_init!(forget_guards: - @munch_fields($($rest)*), - ); - }; - (forget_guards: - @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), - ) => { - unsafe { $crate::init::__internal::DropGuard::forget($field) }; - - $crate::try_pin_init!(forget_guards: - @munch_fields($($rest)*), - ); - }; } /// Construct an in-place initializer for `struct`s.
@@ -824,11 +651,14 @@ macro_rules! init { ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { $($fields:tt)* }) => { - $crate::try_init!( + $crate::__init_internal!( @this($($this)?), @typ($t $(::<$($generics),*>)?), @fields($($fields)*), @error(::core::convert::Infallible), + @data(InitData, /*no use_data*/), + @has_data(HasInitData, __init_data), + @construct_closure(init_from_closure), ) } }
@@ -871,199 +701,29 @@ macro_rules! try_init { ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { $($fields:tt)* }) => { - $crate::try_init!( + $crate::__init_internal!( @this($($this)?), @typ($t $(::<$($generics),*>)?), @fields($($fields)*), @error($crate::error::Error), + @data(InitData, /*no use_data*/), + @has_data(HasInitData, __init_data), + @construct_closure(init_from_closure), ) }; ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { $($fields:tt)* }? $err:ty) => { - $crate::try_init!( + $crate::__init_internal!( @this($($this)?), @typ($t $(::<$($generics),*>)?), @fields($($fields)*), @error($err), + @data(InitData, /*no use_data*/), + @has_data(HasInitData, __init_data), + @construct_closure(init_from_closure), ) }; - ( - @this($($this:ident)?), - @typ($t:ident $(::<$($generics:ty),*>)?), - @fields($($fields:tt)*), - @error($err:ty), - ) => {{ - // We do not want to allow arbitrary returns, so we declare this type as the `Ok` return - // type and shadow it later when we insert the arbitrary user code. That way there will be - // no possibility of returning without `unsafe`. - struct __InitOk; - // Get the init data from the supplied type. - let data = unsafe { - use $crate::init::__internal::HasInitData; - $t$(::<$($generics),*>)?::__init_data() - }; - // Ensure that `data` really is of type `InitData` and help with type inference: - let init = $crate::init::__internal::InitData::make_closure::<_, __InitOk, $err>( - data, - move |slot| { - { - // Shadow the structure so it cannot be used to return early. - struct __InitOk; - // Create the `this` so it can be referenced by the user inside of the - // expressions creating the individual fields. - $(let $this = unsafe { ::core::ptr::NonNull::new_unchecked(slot) };)? - // Initialize every field. - $crate::try_init!(init_slot: - @slot(slot), - @munch_fields($($fields)*,), - ); - // We use unreachable code to ensure that all fields have been mentioned exactly - // once, this struct initializer will still be type-checked and complain with a - // very natural error message if a field is forgotten/mentioned more than once. - #[allow(unreachable_code, clippy::diverging_sub_expression)] - if false { - $crate::try_init!(make_initializer: - @slot(slot), - @type_name($t), - @munch_fields($($fields)*,), - @acc(), - ); - } - // Forget all guards, since initialization was a success. - $crate::try_init!(forget_guards: - @munch_fields($($fields)*,), - ); - } - Ok(__InitOk) - } - ); - let init = move |slot| -> ::core::result::Result<(), $err> { - init(slot).map(|__InitOk| ()) - }; - let init = unsafe { $crate::init::init_from_closure::<_, $err>(init) }; - init - }}; - (init_slot: - @slot($slot:ident), - @munch_fields( $(,)?), - ) => { - // Endpoint of munching, no fields are left. - }; - (init_slot: - @slot($slot:ident), - @munch_fields($field:ident <- $val:expr, $($rest:tt)*), - ) => { - let $field = $val; - // Call the initializer. - // - // SAFETY: `slot` is valid, because we are inside of an initializer closure, we - // return when an error/panic occurs. - unsafe { - $crate::init::Init::__init($field, ::core::ptr::addr_of_mut!((*$slot).$field))?; - } - // Create the drop guard. - // - // We only give access to `&DropGuard`, so it cannot be accidentally forgotten. - // - // SAFETY: We forget the guard later when initialization has succeeded. - let $field = &unsafe { - $crate::init::__internal::DropGuard::new(::core::ptr::addr_of_mut!((*$slot).$field)) - }; - - $crate::try_init!(init_slot: - @slot($slot), - @munch_fields($($rest)*), - ); - }; - (init_slot: - @slot($slot:ident), - // Direct value init. - @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), - ) => { - $(let $field = $val;)? - // Call the initializer. - // - // SAFETY: The memory at `slot` is uninitialized. - unsafe { ::core::ptr::write(::core::ptr::addr_of_mut!((*$slot).$field), $field) }; - // Create the drop guard. - // - // We only give access to `&DropGuard`, so it cannot be accidentally forgotten. - // - // SAFETY: We forget the guard later when initialization has succeeded. - let $field = &unsafe { - $crate::init::__internal::DropGuard::new(::core::ptr::addr_of_mut!((*$slot).$field)) - }; - - $crate::try_init!(init_slot: - @slot($slot), - @munch_fields($($rest)*), - ); - }; - (make_initializer: - @slot($slot:ident), - @type_name($t:ident), - @munch_fields( $(,)?), - @acc($($acc:tt)*), - ) => { - // Endpoint, nothing more to munch, create the initializer. - // Since we are in the `if false` branch, this will never get executed. We abuse `slot` to - // get the correct type inference here: - unsafe { - ::core::ptr::write($slot, $t { - $($acc)* - }); - } - }; - (make_initializer: - @slot($slot:ident), - @type_name($t:ident), - @munch_fields($field:ident <- $val:expr, $($rest:tt)*), - @acc($($acc:tt)*), - ) => { - $crate::try_init!(make_initializer: - @slot($slot), - @type_name($t), - @munch_fields($($rest)*), - @acc($($acc)*$field: ::core::panic!(),), - ); - }; - (make_initializer: - @slot($slot:ident), - @type_name($t:ident), - @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), - @acc($($acc:tt)*), - ) => { - $crate::try_init!(make_initializer: - @slot($slot), - @type_name($t), - @munch_fields($($rest)*), - @acc($($acc)*$field: ::core::panic!(),), - ); - }; - (forget_guards: - @munch_fields($(,)?), - ) => { - // Munching finished. - }; - (forget_guards: - @munch_fields($field:ident <- $val:expr, $($rest:tt)*), - ) => { - unsafe { $crate::init::__internal::DropGuard::forget($field) }; - - $crate::try_init!(forget_guards: - @munch_fields($($rest)*), - ); - }; - (forget_guards: - @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), - ) => { - unsafe { $crate::init::__internal::DropGuard::forget($field) }; - - $crate::try_init!(forget_guards: - @munch_fields($($rest)*), - ); - }; } /// A pin-initializer for the type `T`.
rust/kernel/init/macros.rs +235 -2
248 lines not on this page · raw message
Signature · 1 line
2.41.0
PATCH v4 2/13 rust: init: make `#[pin_data]` compatible with conditional compilation of fields
In reply to Benno LossinThis patch allows one to write
```
#[pin_data]
pub struct Foo {
#[cfg(CONFIG_BAR)]
a: Bar,
#[cfg(not(CONFIG_BAR))]
a: Baz,
}
```Before, this would result in a compile error, because #[pin_data] would generate two functions named a for both fields unconditionally.
---
v3 -> v4:
- added Reviewed-by's from Gary, Alice and Martin.
rust/kernel/init/macros.rs | 2 ++ 1 file changed, 2 insertions(+)
rust/kernel/init/macros.rs +2 -0
@@ -962,6 +962,7 @@ impl<$($impl_generics)*> $pin_data<$($ty_generics)*> where $($whr)* { $( + $(#[$($p_attr)*])* $pvis unsafe fn $p_field<E>( self, slot: *mut $p_type,
@@ -971,6 +972,7 @@ impl<$($impl_generics)*> $pin_data<$($ty_generics)*> } )* $( + $(#[$($attr)*])* $fvis unsafe fn $field<E>( self, slot: *mut $type,
Signature · 1 line
2.41.0
PATCH v4 3/13 rust: add derive macro for `Zeroable`
In reply to Benno LossinAdd a derive proc-macro for the Zeroable trait. The macro supports structs where every field implements the Zeroable trait. This way unsafe implementations can be avoided.
The macro is split into two parts:
- a proc-macro to parse generics into impl and ty generics,
- a declarative macro that expands to the impl block.
---
v3 -> v4:
- add support for + in quote!.
v2 -> v3:
- change derive behavior, instead of adding Zeroable bounds for every field, add them only for generic type parameters,
- still check that every field implements Zeroable,
- removed Reviewed-by's due to changes.
v1 -> v2:
- fix Zeroable path,
- add Reviewed-by from Gary and Björn.
rust/kernel/init/macros.rs | 35 ++++++++++++++++++ rust/kernel/prelude.rs | 2 +- rust/macros/lib.rs | 20 +++++++++++ rust/macros/quote.rs | 12 +++++++ rust/macros/zeroable.rs | 72 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 rust/macros/zeroable.rs
rust/kernel/init/macros.rs +35 -0
@@ -1215,3 +1215,38 @@ macro_rules! __init_internal { ); }; } + +#[doc(hidden)] +#[macro_export] +macro_rules! __derive_zeroable { + (parse_input: + @sig( + $(#[$($struct_attr:tt)*])* + $vis:visstruct $name:ident + $(where $($whr:tt)*)? + ), + @impl_generics($($impl_generics:tt)*), + @ty_generics($($ty_generics:tt)*), + @body({ + $( + $(#[$($field_attr:tt)*])* + $field:ident : $field_ty:ty + ),* $(,)? + }), + ) => { +// SAFETY: every field type implements `Zeroable` and padding bytes may be zero. +#[automatically_derived] +unsafe impl <$($impl_generics)*> $crate::init::Zeroable for $name<$($ty_generics)*> +where + $($($whr)*)? + {} +const _: () = { +fn assert_zeroable <T : ?::core::marker::Sized + $crate::init::Zeroable >() {} +fn ensure_zeroable <$($impl_generics)*>() +where $($($whr)*)? + { + $(assert_zeroable ::<$field_ty>();)* + } + }; + }; +}
rust/kernel/prelude.rs +1 -1
@@ -18,7 +18,7 @@pub use alloc::{boxed::Box , vec::Vec };#[doc(no_inline)] -pub use macros::{module, pin_data, pinned_drop, vtable}; +pub use macros::{module, pin_data, pinned_drop, vtable,Zeroable };pub use super ::build_assert;
rust/macros/lib.rs +20 -0
@@ -11,6 +11,7 @@mod pin_data;mod pinned_drop;mod vtable; +mod zeroable;use proc_macro::TokenStream ;
@@ -343,3 +344,22 @@ pub fn paste(input: TokenStream) -> TokenStream { paste::expand (&mut tokens); tokens.into_iter ().collect () } + +/// Derives the [`Zeroable`] trait for the given struct. +/// +/// This can only be used for structs where every field implements the [`Zeroable`] trait. +/// +/// # Examples +/// +/// ```rust +/// #[derive(Zeroable)] +/// pub struct DriverData { +/// id: i64, +/// buf_ptr: *mut u8, +/// len: usize, +/// } +/// ``` +#[proc_macro_derive( Zeroable )] +pub fn derive_zeroable (input:TokenStream ) ->TokenStream { + zeroable::derive (input) +}
rust/macros/quote.rs +12 -0
@@ -124,6 +124,18 @@ macro_rules! quote_spanned { ));quote_spanned! (@proc $v $span $($tt)*); }; + (@proc $v:ident $span:ident ; $($tt:tt)*) => { + $v.push(::proc_macro::TokenTree::Punct( + ::proc_macro::Punct::new(';', ::proc_macro::Spacing::Alone) + )); + quote_spanned!(@proc $v $span $($tt)*); + }; + (@proc $v:ident $span:ident + $($tt:tt)*) => { + $v.push(::proc_macro::TokenTree::Punct( + ::proc_macro::Punct::new('+', ::proc_macro::Spacing::Alone) + )); + quote_spanned!(@proc $v $span $($tt)*); + }; (@proc $v:ident $span:ident $id:ident $($tt:tt)*) => { $v.push(::proc_macro::TokenTree::Ident(::proc_macro::Ident::new(stringify!($id), $span))); quote_spanned!(@proc $v $span $($tt)*);
rust/macros/zeroable.rs new file +72 -0
72 lines not on this page · raw message
Signature · 1 line
2.41.0
Re: [PATCH v4 03/13] rust: add derive macro for `Zeroable`
Quoted 20 lines · Benno Lossin
Add a derive proc-macro for the
Zeroabletrait. The macro supports structs where every field implements theZeroabletrait. This wayunsafeimplementations can be avoided.The macro is split into two parts:
- a proc-macro to parse generics into impl and ty generics,
- a declarative macro that expands to the impl block.Suggested-by Asahi Lina <[email protected]>Signed-off-by Benno Lossin <[email protected]>---
v3 -> v4:
- add support for+inquote!.v2 -> v3:
- change derive behavior, instead of addingZeroablebounds for every field, add them only for generic type parameters,
- still check that every field implementsZeroable,
- removed Reviewed-by's due to changes.
Quoted 5 lines
v1 -> v2:
- fix Zeroable path,
- add Reviewed-by from Gary and Björn.[...]
Re: [PATCH v4 03/13] rust: add derive macro for `Zeroable`
In reply to Benno LossinQuoted 10 lines · On Mon, 14 Aug 2023 08:46:41 +0000 Benno Lossin <[email protected]> wrote:
Add a derive proc-macro for the
Zeroabletrait. The macro supports structs where every field implements theZeroabletrait. This wayunsafeimplementations can be avoided.The macro is split into two parts:
- a proc-macro to parse generics into impl and ty generics,
- a declarative macro that expands to the impl block.Suggested-by Asahi Lina <[email protected]>Signed-off-by Benno Lossin <[email protected]>
Quoted 214 lines
---
v3 -> v4:
- add support for+inquote!.v2 -> v3:
- change derive behavior, instead of addingZeroablebounds for every field, add them only for generic type parameters,
- still check that every field implementsZeroable,
- removed Reviewed-by's due to changes.v1 -> v2:
- fix Zeroable path,
- add Reviewed-by from Gary and Björn.rust/kernel/init/macros.rs | 35 ++++++++++++++++++ rust/kernel/prelude.rs | 2 +- rust/macros/lib.rs | 20 +++++++++++ rust/macros/quote.rs | 12 +++++++ rust/macros/zeroable.rs | 72 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 rust/macros/zeroable.rsrust/kernel/init/macros.rs +35
-0@@ -1215,3 +1215,38 @@ macro_rules! __init_internal { ); }; } + +#[doc(hidden)] +#[macro_export] +macro_rules! __derive_zeroable { + (parse_input: + @sig( + $(#[$($struct_attr:tt)*])* + $vis:visstruct $name:ident + $(where $($whr:tt)*)? + ), + @impl_generics($($impl_generics:tt)*), + @ty_generics($($ty_generics:tt)*), + @body({ + $( + $(#[$($field_attr:tt)*])* + $field:ident : $field_ty:ty + ),* $(,)? + }), + ) => { +// SAFETY: every field type implements `Zeroable` and padding bytes may be zero. +#[automatically_derived] +unsafe impl <$($impl_generics)*> $crate::init::Zeroable for $name<$($ty_generics)*> +where + $($($whr)*)? + {} +const _: () = { +fn assert_zeroable <T : ?::core::marker::Sized + $crate::init::Zeroable >() {} +fn ensure_zeroable <$($impl_generics)*>() +where $($($whr)*)? + { + $(assert_zeroable ::<$field_ty>();)* + } + }; + }; +}rust/kernel/prelude.rs +1
-1@@ -18,7 +18,7 @@pub use alloc::{boxed::Box , vec::Vec };#[doc(no_inline)] -pub use macros::{module, pin_data, pinned_drop, vtable}; +pub use macros::{module, pin_data, pinned_drop, vtable,Zeroable };pub use super ::build_assert;rust/macros/lib.rs +20
-0@@ -11,6 +11,7 @@mod pin_data;mod pinned_drop;mod vtable; +mod zeroable;use proc_macro::TokenStream ;@@ -343,3 +344,22 @@ pub fn paste(input: TokenStream) -> TokenStream { paste::expand (&mut tokens); tokens.into_iter ().collect () } + +/// Derives the [`Zeroable`] trait for the given struct. +/// +/// This can only be used for structs where every field implements the [`Zeroable`] trait. +/// +/// # Examples +/// +/// ```rust +/// #[derive(Zeroable)] +/// pub struct DriverData { +/// id: i64, +/// buf_ptr: *mut u8, +/// len: usize, +/// } +/// ``` +#[proc_macro_derive( Zeroable )] +pub fn derive_zeroable (input:TokenStream ) ->TokenStream { + zeroable::derive (input) +}rust/macros/quote.rs +12
-0@@ -124,6 +124,18 @@ macro_rules! quote_spanned { ));quote_spanned! (@proc $v $span $($tt)*); }; + (@proc $v:ident $span:ident ; $($tt:tt)*) => { + $v.push(::proc_macro::TokenTree::Punct( + ::proc_macro::Punct::new(';', ::proc_macro::Spacing::Alone) + )); + quote_spanned!(@proc $v $span $($tt)*); + }; + (@proc $v:ident $span:ident + $($tt:tt)*) => { + $v.push(::proc_macro::TokenTree::Punct( + ::proc_macro::Punct::new('+', ::proc_macro::Spacing::Alone) + )); + quote_spanned!(@proc $v $span $($tt)*); + }; (@proc $v:ident $span:ident $id:ident $($tt:tt)*) => { $v.push(::proc_macro::TokenTree::Ident(::proc_macro::Ident::new(stringify!($id), $span))); quote_spanned!(@proc $v $span $($tt)*);rust/macros/zeroable.rs new file +72
-0@@ -0,0 +1,72 @@ +// SPDX-License-Identifier: GPL-2.0 + +use crate ::helpers::{parse_generics,Generics }; +use proc_macro::{TokenStream ,TokenTree }; + +pub (crate )fn derive (input:TokenStream ) ->TokenStream { +let ( +Generics { + impl_generics, + ty_generics, + }, +mut rest, + ) =parse_generics (input); +// This should be the body of the struct `{...}`. +let last = rest.pop (); +// Now we insert `Zeroable` as a bound for every generic parameter in `impl_generics`. +let mut new_impl_generics =Vec ::with_capacity (impl_generics.len ()); +// Are we inside of a generic where we want to add `Zeroable`? +let mut in_generic = !impl_generics.is_empty (); +// Have we already inserted `Zeroable`? +let mut inserted =false ; +// Level of `<>` nestings. +let mut nested =0 ; +for ttin impl_generics { +match &tt { +// If we find a `,`, then we have finished a generic/constant/lifetime parameter. +TokenTree ::Punct (p)if nested ==0 && p.as_char () ==',' => { +if in_generic && !inserted { + new_impl_generics.extend (quote! { : ::kernel::init::Zeroable }); + } + in_generic =true ; + inserted =false ; + new_impl_generics.push (tt); + } +// If we find `'`, then we are entering a lifetime. +TokenTree ::Punct (p)if nested ==0 && p.as_char () =='\'' => { + in_generic =false ; + new_impl_generics.push (tt); + } +TokenTree ::Punct (p)if nested ==0 && p.as_char () ==':' => { + new_impl_generics.push (tt); +if in_generic { + new_impl_generics.extend (quote! { ::kernel::init::Zeroable + }); + inserted =true ; + } + } +TokenTree ::Punct (p)if p.as_char () =='<' => { + nested +=1 ; + new_impl_generics.push (tt); + } +TokenTree ::Punct (p)if p.as_char () =='>' => { +assert! (nested >0 ); + nested -=1 ; + new_impl_generics.push (tt); + } + _ => new_impl_generics.push (tt), + } + } +assert_eq! (nested,0 ); +if in_generic && !inserted { + new_impl_generics.extend (quote! { : ::kernel::init::Zeroable }); + } +quote! { + ::kernel::__derive_zeroable!( +parse_input : + @sig(#(#rest)*), + @impl_generics (#(#new_impl_generics)*), + @ty_generics (#(#ty_generics)*), + @body (#last), + ); + } +}
PATCH v4 4/13 rust: init: make guards in the init macros hygienic
In reply to Benno LossinUse hygienic identifiers for the guards instead of the field names. This makes the init macros feel more like normal struct initializers, since assigning identifiers with the name of a field does not create conflicts.
Also change the internals of the guards, no need to make the forget function unsafe, since users cannot access the guards anyways. Now the guards are carried directly on the stack and have no extra Cell<bool> field that marks if they have been forgotten or not, instead they are just forgotten via mem::forget.
---
v3 -> v4:
- added Reviewed-by from Gary.
v2 -> v3:
- added Reviewed-by's from Martin and Alice.
v1 -> v2:
- use Gary's paste! macro to create the guard hygiene.
rust/kernel/init.rs | 1 - rust/kernel/init/__internal.rs | 25 ++----- rust/kernel/init/macros.rs | 116 +++++++++++++++------------------ 3 files changed, 56 insertions(+), 86 deletions(-)
rust/kernel/init.rs +0 -1
@@ -216,7 +216,6 @@use alloc::boxed::Box ;use core::{ alloc::AllocError , - cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit ,
rust/kernel/init/__internal.rs +4 -21
@@ -174,7 +174,6 @@ pub fn init<E>(self: Pin<&mut Self>, init: impl PinInit<T, E>) -> Result<Pin<&mu/// Can be forgotten to prevent the drop. pub struct DropGuard <T : ?Sized > { ptr: *mut T , - do_drop:Cell <bool >, }impl <T : ?Sized >DropGuard <T > {
@@ -190,32 +189,16 @@ impl<T: ?Sized> DropGuard<T> {/// - will not be dropped by any other means. #[inline] pub unsafe fn new (ptr: *mut T ) ->Self { -Self { - ptr, - do_drop:Cell ::new (true ), - } - } - -/// Prevents this guard from dropping the supplied pointer. -/// -/// # Safety -/// -/// This function is unsafe in order to prevent safe code from forgetting this guard. It should -/// only be called by the macros in this module. -#[inline] -pub unsafe fn forget (&self) { - self.do_drop.set (false ); +Self { ptr } } }impl <T : ?Sized >Drop for DropGuard <T > {#[inline] fn drop (&mut self) { -if self.do_drop.get () { -// SAFETY: A `DropGuard` can only be constructed using the unsafe `new` function -// ensuring that this operation is safe. -unsafe { ptr::drop_in_place (self.ptr) } - } +// SAFETY: A `DropGuard` can only be constructed using the unsafe `new` function +// ensuring that this operation is safe. +unsafe { ptr::drop_in_place (self.ptr) } } }
rust/kernel/init/macros.rs +52 -64
183 lines not on this page · raw message
Signature · 1 line
2.41.0
PATCH v4 5/13 rust: init: wrap type checking struct initializers in a closure
In reply to Benno LossinIn the implementation of the init macros there is a if false statement that type checks the initializer to ensure every field is initialized. Since the next patch has a stack variable to store the struct, the function might allocate too much memory on debug builds. Putting the struct into a closure that is never executed ensures that even in debug builds no stack overflow error is caused. In release builds this was not a problem since the code was optimized away due to the if false.
---
v3 -> v4:
- added Reviewed-by from Gary.
v2 -> v3:
- added Reviewed-by's from Martin and Alice.
v1 -> v2:
- do not call the created closure.
rust/kernel/init/macros.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
rust/kernel/init/macros.rs +4 -4
@@ -1040,14 +1040,14 @@ macro_rules! __init_internal {// once, this struct initializer will still be type-checked and complain with a // very natural error message if a field is forgotten/mentioned more than once. #[allow(unreachable_code, clippy::diverging_sub_expression)] -if false { +let _ = || { $crate::__init_internal!(make_initializer : @slot(slot), @type_name ($t), @munch_fields ($($fields)*,), @acc (), ); - } + }; }Ok (__InitOk) }
@@ -1168,8 +1168,8 @@ macro_rules! __init_internal { @acc($($acc:tt)*), ) => { // Endpoint, nothing more to munch, create the initializer. - // Since we are in the `if false` branch, this will never get executed. We abuse `slot` to - // get the correct type inference here: + // Since we are in the closure that is never called, this will never get executed. + // We abuse `slot` to get the correct type inference here: unsafe { ::core::ptr::write($slot, $t { $($acc)*
Signature · 1 line
2.41.0
PATCH v4 6/13 rust: init: make initializer values inaccessible after initializing
In reply to Benno LossinPreviously the init macros would create a local variable with the name and hygiene of the field that is being initialized to store the value of the field. This would override any user defined variables. For example:
```
struct Foo {
a: usize,
b: usize,
}
let a = 10;
let foo = init!(Foo{
a: a + 1, // This creates a local variable named `a`.
b: a, // This refers to that variable!
});
let foo = Box::init!(foo)?;
assert_eq!(foo.a, 11);
assert_eq!(foo.b, 11);
```This patch changes this behavior, so the above code would panic at the last assertion, since b would have value 10.
---
v3 -> v4:
- added Reviewed-by from Gary.
v2 -> v3:
- added Reviewed-by's from Martin and Alice.
rust/kernel/init/macros.rs | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-)
rust/kernel/init/macros.rs +11 -9
@@ -1075,13 +1075,13 @@ macro_rules! __init_internal {// In-place initialization syntax. @munch_fields($field:ident <- $val:expr, $($rest:tt)*), ) => { - let $field = $val; +let init = $val;// Call the initializer. // // SAFETY: `slot` is valid, because we are inside of an initializer closure, we // return when an error/panic occurs. // We also use the `data` to require the correct trait (`Init` or `PinInit`) for `$field`. - unsafe { $data.$field(::core::ptr::addr_of_mut!((*$slot).$field), $field)? }; + unsafe { $data.$field(::core::ptr::addr_of_mut!((*$slot).$field), init)? };// Create the drop guard: // // We rely on macro hygiene to make it impossible for users to access this local variable.
@@ -1107,12 +1107,12 @@ macro_rules! __init_internal {// In-place initialization syntax. @munch_fields($field:ident <- $val:expr, $($rest:tt)*), ) => { - let $field = $val; +let init = $val;// Call the initializer. // // SAFETY: `slot` is valid, because we are inside of an initializer closure, we // return when an error/panic occurs. -unsafe { $crate::init::Init ::__init ($field, ::core::ptr::addr_of_mut!((*$slot).$field))? }; +unsafe { $crate::init::Init ::__init (init, ::core::ptr::addr_of_mut!((*$slot).$field))? };// Create the drop guard: // // We rely on macro hygiene to make it impossible for users to access this local variable.
@@ -1138,11 +1138,13 @@ macro_rules! __init_internal {// Init by-value. @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), ) => { - $(let $field = $val;)? -// Initialize the field. -// -// SAFETY: The memory at `slot` is uninitialized. -unsafe { ::core::ptr::write (::core::ptr::addr_of_mut!((*$slot).$field), $field) }; + { + $(let $field = $val;)? +// Initialize the field. +// +// SAFETY: The memory at `slot` is uninitialized. +unsafe { ::core::ptr::write (::core::ptr::addr_of_mut!((*$slot).$field), $field) }; + }// Create the drop guard: // // We rely on macro hygiene to make it impossible for users to access this local variable.
Signature · 1 line
2.41.0
PATCH v4 7/13 rust: init: add `..Zeroable::zeroed()` syntax for zeroing all missing fields
In reply to Benno LossinAdd the struct update syntax to the init macros, but only for ..Zeroable::zeroed(). Adding this at the end of the struct initializer allows one to omit fields from the initializer, these fields will be initialized with 0x00 set to every byte. Only types that implement the Zeroable trait can utilize this.
---
v3 -> v4:
- added Reviewed-by from Gary.
v2 -> v3:
- changed if false argument to use never executed closure,
- added Reviewed-by's from Martin and Alice.
v1 -> v2:
- fix doctest imports,
- fix doctest examples,
- fix Zeroable path in the __init_internal macro,
- rename is_zeroable -> assert_zeroable,
- add missing {} to the case when ..Zeroable::zeroed() is present,
- add allow(unused_assignments) in the type-checked struct initializer.
rust/kernel/init.rs | 16 +++++- rust/kernel/init/macros.rs | 115 ++++++++++++++++++++++++++++++++++++- 2 files changed, 129 insertions(+), 2 deletions(-)
rust/kernel/init.rs +15 -1
@@ -517,13 +517,17 @@ macro_rules! stack_try_pin_init {/// - Fields that you want to initialize in-place have to use `<-` instead of `:`. /// - In front of the initializer you can write `&this in` to have access to a [`NonNull<Self>`] /// pointer named `this` inside of the initializer. +/// - Using struct update syntax one can place `..Zeroable::zeroed()` at the very end of the +/// struct, this initializes every field with 0 and then runs all initializers specified in the +/// body. This can only be done if [`Zeroable`] is implemented for the struct. /// /// For instance: /// /// ```rust -/// # use kernel::{macros::pin_data, pin_init}; +/// # use kernel::{macros::{Zeroable, pin_data}, pin_init}; /// # use core::{ptr::addr_of_mut, marker::PhantomPinned}; /// #[pin_data] +/// #[derive(Zeroable)] /// struct Buf { /// // `ptr` points into `buf`. /// ptr: *mut u8,
@@ -536,6 +540,10 @@ macro_rules! stack_try_pin_init {/// ptr: unsafe { addr_of_mut!((*this.as_ptr()).buf).cast() }, /// pin: PhantomPinned, /// }); +/// pin_init!(Buf { +/// buf: [1; 64], +/// ..Zeroable::zeroed() +/// }); /// ``` /// /// [`try_pin_init!`]: kernel::try_pin_init
@@ -555,6 +563,7 @@ macro_rules! pin_init { @data(PinData, use_data), @has_data(HasPinData, __pin_data), @construct_closure(pin_init_from_closure), + @munch_fields($($fields)*), ) }; }
@@ -611,6 +620,7 @@ macro_rules! try_pin_init { @data(PinData, use_data), @has_data(HasPinData, __pin_data), @construct_closure(pin_init_from_closure), + @munch_fields($($fields)*), ) }; ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? {
@@ -624,6 +634,7 @@ macro_rules! try_pin_init { @data(PinData, use_data), @has_data(HasPinData, __pin_data), @construct_closure(pin_init_from_closure), + @munch_fields($($fields)*), ) }; }
@@ -658,6 +669,7 @@ macro_rules! init { @data(InitData, /*no use_data*/), @has_data(HasInitData, __init_data), @construct_closure(init_from_closure), + @munch_fields($($fields)*), ) } }
@@ -708,6 +720,7 @@ macro_rules! try_init { @data(InitData, /*no use_data*/), @has_data(HasInitData, __init_data), @construct_closure(init_from_closure), + @munch_fields($($fields)*), ) }; ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? {
@@ -721,6 +734,7 @@ macro_rules! try_init { @data(InitData, /*no use_data*/), @has_data(HasInitData, __init_data), @construct_closure(init_from_closure), + @munch_fields($($fields)*), ) }; }
rust/kernel/init/macros.rs +114 -1
145 lines not on this page · raw message
Signature · 1 line
2.41.0
PATCH v4 8/13 rust: init: Add functions to create array initializers
In reply to Benno LossinAdd two functions pin_init_array_from_fn and init_array_from_fn that take a function that generates initializers for T from usize, the added functions then return an initializer for [T; N] where every element is initialized by an element returned from the generator function.
---
v3 -> v4:
- changed example size from 1_000_000_000 to 1_000,
- made functions unwind-safe by using a ScopeGuard,
- added Reviewed-by from Martin.
v2 -> v3:
- changed doctest: instead of printing the array, assert the length,
- added Reviewed-by's from Alice.
v1 -> v2:
- fix warnings and errors in doctests,
- replace dropping loop with drop_in_place and slice_from_raw_parts_mut inside of {pin_}init_array_from_fn functions.
rust/kernel/init.rs | 88 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+)
rust/kernel/init.rs +88 -0
@@ -212,6 +212,7 @@use crate ::{ error::{self,Error }, sync::UniqueArc , + types::ScopeGuard , };use alloc::boxed::Box ;use core::{
@@ -875,6 +876,93 @@ pub fn uninit<T, E>() -> impl Init<MaybeUninit<T>, E> {unsafe {init_from_closure (|_|Ok (())) } } +/// Initializes an array by initializing each element via the provided initializer. +/// +/// # Examples +/// +/// ```rust +/// use kernel::{error::Error, init::init_array_from_fn}; +/// let array: Box<[usize; 1_000]>= Box::init::<Error>(init_array_from_fn(|i| i)).unwrap(); +/// assert_eq!(array.len(), 1_000); +/// ``` +pub fn init_array_from_fn <I ,const N :usize ,T ,E >( +mut make_init:impl FnMut (usize ) ->I , +) ->impl Init <[T ;N ],E > +where +I :Init <T ,E >, +{ +let init =move |slot: *mut [T ;N ]| { +let slot = slot.cast ::<T >(); +// Counts the number of initialized elements and when dropped drops that many elements from +// `slot`. +let mut init_count =ScopeGuard ::new_with_data (0 , |i| { +// We now free every element that has been initialized before: +// SAFETY: The loop initialized exactly the values from 0..i and since we +// return `Err` below, the caller will consider the memory at `slot` as +// uninitialized. +unsafe { ptr::drop_in_place (ptr::slice_from_raw_parts_mut (slot, i)) }; + }); +for iin 0 ..N { +let init =make_init (i); +// SAFETY: since 0 <= `i` < N, it is still in bounds of `[T; N]`. +let ptr =unsafe { slot.add (i) }; +// SAFETY: The pointer is derived from `slot` and thus satisfies the `__init` +// requirements. +unsafe { init.__init (ptr) }?; + *init_count +=1 ; + } + init_count.dismiss (); +Ok (()) + }; +// SAFETY: The initializer above initializes every element of the array. On failure it drops +// any initialized elements and returns `Err`. +unsafe {init_from_closure (init) } +} + +/// Initializes an array by initializing each element via the provided initializer. +/// +/// # Examples +/// +/// ```rust +/// use kernel::{sync::{Arc, Mutex}, init::pin_init_array_from_fn, new_mutex}; +/// let array: Arc<[Mutex<usize>; 1_000]>= +/// Arc::pin_init(pin_init_array_from_fn(|i| new_mutex!(i))).unwrap(); +/// assert_eq!(array.len(), 1_000); +/// ``` +pub fn pin_init_array_from_fn <I ,const N :usize ,T ,E >( +mut make_init:impl FnMut (usize ) ->I , +) ->impl PinInit <[T ;N ],E > +where +I :PinInit <T ,E >, +{ +let init =move |slot: *mut [T ;N ]| { +let slot = slot.cast ::<T >(); +// Counts the number of initialized elements and when dropped drops that many elements from +// `slot`. +let mut init_count =ScopeGuard ::new_with_data (0 , |i| { +// We now free every element that has been initialized before: +// SAFETY: The loop initialized exactly the values from 0..i and since we +// return `Err` below, the caller will consider the memory at `slot` as +// uninitialized. +unsafe { ptr::drop_in_place (ptr::slice_from_raw_parts_mut (slot, i)) }; + }); +for iin 0 ..N { +let init =make_init (i); +// SAFETY: since 0 <= `i` < N, it is still in bounds of `[T; N]`. +let ptr =unsafe { slot.add (i) }; +// SAFETY: The pointer is derived from `slot` and thus satisfies the `__init` +// requirements. +unsafe { init.__pinned_init (ptr) }?; + *init_count +=1 ; + } + init_count.dismiss (); +Ok (()) + }; +// SAFETY: The initializer above initializes every element of the array. On failure it drops +// any initialized elements and returns `Err`. +unsafe {pin_init_from_closure (init) } +} +// SAFETY: Every type can be initialized by-value. unsafe impl <T ,E >Init <T ,E >for T {unsafe fn __init (self, slot: *mut T ) ->Result <(),E > {
Signature · 1 line
2.41.0
Gary Guo
maintainerRe: [PATCH v4 08/13] rust: init: Add functions to create array initializers
Quoted 121 lines · On Mon, 14 Aug 2023 08:47:15 +0000 Benno Lossin <[email protected]> wrote:
Add two functions
pin_init_array_from_fnandinit_array_from_fnthat take a function that generates initializers forTfrom usize, the added functions then return an initializer for[T; N]where every element is initialized by an element returned from the generator function.Suggested-by Asahi Lina <[email protected]>Reviewed-by Björn Roy Baron <[email protected]>Reviewed-by Alice Ryhl <[email protected]>Reviewed-by Martin Rodriguez Reboredo <[email protected]>Signed-off-by Benno Lossin <[email protected]>---
v3 -> v4:
- changed example size from 1_000_000_000 to 1_000,
- made functions unwind-safe by using a ScopeGuard,
- added Reviewed-by from Martin.v2 -> v3:
- changed doctest: instead of printing the array, assert the length,
- added Reviewed-by's from Alice.v1 -> v2:
- fix warnings and errors in doctests,
- replace dropping loop withdrop_in_placeandslice_from_raw_parts_mutinside of{pin_}init_array_from_fnfunctions.rust/kernel/init.rs | 88 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+)rust/kernel/init.rs +78
-0@@ -212,6 +212,7 @@use crate ::{ error::{self,Error }, sync::UniqueArc , + types::ScopeGuard , };use alloc::boxed::Box ;use core::{@@ -875,6 +876,93 @@ pub fn uninit<T, E>() -> impl Init<MaybeUninit<T>, E> {unsafe {init_from_closure (|_|Ok (())) } } +/// Initializes an array by initializing each element via the provided initializer. +/// +/// # Examples +/// +/// ```rust +/// use kernel::{error::Error, init::init_array_from_fn}; +/// let array: Box<[usize; 1_000]>= Box::init::<Error>(init_array_from_fn(|i| i)).unwrap(); +/// assert_eq!(array.len(), 1_000); +/// ``` +pub fn init_array_from_fn <I ,const N :usize ,T ,E >( +mut make_init:impl FnMut (usize ) ->I , +) ->impl Init <[T ;N ],E > +where +I :Init <T ,E >, +{ +let init =move |slot: *mut [T ;N ]| { +let slot = slot.cast ::<T >(); +// Counts the number of initialized elements and when dropped drops that many elements from +// `slot`. +let mut init_count =ScopeGuard ::new_with_data (0 , |i| { +// We now free every element that has been initialized before: +// SAFETY: The loop initialized exactly the values from 0..i and since we +// return `Err` below, the caller will consider the memory at `slot` as +// uninitialized. +unsafe { ptr::drop_in_place (ptr::slice_from_raw_parts_mut (slot, i)) }; + }); +for iin 0 ..N { +let init =make_init (i); +// SAFETY: since 0 <= `i` < N, it is still in bounds of `[T; N]`. +let ptr =unsafe { slot.add (i) }; +// SAFETY: The pointer is derived from `slot` and thus satisfies the `__init` +// requirements. +unsafe { init.__init (ptr) }?; + *init_count +=1 ; + } + init_count.dismiss (); +Ok (()) + }; +// SAFETY: The initializer above initializes every element of the array. On failure it drops +// any initialized elements and returns `Err`. +unsafe {init_from_closure (init) } +} + +/// Initializes an array by initializing each element via the provided initializer. +/// +/// # Examples +/// +/// ```rust +/// use kernel::{sync::{Arc, Mutex}, init::pin_init_array_from_fn, new_mutex}; +/// let array: Arc<[Mutex<usize>; 1_000]>= +/// Arc::pin_init(pin_init_array_from_fn(|i| new_mutex!(i))).unwrap(); +/// assert_eq!(array.len(), 1_000); +/// ``` +pub fn pin_init_array_from_fn <I ,const N :usize ,T ,E >( +mut make_init:impl FnMut (usize ) ->I , +) ->impl PinInit <[T ;N ],E > +where +I :PinInit <T ,E >, +{ +let init =move |slot: *mut [T ;N ]| { +let slot = slot.cast ::<T >(); +// Counts the number of initialized elements and when dropped drops that many elements from +// `slot`. +let mut init_count =ScopeGuard ::new_with_data (0 , |i| { +// We now free every element that has been initialized before: +// SAFETY: The loop initialized exactly the values from 0..i and since we +// return `Err` below, the caller will consider the memory at `slot` as +// uninitialized. +unsafe { ptr::drop_in_place (ptr::slice_from_raw_parts_mut (slot, i)) }; + }); +for iin 0 ..N { +let init =make_init (i); +// SAFETY: since 0 <= `i` < N, it is still in bounds of `[T; N]`. +let ptr =unsafe { slot.add (i) }; +// SAFETY: The pointer is derived from `slot` and thus satisfies the `__init` +// requirements. +unsafe { init.__pinned_init (ptr) }?;
rust/kernel/init.rs pub fn uninit<T, E>() -> impl Init<MaybeUninit<T>, E> { · line 965
Quoted 10 lines
rust/kernel/init.rs +10
-0+ *init_count +=1 ; + } + init_count.dismiss (); +Ok (()) + }; +// SAFETY: The initializer above initializes every element of the array. On failure it drops +// any initialized elements and returns `Err`. +unsafe {pin_init_from_closure (init) } +} +
I wonder instead of two nearly identical function, whether this could be a single type that returns a struct which is Init if the initializer is (would need patch 11).
Quoted 3 lines
rust/kernel/init.rs +0
-0// SAFETY: Every type can be initialized by-value. unsafe impl <T ,E >Init <T ,E >for T {unsafe fn __init (self, slot: *mut T ) ->Result <(),E > {
PATCH v4 9/13 rust: init: add support for arbitrary paths in init macros
In reply to Benno LossinPreviously only ident and generic types were supported in the {try_}{pin_}init! macros. This patch allows arbitrary path fragments, so for example Foo::Bar but also very complex paths such as <Foo as Baz>::Bar::<0, i32>.
Internally this is accomplished by using path fragments. Due to some peculiar declarative macro limitations, we have to "forget" certain additional parsing information in the token trees. This is achieved by using the paste! proc macro. It does not actually modify the input, since no [< >] will be present in the input, so it just strips the information held by declarative macros. For example, if a declarative macro takes $t:path as its input, it cannot sensibly propagate this to a macro that takes $($p:tt)* as its input, since the $t token will only be considered one tt token for the second macro. If we first pipe the tokens through paste!, then it parses as expected.
---
v3 -> v4:
- added Reviewed-by from Gary.
v2 -> v3:
- added Reviewed-by's from Martin and Alice.
v1 -> v2:
- use Gary's paste! macro instead of retokenize,
- remove the retokenize macro.
rust/kernel/init/macros.rs | 54 ++++++++++++++++++++++++-------------- 1 file changed, 35 insertions(+), 19 deletions(-)
rust/kernel/init/macros.rs +35 -19
@@ -1000,7 +1000,7 @@ impl<$($impl_generics)*> $pin_data<$($ty_generics)*>macro_rules! __init_internal { ( @this($($this:ident)?), - @typ($t:ident $(::<$($generics:ty),*>)?), + @typ($t:path), @fields($($fields:tt)*), @error($err:ty), // Either `PinData` or `InitData`, `$use_data` should only be present in the `PinData`
@@ -1014,7 +1014,7 @@ macro_rules! __init_internal { ) => { $crate::__init_internal!(with_update_parsed : @this($($this)?), - @typ ($t $(::<$($generics),*>)? ), + @typ ($t), @fields ($($fields)*), @error ($err), @data ($data, $($use_data)?),
@@ -1025,7 +1025,7 @@ macro_rules! __init_internal { }; ( @this($($this:ident)?), - @typ($t:ident $(::<$($generics:ty),*>)?), + @typ($t:path), @fields($($fields:tt)*), @error($err:ty), // Either `PinData` or `InitData`, `$use_data` should only be present in the `PinData`
@@ -1039,7 +1039,7 @@ macro_rules! __init_internal { ) => { $crate::__init_internal!(with_update_parsed : @this($($this)?), - @typ ($t $(::<$($generics),*>)? ), + @typ ($t), @fields ($($fields)*), @error ($err), @data ($data, $($use_data)?),
@@ -1050,7 +1050,7 @@ macro_rules! __init_internal { }; ( @this($($this:ident)?), - @typ($t:ident $(::<$($generics:ty),*>)?), + @typ($t:path), @fields($($fields:tt)*), @error($err:ty), // Either `PinData` or `InitData`, `$use_data` should only be present in the `PinData`
@@ -1064,7 +1064,7 @@ macro_rules! __init_internal { ) => { $crate::__init_internal!( @this ($($this)?), - @typ ($t $(::<$($generics),*>)? ), + @typ ($t), @fields ($($fields)*), @error ($err), @data ($data, $($use_data)?),
@@ -1075,7 +1075,7 @@ macro_rules! __init_internal { }; (with_update_parsed: @this($($this:ident)?), - @typ($t:ident $(::<$($generics:ty),*>)?), + @typ($t:path), @fields($($fields:tt)*), @error($err:ty), // Either `PinData` or `InitData`, `$use_data` should only be present in the `PinData`
@@ -1094,7 +1094,11 @@ macro_rules! __init_internal {// Get the data about fields from the supplied type. let data =unsafe { use $crate::init::__internal::$has_data; - $t$(::<$($generics),*>)?::$get_data() +// Here we abuse `paste!` to retokenize `$t`. Declarative macros have some internal +// information that is associated to already parsed fragments, so a path fragment +// cannot be used in this position. Doing the retokenization results in valid rust +// code. + ::kernel::macros::paste!($t::$get_data()) };// Ensure that `data` really is of type `$data` and help with type inference: let init = $crate::init::__internal::$data::make_closure::<_, __InitOk, $err>(
@@ -1253,7 +1257,7 @@ fn assert_zeroable<T: $crate::init::Zeroable>(_: *mut T) {} }; (make_initializer: @slot($slot:ident), - @type_name($t:ident), + @type_name($t:path), @munch_fields(..Zeroable::zeroed() $(,)?), @acc($($acc:tt)*), ) => {
@@ -1270,15 +1274,21 @@ fn assert_zeroable<T: $crate::init::Zeroable>(_: *mut T) {}// not get executed, so it has no effect. ::core::ptr::write ($slot, zeroed); zeroed = ::core::mem::zeroed (); - ::core::ptr::write($slot, $t { - $($acc)* - ..zeroed - }); +// Here we abuse `paste!` to retokenize `$t`. Declarative macros have some internal +// information that is associated to already parsed fragments, so a path fragment +// cannot be used in this position. Doing the retokenization results in valid rust +// code. + ::kernel::macros::paste!( + ::core::ptr::write ($slot, $t { + $($acc)* + ..zeroed + }); + ); } }; (make_initializer: @slot($slot:ident), - @type_name($t:ident), + @type_name($t:path), @munch_fields($(,)?), @acc($($acc:tt)*), ) => {
@@ -1286,14 +1296,20 @@ fn assert_zeroable<T: $crate::init::Zeroable>(_: *mut T) {}// Since we are in the closure that is never called, this will never get executed. // We abuse `slot` to get the correct type inference here: unsafe { - ::core::ptr::write($slot, $t { - $($acc)* - }); +// Here we abuse `paste!` to retokenize `$t`. Declarative macros have some internal +// information that is associated to already parsed fragments, so a path fragment +// cannot be used in this position. Doing the retokenization results in valid rust +// code. + ::kernel::macros::paste!( + ::core::ptr::write($slot, $t { + $($acc)* + }); + ); } }; (make_initializer: @slot($slot:ident), - @type_name($t:ident), + @type_name($t:path), @munch_fields($field:ident <- $val:expr, $($rest:tt)*), @acc($($acc:tt)*), ) => {
@@ -1306,7 +1322,7 @@ fn assert_zeroable<T: $crate::init::Zeroable>(_: *mut T) {} }; (make_initializer: @slot($slot:ident), - @type_name($t:ident), + @type_name($t:path), @munch_fields($field:ident $(: $val:expr)?, $($rest:tt)*), @acc($($acc:tt)*), ) => {
Signature · 1 line
2.41.0
PATCH v4 10/13 rust: init: implement `Zeroable` for `UnsafeCell<T>` and `Opaque<T>`
In reply to Benno LossinUnsafeCell<T> and T have the same layout so if T is Zeroable then so should UnsafeCell<T> be. This allows using the derive macro for Zeroable on types that contain an UnsafeCell<T>. Since Opaque<T> contains a MaybeUninit<T>, all bytes zero is a valid bit pattern for that type.
---
v3 -> v4:
- added Reviewed-by's from Gary and Martin.
v2 -> v3:
- also implement Zeroable for UnsafeCell<T> when T: Zeroable,
- use impl_zeroable! instead of derive(Zeroable).
rust/kernel/init.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)
rust/kernel/init.rs +7 -1
@@ -212,11 +212,12 @@use crate ::{ error::{self,Error }, sync::UniqueArc , - types::ScopeGuard , + types::{Opaque ,ScopeGuard }, };use alloc::boxed::Box ;use core::{ alloc::AllocError , + cell::UnsafeCell , convert::Infallible , marker::PhantomData , mem::MaybeUninit ,
@@ -1159,6 +1160,11 @@ macro_rules! impl_zeroable { // SAFETY: Type is allowed to take any value, including all zeros. {<T>} MaybeUninit<T>, + // SAFETY: Type is allowed to take any value, including all zeros. + {<T>} Opaque<T>, + + // SAFETY: `T: Zeroable` and `UnsafeCell` is `repr(transparent)`. + {<T: ?Sized + Zeroable>} UnsafeCell<T>, // SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). Option<NonZeroU8>, Option<NonZeroU16>, Option<NonZeroU32>, Option<NonZeroU64>,
Signature · 1 line
2.41.0
PATCH v4 11/13 rust: init: make `PinInit<T, E>` a supertrait of `Init<T, E>`
In reply to Benno LossinRemove the blanket implementation of `PinInit<T, E> for I where I:
Init<T, E>. This blanket implementation prevented custom types that implement PinInit`.
---
v3 -> v4:
- added Reviewed-by from Gary.
v2 -> v3:
- add blank missing line,
- added Reviewed-by's from Martin and Alice.
rust/kernel/init.rs | 21 ++++++++------------- rust/kernel/init/__internal.rs | 12 ++++++++++++ 2 files changed, 20 insertions(+), 13 deletions(-)
rust/kernel/init.rs +8 -13
@@ -807,7 +807,7 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// /// [`Arc<T>`]: crate::sync::Arc #[must_use = "An initializer must be used in order to create its value." ] -pub unsafe trait Init <T : ?Sized ,E =Infallible >:Sized { +pub unsafe trait Init <T : ?Sized ,E =Infallible >:PinInit <T ,E > {/// Initializes `slot`. /// /// # Safety
@@ -818,18 +818,6 @@ pub unsafe trait Init<T: ?Sized, E = Infallible>: Sized {unsafe fn __init (self, slot: *mut T ) ->Result <(),E >; } -// SAFETY: Every in-place initializer can also be used as a pin-initializer. -unsafe impl <T : ?Sized ,E ,I >PinInit <T ,E >for I -where -I :Init <T ,E >, -{ -unsafe fn __pinned_init (self, slot: *mut T ) ->Result <(),E > { -// SAFETY: `__init` meets the same requirements as `__pinned_init`, except that it does not -// require `slot` to not move after init. -unsafe { self.__init (slot) } - } -} -/// Creates a new [`PinInit<T, E>`] from the given closure. /// /// # Safety
@@ -972,6 +960,13 @@ unsafe fn __init(self, slot: *mut T) -> Result<(), E> { } } +// SAFETY: Every type can be initialized by-value. `__pinned_init` calls `__init`. +unsafe impl <T ,E >PinInit <T ,E >for T { +unsafe fn __pinned_init (self, slot: *mut T ) ->Result <(),E > { +unsafe { self.__init (slot) } + } +} +/// Smart pointer that can initialize memory in-place. pub trait InPlaceInit <T >:Sized {/// Use the given pin-initializer to pin-initialize a `T` inside of a new smart pointer of this
rust/kernel/init/__internal.rs +12 -0
@@ -32,6 +32,18 @@ unsafe fn __init(self, slot: *mut T) -> Result<(), E> { } } +// SAFETY: While constructing the `InitClosure`, the user promised that it upholds the +// `__pinned_init` invariants. +unsafe impl <T : ?Sized ,F ,E >PinInit <T ,E >for InitClosure <F ,T ,E > +where +F :FnOnce (*mut T ) ->Result <(),E >, +{ +#[inline] +unsafe fn __pinned_init (self, slot: *mut T ) ->Result <(),E > { + (self.0 )(slot) + } +} +/// This trait is only implemented via the `#[pin_data]` proc-macro. It is used to facilitate /// the pin projections within the initializers. ///
Signature · 1 line
2.41.0
PATCH v4 12/13 rust: init: add `{pin_}chain` functions to `{Pin}Init<T, E>`
In reply to Benno LossinThe {pin_}chain functions extend an initializer: it not only initializes the value, but also executes a closure taking a reference to the initialized value. This allows to do something with a value directly after initialization.
---
v3 -> v4:
- added Reviewed-by from Martin.
v2 -> v3:
- clarify that if f errors, the already initialized value will be dropped in both functions.
rust/kernel/init.rs | 142 +++++++++++++++++++++++++++++++++ rust/kernel/init/__internal.rs | 2 +- 2 files changed, 143 insertions(+), 1 deletion(-)
rust/kernel/init.rs +142 -0
@@ -775,6 +775,79 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// deallocate. /// - `slot` will not move until it is dropped, i.e. it will be pinned. unsafe fn __pinned_init (self, slot: *mut T ) ->Result <(),E >; + +/// First initializes the value using `self` then calls the function `f` with the initialized +/// value. +/// +/// If `f` returns an error the value is dropped and the initializer will forward the error. +/// +/// # Examples +/// +/// ```rust +/// # #![allow(clippy::disallowed_names)] +/// use kernel::{types::Opaque, init::pin_init_from_closure}; +/// #[repr(C)] +/// struct RawFoo([u8; 16]); +/// extern { +/// fn init_foo(_: *mut RawFoo); +/// } +/// +/// #[pin_data] +/// struct Foo { +/// #[pin] +/// raw: Opaque<RawFoo>, +/// } +/// +/// impl Foo { +/// fn setup(self: Pin<&mut Self>) { +/// pr_info!("Setting up foo"); +/// } +/// } +/// +/// let foo = pin_init!(Foo { +/// raw <- unsafe { +/// Opaque::ffi_init(|s| { +/// init_foo(s); +/// }) +/// }, +/// }).pin_chain(|foo| { +/// foo.setup(); +/// Ok(()) +/// }); +/// ``` +fn pin_chain <F >(self, f:F ) ->ChainPinInit <Self ,F ,T ,E > +where +F :FnOnce (Pin <&mut T >) ->Result <(),E >, + { +ChainPinInit (self, f,PhantomData ) + } +} + +/// An initializer returned by [`PinInit::pin_chain`]. +pub struct ChainPinInit <I ,F ,T : ?Sized ,E >(I ,F , __internal::Invariant <(E ,Box <T >)>); + +// SAFETY: the `__pinned_init` function is implemented such that it +// - returns `Ok(())` on successful initialization, +// - returns `Err(err)` on error and in this case `slot` will be dropped. +// - considers `slot` pinned. +unsafe impl <T : ?Sized ,E ,I ,F >PinInit <T ,E >for ChainPinInit <I ,F ,T ,E > +where +I :PinInit <T ,E >, +F :FnOnce (Pin <&mut T >) ->Result <(),E >, +{ +unsafe fn __pinned_init (self, slot: *mut T ) ->Result <(),E > { +// SAFETY: all requirements fulfilled since this function is `__pinned_init`. +unsafe { self.0 .__pinned_init (slot)? }; +// SAFETY: The above call initialized `slot` and we still have unique access. +let val =unsafe { &mut *slot }; +// SAFETY: `slot` is considered pinned +let val =unsafe {Pin ::new_unchecked (val) }; + (self.1 )(val).map_err (|e| { +// SAFETY: `slot` was initialized above. +unsafe { core::ptr::drop_in_place (slot) }; + e + }) + } }/// An initializer for `T`.
@@ -816,6 +889,75 @@ pub unsafe trait Init<T: ?Sized, E = Infallible>: PinInit<T, E> {/// - the caller does not touch `slot` when `Err` is returned, they are only permitted to /// deallocate. unsafe fn __init (self, slot: *mut T ) ->Result <(),E >; + +/// First initializes the value using `self` then calls the function `f` with the initialized +/// value. +/// +/// If `f` returns an error the value is dropped and the initializer will forward the error. +/// +/// # Examples +/// +/// ```rust +/// # #![allow(clippy::disallowed_names)] +/// use kernel::{types::Opaque, init::{self, init_from_closure}}; +/// struct Foo { +/// buf: [u8; 1_000_000], +/// } +/// +/// impl Foo { +/// fn setup(&mut self) { +/// pr_info!("Setting up foo"); +/// } +/// } +/// +/// let foo = init!(Foo { +/// buf <- init::zeroed() +/// }).chain(|foo| { +/// foo.setup(); +/// Ok(()) +/// }); +/// ``` +fn chain <F >(self, f:F ) ->ChainInit <Self ,F ,T ,E > +where +F :FnOnce (&mut T ) ->Result <(),E >, + { +ChainInit (self, f,PhantomData ) + } +} + +/// An initializer returned by [`Init::chain`]. +pub struct ChainInit <I ,F ,T : ?Sized ,E >(I ,F , __internal::Invariant <(E ,Box <T >)>); + +// SAFETY: the `__init` function is implemented such that it +// - returns `Ok(())` on successful initialization, +// - returns `Err(err)` on error and in this case `slot` will be dropped. +unsafe impl <T : ?Sized ,E ,I ,F >Init <T ,E >for ChainInit <I ,F ,T ,E > +where +I :Init <T ,E >, +F :FnOnce (&mut T ) ->Result <(),E >, +{ +unsafe fn __init (self, slot: *mut T ) ->Result <(),E > { +// SAFETY: all requirements fulfilled since this function is `__init`. +unsafe { self.0 .__pinned_init (slot)? }; +// SAFETY: The above call initialized `slot` and we still have unique access. + (self.1 )(unsafe { &mut *slot }).map_err (|e| { +// SAFETY: `slot` was initialized above. +unsafe { core::ptr::drop_in_place (slot) }; + e + }) + } +} + +// SAFETY: `__pinned_init` behaves exactly the same as `__init`. +unsafe impl <T : ?Sized ,E ,I ,F >PinInit <T ,E >for ChainInit <I ,F ,T ,E > +where +I :Init <T ,E >, +F :FnOnce (&mut T ) ->Result <(),E >, +{ +unsafe fn __pinned_init (self, slot: *mut T ) ->Result <(),E > { +// SAFETY: `__init` has less strict requirements compared to `__pinned_init`. +unsafe { self.__init (slot) } + } }/// Creates a new [`PinInit<T, E>`] from the given closure.
rust/kernel/init/__internal.rs +1 -1
@@ -13,7 +13,7 @@/// /// [nomicon]: https://doc.rust-lang.org/nomicon/subtyping.html /// [this table]: https://doc.rust-lang.org/nomicon/phantom-data.html#table-of-phantomdata-patterns -type Invariant <T > =PhantomData <fn (*mut T ) -> *mut T >; +pub (super )type Invariant <T > =PhantomData <fn (*mut T ) -> *mut T >;/// This is the module-internal type implementing `PinInit` and `Init`. It is unsafe to create this /// type, since the closure needs to fulfill the same safety requirement as the
Signature · 1 line
2.41.0
Re: [PATCH v4 12/13] rust: init: add `{pin_}chain` functions to `{Pin}Init<T, E>`
Quoted 8 lines · Benno Lossin
The
{pin_}chainfunctions extend an initializer: it not only initializes the value, but also executes a closure taking a reference to the initialized value. This allows to do something with a value directly after initialization.Suggested-by Asahi Lina <[email protected]>Reviewed-by Martin Rodriguez Reboredo <[email protected]>Signed-off-by Benno Lossin <[email protected]>
PATCH v4 13/13 rust: init: update expanded macro explanation
In reply to Benno LossinThe previous patches changed the internals of the macros resulting in the example expanded code being outdated. This patch updates the example and only changes documentation.
---
v3 -> v4:
No changes.
v2 -> v3:
- added Reviewed-by's from Martin.
rust/kernel/init/macros.rs | 126 ++++++++++++++++++++----------------- 1 file changed, 69 insertions(+), 57 deletions(-)
rust/kernel/init/macros.rs +69 -57
@@ -45,7 +45,7 @@//! #[pinned_drop] //! impl PinnedDrop for Foo { //! fn drop(self: Pin<&mut Self>) { -//! println!("{self:p} is getting dropped."); +//! pr_info!("{self:p} is getting dropped."); //! } //! } //!
@@ -170,8 +170,10 @@//! t: T, //! } //! #[doc(hidden)] -//! impl<'__pin, T> -//! ::core::marker::Unpin for Bar<T> where __Unpin<'__pin, T>: ::core::marker::Unpin {} +//! impl<'__pin, T> ::core::marker::Unpin for Bar<T> +//! where +//! __Unpin<'__pin, T>: ::core::marker::Unpin, +//! {} //! // Now we need to ensure that `Bar` does not implement `Drop`, since that would give users //! // access to `&mut self` inside of `drop` even if the struct was pinned. This could lead to //! // UB with only safe code, so we disallow this by giving a trait implementation error using
@@ -188,8 +190,9 @@//! // for safety, but a good sanity check, since no normal code calls `PinnedDrop::drop`. //! #[allow(non_camel_case_types)] //! trait UselessPinnedDropImpl_you_need_to_specify_PinnedDrop {} -//! impl<T: ::kernel::init::PinnedDrop> -//! UselessPinnedDropImpl_you_need_to_specify_PinnedDrop for T {} +//! impl< +//! T: ::kernel::init::PinnedDrop, +//! > UselessPinnedDropImpl_you_need_to_specify_PinnedDrop for T {} //! impl<T> UselessPinnedDropImpl_you_need_to_specify_PinnedDrop for Bar<T> {} //! }; //! ```
@@ -219,7 +222,7 @@//! // return type and shadow it later when we insert the arbitrary user code. That way //! // there will be no possibility of returning without `unsafe`. //! struct __InitOk; -//! // Get the pin-data type from the initialized type. +//! // Get the data about fields from the supplied type. //! // - the function is unsafe, hence the unsafe block //! // - we `use` the `HasPinData` trait in the block, it is only available in that //! // scope.
@@ -227,8 +230,7 @@//! use ::kernel::init::__internal::HasPinData; //! Self::__pin_data() //! }; -//! // Use `data` to help with type inference, the closure supplied will have the type -//! // `FnOnce(*mut Self) -> Result<__InitOk, Infallible>`. +//! // Ensure that `data` really is of type `PinData` and help with type inference: //! let init = ::kernel::init::__internal::PinData::make_closure::< //! _, //! __InitOk,
@@ -236,71 +238,75 @@//! >(data, move |slot| { //! { //! // Shadow the structure so it cannot be used to return early. If a user -//! // tries to write `return Ok(__InitOk)`, then they get a type error, since -//! // that will refer to this struct instead of the one defined above. +//! // tries to write `return Ok(__InitOk)`, then they get a type error, +//! // since that will refer to this struct instead of the one defined +//! // above. //! struct __InitOk; //! // This is the expansion of `t,`, which is syntactic sugar for `t: t,`. -//! unsafe { ::core::ptr::write(::core::addr_of_mut!((*slot).t), t) }; -//! // Since initialization could fail later (not in this case, since the error -//! // type is `Infallible`) we will need to drop this field if there is an -//! // error later. This `DropGuard` will drop the field when it gets dropped -//! // and has not yet been forgotten. We make a reference to it, so users -//! // cannot `mem::forget` it from the initializer, since the name is the same -//! // as the field (including hygiene). -//! let t = &unsafe { -//! ::kernel::init::__internal::DropGuard::new( -//! ::core::addr_of_mut!((*slot).t), -//! ) +//! { +//! unsafe { ::core::ptr::write(::core::addr_of_mut!((*slot).t), t) }; +//! } +//! // Since initialization could fail later (not in this case, since the +//! // error type is `Infallible`) we will need to drop this field if there +//! // is an error later. This `DropGuard` will drop the field when it gets +//! // dropped and has not yet been forgotten. +//! let t = unsafe { +//! ::pinned_init::__internal::DropGuard::new(::core::addr_of_mut!((*slot).t)) //! }; //! // Expansion of `x: 0,`: -//! // Since this can be an arbitrary expression we cannot place it inside of -//! // the `unsafe` block, so we bind it here. -//! let x = 0; -//! unsafe { ::core::ptr::write(::core::addr_of_mut!((*slot).x), x) }; +//! // Since this can be an arbitrary expression we cannot place it inside +//! // of the `unsafe` block, so we bind it here. +//! { +//! let x = 0; +//! unsafe { ::core::ptr::write(::core::addr_of_mut!((*slot).x), x) }; +//! } //! // We again create a `DropGuard`. -//! let x = &unsafe { -//! ::kernel::init::__internal::DropGuard::new( -//! ::core::addr_of_mut!((*slot).x), -//! ) +//! let x = unsafe { +//! ::kernel::init::__internal::DropGuard::new(::core::addr_of_mut!((*slot).x)) //! }; -//! +//! // Since initialization has successfully completed, we can now forget +//! // the guards. This is not `mem::forget`, since we only have +//! // `&DropGuard`. +//! ::core::mem::forget(x); +//! ::core::mem::forget(t); //! // Here we use the type checker to ensure that every field has been //! // initialized exactly once, since this is `if false` it will never get //! // executed, but still type-checked. -//! // Additionally we abuse `slot` to automatically infer the correct type for -//! // the struct. This is also another check that every field is accessible -//! // from this scope. +//! // Additionally we abuse `slot` to automatically infer the correct type +//! // for the struct. This is also another check that every field is +//! // accessible from this scope. //! #[allow(unreachable_code, clippy::diverging_sub_expression)] -//! if false { +//! let _ = || { //! unsafe { //! ::core::ptr::write( //! slot, //! Self { -//! // We only care about typecheck finding every field here, -//! // the expression does not matter, just conjure one using -//! // `panic!()`: +//! // We only care about typecheck finding every field +//! // here, the expression does not matter, just conjure +//! // one using `panic!()`: //! t: ::core::panic!(), //! x: ::core::panic!(), //! }, //! ); //! }; -//! } -//! // Since initialization has successfully completed, we can now forget the -//! // guards. This is not `mem::forget`, since we only have `&DropGuard`. -//! unsafe { ::kernel::init::__internal::DropGuard::forget(t) }; -//! unsafe { ::kernel::init::__internal::DropGuard::forget(x) }; +//! }; //! } //! // We leave the scope above and gain access to the previously shadowed //! // `__InitOk` that we need to return. //! Ok(__InitOk) //! }); //! // Change the return type from `__InitOk` to `()`. -//! let init = move |slot| -> ::core::result::Result<(), ::core::convert::Infallible> { +//! let init = move | +//! slot, +//! | -> ::core::result::Result<(), ::core::convert::Infallible> { //! init(slot).map(|__InitOk| ()) //! }; //! // Construct the initializer. //! let init = unsafe { -//! ::kernel::init::pin_init_from_closure::<_, ::core::convert::Infallible>(init) +//! ::kernel::init::pin_init_from_closure::< +//! _, +//! ::core::convert::Infallible, +//! >(init) //! }; //! init //! }
@@ -374,7 +380,10 @@//! b: Bar<u32>, //! } //! #[doc(hidden)] -//! impl<'__pin> ::core::marker::Unpin for Foo where __Unpin<'__pin>: ::core::marker::Unpin {} +//! impl<'__pin> ::core::marker::Unpin for Foo +//! where +//! __Unpin<'__pin>: ::core::marker::Unpin, +//! {} //! // Since we specified `PinnedDrop` as the argument to `#[pin_data]`, we expect `Foo` to //! // implement `PinnedDrop`. Thus we do not need to prevent `Drop` implementations like //! // before, instead we implement `Drop` here and delegate to `PinnedDrop`.
@@ -403,7 +412,7 @@//! #[pinned_drop] //! impl PinnedDrop for Foo { //! fn drop(self: Pin<&mut Self>) { -//! println!("{self:p} is getting dropped."); +//! pr_info!("{self:p} is getting dropped."); //! } //! } //! ```
@@ -414,7 +423,7 @@//! // `unsafe`, full path and the token parameter are added, everything else stays the same. //! unsafe impl ::kernel::init::PinnedDrop for Foo { //! fn drop(self: Pin<&mut Self>, _: ::kernel::init::__internal::OnlyCallFromDrop) { -//! println!("{self:p} is getting dropped."); +//! pr_info!("{self:p} is getting dropped."); //! } //! } //! ```
@@ -449,18 +458,21 @@//! >(data, move |slot| { //! { //! struct __InitOk; -//! unsafe { ::core::ptr::write(::core::addr_of_mut!((*slot).a), a) }; -//! let a = &unsafe { +//! { +//! unsafe { ::core::ptr::write(::core::addr_of_mut!((*slot).a), a) }; +//! } +//! let a = unsafe { //! ::kernel::init::__internal::DropGuard::new(::core::addr_of_mut!((*slot).a)) //! }; -//! let b = Bar::new(36); +//! let init = Bar::new(36); //! unsafe { data.b(::core::addr_of_mut!((*slot).b), b)? }; -//! let b = &unsafe { +//! let b = unsafe { //! ::kernel::init::__internal::DropGuard::new(::core::addr_of_mut!((*slot).b)) //! }; -//! +//! ::core::mem::forget(b); +//! ::core::mem::forget(a); //! #[allow(unreachable_code, clippy::diverging_sub_expression)] -//! if false { +//! let _ = || { //! unsafe { //! ::core::ptr::write( //! slot,
@@ -470,13 +482,13 @@//! }, //! ); //! }; -//! } -//! unsafe { ::kernel::init::__internal::DropGuard::forget(a) }; -//! unsafe { ::kernel::init::__internal::DropGuard::forget(b) }; +//! }; //! } //! Ok(__InitOk) //! }); -//! let init = move |slot| -> ::core::result::Result<(), ::core::convert::Infallible> { +//! let init = move | +//! slot, +//! | -> ::core::result::Result<(), ::core::convert::Infallible> { //! init(slot).map(|__InitOk| ()) //! }; //! let init = unsafe {
Signature · 1 line
2.41.0
Alice Ryhl
reviewerPATCH v4 13/13 rust: init: update expanded macro explanation
Quoted 6 lines · Benno Lossin
The previous patches changed the internals of the macros resulting in the example expanded code being outdated. This patch updates the example and only changes documentation.
Reviewed-by Martin Rodriguez Reboredo <[email protected]>Signed-off-by Benno Lossin <[email protected]>
Miguel Ojeda
AppliedQuoted 8 lines · Benno Lossin
This patch series adds several improvements to the pin-init api:
- a derive macro for theZeroabletrait,
- makes hygiene of fields in initializers behave like normal struct initializers would behave,
- prevent stackoverflow without optimizations
- add..Zeroable::zeroed()syntax to zero missing fields,
- support arbitrary paths in initializer macros.
Applied to rust-next with a few changes -- thanks everyone!
- Rebased on top of rust-next instead of rust-dev, which
requires a small use line change due to the KUnit patches being there back then.
- Added an ignore for the macros/lib.rs example to avoid
breaking rusttest.
- Cleaned a few trivial nits I noticed in several commits.
Cheers,
Miguel