#
cargo/core/compiler/
compilation.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
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526

    //! Type definitions for the result of a compilation.

    use std::collections::{BTreeSet, HashMap};
    use std::ffi::{OsStr, OsString};
    use std::path::PathBuf;

    use cargo_platform::CfgExpr;
    use cargo_util::{paths, ProcessBuilder};

    use crate::core::compiler::apply_env_config;
    use crate::core::compiler::BuildContext;
    use crate::core::compiler::{CompileKind, Unit, UnitHash};
    use crate::core::Package;
    use crate::util::{context, CargoResult, GlobalContext};

    /// Represents the kind of process we are creating.
    #[derive(Debug)]
    enum ToolKind {
        /// See [`Compilation::rustc_process`].
        Rustc,
        /// See [`Compilation::rustdoc_process`].
        Rustdoc,
        /// See [`Compilation::host_process`].
        HostProcess,
        /// See [`Compilation::target_process`].
        TargetProcess,
    }

    impl ToolKind {
        fn is_rustc_tool(&self) -> bool {
            matches!(self, ToolKind::Rustc | ToolKind::Rustdoc)
        }
    }

    /// Structure with enough information to run `rustdoc --test`.
    pub struct Doctest {
        /// What's being doctested
        pub unit: Unit,
        /// Arguments needed to pass to rustdoc to run this test.
        pub args: Vec<OsString>,
        /// Whether or not -Zunstable-options is needed.
        pub unstable_opts: bool,
        /// The -Clinker value to use.
        pub linker: Option<PathBuf>,
        /// The script metadata, if this unit's package has a build script.
        ///
        /// This is used for indexing [`Compilation::extra_env`].
        pub script_meta: Option<UnitHash>,

        /// Environment variables to set in the rustdoc process.
        pub env: HashMap<String, OsString>,
    }

    /// Information about the output of a unit.
    #[derive(Ord, PartialOrd, Eq, PartialEq)]
    pub struct UnitOutput {
        /// The unit that generated this output.
        pub unit: Unit,
        /// Path to the unit's primary output (an executable or cdylib).
        pub path: PathBuf,
        /// The script metadata, if this unit's package has a build script.
        ///
        /// This is used for indexing [`Compilation::extra_env`].
        pub script_meta: Option<UnitHash>,
    }

    /// A structure returning the result of a compilation.
    pub struct Compilation<'gctx> {
        /// An array of all tests created during this compilation.
        pub tests: Vec<UnitOutput>,

        /// An array of all binaries created.
        pub binaries: Vec<UnitOutput>,

        /// An array of all cdylibs created.
        pub cdylibs: Vec<UnitOutput>,

        /// The crate names of the root units specified on the command-line.
        pub root_crate_names: Vec<String>,

        /// All directories for the output of native build commands.
        ///
        /// This is currently used to drive some entries which are added to the
        /// `LD_LIBRARY_PATH` as appropriate.
        ///
        /// The order should be deterministic.
        pub native_dirs: BTreeSet<PathBuf>,

        /// Root output directory (for the local package's artifacts)
        pub root_output: HashMap<CompileKind, PathBuf>,

        /// Output directory for rust dependencies.
        /// May be for the host or for a specific target.
        pub deps_output: HashMap<CompileKind, PathBuf>,

        /// The path to libstd for each target
        sysroot_target_libdir: HashMap<CompileKind, PathBuf>,

        /// Extra environment variables that were passed to compilations and should
        /// be passed to future invocations of programs.
        ///
        /// The key is the build script metadata for uniquely identifying the
        /// `RunCustomBuild` unit that generated these env vars.
        pub extra_env: HashMap<UnitHash, Vec<(String, String)>>,

        /// Libraries to test with rustdoc.
        pub to_doc_test: Vec<Doctest>,

        /// The target host triple.
        pub host: String,

        gctx: &'gctx GlobalContext,

        /// Rustc process to be used by default
        rustc_process: ProcessBuilder,
        /// Rustc process to be used for workspace crates instead of `rustc_process`
        rustc_workspace_wrapper_process: ProcessBuilder,
        /// Optional rustc process to be used for primary crates instead of either `rustc_process` or
        /// `rustc_workspace_wrapper_process`
        primary_rustc_process: Option<ProcessBuilder>,

        target_runners: HashMap<CompileKind, Option<(PathBuf, Vec<String>)>>,
        /// The linker to use for each host or target.
        target_linkers: HashMap<CompileKind, Option<PathBuf>>,

        /// The total number of warnings emitted by the compilation.
        pub warning_count: usize,
    }

    impl<'gctx> Compilation<'gctx> {
        pub fn new<'a>(bcx: &BuildContext<'a, 'gctx>) -> CargoResult<Compilation<'gctx>> {
            let rustc_process = bcx.rustc().process();
            let primary_rustc_process = bcx.build_config.primary_unit_rustc.clone();
            let rustc_workspace_wrapper_process = bcx.rustc().workspace_process();
            Ok(Compilation {
                native_dirs: BTreeSet::new(),
                root_output: HashMap::new(),
                deps_output: HashMap::new(),
                sysroot_target_libdir: get_sysroot_target_libdir(bcx)?,
                tests: Vec::new(),
                binaries: Vec::new(),
                cdylibs: Vec::new(),
                root_crate_names: Vec::new(),
                extra_env: HashMap::new(),
                to_doc_test: Vec::new(),
                gctx: bcx.gctx,
                host: bcx.host_triple().to_string(),
                rustc_process,
                rustc_workspace_wrapper_process,
                primary_rustc_process,
                target_runners: bcx
                    .build_config
                    .requested_kinds
                    .iter()
                    .chain(Some(&CompileKind::Host))
                    .map(|kind| Ok((*kind, target_runner(bcx, *kind)?)))
                    .collect::<CargoResult<HashMap<_, _>>>()?,
                target_linkers: bcx
                    .build_config
                    .requested_kinds
                    .iter()
                    .chain(Some(&CompileKind::Host))
                    .map(|kind| Ok((*kind, target_linker(bcx, *kind)?)))
                    .collect::<CargoResult<HashMap<_, _>>>()?,
                warning_count: 0,
            })
        }

        /// Returns a [`ProcessBuilder`] for running `rustc`.
        ///
        /// `is_primary` is true if this is a "primary package", which means it
        /// was selected by the user on the command-line (such as with a `-p`
        /// flag), see [`crate::core::compiler::BuildRunner::primary_packages`].
        ///
        /// `is_workspace` is true if this is a workspace member.
        pub fn rustc_process(
            &self,
            unit: &Unit,
            is_primary: bool,
            is_workspace: bool,
        ) -> CargoResult<ProcessBuilder> {
            let mut rustc = if is_primary && self.primary_rustc_process.is_some() {
                self.primary_rustc_process.clone().unwrap()
            } else if is_workspace {
                self.rustc_workspace_wrapper_process.clone()
            } else {
                self.rustc_process.clone()
            };
            if self.gctx.extra_verbose() {
                rustc.display_env_vars();
            }
            let cmd = fill_rustc_tool_env(rustc, unit);
            self.fill_env(cmd, &unit.pkg, None, unit.kind, ToolKind::Rustc)
        }

        /// Returns a [`ProcessBuilder`] for running `rustdoc`.
        pub fn rustdoc_process(
            &self,
            unit: &Unit,
            script_meta: Option<UnitHash>,
        ) -> CargoResult<ProcessBuilder> {
            let mut rustdoc = ProcessBuilder::new(&*self.gctx.rustdoc()?);
            if self.gctx.extra_verbose() {
                rustdoc.display_env_vars();
            }
            let cmd = fill_rustc_tool_env(rustdoc, unit);
            let mut cmd = self.fill_env(cmd, &unit.pkg, script_meta, unit.kind, ToolKind::Rustdoc)?;
            cmd.retry_with_argfile(true);
            unit.target.edition().cmd_edition_arg(&mut cmd);

            for crate_type in unit.target.rustc_crate_types() {
                cmd.arg("--crate-type").arg(crate_type.as_str());
            }

            Ok(cmd)
        }

        /// Returns a [`ProcessBuilder`] appropriate for running a process for the
        /// host platform.
        ///
        /// This is currently only used for running build scripts. If you use this
        /// for anything else, please be extra careful on how environment
        /// variables are set!
        pub fn host_process<T: AsRef<OsStr>>(
            &self,
            cmd: T,
            pkg: &Package,
        ) -> CargoResult<ProcessBuilder> {
            self.fill_env(
                ProcessBuilder::new(cmd),
                pkg,
                None,
                CompileKind::Host,
                ToolKind::HostProcess,
            )
        }

        pub fn target_runner(&self, kind: CompileKind) -> Option<&(PathBuf, Vec<String>)> {
            self.target_runners.get(&kind).and_then(|x| x.as_ref())
        }

        /// Gets the user-specified linker for a particular host or target.
        pub fn target_linker(&self, kind: CompileKind) -> Option<PathBuf> {
            self.target_linkers.get(&kind).and_then(|x| x.clone())
        }

        /// Returns a [`ProcessBuilder`] appropriate for running a process for the
        /// target platform. This is typically used for `cargo run` and `cargo
        /// test`.
        ///
        /// `script_meta` is the metadata for the `RunCustomBuild` unit that this
        /// unit used for its build script. Use `None` if the package did not have
        /// a build script.
        pub fn target_process<T: AsRef<OsStr>>(
            &self,
            cmd: T,
            kind: CompileKind,
            pkg: &Package,
            script_meta: Option<UnitHash>,
        ) -> CargoResult<ProcessBuilder> {
            let builder = if let Some((runner, args)) = self.target_runner(kind) {
                let mut builder = ProcessBuilder::new(runner);
                builder.args(args);
                builder.arg(cmd);
                builder
            } else {
                ProcessBuilder::new(cmd)
            };
            let tool_kind = ToolKind::TargetProcess;
            let mut builder = self.fill_env(builder, pkg, script_meta, kind, tool_kind)?;

            if let Some(client) = self.gctx.jobserver_from_env() {
                builder.inherit_jobserver(client);
            }

            Ok(builder)
        }

        /// Prepares a new process with an appropriate environment to run against
        /// the artifacts produced by the build process.
        ///
        /// The package argument is also used to configure environment variables as
        /// well as the working directory of the child process.
        fn fill_env(
            &self,
            mut cmd: ProcessBuilder,
            pkg: &Package,
            script_meta: Option<UnitHash>,
            kind: CompileKind,
            tool_kind: ToolKind,
        ) -> CargoResult<ProcessBuilder> {
            let mut search_path = Vec::new();
            if tool_kind.is_rustc_tool() {
                if matches!(tool_kind, ToolKind::Rustdoc) {
                    // HACK: `rustdoc --test` not only compiles but executes doctests.
                    // Ideally only execution phase should have search paths appended,
                    // so the executions can find native libs just like other tests.
                    // However, there is no way to separate these two phase, so this
                    // hack is added for both phases.
                    // TODO: handle doctest-xcompile
                    search_path.extend(super::filter_dynamic_search_path(
                        self.native_dirs.iter(),
                        &self.root_output[&CompileKind::Host],
                    ));
                }
                search_path.push(self.deps_output[&CompileKind::Host].clone());
            } else {
                search_path.extend(super::filter_dynamic_search_path(
                    self.native_dirs.iter(),
                    &self.root_output[&kind],
                ));
                search_path.push(self.deps_output[&kind].clone());
                search_path.push(self.root_output[&kind].clone());
                // For build-std, we don't want to accidentally pull in any shared
                // libs from the sysroot that ships with rustc. This may not be
                // required (at least I cannot craft a situation where it
                // matters), but is here to be safe.
                if self.gctx.cli_unstable().build_std.is_none() {
                    search_path.push(self.sysroot_target_libdir[&kind].clone());
                }
            }

            let dylib_path = paths::dylib_path();
            let dylib_path_is_empty = dylib_path.is_empty();
            if dylib_path.starts_with(&search_path) {
                search_path = dylib_path;
            } else {
                search_path.extend(dylib_path.into_iter());
            }
            if cfg!(target_os = "macos") && dylib_path_is_empty {
                // These are the defaults when DYLD_FALLBACK_LIBRARY_PATH isn't
                // set or set to an empty string. Since Cargo is explicitly setting
                // the value, make sure the defaults still work.
                if let Some(home) = self.gctx.get_env_os("HOME") {
                    search_path.push(PathBuf::from(home).join("lib"));
                }
                search_path.push(PathBuf::from("/usr/local/lib"));
                search_path.push(PathBuf::from("/usr/lib"));
            }
            let search_path = paths::join_paths(&search_path, paths::dylib_path_envvar())?;

            cmd.env(paths::dylib_path_envvar(), &search_path);
            if let Some(meta) = script_meta {
                if let Some(env) = self.extra_env.get(&meta) {
                    for (k, v) in env {
                        cmd.env(k, v);
                    }
                }
            }

            let metadata = pkg.manifest().metadata();

            let cargo_exe = self.gctx.cargo_exe()?;
            cmd.env(crate::CARGO_ENV, cargo_exe);

            // When adding new environment variables depending on
            // crate properties which might require rebuild upon change
            // consider adding the corresponding properties to the hash
            // in BuildContext::target_metadata()
            let rust_version = pkg.rust_version().as_ref().map(ToString::to_string);
            cmd.env("CARGO_MANIFEST_DIR", pkg.root())
                .env("CARGO_MANIFEST_PATH", pkg.manifest_path())
                .env("CARGO_PKG_VERSION_MAJOR", &pkg.version().major.to_string())
                .env("CARGO_PKG_VERSION_MINOR", &pkg.version().minor.to_string())
                .env("CARGO_PKG_VERSION_PATCH", &pkg.version().patch.to_string())
                .env("CARGO_PKG_VERSION_PRE", pkg.version().pre.as_str())
                .env("CARGO_PKG_VERSION", &pkg.version().to_string())
                .env("CARGO_PKG_NAME", &*pkg.name())
                .env(
                    "CARGO_PKG_DESCRIPTION",
                    metadata.description.as_ref().unwrap_or(&String::new()),
                )
                .env(
                    "CARGO_PKG_HOMEPAGE",
                    metadata.homepage.as_ref().unwrap_or(&String::new()),
                )
                .env(
                    "CARGO_PKG_REPOSITORY",
                    metadata.repository.as_ref().unwrap_or(&String::new()),
                )
                .env(
                    "CARGO_PKG_LICENSE",
                    metadata.license.as_ref().unwrap_or(&String::new()),
                )
                .env(
                    "CARGO_PKG_LICENSE_FILE",
                    metadata.license_file.as_ref().unwrap_or(&String::new()),
                )
                .env("CARGO_PKG_AUTHORS", &pkg.authors().join(":"))
                .env(
                    "CARGO_PKG_RUST_VERSION",
                    &rust_version.as_deref().unwrap_or_default(),
                )
                .env(
                    "CARGO_PKG_README",
                    metadata.readme.as_ref().unwrap_or(&String::new()),
                )
                .cwd(pkg.root());

            apply_env_config(self.gctx, &mut cmd)?;

            Ok(cmd)
        }
    }

    /// Prepares a `rustc_tool` process with additional environment variables
    /// that are only relevant in a context that has a unit
    fn fill_rustc_tool_env(mut cmd: ProcessBuilder, unit: &Unit) -> ProcessBuilder {
        if unit.target.is_executable() {
            let name = unit
                .target
                .binary_filename()
                .unwrap_or(unit.target.name().to_string());

            cmd.env("CARGO_BIN_NAME", name);
        }
        cmd.env("CARGO_CRATE_NAME", unit.target.crate_name());
        cmd
    }

    fn get_sysroot_target_libdir(
        bcx: &BuildContext<'_, '_>,
    ) -> CargoResult<HashMap<CompileKind, PathBuf>> {
        bcx.all_kinds
            .iter()
            .map(|&kind| {
                let Some(info) = bcx.target_data.get_info(kind) else {
                    let target = match kind {
                        CompileKind::Host => "host".to_owned(),
                        CompileKind::Target(s) => s.short_name().to_owned(),
                    };

                    let dependency = bcx
                        .unit_graph
                        .iter()
                        .find_map(|(u, _)| (u.kind == kind).then_some(u.pkg.summary().package_id()))
                        .unwrap();

                    anyhow::bail!(
                        "could not find specification for target `{target}`.\n  \
                        Dependency `{dependency}` requires to build for target `{target}`."
                    )
                };

                Ok((kind, info.sysroot_target_libdir.clone()))
            })
            .collect()
    }

    fn target_runner(
        bcx: &BuildContext<'_, '_>,
        kind: CompileKind,
    ) -> CargoResult<Option<(PathBuf, Vec<String>)>> {
        let target = bcx.target_data.short_name(&kind);

        // try target.{}.runner
        let key = format!("target.{}.runner", target);

        if let Some(v) = bcx.gctx.get::<Option<context::PathAndArgs>>(&key)? {
            let path = v.path.resolve_program(bcx.gctx);
            return Ok(Some((path, v.args)));
        }

        // try target.'cfg(...)'.runner
        let target_cfg = bcx.target_data.info(kind).cfg();
        let mut cfgs = bcx
            .gctx
            .target_cfgs()?
            .iter()
            .filter_map(|(key, cfg)| cfg.runner.as_ref().map(|runner| (key, runner)))
            .filter(|(key, _runner)| CfgExpr::matches_key(key, target_cfg));
        let matching_runner = cfgs.next();
        if let Some((key, runner)) = cfgs.next() {
            anyhow::bail!(
                "several matching instances of `target.'cfg(..)'.runner` in configurations\n\
                 first match `{}` located in {}\n\
                 second match `{}` located in {}",
                matching_runner.unwrap().0,
                matching_runner.unwrap().1.definition,
                key,
                runner.definition
            );
        }
        Ok(matching_runner.map(|(_k, runner)| {
            (
                runner.val.path.clone().resolve_program(bcx.gctx),
                runner.val.args.clone(),
            )
        }))
    }

    /// Gets the user-specified linker for a particular host or target from the configuration.
    fn target_linker(bcx: &BuildContext<'_, '_>, kind: CompileKind) -> CargoResult<Option<PathBuf>> {
        // Try host.linker and target.{}.linker.
        if let Some(path) = bcx
            .target_data
            .target_config(kind)
            .linker
            .as_ref()
            .map(|l| l.val.clone().resolve_program(bcx.gctx))
        {
            return Ok(Some(path));
        }

        // Try target.'cfg(...)'.linker.
        let target_cfg = bcx.target_data.info(kind).cfg();
        let mut cfgs = bcx
            .gctx
            .target_cfgs()?
            .iter()
            .filter_map(|(key, cfg)| cfg.linker.as_ref().map(|linker| (key, linker)))
            .filter(|(key, _linker)| CfgExpr::matches_key(key, target_cfg));
        let matching_linker = cfgs.next();
        if let Some((key, linker)) = cfgs.next() {
            anyhow::bail!(
                "several matching instances of `target.'cfg(..)'.linker` in configurations\n\
                 first match `{}` located in {}\n\
                 second match `{}` located in {}",
                matching_linker.unwrap().0,
                matching_linker.unwrap().1.definition,
                key,
                linker.definition
            );
        }
        Ok(matching_linker.map(|(_k, linker)| linker.val.clone().resolve_program(bcx.gctx)))
    }