From: Christian Schrefl <chrisi.schrefl@gmail.com>
To: Sky <sky@sky9.dev>, "Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
"Gerald Wisböck" <gerald.wisboeck@feather.ink>
Cc: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org,
Christian Schrefl <chrisi.schrefl@gmail.com>
Subject: [PATCH v2 3/3] rust: use `UnsafePinned` in the implementation of `Opaque`
Date: Wed, 30 Apr 2025 10:36:13 +0200 [thread overview]
Message-ID: <20250430-rust_unsafe_pinned-v2-3-fc8617a74024@gmail.com> (raw)
In-Reply-To: <20250430-rust_unsafe_pinned-v2-0-fc8617a74024@gmail.com>
This change makes the semantics of the `Opaque` implementation
clearer and prepares for the switch to the upstream rust UnsafePinned`
type in the future.
`Opaque` still uses `UnsafeCell` even though the kernel implementation
of `UnsafePinned` already includes it, since the current upstream
version does not.
Reviewed-by: Gerald Wisböck <gerald.wisboeck@feather.ink>
Signed-off-by: Christian Schrefl <chrisi.schrefl@gmail.com>
---
rust/kernel/types.rs | 29 ++++++++++++-----------------
1 file changed, 12 insertions(+), 17 deletions(-)
diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs
index f06e8720e012102e5c41e79fd97b0607e927d71c..44d96423a8a6c358bb7ebf12c24fad98e5c2cb61 100644
--- a/rust/kernel/types.rs
+++ b/rust/kernel/types.rs
@@ -4,12 +4,12 @@
use core::{
cell::UnsafeCell,
- marker::{PhantomData, PhantomPinned},
+ marker::PhantomData,
mem::{ManuallyDrop, MaybeUninit},
ops::{Deref, DerefMut},
ptr::NonNull,
};
-use pin_init::{PinInit, Wrapper, Zeroable};
+use pin_init::{cast_pin_init, PinInit, Wrapper, Zeroable};
/// Used to transfer ownership to and from foreign (non-Rust) languages.
///
@@ -308,8 +308,7 @@ fn drop(&mut self) {
/// ```
#[repr(transparent)]
pub struct Opaque<T> {
- value: UnsafeCell<MaybeUninit<T>>,
- _pin: PhantomPinned,
+ value: UnsafePinned<UnsafeCell<MaybeUninit<T>>>,
}
// SAFETY: `Opaque<T>` allows the inner value to be any bit pattern, including all zeros.
@@ -319,16 +318,14 @@ impl<T> Opaque<T> {
/// Creates a new opaque value.
pub const fn new(value: T) -> Self {
Self {
- value: UnsafeCell::new(MaybeUninit::new(value)),
- _pin: PhantomPinned,
+ value: UnsafePinned::new(UnsafeCell::new(MaybeUninit::new(value))),
}
}
/// Creates an uninitialised value.
pub const fn uninit() -> Self {
Self {
- value: UnsafeCell::new(MaybeUninit::uninit()),
- _pin: PhantomPinned,
+ value: UnsafePinned::new(UnsafeCell::new(MaybeUninit::uninit())),
}
}
@@ -371,7 +368,7 @@ pub fn try_ffi_init<E>(
/// Returns a raw pointer to the opaque data.
pub const fn get(&self) -> *mut T {
- UnsafeCell::get(&self.value).cast::<T>()
+ UnsafeCell::raw_get(self.value.get()).cast::<T>()
}
/// Gets the value behind `this`.
@@ -384,14 +381,12 @@ pub const fn raw_get(this: *const Self) -> *mut T {
}
impl<T> Wrapper<T> for Opaque<T> {
/// Create an opaque pin-initializer from the given pin-initializer.
- fn pin_init<E>(slot: impl PinInit<T, E>) -> impl PinInit<Self, E> {
- Self::try_ffi_init(|ptr: *mut T| {
- // SAFETY:
- // - `ptr` is a valid pointer to uninitialized memory,
- // - `slot` is not accessed on error; the call is infallible,
- // - `slot` is pinned in memory.
- unsafe { PinInit::<T, E>::__pinned_init(slot, ptr) }
- })
+ fn pin_init<E>(value_init: impl PinInit<T, E>) -> impl PinInit<Self, E> {
+ let value_init =
+ UnsafePinned::pin_init(UnsafeCell::pin_init(MaybeUninit::pin_init(value_init)));
+ // SAFETY: `Opaque<T>` is a `repr(transparent)` wrapper around
+ // `UnsafePinned<UnsafeCell<MabeUninit<T>>>` so the memory representation is compatible.
+ unsafe { cast_pin_init(value_init) }
}
}
--
2.49.0
next prev parent reply other threads:[~2025-04-30 8:36 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-30 8:36 [PATCH v2 0/3] rust: add `UnsafePinned` type Christian Schrefl
2025-04-30 8:36 ` [PATCH v2 1/3] rust: add UnsafePinned type Christian Schrefl
2025-04-30 9:16 ` Alice Ryhl
2025-04-30 9:19 ` Alice Ryhl
2025-04-30 16:45 ` Christian Schrefl
2025-04-30 9:45 ` Benno Lossin
2025-04-30 17:30 ` Christian Schrefl
2025-05-01 18:51 ` Benno Lossin
2025-05-01 19:11 ` Christian Schrefl
2025-05-01 22:51 ` Benno Lossin
2025-05-02 0:08 ` Christian Schrefl
2025-05-02 8:35 ` Alice Ryhl
2025-05-02 9:00 ` Ralf Jung
2025-05-01 17:12 ` Christian Schrefl
2025-05-01 18:55 ` Benno Lossin
2025-05-02 8:57 ` Ralf Jung
2025-04-30 8:36 ` [PATCH v2 2/3] rust: implement `Wrapper<T>` for `Opaque<T>` Christian Schrefl
2025-04-30 9:20 ` Alice Ryhl
2025-04-30 9:32 ` Benno Lossin
2025-04-30 8:36 ` Christian Schrefl [this message]
2025-04-30 9:18 ` [PATCH v2 3/3] rust: use `UnsafePinned` in the implementation of `Opaque` Alice Ryhl
2025-04-30 9:35 ` Benno Lossin
2025-04-30 16:44 ` Boqun Feng
2025-04-30 17:07 ` Christian Schrefl
2025-04-30 9:46 ` [PATCH v2 0/3] rust: add `UnsafePinned` type 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=20250430-rust_unsafe_pinned-v2-3-fc8617a74024@gmail.com \
--to=chrisi.schrefl@gmail.com \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=gary@garyguo.net \
--cc=gerald.wisboeck@feather.ink \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=sky@sky9.dev \
--cc=tmgross@umich.edu \
/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).