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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
use std::collections::hash_map::HashMap;
use std::env;
use std::hash::{Hash, Hasher};
use std::path::{Path, PathBuf};
use std::sync::Mutex;
use anyhow::Context as _;
use cargo_util::{paths, ProcessBuilder, ProcessError};
use log::{debug, info, warn};
use serde::{Deserialize, Serialize};
use crate::util::interning::InternedString;
use crate::util::{profile, CargoResult, StableHasher};
#[derive(Debug)]
pub struct Rustc {
pub path: PathBuf,
pub wrapper: Option<PathBuf>,
pub workspace_wrapper: Option<PathBuf>,
pub verbose_version: String,
pub version: semver::Version,
pub host: InternedString,
cache: Mutex<Cache>,
}
impl Rustc {
pub fn new(
path: PathBuf,
wrapper: Option<PathBuf>,
workspace_wrapper: Option<PathBuf>,
rustup_rustc: &Path,
cache_location: Option<PathBuf>,
) -> CargoResult<Rustc> {
let _p = profile::start("Rustc::new");
let mut cache = Cache::load(
wrapper.as_deref(),
workspace_wrapper.as_deref(),
&path,
rustup_rustc,
cache_location,
);
let mut cmd = ProcessBuilder::new(&path);
cmd.arg("-vV");
let verbose_version = cache.cached_output(&cmd, 0)?.0;
let extract = |field: &str| -> CargoResult<&str> {
verbose_version
.lines()
.find(|l| l.starts_with(field))
.map(|l| &l[field.len()..])
.ok_or_else(|| {
anyhow::format_err!(
"`rustc -vV` didn't have a line for `{}`, got:\n{}",
field.trim(),
verbose_version
)
})
};
let host = InternedString::new(extract("host: ")?);
let version = semver::Version::parse(extract("release: ")?).with_context(|| {
format!(
"rustc version does not appear to be a valid semver version, from:\n{}",
verbose_version
)
})?;
Ok(Rustc {
path,
wrapper,
workspace_wrapper,
verbose_version,
version,
host,
cache: Mutex::new(cache),
})
}
pub fn process(&self) -> ProcessBuilder {
let mut cmd = ProcessBuilder::new(self.path.as_path()).wrapped(self.wrapper.as_ref());
cmd.retry_with_argfile(true);
cmd
}
pub fn workspace_process(&self) -> ProcessBuilder {
let mut cmd = ProcessBuilder::new(self.path.as_path())
.wrapped(self.workspace_wrapper.as_ref())
.wrapped(self.wrapper.as_ref());
cmd.retry_with_argfile(true);
cmd
}
pub fn process_no_wrapper(&self) -> ProcessBuilder {
let mut cmd = ProcessBuilder::new(&self.path);
cmd.retry_with_argfile(true);
cmd
}
pub fn cached_output(
&self,
cmd: &ProcessBuilder,
extra_fingerprint: u64,
) -> CargoResult<(String, String)> {
self.cache
.lock()
.unwrap()
.cached_output(cmd, extra_fingerprint)
}
}
#[derive(Debug)]
struct Cache {
cache_location: Option<PathBuf>,
dirty: bool,
data: CacheData,
}
#[derive(Serialize, Deserialize, Debug, Default)]
struct CacheData {
rustc_fingerprint: u64,
outputs: HashMap<u64, Output>,
successes: HashMap<u64, bool>,
}
#[derive(Serialize, Deserialize, Debug)]
struct Output {
success: bool,
status: String,
code: Option<i32>,
stdout: String,
stderr: String,
}
impl Cache {
fn load(
wrapper: Option<&Path>,
workspace_wrapper: Option<&Path>,
rustc: &Path,
rustup_rustc: &Path,
cache_location: Option<PathBuf>,
) -> Cache {
match (
cache_location,
rustc_fingerprint(wrapper, workspace_wrapper, rustc, rustup_rustc),
) {
(Some(cache_location), Ok(rustc_fingerprint)) => {
let empty = CacheData {
rustc_fingerprint,
outputs: HashMap::new(),
successes: HashMap::new(),
};
let mut dirty = true;
let data = match read(&cache_location) {
Ok(data) => {
if data.rustc_fingerprint == rustc_fingerprint {
debug!("reusing existing rustc info cache");
dirty = false;
data
} else {
debug!("different compiler, creating new rustc info cache");
empty
}
}
Err(e) => {
debug!("failed to read rustc info cache: {}", e);
empty
}
};
return Cache {
cache_location: Some(cache_location),
dirty,
data,
};
fn read(path: &Path) -> CargoResult<CacheData> {
let json = paths::read(path)?;
Ok(serde_json::from_str(&json)?)
}
}
(_, fingerprint) => {
if let Err(e) = fingerprint {
warn!("failed to calculate rustc fingerprint: {}", e);
}
debug!("rustc info cache disabled");
Cache {
cache_location: None,
dirty: false,
data: CacheData::default(),
}
}
}
}
fn cached_output(
&mut self,
cmd: &ProcessBuilder,
extra_fingerprint: u64,
) -> CargoResult<(String, String)> {
let key = process_fingerprint(cmd, extra_fingerprint);
if self.data.outputs.contains_key(&key) {
debug!("rustc info cache hit");
} else {
debug!("rustc info cache miss");
debug!("running {}", cmd);
let output = cmd.output()?;
let stdout = String::from_utf8(output.stdout)
.map_err(|e| anyhow::anyhow!("{}: {:?}", e, e.as_bytes()))
.with_context(|| format!("`{}` didn't return utf8 output", cmd))?;
let stderr = String::from_utf8(output.stderr)
.map_err(|e| anyhow::anyhow!("{}: {:?}", e, e.as_bytes()))
.with_context(|| format!("`{}` didn't return utf8 output", cmd))?;
self.data.outputs.insert(
key,
Output {
success: output.status.success(),
status: if output.status.success() {
String::new()
} else {
cargo_util::exit_status_to_string(output.status)
},
code: output.status.code(),
stdout,
stderr,
},
);
self.dirty = true;
}
let output = &self.data.outputs[&key];
if output.success {
Ok((output.stdout.clone(), output.stderr.clone()))
} else {
Err(ProcessError::new_raw(
&format!("process didn't exit successfully: {}", cmd),
output.code,
&output.status,
Some(output.stdout.as_ref()),
Some(output.stderr.as_ref()),
)
.into())
}
}
}
impl Drop for Cache {
fn drop(&mut self) {
if !self.dirty {
return;
}
if let Some(ref path) = self.cache_location {
let json = serde_json::to_string(&self.data).unwrap();
match paths::write(path, json.as_bytes()) {
Ok(()) => info!("updated rustc info cache"),
Err(e) => warn!("failed to update rustc info cache: {}", e),
}
}
}
}
fn rustc_fingerprint(
wrapper: Option<&Path>,
workspace_wrapper: Option<&Path>,
rustc: &Path,
rustup_rustc: &Path,
) -> CargoResult<u64> {
let mut hasher = StableHasher::new();
let hash_exe = |hasher: &mut _, path| -> CargoResult<()> {
let path = paths::resolve_executable(path)?;
path.hash(hasher);
paths::mtime(&path)?.hash(hasher);
Ok(())
};
hash_exe(&mut hasher, rustc)?;
if let Some(wrapper) = wrapper {
hash_exe(&mut hasher, wrapper)?;
}
if let Some(workspace_wrapper) = workspace_wrapper {
hash_exe(&mut hasher, workspace_wrapper)?;
}
let maybe_rustup = rustup_rustc == rustc;
match (
maybe_rustup,
env::var("RUSTUP_HOME"),
env::var("RUSTUP_TOOLCHAIN"),
) {
(_, Ok(rustup_home), Ok(rustup_toolchain)) => {
debug!("adding rustup info to rustc fingerprint");
rustup_toolchain.hash(&mut hasher);
rustup_home.hash(&mut hasher);
let real_rustc = Path::new(&rustup_home)
.join("toolchains")
.join(rustup_toolchain)
.join("bin")
.join("rustc")
.with_extension(env::consts::EXE_EXTENSION);
paths::mtime(&real_rustc)?.hash(&mut hasher);
}
(true, _, _) => anyhow::bail!("probably rustup rustc, but without rustup's env vars"),
_ => (),
}
Ok(hasher.finish())
}
fn process_fingerprint(cmd: &ProcessBuilder, extra_fingerprint: u64) -> u64 {
let mut hasher = StableHasher::new();
extra_fingerprint.hash(&mut hasher);
cmd.get_args().for_each(|arg| arg.hash(&mut hasher));
let mut env = cmd.get_envs().iter().collect::<Vec<_>>();
env.sort_unstable();
env.hash(&mut hasher);
hasher.finish()
}