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_HIDE_ISOLATION=1)
208    /// Hide the isolation mode from the guest.
209    pub hide_isolation: bool,
210
211    /// (OPENHCL_HALT_ON_GUEST_HALT=1) When receiving a halt request from a
212    /// lower VTL, halt underhill instead of forwarding the halt request to the
213    /// host. This allows for debugging state without the partition state
214    /// changing from the host.
215    pub halt_on_guest_halt: bool,
216
217    /// (OPENHCL_NO_SIDECAR_HOTPLUG=1) Leave sidecar VPs remote even if they
218    /// hit exits.
219    pub no_sidecar_hotplug: bool,
220
221    /// (OPENHCL_NVME_KEEP_ALIVE=\<KeepaliveConfig\>)
222    /// Configure NVMe keep alive behavior when servicing.
223    /// Options are:
224    ///  - "host,privatepool" - Enable keep alive if both host and private pool support it.
225    ///  - "nohost,privatepool" - Used when the host does not support keepalive, but a private pool is present. Keepalive is disabled.
226    ///  - "nohost,noprivatepool" - Keepalive is disabled.
227    ///  - "disabled, X, X" - Keepalive is disabled due to manual
228    ///    override. Host and private pool options are ignored.
229    pub nvme_keep_alive: KeepAliveConfig,
230
231    /// (OPENHCL_MANA_KEEP_ALIVE=\<KeepAliveConfig\>)
232    /// Configure MANA keep alive behavior when servicing.
233    /// Options are:
234    ///  - "host,privatepool" - Enable keep alive if both host and private pool support it.
235    ///  - "nohost,privatepool" - Used when the host does not support keepalive, but a private pool is present. Keepalive is disabled.
236    ///  - "nohost,noprivatepool" - Keepalive is disabled.
237    ///  - "disabled, X, X" - TODO: This needs to be implemented for mana.
238    pub mana_keep_alive: KeepAliveConfig,
239
240    /// (OPENHCL_NVME_ALWAYS_FLR=1)
241    /// Always use the FLR (Function Level Reset) path for NVMe devices,
242    /// even if we would otherwise attempt to use VFIO's NoReset support.
243    pub nvme_always_flr: bool,
244
245    /// (OPENHCL_TEST_CONFIG=\<TestScenarioConfig\>)
246    /// Test configurations are designed to replicate specific behaviors and
247    /// conditions in order to simulate various test scenarios.
248    pub test_configuration: Option<TestScenarioConfig>,
249
250    /// (OPENHCL_DISABLE_UEFI_FRONTPAGE=1) Disable the frontpage in UEFI which
251    /// will result in UEFI terminating, shutting down the guest instead of
252    /// showing the frontpage.
253    pub disable_uefi_frontpage: Option<bool>,
254
255    /// (HCL_DEFAULT_BOOT_ALWAYS_ATTEMPT=1) Instruct UEFI to always attempt a
256    /// default boot, even if existing boot entries fail.
257    pub default_boot_always_attempt: Option<bool>,
258
259    /// (HCL_GUEST_STATE_LIFETIME=\<GuestStateLifetimeCli\>)
260    /// Specify which guest state lifetime to use.
261    pub guest_state_lifetime: Option<GuestStateLifetimeCli>,
262
263    /// (HCL_GUEST_STATE_ENCRYPTION_POLICY=\<GuestStateEncryptionPolicyCli\>)
264    /// Specify which guest state encryption policy to use.
265    pub guest_state_encryption_policy: Option<GuestStateEncryptionPolicyCli>,
266
267    /// (HCL_STRICT_ENCRYPTION_POLICY=1) Strict guest state encryption policy.
268    pub strict_encryption_policy: Option<bool>,
269
270    /// (HCL_ATTEMPT_AK_CERT_CALLBACK=1) Attempt to renew the AK cert.
271    /// If not specified, use the configuration in DPSv2 ManagementVtlFeatures.
272    pub attempt_ak_cert_callback: Option<bool>,
273
274    /// (OPENHCL_ENABLE_VPCI_RELAY=1) Enable the VPCI relay.
275    pub enable_vpci_relay: Option<bool>,
276
277    /// (OPENHCL_DISABLE_PROXY_REDIRECT=1) Disable proxy interrupt redirection.
278    pub disable_proxy_redirect: bool,
279
280    /// (OPENHCL_DISABLE_LOWER_VTL_TIMER_VIRT=1) Disable lower VTL timer virtualization.
281    pub disable_lower_vtl_timer_virt: bool,
282
283    /// (OPENHCL_CONFIG_TIMEOUT_IN_SECONDS=\<number\>) (default: 5)
284    /// Timeout in seconds for VM configuration operations, both initial
285    /// configuration and subsequent modifications.
286    pub config_timeout_in_seconds: u64,
287
288    /// (OPENHCL_SERVICING_TIMEOUT_DUMP_COLLECTION_IN_MS=\<number\>) (default: 500)
289    /// The default time to wait in milliseconds for dump collection during a
290    /// panic in servicing.
291    pub servicing_timeout_dump_collection_in_ms: u64,
292}
293
294impl Options {
295    pub(crate) fn parse(
296        extra_args: Vec<String>,
297        extra_env: Vec<(String, Option<String>)>,
298    ) -> anyhow::Result<Self> {
299        // Pull the entire environment into a BTreeMap for manipulation through extra_env.
300        let mut env: BTreeMap<OsString, OsString> = std::env::vars_os().collect();
301        for (key, value) in extra_env {
302            match value {
303                Some(value) => env.insert(key.into(), value.into()),
304                None => env.remove::<OsStr>(key.as_ref()),
305            };
306        }
307
308        // Reads an environment variable, falling back to a legacy variable (replacing
309        // "OPENHCL_" with "UNDERHILL_") if the original is not set.
310        let read_legacy_openhcl_env = |name: &str| -> Option<&OsString> {
311            env.get::<OsStr>(name.as_ref()).or_else(|| {
312                env.get::<OsStr>(
313                    format!(
314                        "UNDERHILL_{}",
315                        name.strip_prefix("OPENHCL_").unwrap_or(name)
316                    )
317                    .as_ref(),
318                )
319            })
320        };
321
322        // Reads an environment variable strings.
323        let read_env = |name: &str| -> Option<&OsString> { env.get::<OsStr>(name.as_ref()) };
324
325        fn parse_bool_opt(value: Option<&OsString>) -> anyhow::Result<Option<bool>> {
326            value
327                .map(|v| {
328                    if v.eq_ignore_ascii_case("true") || v == "1" {
329                        Ok(true)
330                    } else if v.eq_ignore_ascii_case("false") || v == "0" {
331                        Ok(false)
332                    } else {
333                        Err(anyhow::anyhow!(
334                            "invalid boolean environment variable: {}",
335                            v.to_string_lossy()
336                        ))
337                    }
338                })
339                .transpose()
340        }
341
342        fn parse_bool(value: Option<&OsString>) -> bool {
343            parse_bool_opt(value).ok().flatten().unwrap_or_default()
344        }
345
346        let parse_legacy_env_bool = |name| parse_bool(read_legacy_openhcl_env(name));
347        let parse_env_bool = |name: &str| parse_bool(read_env(name));
348        let parse_env_bool_opt = |name: &str| {
349            parse_bool_opt(read_env(name))
350                .map_err(|e| tracing::warn!("failed to parse {name}: {e:#}"))
351                .ok()
352                .flatten()
353        };
354
355        fn parse_number(value: Option<&OsString>) -> anyhow::Result<Option<u64>> {
356            value
357                .map(|v| {
358                    let v = v.to_string_lossy();
359                    v.parse()
360                        .context(format!("invalid numeric environment variable: {v}"))
361                })
362                .transpose()
363        }
364
365        let parse_legacy_env_number = |name| {
366            parse_number(read_legacy_openhcl_env(name))
367                .context(format!("parsing legacy env number: {name}"))
368        };
369        let parse_env_number = |name: &str| {
370            parse_number(read_env(name)).context(format!("parsing env number: {name}"))
371        };
372
373        let mut wait_for_start = parse_legacy_env_bool("OPENHCL_WAIT_FOR_START");
374        let mut reformat_vmgs = parse_legacy_env_bool("OPENHCL_REFORMAT_VMGS");
375        let mut pid = read_legacy_openhcl_env("OPENHCL_PID_FILE_PATH")
376            .map(|x| x.to_string_lossy().into_owned().into());
377        let vmbus_max_version = read_legacy_openhcl_env("OPENHCL_VMBUS_MAX_VERSION")
378            .map(|x| {
379                vmbus_core::parse_vmbus_version(&(x.to_string_lossy()))
380                    .map_err(|x| anyhow::anyhow!("Error parsing vmbus max version: {}", x))
381            })
382            .transpose()?;
383        let vmbus_enable_mnf =
384            read_legacy_openhcl_env("OPENHCL_VMBUS_ENABLE_MNF").map(|v| parse_bool(Some(v)));
385        let vmbus_force_confidential_external_memory =
386            parse_env_bool("OPENHCL_VMBUS_FORCE_CONFIDENTIAL_EXTERNAL_MEMORY");
387        let vmbus_channel_unstick_delay_ms =
388            parse_legacy_env_number("OPENHCL_VMBUS_CHANNEL_UNSTICK_DELAY_MS")?;
389        let cmdline_append = read_legacy_openhcl_env("OPENHCL_CMDLINE_APPEND")
390            .map(|x| x.to_string_lossy().into_owned());
391        let force_load_vtl0_image = read_legacy_openhcl_env("OPENHCL_FORCE_LOAD_VTL0_IMAGE")
392            .map(|x| x.to_string_lossy().into_owned());
393        let mut vnc_port = parse_legacy_env_number("OPENHCL_VNC_PORT")?.map(|x| x as u32);
394        let framebuffer_gpa_base = parse_legacy_env_number("OPENHCL_FRAMEBUFFER_GPA_BASE")?;
395        let vtl0_starts_paused = parse_legacy_env_bool("OPENHCL_VTL0_STARTS_PAUSED");
396        let serial_wait_for_rts = parse_legacy_env_bool("OPENHCL_SERIAL_WAIT_FOR_RTS");
397        let nvme_vfio = parse_legacy_env_bool("OPENHCL_NVME_VFIO");
398        let hide_isolation = parse_env_bool("OPENHCL_HIDE_ISOLATION");
399        let halt_on_guest_halt = parse_legacy_env_bool("OPENHCL_HALT_ON_GUEST_HALT");
400        let no_sidecar_hotplug = parse_legacy_env_bool("OPENHCL_NO_SIDECAR_HOTPLUG");
401        let gdbstub = parse_legacy_env_bool("OPENHCL_GDBSTUB");
402        let gdbstub_port = parse_legacy_env_number("OPENHCL_GDBSTUB_PORT")?.map(|x| x as u32);
403        let nvme_keep_alive = read_env("OPENHCL_NVME_KEEP_ALIVE")
404                    .map(|x| {
405                        let s = x.to_string_lossy();
406                        match s.parse::<KeepAliveConfig>() {
407                            Ok(v) => v,
408                            Err(e) => {
409                                tracing::warn!(
410                                    "failed to parse OPENHCL_NVME_KEEP_ALIVE ('{s}'): {e}. Nvme keepalive will be disabled."
411                                );
412                                KeepAliveConfig::Disabled
413                            }
414                        }
415                    })
416                    .unwrap_or(KeepAliveConfig::Disabled);
417        let mana_keep_alive = read_env("OPENHCL_MANA_KEEP_ALIVE")
418                    .map(|x| {
419                        let s = x.to_string_lossy();
420                        match s.parse::<KeepAliveConfig>() {
421                            Ok(v) => v,
422                            Err(e) => {
423                                tracing::warn!(
424                                    "failed to parse OPENHCL_MANA_KEEP_ALIVE ('{s}'): {e}. Mana keepalive will be disabled."
425                                );
426                                KeepAliveConfig::Disabled
427                            }
428                        }
429                    })
430                    .unwrap_or(KeepAliveConfig::Disabled);
431        let nvme_always_flr = parse_env_bool("OPENHCL_NVME_ALWAYS_FLR");
432        let test_configuration = read_env("OPENHCL_TEST_CONFIG").and_then(|x| {
433            x.to_string_lossy()
434                .parse::<TestScenarioConfig>()
435                .map_err(|e| {
436                    tracing::warn!(
437                        "failed to parse OPENHCL_TEST_CONFIG: {}. No test will be simulated.",
438                        e
439                    )
440                })
441                .ok()
442        });
443        let disable_uefi_frontpage = parse_env_bool_opt("OPENHCL_DISABLE_UEFI_FRONTPAGE");
444        let signal_vtl0_started = parse_env_bool("OPENHCL_SIGNAL_VTL0_STARTED");
445        let default_boot_always_attempt = parse_env_bool_opt("HCL_DEFAULT_BOOT_ALWAYS_ATTEMPT");
446        let guest_state_lifetime = read_env("HCL_GUEST_STATE_LIFETIME").and_then(|x| {
447            x.to_string_lossy()
448                .parse::<GuestStateLifetimeCli>()
449                .map_err(|e| tracing::warn!("failed to parse HCL_GUEST_STATE_LIFETIME: {:#}", e))
450                .ok()
451        });
452        let guest_state_encryption_policy =
453            read_env("HCL_GUEST_STATE_ENCRYPTION_POLICY").and_then(|x| {
454                x.to_string_lossy()
455                    .parse::<GuestStateEncryptionPolicyCli>()
456                    .map_err(|e| {
457                        tracing::warn!("failed to parse HCL_GUEST_STATE_ENCRYPTION_POLICY: {:#}", e)
458                    })
459                    .ok()
460            });
461        let strict_encryption_policy = parse_env_bool_opt("HCL_STRICT_ENCRYPTION_POLICY");
462        let attempt_ak_cert_callback = parse_env_bool_opt("HCL_ATTEMPT_AK_CERT_CALLBACK");
463        let enable_vpci_relay = parse_env_bool_opt("OPENHCL_ENABLE_VPCI_RELAY");
464        let disable_proxy_redirect = parse_env_bool("OPENHCL_DISABLE_PROXY_REDIRECT");
465        let disable_lower_vtl_timer_virt = parse_env_bool("OPENHCL_DISABLE_LOWER_VTL_TIMER_VIRT");
466        let config_timeout_in_seconds =
467            parse_legacy_env_number("OPENHCL_CONFIG_TIMEOUT_IN_SECONDS")?.unwrap_or(5);
468        let servicing_timeout_dump_collection_in_ms =
469            parse_env_number("OPENHCL_SERVICING_TIMEOUT_DUMP_COLLECTION_IN_MS")?.unwrap_or(500);
470
471        let mut args = std::env::args().chain(extra_args);
472        // Skip our own filename.
473        args.next();
474
475        while let Some(next) = args.next() {
476            let arg = next;
477
478            match &*arg {
479                "--wait-for-start" => wait_for_start = true,
480                "--reformat-vmgs" => reformat_vmgs = true,
481
482                x if x.starts_with("--") && x.len() > 2 => {
483                    if let Some(eq) = arg.find('=') {
484                        let (name, value) = arg.split_at(eq);
485                        // Don't forget to exclude the '=' itself.
486                        let value = &value[1..];
487                        Self::parse_value_arg(name, value, &mut pid, &mut vnc_port)?;
488                    } else {
489                        if let Some(value) = args.next() {
490                            Self::parse_value_arg(&arg, &value, &mut pid, &mut vnc_port)?;
491                        } else {
492                            bail!("Expected a value after argument {}", arg);
493                        }
494                    }
495                }
496                x => bail!("Unrecognized argument {}", x),
497            }
498        }
499
500        Ok(Self {
501            wait_for_start,
502            signal_vtl0_started,
503            reformat_vmgs,
504            pid,
505            vmbus_max_version,
506            vmbus_enable_mnf,
507            vmbus_force_confidential_external_memory,
508            vmbus_channel_unstick_delay_ms: vmbus_channel_unstick_delay_ms.unwrap_or(100),
509            cmdline_append,
510            vnc_port: vnc_port.unwrap_or(3),
511            framebuffer_gpa_base,
512            gdbstub,
513            gdbstub_port: gdbstub_port.unwrap_or(4),
514            vtl0_starts_paused,
515            serial_wait_for_rts,
516            force_load_vtl0_image,
517            nvme_vfio,
518            hide_isolation,
519            halt_on_guest_halt,
520            no_sidecar_hotplug,
521            nvme_keep_alive,
522            mana_keep_alive,
523            nvme_always_flr,
524            test_configuration,
525            disable_uefi_frontpage,
526            default_boot_always_attempt,
527            guest_state_lifetime,
528            guest_state_encryption_policy,
529            strict_encryption_policy,
530            attempt_ak_cert_callback,
531            enable_vpci_relay,
532            disable_proxy_redirect,
533            disable_lower_vtl_timer_virt,
534            config_timeout_in_seconds,
535            servicing_timeout_dump_collection_in_ms,
536        })
537    }
538
539    fn parse_value_arg(
540        name: &str,
541        value: &str,
542        pid: &mut Option<PathBuf>,
543        vnc_port: &mut Option<u32>,
544    ) -> anyhow::Result<()> {
545        match name {
546            "--pid" => *pid = Some(value.into()),
547            "--vnc-port" => {
548                *vnc_port = Some(
549                    value
550                        .parse()
551                        .context(format!("Error parsing VNC port {}", value))?,
552                )
553            }
554            x => bail!("Unrecognized argument {}", x),
555        }
556
557        Ok(())
558    }
559}
underhill_core/options.rs

underhill_core/
options.rs
