src/librustdoc/core.rs

   1 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   2 use rustc_data_structures::sync::{self, Lrc};
   3 use rustc_driver::abort_on_err;
   4 use rustc_errors::emitter::{Emitter, EmitterWriter};
   5 use rustc_errors::json::JsonEmitter;
   6 use rustc_feature::UnstableFeatures;
   7 use rustc_hir::def::Res;
   8 use rustc_hir::def_id::{DefId, LocalDefId};
   9 use rustc_hir::HirId;
  10 use rustc_hir::{
  11     intravisit::{self, NestedVisitorMap, Visitor},
  12     Path,
  13 };
  14 use rustc_interface::{interface, Queries};
  15 use rustc_middle::hir::map::Map;
  16 use rustc_middle::middle::privacy::AccessLevels;
  17 use rustc_middle::ty::{ParamEnv, Ty, TyCtxt};
  18 use rustc_resolve as resolve;
  19 use rustc_session::config::{self, CrateType, ErrorOutputType};
  20 use rustc_session::lint;
  21 use rustc_session::DiagnosticOutput;
  22 use rustc_session::Session;
  23 use rustc_span::source_map;
  24 use rustc_span::symbol::sym;
  25 use rustc_span::Span;
  26
  27 use std::cell::RefCell;
  28 use std::lazy::SyncLazy;
  29 use std::mem;
  30 use std::rc::Rc;
  31
  32 use crate::clean::inline::build_external_trait;
  33 use crate::clean::{self, ItemId, TraitWithExtraInfo};
  34 use crate::config::{Options as RustdocOptions, OutputFormat, RenderOptions};
  35 use crate::formats::cache::Cache;
  36 use crate::passes::{self, Condition::*, ConditionalPass};
  37
  38 crate use rustc_session::config::{DebuggingOptions, Input, Options};
  39
  40 crate struct DocContext<'tcx> {
  41     crate tcx: TyCtxt<'tcx>,
  42     /// Name resolver. Used for intra-doc links.
  43     ///
  44     /// The `Rc<RefCell<...>>` wrapping is needed because that is what's returned by
  45     /// [`Queries::expansion()`].
  46     // FIXME: see if we can get rid of this RefCell somehow
  47     crate resolver: Rc<RefCell<interface::BoxedResolver>>,
  48     /// Used for normalization.
  49     ///
  50     /// Most of this logic is copied from rustc_lint::late.
  51     crate param_env: ParamEnv<'tcx>,
  52     /// Later on moved through `clean::Crate` into `cache`
  53     crate external_traits: Rc<RefCell<FxHashMap<DefId, clean::TraitWithExtraInfo>>>,
  54     /// Used while populating `external_traits` to ensure we don't process the same trait twice at
  55     /// the same time.
  56     crate active_extern_traits: FxHashSet<DefId>,
  57     // The current set of type and lifetime substitutions,
  58     // for expanding type aliases at the HIR level:
  59     /// Table `DefId` of type parameter -> substituted type
  60     crate ty_substs: FxHashMap<DefId, clean::Type>,
  61     /// Table `DefId` of lifetime parameter -> substituted lifetime
  62     crate lt_substs: FxHashMap<DefId, clean::Lifetime>,
  63     /// Table `DefId` of const parameter -> substituted const
  64     crate ct_substs: FxHashMap<DefId, clean::Constant>,
  65     /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
  66     crate impl_trait_bounds: FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>,
  67     /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
  68     // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
  69     crate generated_synthetics: FxHashSet<(Ty<'tcx>, DefId)>,
  70     crate auto_traits: Vec<DefId>,
  71     /// The options given to rustdoc that could be relevant to a pass.
  72     crate render_options: RenderOptions,
  73     /// The traits in scope for a given module.
  74     ///
  75     /// See `collect_intra_doc_links::traits_implemented_by` for more details.
  76     /// `map<module, set<trait>>`
  77     crate module_trait_cache: FxHashMap<DefId, FxHashSet<DefId>>,
  78     /// This same cache is used throughout rustdoc, including in [`crate::html::render`].
  79     crate cache: Cache,
  80     /// Used by [`clean::inline`] to tell if an item has already been inlined.
  81     crate inlined: FxHashSet<ItemId>,
  82     /// Used by `calculate_doc_coverage`.
  83     crate output_format: OutputFormat,
  84 }
  85
  86 impl<'tcx> DocContext<'tcx> {
  87     crate fn sess(&self) -> &'tcx Session {
  88         &self.tcx.sess
  89     }
  90
  91     crate fn with_param_env<T, F: FnOnce(&mut Self) -> T>(&mut self, def_id: DefId, f: F) -> T {
  92         let old_param_env = mem::replace(&mut self.param_env, self.tcx.param_env(def_id));
  93         let ret = f(self);
  94         self.param_env = old_param_env;
  95         ret
  96     }
  97
  98     crate fn enter_resolver<F, R>(&self, f: F) -> R
  99     where
 100         F: FnOnce(&mut resolve::Resolver<'_>) -> R,
 101     {
 102         self.resolver.borrow_mut().access(f)
 103     }
 104
 105     /// Call the closure with the given parameters set as
 106     /// the substitutions for a type alias' RHS.
 107     crate fn enter_alias<F, R>(
 108         &mut self,
 109         ty_substs: FxHashMap<DefId, clean::Type>,
 110         lt_substs: FxHashMap<DefId, clean::Lifetime>,
 111         ct_substs: FxHashMap<DefId, clean::Constant>,
 112         f: F,
 113     ) -> R
 114     where
 115         F: FnOnce(&mut Self) -> R,
 116     {
 117         let (old_tys, old_lts, old_cts) = (
 118             mem::replace(&mut self.ty_substs, ty_substs),
 119             mem::replace(&mut self.lt_substs, lt_substs),
 120             mem::replace(&mut self.ct_substs, ct_substs),
 121         );
 122         let r = f(self);
 123         self.ty_substs = old_tys;
 124         self.lt_substs = old_lts;
 125         self.ct_substs = old_cts;
 126         r
 127     }
 128
 129     /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
 130     /// (This avoids a slice-index-out-of-bounds panic.)
 131     crate fn as_local_hir_id(tcx: TyCtxt<'_>, def_id: ItemId) -> Option<HirId> {
 132         match def_id {
 133             ItemId::DefId(real_id) => {
 134                 real_id.as_local().map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id))
 135             }
 136             // FIXME: Can this be `Some` for `Auto` or `Blanket`?
 137             _ => None,
 138         }
 139     }
 140 }
 141
 142 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
 143 ///
 144 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
 145 /// will be created for the handler.
 146 crate fn new_handler(
 147     error_format: ErrorOutputType,
 148     source_map: Option<Lrc<source_map::SourceMap>>,
 149     debugging_opts: &DebuggingOptions,
 150 ) -> rustc_errors::Handler {
 151     let emitter: Box<dyn Emitter + sync::Send> = match error_format {
 152         ErrorOutputType::HumanReadable(kind) => {
 153             let (short, color_config) = kind.unzip();
 154             Box::new(
 155                 EmitterWriter::stderr(
 156                     color_config,
 157                     source_map.map(|sm| sm as _),
 158                     short,
 159                     debugging_opts.teach,
 160                     debugging_opts.terminal_width,
 161                     false,
 162                 )
 163                 .ui_testing(debugging_opts.ui_testing),
 164             )
 165         }
 166         ErrorOutputType::Json { pretty, json_rendered } => {
 167             let source_map = source_map.unwrap_or_else(|| {
 168                 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
 169             });
 170             Box::new(
 171                 JsonEmitter::stderr(
 172                     None,
 173                     source_map,
 174                     pretty,
 175                     json_rendered,
 176                     debugging_opts.terminal_width,
 177                     false,
 178                 )
 179                 .ui_testing(debugging_opts.ui_testing),
 180             )
 181         }
 182     };
 183
 184     rustc_errors::Handler::with_emitter_and_flags(
 185         emitter,
 186         debugging_opts.diagnostic_handler_flags(true),
 187     )
 188 }
 189
 190 /// Parse, resolve, and typecheck the given crate.
 191 crate fn create_config(
 192     RustdocOptions {
 193         input,
 194         crate_name,
 195         proc_macro_crate,
 196         error_format,
 197         libs,
 198         externs,
 199         mut cfgs,
 200         codegen_options,
 201         debugging_opts,
 202         target,
 203         edition,
 204         maybe_sysroot,
 205         lint_opts,
 206         describe_lints,
 207         lint_cap,
 208         ..
 209     }: RustdocOptions,
 210 ) -> rustc_interface::Config {
 211     // Add the doc cfg into the doc build.
 212     cfgs.push("doc".to_string());
 213
 214     let cpath = Some(input.clone());
 215     let input = Input::File(input);
 216
 217     // By default, rustdoc ignores all lints.
 218     // Specifically unblock lints relevant to documentation or the lint machinery itself.
 219     let mut lints_to_show = vec![
 220         // it's unclear whether these should be part of rustdoc directly (#77364)
 221         rustc_lint::builtin::MISSING_DOCS.name.to_string(),
 222         rustc_lint::builtin::INVALID_DOC_ATTRIBUTES.name.to_string(),
 223         // these are definitely not part of rustdoc, but we want to warn on them anyway.
 224         rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_string(),
 225         rustc_lint::builtin::UNKNOWN_LINTS.name.to_string(),
 226     ];
 227     lints_to_show.extend(crate::lint::RUSTDOC_LINTS.iter().map(|lint| lint.name.to_string()));
 228
 229     let (lint_opts, lint_caps) = crate::lint::init_lints(lints_to_show, lint_opts, |lint| {
 230         Some((lint.name_lower(), lint::Allow))
 231     });
 232
 233     let crate_types =
 234         if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
 235     // plays with error output here!
 236     let sessopts = config::Options {
 237         maybe_sysroot,
 238         search_paths: libs,
 239         crate_types,
 240         lint_opts,
 241         lint_cap,
 242         cg: codegen_options,
 243         externs,
 244         target_triple: target,
 245         unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
 246         actually_rustdoc: true,
 247         debugging_opts,
 248         error_format,
 249         edition,
 250         describe_lints,
 251         crate_name,
 252         ..Options::default()
 253     };
 254
 255     interface::Config {
 256         opts: sessopts,
 257         crate_cfg: interface::parse_cfgspecs(cfgs),
 258         input,
 259         input_path: cpath,
 260         output_file: None,
 261         output_dir: None,
 262         file_loader: None,
 263         diagnostic_output: DiagnosticOutput::Default,
 264         stderr: None,
 265         lint_caps,
 266         parse_sess_created: None,
 267         register_lints: Some(box crate::lint::register_lints),
 268         override_queries: Some(|_sess, providers, _external_providers| {
 269             // Most lints will require typechecking, so just don't run them.
 270             providers.lint_mod = |_, _| {};
 271             // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
 272             providers.typeck_item_bodies = |_, _| {};
 273             // hack so that `used_trait_imports` won't try to call typeck
 274             providers.used_trait_imports = |_, _| {
 275                 static EMPTY_SET: SyncLazy<FxHashSet<LocalDefId>> =
 276                     SyncLazy::new(FxHashSet::default);
 277                 &EMPTY_SET
 278             };
 279             // In case typeck does end up being called, don't ICE in case there were name resolution errors
 280             providers.typeck = move |tcx, def_id| {
 281                 // Closures' tables come from their outermost function,
 282                 // as they are part of the same "inference environment".
 283                 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
 284                 let outer_def_id = tcx.closure_base_def_id(def_id.to_def_id()).expect_local();
 285                 if outer_def_id != def_id {
 286                     return tcx.typeck(outer_def_id);
 287                 }
 288
 289                 let hir = tcx.hir();
 290                 let body = hir.body(hir.body_owned_by(hir.local_def_id_to_hir_id(def_id)));
 291                 debug!("visiting body for {:?}", def_id);
 292                 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
 293                 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
 294             };
 295         }),
 296         make_codegen_backend: None,
 297         registry: rustc_driver::diagnostics_registry(),
 298     }
 299 }
 300
 301 crate fn create_resolver<'a>(
 302     queries: &Queries<'a>,
 303     sess: &Session,
 304 ) -> Rc<RefCell<interface::BoxedResolver>> {
 305     let (krate, resolver, _) = &*abort_on_err(queries.expansion(), sess).peek();
 306     let resolver = resolver.clone();
 307
 308     crate::passes::collect_intra_doc_links::load_intra_link_crates(resolver, krate)
 309 }
 310
 311 crate fn run_global_ctxt(
 312     tcx: TyCtxt<'_>,
 313     resolver: Rc<RefCell<interface::BoxedResolver>>,
 314     mut default_passes: passes::DefaultPassOption,
 315     manual_passes: Vec<String>,
 316     render_options: RenderOptions,
 317     output_format: OutputFormat,
 318 ) -> (clean::Crate, RenderOptions, Cache) {
 319     // Certain queries assume that some checks were run elsewhere
 320     // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
 321     // so type-check everything other than function bodies in this crate before running lints.
 322
 323     // NOTE: this does not call `tcx.analysis()` so that we won't
 324     // typeck function bodies or run the default rustc lints.
 325     // (see `override_queries` in the `config`)
 326
 327     // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
 328     // and might break if queries change their assumptions in the future.
 329
 330     // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
 331     tcx.sess.time("item_types_checking", || {
 332         tcx.hir().for_each_module(|module| tcx.ensure().check_mod_item_types(module))
 333     });
 334     tcx.sess.abort_if_errors();
 335     tcx.sess.time("missing_docs", || {
 336         rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
 337     });
 338     tcx.sess.time("check_mod_attrs", || {
 339         tcx.hir().for_each_module(|module| tcx.ensure().check_mod_attrs(module))
 340     });
 341     rustc_passes::stability::check_unused_or_stable_features(tcx);
 342
 343     let access_levels = AccessLevels {
 344         map: tcx.privacy_access_levels(()).map.iter().map(|(k, v)| (k.to_def_id(), *v)).collect(),
 345     };
 346
 347     let mut ctxt = DocContext {
 348         tcx,
 349         resolver,
 350         param_env: ParamEnv::empty(),
 351         external_traits: Default::default(),
 352         active_extern_traits: Default::default(),
 353         ty_substs: Default::default(),
 354         lt_substs: Default::default(),
 355         ct_substs: Default::default(),
 356         impl_trait_bounds: Default::default(),
 357         generated_synthetics: Default::default(),
 358         auto_traits: tcx
 359             .all_traits(())
 360             .iter()
 361             .cloned()
 362             .filter(|trait_def_id| tcx.trait_is_auto(*trait_def_id))
 363             .collect(),
 364         module_trait_cache: FxHashMap::default(),
 365         cache: Cache::new(access_levels, render_options.document_private),
 366         inlined: FxHashSet::default(),
 367         output_format,
 368         render_options,
 369     };
 370
 371     // Small hack to force the Sized trait to be present.
 372     //
 373     // Note that in case of `#![no_core]`, the trait is not available.
 374     if let Some(sized_trait_did) = ctxt.tcx.lang_items().sized_trait() {
 375         let mut sized_trait = build_external_trait(&mut ctxt, sized_trait_did);
 376         sized_trait.is_auto = true;
 377         ctxt.external_traits
 378             .borrow_mut()
 379             .insert(sized_trait_did, TraitWithExtraInfo { trait_: sized_trait, is_notable: false });
 380     }
 381
 382     debug!("crate: {:?}", tcx.hir().krate());
 383
 384     let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
 385
 386     if krate.module.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
 387         let help = format!(
 388             "The following guide may be of use:\n\
 389             {}/rustdoc/how-to-write-documentation.html",
 390             crate::DOC_RUST_LANG_ORG_CHANNEL
 391         );
 392         tcx.struct_lint_node(
 393             crate::lint::MISSING_CRATE_LEVEL_DOCS,
 394             DocContext::as_local_hir_id(tcx, krate.module.def_id).unwrap(),
 395             |lint| {
 396                 let mut diag =
 397                     lint.build("no documentation found for this crate's top-level module");
 398                 diag.help(&help);
 399                 diag.emit();
 400             },
 401         );
 402     }
 403
 404     fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler, sp: Span) {
 405         let mut msg =
 406             diag.struct_span_warn(sp, &format!("the `#![doc({})]` attribute is deprecated", name));
 407         msg.note(
 408             "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 409              for more information",
 410         );
 411
 412         if name == "no_default_passes" {
 413             msg.help("you may want to use `#![doc(document_private_items)]`");
 414         } else if name.starts_with("plugins") {
 415             msg.warn("`#![doc(plugins = \"...\")]` no longer functions; see CVE-2018-1000622 <https://nvd.nist.gov/vuln/detail/CVE-2018-1000622>");
 416         }
 417
 418         msg.emit();
 419     }
 420
 421     let parse_pass = |name: &str, sp: Option<Span>| {
 422         if let Some(pass) = passes::find_pass(name) {
 423             Some(ConditionalPass::always(pass))
 424         } else {
 425             let msg = &format!("ignoring unknown pass `{}`", name);
 426             let mut warning = if let Some(sp) = sp {
 427                 tcx.sess.struct_span_warn(sp, msg)
 428             } else {
 429                 tcx.sess.struct_warn(msg)
 430             };
 431             if name == "collapse-docs" {
 432                 warning.note("the `collapse-docs` pass was removed in #80261 <https://github.com/rust-lang/rust/pull/80261>");
 433             }
 434             warning.emit();
 435             None
 436         }
 437     };
 438
 439     let mut manual_passes: Vec<_> =
 440         manual_passes.into_iter().flat_map(|name| parse_pass(&name, None)).collect();
 441
 442     // Process all of the crate attributes, extracting plugin metadata along
 443     // with the passes which we are supposed to run.
 444     for attr in krate.module.attrs.lists(sym::doc) {
 445         let diag = ctxt.sess().diagnostic();
 446
 447         let name = attr.name_or_empty();
 448         if attr.is_word() {
 449             if name == sym::no_default_passes {
 450                 report_deprecated_attr("no_default_passes", diag, attr.span());
 451                 if default_passes == passes::DefaultPassOption::Default {
 452                     default_passes = passes::DefaultPassOption::None;
 453                 }
 454             }
 455         } else if let Some(value) = attr.value_str() {
 456             match name {
 457                 sym::passes => {
 458                     report_deprecated_attr("passes = \"...\"", diag, attr.span());
 459                 }
 460                 sym::plugins => {
 461                     report_deprecated_attr("plugins = \"...\"", diag, attr.span());
 462                     continue;
 463                 }
 464                 _ => continue,
 465             };
 466             for name in value.as_str().split_whitespace() {
 467                 let span = attr.name_value_literal_span().unwrap_or(attr.span());
 468                 manual_passes.extend(parse_pass(name, Some(span)));
 469             }
 470         }
 471
 472         if attr.is_word() && name == sym::document_private_items {
 473             ctxt.render_options.document_private = true;
 474         }
 475     }
 476
 477     let passes = passes::defaults(default_passes).iter().copied().chain(manual_passes);
 478     info!("Executing passes");
 479
 480     for p in passes {
 481         let run = match p.condition {
 482             Always => true,
 483             WhenDocumentPrivate => ctxt.render_options.document_private,
 484             WhenNotDocumentPrivate => !ctxt.render_options.document_private,
 485             WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
 486         };
 487         if run {
 488             debug!("running pass {}", p.pass.name);
 489             krate = ctxt.tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &mut ctxt));
 490         }
 491     }
 492
 493     ctxt.sess().abort_if_errors();
 494
 495     let render_options = ctxt.render_options;
 496     let mut cache = ctxt.cache;
 497     krate = tcx.sess.time("create_format_cache", || cache.populate(krate, tcx, &render_options));
 498
 499     // The main crate doc comments are always collapsed.
 500     krate.collapsed = true;
 501
 502     (krate, render_options, cache)
 503 }
 504
 505 /// Due to <https://github.com/rust-lang/rust/pull/73566>,
 506 /// the name resolution pass may find errors that are never emitted.
 507 /// If typeck is called after this happens, then we'll get an ICE:
 508 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
 509 struct EmitIgnoredResolutionErrors<'tcx> {
 510     tcx: TyCtxt<'tcx>,
 511 }
 512
 513 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
 514     fn new(tcx: TyCtxt<'tcx>) -> Self {
 515         Self { tcx }
 516     }
 517 }
 518
 519 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
 520     type Map = Map<'tcx>;
 521
 522     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 523         // We need to recurse into nested closures,
 524         // since those will fallback to the parent for type checking.
 525         NestedVisitorMap::OnlyBodies(self.tcx.hir())
 526     }
 527
 528     fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
 529         debug!("visiting path {:?}", path);
 530         if path.res == Res::Err {
 531             // We have less context here than in rustc_resolve,
 532             // so we can only emit the name and span.
 533             // However we can give a hint that rustc_resolve will have more info.
 534             let label = format!(
 535                 "could not resolve path `{}`",
 536                 path.segments
 537                     .iter()
 538                     .map(|segment| segment.ident.as_str().to_string())
 539                     .collect::<Vec<_>>()
 540                     .join("::")
 541             );
 542             let mut err = rustc_errors::struct_span_err!(
 543                 self.tcx.sess,
 544                 path.span,
 545                 E0433,
 546                 "failed to resolve: {}",
 547                 label
 548             );
 549             err.span_label(path.span, label);
 550             err.note("this error was originally ignored because you are running `rustdoc`");
 551             err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
 552             err.emit();
 553         }
 554         // We could have an outer resolution that succeeded,
 555         // but with generic parameters that failed.
 556         // Recurse into the segments so we catch those too.
 557         intravisit::walk_path(self, path);
 558     }
 559 }
 560
 561 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
 562 /// for `impl Trait` in argument position.
 563 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
 564 crate enum ImplTraitParam {
 565     DefId(DefId),
 566     ParamIndex(u32),
 567 }
 568
 569 impl From<DefId> for ImplTraitParam {
 570     fn from(did: DefId) -> Self {
 571         ImplTraitParam::DefId(did)
 572     }
 573 }
 574
 575 impl From<u32> for ImplTraitParam {
 576     fn from(idx: u32) -> Self {
 577         ImplTraitParam::ParamIndex(idx)
 578     }
 579 }