Merge branch 'post-04' into post-05

Merge pull request #1434 from phil-opp/post-04-test-true
Set `test=true` to enable `main.rs` testing again
2025-12-16 14:27:49 +00:00 · 2025-08-26 16:41:45 +02:00 · 2025-08-26 16:41:21 +02:00 · 2025-08-26 16:21:28 +02:00 · 2025-08-18 09:44:29 +02:00 · 2025-08-18 09:44:27 +02:00
11 changed files with 118 additions and 53 deletions
--- a/.cargo/config.toml
+++ b/.cargo/config.toml
@@ -1,5 +1,6 @@
 [unstable]
 build-std = ["core", "compiler_builtins"]
+build-std-features = ["compiler-builtins-mem"]

 [build]
 target = "x86_64-blog_os.json"
--- a/.github/workflows/build-code.yml
+++ b/.github/workflows/build-code.yml
@@ -1,4 +1,4 @@
-name: Build Code
+name: Code

 on:
  push:
@@ -16,6 +16,7 @@ jobs:
  check:
    name: Check
    strategy:
+      fail-fast: false
      matrix:
        platform: [
          ubuntu-latest,
@@ -41,6 +42,7 @@ jobs:
  test:
    name: Test
    strategy:
+      fail-fast: false
      matrix:
        platform: [
          ubuntu-latest,
@@ -76,14 +78,10 @@ jobs:
          HOMEBREW_NO_AUTO_UPDATE: 1
          HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK: 1
          HOMEBREW_NO_INSTALL_CLEANUP: 1
-      - name: Install Scoop (Windows)
-        run: |
-          Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://get.scoop.sh')
-          echo ::add-path::$HOME\scoop\shims
-        if: runner.os == 'Windows'
-        shell: pwsh
      - name: Install QEMU (Windows)
-        run: scoop install qemu
+        run: |
+          choco install qemu --version 2021.5.5
+          echo "$Env:Programfiles\qemu" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
        if: runner.os == 'Windows'
        shell: pwsh
      - name: "Print QEMU Version"
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1,16 +1,24 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
+version = 4
+
 [[package]]
 name = "bit_field"
-version = "0.9.0"
+version = "0.10.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ed8765909f9009617974ab6b7d332625b320b33c326b1e9321382ef1999b5d56"
+checksum = "dc827186963e592360843fb5ba4b973e145841266c1357f7180c43526f2e5b61"

 [[package]]
 name = "bitflags"
-version = "1.2.1"
+version = "1.3.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693"
+checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+
+[[package]]
+name = "bitflags"
+version = "2.9.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6a65b545ab31d687cff52899d4890855fec459eb6afe0da6417b8a18da87aa29"

 [[package]]
 name = "blog_os"
@@ -18,33 +26,32 @@ version = "0.1.0"
 dependencies = [
 "bootloader",
 "lazy_static",
- "rlibc",
- "spin",
+ "spin 0.5.2",
 "uart_16550",
- "volatile",
+ "volatile 0.2.7",
 "x86_64",
 ]

 [[package]]
 name = "bootloader"
-version = "0.9.8"
+version = "0.9.32"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0ad686b9b47363de7d36c05fb6885f17d08d0f2d15b1bc782a101fe3c94a2c7c"
+checksum = "1ea119c3ed05625c179e09d17d0914570a3753ca09c890a73d98f6b72aea00d2"

 [[package]]
 name = "lazy_static"
-version = "1.4.0"
+version = "1.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
+checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 dependencies = [
- "spin",
+ "spin 0.9.8",
 ]

 [[package]]
-name = "rlibc"
-version = "1.0.0"
+name = "rustversion"
+version = "1.0.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fc874b127765f014d792f16763a81245ab80500e2ad921ed4ee9e82481ee08fe"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"

 [[package]]
 name = "spin"
@@ -53,27 +60,42 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"

 [[package]]
-name = "uart_16550"
-version = "0.2.7"
+name = "spin"
+version = "0.9.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e58fc40dc1712664fc9b0a7bd8ca2f21ab49960924fb245a80a05e1e92f3dfe9"
+checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67"
+
+[[package]]
+name = "uart_16550"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "614ff2a87880d4bd4374722268598a970bbad05ced8bf630439417347254ab2e"
 dependencies = [
- "bitflags",
+ "bitflags 1.3.2",
+ "rustversion",
 "x86_64",
 ]

 [[package]]
 name = "volatile"
-version = "0.2.6"
+version = "0.2.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6af0edf5b4faacc31fc51159244d78d65ec580f021afcef7bd53c04aeabc7f29"
+checksum = "f6b06ad3ed06fef1713569d547cdbdb439eafed76341820fb0e0344f29a41945"
+
+[[package]]
+name = "volatile"
+version = "0.4.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "442887c63f2c839b346c192d047a7c87e73d0689c9157b00b53dcc27dd5ea793"

 [[package]]
 name = "x86_64"
-version = "0.11.0"
+version = "0.14.13"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "365de37eb7c6da582cbb510dd0f3f1235d24ff6309a8a96e8a9909cc9bfd608f"
+checksum = "c101112411baafbb4bf8d33e4c4a80ab5b02d74d2612331c61e8192fc9710491"
 dependencies = [
 "bit_field",
- "bitflags",
+ "bitflags 2.9.2",
+ "rustversion",
+ "volatile 0.4.6",
 ]
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,28 +2,36 @@
 name = "blog_os"
 version = "0.1.0"
 authors = ["Philipp Oppermann <dev@phil-opp.com>"]
-edition = "2018"
+edition = "2024"

 [[test]]
 name = "should_panic"
 harness = false

 [dependencies]
-bootloader = "0.9.8"
-rlibc = "1.0.0"
+bootloader = "0.9"
 volatile = "0.2.6"
 spin = "0.5.2"
-x86_64 = "0.11.0"
+x86_64 = "0.14.2"
 uart_16550 = "0.2.0"

 [dependencies.lazy_static]
 version = "1.0"
 features = ["spin_no_std"]

+[[bin]]
+name = "blog_os"
+test = true
+bench = false
+

 [package.metadata.bootimage]
 test-args = [
-    "-device", "isa-debug-exit,iobase=0xf4,iosize=0x04", "-serial", "stdio",
-    "-display", "none"
+    "-device",
+    "isa-debug-exit,iobase=0xf4,iosize=0x04",
+    "-serial",
+    "stdio",
+    "-display",
+    "none",
 ]
-test-success-exit-code = 33         # (0x10 << 1) | 1
+test-success-exit-code = 33 # (0x10 << 1) | 1
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# Blog OS (Testing)
+# Blog OS (CPU Exceptions)

-[![Build Status](https://github.com/phil-opp/blog_os/workflows/Build%20Code/badge.svg?branch=post-04)](https://github.com/phil-opp/blog_os/actions?query=workflow%3A%22Build+Code%22+branch%3Apost-04)
+[![Build Status](https://github.com/phil-opp/blog_os/workflows/Code/badge.svg?branch=post-05)](https://github.com/phil-opp/blog_os/actions?query=workflow%3A%22Code%22+branch%3Apost-05)

-This repository contains the source code for the [Testing][post] post of the [Writing an OS in Rust](https://os.phil-opp.com) series.
+This repository contains the source code for the [CPU Exceptions][post] post of the [Writing an OS in Rust](https://os.phil-opp.com) series.

-[post]: https://os.phil-opp.com/testing/
+[post]: https://os.phil-opp.com/cpu-exceptions/

 **Check out the [master branch](https://github.com/phil-opp/blog_os) for more information.**

--- a/src/interrupts.rs
+++ b/src/interrupts.rs
@@ -0,0 +1,25 @@
+use crate::println;
+use lazy_static::lazy_static;
+use x86_64::structures::idt::{InterruptDescriptorTable, InterruptStackFrame};
+
+lazy_static! {
+    static ref IDT: InterruptDescriptorTable = {
+        let mut idt = InterruptDescriptorTable::new();
+        idt.breakpoint.set_handler_fn(breakpoint_handler);
+        idt
+    };
+}
+
+pub fn init_idt() {
+    IDT.load();
+}
+
+extern "x86-interrupt" fn breakpoint_handler(stack_frame: InterruptStackFrame) {
+    println!("EXCEPTION: BREAKPOINT\n{:#?}", stack_frame);
+}
+
+#[test_case]
+fn test_breakpoint_exception() {
+    // invoke a breakpoint exception
+    x86_64::instructions::interrupts::int3();
+}
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,16 +1,19 @@
 #![no_std]
 #![cfg_attr(test, no_main)]
 #![feature(custom_test_frameworks)]
+#![feature(abi_x86_interrupt)]
 #![test_runner(crate::test_runner)]
 #![reexport_test_harness_main = "test_main"]

-extern crate rlibc;
-
 use core::panic::PanicInfo;

+pub mod interrupts;
 pub mod serial;
 pub mod vga_buffer;

+pub fn init() {
+    interrupts::init_idt();
+}
 pub trait Testable {
    fn run(&self) -> ();
 }
@@ -59,8 +62,9 @@ pub fn exit_qemu(exit_code: QemuExitCode) {

 /// Entry point for `cargo xtest`
 #[cfg(test)]
-#[no_mangle]
+#[unsafe(no_mangle)]
 pub extern "C" fn _start() -> ! {
+    init();
    test_main();
    loop {}
 }
--- a/src/main.rs
+++ b/src/main.rs
@@ -7,13 +7,19 @@
 use blog_os::println;
 use core::panic::PanicInfo;

-#[no_mangle]
+#[unsafe(no_mangle)]
 pub extern "C" fn _start() -> ! {
    println!("Hello World{}", "!");

+    blog_os::init();
+
+    // invoke a breakpoint exception
+    x86_64::instructions::interrupts::int3();
+
    #[cfg(test)]
    test_main();

+    println!("It did not crash!");
    loop {}
 }

--- a/tests/basic_boot.rs
+++ b/tests/basic_boot.rs
@@ -7,7 +7,7 @@
 use blog_os::println;
 use core::panic::PanicInfo;

-#[no_mangle] // don't mangle the name of this function
+#[unsafe(no_mangle)] // don't mangle the name of this function
 pub extern "C" fn _start() -> ! {
    test_main();

--- a/tests/should_panic.rs
+++ b/tests/should_panic.rs
@@ -1,10 +1,10 @@
 #![no_std]
 #![no_main]

-use blog_os::{exit_qemu, serial_print, serial_println, QemuExitCode};
+use blog_os::{QemuExitCode, exit_qemu, serial_print, serial_println};
 use core::panic::PanicInfo;

-#[no_mangle]
+#[unsafe(no_mangle)]
 pub extern "C" fn _start() -> ! {
    should_fail();
    serial_println!("[test did not panic]");
--- a/x86_64-blog_os.json
+++ b/x86_64-blog_os.json
@@ -1,15 +1,16 @@
 {
    "llvm-target": "x86_64-unknown-none",
-    "data-layout": "e-m:e-i64:64-f80:128-n8:16:32:64-S128",
+    "data-layout": "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-i128:128-f80:128-n8:16:32:64-S128",
    "arch": "x86_64",
    "target-endian": "little",
    "target-pointer-width": "64",
-    "target-c-int-width": "32",
+    "target-c-int-width": 32,
    "os": "none",
    "executables": true,
    "linker-flavor": "ld.lld",
    "linker": "rust-lld",
    "panic-strategy": "abort",
    "disable-redzone": true,
-    "features": "-mmx,-sse,+soft-float"
+    "features": "-mmx,-sse,+soft-float",
+    "rustc-abi": "x86-softfloat"
  }