1 use rustc_attr as attr;
2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::{self, Lrc};
4 use rustc_driver::abort_on_err;
5 use rustc_errors::emitter::{Emitter, EmitterWriter};
6 use rustc_errors::json::JsonEmitter;
7 use rustc_feature::UnstableFeatures;
8 use rustc_hir::def::{Namespace::TypeNS, Res};
9 use rustc_hir::def_id::{CrateNum, DefId, DefIndex, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
12 intravisit::{self, NestedVisitorMap, Visitor},
15 use rustc_interface::interface;
16 use rustc_middle::hir::map::Map;
17 use rustc_middle::middle::cstore::CrateStore;
18 use rustc_middle::middle::privacy::AccessLevels;
19 use rustc_middle::ty::{Ty, TyCtxt};
20 use rustc_resolve as resolve;
21 use rustc_session::config::{self, CrateType, ErrorOutputType};
22 use rustc_session::lint;
23 use rustc_session::DiagnosticOutput;
24 use rustc_session::Session;
25 use rustc_span::source_map;
26 use rustc_span::symbol::sym;
27 use rustc_span::DUMMY_SP;
29 use std::cell::RefCell;
34 use crate::clean::{AttributesExt, MAX_DEF_ID};
35 use crate::config::{Options as RustdocOptions, RenderOptions};
36 use crate::config::{OutputFormat, RenderInfo};
37 use crate::passes::{self, Condition::*, ConditionalPass};
39 pub use rustc_session::config::{CodegenOptions, DebuggingOptions, Input, Options};
40 pub use rustc_session::search_paths::SearchPath;
42 pub type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
44 pub struct DocContext<'tcx> {
45 pub tcx: TyCtxt<'tcx>,
46 pub resolver: Rc<RefCell<interface::BoxedResolver>>,
47 /// Later on moved into `CACHE_KEY`
48 pub renderinfo: RefCell<RenderInfo>,
49 /// Later on moved through `clean::Crate` into `CACHE_KEY`
50 pub external_traits: Rc<RefCell<FxHashMap<DefId, clean::Trait>>>,
51 /// Used while populating `external_traits` to ensure we don't process the same trait twice at
53 pub active_extern_traits: RefCell<FxHashSet<DefId>>,
54 // The current set of type and lifetime substitutions,
55 // for expanding type aliases at the HIR level:
56 /// Table `DefId` of type parameter -> substituted type
57 pub ty_substs: RefCell<FxHashMap<DefId, clean::Type>>,
58 /// Table `DefId` of lifetime parameter -> substituted lifetime
59 pub lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
60 /// Table `DefId` of const parameter -> substituted const
61 pub ct_substs: RefCell<FxHashMap<DefId, clean::Constant>>,
62 /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
63 pub impl_trait_bounds: RefCell<FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>>,
64 pub fake_def_ids: RefCell<FxHashMap<CrateNum, DefId>>,
65 pub all_fake_def_ids: RefCell<FxHashSet<DefId>>,
66 /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
67 // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
68 pub generated_synthetics: RefCell<FxHashSet<(Ty<'tcx>, DefId)>>,
69 pub auto_traits: Vec<DefId>,
70 /// The options given to rustdoc that could be relevant to a pass.
71 pub render_options: RenderOptions,
72 /// The traits in scope for a given module.
74 /// See `collect_intra_doc_links::traits_implemented_by` for more details.
75 /// `map<module, set<trait>>`
76 pub module_trait_cache: RefCell<FxHashMap<DefId, FxHashSet<DefId>>>,
79 impl<'tcx> DocContext<'tcx> {
80 pub fn sess(&self) -> &Session {
84 pub fn enter_resolver<F, R>(&self, f: F) -> R
86 F: FnOnce(&mut resolve::Resolver<'_>) -> R,
88 self.resolver.borrow_mut().access(f)
91 /// Call the closure with the given parameters set as
92 /// the substitutions for a type alias' RHS.
93 pub fn enter_alias<F, R>(
95 ty_substs: FxHashMap<DefId, clean::Type>,
96 lt_substs: FxHashMap<DefId, clean::Lifetime>,
97 ct_substs: FxHashMap<DefId, clean::Constant>,
103 let (old_tys, old_lts, old_cts) = (
104 mem::replace(&mut *self.ty_substs.borrow_mut(), ty_substs),
105 mem::replace(&mut *self.lt_substs.borrow_mut(), lt_substs),
106 mem::replace(&mut *self.ct_substs.borrow_mut(), ct_substs),
109 *self.ty_substs.borrow_mut() = old_tys;
110 *self.lt_substs.borrow_mut() = old_lts;
111 *self.ct_substs.borrow_mut() = old_cts;
115 // This is an ugly hack, but it's the simplest way to handle synthetic impls without greatly
116 // refactoring either librustdoc or librustc_middle. In particular, allowing new DefIds to be
117 // registered after the AST is constructed would require storing the defid mapping in a
118 // RefCell, decreasing the performance for normal compilation for very little gain.
120 // Instead, we construct 'fake' def ids, which start immediately after the last DefId.
121 // In the Debug impl for clean::Item, we explicitly check for fake
122 // def ids, as we'll end up with a panic if we use the DefId Debug impl for fake DefIds
123 pub fn next_def_id(&self, crate_num: CrateNum) -> DefId {
125 let num_def_ids = if crate_num == LOCAL_CRATE {
126 self.tcx.hir().definitions().def_path_table().num_def_ids()
128 self.enter_resolver(|r| r.cstore().num_def_ids(crate_num))
131 DefId { krate: crate_num, index: DefIndex::from_usize(num_def_ids) }
134 let mut fake_ids = self.fake_def_ids.borrow_mut();
136 let def_id = *fake_ids.entry(crate_num).or_insert(start_def_id);
139 DefId { krate: crate_num, index: DefIndex::from(def_id.index.index() + 1) },
142 MAX_DEF_ID.with(|m| {
143 m.borrow_mut().entry(def_id.krate).or_insert(start_def_id);
146 self.all_fake_def_ids.borrow_mut().insert(def_id);
151 /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
152 /// (This avoids a slice-index-out-of-bounds panic.)
153 pub fn as_local_hir_id(&self, def_id: DefId) -> Option<HirId> {
154 if self.all_fake_def_ids.borrow().contains(&def_id) {
157 def_id.as_local().map(|def_id| self.tcx.hir().local_def_id_to_hir_id(def_id))
161 pub fn stability(&self, id: HirId) -> Option<attr::Stability> {
164 .opt_local_def_id(id)
165 .and_then(|def_id| self.tcx.lookup_stability(def_id.to_def_id()))
169 pub fn deprecation(&self, id: HirId) -> Option<attr::Deprecation> {
172 .opt_local_def_id(id)
173 .and_then(|def_id| self.tcx.lookup_deprecation(def_id.to_def_id()))
177 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
179 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
180 /// will be created for the handler.
182 error_format: ErrorOutputType,
183 source_map: Option<Lrc<source_map::SourceMap>>,
184 debugging_opts: &DebuggingOptions,
185 ) -> rustc_errors::Handler {
186 let emitter: Box<dyn Emitter + sync::Send> = match error_format {
187 ErrorOutputType::HumanReadable(kind) => {
188 let (short, color_config) = kind.unzip();
190 EmitterWriter::stderr(
192 source_map.map(|sm| sm as _),
194 debugging_opts.teach,
195 debugging_opts.terminal_width,
198 .ui_testing(debugging_opts.ui_testing),
201 ErrorOutputType::Json { pretty, json_rendered } => {
202 let source_map = source_map.unwrap_or_else(|| {
203 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
211 debugging_opts.terminal_width,
214 .ui_testing(debugging_opts.ui_testing),
219 rustc_errors::Handler::with_emitter_and_flags(
221 debugging_opts.diagnostic_handler_flags(true),
225 /// This function is used to setup the lint initialization. By default, in rustdoc, everything
226 /// is "allowed". Depending if we run in test mode or not, we want some of them to be at their
227 /// default level. For example, the "INVALID_CODEBLOCK_ATTRIBUTES" lint is activated in both
230 /// A little detail easy to forget is that there is a way to set the lint level for all lints
231 /// through the "WARNINGS" lint. To prevent this to happen, we set it back to its "normal" level
232 /// inside this function.
234 /// It returns a tuple containing:
235 /// * Vector of tuples of lints' name and their associated "max" level
236 /// * HashMap of lint id with their associated "max" level
237 pub(crate) fn init_lints<F>(
238 mut allowed_lints: Vec<String>,
239 lint_opts: Vec<(String, lint::Level)>,
241 ) -> (Vec<(String, lint::Level)>, FxHashMap<lint::LintId, lint::Level>)
243 F: Fn(&lint::Lint) -> Option<(String, lint::Level)>,
245 let warnings_lint_name = lint::builtin::WARNINGS.name;
247 allowed_lints.push(warnings_lint_name.to_owned());
248 allowed_lints.extend(lint_opts.iter().map(|(lint, _)| lint).cloned());
251 lint::builtin::HardwiredLints::get_lints()
253 .chain(rustc_lint::SoftLints::get_lints().into_iter())
256 let lint_opts = lints()
258 // Permit feature-gated lints to avoid feature errors when trying to
260 if lint.feature_gate.is_some() || allowed_lints.iter().any(|l| lint.name == l) {
266 .chain(lint_opts.into_iter())
267 .collect::<Vec<_>>();
269 let lint_caps = lints()
271 // We don't want to allow *all* lints so let's ignore
273 if allowed_lints.iter().any(|l| lint.name == l) {
276 Some((lint::LintId::of(lint), lint::Allow))
280 (lint_opts, lint_caps)
284 options: RustdocOptions,
285 ) -> (clean::Crate, RenderInfo, RenderOptions, Lrc<Session>) {
286 // Parse, resolve, and typecheck the given crate.
312 let extern_names: Vec<String> = externs
314 .filter(|(_, entry)| entry.add_prelude)
315 .map(|(name, _)| name)
319 // Add the doc cfg into the doc build.
320 cfgs.push("doc".to_string());
322 let cpath = Some(input.clone());
323 let input = Input::File(input);
325 let intra_link_resolution_failure_name = lint::builtin::BROKEN_INTRA_DOC_LINKS.name;
326 let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
327 let missing_doc_example = rustc_lint::builtin::MISSING_DOC_CODE_EXAMPLES.name;
328 let private_doc_tests = rustc_lint::builtin::PRIVATE_DOC_TESTS.name;
329 let no_crate_level_docs = rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS.name;
330 let invalid_codeblock_attributes_name = rustc_lint::builtin::INVALID_CODEBLOCK_ATTRIBUTES.name;
331 let renamed_and_removed_lints = rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name;
332 let unknown_lints = rustc_lint::builtin::UNKNOWN_LINTS.name;
334 // In addition to those specific lints, we also need to allow those given through
335 // command line, otherwise they'll get ignored and we don't want that.
336 let lints_to_show = vec![
337 intra_link_resolution_failure_name.to_owned(),
338 missing_docs.to_owned(),
339 missing_doc_example.to_owned(),
340 private_doc_tests.to_owned(),
341 no_crate_level_docs.to_owned(),
342 invalid_codeblock_attributes_name.to_owned(),
343 renamed_and_removed_lints.to_owned(),
344 unknown_lints.to_owned(),
347 let (lint_opts, lint_caps) = init_lints(lints_to_show, lint_opts, |lint| {
348 if lint.name == intra_link_resolution_failure_name
349 || lint.name == invalid_codeblock_attributes_name
353 Some((lint.name_lower(), lint::Allow))
358 if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
359 // plays with error output here!
360 let sessopts = config::Options {
364 lint_opts: if !display_warnings { lint_opts } else { vec![] },
368 target_triple: target,
369 unstable_features: UnstableFeatures::from_environment(),
370 actually_rustdoc: true,
378 let config = interface::Config {
380 crate_cfg: interface::parse_cfgspecs(cfgs),
386 diagnostic_output: DiagnosticOutput::Default,
390 register_lints: None,
391 override_queries: Some(|_sess, providers, _external_providers| {
392 // Most lints will require typechecking, so just don't run them.
393 providers.lint_mod = |_, _| {};
394 // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
395 providers.typeck_item_bodies = |_, _| {};
396 // hack so that `used_trait_imports` won't try to call typeck
397 providers.used_trait_imports = |_, _| {
399 static ref EMPTY_SET: FxHashSet<LocalDefId> = FxHashSet::default();
403 // In case typeck does end up being called, don't ICE in case there were name resolution errors
404 providers.typeck = move |tcx, def_id| {
405 // Closures' tables come from their outermost function,
406 // as they are part of the same "inference environment".
407 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
408 let outer_def_id = tcx.closure_base_def_id(def_id.to_def_id()).expect_local();
409 if outer_def_id != def_id {
410 return tcx.typeck(outer_def_id);
414 let body = hir.body(hir.body_owned_by(hir.local_def_id_to_hir_id(def_id)));
415 debug!("visiting body for {:?}", def_id);
416 tcx.sess.time("emit_ignored_resolution_errors", || {
417 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
419 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
422 make_codegen_backend: None,
423 registry: rustc_driver::diagnostics_registry(),
426 interface::create_compiler_and_run(config, |compiler| {
427 compiler.enter(|queries| {
428 let sess = compiler.session();
430 // We need to hold on to the complete resolver, so we cause everything to be
431 // cloned for the analysis passes to use. Suboptimal, but necessary in the
432 // current architecture.
434 let parts = abort_on_err(queries.expansion(), sess).peek();
435 let resolver = parts.1.borrow();
437 // Before we actually clone it, let's force all the extern'd crates to
438 // actually be loaded, just in case they're only referred to inside
440 resolver.borrow_mut().access(|resolver| {
441 sess.time("load_extern_crates", || {
442 for extern_name in &extern_names {
443 debug!("loading extern crate {}", extern_name);
445 .resolve_str_path_error(
449 LocalDefId { local_def_index: CRATE_DEF_INDEX }.to_def_id(),
451 .unwrap_or_else(|()| {
452 panic!("Unable to resolve external crate {}", extern_name)
458 // Now we're good to clone the resolver because everything should be loaded
462 if sess.has_errors() {
463 sess.fatal("Compilation failed, aborting rustdoc");
466 let mut global_ctxt = abort_on_err(queries.global_ctxt(), sess).take();
468 let (krate, render_info, opts) = sess.time("run_global_ctxt", || {
469 global_ctxt.enter(|tcx| {
480 (krate, render_info, opts, Lrc::clone(sess))
487 resolver: Rc<RefCell<interface::BoxedResolver>>,
488 mut default_passes: passes::DefaultPassOption,
489 mut manual_passes: Vec<String>,
490 render_options: RenderOptions,
491 output_format: Option<OutputFormat>,
492 ) -> (clean::Crate, RenderInfo, RenderOptions) {
493 // Certain queries assume that some checks were run elsewhere
494 // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
495 // so type-check everything other than function bodies in this crate before running lints.
497 // NOTE: this does not call `tcx.analysis()` so that we won't
498 // typeck function bodies or run the default rustc lints.
499 // (see `override_queries` in the `config`)
501 // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
502 // and might break if queries change their assumptions in the future.
504 // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
505 tcx.sess.time("item_types_checking", || {
506 for &module in tcx.hir().krate().modules.keys() {
507 tcx.ensure().check_mod_item_types(tcx.hir().local_def_id(module));
510 tcx.sess.abort_if_errors();
511 tcx.sess.time("missing_docs", || {
512 rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
514 tcx.sess.time("check_mod_attrs", || {
515 for &module in tcx.hir().krate().modules.keys() {
516 let local_def_id = tcx.hir().local_def_id(module);
517 tcx.ensure().check_mod_attrs(local_def_id);
521 let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
522 // Convert from a HirId set to a DefId set since we don't always have easy access
523 // to the map from defid -> hirid
524 let access_levels = AccessLevels {
528 .map(|(&k, &v)| (tcx.hir().local_def_id(k).to_def_id(), v))
532 let mut renderinfo = RenderInfo::default();
533 renderinfo.access_levels = access_levels;
534 renderinfo.output_format = output_format;
536 let mut ctxt = DocContext {
539 external_traits: Default::default(),
540 active_extern_traits: Default::default(),
541 renderinfo: RefCell::new(renderinfo),
542 ty_substs: Default::default(),
543 lt_substs: Default::default(),
544 ct_substs: Default::default(),
545 impl_trait_bounds: Default::default(),
546 fake_def_ids: Default::default(),
547 all_fake_def_ids: Default::default(),
548 generated_synthetics: Default::default(),
550 .all_traits(LOCAL_CRATE)
553 .filter(|trait_def_id| tcx.trait_is_auto(*trait_def_id))
556 module_trait_cache: RefCell::new(FxHashMap::default()),
558 debug!("crate: {:?}", tcx.hir().krate());
560 let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
562 if let Some(ref m) = krate.module {
563 if let None | Some("") = m.doc_value() {
564 let help = "The following guide may be of use:\n\
565 https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html";
566 tcx.struct_lint_node(
567 rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS,
568 ctxt.as_local_hir_id(m.def_id).unwrap(),
571 lint.build("no documentation found for this crate's top-level module");
579 fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler) {
581 .struct_warn(&format!("the `#![doc({})]` attribute is considered deprecated", name));
583 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
584 for more information",
587 if name == "no_default_passes" {
588 msg.help("you may want to use `#![doc(document_private_items)]`");
594 // Process all of the crate attributes, extracting plugin metadata along
595 // with the passes which we are supposed to run.
596 for attr in krate.module.as_ref().unwrap().attrs.lists(sym::doc) {
597 let diag = ctxt.sess().diagnostic();
599 let name = attr.name_or_empty();
601 if name == sym::no_default_passes {
602 report_deprecated_attr("no_default_passes", diag);
603 if default_passes == passes::DefaultPassOption::Default {
604 default_passes = passes::DefaultPassOption::None;
607 } else if let Some(value) = attr.value_str() {
608 let sink = match name {
610 report_deprecated_attr("passes = \"...\"", diag);
614 report_deprecated_attr("plugins = \"...\"", diag);
616 "WARNING: `#![doc(plugins = \"...\")]` \
617 no longer functions; see CVE-2018-1000622"
623 for name in value.as_str().split_whitespace() {
624 sink.push(name.to_string());
628 if attr.is_word() && name == sym::document_private_items {
629 ctxt.render_options.document_private = true;
633 let passes = passes::defaults(default_passes).iter().copied().chain(
634 manual_passes.into_iter().flat_map(|name| {
635 if let Some(pass) = passes::find_pass(&name) {
636 Some(ConditionalPass::always(pass))
638 error!("unknown pass {}, skipping", name);
644 info!("Executing passes");
647 let run = match p.condition {
649 WhenDocumentPrivate => ctxt.render_options.document_private,
650 WhenNotDocumentPrivate => !ctxt.render_options.document_private,
651 WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
654 debug!("running pass {}", p.pass.name);
655 krate = ctxt.tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &ctxt));
659 ctxt.sess().abort_if_errors();
661 (krate, ctxt.renderinfo.into_inner(), ctxt.render_options)
664 /// Due to https://github.com/rust-lang/rust/pull/73566,
665 /// the name resolution pass may find errors that are never emitted.
666 /// If typeck is called after this happens, then we'll get an ICE:
667 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
668 struct EmitIgnoredResolutionErrors<'tcx> {
672 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
673 fn new(tcx: TyCtxt<'tcx>) -> Self {
678 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
679 type Map = Map<'tcx>;
681 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
682 // We need to recurse into nested closures,
683 // since those will fallback to the parent for type checking.
684 NestedVisitorMap::OnlyBodies(self.tcx.hir())
687 fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
688 debug!("visiting path {:?}", path);
689 if path.res == Res::Err {
690 // We have less context here than in rustc_resolve,
691 // so we can only emit the name and span.
692 // However we can give a hint that rustc_resolve will have more info.
694 "could not resolve path `{}`",
697 .map(|segment| segment.ident.as_str().to_string())
701 let mut err = rustc_errors::struct_span_err!(
705 "failed to resolve: {}",
708 err.span_label(path.span, label);
709 err.note("this error was originally ignored because you are running `rustdoc`");
710 err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
713 // We could have an outer resolution that succeeded,
714 // but with generic parameters that failed.
715 // Recurse into the segments so we catch those too.
716 intravisit::walk_path(self, path);
720 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
721 /// for `impl Trait` in argument position.
722 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
723 pub enum ImplTraitParam {
728 impl From<DefId> for ImplTraitParam {
729 fn from(did: DefId) -> Self {
730 ImplTraitParam::DefId(did)
734 impl From<u32> for ImplTraitParam {
735 fn from(idx: u32) -> Self {
736 ImplTraitParam::ParamIndex(idx)