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
//! Crash-safe file writes.
use std::fs::{self, File};
use std::io::{self, Write};
use std::path::Path;
/// Atomically write `contents` to `path`.
///
/// `fs::write` truncates the target and then streams bytes into it, so a crash
/// (or a full disk) partway through leaves a half-written, corrupt file — fatal
/// when the target is a release artifact, manifest, or checksum that downstream
/// tooling trusts. This instead writes to a uniquely-named temp file in the
/// SAME directory as the target (so the final `rename` is a same-filesystem,
/// atomic operation), `fsync`s that file, renames it over `path`, and then
/// `fsync`s the parent directory so the rename itself is durable (a crash after
/// the rename returns but before the directory entry is flushed could otherwise
/// lose it). The rename either fully succeeds or leaves the previous contents
/// intact; readers never observe a partial write. The temp file is removed on
/// any error before the rename, so a failed write does not litter the directory.
/// The directory `fsync` is best-effort: a platform that rejects it (or has no
/// such concept) does not fail the write.
pub fn atomic_write(path: &Path, contents: &[u8]) -> io::Result<()> {
let dir = path.parent().filter(|p| !p.as_os_str().is_empty());
let dir = dir.unwrap_or_else(|| Path::new("."));
let file_name = path.file_name().ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidInput,
format!("atomic_write: path has no file name: {}", path.display()),
)
})?;
// A process-id + nanosecond suffix keeps concurrent writers to distinct
// targets in the same directory from colliding on the temp name.
let nanos = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.map(|d| d.as_nanos())
.unwrap_or(0);
let mut tmp_name = file_name.to_os_string();
tmp_name.push(format!(".{}.{}.tmp", std::process::id(), nanos));
let tmp_path = dir.join(tmp_name);
let write_result = (|| -> io::Result<()> {
let mut file = File::create(&tmp_path)?;
file.write_all(contents)?;
file.sync_all()?;
Ok(())
})();
if let Err(e) = write_result {
let _ = fs::remove_file(&tmp_path);
return Err(e);
}
if let Err(e) = fs::rename(&tmp_path, path) {
let _ = fs::remove_file(&tmp_path);
return Err(e);
}
// Durably flush the rename: fsync the parent directory so a crash right
// after this call cannot lose the new directory entry. Best-effort — some
// filesystems/platforms reject an fsync on a directory handle, which must
// not fail an otherwise-successful write.
if let Ok(dir_handle) = File::open(dir) {
let _ = dir_handle.sync_all();
}
Ok(())
}
/// Atomically write a string to `path`. Convenience wrapper over
/// [`atomic_write`].
pub fn atomic_write_str(path: &Path, contents: &str) -> io::Result<()> {
atomic_write(path, contents.as_bytes())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn writes_full_contents_and_leaves_no_temp() {
let dir = tempfile::tempdir().unwrap();
let target = dir.path().join("release.txt");
atomic_write(&target, b"full contents here").unwrap();
assert_eq!(fs::read_to_string(&target).unwrap(), "full contents here");
// No leftover temp file: the directory should contain exactly the
// target and nothing matching the `.tmp` suffix.
let entries: Vec<_> = fs::read_dir(dir.path())
.unwrap()
.map(|e| e.unwrap().file_name().to_string_lossy().into_owned())
.collect();
assert_eq!(entries, vec!["release.txt".to_string()]);
assert!(
!entries.iter().any(|n| n.ends_with(".tmp")),
"temp file was left behind: {entries:?}"
);
}
#[test]
fn overwrites_existing_file() {
let dir = tempfile::tempdir().unwrap();
let target = dir.path().join("manifest.yaml");
fs::write(&target, "old").unwrap();
atomic_write_str(&target, "new value").unwrap();
assert_eq!(fs::read_to_string(&target).unwrap(), "new value");
}
}