1 #![feature(rustc_private)]
3 extern crate rustc_middle;
4 extern crate rustc_driver;
5 extern crate rustc_hir;
6 extern crate rustc_interface;
7 extern crate rustc_session;
9 use std::convert::TryFrom;
11 use std::str::FromStr;
13 use hex::FromHexError;
16 use rustc_session::CtfeBacktrace;
17 use rustc_driver::Compilation;
18 use rustc_hir::def_id::LOCAL_CRATE;
19 use rustc_interface::{interface, Queries};
20 use rustc_middle::ty::TyCtxt;
22 struct MiriCompilerCalls {
23 miri_config: miri::MiriConfig,
26 impl rustc_driver::Callbacks for MiriCompilerCalls {
27 fn after_analysis<'tcx>(
29 compiler: &interface::Compiler,
30 queries: &'tcx Queries<'tcx>,
32 compiler.session().abort_if_errors();
34 queries.global_ctxt().unwrap().peek_mut().enter(|tcx| {
35 init_late_loggers(tcx);
36 let (entry_def_id, _) = tcx.entry_fn(LOCAL_CRATE).expect("no main function found!");
37 let mut config = self.miri_config.clone();
39 // Add filename to `miri` arguments.
40 config.args.insert(0, compiler.input().filestem().to_string());
42 if let Some(return_code) = miri::eval_main(tcx, entry_def_id, config) {
44 i32::try_from(return_code).expect("Return value was too large!"),
49 compiler.session().abort_if_errors();
55 fn init_early_loggers() {
56 // Note that our `extern crate log` is *not* the same as rustc's; as a result, we have to
57 // initialize them both, and we always initialize `miri`'s first.
58 let env = env_logger::Env::new().filter("MIRI_LOG").write_style("MIRI_LOG_STYLE");
59 env_logger::init_from_env(env);
60 // We only initialize `rustc` if the env var is set (so the user asked for it).
61 // If it is not set, we avoid initializing now so that we can initialize
62 // later with our custom settings, and *not* log anything for what happens before
63 // `miri` gets started.
64 if env::var("RUSTC_LOG").is_ok() {
65 rustc_driver::init_rustc_env_logger();
69 fn init_late_loggers(tcx: TyCtxt<'_>) {
70 // We initialize loggers right before we start evaluation. We overwrite the `RUSTC_LOG`
71 // env var if it is not set, control it based on `MIRI_LOG`.
72 if let Ok(var) = env::var("MIRI_LOG") {
73 if env::var("RUSTC_LOG").is_err() {
74 // We try to be a bit clever here: if `MIRI_LOG` is just a single level
75 // used for everything, we only apply it to the parts of rustc that are
76 // CTFE-related. Otherwise, we use it verbatim for `RUSTC_LOG`.
77 // This way, if you set `MIRI_LOG=trace`, you get only the right parts of
78 // rustc traced, but you can also do `MIRI_LOG=miri=trace,rustc_mir::interpret=debug`.
79 if log::Level::from_str(&var).is_ok() {
82 &format!("rustc_middle::mir::interpret={0},rustc_mir::interpret={0}", var),
85 env::set_var("RUSTC_LOG", &var);
87 rustc_driver::init_rustc_env_logger();
91 // If `MIRI_BACKTRACE` is set and `RUSTC_CTFE_BACKTRACE` is not, set `RUSTC_CTFE_BACKTRACE`.
92 // Do this late, so we ideally only apply this to Miri's errors.
93 if let Ok(val) = env::var("MIRI_BACKTRACE") {
94 let ctfe_backtrace = match &*val {
95 "immediate" => CtfeBacktrace::Immediate,
96 "0" => CtfeBacktrace::Disabled,
97 _ => CtfeBacktrace::Capture,
99 *tcx.sess.ctfe_backtrace.borrow_mut() = ctfe_backtrace;
103 /// Returns the "default sysroot" that Miri will use if no `--sysroot` flag is set.
104 /// Should be a compile-time constant.
105 fn compile_time_sysroot() -> Option<String> {
106 if option_env!("RUSTC_STAGE").is_some() {
107 // This is being built as part of rustc, and gets shipped with rustup.
108 // We can rely on the sysroot computation in librustc.
111 // For builds outside rustc, we need to ensure that we got a sysroot
112 // that gets used as a default. The sysroot computation in librustc would
113 // end up somewhere in the build dir.
114 // Taken from PR <https://github.com/Manishearth/rust-clippy/pull/911>.
115 let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
116 let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
117 Some(match (home, toolchain) {
118 (Some(home), Some(toolchain)) => format!("{}/toolchains/{}", home, toolchain),
119 _ => option_env!("RUST_SYSROOT")
120 .expect("To build Miri without rustup, set the `RUST_SYSROOT` env var at build time")
126 init_early_loggers();
128 // Parse our arguments and split them across `rustc` and `miri`.
129 let mut validate = true;
130 let mut stacked_borrows = true;
131 let mut communicate = false;
132 let mut ignore_leaks = false;
133 let mut seed: Option<u64> = None;
134 let mut tracked_pointer_tag: Option<miri::PtrId> = None;
135 let mut tracked_alloc_id: Option<miri::AllocId> = None;
136 let mut rustc_args = vec![];
137 let mut miri_args = vec![];
138 let mut after_dashdash = false;
139 let mut excluded_env_vars = vec![];
140 for arg in std::env::args() {
141 if rustc_args.is_empty() {
142 // Very first arg: for `rustc`.
143 rustc_args.push(arg);
144 } else if after_dashdash {
145 // Everything that comes after are `miri` args.
149 "-Zmiri-disable-validation" => {
152 "-Zmiri-disable-stacked-borrows" => {
153 stacked_borrows = false;
155 "-Zmiri-disable-isolation" => {
158 "-Zmiri-ignore-leaks" => {
162 after_dashdash = true;
164 arg if arg.starts_with("-Zmiri-seed=") => {
166 panic!("Cannot specify -Zmiri-seed multiple times!");
168 let seed_raw = hex::decode(arg.trim_start_matches("-Zmiri-seed="))
169 .unwrap_or_else(|err| match err {
170 FromHexError::InvalidHexCharacter { .. } => panic!(
171 "-Zmiri-seed should only contain valid hex digits [0-9a-fA-F]"
173 FromHexError::OddLength =>
174 panic!("-Zmiri-seed should have an even number of digits"),
175 err => panic!("Unknown error decoding -Zmiri-seed as hex: {:?}", err),
177 if seed_raw.len() > 8 {
179 "-Zmiri-seed must be at most 8 bytes, was {}",
184 let mut bytes = [0; 8];
185 bytes[..seed_raw.len()].copy_from_slice(&seed_raw);
186 seed = Some(u64::from_be_bytes(bytes));
188 arg if arg.starts_with("-Zmiri-env-exclude=") => {
190 .push(arg.trim_start_matches("-Zmiri-env-exclude=").to_owned());
192 arg if arg.starts_with("-Zmiri-track-pointer-tag=") => {
193 let id: u64 = match arg.trim_start_matches("-Zmiri-track-pointer-tag=").parse()
197 "-Zmiri-track-pointer-tag requires a valid `u64` as the argument: {}",
201 if let Some(id) = miri::PtrId::new(id) {
202 tracked_pointer_tag = Some(id);
204 panic!("-Zmiri-track-pointer-tag must be a nonzero id");
207 arg if arg.starts_with("-Zmiri-track-alloc-id=") => {
208 let id: u64 = match arg.trim_start_matches("-Zmiri-track-alloc-id=").parse()
212 "-Zmiri-track-alloc-id requires a valid `u64` as the argument: {}",
216 tracked_alloc_id = Some(miri::AllocId(id));
219 rustc_args.push(arg);
225 // Determine sysroot if needed. Make sure we always call `compile_time_sysroot`
226 // as that also does some sanity-checks of the environment we were built in.
227 // FIXME: Ideally we'd turn a bad build env into a compile-time error, but
228 // CTFE does not seem powerful enough for that yet.
229 if let Some(sysroot) = compile_time_sysroot() {
230 let sysroot_flag = "--sysroot";
231 if !rustc_args.iter().any(|e| e == sysroot_flag) {
232 // We need to overwrite the default that librustc would compute.
233 rustc_args.push(sysroot_flag.to_owned());
234 rustc_args.push(sysroot);
238 // Finally, add the default flags all the way in the beginning, but after the binary name.
239 rustc_args.splice(1..1, miri::miri_default_args().iter().map(ToString::to_string));
241 debug!("rustc arguments: {:?}", rustc_args);
242 debug!("miri arguments: {:?}", miri_args);
243 let miri_config = miri::MiriConfig {
254 rustc_driver::install_ice_hook();
255 let result = rustc_driver::catch_fatal_errors(move || {
256 rustc_driver::run_compiler(&rustc_args, &mut MiriCompilerCalls { miri_config }, None, None)
258 std::process::exit(result.is_err() as i32);