tidy/
deps.rs

Help
1//! Checks the licenses of third-party dependencies.
2
3use std::collections::{HashMap, HashSet};
4use std::fs::{File, read_dir};
5use std::io::Write;
6use std::path::Path;
7
8use build_helper::ci::CiEnv;
9use cargo_metadata::semver::Version;
10use cargo_metadata::{Metadata, Package, PackageId};
11
12#[path = "../../../bootstrap/src/utils/proc_macro_deps.rs"]
13mod proc_macro_deps;
14
15/// These are licenses that are allowed for all crates, including the runtime,
16/// rustc, tools, etc.
17#[rustfmt::skip]
18const LICENSES: &[&str] = &[
19    // tidy-alphabetical-start
20    "(MIT OR Apache-2.0) AND Unicode-3.0",                 // unicode_ident (1.0.14)
21    "(MIT OR Apache-2.0) AND Unicode-DFS-2016",            // unicode_ident (1.0.12)
22    "0BSD OR MIT OR Apache-2.0",                           // adler2 license
23    "0BSD",
24    "Apache-2.0 / MIT",
25    "Apache-2.0 OR ISC OR MIT",
26    "Apache-2.0 OR MIT",
27    "Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT", // wasi license
28    "Apache-2.0",
29    "Apache-2.0/MIT",
30    "BSD-2-Clause OR Apache-2.0 OR MIT",                   // zerocopy
31    "ISC",
32    "MIT / Apache-2.0",
33    "MIT AND (MIT OR Apache-2.0)",
34    "MIT AND Apache-2.0 WITH LLVM-exception AND (MIT OR Apache-2.0)", // compiler-builtins
35    "MIT OR Apache-2.0 OR LGPL-2.1-or-later",              // r-efi, r-efi-alloc
36    "MIT OR Apache-2.0 OR Zlib",                           // tinyvec_macros
37    "MIT OR Apache-2.0",
38    "MIT OR Zlib OR Apache-2.0",                           // miniz_oxide
39    "MIT",
40    "MIT/Apache-2.0",
41    "Unicode-3.0",                                         // icu4x
42    "Unicode-DFS-2016",                                    // tinystr
43    "Unlicense OR MIT",
44    "Unlicense/MIT",
45    "Zlib OR Apache-2.0 OR MIT",                           // tinyvec
46    // tidy-alphabetical-end
47];
48
49type ExceptionList = &'static [(&'static str, &'static str)];
50
51/// The workspaces to check for licensing and optionally permitted dependencies.
52///
53/// Each entry consists of a tuple with the following elements:
54///
55/// * The path to the workspace root Cargo.toml file.
56/// * The list of license exceptions.
57/// * Optionally a tuple of:
58///     * A list of crates for which dependencies need to be explicitly allowed.
59///     * The list of allowed dependencies.
60/// * Submodules required for the workspace.
61// FIXME auto detect all cargo workspaces
62pub(crate) const WORKSPACES: &[(&str, ExceptionList, Option<(&[&str], &[&str])>, &[&str])] = &[
63    // The root workspace has to be first for check_rustfix to work.
64    (".", EXCEPTIONS, Some((&["rustc-main"], PERMITTED_RUSTC_DEPENDENCIES)), &[]),
65    ("library", EXCEPTIONS_STDLIB, Some((&["sysroot"], PERMITTED_STDLIB_DEPENDENCIES)), &[]),
66    // Outside of the alphabetical section because rustfmt formats it using multiple lines.
67    (
68        "compiler/rustc_codegen_cranelift",
69        EXCEPTIONS_CRANELIFT,
70        Some((&["rustc_codegen_cranelift"], PERMITTED_CRANELIFT_DEPENDENCIES)),
71        &[],
72    ),
73    // tidy-alphabetical-start
74    ("compiler/rustc_codegen_gcc", EXCEPTIONS_GCC, None, &[]),
75    ("src/bootstrap", EXCEPTIONS_BOOTSTRAP, None, &[]),
76    ("src/ci/docker/host-x86_64/test-various/uefi_qemu_test", EXCEPTIONS_UEFI_QEMU_TEST, None, &[]),
77    ("src/etc/test-float-parse", EXCEPTIONS, None, &[]),
78    ("src/tools/cargo", EXCEPTIONS_CARGO, None, &["src/tools/cargo"]),
79    //("src/tools/miri/test-cargo-miri", &[], None), // FIXME uncomment once all deps are vendored
80    //("src/tools/miri/test_dependencies", &[], None), // FIXME uncomment once all deps are vendored
81    ("src/tools/rust-analyzer", EXCEPTIONS_RUST_ANALYZER, None, &[]),
82    ("src/tools/rustbook", EXCEPTIONS_RUSTBOOK, None, &["src/doc/book", "src/doc/reference"]),
83    ("src/tools/rustc-perf", EXCEPTIONS_RUSTC_PERF, None, &["src/tools/rustc-perf"]),
84    // tidy-alphabetical-end
85];
86
87/// These are exceptions to Rust's permissive licensing policy, and
88/// should be considered bugs. Exceptions are only allowed in Rust
89/// tooling. It is _crucial_ that no exception crates be dependencies
90/// of the Rust runtime (std/test).
91#[rustfmt::skip]
92const EXCEPTIONS: ExceptionList = &[
93    // tidy-alphabetical-start
94    ("ar_archive_writer", "Apache-2.0 WITH LLVM-exception"), // rustc
95    ("arrayref", "BSD-2-Clause"),                            // rustc
96    ("blake3", "CC0-1.0 OR Apache-2.0 OR Apache-2.0 WITH LLVM-exception"),  // rustc
97    ("colored", "MPL-2.0"),                                  // rustfmt
98    ("constant_time_eq", "CC0-1.0 OR MIT-0 OR Apache-2.0"),  // rustc
99    ("dissimilar", "Apache-2.0"),                            // rustdoc, rustc_lexer (few tests) via expect-test, (dev deps)
100    ("fluent-langneg", "Apache-2.0"),                        // rustc (fluent translations)
101    ("foldhash", "Zlib"),                                    // rustc
102    ("option-ext", "MPL-2.0"),                               // cargo-miri (via `directories`)
103    ("rustc_apfloat", "Apache-2.0 WITH LLVM-exception"),     // rustc (license is the same as LLVM uses)
104    ("ryu", "Apache-2.0 OR BSL-1.0"), // BSL is not acceptble, but we use it under Apache-2.0                       // cargo/... (because of serde)
105    ("self_cell", "Apache-2.0"),                             // rustc (fluent translations)
106    ("wasi-preview1-component-adapter-provider", "Apache-2.0 WITH LLVM-exception"), // rustc
107    // tidy-alphabetical-end
108];
109
110/// These are exceptions to Rust's permissive licensing policy, and
111/// should be considered bugs. Exceptions are only allowed in Rust
112/// tooling. It is _crucial_ that no exception crates be dependencies
113/// of the Rust runtime (std/test).
114#[rustfmt::skip]
115const EXCEPTIONS_STDLIB: ExceptionList = &[
116    // tidy-alphabetical-start
117    ("fortanix-sgx-abi", "MPL-2.0"), // libstd but only for `sgx` target. FIXME: this dependency violates the documentation comment above.
118    // tidy-alphabetical-end
119];
120
121const EXCEPTIONS_CARGO: ExceptionList = &[
122    // tidy-alphabetical-start
123    ("arrayref", "BSD-2-Clause"),
124    ("bitmaps", "MPL-2.0+"),
125    ("blake3", "CC0-1.0 OR Apache-2.0 OR Apache-2.0 WITH LLVM-exception"),
126    ("ciborium", "Apache-2.0"),
127    ("ciborium-io", "Apache-2.0"),
128    ("ciborium-ll", "Apache-2.0"),
129    ("constant_time_eq", "CC0-1.0 OR MIT-0 OR Apache-2.0"),
130    ("dunce", "CC0-1.0 OR MIT-0 OR Apache-2.0"),
131    ("encoding_rs", "(Apache-2.0 OR MIT) AND BSD-3-Clause"),
132    ("fiat-crypto", "MIT OR Apache-2.0 OR BSD-1-Clause"),
133    ("foldhash", "Zlib"),
134    ("im-rc", "MPL-2.0+"),
135    ("normalize-line-endings", "Apache-2.0"),
136    ("openssl", "Apache-2.0"),
137    ("ryu", "Apache-2.0 OR BSL-1.0"), // BSL is not acceptble, but we use it under Apache-2.0
138    ("sha1_smol", "BSD-3-Clause"),
139    ("similar", "Apache-2.0"),
140    ("sized-chunks", "MPL-2.0+"),
141    ("subtle", "BSD-3-Clause"),
142    ("supports-hyperlinks", "Apache-2.0"),
143    ("unicode-bom", "Apache-2.0"),
144    // tidy-alphabetical-end
145];
146
147const EXCEPTIONS_RUST_ANALYZER: ExceptionList = &[
148    // tidy-alphabetical-start
149    ("dissimilar", "Apache-2.0"),
150    ("notify", "CC0-1.0"),
151    ("option-ext", "MPL-2.0"),
152    ("pulldown-cmark-to-cmark", "Apache-2.0"),
153    ("rustc_apfloat", "Apache-2.0 WITH LLVM-exception"),
154    ("ryu", "Apache-2.0 OR BSL-1.0"), // BSL is not acceptble, but we use it under Apache-2.0
155    ("scip", "Apache-2.0"),
156    // tidy-alphabetical-end
157];
158
159const EXCEPTIONS_RUSTC_PERF: ExceptionList = &[
160    // tidy-alphabetical-start
161    ("alloc-no-stdlib", "BSD-3-Clause"),
162    ("alloc-stdlib", "BSD-3-Clause"),
163    ("brotli", "BSD-3-Clause/MIT"),
164    ("brotli-decompressor", "BSD-3-Clause/MIT"),
165    ("encoding_rs", "(Apache-2.0 OR MIT) AND BSD-3-Clause"),
166    ("inferno", "CDDL-1.0"),
167    ("instant", "BSD-3-Clause"),
168    ("ring", NON_STANDARD_LICENSE), // see EXCEPTIONS_NON_STANDARD_LICENSE_DEPS for more.
169    ("ryu", "Apache-2.0 OR BSL-1.0"),
170    ("snap", "BSD-3-Clause"),
171    ("subtle", "BSD-3-Clause"),
172    // tidy-alphabetical-end
173];
174
175const EXCEPTIONS_RUSTBOOK: ExceptionList = &[
176    // tidy-alphabetical-start
177    ("mdbook", "MPL-2.0"),
178    ("ryu", "Apache-2.0 OR BSL-1.0"),
179    // tidy-alphabetical-end
180];
181
182const EXCEPTIONS_CRANELIFT: ExceptionList = &[
183    // tidy-alphabetical-start
184    ("cranelift-assembler-x64", "Apache-2.0 WITH LLVM-exception"),
185    ("cranelift-assembler-x64-meta", "Apache-2.0 WITH LLVM-exception"),
186    ("cranelift-bforest", "Apache-2.0 WITH LLVM-exception"),
187    ("cranelift-bitset", "Apache-2.0 WITH LLVM-exception"),
188    ("cranelift-codegen", "Apache-2.0 WITH LLVM-exception"),
189    ("cranelift-codegen-meta", "Apache-2.0 WITH LLVM-exception"),
190    ("cranelift-codegen-shared", "Apache-2.0 WITH LLVM-exception"),
191    ("cranelift-control", "Apache-2.0 WITH LLVM-exception"),
192    ("cranelift-entity", "Apache-2.0 WITH LLVM-exception"),
193    ("cranelift-frontend", "Apache-2.0 WITH LLVM-exception"),
194    ("cranelift-isle", "Apache-2.0 WITH LLVM-exception"),
195    ("cranelift-jit", "Apache-2.0 WITH LLVM-exception"),
196    ("cranelift-module", "Apache-2.0 WITH LLVM-exception"),
197    ("cranelift-native", "Apache-2.0 WITH LLVM-exception"),
198    ("cranelift-object", "Apache-2.0 WITH LLVM-exception"),
199    ("foldhash", "Zlib"),
200    ("mach2", "BSD-2-Clause OR MIT OR Apache-2.0"),
201    ("regalloc2", "Apache-2.0 WITH LLVM-exception"),
202    ("target-lexicon", "Apache-2.0 WITH LLVM-exception"),
203    ("wasmtime-jit-icache-coherence", "Apache-2.0 WITH LLVM-exception"),
204    // tidy-alphabetical-end
205];
206
207const EXCEPTIONS_GCC: ExceptionList = &[
208    // tidy-alphabetical-start
209    ("gccjit", "GPL-3.0"),
210    ("gccjit_sys", "GPL-3.0"),
211    // tidy-alphabetical-end
212];
213
214const EXCEPTIONS_BOOTSTRAP: ExceptionList = &[
215    ("ryu", "Apache-2.0 OR BSL-1.0"), // through serde. BSL is not acceptble, but we use it under Apache-2.0
216];
217
218const EXCEPTIONS_UEFI_QEMU_TEST: ExceptionList = &[
219    ("r-efi", "MIT OR Apache-2.0 OR LGPL-2.1-or-later"), // LGPL is not acceptable, but we use it under MIT OR Apache-2.0
220];
221
222/// Placeholder for non-standard license file.
223const NON_STANDARD_LICENSE: &str = "NON_STANDARD_LICENSE";
224
225/// These dependencies have non-standard licenses but are genenrally permitted.
226const EXCEPTIONS_NON_STANDARD_LICENSE_DEPS: &[&str] = &[
227    // `ring` is included because it is an optional dependency of `hyper`,
228    // which is a training data in rustc-perf for optimized build.
229    // The license of it is generally `ISC AND MIT AND OpenSSL`,
230    // though the `package.license` field is not set.
231    //
232    // See https://github.com/briansmith/ring/issues/902
233    "ring",
234];
235
236const PERMITTED_DEPS_LOCATION: &str = concat!(file!(), ":", line!());
237
238/// Crates rustc is allowed to depend on. Avoid adding to the list if possible.
239///
240/// This list is here to provide a speed-bump to adding a new dependency to
241/// rustc. Please check with the compiler team before adding an entry.
242const PERMITTED_RUSTC_DEPENDENCIES: &[&str] = &[
243    // tidy-alphabetical-start
244    "adler2",
245    "aho-corasick",
246    "allocator-api2", // FIXME: only appears in Cargo.lock due to https://github.com/rust-lang/cargo/issues/10801
247    "annotate-snippets",
248    "anstyle",
249    "ar_archive_writer",
250    "arrayref",
251    "arrayvec",
252    "autocfg",
253    "bitflags",
254    "blake3",
255    "block-buffer",
256    "bstr",
257    "cc",
258    "cfg-if",
259    "cfg_aliases",
260    "constant_time_eq",
261    "cpufeatures",
262    "crc32fast",
263    "crossbeam-channel",
264    "crossbeam-deque",
265    "crossbeam-epoch",
266    "crossbeam-utils",
267    "crypto-common",
268    "ctrlc",
269    "darling",
270    "darling_core",
271    "darling_macro",
272    "datafrog",
273    "deranged",
274    "derive-where",
275    "derive_setters",
276    "digest",
277    "displaydoc",
278    "dissimilar",
279    "either",
280    "elsa",
281    "ena",
282    "equivalent",
283    "errno",
284    "expect-test",
285    "fallible-iterator", // dependency of `thorin`
286    "fastrand",
287    "flate2",
288    "fluent-bundle",
289    "fluent-langneg",
290    "fluent-syntax",
291    "fnv",
292    "foldhash",
293    "generic-array",
294    "getopts",
295    "getrandom",
296    "gimli",
297    "gsgdt",
298    "hashbrown",
299    "hermit-abi",
300    "icu_list",
301    "icu_list_data",
302    "icu_locid",
303    "icu_locid_transform",
304    "icu_locid_transform_data",
305    "icu_provider",
306    "icu_provider_adapters",
307    "icu_provider_macros",
308    "ident_case",
309    "indexmap",
310    "intl-memoizer",
311    "intl_pluralrules",
312    "itertools",
313    "itoa",
314    "jobserver",
315    "lazy_static",
316    "leb128",
317    "libc",
318    "libloading",
319    "linux-raw-sys",
320    "litemap",
321    "lock_api",
322    "log",
323    "matchers",
324    "md-5",
325    "measureme",
326    "memchr",
327    "memmap2",
328    "miniz_oxide",
329    "nix",
330    "nu-ansi-term",
331    "num-conv",
332    "num_cpus",
333    "object",
334    "odht",
335    "once_cell",
336    "overload",
337    "parking_lot",
338    "parking_lot_core",
339    "pathdiff",
340    "perf-event-open-sys",
341    "pin-project-lite",
342    "polonius-engine",
343    "portable-atomic", // dependency for platforms doesn't support `AtomicU64` in std
344    "powerfmt",
345    "ppv-lite86",
346    "proc-macro-hack",
347    "proc-macro2",
348    "psm",
349    "pulldown-cmark",
350    "pulldown-cmark-escape",
351    "punycode",
352    "quote",
353    "r-efi",
354    "rand",
355    "rand_chacha",
356    "rand_core",
357    "rand_xoshiro",
358    "redox_syscall",
359    "regex",
360    "regex-automata",
361    "regex-syntax",
362    "rustc-demangle",
363    "rustc-hash",
364    "rustc-rayon",
365    "rustc-rayon-core",
366    "rustc-stable-hash",
367    "rustc_apfloat",
368    "rustix",
369    "ruzstd", // via object in thorin-dwp
370    "ryu",
371    "scoped-tls",
372    "scopeguard",
373    "self_cell",
374    "serde",
375    "serde_derive",
376    "serde_json",
377    "sha1",
378    "sha2",
379    "sharded-slab",
380    "shlex",
381    "smallvec",
382    "stable_deref_trait",
383    "stacker",
384    "static_assertions",
385    "strsim",
386    "syn",
387    "synstructure",
388    "tempfile",
389    "termcolor",
390    "termize",
391    "thin-vec",
392    "thiserror",
393    "thiserror-impl",
394    "thorin-dwp",
395    "thread_local",
396    "tikv-jemalloc-sys",
397    "time",
398    "time-core",
399    "time-macros",
400    "tinystr",
401    "tinyvec",
402    "tinyvec_macros",
403    "tracing",
404    "tracing-attributes",
405    "tracing-core",
406    "tracing-log",
407    "tracing-subscriber",
408    "tracing-tree",
409    "twox-hash",
410    "type-map",
411    "typenum",
412    "unic-langid",
413    "unic-langid-impl",
414    "unic-langid-macros",
415    "unic-langid-macros-impl",
416    "unicase",
417    "unicode-ident",
418    "unicode-normalization",
419    "unicode-properties",
420    "unicode-script",
421    "unicode-security",
422    "unicode-width",
423    "unicode-xid",
424    "valuable",
425    "version_check",
426    "wasi",
427    "wasm-encoder",
428    "wasmparser",
429    "winapi",
430    "winapi-i686-pc-windows-gnu",
431    "winapi-util",
432    "winapi-x86_64-pc-windows-gnu",
433    "windows",
434    "windows-core",
435    "windows-implement",
436    "windows-interface",
437    "windows-link",
438    "windows-result",
439    "windows-strings",
440    "windows-sys",
441    "windows-targets",
442    "windows_aarch64_gnullvm",
443    "windows_aarch64_msvc",
444    "windows_i686_gnu",
445    "windows_i686_gnullvm",
446    "windows_i686_msvc",
447    "windows_x86_64_gnu",
448    "windows_x86_64_gnullvm",
449    "windows_x86_64_msvc",
450    "wit-bindgen-rt@0.39.0", // pinned to a specific version due to using a binary blob: <https://github.com/rust-lang/rust/pull/136395#issuecomment-2692769062>
451    "writeable",
452    "yoke",
453    "yoke-derive",
454    "zerocopy",
455    "zerocopy-derive",
456    "zerofrom",
457    "zerofrom-derive",
458    "zerovec",
459    "zerovec-derive",
460    // tidy-alphabetical-end
461];
462
463const PERMITTED_STDLIB_DEPENDENCIES: &[&str] = &[
464    // tidy-alphabetical-start
465    "addr2line",
466    "adler2",
467    "allocator-api2",
468    "cc",
469    "cfg-if",
470    "compiler_builtins",
471    "dlmalloc",
472    "fortanix-sgx-abi",
473    "getopts",
474    "gimli",
475    "hashbrown",
476    "hermit-abi",
477    "libc",
478    "memchr",
479    "miniz_oxide",
480    "object",
481    "proc-macro2",
482    "quote",
483    "r-efi",
484    "r-efi-alloc",
485    "rand",
486    "rand_core",
487    "rand_xorshift",
488    "rustc-demangle",
489    "shlex",
490    "syn",
491    "unicode-ident",
492    "unicode-width",
493    "unwinding",
494    "wasi",
495    "windows-sys",
496    "windows-targets",
497    "windows_aarch64_gnullvm",
498    "windows_aarch64_msvc",
499    "windows_i686_gnu",
500    "windows_i686_gnullvm",
501    "windows_i686_msvc",
502    "windows_x86_64_gnu",
503    "windows_x86_64_gnullvm",
504    "windows_x86_64_msvc",
505    "zerocopy",
506    "zerocopy-derive",
507    // tidy-alphabetical-end
508];
509
510const PERMITTED_CRANELIFT_DEPENDENCIES: &[&str] = &[
511    // tidy-alphabetical-start
512    "allocator-api2",
513    "anyhow",
514    "arbitrary",
515    "bitflags",
516    "bumpalo",
517    "cfg-if",
518    "cranelift-assembler-x64",
519    "cranelift-assembler-x64-meta",
520    "cranelift-bforest",
521    "cranelift-bitset",
522    "cranelift-codegen",
523    "cranelift-codegen-meta",
524    "cranelift-codegen-shared",
525    "cranelift-control",
526    "cranelift-entity",
527    "cranelift-frontend",
528    "cranelift-isle",
529    "cranelift-jit",
530    "cranelift-module",
531    "cranelift-native",
532    "cranelift-object",
533    "crc32fast",
534    "equivalent",
535    "fallible-iterator",
536    "foldhash",
537    "gimli",
538    "hashbrown",
539    "indexmap",
540    "libc",
541    "libloading",
542    "log",
543    "mach2",
544    "memchr",
545    "object",
546    "proc-macro2",
547    "quote",
548    "regalloc2",
549    "region",
550    "rustc-hash",
551    "serde",
552    "serde_derive",
553    "smallvec",
554    "stable_deref_trait",
555    "syn",
556    "target-lexicon",
557    "unicode-ident",
558    "wasmtime-jit-icache-coherence",
559    "windows-sys",
560    "windows-targets",
561    "windows_aarch64_gnullvm",
562    "windows_aarch64_msvc",
563    "windows_i686_gnu",
564    "windows_i686_gnullvm",
565    "windows_i686_msvc",
566    "windows_x86_64_gnu",
567    "windows_x86_64_gnullvm",
568    "windows_x86_64_msvc",
569    // tidy-alphabetical-end
570];
571
572/// Dependency checks.
573///
574/// `root` is path to the directory with the root `Cargo.toml` (for the workspace). `cargo` is path
575/// to the cargo executable.
576pub fn check(root: &Path, cargo: &Path, bless: bool, bad: &mut bool) {
577    let mut checked_runtime_licenses = false;
578
579    check_proc_macro_dep_list(root, cargo, bless, bad);
580
581    for &(workspace, exceptions, permitted_deps, submodules) in WORKSPACES {
582        if has_missing_submodule(root, submodules) {
583            continue;
584        }
585
586        if !root.join(workspace).join("Cargo.lock").exists() {
587            tidy_error!(bad, "the `{workspace}` workspace doesn't have a Cargo.lock");
588            continue;
589        }
590
591        let mut cmd = cargo_metadata::MetadataCommand::new();
592        cmd.cargo_path(cargo)
593            .manifest_path(root.join(workspace).join("Cargo.toml"))
594            .features(cargo_metadata::CargoOpt::AllFeatures)
595            .other_options(vec!["--locked".to_owned()]);
596        let metadata = t!(cmd.exec());
597
598        check_license_exceptions(&metadata, exceptions, bad);
599        if let Some((crates, permitted_deps)) = permitted_deps {
600            check_permitted_dependencies(&metadata, workspace, permitted_deps, crates, bad);
601        }
602
603        if workspace == "library" {
604            check_runtime_license_exceptions(&metadata, bad);
605            checked_runtime_licenses = true;
606        }
607    }
608
609    // Sanity check to ensure we don't accidentally remove the workspace containing the runtime
610    // crates.
611    assert!(checked_runtime_licenses);
612}
613
614/// Ensure the list of proc-macro crate transitive dependencies is up to date
615fn check_proc_macro_dep_list(root: &Path, cargo: &Path, bless: bool, bad: &mut bool) {
616    let mut cmd = cargo_metadata::MetadataCommand::new();
617    cmd.cargo_path(cargo)
618        .manifest_path(root.join("Cargo.toml"))
619        .features(cargo_metadata::CargoOpt::AllFeatures)
620        .other_options(vec!["--locked".to_owned()]);
621    let metadata = t!(cmd.exec());
622    let is_proc_macro_pkg = |pkg: &Package| pkg.targets.iter().any(|target| target.is_proc_macro());
623
624    let mut proc_macro_deps = HashSet::new();
625    for pkg in metadata.packages.iter().filter(|pkg| is_proc_macro_pkg(*pkg)) {
626        deps_of(&metadata, &pkg.id, &mut proc_macro_deps);
627    }
628    // Remove the proc-macro crates themselves
629    proc_macro_deps.retain(|pkg| !is_proc_macro_pkg(&metadata[pkg]));
630
631    let proc_macro_deps: HashSet<_> =
632        proc_macro_deps.into_iter().map(|dep| metadata[dep].name.clone()).collect();
633    let expected = proc_macro_deps::CRATES.iter().map(|s| s.to_string()).collect::<HashSet<_>>();
634
635    let needs_blessing = proc_macro_deps.difference(&expected).next().is_some()
636        || expected.difference(&proc_macro_deps).next().is_some();
637
638    if needs_blessing && bless {
639        let mut proc_macro_deps: Vec<_> = proc_macro_deps.into_iter().collect();
640        proc_macro_deps.sort();
641        let mut file = File::create(root.join("src/bootstrap/src/utils/proc_macro_deps.rs"))
642            .expect("`proc_macro_deps` should exist");
643        writeln!(
644            &mut file,
645            "/// Do not update manually - use `./x.py test tidy --bless`
646/// Holds all direct and indirect dependencies of proc-macro crates in tree.
647/// See <https://github.com/rust-lang/rust/issues/134863>
648pub static CRATES: &[&str] = &[
649    // tidy-alphabetical-start"
650        )
651        .unwrap();
652        for dep in proc_macro_deps {
653            writeln!(&mut file, "    {dep:?},").unwrap();
654        }
655        writeln!(
656            &mut file,
657            "    // tidy-alphabetical-end
658];"
659        )
660        .unwrap();
661    } else {
662        let old_bad = *bad;
663
664        for missing in proc_macro_deps.difference(&expected) {
665            tidy_error!(
666                bad,
667                "proc-macro crate dependency `{missing}` is not registered in `src/bootstrap/src/utils/proc_macro_deps.rs`",
668            );
669        }
670        for extra in expected.difference(&proc_macro_deps) {
671            tidy_error!(
672                bad,
673                "`{extra}` is registered in `src/bootstrap/src/utils/proc_macro_deps.rs`, but is not a proc-macro crate dependency",
674            );
675        }
676        if *bad != old_bad {
677            eprintln!("Run `./x.py test tidy --bless` to regenerate the list");
678        }
679    }
680}
681
682/// Used to skip a check if a submodule is not checked out, and not in a CI environment.
683///
684/// This helps prevent enforcing developers to fetch submodules for tidy.
685pub fn has_missing_submodule(root: &Path, submodules: &[&str]) -> bool {
686    !CiEnv::is_ci()
687        && submodules.iter().any(|submodule| {
688            // If the directory is empty, we can consider it as an uninitialized submodule.
689            read_dir(root.join(submodule)).unwrap().next().is_none()
690        })
691}
692
693/// Check that all licenses of runtime dependencies are in the valid list in `LICENSES`.
694///
695/// Unlike for tools we don't allow exceptions to the `LICENSES` list for the runtime with the sole
696/// exception of `fortanix-sgx-abi` which is only used on x86_64-fortanix-unknown-sgx.
697fn check_runtime_license_exceptions(metadata: &Metadata, bad: &mut bool) {
698    for pkg in &metadata.packages {
699        if pkg.source.is_none() {
700            // No need to check local packages.
701            continue;
702        }
703        let license = match &pkg.license {
704            Some(license) => license,
705            None => {
706                tidy_error!(bad, "dependency `{}` does not define a license expression", pkg.id);
707                continue;
708            }
709        };
710        if !LICENSES.contains(&license.as_str()) {
711            // This is a specific exception because SGX is considered "third party".
712            // See https://github.com/rust-lang/rust/issues/62620 for more.
713            // In general, these should never be added and this exception
714            // should not be taken as precedent for any new target.
715            if pkg.name == "fortanix-sgx-abi" && pkg.license.as_deref() == Some("MPL-2.0") {
716                continue;
717            }
718
719            tidy_error!(bad, "invalid license `{}` in `{}`", license, pkg.id);
720        }
721    }
722}
723
724/// Check that all licenses of tool dependencies are in the valid list in `LICENSES`.
725///
726/// Packages listed in `exceptions` are allowed for tools.
727fn check_license_exceptions(metadata: &Metadata, exceptions: &[(&str, &str)], bad: &mut bool) {
728    // Validate the EXCEPTIONS list hasn't changed.
729    for (name, license) in exceptions {
730        // Check that the package actually exists.
731        if !metadata.packages.iter().any(|p| p.name == *name) {
732            tidy_error!(
733                bad,
734                "could not find exception package `{}`\n\
735                Remove from EXCEPTIONS list if it is no longer used.",
736                name
737            );
738        }
739        // Check that the license hasn't changed.
740        for pkg in metadata.packages.iter().filter(|p| p.name == *name) {
741            match &pkg.license {
742                None => {
743                    if *license == NON_STANDARD_LICENSE
744                        && EXCEPTIONS_NON_STANDARD_LICENSE_DEPS.contains(&pkg.name.as_str())
745                    {
746                        continue;
747                    }
748                    tidy_error!(
749                        bad,
750                        "dependency exception `{}` does not declare a license expression",
751                        pkg.id
752                    );
753                }
754                Some(pkg_license) => {
755                    if pkg_license.as_str() != *license {
756                        println!("dependency exception `{name}` license has changed");
757                        println!("    previously `{license}` now `{pkg_license}`");
758                        println!("    update EXCEPTIONS for the new license");
759                        *bad = true;
760                    }
761                }
762            }
763        }
764    }
765
766    let exception_names: Vec<_> = exceptions.iter().map(|(name, _license)| *name).collect();
767
768    // Check if any package does not have a valid license.
769    for pkg in &metadata.packages {
770        if pkg.source.is_none() {
771            // No need to check local packages.
772            continue;
773        }
774        if exception_names.contains(&pkg.name.as_str()) {
775            continue;
776        }
777        let license = match &pkg.license {
778            Some(license) => license,
779            None => {
780                tidy_error!(bad, "dependency `{}` does not define a license expression", pkg.id);
781                continue;
782            }
783        };
784        if !LICENSES.contains(&license.as_str()) {
785            tidy_error!(bad, "invalid license `{}` in `{}`", license, pkg.id);
786        }
787    }
788}
789
790/// Checks the dependency of `restricted_dependency_crates` at the given path. Changes `bad` to
791/// `true` if a check failed.
792///
793/// Specifically, this checks that the dependencies are on the `permitted_dependencies`.
794fn check_permitted_dependencies(
795    metadata: &Metadata,
796    descr: &str,
797    permitted_dependencies: &[&'static str],
798    restricted_dependency_crates: &[&'static str],
799    bad: &mut bool,
800) {
801    let mut has_permitted_dep_error = false;
802    let mut deps = HashSet::new();
803    for to_check in restricted_dependency_crates {
804        let to_check = pkg_from_name(metadata, to_check);
805        deps_of(metadata, &to_check.id, &mut deps);
806    }
807
808    // Check that the PERMITTED_DEPENDENCIES does not have unused entries.
809    for permitted in permitted_dependencies {
810        fn compare(pkg: &Package, permitted: &str) -> bool {
811            if let Some((name, version)) = permitted.split_once("@") {
812                let Ok(version) = Version::parse(version) else {
813                    return false;
814                };
815                pkg.name == name && pkg.version == version
816            } else {
817                pkg.name == permitted
818            }
819        }
820        if !deps.iter().any(|dep_id| compare(pkg_from_id(metadata, dep_id), permitted)) {
821            tidy_error!(
822                bad,
823                "could not find allowed package `{permitted}`\n\
824                Remove from PERMITTED_DEPENDENCIES list if it is no longer used.",
825            );
826            has_permitted_dep_error = true;
827        }
828    }
829
830    // Get in a convenient form.
831    let permitted_dependencies: HashMap<_, _> = permitted_dependencies
832        .iter()
833        .map(|s| {
834            if let Some((name, version)) = s.split_once('@') {
835                (name, Version::parse(version).ok())
836            } else {
837                (*s, None)
838            }
839        })
840        .collect();
841
842    for dep in deps {
843        let dep = pkg_from_id(metadata, dep);
844        // If this path is in-tree, we don't require it to be explicitly permitted.
845        if dep.source.is_some() {
846            let is_eq = if let Some(version) = permitted_dependencies.get(dep.name.as_str()) {
847                if let Some(version) = version { version == &dep.version } else { true }
848            } else {
849                false
850            };
851            if !is_eq {
852                tidy_error!(bad, "Dependency for {descr} not explicitly permitted: {}", dep.id);
853                has_permitted_dep_error = true;
854            }
855        }
856    }
857
858    if has_permitted_dep_error {
859        eprintln!("Go to `{PERMITTED_DEPS_LOCATION}` for the list.");
860    }
861}
862
863/// Finds a package with the given name.
864fn pkg_from_name<'a>(metadata: &'a Metadata, name: &'static str) -> &'a Package {
865    let mut i = metadata.packages.iter().filter(|p| p.name == name);
866    let result =
867        i.next().unwrap_or_else(|| panic!("could not find package `{name}` in package list"));
868    assert!(i.next().is_none(), "more than one package found for `{name}`");
869    result
870}
871
872fn pkg_from_id<'a>(metadata: &'a Metadata, id: &PackageId) -> &'a Package {
873    metadata.packages.iter().find(|p| &p.id == id).unwrap()
874}
875
876/// Recursively find all dependencies.
877fn deps_of<'a>(metadata: &'a Metadata, pkg_id: &'a PackageId, result: &mut HashSet<&'a PackageId>) {
878    if !result.insert(pkg_id) {
879        return;
880    }
881    let node = metadata
882        .resolve
883        .as_ref()
884        .unwrap()
885        .nodes
886        .iter()
887        .find(|n| &n.id == pkg_id)
888        .unwrap_or_else(|| panic!("could not find `{pkg_id}` in resolve"));
889    for dep in &node.deps {
890        deps_of(metadata, &dep.pkg, result);
891    }
892}
tidy/deps.rs

tidy/
deps.rs
