flowey_lib_hvlite/_jobs/
local_build_igvm.rs

1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4//! A local-only job that supports the `cargo xflowey build-igvm` CLI
5
6use flowey::node::prelude::*;
7
8use crate::build_openhcl_boot::OpenhclBootOutput;
9use crate::build_openhcl_igvm_from_recipe::IgvmManifestPath;
10use crate::build_openhcl_igvm_from_recipe::OpenhclIgvmRecipe;
11use crate::build_openhcl_igvm_from_recipe::OpenhclIgvmRecipeDetails;
12use crate::build_openhcl_igvm_from_recipe::OpenhclIgvmRecipeDetailsLocalOnly;
13use crate::build_openhcl_igvm_from_recipe::OpenhclKernelPackage;
14use crate::build_openhcl_igvm_from_recipe::Vtl0KernelType;
15use crate::build_openhcl_initrd::OpenhclInitrdExtraParams;
16use crate::build_openvmm_hcl::OpenvmmHclBuildProfile;
17use crate::build_openvmm_hcl::OpenvmmHclFeature;
18use crate::build_openvmm_hcl::OpenvmmHclOutput;
19use crate::run_cargo_build::common::CommonArch;
20use crate::run_cargo_build::common::CommonTriple;
21use crate::run_igvmfilegen::IgvmOutput;
22
23#[derive(Default, Serialize, Deserialize, PartialEq, Eq)]
24pub struct Customizations {
25    pub build_label: Option<String>,
26    pub custom_directory: Vec<PathBuf>,
27    pub custom_kernel_modules: Option<PathBuf>,
28    pub custom_kernel: Option<PathBuf>,
29    pub custom_layer: Vec<PathBuf>,
30    pub custom_openhcl_boot: Option<PathBuf>,
31    pub custom_openvmm_hcl: Option<PathBuf>,
32    pub custom_sidecar: Option<PathBuf>,
33    pub custom_uefi: Option<PathBuf>,
34    pub custom_vtl0_kernel: Option<PathBuf>,
35    pub custom_extra_rootfs: Vec<PathBuf>,
36    pub override_arch: Option<CommonArch>,
37    pub override_kernel_pkg: Option<OpenhclKernelPackage>,
38    pub override_manifest: Option<PathBuf>,
39    pub override_openvmm_hcl_feature: Vec<String>,
40    pub with_debuginfo: bool,
41    pub with_perf_tools: bool,
42    pub with_sidecar: bool,
43}
44
45flowey_request! {
46    pub struct Params {
47        pub artifact_dir: ReadVar<PathBuf>,
48        pub done: WriteVar<SideEffect>,
49
50        pub base_recipe: OpenhclIgvmRecipe,
51        pub release: bool,
52        pub release_cfg: bool,
53
54        pub customizations: Customizations,
55    }
56}
57
58new_simple_flow_node!(struct Node);
59
60impl SimpleFlowNode for Node {
61    type Request = Params;
62
63    fn imports(ctx: &mut ImportCtx<'_>) {
64        ctx.import::<crate::build_openhcl_igvm_from_recipe::Node>();
65    }
66
67    fn process_request(request: Self::Request, ctx: &mut NodeCtx<'_>) -> anyhow::Result<()> {
68        let Params {
69            artifact_dir,
70            done,
71
72            base_recipe,
73            release,
74            release_cfg,
75
76            customizations,
77        } = request;
78
79        let has_customizations = customizations != Customizations::default();
80
81        let Customizations {
82            build_label,
83            custom_directory,
84            custom_kernel_modules,
85            custom_kernel,
86            custom_layer,
87            override_manifest,
88            custom_openhcl_boot,
89            custom_openvmm_hcl,
90            custom_sidecar,
91            custom_uefi,
92            custom_vtl0_kernel,
93            override_arch,
94            override_kernel_pkg,
95            override_openvmm_hcl_feature,
96            with_debuginfo,
97            with_perf_tools,
98            with_sidecar,
99            custom_extra_rootfs,
100        } = customizations;
101
102        if release_cfg && !release {
103            log::warn!(
104                "You are building a debug binary with a release configuration.\n\
105                The produced binary likely will not function properly due to memory restrictions."
106            )
107        }
108
109        let build_profile = if release {
110            OpenvmmHclBuildProfile::OpenvmmHclShip
111        } else {
112            OpenvmmHclBuildProfile::Debug
113        };
114        let mut recipe_details = base_recipe.recipe_details(release_cfg);
115
116        {
117            let OpenhclIgvmRecipeDetails {
118                local_only,
119                igvm_manifest,
120                openhcl_kernel_package,
121                openvmm_hcl_features,
122                target,
123                vtl0_kernel_type,
124                with_uefi,
125                with_interactive,
126                with_sidecar: with_sidecar_details,
127            } = &mut recipe_details;
128
129            if custom_kernel.is_some() {
130                *with_uefi = true
131            }
132
133            if with_sidecar || custom_sidecar.is_some() {
134                *with_sidecar_details = true;
135            }
136
137            // Debug configurations include --interactive by default, for busybox, gdbserver, and perf.
138            *with_interactive = !release_cfg || with_perf_tools;
139
140            assert!(local_only.is_none());
141            *local_only = Some(OpenhclIgvmRecipeDetailsLocalOnly {
142                // ensure binary remains un-sripped if perf tooling was also
143                // requested
144                openvmm_hcl_no_strip: with_perf_tools || with_debuginfo,
145                openhcl_initrd_extra_params: Some(OpenhclInitrdExtraParams {
146                    extra_initrd_layers: custom_layer
147                        .into_iter()
148                        .map(|p| p.absolute())
149                        .collect::<Result<_, _>>()?,
150                    extra_initrd_directories: custom_directory
151                        .into_iter()
152                        .map(|p| p.absolute())
153                        .collect::<Result<_, _>>()?,
154                    custom_kernel_modules,
155                }),
156                custom_openvmm_hcl: custom_openvmm_hcl.map(|p| p.absolute()).transpose()?,
157                custom_openhcl_boot: custom_openhcl_boot.map(|p| p.absolute()).transpose()?,
158                custom_uefi: custom_uefi.map(|p| p.absolute()).transpose()?,
159                custom_kernel: custom_kernel.map(|p| p.absolute()).transpose()?,
160                custom_sidecar: custom_sidecar.map(|p| p.absolute()).transpose()?,
161                custom_extra_rootfs: custom_extra_rootfs
162                    .into_iter()
163                    .map(|p| p.absolute())
164                    .collect::<Result<_, _>>()?,
165            });
166
167            if let Some(p) = override_manifest {
168                *igvm_manifest = IgvmManifestPath::LocalOnlyCustom(p.absolute()?);
169            }
170
171            if let Some(override_kernel_pkg) = override_kernel_pkg {
172                *openhcl_kernel_package = override_kernel_pkg;
173            }
174
175            if !override_openvmm_hcl_feature.is_empty() {
176                *openvmm_hcl_features = override_openvmm_hcl_feature
177                    .into_iter()
178                    .map(OpenvmmHclFeature::LocalOnlyCustom)
179                    .collect()
180            }
181
182            if let Some(arch) = override_arch {
183                *target = match arch {
184                    CommonArch::X86_64 => CommonTriple::X86_64_LINUX_MUSL,
185                    CommonArch::Aarch64 => CommonTriple::AARCH64_LINUX_MUSL,
186                };
187            }
188
189            if let Some(p) = custom_vtl0_kernel {
190                *vtl0_kernel_type = Some(Vtl0KernelType::LocalOnlyCustom(p.absolute()?))
191            }
192        }
193
194        let build_label = if let Some(label) = build_label {
195            label
196        } else {
197            let base = match &recipe_details.igvm_manifest {
198                IgvmManifestPath::InTree(_) => {
199                    non_production_build_igvm_tool_out_name(&base_recipe).to_string()
200                }
201                IgvmManifestPath::LocalOnlyCustom(path) => path
202                    .file_name()
203                    .unwrap()
204                    .to_str()
205                    .unwrap()
206                    .strip_suffix(".json")
207                    .unwrap()
208                    .to_string(),
209            };
210
211            if has_customizations {
212                format!("{base}-custom")
213            } else {
214                base
215            }
216        };
217
218        let (built_openvmm_hcl, write_built_openvmm_hcl) = ctx.new_var();
219        let (built_openhcl_boot, write_built_openhcl_boot) = ctx.new_var();
220        let (built_openhcl_igvm, write_built_openhcl_igvm) = ctx.new_var();
221        let (built_sidecar, write_built_sidecar) = ctx.new_var();
222
223        ctx.req(crate::build_openhcl_igvm_from_recipe::Request {
224            build_profile,
225            release_cfg,
226            recipe: OpenhclIgvmRecipe::LocalOnlyCustom(recipe_details),
227            custom_target: None,
228            built_openvmm_hcl: write_built_openvmm_hcl,
229            built_openhcl_boot: write_built_openhcl_boot,
230            built_openhcl_igvm: write_built_openhcl_igvm,
231            built_sidecar: write_built_sidecar,
232        });
233
234        ctx.emit_rust_step("copy to output directory", |ctx| {
235            done.claim(ctx);
236            let artifact_dir = artifact_dir.claim(ctx);
237            let built_openvmm_hcl = built_openvmm_hcl.claim(ctx);
238            let built_openhcl_boot = built_openhcl_boot.claim(ctx);
239            let built_openhcl_igvm = built_openhcl_igvm.claim(ctx);
240            let built_sidecar = built_sidecar.claim(ctx);
241            move |rt| {
242                let output_dir = rt
243                    .read(artifact_dir)
244                    .join(match build_profile {
245                        OpenvmmHclBuildProfile::Debug => "debug",
246                        OpenvmmHclBuildProfile::Release => "release",
247                        OpenvmmHclBuildProfile::OpenvmmHclShip => "ship",
248                    })
249                    .join(&build_label);
250                fs_err::create_dir_all(&output_dir)?;
251
252                let OpenvmmHclOutput { bin, dbg } = rt.read(built_openvmm_hcl);
253                fs_err::copy(bin, output_dir.join("openvmm_hcl"))?;
254                if let Some(dbg) = dbg {
255                    fs_err::copy(dbg, output_dir.join("openvmm_hcl.dbg"))?;
256                }
257
258                let OpenhclBootOutput { bin, dbg } = rt.read(built_openhcl_boot);
259                fs_err::copy(bin, output_dir.join("openhcl_boot"))?;
260                fs_err::copy(dbg, output_dir.join("openhcl_boot.dbg"))?;
261
262                if let Some(built_sidecar) = rt.read(built_sidecar) {
263                    let crate::build_sidecar::SidecarOutput { bin, dbg } = built_sidecar;
264                    fs_err::copy(bin, output_dir.join("sidecar"))?;
265                    fs_err::copy(dbg, output_dir.join("sidecar.dbg"))?;
266                }
267
268                let IgvmOutput {
269                    igvm_bin,
270                    igvm_map,
271                    igvm_tdx_json,
272                    igvm_snp_json,
273                    igvm_vbs_json,
274                } = rt.read(built_openhcl_igvm);
275                fs_err::copy(
276                    igvm_bin,
277                    output_dir.join(format!("openhcl-{build_label}.bin")),
278                )?;
279                if let Some(igvm_map) = igvm_map {
280                    fs_err::copy(
281                        igvm_map,
282                        output_dir.join(format!("openhcl-{build_label}.bin.map")),
283                    )?;
284                }
285                if let Some(igvm_tdx_json) = igvm_tdx_json {
286                    fs_err::copy(igvm_tdx_json, output_dir.join("openhcl-tdx.json"))?;
287                }
288                if let Some(igvm_snp_json) = igvm_snp_json {
289                    fs_err::copy(igvm_snp_json, output_dir.join("openhcl-snp.json"))?;
290                }
291                if let Some(igvm_vbs_json) = igvm_vbs_json {
292                    fs_err::copy(igvm_vbs_json, output_dir.join("openhcl-vbs.json"))?;
293                }
294                for e in fs_err::read_dir(output_dir)? {
295                    let e = e?;
296                    log::info!("{}", e.path().display());
297                }
298
299                Ok(())
300            }
301        });
302
303        Ok(())
304    }
305}
306
307pub fn non_production_build_igvm_tool_out_name(recipe: &OpenhclIgvmRecipe) -> &'static str {
308    match recipe {
309        OpenhclIgvmRecipe::X64 => "x64",
310        OpenhclIgvmRecipe::X64Devkern => "x64-devkern",
311        OpenhclIgvmRecipe::X64TestLinuxDirect => "x64-test-linux-direct",
312        OpenhclIgvmRecipe::X64TestLinuxDirectDevkern => "x64-test-linux-direct-devkern",
313        OpenhclIgvmRecipe::X64Cvm => "x64-cvm",
314        OpenhclIgvmRecipe::X64CvmDevkern => "x64-cvm-devkern",
315        OpenhclIgvmRecipe::Aarch64 => "aarch64",
316        OpenhclIgvmRecipe::Aarch64Devkern => "aarch64-devkern",
317        OpenhclIgvmRecipe::LocalOnlyCustom(_) => unreachable!(),
318    }
319}
flowey_lib_hvlite/_jobs/local_build_igvm.rs

flowey_lib_hvlite/_jobs/
local_build_igvm.rs
