rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Benno Lossin <y86-dev@protonmail.com>
To: "Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Wedson Almeida Filho" <wedsonaf@gmail.com>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Alice Ryhl" <alice@ryhl.io>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
	patches@lists.linux.dev, Benno Lossin <y86-dev@protonmail.com>,
	Alice Ryhl <aliceryhl@google.com>,
	Andreas Hindborg <a.hindborg@samsung.com>
Subject: [PATCH v5 14/15] rust: sync: reduce stack usage of `UniqueArc::try_new_uninit`
Date: Mon, 03 Apr 2023 16:05:56 +0000	[thread overview]
Message-ID: <20230403160511.174894-7-y86-dev@protonmail.com> (raw)
In-Reply-To: <20230403154422.168633-1-y86-dev@protonmail.com>

`UniqueArc::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.

Signed-off-by: Benno Lossin <y86-dev@protonmail.com>
Cc: Gary Guo <gary@garyguo.net>
Cc: Alice Ryhl <aliceryhl@google.com>
Cc: Andreas Hindborg <a.hindborg@samsung.com>
---
 rust/kernel/lib.rs      |  1 -
 rust/kernel/sync/arc.rs | 16 +++++++++++++---
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs
index 821bd067151c..2d7606135ef6 100644
--- a/rust/kernel/lib.rs
+++ b/rust/kernel/lib.rs
@@ -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 self as kernel;

diff --git a/rust/kernel/sync/arc.rs b/rust/kernel/sync/arc.rs
index 43a53fbe175d..d05caa723718 100644
--- a/rust/kernel/sync/arc.rs
+++ b/rust/kernel/sync/arc.rs
@@ -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



  parent reply	other threads:[~2023-04-03 16:06 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-03 15:44 [PATCH v5 00/15] Rust pin-init API for pinned initialization of structs Benno Lossin
2023-04-03 15:44 ` [PATCH v5 01/15] rust: enable the `pin_macro` feature Benno Lossin
2023-04-03 17:55   ` Alice Ryhl
2023-04-04 13:11   ` Gary Guo
2023-04-03 15:44 ` [PATCH v5 02/15] rust: macros: add `quote!` macro Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-03 15:44 ` [PATCH v5 03/15] rust: sync: change error type of constructor functions Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-04 13:11   ` Gary Guo
2023-04-03 15:45 ` [PATCH v5 04/15] rust: sync: add `assume_init` to `UniqueArc` Benno Lossin
2023-04-03 15:45 ` [PATCH v5 05/15] rust: types: add `Opaque::raw_get` Benno Lossin
2023-04-03 15:45 ` [PATCH v5 06/15] rust: add pin-init API core Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-03 15:45 ` [PATCH v5 07/15] rust: init: add initialization macros Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-03 16:05 ` [PATCH v5 08/15] rust: init/sync: add `InPlaceInit` trait to pin-initialize smart pointers Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-04 13:15   ` Gary Guo
2023-04-03 16:05 ` [PATCH v5 09/15] rust: init: add `PinnedDrop` trait and macros Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-03 16:05 ` [PATCH v5 10/15] rust: init: add `stack_pin_init!` macro Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-03 16:05 ` [PATCH v5 11/15] rust: init: add `Zeroable` trait and `init::zeroed` function Benno Lossin
2023-04-03 17:56   ` Alice Ryhl
2023-04-03 19:20     ` Gary Guo
2023-04-04 13:24   ` Gary Guo
2023-04-03 16:05 ` [PATCH v5 12/15] rust: prelude: add `pin-init` API items to prelude Benno Lossin
2023-04-03 16:05 ` [PATCH v5 13/15] rust: types: add common init-helper functions for `Opaque` Benno Lossin
2023-04-03 16:05 ` Benno Lossin [this message]
2023-04-03 17:56   ` [PATCH v5 14/15] rust: sync: reduce stack usage of `UniqueArc::try_new_uninit` Alice Ryhl
2023-04-03 21:06     ` y86-dev
2023-04-04 13:25   ` Gary Guo
2023-04-03 16:06 ` [PATCH v5 15/15] rust: sync: add functions for initializing `UniqueArc<MaybeUninit<T>>` Benno Lossin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230403160511.174894-7-y86-dev@protonmail.com \
    --to=y86-dev@protonmail.com \
    --cc=a.hindborg@samsung.com \
    --cc=alex.gaynor@gmail.com \
    --cc=alice@ryhl.io \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=gary@garyguo.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ojeda@kernel.org \
    --cc=patches@lists.linux.dev \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=wedsonaf@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).