From patchwork Mon Apr 3 16:05:40 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: y86-dev X-Patchwork-Id: 78620 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp2418004vqo; Mon, 3 Apr 2023 09:12:49 -0700 (PDT) X-Google-Smtp-Source: AK7set9MoCQtrHE3rktUeSwMyWjfiyekVQBoZEW1AhX4l5jIPJC9t8gZBNcOcWaa+0BVJek4QrUT X-Received: by 2002:a05:6a20:47e2:b0:da:adbf:7b96 with SMTP id ey34-20020a056a2047e200b000daadbf7b96mr29828845pzb.21.1680538368899; Mon, 03 Apr 2023 09:12:48 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1680538368; cv=none; d=google.com; s=arc-20160816; b=QCexGGLMzRzeWHddkEgn6xVqy/wdMPOwoY/64pJ7ZJHLr9KFsBJU5cNF5TfPIT2MDB 7Mwj36R7H5D9USyMz5Q0u/DPvSlAYhTI44FWH5fyEMP5SaeKtyUVfvmuxaP3Rpoqerxi 7zCVUB9yaWfoyvOhJ7zDm71R2tl2oUQsGkLfkj+eKNPLspeWzEeciZe924BFhydv9K/m FSyYR2gf/2UbWyGvzTvqqkbnA/z8V8ssDcE1uTwxzt28zznaapwTneTi6lK0VFknW/hB T0qYRAXfKN4IcN0E8oOKG29HE4waIUl2ufA8OuhiUbPtYntwjYmBcT33kvf4xy+6AjXN cKXg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :feedback-id:references:in-reply-to:message-id:subject:cc:from:to :dkim-signature:date; bh=0rd5UabrR4S8zBOjGuYiCQNZWnW9f90O2jNqLnbMfWQ=; b=t5czbBYmqT+uBY54LDu0bD0Ra57+XbyKsjhKm/PNDIcLYeWeqlftrVtDCbNjA/vDl3 dy5sq4bRiI3hCv5v3qxdvWZsXvACDS7vPKFM5faWlsdsMyA1PjG6O+9j0o2dyvuGPYUk 5AL9/R6a3O4ORTF4izFKPXbsF+XWqYTE1kKlGXVxWd+s43tf3clvjBCsjdnKSwnuKfzn TXbEJGxHtysspmBQq5PVYT8utlHruK+3CHPrxu4KKEJRhZbUT4ZuTMzQMo0MYKFkyO+x ThUSYueXb1wTrQ3EukGAapAg3iffHx/4hiMLH8VTNZwaPRTq8DAOkHyIZB5giShr3KmG p8pA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@protonmail.com header.s=protonmail3 header.b=UGpvUuXy; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=protonmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id b2-20020aa79502000000b0062b90348402si8540627pfp.106.2023.04.03.09.12.35; Mon, 03 Apr 2023 09:12:48 -0700 (PDT) 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; Authentication-Results: mx.google.com; dkim=pass header.i=@protonmail.com header.s=protonmail3 header.b=UGpvUuXy; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=protonmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232656AbjDCQF4 (ORCPT + 99 others); Mon, 3 Apr 2023 12:05:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33300 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229446AbjDCQFv (ORCPT ); Mon, 3 Apr 2023 12:05:51 -0400 Received: from mail-40134.protonmail.ch (mail-40134.protonmail.ch [185.70.40.134]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CB24D2D6A; Mon, 3 Apr 2023 09:05:47 -0700 (PDT) Date: Mon, 03 Apr 2023 16:05:40 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail3; t=1680537945; x=1680797145; bh=0rd5UabrR4S8zBOjGuYiCQNZWnW9f90O2jNqLnbMfWQ=; h=Date:To:From:Cc:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector; b=UGpvUuXySKIQEtOuB55zxqpC1PpiMhJ8FMYSS/tv8ESgwa9km4t/qF4VfPGnPls4I jOjFfIg44ykT/vg12YzynQGnKM0+sShxvsDO4YECHqFN9Ylg6px5qy59mv4XNvPldn 7imdbUjIDJV1uanzAoTaVXQkGGLG7PefENu5WNJg9nJ4lmdPxZj+aIfJaJMfR3Y4sq KXtvzOnkl4wb4XUinkV8ia3E1ARknKv5+Vb5pHelVrzRamR4nQaFqPScb2N+eZWfGZ AZe7NsLxr9FzXripc7x7hNjktRXeI+fNDn80ZxR8fu6DzfVLXJEGxcQKMzpqHoPbun Hrj3ZjOiyT7XA== To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Alice Ryhl From: Benno Lossin Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Benno Lossin , Alice Ryhl , Andreas Hindborg Subject: [PATCH v5 11/15] rust: init: add `Zeroable` trait and `init::zeroed` function Message-ID: <20230403160511.174894-4-y86-dev@protonmail.com> In-Reply-To: <20230403154422.168633-1-y86-dev@protonmail.com> References: <20230403154422.168633-1-y86-dev@protonmail.com> Feedback-ID: 40624463:user:proton MIME-Version: 1.0 X-Spam-Status: No, score=-0.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,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: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1762172200469776965?= X-GMAIL-MSGID: =?utf-8?q?1762172200469776965?= Add the `Zeroable` trait which marks types that can be initialized by writing `0x00` to every byte of the type. Also add the `init::zeroed` function that creates an initializer for a `Zeroable` type that writes `0x00` to every byte. Signed-off-by: Benno Lossin Cc: Gary Guo Cc: Alice Ryhl Cc: Andreas Hindborg Reviewed-by: Alice Ryhl Reviewed-by: Gary Guo --- rust/kernel/init.rs | 94 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 92 insertions(+), 2 deletions(-) -- 2.39.2 diff --git a/rust/kernel/init.rs b/rust/kernel/init.rs index 1343cafdd760..09bba4e86ace 100644 --- a/rust/kernel/init.rs +++ b/rust/kernel/init.rs @@ -195,8 +195,14 @@ use crate::{ }; use alloc::boxed::Box; use core::{ - alloc::AllocError, cell::Cell, convert::Infallible, marker::PhantomData, mem::MaybeUninit, - pin::Pin, ptr, + alloc::AllocError, + cell::Cell, + convert::Infallible, + marker::PhantomData, + mem::MaybeUninit, + num::*, + pin::Pin, + ptr::{self, NonNull}, }; #[doc(hidden)] @@ -1329,3 +1335,87 @@ pub unsafe trait PinnedDrop: __internal::HasPinData { /// automatically. fn drop(self: Pin<&mut Self>, only_call_from_drop: __internal::OnlyCallFromDrop); } + +/// Marker trait for types that can be initialized by writing just zeroes. +/// +/// # Safety +/// +/// The bit pattern consisting of only zeroes is a valid bit pattern for this type. In other words, +/// this is not UB: +/// +/// ```rust,ignore +/// let val: Self = unsafe { core::mem::zeroed() }; +/// ``` +pub unsafe trait Zeroable {} + +/// Create a new zeroed T. +/// +/// The returned initializer will write `0x00` to every byte of the given `slot`. +#[inline] +pub fn zeroed() -> impl Init { + // SAFETY: Because `T: Zeroable`, all bytes zero is a valid bit pattern for `T` + // and because we write all zeroes, the memory is initialized. + unsafe { + init_from_closure(|slot: *mut T| { + slot.write_bytes(0, 1); + Ok(()) + }) + } +} + +macro_rules! impl_zeroable { + ($($({$($generics:tt)*})? $t:ty, )*) => { + $(unsafe impl$($($generics)*)? Zeroable for $t {})* + }; +} + +impl_zeroable! { + // SAFETY: All primitives that are allowed to be zero. + bool, + char, + u8, u16, u32, u64, u128, usize, + i8, i16, i32, i64, i128, isize, + f32, f64, + + // SAFETY: These are ZSTs, there is nothing to zero. + {} PhantomData, core::marker::PhantomPinned, Infallible, (), + + // SAFETY: Type is allowed to take any value, including all zeros. + {} MaybeUninit, + + // SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). + Option, Option, Option, Option, + Option, Option, + Option, Option, Option, Option, + Option, Option, + + // SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee). + // + // In this case we are allowed to use `T: ?Sized`, since all zeros is the `None` variant. + {} Option>, + {} Option>, + + // SAFETY: `null` pointer is valid. + // + // We cannot use `T: ?Sized`, since the VTABLE pointer part of fat pointers is not allowed to be + // null. + {} *mut T, {} *const T, + + // SAFETY: `null` pointer is valid and the metadata part of these fat pointers is allowed to be + // zero. + {} *mut [T], {} *const [T], *mut str, *const str, + + // SAFETY: `T` is `Zeroable`. + {} [T; N], {} Wrapping, +} + +macro_rules! impl_tuple_zeroable { + ($(,)?) => {}; + ($first:ident, $($t:ident),* $(,)?) => { + // SAFETY: All elements are zeroable and padding can be zero. + unsafe impl<$first: Zeroable, $($t: Zeroable),*> Zeroable for ($first, $($t),*) {} + impl_tuple_zeroable!($($t),* ,); + } +} + +impl_tuple_zeroable!(A, B, C, D, E, F, G, H, I, J);