Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(x86_64): change build script to invoke cargo #326

Merged
merged 2 commits into from
Aug 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ _d1_pkg := "mnemos-d1"

_espbuddy_pkg := "mnemos-esp32c3-buddy"

_x86_pkg := "mnemos-x86_64-bootloader"
_x86_pkg := "mnemos-x86_64-core"
_x86_bootloader_pkg := "mnemos-x86_64-bootloader"

_mn_pkg := "manganese"
Expand Down Expand Up @@ -169,6 +169,12 @@ flash-c3 board *espflash-args: (_get-cargo-command "espflash" "cargo-espflash")

# build a bootable x86_64 disk image, using rust-osdev/bootloader.
build-x86 *args='':
# run `cargo check` first because the actual binary will be built in a build
# script that that eats compiler output :(
{{ _cargo }} check --package {{ _x86_pkg }} \
--bin bootloader \
--target x86_64-unknown-none \
--features bootloader_api {{ args }}
{{ _cargo }} build --package {{ _x86_bootloader_pkg }} {{ args }}

# run an x86_64 MnemOS image in QEMU
Expand Down
10 changes: 2 additions & 8 deletions platforms/x86_64/bootloader/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@ ovmf-prebuilt = "0.1.0-alpha.1"
clap = { version = "4", features = ["derive", "env"] }

[build-dependencies]
anyhow = "1"
bootloader = "0.11"

# the actual MnemOS kernel binary
[build-dependencies.mnemos]
package = "mnemos-x86_64-core"
path = "../core"
artifact = "bin:bootloader"
target = "x86_64-unknown-none"
features = ["bootloader_api"]
escargot = "0.5"
63 changes: 56 additions & 7 deletions platforms/x86_64/bootloader/build.rs
Original file line number Diff line number Diff line change
@@ -1,24 +1,73 @@
use anyhow::Context;
use std::path::PathBuf;

fn main() {
fn main() -> anyhow::Result<()> {
// I *hate* this stupid goddamn Clippy lint. On a new enough nightly, the
// compiler warns that `'static` lifetimes for constants will become
// mandatory in a future Rust edition, so the Clippy lint is actually
// telling you to do the opposite of what's compatible with future Rustc
// changes...
#![allow(clippy::redundant_static_lifetimes)]

const PKG_NAME: &'static str = "mnemos-x86_64-core";
const BIN_NAME: &'static str = "bootloader";
const TARGET_TRIPLE: &'static str = "x86_64-unknown-none";
const ENV_OUT_DIR: &'static str = "OUT_DIR";
const ENV_PROFILE: &'static str = "PROFILE";

// set by cargo, build scripts should use this directory for output files
let out_dir = PathBuf::from(std::env::var_os("OUT_DIR").unwrap());
// set by cargo's artifact dependency feature, see
// https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#artifact-dependencies
let kernel = PathBuf::from(std::env::var_os("CARGO_BIN_FILE_MNEMOS_bootloader").unwrap());
let out_dir = PathBuf::from(
std::env::var_os(ENV_OUT_DIR)
.with_context(|| format!("missing {ENV_OUT_DIR} environment variable!"))?,
);
let release = match std::env::var_os(ENV_PROFILE) {
Some(x) if x == "release" => true,
Some(x) if x == "debug" => false,
x => {
println!("cargo:warning={ENV_PROFILE} env var either unset or weird: {x:?}");
false
}
};

// XXX(eliza): it's sad that this way of building the binary by just
// shelling out to a child `cargo` invocation will eat things like the
// compiler output. but, the alternative approach where the same cargo
// invocation can build everything would be to use artifact deps, which are
// unfortunately broken due to this Cargo bug:
// https://github.com/rust-lang/cargo/issues/12358
//
// If upstream PR https://github.com/rust-lang/cargo/pull/13207 ever merges,
// we should revisit this approach and see if we can switch back to artifact
// deps...
let mut build = escargot::CargoBuild::new()
.package(PKG_NAME)
.bin(BIN_NAME)
.target(TARGET_TRIPLE)
.target_dir(&out_dir)
.features("bootloader_api");
if release {
build = build.release();
}

let cargo_output = build
.run()
.context("failed to execute cargo build command")?;

let kernel = cargo_output.path();

let uefi_path = out_dir.join("mnemos-x86_64-uefi.img");
bootloader::UefiBoot::new(&kernel)
bootloader::UefiBoot::new(kernel)
.create_disk_image(&uefi_path)
.unwrap();

// create a BIOS disk image
let bios_path = out_dir.join("mnemos-x86_64-bios.img");
bootloader::BiosBoot::new(&kernel)
bootloader::BiosBoot::new(kernel)
.create_disk_image(&bios_path)
.unwrap();

// pass the disk image paths as env variables to the `main.rs`
println!("cargo:rustc-env=UEFI_PATH={}", uefi_path.display());
println!("cargo:rustc-env=BIOS_PATH={}", bios_path.display());
Ok(())
}
Loading