linux-kernel - Re: [PATCH v3] scripts: generate_rust_analyzer.py: add missing macros deps

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAJ-ks9mofNbtGqoYBummkfxZ+zrmEHg5P6viVwwgs9-BuNGbZg@mail.gmail.com>
Date: Fri, 7 Mar 2025 06:05:29 -0500
From: Tamir Duberstein <tamird@...il.com>
To: Andreas Hindborg <a.hindborg@...nel.org>
Cc: Miguel Ojeda <ojeda@...nel.org>, Alex Gaynor <alex.gaynor@...il.com>, 
	Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>, 
	Björn Roy Baron <bjorn3_gh@...tonmail.com>, 
	Benno Lossin <benno.lossin@...ton.me>, Alice Ryhl <aliceryhl@...gle.com>, 
	Trevor Gross <tmgross@...ch.edu>, Boris-Chengbiao Zhou <bobo1239@....de>, Fiona Behrens <me@...enk.dev>, 
	Kees Cook <kees@...nel.org>, rust-for-linux@...r.kernel.org, 
	linux-kernel@...r.kernel.org, Chayim Refael Friedman <chayimfr@...il.com>
Subject: Re: [PATCH v3] scripts: generate_rust_analyzer.py: add missing macros deps

On Fri, Mar 7, 2025 at 5:57 AM Andreas Hindborg <a.hindborg@...nel.org> wrote:
>
> "Tamir Duberstein" <tamird@...il.com> writes:
>
> > The macros crate has depended on std and proc_macro since its
> > introduction in commit 1fbde52bde73 ("rust: add `macros` crate"). These
> > dependencies were omitted from commit 8c4555ccc55c ("scripts: add
> > `generate_rust_analyzer.py`") resulting in missing go-to-definition and
> > autocomplete, and false-positive warnings emitted from rust-analyzer
> > such as:
> >
> >   [{
> >       "resource": "/Users/tamird/src/linux/rust/macros/module.rs",
> >       "owner": "_generated_diagnostic_collection_name_#1",
> >       "code": {
> >               "value": "non_snake_case",
> >               "target": {
> >                       "$mid": 1,
> >                       "path": "/rustc/",
> >                       "scheme": "https",
> >                       "authority": "doc.rust-lang.org",
> >                       "query": "search=non_snake_case"
> >               }
> >       },
> >       "severity": 4,
> >       "message": "Variable `None` should have snake_case name, e.g. `none`",
> >       "source": "rust-analyzer",
> >       "startLineNumber": 123,
> >       "startColumn": 17,
> >       "endLineNumber": 123,
> >       "endColumn": 21
> >   }]
> >
> > Add the missing dependencies to improve the developer experience.
> >
> > Fixes: 8c4555ccc55c ("scripts: add `generate_rust_analyzer.py`")
> > Reviewed-by: Fiona Behrens <me@...enk.dev>
> > Suggested-by: Chayim Refael Friedman <chayimfr@...il.com>
> > Signed-off-by: Tamir Duberstein <tamird@...il.com>
> > ---
> > Changes in v3:
> > - Avoid shuffling compilter_builtins; it is not needed for RA support.
> > - Align more closely with the long-term solution:
> >   https://lore.kernel.org/all/20250209-rust-analyzer-host-v1-0-a2286a2a2fa3@gmail.com/.
> > - Link to v2: https://lore.kernel.org/r/20250209-rust-analyzer-macros-core-dep-v2-1-897338344d16@gmail.com
> >
> > Changes in v2:
> > - Change macros deps from [core] to [std, proc_macro], improving
> >   autocomplete and go-to-definition.
> > - Remove Wedson Almeida Filho <wedsonaf@...gle.com> from cc; email
> >   bounced.
> > - Link to v1: https://lore.kernel.org/r/20250209-rust-analyzer-macros-core-dep-v1-1-5ebeb3eb60a9@gmail.com
> > ---
> >  scripts/generate_rust_analyzer.py | 30 +++++++++++++++++++++---------
> >  1 file changed, 21 insertions(+), 9 deletions(-)
> >
> > diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
> > index aa8ea1a4dbe5..1394baa5ee9e 100755
> > --- a/scripts/generate_rust_analyzer.py
> > +++ b/scripts/generate_rust_analyzer.py
> > @@ -57,14 +57,26 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs):
> >          crates_indexes[display_name] = len(crates)
> >          crates.append(crate)
> >
> > -    # First, the ones in `rust/` since they are a bit special.
> > -    append_crate(
> > -        "core",
> > -        sysroot_src / "core" / "src" / "lib.rs",
> > -        [],
> > -        cfg=crates_cfgs.get("core", []),
> > -        is_workspace_member=False,
> > -    )
> > +    def append_sysroot_crate(
> > +        display_name,
> > +        deps,
> > +        cfg=[],
> > +    ):
> > +        return append_crate(
>
> Why the `return` here?

It's in anticipation of this follow up patch

https://lore.kernel.org/all/20250209-rust-analyzer-host-v1-2-a2286a2a2fa3@gmail.com/

where the return value is used to identify the crate. I developed the
two in parallel so I added this return to reduce overall churn.

> Otherwise looks good to me.
>
> I never had any errors as described above, but I can confirm that go to
> definition in `macros` for items in `proc_macro` work with this patch
> applied. It does not work prior to applying the patch.
>
>
> Tested-by: Andreas Hindborg <a.hindborg@...nel.org>

Thanks!