flowey_lib_hvlite/
run_split_debug_info.rs

1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4//! Splits debug info from a binary into a separate file using `objcopy`
5
6use crate::run_cargo_build::common::CommonArch;
7use flowey::node::prelude::*;
8
9flowey_request! {
10    pub struct Request {
11        pub arch: CommonArch,
12        pub in_bin: ReadVar<PathBuf>,
13        pub out_bin: WriteVar<PathBuf>,
14        pub out_dbg_info: WriteVar<PathBuf>,
15    }
16}
17
18new_simple_flow_node!(struct Node);
19
20impl SimpleFlowNode for Node {
21    type Request = Request;
22
23    fn imports(ctx: &mut ImportCtx<'_>) {
24        ctx.import::<flowey_lib_common::install_dist_pkg::Node>();
25    }
26
27    fn process_request(request: Self::Request, ctx: &mut NodeCtx<'_>) -> anyhow::Result<()> {
28        let Request {
29            arch,
30            in_bin,
31            out_bin,
32            out_dbg_info,
33        } = request;
34
35        let host_arch = ctx.arch();
36        let platform = ctx.platform();
37
38        let (objcopy_pkg, objcopy_bin): (Option<&str>, &str) = match arch {
39            CommonArch::X86_64 => match platform {
40                FlowPlatform::Linux(linux_distribution) => match linux_distribution {
41                    FlowPlatformLinuxDistro::Fedora => (
42                        Some("binutils-x86_64-linux-gnu"),
43                        "x86_64-linux-gnu-objcopy",
44                    ),
45                    FlowPlatformLinuxDistro::Ubuntu => (
46                        Some("binutils-x86-64-linux-gnu"),
47                        "x86_64-linux-gnu-objcopy",
48                    ),
49                    FlowPlatformLinuxDistro::Arch => {
50                        match_arch!(host_arch, FlowArch::X86_64, (Some("binutils"), "objcopy"))
51                    }
52                    FlowPlatformLinuxDistro::Nix => (None, "objcopy"),
53                    FlowPlatformLinuxDistro::Unknown => anyhow::bail!("Unknown Linux distribution"),
54                },
55                _ => anyhow::bail!("Unsupported platform"),
56            },
57            CommonArch::Aarch64 => {
58                let pkg = match platform {
59                    FlowPlatform::Linux(linux_distribution) => match linux_distribution {
60                        FlowPlatformLinuxDistro::Fedora | FlowPlatformLinuxDistro::Ubuntu => {
61                            Some("binutils-aarch64-linux-gnu")
62                        }
63                        FlowPlatformLinuxDistro::Arch => {
64                            match_arch!(
65                                host_arch,
66                                FlowArch::X86_64,
67                                Some("aarch64-linux-gnu-binutils")
68                            )
69                        }
70                        FlowPlatformLinuxDistro::Nix => None,
71                        FlowPlatformLinuxDistro::Unknown => {
72                            anyhow::bail!("Unknown Linux distribution")
73                        }
74                    },
75                    _ => anyhow::bail!("Unsupported platform"),
76                };
77                (pkg, "aarch64-linux-gnu-objcopy")
78            }
79        };
80
81        let installed_objcopy = objcopy_pkg.map(|objcopy_pkg| {
82            ctx.reqv(
83                |side_effect| flowey_lib_common::install_dist_pkg::Request::Install {
84                    package_names: vec![objcopy_pkg.into()],
85                    done: side_effect,
86                },
87            )
88        });
89
90        ctx.emit_rust_step("split debug symbols", |ctx| {
91            installed_objcopy.claim(ctx);
92            let in_bin = in_bin.claim(ctx);
93            let out_bin = out_bin.claim(ctx);
94            let out_dbg_info = out_dbg_info.claim(ctx);
95            move |rt| {
96                let in_bin = rt.read(in_bin);
97
98                let sh = xshell::Shell::new()?;
99                let output = sh.current_dir().join(in_bin.file_name().unwrap());
100                xshell::cmd!(sh, "{objcopy_bin} --only-keep-debug {in_bin} {output}.dbg").run()?;
101                xshell::cmd!(
102                    sh,
103                    "{objcopy_bin} --strip-all --keep-section=.build_info --add-gnu-debuglink={output}.dbg {in_bin} {output}"
104                )
105                .run()?;
106
107                let output = output.absolute()?;
108
109                rt.write(out_bin, &output);
110                rt.write(out_dbg_info, &output.with_extension("dbg"));
111
112                Ok(())
113            }
114        });
115
116        Ok(())
117    }
118}