axbuild 0.4.19

An OS build lib toolkit used by arceos
Documentation 
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

use std::time::{Duration, Instant};

const TIMING_PREFIX: &str = "AXBUILD_TIMING:";

#[derive(Debug)]
pub(crate) struct TimingStage {
    scope: &'static str,
    fields: Vec<(&'static str, String)>,
    started: Instant,
}

impl TimingStage {
    pub(crate) fn new(
        scope: &'static str,
        fields: impl IntoIterator<Item = (&'static str, String)>,
    ) -> Self {
        Self {
            scope,
            fields: fields.into_iter().collect(),
            started: Instant::now(),
        }
    }

    pub(crate) fn elapsed(&self) -> Duration {
        self.started.elapsed()
    }

    pub(crate) fn finish(self) -> Duration {
        let elapsed = self.started.elapsed();
        print_timing_line(self.scope, &self.fields, elapsed);
        elapsed
    }
}

pub(crate) fn print_timing_line(scope: &str, fields: &[(&'static str, String)], elapsed: Duration) {
    println!("{}", format_timing_line(scope, fields, elapsed));
}

pub(crate) fn print_grouped_c_compile_total(case: &str, mode: &str, elapsed: Duration) {
    println!(
        "{}",
        format_grouped_c_compile_total_line(case, mode, elapsed)
    );
}

pub(crate) fn format_grouped_c_compile_total_line(
    case: &str,
    mode: &str,
    elapsed: Duration,
) -> String {
    format_timing_line(
        "grouped-c",
        &[("case", case), ("phase", "compile-total"), ("mode", mode)],
        elapsed,
    )
}

pub(crate) fn format_timing_line(
    scope: &str,
    fields: &[(&'static str, impl AsRef<str>)],
    elapsed: Duration,
) -> String {
    let mut line = format!("{TIMING_PREFIX} scope={}", normalize_timing_value(scope));
    for (key, value) in fields {
        line.push(' ');
        line.push_str(key);
        line.push('=');
        line.push_str(&normalize_timing_value(value.as_ref()));
    }
    line.push_str(&format!(" elapsed_s={:.3}", elapsed.as_secs_f64()));
    line
}

fn normalize_timing_value(value: &str) -> String {
    value
        .chars()
        .map(|ch| if ch.is_ascii_whitespace() { '-' } else { ch })
        .collect()
}

#[cfg(test)]
mod tests {
    use std::time::Duration;

    #[test]
    fn axbuild_timing_line_contains_stable_fields_and_parseable_seconds() {
        let line = super::format_timing_line(
            "starry-qemu",
            &[("build_group", "qemu"), ("phase", "build")],
            Duration::from_millis(1250),
        );

        assert!(line.starts_with("AXBUILD_TIMING: "));
        assert!(line.contains("scope=starry-qemu"));
        assert!(line.contains("build_group=qemu"));
        assert!(line.contains("phase=build"));

        let elapsed = line
            .split_ascii_whitespace()
            .find_map(|field| field.strip_prefix("elapsed_s="))
            .expect("timing line must include elapsed_s");
        let elapsed = elapsed
            .parse::<f64>()
            .expect("elapsed_s must be a parseable floating point second value");
        assert!((elapsed - 1.25).abs() < f64::EPSILON);
    }

    #[test]
    fn axbuild_timing_line_normalizes_field_whitespace() {
        let line = super::format_timing_line(
            "qemu case",
            &[("case", "qemu/system test"), ("phase", "prepare assets")],
            Duration::from_millis(1),
        );

        assert!(line.contains("scope=qemu-case"));
        assert!(line.contains("case=qemu/system-test"));
        assert!(line.contains("phase=prepare-assets"));
    }

    #[test]
    fn axbuild_timing_grouped_c_compile_total_line_includes_mode() {
        let line = super::format_grouped_c_compile_total_line(
            "qemu/system",
            "per-subcase",
            Duration::from_millis(3456),
        );

        assert!(line.starts_with("AXBUILD_TIMING: "));
        assert!(line.contains("scope=grouped-c"));
        assert!(line.contains("case=qemu/system"));
        assert!(line.contains("phase=compile-total"));
        assert!(line.contains("mode=per-subcase"));
        assert!(line.contains("elapsed_s=3.456"));
    }

    #[test]
    fn axbuild_timing_grouped_c_root_project_compile_total_line_includes_mode() {
        let line = super::format_grouped_c_compile_total_line(
            "qemu/system",
            "root-project",
            Duration::from_millis(7890),
        );

        assert!(line.starts_with("AXBUILD_TIMING: "));
        assert!(line.contains("scope=grouped-c"));
        assert!(line.contains("case=qemu/system"));
        assert!(line.contains("phase=compile-total"));
        assert!(line.contains("mode=root-project"));
        assert!(line.contains("elapsed_s=7.890"));
    }
}