Add pxe, bios, and uefi features, all enabled by default

Author: jasoncouture

build.rs

@@ -6,29 +6,37 @@ use std::{
 const BOOTLOADER_VERSION: &str = env!("CARGO_PKG_VERSION");
 
 fn main() {
-    let out_dir = PathBuf::from(std::env::var("OUT_DIR").unwrap());
-
     #[cfg(feature = "uefi")]
-    {
-        let uefi_path = build_uefi_bootloader(&out_dir);
-        println!(
-            "cargo:rustc-env=UEFI_BOOTLOADER_PATH={}",
-            uefi_path.display()
-        );
-    }
-
+    uefi_main();
     #[cfg(feature = "bios")]
-    {
-        let bios_boot_sector_path = build_bios_boot_sector(&out_dir);
-        println!(
-            "cargo:rustc-env=BIOS_BOOT_SECTOR_PATH={}",
-            bios_boot_sector_path.display()
-        );
-        let bios_stage_2_path = build_bios_stage_2(&out_dir);
-        println!(
-            "cargo:rustc-env=BIOS_STAGE_2_PATH={}",
-            bios_stage_2_path.display()
-        );
+    bios_main();
+}
+
+#[cfg(not(docsrs_dummy_build))]
+#[cfg(feature = "uefi")]
+fn uefi_main() {
+    let out_dir = PathBuf::from(std::env::var("OUT_DIR").unwrap());
+    let uefi_path = build_uefi_bootloader(&out_dir);
+    println!(
+        "cargo:rustc-env=UEFI_BOOTLOADER_PATH={}",
+        uefi_path.display()
+    );
+}
+
+#[cfg(not(docsrs_dummy_build))]
+#[cfg(feature = "bios")]
+fn bios_main() {
+    let out_dir = PathBuf::from(std::env::var("OUT_DIR").unwrap());
+    let bios_boot_sector_path = build_bios_boot_sector(&out_dir);
+    println!(
+        "cargo:rustc-env=BIOS_BOOT_SECTOR_PATH={}",
+        bios_boot_sector_path.display()
+    );
+    let bios_stage_2_path = build_bios_stage_2(&out_dir);
+    println!(
+        "cargo:rustc-env=BIOS_STAGE_2_PATH={}",
+        bios_stage_2_path.display()
+    );
 
         let bios_stage_3_path = build_bios_stage_3(&out_dir);
         println!(
@@ -41,10 +49,8 @@ fn main() {
             "cargo:rustc-env=BIOS_STAGE_4_PATH={}",
             bios_stage_4_path.display()
         );
-    }
 }
 
-#[cfg(not(docsrs_dummy_build))]
 #[cfg(feature = "uefi")]
 fn build_uefi_bootloader(out_dir: &Path) -> PathBuf {
     let cargo = std::env::var("CARGO").unwrap_or_else(|_| "cargo".into());
@@ -79,7 +85,6 @@ fn build_uefi_bootloader(out_dir: &Path) -> PathBuf {
     }
 }
 
-#[cfg(not(docsrs_dummy_build))]
 #[cfg(feature = "bios")]
 fn build_bios_boot_sector(out_dir: &Path) -> PathBuf {
     let cargo = std::env::var("CARGO").unwrap_or_else(|_| "cargo".into());
@@ -122,7 +127,6 @@ fn build_bios_boot_sector(out_dir: &Path) -> PathBuf {
     convert_elf_to_bin(elf_path)
 }
 
-#[cfg(not(docsrs_dummy_build))]
 #[cfg(feature = "bios")]
 fn build_bios_stage_2(out_dir: &Path) -> PathBuf {
     let cargo = std::env::var("CARGO").unwrap_or_else(|_| "cargo".into());
@@ -163,7 +167,6 @@ fn build_bios_stage_2(out_dir: &Path) -> PathBuf {
     convert_elf_to_bin(elf_path)
 }
 
-#[cfg(not(docsrs_dummy_build))]
 #[cfg(feature = "bios")]
 fn build_bios_stage_3(out_dir: &Path) -> PathBuf {
     let cargo = std::env::var("CARGO").unwrap_or_else(|_| "cargo".into());
@@ -204,7 +207,6 @@ fn build_bios_stage_3(out_dir: &Path) -> PathBuf {
     convert_elf_to_bin(elf_path)
 }
 
-#[cfg(not(docsrs_dummy_build))]
 #[cfg(feature = "bios")]
 fn build_bios_stage_4(out_dir: &Path) -> PathBuf {
     let cargo = std::env::var("CARGO").unwrap_or_else(|_| "cargo".into());
@@ -277,22 +279,9 @@ fn convert_elf_to_bin(elf_path: PathBuf) -> PathBuf {
 // dummy implementations because docsrs builds have no network access
 
 #[cfg(docsrs_dummy_build)]
-fn build_uefi_bootloader(_out_dir: &Path) -> PathBuf {
-    PathBuf::new()
-}
-#[cfg(docsrs_dummy_build)]
-fn build_bios_boot_sector(_out_dir: &Path) -> PathBuf {
-    PathBuf::new()
-}
-#[cfg(docsrs_dummy_build)]
-fn build_bios_stage_2(_out_dir: &Path) -> PathBuf {
-    PathBuf::new()
-}
-#[cfg(docsrs_dummy_build)]
-fn build_bios_stage_3(_out_dir: &Path) -> PathBuf {
-    PathBuf::new()
-}
+#[cfg(feature = "uefi")]
+fn uefi_main() {}
+
 #[cfg(docsrs_dummy_build)]
-fn build_bios_stage_4(_out_dir: &Path) -> PathBuf {
-    PathBuf::new()
-}
+#[cfg(feature = "bios")]
+fn bios_main() {}

src/lib.rs

@@ -21,10 +21,6 @@ use anyhow::Context;
 use tempfile::NamedTempFile;
 
 const KERNEL_FILE_NAME: &str = "kernel-x86_64";
-const BIOS_STAGE_3: &str = "boot-stage-3";
-const BIOS_STAGE_4: &str = "boot-stage-4";
-const UEFI_BOOT_FILENAME: &str = "efi/boot/bootx64.efi";
-const UEFI_TFTP_BOOT_FILENAME: &str = "bootloader";
 
 struct DiskImageFile<'a> {
     source: &'a PathBuf,
@@ -87,9 +83,11 @@ impl<'a> DiskImageBuilder<'a> {
 
         Ok(out_file)
     }
-
+    #[cfg(feature = "bios")]
     /// Create an MBR disk image for booting on BIOS systems.
     pub fn create_bios_image(&self, image_filename: &Path) -> anyhow::Result<()> {
+        const BIOS_STAGE_3: &str = "boot-stage-3";
+        const BIOS_STAGE_4: &str = "boot-stage-4";
         let bootsector_path = Path::new(env!("BIOS_BOOT_SECTOR_PATH"));
         let stage_2_path = Path::new(env!("BIOS_STAGE_2_PATH"));
         let stage_3_path = Path::new(env!("BIOS_STAGE_3_PATH"));
@@ -114,8 +112,11 @@ impl<'a> DiskImageBuilder<'a> {
             .context("failed to delete FAT partition after disk image creation")?;
         Ok(())
     }
+
+    #[cfg(feature = "uefi")]
     /// Create a GPT disk image for booting on UEFI systems.
     pub fn create_uefi_image(&self, image_filename: &Path) -> anyhow::Result<()> {
+        const UEFI_BOOT_FILENAME: &str = "efi/boot/bootx64.efi";
         let bootloader_path = Path::new(env!("UEFI_BOOTLOADER_PATH"));
         let mut internal_files = BTreeMap::new();
         internal_files.insert(UEFI_BOOT_FILENAME, bootloader_path);
@@ -131,8 +132,10 @@ impl<'a> DiskImageBuilder<'a> {
         Ok(())
     }
 
+    #[cfg(feature = "uefi")]
     /// Create a folder containing the needed files for UEFI TFTP/PXE booting.
     pub fn create_uefi_tftp_folder(&self, tftp_path: &Path) -> anyhow::Result<()> {
+        const UEFI_TFTP_BOOT_FILENAME: &str = "bootloader";
         let bootloader_path = Path::new(env!("UEFI_BOOTLOADER_PATH"));
         std::fs::create_dir_all(tftp_path)
             .with_context(|| format!("failed to create out dir at {}", tftp_path.display()))?;