]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_interface/src/util.rs
Merge set_panic and set_print into set_output_capture.
[rust.git] / compiler / rustc_interface / src / util.rs
1 use rustc_ast::mut_visit::{visit_clobber, MutVisitor, *};
2 use rustc_ast::ptr::P;
3 use rustc_ast::util::lev_distance::find_best_match_for_name;
4 use rustc_ast::{self as ast, AttrVec, BlockCheckMode};
5 use rustc_codegen_ssa::traits::CodegenBackend;
6 use rustc_data_structures::fingerprint::Fingerprint;
7 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
8 #[cfg(parallel_compiler)]
9 use rustc_data_structures::jobserver;
10 use rustc_data_structures::stable_hasher::StableHasher;
11 use rustc_data_structures::sync::Lrc;
12 use rustc_errors::registry::Registry;
13 use rustc_metadata::dynamic_lib::DynamicLibrary;
14 use rustc_resolve::{self, Resolver};
15 use rustc_session as session;
16 use rustc_session::config::{self, CrateType};
17 use rustc_session::config::{ErrorOutputType, Input, OutputFilenames};
18 use rustc_session::lint::{self, BuiltinLintDiagnostics, LintBuffer};
19 use rustc_session::parse::CrateConfig;
20 use rustc_session::CrateDisambiguator;
21 use rustc_session::{early_error, filesearch, output, DiagnosticOutput, Session};
22 use rustc_span::edition::Edition;
23 use rustc_span::source_map::FileLoader;
24 use rustc_span::symbol::{sym, Symbol};
25 use smallvec::SmallVec;
26 use std::env;
27 use std::env::consts::{DLL_PREFIX, DLL_SUFFIX};
28 use std::io;
29 use std::lazy::SyncOnceCell;
30 use std::mem;
31 use std::ops::DerefMut;
32 use std::path::{Path, PathBuf};
33 use std::sync::atomic::{AtomicBool, Ordering};
34 use std::sync::{Arc, Mutex, Once};
35 #[cfg(not(parallel_compiler))]
36 use std::{panic, thread};
37 use tracing::info;
38
39 /// Adds `target_feature = "..."` cfgs for a variety of platform
40 /// specific features (SSE, NEON etc.).
41 ///
42 /// This is performed by checking whether a set of permitted features
43 /// is available on the target machine, by querying LLVM.
44 pub fn add_configuration(
45     cfg: &mut CrateConfig,
46     sess: &mut Session,
47     codegen_backend: &dyn CodegenBackend,
48 ) {
49     let tf = sym::target_feature;
50
51     let target_features = codegen_backend.target_features(sess);
52     sess.target_features.extend(target_features.iter().cloned());
53
54     cfg.extend(target_features.into_iter().map(|feat| (tf, Some(feat))));
55
56     if sess.crt_static(None) {
57         cfg.insert((tf, Some(sym::crt_dash_static)));
58     }
59 }
60
61 pub fn create_session(
62     sopts: config::Options,
63     cfg: FxHashSet<(String, Option<String>)>,
64     diagnostic_output: DiagnosticOutput,
65     file_loader: Option<Box<dyn FileLoader + Send + Sync + 'static>>,
66     input_path: Option<PathBuf>,
67     lint_caps: FxHashMap<lint::LintId, lint::Level>,
68     make_codegen_backend: Option<
69         Box<dyn FnOnce(&config::Options) -> Box<dyn CodegenBackend> + Send>,
70     >,
71     descriptions: Registry,
72 ) -> (Lrc<Session>, Lrc<Box<dyn CodegenBackend>>) {
73     let codegen_backend = if let Some(make_codegen_backend) = make_codegen_backend {
74         make_codegen_backend(&sopts)
75     } else {
76         get_codegen_backend(&sopts)
77     };
78
79     // target_override is documented to be called before init(), so this is okay
80     let target_override = codegen_backend.target_override(&sopts);
81
82     let mut sess = session::build_session(
83         sopts,
84         input_path,
85         descriptions,
86         diagnostic_output,
87         lint_caps,
88         file_loader,
89         target_override,
90     );
91
92     codegen_backend.init(&sess);
93
94     let mut cfg = config::build_configuration(&sess, config::to_crate_config(cfg));
95     add_configuration(&mut cfg, &mut sess, &*codegen_backend);
96     sess.parse_sess.config = cfg;
97
98     (Lrc::new(sess), Lrc::new(codegen_backend))
99 }
100
101 const STACK_SIZE: usize = 8 * 1024 * 1024;
102
103 fn get_stack_size() -> Option<usize> {
104     // FIXME: Hacks on hacks. If the env is trying to override the stack size
105     // then *don't* set it explicitly.
106     env::var_os("RUST_MIN_STACK").is_none().then_some(STACK_SIZE)
107 }
108
109 /// Like a `thread::Builder::spawn` followed by a `join()`, but avoids the need
110 /// for `'static` bounds.
111 #[cfg(not(parallel_compiler))]
112 pub fn scoped_thread<F: FnOnce() -> R + Send, R: Send>(cfg: thread::Builder, f: F) -> R {
113     struct Ptr(*mut ());
114     unsafe impl Send for Ptr {}
115     unsafe impl Sync for Ptr {}
116
117     let mut f = Some(f);
118     let run = Ptr(&mut f as *mut _ as *mut ());
119     let mut result = None;
120     let result_ptr = Ptr(&mut result as *mut _ as *mut ());
121
122     let thread = cfg.spawn(move || {
123         let run = unsafe { (*(run.0 as *mut Option<F>)).take().unwrap() };
124         let result = unsafe { &mut *(result_ptr.0 as *mut Option<R>) };
125         *result = Some(run());
126     });
127
128     match thread.unwrap().join() {
129         Ok(()) => result.unwrap(),
130         Err(p) => panic::resume_unwind(p),
131     }
132 }
133
134 #[cfg(not(parallel_compiler))]
135 pub fn setup_callbacks_and_run_in_thread_pool_with_globals<F: FnOnce() -> R + Send, R: Send>(
136     edition: Edition,
137     _threads: usize,
138     stderr: &Option<Arc<Mutex<Vec<u8>>>>,
139     f: F,
140 ) -> R {
141     let mut cfg = thread::Builder::new().name("rustc".to_string());
142
143     if let Some(size) = get_stack_size() {
144         cfg = cfg.stack_size(size);
145     }
146
147     crate::callbacks::setup_callbacks();
148
149     let main_handler = move || {
150         rustc_span::with_session_globals(edition, || {
151             io::set_output_capture(stderr.clone());
152             f()
153         })
154     };
155
156     scoped_thread(cfg, main_handler)
157 }
158
159 #[cfg(parallel_compiler)]
160 pub fn setup_callbacks_and_run_in_thread_pool_with_globals<F: FnOnce() -> R + Send, R: Send>(
161     edition: Edition,
162     threads: usize,
163     stderr: &Option<Arc<Mutex<Vec<u8>>>>,
164     f: F,
165 ) -> R {
166     use rustc_middle::ty;
167     crate::callbacks::setup_callbacks();
168
169     let mut config = rayon::ThreadPoolBuilder::new()
170         .thread_name(|_| "rustc".to_string())
171         .acquire_thread_handler(jobserver::acquire_thread)
172         .release_thread_handler(jobserver::release_thread)
173         .num_threads(threads)
174         .deadlock_handler(|| unsafe { ty::query::handle_deadlock() });
175
176     if let Some(size) = get_stack_size() {
177         config = config.stack_size(size);
178     }
179
180     let with_pool = move |pool: &rayon::ThreadPool| pool.install(f);
181
182     rustc_span::with_session_globals(edition, || {
183         rustc_span::SESSION_GLOBALS.with(|session_globals| {
184             // The main handler runs for each Rayon worker thread and sets up
185             // the thread local rustc uses. `session_globals` is captured and set
186             // on the new threads.
187             let main_handler = move |thread: rayon::ThreadBuilder| {
188                 rustc_span::SESSION_GLOBALS.set(session_globals, || {
189                     io::set_output_capture(stderr.clone());
190                     thread.run()
191                 })
192             };
193
194             config.build_scoped(main_handler, with_pool).unwrap()
195         })
196     })
197 }
198
199 fn load_backend_from_dylib(path: &Path) -> fn() -> Box<dyn CodegenBackend> {
200     let lib = DynamicLibrary::open(path).unwrap_or_else(|err| {
201         let err = format!("couldn't load codegen backend {:?}: {:?}", path, err);
202         early_error(ErrorOutputType::default(), &err);
203     });
204     unsafe {
205         match lib.symbol("__rustc_codegen_backend") {
206             Ok(f) => {
207                 mem::forget(lib);
208                 mem::transmute::<*mut u8, _>(f)
209             }
210             Err(e) => {
211                 let err = format!(
212                     "couldn't load codegen backend as it \
213                                    doesn't export the `__rustc_codegen_backend` \
214                                    symbol: {:?}",
215                     e
216                 );
217                 early_error(ErrorOutputType::default(), &err);
218             }
219         }
220     }
221 }
222
223 pub fn get_codegen_backend(sopts: &config::Options) -> Box<dyn CodegenBackend> {
224     static INIT: Once = Once::new();
225
226     static mut LOAD: fn() -> Box<dyn CodegenBackend> = || unreachable!();
227
228     INIT.call_once(|| {
229         #[cfg(feature = "llvm")]
230         const DEFAULT_CODEGEN_BACKEND: &str = "llvm";
231
232         #[cfg(not(feature = "llvm"))]
233         const DEFAULT_CODEGEN_BACKEND: &str = "cranelift";
234
235         let codegen_name = sopts
236             .debugging_opts
237             .codegen_backend
238             .as_ref()
239             .map(|name| &name[..])
240             .unwrap_or(DEFAULT_CODEGEN_BACKEND);
241
242         let backend = match codegen_name {
243             filename if filename.contains('.') => load_backend_from_dylib(filename.as_ref()),
244             codegen_name => get_builtin_codegen_backend(codegen_name),
245         };
246
247         unsafe {
248             LOAD = backend;
249         }
250     });
251     unsafe { LOAD() }
252 }
253
254 // This is used for rustdoc, but it uses similar machinery to codegen backend
255 // loading, so we leave the code here. It is potentially useful for other tools
256 // that want to invoke the rustc binary while linking to rustc as well.
257 pub fn rustc_path<'a>() -> Option<&'a Path> {
258     static RUSTC_PATH: SyncOnceCell<Option<PathBuf>> = SyncOnceCell::new();
259
260     const BIN_PATH: &str = env!("RUSTC_INSTALL_BINDIR");
261
262     RUSTC_PATH.get_or_init(|| get_rustc_path_inner(BIN_PATH)).as_ref().map(|v| &**v)
263 }
264
265 fn get_rustc_path_inner(bin_path: &str) -> Option<PathBuf> {
266     sysroot_candidates().iter().find_map(|sysroot| {
267         let candidate = sysroot.join(bin_path).join(if cfg!(target_os = "windows") {
268             "rustc.exe"
269         } else {
270             "rustc"
271         });
272         candidate.exists().then_some(candidate)
273     })
274 }
275
276 fn sysroot_candidates() -> Vec<PathBuf> {
277     let target = session::config::host_triple();
278     let mut sysroot_candidates = vec![filesearch::get_or_default_sysroot()];
279     let path = current_dll_path().and_then(|s| s.canonicalize().ok());
280     if let Some(dll) = path {
281         // use `parent` twice to chop off the file name and then also the
282         // directory containing the dll which should be either `lib` or `bin`.
283         if let Some(path) = dll.parent().and_then(|p| p.parent()) {
284             // The original `path` pointed at the `rustc_driver` crate's dll.
285             // Now that dll should only be in one of two locations. The first is
286             // in the compiler's libdir, for example `$sysroot/lib/*.dll`. The
287             // other is the target's libdir, for example
288             // `$sysroot/lib/rustlib/$target/lib/*.dll`.
289             //
290             // We don't know which, so let's assume that if our `path` above
291             // ends in `$target` we *could* be in the target libdir, and always
292             // assume that we may be in the main libdir.
293             sysroot_candidates.push(path.to_owned());
294
295             if path.ends_with(target) {
296                 sysroot_candidates.extend(
297                     path.parent() // chop off `$target`
298                         .and_then(|p| p.parent()) // chop off `rustlib`
299                         .and_then(|p| p.parent()) // chop off `lib`
300                         .map(|s| s.to_owned()),
301                 );
302             }
303         }
304     }
305
306     return sysroot_candidates;
307
308     #[cfg(unix)]
309     fn current_dll_path() -> Option<PathBuf> {
310         use std::ffi::{CStr, OsStr};
311         use std::os::unix::prelude::*;
312
313         unsafe {
314             let addr = current_dll_path as usize as *mut _;
315             let mut info = mem::zeroed();
316             if libc::dladdr(addr, &mut info) == 0 {
317                 info!("dladdr failed");
318                 return None;
319             }
320             if info.dli_fname.is_null() {
321                 info!("dladdr returned null pointer");
322                 return None;
323             }
324             let bytes = CStr::from_ptr(info.dli_fname).to_bytes();
325             let os = OsStr::from_bytes(bytes);
326             Some(PathBuf::from(os))
327         }
328     }
329
330     #[cfg(windows)]
331     fn current_dll_path() -> Option<PathBuf> {
332         use std::ffi::OsString;
333         use std::os::windows::prelude::*;
334         use std::ptr;
335
336         use winapi::um::libloaderapi::{
337             GetModuleFileNameW, GetModuleHandleExW, GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
338         };
339
340         unsafe {
341             let mut module = ptr::null_mut();
342             let r = GetModuleHandleExW(
343                 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
344                 current_dll_path as usize as *mut _,
345                 &mut module,
346             );
347             if r == 0 {
348                 info!("GetModuleHandleExW failed: {}", io::Error::last_os_error());
349                 return None;
350             }
351             let mut space = Vec::with_capacity(1024);
352             let r = GetModuleFileNameW(module, space.as_mut_ptr(), space.capacity() as u32);
353             if r == 0 {
354                 info!("GetModuleFileNameW failed: {}", io::Error::last_os_error());
355                 return None;
356             }
357             let r = r as usize;
358             if r >= space.capacity() {
359                 info!("our buffer was too small? {}", io::Error::last_os_error());
360                 return None;
361             }
362             space.set_len(r);
363             let os = OsString::from_wide(&space);
364             Some(PathBuf::from(os))
365         }
366     }
367 }
368
369 pub fn get_builtin_codegen_backend(backend_name: &str) -> fn() -> Box<dyn CodegenBackend> {
370     match backend_name {
371         #[cfg(feature = "llvm")]
372         "llvm" => rustc_codegen_llvm::LlvmCodegenBackend::new,
373         _ => get_codegen_sysroot(backend_name),
374     }
375 }
376
377 pub fn get_codegen_sysroot(backend_name: &str) -> fn() -> Box<dyn CodegenBackend> {
378     // For now we only allow this function to be called once as it'll dlopen a
379     // few things, which seems to work best if we only do that once. In
380     // general this assertion never trips due to the once guard in `get_codegen_backend`,
381     // but there's a few manual calls to this function in this file we protect
382     // against.
383     static LOADED: AtomicBool = AtomicBool::new(false);
384     assert!(
385         !LOADED.fetch_or(true, Ordering::SeqCst),
386         "cannot load the default codegen backend twice"
387     );
388
389     let target = session::config::host_triple();
390     let sysroot_candidates = sysroot_candidates();
391
392     let sysroot = sysroot_candidates
393         .iter()
394         .map(|sysroot| {
395             let libdir = filesearch::relative_target_lib_path(&sysroot, &target);
396             sysroot.join(libdir).with_file_name("codegen-backends")
397         })
398         .find(|f| {
399             info!("codegen backend candidate: {}", f.display());
400             f.exists()
401         });
402     let sysroot = sysroot.unwrap_or_else(|| {
403         let candidates = sysroot_candidates
404             .iter()
405             .map(|p| p.display().to_string())
406             .collect::<Vec<_>>()
407             .join("\n* ");
408         let err = format!(
409             "failed to find a `codegen-backends` folder \
410                            in the sysroot candidates:\n* {}",
411             candidates
412         );
413         early_error(ErrorOutputType::default(), &err);
414     });
415     info!("probing {} for a codegen backend", sysroot.display());
416
417     let d = sysroot.read_dir().unwrap_or_else(|e| {
418         let err = format!(
419             "failed to load default codegen backend, couldn't \
420                            read `{}`: {}",
421             sysroot.display(),
422             e
423         );
424         early_error(ErrorOutputType::default(), &err);
425     });
426
427     let mut file: Option<PathBuf> = None;
428
429     let expected_name =
430         format!("rustc_codegen_{}-{}", backend_name, release_str().expect("CFG_RELEASE"));
431     for entry in d.filter_map(|e| e.ok()) {
432         let path = entry.path();
433         let filename = match path.file_name().and_then(|s| s.to_str()) {
434             Some(s) => s,
435             None => continue,
436         };
437         if !(filename.starts_with(DLL_PREFIX) && filename.ends_with(DLL_SUFFIX)) {
438             continue;
439         }
440         let name = &filename[DLL_PREFIX.len()..filename.len() - DLL_SUFFIX.len()];
441         if name != expected_name {
442             continue;
443         }
444         if let Some(ref prev) = file {
445             let err = format!(
446                 "duplicate codegen backends found\n\
447                                first:  {}\n\
448                                second: {}\n\
449             ",
450                 prev.display(),
451                 path.display()
452             );
453             early_error(ErrorOutputType::default(), &err);
454         }
455         file = Some(path.clone());
456     }
457
458     match file {
459         Some(ref s) => load_backend_from_dylib(s),
460         None => {
461             let err = format!("unsupported builtin codegen backend `{}`", backend_name);
462             early_error(ErrorOutputType::default(), &err);
463         }
464     }
465 }
466
467 pub(crate) fn compute_crate_disambiguator(session: &Session) -> CrateDisambiguator {
468     use std::hash::Hasher;
469
470     // The crate_disambiguator is a 128 bit hash. The disambiguator is fed
471     // into various other hashes quite a bit (symbol hashes, incr. comp. hashes,
472     // debuginfo type IDs, etc), so we don't want it to be too wide. 128 bits
473     // should still be safe enough to avoid collisions in practice.
474     let mut hasher = StableHasher::new();
475
476     let mut metadata = session.opts.cg.metadata.clone();
477     // We don't want the crate_disambiguator to dependent on the order
478     // -C metadata arguments, so sort them:
479     metadata.sort();
480     // Every distinct -C metadata value is only incorporated once:
481     metadata.dedup();
482
483     hasher.write(b"metadata");
484     for s in &metadata {
485         // Also incorporate the length of a metadata string, so that we generate
486         // different values for `-Cmetadata=ab -Cmetadata=c` and
487         // `-Cmetadata=a -Cmetadata=bc`
488         hasher.write_usize(s.len());
489         hasher.write(s.as_bytes());
490     }
491
492     // Also incorporate crate type, so that we don't get symbol conflicts when
493     // linking against a library of the same name, if this is an executable.
494     let is_exe = session.crate_types().contains(&CrateType::Executable);
495     hasher.write(if is_exe { b"exe" } else { b"lib" });
496
497     CrateDisambiguator::from(hasher.finish::<Fingerprint>())
498 }
499
500 pub(crate) fn check_attr_crate_type(
501     sess: &Session,
502     attrs: &[ast::Attribute],
503     lint_buffer: &mut LintBuffer,
504 ) {
505     // Unconditionally collect crate types from attributes to make them used
506     for a in attrs.iter() {
507         if sess.check_name(a, sym::crate_type) {
508             if let Some(n) = a.value_str() {
509                 if categorize_crate_type(n).is_some() {
510                     return;
511                 }
512
513                 if let ast::MetaItemKind::NameValue(spanned) = a.meta().unwrap().kind {
514                     let span = spanned.span;
515                     let lev_candidate =
516                         find_best_match_for_name(CRATE_TYPES.iter().map(|(k, _)| k), n, None);
517                     if let Some(candidate) = lev_candidate {
518                         lint_buffer.buffer_lint_with_diagnostic(
519                             lint::builtin::UNKNOWN_CRATE_TYPES,
520                             ast::CRATE_NODE_ID,
521                             span,
522                             "invalid `crate_type` value",
523                             BuiltinLintDiagnostics::UnknownCrateTypes(
524                                 span,
525                                 "did you mean".to_string(),
526                                 format!("\"{}\"", candidate),
527                             ),
528                         );
529                     } else {
530                         lint_buffer.buffer_lint(
531                             lint::builtin::UNKNOWN_CRATE_TYPES,
532                             ast::CRATE_NODE_ID,
533                             span,
534                             "invalid `crate_type` value",
535                         );
536                     }
537                 }
538             }
539         }
540     }
541 }
542
543 const CRATE_TYPES: &[(Symbol, CrateType)] = &[
544     (sym::rlib, CrateType::Rlib),
545     (sym::dylib, CrateType::Dylib),
546     (sym::cdylib, CrateType::Cdylib),
547     (sym::lib, config::default_lib_output()),
548     (sym::staticlib, CrateType::Staticlib),
549     (sym::proc_dash_macro, CrateType::ProcMacro),
550     (sym::bin, CrateType::Executable),
551 ];
552
553 fn categorize_crate_type(s: Symbol) -> Option<CrateType> {
554     Some(CRATE_TYPES.iter().find(|(key, _)| *key == s)?.1)
555 }
556
557 pub fn collect_crate_types(session: &Session, attrs: &[ast::Attribute]) -> Vec<CrateType> {
558     // Unconditionally collect crate types from attributes to make them used
559     let attr_types: Vec<CrateType> = attrs
560         .iter()
561         .filter_map(|a| {
562             if session.check_name(a, sym::crate_type) {
563                 match a.value_str() {
564                     Some(s) => categorize_crate_type(s),
565                     _ => None,
566                 }
567             } else {
568                 None
569             }
570         })
571         .collect();
572
573     // If we're generating a test executable, then ignore all other output
574     // styles at all other locations
575     if session.opts.test {
576         return vec![CrateType::Executable];
577     }
578
579     // Only check command line flags if present. If no types are specified by
580     // command line, then reuse the empty `base` Vec to hold the types that
581     // will be found in crate attributes.
582     let mut base = session.opts.crate_types.clone();
583     if base.is_empty() {
584         base.extend(attr_types);
585         if base.is_empty() {
586             base.push(output::default_output_for_target(session));
587         } else {
588             base.sort();
589             base.dedup();
590         }
591     }
592
593     base.retain(|crate_type| {
594         let res = !output::invalid_output_for_target(session, *crate_type);
595
596         if !res {
597             session.warn(&format!(
598                 "dropping unsupported crate type `{}` for target `{}`",
599                 *crate_type, session.opts.target_triple
600             ));
601         }
602
603         res
604     });
605
606     base
607 }
608
609 pub fn build_output_filenames(
610     input: &Input,
611     odir: &Option<PathBuf>,
612     ofile: &Option<PathBuf>,
613     attrs: &[ast::Attribute],
614     sess: &Session,
615 ) -> OutputFilenames {
616     match *ofile {
617         None => {
618             // "-" as input file will cause the parser to read from stdin so we
619             // have to make up a name
620             // We want to toss everything after the final '.'
621             let dirpath = (*odir).as_ref().cloned().unwrap_or_default();
622
623             // If a crate name is present, we use it as the link name
624             let stem = sess
625                 .opts
626                 .crate_name
627                 .clone()
628                 .or_else(|| rustc_attr::find_crate_name(&sess, attrs).map(|n| n.to_string()))
629                 .unwrap_or_else(|| input.filestem().to_owned());
630
631             OutputFilenames::new(
632                 dirpath,
633                 stem,
634                 None,
635                 sess.opts.cg.extra_filename.clone(),
636                 sess.opts.output_types.clone(),
637             )
638         }
639
640         Some(ref out_file) => {
641             let unnamed_output_types =
642                 sess.opts.output_types.values().filter(|a| a.is_none()).count();
643             let ofile = if unnamed_output_types > 1 {
644                 sess.warn(
645                     "due to multiple output types requested, the explicitly specified \
646                      output file name will be adapted for each output type",
647                 );
648                 None
649             } else {
650                 if !sess.opts.cg.extra_filename.is_empty() {
651                     sess.warn("ignoring -C extra-filename flag due to -o flag");
652                 }
653                 Some(out_file.clone())
654             };
655             if *odir != None {
656                 sess.warn("ignoring --out-dir flag due to -o flag");
657             }
658
659             OutputFilenames::new(
660                 out_file.parent().unwrap_or_else(|| Path::new("")).to_path_buf(),
661                 out_file.file_stem().unwrap_or_default().to_str().unwrap().to_string(),
662                 ofile,
663                 sess.opts.cg.extra_filename.clone(),
664                 sess.opts.output_types.clone(),
665             )
666         }
667     }
668 }
669
670 // Note: Also used by librustdoc, see PR #43348. Consider moving this struct elsewhere.
671 //
672 // FIXME: Currently the `everybody_loops` transformation is not applied to:
673 //  * `const fn`, due to issue #43636 that `loop` is not supported for const evaluation. We are
674 //    waiting for miri to fix that.
675 //  * `impl Trait`, due to issue #43869 that functions returning impl Trait cannot be diverging.
676 //    Solving this may require `!` to implement every trait, which relies on the an even more
677 //    ambitious form of the closed RFC #1637. See also [#34511].
678 //
679 // [#34511]: https://github.com/rust-lang/rust/issues/34511#issuecomment-322340401
680 pub struct ReplaceBodyWithLoop<'a, 'b> {
681     within_static_or_const: bool,
682     nested_blocks: Option<Vec<ast::Block>>,
683     resolver: &'a mut Resolver<'b>,
684 }
685
686 impl<'a, 'b> ReplaceBodyWithLoop<'a, 'b> {
687     pub fn new(resolver: &'a mut Resolver<'b>) -> ReplaceBodyWithLoop<'a, 'b> {
688         ReplaceBodyWithLoop { within_static_or_const: false, nested_blocks: None, resolver }
689     }
690
691     fn run<R, F: FnOnce(&mut Self) -> R>(&mut self, is_const: bool, action: F) -> R {
692         let old_const = mem::replace(&mut self.within_static_or_const, is_const);
693         let old_blocks = self.nested_blocks.take();
694         let ret = action(self);
695         self.within_static_or_const = old_const;
696         self.nested_blocks = old_blocks;
697         ret
698     }
699
700     fn should_ignore_fn(ret_ty: &ast::FnRetTy) -> bool {
701         if let ast::FnRetTy::Ty(ref ty) = ret_ty {
702             fn involves_impl_trait(ty: &ast::Ty) -> bool {
703                 match ty.kind {
704                     ast::TyKind::ImplTrait(..) => true,
705                     ast::TyKind::Slice(ref subty)
706                     | ast::TyKind::Array(ref subty, _)
707                     | ast::TyKind::Ptr(ast::MutTy { ty: ref subty, .. })
708                     | ast::TyKind::Rptr(_, ast::MutTy { ty: ref subty, .. })
709                     | ast::TyKind::Paren(ref subty) => involves_impl_trait(subty),
710                     ast::TyKind::Tup(ref tys) => any_involves_impl_trait(tys.iter()),
711                     ast::TyKind::Path(_, ref path) => {
712                         path.segments.iter().any(|seg| match seg.args.as_deref() {
713                             None => false,
714                             Some(&ast::GenericArgs::AngleBracketed(ref data)) => {
715                                 data.args.iter().any(|arg| match arg {
716                                     ast::AngleBracketedArg::Arg(arg) => match arg {
717                                         ast::GenericArg::Type(ty) => involves_impl_trait(ty),
718                                         ast::GenericArg::Lifetime(_)
719                                         | ast::GenericArg::Const(_) => false,
720                                     },
721                                     ast::AngleBracketedArg::Constraint(c) => match c.kind {
722                                         ast::AssocTyConstraintKind::Bound { .. } => true,
723                                         ast::AssocTyConstraintKind::Equality { ref ty } => {
724                                             involves_impl_trait(ty)
725                                         }
726                                     },
727                                 })
728                             }
729                             Some(&ast::GenericArgs::Parenthesized(ref data)) => {
730                                 any_involves_impl_trait(data.inputs.iter())
731                                     || ReplaceBodyWithLoop::should_ignore_fn(&data.output)
732                             }
733                         })
734                     }
735                     _ => false,
736                 }
737             }
738
739             fn any_involves_impl_trait<'a, I: Iterator<Item = &'a P<ast::Ty>>>(mut it: I) -> bool {
740                 it.any(|subty| involves_impl_trait(subty))
741             }
742
743             involves_impl_trait(ty)
744         } else {
745             false
746         }
747     }
748
749     fn is_sig_const(sig: &ast::FnSig) -> bool {
750         matches!(sig.header.constness, ast::Const::Yes(_))
751             || ReplaceBodyWithLoop::should_ignore_fn(&sig.decl.output)
752     }
753 }
754
755 impl<'a> MutVisitor for ReplaceBodyWithLoop<'a, '_> {
756     fn visit_item_kind(&mut self, i: &mut ast::ItemKind) {
757         let is_const = match i {
758             ast::ItemKind::Static(..) | ast::ItemKind::Const(..) => true,
759             ast::ItemKind::Fn(_, ref sig, _, _) => Self::is_sig_const(sig),
760             _ => false,
761         };
762         self.run(is_const, |s| noop_visit_item_kind(i, s))
763     }
764
765     fn flat_map_trait_item(&mut self, i: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
766         let is_const = match i.kind {
767             ast::AssocItemKind::Const(..) => true,
768             ast::AssocItemKind::Fn(_, ref sig, _, _) => Self::is_sig_const(sig),
769             _ => false,
770         };
771         self.run(is_const, |s| noop_flat_map_assoc_item(i, s))
772     }
773
774     fn flat_map_impl_item(&mut self, i: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
775         self.flat_map_trait_item(i)
776     }
777
778     fn visit_anon_const(&mut self, c: &mut ast::AnonConst) {
779         self.run(true, |s| noop_visit_anon_const(c, s))
780     }
781
782     fn visit_block(&mut self, b: &mut P<ast::Block>) {
783         fn stmt_to_block(
784             rules: ast::BlockCheckMode,
785             s: Option<ast::Stmt>,
786             resolver: &mut Resolver<'_>,
787         ) -> ast::Block {
788             ast::Block {
789                 stmts: s.into_iter().collect(),
790                 rules,
791                 id: resolver.next_node_id(),
792                 span: rustc_span::DUMMY_SP,
793                 tokens: None,
794             }
795         }
796
797         fn block_to_stmt(b: ast::Block, resolver: &mut Resolver<'_>) -> ast::Stmt {
798             let expr = P(ast::Expr {
799                 id: resolver.next_node_id(),
800                 kind: ast::ExprKind::Block(P(b), None),
801                 span: rustc_span::DUMMY_SP,
802                 attrs: AttrVec::new(),
803                 tokens: None,
804             });
805
806             ast::Stmt {
807                 id: resolver.next_node_id(),
808                 kind: ast::StmtKind::Expr(expr),
809                 span: rustc_span::DUMMY_SP,
810                 tokens: None,
811             }
812         }
813
814         let empty_block = stmt_to_block(BlockCheckMode::Default, None, self.resolver);
815         let loop_expr = P(ast::Expr {
816             kind: ast::ExprKind::Loop(P(empty_block), None),
817             id: self.resolver.next_node_id(),
818             span: rustc_span::DUMMY_SP,
819             attrs: AttrVec::new(),
820             tokens: None,
821         });
822
823         let loop_stmt = ast::Stmt {
824             id: self.resolver.next_node_id(),
825             span: rustc_span::DUMMY_SP,
826             kind: ast::StmtKind::Expr(loop_expr),
827             tokens: None,
828         };
829
830         if self.within_static_or_const {
831             noop_visit_block(b, self)
832         } else {
833             visit_clobber(b.deref_mut(), |b| {
834                 let mut stmts = vec![];
835                 for s in b.stmts {
836                     let old_blocks = self.nested_blocks.replace(vec![]);
837
838                     stmts.extend(self.flat_map_stmt(s).into_iter().filter(|s| s.is_item()));
839
840                     // we put a Some in there earlier with that replace(), so this is valid
841                     let new_blocks = self.nested_blocks.take().unwrap();
842                     self.nested_blocks = old_blocks;
843                     stmts.extend(new_blocks.into_iter().map(|b| block_to_stmt(b, self.resolver)));
844                 }
845
846                 let mut new_block = ast::Block { stmts, ..b };
847
848                 if let Some(old_blocks) = self.nested_blocks.as_mut() {
849                     //push our fresh block onto the cache and yield an empty block with `loop {}`
850                     if !new_block.stmts.is_empty() {
851                         old_blocks.push(new_block);
852                     }
853
854                     stmt_to_block(b.rules, Some(loop_stmt), &mut self.resolver)
855                 } else {
856                     //push `loop {}` onto the end of our fresh block and yield that
857                     new_block.stmts.push(loop_stmt);
858
859                     new_block
860                 }
861             })
862         }
863     }
864 }
865
866 /// Returns a version string such as "rustc 1.46.0 (04488afe3 2020-08-24)"
867 pub fn version_str() -> Option<&'static str> {
868     option_env!("CFG_VERSION")
869 }
870
871 /// Returns a version string such as "0.12.0-dev".
872 pub fn release_str() -> Option<&'static str> {
873     option_env!("CFG_RELEASE")
874 }
875
876 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
877 pub fn commit_hash_str() -> Option<&'static str> {
878     option_env!("CFG_VER_HASH")
879 }
880
881 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
882 pub fn commit_date_str() -> Option<&'static str> {
883     option_env!("CFG_VER_DATE")
884 }