Rust pin-init API for pinned initialization of structs
Subsystems (4)
v5 cover Rust pin-init API for pinned initialization of structs
This is the fifth version of the pin-init API. See [1] for v4.
The tree at [2] contains these patches applied on top of 6.3-rc1. The Rust-doc documentation of the pin-init API can be found at [3].
These patches are a long way coming, since I held a presentation on safe pinned initialization at Kangrejos [4]. And my discovery of this problem was almost a year ago [5].
- #1 enables the pin_macro feature which is already stable in Rust version 1.68.
- #2 adds a utility macro quote! for proc-macros. This macro converts the typed characters directly into Rust tokens that are the output of proc-macros. It is used by the pin-init API proc-macros.
- #3 changes the Err types of the constructor functions of Arc and UniqueArc to AllocError.
- #4 adds the assume_init function to UniqueArc<MaybeUninit<T>> that unsafely assumes the pointee to be initialized and returns a UniqueArc<T>. UniqueArc::write is modified to use this new function. Later patches use it as well.
- #5 adds Opaque::raw_get to access the value inside of an Opaque from a raw pointer only.
- #6-11 introduce the pin-init API. The commit message of #4 details the problem it solves and lays out the overall architecture. The implementation details are fairly complex; however, this is required to provide a safe API for users -- reducing the amount of unsafe code is a key goal of the Rust support in the kernel. An example of the before/after difference from the point of view of users is provided in the commit message. It is a goal to at some point have pin-init as a language feature of Rust. A first step in this direction is the Field Projection RFC [6].
- #12 adds important traits and macros from pin-init to the prelude.
- #13 adds functions for easier initialization of Opaque<T> via FFI and raw pointer initializer functions. This is necessary when writing Rust wrappers and will be used by Wedson's sync module patches.
- #14 improves the UniqueArc::try_new_uninit function by using the pin-init API. The old version first allocated uninitialized memory on the stack and then moved it into the location in the heap. The new version directly allocates this on the heap.
- #15 adds functions for initializing already allocated UniqueArcs, this will be used by the Android Binder driver.
--
Changelog:
v4 -> v5:
- Add pin_macro to rust_allowed_features.
- Improve wording of commit message #6.
- Remove PinInit as a supertrait from Init, instead add a blanket impl:
impl PinInit<T, E> for Init<T, E>.
- Fix BigBuf example on try_init!.
- Fix imports in arc.rs.
v3 -> v4:
- Improve documentation.
- Fixing doc-tests imports, comments and full paths in macro examples.
- Implement Zeroable for many more types.
- Fix unsoundness: Zeroable allowed to create fat pointers with a null VTABLE pointer.
- Split fallible components from stack_pin_init! into stack_try_pin_init!.
- Move Invariant type alias and InitClosure into __internal.
- Change the error type of the constructor functions of Arc and UniqueArc to AllocError.
- Add try variants to InPlaceInit to allow custom error types.
- Make StackInit::init a safe function.
- Rename OnlyCallFromDrop::create to OnlyCallFromDrop::new.
- Enable the pin_macro feature for use inside of stack_pin_init!.
- Make quote! and quote_spanned! use absolute paths.
v2 -> v3:
- Split the big original commit into six smaller commits.
- Use PinnedDrop in the RawFoo code example.
- Move the init::common::ffi_init functions to Opaque::ffi_init.
- Move all #[doc(hidden)], internal types into the new __internal module.
- Specify safety guarantees and requirements of the initializer macros.
- Add a detailed example of what the expanded code of the various macros looks like.
- Require generics in the initializer macros to use turbofish syntax (::<>).
- Refactor the internals of the initializer macros, this way they have better type inference and generic arguments can be omitted more often.
- Replace init::from_value with a blanket impl of the initializer traits for ordinary objects.
- Add initializing functions for already allocated UniqueArcs.
- Add Opaque::manual_init functions akin to ffi_init, but they take an extern "Rust" fn instead.
- Documentation and inline comment improvements.
v1 -> v2:
- Split the common module and UniqueArc::assume_init into their own commits.
- Change the generics syntax of pin_init! to reflect normal struct generic syntax.
- Replace PinnedDrop::__ensure_no_unsafe_op_in_drop with an only unsafely creatable token.
- Hide StackInit<T> in the docs, because it is internal API.
- Improve macro internals of pin_init! according to Gary's review.
- Add check for PhantomPinned fields without a #[pin] attribute in #[pin_data], as those fields will not have the intended effect.
- Add docs to quote.rs.
[1] https://lore.kernel.org/rust-for-linux/[email protected]/
[2] https://github.com/y86-dev/linux.git patch/pinned-init-v5
[3] https://rust-for-linux.github.io/docs/pinned-init/kernel/init
[4] https://kangrejos.com
[5] https://github.com/Rust-for-Linux/linux/issues/772
[6] https://github.com/rust-lang/rfcs/pull/3318
Benno Lossin (14):
rust: enable the pin_macro feature
rust: sync: change error type of constructor functions
rust: sync: add assume_init to UniqueArc
rust: types: add Opaque::raw_get
rust: add pin-init API core
rust: init: add initialization macros
rust: init/sync: add InPlaceInit trait to pin-initialize smart
pointers
rust: init: add PinnedDrop trait and macros
rust: init: add stack_pin_init! macro
rust: init: add Zeroable trait and init::zeroed function
rust: prelude: add pin-init API items to prelude
rust: types: add common init-helper functions for Opaque
rust: sync: reduce stack usage of UniqueArc::try_new_uninit
rust: sync: add functions for initializing UniqueArc<MaybeUninit<T>>
Gary Guo (1):
rust: macros: add quote! macro
rust/kernel/init.rs | 1430 ++++++++++++++++++++++++++++++++ rust/kernel/init/__internal.rs | 222 +++++ rust/kernel/init/macros.rs | 971 ++++++++++++++++++++++ rust/kernel/lib.rs | 7 + rust/kernel/prelude.rs | 6 +- rust/kernel/sync/arc.rs | 81 +- rust/kernel/types.rs | 55 ++ rust/macros/lib.rs | 80 ++ rust/macros/pin_data.rs | 79 ++ rust/macros/pinned_drop.rs | 49 ++ rust/macros/quote.rs | 143 ++++ scripts/Makefile.build | 2 +- 12 files changed, 3117 insertions(+), 8 deletions(-) create mode 100644 rust/kernel/init.rs create mode 100644 rust/kernel/init/__internal.rs create mode 100644 rust/kernel/init/macros.rs create mode 100644 rust/macros/pin_data.rs create mode 100644 rust/macros/pinned_drop.rs create mode 100644 rust/macros/quote.rs
base-commit: fe15c26ee26efa11741a7b632e9f23b01aca4cc6 --
2.39.2
PATCH v5 1/15 rust: enable the `pin_macro` feature
This feature enables the use of the pin! macro for the stack_pin_init! macro. This feature is already stabilized in Rust version 1.68.
--- rust/kernel/lib.rs | 1 + scripts/Makefile.build | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)
rust/kernel/lib.rs +1 -0
@@ -17,6 +17,7 @@#![feature(core_ffi_c)] #![feature(dispatch_from_dyn)] #![feature(generic_associated_types)] +#![feature(pin_macro)] #![feature(receiver_trait)] #![feature(unsize)]
scripts/Makefile.build +1 -1
@@ -277,7 +277,7 @@ $(obj)/%.lst: $(src)/%.c FORCE # Compile Rust sources (.rs) # --------------------------------------------------------------------------- -rust_allowed_features := core_ffi_c +rust_allowed_features := core_ffi_c,pin_macro rust_common_cmd = \ RUST_MODFILE=$(modfile) $(RUSTC_OR_CLIPPY) $(rust_flags) \
--
2.39.2
Re: [PATCH v5 01/15] rust: enable the `pin_macro` feature
Quoted 8 lines · Benno Lossin
This feature enables the use of the
pin!macro for thestack_pin_init!macro. This feature is already stabilized in Rust version 1.68.Signed-off-by Benno Lossin <[email protected]>Cc Gary Guo <[email protected]>Cc Andreas Hindborg <[email protected]>Cc Alice Ryhl <[email protected]>Acked-by Boqun Feng <[email protected]>
Re: [PATCH v5 01/15] rust: enable the `pin_macro` feature
In reply to Benno LossinQuoted 8 lines · On Mon, 03 Apr 2023 15:44:46 +0000 Benno Lossin <[email protected]> wrote:
This feature enables the use of the
pin!macro for thestack_pin_init!macro. This feature is already stabilized in Rust version 1.68.Signed-off-by Benno Lossin <[email protected]>Cc Gary Guo <[email protected]>Cc Andreas Hindborg <[email protected]>Cc Alice Ryhl <[email protected]>Acked-by Boqun Feng <[email protected]>
Quoted 34 lines
--- rust/kernel/lib.rs | 1 + scripts/Makefile.build | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)rust/kernel/lib.rs +1
-0@@ -17,6 +17,7 @@#![feature(core_ffi_c)] #![feature(dispatch_from_dyn)] #![feature(generic_associated_types)] +#![feature(pin_macro)] #![feature(receiver_trait)] #![feature(unsize)] scripts/Makefile.build +1
-2@@ -277,7 +277,7 @@ $(obj)/%.lst: $(src)/%.c FORCE # Compile Rust sources (.rs) # --------------------------------------------------------------------------- -rust_allowed_features := core_ffi_c +rust_allowed_features := core_ffi_c,pin_macro rust_common_cmd = \ RUST_MODFILE=$(modfile) $(RUSTC_OR_CLIPPY) $(rust_flags) \ --2.39.2
PATCH v5 2/15 rust: macros: add `quote!` macro
In reply to Benno LossinFrom: Gary Guo <[email protected]>
Add the quote! macro for creating TokenStreams directly via the given Rust tokens. It also supports repetitions using iterators.
It will be used by the pin-init API proc-macros to generate code.
--- rust/macros/lib.rs | 2 + rust/macros/quote.rs | 145 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 147 insertions(+) create mode 100644 rust/macros/quote.rs
rust/macros/lib.rs +2 -0
@@ -2,6 +2,8 @@//! Crate for all kernel procedural macros. +#[macro_use] +mod quote;mod concat_idents;mod helpers;mod module;
rust/macros/quote.rs new file +145 -0
145 lines not on this page · raw message
--
2.39.2
Re: [PATCH v5 02/15] rust: macros: add `quote!` macro
Quoted 11 lines · Benno Lossin
From: Gary Guo <[email protected]>
Add the
quote!macro for creatingTokenStreams directly via the given Rust tokens. It also supports repetitions using iterators.It will be used by the pin-init API proc-macros to generate code.
Signed-off-by Gary Guo <[email protected]>Signed-off-by Benno Lossin <[email protected]>Reviewed-by Andreas Hindborg <[email protected]>Cc Alice Ryhl <[email protected]>
PATCH v5 3/15 rust: sync: change error type of constructor functions
In reply to Benno LossinChange the error type of the constructors of Arc and UniqueArc to be AllocError instead of Error. This makes the API more clear as to what can go wrong when calling try_new or its variants.
--- rust/kernel/sync/arc.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
rust/kernel/sync/arc.rs +4 -4
@@ -17,11 +17,11 @@use crate ::{ bindings, - error::Result , types::{ForeignOwnable ,Opaque }, };use alloc::boxed::Box ;use core::{ + alloc::AllocError , marker::{PhantomData ,Unsize }, mem::{ManuallyDrop ,MaybeUninit }, ops::{Deref ,DerefMut },
@@ -149,7 +149,7 @@ unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {}impl <T >Arc <T > {/// Constructs a new reference counted instance of `T`. -pub fn try_new (contents:T ) ->Result <Self > { +pub fn try_new (contents:T ) ->Result <Self ,AllocError > {// INVARIANT: The refcount is initialised to a non-zero value. let value = ArcInner {// SAFETY: There are no safety requirements for this FFI call.
@@ -469,7 +469,7 @@ pub struct UniqueArc<T: ?Sized> {impl <T >UniqueArc <T > {/// Tries to allocate a new [`UniqueArc`] instance. -pub fn try_new (value:T ) ->Result <Self > { +pub fn try_new (value:T ) ->Result <Self ,AllocError > {Ok (Self {// INVARIANT: The newly-created object has a ref-count of 1. inner:Arc ::try_new (value)?,
@@ -477,7 +477,7 @@ impl<T> UniqueArc<T> { }/// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet. -pub fn try_new_uninit () ->Result <UniqueArc <MaybeUninit <T >>> { +pub fn try_new_uninit () ->Result <UniqueArc <MaybeUninit <T >>,AllocError > {Ok (UniqueArc ::<MaybeUninit <T >> {// INVARIANT: The newly-created object has a ref-count of 1. inner:Arc ::try_new (MaybeUninit ::uninit ())?,
--
2.39.2
Re: [PATCH v5 03/15] rust: sync: change error type of constructor functions
Quoted 8 lines · Benno Lossin
Change the error type of the constructors of
ArcandUniqueArcto beAllocErrorinstead ofError. This makes the API more clear as to what can go wrong when callingtry_newor its variants.Signed-off-by Benno Lossin <[email protected]>Reviewed-by Andreas Hindborg <[email protected]>Cc Gary Guo <[email protected]>Cc Alice Ryhl <[email protected]>
Re: [PATCH v5 03/15] rust: sync: change error type of constructor functions
In reply to Benno LossinQuoted 8 lines · On Mon, 03 Apr 2023 15:44:58 +0000 Benno Lossin <[email protected]> wrote:
Change the error type of the constructors of
ArcandUniqueArcto beAllocErrorinstead ofError. This makes the API more clear as to what can go wrong when callingtry_newor its variants.Signed-off-by Benno Lossin <[email protected]>Reviewed-by Andreas Hindborg <[email protected]>Cc Gary Guo <[email protected]>Cc Alice Ryhl <[email protected]>
Quoted 52 lines
--- rust/kernel/sync/arc.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)rust/kernel/sync/arc.rs +4
-5@@ -17,11 +17,11 @@use crate ::{ bindings, - error::Result , types::{ForeignOwnable ,Opaque }, };use alloc::boxed::Box ;use core::{ + alloc::AllocError , marker::{PhantomData ,Unsize }, mem::{ManuallyDrop ,MaybeUninit }, ops::{Deref ,DerefMut },@@ -149,7 +149,7 @@ unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {}impl <T >Arc <T > {/// Constructs a new reference counted instance of `T`. -pub fn try_new (contents:T ) ->Result <Self > { +pub fn try_new (contents:T ) ->Result <Self ,AllocError > {// INVARIANT: The refcount is initialised to a non-zero value. let value = ArcInner {// SAFETY: There are no safety requirements for this FFI call. @@ -469,7 +469,7 @@ pub struct UniqueArc<T: ?Sized> {impl <T >UniqueArc <T > {/// Tries to allocate a new [`UniqueArc`] instance. -pub fn try_new (value:T ) ->Result <Self > { +pub fn try_new (value:T ) ->Result <Self ,AllocError > {Ok (Self {// INVARIANT: The newly-created object has a ref-count of 1. inner:Arc ::try_new (value)?,@@ -477,7 +477,7 @@ impl<T> UniqueArc<T> { }/// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet. -pub fn try_new_uninit () ->Result <UniqueArc <MaybeUninit <T >>> { +pub fn try_new_uninit () ->Result <UniqueArc <MaybeUninit <T >>,AllocError > {Ok (UniqueArc ::<MaybeUninit <T >> {// INVARIANT: The newly-created object has a ref-count of 1. inner:Arc ::try_new (MaybeUninit ::uninit ())?, --2.39.2
PATCH v5 4/15 rust: sync: add `assume_init` to `UniqueArc`
In reply to Benno LossinAdds the assume_init function to UniqueArc<MaybeUninit<T>> that unsafely assumes the value to be initialized and yields a value of type UniqueArc<T>. This function is used when manually initializing the pointee of an UniqueArc.
--- rust/kernel/sync/arc.rs | 11 +++++++++++ 1 file changed, 11 insertions(+)
rust/kernel/sync/arc.rs +11 -0
@@ -489,6 +489,17 @@ impl<T> UniqueArc<MaybeUninit<T>> {/// Converts a `UniqueArc<MaybeUninit<T>>` into a `UniqueArc<T>` by writing a value into it. pub fn write (mut self, value:T ) ->UniqueArc <T > { self.deref_mut ().write (value); +// SAFETY: We just wrote the value to be initialized. +unsafe { self.assume_init () } + } + +/// Unsafely assume that `self` is initialized. +/// +/// # Safety +/// +/// The caller guarantees that the value behind this pointer has been initialized. It is +/// *immediate* UB to call this when the value is not initialized. +pub unsafe fn assume_init (self) ->UniqueArc <T > {let inner =ManuallyDrop ::new (self).inner.ptr;UniqueArc {// SAFETY: The new `Arc` is taking over `ptr` from `self.inner` (which won't be
--
2.39.2
PATCH v5 5/15 rust: types: add `Opaque::raw_get`
In reply to Benno LossinThis function mirrors UnsafeCell::raw_get. It avoids creating a reference and allows solely using raw pointers.
The pin-init API will be using this, since uninitialized memory requires raw pointers.
--- rust/kernel/types.rs | 8 ++++++++ 1 file changed, 8 insertions(+)
rust/kernel/types.rs +8 -0
@@ -238,6 +238,14 @@ impl<T> Opaque<T> {pub fn get (&self) -> *mut T {UnsafeCell ::raw_get (self.0 .as_ptr ()) } + +/// Gets the value behind `this`. +/// +/// This function is useful to get access to the value without creating intermediate +/// references. +pub const fn raw_get (this: *const Self ) -> *mut T { +UnsafeCell ::raw_get (this.cast ::<UnsafeCell <T >>()) + } }/// A sum type that always holds either a value of type `L` or `R`.
--
2.39.2
PATCH v5 6/15 rust: add pin-init API core
In reply to Benno LossinThis API is used to facilitate safe pinned initialization of structs. It replaces cumbersome unsafe manual initialization with elegant safe macro invocations.
Due to the size of this change it has been split into six commits:
1. This commit introducing the basic public interface: traits and functions to represent and create initializers.
2. Adds the #[pin_data], pin_init!, try_pin_init!, init! and try_init! macros along with their internal types.
3. Adds the InPlaceInit trait that allows using an initializer to create an object inside of a Box<T> and other smart pointers.
4. Adds the PinnedDrop trait and adds macro support for it in the #[pin_data] macro.
5. Adds the stack_pin_init! macro allowing to pin-initialize a struct on the stack.
6. Adds the Zeroable trait and init::zeroed function to initialize types that have 0x00 in all bytes as a valid bit pattern.
--
In this section the problem that the new pin-init API solves is outlined. This message describes the entirety of the API, not just the parts introduced in this commit. For a more granular explanation and additional information on pinning and this issue, view [1].
Pinning is Rust's way of enforcing the address stability of a value. When a value gets pinned it will be impossible for safe code to move it to another location. This is done by wrapping pointers to said object with Pin<P>. This wrapper prevents safe code from creating mutable references to the object, preventing mutable access, which is needed to move the value. Pin<P> provides unsafe functions to circumvent this and allow modifications regardless. It is then the programmer's responsibility to uphold the pinning guarantee.
Many kernel data structures require a stable address, because there are foreign pointers to them which would get invalidated by moving the structure. Since these data structures are usually embedded in structs to use them, this pinning property propagates to the container struct. Resulting in most structs in both Rust and C code needing to be pinned.
So if we want to have a mutex field in a Rust struct, this struct also needs to be pinned, because a mutex contains a list_head. Additionally initializing a list_head requires already having the final memory location available, because it is initialized by pointing it to itself. But this presents another challenge in Rust: values have to be initialized at all times. There is the MaybeUninit<T> wrapper type, which allows handling uninitialized memory, but this requires using the unsafe raw pointers and a casting the type to the initialized variant.
This problem gets exacerbated when considering encapsulation and the normal safety requirements of Rust code. The fields of the Rust Mutex<T> should not be accessible to normal driver code. After all if anyone can modify the fields, there is no way to ensure the invariants of the Mutex<T> are upheld. But if the fields are inaccessible, then initialization of a Mutex<T> needs to be somehow achieved via a function or a macro. Because the Mutex<T> must be pinned in memory, the function cannot return it by value. It also cannot allocate a Box to put the Mutex<T> into, because that is an unnecessary allocation and indirection which would hurt performance.
The solution in the rust tree (e.g. this commit: [2]) that is replaced by this API is to split this function into two parts:
1. A new function that returns a partially initialized Mutex<T>,
2. An init function that requires the Mutex<T> to be pinned and that fully initializes the Mutex<T>.
Both of these functions have to be marked unsafe, since a call to new needs to be accompanied with a call to init, otherwise using the Mutex<T> could result in UB. And because calling init twice also is not safe. While Mutex<T> initialization cannot fail, other structs might also have to allocate memory, which would result in conditional successful initialization requiring even more manual accommodation work.
Combine this with the problem of pin-projections -- the way of accessing fields of a pinned struct -- which also have an unsafe API, pinned initialization is riddled with unsafe resulting in very poor ergonomics. Not only that, but also having to call two functions possibly multiple lines apart makes it very easy to forget it outright or during refactoring.
Here is an example of the current way of initializing a struct with two synchronization primitives (see [3] for the full example):
struct SharedState {
state_changed: CondVar,
inner: Mutex<SharedStateInner>,
}
impl SharedState {
fn try_new() -> Result<Arc<Self>> {
let mut state = Pin::from(UniqueArc::try_new(Self {
// SAFETY: `condvar_init!` is called below.
state_changed: unsafe { CondVar::new() },
// SAFETY: `mutex_init!` is called below.
inner: unsafe {
Mutex::new(SharedStateInner { token_count: 0 })
},
})?);
// SAFETY: `state_changed` is pinned when `state` is.
let pinned = unsafe {
state.as_mut().map_unchecked_mut(|s| &mut s.state_changed)
};
kernel::condvar_init!(pinned, "SharedState::state_changed");
// SAFETY: `inner` is pinned when `state` is.
let pinned = unsafe {
state.as_mut().map_unchecked_mut(|s| &mut s.inner)
};
kernel::mutex_init!(pinned, "SharedState::inner");
Ok(state.into())
}
}The pin-init API of this patch solves this issue by providing a comprehensive solution comprised of macros and traits. Here is the example from above using the pin-init API:
#[pin_data]
struct SharedState {
#[pin]
state_changed: CondVar,
#[pin]
inner: Mutex<SharedStateInner>,
}
impl SharedState {
fn new() -> impl PinInit<Self> {
pin_init!(Self {
state_changed <- new_condvar!("SharedState::state_changed"),
inner <- new_mutex!(
SharedStateInner { token_count: 0 },
"SharedState::inner",
),
})
}
}Notably the way the macro is used here requires no unsafe and thus comes with the usual Rust promise of safe code not introducing any memory violations. Additionally it is now up to the caller of new() to decide the memory location of the SharedState. They can choose at the moment Arc<T>, Box<T> or the stack.
--
The API has the following architecture:
1. Initializer traits PinInit<T, E> and Init<T, E> that act like closures.
2. Macros to create these initializer traits safely.
3. Functions to allow manually writing initializers.
The initializers (an impl PinInit<T, E>) receive a raw pointer pointing to uninitialized memory and their job is to fully initialize a T at that location. If initialization fails, they return an error (E) by value.
This way of initializing cannot be safely exposed to the user, since it relies upon these properties outside of the control of the trait:
- the memory location (slot) needs to be valid memory,
- if initialization fails, the slot should not be read from,
- the value in the slot should be pinned, so it cannot move and the memory cannot be deallocated until the value is dropped.
This is why using an initializer is facilitated by another trait that ensures these requirements.
These initializers can be created manually by just supplying a closure that fulfills the same safety requirements as PinInit<T, E>. But this is an unsafe operation. To allow safe initializer creation, the pin_init! is provided along with three other variants: try_pin_init!, try_init! and init!. These take a modified struct initializer as a parameter and generate a closure that initializes the fields in sequence.
The macros take great care in upholding the safety requirements:
- A shadowed struct type is used as the return type of the closure instead of (). This is to prevent early returns, as these would prevent full initialization.
- To ensure every field is only initialized once, a normal struct initializer is placed in unreachable code. The type checker will emit errors if a field is missing or specified multiple times.
- When initializing a field fails, the whole initializer will fail and automatically drop fields that have been initialized earlier.
- Only the correct initializer type is allowed for unpinned fields. You cannot use a impl PinInit<T, E> to initialize a structurally not pinned field.
To ensure the last point, an additional macro #[pin_data] is needed. This macro annotates the struct itself and the user specifies structurally pinned and not pinned fields.
Because dropping a pinned struct is also not allowed to break the pinning invariants, another macro attribute #[pinned_drop] is needed. This macro is introduced in a following commit.
These two macros also have mechanisms to ensure the overall safety of the API. Additionally, they utilize a combined proc-macro, declarative macro
design: first a proc-macro enables the outer attribute syntax #[...] and does some important pre-parsing. Notably this prepares the generics such that the declarative macro can handle them using token trees. Then the actual parsing of the structure and the emission of code is handled by a declarative macro.
For pin-projections the crates pin-project [4] and pin-project-lite [5] had been considered, but were ultimately rejected:
- pin-project depends on syn [6] which is a very big dependency, around 50k lines of code.
- pin-project-lite is a more reasonable 5k lines of code, but contains a very complex declarative macro to parse generics. On top of that it would require modification that would need to be maintained independently.
--- rust/kernel/init.rs | 187 +++++++++++++++++++++++++++++++++ rust/kernel/init/__internal.rs | 33 ++++++ rust/kernel/lib.rs | 7 ++ scripts/Makefile.build | 2 +- 4 files changed, 228 insertions(+), 1 deletion(-) create mode 100644 rust/kernel/init.rs create mode 100644 rust/kernel/init/__internal.rs
rust/kernel/init.rs new file +187 -0
@@ -0,0 +1,187 @@ +// SPDX-License-Identifier: Apache-2.0 OR MIT + +//! API to safely and fallibly initialize pinned `struct`s using in-place constructors. +//! +//! It also allows in-place initialization of big `struct`s that would otherwise produce a stack +//! overflow. +//! +//! Most `struct`s from the [`sync`] module need to be pinned, because they contain self-referential +//! `struct`s from C. [Pinning][pinning] is Rust's way of ensuring data does not move. +//! +//! # Overview +//! +//! To initialize a `struct` with an in-place constructor you will need two things: +//! - an in-place constructor, +//! - a memory location that can hold your `struct`. +//! +//! To get an in-place constructor there are generally two options: +//! - a custom function/macro returning an in-place constructor provided by someone else, +//! - using the unsafe function [`pin_init_from_closure()`] to manually create an initializer. +//! +//! Aside from pinned initialization, this API also supports in-place construction without pinning, +//! the macros/types/functions are generally named like the pinned variants without the `pin` +//! prefix. +//! +//! [`sync`]: kernel::sync +//! [pinning]: https://doc.rust-lang.org/std/pin/index.html +//! [structurally pinned fields]: +//! https://doc.rust-lang.org/std/pin/index.html#pinning-is-structural-for-field +//! [`Arc<T>`]: crate::sync::Arc +//! [`impl PinInit<Foo>`]: PinInit +//! [`impl PinInit<T, E>`]: PinInit +//! [`impl Init<T, E>`]: Init +//! [`Opaque`]: kernel::types::Opaque +//! [`pin_data`]: ::macros::pin_data +//! [`UniqueArc<T>`]: kernel::sync::UniqueArc +//! [`Box<T>`]: alloc::boxed::Box + +use core::{convert::Infallible , marker::PhantomData , mem::MaybeUninit }; + +#[doc(hidden)] +pub mod __internal; + +/// A pin-initializer for the type `T`. +/// +/// To use this initializer, you will need a suitable memory location that can hold a `T`. This can +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. +/// +/// Also see the [module description](self). +/// +/// # Safety +/// +/// When implementing this type you will need to take great care. Also there are probably very few +/// cases where a manual implementation is necessary. Use [`pin_init_from_closure`] where possible. +/// +/// The [`PinInit::__pinned_init`] function +/// - returns `Ok(())` if it initialized every field of `slot`, +/// - returns `Err(err)` if it encountered an error and then cleaned `slot`, this means: +/// - `slot` can be deallocated without UB occurring, +/// - `slot` does not need to be dropped, +/// - `slot` is not partially initialized. +/// - while constructing the `T` at `slot` it upholds the pinning invariants of `T`. +/// +/// [`Arc<T>`]: crate::sync::Arc +/// [`Arc::pin_init`]: crate::sync::Arc::pin_init +/// [`UniqueArc<T>`]: kernel::sync::UniqueArc +/// [`Box<T>`]: alloc::boxed::Box +#[must_use = "An initializer must be used in order to create its value." ] +pub unsafe trait PinInit <T : ?Sized ,E =Infallible >:Sized { +/// Initializes `slot`. +/// +/// # Safety +/// +/// - `slot` is a valid pointer to uninitialized memory. +/// - the caller does not touch `slot` when `Err` is returned, they are only permitted to +/// 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 >; +} + +/// An initializer for `T`. +/// +/// To use this initializer, you will need a suitable memory location that can hold a `T`. This can +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Because [`PinInit<T, E>`] is a super trait, you can +/// use every function that takes it as well. +/// +/// Also see the [module description](self). +/// +/// # Safety +/// +/// When implementing this type you will need to take great care. Also there are probably very few +/// cases where a manual implementation is necessary. Use [`init_from_closure`] where possible. +/// +/// The [`Init::__init`] function +/// - returns `Ok(())` if it initialized every field of `slot`, +/// - returns `Err(err)` if it encountered an error and then cleaned `slot`, this means: +/// - `slot` can be deallocated without UB occurring, +/// - `slot` does not need to be dropped, +/// - `slot` is not partially initialized. +/// - while constructing the `T` at `slot` it upholds the pinning invariants of `T`. +/// +/// The `__pinned_init` function from the supertrait [`PinInit`] needs to execute the exact same +/// code as `__init`. +/// +/// Contrary to its supertype [`PinInit<T, E>`] the caller is allowed to +/// move the pointee after initialization. +/// +/// [`Arc<T>`]: crate::sync::Arc +/// [`UniqueArc<T>`]: kernel::sync::UniqueArc +/// [`Box<T>`]: alloc::boxed::Box +#[must_use = "An initializer must be used in order to create its value." ] +pub unsafe trait Init <T : ?Sized ,E =Infallible >:Sized { +/// Initializes `slot`. +/// +/// # Safety +/// +/// - `slot` is a valid pointer to uninitialized memory. +/// - 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 >; +} + +// 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 +/// +/// The closure: +/// - returns `Ok(())` if it initialized every field of `slot`, +/// - returns `Err(err)` if it encountered an error and then cleaned `slot`, this means: +/// - `slot` can be deallocated without UB occurring, +/// - `slot` does not need to be dropped, +/// - `slot` is not partially initialized. +/// - may assume that the `slot` does not move if `T: !Unpin`, +/// - while constructing the `T` at `slot` it upholds the pinning invariants of `T`. +#[inline] +pub const unsafe fn pin_init_from_closure <T : ?Sized ,E >( + f:impl FnOnce (*mut T ) ->Result <(),E >, +) ->impl PinInit <T ,E > { + __internal::InitClosure (f,PhantomData ) +} + +/// Creates a new [`Init<T, E>`] from the given closure. +/// +/// # Safety +/// +/// The closure: +/// - returns `Ok(())` if it initialized every field of `slot`, +/// - returns `Err(err)` if it encountered an error and then cleaned `slot`, this means: +/// - `slot` can be deallocated without UB occurring, +/// - `slot` does not need to be dropped, +/// - `slot` is not partially initialized. +/// - the `slot` may move after initialization. +/// - while constructing the `T` at `slot` it upholds the pinning invariants of `T`. +#[inline] +pub const unsafe fn init_from_closure <T : ?Sized ,E >( + f:impl FnOnce (*mut T ) ->Result <(),E >, +) ->impl Init <T ,E > { + __internal::InitClosure (f,PhantomData ) +} + +/// An initializer that leaves the memory uninitialized. +/// +/// The initializer is a no-op. The `slot` memory is not changed. +#[inline] +pub fn uninit <T ,E >() ->impl Init <MaybeUninit <T >,E > { +// SAFETY: The memory is allowed to be uninitialized. +unsafe {init_from_closure (|_|Ok (())) } +} + +// SAFETY: Every type can be initialized by-value. +unsafe impl <T >Init <T >for T { +unsafe fn __init (self, slot: *mut T ) ->Result <(),Infallible > { +unsafe { slot.write (self) }; +Ok (()) + } +}
rust/kernel/init/__internal.rs new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: Apache-2.0 OR MIT + +//! This module contains API-internal items for pin-init. +//! +//! These items must not be used outside of +//! - `kernel/init.rs` +//! - `macros/pin_data.rs` +//! - `macros/pinned_drop.rs` + +use super ::*; + +/// See the [nomicon] for what subtyping is. See also [this table]. +/// +/// [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 >; + +/// 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 +/// `__pinned_init`/`__init` functions. +pub (crate )struct InitClosure <F ,T : ?Sized ,E >(pub (crate )F ,pub (crate )Invariant <(E ,T )>); + +// SAFETY: While constructing the `InitClosure`, the user promised that it upholds the +// `__init` invariants. +unsafe impl <T : ?Sized ,F ,E >Init <T ,E >for InitClosure <F ,T ,E > +where +F :FnOnce (*mut T ) ->Result <(),E >, +{ +#[inline] +unsafe fn __init (self, slot: *mut T ) ->Result <(),E > { + (self.0 )(slot) + } +}
rust/kernel/lib.rs +7 -0
@@ -16,7 +16,9 @@#![feature(coerce_unsized)] #![feature(core_ffi_c)] #![feature(dispatch_from_dyn)] +#![feature(explicit_generic_args_with_impl_trait)] #![feature(generic_associated_types)] +#![feature(new_uninit)] #![feature(pin_macro)] #![feature(receiver_trait)] #![feature(unsize)]
@@ -26,11 +28,16 @@#[cfg(not( CONFIG_RUST ))] compile_error! ("Missing kernel configuration for conditional compilation" ); +#[allow(unused_extern_crates)] +// Allow proc-macros to refer to `::kernel` inside the `kernel` crate (this crate). +extern crate selfas kernel; +#[cfg(not(test))] #[cfg(not(testlib))] mod allocator;mod build_assert;pub mod error; +pub mod init;pub mod prelude;pub mod print;mod static_assert;
scripts/Makefile.build +1 -1
@@ -277,7 +277,7 @@ $(obj)/%.lst: $(src)/%.c FORCE # Compile Rust sources (.rs) # --------------------------------------------------------------------------- -rust_allowed_features := core_ffi_c,pin_macro +rust_allowed_features := core_ffi_c,pin_macro,explicit_generic_args_with_impl_trait rust_common_cmd = \ RUST_MODFILE=$(modfile) $(RUSTC_OR_CLIPPY) $(rust_flags) \
--
2.39.2
Re: [PATCH v5 06/15] rust: add pin-init API core
Quoted 18 lines · Benno Lossin
This API is used to facilitate safe pinned initialization of structs. It replaces cumbersome
unsafemanual initialization with elegant safe macro invocations.Due to the size of this change it has been split into six commits:
1. This commit introducing the basic public interface: traits and functions to represent and create initializers.
2. Adds the#[pin_data],pin_init!,try_pin_init!,init!andtry_init!macros along with their internal types.
3. Adds theInPlaceInittrait that allows using an initializer to create an object inside of aBox<T>and other smart pointers.
4. Adds thePinnedDroptrait and adds macro support for it inthe `#[pin_data]` macro. 5. Adds the `stack_pin_init!` macro allowing to pin-initialize a struct on the stack. 6. Adds the `Zeroable` trait and `init::zeroed` function to initialize types that have `0x00` in all bytes as a valid bit pattern.
Quoted 6 lines
Co-developed-by Gary Guo <[email protected]>Signed-off-by Gary Guo <[email protected]>Signed-off-by Benno Lossin <[email protected]>Cc Andreas Hindborg <[email protected]>Cc Alice Ryhl <[email protected]>Cc Wedson Almeida Filho <[email protected]>
PATCH v5 7/15 rust: init: add initialization macros
In reply to Benno LossinAdd the following initializer macros:
- #[pin_data] to annotate structurally pinned fields of structs, needed for pin_init! and try_pin_init! to select the correct initializer of fields.
- pin_init! create a pin-initializer for a struct with the Infallible error type.
- try_pin_init! create a pin-initializer for a struct with a custom error type (kernel::error::Error is the default).
- init! create an in-place-initializer for a struct with the Infallible error type.
- try_init! create an in-place-initializer for a struct with a custom error type (kernel::error::Error is the default).
Also add their needed internal helper traits and structs.
--- rust/kernel/init.rs | 807 ++++++++++++++++++++++++++++++++- rust/kernel/init/__internal.rs | 124 +++++ rust/kernel/init/macros.rs | 707 +++++++++++++++++++++++++++++ rust/macros/lib.rs | 29 ++ rust/macros/pin_data.rs | 79 ++++ rust/macros/quote.rs | 2 - 6 files changed, 1741 insertions(+), 7 deletions(-) create mode 100644 rust/kernel/init/macros.rs create mode 100644 rust/macros/pin_data.rs
rust/kernel/init.rs +802 -5
@@ -14,7 +14,8 @@//! - an in-place constructor, //! - a memory location that can hold your `struct`. //! -//! To get an in-place constructor there are generally two options: +//! To get an in-place constructor there are generally three options: +//! - directly creating an in-place constructor using the [`pin_init!`] macro, //! - a custom function/macro returning an in-place constructor provided by someone else, //! - using the unsafe function [`pin_init_from_closure()`] to manually create an initializer. //!
@@ -22,6 +23,87 @@//! the macros/types/functions are generally named like the pinned variants without the `pin` //! prefix. //! +//! # Examples +//! +//! ## Using the [`pin_init!`] macro +//! +//! If you want to use [`PinInit`], then you will have to annotate your `struct` with +//! `#[`[`pin_data`]`]`. It is a macro that uses `#[pin]` as a marker for +//! [structurally pinned fields]. After doing this, you can then create an in-place constructor via +//! [`pin_init!`]. The syntax is almost the same as normal `struct` initializers. The difference is +//! that you need to write `<-` instead of `:` for fields that you want to initialize in-place. +//! +//! ```rust +//! # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +//! use kernel::{prelude::*, sync::Mutex, new_mutex}; +//! # use core::pin::Pin; +//! #[pin_data] +//! struct Foo { +//! #[pin] +//! a: Mutex<usize>, +//! b: u32, +//! } +//! +//! let foo = pin_init!(Foo { +//! a <- new_mutex!(42, "Foo::a"), +//! b: 24, +//! }); +//! ``` +//! +//! `foo` now is of the type [`impl PinInit<Foo>`]. We can now use any smart pointer that we like +//! (or just the stack) to actually initialize a `Foo`: +//! +//! ```rust +//! # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +//! # use kernel::{prelude::*, sync::Mutex, new_mutex}; +//! # use core::pin::Pin; +//! # #[pin_data] +//! # struct Foo { +//! # #[pin] +//! # a: Mutex<usize>, +//! # b: u32, +//! # } +//! # let foo = pin_init!(Foo { +//! # a <- new_mutex!(42, "Foo::a"), +//! # b: 24, +//! # }); +//! let foo: Result<Pin<Box<Foo>>> = Box::pin_init(foo); +//! ``` +//! +//! For more information see the [`pin_init!`] macro. +//! +//! ## Using a custom function/macro that returns an initializer +//! +//! Many types from the kernel supply a function/macro that returns an initializer, because the +//! above method only works for types where you can access the fields. +//! +//! ```rust +//! # use kernel::{new_mutex, sync::{Arc, Mutex}}; +//! let mtx: Result<Arc<Mutex<usize>>> = Arc::pin_init(new_mutex!(42, "example::mtx")); +//! ``` +//! +//! To declare an init macro/function you just return an [`impl PinInit<T, E>`]: +//! +//! ```rust +//! # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +//! # use kernel::{sync::Mutex, prelude::*, new_mutex, init::PinInit, try_pin_init}; +//! #[pin_data] +//! struct DriverData { +//! #[pin] +//! status: Mutex<i32>, +//! buffer: Box<[u8; 1_000_000]>, +//! } +//! +//! impl DriverData { +//! fn new() -> impl PinInit<Self, Error> { +//! try_pin_init!(Self { +//! status <- new_mutex!(0, "DriverData::status"), +//! buffer: Box::init(kernel::init::zeroed())?, +//! }) +//! } +//! } +//! ``` +//! //! [`sync`]: kernel::sync //! [pinning]: https://doc.rust-lang.org/std/pin/index.html //! [structurally pinned fields]:
@@ -33,12 +115,729 @@//! [`Opaque`]: kernel::types::Opaque //! [`pin_data`]: ::macros::pin_data //! [`UniqueArc<T>`]: kernel::sync::UniqueArc -//! [`Box<T>`]: alloc::boxed::Box -use core::{convert::Infallible , marker::PhantomData , mem::MaybeUninit }; +use alloc::boxed::Box ; +use core::{cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit , ptr};#[doc(hidden)] pub mod __internal; +#[doc(hidden)] +pub mod macros; + +/// Construct an in-place, pinned initializer for `struct`s. +/// +/// This macro defaults the error to [`Infallible`]. If you need [`Error`], then use +/// [`try_pin_init!`]. +/// +/// The syntax is almost identical to that of a normal `struct` initializer: +/// +/// ```rust +/// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +/// # use kernel::{init, pin_init, macros::pin_data, init::*}; +/// # use core::pin::Pin; +/// #[pin_data] +/// struct Foo { +/// a: usize, +/// b: Bar, +/// } +/// +/// #[pin_data] +/// struct Bar { +/// x: u32, +/// } +/// +/// # fn demo() -> impl PinInit<Foo> { +/// let a = 42; +/// +/// let initializer = pin_init!(Foo { +/// a, +/// b: Bar { +/// x: 64, +/// }, +/// }); +/// # initializer } +/// # Box::pin_init(demo()).unwrap(); +/// ``` +/// +/// Arbitrary Rust expressions can be used to set the value of a variable. +/// +/// The fields are initialized in the order that they appear in the initializer. So it is possible +/// to read already initialized fields using raw pointers. +/// +/// IMPORTANT: You are not allowed to create references to fields of the struct inside of the +/// initializer. +/// +/// # Init-functions +/// +/// When working with this API it is often desired to let others construct your types without +/// giving access to all fields. This is where you would normally write a plain function `new` +/// that would return a new instance of your type. With this API that is also possible. +/// However, there are a few extra things to keep in mind. +/// +/// To create an initializer function, simply declare it like this: +/// +/// ```rust +/// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +/// # use kernel::{init, pin_init, prelude::*, init::*}; +/// # use core::pin::Pin; +/// # #[pin_data] +/// # struct Foo { +/// # a: usize, +/// # b: Bar, +/// # } +/// # #[pin_data] +/// # struct Bar { +/// # x: u32, +/// # } +/// impl Foo { +/// fn new() -> impl PinInit<Self> { +/// pin_init!(Self { +/// a: 42, +/// b: Bar { +/// x: 64, +/// }, +/// }) +/// } +/// } +/// ``` +/// +/// Users of `Foo` can now create it like this: +/// +/// ```rust +/// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +/// # use kernel::{init, pin_init, macros::pin_data, init::*}; +/// # use core::pin::Pin; +/// # #[pin_data] +/// # struct Foo { +/// # a: usize, +/// # b: Bar, +/// # } +/// # #[pin_data] +/// # struct Bar { +/// # x: u32, +/// # } +/// # impl Foo { +/// # fn new() -> impl PinInit<Self> { +/// # pin_init!(Self { +/// # a: 42, +/// # b: Bar { +/// # x: 64, +/// # }, +/// # }) +/// # } +/// # } +/// let foo = Box::pin_init(Foo::new()); +/// ``` +/// +/// They can also easily embed it into their own `struct`s: +/// +/// ```rust +/// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +/// # use kernel::{init, pin_init, macros::pin_data, init::*}; +/// # use core::pin::Pin; +/// # #[pin_data] +/// # struct Foo { +/// # a: usize, +/// # b: Bar, +/// # } +/// # #[pin_data] +/// # struct Bar { +/// # x: u32, +/// # } +/// # impl Foo { +/// # fn new() -> impl PinInit<Self> { +/// # pin_init!(Self { +/// # a: 42, +/// # b: Bar { +/// # x: 64, +/// # }, +/// # }) +/// # } +/// # } +/// #[pin_data] +/// struct FooContainer { +/// #[pin] +/// foo1: Foo, +/// #[pin] +/// foo2: Foo, +/// other: u32, +/// } +/// +/// impl FooContainer { +/// fn new(other: u32) -> impl PinInit<Self> { +/// pin_init!(Self { +/// foo1 <- Foo::new(), +/// foo2 <- Foo::new(), +/// other, +/// }) +/// } +/// } +/// ``` +/// +/// Here we see that when using `pin_init!` with `PinInit`, one needs to write `<-` instead of `:`. +/// This signifies that the given field is initialized in-place. As with `struct` initializers, just +/// writing the field (in this case `other`) without `:` or `<-` means `other: other,`. +/// +/// # Syntax +/// +/// As already mentioned in the examples above, inside of `pin_init!` a `struct` initializer with +/// the following modifications is expected: +/// - 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. +/// +/// For instance: +/// +/// ```rust +/// # use kernel::pin_init; +/// # use macros::pin_data; +/// # use core::{ptr::addr_of_mut, marker::PhantomPinned}; +/// #[pin_data] +/// struct Buf { +/// // `ptr` points into `buf`. +/// ptr: *mut u8, +/// buf: [u8; 64], +/// #[pin] +/// pin: PhantomPinned, +/// } +/// pin_init!(&this in Buf { +/// buf: [0; 64], +/// ptr: unsafe { addr_of_mut!((*this.as_ptr()).buf).cast() }, +/// pin: PhantomPinned, +/// }); +/// ``` +/// +/// [`try_pin_init!`]: kernel::try_pin_init +/// [`NonNull<Self>`]: core::ptr::NonNull +/// [`Error`]: kernel::error::Error +// For a detailed example of how this macro works, see the module documentation of the hidden +// module `__internal` inside of `init/__internal.rs`. +#[macro_export] +macro_rules! pin_init { + ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { + $($fields:tt)* + }) => { + $crate::try_pin_init!( + @this ($($this)?), + @typ ($t $(::<$($generics),*>)?), + @fields ($($fields)*), + @error (::core::convert::Infallible ), + ) + }; +} + +/// Construct an in-place, fallible pinned initializer for `struct`s. +/// +/// If the initialization can complete without error (or [`Infallible`]), then use [`pin_init!`]. +/// +/// You can use the `?` operator or use `return Err(err)` inside the initializer to stop +/// initialization and return the error. +/// +/// IMPORTANT: if you have `unsafe` code inside of the initializer you have to ensure that when +/// initialization fails, the memory can be safely deallocated without any further modifications. +/// +/// This macro defaults the error to [`Error`]. +/// +/// The syntax is identical to [`pin_init!`] with the following exception: you can append `? $type` +/// after the `struct` initializer to specify the error type you want to use. +/// +/// # Examples +/// +/// ```rust +/// # #![feature(new_uninit)] +/// use kernel::{init::{self, PinInit}, error::Error}; +/// #[pin_data] +/// struct BigBuf { +/// big: Box<[u8; 1024 * 1024 * 1024]>, +/// small: [u8; 1024 * 1024], +/// ptr: *mut u8, +/// } +/// +/// impl BigBuf { +/// fn new() -> impl PinInit<Self, Error> { +/// try_pin_init!(Self { +/// big: Box::init(init::zeroed())?, +/// small: [0; 1024 * 1024], +/// ptr: core::ptr::null_mut(), +/// }? Error) +/// } +/// } +/// ``` +/// +/// [`Error`]: kernel::error::Error +// For a detailed example of how this macro works, see the module documentation of the hidden +// module `__internal` inside of `init/__internal.rs`. +#[macro_export] +macro_rules! try_pin_init { + ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { + $($fields:tt)* + }) => { + $crate::try_pin_init!( + @this ($($this)?), + @typ ($t $(::<$($generics),*>)? ), + @fields ($($fields)*), + @error ($crate ::error::Error ), + ) + }; + ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { + $($fields:tt)* + }? $err:ty) => { + $crate::try_pin_init!( + @this ($($this)?), + @typ ($t $(::<$($generics),*>)? ), + @fields ($($fields)*), + @error ($err), + ) + }; + ( + @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. +/// +/// This macro defaults the error to [`Infallible`]. If you need [`Error`], then use +/// [`try_init!`]. +/// +/// The syntax is identical to [`pin_init!`] and its safety caveats also apply: +/// - `unsafe` code must guarantee either full initialization or return an error and allow +/// deallocation of the memory. +/// - the fields are initialized in the order given in the initializer. +/// - no references to fields are allowed to be created inside of the initializer. +/// +/// This initializer is for initializing data in-place that might later be moved. If you want to +/// pin-initialize, use [`pin_init!`]. +/// +/// [`Error`]: kernel::error::Error +// For a detailed example of how this macro works, see the module documentation of the hidden +// module `__internal` inside of `init/__internal.rs`. +#[macro_export] +macro_rules! init { + ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { + $($fields:tt)* + }) => { + $crate::try_init!( + @this ($($this)?), + @typ ($t $(::<$($generics),*>)?), + @fields ($($fields)*), + @error (::core::convert::Infallible ), + ) + } +} + +/// Construct an in-place fallible initializer for `struct`s. +/// +/// This macro defaults the error to [`Error`]. If you need [`Infallible`], then use +/// [`init!`]. +/// +/// The syntax is identical to [`try_pin_init!`]. If you want to specify a custom error, +/// append `? $type` after the `struct` initializer. +/// The safety caveats from [`try_pin_init!`] also apply: +/// - `unsafe` code must guarantee either full initialization or return an error and allow +/// deallocation of the memory. +/// - the fields are initialized in the order given in the initializer. +/// - no references to fields are allowed to be created inside of the initializer. +/// +/// # Examples +/// +/// ```rust +/// use kernel::{init::PinInit, error::Error, InPlaceInit}; +/// struct BigBuf { +/// big: Box<[u8; 1024 * 1024 * 1024]>, +/// small: [u8; 1024 * 1024], +/// } +/// +/// impl BigBuf { +/// fn new() -> impl Init<Self, Error> { +/// try_init!(Self { +/// big: Box::init(zeroed())?, +/// small: [0; 1024 * 1024], +/// }? Error) +/// } +/// } +/// ``` +/// +/// [`Error`]: kernel::error::Error +// For a detailed example of how this macro works, see the module documentation of the hidden +// module `__internal` inside of `init/__internal.rs`. +#[macro_export] +macro_rules! try_init { + ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { + $($fields:tt)* + }) => { + $crate::try_init!( + @this ($($this)?), + @typ ($t $(::<$($generics),*>)?), + @fields ($($fields)*), + @error ($crate ::error::Error ), + ) + }; + ($(&$this:ident in)? $t:ident $(::<$($generics:ty),* $(,)?>)? { + $($fields:tt)* + }? $err:ty) => { + $crate::try_init!( + @this ($($this)?), + @typ ($t $(::<$($generics),*>)?), + @fields ($($fields)*), + @error ($err), + ) + }; + ( + @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`. ///
@@ -63,7 +862,6 @@ pub mod __internal;/// [`Arc<T>`]: crate::sync::Arc /// [`Arc::pin_init`]: crate::sync::Arc::pin_init /// [`UniqueArc<T>`]: kernel::sync::UniqueArc -/// [`Box<T>`]: alloc::boxed::Box #[must_use = "An initializer must be used in order to create its value." ] pub unsafe trait PinInit <T : ?Sized ,E =Infallible >:Sized {/// Initializes `slot`.
@@ -106,7 +904,6 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// /// [`Arc<T>`]: crate::sync::Arc /// [`UniqueArc<T>`]: kernel::sync::UniqueArc -/// [`Box<T>`]: alloc::boxed::Box #[must_use = "An initializer must be used in order to create its value." ] pub unsafe trait Init <T : ?Sized ,E =Infallible >:Sized {/// Initializes `slot`.
rust/kernel/init/__internal.rs +124 -0
127 lines not on this page · raw message
rust/kernel/init/macros.rs new file +707 -0
707 lines not on this page · raw message
rust/macros/lib.rs +29 -0
@@ -7,6 +7,7 @@ mod quote;mod concat_idents;mod helpers;mod module; +mod pin_data;mod vtable;use proc_macro::TokenStream ;
@@ -168,3 +169,31 @@ pub fn vtable(attr: TokenStream, ts: TokenStream) -> TokenStream {pub fn concat_idents (ts:TokenStream ) ->TokenStream { concat_idents::concat_idents (ts) } + +/// Used to specify the pinning information of the fields of a struct. +/// +/// This is somewhat similar in purpose as +/// [pin-project-lite](https://crates.io/crates/pin-project-lite). +/// Place this macro on a struct definition and then `#[pin]` in front of the attributes of each +/// field you want to structurally pin. +/// +/// This macro enables the use of the [`pin_init!`] macro. When pin-initializing a `struct`, +/// then `#[pin]` directs the type of intializer that is required. +/// +/// # Examples +/// +/// ```rust,ignore +/// #[pin_data] +/// struct DriverData { +/// #[pin] +/// queue: Mutex<Vec<Command>>, +/// buf: Box<[u8; 1024 * 1024]>, +/// } +/// ``` +/// +/// [`pin_init!`]: ../kernel/macro.pin_init.html +// ^ cannot use direct link, since `kernel` is not a dependency of `macros`. +#[proc_macro_attribute] +pub fn pin_data (inner:TokenStream , item:TokenStream ) ->TokenStream { + pin_data::pin_data (inner, item) +}
rust/macros/pin_data.rs new file +79 -0
79 lines not on this page · raw message
rust/macros/quote.rs +0 -2
@@ -38,7 +38,6 @@ impl ToTokens for TokenStream {/// This is a similar to the /// [`quote_spanned!`](https://docs.rs/quote/latest/quote/macro.quote_spanned.html) macro from the /// `quote` crate but provides only just enough functionality needed by the current `macros` crate. -#[allow(unused_macros)] macro_rules! quote_spanned { ($span:expr => $($tt:tt)*) => {#[allow(clippy::vec_init_then_push)]
@@ -137,7 +136,6 @@ macro_rules! quote_spanned {/// `macros` crate. /// /// [`Span::mixed_site()`]: https://doc.rust-lang.org/proc_macro/struct.Span.html#method.mixed_site -#[allow(unused_macros)] macro_rules! quote { ($($tt:tt)*) => {quote_spanned! (::proc_macro::Span ::mixed_site () => $($tt)*)
--
2.39.2
Re: [PATCH v5 07/15] rust: init: add initialization macros
Quoted 13 lines · Benno Lossin
Add the following initializer macros:
-#[pin_data]to annotate structurally pinned fields of structs, needed forpin_init!andtry_pin_init!to select the correct initializer of fields.
-pin_init!create a pin-initializer for a struct with theInfallibleerror type.
-try_pin_init!create a pin-initializer for a struct with a custom error type (kernel::error::Erroris the default).
-init!create an in-place-initializer for a struct with theInfallibleerror type.
-try_init!create an in-place-initializer for a struct with a custom error type (kernel::error::Erroris the default).
Quoted 7 lines
Also add their needed internal helper traits and structs.
Co-developed-by Gary Guo <[email protected]>Signed-off-by Gary Guo <[email protected]>Signed-off-by Benno Lossin <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>
PATCH v5 8/15 rust: init/sync: add `InPlaceInit` trait to pin-initialize smart pointers
In reply to Benno LossinThe InPlaceInit trait that provides two functions, for initializing using PinInit<T, E> and Init<T>. It is implemented by Arc<T>, UniqueArc<T> and Box<T>.
--- rust/kernel/init.rs | 128 ++++++++++++++++++++++++++++++++++++---- rust/kernel/sync/arc.rs | 24 ++++++++ 2 files changed, 139 insertions(+), 13 deletions(-)
rust/kernel/init.rs +115 -13
@@ -114,10 +114,16 @@//! [`impl Init<T, E>`]: Init //! [`Opaque`]: kernel::types::Opaque //! [`pin_data`]: ::macros::pin_data -//! [`UniqueArc<T>`]: kernel::sync::UniqueArc +use crate ::{ + error::{self,Error }, + sync::UniqueArc , +};use alloc::boxed::Box ; -use core::{cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit , ptr}; +use core::{ + alloc::AllocError , cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit , + pin::Pin , ptr, +};#[doc(hidden)] pub mod __internal;
@@ -309,7 +315,6 @@ pub mod macros;/// /// [`try_pin_init!`]: kernel::try_pin_init /// [`NonNull<Self>`]: core::ptr::NonNull -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export]
@@ -363,8 +368,6 @@ macro_rules! pin_init {/// } /// } /// ``` -/// -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export]
@@ -586,8 +589,6 @@ macro_rules! try_pin_init {/// /// This initializer is for initializing data in-place that might later be moved. If you want to /// pin-initialize, use [`pin_init!`]. -/// -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export]
@@ -635,8 +636,6 @@ macro_rules! init {/// } /// } /// ``` -/// -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export]
@@ -842,7 +841,8 @@ macro_rules! try_init {/// A pin-initializer for the type `T`. /// /// To use this initializer, you will need a suitable memory location that can hold a `T`. This can -/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Use the [`InPlaceInit::pin_init`] function of a +/// smart pointer like [`Arc<T>`] on this. /// /// Also see the [module description](self). ///
@@ -861,7 +861,6 @@ macro_rules! try_init {/// /// [`Arc<T>`]: crate::sync::Arc /// [`Arc::pin_init`]: crate::sync::Arc::pin_init -/// [`UniqueArc<T>`]: kernel::sync::UniqueArc #[must_use = "An initializer must be used in order to create its value." ] pub unsafe trait PinInit <T : ?Sized ,E =Infallible >:Sized {/// Initializes `slot`.
@@ -878,7 +877,8 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// An initializer for `T`. /// /// To use this initializer, you will need a suitable memory location that can hold a `T`. This can -/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Because [`PinInit<T, E>`] is a super trait, you can +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Use the [`InPlaceInit::init`] function of a smart +/// pointer like [`Arc<T>`] on this. Because [`PinInit<T, E>`] is a super trait, you can /// use every function that takes it as well. /// /// Also see the [module description](self).
@@ -903,7 +903,6 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// move the pointee after initialization. /// /// [`Arc<T>`]: crate::sync::Arc -/// [`UniqueArc<T>`]: kernel::sync::UniqueArc #[must_use = "An initializer must be used in order to create its value." ] pub unsafe trait Init <T : ?Sized ,E =Infallible >:Sized {/// Initializes `slot`.
@@ -982,3 +981,106 @@ unsafe impl<T> Init<T> for T {Ok (()) } } + +/// 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 +/// type. +/// +/// If `T: !Unpin` it will not be able to move afterwards. +fn try_pin_init <E >(init:impl PinInit <T ,E >) ->Result <Pin <Self >,E > +where +E :From <AllocError >; + +/// Use the given pin-initializer to pin-initialize a `T` inside of a new smart pointer of this +/// type. +/// +/// If `T: !Unpin` it will not be able to move afterwards. +fn pin_init <E >(init:impl PinInit <T ,E >) -> error::Result <Pin <Self >> +where +Error :From <E >, + { +// SAFETY: We delegate to `init` and only change the error type. +let init =unsafe { +pin_init_from_closure (|slot| init.__pinned_init (slot).map_err (|e|Error ::from (e))) + }; +Self ::try_pin_init (init) + } + +/// Use the given initializer to in-place initialize a `T`. +fn try_init <E >(init:impl Init <T ,E >) ->Result <Self ,E > +where +E :From <AllocError >; + +/// Use the given initializer to in-place initialize a `T`. +fn init <E >(init:impl Init <T ,E >) -> error::Result <Self > +where +Error :From <E >, + { +// SAFETY: We delegate to `init` and only change the error type. +let init =unsafe { +init_from_closure (|slot| init.__pinned_init (slot).map_err (|e|Error ::from (e))) + }; +Self ::try_init (init) + } +} + +impl <T >InPlaceInit <T >for Box <T > { +#[inline] +fn try_pin_init <E >(init:impl PinInit <T ,E >) ->Result <Pin <Self >,E > +where +E :From <AllocError >, + { +let mut this =Box ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid and will not be moved, because we pin it later. +unsafe { init.__pinned_init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }.into ()) + } + +#[inline] +fn try_init <E >(init:impl Init <T ,E >) ->Result <Self ,E > +where +E :From <AllocError >, + { +let mut this =Box ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid. +unsafe { init.__init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }) + } +} + +impl <T >InPlaceInit <T >for UniqueArc <T > { +#[inline] +fn try_pin_init <E >(init:impl PinInit <T ,E >) ->Result <Pin <Self >,E > +where +E :From <AllocError >, + { +let mut this =UniqueArc ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid and will not be moved, because we pin it later. +unsafe { init.__pinned_init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }.into ()) + } + +#[inline] +fn try_init <E >(init:impl Init <T ,E >) ->Result <Self ,E > +where +E :From <AllocError >, + { +let mut this =UniqueArc ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid. +unsafe { init.__init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }) + } +}
rust/kernel/sync/arc.rs +24 -0
@@ -17,6 +17,8 @@use crate ::{ bindings, + error::{self,Error }, + init::{InPlaceInit ,Init ,PinInit }, types::{ForeignOwnable ,Opaque }, };use alloc::boxed::Box ;
@@ -163,6 +165,28 @@ impl<T> Arc<T> {// `Arc` object. Ok (unsafe {Self ::from_inner (Box ::leak (inner).into ()) }) } + +/// Use the given initializer to in-place initialize a `T`. +/// +/// If `T: !Unpin` it will not be able to move afterwards. +#[inline] +pub fn pin_init <E >(init:impl PinInit <T ,E >) -> error::Result <Self > +where +Error :From <E >, + { +UniqueArc ::pin_init (init).map (|u| u.into ()) + } + +/// Use the given initializer to in-place initialize a `T`. +/// +/// This is equivalent to [`pin_init`], since an [`Arc`] is always pinned. +#[inline] +pub fn init <E >(init:impl Init <T ,E >) -> error::Result <Self > +where +Error :From <E >, + { +UniqueArc ::init (init).map (|u| u.into ()) + } }impl <T : ?Sized >Arc <T > {
--
2.39.2
Re: [PATCH v5 08/15] rust: init/sync: add `InPlaceInit` trait to pin-initialize smart pointers
Quoted 8 lines · Benno Lossin
The
InPlaceInittrait that provides two functions, for initializing usingPinInit<T, E>andInit<T>. It is implemented byArc<T>,UniqueArc<T>andBox<T>.Signed-off-by Benno Lossin <[email protected]>Cc Andreas Hindborg <[email protected]>Cc Alice Ryhl <[email protected]>Cc Gary Guo <[email protected]>
Re: [PATCH v5 08/15] rust: init/sync: add `InPlaceInit` trait to pin-initialize smart pointers
In reply to Benno LossinQuoted 8 lines · On Mon, 03 Apr 2023 16:05:22 +0000 Benno Lossin <[email protected]> wrote:
The
InPlaceInittrait that provides two functions, for initializing usingPinInit<T, E>andInit<T>. It is implemented byArc<T>,UniqueArc<T>andBox<T>.Signed-off-by Benno Lossin <[email protected]>Cc Andreas Hindborg <[email protected]>Cc Alice Ryhl <[email protected]>Cc Gary Guo <[email protected]>
Quoted 252 lines
--- rust/kernel/init.rs | 128 ++++++++++++++++++++++++++++++++++++---- rust/kernel/sync/arc.rs | 24 ++++++++ 2 files changed, 139 insertions(+), 13 deletions(-)rust/kernel/init.rs +115
-13@@ -114,10 +114,16 @@//! [`impl Init<T, E>`]: Init //! [`Opaque`]: kernel::types::Opaque //! [`pin_data`]: ::macros::pin_data -//! [`UniqueArc<T>`]: kernel::sync::UniqueArc +use crate ::{ + error::{self,Error }, + sync::UniqueArc , +};use alloc::boxed::Box ; -use core::{cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit , ptr}; +use core::{ + alloc::AllocError , cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit , + pin::Pin , ptr, +};#[doc(hidden)] pub mod __internal;@@ -309,7 +315,6 @@ pub mod macros;/// /// [`try_pin_init!`]: kernel::try_pin_init /// [`NonNull<Self>`]: core::ptr::NonNull -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export] @@ -363,8 +368,6 @@ macro_rules! pin_init {/// } /// } /// ``` -/// -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export] @@ -586,8 +589,6 @@ macro_rules! try_pin_init {/// /// This initializer is for initializing data in-place that might later be moved. If you want to /// pin-initialize, use [`pin_init!`]. -/// -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export] @@ -635,8 +636,6 @@ macro_rules! init {/// } /// } /// ``` -/// -/// [`Error`]: kernel::error::Error // For a detailed example of how this macro works, see the module documentation of the hidden // module `__internal` inside of `init/__internal.rs`. #[macro_export] @@ -842,7 +841,8 @@ macro_rules! try_init {/// A pin-initializer for the type `T`. /// /// To use this initializer, you will need a suitable memory location that can hold a `T`. This can -/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Use the [`InPlaceInit::pin_init`] function of a +/// smart pointer like [`Arc<T>`] on this. /// /// Also see the [module description](self). /// @@ -861,7 +861,6 @@ macro_rules! try_init {/// /// [`Arc<T>`]: crate::sync::Arc /// [`Arc::pin_init`]: crate::sync::Arc::pin_init -/// [`UniqueArc<T>`]: kernel::sync::UniqueArc #[must_use = "An initializer must be used in order to create its value." ] pub unsafe trait PinInit <T : ?Sized ,E =Infallible >:Sized {/// Initializes `slot`. @@ -878,7 +877,8 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// An initializer for `T`. /// /// To use this initializer, you will need a suitable memory location that can hold a `T`. This can -/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Because [`PinInit<T, E>`] is a super trait, you can +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Use the [`InPlaceInit::init`] function of a smart +/// pointer like [`Arc<T>`] on this. Because [`PinInit<T, E>`] is a super trait, you can /// use every function that takes it as well. /// /// Also see the [module description](self). @@ -903,7 +903,6 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// move the pointee after initialization. /// /// [`Arc<T>`]: crate::sync::Arc -/// [`UniqueArc<T>`]: kernel::sync::UniqueArc #[must_use = "An initializer must be used in order to create its value." ] pub unsafe trait Init <T : ?Sized ,E =Infallible >:Sized {/// Initializes `slot`. @@ -982,3 +981,106 @@ unsafe impl<T> Init<T> for T {Ok (()) } } + +/// 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 +/// type. +/// +/// If `T: !Unpin` it will not be able to move afterwards. +fn try_pin_init <E >(init:impl PinInit <T ,E >) ->Result <Pin <Self >,E > +where +E :From <AllocError >; + +/// Use the given pin-initializer to pin-initialize a `T` inside of a new smart pointer of this +/// type. +/// +/// If `T: !Unpin` it will not be able to move afterwards. +fn pin_init <E >(init:impl PinInit <T ,E >) -> error::Result <Pin <Self >> +where +Error :From <E >, + { +// SAFETY: We delegate to `init` and only change the error type. +let init =unsafe { +pin_init_from_closure (|slot| init.__pinned_init (slot).map_err (|e|Error ::from (e))) + }; +Self ::try_pin_init (init) + } + +/// Use the given initializer to in-place initialize a `T`. +fn try_init <E >(init:impl Init <T ,E >) ->Result <Self ,E > +where +E :From <AllocError >; + +/// Use the given initializer to in-place initialize a `T`. +fn init <E >(init:impl Init <T ,E >) -> error::Result <Self > +where +Error :From <E >, + { +// SAFETY: We delegate to `init` and only change the error type. +let init =unsafe { +init_from_closure (|slot| init.__pinned_init (slot).map_err (|e|Error ::from (e))) + }; +Self ::try_init (init) + } +} + +impl <T >InPlaceInit <T >for Box <T > { +#[inline] +fn try_pin_init <E >(init:impl PinInit <T ,E >) ->Result <Pin <Self >,E > +where +E :From <AllocError >, + { +let mut this =Box ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid and will not be moved, because we pin it later. +unsafe { init.__pinned_init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }.into ()) + } + +#[inline] +fn try_init <E >(init:impl Init <T ,E >) ->Result <Self ,E > +where +E :From <AllocError >, + { +let mut this =Box ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid. +unsafe { init.__init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }) + } +} + +impl <T >InPlaceInit <T >for UniqueArc <T > { +#[inline] +fn try_pin_init <E >(init:impl PinInit <T ,E >) ->Result <Pin <Self >,E > +where +E :From <AllocError >, + { +let mut this =UniqueArc ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid and will not be moved, because we pin it later. +unsafe { init.__pinned_init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }.into ()) + } + +#[inline] +fn try_init <E >(init:impl Init <T ,E >) ->Result <Self ,E > +where +E :From <AllocError >, + { +let mut this =UniqueArc ::try_new_uninit ()?; +let slot = this.as_mut_ptr (); +// SAFETY: When init errors/panics, slot will get deallocated but not dropped, +// slot is valid. +unsafe { init.__init (slot)? }; +// SAFETY: All fields have been initialized. +Ok (unsafe { this.assume_init () }) + } +}rust/kernel/sync/arc.rs +24
-1@@ -17,6 +17,8 @@use crate ::{ bindings, + error::{self,Error }, + init::{InPlaceInit ,Init ,PinInit }, types::{ForeignOwnable ,Opaque }, };use alloc::boxed::Box ;@@ -163,6 +165,28 @@ impl<T> Arc<T> {// `Arc` object. Ok (unsafe {Self ::from_inner (Box ::leak (inner).into ()) }) } + +/// Use the given initializer to in-place initialize a `T`. +/// +/// If `T: !Unpin` it will not be able to move afterwards. +#[inline] +pub fn pin_init <E >(init:impl PinInit <T ,E >) -> error::Result <Self > +where +Error :From <E >, + { +UniqueArc ::pin_init (init).map (|u| u.into ()) + } + +/// Use the given initializer to in-place initialize a `T`. +/// +/// This is equivalent to [`pin_init`], since an [`Arc`] is always pinned. +#[inline] +pub fn init <E >(init:impl Init <T ,E >) -> error::Result <Self > +where +Error :From <E >, + { +UniqueArc ::init (init).map (|u| u.into ()) + } }impl <T : ?Sized >Arc <T > { --2.39.2
PATCH v5 9/15 rust: init: add `PinnedDrop` trait and macros
In reply to Benno LossinThe PinnedDrop trait that facilitates destruction of pinned types. It has to be implemented via the #[pinned_drop] macro, since the drop function should not be called by normal code, only by other destructors. It also only works on structs that are annotated with #[pin_data(PinnedDrop)].
--- rust/kernel/init.rs | 111 ++++++++++++++ rust/kernel/init/__internal.rs | 15 ++ rust/kernel/init/macros.rs | 264 +++++++++++++++++++++++++++++++++ rust/macros/lib.rs | 49 ++++++ rust/macros/pinned_drop.rs | 49 ++++++ 5 files changed, 488 insertions(+) create mode 100644 rust/macros/pinned_drop.rs
rust/kernel/init.rs +111 -0
@@ -104,6 +104,78 @@//! } //! ``` //! +//! ## Manual creation of an initializer +//! +//! Often when working with primitives the previous approaches are not sufficient. That is where +//! [`pin_init_from_closure()`] comes in. This `unsafe` function allows you to create a +//! [`impl PinInit<T, E>`] directly from a closure. Of course you have to ensure that the closure +//! actually does the initialization in the correct way. Here are the things to look out for +//! (we are calling the parameter to the closure `slot`): +//! - when the closure returns `Ok(())`, then it has completed the initialization successfully, so +//! `slot` now contains a valid bit pattern for the type `T`, +//! - when the closure returns `Err(e)`, then the caller may deallocate the memory at `slot`, so +//! you need to take care to clean up anything if your initialization fails mid-way, +//! - you may assume that `slot` will stay pinned even after the closure returns until `drop` of +//! `slot` gets called. +//! +//! ```rust +//! use kernel::{prelude::*, init}; +//! use core::{ptr::addr_of_mut, marker::PhantomPinned, pin::Pin}; +//! # mod bindings { +//! # pub struct foo; +//! # pub unsafe fn init_foo(_ptr: *mut foo) {} +//! # pub unsafe fn destroy_foo(_ptr: *mut foo) {} +//! # pub unsafe fn enable_foo(_ptr: *mut foo, _flags: u32) -> i32 { 0 } +//! # } +//! /// # Invariants +//! /// +//! /// `foo` is always initialized +//! #[pin_data(PinnedDrop)] +//! pub struct RawFoo { +//! #[pin] +//! foo: Opaque<bindings::foo>, +//! #[pin] +//! _p: PhantomPinned, +//! } +//! +//! impl RawFoo { +//! pub fn new(flags: u32) -> impl PinInit<Self, Error> { +//! // SAFETY: +//! // - when the closure returns `Ok(())`, then it has successfully initialized and +//! // enabled `foo`, +//! // - when it returns `Err(e)`, then it has cleaned up before +//! unsafe { +//! init::pin_init_from_closure(move |slot: *mut Self| { +//! // `slot` contains uninit memory, avoid creating a reference. +//! let foo = addr_of_mut!((*slot).foo); +//! +//! // Initialize the `foo` +//! bindings::init_foo(Opaque::raw_get(foo)); +//! +//! // Try to enable it. +//! let err = bindings::enable_foo(Opaque::raw_get(foo), flags); +//! if err != 0 { +//! // Enabling has failed, first clean up the foo and then return the error. +//! bindings::destroy_foo(Opaque::raw_get(foo)); +//! return Err(Error::from_kernel_errno(err)); +//! } +//! +//! // All fields of `RawFoo` have been initialized, since `_p` is a ZST. +//! Ok(()) +//! }) +//! } +//! } +//! } +//! +//! #[pinned_drop] +//! impl PinnedDrop for RawFoo { +//! fn drop(self: Pin<&mut Self>) { +//! // SAFETY: Since `foo` is initialized, destroying is safe. +//! unsafe { bindings::destroy_foo(self.foo.get()) }; +//! } +//! } +//! ``` +//! //! [`sync`]: kernel::sync //! [pinning]: https://doc.rust-lang.org/std/pin/index.html //! [structurally pinned fields]:
@@ -1084,3 +1156,42 @@ impl<T> InPlaceInit<T> for UniqueArc<T> {Ok (unsafe { this.assume_init () }) } } + +/// Trait facilitating pinned destruction. +/// +/// Use [`pinned_drop`] to implement this trait safely: +/// +/// ```rust +/// # use kernel::sync::Mutex; +/// use kernel::macros::pinned_drop; +/// use core::pin::Pin; +/// #[pin_data(PinnedDrop)] +/// struct Foo { +/// #[pin] +/// mtx: Mutex<usize>, +/// } +/// +/// #[pinned_drop] +/// impl PinnedDrop for Foo { +/// fn drop(self: Pin<&mut Self>) { +/// pr_info!("Foo is being dropped!"); +/// } +/// } +/// ``` +/// +/// # Safety +/// +/// This trait must be implemented via the [`pinned_drop`] proc-macro attribute on the impl. +/// +/// [`pinned_drop`]: kernel::macros::pinned_drop +pub unsafe trait PinnedDrop : __internal::HasPinData { +/// Executes the pinned destructor of this type. +/// +/// While this function is marked safe, it is actually unsafe to call it manually. For this +/// reason it takes an additional parameter. This type can only be constructed by `unsafe` code +/// and thus prevents this function from being called where it should not. +/// +/// This extra parameter will be generated by the `#[pinned_drop]` proc-macro attribute +/// automatically. +fn drop (self:Pin <&mut Self >, only_call_from_drop: __internal::OnlyCallFromDrop ); +}
rust/kernel/init/__internal.rs +15 -0
@@ -155,3 +155,18 @@ impl<T: ?Sized> Drop for DropGuard<T> { } } } + +/// Token used by `PinnedDrop` to prevent calling the function without creating this unsafely +/// created struct. This is needed, because the `drop` function is safe, but should not be called +/// manually. +pub struct OnlyCallFromDrop (()); + +impl OnlyCallFromDrop { +/// # Safety +/// +/// This function should only be called from the [`Drop::drop`] function and only be used to +/// delegate the destruction to the pinned destructor [`PinnedDrop::drop`] of the same type. +pub unsafe fn new () ->Self { +Self (()) + } +}
rust/kernel/init/macros.rs +264 -0
288 lines not on this page · raw message
rust/macros/lib.rs +49 -0
70 lines not on this page · raw message
rust/macros/pinned_drop.rs new file +49 -0
49 lines not on this page · raw message
--
2.39.2
Re: [PATCH v5 09/15] rust: init: add `PinnedDrop` trait and macros
Quoted 11 lines · Benno Lossin
The
PinnedDroptrait that facilitates destruction of pinned types. It has to be implemented via the#[pinned_drop]macro, since thedropfunction should not be called by normal code, only by other destructors. It also only works on structs that are annotated with#[pin_data(PinnedDrop)].Co-developed-by Gary Guo <[email protected]>Signed-off-by Gary Guo <[email protected]>Signed-off-by Benno Lossin <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>
PATCH v5 10/15 rust: init: add `stack_pin_init!` macro
In reply to Benno LossinThe stack_pin_init! macro allows pin-initializing a value on the stack. It accepts a impl PinInit<T, E> to initialize a T. It allows propagating any errors via ? or handling it normally via match.
--- rust/kernel/init.rs | 146 +++++++++++++++++++++++++++++++-- rust/kernel/init/__internal.rs | 50 +++++++++++ 2 files changed, 190 insertions(+), 6 deletions(-)
rust/kernel/init.rs +140 -6
@@ -12,7 +12,8 @@//! //! To initialize a `struct` with an in-place constructor you will need two things: //! - an in-place constructor, -//! - a memory location that can hold your `struct`. +//! - a memory location that can hold your `struct` (this can be the [stack], an [`Arc<T>`], +//! [`UniqueArc<T>`], [`Box<T>`] or any other smart pointer that implements [`InPlaceInit`]). //! //! To get an in-place constructor there are generally three options: //! - directly creating an in-place constructor using the [`pin_init!`] macro,
@@ -180,6 +181,7 @@//! [pinning]: https://doc.rust-lang.org/std/pin/index.html //! [structurally pinned fields]: //! https://doc.rust-lang.org/std/pin/index.html#pinning-is-structural-for-field +//! [stack]: crate::stack_pin_init //! [`Arc<T>`]: crate::sync::Arc //! [`impl PinInit<Foo>`]: PinInit //! [`impl PinInit<T, E>`]: PinInit
@@ -202,6 +204,138 @@ pub mod __internal;#[doc(hidden)] pub mod macros; +/// Initialize and pin a type directly on the stack. +/// +/// # Examples +/// +/// ```rust +/// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +/// # use kernel::{init, pin_init, stack_pin_init, init::*, sync::Mutex, new_mutex}; +/// # use macros::pin_data; +/// # use core::pin::Pin; +/// #[pin_data] +/// struct Foo { +/// #[pin] +/// a: Mutex<usize>, +/// b: Bar, +/// } +/// +/// #[pin_data] +/// struct Bar { +/// x: u32, +/// } +/// +/// stack_pin_init!(let foo = pin_init!(Foo { +/// a <- new_mutex!(42), +/// b: Bar { +/// x: 64, +/// }, +/// })); +/// let foo: Pin<&mut Foo> = foo; +/// pr_info!("a: {}", &*foo.a.lock()); +/// ``` +/// +/// # Syntax +/// +/// A normal `let` binding with optional type annotation. The expression is expected to implement +/// [`PinInit`]/[`Init`] with the error type [`Infallible`]. If you want to use a different error +/// type, then use [`stack_try_pin_init!`]. +#[macro_export] +macro_rules! stack_pin_init { + (let $var:ident $(: $t:ty)? = $val:expr) => { +let mut $var = ::core::pin::pin!($crate ::init::__internal::StackInit $(::<$t>)?::uninit ()); +let mut $var = { +let val = $val; +match $crate::init::__internal::StackInit ::init ($var, val) { +Ok (res) => res, +Err (x) => { +let x: ::core::convert::Infallible = x; +match x {} + } + } + }; + }; +} + +/// Initialize and pin a type directly on the stack. +/// +/// # Examples +/// +/// ```rust +/// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +/// # use kernel::{init, pin_init, stack_try_pin_init, init::*, sync::Mutex, new_mutex}; +/// # use macros::pin_data; +/// # use core::{alloc::AllocError, pin::Pin}; +/// #[pin_data] +/// struct Foo { +/// #[pin] +/// a: Mutex<usize>, +/// b: Box<Bar>, +/// } +/// +/// struct Bar { +/// x: u32, +/// } +/// +/// stack_try_pin_init!(let foo: Result<Pin<&mut Foo>, AllocError> = pin_init!(Foo { +/// a <- new_mutex!(42), +/// b: Box::try_new(Bar { +/// x: 64, +/// })?, +/// })); +/// let foo = foo.unwrap(); +/// pr_info!("a: {}", &*foo.a.lock()); +/// ``` +/// +/// ```rust +/// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)] +/// # use kernel::{init, pin_init, stack_try_pin_init, init::*, sync::Mutex, new_mutex}; +/// # use macros::pin_data; +/// # use core::{alloc::AllocError, pin::Pin}; +/// #[pin_data] +/// struct Foo { +/// #[pin] +/// a: Mutex<usize>, +/// b: Box<Bar>, +/// } +/// +/// struct Bar { +/// x: u32, +/// } +/// +/// stack_try_pin_init!(let foo: Pin<&mut Foo> =? pin_init!(Foo { +/// a <- new_mutex!(42), +/// b: Box::try_new(Bar { +/// x: 64, +/// })?, +/// })); +/// pr_info!("a: {}", &*foo.a.lock()); +/// # Ok::<_, AllocError>(()) +/// ``` +/// +/// # Syntax +/// +/// A normal `let` binding with optional type annotation. The expression is expected to implement +/// [`PinInit`]/[`Init`]. This macro assigns a result to the given variable, adding a `?` after the +/// `=` will propagate this error. +#[macro_export] +macro_rules! stack_try_pin_init { + (let $var:ident $(: $t:ty)? = $val:expr) => { +let mut $var = ::core::pin::pin!($crate ::init::__internal::StackInit $(::<$t>)?::uninit ()); +let mut $var = { +let val = $val; + $crate::init::__internal::StackInit ::init ($var, val) + }; + }; + (let $var:ident $(: $t:ty)? =? $val:expr) => { +let mut $var = ::core::pin::pin!($crate ::init::__internal::StackInit $(::<$t>)?::uninit ()); +let mut $var = { +let val = $val; + $crate::init::__internal::StackInit ::init ($var, val)? + }; + }; +} +/// Construct an in-place, pinned initializer for `struct`s. /// /// This macro defaults the error to [`Infallible`]. If you need [`Error`], then use
@@ -913,8 +1047,8 @@ macro_rules! try_init {/// A pin-initializer for the type `T`. /// /// To use this initializer, you will need a suitable memory location that can hold a `T`. This can -/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Use the [`InPlaceInit::pin_init`] function of a -/// smart pointer like [`Arc<T>`] on this. +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`] or even the stack (see [`stack_pin_init!`]). Use the +/// [`InPlaceInit::pin_init`] function of a smart pointer like [`Arc<T>`] on this. /// /// Also see the [module description](self). ///
@@ -949,9 +1083,9 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {/// An initializer for `T`. /// /// To use this initializer, you will need a suitable memory location that can hold a `T`. This can -/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`]. Use the [`InPlaceInit::init`] function of a smart -/// pointer like [`Arc<T>`] on this. Because [`PinInit<T, E>`] is a super trait, you can -/// use every function that takes it as well. +/// be [`Box<T>`], [`Arc<T>`], [`UniqueArc<T>`] or even the stack (see [`stack_pin_init!`]). Use the +/// [`InPlaceInit::init`] function of a smart pointer like [`Arc<T>`] on this. Because +/// [`PinInit<T, E>`] is a super trait, you can use every function that takes it as well. /// /// Also see the [module description](self). ///
rust/kernel/init/__internal.rs +50 -0
56 lines not on this page · raw message
--
2.39.2
Re: [PATCH v5 10/15] rust: init: add `stack_pin_init!` macro
Quoted 9 lines · Benno Lossin
The
stack_pin_init!macro allows pin-initializing a value on the stack. It accepts aimpl PinInit<T, E>to initialize aT. It allows propagating any errors via?or handling it normally viamatch.Signed-off-by Benno Lossin <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>Cc Gary Guo <[email protected]>---
If you fix the issue below, then you may add
rust/kernel/init/__internal.rs unsafe impl<T: ?Sized> HasInitData for T { · line 156
Quoted 12 lines
rust/kernel/init/__internal.rs +12
-0+/// Initializes the contents and returns the result. +#[inline] +pub fn init <E >(self:Pin <&mut Self >, init:impl PinInit <T ,E >) ->Result <Pin <&mut T >,E > { +// SAFETY: We never move out of `this`. +let this =unsafe {Pin ::into_inner_unchecked (self) }; +// The value is currently initialized, so it needs to be dropped before we can reuse +// the memory (this is a safety guarantee of `Pin`). +if this.1 { +// SAFETY: `this.1` is true and we set it to false after this. +unsafe { this.0 .assume_init_drop () }; + this.1 =false ; + }
This would double-free the value if assume_init_drop panics. I know that we configure panics to abort the kernel, but someone could copy this into another codebase and then they would have this issue.
You can fix it by setting this.1 to false *before* calling assume_init_drop.
PATCH v5 11/15 rust: init: add `Zeroable` trait and `init::zeroed` function
In reply to Benno LossinAdd the Zeroable trait which marks types that can be initialized by writing 0x00 to every byte of the type. Also add the init::zeroed function that creates an initializer for a Zeroable type that writes 0x00 to every byte.
--- rust/kernel/init.rs | 94 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 92 insertions(+), 2 deletions(-)
rust/kernel/init.rs +92 -2
@@ -195,8 +195,14 @@ use crate::{ };use alloc::boxed::Box ;use core::{ - alloc::AllocError , cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit , - pin::Pin , ptr, + alloc::AllocError , + cell::Cell , + convert::Infallible , + marker::PhantomData , + mem::MaybeUninit , + num::*, + pin::Pin , + ptr::{self,NonNull }, };#[doc(hidden)]
@@ -1329,3 +1335,87 @@ pub unsafe trait PinnedDrop: __internal::HasPinData {/// automatically. fn drop (self:Pin <&mut Self >, only_call_from_drop: __internal::OnlyCallFromDrop ); } + +/// Marker trait for types that can be initialized by writing just zeroes. +/// +/// # Safety +/// +/// The bit pattern consisting of only zeroes is a valid bit pattern for this type. In other words, +/// this is not UB: +/// +/// ```rust,ignore +/// let val: Self = unsafe { core::mem::zeroed() }; +/// ``` +pub unsafe trait Zeroable {} + +/// Create a new zeroed T. +/// +/// The returned initializer will write `0x00` to every byte of the given `slot`. +#[inline] +pub fn zeroed <T :Zeroable +Unpin >() ->impl Init <T > { +// SAFETY: Because `T: Zeroable`, all bytes zero is a valid bit pattern for `T` +// and because we write all zeroes, the memory is initialized. +unsafe { +init_from_closure (|slot: *mut T | { + slot.write_bytes (0 ,1 ); +Ok (()) + }) + } +} + +macro_rules! impl_zeroable { + ($($({$($generics:tt)*})? $t:ty, )*) => { + $(unsafe impl $($($generics)*)?Zeroable for $t {})* + }; +} + +impl_zeroable! { +// SAFETY: All primitives that are allowed to be zero. +bool , +char , +u8 ,u16 ,u32 ,u64 ,u128 ,usize , +i8 ,i16 ,i32 ,i64 ,i128 ,isize , +f32 ,f64 , + +// SAFETY: These are ZSTs, there is nothing to zero. + {<T : ?Sized >}PhantomData <T >, core::marker::PhantomPinned ,Infallible , (), + +// SAFETY: Type is allowed to take any value, including all zeros. + {<T >}MaybeUninit <T >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +Option <NonZeroU8 >,Option <NonZeroU16 >,Option <NonZeroU32 >,Option <NonZeroU64 >, +Option <NonZeroU128 >,Option <NonZeroUsize >, +Option <NonZeroI8 >,Option <NonZeroI16 >,Option <NonZeroI32 >,Option <NonZeroI64 >, +Option <NonZeroI128 >,Option <NonZeroIsize >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +// +// In this case we are allowed to use `T: ?Sized`, since all zeros is the `None` variant. + {<T : ?Sized >}Option <NonNull <T >>, + {<T : ?Sized >}Option <Box <T >>, + +// SAFETY: `null` pointer is valid. +// +// We cannot use `T: ?Sized`, since the VTABLE pointer part of fat pointers is not allowed to be +// null. + {<T >} *mut T , {<T >} *const T , + +// SAFETY: `null` pointer is valid and the metadata part of these fat pointers is allowed to be +// zero. + {<T >} *mut [T ], {<T >} *const [T ], *mut str , *const str , + +// SAFETY: `T` is `Zeroable`. + {<const N :usize ,T :Zeroable >} [T ;N ], {<T :Zeroable >}Wrapping <T >, +} + +macro_rules! impl_tuple_zeroable { + ($(,)?) => {}; + ($first:ident, $($t:ident),* $(,)?) => { +// SAFETY: All elements are zeroable and padding can be zero. +unsafe impl <$first:Zeroable , $($t:Zeroable ),*>Zeroable for ($first, $($t),*) {} +impl_tuple_zeroable! ($($t),* ,); + } +} + +impl_tuple_zeroable! (A ,B ,C ,D ,E ,F ,G ,H ,I ,J );
--
2.39.2
Re: [PATCH v5 11/15] rust: init: add `Zeroable` trait and `init::zeroed` function
Quoted 9 lines · Benno Lossin
Add the
Zeroabletrait which marks types that can be initialized by writing0x00to every byte of the type. Also add theinit::zeroedfunction that creates an initializer for aZeroabletype that writes0x00to every byte.Signed-off-by Benno Lossin <[email protected]>Cc Gary Guo <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>
I have two minor suggestions - take them or leave them.
rust/kernel/init.rs pub unsafe trait PinnedDrop: __internal::HasPinData { · line 1364
Quoted 10 lines
rust/kernel/init.rs +10
-0+pub fn zeroed <T :Zeroable +Unpin >() ->impl Init <T > { +// SAFETY: Because `T: Zeroable`, all bytes zero is a valid bit pattern for `T` +// and because we write all zeroes, the memory is initialized. +unsafe { +init_from_closure (|slot: *mut T | { + slot.write_bytes (0 ,1 ); +Ok (()) + }) + } +}
You don't need T: Unpin here.
Quoted 35 lines
rust/kernel/init.rs +35
-0+macro_rules! impl_zeroable { + ($($({$($generics:tt)*})? $t:ty, )*) => { + $(unsafe impl $($($generics)*)?Zeroable for $t {})* + }; +} + +impl_zeroable! { +// SAFETY: All primitives that are allowed to be zero. +bool , +char , +u8 ,u16 ,u32 ,u64 ,u128 ,usize , +i8 ,i16 ,i32 ,i64 ,i128 ,isize , +f32 ,f64 , + +// SAFETY: These are ZSTs, there is nothing to zero. + {<T : ?Sized >}PhantomData <T >, core::marker::PhantomPinned ,Infallible , (), + +// SAFETY: Type is allowed to take any value, including all zeros. + {<T >}MaybeUninit <T >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +Option <NonZeroU8 >,Option <NonZeroU16 >,Option <NonZeroU32 >,Option <NonZeroU64 >, +Option <NonZeroU128 >,Option <NonZeroUsize >, +Option <NonZeroI8 >,Option <NonZeroI16 >,Option <NonZeroI32 >,Option <NonZeroI64 >, +Option <NonZeroI128 >,Option <NonZeroIsize >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +// +// In this case we are allowed to use `T: ?Sized`, since all zeros is the `None` variant. + {<T : ?Sized >}Option <NonNull <T >>, + {<T : ?Sized >}Option <Box <T >>, + +// SAFETY: `null` pointer is valid. +// +// We cannot use `T: ?Sized`, since the VTABLE pointer part of fat pointers is not allowed to be
rust/kernel/init.rs pub unsafe trait PinnedDrop: __internal::HasPinData { · line 1410
Quoted 10 lines
rust/kernel/init.rs +10
-0+// null. + {<T>} *mut T, {<T>} *const T, + +// SAFETY: `null` pointer is valid and the metadata part of these fat pointers is allowed to be +// zero. + {<T>} *mut [T], {<T>} *const [T], *mut str, *const str, + +// SAFETY: `T` is `Zeroable`. + {<const N: usize, T: Zeroable>} [T; N], {<T: Zeroable>} Wrapping<T>, +}
Arguably, it would make sense to just expand this macro. The code doesn't become that much longer, and it removes the need to understand the macro.
Gary Guo
maintainerRe: [PATCH v5 11/15] rust: init: add `Zeroable` trait and `init::zeroed` function
Quoted 69 lines · On Mon, 3 Apr 2023 19:56:29 +0200 Alice Ryhl <[email protected]> wrote:
Quoted 9 lines · Benno Lossin
Add the
Zeroabletrait which marks types that can be initialized by writing0x00to every byte of the type. Also add theinit::zeroedfunction that creates an initializer for aZeroabletype that writes0x00to every byte.Signed-off-by Benno Lossin <[email protected]>Cc Gary Guo <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>Reviewed-by Alice Ryhl <[email protected]>I have two minor suggestions - take them or leave them.
rust/kernel/init.rs pub unsafe trait PinnedDrop: __internal::HasPinData { · line 1364
Quoted 10 lines
rust/kernel/init.rs +10
-0+pub fn zeroed <T :Zeroable +Unpin >() ->impl Init <T > { +// SAFETY: Because `T: Zeroable`, all bytes zero is a valid bit pattern for `T` +// and because we write all zeroes, the memory is initialized. +unsafe { +init_from_closure (|slot: *mut T | { + slot.write_bytes (0 ,1 ); +Ok (()) + }) + } +}You don't need
T: Unpinhere.Quoted 41 lines
rust/kernel/init.rs +41
-0+macro_rules! impl_zeroable { + ($($({$($generics:tt)*})? $t:ty, )*) => { + $(unsafe impl $($($generics)*)?Zeroable for $t {})* + }; +} + +impl_zeroable! { +// SAFETY: All primitives that are allowed to be zero. +bool , +char , +u8 ,u16 ,u32 ,u64 ,u128 ,usize , +i8 ,i16 ,i32 ,i64 ,i128 ,isize , +f32 ,f64 , + +// SAFETY: These are ZSTs, there is nothing to zero. + {<T : ?Sized >}PhantomData <T >, core::marker::PhantomPinned ,Infallible , (), + +// SAFETY: Type is allowed to take any value, including all zeros. + {<T >}MaybeUninit <T >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +Option <NonZeroU8 >,Option <NonZeroU16 >,Option <NonZeroU32 >,Option <NonZeroU64 >, +Option <NonZeroU128 >,Option <NonZeroUsize >, +Option <NonZeroI8 >,Option <NonZeroI16 >,Option <NonZeroI32 >,Option <NonZeroI64 >, +Option <NonZeroI128 >,Option <NonZeroIsize >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +// +// In this case we are allowed to use `T: ?Sized`, since all zeros is the `None` variant. + {<T : ?Sized >}Option <NonNull <T >>, + {<T : ?Sized >}Option <Box <T >>, + +// SAFETY: `null` pointer is valid. +// +// We cannot use `T: ?Sized`, since the VTABLE pointer part of fat pointers is not allowed to be +// null. + {<T >} *mut T , {<T >} *const T , + +// SAFETY: `null` pointer is valid and the metadata part of these fat pointers is allowed to be +// zero. + {<T >} *mut [T ], {<T >} *const [T ], *mut str , *const str ,
Quoted 8 lines
rust/kernel/init.rs pub unsafe trait PinnedDrop: __internal::HasPinData { · line 1410
Quoted 4 lines
rust/kernel/init.rs +4
-0+ +// SAFETY: `T` is `Zeroable`. + {<const N: usize, T: Zeroable>} [T; N], {<T: Zeroable>} Wrapping<T>, +}Arguably, it would make sense to just expand this macro. The code doesn't become that much longer, and it removes the need to understand the macro.
I think it makes sense to use macro for non-generic types (primitives and NonZeros. It'll be quite verbose if these are just expanded.
For the generic ones, I have no preference.
Re: [PATCH v5 11/15] rust: init: add `Zeroable` trait and `init::zeroed` function
In reply to Benno LossinQuoted 9 lines · On Mon, 03 Apr 2023 16:05:40 +0000 Benno Lossin <[email protected]> wrote:
Add the
Zeroabletrait which marks types that can be initialized by writing0x00to every byte of the type. Also add theinit::zeroedfunction that creates an initializer for aZeroabletype that writes0x00to every byte.Signed-off-by Benno Lossin <[email protected]>Cc Gary Guo <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>
Quoted 88 lines
--- rust/kernel/init.rs | 94 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 92 insertions(+), 2 deletions(-)rust/kernel/init.rs +67
-2@@ -195,8 +195,14 @@ use crate::{ };use alloc::boxed::Box ;use core::{ - alloc::AllocError , cell::Cell , convert::Infallible , marker::PhantomData , mem::MaybeUninit , - pin::Pin , ptr, + alloc::AllocError , + cell::Cell , + convert::Infallible , + marker::PhantomData , + mem::MaybeUninit , + num::*, + pin::Pin , + ptr::{self,NonNull }, };#[doc(hidden)] @@ -1329,3 +1335,87 @@ pub unsafe trait PinnedDrop: __internal::HasPinData {/// automatically. fn drop (self:Pin <&mut Self >, only_call_from_drop: __internal::OnlyCallFromDrop ); } + +/// Marker trait for types that can be initialized by writing just zeroes. +/// +/// # Safety +/// +/// The bit pattern consisting of only zeroes is a valid bit pattern for this type. In other words, +/// this is not UB: +/// +/// ```rust,ignore +/// let val: Self = unsafe { core::mem::zeroed() }; +/// ``` +pub unsafe trait Zeroable {} + +/// Create a new zeroed T. +/// +/// The returned initializer will write `0x00` to every byte of the given `slot`. +#[inline] +pub fn zeroed <T :Zeroable +Unpin >() ->impl Init <T > { +// SAFETY: Because `T: Zeroable`, all bytes zero is a valid bit pattern for `T` +// and because we write all zeroes, the memory is initialized. +unsafe { +init_from_closure (|slot: *mut T | { + slot.write_bytes (0 ,1 ); +Ok (()) + }) + } +} + +macro_rules! impl_zeroable { + ($($({$($generics:tt)*})? $t:ty, )*) => { + $(unsafe impl $($($generics)*)?Zeroable for $t {})* + }; +} + +impl_zeroable! { +// SAFETY: All primitives that are allowed to be zero. +bool , +char , +u8 ,u16 ,u32 ,u64 ,u128 ,usize , +i8 ,i16 ,i32 ,i64 ,i128 ,isize , +f32 ,f64 , + +// SAFETY: These are ZSTs, there is nothing to zero. + {<T : ?Sized >}PhantomData <T >, core::marker::PhantomPinned ,Infallible , (), + +// SAFETY: Type is allowed to take any value, including all zeros. + {<T >}MaybeUninit <T >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +Option <NonZeroU8 >,Option <NonZeroU16 >,Option <NonZeroU32 >,Option <NonZeroU64 >, +Option <NonZeroU128 >,Option <NonZeroUsize >, +Option <NonZeroI8 >,Option <NonZeroI16 >,Option <NonZeroI32 >,Option <NonZeroI64 >, +Option <NonZeroI128 >,Option <NonZeroIsize >, + +// SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). +// +// In this case we are allowed to use `T: ?Sized`, since all zeros is the `None` variant. + {<T : ?Sized >}Option <NonNull <T >>, + {<T : ?Sized >}Option <Box <T >>,
rust/kernel/init.rs pub unsafe trait PinnedDrop: __internal::HasPinData { · line 1406
Quoted 10 lines
rust/kernel/init.rs +10
-0+ +// SAFETY: `null` pointer is valid. +// +// We cannot use `T: ?Sized`, since the VTABLE pointer part of fat pointers is not allowed to be +// null. + {<T>} *mut T, {<T>} *const T, + +// SAFETY: `null` pointer is valid and the metadata part of these fat pointers is allowed to be +// zero. + {<T>} *mut [T], {<T>} *const [T], *mut str, *const str,
Just a note: if Pointee trait is stabilised, this could be changed to
impl<T: ?Sized> Zeroable for *const T where <T as Pointee>::Metadata: Zeroable {}
Quoted 19 lines
rust/kernel/init.rs +15
-1+ +// SAFETY: `T` is `Zeroable`. + {<const N: usize, T: Zeroable>} [T; N], {<T: Zeroable>} Wrapping<T>, +} + +macro_rules! impl_tuple_zeroable { + ($(,)?) => {}; + ($first:ident, $($t:ident),* $(,)?) => { +// SAFETY: All elements are zeroable and padding can be zero. +unsafe impl <$first:Zeroable , $($t:Zeroable ),*>Zeroable for ($first, $($t),*) {} +impl_tuple_zeroable! ($($t),* ,); + } +} + +impl_tuple_zeroable! (A ,B ,C ,D ,E ,F ,G ,H ,I ,J ); --2.39.2
PATCH v5 12/15 rust: prelude: add `pin-init` API items to prelude
In reply to Benno LossinAdd pin-init API macros and traits to the prelude.
--- rust/kernel/prelude.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
rust/kernel/prelude.rs +5 -1
@@ -18,7 +18,7 @@ pub use core::pin::Pin;pub use alloc::{boxed::Box , vec::Vec };#[doc(no_inline)] -pub use macros::{module, vtable}; +pub use macros::{module, pin_data, pinned_drop, vtable};pub use super ::build_assert;
@@ -27,8 +27,12 @@ pub use super::build_assert;pub use super ::dbg;pub use super ::{pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn}; +pub use super ::{init, pin_init, try_init, try_pin_init}; +pub use super ::static_assert;pub use super ::error::{code::*,Error ,Result };pub use super ::{str::CStr ,ThisModule }; + +pub use super ::init::{InPlaceInit ,Init ,PinInit };
--
2.39.2
PATCH v5 13/15 rust: types: add common init-helper functions for `Opaque`
In reply to Benno LossinAdd helper functions to more easily initialize Opaque<T> via FFI and rust raw initializer functions.
These functions take a function pointer to the FFI/raw initialization function and take between 0-4 other arguments. It then returns an initializer that uses the FFI/raw initialization function along with the given arguments to initialize an Opaque<T>.
--- rust/kernel/init.rs | 9 +++++++++ rust/kernel/types.rs | 47 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+)
rust/kernel/init.rs +9 -0
@@ -177,6 +177,14 @@//! } //! ``` //! +//! For the special case where initializing a field is a single FFI-function call that cannot fail, +//! there exist helper functions [`Opaque::ffi_init`]. These functions initialize a single +//! [`Opaque`] field by just delegating to the FFI-function. You can use these in combination with +//! [`pin_init!`]. +//! +//! For more information on how to use [`pin_init_from_closure()`], take a look at the uses inside +//! the `kernel` crate. The [`sync`] module is a good starting point. +//! //! [`sync`]: kernel::sync //! [pinning]: https://doc.rust-lang.org/std/pin/index.html //! [structurally pinned fields]:
@@ -187,6 +195,7 @@//! [`impl PinInit<T, E>`]: PinInit //! [`impl Init<T, E>`]: Init //! [`Opaque`]: kernel::types::Opaque +//! [`Opaque::ffi_init`]: kernel::types::Opaque::ffi_init //! [`pin_data`]: ::macros::pin_data use crate ::{
rust/kernel/types.rs +47 -0
59 lines not on this page · raw message
--
2.39.2
PATCH v5 14/15 rust: sync: reduce stack usage of `UniqueArc::try_new_uninit`
In reply to Benno LossinUniqueArc::try_new_uninit calls Arc::try_new(MaybeUninit::uninit()). This results in the uninitialized memory being placed on the stack, which may be arbitrarily large due to the generic T and thus could cause a stack overflow for large types.
Change the implementation to use the pin-init API which enables in-place initialization. In particular it avoids having to first construct and then move the uninitialized memory from the stack into the final location.
--- rust/kernel/lib.rs | 1 - rust/kernel/sync/arc.rs | 16 +++++++++++++--- 2 files changed, 13 insertions(+), 4 deletions(-)
rust/kernel/lib.rs +0 -1
@@ -28,7 +28,6 @@#[cfg(not( CONFIG_RUST ))] compile_error! ("Missing kernel configuration for conditional compilation" ); -#[allow(unused_extern_crates)] // Allow proc-macros to refer to `::kernel` inside the `kernel` crate (this crate). extern crate selfas kernel;
rust/kernel/sync/arc.rs +13 -3
@@ -18,7 +18,8 @@use crate ::{ bindings, error::{self,Error }, - init::{InPlaceInit ,Init ,PinInit }, + init::{self,InPlaceInit ,Init ,PinInit }, + try_init, types::{ForeignOwnable ,Opaque }, };use alloc::boxed::Box ;
@@ -30,6 +31,7 @@ use core::{ pin::Pin, ptr::NonNull, }; +use macros::pin_data;/// A reference-counted pointer to an instance of `T`. ///
@@ -122,6 +124,7 @@ pub struct Arc<T: ?Sized> { _p: PhantomData<ArcInner<T>>, } +#[pin_data] #[repr( C )] struct ArcInner <T : ?Sized > { refcount:Opaque <bindings::refcount_t >,
@@ -502,9 +505,16 @@ impl<T> UniqueArc<T> {/// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet. pub fn try_new_uninit () ->Result <UniqueArc <MaybeUninit <T >>,AllocError > { -Ok (UniqueArc ::<MaybeUninit <T >> { +// INVARIANT: The refcount is initialised to a non-zero value. +let inner =Box ::try_init ::<AllocError >(try_init! (ArcInner { +// SAFETY: There are no safety requirements for this FFI call. + refcount:Opaque ::new (unsafe { bindings::REFCOUNT_INIT (1 ) }), + data <- init::uninit ::<T ,AllocError >(), + }?AllocError ))?; +Ok (UniqueArc {// INVARIANT: The newly-created object has a ref-count of 1. - inner:Arc ::try_new (MaybeUninit ::uninit ())?, +// SAFETY: The pointer from the `Box` is valid. + inner:unsafe {Arc ::from_inner (Box ::leak (inner).into ()) }, }) } }
--
2.39.2
Re: [PATCH v5 14/15] rust: sync: reduce stack usage of `UniqueArc::try_new_uninit`
Quoted 5 lines · Benno Lossin
UniqueArc::try_new_uninitcallsArc::try_new(MaybeUninit::uninit()). This results in the uninitialized memory being placed on the stack, which may be arbitrarily large due to the genericTand thus could cause a stack overflow for large types.
Quoted 8 lines
Change the implementation to use the pin-init API which enables in-place initialization. In particular it avoids having to first construct and then move the uninitialized memory from the stack into the final location.
Signed-off-by Benno Lossin <[email protected]>Cc Gary Guo <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>
Quoted 8 lines
/// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet. pub fn try_new_uninit() -> Result<UniqueArc<MaybeUninit<T>>, AllocError> {rust/kernel/sync/arc.rs +4
-1-Ok (UniqueArc ::<MaybeUninit <T >> { +// INVARIANT: The refcount is initialised to a non-zero value. + let inner = Box::try_init::<AllocError>(try_init!(ArcInner { + // SAFETY: There are no safety requirements for this FFI call. + refcount: Opaque::new(unsafe { bindings::REFCOUNT_INIT(1) }),
rust/kernel/sync/arc.rs impl<T> UniqueArc<T> { · line 520
Quoted 10 lines
rust/kernel/sync/arc.rs +5
-1+ data <- init::uninit::<T, AllocError>(), + }? AllocError))?; +Ok (UniqueArc {// INVARIANT: The newly-created object has a ref-count of 1. - inner: Arc::try_new(MaybeUninit::uninit())?, +// SAFETY: The pointer from the `Box` is valid. + inner:unsafe {Arc ::from_inner (Box ::leak (inner).into ()) }, }) } }
I'm curious - do you know whether this compiles to the same machine code as this?
pub fn try_new_uninit() -> Result<UniqueArc<MaybeUninit<T>>, AllocError> {
let inner: Box<MaybeUninit<ArcInner<T>>> = Box::try_new_uninit()?;
let ptr = Box::into_raw(inner) as *mut ArcInner<T>;
addr_of_mut!((*ptr).refcount).write(bindings::REFCOUNT_INIT(1));
Ok(UniqueArc {
inner: Arc {
ptr: unsafe { NonNull::new_unchecked(ptr) },
_p: PhantomData,
}
})
}Re: [PATCH v5 14/15] rust: sync: reduce stack usage of `UniqueArc::try_new_uninit`
Quoted 22 lines · Alice Ryhl
Quoted 7 lines · Benno Lossin
/// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet. pub fn try_new_uninit() -> Result<UniqueArc<MaybeUninit<T>>, AllocError> {rust/kernel/sync/arc.rs +4
-1-Ok (UniqueArc ::<MaybeUninit <T >> { +// INVARIANT: The refcount is initialised to a non-zero value. + let inner = Box::try_init::<AllocError>(try_init!(ArcInner { + // SAFETY: There are no safety requirements for this FFI call. + refcount: Opaque::new(unsafe { bindings::REFCOUNT_INIT(1) }),rust/kernel/sync/arc.rs impl<T> UniqueArc<T> { · line 520
Quoted 10 lines
rust/kernel/sync/arc.rs +5
-1+ data <- init::uninit::<T, AllocError>(), + }? AllocError))?; +Ok (UniqueArc {// INVARIANT: The newly-created object has a ref-count of 1. - inner: Arc::try_new(MaybeUninit::uninit())?, +// SAFETY: The pointer from the `Box` is valid. + inner:unsafe {Arc ::from_inner (Box ::leak (inner).into ()) }, }) } }I'm curious - do you know whether this compiles to the same machine code as this?
Quoted 11 lines
pub fn try_new_uninit() -> Result<UniqueArc<MaybeUninit<T>>, AllocError> {
let inner: Box<MaybeUninit<ArcInner<T>>> = Box::try_new_uninit()?;
let ptr = Box::into_raw(inner) as *mut ArcInner<T>;
addr_of_mut!((*ptr).refcount).write(bindings::REFCOUNT_INIT(1));
Ok(UniqueArc {
inner: Arc {
ptr: unsafe { NonNull::new_unchecked(ptr) },
_p: PhantomData,
}
})
}Yes it compiles to exactly the same assembly (byte for byte), because I was not sure if I was compiling the right thing, I compiled this function:
unsafe { core::arch::asm!("ud2") };
let r1 = UniqueArc::try_new_uninit();
unsafe { core::arch::asm!("ud2") };
let r2 = UniqueArc::try_new_uninit2();
unsafe { core::arch::asm!("ud2") };The ud2 instructions are for better visibility, as I have not read a lot of assembly. The above disassembles to this:
ffffffff8143bb80 <_RNvXCsdVu6umiBwhr_12rust_minimalNtB2_11RustMinimalNtCsfATHBUcknU9_6kernel6Module4init>:
ffffffff8143bb80: 41 57 push r15
ffffffff8143bb82: 41 56 push r14
ffffffff8143bb84: 53 push rbx
ffffffff8143bb85: 49 89 ff mov r15,rdi
ffffffff8143bb88: 0f 0b ud2
ffffffff8143bb8a: bf 04 00 10 00 mov edi,0x100004
ffffffff8143bb8f: be 04 00 00 00 mov esi,0x4
ffffffff8143bb94: e8 a7 23 f5 ff call ffffffff8138df40 <__rust_alloc>
ffffffff8143bb99: 48 85 c0 test rax,rax
ffffffff8143bb9c: 74 12 je ffffffff8143bbb0 <_RNvXCsdVu6umiBwhr_12rust_minimalNtB2_11RustMinimalNtCsfATHBUcknU9_6kernel6Module4init+0x30>
ffffffff8143bb9e: 49 89 c6 mov r14,rax
ffffffff8143bba1: bf 01 00 00 00 mov edi,0x1
ffffffff8143bba6: e8 e5 fc f4 ff call ffffffff8138b890 <rust_helper_REFCOUNT_INIT>
ffffffff8143bbab: 41 89 06 mov DWORD PTR [r14],eax
ffffffff8143bbae: eb 03 jmp ffffffff8143bbb3 <_RNvXCsdVu6umiBwhr_12rust_minimalNtB2_11RustMinimalNtCsfATHBUcknU9_6kernel6Module4init+0x33>
ffffffff8143bbb0: 45 31 f6 xor r14d,r14d
ffffffff8143bbb3: 0f 0b ud2
ffffffff8143bbb5: bf 04 00 10 00 mov edi,0x100004
ffffffff8143bbba: be 04 00 00 00 mov esi,0x4
ffffffff8143bbbf: e8 7c 23 f5 ff call ffffffff8138df40 <__rust_alloc>
ffffffff8143bbc4: 48 85 c0 test rax,rax
ffffffff8143bbc7: 74 11 je ffffffff8143bbda <_RNvXCsdVu6umiBwhr_12rust_minimalNtB2_11RustMinimalNtCsfATHBUcknU9_6kernel6Module4init+0x5a>
ffffffff8143bbc9: 48 89 c3 mov rbx,rax
ffffffff8143bbcc: bf 01 00 00 00 mov edi,0x1
ffffffff8143bbd1: e8 ba fc f4 ff call ffffffff8138b890 <rust_helper_REFCOUNT_INIT>
ffffffff8143bbd6: 89 03 mov DWORD PTR [rbx],eax
ffffffff8143bbd8: eb 02 jmp ffffffff8143bbdc <_RNvXCsdVu6umiBwhr_12rust_minimalNtB2_11RustMinimalNtCsfATHBUcknU9_6kernel6Module4init+0x5c>
ffffffff8143bbda: 31 db xor ebx,ebx
ffffffff8143bbdc: 0f 0b ud2
ffffffff8143bbde: 4d 89 77 08 mov QWORD PTR [r15+0x8],r14
ffffffff8143bbe2: 49 89 5f 10 mov QWORD PTR [r15+0x10],rbx
ffffffff8143bbe6: 41 c7 07 00 00 00 00 mov DWORD PTR [r15],0x0
ffffffff8143bbed: 4c 89 f8 mov rax,r15
ffffffff8143bbf0: 5b pop rbx
ffffffff8143bbf1: 41 5e pop r14
ffffffff8143bbf3: 41 5f pop r15
ffffffff8143bbf5: c3 retI have not done extensive enough tests to be sure about this in general, but most of the examples of the pin-init API that I looked at were optimized to the same assembly as manual initialization.
The only examples were this was not the case was when I had triply nested structs with Boxes that all were initialized via PinInit. That was the point were the initialization closure was not inlined any more. I also verified that in this particular case the closure was again inlined after adding #[inline] to it (which requires stmt_expr_attributes).
At some point I might do a more thorough analysis.
Signature · 2 lines
Cheers, Benno
Re: [PATCH v5 14/15] rust: sync: reduce stack usage of `UniqueArc::try_new_uninit`
In reply to Benno LossinQuoted 5 lines · On Mon, 03 Apr 2023 16:05:56 +0000 Benno Lossin <[email protected]> wrote:
UniqueArc::try_new_uninitcallsArc::try_new(MaybeUninit::uninit()). This results in the uninitialized memory being placed on the stack, which may be arbitrarily large due to the genericTand thus could cause a stack overflow for large types.
Quoted 8 lines
Change the implementation to use the pin-init API which enables in-place initialization. In particular it avoids having to first construct and then move the uninitialized memory from the stack into the final location.
Signed-off-by Benno Lossin <[email protected]>Cc Gary Guo <[email protected]>Cc Alice Ryhl <[email protected]>Cc Andreas Hindborg <[email protected]>
Quoted 70 lines
--- rust/kernel/lib.rs | 1 - rust/kernel/sync/arc.rs | 16 +++++++++++++--- 2 files changed, 13 insertions(+), 4 deletions(-)rust/kernel/lib.rs +0
-1@@ -28,7 +28,6 @@#[cfg(not( CONFIG_RUST ))] compile_error! ("Missing kernel configuration for conditional compilation" ); -#[allow(unused_extern_crates)] // Allow proc-macros to refer to `::kernel` inside the `kernel` crate (this crate). extern crate selfas kernel;rust/kernel/sync/arc.rs +13
-4@@ -18,7 +18,8 @@use crate ::{ bindings, error::{self,Error }, - init::{InPlaceInit ,Init ,PinInit }, + init::{self,InPlaceInit ,Init ,PinInit }, + try_init, types::{ForeignOwnable ,Opaque }, };use alloc::boxed::Box ;@@ -30,6 +31,7 @@ use core::{ pin::Pin, ptr::NonNull, }; +use macros::pin_data;/// A reference-counted pointer to an instance of `T`. /// @@ -122,6 +124,7 @@ pub struct Arc<T: ?Sized> { _p: PhantomData<ArcInner<T>>, } +#[pin_data] #[repr( C )] struct ArcInner <T : ?Sized > { refcount:Opaque <bindings::refcount_t >,@@ -502,9 +505,16 @@ impl<T> UniqueArc<T> {/// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet. pub fn try_new_uninit () ->Result <UniqueArc <MaybeUninit <T >>,AllocError > { -Ok (UniqueArc ::<MaybeUninit <T >> { +// INVARIANT: The refcount is initialised to a non-zero value. +let inner =Box ::try_init ::<AllocError >(try_init! (ArcInner { +// SAFETY: There are no safety requirements for this FFI call. + refcount:Opaque ::new (unsafe { bindings::REFCOUNT_INIT (1 ) }), + data <- init::uninit ::<T ,AllocError >(), + }?AllocError ))?; +Ok (UniqueArc {// INVARIANT: The newly-created object has a ref-count of 1. - inner:Arc ::try_new (MaybeUninit ::uninit ())?, +// SAFETY: The pointer from the `Box` is valid. + inner:unsafe {Arc ::from_inner (Box ::leak (inner).into ()) }, }) } } --2.39.2
PATCH v5 15/15 rust: sync: add functions for initializing `UniqueArc<MaybeUninit<T>>`
In reply to Benno LossinAdd two functions init_with and pin_init_with to UniqueArc<MaybeUninit<T>> to initialize the memory of already allocated UniqueArcs. This is useful when you want to allocate memory check some condition inside of a context where allocation is forbidden and then conditionally initialize an object.
--- rust/kernel/sync/arc.rs | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)
rust/kernel/sync/arc.rs +24 -0
@@ -541,6 +541,30 @@ impl<T> UniqueArc<MaybeUninit<T>> { inner: unsafe { Arc::from_inner(inner.cast()) }, } } + +/// Initialize `self` using the given initializer. +pub fn init_with <E >(mut self, init:impl Init <T ,E >) -> core::result::Result <UniqueArc <T >,E > { +// SAFETY: The supplied pointer is valid for initialization. +match unsafe { init.__init (self.as_mut_ptr ()) } { +// SAFETY: Initialization completed successfully. +Ok (()) =>Ok (unsafe { self.assume_init () }), +Err (err) =>Err (err), + } + } + +/// Pin-initialize `self` using the given pin-initializer. +pub fn pin_init_with <E >( +mut self, + init:impl PinInit <T ,E >, + ) -> core::result::Result <Pin <UniqueArc <T >>,E > { +// SAFETY: The supplied pointer is valid for initialization and we will later pin the value +// to ensure it does not move. +match unsafe { init.__pinned_init (self.as_mut_ptr ()) } { +// SAFETY: Initialization completed successfully. +Ok (()) =>Ok (unsafe { self.assume_init () }.into ()), +Err (err) =>Err (err), + } + } }impl <T : ?Sized >From <UniqueArc <T >>for Pin <UniqueArc <T >> {
--
2.39.2