From patchwork Wed Dec 13 22:08:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Benno Lossin X-Patchwork-Id: 178316 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:3b04:b0:fb:cd0c:d3e with SMTP id c4csp8123876dys; Wed, 13 Dec 2023 14:08:53 -0800 (PST) X-Google-Smtp-Source: AGHT+IE501lK/4WF9k0vw70S6MT1raHZ6Xn9+HVQpxiYEh2NiVFO9Zdr7qnAoBMryIP86TzemWnV X-Received: by 2002:a17:90b:290:b0:286:a708:cd08 with SMTP id az16-20020a17090b029000b00286a708cd08mr4506634pjb.40.1702505333629; Wed, 13 Dec 2023 14:08:53 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1702505333; cv=none; d=google.com; s=arc-20160816; b=K8M4lUzeO68HJ4ve1JBXtLtXdEJLn4H1O4XCcBxf0WSrDJm00bwbbQ3LfiESIuOJdu b5unJWa8rdeTVeFzNCtXgURBB/ewVQ3uX+p3FbX6ZtGeu81cbGvkPHjOQaVWNdJIpbbW 9XmmBJrQRlh+DBhlVZGny2Fy7UAhMwnfZBr+QScftrCCjkn+aTNIhxbQwQmRDLk4OtZk DOXmqxVx/W5uJap2BTjk5twYUFyeaJpBeBc2eRCYwdRa786T+Rx/xl2RPV/amyR3bkez XsKKUKvGZPECOjVdnAfMPqcauBoPbIga+1tUAJ/4K4JNAx9h5uhMJjD9qViBksQNkO0w XV+g== 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:message-id:subject:cc:from:to:date:dkim-signature; bh=Wynj0f8vy1dMFkSRpdFHLagtu+BF+QLWLK677HHPjYc=; fh=mqtUycvvt6dhLqs7LstFlpErPS7EEmEp1YKc77Rhw4k=; b=XQq65yG01jYPYGVlSdpWnHVutakDywbgOlHfiJpN6TXfvDSVRiINAP4vQmZmIscdKe 6kiQpicO/2tBIOu0QSpPcUOzwYkmkbWvQrueXEDQSovaviTMaNxVTMSbanSdG5sdCK8s VF0Cnqsqj5gvqiMfETqoVNl4iGDvW9jgCTLJ4hw9fnIi0w8obrf+o2TUb1uXDuRVIj88 qooCALSXoASVLOa6bFrGTTvIQCwV3xhUYa9Ce+PYGhnCUIbTKOFiAbfRgvgl8claROeV xbBaz+0obRv6TvmO1YGZihPAIxHieB8DEBQqTVKSl04g/TvoMeo43k3qgyQ3ShoOlLqs +1sg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@proton.me header.s=protonmail header.b=Qijbzkwg; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=proton.me Received: from groat.vger.email (groat.vger.email. [2620:137:e000::3:5]) by mx.google.com with ESMTPS id q5-20020a17090aa00500b002839db82641si10296183pjp.85.2023.12.13.14.08.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Dec 2023 14:08:53 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) client-ip=2620:137:e000::3:5; Authentication-Results: mx.google.com; dkim=pass header.i=@proton.me header.s=protonmail header.b=Qijbzkwg; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=proton.me Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by groat.vger.email (Postfix) with ESMTP id 4E33D8032236; Wed, 13 Dec 2023 14:08:47 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at groat.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1442740AbjLMWIi (ORCPT + 99 others); Wed, 13 Dec 2023 17:08:38 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35394 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229929AbjLMWIh (ORCPT ); Wed, 13 Dec 2023 17:08:37 -0500 Received: from mail-4322.protonmail.ch (mail-4322.protonmail.ch [185.70.43.22]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 92829AC for ; Wed, 13 Dec 2023 14:08:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=proton.me; s=protonmail; t=1702505319; x=1702764519; bh=Wynj0f8vy1dMFkSRpdFHLagtu+BF+QLWLK677HHPjYc=; h=Date:To:From:Cc:Subject:Message-ID:Feedback-ID:From:To:Cc:Date: Subject:Reply-To:Feedback-ID:Message-ID:BIMI-Selector; b=Qijbzkwgws8v2BOJU/Y04JKzswsD8go/e5ulLXTKs2nq2THXRHERcDlAoHedQwjuG eOos7HR7iuVpc7t4XoU/0JZxEbIu1KOpv1TeoICu/fBXDr17nhlnElyvkuPVQ4pZHd VeBNtDDBWl4ZNZ1w1DICo2crNDFHrofSmqP+luDoHkjfgW8H8nI+3zUaLDuWaT55pP dOrsQFpi+pHcc3w5oRabMyZwNOBkYNG7eOV6+1x3mWthM9Mp3PqlceAVy1IKLd5CbN jYx/S41HAw91r/266P+EAd2n/sORBzKR51nyFOdvRxf7AwrEPcmySssaqewCzyrZRV kQT7Pi4NCpwDQ== Date: Wed, 13 Dec 2023 22:08:32 +0000 To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Sumera Priyadarsini , Vincenzo Palazzo , Asahi Lina , Martin Rodriguez Reboredo From: Benno Lossin Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 1/3] rust: macros: add `decl_generics` to `parse_generics()` Message-ID: <20231213220447.3613500-1-benno.lossin@proton.me> Feedback-ID: 71780778:user:proton MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on groat.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (groat.vger.email [0.0.0.0]); Wed, 13 Dec 2023 14:08:47 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785206232782361377 X-GMAIL-MSGID: 1785206232782361377 The generic parameters on a type definition can specify default values. Currently `parse_generics()` cannot handle this though. For example when parsing the following generics: The `impl_generics` will be set to `T: Clone, const N: usize = 0` and `ty_generics` will be set to `T, N`. Now using the `impl_generics` on an impl block: impl<$($impl_generics)*> Foo {} will result in invalid Rust code, because default values are only available on type definitions. Therefore add parsing support for generic parameter default values using a new kind of generics called `decl_generics` and change the old behavior of `impl_generics` to not contain the generic parameter default values. Now `Generics` has three fields: - `impl_generics`: the generics with bounds (e.g. `T: Clone, const N: usize`) - `decl_generics`: the generics with bounds and default values (e.g. `T: Clone, const N: usize = 0`) - `ty_generics`: contains the generics without bounds and without default values (e.g. `T, N`) `impl_generics` is designed to be used on `impl<$impl_generics>`, `decl_generics` for the type definition, so `struct Foo<$decl_generics>` and `ty_generics` whenever you use the type, so `Foo<$ty_generics>`. Here is an example that uses all three different types of generics: let (Generics { decl_generics, impl_generics, ty_generics }, rest) = parse_generics(input); quote! { struct Foo<$($decl_generics)*> { // ... } impl<$impl_generics> Foo<$ty_generics> { fn foo() { // ... } } } The next commit contains a fix to the `#[pin_data]` macro making it compatible with generic parameter default values by relying on this new behavior. Signed-off-by: Benno Lossin Reviewed-by: Martin Rodriguez Reboredo Tested-by: Alice Ryhl --- v1 -> v2: - improve documentation and commit message explanation - add motivation to commit message rust/macros/helpers.rs | 122 ++++++++++++++++++++++++++++++---------- rust/macros/pin_data.rs | 1 + rust/macros/zeroable.rs | 1 + 3 files changed, 94 insertions(+), 30 deletions(-) base-commit: d9857c16cfc6bce7764e1b79956c6a028f97f4d0 diff --git a/rust/macros/helpers.rs b/rust/macros/helpers.rs index afb0f2e3a36a..3f50a5c847c8 100644 --- a/rust/macros/helpers.rs +++ b/rust/macros/helpers.rs @@ -1,6 +1,6 @@ // SPDX-License-Identifier: GPL-2.0 -use proc_macro::{token_stream, Group, Punct, Spacing, TokenStream, TokenTree}; +use proc_macro::{token_stream, Group, TokenStream, TokenTree}; pub(crate) fn try_ident(it: &mut token_stream::IntoIter) -> Option { if let Some(TokenTree::Ident(ident)) = it.next() { @@ -70,8 +70,40 @@ pub(crate) fn expect_end(it: &mut token_stream::IntoIter) { } } +/// Parsed generics. +/// +/// See the field documentation for an explanation what each of the fields represents. +/// +/// # Examples +/// +/// ```rust,ignore +/// # let input = todo!(); +/// let (Generics { decl_generics, impl_generics, ty_generics }, rest) = parse_generics(input); +/// quote! { +/// struct Foo<$($decl_generics)*> { +/// // ... +/// } +/// +/// impl<$impl_generics> Foo<$ty_generics> { +/// fn foo() { +/// // ... +/// } +/// } +/// } +/// ``` pub(crate) struct Generics { + /// The generics with bounds and default values (e.g. `T: Clone, const N: usize = 0`). + /// + /// Use this on type definitions e.g. `struct Foo<$decl_generics> ...` (or `union`/`enum`). + pub(crate) decl_generics: Vec, + /// The generics with bounds (e.g. `T: Clone, const N: usize`). + /// + /// Use this on `impl` blocks e.g. `impl<$impl_generics> Trait for ...`. pub(crate) impl_generics: Vec, + /// The generics without bounds and without default values (e.g. `T, N`). + /// + /// Use this when you use the type that is declared with these generics e.g. + /// `Foo<$ty_generics>`. pub(crate) ty_generics: Vec, } @@ -81,6 +113,8 @@ pub(crate) struct Generics { pub(crate) fn parse_generics(input: TokenStream) -> (Generics, Vec) { // `impl_generics`, the declared generics with their bounds. let mut impl_generics = vec![]; + // The generics with bounds and default values. + let mut decl_generics = vec![]; // Only the names of the generics, without any bounds. let mut ty_generics = vec![]; // Tokens not related to the generics e.g. the `where` token and definition. @@ -90,10 +124,17 @@ pub(crate) fn parse_generics(input: TokenStream) -> (Generics, Vec) { let mut toks = input.into_iter(); // If we are at the beginning of a generic parameter. let mut at_start = true; - for tt in &mut toks { + let mut skip_until_comma = false; + while let Some(tt) = toks.next() { + if nesting == 1 && matches!(&tt, TokenTree::Punct(p) if p.as_char() == '>') { + // Found the end of the generics. + break; + } else if nesting >= 1 { + decl_generics.push(tt.clone()); + } match tt.clone() { TokenTree::Punct(p) if p.as_char() == '<' => { - if nesting >= 1 { + if nesting >= 1 && !skip_until_comma { // This is inside of the generics and part of some bound. impl_generics.push(tt); } @@ -105,49 +146,70 @@ pub(crate) fn parse_generics(input: TokenStream) -> (Generics, Vec) { break; } else { nesting -= 1; - if nesting >= 1 { + if nesting >= 1 && !skip_until_comma { // We are still inside of the generics and part of some bound. impl_generics.push(tt); } - if nesting == 0 { - break; - } } } - tt => { + TokenTree::Punct(p) if skip_until_comma && p.as_char() == ',' => { if nesting == 1 { - // Here depending on the token, it might be a generic variable name. - match &tt { - // Ignore const. - TokenTree::Ident(i) if i.to_string() == "const" => {} - TokenTree::Ident(_) if at_start => { - ty_generics.push(tt.clone()); - // We also already push the `,` token, this makes it easier to append - // generics. - ty_generics.push(TokenTree::Punct(Punct::new(',', Spacing::Alone))); - at_start = false; - } - TokenTree::Punct(p) if p.as_char() == ',' => at_start = true, - // Lifetimes begin with `'`. - TokenTree::Punct(p) if p.as_char() == '\'' && at_start => { - ty_generics.push(tt.clone()); - } - _ => {} - } + impl_generics.push(TokenTree::Punct(p.clone())); + ty_generics.push(TokenTree::Punct(p)); + skip_until_comma = false; } - if nesting >= 1 { - impl_generics.push(tt); - } else if nesting == 0 { + } + tt if !skip_until_comma => { + match nesting { // If we haven't entered the generics yet, we still want to keep these tokens. - rest.push(tt); + 0 => rest.push(tt), + 1 => { + // Here depending on the token, it might be a generic variable name. + match tt { + TokenTree::Ident(i) if at_start && i.to_string() == "const" => { + let Some(name) = toks.next() else { + // Parsing error. + break; + }; + impl_generics.push(TokenTree::Ident(i)); + impl_generics.push(name.clone()); + ty_generics.push(name.clone()); + decl_generics.push(name); + at_start = false; + } + tt @ TokenTree::Ident(_) if at_start => { + impl_generics.push(tt.clone()); + ty_generics.push(tt); + at_start = false; + } + TokenTree::Punct(p) if p.as_char() == ',' => { + impl_generics.push(TokenTree::Punct(p.clone())); + ty_generics.push(TokenTree::Punct(p)); + at_start = true; + } + // Lifetimes begin with `'`. + TokenTree::Punct(p) if p.as_char() == '\'' && at_start => { + ty_generics.push(TokenTree::Punct(p.clone())); + impl_generics.push(TokenTree::Punct(p)); + } + // Generics can have default values, we skip these. + TokenTree::Punct(p) if p.as_char() == '=' => { + skip_until_comma = true; + } + tt => impl_generics.push(tt), + } + } + _ => impl_generics.push(tt), } } + _ => {} } } rest.extend(toks); ( Generics { impl_generics, + decl_generics, ty_generics, }, rest, diff --git a/rust/macros/pin_data.rs b/rust/macros/pin_data.rs index 6d58cfda9872..022e68e9720d 100644 --- a/rust/macros/pin_data.rs +++ b/rust/macros/pin_data.rs @@ -10,6 +10,7 @@ pub(crate) fn pin_data(args: TokenStream, input: TokenStream) -> TokenStream { let ( Generics { impl_generics, + decl_generics: _, ty_generics, }, rest, diff --git a/rust/macros/zeroable.rs b/rust/macros/zeroable.rs index 0d605c46ab3b..cfee2cec18d5 100644 --- a/rust/macros/zeroable.rs +++ b/rust/macros/zeroable.rs @@ -7,6 +7,7 @@ pub(crate) fn derive(input: TokenStream) -> TokenStream { let ( Generics { impl_generics, + decl_generics: _, ty_generics, }, mut rest, From patchwork Wed Dec 13 22:08:53 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Benno Lossin X-Patchwork-Id: 178317 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:3b04:b0:fb:cd0c:d3e with SMTP id c4csp8124047dys; Wed, 13 Dec 2023 14:09:16 -0800 (PST) X-Google-Smtp-Source: AGHT+IFYRaVJAgBNd5qOWbrgceffk1UqBl5WMPktHDd6mQpJ8Cm7dFQGSviAaQPrEFc5S2of5JTn X-Received: by 2002:a17:90b:4a47:b0:28a:b287:e90a with SMTP id lb7-20020a17090b4a4700b0028ab287e90amr2562236pjb.71.1702505356624; Wed, 13 Dec 2023 14:09:16 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1702505356; cv=none; d=google.com; s=arc-20160816; b=hJm8Qukf51pn79tSG270kEVcv2G2w5jj5SeDaLokv6JU1h0MbsKkB+Ucnvuzwu/yGn 2ux7o5nDb7SF2HPvaiIXtVJDBXwLRXHPTwDEbsvqfqh4MM4c0HblyS0+GrmE/mwgtVxk EjZI0ok9hsVrJKzk1DqP0CIEyt+VwHJW393JrtmBYSLxb6tzRN0QGWKy6EDvLvR3U4Cm 52CHRRaIB78kSsFBc3plMkqJp0JTiUF8TJ55Wz5Yw+CxU/MMKa0Aneqj8vJRg++3WoU4 I+Ycn0qtFFmcq/yk9b6QNy1jHzHQcwQfkk//ePz8c1Cq4tTBEFGcbryDz32s1wdzpruC yJWw== 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 :date:dkim-signature; bh=/sxUPUCZGGUcmNBROpNTSbutQhtb2lUVRGVV1RJCeAs=; fh=Ov/rTNdileIkvoFBvDwlWN6kRuLU6cjKBx/1/vxBh1M=; b=YXPCpKZx+4BOJ/rxkkakZQiB+7Xv4s+12t0nv6a0/WmnINW9/JFMuvSFmTb9JSqqRv EEt6fsNHsMveoe3RwJ18y+N4t9XqL0ECFHzlunIq2ONwhmYXeZtgKk7Zv6Ql/G6iCheB eMszqEEQLQTRV/gJC6zRiwFS25WxUsMFNCSPL/TwOA+jpqe7mdmJcybECKchnPO+7fYY L3qkzxIPduZJp48IULvEgh1JfOqNEZmNogDlNzqGrb8HlB7smJscL6GpjaLJvc/f3Adx HkUbrA1cxCjvhd8f3VdcCqf/RqjJixpEtS3b82lmUTJRffNswsm1QDLRjm8RsM3vLO7/ 3WnQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@proton.me header.s=5ij2hnl3gzgkvokoca6crcyvfa.protonmail header.b=eVe3aIjz; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=proton.me Received: from morse.vger.email (morse.vger.email. [23.128.96.31]) by mx.google.com with ESMTPS id k2-20020a17090a62c200b00280479459f7si911773pjs.50.2023.12.13.14.09.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Dec 2023 14:09:16 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31; Authentication-Results: mx.google.com; dkim=pass header.i=@proton.me header.s=5ij2hnl3gzgkvokoca6crcyvfa.protonmail header.b=eVe3aIjz; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=proton.me Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by morse.vger.email (Postfix) with ESMTP id 6964D826FA91; Wed, 13 Dec 2023 14:09:12 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at morse.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233930AbjLMWJE (ORCPT + 99 others); Wed, 13 Dec 2023 17:09:04 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33536 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230397AbjLMWJC (ORCPT ); Wed, 13 Dec 2023 17:09:02 -0500 Received: from mail-4316.protonmail.ch (mail-4316.protonmail.ch [185.70.43.16]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 34A9DAF for ; Wed, 13 Dec 2023 14:09:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=proton.me; s=5ij2hnl3gzgkvokoca6crcyvfa.protonmail; t=1702505346; x=1702764546; bh=/sxUPUCZGGUcmNBROpNTSbutQhtb2lUVRGVV1RJCeAs=; 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=eVe3aIjzzfpnSaAPoKNkuOCaVOTNRVRQ7OBVrNOfRNGMvVVnJhid9GQkHQ9e3f5Ec vFr2k082SBsYljRG7Au0EFKa+s9H32ZwigRPmskYl5N9ppBNr8IX1RoXz3aXTcD5cy AXNgeySoFLHutIOPxsX7c500uC9Uhi3qeT7TWIDmIY7q4hfliMsinSPLdVbqfZ7jLh XDLPvQPKn4414FtmQm0AfMXHQjXZDG13pwk1iahO6zupKC+nFBOjmLkMMLzwCAtztE DmiIJXOD2I4jIgVo5jnjI38o8q6js+CNWP7yx49ch4qZMtsztWmMHH9qEauNSh8owG rfEsUmfjdn7/g== Date: Wed, 13 Dec 2023 22:08:53 +0000 To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Martin Rodriguez Reboredo From: Benno Lossin Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 2/3] rust: macros: allow generic parameter default values in `#[pin_data]` Message-ID: <20231213220447.3613500-2-benno.lossin@proton.me> In-Reply-To: <20231213220447.3613500-1-benno.lossin@proton.me> References: <20231213220447.3613500-1-benno.lossin@proton.me> Feedback-ID: 71780778:user:proton MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on morse.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (morse.vger.email [0.0.0.0]); Wed, 13 Dec 2023 14:09:12 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785206256931752326 X-GMAIL-MSGID: 1785206256931752326 Add support for generic parameters defaults in `#[pin_data]` by using the newly introduced `decl_generics` instead of the `impl_generics`. Before this would not compile: #[pin_data] struct Foo { // ... } because it would be expanded to this: struct Foo { // ... } const _: () = { struct __ThePinData { __phantom: ::core::marker::PhantomData) -> Foo>, } impl ::core::clone::Clone for __ThePinData { fn clone(&self) -> Self { *self } } // [...] rest of expansion omitted }; The problem is with the `impl`, since that is invalid Rust syntax. It should not mention the default value at all, since default values only make sense on type definitions. The new `impl_generics` do not contain the default values, thus generating correct Rust code. This is used by the next commit that puts `#[pin_data]` on `kernel::workqueue::Work`. Signed-off-by: Benno Lossin Reviewed-by: Martin Rodriguez Reboredo Reviewed-by: Gary Guo Tested-by: Alice Ryhl Reviewed-by: Alice Ryhl --- v1 -> v2: - clarify the change in the commit message - add motivation to the commit message rust/kernel/init/macros.rs | 19 ++++++++++++++++++- rust/macros/pin_data.rs | 3 ++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/rust/kernel/init/macros.rs b/rust/kernel/init/macros.rs index cb6e61b6c50b..624e9108e3b4 100644 --- a/rust/kernel/init/macros.rs +++ b/rust/kernel/init/macros.rs @@ -538,6 +538,7 @@ macro_rules! __pin_data { ), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @body({ $($fields:tt)* }), ) => { // We now use token munching to iterate through all of the fields. While doing this we @@ -560,6 +561,9 @@ macro_rules! __pin_data { @impl_generics($($impl_generics)*), // The 'ty generics', the generics that will need to be specified on the impl blocks. @ty_generics($($ty_generics)*), + // The 'decl generics', the generics that need to be specified on the struct + // definition. + @decl_generics($($decl_generics)*), // The where clause of any impl block and the declaration. @where($($($whr)*)?), // The remaining fields tokens that need to be processed. @@ -585,6 +589,7 @@ macro_rules! __pin_data { @name($name:ident), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @where($($whr:tt)*), // We found a PhantomPinned field, this should generally be pinned! @fields_munch($field:ident : $($($(::)?core::)?marker::)?PhantomPinned, $($rest:tt)*), @@ -607,6 +612,7 @@ macro_rules! __pin_data { @name($name), @impl_generics($($impl_generics)*), @ty_generics($($ty_generics)*), + @decl_generics($($decl_generics)*), @where($($whr)*), @fields_munch($($rest)*), @pinned($($pinned)* $($accum)* $field: ::core::marker::PhantomPinned,), @@ -623,6 +629,7 @@ macro_rules! __pin_data { @name($name:ident), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @where($($whr:tt)*), // We reached the field declaration. @fields_munch($field:ident : $type:ty, $($rest:tt)*), @@ -640,6 +647,7 @@ macro_rules! __pin_data { @name($name), @impl_generics($($impl_generics)*), @ty_generics($($ty_generics)*), + @decl_generics($($decl_generics)*), @where($($whr)*), @fields_munch($($rest)*), @pinned($($pinned)* $($accum)* $field: $type,), @@ -656,6 +664,7 @@ macro_rules! __pin_data { @name($name:ident), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @where($($whr:tt)*), // We reached the field declaration. @fields_munch($field:ident : $type:ty, $($rest:tt)*), @@ -673,6 +682,7 @@ macro_rules! __pin_data { @name($name), @impl_generics($($impl_generics)*), @ty_generics($($ty_generics)*), + @decl_generics($($decl_generics)*), @where($($whr)*), @fields_munch($($rest)*), @pinned($($pinned)*), @@ -689,6 +699,7 @@ macro_rules! __pin_data { @name($name:ident), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @where($($whr:tt)*), // We found the `#[pin]` attr. @fields_munch(#[pin] $($rest:tt)*), @@ -705,6 +716,7 @@ macro_rules! __pin_data { @name($name), @impl_generics($($impl_generics)*), @ty_generics($($ty_generics)*), + @decl_generics($($decl_generics)*), @where($($whr)*), @fields_munch($($rest)*), // We do not include `#[pin]` in the list of attributes, since it is not actually an @@ -724,6 +736,7 @@ macro_rules! __pin_data { @name($name:ident), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @where($($whr:tt)*), // We reached the field declaration with visibility, for simplicity we only munch the // visibility and put it into `$accum`. @@ -741,6 +754,7 @@ macro_rules! __pin_data { @name($name), @impl_generics($($impl_generics)*), @ty_generics($($ty_generics)*), + @decl_generics($($decl_generics)*), @where($($whr)*), @fields_munch($field $($rest)*), @pinned($($pinned)*), @@ -757,6 +771,7 @@ macro_rules! __pin_data { @name($name:ident), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @where($($whr:tt)*), // Some other attribute, just put it into `$accum`. @fields_munch(#[$($attr:tt)*] $($rest:tt)*), @@ -773,6 +788,7 @@ macro_rules! __pin_data { @name($name), @impl_generics($($impl_generics)*), @ty_generics($($ty_generics)*), + @decl_generics($($decl_generics)*), @where($($whr)*), @fields_munch($($rest)*), @pinned($($pinned)*), @@ -789,6 +805,7 @@ macro_rules! __pin_data { @name($name:ident), @impl_generics($($impl_generics:tt)*), @ty_generics($($ty_generics:tt)*), + @decl_generics($($decl_generics:tt)*), @where($($whr:tt)*), // We reached the end of the fields, plus an optional additional comma, since we added one // before and the user is also allowed to put a trailing comma. @@ -802,7 +819,7 @@ macro_rules! __pin_data { ) => { // Declare the struct with all fields in the correct order. $($struct_attrs)* - $vis struct $name <$($impl_generics)*> + $vis struct $name <$($decl_generics)*> where $($whr)* { $($fields)* diff --git a/rust/macros/pin_data.rs b/rust/macros/pin_data.rs index 022e68e9720d..1d4a3547c684 100644 --- a/rust/macros/pin_data.rs +++ b/rust/macros/pin_data.rs @@ -10,7 +10,7 @@ pub(crate) fn pin_data(args: TokenStream, input: TokenStream) -> TokenStream { let ( Generics { impl_generics, - decl_generics: _, + decl_generics, ty_generics, }, rest, @@ -77,6 +77,7 @@ pub(crate) fn pin_data(args: TokenStream, input: TokenStream) -> TokenStream { @sig(#(#rest)*), @impl_generics(#(#impl_generics)*), @ty_generics(#(#ty_generics)*), + @decl_generics(#(#decl_generics)*), @body(#last), }); quoted.extend(errs); From patchwork Wed Dec 13 22:09:04 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Benno Lossin X-Patchwork-Id: 178318 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:3b04:b0:fb:cd0c:d3e with SMTP id c4csp8124186dys; Wed, 13 Dec 2023 14:09:33 -0800 (PST) X-Google-Smtp-Source: AGHT+IFvFFwjN6gLIoRRIgbnOvzEdTH5vbCx9MtxQj5BUOtDcwYCBY735Y0WNO904lZ3UKw/B925 X-Received: by 2002:a05:6a20:f39c:b0:18c:92f0:69bd with SMTP id qr28-20020a056a20f39c00b0018c92f069bdmr4796761pzb.24.1702505373116; Wed, 13 Dec 2023 14:09:33 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1702505373; cv=none; d=google.com; s=arc-20160816; b=HggrI77wJgOSonU7igXMZgUUAu2ZEzbrQEt7o8scnvyPn3PsaFLT2yJqsa87czXQwv hnX2mX7GkRsyN7G7akwV3bjS5NRGyBc15tnW4zVYmA0acfvibgNofpN8sAtGvO3KrAbS +myIK6DJ4P7ZnUa7XP+At5ZyKWYZ+oKOGVuusFjrBodwolYwfzeVPykuZMT7GPR2G9kK oTkbJXN24Gv1yRw8fb6awpH2NxvAtnlShPsMp+/xgJgggmRyw7/ncd4adYQJsGy/Wy5G z95VdvrXeZD3YQ6Wu9qYmiCEtA+7jHt49AzRFl3GZVmjAa6tvM4igQklTId8BOlTmQ+G 1MBA== 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 :date:dkim-signature; bh=HEh8GOBW89PGEJ9xzMl86G8ozQum0hgJyYTbj8sFLEs=; fh=MKp4uwIS2qcobQvLDCgvPbRKPggooUfCgyYyA4DDQfU=; b=u9068LaOYfiejTMoNUaMZYtGCmwWDd6KvWzP2apsIgrDvP8pnGYthMA7Ru9RczozlS +x7DlN034uP3thQiy54W9Lwe2ZPnbpOw4dInqaIRD0eInStPHSVJiYAqIQzIBPmJqYQP VloqZg/bbUt2T4Y90cTkU5VwhX2FmKfAgPJL9CSitjf7VsrDlD+XbcxsKuLaiKoi9u5s 5Vd5HMJVCSYx9mmpf6U4AlXZrFGOnKLvm0pImhdE9BgdDwnea30AhMnRm2PT9q2q2W4q 3Ul0M9s0MjZgXWgQDddD3wMpjxbIdMZLlT68K9DyPAKk+JhVCO4KbhlA+MQurAEGFJuF PQWA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@proton.me header.s=protonmail header.b=eWv5PSEi; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=proton.me Received: from fry.vger.email (fry.vger.email. [23.128.96.38]) by mx.google.com with ESMTPS id 8-20020a17090a0c0800b0028abe8926a4si3350251pjs.168.2023.12.13.14.09.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Dec 2023 14:09:33 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) client-ip=23.128.96.38; Authentication-Results: mx.google.com; dkim=pass header.i=@proton.me header.s=protonmail header.b=eWv5PSEi; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=proton.me Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by fry.vger.email (Postfix) with ESMTP id 8760180C776A; Wed, 13 Dec 2023 14:09:28 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at fry.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234000AbjLMWJT (ORCPT + 99 others); Wed, 13 Dec 2023 17:09:19 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53216 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233993AbjLMWJS (ORCPT ); Wed, 13 Dec 2023 17:09:18 -0500 Received: from mail-40134.protonmail.ch (mail-40134.protonmail.ch [185.70.40.134]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 78163EA; Wed, 13 Dec 2023 14:09:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=proton.me; s=protonmail; t=1702505362; x=1702764562; bh=HEh8GOBW89PGEJ9xzMl86G8ozQum0hgJyYTbj8sFLEs=; 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=eWv5PSEiLPvHNdz71xYJcidf281WJHTlXrjDyLIpSByBrLzTux4LrveZ/Prak6Zhk AT/apxLngUyyqoeALLk/T/FuxULzpAvqDcL0Ps1nhgXqUKUAjuPhg7O7rgOz9y2rqt lDgfZgJy2GQSRWFaZrJtjGiv8SYUaJ78W/Z0hrtsO+6X1UNYVlY7do9u0iDsZkGXTx UkvmN0EwUBZhS1+5C6Y3Dwdf5UHaruT1Kn7V9W2wED9QSl/Wv2s7e9qaLLzHYAkqgZ O5n1mUy/zbKPR4OaIt0cRx813c0TSlGJiHWIqOo+6b9vgXr+Y5X6cJtUdJuh8gbDZd 70Qk0nv/uTCig== Date: Wed, 13 Dec 2023 22:09:04 +0000 To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Martin Rodriguez Reboredo , Tejun Heo From: Benno Lossin Cc: Wedson Almeida Filho , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 3/3] rust: workqueue: add `#[pin_data]` to `Work` Message-ID: <20231213220447.3613500-3-benno.lossin@proton.me> In-Reply-To: <20231213220447.3613500-1-benno.lossin@proton.me> References: <20231213220447.3613500-1-benno.lossin@proton.me> Feedback-ID: 71780778:user:proton MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Wed, 13 Dec 2023 14:09:28 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785206273669236805 X-GMAIL-MSGID: 1785206273669236805 The previous two patches made it possible to add `#[pin_data]` on structs with default generic parameter values. This patch makes `Work` use `#[pin_data]` and removes an invocation of `pin_init_from_closure`. This function is intended as a low level manual escape hatch, so it is better to rely on the safe `pin_init!` macro. Signed-off-by: Benno Lossin --- v1 -> v2: - improve commit message wording - change `:` to `<-` in `pin_init!` invocation rust/kernel/workqueue.rs | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/rust/kernel/workqueue.rs b/rust/kernel/workqueue.rs index b67fb1ba168e..4a9fb7d06d20 100644 --- a/rust/kernel/workqueue.rs +++ b/rust/kernel/workqueue.rs @@ -334,8 +334,10 @@ pub trait WorkItem { /// Wraps the kernel's C `struct work_struct`. /// /// This is a helper type used to associate a `work_struct` with the [`WorkItem`] that uses it. +#[pin_data] #[repr(transparent)] pub struct Work { + #[pin] work: Opaque, _inner: PhantomData, } @@ -357,21 +359,22 @@ pub fn new(name: &'static CStr, key: &'static LockClassKey) -> impl PinInit, { - // SAFETY: The `WorkItemPointer` implementation promises that `run` can be used as the work - // item function. - unsafe { - kernel::init::pin_init_from_closure(move |slot| { - let slot = Self::raw_get(slot); - bindings::init_work_with_key( - slot, - Some(T::Pointer::run), - false, - name.as_char_ptr(), - key.as_ptr(), - ); - Ok(()) - }) - } + pin_init!(Self { + work <- Opaque::ffi_init(|slot| { + // SAFETY: The `WorkItemPointer` implementation promises that `run` can be used as + // the work item function. + unsafe { + bindings::init_work_with_key( + slot, + Some(T::Pointer::run), + false, + name.as_char_ptr(), + key.as_ptr(), + ) + } + }), + _inner: PhantomData, + }) } /// Get a pointer to the inner `work_struct`.