feat(main): Add virtio-block device support, adjust ramdisk interface content, and unify the external API interface of boot media (#7)

- Add virtio-block device support, implemented by encapsulating related interfaces of axfs
- Modify ramdisk-cpio related interfaces and open them to the public
- Shield the differences between different boot media and unify the medium API interface

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

Author: JensenWei007

.gitignore

@@ -30,4 +30,4 @@ rustsbi/
 
 /.axconfig.*
 
-*.cpio
+*.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", "ramdisk_cpio"]
+default = ["alloc", "fs", "paging", "virtiodisk"]
 
 alloc = ["axalloc"]
 paging = ["axhal/paging", "axmm"]
@@ -15,7 +15,6 @@ net = ["axdriver", "axnet"]
 display = ["axdriver", "axdisplay"]
 
 # Boot Media
-
 virtiodisk = ["axdriver/virtio-blk"]
 ramdisk_cpio = []
 
@@ -35,3 +34,4 @@ ctor_bare = "0.2"
 cfg-if = "1.0"
 
 chrono = { version = "0.4.38", default-features = false }
+axio = { version = "0.1", features = ["alloc"] }

Cargo.toml

@@ -4,7 +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
+#     - `MEDIUM:` Boot Medium Type: ramdisk-cpio, virtio-blk
 #     - `EXTRA_CONFIG`: Extra config specification file
 #     - `OUT_CONFIG`: Final config file that takes effect
 # * QEMU options:
@@ -16,13 +16,15 @@ ARCH ?= riscv64
 PLATFORM ?=
 SMP ?= 1
 LOG ?= debug
-MEDIA ?= ramdisk-cpio
+
+# 下面的目前还没用, 现在需要手动去cargo.toml中修改, 后面补上
+MEDIUM ?= ramdisk-cpio
 
 OUT_CONFIG ?= $(PWD)/.axconfig.toml
 EXTRA_CONFIG ?=
 
 # QEMU options
-DISK:= fat32_disk_test.img
+DISK:= disk.img
 SBI:=rustsbi/target/riscv64imac-unknown-none-elf/release/rustsbi-prototyper-payload.elf
 RAMDISK_CPIO:=ramdisk.cpio
 
@@ -50,5 +52,5 @@ 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 -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)
+virtiodisk:
+	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

@@ -1,14 +1,25 @@
 #!/bin/bash
 set -e
 
-IMG_NAME="fat32_disk_test.img"
-IMG_SIZE_MB=512
-MOUNT_DIR="mnt_fat32"
+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"
+}
 
-echo "[1/2] 创建空镜像文件..."
-dd if=/dev/zero of=$IMG_NAME bs=1M count=$IMG_SIZE_MB
+print_info "开始执行 virtio-block 类型的 disk 创建脚本"
+print_info "此为 FAT32 文件系统镜像, 只含有一个 arceboot.txt 文件, 用于测试 Arceboot"
+print_info "即将在当前目录执行创建 -------->"
 
-echo "[2/2] 格式化为 FAT32 文件系统..."
-mkfs.vfat -F 32 $IMG_NAME
+dd if=/dev/zero of=disk.img bs=1M count=512
+mkfs.vfat -F 32 disk.img
 
-echo "======== DONE ========"
+mkdir temp
+sudo mount -o loop disk.img temp
+mkdir -p temp/test
+touch temp/test/arceboot.txt
+echo "This is a test file for Arceboot." > temp/test/arceboot.txt
+sudo umount temp
+rm -rf temp
+
+print_info "创建完成, 生成的 disk.img 位于当前目录"

scripts/test/disk.sh

@@ -12,8 +12,9 @@ print_info "此为空镜像, 只含有一个 arceboot.txt 文件, 用于测试 A
 print_info "即将在当前目录执行创建 -------->"
 
 mkdir myramdisk
-touch myramdisk/arceboot.txt
-echo "This is a test file for Arceboot." > myramdisk/arceboot.txt
+mkdir myramdisk/test
+touch myramdisk/test/arceboot.txt
+echo "This is a test file for Arceboot." > myramdisk/test/arceboot.txt
 
 cd myramdisk
 find . | cpio -o --format=newc > ../ramdisk.cpio

