|
| 1 | +use std::ffi::OsString; |
| 2 | + |
| 3 | +use anyhow::{Context, Result}; |
| 4 | +use path_macro::path; |
| 5 | +use tempfile::TempDir; |
| 6 | +use xshell::cmd; |
| 7 | + |
| 8 | +use crate::util::MiriEnv; |
| 9 | + |
| 10 | +/// CoverageReport can generate code coverage reports for miri. |
| 11 | +pub struct CoverageReport { |
| 12 | + /// path is a temporary directory where coverage artifacts will be stored. |
| 13 | + path: TempDir, |
| 14 | +} |
| 15 | + |
| 16 | +impl CoverageReport { |
| 17 | + /// new creates a new CoverageReport |
| 18 | + /// |
| 19 | + /// # Errors |
| 20 | + /// |
| 21 | + /// An error will be returned if a temporary directory could not be created. |
| 22 | + pub fn new() -> Result<Self> { |
| 23 | + Ok(Self { path: TempDir::new()? }) |
| 24 | + } |
| 25 | + |
| 26 | + /// add_env_vars will add the required environment variables to MiriEnv `e`. |
| 27 | + pub fn add_env_vars(&self, e: &mut MiriEnv) -> Result<()> { |
| 28 | + let mut rustflags = e.sh.var("RUSTFLAGS")?; |
| 29 | + rustflags.push_str(" -C instrument-coverage"); |
| 30 | + e.sh.set_var("RUSTFLAGS", rustflags); |
| 31 | + |
| 32 | + // Copy-pasting from: https://doc.rust-lang.org/rustc/instrument-coverage.html#instrumentation-based-code-coverage |
| 33 | + // The format symbols below have the following meaning: |
| 34 | + // - %p - The process ID. |
| 35 | + // - %Nm - the instrumented binary’s signature: |
| 36 | + // The runtime creates a pool of N raw profiles, used for on-line |
| 37 | + // profile merging. The runtime takes care of selecting a raw profile |
| 38 | + // from the pool, locking it, and updating it before the program |
| 39 | + // exits. N must be between 1 and 9, and defaults to 1 if omitted |
| 40 | + // (with simply %m). |
| 41 | + // |
| 42 | + // Additionally the default for LLVM_PROFILE_FILE is default_%m_%p.profraw. |
| 43 | + // So we just use the same template, replacing "default" with "miri". |
| 44 | + let file_template = self.path.path().join("miri_%m_%p.profraw"); |
| 45 | + e.sh.set_var("LLVM_PROFILE_FILE", file_template); |
| 46 | + Ok(()) |
| 47 | + } |
| 48 | + |
| 49 | + /// show_coverage_report will print coverage information using the artifact |
| 50 | + /// files in `self.path`. |
| 51 | + pub fn show_coverage_report(&self, e: &MiriEnv) -> Result<()> { |
| 52 | + let profraw_files: Vec<_> = self.profraw_files()?; |
| 53 | + |
| 54 | + let profdata_bin = path!(e.libdir / ".." / "bin" / "llvm-profdata"); |
| 55 | + |
| 56 | + let merged_file = path!(e.miri_dir / "target" / "coverage.profdata"); |
| 57 | + |
| 58 | + // Merge the profraw files |
| 59 | + let profraw_files_cloned = profraw_files.iter(); |
| 60 | + cmd!(e.sh, "{profdata_bin} merge -sparse {profraw_files_cloned...} -o {merged_file}") |
| 61 | + .quiet() |
| 62 | + .run()?; |
| 63 | + |
| 64 | + // Create the coverage report. |
| 65 | + let cov_bin = path!(e.libdir / ".." / "bin" / "llvm-cov"); |
| 66 | + let miri_bin = |
| 67 | + e.build_get_binary(".").context("failed to get filename of miri executable")?; |
| 68 | + cmd!( |
| 69 | + e.sh, |
| 70 | + "{cov_bin} report --instr-profile={merged_file} --object {miri_bin} --sources src/" |
| 71 | + ) |
| 72 | + .run()?; |
| 73 | + |
| 74 | + Ok(()) |
| 75 | + } |
| 76 | + |
| 77 | + /// profraw_files returns the profraw files in `self.path`. |
| 78 | + /// |
| 79 | + /// # Errors |
| 80 | + /// |
| 81 | + /// An error will be returned if `self.path` can't be read. |
| 82 | + fn profraw_files(&self) -> Result<Vec<OsString>> { |
| 83 | + Ok(std::fs::read_dir(&self.path)? |
| 84 | + .filter_map(|r| r.ok()) |
| 85 | + .map(|e| e.path()) |
| 86 | + .filter(|p| p.extension().map(|e| e == "profraw").unwrap_or(false)) |
| 87 | + .map(|p| p.as_os_str().to_os_string()) |
| 88 | + .collect()) |
| 89 | + } |
| 90 | +} |
0 commit comments