Skip to content

Commit

Permalink
uefi: process: Add support for command environment variables
Browse files Browse the repository at this point in the history
Set environment variables before launching the process and restore the
prior variables after the program exists.

This is the same implementation as the one used by UEFI Shell Execute [0].

[0]: https://github.com/tianocore/edk2/blob/2d2642f4832ebc45cb7d5ba9430b933d953b94f2/ShellPkg/Application/Shell/ShellProtocol.c#L1700

Signed-off-by: Ayush Singh <ayush@beagleboard.org>
  • Loading branch information
Ayush1325 authored and gitbot committed Feb 20, 2025
1 parent b2bd55d commit 830d4ad
Showing 1 changed file with 62 additions and 3 deletions.
65 changes: 62 additions & 3 deletions std/src/sys/pal/uefi/process.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use r_efi::protocols::simple_text_output;

use super::helpers;
use crate::collections::BTreeMap;
pub use crate::ffi::OsString as EnvKey;
use crate::ffi::{OsStr, OsString};
use crate::num::{NonZero, NonZeroI32};
Expand All @@ -21,6 +22,7 @@ pub struct Command {
args: Vec<OsString>,
stdout: Option<Stdio>,
stderr: Option<Stdio>,
env: CommandEnv,
}

// passed back to std::process with the pipes connected to the child, if any
Expand All @@ -40,15 +42,21 @@ pub enum Stdio {

impl Command {
pub fn new(program: &OsStr) -> Command {
Command { prog: program.to_os_string(), args: Vec::new(), stdout: None, stderr: None }
Command {
prog: program.to_os_string(),
args: Vec::new(),
stdout: None,
stderr: None,
env: Default::default(),
}
}

pub fn arg(&mut self, arg: &OsStr) {
self.args.push(arg.to_os_string());
}

pub fn env_mut(&mut self) -> &mut CommandEnv {
panic!("unsupported")
&mut self.env
}

pub fn cwd(&mut self, _dir: &OsStr) {
Expand Down Expand Up @@ -76,7 +84,7 @@ impl Command {
}

pub fn get_envs(&self) -> CommandEnvs<'_> {
panic!("unsupported")
self.env.iter()
}

pub fn get_current_dir(&self) -> Option<&Path> {
Expand Down Expand Up @@ -140,8 +148,30 @@ impl Command {
cmd.stderr_inherit()
};

let env = env_changes(&self.env);

// Set any new vars
if let Some(e) = &env {
for (k, (_, v)) in e {
match v {
Some(v) => crate::env::set_var(k, v),
None => crate::env::remove_var(k),
}
}
}

let stat = cmd.start_image()?;

// Rollback any env changes
if let Some(e) = env {
for (k, (v, _)) in e {
match v {
Some(v) => crate::env::set_var(k, v),
None => crate::env::remove_var(k),
}
}
}

let stdout = cmd.stdout()?;
let stderr = cmd.stderr()?;

Expand Down Expand Up @@ -725,3 +755,32 @@ mod uefi_command_internal {
res.into_boxed_slice()
}
}

/// Create a map of environment variable changes. Allows efficient setting and rolling back of
/// enviroment variable changes.
///
/// Entry: (Old Value, New Value)
fn env_changes(env: &CommandEnv) -> Option<BTreeMap<EnvKey, (Option<OsString>, Option<OsString>)>> {
if env.is_unchanged() {
return None;
}

let mut result = BTreeMap::<EnvKey, (Option<OsString>, Option<OsString>)>::new();

// Check if we want to clear all prior variables
if env.does_clear() {
for (k, v) in crate::env::vars_os() {
result.insert(k.into(), (Some(v), None));
}
}

for (k, v) in env.iter() {
let v: Option<OsString> = v.map(Into::into);
result
.entry(k.into())
.and_modify(|cur| *cur = (cur.0.clone(), v.clone()))
.or_insert((crate::env::var_os(k), v));
}

Some(result)
}

0 comments on commit 830d4ad

Please sign in to comment.