scripts/test/ramdisk_cpio.sh

@@ -6,7 +6,7 @@ extern crate axlog;
 
 mod panic;
 mod log;
-mod media;
+mod medium;
 
 #[cfg_attr(not(test), unsafe(no_mangle))]
 pub extern "C" fn rust_main(_cpu_id: usize, _dtb: usize) -> ! {
@@ -42,7 +42,7 @@ pub extern "C" fn rust_main(_cpu_id: usize, _dtb: usize) -> ! {
         #[cfg(feature = "fs")]
         // 目前使用ramdisk的cpio格式时，驱动还不完善，用不了，需要注释掉
         // 如果使用virtio-blk驱动，则可以正常使用
-        //axfs::init_filesystems(all_devices.block);
+        axfs::init_filesystems(all_devices.block);
 
         #[cfg(feature = "net")]
         axnet::init_network(all_devices.net);
@@ -52,9 +52,8 @@ 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!("current root dir: {}", crate::medium::current_dir().unwrap());
+    info!("read test file context: {}", crate::medium::read_to_string("/test/arceboot.txt").unwrap());
 
     info!("will shut down.");
 

src/main.rs

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

src/media/ramdisk_cpio.rs

@@ -0,0 +1,138 @@
+extern crate alloc;
+
+use core::{ptr, str};
+use axhal::mem::phys_to_virt;
+use axio::{self as io, prelude::*};
+use alloc::{string::String, vec::Vec, string::ToString};
+
+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)
+}
+
+fn align_up(addr: usize, align: usize) -> usize {
+    (addr + align - 1) & !(align - 1)
+}
+
+/// Returns the current working directory as a [`String`].
+pub fn current_dir() -> io::Result<String> {
+    Ok("/".to_string())
+}
+
+/// Read the entire contents of a file into a bytes vector.
+pub fn read(path: &str) -> io::Result<Vec<u8>> {
+    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 {
+            break;
+        }
+
+        let namesize = parse_hex_field(&hdr.c_namesize);
+        let filesize = parse_hex_field(&hdr.c_filesize);
+
+        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);
+            str::from_utf8(slice).unwrap_or("<invalid utf8>")
+        };
+
+        if name == "TRAILER!!!" {
+            break;
+        }
+
+        let file_start = align_up(name_ptr + namesize, 4);
+        let file_end = file_start + filesize;
+
+        let is_match = if path.starts_with('/') {
+            &path[1..] == name
+        } else {
+            path == name
+        };
+
+        if is_match {
+            let data = unsafe {
+                core::slice::from_raw_parts(file_start as *const u8, filesize)
+            };
+            let mut bytes = Vec::with_capacity(filesize as usize);
+            bytes.extend_from_slice(data);
+            return Ok(bytes);
+        }
+
+        ptr = align_up(file_end, 4);
+    }
+
+    core::prelude::v1::Err(io::Error::NotFound)
+}
+
+/// Read the entire contents of a file into a string.
+pub fn read_to_string(path: &str) -> io::Result<String> {
+    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 {
+            break;
+        }
+
+        let namesize = parse_hex_field(&hdr.c_namesize);
+        let filesize = parse_hex_field(&hdr.c_filesize);
+
+        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);
+            str::from_utf8(slice).unwrap_or("<invalid utf8>")
+        };
+
+        if name == "TRAILER!!!" {
+            break;
+        }
+
+        let file_start = align_up(name_ptr + namesize, 4);
+        let file_end = file_start + filesize;
+
+        let is_match = if path.starts_with('/') {
+            &path[1..] == name
+        } else {
+            path == name
+        };
+
+        if is_match {
+            let data = unsafe {
+                let slice = core::slice::from_raw_parts(file_start as *const u8, filesize);
+                str::from_utf8(slice).unwrap_or("<invalid utf8>")
+            };
+            return Ok(data.to_string());
+        }
+
+        ptr = align_up(file_end, 4);
+    }
+
+    core::prelude::v1::Err(io::Error::NotFound)
+}