#
cargo/core/compiler/
build_config.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

    use crate::core::compiler::CompileKind;
    use crate::util::context::JobsConfig;
    use crate::util::interning::InternedString;
    use crate::util::{CargoResult, GlobalContext, RustfixDiagnosticServer};
    use anyhow::{bail, Context as _};
    use cargo_util::ProcessBuilder;
    use serde::ser;
    use std::cell::RefCell;
    use std::path::PathBuf;
    use std::rc::Rc;
    use std::thread::available_parallelism;

    /// Configuration information for a rustc build.
    #[derive(Debug, Clone)]
    pub struct BuildConfig {
        /// The requested kind of compilation for this session
        pub requested_kinds: Vec<CompileKind>,
        /// Number of rustc jobs to run in parallel.
        pub jobs: u32,
        /// Do not abort the build as soon as there is an error.
        pub keep_going: bool,
        /// Build profile
        pub requested_profile: InternedString,
        /// The mode we are compiling in.
        pub mode: CompileMode,
        /// `true` to print stdout in JSON format (for machine reading).
        pub message_format: MessageFormat,
        /// Force Cargo to do a full rebuild and treat each target as changed.
        pub force_rebuild: bool,
        /// Output a build plan to stdout instead of actually compiling.
        pub build_plan: bool,
        /// Output the unit graph to stdout instead of actually compiling.
        pub unit_graph: bool,
        /// `true` to avoid really compiling.
        pub dry_run: bool,
        /// An optional override of the rustc process for primary units
        pub primary_unit_rustc: Option<ProcessBuilder>,
        /// A thread used by `cargo fix` to receive messages on a socket regarding
        /// the success/failure of applying fixes.
        pub rustfix_diagnostic_server: Rc<RefCell<Option<RustfixDiagnosticServer>>>,
        /// The directory to copy final artifacts to. Note that even if
        /// `artifact-dir` is set, a copy of artifacts still can be found at
        /// `target/(debug\release)` as usual.
        /// Named `export_dir` to avoid confusion with
        /// `CompilationFiles::artifact_dir`.
        pub export_dir: Option<PathBuf>,
        /// `true` to output a future incompatibility report at the end of the build
        pub future_incompat_report: bool,
        /// Which kinds of build timings to output (empty if none).
        pub timing_outputs: Vec<TimingOutput>,
    }

    fn default_parallelism() -> CargoResult<u32> {
        Ok(available_parallelism()
            .context("failed to determine the amount of parallelism available")?
            .get() as u32)
    }

    impl BuildConfig {
        /// Parses all config files to learn about build configuration. Currently
        /// configured options are:
        ///
        /// * `build.jobs`
        /// * `build.target`
        /// * `target.$target.ar`
        /// * `target.$target.linker`
        /// * `target.$target.libfoo.metadata`
        pub fn new(
            gctx: &GlobalContext,
            jobs: Option<JobsConfig>,
            keep_going: bool,
            requested_targets: &[String],
            mode: CompileMode,
        ) -> CargoResult<BuildConfig> {
            let cfg = gctx.build_config()?;
            let requested_kinds = CompileKind::from_requested_targets(gctx, requested_targets)?;
            if jobs.is_some() && gctx.jobserver_from_env().is_some() {
                gctx.shell().warn(
                    "a `-j` argument was passed to Cargo but Cargo is \
                     also configured with an external jobserver in \
                     its environment, ignoring the `-j` parameter",
                )?;
            }
            let jobs = match jobs.or(cfg.jobs.clone()) {
                None => default_parallelism()?,
                Some(value) => match value {
                    JobsConfig::Integer(j) => match j {
                        0 => anyhow::bail!("jobs may not be 0"),
                        j if j < 0 => (default_parallelism()? as i32 + j).max(1) as u32,
                        j => j as u32,
                    },
                    JobsConfig::String(j) => match j.as_str() {
                        "default" => default_parallelism()?,
                        _ => {
                            anyhow::bail!(
    			    format!("could not parse `{j}`. Number of parallel jobs should be `default` or a number."))
                        }
                    },
                },
            };

            if gctx.cli_unstable().build_std.is_some() && requested_kinds[0].is_host() {
                // TODO: This should eventually be fixed.
                anyhow::bail!("-Zbuild-std requires --target");
            }

            Ok(BuildConfig {
                requested_kinds,
                jobs,
                keep_going,
                requested_profile: InternedString::new("dev"),
                mode,
                message_format: MessageFormat::Human,
                force_rebuild: false,
                build_plan: false,
                unit_graph: false,
                dry_run: false,
                primary_unit_rustc: None,
                rustfix_diagnostic_server: Rc::new(RefCell::new(None)),
                export_dir: None,
                future_incompat_report: false,
                timing_outputs: Vec::new(),
            })
        }

        /// Whether or not the *user* wants JSON output. Whether or not rustc
        /// actually uses JSON is decided in `add_error_format`.
        pub fn emit_json(&self) -> bool {
            matches!(self.message_format, MessageFormat::Json { .. })
        }

        pub fn test(&self) -> bool {
            self.mode == CompileMode::Test || self.mode == CompileMode::Bench
        }

        pub fn single_requested_kind(&self) -> CargoResult<CompileKind> {
            match self.requested_kinds.len() {
                1 => Ok(self.requested_kinds[0]),
                _ => bail!("only one `--target` argument is supported"),
            }
        }
    }

    #[derive(Clone, Copy, Debug, PartialEq, Eq)]
    pub enum MessageFormat {
        Human,
        Json {
            /// Whether rustc diagnostics are rendered by cargo or included into the
            /// output stream.
            render_diagnostics: bool,
            /// Whether the `rendered` field of rustc diagnostics are using the
            /// "short" rendering.
            short: bool,
            /// Whether the `rendered` field of rustc diagnostics embed ansi color
            /// codes.
            ansi: bool,
        },
        Short,
    }

    /// The general "mode" for what to do.
    /// This is used for two purposes. The commands themselves pass this in to
    /// `compile_ws` to tell it the general execution strategy. This influences
    /// the default targets selected. The other use is in the `Unit` struct
    /// to indicate what is being done with a specific target.
    #[derive(Clone, Copy, PartialEq, Debug, Eq, Hash, PartialOrd, Ord)]
    pub enum CompileMode {
        /// A target being built for a test.
        Test,
        /// Building a target with `rustc` (lib or bin).
        Build,
        /// Building a target with `rustc` to emit `rmeta` metadata only. If
        /// `test` is true, then it is also compiled with `--test` to check it like
        /// a test.
        Check { test: bool },
        /// Used to indicate benchmarks should be built. This is not used in
        /// `Unit`, because it is essentially the same as `Test` (indicating
        /// `--test` should be passed to rustc) and by using `Test` instead it
        /// allows some de-duping of Units to occur.
        Bench,
        /// A target that will be documented with `rustdoc`.

        /// If `deps` is true, then it will also document all dependencies.
        /// if `json` is true, the documentation output is in json format.
        Doc { deps: bool, json: bool },
        /// A target that will be tested with `rustdoc`.
        Doctest,
        /// An example or library that will be scraped for function calls by `rustdoc`.
        Docscrape,
        /// A marker for Units that represent the execution of a `build.rs` script.
        RunCustomBuild,
    }

    impl ser::Serialize for CompileMode {
        fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>
        where
            S: ser::Serializer,
        {
            use self::CompileMode::*;
            match *self {
                Test => "test".serialize(s),
                Build => "build".serialize(s),
                Check { .. } => "check".serialize(s),
                Bench => "bench".serialize(s),
                Doc { .. } => "doc".serialize(s),
                Doctest => "doctest".serialize(s),
                Docscrape => "docscrape".serialize(s),
                RunCustomBuild => "run-custom-build".serialize(s),
            }
        }
    }

    impl CompileMode {
        /// Returns `true` if the unit is being checked.
        pub fn is_check(self) -> bool {
            matches!(self, CompileMode::Check { .. })
        }

        /// Returns `true` if this is generating documentation.
        pub fn is_doc(self) -> bool {
            matches!(self, CompileMode::Doc { .. })
        }

        /// Returns `true` if this a doc test.
        pub fn is_doc_test(self) -> bool {
            self == CompileMode::Doctest
        }

        /// Returns `true` if this is scraping examples for documentation.
        pub fn is_doc_scrape(self) -> bool {
            self == CompileMode::Docscrape
        }

        /// Returns `true` if this is any type of test (test, benchmark, doc test, or
        /// check test).
        pub fn is_any_test(self) -> bool {
            matches!(
                self,
                CompileMode::Test
                    | CompileMode::Bench
                    | CompileMode::Check { test: true }
                    | CompileMode::Doctest
            )
        }

        /// Returns `true` if this is something that passes `--test` to rustc.
        pub fn is_rustc_test(self) -> bool {
            matches!(
                self,
                CompileMode::Test | CompileMode::Bench | CompileMode::Check { test: true }
            )
        }

        /// Returns `true` if this is the *execution* of a `build.rs` script.
        pub fn is_run_custom_build(self) -> bool {
            self == CompileMode::RunCustomBuild
        }

        /// Returns `true` if this mode may generate an executable.
        ///
        /// Note that this also returns `true` for building libraries, so you also
        /// have to check the target.
        pub fn generates_executable(self) -> bool {
            matches!(
                self,
                CompileMode::Test | CompileMode::Bench | CompileMode::Build
            )
        }
    }

    /// Kinds of build timings we can output.
    #[derive(Clone, Copy, PartialEq, Debug, Eq, Hash, PartialOrd, Ord)]
    pub enum TimingOutput {
        /// Human-readable HTML report
        Html,
        /// Machine-readable JSON (unstable)
        Json,
    }