summaryrefslogtreecommitdiffstats
path: root/library/std/src/sys/uefi/args.rs
blob: 4ff7be748e90b00261cdd12f8c097b23d7f593ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
use r_efi::protocols::loaded_image;

use crate::env::current_exe;
use crate::ffi::OsString;
use crate::fmt;
use crate::iter::Iterator;
use crate::mem::size_of;
use crate::sys::uefi::helpers;
use crate::vec;

pub struct Args {
    parsed_args_list: vec::IntoIter<OsString>,
}

pub fn args() -> Args {
    let lazy_current_exe = || Vec::from([current_exe().map(Into::into).unwrap_or_default()]);

    // Each loaded image has an image handle that supports `EFI_LOADED_IMAGE_PROTOCOL`. Thus, this
    // will never fail.
    let protocol =
        helpers::image_handle_protocol::<loaded_image::Protocol>(loaded_image::PROTOCOL_GUID)
            .unwrap();

    let lp_size = unsafe { (*protocol.as_ptr()).load_options_size } as usize;
    // Break if we are sure that it cannot be UTF-16
    if lp_size < size_of::<u16>() || lp_size % size_of::<u16>() != 0 {
        return Args { parsed_args_list: lazy_current_exe().into_iter() };
    }
    let lp_size = lp_size / size_of::<u16>();

    let lp_cmd_line = unsafe { (*protocol.as_ptr()).load_options as *const u16 };
    if !lp_cmd_line.is_aligned() {
        return Args { parsed_args_list: lazy_current_exe().into_iter() };
    }
    let lp_cmd_line = unsafe { crate::slice::from_raw_parts(lp_cmd_line, lp_size) };

    Args {
        parsed_args_list: parse_lp_cmd_line(lp_cmd_line)
            .unwrap_or_else(lazy_current_exe)
            .into_iter(),
    }
}

impl fmt::Debug for Args {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.parsed_args_list.as_slice().fmt(f)
    }
}

impl Iterator for Args {
    type Item = OsString;

    fn next(&mut self) -> Option<OsString> {
        self.parsed_args_list.next()
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.parsed_args_list.size_hint()
    }
}

impl ExactSizeIterator for Args {
    fn len(&self) -> usize {
        self.parsed_args_list.len()
    }
}

impl DoubleEndedIterator for Args {
    fn next_back(&mut self) -> Option<OsString> {
        self.parsed_args_list.next_back()
    }
}

/// Implements the UEFI command-line argument parsing algorithm.
///
/// This implementation is based on what is defined in Section 3.4 of
/// [UEFI Shell Specification](https://uefi.org/sites/default/files/resources/UEFI_Shell_Spec_2_0.pdf)
///
/// Return None in the following cases:
/// - Invalid UTF-16 (unpaired surrogate)
/// - Empty/improper arguments
fn parse_lp_cmd_line(code_units: &[u16]) -> Option<Vec<OsString>> {
    const QUOTE: char = '"';
    const SPACE: char = ' ';
    const CARET: char = '^';
    const NULL: char = '\0';

    let mut ret_val = Vec::new();
    let mut code_units_iter = char::decode_utf16(code_units.iter().cloned()).peekable();

    // The executable name at the beginning is special.
    let mut in_quotes = false;
    let mut cur = String::new();
    while let Some(w) = code_units_iter.next() {
        let w = w.ok()?;
        match w {
            // break on NULL
            NULL => break,
            // A quote mark always toggles `in_quotes` no matter what because
            // there are no escape characters when parsing the executable name.
            QUOTE => in_quotes = !in_quotes,
            // If not `in_quotes` then whitespace ends argv[0].
            SPACE if !in_quotes => break,
            // In all other cases the code unit is taken literally.
            _ => cur.push(w),
        }
    }

    // If exe name is missing, the cli args are invalid
    if cur.is_empty() {
        return None;
    }

    ret_val.push(OsString::from(cur));
    // Skip whitespace.
    while code_units_iter.next_if_eq(&Ok(SPACE)).is_some() {}

    // Parse the arguments according to these rules:
    // * All code units are taken literally except space, quote and caret.
    // * When not `in_quotes`, space separate arguments. Consecutive spaces are
    // treated as a single separator.
    // * A space `in_quotes` is taken literally.
    // * A quote toggles `in_quotes` mode unless it's escaped. An escaped quote is taken literally.
    // * A quote can be escaped if preceded by caret.
    // * A caret can be escaped if preceded by caret.
    let mut cur = String::new();
    let mut in_quotes = false;
    while let Some(w) = code_units_iter.next() {
        let w = w.ok()?;
        match w {
            // break on NULL
            NULL => break,
            // If not `in_quotes`, a space or tab ends the argument.
            SPACE if !in_quotes => {
                ret_val.push(OsString::from(&cur[..]));
                cur.truncate(0);

                // Skip whitespace.
                while code_units_iter.next_if_eq(&Ok(SPACE)).is_some() {}
            }
            // Caret can escape quotes or carets
            CARET if in_quotes => {
                if let Some(x) = code_units_iter.next() {
                    cur.push(x.ok()?);
                }
            }
            // If quote then flip `in_quotes`
            QUOTE => in_quotes = !in_quotes,
            // Everything else is always taken literally.
            _ => cur.push(w),
        }
    }
    // Push the final argument, if any.
    if !cur.is_empty() || in_quotes {
        ret_val.push(OsString::from(cur));
    }
    Some(ret_val)
}