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

    //! Generate artifact information from unit dependencies for configuring the compiler environment.

    use crate::core::compiler::unit_graph::UnitDep;
    use crate::core::compiler::{BuildRunner, CrateType, FileFlavor, Unit};
    use crate::core::dependency::ArtifactKind;
    use crate::core::{Dependency, Target, TargetKind};
    use crate::CargoResult;
    use std::collections::{HashMap, HashSet};
    use std::ffi::OsString;

    /// Return all environment variables for the given unit-dependencies
    /// if artifacts are present.
    pub fn get_env(
        build_runner: &BuildRunner<'_, '_>,
        dependencies: &[UnitDep],
    ) -> CargoResult<HashMap<String, OsString>> {
        let mut env = HashMap::new();
        for unit_dep in dependencies.iter().filter(|d| d.unit.artifact.is_true()) {
            for artifact_path in build_runner
                .outputs(&unit_dep.unit)?
                .iter()
                .filter_map(|f| (f.flavor == FileFlavor::Normal).then(|| &f.path))
            {
                let artifact_type_upper = unit_artifact_type_name_upper(&unit_dep.unit);
                let dep_name = unit_dep.dep_name.unwrap_or(unit_dep.unit.pkg.name());
                let dep_name_upper = dep_name.to_uppercase().replace("-", "_");

                let var = format!("CARGO_{}_DIR_{}", artifact_type_upper, dep_name_upper);
                let path = artifact_path.parent().expect("parent dir for artifacts");
                env.insert(var, path.to_owned().into());

                let var_file = format!(
                    "CARGO_{}_FILE_{}_{}",
                    artifact_type_upper,
                    dep_name_upper,
                    unit_dep.unit.target.name()
                );

                // In older releases, lib-targets defaulted to the name of the package. Newer releases
                // use the same name as default, but with dashes replaced. Hence, if the name of the
                // target was inferred by Cargo, we also set the env-var with the unconverted name for
                // backwards compatibility.
                let need_compat = unit_dep.unit.target.is_lib() && unit_dep.unit.target.name_inferred();
                if need_compat {
                    let var_compat = format!(
                        "CARGO_{}_FILE_{}_{}",
                        artifact_type_upper,
                        dep_name_upper,
                        unit_dep.unit.pkg.name(),
                    );
                    if var_compat != var_file {
                        env.insert(var_compat, artifact_path.to_owned().into());
                    }
                }

                env.insert(var_file, artifact_path.to_owned().into());

                // If the name of the target matches the name of the dependency, we strip the
                // repetition and provide the simpler env-var as well.
                // For backwards-compatibility of inferred names, we compare against the name of the
                // package as well, since that used to be the default for library targets.
                if unit_dep.unit.target.name() == dep_name.as_str()
                    || (need_compat && unit_dep.unit.pkg.name() == dep_name.as_str())
                {
                    let var = format!("CARGO_{}_FILE_{}", artifact_type_upper, dep_name_upper,);
                    env.insert(var, artifact_path.to_owned().into());
                }
            }
        }
        Ok(env)
    }

    fn unit_artifact_type_name_upper(unit: &Unit) -> &'static str {
        match unit.target.kind() {
            TargetKind::Lib(kinds) => match kinds.as_slice() {
                &[CrateType::Cdylib] => "CDYLIB",
                &[CrateType::Staticlib] => "STATICLIB",
                invalid => unreachable!("BUG: artifacts cannot be of type {:?}", invalid),
            },
            TargetKind::Bin => "BIN",
            invalid => unreachable!("BUG: artifacts cannot be of type {:?}", invalid),
        }
    }

    /// Given a dependency with an artifact `artifact_dep` and a set of available `targets`
    /// of its package, find a target for each kind of artifacts that are to be built.
    ///
    /// Failure to match any target results in an error mentioning the parent manifests
    /// `parent_package` name.
    pub(crate) fn match_artifacts_kind_with_targets<'t, 'd>(
        artifact_dep: &'d Dependency,
        targets: &'t [Target],
        parent_package: &str,
    ) -> CargoResult<HashSet<(&'d ArtifactKind, &'t Target)>> {
        let mut out = HashSet::new();
        let artifact_requirements = artifact_dep.artifact().expect("artifact present");
        for artifact_kind in artifact_requirements.kinds() {
            let mut extend = |kind, filter: &dyn Fn(&&Target) -> bool| {
                let mut iter = targets.iter().filter(filter).peekable();
                let found = iter.peek().is_some();
                out.extend(std::iter::repeat(kind).zip(iter));
                found
            };
            let found = match artifact_kind {
                ArtifactKind::Cdylib => extend(artifact_kind, &|t| t.is_cdylib()),
                ArtifactKind::Staticlib => extend(artifact_kind, &|t| t.is_staticlib()),
                ArtifactKind::AllBinaries => extend(artifact_kind, &|t| t.is_bin()),
                ArtifactKind::SelectedBinary(bin_name) => extend(artifact_kind, &|t| {
                    t.is_bin() && t.name() == bin_name.as_str()
                }),
            };
            if !found {
                anyhow::bail!(
                    "dependency `{}` in package `{}` requires a `{}` artifact to be present.",
                    artifact_dep.name_in_toml(),
                    parent_package,
                    artifact_kind
                );
            }
        }
        Ok(out)
    }