Resolve all remaining warnings and fix build with --all-targets

Makes the `panic` implementations conditional to fix errors when building with `cargo check --all-targets --all`. This also fixes the remaining rust-analyzer errors.

Author: phil-opp

Cargo.toml

@@ -8,7 +8,6 @@ license = "MIT/Apache-2.0"
 description = "An experimental x86_64 bootloader that works on both BIOS and UEFI systems."
 repository = "https://github.com/rust-osdev/bootloader"
 edition = "2021"
-resolver = "2"
 
 [workspace]
 members = [

api/src/config.rs

@@ -282,6 +282,7 @@ impl Default for BootloaderConfig {
     }
 }
 
+/// A semver-compatible version.
 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
 #[repr(C)]
 pub struct ApiVersion {
@@ -318,18 +319,22 @@ impl ApiVersion {
         }
     }
 
+    /// Returns the major version number.
     pub fn version_major(&self) -> u16 {
         self.version_major
     }
 
+    /// Returns the minor version number.
     pub fn version_minor(&self) -> u16 {
         self.version_minor
     }
 
+    /// Returns the patch version number.
     pub fn version_patch(&self) -> u16 {
         self.version_patch
     }
 
+    /// Returns whether this version is a pre-release, e.g., an alpha version.
     pub fn pre_release(&self) -> bool {
         self.pre_release
     }

api/src/info.rs

@@ -20,6 +20,7 @@ use crate::config::ApiVersion;
 #[repr(C)]
 #[non_exhaustive]
 pub struct BootInfo {
+    /// The version of the `bootloader_api` crate. Must match the `bootloader` version.
     pub api_version: ApiVersion,
     /// A map of the physical memory regions of the underlying machine.
     ///
@@ -54,6 +55,9 @@ pub struct BootInfo {
 }
 
 impl BootInfo {
+    /// Create a new boot info structure with the given memory map.
+    ///
+    /// The other fields are initialized with default values.
     pub fn new(memory_regions: MemoryRegions) -> Self {
         Self {
             api_version: ApiVersion::new_default(),
@@ -162,7 +166,13 @@ pub struct FrameBuffer {
 }
 
 impl FrameBuffer {
-    pub fn new(buffer_start: u64, info: FrameBufferInfo) -> Self {
+    /// Creates a new framebuffer instance.
+    ///
+    /// ## Safety
+    ///
+    /// The given start address and info must describe a valid, accessible, and unaliased
+    /// framebuffer.
+    pub unsafe fn new(buffer_start: u64, info: FrameBufferInfo) -> Self {
         Self { buffer_start, info }
     }
 
@@ -232,9 +242,13 @@ pub enum PixelFormat {
     /// Length might be larger than 1, check [`bytes_per_pixel`][FrameBufferInfo::bytes_per_pixel]
     /// for this.
     U8,
+    /// Unknown pixel format.
     Unknown {
+        /// Bit offset of the red value.
         red_position: u8,
+        /// Bit offset of the green value.
         green_position: u8,
+        /// Bit offset of the blue value.
         blue_position: u8,
     },
 }

bios/stage-2/src/screen.rs

@@ -29,8 +29,8 @@ impl Write for Writer {
     }
 }
 
+#[cfg(all(not(test), target_os = "none"))]
 #[panic_handler]
-#[cfg(not(test))]
 pub fn panic(info: &core::panic::PanicInfo) -> ! {
     let _ = write!(Writer, "\nPANIC: ");
     if let Some(location) = info.location() {

bios/stage-4/src/main.rs

@@ -227,8 +227,8 @@ fn detect_rsdp() -> Option<PhysAddr> {
     }
 }
 
+#[cfg(all(not(test), target_os = "none"))]
 #[panic_handler]
-#[cfg(not(test))]
 fn panic(info: &core::panic::PanicInfo) -> ! {
     unsafe {
         bootloader_x86_64_common::logger::LOGGER

common/src/lib.rs

@@ -447,7 +447,18 @@ where
         let mut info = BootInfo::new(memory_regions.into());
         info.framebuffer = mappings
             .framebuffer
-            .map(|addr| FrameBuffer::new(addr.as_u64(), system_info.framebuffer.expect("there shouldn't be a mapping for the framebuffer if there is not framebuffer").info))
+            .map(|addr| unsafe {
+                FrameBuffer::new(
+                    addr.as_u64(),
+                    system_info
+                        .framebuffer
+                        .expect(
+                            "there shouldn't be a mapping for the framebuffer if there is \
+                            no framebuffer",
+                        )
+                        .info,
+                )
+            })
             .into();
         info.physical_memory_offset = mappings.physical_memory_offset.map(VirtAddr::as_u64).into();
         info.recursive_index = mappings.recursive_index.map(Into::into).into();

tests/runner/Cargo.toml

@@ -2,7 +2,7 @@
 name = "bootloader_test_runner"
 version = "0.1.0"
 authors = ["Philipp Oppermann <[email protected]>"]
-edition = "2018"
+edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

tests/test_kernels/default_settings/Cargo.toml

@@ -2,9 +2,12 @@
 name = "test_kernel_default_settings"
 version = "0.1.0"
 authors = ["Philipp Oppermann <[email protected]>"]
-edition = "2018"
+edition = "2021"
 
 [dependencies]
 bootloader_api = { path = "../../../api" }
-x86_64 = { version = "0.14.7", default-features = false, features = ["instructions", "inline_asm"] }
+x86_64 = { version = "0.14.7", default-features = false, features = [
+    "instructions",
+    "inline_asm",
+] }
 uart_16550 = "0.2.10"

tests/test_kernels/default_settings/src/bin/basic_boot.rs

@@ -2,7 +2,6 @@
 #![no_main] // disable all Rust-level entry points
 
 use bootloader_api::{entry_point, BootInfo};
-use core::panic::PanicInfo;
 use test_kernel_default_settings::{exit_qemu, QemuExitCode};
 
 entry_point!(kernel_main);
@@ -13,7 +12,8 @@ fn kernel_main(_boot_info: &'static mut BootInfo) -> ! {
 
 /// This function is called on panic.
 #[panic_handler]
-fn panic(info: &PanicInfo) -> ! {
+#[cfg(not(test))]
+fn panic(info: &core::panic::PanicInfo) -> ! {
     use core::fmt::Write;
 
     let _ = writeln!(test_kernel_default_settings::serial(), "PANIC: {}", info);

tests/test_kernels/default_settings/src/bin/check_boot_info.rs

@@ -2,7 +2,6 @@
 #![no_main] // disable all Rust-level entry points
 
 use bootloader_api::{entry_point, info::PixelFormat, BootInfo};
-use core::panic::PanicInfo;
 use test_kernel_default_settings::{exit_qemu, QemuExitCode};
 
 entry_point!(kernel_main);
@@ -41,8 +40,9 @@ fn kernel_main(boot_info: &'static mut BootInfo) -> ! {
 }
 
 /// This function is called on panic.
+#[cfg(not(test))]
 #[panic_handler]
-fn panic(info: &PanicInfo) -> ! {
+fn panic(info: &core::panic::PanicInfo) -> ! {
     use core::fmt::Write;
 
     let _ = writeln!(test_kernel_default_settings::serial(), "PANIC: {}", info);