Restrict sysroot crate imports to those defined in this repo.

It's common to import dependencies from the sysroot via `extern crate` rather than use an explicit cargo dependency, when it's necessary to use the same dependency version as used by rustc itself. However, this is dangerous for crates.io crates, since rustc may not pull in the dependency on some targets, or may pull in multiple versions. In both cases, the `extern crate` fails to resolve. To address this, re-export all such dependencies from the appropriate `rustc_*` crates, and use this alias from crates which would otherwise need to use `extern crate`.

Author: Diggsey

compiler/rustc_codegen_cranelift/src/lib.rs

@@ -26,13 +26,12 @@ extern crate rustc_fs_util;
 extern crate rustc_hir;
 extern crate rustc_incremental;
 extern crate rustc_index;
+extern crate rustc_log;
 extern crate rustc_metadata;
 extern crate rustc_session;
 extern crate rustc_span;
 extern crate rustc_symbol_mangling;
 extern crate rustc_target;
-#[macro_use]
-extern crate tracing;
 
 // This prevents duplicating functions and statics that are already part of the host rustc process.
 #[allow(unused_extern_crates)]
@@ -46,6 +45,7 @@ use cranelift_codegen::isa::TargetIsa;
 use cranelift_codegen::settings::{self, Configurable};
 use rustc_codegen_ssa::traits::CodegenBackend;
 use rustc_codegen_ssa::{CodegenResults, TargetConfig};
+use rustc_log::tracing::info;
 use rustc_middle::dep_graph::{WorkProduct, WorkProductId};
 use rustc_session::Session;
 use rustc_session::config::OutputFilenames;

compiler/rustc_codegen_gcc/src/back/lto.rs

@@ -32,6 +32,7 @@ use rustc_codegen_ssa::{ModuleCodegen, ModuleKind, looks_like_rust_object_file};
 use rustc_data_structures::memmap::Mmap;
 use rustc_errors::{DiagCtxtHandle, FatalError};
 use rustc_hir::def_id::LOCAL_CRATE;
+use rustc_log::tracing::info;
 use rustc_middle::bug;
 use rustc_middle::dep_graph::WorkProduct;
 use rustc_middle::middle::exported_symbols::{SymbolExportInfo, SymbolExportLevel};

compiler/rustc_codegen_gcc/src/back/write.rs

