uefi-fs: initial commit

Author: phip1611

Cargo.toml

@@ -2,6 +2,7 @@
 resolver = "2"
 members = [
     "template",
+    "uefi-fs",
     "uefi-macros",
     "uefi-services",
     "uefi-test-runner",
@@ -10,5 +11,6 @@ members = [
 
 [patch.crates-io]
 uefi = { path = "uefi" }
+uefi-fs = { path = "uefi-fs" }
 uefi-macros = { path = "uefi-macros" }
 uefi-services = { path = "uefi-services" }

uefi-fs/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "uefi-fs"
+version = "1.0.0"
+authors = ["The Rust OSDev team"]
+readme = "README.md"
+edition = "2021"
+description = """
+File-system abstraction for the uefi-crate that is close to Rust's standard
+libraries `fs` module.
+"""
+repository = "https://github.com/rust-osdev/uefi-rs"
+keywords = ["uefi", "fs", "file-system"]
+categories = ["embedded", "no-std"]
+license = "MPL-2.0"
+
+[dependencies]
+# uefi = { version = "0.18.0", features = ["alloc", "logger"] }
+uefi = { path = "../uefi" , features = ["alloc", "logger"] }
+log = { version = "0.4.5", default-features = false }
+derive_more = { version = "0.99", default-features = false, features = ["display"]}

uefi-fs/LICENSE

@@ -0,0 +1,17 @@
+# uefi-services
+
+[![Crates.io](https://img.shields.io/crates/v/uefi-services)](https://crates.io/crates/uefi-services)
+[![Docs.rs](https://docs.rs/uefi-macros/badge.svg)](https://docs.rs/uefi-services)
+
+This crate enables you some convenience features on top of the
+[`uefi`](https://crates.io/crates/uefi) crate. It includes a panic handler, a logger, and
+a global allocator.
+
+`uefi-services` is part of the `uefi-rs` project. Please refer to
+<https://github.com/rust-osdev/uefi-rs/> for comprehensive documentation.
+
+## Optional features
+
+This crate's features are described in [`src/lib.rs`].
+  
+[`src/lib.rs`]: src/lib.rs

uefi-fs/README.md

@@ -0,0 +1,31 @@
+use super::*;
+use alloc::boxed::Box;
+use alloc::vec::Vec;
+use uefi::Result;
+
+pub struct UefiError;
+
+/// Iterates over the entries of an UEFI directory. It returns boxed values of
+/// type [`UefiFileInfo`].
+pub struct UefiDirectoryIter(UefiDirectoryHandle);
+
+impl UefiDirectoryIter {
+    /// Constructor.
+    pub(crate) fn new(handle: UefiDirectoryHandle) -> Self {
+        Self(handle)
+    }
+}
+
+impl Iterator for UefiDirectoryIter {
+    type Item = Result<Box<UefiFileInfo>, ()>;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        let e = self.0.read_entry_boxed();
+        match e {
+            // no more entries
+            Ok(None) => None,
+            Ok(Some(e)) => Some(Ok(e)),
+            Err(e) => Some(Err(e)),
+        }
+    }
+}

uefi-fs/src/dir_entry_iter.rs

@@ -0,0 +1,67 @@
+use crate::path::MAX_COMPONENT_LENGTH;
+use alloc::vec::Vec;
+use core::ops::Deref;
+use uefi::proto::media::file::FileInfo as UefiFileInfo;
+
+// Ugly but we can't use size_of() as the type isn't sized.
+// This is constant, as it is specified.
+/// Size of a [UefiFileInfo] without the filename and without a NULL byte.
+pub const UEFI_FILE_INFO_MAX_SIZE: usize = 80 + 2 * (1 + MAX_COMPONENT_LENGTH);
+
+/// A UEFI file info that lives on the heap. Owns the data.
+#[derive(Debug)]
+pub struct BoxedUefiFileInfo {
+    // owning buffer
+    buffer: Vec<u8>,
+}
+
+impl BoxedUefiFileInfo {
+    pub fn new(info: &UefiFileInfo) -> Self {
+        let mut buffer = Vec::<u8>::with_capacity(UEFI_FILE_INFO_MAX_SIZE);
+        (0..buffer.capacity()).for_each(|_| buffer.push(0));
+
+        unsafe {
+            let src_ptr = core::ptr::addr_of!(*info).cast::<u8>();
+            let dest_ptr = buffer.as_mut_ptr().cast::<u8>();
+            core::ptr::copy_nonoverlapping(src_ptr, dest_ptr, UEFI_FILE_INFO_MAX_SIZE);
+        }
+        Self { buffer }
+    }
+}
+
+impl Deref for BoxedUefiFileInfo {
+    type Target = UefiFileInfo;
+    fn deref(&self) -> &Self::Target {
+        unsafe {
+            let addr = self.buffer.as_ptr().cast::<()>();
+            let ptr: *const UefiFileInfo =
+            // todo metadata is here probably unused?!
+                core::ptr::from_raw_parts(addr, self.buffer.capacity());
+            ptr.as_ref().unwrap()
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use uefi::proto::media::file::FromUefi;
+
+    #[test]
+    fn test_put_into_box() {
+        let mut buffer = [0_u8; UEFI_FILE_INFO_MAX_SIZE];
+
+        let boxed_fileinfo = unsafe {
+            let ptr = buffer.as_mut_ptr();
+
+            // set some values to the "file_size" property
+            *ptr.cast::<u64>().add(1) = 0x7733_0909_2345_1337;
+
+            let uefi_fileinfo = UefiFileInfo::from_uefi(ptr.cast());
+            assert_eq!(uefi_fileinfo.file_size(), 0x7733_0909_2345_1337);
+            BoxedUefiFileInfo::new(uefi_fileinfo)
+        };
+
+        assert_eq!(boxed_fileinfo.file_size(), 0x7733_0909_2345_1337);
+    }
+}