Struct Options

pub struct Options {

    pub wait_for_start: bool,
    pub reformat_vmgs: bool,
    pub pid: Option<PathBuf>,
    pub vmbus_max_version: Option<u32>,
    pub vmbus_enable_mnf: Option<bool>,
    pub vmbus_force_confidential_external_memory: bool,
    pub cmdline_append: Option<String>,
    pub vnc_port: u32,
    pub gdbstub: bool,
    pub gdbstub_port: u32,
    pub vtl0_starts_paused: bool,
    pub framebuffer_gpa_base: Option<u64>,
    pub serial_wait_for_rts: bool,
    pub force_load_vtl0_image: Option<String>,
    pub nvme_vfio: bool,
    pub mcr: bool,
    pub enable_shared_visibility_pool: bool,
    pub cvm_guest_vsm: bool,
    pub hide_isolation: bool,
    pub halt_on_guest_halt: bool,
    pub no_sidecar_hotplug: bool,
    pub nvme_keep_alive: bool,
    pub test_configuration: Option<TestScenarioConfig>,
}

underhill core command-line and environment variable options.

Fields

wait_for_start: bool

(OPENHCL_WAIT_FOR_START=1 | –wait-for-start) wait for a diagnostics start request before initializing and starting the VM

reformat_vmgs: bool

(OPENHCL_REFORMAT_VMGS=1 | –reformat-vmgs) reformat the VMGS file on boot. useful for running potentially destructive VMGS tests.

pid: Option<PathBuf>

(OPENHCL_PID_FILE_PATH=/path/to/file | –pid /path/to/file) write the PID to the specified path

vmbus_max_version: Option<u32>

(OPENHCL_VMBUS_MAX_VERSION=<number>) limit the maximum protocol version allowed by vmbus; used for testing purposes

vmbus_enable_mnf: Option<bool>

(OPENHCL_VMBUS_ENABLE_MNF=1) Enable handling of MNF in the Underhill vmbus server, instead of the host.

vmbus_force_confidential_external_memory: bool

(OPENHCL_VMBUS_FORCE_CONFIDENTIAL_EXTERNAL_MEMORY=1) Force the use of confidential external memory for all non-relay vmbus channels. For testing purposes only.

N.B.: Not all vmbus devices support this feature, so enabling it may cause failures.

cmdline_append: Option<String>

(OPENHCL_CMDLINE_APPEND=<string>) Command line to append to VTL0, only used with direct boot.

vnc_port: u32

(OPENHCL_VNC_PORT=<number> | –vnc-port <number>) (default: 3) VNC (vsock) port number

gdbstub: bool

(OPENHCL_GDBSTUB=1) Enables the GDB stub for debugging the guest.

gdbstub_port: u32

(OPENHCL_GDBSTUB_PORT=<number>) (default: 4) GDB stub (vsock) port number.

vtl0_starts_paused: bool

(OPENHCL_VTL0_STARTS_PAUSED=1) Start with VTL0 paused

framebuffer_gpa_base: Option<u64>

(OPENHCL_FRAMEBUFFER_GPA_BASE=<number>) Base GPA of the fixed framebuffer mapping for underhill to read. If a value is provided, a graphics device is exposed.

serial_wait_for_rts: bool

(OPENHCL_SERIAL_WAIT_FOR_RTS=<bool>) Whether the emulated 16550 waits for guest DTR+RTS before pulling data from the host.

force_load_vtl0_image: Option<String>

(OPENHCL_FORCE_LOAD_VTL0_IMAGE=<string>) Force load the specified image in VTL0. The image must support the option specified.

Valid options are “pcat, uefi, linux”.

nvme_vfio: bool

(OPENHCL_NVME_VFIO=1) Use the user-mode VFIO NVMe driver instead of the Linux driver.

mcr: bool

(OPENHCL_MCR_DEVICE=1) MCR Device Enable

enable_shared_visibility_pool: bool

(OPENHCL_ENABLE_SHARED_VISIBILITY_POOL=1) Enable the shared visibility pool. This is enabled by default on hardware isolated platforms, but can be enabled for testing.

cvm_guest_vsm: bool

(OPENHCL_CVM_GUEST_VSM=1) Enable support for guest vsm in CVMs. This is disabled by default.

hide_isolation: bool

(OPENHCL_HIDE_ISOLATION=1) Hide the isolation mode from the guest.

halt_on_guest_halt: bool

(OPENHCL_HALT_ON_GUEST_HALT=1) When receiving a halt request from a lower VTL, halt underhill instead of forwarding the halt request to the host. This allows for debugging state without the partition state changing from the host.

no_sidecar_hotplug: bool

(OPENHCL_NO_SIDECAR_HOTPLUG=1) Leave sidecar VPs remote even if they hit exits.

nvme_keep_alive: bool

(OPENHCL_NVME_KEEP_ALIVE=1) Enable nvme keep alive when servicing.

test_configuration: Option<TestScenarioConfig>

(OPENHCL_TEST_CONFIG=<TestScenarioConfig>) Test configurations are designed to replicate specific behaviors and conditions in order to simulate various test scenarios.