Skip to content

fix: boot on qemu x86_64#677

Open
nokosaaan wants to merge 5 commits intomainfrom
bootloader-fix
Open

fix: boot on qemu x86_64#677
nokosaaan wants to merge 5 commits intomainfrom
bootloader-fix

Conversation

@nokosaaan
Copy link
Copy Markdown
Contributor

@nokosaaan nokosaaan commented Apr 7, 2026

Description

I fixed an issue where QEMU on x86_64 would not start properly.
This was resolved by clearly separating the BIOS and UEFI boot paths using the features option.
With the current configuration, the build process generated numerous warnings and errors,
preventing the program from starting successfully.
Specifically, the error error: unknown -Z flag specified: json-target-spec was being displayed.
The -Z flag is used to specify unstable, experimental features of the Rust compiler. It appears the issue arose because an outdated or incompatible version of Rust Nightly was used during the build of the Bootloader package, causing the flag to go unrecognized.
Possible solutions include:

  • Using a newer Nightly build
  • Updating the bootloader
  • Using a known compatible version
    The nightly build is already the latest version, and the Bootloader is also kept up to date. Since we confirmed that it works without issues when using a compatible version, rolling back the version would be preferable; however, the cost of rework and the impact on existing code are significant, making this impractical.
    Therefore, since the BIOS processing is not expected to run in the current implementation, I isolated it in features. After confirming that it behaves the same as the compatible version, we decided to implement this fix.

In addition, a compile_error! guard was added to x86bootdisk/src/main.rs to produce a clear, actionable compiler error when the crate is built with --no-default-features and neither the bios nor uefi feature is selected, preventing confusing missing-impl errors in misconfigured builds.

Related links

https://github.com/rust-osdev/bootloader

How was this PR tested?

Please refer to attached files.
Compile logs are showed.
bootloader-fix.log
main.log

Notes for reviewers

Signed-off-by: nokosaaan <nishimura.r.019@ms.saitama-u.ac.jp>
Signed-off-by: nokosaaan <nishimura.r.019@ms.saitama-u.ac.jp>
Signed-off-by: nokosaaan <nishimura.r.019@ms.saitama-u.ac.jp>
@nokosaaan nokosaaan requested review from Copilot and kobayu858 April 7, 2026 06:09
@nokosaaan nokosaaan changed the title fix: Boot on qemu x86_64 fix: boot on qemu x86_64 Apr 7, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adjusts the x86bootdisk helper tool and build scripts to split BIOS vs UEFI boot image generation using Cargo features, with the goal of making x86_64 QEMU boot reliably by avoiding incompatible bootloader build paths.

Changes:

  • Introduces bios/uefi feature flags in x86bootdisk and gates bootloader usage accordingly.
  • Updates x86_64 Makefile image targets to build x86bootdisk with --no-default-features and the appropriate boot feature.
  • Removes multilingual = false from the mdBook configuration.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
x86bootdisk/src/main.rs Feature-gates BIOS/UEFI boot paths and adjusts CLI defaulting behavior based on enabled features.
x86bootdisk/Cargo.toml Adds bios/uefi features and disables bootloader default features to control build paths.
mdbook/book.toml Simplifies mdBook config by removing the explicit multilingual setting.
Makefile Builds BIOS and UEFI images by selecting the corresponding x86bootdisk feature set.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +5 to +9
#[cfg(feature = "bios")]
use bootloader::BiosBoot;
#[cfg(feature = "uefi")]
use bootloader::UefiBoot;

Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the new feature-gated enum variants and Default impl, building this crate with --no-default-features and without selecting either bios or uefi will fail with confusing compiler errors (e.g., missing Default::default impl items / empty BootType). Consider adding an explicit #[cfg(not(any(feature = "bios", feature = "uefi")))] compile_error!(...) guard so misconfigured builds fail with a clear message.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a compile_error! guard in commit d69ffdc so that builds with --no-default-features and neither bios nor uefi selected will fail with a clear message:

#[cfg(not(any(feature = "bios", feature = "uefi")))]
compile_error!("At least one of the `bios` or `uefi` features must be enabled.");

Comment on lines +8 to +11
[features]
default = ["bios", "uefi"]
bios = ["bootloader/bios"]
uefi = ["bootloader/uefi"]
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR description suggests isolating BIOS vs UEFI via Cargo features to avoid problematic build paths, but default = ["bios", "uefi"] still enables (and compiles) both by default. If the intent is to avoid BIOS-related build failures unless explicitly requested, consider making the default feature set [] or ['uefi'] and requiring callers (e.g., the Makefile) to opt into bios explicitly.

Copilot uses AI. Check for mistakes.

x86_64_boot.img: kernel-x86_64.elf
RUSTFLAGS="$(RUSTC_MISC_ARGS)" cargo +$(RUSTV) run --release --package x86bootdisk -- --kernel $< --output $@
RUSTFLAGS="$(RUSTC_MISC_ARGS)" cargo +$(RUSTV) run --release --package x86bootdisk --no-default-features --features bios -- --kernel $< --output $@
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This target now relies on BootType's CLI default to select BIOS (since --boot-type bios is not passed). To make the build resilient to future changes in the Rust-side defaulting logic (or feature defaults), consider passing --boot-type bios explicitly here, similar to the UEFI target.

Suggested change
RUSTFLAGS="$(RUSTC_MISC_ARGS)" cargo +$(RUSTV) run --release --package x86bootdisk --no-default-features --features bios -- --kernel $< --output $@
RUSTFLAGS="$(RUSTC_MISC_ARGS)" cargo +$(RUSTV) run --release --package x86bootdisk --no-default-features --features bios -- --kernel $< --output $@ --boot-type bios

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants