src/bin/miri.rs

   1 #![feature(rustc_private)]
   2
   3 extern crate env_logger;
   4 extern crate getopts;
   5 #[macro_use]
   6 extern crate log;
   7 extern crate log_settings;
   8 extern crate miri;
   9 extern crate rustc;
  10 extern crate rustc_metadata;
  11 extern crate rustc_driver;
  12 extern crate rustc_errors;
  13 extern crate rustc_codegen_utils;
  14 extern crate rustc_interface;
  15 extern crate syntax;
  16
  17 use std::str::FromStr;
  18 use std::env;
  19
  20 use rustc_interface::interface;
  21 use rustc::hir::def_id::LOCAL_CRATE;
  22
  23 struct MiriCompilerCalls {
  24     miri_config: miri::MiriConfig,
  25 }
  26
  27 impl rustc_driver::Callbacks for MiriCompilerCalls {
  28     fn after_parsing(&mut self, compiler: &interface::Compiler) -> bool {
  29         let attr = (
  30             syntax::symbol::Symbol::intern("miri"),
  31             syntax::feature_gate::AttributeType::Whitelisted,
  32         );
  33         compiler.session().plugin_attributes.borrow_mut().push(attr);
  34
  35         // Continue execution
  36         true
  37     }
  38
  39     fn after_analysis(&mut self, compiler: &interface::Compiler) -> bool {
  40         init_late_loggers();
  41         compiler.session().abort_if_errors();
  42
  43         compiler.global_ctxt().unwrap().peek_mut().enter(|tcx| {
  44             let (entry_def_id, _) = tcx.entry_fn(LOCAL_CRATE).expect("no main function found!");
  45             let mut config = self.miri_config.clone();
  46
  47             // Add filename to `miri` arguments.
  48             config.args.insert(0, compiler.input().filestem().to_string());
  49
  50             miri::eval_main(tcx, entry_def_id, config);
  51         });
  52
  53         compiler.session().abort_if_errors();
  54
  55         // Don't continue execution
  56         false
  57     }
  58 }
  59
  60 fn init_early_loggers() {
  61     // Note that our `extern crate log` is *not* the same as rustc's; as a result, we have to
  62     // initialize them both, and we always initialize `miri`'s first.
  63     let env = env_logger::Env::new().filter("MIRI_LOG").write_style("MIRI_LOG_STYLE");
  64     env_logger::init_from_env(env);
  65     // We only initialize `rustc` if the env var is set (so the user asked for it).
  66     // If it is not set, we avoid initializing now so that we can initialize
  67     // later with our custom settings, and *not* log anything for what happens before
  68     // `miri` gets started.
  69     if env::var("RUSTC_LOG").is_ok() {
  70         rustc_driver::init_rustc_env_logger();
  71     }
  72 }
  73
  74 fn init_late_loggers() {
  75     // We initialize loggers right before we start evaluation. We overwrite the `RUSTC_LOG`
  76     // env var if it is not set, control it based on `MIRI_LOG`.
  77     if let Ok(var) = env::var("MIRI_LOG") {
  78         if env::var("RUSTC_LOG").is_err() {
  79             // We try to be a bit clever here: if `MIRI_LOG` is just a single level
  80             // used for everything, we only apply it to the parts of rustc that are
  81             // CTFE-related. Otherwise, we use it verbatim for `RUSTC_LOG`.
  82             // This way, if you set `MIRI_LOG=trace`, you get only the right parts of
  83             // rustc traced, but you can also do `MIRI_LOG=miri=trace,rustc_mir::interpret=debug`.
  84             if log::Level::from_str(&var).is_ok() {
  85                 env::set_var("RUSTC_LOG",
  86                     &format!("rustc::mir::interpret={0},rustc_mir::interpret={0}", var));
  87             } else {
  88                 env::set_var("RUSTC_LOG", &var);
  89             }
  90             rustc_driver::init_rustc_env_logger();
  91         }
  92     }
  93
  94     // If `MIRI_BACKTRACE` is set and `RUST_CTFE_BACKTRACE` is not, set `RUST_CTFE_BACKTRACE`.
  95     // Do this late, so we really only apply this to miri's errors.
  96     if let Ok(var) = env::var("MIRI_BACKTRACE") {
  97         if env::var("RUST_CTFE_BACKTRACE") == Err(env::VarError::NotPresent) {
  98             env::set_var("RUST_CTFE_BACKTRACE", &var);
  99         }
 100     }
 101 }
 102
 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.
 109         return None;
 110     }
 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         _ => {
 120             option_env!("RUST_SYSROOT")
 121                 .expect("To build Miri without rustup, set the `RUST_SYSROOT` env var at build time")
 122                 .to_owned()
 123         }
 124     })
 125 }
 126
 127 fn main() {
 128     init_early_loggers();
 129
 130     // Parse our arguments and split them across `rustc` and `miri`.
 131     let mut validate = true;
 132     let mut seed: Option<u64> = None;
 133     let mut rustc_args = vec![];
 134     let mut miri_args = vec![];
 135     let mut after_dashdash = false;
 136     for arg in std::env::args() {
 137         if rustc_args.is_empty() {
 138             // Very first arg: for `rustc`.
 139             rustc_args.push(arg);
 140         }
 141         else if after_dashdash {
 142             // Everything that comes after are `miri` args.
 143             miri_args.push(arg);
 144         } else {
 145             match arg.as_str() {
 146                 "-Zmiri-disable-validation" => {
 147                     validate = false;
 148                 },
 149                 "--" => {
 150                     after_dashdash = true;
 151                 }
 152                 arg if arg.starts_with("-Zmiri-seed=") => {
 153                     if seed.is_some() {
 154                         panic!("Cannot specify -Zmiri-seed multiple times!");
 155                     }
 156                     let seed_raw = hex::decode(arg.trim_start_matches("-Zmiri-seed=")).unwrap();
 157                     if seed_raw.len() > 8 {
 158                         panic!(format!("-Zmiri-seed must be at most 8 bytes, was {}", seed_raw.len()));
 159                     }
 160
 161                     let mut bytes = [0; 8];
 162                     bytes[..seed_raw.len()].copy_from_slice(&seed_raw);
 163                     seed = Some(u64::from_be_bytes(bytes));
 164
 165                 },
 166                 _ => {
 167                     rustc_args.push(arg);
 168                 }
 169             }
 170         }
 171     }
 172
 173     // Determine sysroot if needed.  Make sure we always call `compile_time_sysroot`
 174     // as that also does some sanity-checks of the environment we were built in.
 175     // FIXME: Ideally we'd turn a bad build env into a compile-time error, but
 176     // CTFE does not seem powerful enough for that yet.
 177     if let Some(sysroot) = compile_time_sysroot() {
 178         let sysroot_flag = "--sysroot".to_string();
 179         if !rustc_args.contains(&sysroot_flag) {
 180             // We need to overwrite the default that librustc would compute.
 181             rustc_args.push(sysroot_flag);
 182             rustc_args.push(sysroot);
 183         }
 184     }
 185
 186     // Finally, add the default flags all the way in the beginning, but after the binary name.
 187     rustc_args.splice(1..1, miri::miri_default_args().iter().map(ToString::to_string));
 188
 189     debug!("rustc arguments: {:?}", rustc_args);
 190     debug!("miri arguments: {:?}", miri_args);
 191     let miri_config = miri::MiriConfig { validate, args: miri_args, seed };
 192     let result = rustc_driver::report_ices_to_stderr_if_any(move || {
 193         rustc_driver::run_compiler(&rustc_args, &mut MiriCompilerCalls { miri_config }, None, None)
 194     }).and_then(|result| result);
 195     std::process::exit(result.is_err() as i32);
 196 }