-
Notifications
You must be signed in to change notification settings - Fork 31
/
fingerprint.rs
428 lines (398 loc) · 14.7 KB
/
fingerprint.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
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
#![allow(deprecated)]
use failure::{bail, Error};
use log::{debug, info, warn};
use serde_derive::Deserialize;
use serde_json::from_str;
use std::{
collections::{HashMap, HashSet},
fs::{self, remove_dir_all, remove_file, File},
hash::{Hash, Hasher, SipHasher},
io::prelude::*,
path::Path,
process::Command,
time::Duration,
};
use walkdir::{DirEntry, WalkDir};
/// This has to match the way Cargo hashes a rustc version.
/// As such it is copied from Cargos code.
fn hash_u64<H: Hash>(hashable: &H) -> u64 {
let mut hasher = SipHasher::new_with_keys(0, 0);
hashable.hash(&mut hasher);
hasher.finish()
}
/// This has to match the way Cargo stores a rustc version in a fingerprint file.
#[derive(Deserialize, Debug)]
struct Fingerprint {
rustc: u64,
}
/// the files and folder tracked by fingerprint have the form `({prefix}-)?{name}-{16 char hex hash}(.{extension})?`
/// this returns `Some({hex hash})` if it is of that form and `None` otherwise.
fn hash_from_path_name(filename: &str) -> Option<&str> {
// maybe just use regex
let name = filename.split('.').next().unwrap();
let hash = name.rsplit('-').next().unwrap();
if hash.len() == name.len() {
// we did not find a dash, it cant be a fingerprint matched file.
return None;
}
if !hash.chars().all(|x| x.is_digit(16)) {
// we found a non hex char, it cant be a fingerprint matched file.
return None;
}
if hash.len() != 16 {
// the hash part is the wrong length.
// It is not a fingerprint just a project with an unfortunate name.
return None;
}
Some(hash)
}
impl Fingerprint {
/// Attempts to load the the Fingerprint data for a given fingerprint directory.
fn load(fingerprint_dir: &Path) -> Result<Self, Error> {
for entry in fs::read_dir(fingerprint_dir)? {
let path = entry?.path();
if let Some(ext) = path.extension() {
if ext == "json" {
let mut file = File::open(&path)?;
let mut contents = String::new();
file.read_to_string(&mut contents)?;
if let Ok(fing) = from_str(&contents) {
return Ok(fing);
}
}
}
}
bail!("did not fine a fingerprint file in {:?}", fingerprint_dir)
}
}
fn load_all_fingerprints_built_with(
fingerprint_dir: &Path,
instaled_rustc: &HashSet<u64>,
) -> Result<HashSet<String>, Error> {
assert_eq!(
fingerprint_dir
.file_name()
.expect("load takes the path to a .fingerprint directory"),
".fingerprint"
);
let mut keep = HashSet::new();
for entry in fs::read_dir(fingerprint_dir)? {
let path = entry?.path();
if path.is_dir() {
let f = Fingerprint::load(&path).map(|f| instaled_rustc.contains(&f.rustc));
// we default to keeping, as there are files that dont have the data we need.
if f.unwrap_or(true) {
let name = path.file_name().unwrap().to_string_lossy();
if let Some(hash) = hash_from_path_name(&name) {
keep.insert(hash.to_string());
}
}
}
}
debug!("Hashs to keep: {:#?}", keep);
Ok(keep)
}
fn last_used_time(fingerprint_dir: &Path) -> Result<Duration, Error> {
let mut best = Duration::from_secs(3_155_760_000); // 100 years!
for entry in fs::read_dir(fingerprint_dir)? {
let accessed = entry?.metadata()?.accessed()?.elapsed()?;
if accessed < best {
best = accessed;
}
}
Ok(best)
}
fn load_all_fingerprints_by_time(fingerprint_dir: &Path) -> Result<Vec<(Duration, String)>, Error> {
assert_eq!(
fingerprint_dir
.file_name()
.expect("load takes the path to a .fingerprint directory"),
".fingerprint"
);
let mut keep = vec![];
for entry in fs::read_dir(fingerprint_dir)? {
let path = entry?.path();
if path.is_dir() {
let last_used = last_used_time(&path)?;
let name = path.file_name().unwrap().to_string_lossy();
if let Some(hash) = hash_from_path_name(&name) {
keep.push((last_used, hash.to_string()));
}
}
}
keep.sort_unstable();
debug!("Hashs by time: {:#?}", keep);
Ok(keep)
}
fn load_all_fingerprints_newer_then(
fingerprint_dir: &Path,
keep_duration: &Duration,
) -> Result<HashSet<String>, Error> {
assert_eq!(
fingerprint_dir
.file_name()
.expect("load takes the path to a .fingerprint directory"),
".fingerprint"
);
let mut keep = HashSet::new();
for entry in fs::read_dir(fingerprint_dir)? {
let path = entry?.path();
if path.is_dir() && last_used_time(&path)? < *keep_duration {
let name = path.file_name().unwrap().to_string_lossy();
if let Some(hash) = hash_from_path_name(&name) {
keep.insert(hash.to_string());
}
}
}
debug!("Hashs to keep: {:#?}", keep);
Ok(keep)
}
fn total_disk_space_dir(dir: &Path) -> u64 {
WalkDir::new(dir)
.into_iter()
.filter_map(|entry| entry.ok())
.filter_map(|entry| entry.metadata().ok())
.filter(|metadata| metadata.is_file())
.fold(0, |acc, m| acc + m.len())
}
fn total_disk_space_by_hash_in_a_dir(
dir: &Path,
disk_space: &mut HashMap<String, u64>,
) -> Result<(), Error> {
for entry in fs::read_dir(dir)? {
let entry = entry?;
let metadata = entry.metadata()?;
let path = entry.path();
let name = path
.file_name()
.expect("folders in a directory dont have a name!?")
.to_string_lossy();
if let Some(hash) = hash_from_path_name(&name) {
*disk_space.entry(hash.to_owned()).or_default() += if path.is_file() {
metadata.len()
} else if path.is_dir() {
total_disk_space_dir(&path)
} else {
panic!("what type is it!")
};
}
}
Ok(())
}
fn remove_not_matching_in_a_dir(
dir: &Path,
keep: &HashSet<String>,
dry_run: bool,
) -> Result<u64, Error> {
let mut total_disk_space = 0;
for entry in fs::read_dir(dir)? {
let entry = entry?;
let metadata = entry.metadata()?;
let path = entry.path();
let name = path
.file_name()
.expect("folders in a directory dont have a name!?")
.to_string_lossy();
if let Some(hash) = hash_from_path_name(&name) {
if !keep.contains(hash) {
if path.is_file() {
total_disk_space += metadata.len();
if !dry_run {
match remove_file(&path) {
Ok(_) => info!("Successfully removed: {:?}", &path),
Err(e) => warn!("Failed to remove: {:?} {}", &path, e),
};
} else {
info!("Would remove: {:?}", &path);
}
} else if path.is_dir() {
total_disk_space += total_disk_space_dir(&path);
if !dry_run {
match remove_dir_all(&path) {
Ok(_) => info!("Successfully removed: {:?}", &path),
Err(e) => warn!("Failed to remove: {:?} {}", &path, e),
};
} else {
info!("Would remove: {:?}", &path);
}
}
}
}
}
Ok(total_disk_space)
}
fn total_disk_space_in_a_profile(dir: &Path) -> Result<HashMap<String, u64>, Error> {
debug!("Sizing: {:?} with total_disk_space_in_a_profile", dir);
let mut total_disk_space = HashMap::new();
total_disk_space_by_hash_in_a_dir(&dir.join(".fingerprint"), &mut total_disk_space)?;
total_disk_space_by_hash_in_a_dir(&dir.join("build"), &mut total_disk_space)?;
total_disk_space_by_hash_in_a_dir(&dir.join("deps"), &mut total_disk_space)?;
// examples is just final artifacts not tracked by fingerprint so skip that one.
// incremental is not tracked by fingerprint so skip that one.
total_disk_space_by_hash_in_a_dir(&dir.join("native"), &mut total_disk_space)?;
total_disk_space_by_hash_in_a_dir(dir, &mut total_disk_space)?;
Ok(total_disk_space)
}
fn remove_not_built_with_in_a_profile(
dir: &Path,
keep: &HashSet<String>,
dry_run: bool,
) -> Result<u64, Error> {
debug!(
"cleaning: {:?} with remove_not_built_with_in_a_profile",
dir
);
let mut total_disk_space = 0;
total_disk_space += remove_not_matching_in_a_dir(&dir.join(".fingerprint"), &keep, dry_run)?;
total_disk_space += remove_not_matching_in_a_dir(&dir.join("build"), &keep, dry_run)?;
total_disk_space += remove_not_matching_in_a_dir(&dir.join("deps"), &keep, dry_run)?;
// examples is just final artifacts not tracked by fingerprint so skip that one.
// incremental is not tracked by fingerprint so skip that one.
total_disk_space += remove_not_matching_in_a_dir(&dir.join("native"), &keep, dry_run)?;
total_disk_space += remove_not_matching_in_a_dir(dir, &keep, dry_run)?;
Ok(total_disk_space)
}
fn lookup_all_fingerprint_dirs(dir: &Path) -> impl Iterator<Item = DirEntry> {
WalkDir::new(dir)
.min_depth(1)
.into_iter()
.filter_map(|entry| entry.ok())
.filter(|e| {
e.file_name()
.to_str()
.map(|s| s == ".fingerprint")
.unwrap_or(false)
})
}
fn lookup_from_names<'a>(iter: impl Iterator<Item = &'a str>) -> Result<HashSet<u64>, Error> {
iter.map(|x| {
let plus_name = "+".to_owned() + x;
let out = Command::new("rustc").args(&[&plus_name, "-vV"]).output()?;
if !out.status.success() {
bail!(String::from_utf8_lossy(&out.stdout).to_string());
}
Ok(hash_u64(&String::from_utf8_lossy(&out.stdout)))
})
.chain(
// Some fingerprints made to track the output of build scripts claim to have been built with a rust that hashes to 0.
// This can be fixed in cargo, but for now this makes sure we don't clean the files.
Some(Ok(0)),
)
.collect()
}
fn rustup_toolchain_list() -> Result<Vec<String>, Error> {
let out = Command::new("rustup")
.args(&["toolchain", "list"])
.output()?;
if !out.status.success() {
bail!(String::from_utf8_lossy(&out.stdout).to_string());
}
Ok(String::from_utf8_lossy(&out.stdout)
.split('\n')
.filter_map(|x| x.split_whitespace().next())
.map(|x| x.trim().to_owned())
.collect::<Vec<String>>())
}
pub fn remove_not_built_with(
dir: &Path,
rust_vertion_to_keep: Option<&str>,
dry_run: bool,
) -> Result<u64, Error> {
debug!("cleaning: {:?} with remove_not_built_with", dir);
let mut total_disk_space = 0;
let hashed_rust_version_to_keep = if let Some(names) = rust_vertion_to_keep {
info!(
"Using specified installed toolchains: {:?}",
names.split(',').collect::<Vec<_>>()
);
lookup_from_names(names.split(','))?
} else {
let rustup_toolchain_list = rustup_toolchain_list()?;
info!(
"Using all installed toolchains: {:?}",
rustup_toolchain_list
);
lookup_from_names(rustup_toolchain_list.iter().map(|x| x.as_str()))?
};
for fing in lookup_all_fingerprint_dirs(dir) {
let path = fing.into_path();
let keep = load_all_fingerprints_built_with(&path, &hashed_rust_version_to_keep)?;
total_disk_space +=
remove_not_built_with_in_a_profile(path.parent().unwrap(), &keep, dry_run)?;
}
Ok(total_disk_space)
}
/// Attempts to sweep the cargo project located at the given path,
/// keeping only files which have been accessed within the given duration.
/// Dry specifies if files should actually be removed or not.
/// Returns a list of the deleted file/dir paths.
pub fn remove_older_then(
path: &Path,
keep_duration: &Duration,
dry_run: bool,
) -> Result<u64, Error> {
debug!("cleaning: {:?} with remove_older_then", path);
let mut total_disk_space = 0;
for fing in lookup_all_fingerprint_dirs(path) {
let path = fing.into_path();
let keep = load_all_fingerprints_newer_then(&path, &keep_duration)?;
total_disk_space +=
remove_not_built_with_in_a_profile(path.parent().unwrap(), &keep, dry_run)?;
}
Ok(total_disk_space)
}
pub fn remove_older_until_fits(path: &Path, target_size: u64, dry_run: bool) -> Result<u64, Error> {
debug!("cleaning: {:?} with remove_older_until_fits", path);
let starting_size = total_disk_space_dir(path);
if starting_size <= target_size {
// already below target
return Ok(0);
}
let size_to_remove = starting_size - target_size;
debug!("size_to_remove: {:?}", size_to_remove);
let fingerprint_dirs: Vec<DirEntry> = lookup_all_fingerprint_dirs(path).collect();
let mut order: Vec<(Duration, u64, &Path, String)> = vec![];
for fing in &fingerprint_dirs {
let path = fing.path();
let sizes = total_disk_space_in_a_profile(path.parent().unwrap())?;
for (last_used, hash) in load_all_fingerprints_by_time(path)? {
order.push((
last_used,
*(sizes.get(&hash).unwrap_or(&0)),
fing.path(),
hash,
));
}
}
// as Duration is first in the elements of order this sorts items from new to old
order.sort();
let mut removed = 0u64;
// organized keeps track of what needs to be keep per fingerprint dirs
let mut organized = HashMap::new();
let mut printed = false;
for dir in &fingerprint_dirs {
// populate organized with keeping nothing in each fingerprint dirs
organized.entry(dir.path()).or_insert_with(HashSet::new);
}
for (last_used, sizes, fing, hash) in order.into_iter().rev() {
if removed + sizes < size_to_remove {
removed += sizes;
continue;
}
if !printed {
// TODO: consider formatting better for printing
info!("Removing older then: {:?}", &last_used);
printed = true;
}
organized
.entry(fing)
.or_insert_with(HashSet::new)
.insert(hash);
}
let mut total_disk_space = 0;
for (fing, keep) in organized {
total_disk_space +=
remove_not_built_with_in_a_profile(fing.parent().unwrap(), &keep, dry_run)?;
}
Ok(total_disk_space)
}