Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 30 Jun 2023 18:52:22 +0100
From:   Gary Guo <gary@garyguo.net>
To:     Benno Lossin <benno.lossin@proton.me>
Cc:     Miguel Ojeda <ojeda@kernel.org>,
        Wedson Almeida Filho <wedsonaf@gmail.com>,
        Alex Gaynor <alex.gaynor@gmail.com>,
        Boqun Feng <boqun.feng@gmail.com>,
        =?UTF-8?B?QmrDtnJu?= Roy Baron <bjorn3_gh@protonmail.com>,
        Alice Ryhl <aliceryhl@google.com>,
        Andreas Hindborg <nmi@metaspace.dk>,
        rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
        patches@lists.linux.dev
Subject: Re: [PATCH] rust: types: make `Opaque` be `!Unpin`
Message-ID: <20230630185222.6ee044bd.gary@garyguo.net>
In-Reply-To: <20230630150216.109789-1-benno.lossin@proton.me>
References: <20230630150216.109789-1-benno.lossin@proton.me>
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?l5OlcKW+4WK55Az4AuY1/C1pRhjfMBgdi+QZQA2HB+35JnKFwzRthZHgk46k?=
 =?us-ascii?Q?Rbe3svILhBxd4PcNc3shwIJfRXC4+k1hxxnngV6jA3OSOLaTnOEm/2iNiJ4a?=
 =?us-ascii?Q?A9qZfICvwCiC/Q8lmFPyukCyggpKw3tzV938A/4Jbb7ZAKXbiFszTo1jJ9+E?=
 =?us-ascii?Q?w4PYva66l7Rlai7MwNNEzTRVMrMyjdiH5fr2YmE+yjVvo5Z/WRaUjAAiYpeW?=
 =?us-ascii?Q?1FhYIEoiihI4NUVmml3TJtp4SOHBw9uTE44xmZ7ZMhrYvrR+gZSmgjO2ll52?=
 =?us-ascii?Q?A/iAzF7HfUOAVAM4R8e2l9H9x6mkIim8OAiMqrmrUmrsQhnjLMotmIOdaBBt?=
 =?us-ascii?Q?LwJGooxotKVJffVik3v9QPwsDlPBagBlGl3PzcLWDw0Bicme244sibBt98G1?=
 =?us-ascii?Q?1aeMe3pN+8X2FGYFPBb34F/F2Bwcre3vayCc0Ikr/mPbgaIkKFgsupzAA5gM?=
 =?us-ascii?Q?y1BoN7SQ2HiqFY3QcRP0Gdys3QjORpuMYWsspsdBLzMm/pVFGT2FR6XEypO3?=
 =?us-ascii?Q?k3IRZUkBlL1URygO8kaRWROIEN8HHkGEoRp0p32zZ8VDM92lXIgS+Qo7U9+O?=
 =?us-ascii?Q?L5jul4vWT1mKRAfM3MxLkay0t5+TA+dmqscWxBFMVWT6QPaJht/fTyxhbdCp?=
 =?us-ascii?Q?p8+p77bFDgvWxqZXKQL+/wZlKcUEa0Xdffg0wrbthdzQ/mQsKQebGjvBIkZE?=
 =?us-ascii?Q?qDX+E59AxqnRnaTnfJZtjoyPTkDfUwfvcedBOzerZMjb73XrymbxYAnyqmhK?=
 =?us-ascii?Q?K590ihyoJjZSwDSEJhNAvtGxmvhomw7jM4xtzyrQ9sZxOfvT3kLhYPje5bwg?=
 =?us-ascii?Q?7Ow4NqSpWjwsTgCDkqbtzeUBcUqoe96lpWbQozeYsA481BkU/NXCyGtyrp6n?=
 =?us-ascii?Q?WSUBRxYlKgl6LrLTRNJBJIWrkhdkeMQoynyreC1Rn0J7LeYtxsHtGjWr/KdN?=
 =?us-ascii?Q?M951VBnpZsN9WJjdOFRCHyQU4OKmxo4lIfFnbLK8pVLsaxKxKrnH0V1nyqTx?=
 =?us-ascii?Q?LmorVYilFr1IEJX6O8RDNngIadwUDGzNz6yqHS8tva04Uy9RXxmDyI8U6UYZ?=
 =?us-ascii?Q?vwe5qt4IxDKpicZbNHGlWg1c9UZwoheUmmGlTckTT5vkTJDsmppKZb0Iw17h?=
 =?us-ascii?Q?MDJ7hZCWBNPt6WGol/bare66U9VwuSy3mtF6BA/erfgSq6IDX/zRd2I3hCGO?=
 =?us-ascii?Q?liicHAtrIYBKCg/vhNxIHmVVsk/zRkFWcJ1KikDyCrmeKLL+kN21x+BqnRZ6?=
 =?us-ascii?Q?MSpU8q2xJPOoF9PSDiQnHXpu9o09WliXiPc/hxE3PopDUOtgmVdVEAGieG4m?=
 =?us-ascii?Q?XGqCFhV5PcsZqvIaA8OYAFpxLTv6sSetX6oz2ffn2WyLT+LRJWLhqHtcUuvU?=
 =?us-ascii?Q?Os8uhHkALnVV/YMjy/tlbqyqS9x976LreWghYiLVEmIm22bf1U3GI780zda0?=
 =?us-ascii?Q?E4Z8sPDbHU+JD/IK0dHB48eJNyb404xhMZRSI+UDpKYPR8EFkRbRiirWGbZY?=
 =?us-ascii?Q?cL+ar+srKfKVsNJflqCB5H7x8A2FFg82NZHuH0kw/j9wy7A3gu3UKB5omFpb?=
 =?us-ascii?Q?V+NYdY/6TC88+GK1DS4zZK8VlslSVpmv1sNbnnTj?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: d3c12987-6ceb-4afc-07d7-08db7992c347
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Jun 2023 17:52:25.3245
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bbc898ad-b10f-4e10-8552-d9377b823d45
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: u55V6k9QwXyI7tSDFtlg/W+BbKIPkh75RDylglJFQervECpb+Bx47agsWZz5NRelIvD+BDG5Ac6Mum0g4/DQTw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CWLP265MB2035
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE,
        URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Fri, 30 Jun 2023 15:03:23 +0000
