2 html_root_url = "https://doc.rust-lang.org/nightly/",
3 html_playground_url = "https://play.rust-lang.org/"
5 #![feature(rustc_private)]
6 #![feature(array_methods)]
7 #![feature(box_patterns)]
8 #![feature(box_syntax)]
9 #![feature(in_band_lifetimes)]
12 #![feature(crate_visibility_modifier)]
13 #![feature(never_type)]
14 #![feature(once_cell)]
15 #![feature(type_ascription)]
16 #![feature(iter_intersperse)]
17 #![recursion_limit = "256"]
18 #![warn(rustc::internal)]
21 extern crate lazy_static;
25 // N.B. these need `extern crate` even in 2018 edition
26 // because they're loaded implicitly from the sysroot.
27 // The reason they're loaded from the sysroot is because
28 // the rustdoc artifacts aren't stored in rustc's cargo target directory.
29 // So if `rustc` was specified in Cargo.toml, this would spuriously rebuild crates.
31 // Dependencies listed in Cargo.toml do not need `extern crate`.
33 extern crate rustc_ast;
34 extern crate rustc_ast_pretty;
35 extern crate rustc_attr;
36 extern crate rustc_data_structures;
37 extern crate rustc_driver;
38 extern crate rustc_errors;
39 extern crate rustc_expand;
40 extern crate rustc_feature;
41 extern crate rustc_hir;
42 extern crate rustc_hir_pretty;
43 extern crate rustc_index;
44 extern crate rustc_infer;
45 extern crate rustc_interface;
46 extern crate rustc_lexer;
47 extern crate rustc_lint;
48 extern crate rustc_lint_defs;
49 extern crate rustc_metadata;
50 extern crate rustc_middle;
51 extern crate rustc_mir;
52 extern crate rustc_parse;
53 extern crate rustc_passes;
54 extern crate rustc_resolve;
55 extern crate rustc_session;
56 extern crate rustc_span as rustc_span;
57 extern crate rustc_target;
58 extern crate rustc_trait_selection;
59 extern crate rustc_typeck;
60 extern crate test as testing;
62 #[cfg(feature = "jemalloc")]
63 extern crate tikv_jemalloc_sys;
64 #[cfg(feature = "jemalloc")]
65 use tikv_jemalloc_sys as jemalloc_sys;
66 #[cfg(feature = "jemalloc")]
67 extern crate tikv_jemallocator;
68 #[cfg(feature = "jemalloc")]
69 use tikv_jemallocator as jemallocator;
71 use std::default::Default;
75 use rustc_driver::{abort_on_err, describe_lints};
76 use rustc_errors::ErrorReported;
77 use rustc_interface::interface;
78 use rustc_middle::ty::TyCtxt;
79 use rustc_session::config::{make_crate_type_option, ErrorOutputType, RustcOptGroup};
80 use rustc_session::getopts;
81 use rustc_session::{early_error, early_warn};
83 use crate::clean::utils::DOC_RUST_LANG_ORG_CHANNEL;
85 /// A macro to create a FxHashMap.
90 /// let letters = map!{"a" => "b", "c" => "d"};
93 /// Trailing commas are allowed.
94 /// Commas between elements are required (even if the expression is a block).
96 ($( $key: expr => $val: expr ),* $(,)*) => {{
97 let mut map = ::rustc_data_structures::fx::FxHashMap::default();
98 $( map.insert($key, $val); )*
116 // used by the error-index generator, so it needs to be public
126 // See docs in https://github.com/rust-lang/rust/blob/master/compiler/rustc/src/main.rs
127 // about jemallocator
128 #[cfg(feature = "jemalloc")]
130 static ALLOC: jemallocator::Jemalloc = jemallocator::Jemalloc;
133 // See docs in https://github.com/rust-lang/rust/blob/master/compiler/rustc/src/main.rs
134 // about jemalloc-sys
135 #[cfg(feature = "jemalloc")]
137 use std::os::raw::{c_int, c_void};
140 static _F1: unsafe extern "C" fn(usize, usize) -> *mut c_void = jemalloc_sys::calloc;
142 static _F2: unsafe extern "C" fn(*mut *mut c_void, usize, usize) -> c_int =
143 jemalloc_sys::posix_memalign;
145 static _F3: unsafe extern "C" fn(usize, usize) -> *mut c_void = jemalloc_sys::aligned_alloc;
147 static _F4: unsafe extern "C" fn(usize) -> *mut c_void = jemalloc_sys::malloc;
149 static _F5: unsafe extern "C" fn(*mut c_void, usize) -> *mut c_void = jemalloc_sys::realloc;
151 static _F6: unsafe extern "C" fn(*mut c_void) = jemalloc_sys::free;
153 // On OSX, jemalloc doesn't directly override malloc/free, but instead
154 // registers itself with the allocator's zone APIs in a ctor. However,
155 // the linker doesn't seem to consider ctors as "used" when statically
156 // linking, so we need to explicitly depend on the function.
157 #[cfg(target_os = "macos")]
160 fn _rjem_je_zone_register();
164 static _F7: unsafe extern "C" fn() = _rjem_je_zone_register;
168 rustc_driver::set_sigpipe_handler();
169 rustc_driver::install_ice_hook();
171 // When using CI artifacts (with `download_stage1 = true`), tracing is unconditionally built
172 // with `--features=static_max_level_info`, which disables almost all rustdoc logging. To avoid
173 // this, compile our own version of `tracing` that logs all levels.
174 // NOTE: this compiles both versions of tracing unconditionally, because
175 // - The compile time hit is not that bad, especially compared to rustdoc's incremental times, and
176 // - Otherwise, there's no warning that logging is being ignored when `download_stage1 = true`.
177 // NOTE: The reason this doesn't show double logging when `download_stage1 = false` and
178 // `debug_logging = true` is because all rustc logging goes to its version of tracing (the one
179 // in the sysroot), and all of rustdoc's logging goes to its version (the one in Cargo.toml).
181 rustc_driver::init_env_logger("RUSTDOC_LOG");
183 let exit_code = rustc_driver::catch_with_exit_code(|| match get_args() {
184 Some(args) => main_args(&args),
185 _ => Err(ErrorReported),
187 process::exit(exit_code);
193 // FIXME remove these and use winapi 0.3 instead
194 // Duplicates: bootstrap/compile.rs, librustc_errors/emitter.rs, rustc_driver/lib.rs
196 fn stdout_isatty() -> bool {
198 unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
202 fn stdout_isatty() -> bool {
204 use winapi::um::consoleapi::GetConsoleMode;
205 use winapi::um::processenv::GetStdHandle;
206 use winapi::um::winbase::STD_OUTPUT_HANDLE;
209 let handle = GetStdHandle(STD_OUTPUT_HANDLE);
211 GetConsoleMode(handle, &mut out) != 0
215 let color_logs = match std::env::var("RUSTDOC_LOG_COLOR") {
216 Ok(value) => match value.as_ref() {
219 "auto" => stdout_isatty(),
221 ErrorOutputType::default(),
223 "invalid log color value '{}': expected one of always, never, or auto",
228 Err(std::env::VarError::NotPresent) => stdout_isatty(),
229 Err(std::env::VarError::NotUnicode(_value)) => early_error(
230 ErrorOutputType::default(),
231 "non-Unicode log color value: expected one of always, never, or auto",
234 let filter = tracing_subscriber::EnvFilter::from_env("RUSTDOC_LOG");
235 let layer = tracing_tree::HierarchicalLayer::default()
236 .with_writer(io::stderr)
237 .with_indent_lines(true)
238 .with_ansi(color_logs)
241 .with_verbose_exit(true)
242 .with_verbose_entry(true)
243 .with_indent_amount(2);
244 #[cfg(parallel_compiler)]
245 let layer = layer.with_thread_ids(true).with_thread_names(true);
247 use tracing_subscriber::layer::SubscriberExt;
248 let subscriber = tracing_subscriber::Registry::default().with(filter).with(layer);
249 tracing::subscriber::set_global_default(subscriber).unwrap();
252 fn get_args() -> Option<Vec<String>> {
259 ErrorOutputType::default(),
260 &format!("Argument {} is not valid Unicode: {:?}", i, arg),
268 fn opts() -> Vec<RustcOptGroup> {
269 let stable: fn(_, fn(&mut getopts::Options) -> &mut _) -> _ = RustcOptGroup::stable;
270 let unstable: fn(_, fn(&mut getopts::Options) -> &mut _) -> _ = RustcOptGroup::unstable;
272 stable("h", |o| o.optflagmulti("h", "help", "show this help message")),
273 stable("V", |o| o.optflagmulti("V", "version", "print rustdoc's version")),
274 stable("v", |o| o.optflagmulti("v", "verbose", "use verbose output")),
276 o.optopt("r", "input-format", "the input type of the specified file", "[rust]")
278 stable("w", |o| o.optopt("w", "output-format", "the output type to write", "[html]")),
279 stable("o", |o| o.optopt("o", "output", "where to place the output", "PATH")),
280 stable("crate-name", |o| {
281 o.optopt("", "crate-name", "specify the name of this crate", "NAME")
283 make_crate_type_option(),
285 o.optmulti("L", "library-path", "directory to add to crate search path", "DIR")
287 stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
288 stable("extern", |o| o.optmulti("", "extern", "pass an --extern to rustc", "NAME[=PATH]")),
289 unstable("extern-html-root-url", |o| {
292 "extern-html-root-url",
293 "base URL to use for dependencies; for example, \
294 \"std=/doc\" links std::vec::Vec to /doc/std/vec/struct.Vec.html",
298 stable("plugin-path", |o| o.optmulti("", "plugin-path", "removed", "DIR")),
300 o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
302 stable("passes", |o| {
306 "list of passes to also run, you might want to pass it multiple times; a value of \
307 `list` will print available passes",
311 stable("plugins", |o| o.optmulti("", "plugins", "removed", "PLUGINS")),
312 stable("no-default", |o| o.optflagmulti("", "no-defaults", "don't run the default passes")),
313 stable("document-private-items", |o| {
314 o.optflagmulti("", "document-private-items", "document private items")
316 unstable("document-hidden-items", |o| {
317 o.optflagmulti("", "document-hidden-items", "document items that have doc(hidden)")
319 stable("test", |o| o.optflagmulti("", "test", "run code examples as tests")),
320 stable("test-args", |o| {
321 o.optmulti("", "test-args", "arguments to pass to the test runner", "ARGS")
323 unstable("test-run-directory", |o| {
326 "test-run-directory",
327 "The working directory in which to run tests",
331 stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
332 stable("markdown-css", |o| {
336 "CSS files to include via <link> in a rendered Markdown file",
340 stable("html-in-header", |o| {
344 "files to include inline in the <head> section of a rendered Markdown file \
345 or generated documentation",
349 stable("html-before-content", |o| {
352 "html-before-content",
353 "files to include inline between <body> and the content of a rendered \
354 Markdown file or generated documentation",
358 stable("html-after-content", |o| {
361 "html-after-content",
362 "files to include inline between the content and </body> of a rendered \
363 Markdown file or generated documentation",
367 unstable("markdown-before-content", |o| {
370 "markdown-before-content",
371 "files to include inline between <body> and the content of a rendered \
372 Markdown file or generated documentation",
376 unstable("markdown-after-content", |o| {
379 "markdown-after-content",
380 "files to include inline between the content and </body> of a rendered \
381 Markdown file or generated documentation",
385 stable("markdown-playground-url", |o| {
386 o.optopt("", "markdown-playground-url", "URL to send code snippets to", "URL")
388 stable("markdown-no-toc", |o| {
389 o.optflagmulti("", "markdown-no-toc", "don't include table of contents")
395 "To add some CSS rules with a given file to generate doc with your \
396 own theme. However, your theme might break if the rustdoc's generated HTML \
397 changes, so be careful!",
402 o.optmulti("Z", "", "internal and debugging options (only on nightly build)", "FLAG")
404 stable("sysroot", |o| o.optopt("", "sysroot", "Override the system root", "PATH")),
405 unstable("playground-url", |o| {
409 "URL to send code snippets to, may be reset by --markdown-playground-url \
410 or `#![doc(html_playground_url=...)]`",
414 unstable("display-warnings", |o| {
415 o.optflagmulti("", "display-warnings", "to print code warnings when testing doc")
417 stable("crate-version", |o| {
418 o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
420 unstable("sort-modules-by-appearance", |o| {
423 "sort-modules-by-appearance",
424 "sort modules by where they appear in the program, rather than alphabetically",
427 stable("default-theme", |o| {
431 "Set the default theme. THEME should be the theme name, generally lowercase. \
432 If an unknown default theme is specified, the builtin default is used. \
433 The set of themes, and the rustdoc built-in default, are not stable.",
437 unstable("default-setting", |o| {
441 "Default value for a rustdoc setting (used when \"rustdoc-SETTING\" is absent \
442 from web browser Local Storage). If VALUE is not supplied, \"true\" is used. \
443 Supported SETTINGs and VALUEs are not documented and not stable.",
447 stable("theme", |o| {
451 "additional themes which will be added to the generated docs",
455 stable("check-theme", |o| {
456 o.optmulti("", "check-theme", "check if given theme is valid", "FILES")
458 unstable("resource-suffix", |o| {
462 "suffix to add to CSS and JavaScript files, e.g., \"light.css\" will become \
463 \"light-suffix.css\"",
467 stable("edition", |o| {
471 "edition to use when compiling rust code (default: 2015)",
475 stable("color", |o| {
479 "Configure coloring of output:
480 auto = colorize, if output goes to a tty (default);
481 always = always colorize output;
482 never = never colorize output",
486 stable("error-format", |o| {
490 "How errors and other messages are produced",
495 o.optopt("", "json", "Configure the structure of JSON diagnostics", "CONFIG")
497 unstable("disable-minification", |o| {
498 o.optflagmulti("", "disable-minification", "Disable minification applied on JS files")
500 stable("warn", |o| o.optmulti("W", "warn", "Set lint warnings", "OPT")),
501 stable("allow", |o| o.optmulti("A", "allow", "Set lint allowed", "OPT")),
502 stable("deny", |o| o.optmulti("D", "deny", "Set lint denied", "OPT")),
503 stable("forbid", |o| o.optmulti("F", "forbid", "Set lint forbidden", "OPT")),
504 stable("cap-lints", |o| {
508 "Set the most restrictive lint level. \
509 More restrictive lints are capped at this \
510 level. By default, it is at `forbid` level.",
514 unstable("force-warns", |o| {
518 "Lints that will warn even if allowed somewhere else",
522 unstable("index-page", |o| {
523 o.optopt("", "index-page", "Markdown file to be used as index page", "PATH")
525 unstable("enable-index-page", |o| {
526 o.optflagmulti("", "enable-index-page", "To enable generation of the index page")
528 unstable("static-root-path", |o| {
532 "Path string to force loading static files from in output pages. \
533 If not set, uses combinations of '../' to reach the documentation root.",
537 unstable("disable-per-crate-search", |o| {
540 "disable-per-crate-search",
541 "disables generating the crate selector on the search box",
544 unstable("persist-doctests", |o| {
548 "Directory to persist doctest executables into",
552 unstable("show-coverage", |o| {
556 "calculate percentage of public items with documentation",
559 unstable("enable-per-target-ignores", |o| {
562 "enable-per-target-ignores",
563 "parse ignore-foo for ignoring doctests on a per-target basis",
566 unstable("runtool", |o| {
571 "The tool to run tests with when building for a different target than host",
574 unstable("runtool-arg", |o| {
579 "One (of possibly many) arguments to pass to the runtool",
582 unstable("test-builder", |o| {
583 o.optopt("", "test-builder", "The rustc-like binary to use as the test builder", "PATH")
585 unstable("check", |o| o.optflagmulti("", "check", "Run rustdoc checks")),
586 unstable("generate-redirect-map", |o| {
589 "generate-redirect-map",
590 "Generate JSON file at the top level instead of generating HTML redirection files",
593 unstable("emit", |o| {
597 "Comma separated list of types of output for rustdoc to emit",
598 "[unversioned-shared-resources,toolchain-shared-resources,invocation-specific]",
601 unstable("no-run", |o| {
602 o.optflagmulti("", "no-run", "Compile doctests without running them")
604 unstable("show-type-layout", |o| {
605 o.optflagmulti("", "show-type-layout", "Include the memory layout of types in the docs")
610 fn usage(argv0: &str) {
611 let mut options = getopts::Options::new();
612 for option in opts() {
613 (option.apply)(&mut options);
615 println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
616 println!(" @path Read newline separated options from `path`\n");
618 "More information available at {}/rustdoc/what-is-rustdoc.html",
619 DOC_RUST_LANG_ORG_CHANNEL
623 /// A result type used by several functions under `main()`.
624 type MainResult = Result<(), ErrorReported>;
626 fn main_args(at_args: &[String]) -> MainResult {
627 let args = rustc_driver::args::arg_expand_all(at_args);
629 let mut options = getopts::Options::new();
630 for option in opts() {
631 (option.apply)(&mut options);
633 let matches = match options.parse(&args[1..]) {
636 early_error(ErrorOutputType::default(), &err.to_string());
640 // Note that we discard any distinction between different non-zero exit
641 // codes from `from_matches` here.
642 let options = match config::Options::from_matches(&matches) {
644 Err(code) => return if code == 0 { Ok(()) } else { Err(ErrorReported) },
646 rustc_interface::util::setup_callbacks_and_run_in_thread_pool_with_globals(
648 1, // this runs single-threaded, even in a parallel compiler
650 move || main_options(options),
654 fn wrap_return(diag: &rustc_errors::Handler, res: Result<(), String>) -> MainResult {
658 diag.struct_err(&err).emit();
664 fn run_renderer<'tcx, T: formats::FormatRenderer<'tcx>>(
666 renderopts: config::RenderOptions,
667 cache: formats::cache::Cache,
670 match formats::run_format::<T>(krate, renderopts, cache, tcx) {
674 tcx.sess.struct_err(&format!("couldn't generate documentation: {}", e.error));
675 let file = e.file.display().to_string();
679 msg.note(&format!("failed to create or modify \"{}\"", file)).emit()
686 fn main_options(options: config::Options) -> MainResult {
687 let diag = core::new_handler(options.error_format, None, &options.debugging_opts);
689 match (options.should_test, options.markdown_input()) {
690 (true, true) => return wrap_return(&diag, markdown::test(options)),
691 (true, false) => return doctest::run(options),
695 markdown::render(&options.input, options.render_options, options.edition),
701 // need to move these items separately because we lose them by the time the closure is called,
702 // but we can't create the Handler ahead of time because it's not Send
703 let show_coverage = options.show_coverage;
704 let run_check = options.run_check;
706 // First, parse the crate and extract all relevant information.
707 info!("starting to run rustc");
709 // Interpret the input file as a rust source file, passing it through the
710 // compiler all the way through the analysis passes. The rustdoc output is
711 // then generated from the cleaned AST of the crate. This runs all the
712 // plug/cleaning passes.
713 let crate_version = options.crate_version.clone();
715 let default_passes = options.default_passes;
716 let output_format = options.output_format;
717 // FIXME: fix this clone (especially render_options)
718 let externs = options.externs.clone();
719 let manual_passes = options.manual_passes.clone();
720 let render_options = options.render_options.clone();
721 let config = core::create_config(options);
723 interface::create_compiler_and_run(config, |compiler| {
724 compiler.enter(|queries| {
725 let sess = compiler.session();
727 if sess.opts.describe_lints {
728 let (_, lint_store) = &*queries.register_plugins()?.peek();
729 describe_lints(sess, lint_store, true);
733 // We need to hold on to the complete resolver, so we cause everything to be
734 // cloned for the analysis passes to use. Suboptimal, but necessary in the
735 // current architecture.
736 let resolver = core::create_resolver(externs, queries, &sess);
738 if sess.has_errors() {
739 sess.fatal("Compilation failed, aborting rustdoc");
742 let mut global_ctxt = abort_on_err(queries.global_ctxt(), sess).peek_mut();
744 global_ctxt.enter(|tcx| {
745 let (krate, render_opts, mut cache) = sess.time("run_global_ctxt", || {
746 core::run_global_ctxt(
755 info!("finished with rustc");
757 cache.crate_version = crate_version;
760 // if we ran coverage, bail early, we don't need to also generate docs at this point
761 // (also we didn't load in any of the useful passes)
763 } else if run_check {
764 // Since we're in "check" mode, no need to generate anything beyond this point.
768 info!("going to format");
769 match output_format {
770 config::OutputFormat::Html => sess.time("render_html", || {
771 run_renderer::<html::render::Context<'_>>(krate, render_opts, cache, tcx)
773 config::OutputFormat::Json => sess.time("render_json", || {
774 run_renderer::<json::JsonRenderer<'_>>(krate, render_opts, cache, tcx)