feat(main): Adapt to ramdisk type boot media, use CPIO format, and add test script (#5)

- Add boot media type compilation options and source code adaptation
- Add ramdisk boot media type (CPIO format)
- Add test suite for ramdisk boot media type (CPIO format)

Signed-off-by: JensenWei007 <jensenwei007@gmail.com>

Author: JensenWei007

.gitignore

@@ -28,4 +28,6 @@ arceboot.bin
 
 rustsbi/
 
-/.axconfig.*
+/.axconfig.*
+
+*.cpio

Cargo.lock

@@ -5,7 +5,7 @@ edition = "2024"
 authors = ["Zhihang Shao <dio_ro@outlook.com>", "Jingxuan Wei <jensenwei007@gmail.com>"]
 
 [features]
-default = ["alloc", "fs", "paging", "disk"]
+default = ["alloc", "fs", "paging", "ramdisk_cpio"]
 
 alloc = ["axalloc"]
 paging = ["axhal/paging", "axmm"]
@@ -14,7 +14,10 @@ fs = ["axdriver", "axfs"]
 net = ["axdriver", "axnet"]
 display = ["axdriver", "axdisplay"]
 
-disk = ["axdriver/virtio-blk"]
+# Boot Media
+
+virtiodisk = ["axdriver/virtio-blk"]
+ramdisk_cpio = []
 
 [dependencies]
 axhal = { git = "https://github.com/arceos-org/arceos.git" }
@@ -29,5 +32,6 @@ axdisplay = { git = "https://github.com/arceos-org/arceos.git", optional = true
 
 crate_interface = "0.1"
 ctor_bare = "0.2"
+cfg-if = "1.0"
 
 chrono = { version = "0.4.38", default-features = false }

Cargo.toml

@@ -4,6 +4,7 @@
 #     - `PLATFORM`: Target platform in the `platforms` directory
 #     - `SMP`: Number of CPUs
 #     - `LOG:` Logging level: warn, error, info, debug, trace
+#     - `MEDIA:` Boot Media Type: ramdisk-cpio, virtio-blk
 #     - `EXTRA_CONFIG`: Extra config specification file
 #     - `OUT_CONFIG`: Final config file that takes effect
 # * QEMU options:
@@ -14,14 +15,16 @@
 ARCH ?= riscv64
 PLATFORM ?=
 SMP ?= 1
-LOG ?= info
+LOG ?= debug
+MEDIA ?= ramdisk-cpio
 
 OUT_CONFIG ?= $(PWD)/.axconfig.toml
 EXTRA_CONFIG ?=
 
 # QEMU options
 DISK:= fat32_disk_test.img
 SBI:=rustsbi/target/riscv64imac-unknown-none-elf/release/rustsbi-prototyper-payload.elf
+RAMDISK_CPIO:=ramdisk.cpio
 
 export AX_CONFIG_PATH=$(OUT_CONFIG)
 export AX_LOG=$(LOG)
@@ -44,5 +47,8 @@ clean:
 
 build: clean defconfig all
 
+ramdiskcpio:
+	qemu-system-riscv64 -m 128M -serial mon:stdio -bios $(SBI) -nographic -machine virt -device loader,file=$(RAMDISK_CPIO),addr=0x84000000
+
 run:
-	qemu-system-riscv64 -serial mon:stdio -bios $(SBI) -nographic -machine virt -device virtio-blk-pci,drive=disk0 -drive id=disk0,if=none,format=raw,file=$(DISK)
+	qemu-system-riscv64 -m 128M -serial mon:stdio -bios $(SBI) -nographic -machine virt -device virtio-blk-pci,drive=disk0 -drive id=disk0,if=none,format=raw,file=$(DISK)

Makefile

@@ -0,0 +1,24 @@
+#!/bin/bash
+set -e
+
+print_info() {
+    printf "\033[1;37m%s\033[0m" "[RustSBI-Arceboot Build For Test] "
+    printf "\033[1;32m%s\033[0m" "[INFO] "
+    printf "\033[36m%s\033[0m\n" "$1"
+}
+
+print_info "开始执行 ramdisk 类型的 cpio 打包脚本"
+print_info "此为空镜像, 只含有一个 arceboot.txt 文件, 用于测试 Arceboot"
+print_info "即将在当前目录执行创建 -------->"
+
+mkdir myramdisk
+touch myramdisk/arceboot.txt
+echo "This is a test file for Arceboot." > myramdisk/arceboot.txt
+
+cd myramdisk
+find . | cpio -o --format=newc > ../ramdisk.cpio
+cd ..
+
+rm -rf myramdisk
+
+print_info "创建完成, 生成的 ramdisk.cpio 位于当前目录"

scripts/test/ramdisk_cpio.sh

@@ -6,6 +6,7 @@ extern crate axlog;
 
 mod panic;
 mod log;
+mod media;
 
 #[cfg_attr(not(test), unsafe(no_mangle))]
 pub extern "C" fn rust_main(_cpu_id: usize, _dtb: usize) -> ! {
@@ -39,7 +40,9 @@ pub extern "C" fn rust_main(_cpu_id: usize, _dtb: usize) -> ! {
         let all_devices = axdriver::init_drivers();
 
         #[cfg(feature = "fs")]
-        axfs::init_filesystems(all_devices.block);
+        // 目前使用ramdisk的cpio格式时，驱动还不完善，用不了，需要注释掉
+        // 如果使用virtio-blk驱动，则可以正常使用
+        //axfs::init_filesystems(all_devices.block);
 
         #[cfg(feature = "net")]
         axnet::init_network(all_devices.net);
@@ -49,6 +52,10 @@ pub extern "C" fn rust_main(_cpu_id: usize, _dtb: usize) -> ! {
     }
     ctor_bare::call_ctors();
 
+    info!("will test cpio.");
+
+    crate::media::parse_cpio_ramdisk();
+
     info!("will shut down.");
 
     axhal::misc::terminate();

src/main.rs

@@ -0,0 +1,8 @@
+cfg_if::cfg_if! {
+    if #[cfg(feature = "ramdisk_cpio")] {
+        mod ramdisk_cpio;
+        pub use ramdisk_cpio::*;
+    } else {
+        info!("Boot media feature is not enabled.");
+    }
+}

src/media/mod.rs

@@ -0,0 +1,82 @@
+use core::{ptr, str};
+use axhal::mem::phys_to_virt;
+
+const CPIO_MAGIC: &[u8; 6] = b"070701";
+const CPIO_BASE: usize = 0x8400_0000;
+
+#[repr(C)]
+#[derive(Debug)]
+struct CpioNewcHeader {
+    c_magic: [u8; 6],
+    c_ino: [u8; 8],
+    c_mode: [u8; 8],
+    c_uid: [u8; 8],
+    c_gid: [u8; 8],
+    c_nlink: [u8; 8],
+    c_mtime: [u8; 8],
+    c_filesize: [u8; 8],
+    c_devmajor: [u8; 8],
+    c_devminor: [u8; 8],
+    c_rdevmajor: [u8; 8],
+    c_rdevminor: [u8; 8],
+    c_namesize: [u8; 8],
+    c_check: [u8; 8],
+}
+
+fn parse_hex_field(field: &[u8]) -> usize {
+    // 将ASCII十六进制转换为数字
+    let s = core::str::from_utf8(field).unwrap_or("0");
+    usize::from_str_radix(s, 16).unwrap_or(0)
+}
+
+pub fn parse_cpio_ramdisk() {
+    let mut ptr = phys_to_virt(CPIO_BASE.into()).as_usize();
+
+    loop {
+        let hdr = unsafe { &*(ptr as *const CpioNewcHeader) };
+
+        if &hdr.c_magic != CPIO_MAGIC {
+            info!("Invalid magic at {:#x}", ptr);
+            break;
+        }
+
+        let namesize = parse_hex_field(&hdr.c_namesize);
+        let filesize = parse_hex_field(&hdr.c_filesize);
+
+        // 文件名在 header 后面紧跟着
+        let name_ptr = ptr + core::mem::size_of::<CpioNewcHeader>();
+        let name = unsafe {
+            let slice = core::slice::from_raw_parts(name_ptr as *const u8, namesize - 1); // 去掉末尾的 '\0'
+            str::from_utf8(slice).unwrap_or("<invalid utf8>")
+        };
+
+        if name == "TRAILER!!!" {
+            info!("End of CPIO archive.");
+            break;
+        }
+
+        info!("Found file: {}, size: {}", name, filesize);
+
+        // 文件数据
+        let file_start = align_up(name_ptr + namesize, 4);
+        let file_end = file_start + filesize;
+
+        if name == "arceboot.txt" {
+            let data = unsafe {
+                core::slice::from_raw_parts(file_start as *const u8, filesize)
+            };
+            if let Ok(text) = core::str::from_utf8(data) {
+                info!("Content of {}:\n{}", name, text);
+            } else {
+                info!("Binary content of {}: {:02x?}", name, &data[0..core::cmp::min(32, data.len())]);
+            }
+        }
+
+        // 移动到下一个 header
+        ptr = align_up(file_end, 4);
+    }
+}
+
+fn align_up(addr: usize, align: usize) -> usize {
+    (addr + align - 1) & !(align - 1)
+}