OXYGENHUB
# e6949d87205b oxygenflow / crates / flow / src / facts.rs
5.8 KiB · Rust · last changed flow builds for Windows, offering the WASM tier 10 days ago source blame history raw
1
//! What a runner measures about itself (spec §11.1, docs/jetstream.md §6):
2
//! free disk, load and the kernel each claim, cheaply; and its speed, from
3
//! a short fixed benchmark run at start and again while idle.
4
5
use crate::home::Home;
6
use flow_core::api::Facts;
7
use std::time::Instant;
8
9
/// The benchmark's time on the reference machine (Earth), in ms: a runner
10
/// that takes as long scores 100.
11
const REFERENCE_MS: f64 = 225.0;
12
13
/// The cheap facts, with the last speed measured.
14
pub fn now(home: &Home, speed: Option<u32>) -> Facts {
15
    Facts {
16
        free_disk_mib: free_disk_mib(&home.root),
17
        load_x100: load_x100(),
18
        speed,
19
        speed_class: speed.map(Facts::class_of),
20
        kernel: kernel(),
21
    }
22
}
23
24
/// The kernel's release, as uname says. Not read from /proc: an Android
25
/// app may not read it there, and is refused (and logged) every claim.
26
/// None on Windows (oxygenflow#83).
27
#[cfg(unix)]
28
pub fn kernel() -> Option<String> {
29
    let mut u: libc::utsname = unsafe { std::mem::zeroed() };
30
    // SAFETY: `u` is a writable utsname.
31
    if unsafe { libc::uname(&mut u) } != 0 {
32
        return None;
33
    }
34
    // SAFETY: uname writes NUL-terminated strings.
35
    let release = unsafe { std::ffi::CStr::from_ptr(u.release.as_ptr()) };
36
    Some(release.to_string_lossy().into_owned())
37
}
38
39
#[cfg(not(unix))]
40
pub fn kernel() -> Option<String> {
41
    None
42
}
43
44
/// Free space for an unprivileged writer on the file system holding `path`,
45
/// in MiB; not measured on Windows.
46
#[cfg(unix)]
47
pub fn free_disk_mib(path: &std::path::Path) -> Option<u64> {
48
    use std::os::unix::ffi::OsStrExt;
49
    let c = std::ffi::CString::new(path.as_os_str().as_bytes()).ok()?;
50
    let mut s: libc::statvfs = unsafe { std::mem::zeroed() };
51
    // SAFETY: `c` is a valid NUL-terminated path and `s` a writable statvfs.
52
    if unsafe { libc::statvfs(c.as_ptr(), &mut s) } != 0 {
53
        return None;
54
    }
55
    Some((s.f_bavail as u64).saturating_mul(s.f_frsize as u64) >> 20)
56
}
57
58
#[cfg(not(unix))]
59
pub fn free_disk_mib(_path: &std::path::Path) -> Option<u64> {
60
    None
61
}
62
63
/// The disk the files under `dir` take (their blocks, not their sizes: a
64
/// job's disks are sparse), in MiB; links are not followed.
65
pub fn allocated_mib(dir: &std::path::Path) -> Option<u64> {
66
    let mut total: u64 = 0;
67
    let mut stack = vec![dir.to_path_buf()];
68
    while let Some(d) = stack.pop() {
69
        for e in std::fs::read_dir(&d).ok()?.flatten() {
70
            let m = std::fs::symlink_metadata(e.path()).ok()?;
71
            if m.is_dir() {
72
                stack.push(e.path());
73
            } else {
74
                total = total.saturating_add(crate::portable::disk_bytes(&m));
75
            }
76
        }
77
    }
78
    Some(total >> 20)
79
}
80
81
/// A process's peak resident memory (`VmHWM`), in MiB.
82
pub fn peak_rss_mib(pid: u32) -> Option<u64> {
83
    let text = std::fs::read_to_string(format!("/proc/{pid}/status")).ok()?;
84
    let kib: u64 = text.lines().find_map(|l| l.strip_prefix("VmHWM:"))?.trim().trim_end_matches("kB").trim().parse().ok()?;
85
    Some(kib / 1024)
86
}
87
88
/// The 1-minute load average, times 100, from sysinfo (the kernel's own
89
/// numbers behind /proc/loadavg, which an Android app may not read); not
90
/// measured on Windows.
91
#[cfg(not(unix))]
92
pub fn load_x100() -> Option<u32> {
93
    None
94
}
95
96
#[cfg(unix)]
97
pub fn load_x100() -> Option<u32> {
98
    let mut i: libc::sysinfo = unsafe { std::mem::zeroed() };
99
    // SAFETY: `i` is a writable sysinfo.
100
    if unsafe { libc::sysinfo(&mut i) } != 0 {
101
        return None;
102
    }
103
    // Fixed point with 16 fraction bits (SI_LOAD_SHIFT).
104
    Some(((i.loads[0] as f64) / 65536.0 * 100.0).round() as u32)
105
}
106
107
/// The benchmark, one thread: BLAKE3 over 256 MiB (spec §11.1), and a sort
108
/// of 4 Mi pseudo-random words for the integer and memory side. Answers
109
/// the score, 100 on the reference machine, and the time it took.
110
pub fn bench() -> (u32, u128) {
111
    let start = Instant::now();
112
    let buf: Vec<u8> = (0..32u32 << 20).map(|i| (i.wrapping_mul(2_654_435_761) >> 13) as u8).collect();
113
    let mut h = blake3::Hasher::new();
114
    for _ in 0..8 {
115
        h.update(&buf);
116
    }
117
    std::hint::black_box(h.finalize());
118
    drop(buf);
119
    let mut x: u64 = 0x9e37_79b9_7f4a_7c15;
120
    let mut words: Vec<u64> = (0..4u64 << 20)
121
        .map(|_| {
122
            x ^= x << 13;
123
            x ^= x >> 7;
124
            x ^= x << 17;
125
            x
126
        })
127
        .collect();
128
    words.sort_unstable();
129
    std::hint::black_box(&words);
130
    let ms = start.elapsed().as_millis().max(1);
131
    ((REFERENCE_MS * 100.0 / ms as f64).round() as u32, ms)
132
}
133
134
#[cfg(test)]
135
mod tests {
136
    use super::*;
137
138
    #[test]
139
    fn the_cheap_facts_are_read_and_classes_double() {
140
        assert!(free_disk_mib(std::path::Path::new("/")).is_some());
141
        // The same numbers /proc gives, read without it (an Android app may not).
142
        let proc_load: f64 = std::fs::read_to_string("/proc/loadavg").unwrap().split_whitespace().next().unwrap().parse().unwrap();
143
        let load = load_x100().unwrap() as f64 / 100.0;
144
        assert!((load - proc_load).abs() < 1.0 + proc_load / 4.0, "sysinfo {load}, /proc {proc_load}");
145
        assert_eq!(kernel().unwrap(), std::fs::read_to_string("/proc/sys/kernel/osrelease").unwrap().trim());
146
        assert!(peak_rss_mib(std::process::id()).is_some_and(|m| m > 0));
147
        let dir = tempfile::tempdir().unwrap();
148
        let f = std::fs::File::create(dir.path().join("sparse")).unwrap();
149
        f.set_len(1 << 30).unwrap();
150
        std::fs::write(dir.path().join("full"), vec![7u8; 3 << 20]).unwrap();
151
        let mib = allocated_mib(dir.path()).unwrap();
152
        assert!((3..=4).contains(&mib), "the sparse gigabyte takes nothing, the written 3 MiB do: {mib}");
153
        assert_eq!(Facts::class_of(100), 3, "the reference machine");
154
        assert_eq!((Facts::class_of(50), Facts::class_of(200), Facts::class_of(500), Facts::class_of(10)), (2, 4, 5, 1));
155
    }
156
}