-
Notifications
You must be signed in to change notification settings - Fork 11
/
build.rs
243 lines (218 loc) · 6.77 KB
/
build.rs
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
use crate::get_default_target;
use cargo_metadata::{Artifact, Message, MessageIter};
use std::collections::HashMap;
use std::fmt::Write as WriteFmt;
use std::io::{BufReader, Write};
use std::process::{Child, ChildStdout, Command, Stdio};
#[derive(Debug, Default)]
struct CargoArgs {
filtered: Vec<String>,
contains_target: bool,
}
enum ReleaseMode {
AddRelease,
NoRelease,
}
pub struct RunningCargo {
child: Child,
message_iter: MessageIter<BufReader<ChildStdout>>,
}
impl RunningCargo {
pub fn messages(&mut self) -> &mut MessageIter<BufReader<ChildStdout>> {
&mut self.message_iter
}
pub fn check_status(mut self) -> anyhow::Result<()> {
let status = self.child.wait()?;
if !status.success() {
return Err(anyhow::anyhow!(
"Cargo finished with an error ({})",
status.code().unwrap_or(-1),
));
}
Ok(())
}
}
/// Start a `cargo` command in release mode with the provided RUSTFLAGS and Cargo arguments.
pub fn cargo_command_with_flags(
command: CargoCommand,
flags: &str,
cargo_args: Vec<String>,
) -> anyhow::Result<RunningCargo> {
let mut rustflags = std::env::var("RUSTFLAGS").unwrap_or_default();
write!(&mut rustflags, " {}", flags).unwrap();
let mut env = HashMap::default();
env.insert("RUSTFLAGS".to_string(), rustflags);
let release_mode = match command {
CargoCommand::Bench => ReleaseMode::NoRelease,
_ => ReleaseMode::AddRelease,
};
let mut child = cargo_command(command, cargo_args, env, release_mode)?;
let stdout = child.stdout.take().unwrap();
Ok(RunningCargo {
child,
message_iter: Message::parse_stream(BufReader::new(stdout)),
})
}
/// Spawn `cargo` command in release mode with the provided env variables and Cargo arguments.
fn cargo_command(
cargo_cmd: CargoCommand,
cargo_args: Vec<String>,
env: HashMap<String, String>,
release_mode: ReleaseMode,
) -> anyhow::Result<Child> {
let parsed_args = parse_cargo_args(cargo_args);
let mut command = Command::new("cargo");
command.args(&[
cargo_cmd.to_str(),
"--message-format",
"json-diagnostic-rendered-ansi",
]);
command.stdin(Stdio::null());
command.stdout(Stdio::piped());
command.stderr(Stdio::inherit());
match release_mode {
ReleaseMode::AddRelease => {
command.arg("--release");
}
ReleaseMode::NoRelease => {}
}
// --target is passed to avoid instrumenting build scripts
// See https://doc.rust-lang.org/rustc/profile-guided-optimization.html#a-complete-cargo-workflow
if !parsed_args.contains_target {
let default_target = get_default_target().map_err(|error| {
anyhow::anyhow!(
"Unable to find default target triple for your platform: {:?}",
error
)
})?;
command.args(&["--target", &default_target]);
}
for arg in parsed_args.filtered {
command.arg(arg);
}
for (key, value) in env {
command.env(key, value);
}
log::debug!("Executing cargo command: {:?}", command);
Ok(command.spawn()?)
}
fn parse_cargo_args(cargo_args: Vec<String>) -> CargoArgs {
let mut args = CargoArgs::default();
let mut iterator = cargo_args.into_iter();
while let Some(arg) = iterator.next() {
match arg.as_str() {
// Skip `--release`, we will pass it by ourselves.
"--release" => {
log::warn!("Do not pass `--release` manually, it will be added automatically by `cargo-pgo`");
}
// Skip `--message-format`, we need it to be JSON.
"--message-format" => {
log::warn!("Do not pass `--message-format` manually, it will be added automatically by `cargo-pgo`");
iterator.next(); // skip flag value
}
"--target" => {
args.contains_target = true;
args.filtered.push(arg);
}
_ => args.filtered.push(arg),
}
}
args
}
pub fn handle_metadata_message(message: Message) {
let stdout = std::io::stdout();
let mut stdout = stdout.lock();
write_metadata_message(&mut stdout, message);
stdout.flush().unwrap();
}
fn write_metadata_message<W: Write>(mut stream: W, message: Message) {
match message {
Message::TextLine(line) => {
log::debug!("TextLine {}", line);
writeln!(stream, "{}", line).unwrap();
}
Message::CompilerMessage(message) => {
log::debug!("CompilerMessage {}", message);
write!(
stream,
"{}",
message.message.rendered.unwrap_or(message.message.message)
)
.unwrap();
}
_ => {
log::debug!("Metadata output: {:?}", message);
}
}
}
/// Returns a user-friendly name of an artifact kind.
pub fn get_artifact_kind(artifact: &Artifact) -> &str {
for kind in &artifact.target.kind {
match kind.as_str() {
"bin" => {
return "binary";
}
"bench" => {
return "benchmark";
}
"example" => {
return "example";
}
_ => {}
}
}
"artifact"
}
#[cfg(test)]
mod tests {
use crate::build::parse_cargo_args;
#[test]
fn test_parse_cargo_args_filter_release() {
let args = parse_cargo_args(vec![
"foo".to_string(),
"--release".to_string(),
"--bar".to_string(),
]);
assert_eq!(args.filtered, vec!["foo".to_string(), "--bar".to_string()]);
}
#[test]
fn test_parse_cargo_args_filter_message_format() {
let args = parse_cargo_args(vec![
"foo".to_string(),
"--message-format".to_string(),
"json".to_string(),
"bar".to_string(),
]);
assert_eq!(args.filtered, vec!["foo".to_string(), "bar".to_string()]);
}
#[test]
fn test_parse_cargo_args_find_target() {
let args = parse_cargo_args(vec![
"--target".to_string(),
"x64".to_string(),
"bar".to_string(),
]);
assert_eq!(
args.filtered,
vec!["--target".to_string(), "x64".to_string(), "bar".to_string()]
);
assert!(args.contains_target);
}
}
#[derive(Debug, Copy, Clone, clap::ValueEnum)]
pub enum CargoCommand {
Build,
Test,
Run,
Bench,
}
impl CargoCommand {
pub fn to_str(&self) -> &str {
match self {
CargoCommand::Build => "build",
CargoCommand::Test => "test",
CargoCommand::Run => "run",
CargoCommand::Bench => "bench",
}
}
}