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:   Sun, 4 Dec 2022 00:20:37 +0000
From:   Gary Guo <gary@garyguo.net>
To:     ojeda@kernel.org, Finn Behrens <me@kloenk.dev>
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 v2 05/28] rust: macros: add `concat_idents!` proc macro
Message-ID: <20221204002037.29e7da42@GaryWorkstation>
In-Reply-To: <20221202161502.385525-6-ojeda@kernel.org>
References: <20221202161502.385525-1-ojeda@kernel.org>
        <20221202161502.385525-6-ojeda@kernel.org>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?VHhMVVZCR0lTTHY0Z1poNE8zR2tMcDQ4aTVGajZSUHZ1UkJEaC8yc01xaFJu?=
 =?utf-8?B?TThuMThoYk0vY3JobytYbXA3aXJCN1VDNVo0WUg2VWZnR0RsQXI4L3cxNmRH?=
 =?utf-8?B?Zk5ESEpKUW5WQm50RUVGQSt2Ump6TmUvWFRGSFpVdlJlWTZHUElxYlpIa0NR?=
 =?utf-8?B?THZYSFpoeldRV1ZsdGlDK1NXeDRTcnM2ZDNLS3pBMHNGUThLanRaQ2EwUFc2?=
 =?utf-8?B?STRBWnlSK0NkYlJEdmZ5UTZXd04vTjFiOHNSSG9BNTlZZHRZSWN0ZzJBSHdx?=
 =?utf-8?B?YzJPTTRsd1NTeisrc29NWmxhekhaN2lDUXRkWDZsYjM0N1RRMGZrNVcrc2Ny?=
 =?utf-8?B?Wkg5U0Q3UFVDY01vY0dPdHRiUC9YKzRpWkJEZjNJNnN3ZnJqanF3N2RjRi9o?=
 =?utf-8?B?TlFoa01OL08wVmsrdWZ4cGZTNTdCaWxMaHpDOC9HdmxGbmhrMFp4bzRXZXJv?=
 =?utf-8?B?aDZVWTlvblc2NXMxd2prSGExYkJGYnhRVFhjK0tpbm5wL2o2VmgxY1JEMEo0?=
 =?utf-8?B?SU13eDgxeFdYYk1Dclp4dUNWN0JtL2lNM1dCVVFUOURJVVdkUzVhdXlnUWs3?=
 =?utf-8?B?bWozN1BPVkcwV3lLcGpQTERWQlRTTWxXSmlNcG1yZytZd21WZEdqL3pydnBx?=
 =?utf-8?B?elJvRk1OcWhJYi83aXpLYlpjNmFHZDg3bldRajhqQ3o3S2ZaRVBaYkJKcEtn?=
 =?utf-8?B?WlBHOTJrL3BLUStnWWQxSUhJYzBKV2hKWUp0dEZSNkNjbm1INHJPZ2hOczBu?=
 =?utf-8?B?MERnUmVhWkVGTEVGems4bG4xRXpBbW1JNDI3aEExSEdKYUNwaVozdmVWL25p?=
 =?utf-8?B?djRNV0NHREZVYUdQUW1sSWhPSkdDcTh3K2wyL3dEWG5RcUVwZWQ2b3NpRkVD?=
 =?utf-8?B?WG4vUGh6eTZkeW0vRjBaTXlNU0NVZW94RTlxbk54YjUyTEJFTlhoalgrV3lm?=
 =?utf-8?B?bkY0YXZCYy9NSkFnYmRqaW1oSG5HK1prUjV1T0lEcjBuRzVwYUZ1dGVkclNR?=
 =?utf-8?B?NnMwWGdYZGtoMGJZMy9kUnNJS1JoK2VLZUlOWmZ4MVM2Rmh1dmlETVFkdFFn?=
 =?utf-8?B?M0FrOXVhZEVkbWNpc1RiRVVySmFGbUwrZzJER0d0SnBtRzNyL2dPbVNFUFov?=
 =?utf-8?B?bGQxSjlwMnRqaWV0bzk3SFViLzVjbmNPRlo0RVlxajFKMi85YlRiSTJsOWpl?=
 =?utf-8?B?enAwUUdFNUZxRytMV3QyVWhzYjh0Qy9iWjZXR2lQR1JWWDgxdDZ4SEdSUmpk?=
 =?utf-8?B?YlVWOThoTmYxeXFpQ29Rc2JIU3c1eVlrOUptNmkxZHFNNUdjcVNvdEpZZTd5?=
 =?utf-8?B?TUpHdjRZWE41YmJ3Ukdmb09TV0N6eWU3WjVqSHlTdzQ4K2FGa25hZzA0TERG?=
 =?utf-8?B?YzBaQjlYQXZXbU9Hais4MjBOMzhxYjlscFFIZWt4R0NTY1BhV2FSMm10UkY2?=
 =?utf-8?B?eDI5Q0t0TitMMVhRZW4rM0VrbFFaVGMrZkdOZGF4Y2Zwby9ocFFIUk84Wkd0?=
 =?utf-8?B?NDFXclB5WFpBZEprUldSNFdjYTdjeVlwUXJQZnlkWElKTWk0dmtuTGIyQlBG?=
 =?utf-8?B?VnJ2WkZYaldZL1FwOGFsQmFqcnhBZDBKK28wUFBQTWhDcitaNEkzenNDQUgz?=
 =?utf-8?B?aG5kZGQxMFkvaHh2Rnp5Nm05eTZxQk5YM3BqTUI0ckxxOEFyaEhuOXh0QVhl?=
 =?utf-8?B?dFlxclFuUStteUl2MFBwaU9sWkpZOE1Tc3VCaEVNbmhuaUpnOGhkYm1BMzAr?=
 =?utf-8?B?UlFMcU1Ia0Vsb0VqMGQvOEJGTWVFZXk3T0R1KzZjY29GNlNoWDdBOUVvWHlK?=
 =?utf-8?B?OVBzQnhqQnZyeEQrMHlYaDE1ZUgvNlB4RFhvQ09mM2F3clAvcEZxWmZVZWMz?=
 =?utf-8?B?UW9NS1FjWTI1UTJKUGNaMW10cTlOOTgyeXVSclhqbnRycldPSVNuOUpNS2FL?=
 =?utf-8?B?WlR1Q0F0Y1lTSFp1S2svT1pSYXNNdHdZem5OSHpqaS91dGtuQktXdytpYm5Y?=
 =?utf-8?B?dkdLU044WUxWTnFWbFVnMU05UmVUcDFXZFg1S1dTbEJXTE5peFZveGZrU0NU?=
 =?utf-8?B?MTg4WnRLVG1nMUFOZkJwbWRoU2xWa3FCcXpqbytQN1pxVW9TNFFkNmdBdEJ4?=
 =?utf-8?B?Z1BldTVtNXA0anlWWWZaMlVMREV5RHpNWVcrVDJaU0hHcHc2TTdxRlpRdWtB?=
 =?utf-8?Q?lP+lwJcTmNEr/YEvXUvVKdvl8RAms3rno0tjyGGXl6xT?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 46ca7a24-ed66-42c4-f79c-08dad58d5edc
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Dec 2022 00:20:38.5772
 (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: +CD0sfC3cGO38y0aWLAB23kJJyjWvn7PTKafedVEriEv/LODUHhUAI1XRNZdXs2omUtkaVvHbB+3SdseLKHH6A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LO2P265MB7170
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 Fri,  2 Dec 2022 17:14:36 +0100
ojeda@kernel.org wrote:

> From: Bj=C3=B6rn Roy Baron <bjorn3_gh@protonmail.com>
>=20
> This macro provides similar functionality to the unstable feature
> `concat_idents` without having to rely on it.
>=20
> For instance:
>=20
>     let x_1 =3D 42;
>     let x_2 =3D concat_idents!(x, _1);
>     assert!(x_1 =3D=3D x_2);
>=20
> It has different behavior with respect to macro hygiene. Unlike
> the unstable `concat_idents!` macro, it allows, for example,
> referring to local variables by taking the span of the second
> macro as span for the output identifier.
>=20
> Signed-off-by: Bj=C3=B6rn Roy Baron <bjorn3_gh@protonmail.com>
> Reviewed-by: Finn Behrens <me@kloenk.dev>
> [Reworded, adapted for upstream and applied latest changes]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
>  rust/macros/concat_idents.rs | 23 +++++++++++++++++++
>  rust/macros/lib.rs           | 44 ++++++++++++++++++++++++++++++++++++
>  2 files changed, 67 insertions(+)
>  create mode 100644 rust/macros/concat_idents.rs
>=20
> diff --git a/rust/macros/concat_idents.rs b/rust/macros/concat_idents.rs
> new file mode 100644
> index 000000000000..7e4b450f3a50
> --- /dev/null
> +++ b/rust/macros/concat_idents.rs
> @@ -0,0 +1,23 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +use proc_macro::{token_stream, Ident, TokenStream, TokenTree};
> +
> +use crate::helpers::expect_punct;
> +
> +fn expect_ident(it: &mut token_stream::IntoIter) -> Ident {
> +    if let Some(TokenTree::Ident(ident)) =3D it.next() {
> +        ident
> +    } else {
> +        panic!("Expected Ident")
> +    }
> +}
> +
> +pub(crate) fn concat_idents(ts: TokenStream) -> TokenStream {
> +    let mut it =3D ts.into_iter();
> +    let a =3D expect_ident(&mut it);
> +    assert_eq!(expect_punct(&mut it), ',');
> +    let b =3D expect_ident(&mut it);
> +    assert!(it.next().is_none(), "only two idents can be concatenated");
> +    let res =3D Ident::new(&format!("{a}{b}"), b.span());
> +    TokenStream::from_iter([TokenTree::Ident(res)])
> +}
> diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
> index 91764bfb1f89..15555e7ff487 100644
> --- a/rust/macros/lib.rs
> +++ b/rust/macros/lib.rs
> @@ -2,6 +2,7 @@
> =20
>  //! Crate for all kernel procedural macros.
> =20
> +mod concat_idents;
>  mod helpers;
>  mod module;
> =20
> @@ -70,3 +71,46 @@ use proc_macro::TokenStream;
>  pub fn module(ts: TokenStream) -> TokenStream {
>      module::module(ts)
>  }
> +
> +/// Concatenate two identifiers.
> +///
> +/// This is useful in macros that need to declare or reference items wit=
h names
> +/// starting with a fixed prefix and ending in a user specified name. Th=
e resulting
> +/// identifier has the span of the second argument.
> +///
> +/// # Examples
> +///
> +/// ```ignore
> +/// use kernel::macro::concat_idents;
> +///
> +/// macro_rules! pub_no_prefix {
> +///     ($prefix:ident, $($newname:ident),+) =3D> {
> +///         $(pub(crate) const $newname: u32 =3D kernel::macros::concat_=
idents!($prefix, $newname);)+
> +///     };
> +/// }
> +///
> +/// pub_no_prefix!(
> +///     binder_driver_return_protocol_,
> +///     BR_OK,
> +///     BR_ERROR,
> +///     BR_TRANSACTION,
> +///     BR_REPLY,
> +///     BR_DEAD_REPLY,
> +///     BR_TRANSACTION_COMPLETE,
> +///     BR_INCREFS,
> +///     BR_ACQUIRE,
> +///     BR_RELEASE,
> +///     BR_DECREFS,
> +///     BR_NOOP,
> +///     BR_SPAWN_LOOPER,
> +///     BR_DEAD_BINDER,
> +///     BR_CLEAR_DEATH_NOTIFICATION_DONE,
> +///     BR_FAILED_REPLY
> +/// );
> +///
> +/// assert_eq!(BR_OK, binder_driver_return_protocol_BR_OK);
> +/// ```
> +#[proc_macro]
> +pub fn concat_idents(ts: TokenStream) -> TokenStream {
> +    concat_idents::concat_idents(ts)
> +}

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