cargo-wizard 0.2.3

Cargo subcommand for applying Cargo profile templates.
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

use rustc_version::Version;

use crate::template::{TemplateItemId, dev_profile, release_profile};
use crate::toml::TomlValue;
use crate::utils::get_core_count;
use crate::{Template, WizardOptions};

/// Enumeration of predefined templates.
#[derive(clap::ValueEnum, Clone, Copy, Debug)]
pub enum PredefinedTemplateKind {
    /// Profile designed for fast compilation times.
    FastCompile,
    /// Profile designed for fast runtime performance.
    FastRuntime,
    /// Profile designed for minimal binary size.
    MinSize,
}

impl PredefinedTemplateKind {
    pub fn build_template(&self, options: &WizardOptions) -> Template {
        match self {
            PredefinedTemplateKind::FastCompile => fast_compile_template(options),
            PredefinedTemplateKind::FastRuntime => fast_runtime_template(),
            PredefinedTemplateKind::MinSize => min_size_template(),
        }
    }
}

#[cfg(unix)]
fn is_macos_host(host: &str) -> bool {
    host.ends_with("-apple-darwin")
}

#[cfg(unix)]
fn should_suggest_lld(version: &Version, host: &str) -> bool {
    if is_macos_host(host) {
        return false;
    }

    version < &Version::new(1, 90, 0) || host != "x86_64-unknown-linux-gnu"
}

/// Template that focuses on quick compile time.
pub fn fast_compile_template(options: &WizardOptions) -> Template {
    let mut builder = dev_profile().item(TemplateItemId::DebugInfo, TomlValue::int(0));

    #[cfg(unix)]
    match rustc_version::version_meta() {
        Ok(meta) => {
            if should_suggest_lld(&meta.semver, &meta.host) {
                builder = builder.item(TemplateItemId::Linker, TomlValue::string("lld"));
            }
        }
        Err(error) => {
            if !cfg!(target_os = "macos") {
                builder = builder.item(TemplateItemId::Linker, TomlValue::string("lld"));
            }
            eprintln!("Cannot get compiler version metadata. ({error:?})");
        }
    }

    if options.nightly_items_enabled() {
        builder = builder
            .item(
                TemplateItemId::CodegenBackend,
                TomlValue::string("cranelift"),
            )
            .item(
                TemplateItemId::FrontendThreads,
                TomlValue::Int(get_core_count()),
            )
    }
    builder.build()
}

/// Template that focuses on maximum runtime performance.
pub fn fast_runtime_template() -> Template {
    release_profile()
        .item(TemplateItemId::Lto, TomlValue::bool(true))
        .item(TemplateItemId::CodegenUnits, TomlValue::int(1))
        .item(TemplateItemId::Panic, TomlValue::string("abort"))
        .item(
            TemplateItemId::TargetCpuInstructionSet,
            TomlValue::string("native"),
        )
        .build()
}

/// Template that template focuses on minimal binary size.
pub fn min_size_template() -> Template {
    release_profile()
        .item(TemplateItemId::DebugInfo, TomlValue::bool(false))
        .item(TemplateItemId::Strip, TomlValue::bool(true))
        .item(TemplateItemId::Lto, TomlValue::bool(true))
        .item(TemplateItemId::OptimizationLevel, TomlValue::string("z"))
        .item(TemplateItemId::CodegenUnits, TomlValue::int(1))
        .item(TemplateItemId::Panic, TomlValue::string("abort"))
        .build()
}

/// Test that the predefined templates can be created without panicking.
#[cfg(test)]
mod tests {
    use crate::{WizardOptions, fast_compile_template, fast_runtime_template, min_size_template};

    #[cfg(unix)]
    use super::should_suggest_lld;
    #[cfg(unix)]
    use rustc_version::Version;

    #[test]
    fn create_fast_compile_template() {
        fast_compile_template(&WizardOptions::default());
    }

    #[test]
    fn create_fast_runtime_template() {
        fast_runtime_template();
    }

    #[test]
    fn create_min_size_template() {
        min_size_template();
    }

    #[test]
    #[cfg(unix)]
    fn fast_compile_linker_matrix_matches_supported_hosts() {
        assert!(should_suggest_lld(
            &Version::new(1, 89, 0),
            "x86_64-unknown-linux-gnu"
        ));
        assert!(!should_suggest_lld(
            &Version::new(1, 90, 0),
            "x86_64-unknown-linux-gnu"
        ));
        assert!(should_suggest_lld(
            &Version::new(1, 90, 0),
            "aarch64-unknown-linux-gnu"
        ));
        assert!(!should_suggest_lld(
            &Version::new(1, 89, 0),
            "x86_64-apple-darwin"
        ));
        assert!(!should_suggest_lld(
            &Version::new(1, 90, 0),
            "aarch64-apple-darwin"
        ));
    }
}