1#!/usr/bin/env python3
2# SPDX-License-Identifier: GPL-2.0
3"""generate_rust_analyzer - Generates the `rust-project.json` file for `rust-analyzer`.
4"""
5
6import argparse
7import json
8import logging
9import os
10import pathlib
11import subprocess
12import sys
13
14def args_crates_cfgs(cfgs):
15    crates_cfgs = {}
16    for cfg in cfgs:
17        crate, vals = cfg.split("=", 1)
18        crates_cfgs[crate] = vals.replace("--cfg", "").split()
19
20    return crates_cfgs
21
22def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs):
23    # Generate the configuration list.
24    cfg = []
25    with open(objtree / "include" / "generated" / "rustc_cfg") as fd:
26        for line in fd:
27            line = line.replace("--cfg=", "")
28            line = line.replace("\n", "")
29            cfg.append(line)
30
31    # Now fill the crates list -- dependencies need to come first.
32    #
33    # Avoid O(n^2) iterations by keeping a map of indexes.
34    crates = []
35    crates_indexes = {}
36    crates_cfgs = args_crates_cfgs(cfgs)
37
38    def append_crate(display_name, root_module, deps, cfg=[], is_workspace_member=True, is_proc_macro=False):
39        crate = {
40            "display_name": display_name,
41            "root_module": str(root_module),
42            "is_workspace_member": is_workspace_member,
43            "is_proc_macro": is_proc_macro,
44            "deps": [{"crate": crates_indexes[dep], "name": dep} for dep in deps],
45            "cfg": cfg,
46            "edition": "2021",
47            "env": {
48                "RUST_MODFILE": "This is only for rust-analyzer"
49            }
50        }
51        if is_proc_macro:
52            proc_macro_dylib_name = subprocess.check_output(
53                [os.environ["RUSTC"], "--print", "file-names", "--crate-name", display_name, "--crate-type", "proc-macro", "-"],
54                stdin=subprocess.DEVNULL,
55            ).decode('utf-8').strip()
56            crate["proc_macro_dylib_path"] = f"{objtree}/rust/{proc_macro_dylib_name}"
57        crates_indexes[display_name] = len(crates)
58        crates.append(crate)
59
60    def append_sysroot_crate(
61        display_name,
62        deps,
63        cfg=[],
64    ):
65        append_crate(
66            display_name,
67            sysroot_src / display_name / "src" / "lib.rs",
68            deps,
69            cfg,
70            is_workspace_member=False,
71        )
72
73    # NB: sysroot crates reexport items from one another so setting up our transitive dependencies
74    # here is important for ensuring that rust-analyzer can resolve symbols. The sources of truth
75    # for this dependency graph are `(sysroot_src / crate / "Cargo.toml" for crate in crates)`.
76    append_sysroot_crate("core", [], cfg=crates_cfgs.get("core", []))
77    append_sysroot_crate("alloc", ["core"])
78    append_sysroot_crate("std", ["alloc", "core"])
79    append_sysroot_crate("proc_macro", ["core", "std"])
80
81    append_crate(
82        "compiler_builtins",
83        srctree / "rust" / "compiler_builtins.rs",
84        [],
85    )
86
87    append_crate(
88        "macros",
89        srctree / "rust" / "macros" / "lib.rs",
90        ["std", "proc_macro"],
91        is_proc_macro=True,
92    )
93
94    append_crate(
95        "build_error",
96        srctree / "rust" / "build_error.rs",
97        ["core", "compiler_builtins"],
98    )
99
100    append_crate(
101        "ffi",
102        srctree / "rust" / "ffi.rs",
103        ["core", "compiler_builtins"],
104    )
105
106    def append_crate_with_generated(
107        display_name,
108        deps,
109    ):
110        append_crate(
111            display_name,
112            srctree / "rust"/ display_name / "lib.rs",
113            deps,
114            cfg=cfg,
115        )
116        crates[-1]["env"]["OBJTREE"] = str(objtree.resolve(True))
117        crates[-1]["source"] = {
118            "include_dirs": [
119                str(srctree / "rust" / display_name),
120                str(objtree / "rust")
121            ],
122            "exclude_dirs": [],
123        }
124
125    append_crate_with_generated("bindings", ["core", "ffi"])
126    append_crate_with_generated("uapi", ["core", "ffi"])
127    append_crate_with_generated("kernel", ["core", "macros", "build_error", "ffi", "bindings", "uapi"])
128
129    def is_root_crate(build_file, target):
130        try:
131            return f"{target}.o" in open(build_file).read()
132        except FileNotFoundError:
133            return False
134
135    # Then, the rest outside of `rust/`.
136    #
137    # We explicitly mention the top-level folders we want to cover.
138    extra_dirs = map(lambda dir: srctree / dir, ("samples", "drivers"))
139    if external_src is not None:
140        extra_dirs = [external_src]
141    for folder in extra_dirs:
142        for path in folder.rglob("*.rs"):
143            logging.info("Checking %s", path)
144            name = path.name.replace(".rs", "")
145
146            # Skip those that are not crate roots.
147            if not is_root_crate(path.parent / "Makefile", name) and \
148               not is_root_crate(path.parent / "Kbuild", name):
149                continue
150
151            logging.info("Adding %s", name)
152            append_crate(
153                name,
154                path,
155                ["core", "kernel"],
156                cfg=cfg,
157            )
158
159    return crates
160
161def main():
162    parser = argparse.ArgumentParser()
163    parser.add_argument('--verbose', '-v', action='store_true')
164    parser.add_argument('--cfgs', action='append', default=[])
165    parser.add_argument("srctree", type=pathlib.Path)
166    parser.add_argument("objtree", type=pathlib.Path)
167    parser.add_argument("sysroot", type=pathlib.Path)
168    parser.add_argument("sysroot_src", type=pathlib.Path)
169    parser.add_argument("exttree", type=pathlib.Path, nargs="?")
170    args = parser.parse_args()
171
172    logging.basicConfig(
173        format="[%(asctime)s] [%(levelname)s] %(message)s",
174        level=logging.INFO if args.verbose else logging.WARNING
175    )
176
177    # Making sure that the `sysroot` and `sysroot_src` belong to the same toolchain.
178    assert args.sysroot in args.sysroot_src.parents
179
180    rust_project = {
181        "crates": generate_crates(args.srctree, args.objtree, args.sysroot_src, args.exttree, args.cfgs),
182        "sysroot": str(args.sysroot),
183    }
184
185    json.dump(rust_project, sys.stdout, sort_keys=True, indent=4)
186
187if __name__ == "__main__":
188    main()
189