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, 14 Nov 2022 14:39:28 +0000
From:   Gary Guo <gary@garyguo.net>
To:     Miguel Ojeda <ojeda@kernel.org>
Cc:     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>,
        rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
        patches@lists.linux.dev
Subject: Re: [PATCH v1 19/28] rust: str: add `c_str!` macro
Message-ID: <20221114143928.4dde6589@GaryWorkstation>
In-Reply-To: <20221110164152.26136-20-ojeda@kernel.org>
References: <20221110164152.26136-1-ojeda@kernel.org>
        <20221110164152.26136-20-ojeda@kernel.org>
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?xXbtYbgcH1VgPQ9Run0eIPoNiiDIMrHMsVdNR/RqHenIH3cEML8QW4zm3Ab7?=
 =?us-ascii?Q?JveX8Z0RC2xQktTS9P/QjbpcGjClVLDi1JHZ9UuLQ0y9gdPASfmQq379wTL3?=
 =?us-ascii?Q?/7s5Iwwc2OGr+OAdS5rhsDXEUu3BZDI+Az67VktLDKoWPQZsgNfxsJ523u8C?=
 =?us-ascii?Q?tJ16YrgdocRX1v+0wIfTwCEiC8CE4jyMW0ZPPIXayhVocTAn7R01TVamNQB3?=
 =?us-ascii?Q?sKx2IVgOSBKsA6PV8lyoTjDQHiYmB+PYDFntPZ7O03sbByQO7cKMMoZZxI2Q?=
 =?us-ascii?Q?lVoehFc++ft+NkhB+e3WgMu0pvKEPFC7NcNYHqsX+zOGyoEfedN6Zj2whxT4?=
 =?us-ascii?Q?LyMevq6pPKHO/A268hHy1hSxsnTZ85CWB0yeVM1gWa3NNqjUCMUnfv3sP412?=
 =?us-ascii?Q?HsIXu/K42Ngqf9p9VxH4oYPfF1zYl2ZDn8mR5UX2OIx9rW5CgIyXyW13Yhsj?=
 =?us-ascii?Q?/3P8R/Ev+nGEBQ60jYNe2zyp09tH4y0OdaBxuJ7TnT9wQ4RyADUYsSovH5Qp?=
 =?us-ascii?Q?QQ3AbSybEXL6BKpZyZ+UPOUqHqXDs5U5SUfxbln/0lb/+AsIMI9qbiX7F/Lz?=
 =?us-ascii?Q?6RJy11bQE48gjZQYS3Otl3rRukx8Npf8zeeLIGPUdC9GKO2S34zHWktVrtVX?=
 =?us-ascii?Q?UGVDYxOS+LVoGOklCYXi/SfaBMfd04k6LFg5IlgoZ9dr9yGfZSF0O8vgOnon?=
 =?us-ascii?Q?O4q29DQk87WbZKqbBJN3RzN0QG7yJmOAUK4Ba3HFrp5ZiNv5eGnNdORcBWZc?=
 =?us-ascii?Q?13dvmWMvSEnroATL7Kf4QQqDJBm2gq7jT4kMRqVu2ib6V7R++isU1aClF7iJ?=
 =?us-ascii?Q?Mpf3DOENiWXmkQWbtu6ejUGJYB3WMX+hem4oPeQljSrB+hgAc5r6JdDvChL4?=
 =?us-ascii?Q?TbX1lpRvFKQiQYeNPAL6a2yw3kVZORTsNJYL/xo5dmtYjJcLqm9aIu+4rd9r?=
 =?us-ascii?Q?YDUdwZ/qdGMkGGsDKwR50eeb+mPz5F22ou3y4F8GH9ZIJMdYKavX+cX2fTfl?=
 =?us-ascii?Q?LCgp+EHxHVBJY7kIeC3kdwQgnISPPRX0lcwValrzDRGAiOy/W4S/D2c8AEOC?=
 =?us-ascii?Q?MKP9xP0XKtSZLUv5eW5U9bfO032lTQnlWT/m57VbeZLC/MenzjFklWJSp3LG?=
 =?us-ascii?Q?yEF129Kc0mUECx7xygAN4P9Wz4hPxj5qEJKUu86vVyx2/ooWPKx4Pq1iYq8z?=
 =?us-ascii?Q?ppR799MzrP4jT3K+DSf+A+soXVthiy8GDrfCWyjVAXXPNW4BdxFHyT1IFHPy?=
 =?us-ascii?Q?0feX07wT7TfQvbRjfiKh1E2dlHAXD218Rqlg+7mUxtjR+zTmj0UbpvLjYUqt?=
 =?us-ascii?Q?LNin+Aps1B/5bt7CK/89CIwgH1pz7J9nyvz3g2sZWoRfXu0PoZZj32EuGLZq?=
 =?us-ascii?Q?TZbl3K697ztWpu084yurGNaZ/DfMV8tpS4ZPLghq/ZtAER+M0S9llg1LggCl?=
 =?us-ascii?Q?3ZkD5JfMcmoZ2IFHzSN6MS0AW3oqVB65f85ZHSvGm/7yTAHqwx+X/Txc4OGn?=
 =?us-ascii?Q?TUI79+SdSD3ZdTXr8H1grFyuWQGL+w2pueCHwo3F2KxfvGLt2nIz6b7Fsag4?=
 =?us-ascii?Q?pxd+Pu1Tr8wo7jHTORT1+UWmseZ+zMSqjW+xsB+DD6RAIR69crE1E6oNLrdR?=
 =?us-ascii?Q?3UyK2RzKyj464OWGKlSHxHRze/52YdRwC438RxfrGio+?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 1d322a5e-1bc8-489c-c1d3-08dac64e09e8
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Nov 2022 14:39:32.1248
 (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: yLG8RtSY4d8eMlO/xyf0zBQA1KO9vopVE9keD8bX7wbD00vByQ2jeOMTzofzCjJu7CJyf2iImPTqY/oSuqpAlQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LO0P265MB5826
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 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 Thu, 10 Nov 2022 17:41:31 +0100
Miguel Ojeda <ojeda@kernel.org> wrote:

> From: Gary Guo <gary@garyguo.net>
> 
> Add `c_str!`, which is a convenience macro that creates a new `CStr`
> from a string literal.
> 
> It is designed to be similar to a `str` in usage, and it is usable
> in const contexts, for instance:
> 
>     const X: &CStr = c_str!("Example");
> 
> Co-developed-by: Alex Gaynor <alex.gaynor@gmail.com>
> Signed-off-by: Alex Gaynor <alex.gaynor@gmail.com>
> Signed-off-by: Gary Guo <gary@garyguo.net>
> [Reworded, adapted for upstream and applied latest changes]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
>  rust/kernel/str.rs | 32 ++++++++++++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
> 
> diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs
> index 3ed685cb5a3c..3fb73b888dce 100644
> --- a/rust/kernel/str.rs
> +++ b/rust/kernel/str.rs
> @@ -128,6 +128,18 @@ impl CStr {
>          Ok(unsafe { Self::from_bytes_with_nul_unchecked(bytes) })
>      }
>  
> +    /// Creates a [`CStr`] from a `[u8]`, panic if input is not valid.
> +    ///
> +    /// This function is only meant to be used by `c_str!` macro, so
> +    /// crates using `c_str!` macro don't have to enable `const_panic` feature.

I wrote this code when `const_panic` was not yet stable. Now we have
stable const panic this function could be removed.

> +    #[doc(hidden)]
> +    pub const fn from_bytes_with_nul_unwrap(bytes: &[u8]) -> &Self {
> +        match Self::from_bytes_with_nul(bytes) {
> +            Ok(v) => v,
> +            Err(_) => panic!("string contains interior NUL"),
> +        }
> +    }
> +
>      /// Creates a [`CStr`] from a `[u8]` without performing any additional
>      /// checks.
>      ///
> @@ -321,6 +333,26 @@ where
>      }
>  }
>  
> +/// Creates a new [`CStr`] from a string literal.
> +///
> +/// The string literal should not contain any `NUL` bytes.
> +///
> +/// # Examples
> +///
> +/// ```
> +/// # use kernel::c_str;
> +/// # use kernel::str::CStr;
> +/// const MY_CSTR: &CStr = c_str!("My awesome CStr!");
> +/// ```
> +#[macro_export]
> +macro_rules! c_str {
> +    ($str:expr) => {{
> +        const S: &str = concat!($str, "\0");
> +        const C: &$crate::str::CStr = $crate::str::CStr::from_bytes_with_nul_unwrap(S.as_bytes());
> +        C
> +    }};
> +}

+#[macro_export]
+macro_rules! c_str {
+    ($str:expr) => {{
+        const S: &str = concat!($str, "\0");
+        const C: &$crate::str::CStr = match $crate::str::CStr::from_bytes_with_nul(S.as_bytes()) {
+            Ok(v) => v,
+            Err(_) => panic!("string contains interior NUL"),
+        };
+        C
+    }};
+}

> +
>  #[cfg(test)]
>  mod tests {
>      use super::*;