@@ -6,6 +6,7 @@ use rustc_codegen_ssa::back::write::{BitcodeSection, CodegenContext, EmitObj, Mo
 use rustc_codegen_ssa::{CompiledModule, ModuleCodegen};
 use rustc_errors::DiagCtxtHandle;
 use rustc_fs_util::link_or_copy;
+use rustc_log::tracing::debug;
 use rustc_session::config::OutputType;
 use rustc_span::fatal_error::FatalError;
 use rustc_target::spec::SplitDebuginfo;

compiler/rustc_codegen_gcc/src/consts.rs

@@ -6,6 +6,7 @@ use rustc_codegen_ssa::traits::{
  BaseTypeCodegenMethods, ConstCodegenMethods, StaticCodegenMethods,
 };
 use rustc_hir::def::DefKind;
+use rustc_log::tracing::trace;
 use rustc_middle::middle::codegen_fn_attrs::{CodegenFnAttrFlags, CodegenFnAttrs};
 use rustc_middle::mir::interpret::{
  self, ConstAllocation, ErrorHandled, Scalar as InterpScalar, read_target_uint,

compiler/rustc_codegen_gcc/src/gcc_util.rs

@@ -1,8 +1,8 @@
 #[cfg(feature = "master")]
 use gccjit::Context;
 use rustc_codegen_ssa::target_features;
+use rustc_data_structures::smallvec::{SmallVec, smallvec};
 use rustc_session::Session;
-use smallvec::{SmallVec, smallvec};
 
 fn gcc_features_by_flags(sess: &Session, features: &mut Vec<String>) {
  target_features::retpoline_features_by_flags(sess, features);

compiler/rustc_codegen_gcc/src/lib.rs

@@ -25,12 +25,6 @@
 #![deny(clippy::pattern_type_mismatch)]
 #![allow(clippy::needless_lifetimes, clippy::uninlined_format_args)]
 
-// These crates are pulled from the sysroot because they are part of
-// rustc's public API, so we need to ensure version compatibility.
-extern crate smallvec;
-#[macro_use]
-extern crate tracing;
-
 // The rustc crates we need
 extern crate rustc_abi;
 extern crate rustc_apfloat;
@@ -45,6 +39,7 @@ extern crate rustc_hir;
 extern crate rustc_index;
 #[cfg(feature = "master")]
 extern crate rustc_interface;
+extern crate rustc_log;
 extern crate rustc_macros;
 extern crate rustc_middle;
 extern crate rustc_session;

compiler/rustc_data_structures/src/lib.rs

@@ -43,6 +43,8 @@ use std::fmt;
 pub use atomic_ref::AtomicRef;
 pub use ena::{snapshot_vec, undo_log, unify};
 pub use rustc_index::static_assert_size;
+// Re-export some data-structure crates which are part of our public API.
+pub use {either, indexmap, smallvec, thin_vec};
 
 pub mod aligned;
 pub mod base_n;

compiler/rustc_lint/messages.ftl

@@ -207,6 +207,9 @@ lint_confusable_identifier_pair = found both `{$existing_sym}` and `{$sym}` as i
 
 lint_custom_inner_attribute_unstable = custom inner attributes are unstable
 
+lint_dangerous_extern_crate = dangerous use of `extern crate {$name}` which is not guaranteed to exist exactly once in the sysroot
+ .help = try using a cargo dependency or using a re-export of the dependency provided by a rustc_* crate
+
 lint_dangling_pointers_from_temporaries = a dangling pointer will be produced because the temporary `{$ty}` will be dropped
  .label_ptr = this pointer will immediately be invalid
  .label_temporary = this `{$ty}` is deallocated at the end of the statement, bind it to a variable to extend its lifetime

compiler/rustc_lint/src/internal.rs

@@ -12,10 +12,10 @@ use tracing::debug;
 use {rustc_ast as ast, rustc_hir as hir};
 
 use crate::lints::{
- BadOptAccessDiag, DefaultHashTypesDiag, DiagOutOfImpl, LintPassByHand,
- NonGlobImportTypeIrInherent, QueryInstability, QueryUntracked, SpanUseEqCtxtDiag,
- SymbolInternStringLiteralDiag, TyQualified, TykindDiag, TykindKind, TypeIrDirectUse,
- TypeIrInherentUsage, TypeIrTraitUsage, UntranslatableDiag,
+ BadOptAccessDiag, DangerousExternCrateDiag, DefaultHashTypesDiag, DiagOutOfImpl,
+ LintPassByHand, NonGlobImportTypeIrInherent, QueryInstability, QueryUntracked,
+ SpanUseEqCtxtDiag, SymbolInternStringLiteralDiag, TyQualified, TykindDiag, TykindKind,
+ TypeIrDirectUse, TypeIrInherentUsage, TypeIrTraitUsage, UntranslatableDiag,
 };
 use crate::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
 
@@ -703,3 +703,37 @@ impl<'tcx> LateLintPass<'tcx> for SymbolInternStringLiteral {
  }
  }
 }
+
+declare_tool_lint! {
+ /// The `dangerous_extern_crate` detects use of `extern crate` to import non-whitelisted crates
+ /// from the sysroot, which is dangerous because these crates are not guaranteed to exist
+ /// exactly once, and so may be missing entirely or appear multiple times resulting in ambiguity.
+ pub rustc::DANGEROUS_EXTERN_CRATE,
+ Deny,
+ "Forbid uses of non-whitelisted crates in `extern crate`",
+ report_in_external_macro: true
+}
+
+declare_lint_pass!(DangerousExternCrate => [DANGEROUS_EXTERN_CRATE]);
+
+impl EarlyLintPass for DangerousExternCrate {
+ fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
+ fn is_whitelisted(crate_name: &str) -> bool {
+ // Whitelist of allowed crates.
+ crate_name.starts_with("rustc_")
+ || matches!(crate_name, "test" | "self" | "core" | "alloc" | "std" | "mini_core")
+ }
+
+ if let ast::ItemKind::ExternCrate(original_name, imported_name) = &item.kind {
+ let name = original_name.as_ref().unwrap_or(&imported_name.name).as_str();
+ let externs = &cx.builder.sess().opts.externs;
+ if externs.get(name).is_none() && !is_whitelisted(name) {
+ cx.emit_span_lint(
+ DANGEROUS_EXTERN_CRATE,
+ item.span,
+ DangerousExternCrateDiag { name },
+ );
+ }
+ }
+ }
+}

compiler/rustc_lint/src/lib.rs

@@ -648,6 +648,8 @@ fn register_internals(store: &mut LintStore) {
  store.register_late_mod_pass(|_| Box::new(SpanUseEqCtxt));
  store.register_lints(&SymbolInternStringLiteral::lint_vec());
  store.register_late_mod_pass(|_| Box::new(SymbolInternStringLiteral));
+ store.register_lints(&DangerousExternCrate::lint_vec());
+ store.register_early_pass(|| Box::new(DangerousExternCrate));
  // FIXME(davidtwco): deliberately do not include `UNTRANSLATABLE_DIAGNOSTIC` and
  // `DIAGNOSTIC_OUTSIDE_OF_IMPL` here because `-Wrustc::internal` is provided to every crate and
  // these lints will trigger all of the time - change this once migration to diagnostic structs
@@ -670,6 +672,7 @@ fn register_internals(store: &mut LintStore) {
  LintId::of(BAD_OPT_ACCESS),
  LintId::of(SPAN_USE_EQ_CTXT),
  LintId::of(DIRECT_USE_OF_RUSTC_TYPE_IR),
+ LintId::of(DANGEROUS_EXTERN_CRATE),
  ],
  );
 }