Skip to content

Commit

Permalink
rust: sync: reduce stack usage of UniqueArc::try_new_uninit
Browse files Browse the repository at this point in the history
`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 <[email protected]>
  • Loading branch information
y86-dev committed Mar 28, 2023
1 parent 4cb7225 commit 44ede9b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
1 change: 0 additions & 1 deletion rust/kernel/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,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;

Expand Down
14 changes: 12 additions & 2 deletions rust/kernel/sync/arc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use crate::{
bindings,
error::{Error, Result},
init,
init::{InPlaceInit, Init, PinInit},
types::{ForeignOwnable, Opaque},
};
Expand All @@ -29,6 +30,7 @@ use core::{
pin::Pin,
ptr::NonNull,
};
use macros::pin_data;

/// A reference-counted pointer to an instance of `T`.
///
Expand Down Expand Up @@ -121,6 +123,7 @@ pub struct Arc<T: ?Sized> {
_p: PhantomData<ArcInner<T>>,
}

#[pin_data]
#[repr(C)]
struct ArcInner<T: ?Sized> {
refcount: Opaque<bindings::refcount_t>,
Expand Down Expand Up @@ -501,9 +504,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>>> {
Ok(UniqueArc::<MaybeUninit<T>> {
// INVARIANT: The refcount is initialised to a non-zero value.
let inner = Box::init(init!(ArcInner {
// SAFETY: There are no safety requirements for this FFI call.
refcount: Opaque::new(unsafe { bindings::REFCOUNT_INIT(1) }),
data <- init::uninit(),
}))?;
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()) },
})
}
}
Expand Down

0 comments on commit 44ede9b

Please sign in to comment.