cargo-pgo 0.3.0

Cargo subcommand for optimizing Rust binaries with PGO and BOLT.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! This crate contains a Cargo subcommand designed for simplifying the usage of
//! feedback-directed optimizations for Rust crates.
//!
//! You can find a usage guide for `cargo-pgo` at its [repository](https://github.com/kobzol/cargo-pgo).

pub mod bolt;
pub mod build;
pub mod check;
pub mod clean;
pub(crate) mod cli;
pub mod pgo;
pub(crate) mod utils;
pub(crate) mod workspace;

use std::ffi::OsStr;
use std::path::{Path, PathBuf};
use std::process::{Command, ExitStatus};

pub use workspace::get_cargo_ctx;

pub(crate) fn resolve_binary(path: &Path) -> anyhow::Result<PathBuf> {
    Ok(which::which(path)?)
}

#[derive(Debug)]
struct Utf8Output {
    stdout: String,
    stderr: String,
    status: ExitStatus,
}

impl Utf8Output {
    pub fn ok(self) -> anyhow::Result<Self> {
        if self.status.success() {
            Ok(self)
        } else {
            Err(anyhow::anyhow!(
                "Command ended with {}\nStderr\n{}\nStdout\n{}",
                self.status,
                self.stderr,
                self.stdout
            ))
        }
    }
}

/// Runs a command with the provided arguments and returns its stdout and stderr.
fn run_command<S: AsRef<OsStr>, Str: AsRef<OsStr>>(
    program: S,
    args: &[Str],
) -> anyhow::Result<Utf8Output> {
    let mut cmd = Command::new(program);
    for arg in args {
        cmd.arg(arg);
    }
    log::debug!("Running command {:?}", cmd);
    cmd.stdout(std::process::Stdio::piped());
    cmd.stderr(std::process::Stdio::piped());

    let output = cmd.output()?;
    Ok(Utf8Output {
        stdout: String::from_utf8(output.stdout)?,
        stderr: String::from_utf8(output.stderr)?,
        status: output.status,
    })
}

/// Tries to find the default target triple used for compiling on the current host computer.
pub fn get_default_target() -> anyhow::Result<String> {
    Ok(rustc_version::version_meta()?.host)
}

/// Clears all files from the directory, and recreates it.
fn clear_directory(path: &Path) -> std::io::Result<()> {
    if path.exists() {
        std::fs::remove_dir_all(path)?;
    }
    ensure_directory(path)
}

/// Make sure that directory exists.
fn ensure_directory(path: &Path) -> std::io::Result<()> {
    std::fs::create_dir_all(path)
}