uefi: Changing get_envs() to return an Iterator

Co-authored-by: Philipp Schuster <[email protected]>

Author: RenTrieu

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

@@ -2,30 +2,23 @@
 
 use uefi::boot::ScopedProtocol;
 use uefi::proto::shell::Shell;
-use uefi::{CStr16, boot};
+use uefi::{boot, cstr16};
 use uefi_raw::Status;
 
-/// Test ``get_env()``, ``get_envs()``, and ``set_env()``
+/// Test `get_env()`, `get_envs()`, and `set_env()`
 pub fn test_env(shell: &ScopedProtocol<Shell>) {
-    let mut test_buf = [0u16; 128];
-
     /* Test retrieving list of environment variable names */
+    let mut cur_env_vec = shell.get_envs();
+    assert_eq!(cur_env_vec.next().unwrap(), cstr16!("path"),);
+    // check pre-defined shell variables; see UEFI Shell spec
+    assert_eq!(cur_env_vec.next().unwrap(), cstr16!("nonesting"),);
     let cur_env_vec = shell.get_envs();
-    assert_eq!(
-        *cur_env_vec.first().unwrap(),
-        CStr16::from_str_with_buf("path", &mut test_buf).unwrap()
-    );
-    assert_eq!(
-        *cur_env_vec.get(1).unwrap(),
-        CStr16::from_str_with_buf("nonesting", &mut test_buf).unwrap()
-    );
-    let default_len = cur_env_vec.len();
+    let default_len = cur_env_vec.count();
 
     /* Test setting and getting a specific environment variable */
-    let mut test_env_buf = [0u16; 32];
-    let test_var = CStr16::from_str_with_buf("test_var", &mut test_env_buf).unwrap();
-    let mut test_val_buf = [0u16; 32];
-    let test_val = CStr16::from_str_with_buf("test_val", &mut test_val_buf).unwrap();
+    let cur_env_vec = shell.get_envs();
+    let test_var = cstr16!("test_var");
+    let test_val = cstr16!("test_val");
     assert!(shell.get_env(test_var).is_none());
     let status = shell.set_env(test_var, test_val, false);
     assert_eq!(status, Status::SUCCESS);
@@ -34,64 +27,81 @@ pub fn test_env(shell: &ScopedProtocol<Shell>) {
         .expect("Could not get environment variable");
     assert_eq!(cur_env_str, test_val);
 
-    assert!(!cur_env_vec.contains(&test_var));
+    let mut found_var = false;
+    for env_var in cur_env_vec {
+        if env_var == test_var {
+            found_var = true;
+        }
+    }
+    assert!(!found_var);
+    let cur_env_vec = shell.get_envs();
+    let mut found_var = false;
+    for env_var in cur_env_vec {
+        if env_var == test_var {
+            found_var = true;
+        }
+    }
+    assert!(found_var);
+
     let cur_env_vec = shell.get_envs();
-    assert!(cur_env_vec.contains(&test_var));
-    assert_eq!(cur_env_vec.len(), default_len + 1);
+    assert_eq!(cur_env_vec.count(), default_len + 1);
 
     /* Test deleting environment variable */
-    let test_val = CStr16::from_str_with_buf("", &mut test_val_buf).unwrap();
+    let test_val = cstr16!("");
     let status = shell.set_env(test_var, test_val, false);
     assert_eq!(status, Status::SUCCESS);
     assert!(shell.get_env(test_var).is_none());
 
     let cur_env_vec = shell.get_envs();
-    assert!(!cur_env_vec.contains(&test_var));
-    assert_eq!(cur_env_vec.len(), default_len);
+    let mut found_var = false;
+    for env_var in cur_env_vec {
+        if env_var == test_var {
+            found_var = true;
+        }
+    }
+    assert!(!found_var);
+    let cur_env_vec = shell.get_envs();
+    assert_eq!(cur_env_vec.count(), default_len);
 }
 
-/// Test ``get_cur_dir()`` and ``set_cur_dir()``
+/// Test `get_cur_dir()` and `set_cur_dir()`
 pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
-    let mut test_buf = [0u16; 128];
-
     /* Test setting and getting current file system and current directory */
-    let mut fs_buf = [0u16; 16];
-    let fs_var = CStr16::from_str_with_buf("fs0:", &mut fs_buf).unwrap();
-    let mut dir_buf = [0u16; 32];
-    let dir_var = CStr16::from_str_with_buf("/", &mut dir_buf).unwrap();
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("/");
     let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
     assert_eq!(status, Status::SUCCESS);
 
     let cur_fs_str = shell
         .get_cur_dir(Some(fs_var))
         .expect("Could not get the current file system mapping");
-    let expected_fs_str = CStr16::from_str_with_buf("FS0:\\", &mut test_buf).unwrap();
+    let expected_fs_str = cstr16!("FS0:\\");
     assert_eq!(cur_fs_str, expected_fs_str);
 
     // Changing current file system
-    let fs_var = CStr16::from_str_with_buf("fs1:", &mut fs_buf).unwrap();
-    let dir_var = CStr16::from_str_with_buf("/", &mut dir_buf).unwrap();
+    let fs_var = cstr16!("fs1:");
+    let dir_var = cstr16!("/");
     let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
     assert_eq!(status, Status::SUCCESS);
 
     let cur_fs_str = shell
         .get_cur_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::from_str_with_buf("FS1:\\", &mut test_buf).unwrap();
+    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::from_str_with_buf("fs0:", &mut fs_buf).unwrap();
-    let dir_var = CStr16::from_str_with_buf("efi/", &mut dir_buf).unwrap();
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("efi/");
     let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
     assert_eq!(status, Status::SUCCESS);
 
     let cur_fs_str = shell
         .get_cur_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::from_str_with_buf("FS0:\\efi", &mut test_buf).unwrap();
+    let expected_fs_str = cstr16!("FS0:\\efi");
     assert_eq!(cur_fs_str, expected_fs_str);
 
     /* Test current working directory cases */
@@ -101,13 +111,13 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     assert!(shell.get_cur_dir(None).is_none());
 
     // Setting the current working file system and current working directory
-    let dir_var = CStr16::from_str_with_buf("fs0:/", &mut dir_buf).unwrap();
+    let dir_var = cstr16!("fs0:/");
     let status = shell.set_cur_dir(None, Some(dir_var));
     assert_eq!(status, Status::SUCCESS);
     let cur_fs_str = shell
         .get_cur_dir(Some(fs_var))
         .expect("Could not get the current file system mapping");
-    let expected_fs_str = CStr16::from_str_with_buf("FS0:", &mut test_buf).unwrap();
+    let expected_fs_str = cstr16!("FS0:");
     assert_eq!(cur_fs_str, expected_fs_str);
 
     let cur_fs_str = shell
@@ -116,30 +126,30 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     assert_eq!(cur_fs_str, expected_fs_str);
 
     // Changing current working directory
-    let dir_var = CStr16::from_str_with_buf("/efi", &mut dir_buf).unwrap();
+    let dir_var = cstr16!("/efi");
     let status = shell.set_cur_dir(None, Some(dir_var));
     assert_eq!(status, Status::SUCCESS);
     let cur_fs_str = shell
         .get_cur_dir(Some(fs_var))
         .expect("Could not get the current file system mapping");
-    let expected_fs_str = CStr16::from_str_with_buf("FS0:\\efi", &mut test_buf).unwrap();
+    let expected_fs_str = cstr16!("FS0:\\efi");
     assert_eq!(cur_fs_str, expected_fs_str);
     let cur_fs_str = shell
         .get_cur_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::from_str_with_buf("fs0:", &mut fs_buf).unwrap();
-    let dir_var = CStr16::from_str_with_buf("efi/tools", &mut dir_buf).unwrap();
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("efi/tools");
     let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
     assert_eq!(status, Status::SUCCESS);
     let cur_fs_str = shell
         .get_cur_dir(None)
         .expect("Could not get the current file system mapping");
     assert_ne!(cur_fs_str, expected_fs_str);
 
-    let expected_fs_str = CStr16::from_str_with_buf("FS0:\\efi\\tools", &mut test_buf).unwrap();
+    let expected_fs_str = cstr16!("FS0:\\efi\\tools");
     let cur_fs_str = shell
         .get_cur_dir(Some(fs_var))
         .expect("Could not get the current file system mapping");

uefi/src/proto/shell/mod.rs

@@ -2,12 +2,10 @@
 
 //! EFI Shell Protocol v2.2
 
-#![cfg(feature = "alloc")]
-
-use alloc::vec::Vec;
 use uefi_macros::unsafe_protocol;
 use uefi_raw::Status;
 
+use core::marker::PhantomData;
 use core::ptr;
 
 use uefi_raw::protocol::shell::ShellProtocol;
@@ -20,6 +18,35 @@ use crate::{CStr16, Char16};
 #[unsafe_protocol(ShellProtocol::GUID)]
 pub struct Shell(ShellProtocol);
 
+/// Iterator over the names of environmental variables obtained from the Shell protocol.
+#[derive(Debug)]
+pub struct Vars<'a> {
+    /// Char16 containing names of environment variables
+    inner: *const Char16,
+    /// Placeholder to attach a lifetime to `Vars`
+    placeholder: PhantomData<&'a CStr16>,
+}
+
+impl<'a> Iterator for Vars<'a> {
+    type Item = &'a CStr16;
+    // We iterate a list of NUL terminated CStr16s.
+    // The list is terminated with a double NUL.
+    fn next(&mut self) -> Option<Self::Item> {
+        let cur_start = self.inner;
+        let mut cur_len = 0;
+        unsafe {
+            if *(cur_start) == Char16::from_u16_unchecked(0) {
+                return None;
+            }
+            while *(cur_start.add(cur_len)) != Char16::from_u16_unchecked(0) {
+                cur_len += 1;
+            }
+            self.inner = self.inner.add(cur_len + 1);
+            Some(CStr16::from_ptr(cur_start))
+        }
+    }
+}
+
 impl Shell {
     /// Gets the value of the specified environment variable
     ///
@@ -50,36 +77,12 @@ impl Shell {
     ///
     /// * `Vec<env_names>` - Vector of environment variable names
     #[must_use]
-    pub fn get_envs(&self) -> Vec<&CStr16> {
-        let mut env_vec: Vec<&CStr16> = Vec::new();
-        let cur_env_ptr = unsafe { (self.0.get_env)(ptr::null()) };
-
-        let mut cur_start = cur_env_ptr;
-        let mut cur_len = 0;
-
-        let mut i = 0;
-        let mut null_count = 0;
-        unsafe {
-            while null_count <= 1 {
-                if (*(cur_env_ptr.add(i))) == Char16::from_u16_unchecked(0).into() {
-                    if cur_len > 0 {
-                        env_vec.push(CStr16::from_char16_with_nul(
-                            &(*ptr::slice_from_raw_parts(cur_start.cast(), cur_len + 1)),
-                        ).unwrap());
-                    }
-                    cur_len = 0;
-                    null_count += 1;
-                } else {
-                    if null_count > 0 {
-                        cur_start = cur_env_ptr.add(i);
-                    }
-                    null_count = 0;
-                    cur_len += 1;
-                }
-                i += 1;
-            }
+    pub fn get_envs(&self) -> Vars {
+        let env_ptr = unsafe { (self.0.get_env)(ptr::null()) };
+        Vars {
+            inner: env_ptr.cast::<Char16>(),
+            placeholder: PhantomData,
         }
-        env_vec
     }
 
     /// Sets the environment variable
@@ -143,3 +146,64 @@ impl Shell {
         unsafe { (self.0.set_cur_dir)(fs_ptr.cast(), dir_ptr.cast()) }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use alloc::vec::Vec;
+    use uefi::cstr16;
+
+    /// Testing Vars struct
+    #[test]
+    fn test_vars() {
+        // Empty Vars
+        let mut vars_mock = Vec::<u16>::new();
+        vars_mock.push(0);
+        vars_mock.push(0);
+        let mut vars = Vars {
+            inner: vars_mock.as_ptr().cast(),
+            placeholder: PhantomData,
+        };
+        assert!(vars.next().is_none());
+
+        // One environment variable in Vars
+        let mut vars_mock = Vec::<u16>::new();
+        vars_mock.push(b'f' as u16);
+        vars_mock.push(b'o' as u16);
+        vars_mock.push(b'o' as u16);
+        vars_mock.push(0);
+        vars_mock.push(0);
+        let vars = Vars {
+            inner: vars_mock.as_ptr().cast(),
+            placeholder: PhantomData,
+        };
+        assert_eq!(vars.collect::<Vec<_>>(), Vec::from([cstr16!("foo")]));
+
+        // Multiple environment variables in Vars
+        let mut vars_mock = Vec::<u16>::new();
+        vars_mock.push(b'f' as u16);
+        vars_mock.push(b'o' as u16);
+        vars_mock.push(b'o' as u16);
+        vars_mock.push(b'1' as u16);
+        vars_mock.push(0);
+        vars_mock.push(b'b' as u16);
+        vars_mock.push(b'a' as u16);
+        vars_mock.push(b'r' as u16);
+        vars_mock.push(0);
+        vars_mock.push(b'b' as u16);
+        vars_mock.push(b'a' as u16);
+        vars_mock.push(b'z' as u16);
+        vars_mock.push(b'2' as u16);
+        vars_mock.push(0);
+        vars_mock.push(0);
+
+        let vars = Vars {
+            inner: vars_mock.as_ptr().cast(),
+            placeholder: PhantomData,
+        };
+        assert_eq!(
+            vars.collect::<Vec<_>>(),
+            Vec::from([cstr16!("foo1"), cstr16!("bar"), cstr16!("baz2")])
+        );
+    }
+}