Benno Lossin <benno.lossin@proton.me> wrote:

> Adds a `PhantomPinned` field to `Opaque<T>`. This removes the last Rust
> guarantee: the assumption that the type `T` can be freely moved. This is
> not the case for many types from the C side (e.g. if they contain a
> `struct list_head`). This change removes the need to add a
> `PhantomPinned` field manually to Rust structs that contain C structs
> which must not be moved.
> 
> Signed-off-by: Benno Lossin <benno.lossin@proton.me>

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

> ---
> This patch depends on the patch that swaps `UnsafeCell` with
> `MaybeUninit` inside `Opaque` [1].
> 
> [1]: https://lore.kernel.org/rust-for-linux/20230614115328.2825961-1-aliceryhl@google.com/
> ---
>  rust/kernel/types.rs | 19 ++++++++++++++-----
>  1 file changed, 14 insertions(+), 5 deletions(-)
> 
> diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs
> index fb41635f1e1f..e664a2beef30 100644
> --- a/rust/kernel/types.rs
> +++ b/rust/kernel/types.rs
> @@ -6,7 +6,7 @@
>  use alloc::boxed::Box;
>  use core::{
>      cell::UnsafeCell,
> -    marker::PhantomData,
> +    marker::{PhantomData, PhantomPinned},
>      mem::MaybeUninit,
>      ops::{Deref, DerefMut},
>      ptr::NonNull,
> @@ -224,17 +224,26 @@ fn drop(&mut self) {
>  ///
>  /// This is meant to be used with FFI objects that are never interpreted by Rust code.
>  #[repr(transparent)]
> -pub struct Opaque<T>(UnsafeCell<MaybeUninit<T>>);
> +pub struct Opaque<T> {
> +    value: UnsafeCell<MaybeUninit<T>>,
> +    _pin: PhantomPinned,
> +}
>  
>  impl<T> Opaque<T> {
>      /// Creates a new opaque value.
>      pub const fn new(value: T) -> Self {
> -        Self(UnsafeCell::new(MaybeUninit::new(value)))
> +        Self {
> +            value: UnsafeCell::new(MaybeUninit::new(value)),
> +            _pin: PhantomPinned,
> +        }
>      }
>  
>      /// Creates an uninitialised value.
>      pub const fn uninit() -> Self {
> -        Self(UnsafeCell::new(MaybeUninit::uninit()))
> +        Self {
> +            value: UnsafeCell::new(MaybeUninit::uninit()),
> +            _pin: PhantomPinned,
> +        }
>      }
>  
>      /// Creates a pin-initializer from the given initializer closure.
> @@ -258,7 +267,7 @@ pub fn ffi_init(init_func: impl FnOnce(*mut T)) -> impl PinInit<Self> {
>  
>      /// Returns a raw pointer to the opaque data.
>      pub fn get(&self) -> *mut T {
> -        UnsafeCell::get(&self.0).cast::<T>()
> +        UnsafeCell::get(&self.value).cast::<T>()
>      }
>  
>      /// Gets the value behind `this`.