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 20:20:15 +0100
From:   Gary Guo <gary@garyguo.net>
To:     Alice Ryhl <alice@ryhl.io>
Cc:     Benno Lossin <y86-dev@protonmail.com>,
        rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
        patches@lists.linux.dev, Alice Ryhl <aliceryhl@google.com>,
        Andreas Hindborg <a.hindborg@samsung.com>,
        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>
Subject: Re: [PATCH v5 11/15] rust: init: add `Zeroable` trait and
 `init::zeroed` function
Message-ID: <20230403202015.22e351bb.gary@garyguo.net>
In-Reply-To: <dc983245-2de9-2aa4-16c3-ae11a8c20b6f@ryhl.io>
References: <20230403154422.168633-1-y86-dev@protonmail.com>
        <20230403160511.174894-4-y86-dev@protonmail.com>
        <dc983245-2de9-2aa4-16c3-ae11a8c20b6f@ryhl.io>
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?XolaOQC0GDomt5K8a4cxIK3qYQ/j5osgFcFakHV238gRFdZEnj6xwb9vFgsO?=
 =?us-ascii?Q?fHEhNAmYMy5vE4M001Bdu14886FFWpap44v5MInap8yF1JJ6wiTgpxz/6oFn?=
 =?us-ascii?Q?GeqxEOVj0Xc5qrVTP7k3nHGtrBUg6MWRhNsJDT9l4JVIvOwKYtTQvUhNSBoC?=
 =?us-ascii?Q?8DMlU4ubkLHvOU2hcxFRagZbhEjfLU8h8zEDF4n7bt9MjOONEB651m7RKm3M?=
 =?us-ascii?Q?nIk4ZESBmQygAv/6l2iOOvdzYyILUkJ13PvrSvr1ERH/NOBIWgsNtQwLmDE3?=
 =?us-ascii?Q?Vh+pTcl/OMzNUpErdmRU5saHc9FK3SaagOPVFdrCFPKOuoHb1FbStN+jcdKf?=
 =?us-ascii?Q?zkvAOrHEhdGub3HUZohVZbZr/SgHKr+trknaQysUGaouPZpqs7e0msQNjAlm?=
 =?us-ascii?Q?zDnI7/e/HEJdn8wThmw8WvEZTEbNA4vIzhLRen06usayE5SwtV/TigP99CGX?=
 =?us-ascii?Q?qP4yp46yQ5VRq1eJFTvoti4O73uupNjIK2+c9uA3PbTK3C971Hb8iCr3ViM/?=
 =?us-ascii?Q?FETT9eIHLbpFmmLctNoscVBQ4Yk4Q9nXtLyUUUdXO6IvD5ErrLf9+0xOGX2h?=
 =?us-ascii?Q?1wkOCfnNu2uBjC2fXkEXDDHI8yCoewzvxDnxudXiodrcqGDLurIbSxFfr+mQ?=
 =?us-ascii?Q?P93QGKmrFduDOgLczJn/SacsHNqxSPl+TbpBU9MpXQxfa2IlIEZbfqk3032r?=
 =?us-ascii?Q?OzOgfT0xXowBlS4wqlAmjeeJmUEn2CBwg9GgPnMHAnv2XOKoZxXCgHrJ4l5m?=
 =?us-ascii?Q?fM4OwvPqm5YgNqukd2VI9SP+K/eSQnFLCSCRrGqi7qgYObfcl/kBATaaZpaL?=
 =?us-ascii?Q?AAF9uq3nW3Ib3GOIzrx6+y1Yn9pyA9k0kYzQs8PDXITFubT/do9znqd2Aozs?=
 =?us-ascii?Q?0Z7cWb6J068h5VuEQw8/+MApHtEyf2r87lw5sNwVoOeE+FNXFEVeyXvkK6pR?=
 =?us-ascii?Q?BNKj+XZ8Jf5BunnVVZ1UsfNn3kVazUK68hnEPyXdmKrxcoFRlbtwe/mKRbCp?=
 =?us-ascii?Q?ZDVCjIhRIMkegq1r34tBMIHyHxwIX2aWw9qv6/+ducnFIm2IoMX3GumsmlJI?=
 =?us-ascii?Q?JMkqKtaRjFNEd4IKVglXZ+jR2dr0NRduGYkHPAohnZgi+ExbiIcvZqZIwPcH?=
 =?us-ascii?Q?CF3FjgoDwbk0grSXt+sjiP7qzxPHId6l4x9srjxKTamFAC1iliJWiXRXYKNO?=
 =?us-ascii?Q?u+wKv829ZCs0oeIQhxCXaQPm7AjNaDYl60QEvZAhTK2ZXJ0ZR3Ti1wXl2Ru8?=
 =?us-ascii?Q?mcuQto88JsQ598EqS4iLeITHanKF9HYMLe7upnZ2qlycsNOBa//l3jjDdir7?=
 =?us-ascii?Q?keqoNy0sXcfjaRe7adIVjMVJYc8jsRGccquDXnCx89JK3IKB5WZ36KZLkFpB?=
 =?us-ascii?Q?EpPo87guFt4ZniZsfTZIw9bzQi8MF1wKNeqaMUpJLXZAx3qoXyxTKeaVx2QN?=
 =?us-ascii?Q?K2vj7AIHZTws0WuECVh5LxYa8HoB1aDGVXHIhox7kldeDJpsL1Aer5GZhxAk?=
 =?us-ascii?Q?tEVUTVwosR/cmfdTawZN0feHHzoAVQaMJ4hFF8ZkSjFFBBuEUrykZDUdSFqO?=
 =?us-ascii?Q?JlVNTYIMiTzfCAqaLLIqIeRpTWHKsof2SR1qptPV?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: c2dbe589-1c3b-402d-9a0b-08db347875c2
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Apr 2023 19:20:18.0990
 (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: oXI3ofRVYMs7h3+xHnh1JdBOKKih+tV8FSL34rOG49Fg4C//yLW79l5Qj5Q/PEqiMZha3706/sldmofbAOkADw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CWXP265MB2391
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, 3 Apr 2023 19:56:29 +0200
Alice Ryhl <alice@ryhl.io> wrote:

> On 4/3/23 18:05, Benno Lossin wrote:
> > 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 <y86-dev@protonmail.com>
> > Cc: Gary Guo <gary@garyguo.net>
> > Cc: Alice Ryhl <aliceryhl@google.com>
> > Cc: Andreas Hindborg <a.hindborg@samsung.com>  
> 
> Reviewed-by: Alice Ryhl <aliceryhl@google.com>
> 
> I have two minor suggestions - take them or leave them.
> 
> > +pub fn zeroed<T: Zeroable + Unpin>() -> impl Init<T> {
> > +    // 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(())
> > +        })
> > +    }
> > +}  
> 
> You don't need `T: Unpin` here.
> 
> > +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.
> > +    {<T: ?Sized>} PhantomData<T>, core::marker::PhantomPinned, Infallible, (),
> > +
> > +    // SAFETY: Type is allowed to take any value, including all zeros.
> > +    {<T>} MaybeUninit<T>,
> > +
> > +    // SAFETY: All zeros is equivalent to `None` (option layout optimization guarantee).
> > +    Option<NonZeroU8>, Option<NonZeroU16>, Option<NonZeroU32>, Option<NonZeroU64>,
> > +    Option<NonZeroU128>, Option<NonZeroUsize>,
> > +    Option<NonZeroI8>, Option<NonZeroI16>, Option<NonZeroI32>, Option<NonZeroI64>,
> > +    Option<NonZeroI128>, Option<NonZeroIsize>,
> > +
> > +    // 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.
> > +    {<T: ?Sized>} Option<NonNull<T>>,
> > +    {<T: ?Sized>} Option<Box<T>>,
> > +
> > +    // SAFETY: `null` pointer is valid.
> > +    //
> > +    // We cannot use `T: ?Sized`, since the VTABLE pointer part of fat pointers is not allowed to be
> > +    // null.
> > +    {<T>} *mut T, {<T>} *const T,
> > +
> > +    // SAFETY: `null` pointer is valid and the metadata part of these fat pointers is allowed to be
> > +    // zero.
> > +    {<T>} *mut [T], {<T>} *const [T], *mut str, *const str,
> > +
> > +    // SAFETY: `T` is `Zeroable`.
> > +    {<const N: usize, T: Zeroable>} [T; N], {<T: Zeroable>} Wrapping<T>,
> > +}  
> 
> Arguably, it would make sense to just expand this macro. The code 
> doesn't become that much longer, and it removes the need to understand 
> the macro.

I think it makes sense to use macro for non-generic types (primitives
and `NonZero`s. It'll be quite verbose if these are just expanded.

For the generic ones, I have no preference.