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:   Mon, 3 Apr 2023 16:26:09 +0100
From:   Gary Guo <gary@garyguo.net>
To:     Asahi Lina <lina@asahilina.net>
Cc:     Miguel Ojeda <ojeda@kernel.org>,
        Alex Gaynor <alex.gaynor@gmail.com>,
        Wedson Almeida Filho <wedsonaf@gmail.com>,
        Boqun Feng <boqun.feng@gmail.com>,
        =?UTF-8?B?QmrDtnJu?= Roy Baron <bjorn3_gh@protonmail.com>,
        Andreas Hindborg <a.hindborg@samsung.com>,
        Vincenzo Palazzo <vincenzopalazzodev@gmail.com>,
        Martin Rodriguez Reboredo <yakoyoku@gmail.com>,
        Benno Lossin <y86-dev@protonmail.com>,
        rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
        asahi@lists.linux.dev
Subject: Re: [PATCH v2 2/2] rust: sync: arc: Add
 UniqueArc<MaybeUninit<T>::assume_init()
Message-ID: <20230403162609.286db824.gary@garyguo.net>
In-Reply-To: <20230224-rust-arc-v2-2-5c97a865b276@asahilina.net>
References: <20230224-rust-arc-v2-0-5c97a865b276@asahilina.net>
        <20230224-rust-arc-v2-2-5c97a865b276@asahilina.net>
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?E0Z2Ct0SYy0N26ADnYhgxUO+Upkva7SgwXcw4RpuwOWfJ3IBeFU4i5ivupZ0?=
 =?us-ascii?Q?pP6L2dViuwC3FVeT+b6A/qJlqsoFXv4jCUNWf6GJDYWF4mdk5z4eb0vrXwRV?=
 =?us-ascii?Q?B6009WeUVN5oXW1vMuFE07d25xQoA0V+5+9A4+ObgPg1jpX/JVIesc6geTyT?=
 =?us-ascii?Q?BJmCdkh/F7k143CUQineqwd+g5wvyCNxFAneCrdiC+SDd/VQ+NyQnUiwuzdg?=
 =?us-ascii?Q?7J+xpZwRrBcrW3lMA/He4FP9iW6EYwgYgLxuu37kPVVQCsQNIvMtjsGZZyQP?=
 =?us-ascii?Q?ASyma6bCmE/pXKN7oPMfNbSRUelcncPscddwCrzo9I6SLIL1jDfTr8Rb3i9l?=
 =?us-ascii?Q?NdUws0w4msOytRQCepmTY4yMZa0mbVNEuIit9hN+XDDdWx+vxd6RzVy1gYY1?=
 =?us-ascii?Q?FZ6JXpwWeB+hhgmsBH3Fu1rXQ+hah0zUk24Rmf0oBhsX/T3cTkglsYW8IzQ6?=
 =?us-ascii?Q?otDx6h3XwJMCJUENl2Eg8QbsG/bN9k1psM8/zzx79CheFuNreZD+HQj/qeXb?=
 =?us-ascii?Q?Farka0ly+2gw9KbKiothfy3+WcyCRswXdn6xMizjEd4H70z8yCSkOkSdKXkq?=
 =?us-ascii?Q?CTv7QWUk4IfGpiwIsmzLqSM4YaZZcZrcgeNLnJqiXJJs/nFw8YjocexpuOXF?=
 =?us-ascii?Q?hUenwYBu+NqdZBLofVjv3IGpQ2IKufwsxZxVW5NM4UxYoVrTIZfLPGVT7WX9?=
 =?us-ascii?Q?OK4ePuv4vT1jIsRlBT6uBwKS0mkKkxDPrfSUqDX8OU0rVpaHnGFL3gghq4j9?=
 =?us-ascii?Q?/K/nDoWgNW6AL9cHICYRI0lI7WPAE+RJ6OriJ+psPfWl1v2WOZNW2AcsAkYC?=
 =?us-ascii?Q?K7lBSlEq2aL357D4wTiNMaBGLtX3OgeRtmWhjdgrBxnyhrVV5ZBV8WUeHXNz?=
 =?us-ascii?Q?EaFyJv7oy/4gWY46TbDX17PlMLBOWIOBJ+58bRa/NMsz0S31AO8KgN9rVzUP?=
 =?us-ascii?Q?eossgZfrNktHX13Bd+aOC0IQ/4rnGAqGAJrUPmiAMs04V74JtnOoJVLOakjl?=
 =?us-ascii?Q?Jpjf3BI3DJE4naVZ4mdsGULVa6hLu8IOVSb2OMIUjcQNAPfsnhn70loclfJQ?=
 =?us-ascii?Q?7QTozTXSb2o/BTJxBwzjqF70kWaZa5Qeb6b1JkqtkA3T4E1M/oqX3vaiKqnz?=
 =?us-ascii?Q?aycGXo4DUQNs3mCFlCgetOz1xRyMKea0jBpQEhd+dFobq9p13xXw1r0IX7XQ?=
 =?us-ascii?Q?Yn5RP9Ms/uojNvsezp3o3U1uJ05x1AiNId0akg2vpV0f6AbWjgpjocwq9h+a?=
 =?us-ascii?Q?lmoG5GzZK33pGN0v+XEQ53F+2HR1Da3d1hKMvN3linHCIjs8mTwZcmM9KFo2?=
 =?us-ascii?Q?cWrWSBp/ArHPVzcNpClm3816SNhpXimH6b+L7vZkwCXCBQXKm7NvE2dFLe8l?=
 =?us-ascii?Q?ihBGhRKQut5tkYw+wjrPKw/MZKc7tBJNkcL1Lhm4lFqr0MIN4mjytHF5NF0s?=
 =?us-ascii?Q?Mfr3OMnC39y0gzT6R+rez6NErfCrtOT49XK8S0HKn6u7NyokP9SAjHGRSj4U?=
 =?us-ascii?Q?5iu9BS2EdGHP1R3BJ7QeRC6Nm3V7RreqcmewtjkcoYLWTWHf979ZE3JmfcCf?=
 =?us-ascii?Q?n0FNTK+3/6xtP6JhmbZm5R+Pd11qNnhB0UaUuYoH?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: bfe8589d-d944-48ed-84b5-08db3457c0dd
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Apr 2023 15:26:10.6755
 (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: On8ziUw1agqY63zr8SjLHaGbRt8cwWcDbESOVSFGS0KegLJy1flOsJ/zQl7fHPGODJYUX2IuthDzX1EeQwzReQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LO0P265MB6327
X-Spam-Status: No, score=-0.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
        DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,
        SPF_HELO_PASS,SPF_PASS autolearn=unavailable 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 Mon, 03 Apr 2023 19:01:12 +0900
Asahi Lina <lina@asahilina.net> wrote:

> We can already create `UniqueArc<MaybeUninit<T>>` instances with
> `UniqueArc::try_new_uninit()` and write to them with `write()`. Add
> the missing unsafe `assume_init()` function to promote it to
> `UniqueArc<T>`, so users can do piece-wise initialization of the
> contents instead of doing it all at once as long as they keep the
> invariants (the same requirements as `MaybeUninit::assume_init()`).
> 
> This mirrors the std `Arc::assume_init()` function. In the kernel,
> since we have `UniqueArc`, arguably this only belongs there since most
> use cases will initialize it immediately after creating it, before
> demoting it to `Arc` to share it.
> 
> Co-authored-by: Benno Lossin <y86-dev@protonmail.com>
> Signed-off-by: Benno Lossin <y86-dev@protonmail.com>
> Signed-off-by: Asahi Lina <lina@asahilina.net>

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

> ---
>  rust/kernel/sync/arc.rs | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/rust/kernel/sync/arc.rs b/rust/kernel/sync/arc.rs
> index b904ed898d3a..b664b41e473d 100644
> --- a/rust/kernel/sync/arc.rs
> +++ b/rust/kernel/sync/arc.rs
> @@ -489,6 +489,17 @@ impl<T> UniqueArc<MaybeUninit<T>> {
>      /// Converts a `UniqueArc<MaybeUninit<T>>` into a `UniqueArc<T>` by writing a value into it.
>      pub fn write(mut self, value: T) -> UniqueArc<T> {
>          self.deref_mut().write(value);
> +        // SAFETY: We have just written the contents fully.
> +        unsafe { self.assume_init() }
> +    }
> +
> +    /// Unsafely assume that `self` is initialized.
> +    ///
> +    /// # Safety
> +    ///
> +    /// The caller guarantees that the value behind this pointer has been initialized. It is
> +    /// *immediate* UB to call this when the value is not initialized.
> +    pub unsafe fn assume_init(self) -> UniqueArc<T> {
>          let inner = ManuallyDrop::new(self).inner.ptr;
>          UniqueArc {
>              // SAFETY: The new `Arc` is taking over `ptr` from `self.inner` (which won't be
>