| 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
| ||
|
Message-ID: <CAJ-ks9k_c3hq9ov8nqXLakkC6=Ly1+Fr3kbQ8BUbAQrRcHZhqw@mail.gmail.com>
Date: Tue, 20 Jan 2026 10:34:08 -0500
From: Tamir Duberstein <tamird@...nel.org>
To: Eliot Courtney <ecourtney@...dia.com>, Jesung Yang <y.j3ms.n@...il.com>
Cc: Miguel Ojeda <ojeda@...nel.org>, Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
Björn Roy Baron <bjorn3_gh@...tonmail.com>,
Benno Lossin <lossin@...nel.org>, Andreas Hindborg <a.hindborg@...nel.org>,
Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>,
Danilo Krummrich <dakr@...nel.org>, Nathan Chancellor <nathan@...nel.org>, Nicolas Schier <nsc@...nel.org>,
rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org,
linux-kbuild@...r.kernel.org
Subject: Re: [PATCH 6/6] scripts: generate_rust_analyzer: move sysroot crates
to sysroot_project
On Tue, Jan 20, 2026 at 3:55 AM Eliot Courtney <ecourtney@...dia.com> wrote:
>
> Use rust-analyzer's sysroot_project feature to properly configure
> sysroot crates (core, alloc, std, proc_macro). This allows
> rust-analyzer to correctly resolve items from the sysroot and
> automatically add sysroot crate dependencies to all project crates.
>
> Some sysroot crates use #[path] directives to load files outside of
> their directory but still in the sysroot. This is disallowed by
> rust-analyzer, so the sysroot crate are not properly loaded. Loading them
> using sysroot_project tells rust-analyzer to let them load anything inside
> sysroot_src.
>
> The sysroot_project field was added to rust-analyzer in v0.3.2328
> (~1.87.0) and is silently ignored by older versions. In that case,
> rust-analyzer falls back to loading the sysroot via sysroot_src.
> This basically works, but the advantage of using sysroot_project is
> that we can make the set of features/cfgs more similar to what the
> actual build uses.
This is a very nice patch, and perhaps obviates the need for the
versioning infrastructure in
https://lore.kernel.org/all/20260109-ra-fix-primitive-v2-0-249852a4145a@gmail.com/.
As with the other commits in this series, we need citations of the
claims that these newer fields are properly ignored by older versions
of RA.
>
> Signed-off-by: Eliot Courtney <ecourtney@...dia.com>
> ---
> scripts/generate_rust_analyzer.py | 118 ++++++++++++++++++++++----------------
> 1 file changed, 70 insertions(+), 48 deletions(-)
>
> diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
> index ba2f6b0fb99b..f8666050a997 100755
> --- a/scripts/generate_rust_analyzer.py
> +++ b/scripts/generate_rust_analyzer.py
> @@ -27,25 +27,14 @@ def args_crates_cfgs(cfgs):
>
> return crates_cfgs
>
> -def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions, crate_attrs, common_crate_attrs):
> - # Generate the configuration list.
> - generated_cfg = []
> - with open(objtree / "include" / "generated" / "rustc_cfg") as fd:
> - for line in fd:
> - line = line.replace("--cfg=", "")
> - line = line.replace("\n", "")
> - generated_cfg.append(line)
> -
> - # Now fill the crates list -- dependencies need to come first.
> - #
> - # Avoid O(n^2) iterations by keeping a map of indexes.
> +def generate_sysroot_crates(cfgs, editions, crate_attrs):
> crates = []
> crates_indexes = {}
> crates_cfgs = args_crates_cfgs(cfgs)
> crates_editions = args_single(editions)
> crates_crate_attrs = args_crates_cfgs(crate_attrs)
>
> - def append_crate(display_name, root_module, deps, cfg=[], is_workspace_member=True, is_proc_macro=False, is_proc_macro_library=False):
> + def append_sysroot_crate(display_name, deps):
> # Miguel Ojeda writes:
> #
> # > ... in principle even the sysroot crates may have different
> @@ -72,6 +61,52 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> # assumption if future edition moves span multiple rust versions.
> edition = crates_editions.get(display_name, "2021")
>
> + cfg = crates_cfgs.get(display_name, [])
> + crates_indexes[display_name] = len(crates)
> + crates.append({
> + "display_name": display_name,
> + # Paths in sysroot_project are relative to sysroot_src.
> + "root_module": f"{display_name}/src/lib.rs",
> + "is_workspace_member": False,
> + "is_proc_macro": False,
> + "deps": [{"crate": crates_indexes[dep], "name": dep} for dep in deps],
> + "cfg": cfg,
> + "edition": edition,
> + # Crate attributes were introduced in 1.94.0 but older versions will silently ignore this.
> + "crate_attrs": crates_crate_attrs.get(display_name, []),
> + "env": {
> + "RUST_MODFILE": "This is only for rust-analyzer"
> + }
> + })
> +
> + append_sysroot_crate("core", [])
> + append_sysroot_crate("alloc", ["core"])
> + append_sysroot_crate("std", ["alloc", "core"])
> + append_sysroot_crate("proc_macro", ["core", "std"])
> +
> + return crates
> +
> +def generate_crates(srctree, objtree, external_src, cfgs, editions, crate_attrs, common_crate_attrs):
> + # Generate the configuration list.
> + generated_cfg = []
> + with open(objtree / "include" / "generated" / "rustc_cfg") as fd:
> + for line in fd:
> + line = line.replace("--cfg=", "")
> + line = line.replace("\n", "")
> + generated_cfg.append(line)
> +
> + # Now fill the crates list -- dependencies need to come first.
> + #
> + # Avoid O(n^2) iterations by keeping a map of indexes.
> + crates = []
> + crates_indexes = {}
> + crates_cfgs = args_crates_cfgs(cfgs)
> + crates_editions = args_single(editions)
> + crates_crate_attrs = args_crates_cfgs(crate_attrs)
> +
> + def append_crate(display_name, root_module, deps, cfg=[], is_proc_macro=False, is_proc_macro_library=False):
> + edition = crates_editions.get(display_name, "2021")
> +
> crate_attrs = crates_crate_attrs.get(display_name, [])
> # Apply common crate attrs to non-host crates.
> if not is_proc_macro_library and not is_proc_macro:
> @@ -80,7 +115,7 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> crate = {
> "display_name": display_name,
> "root_module": str(root_module),
> - "is_workspace_member": is_workspace_member,
> + "is_workspace_member": True,
> "is_proc_macro": is_proc_macro,
> "deps": [{"crate": crates_indexes[dep], "name": dep} for dep in deps],
> "cfg": cfg,
> @@ -100,37 +135,20 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> crates_indexes[display_name] = len(crates)
> crates.append(crate)
>
> - def append_sysroot_crate(
> - display_name,
> - deps,
> - cfg=[],
> - ):
> - append_crate(
> - display_name,
> - sysroot_src / display_name / "src" / "lib.rs",
> - deps,
> - cfg,
> - is_workspace_member=False,
> - )
> -
> - # NB: sysroot crates reexport items from one another so setting up our transitive dependencies
> - # here is important for ensuring that rust-analyzer can resolve symbols. The sources of truth
> - # for this dependency graph are `(sysroot_src / crate / "Cargo.toml" for crate in crates)`.
> - append_sysroot_crate("core", [], cfg=crates_cfgs.get("core", []))
> - append_sysroot_crate("alloc", ["core"])
> - append_sysroot_crate("std", ["alloc", "core"])
> - append_sysroot_crate("proc_macro", ["core", "std"])
> + # Sysroot crates (core, alloc, std, proc_macro) are in sysroot_project,
> + # and their deps are automatically added to all crates by rust-analyzer.
> + # We only need to define deps between our own crates here.
>
> append_crate(
> "compiler_builtins",
> srctree / "rust" / "compiler_builtins.rs",
> - ["core"],
> + [],
> )
>
> append_crate(
> "proc_macro2",
> srctree / "rust" / "proc-macro2" / "lib.rs",
> - ["core", "alloc", "std", "proc_macro"],
> + [],
> cfg=crates_cfgs["proc_macro2"],
> is_proc_macro_library=True,
> )
> @@ -138,7 +156,7 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> append_crate(
> "quote",
> srctree / "rust" / "quote" / "lib.rs",
> - ["core", "alloc", "std", "proc_macro", "proc_macro2"],
> + ["proc_macro2"],
> cfg=crates_cfgs["quote"],
> is_proc_macro_library=True,
> )
> @@ -146,7 +164,7 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> append_crate(
> "syn",
> srctree / "rust" / "syn" / "lib.rs",
> - ["std", "proc_macro", "proc_macro2", "quote"],
> + ["proc_macro2", "quote"],
> cfg=crates_cfgs["syn"],
> is_proc_macro_library=True,
> )
> @@ -154,20 +172,20 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> append_crate(
> "macros",
> srctree / "rust" / "macros" / "lib.rs",
> - ["std", "proc_macro", "proc_macro2", "quote", "syn"],
> + ["proc_macro2", "quote", "syn"],
> is_proc_macro=True,
> )
>
> append_crate(
> "build_error",
> srctree / "rust" / "build_error.rs",
> - ["core", "compiler_builtins"],
> + ["compiler_builtins"],
> )
>
> append_crate(
> "pin_init_internal",
> srctree / "rust" / "pin-init" / "internal" / "src" / "lib.rs",
> - ["std", "proc_macro"],
> + [],
> cfg=["kernel"],
> is_proc_macro=True,
> )
> @@ -175,14 +193,14 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> append_crate(
> "pin_init",
> srctree / "rust" / "pin-init" / "src" / "lib.rs",
> - ["core", "compiler_builtins", "pin_init_internal", "macros"],
> + ["pin_init_internal", "macros"],
> cfg=["kernel"],
> )
>
> append_crate(
> "ffi",
> srctree / "rust" / "ffi.rs",
> - ["core", "compiler_builtins"],
> + ["compiler_builtins"],
> )
>
> def append_crate_with_generated(
> @@ -204,9 +222,9 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> "exclude_dirs": [],
> }
>
> - append_crate_with_generated("bindings", ["core", "ffi", "pin_init"])
> - append_crate_with_generated("uapi", ["core", "ffi", "pin_init"])
> - append_crate_with_generated("kernel", ["core", "macros", "build_error", "pin_init", "ffi", "bindings", "uapi"])
> + append_crate_with_generated("bindings", ["ffi", "pin_init"])
> + append_crate_with_generated("uapi", ["ffi", "pin_init"])
> + append_crate_with_generated("kernel", ["macros", "build_error", "pin_init", "ffi", "bindings", "uapi"])
>
> def is_root_crate(build_file, target):
> try:
> @@ -234,7 +252,7 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs, editions,
> append_crate(
> name,
> path,
> - ["core", "kernel", "pin_init"],
> + ["kernel", "pin_init"],
> cfg=generated_cfg,
> )
>
> @@ -261,7 +279,11 @@ def main():
>
> common_crate_attrs = args.common_crate_attrs.split() if args.common_crate_attrs else []
> rust_project = {
> - "crates": generate_crates(args.srctree, args.objtree, args.sysroot_src, args.exttree, args.cfgs, args.editions, args.crate_attrs, common_crate_attrs),
> + "sysroot_src": str(args.sysroot_src),
> + "sysroot_project": {
> + "crates": generate_sysroot_crates(args.cfgs, args.editions, args.crate_attrs),
> + },
> + "crates": generate_crates(args.srctree, args.objtree, args.exttree, args.cfgs, args.editions, args.crate_attrs, common_crate_attrs),
> "sysroot": str(args.sysroot),
> }
>
>
> --
> 2.52.0
>
>
Powered by blists - more mailing lists