underhill_core/
options.rs

1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4//! CLI argument parsing for the underhill core process.
5
6#![warn(missing_docs)]
7
8use anyhow::Context;
9use anyhow::bail;
10use inspect::Inspect;
11use inspect::InspectMut;
12use mesh::MeshPayload;
13use std::collections::BTreeMap;
14use std::ffi::OsStr;
15use std::ffi::OsString;
16use std::path::PathBuf;
17use std::str::FromStr;
18
19#[derive(Clone, Debug, MeshPayload)]
20pub enum TestScenarioConfig {
21    SaveFail,
22    RestoreStuck,
23    SaveStuck,
24
25    /// Exercises a mocked TDISP flow for emulated TDISP devices produced by OpenVMM tests.
26    VpciTdispFlow,
27}
28
29impl FromStr for TestScenarioConfig {
30    type Err = anyhow::Error;
31
32    fn from_str(s: &str) -> Result<TestScenarioConfig, anyhow::Error> {
33        match s {
34            "SERVICING_SAVE_FAIL" => Ok(TestScenarioConfig::SaveFail),
35            "SERVICING_RESTORE_STUCK" => Ok(TestScenarioConfig::RestoreStuck),
36            "SERVICING_SAVE_STUCK" => Ok(TestScenarioConfig::SaveStuck),
37            "TDISP_VPCI_FLOW_TEST" => Ok(TestScenarioConfig::VpciTdispFlow),
38            _ => Err(anyhow::anyhow!("Invalid test config: {}", s)),
39        }
40    }
41}
42
43#[derive(Clone, Debug, MeshPayload)]
44pub enum GuestStateLifetimeCli {
45    Default,
46    ReprovisionOnFailure,
47    Reprovision,
48    Ephemeral,
49}
50
51impl FromStr for GuestStateLifetimeCli {
52    type Err = anyhow::Error;
53
54    fn from_str(s: &str) -> Result<GuestStateLifetimeCli, anyhow::Error> {
55        match s {
56            "DEFAULT" | "0" => Ok(GuestStateLifetimeCli::Default),
57            "REPROVISION_ON_FAILURE" | "1" => Ok(GuestStateLifetimeCli::ReprovisionOnFailure),
58            "REPROVISION" | "2" => Ok(GuestStateLifetimeCli::Reprovision),
59            "EPHEMERAL" | "3" => Ok(GuestStateLifetimeCli::Ephemeral),
60            _ => Err(anyhow::anyhow!("Invalid lifetime: {}", s)),
61        }
62    }
63}
64
65#[derive(Clone, Debug, MeshPayload)]
66pub enum GuestStateEncryptionPolicyCli {
67    Auto,
68    None,
69    GspById,
70    GspKey,
71}
72
73impl FromStr for GuestStateEncryptionPolicyCli {
74    type Err = anyhow::Error;
75
76    fn from_str(s: &str) -> Result<GuestStateEncryptionPolicyCli, anyhow::Error> {
77        match s {
78            "AUTO" | "0" => Ok(GuestStateEncryptionPolicyCli::Auto),
79            "NONE" | "1" => Ok(GuestStateEncryptionPolicyCli::None),
80            "GSP_BY_ID" | "2" => Ok(GuestStateEncryptionPolicyCli::GspById),
81            "GSP_KEY" | "3" => Ok(GuestStateEncryptionPolicyCli::GspKey),
82            _ => Err(anyhow::anyhow!("Invalid encryption policy: {}", s)),
83        }
84    }
85}
86
87#[derive(Clone, Debug, MeshPayload, Inspect, InspectMut)]
88pub enum KeepAliveConfig {
89    EnabledHostAndPrivatePoolPresent,
90    DisabledHostAndPrivatePoolPresent,
91    Disabled,
92}
93
94impl FromStr for KeepAliveConfig {
95    type Err = anyhow::Error;
96
97    fn from_str(s: &str) -> Result<KeepAliveConfig, anyhow::Error> {
98        match s.to_lowercase().as_str() {
99            "host,privatepool" | "enabled" => Ok(KeepAliveConfig::EnabledHostAndPrivatePoolPresent),
100            "nohost,privatepool" => Ok(KeepAliveConfig::DisabledHostAndPrivatePoolPresent),
101            "nohost,noprivatepool" => Ok(KeepAliveConfig::Disabled),
102            x if x == "disabled" || x.starts_with("disabled,") => Ok(KeepAliveConfig::Disabled),
103            _ => Err(anyhow::anyhow!("Invalid keepalive config: {}", s)),
104        }
105    }
106}
107
108impl KeepAliveConfig {
109    pub fn is_enabled(&self) -> bool {
110        matches!(self, KeepAliveConfig::EnabledHostAndPrivatePoolPresent)
111    }
112
113    /// Returns the string representation matching the inspect rename attributes.
114    pub fn as_str(&self) -> &'static str {
115        match self {
116            KeepAliveConfig::EnabledHostAndPrivatePoolPresent => "enabled",
117            KeepAliveConfig::DisabledHostAndPrivatePoolPresent => "nohost,privatepool",
118            KeepAliveConfig::Disabled => "disabled",
119        }
120    }
121}
122
123// We've made our own parser here instead of using something like clap in order
124// to save on compiled file size. We don't need all the features a crate can provide.
125/// underhill core command-line and environment variable options.
126pub struct Options {
127    /// (OPENHCL_WAIT_FOR_START=1 | --wait-for-start)
128    ///  wait for a diagnostics start request before initializing and starting the VM
129    pub wait_for_start: bool,
130
131    /// (OPENHCL_SIGNAL_VTL0_STARTED=1)
132    /// immediately signal that VTL0 has started, before doing any
133    /// initialization. This allows VM boot to proceed even if initialization
134    /// may hang (e.g., because you specified OPENHCL_WAIT_FOR_START=1).
135    pub signal_vtl0_started: bool,
136
137    /// (OPENHCL_REFORMAT_VMGS=1 | --reformat-vmgs)
138    /// reformat the VMGS file on boot. useful for running potentially destructive VMGS tests.
139    pub reformat_vmgs: bool,
140
141    /// (OPENHCL_PID_FILE_PATH=/path/to/file | --pid /path/to/file)
142    /// write the PID to the specified path
143    pub pid: Option<PathBuf>,
144
145    /// (OPENHCL_VMBUS_MAX_VERSION=\<number\>)
146    /// limit the maximum protocol version allowed by vmbus; used for testing purposes
147    pub vmbus_max_version: Option<u32>,
148
149    /// (OPENHCL_VMBUS_ENABLE_MNF=1)
150    /// Enable handling of MNF in the Underhill vmbus server, instead of the host.
151    pub vmbus_enable_mnf: Option<bool>,
152
153    /// (OPENHCL_VMBUS_FORCE_CONFIDENTIAL_EXTERNAL_MEMORY=1)
154    /// Force the use of confidential external memory for all non-relay vmbus channels. For testing
155    /// purposes only.
156    ///
157    /// N.B.: Not all vmbus devices support this feature, so enabling it may cause failures.
158    pub vmbus_force_confidential_external_memory: bool,
159
160    /// (OPENHCL_VMBUS_CHANNEL_UNSTICK_DELAY_MS=\<number\>) (default: 100)
161    /// Delay before unsticking a vmbus channel after it has been opened, in milliseconds. Set to
162    /// zero to disable unsticking.
163    pub vmbus_channel_unstick_delay_ms: u64,
164
165    /// (OPENHCL_CMDLINE_APPEND=\<string\>)
166    /// Command line to append to VTL0, only used with direct boot.
167    pub cmdline_append: Option<String>,
168
169    /// (OPENHCL_VNC_PORT=\<number\> | --vnc-port \<number\>) (default: 3)
170    /// VNC (vsock) port number
171    pub vnc_port: u32,
172
173    /// (OPENHCL_GDBSTUB=1)
174    /// Enables the GDB stub for debugging the guest.
175    pub gdbstub: bool,
176
177    /// (OPENHCL_GDBSTUB_PORT=\<number\>) (default: 4)
178    /// GDB stub (vsock) port number.
179    pub gdbstub_port: u32,
180
181    /// (OPENHCL_VTL0_STARTS_PAUSED=1)
182    /// Start with VTL0 paused
183    pub vtl0_starts_paused: bool,
184
185    /// (OPENHCL_FRAMEBUFFER_GPA_BASE=\<number\>)
186    /// Base GPA of the fixed framebuffer mapping for underhill to read.
187    /// If a value is provided, a graphics device is exposed.
188    // TODO: send this value as an IGVM device tree parameter instead
189    pub framebuffer_gpa_base: Option<u64>,
190
191    /// (OPENHCL_SERIAL_WAIT_FOR_RTS=\<bool\>)
192    /// Whether the emulated 16550 waits for guest DTR+RTS before pulling data
193    /// from the host.
194    pub serial_wait_for_rts: bool,
195
196    /// (OPENHCL_FORCE_LOAD_VTL0_IMAGE=\<string\>)
197    /// Force load the specified image in VTL0. The image must support the
198    /// option specified.
199    ///
200    /// Valid options are "pcat, uefi, linux".
201    pub force_load_vtl0_image: Option<String>,
202
203    /// (OPENHCL_NVME_VFIO=1)
204    /// Use the user-mode VFIO NVMe driver instead of the Linux driver.
205    pub nvme_vfio: bool,
206
207    /// (OPENHCL_MCR_DEVICE=1)
208    /// MCR Device Enable
209    pub mcr: bool, // TODO MCR: support closed-source ENV vars
210
211    /// (OPENHCL_HIDE_ISOLATION=1)
212    /// Hide the isolation mode from the guest.
213    pub hide_isolation: bool,
214
215    /// (OPENHCL_HALT_ON_GUEST_HALT=1) When receiving a halt request from a
216    /// lower VTL, halt underhill instead of forwarding the halt request to the
217    /// host. This allows for debugging state without the partition state
218    /// changing from the host.
219    pub halt_on_guest_halt: bool,
220
221    /// (OPENHCL_NO_SIDECAR_HOTPLUG=1) Leave sidecar VPs remote even if they
222    /// hit exits.
223    pub no_sidecar_hotplug: bool,
224
225    /// (OPENHCL_NVME_KEEP_ALIVE=\<KeepaliveConfig\>)
226    /// Configure NVMe keep alive behavior when servicing.
227    /// Options are:
228    ///  - "host,privatepool" - Enable keep alive if both host and private pool support it.
229    ///  - "nohost,privatepool" - Used when the host does not support keepalive, but a private pool is present. Keepalive is disabled.
230    ///  - "nohost,noprivatepool" - Keepalive is disabled.
231    ///  - "disabled, X, X" - Keepalive is disabled due to manual
232    ///    override. Host and private pool options are ignored.
233    pub nvme_keep_alive: KeepAliveConfig,
234
235    /// (OPENHCL_MANA_KEEP_ALIVE=\<KeepAliveConfig\>)
236    /// Configure MANA keep alive behavior when servicing.
237    /// Options are:
238    ///  - "host,privatepool" - Enable keep alive if both host and private pool support it.
239    ///  - "nohost,privatepool" - Used when the host does not support keepalive, but a private pool is present. Keepalive is disabled.
240    ///  - "nohost,noprivatepool" - Keepalive is disabled.
241    ///  - "disabled, X, X" - TODO: This needs to be implemented for mana.
242    pub mana_keep_alive: KeepAliveConfig,
243
244    /// (OPENHCL_NVME_ALWAYS_FLR=1)
245    /// Always use the FLR (Function Level Reset) path for NVMe devices,
246    /// even if we would otherwise attempt to use VFIO's NoReset support.
247    pub nvme_always_flr: bool,
248
249    /// (OPENHCL_TEST_CONFIG=\<TestScenarioConfig\>)
250    /// Test configurations are designed to replicate specific behaviors and
251    /// conditions in order to simulate various test scenarios.
252    pub test_configuration: Option<TestScenarioConfig>,
253
254    /// (OPENHCL_DISABLE_UEFI_FRONTPAGE=1) Disable the frontpage in UEFI which
255    /// will result in UEFI terminating, shutting down the guest instead of
256    /// showing the frontpage.
257    pub disable_uefi_frontpage: Option<bool>,
258
259    /// (HCL_DEFAULT_BOOT_ALWAYS_ATTEMPT=1) Instruct UEFI to always attempt a
260    /// default boot, even if existing boot entries fail.
261    pub default_boot_always_attempt: Option<bool>,
262
263    /// (HCL_GUEST_STATE_LIFETIME=\<GuestStateLifetimeCli\>)
264    /// Specify which guest state lifetime to use.
265    pub guest_state_lifetime: Option<GuestStateLifetimeCli>,
266
267    /// (HCL_GUEST_STATE_ENCRYPTION_POLICY=\<GuestStateEncryptionPolicyCli\>)
268    /// Specify which guest state encryption policy to use.
269    pub guest_state_encryption_policy: Option<GuestStateEncryptionPolicyCli>,
270
271    /// (HCL_STRICT_ENCRYPTION_POLICY=1) Strict guest state encryption policy.
272    pub strict_encryption_policy: Option<bool>,
273
274    /// (HCL_ATTEMPT_AK_CERT_CALLBACK=1) Attempt to renew the AK cert.
275    /// If not specified, use the configuration in DPSv2 ManagementVtlFeatures.
276    pub attempt_ak_cert_callback: Option<bool>,
277
278    /// (OPENHCL_ENABLE_VPCI_RELAY=1) Enable the VPCI relay.
279    pub enable_vpci_relay: Option<bool>,
280
281    /// (OPENHCL_DISABLE_PROXY_REDIRECT=1) Disable proxy interrupt redirection.
282    pub disable_proxy_redirect: bool,
283
284    /// (OPENHCL_DISABLE_LOWER_VTL_TIMER_VIRT=1) Disable lower VTL timer virtualization.
285    pub disable_lower_vtl_timer_virt: bool,
286
287    /// (OPENHCL_CONFIG_TIMEOUT_IN_SECONDS=\<number\>) (default: 5)
288    /// Timeout in seconds for VM configuration operations, both initial
289    /// configuration and subsequent modifications.
290    pub config_timeout_in_seconds: u64,
291
292    /// (OPENHCL_SERVICING_TIMEOUT_DUMP_COLLECTION_IN_MS=\<number\>) (default: 500)
293    /// The default time to wait in milliseconds for dump collection during a
294    /// panic in servicing.
295    pub servicing_timeout_dump_collection_in_ms: u64,
296}
297
298impl Options {
299    pub(crate) fn parse(
300        extra_args: Vec<String>,
301        extra_env: Vec<(String, Option<String>)>,
302    ) -> anyhow::Result<Self> {
303        // Pull the entire environment into a BTreeMap for manipulation through extra_env.
304        let mut env: BTreeMap<OsString, OsString> = std::env::vars_os().collect();
305        for (key, value) in extra_env {
306            match value {
307                Some(value) => env.insert(key.into(), value.into()),
308                None => env.remove::<OsStr>(key.as_ref()),
309            };
310        }
311
312        // Reads an environment variable, falling back to a legacy variable (replacing
313        // "OPENHCL_" with "UNDERHILL_") if the original is not set.
314        let read_legacy_openhcl_env = |name: &str| -> Option<&OsString> {
315            env.get::<OsStr>(name.as_ref()).or_else(|| {
316                env.get::<OsStr>(
317                    format!(
318                        "UNDERHILL_{}",
319                        name.strip_prefix("OPENHCL_").unwrap_or(name)
320                    )
321                    .as_ref(),
322                )
323            })
324        };
325
326        // Reads an environment variable strings.
327        let read_env = |name: &str| -> Option<&OsString> { env.get::<OsStr>(name.as_ref()) };
328
329        fn parse_bool_opt(value: Option<&OsString>) -> anyhow::Result<Option<bool>> {
330            value
331                .map(|v| {
332                    if v.eq_ignore_ascii_case("true") || v == "1" {
333                        Ok(true)
334                    } else if v.eq_ignore_ascii_case("false") || v == "0" {
335                        Ok(false)
336                    } else {
337                        Err(anyhow::anyhow!(
338                            "invalid boolean environment variable: {}",
339                            v.to_string_lossy()
340                        ))
341                    }
342                })
343                .transpose()
344        }
345
346        fn parse_bool(value: Option<&OsString>) -> bool {
347            parse_bool_opt(value).ok().flatten().unwrap_or_default()
348        }
349
350        let parse_legacy_env_bool = |name| parse_bool(read_legacy_openhcl_env(name));
351        let parse_env_bool = |name: &str| parse_bool(read_env(name));
352        let parse_env_bool_opt = |name: &str| {
353            parse_bool_opt(read_env(name))
354                .map_err(|e| tracing::warn!("failed to parse {name}: {e:#}"))
355                .ok()
356                .flatten()
357        };
358
359        fn parse_number(value: Option<&OsString>) -> anyhow::Result<Option<u64>> {
360            value
361                .map(|v| {
362                    let v = v.to_string_lossy();
363                    v.parse()
364                        .context(format!("invalid numeric environment variable: {v}"))
365                })
366                .transpose()
367        }
368
369        let parse_legacy_env_number = |name| {
370            parse_number(read_legacy_openhcl_env(name))
371                .context(format!("parsing legacy env number: {name}"))
372        };
373        let parse_env_number = |name: &str| {
374            parse_number(read_env(name)).context(format!("parsing env number: {name}"))
375        };
376
377        let mut wait_for_start = parse_legacy_env_bool("OPENHCL_WAIT_FOR_START");
378        let mut reformat_vmgs = parse_legacy_env_bool("OPENHCL_REFORMAT_VMGS");
379        let mut pid = read_legacy_openhcl_env("OPENHCL_PID_FILE_PATH")
380            .map(|x| x.to_string_lossy().into_owned().into());
381        let vmbus_max_version = read_legacy_openhcl_env("OPENHCL_VMBUS_MAX_VERSION")
382            .map(|x| {
383                vmbus_core::parse_vmbus_version(&(x.to_string_lossy()))
384                    .map_err(|x| anyhow::anyhow!("Error parsing vmbus max version: {}", x))
385            })
386            .transpose()?;
387        let vmbus_enable_mnf =
388            read_legacy_openhcl_env("OPENHCL_VMBUS_ENABLE_MNF").map(|v| parse_bool(Some(v)));
389        let vmbus_force_confidential_external_memory =
390            parse_env_bool("OPENHCL_VMBUS_FORCE_CONFIDENTIAL_EXTERNAL_MEMORY");
391        let vmbus_channel_unstick_delay_ms =
392            parse_legacy_env_number("OPENHCL_VMBUS_CHANNEL_UNSTICK_DELAY_MS")?;
393        let cmdline_append = read_legacy_openhcl_env("OPENHCL_CMDLINE_APPEND")
394            .map(|x| x.to_string_lossy().into_owned());
395        let force_load_vtl0_image = read_legacy_openhcl_env("OPENHCL_FORCE_LOAD_VTL0_IMAGE")
396            .map(|x| x.to_string_lossy().into_owned());
397        let mut vnc_port = parse_legacy_env_number("OPENHCL_VNC_PORT")?.map(|x| x as u32);
398        let framebuffer_gpa_base = parse_legacy_env_number("OPENHCL_FRAMEBUFFER_GPA_BASE")?;
399        let vtl0_starts_paused = parse_legacy_env_bool("OPENHCL_VTL0_STARTS_PAUSED");
400        let serial_wait_for_rts = parse_legacy_env_bool("OPENHCL_SERIAL_WAIT_FOR_RTS");
401        let nvme_vfio = parse_legacy_env_bool("OPENHCL_NVME_VFIO");
402        let mcr = parse_legacy_env_bool("OPENHCL_MCR_DEVICE");
403        let hide_isolation = parse_env_bool("OPENHCL_HIDE_ISOLATION");
404        let halt_on_guest_halt = parse_legacy_env_bool("OPENHCL_HALT_ON_GUEST_HALT");
405        let no_sidecar_hotplug = parse_legacy_env_bool("OPENHCL_NO_SIDECAR_HOTPLUG");
406        let gdbstub = parse_legacy_env_bool("OPENHCL_GDBSTUB");
407        let gdbstub_port = parse_legacy_env_number("OPENHCL_GDBSTUB_PORT")?.map(|x| x as u32);
408        let nvme_keep_alive = read_env("OPENHCL_NVME_KEEP_ALIVE")
409                    .map(|x| {
410                        let s = x.to_string_lossy();
411                        match s.parse::<KeepAliveConfig>() {
412                            Ok(v) => v,
413                            Err(e) => {
414                                tracing::warn!(
415                                    "failed to parse OPENHCL_NVME_KEEP_ALIVE ('{s}'): {e}. Nvme keepalive will be disabled."
416                                );
417                                KeepAliveConfig::Disabled
418                            }
419                        }
420                    })
421                    .unwrap_or(KeepAliveConfig::Disabled);
422        let mana_keep_alive = read_env("OPENHCL_MANA_KEEP_ALIVE")
423                    .map(|x| {
424                        let s = x.to_string_lossy();
425                        match s.parse::<KeepAliveConfig>() {
426                            Ok(v) => v,
427                            Err(e) => {
428                                tracing::warn!(
429                                    "failed to parse OPENHCL_MANA_KEEP_ALIVE ('{s}'): {e}. Mana keepalive will be disabled."
430                                );
431                                KeepAliveConfig::Disabled
432                            }
433                        }
434                    })
435                    .unwrap_or(KeepAliveConfig::Disabled);
436        let nvme_always_flr = parse_env_bool("OPENHCL_NVME_ALWAYS_FLR");
437        let test_configuration = read_env("OPENHCL_TEST_CONFIG").and_then(|x| {
438            x.to_string_lossy()
439                .parse::<TestScenarioConfig>()
440                .map_err(|e| {
441                    tracing::warn!(
442                        "failed to parse OPENHCL_TEST_CONFIG: {}. No test will be simulated.",
443                        e
444                    )
445                })
446                .ok()
447        });
448        let disable_uefi_frontpage = parse_env_bool_opt("OPENHCL_DISABLE_UEFI_FRONTPAGE");
449        let signal_vtl0_started = parse_env_bool("OPENHCL_SIGNAL_VTL0_STARTED");
450        let default_boot_always_attempt = parse_env_bool_opt("HCL_DEFAULT_BOOT_ALWAYS_ATTEMPT");
451        let guest_state_lifetime = read_env("HCL_GUEST_STATE_LIFETIME").and_then(|x| {
452            x.to_string_lossy()
453                .parse::<GuestStateLifetimeCli>()
454                .map_err(|e| tracing::warn!("failed to parse HCL_GUEST_STATE_LIFETIME: {:#}", e))
455                .ok()
456        });
457        let guest_state_encryption_policy =
458            read_env("HCL_GUEST_STATE_ENCRYPTION_POLICY").and_then(|x| {
459                x.to_string_lossy()
460                    .parse::<GuestStateEncryptionPolicyCli>()
461                    .map_err(|e| {
462                        tracing::warn!("failed to parse HCL_GUEST_STATE_ENCRYPTION_POLICY: {:#}", e)
463                    })
464                    .ok()
465            });
466        let strict_encryption_policy = parse_env_bool_opt("HCL_STRICT_ENCRYPTION_POLICY");
467        let attempt_ak_cert_callback = parse_env_bool_opt("HCL_ATTEMPT_AK_CERT_CALLBACK");
468        let enable_vpci_relay = parse_env_bool_opt("OPENHCL_ENABLE_VPCI_RELAY");
469        let disable_proxy_redirect = parse_env_bool("OPENHCL_DISABLE_PROXY_REDIRECT");
470        let disable_lower_vtl_timer_virt = parse_env_bool("OPENHCL_DISABLE_LOWER_VTL_TIMER_VIRT");
471        let config_timeout_in_seconds =
472            parse_legacy_env_number("OPENHCL_CONFIG_TIMEOUT_IN_SECONDS")?.unwrap_or(5);
473        let servicing_timeout_dump_collection_in_ms =
474            parse_env_number("OPENHCL_SERVICING_TIMEOUT_DUMP_COLLECTION_IN_MS")?.unwrap_or(500);
475
476        let mut args = std::env::args().chain(extra_args);
477        // Skip our own filename.
478        args.next();
479
480        while let Some(next) = args.next() {
481            let arg = next;
482
483            match &*arg {
484                "--wait-for-start" => wait_for_start = true,
485                "--reformat-vmgs" => reformat_vmgs = true,
486
487                x if x.starts_with("--") && x.len() > 2 => {
488                    if let Some(eq) = arg.find('=') {
489                        let (name, value) = arg.split_at(eq);
490                        // Don't forget to exclude the '=' itself.
491                        let value = &value[1..];
492                        Self::parse_value_arg(name, value, &mut pid, &mut vnc_port)?;
493                    } else {
494                        if let Some(value) = args.next() {
495                            Self::parse_value_arg(&arg, &value, &mut pid, &mut vnc_port)?;
496                        } else {
497                            bail!("Expected a value after argument {}", arg);
498                        }
499                    }
500                }
501                x => bail!("Unrecognized argument {}", x),
502            }
503        }
504
505        Ok(Self {
506            wait_for_start,
507            signal_vtl0_started,
508            reformat_vmgs,
509            pid,
510            vmbus_max_version,
511            vmbus_enable_mnf,
512            vmbus_force_confidential_external_memory,
513            vmbus_channel_unstick_delay_ms: vmbus_channel_unstick_delay_ms.unwrap_or(100),
514            cmdline_append,
515            vnc_port: vnc_port.unwrap_or(3),
516            framebuffer_gpa_base,
517            gdbstub,
518            gdbstub_port: gdbstub_port.unwrap_or(4),
519            vtl0_starts_paused,
520            serial_wait_for_rts,
521            force_load_vtl0_image,
522            nvme_vfio,
523            mcr,
524            hide_isolation,
525            halt_on_guest_halt,
526            no_sidecar_hotplug,
527            nvme_keep_alive,
528            mana_keep_alive,
529            nvme_always_flr,
530            test_configuration,
531            disable_uefi_frontpage,
532            default_boot_always_attempt,
533            guest_state_lifetime,
534            guest_state_encryption_policy,
535            strict_encryption_policy,
536            attempt_ak_cert_callback,
537            enable_vpci_relay,
538            disable_proxy_redirect,
539            disable_lower_vtl_timer_virt,
540            config_timeout_in_seconds,
541            servicing_timeout_dump_collection_in_ms,
542        })
543    }
544
545    fn parse_value_arg(
546        name: &str,
547        value: &str,
548        pid: &mut Option<PathBuf>,
549        vnc_port: &mut Option<u32>,
550    ) -> anyhow::Result<()> {
551        match name {
552            "--pid" => *pid = Some(value.into()),
553            "--vnc-port" => {
554                *vnc_port = Some(
555                    value
556                        .parse()
557                        .context(format!("Error parsing VNC port {}", value))?,
558                )
559            }
560            x => bail!("Unrecognized argument {}", x),
561        }
562
563        Ok(())
564    }
565}
underhill_core/options.rs

underhill_core/
options.rs
