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

    //! A graph-like structure used to represent the rustc commands to build the package and the
    //! interdependencies between them.
    //!
    //! The `BuildPlan` structure is used to store the dependency graph of a dry run so that it can be
    //! shared with an external build system. Each Invocation in the `BuildPlan` comprises a single
    //! subprocess and defines the build environment, the outputs produced by the subprocess, and the
    //! dependencies on other Invocations.

    use std::collections::BTreeMap;
    use std::path::{Path, PathBuf};

    use serde::Serialize;

    use super::build_runner::OutputFile;
    use super::{BuildRunner, CompileKind, CompileMode, Unit};
    use crate::core::TargetKind;
    use crate::util::{internal, CargoResult, GlobalContext};
    use cargo_util::ProcessBuilder;

    #[derive(Debug, Serialize)]
    struct Invocation {
        package_name: String,
        package_version: semver::Version,
        target_kind: TargetKind,
        kind: CompileKind,
        compile_mode: CompileMode,
        deps: Vec<usize>,
        outputs: Vec<PathBuf>,
        links: BTreeMap<PathBuf, PathBuf>,
        program: String,
        args: Vec<String>,
        env: BTreeMap<String, String>,
        cwd: Option<PathBuf>,
    }

    #[derive(Debug)]
    pub struct BuildPlan {
        invocation_map: BTreeMap<String, usize>,
        plan: SerializedBuildPlan,
    }

    #[derive(Debug, Serialize)]
    struct SerializedBuildPlan {
        invocations: Vec<Invocation>,
        inputs: Vec<PathBuf>,
    }

    impl Invocation {
        pub fn new(unit: &Unit, deps: Vec<usize>) -> Invocation {
            let id = unit.pkg.package_id();
            Invocation {
                package_name: id.name().to_string(),
                package_version: id.version().clone(),
                kind: unit.kind,
                target_kind: unit.target.kind().clone(),
                compile_mode: unit.mode,
                deps,
                outputs: Vec::new(),
                links: BTreeMap::new(),
                program: String::new(),
                args: Vec::new(),
                env: BTreeMap::new(),
                cwd: None,
            }
        }

        pub fn add_output(&mut self, path: &Path, link: &Option<PathBuf>) {
            self.outputs.push(path.to_path_buf());
            if let Some(ref link) = *link {
                self.links.insert(link.clone(), path.to_path_buf());
            }
        }

        pub fn update_cmd(&mut self, cmd: &ProcessBuilder) -> CargoResult<()> {
            self.program = cmd
                .get_program()
                .to_str()
                .ok_or_else(|| anyhow::format_err!("unicode program string required"))?
                .to_string();
            self.cwd = Some(cmd.get_cwd().unwrap().to_path_buf());
            for arg in cmd.get_args() {
                self.args.push(
                    arg.to_str()
                        .ok_or_else(|| anyhow::format_err!("unicode argument string required"))?
                        .to_string(),
                );
            }
            for (var, value) in cmd.get_envs() {
                let Some(value) = value else { continue };
                self.env.insert(
                    var.clone(),
                    value
                        .to_str()
                        .ok_or_else(|| anyhow::format_err!("unicode environment value required"))?
                        .to_string(),
                );
            }
            Ok(())
        }
    }

    impl BuildPlan {
        pub fn new() -> BuildPlan {
            BuildPlan {
                invocation_map: BTreeMap::new(),
                plan: SerializedBuildPlan::new(),
            }
        }

        pub fn add(&mut self, build_runner: &BuildRunner<'_, '_>, unit: &Unit) -> CargoResult<()> {
            let id = self.plan.invocations.len();
            self.invocation_map.insert(unit.buildkey(), id);
            let deps = build_runner
                .unit_deps(unit)
                .iter()
                .map(|dep| self.invocation_map[&dep.unit.buildkey()])
                .collect();
            let invocation = Invocation::new(unit, deps);
            self.plan.invocations.push(invocation);
            Ok(())
        }

        pub fn update(
            &mut self,
            invocation_name: &str,
            cmd: &ProcessBuilder,
            outputs: &[OutputFile],
        ) -> CargoResult<()> {
            let id = self.invocation_map[invocation_name];
            let invocation =
                self.plan.invocations.get_mut(id).ok_or_else(|| {
                    internal(format!("couldn't find invocation for {}", invocation_name))
                })?;

            invocation.update_cmd(cmd)?;
            for output in outputs.iter() {
                invocation.add_output(&output.path, &output.hardlink);
            }

            Ok(())
        }

        pub fn set_inputs(&mut self, inputs: Vec<PathBuf>) {
            self.plan.inputs = inputs;
        }

        pub fn output_plan(self, gctx: &GlobalContext) {
            let encoded = serde_json::to_string(&self.plan).unwrap();
            crate::drop_println!(gctx, "{}", encoded);
        }
    }

    impl SerializedBuildPlan {
        pub fn new() -> SerializedBuildPlan {
            SerializedBuildPlan {
                invocations: Vec::new(),
                inputs: Vec::new(),
            }
        }
    }