Merge pull request #1740 from RenTrieu/enhancement/efi_shell_interface_cur_dir

EFI Shell Interface: CurDir Functions

Author: nicholasbishop

uefi-test-runner/src/proto/shell.rs

@@ -1,13 +1,112 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-use uefi::boot;
+use uefi::boot::ScopedProtocol;
 use uefi::proto::shell::Shell;
+use uefi::{Error, Status, boot, cstr16};
+
+/// Test `current_dir()` and `set_current_dir()`
+pub fn test_current_dir(shell: &ScopedProtocol<Shell>) {
+    /* Test setting and getting current file system and current directory */
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("/");
+    let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
+    assert!(status.is_ok());
+
+    let cur_fs_str = shell
+        .current_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    let expected_fs_str = cstr16!("FS0:\\");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current file system
+    let fs_var = cstr16!("fs1:");
+    let dir_var = cstr16!("/");
+    let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
+    assert!(status.is_ok());
+
+    let cur_fs_str = shell
+        .current_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    assert_ne!(cur_fs_str, expected_fs_str);
+    let expected_fs_str = cstr16!("FS1:\\");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current file system and current directory
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("efi/");
+    let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
+    assert!(status.is_ok());
+
+    let cur_fs_str = shell
+        .current_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    assert_ne!(cur_fs_str, expected_fs_str);
+    let expected_fs_str = cstr16!("FS0:\\efi");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    /* Test current working directory cases */
+
+    // At this point, the current working file system has not been set
+    // So we expect a NULL output
+    assert!(shell.current_dir(None).is_err());
+    assert_eq!(
+        shell.current_dir(None).err().unwrap(),
+        Error::new(Status::NOT_FOUND, ())
+    );
+
+    // Setting the current working file system and current working directory
+    let dir_var = cstr16!("fs0:/");
+    let status = shell.set_current_dir(None, Some(dir_var));
+    assert!(status.is_ok());
+    let cur_fs_str = shell
+        .current_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    let expected_fs_str = cstr16!("FS0:");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    let cur_fs_str = shell
+        .current_dir(None)
+        .expect("Could not get the current file system mapping");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current working directory
+    let dir_var = cstr16!("/efi");
+    let status = shell.set_current_dir(None, Some(dir_var));
+    assert!(status.is_ok());
+    let cur_fs_str = shell
+        .current_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    let expected_fs_str = cstr16!("FS0:\\efi");
+    assert_eq!(cur_fs_str, expected_fs_str);
+    let cur_fs_str = shell
+        .current_dir(None)
+        .expect("Could not get the current file system mapping");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current directory in a non-current working file system
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("efi/tools");
+    let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
+    assert!(status.is_ok());
+    let cur_fs_str = shell
+        .current_dir(None)
+        .expect("Could not get the current file system mapping");
+    assert_ne!(cur_fs_str, expected_fs_str);
+
+    let expected_fs_str = cstr16!("FS0:\\efi\\tools");
+    let cur_fs_str = shell
+        .current_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    assert_eq!(cur_fs_str, expected_fs_str);
+}
 
 pub fn test() {
     info!("Running shell protocol tests");
 
     let handle = boot::get_handle_for_protocol::<Shell>().expect("No Shell handles");
 
-    let mut _shell =
+    let shell =
         boot::open_protocol_exclusive::<Shell>(handle).expect("Failed to open Shell protocol");
+
+    test_current_dir(&shell);
 }

uefi/src/proto/shell/mod.rs

@@ -3,11 +3,55 @@
 //! EFI Shell Protocol v2.2
 
 use crate::proto::unsafe_protocol;
-
-pub use uefi_raw::protocol::shell::ShellProtocol;
+use crate::{CStr16, Char16, Error, Result, Status, StatusExt};
+use core::ptr;
+use uefi_raw::protocol::shell::ShellProtocol;
 
 /// Shell Protocol
 #[derive(Debug)]
 #[repr(transparent)]
-#[unsafe_protocol(uefi_raw::protocol::shell::ShellProtocol::GUID)]
-pub struct Shell(uefi_raw::protocol::shell::ShellProtocol);
+#[unsafe_protocol(ShellProtocol::GUID)]
+pub struct Shell(ShellProtocol);
+
+impl Shell {
+    /// Returns the current directory on the specified device.
+    ///
+    /// # Arguments
+    ///
+    /// * `file_system_mapping` - The file system mapping for which to get
+    ///   the current directory
+    ///
+    /// # Errors
+    ///
+    /// * [`Status::NOT_FOUND`] - Could not retrieve current directory
+    pub fn current_dir(&self, file_system_mapping: Option<&CStr16>) -> Result<&CStr16> {
+        let mapping_ptr: *const Char16 = file_system_mapping.map_or(ptr::null(), CStr16::as_ptr);
+        let cur_dir = unsafe { (self.0.get_cur_dir)(mapping_ptr.cast()) };
+        if cur_dir.is_null() {
+            Err(Error::new(Status::NOT_FOUND, ()))
+        } else {
+            unsafe { Ok(CStr16::from_ptr(cur_dir.cast())) }
+        }
+    }
+
+    /// Changes the current directory on the specified device
+    ///
+    /// # Arguments
+    ///
+    /// * `file_system` - File system's mapped name.
+    /// * `directory` - Directory on the device specified by
+    ///   `file_system`.
+    ///
+    /// # Errors
+    ///
+    /// * [`Status::NOT_FOUND`] - The directory does not exist
+    pub fn set_current_dir(
+        &self,
+        file_system: Option<&CStr16>,
+        directory: Option<&CStr16>,
+    ) -> Result {
+        let fs_ptr: *const Char16 = file_system.map_or(ptr::null(), |x| x.as_ptr());
+        let dir_ptr: *const Char16 = directory.map_or(ptr::null(), |x| x.as_ptr());
+        unsafe { (self.0.set_cur_dir)(fs_ptr.cast(), dir_ptr.cast()) }.to_result()
+    }
+}