diff mbox series

[v3,13/13] rust: sync: add functions for initializing `UniqueArc<MaybeUninit<T>>`

Message ID 20230329223239.138757-14-y86-dev@protonmail.com
State New
Headers
Series Rust pin-init API for pinned initialization of structs |

Commit Message

y86-dev March 29, 2023, 10:33 p.m. UTC 
  From: Benno Lossin <y86-dev@protonmail.com>

Add two functions `init_with` and `pin_init_with` to
`UniqueArc<MaybeUninit<T>>` to initialize the memory of already allocated
`UniqueArc`s. 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.

Signed-off-by: Benno Lossin <y86-dev@protonmail.com>
---
 rust/kernel/sync/arc.rs | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

--
2.39.2

Comments

Gary Guo March 30, 2023, 11:09 a.m. UTC | #1 
On Wed, 29 Mar 2023 22:33:53 +0000
y86-dev@protonmail.com wrote:

> From: Benno Lossin <y86-dev@protonmail.com>
> 
> Add two functions `init_with` and `pin_init_with` to
> `UniqueArc<MaybeUninit<T>>` to initialize the memory of already allocated
> `UniqueArc`s. 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.
> 
> Signed-off-by: Benno Lossin <y86-dev@protonmail.com>

Reviewed-by: Gary Guo <gary@garyguo.net>

> ---
>  rust/kernel/sync/arc.rs | 24 ++++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
> 
> diff --git a/rust/kernel/sync/arc.rs b/rust/kernel/sync/arc.rs
> index 4ed6329a5e5f..64b0e9d67025 100644
> --- a/rust/kernel/sync/arc.rs
> +++ b/rust/kernel/sync/arc.rs
> @@ -540,6 +540,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
> 
>
Alice Ryhl March 31, 2023, 7:07 a.m. UTC | #2 
On 3/30/23 00:33, y86-dev@protonmail.com wrote:
> From: Benno Lossin <y86-dev@protonmail.com>
> 
> Add two functions `init_with` and `pin_init_with` to
> `UniqueArc<MaybeUninit<T>>` to initialize the memory of already allocated
> `UniqueArc`s. 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.
> 
> Signed-off-by: Benno Lossin <y86-dev@protonmail.com>

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

I asked for this one because we will need it in the binder driver.
Andreas Hindborg March 31, 2023, 1:07 p.m. UTC | #3 
y86-dev@protonmail.com writes:

> From: Benno Lossin <y86-dev@protonmail.com>
>
> Add two functions `init_with` and `pin_init_with` to
> `UniqueArc<MaybeUninit<T>>` to initialize the memory of already allocated
> `UniqueArc`s. 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.
>
> Signed-off-by: Benno Lossin <y86-dev@protonmail.com>
> ---

Reviewed-by: Andreas Hindborg <a.hindborg@samsung.com>

>  rust/kernel/sync/arc.rs | 24 ++++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>
> diff --git a/rust/kernel/sync/arc.rs b/rust/kernel/sync/arc.rs
> index 4ed6329a5e5f..64b0e9d67025 100644
> --- a/rust/kernel/sync/arc.rs
> +++ b/rust/kernel/sync/arc.rs
> @@ -540,6 +540,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>> {
diff mbox series

Patch

diff --git a/rust/kernel/sync/arc.rs b/rust/kernel/sync/arc.rs
index 4ed6329a5e5f..64b0e9d67025 100644
--- a/rust/kernel/sync/arc.rs
+++ b/rust/kernel/sync/arc.rs
@@ -540,6 +540,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>> {