1#![expect(missing_docs)]
8#![forbid(unsafe_code)]
9
10mod cli_args;
11mod crash_dump;
12mod kvp;
13mod meshworker;
14mod pidfile;
15mod repl;
16mod serial_io;
17mod storage_builder;
18mod tracing_init;
19mod ttrpc;
20mod vm_controller;
21
22pub use cli_args::Options;
25use console_relay::ConsoleLaunchOptions;
26
27use crate::cli_args::SecureBootTemplateCli;
28use anyhow::Context;
29use anyhow::bail;
30use chipset_resources::battery::HostBatteryUpdate;
31use cli_args::DiskCliKind;
32use cli_args::EfiDiagnosticsLogLevelCli;
33use cli_args::EndpointConfigCli;
34use cli_args::GuestPowerAction;
35use cli_args::NicConfigCli;
36use cli_args::ProvisionVmgs;
37use cli_args::SerialConfigCli;
38use cli_args::UefiConsoleModeCli;
39use cli_args::VirtioBusCli;
40use cli_args::VmgsCli;
41use crash_dump::spawn_dump_handler;
42use cxl_spec::test::CxlTestDeviceHandle;
43use disk_backend_resources::DelayDiskHandle;
44use disk_backend_resources::DiskLayerDescription;
45use disk_backend_resources::layer::DiskLayerHandle;
46use disk_backend_resources::layer::RamDiskLayerHandle;
47use disk_backend_resources::layer::SqliteAutoCacheDiskLayerHandle;
48use disk_backend_resources::layer::SqliteDiskLayerHandle;
49use floppy_resources::FloppyDiskConfig;
50use framebuffer::FRAMEBUFFER_SIZE;
51use framebuffer::FramebufferAccess;
52use futures::AsyncReadExt;
53use futures::AsyncWrite;
54use futures::StreamExt;
55use futures::executor::block_on;
56use futures::io::AllowStdIo;
57use gdma_resources::GdmaDeviceHandle;
58use gdma_resources::VportDefinition;
59use guid::Guid;
60use input_core::MultiplexedInputHandle;
61use inspect::InspectMut;
62use mesh::CancelContext;
63use mesh::CellUpdater;
64use mesh::rpc::RpcSend;
65use meshworker::VmmMesh;
66use net_backend_resources::mac_address::MacAddress;
67use nvme_resources::NvmeControllerRequest;
68use openvmm_defs::config::Config;
69use openvmm_defs::config::DEFAULT_PCAT_BOOT_ORDER;
70use openvmm_defs::config::DeviceVtl;
71use openvmm_defs::config::HypervisorConfig;
72use openvmm_defs::config::LateMapVtl0MemoryPolicy;
73use openvmm_defs::config::LoadMode;
74use openvmm_defs::config::MemoryConfig;
75use openvmm_defs::config::NumaDistance;
76use openvmm_defs::config::NumaNode;
77use openvmm_defs::config::NumaTopology;
78use openvmm_defs::config::PcieDeviceConfig;
79use openvmm_defs::config::PcieMmioRangeConfig;
80use openvmm_defs::config::PciePortConfig;
81use openvmm_defs::config::PcieRootComplexConfig;
82use openvmm_defs::config::PcieSwitchConfig;
83use openvmm_defs::config::ProcessorTopologyConfig;
84use openvmm_defs::config::RootComplexCxlConfig;
85use openvmm_defs::config::SerialInformation;
86use openvmm_defs::config::VirtioBus;
87use openvmm_defs::config::VmbusConfig;
88use openvmm_defs::config::VpAssignment;
89use openvmm_defs::config::VpciDeviceConfig;
90use openvmm_defs::config::Vtl2Config;
91use openvmm_defs::rpc::VmRpc;
92use openvmm_defs::worker::VM_WORKER;
93use openvmm_defs::worker::VmWorkerParameters;
94use openvmm_helpers::disk::OpenDiskOptions;
95use openvmm_helpers::disk::create_disk_type;
96use openvmm_helpers::disk::open_disk_type;
97use pal_async::DefaultDriver;
98use pal_async::DefaultPool;
99use pal_async::socket::PolledSocket;
100use pal_async::task::Spawn;
101use pal_async::task::Task;
102use serial_16550_resources::ComPort;
103use serial_core::resources::DisconnectedSerialBackendHandle;
104use sparse_mmap::alloc_shared_memory;
105use std::cell::RefCell;
106use std::collections::BTreeMap;
107use std::fmt::Write as _;
108use std::io;
109#[cfg(unix)]
110use std::io::IsTerminal;
111use std::io::Write;
112use std::net::TcpListener;
113use std::path::Path;
114use std::path::PathBuf;
115use std::sync::Arc;
116use std::thread;
117use std::time::Duration;
118use storvsp_resources::ScsiControllerRequest;
119use tpm_resources::TpmDeviceHandle;
120use tpm_resources::TpmRegisterLayout;
121use uidevices_resources::SynthKeyboardHandle;
122use uidevices_resources::SynthMouseHandle;
123use uidevices_resources::SynthVideoHandle;
124use video_core::SharedFramebufferHandle;
125use virtio_resources::VirtioPciDeviceHandle;
126use vm_manifest_builder::BaseChipsetType;
127use vm_manifest_builder::MachineArch;
128use vm_manifest_builder::VmChipsetResult;
129use vm_manifest_builder::VmManifestBuilder;
130use vm_resource::IntoResource;
131use vm_resource::Resource;
132use vm_resource::kind::DiskHandleKind;
133use vm_resource::kind::DiskLayerHandleKind;
134use vm_resource::kind::NetEndpointHandleKind;
135use vm_resource::kind::VirtioDeviceHandle;
136use vm_resource::kind::VmbusDeviceHandleKind;
137use vmbus_serial_resources::VmbusSerialDeviceHandle;
138use vmbus_serial_resources::VmbusSerialPort;
139use vmcore::non_volatile_store::resources::EphemeralNonVolatileStoreHandle;
140use vmgs_resources::GuestStateEncryptionPolicy;
141use vmgs_resources::VmgsDisk;
142use vmgs_resources::VmgsFileHandle;
143use vmgs_resources::VmgsResource;
144use vmotherboard::ChipsetDeviceHandle;
145use vnc_worker_defs::VncParameters;
146
147pub fn openvmm_main() {
148 #[cfg(unix)]
151 let orig_termios = io::stderr().is_terminal().then(term::get_termios);
152
153 let mut pidfile_guard: Option<pidfile::Pidfile> = None;
154 let exit_code = match do_main(&mut pidfile_guard) {
155 Ok(code) => code,
156 Err(err) => {
157 eprintln!("fatal error: {:?}", err);
158 1
159 }
160 };
161
162 #[cfg(unix)]
164 if let Some(orig_termios) = orig_termios {
165 term::set_termios(orig_termios);
166 }
167
168 drop(pidfile_guard);
171
172 let _ = io::stdout().flush();
178 pal::process::terminate(exit_code);
179}
180
181#[derive(Default)]
182struct VmResources {
183 console_in: Option<Box<dyn AsyncWrite + Send + Unpin>>,
184 serial_driver: Option<DefaultDriver>,
186 framebuffer_access: Option<FramebufferAccess>,
187 shutdown_ic: Option<mesh::Sender<hyperv_ic_resources::shutdown::ShutdownRpc>>,
188 kvp_ic: Option<mesh::Sender<hyperv_ic_resources::kvp::KvpConnectRpc>>,
189 scsi_rpc: Option<mesh::Sender<ScsiControllerRequest>>,
190 nvme_vtl2_rpc: Option<mesh::Sender<NvmeControllerRequest>>,
191 consomme_rpc: Option<mesh::Sender<net_backend_resources::consomme::ConsommeRequest>>,
192 ged_rpc: Option<mesh::Sender<get_resources::ged::GuestEmulationRequest>>,
193 vtl2_settings: Option<vtl2_settings_proto::Vtl2Settings>,
194 dirty_rect_recv: Option<mesh::Receiver<Vec<video_core::DirtyRect>>>,
196 #[cfg(windows)]
197 switch_ports: Vec<vmswitch::kernel::SwitchPort>,
198}
199
200struct ConsoleState<'a> {
201 device: &'a str,
202 input: Box<dyn AsyncWrite + Unpin + Send>,
203}
204
205fn build_switch_list(all_switches: &[cli_args::GenericPcieSwitchCli]) -> Vec<PcieSwitchConfig> {
210 all_switches
211 .iter()
212 .map(|switch_cli| PcieSwitchConfig {
213 name: switch_cli.name.clone(),
214 parent_port: switch_cli.port_name.clone(),
215 ports: (0..switch_cli.num_downstream_ports)
216 .map(|i| PciePortConfig {
217 name: format!("{}-downstream-{}", switch_cli.name, i),
218 devfn: None,
219 hotplug: switch_cli.hotplug,
220 acs_capabilities_supported: switch_cli.acs_capabilities_supported,
221 cxl: false,
222 pasid: switch_cli.pasid,
223 })
224 .collect(),
225 })
226 .collect()
227}
228
229async fn vm_config_from_command_line(
230 spawner: impl Spawn,
231 mesh: &VmmMesh,
232 opt: &Options,
233) -> anyhow::Result<(Config, VmResources)> {
234 let (_, serial_driver) = DefaultPool::spawn_on_thread("serial");
235
236 let openhcl_vtl = if opt.vtl2 {
237 DeviceVtl::Vtl2
238 } else {
239 DeviceVtl::Vtl0
240 };
241
242 let console_state: RefCell<Option<ConsoleState<'_>>> = RefCell::new(None);
243 let setup_serial = |name: &str, cli_cfg, device| -> anyhow::Result<_> {
244 Ok(match cli_cfg {
245 SerialConfigCli::Console => {
246 if let Some(console_state) = console_state.borrow().as_ref() {
247 bail!("console already set by {}", console_state.device);
248 }
249 let (config, serial) = serial_io::anonymous_serial_pair(&serial_driver)?;
250 let (serial_read, serial_write) = AsyncReadExt::split(serial);
251 *console_state.borrow_mut() = Some(ConsoleState {
252 device,
253 input: Box::new(serial_write),
254 });
255 thread::Builder::new()
256 .name(name.to_owned())
257 .spawn(move || {
258 let _ = block_on(futures::io::copy(
259 serial_read,
260 &mut AllowStdIo::new(term::raw_stdout()),
261 ));
262 })
263 .unwrap();
264 Some(config)
265 }
266 SerialConfigCli::Stderr => {
267 let (config, serial) = serial_io::anonymous_serial_pair(&serial_driver)?;
268 thread::Builder::new()
269 .name(name.to_owned())
270 .spawn(move || {
271 let _ = block_on(futures::io::copy(
272 serial,
273 &mut AllowStdIo::new(term::raw_stderr()),
274 ));
275 })
276 .unwrap();
277 Some(config)
278 }
279 SerialConfigCli::File(path) => {
280 let (config, serial) = serial_io::anonymous_serial_pair(&serial_driver)?;
281 let file = fs_err::File::create(path).context("failed to create file")?;
282
283 thread::Builder::new()
284 .name(name.to_owned())
285 .spawn(move || {
286 let _ = block_on(futures::io::copy(serial, &mut AllowStdIo::new(file)));
287 })
288 .unwrap();
289 Some(config)
290 }
291 SerialConfigCli::None => None,
292 SerialConfigCli::Pipe(path) => {
293 Some(serial_io::bind_serial(&path).context("failed to bind serial")?)
294 }
295 SerialConfigCli::Tcp(addr) => {
296 Some(serial_io::bind_tcp_serial(&addr).context("failed to bind serial")?)
297 }
298 SerialConfigCli::NewConsole(app, window_title) => {
299 let path = console_relay::random_console_path();
300 let config =
301 serial_io::bind_serial(&path).context("failed to bind console serial")?;
302 let window_title =
303 window_title.unwrap_or_else(|| name.to_uppercase() + " [OpenVMM]");
304
305 console_relay::launch_console(
306 app.or_else(openvmm_terminal_app).as_deref(),
307 &path,
308 ConsoleLaunchOptions {
309 window_title: Some(window_title),
310 },
311 )
312 .context("failed to launch console")?;
313
314 Some(config)
315 }
316 })
317 };
318
319 let mut vmbus_devices = Vec::new();
320
321 let com_debugger_mode = [
322 opt.com1.as_ref().is_some_and(|c| c.debugger_mode),
323 opt.com2.as_ref().is_some_and(|c| c.debugger_mode),
324 opt.com3.as_ref().is_some_and(|c| c.debugger_mode),
325 opt.com4.as_ref().is_some_and(|c| c.debugger_mode),
326 ];
327
328 let serial0_cfg = setup_serial(
329 "com1",
330 opt.com1
331 .clone()
332 .map_or(SerialConfigCli::Console, |c| c.backend),
333 if cfg!(guest_arch = "x86_64") {
334 "ttyS0"
335 } else {
336 "ttyAMA0"
337 },
338 )?;
339 let serial1_cfg = setup_serial(
340 "com2",
341 opt.com2
342 .clone()
343 .map_or(SerialConfigCli::None, |c| c.backend),
344 if cfg!(guest_arch = "x86_64") {
345 "ttyS1"
346 } else {
347 "ttyAMA1"
348 },
349 )?;
350 let serial2_cfg = setup_serial(
351 "com3",
352 opt.com3
353 .clone()
354 .map_or(SerialConfigCli::None, |c| c.backend),
355 if cfg!(guest_arch = "x86_64") {
356 "ttyS2"
357 } else {
358 "ttyAMA2"
359 },
360 )?;
361 let serial3_cfg = setup_serial(
362 "com4",
363 opt.com4
364 .clone()
365 .map_or(SerialConfigCli::None, |c| c.backend),
366 if cfg!(guest_arch = "x86_64") {
367 "ttyS3"
368 } else {
369 "ttyAMA3"
370 },
371 )?;
372 let with_vmbus_com1_serial = if let Some(vmbus_com1_cfg) = setup_serial(
373 "vmbus_com1",
374 opt.vmbus_com1_serial
375 .clone()
376 .unwrap_or(SerialConfigCli::None),
377 "vmbus_com1",
378 )? {
379 vmbus_devices.push((
380 openhcl_vtl,
381 VmbusSerialDeviceHandle {
382 port: VmbusSerialPort::Com1,
383 backend: vmbus_com1_cfg,
384 }
385 .into_resource(),
386 ));
387 true
388 } else {
389 false
390 };
391 let with_vmbus_com2_serial = if let Some(vmbus_com2_cfg) = setup_serial(
392 "vmbus_com2",
393 opt.vmbus_com2_serial
394 .clone()
395 .unwrap_or(SerialConfigCli::None),
396 "vmbus_com2",
397 )? {
398 vmbus_devices.push((
399 openhcl_vtl,
400 VmbusSerialDeviceHandle {
401 port: VmbusSerialPort::Com2,
402 backend: vmbus_com2_cfg,
403 }
404 .into_resource(),
405 ));
406 true
407 } else {
408 false
409 };
410 let debugcon_cfg = setup_serial(
411 "debugcon",
412 opt.debugcon
413 .clone()
414 .map(|cfg| cfg.serial)
415 .unwrap_or(SerialConfigCli::None),
416 "debugcon",
417 )?;
418
419 let virtio_console_backend = if let Some(serial_cfg) = opt.virtio_console.clone() {
420 setup_serial("virtio-console", serial_cfg, "hvc0")?
421 } else {
422 None
423 };
424
425 let mut resources = VmResources::default();
426 let mut console_str = "";
427 if let Some(ConsoleState { device, input }) = console_state.into_inner() {
428 resources.console_in = Some(input);
429 console_str = device;
430 }
431
432 if opt.shared_memory {
433 tracing::warn!("--shared-memory/-M flag has no effect and will be removed");
434 }
435 if opt.deprecated_prefetch {
436 tracing::warn!("--prefetch is deprecated; use --memory prefetch=on");
437 }
438 if opt.deprecated_private_memory {
439 tracing::warn!("--private-memory is deprecated; use --memory shared=off");
440 }
441 if opt.deprecated_thp {
442 tracing::warn!("--thp is deprecated; use --memory shared=off,thp=on");
443 }
444 if opt.deprecated_memory_backing_file.is_some() {
445 tracing::warn!("--memory-backing-file is deprecated; use --memory file=<path>");
446 }
447
448 opt.validate_memory_options()?;
449
450 const MAX_PROCESSOR_COUNT: u32 = 1024;
451
452 if opt.processors == 0 || opt.processors > MAX_PROCESSOR_COUNT {
453 bail!("invalid proc count: {}", opt.processors);
454 }
455
456 if opt.scsi_sub_channels > (MAX_PROCESSOR_COUNT - 1) as u16 {
459 bail!(
460 "invalid SCSI sub-channel count: requested {}, max {}",
461 opt.scsi_sub_channels,
462 MAX_PROCESSOR_COUNT - 1
463 );
464 }
465
466 let with_get = opt.get || (opt.vtl2 && !opt.no_get);
467
468 let mut storage = storage_builder::StorageBuilder::new(with_get.then_some(openhcl_vtl));
469
470 for ctrl in &opt.nvme_pci {
473 let transport = match &ctrl.transport {
474 cli_args::NvmeControllerTransport::Pcie(port) => {
475 storage_builder::NvmeControllerTransport::Pcie(port.clone())
476 }
477 cli_args::NvmeControllerTransport::Vpci(guid) => {
478 let guid = guid.unwrap_or_else(|| storage_builder::deterministic_guid(&ctrl.id));
479 storage_builder::NvmeControllerTransport::Vpci(guid)
480 }
481 };
482 storage.add_nvme_controller(ctrl.id.clone(), ctrl.vtl, transport, None)?;
483 }
484
485 for ctrl in &opt.vmbus_scsi {
486 let instance_id = storage_builder::deterministic_guid(&ctrl.id);
487 storage.add_scsi_controller(ctrl.id.clone(), ctrl.vtl, instance_id, ctrl.sub_channels)?;
488 }
489
490 for ctrl in &opt.openhcl_controller {
491 let controller_type = match ctrl.controller_type {
492 cli_args::OpenhclControllerType::Scsi => storage_builder::OpenhclControllerType::Scsi,
493 cli_args::OpenhclControllerType::Nvme => storage_builder::OpenhclControllerType::Nvme,
494 };
495 let instance_id = ctrl
496 .guid
497 .unwrap_or_else(|| storage_builder::deterministic_guid(&ctrl.id));
498 storage.add_openhcl_controller(ctrl.id.clone(), controller_type, instance_id)?;
499 }
500
501 for &cli_args::DiskCli {
502 vtl,
503 ref kind,
504 read_only,
505 is_dvd,
506 underhill,
507 ref pcie_port,
508 ref controller,
509 nsid,
510 lun,
511 ref relay,
512 } in &opt.disk
513 {
514 if controller.is_none() && underhill.is_none() && relay.is_none() {
515 tracing::warn!(
516 "--disk without `on` is deprecated; \
517 use --vmbus-scsi and --disk on=<name> instead"
518 );
519 }
520
521 let relay_target = relay
522 .as_ref()
523 .map(|(name, loc)| storage_builder::RelayTarget {
524 controller: name.clone(),
525 location: *loc,
526 });
527
528 let target = if let Some(name) = controller {
529 if pcie_port.is_some() {
530 anyhow::bail!("`on` is incompatible with `pcie_port` on `--disk`");
531 }
532 storage_builder::DiskLocation::Named {
533 controller: name.clone(),
534 nsid,
535 lun,
536 }
537 } else if pcie_port.is_some() {
538 anyhow::bail!("`--disk` is incompatible with `pcie_port` without `controller`");
539 } else {
540 if opt.no_vmbus {
541 anyhow::bail!(
542 "`--disk` without `on=` attaches to the default VMBus SCSI controller and \
543 cannot be used with `--no-vmbus`; use `on=<name>` to attach to a named controller"
544 );
545 }
546 storage_builder::DiskLocation::Scsi(None)
547 };
548
549 storage
550 .add(
551 vtl,
552 underhill,
553 relay_target,
554 target,
555 kind,
556 is_dvd,
557 read_only,
558 )
559 .await?;
560 }
561
562 for &cli_args::IdeDiskCli {
563 ref kind,
564 read_only,
565 channel,
566 device,
567 is_dvd,
568 } in &opt.ide
569 {
570 storage
571 .add(
572 DeviceVtl::Vtl0,
573 None,
574 None,
575 storage_builder::DiskLocation::Ide(channel, device),
576 kind,
577 is_dvd,
578 read_only,
579 )
580 .await?;
581 }
582
583 if !opt.nvme.is_empty() {
584 tracing::warn!("--nvme is deprecated; use --nvme-pci and --disk on=<name> instead");
585
586 let mut registered_ports = std::collections::BTreeSet::new();
588 for disk in &opt.nvme {
589 if let Some(port) = &disk.pcie_port {
590 if registered_ports.insert(port.clone()) {
591 storage.add_nvme_controller(
592 port.clone(),
593 DeviceVtl::Vtl0,
594 storage_builder::NvmeControllerTransport::Pcie(port.clone()),
595 None,
596 ).with_context(|| format!(
597 "legacy --nvme flag conflicts with an explicit controller named '{port}'; \
598 use --nvme-pci and --disk on=<name> instead"
599 ))?;
600 }
601 }
602 }
603 }
604
605 for &cli_args::DiskCli {
606 vtl,
607 ref kind,
608 read_only,
609 is_dvd,
610 underhill,
611 ref pcie_port,
612 controller: _,
613 nsid: _,
614 lun: _,
615 relay: _,
616 } in &opt.nvme
617 {
618 let target = if let Some(port) = pcie_port {
619 storage_builder::DiskLocation::Named {
620 controller: port.clone(),
621 nsid: None,
622 lun: None,
623 }
624 } else {
625 storage_builder::DiskLocation::Nvme(None)
626 };
627 storage
628 .add(vtl, underhill, None, target, kind, is_dvd, read_only)
629 .await?;
630 }
631
632 for &cli_args::DiskCli {
633 vtl,
634 ref kind,
635 read_only,
636 is_dvd,
637 ref underhill,
638 ref pcie_port,
639 controller: _,
640 nsid: _,
641 lun: _,
642 relay: _,
643 } in &opt.virtio_blk
644 {
645 if underhill.is_some() {
646 anyhow::bail!("underhill not supported with virtio-blk");
647 }
648 storage
649 .add(
650 vtl,
651 None,
652 None,
653 storage_builder::DiskLocation::VirtioBlk(pcie_port.clone()),
654 kind,
655 is_dvd,
656 read_only,
657 )
658 .await?;
659 }
660
661 let mut floppy_disks = Vec::new();
662 for disk in &opt.floppy {
663 let &cli_args::FloppyDiskCli {
664 ref kind,
665 read_only,
666 } = disk;
667 floppy_disks.push(FloppyDiskConfig {
668 disk_type: disk_open(kind, read_only).await?,
669 read_only,
670 });
671 }
672
673 let mut vpci_mana_nics = [(); 3].map(|()| None);
674 let mut pcie_mana_nics = BTreeMap::<String, GdmaDeviceHandle>::new();
675 let mut underhill_nics = Vec::new();
676 let mut vpci_devices = Vec::new();
677
678 let mut nic_index = 0;
679 for cli_cfg in &opt.net {
680 if cli_cfg.pcie_port.is_some() {
681 anyhow::bail!("`--net` does not support PCIe");
682 }
683 let vport = parse_endpoint(cli_cfg, &mut nic_index, &mut resources)?;
684 if cli_cfg.underhill {
685 if !opt.no_alias_map {
686 anyhow::bail!("must specify --no-alias-map to offer NICs to VTL2");
687 }
688 let mana = vpci_mana_nics[openhcl_vtl as usize].get_or_insert_with(|| {
689 let vpci_instance_id = Guid::new_random();
690 underhill_nics.push(vtl2_settings_proto::NicDeviceLegacy {
691 instance_id: vpci_instance_id.to_string(),
692 subordinate_instance_id: None,
693 max_sub_channels: None,
694 });
695 (vpci_instance_id, GdmaDeviceHandle { vports: Vec::new() })
696 });
697 mana.1.vports.push(VportDefinition {
698 mac_address: vport.mac_address,
699 endpoint: vport.endpoint,
700 });
701 } else {
702 vmbus_devices.push(vport.into_netvsp_handle());
703 }
704 }
705
706 if opt.nic {
707 let nic_config = parse_endpoint(
708 &NicConfigCli {
709 vtl: DeviceVtl::Vtl0,
710 endpoint: EndpointConfigCli::Consomme {
711 cidr: None,
712 host_fwd: Vec::new(),
713 },
714 max_queues: None,
715 underhill: false,
716 pcie_port: None,
717 },
718 &mut nic_index,
719 &mut resources,
720 )?;
721 vmbus_devices.push(nic_config.into_netvsp_handle());
722 }
723
724 let mut pcie_devices = Vec::new();
727 for (index, cli_cfg) in opt.pcie_remote.iter().enumerate() {
728 tracing::info!(
729 port_name = %cli_cfg.port_name,
730 socket_addr = ?cli_cfg.socket_addr,
731 "instantiating PCIe remote device"
732 );
733
734 const PCIE_REMOTE_BASE_INSTANCE_ID: Guid =
736 guid::guid!("28ed784d-c059-429f-9d9a-46bea02562c0");
737 let instance_id = Guid {
738 data1: index as u32,
739 ..PCIE_REMOTE_BASE_INSTANCE_ID
740 };
741
742 pcie_devices.push(PcieDeviceConfig {
743 port_name: cli_cfg.port_name.clone(),
744 resource: pcie_remote_resources::PcieRemoteHandle {
745 instance_id,
746 socket_addr: cli_cfg.socket_addr.clone(),
747 hu: cli_cfg.hu,
748 controller: cli_cfg.controller,
749 }
750 .into_resource(),
751 });
752 }
753
754 #[cfg(windows)]
755 let mut kernel_vmnics = Vec::new();
756 #[cfg(windows)]
757 for (index, switch_id) in opt.kernel_vmnic.iter().enumerate() {
758 let mut mac_address = [0x00, 0x15, 0x5D, 0, 0, 0];
760 getrandom::fill(&mut mac_address[3..]).expect("rng failure");
761
762 const BASE_INSTANCE_ID: Guid = guid::guid!("00000000-435d-11ee-9f59-00155d5016fc");
764 let instance_id = Guid {
765 data1: index as u32,
766 ..BASE_INSTANCE_ID
767 };
768
769 let switch_id = if switch_id == "default" {
770 None
771 } else {
772 Some(switch_id.as_str())
773 };
774 let (port_id, port) = new_switch_port(switch_id)?;
775 resources.switch_ports.push(port);
776
777 kernel_vmnics.push(openvmm_defs::config::KernelVmNicConfig {
778 instance_id,
779 mac_address: mac_address.into(),
780 switch_port_id: port_id,
781 });
782 }
783
784 for vport in &opt.mana {
785 let vport = parse_endpoint(vport, &mut nic_index, &mut resources)?;
786 let vport_array = match (vport.vtl as usize, vport.pcie_port) {
787 (vtl, None) => {
788 &mut vpci_mana_nics[vtl]
789 .get_or_insert_with(|| {
790 (Guid::new_random(), GdmaDeviceHandle { vports: Vec::new() })
791 })
792 .1
793 .vports
794 }
795 (0, Some(pcie_port)) => {
796 &mut pcie_mana_nics
797 .entry(pcie_port)
798 .or_insert(GdmaDeviceHandle { vports: Vec::new() })
799 .vports
800 }
801 _ => anyhow::bail!("PCIe NICs only supported to VTL0"),
802 };
803 vport_array.push(VportDefinition {
804 mac_address: vport.mac_address,
805 endpoint: vport.endpoint,
806 });
807 }
808
809 vpci_devices.extend(
810 vpci_mana_nics
811 .into_iter()
812 .enumerate()
813 .filter_map(|(vtl, nic)| {
814 nic.map(|(instance_id, handle)| VpciDeviceConfig {
815 vtl: match vtl {
816 0 => DeviceVtl::Vtl0,
817 1 => DeviceVtl::Vtl1,
818 2 => DeviceVtl::Vtl2,
819 _ => unreachable!(),
820 },
821 instance_id,
822 resource: handle.into_resource(),
823 vnode: None,
824 })
825 }),
826 );
827
828 pcie_devices.extend(
829 pcie_mana_nics
830 .into_iter()
831 .map(|(pcie_port, handle)| PcieDeviceConfig {
832 port_name: pcie_port,
833 resource: handle.into_resource(),
834 }),
835 );
836
837 for cxl_test in &opt.cxl_test {
838 pcie_devices.push(PcieDeviceConfig {
839 port_name: cxl_test.pcie_port.clone(),
840 resource: CxlTestDeviceHandle {
841 hdm_size_bytes: cxl_test.hdm_size,
842 }
843 .into_resource(),
844 });
845 }
846
847 #[cfg(guest_arch = "aarch64")]
848 let arch = MachineArch::Aarch64;
849 #[cfg(guest_arch = "x86_64")]
850 let arch = MachineArch::X86_64;
851
852 #[cfg(guest_arch = "x86_64")]
853 anyhow::ensure!(
854 opt.amd_iommu.is_empty() || opt.intel_vtd.is_empty(),
855 "--amd-iommu and --intel-vtd cannot both be used in the same VM"
856 );
857
858 #[cfg(guest_arch = "x86_64")]
859 let mut amd_iommu_names: std::collections::HashSet<&str> =
860 opt.amd_iommu.iter().map(|s| s.as_str()).collect();
861 #[cfg(guest_arch = "x86_64")]
862 let mut vtd_names: std::collections::HashSet<&str> =
863 opt.intel_vtd.iter().map(|s| s.as_str()).collect();
864
865 #[cfg(guest_arch = "aarch64")]
869 let mut smmu_names: std::collections::HashMap<&str, &cli_args::SmmuCli> = {
870 let mut map = std::collections::HashMap::new();
871 for s in &opt.smmu {
872 if map.insert(s.rc_name.as_str(), s).is_some() {
873 anyhow::bail!(
874 "--smmu specified multiple times for root complex '{}'",
875 s.rc_name
876 );
877 }
878 }
879 map
880 };
881
882 let mut pcie_root_complexes = Vec::new();
883 for (i, rc_cli) in opt.pcie_root_complex.iter().enumerate() {
884 let ports: Vec<PciePortConfig> = opt
885 .pcie_root_port
886 .iter()
887 .filter(|port_cli| port_cli.root_complex_name == rc_cli.name)
888 .map(|port_cli| PciePortConfig {
889 name: port_cli.name.clone(),
890 devfn: port_cli.devfn,
891 hotplug: port_cli.hotplug,
892 acs_capabilities_supported: port_cli.acs_capabilities_supported,
893 cxl: port_cli.cxl,
894 pasid: port_cli.pasid,
895 })
896 .collect();
897
898 const ONE_MB: u64 = 1024 * 1024;
899 let low_mmio_size = (rc_cli.low_mmio as u64).next_multiple_of(ONE_MB);
901 let high_mmio_size = rc_cli
902 .high_mmio
903 .checked_next_multiple_of(ONE_MB)
904 .context("high mmio rounding error")?;
905
906 let cxl_port_count = ports.iter().filter(|port| port.cxl).count() as u64;
908
909 let cxl = if cxl_port_count != 0 {
910 Some(RootComplexCxlConfig {
911 hdm_size: rc_cli.hdm,
912 hdm_window_restrictions: rc_cli.hdm_window_restrictions.bits(),
913 })
914 } else {
915 None
916 };
917 pcie_root_complexes.push(PcieRootComplexConfig {
918 index: i as u32,
919 name: rc_cli.name.clone(),
920 segment: rc_cli.segment,
921 start_bus: rc_cli.start_bus,
922 end_bus: rc_cli.end_bus,
923 low_mmio: if let Some(base) = rc_cli.low_mmio_base {
924 PcieMmioRangeConfig::Fixed(
925 memory_range::MemoryRange::try_new(base..base.wrapping_add(low_mmio_size))
926 .context("invalid low MMIO range")?,
927 )
928 } else {
929 PcieMmioRangeConfig::Dynamic {
930 size: low_mmio_size,
931 }
932 },
933 high_mmio: if let Some(base) = rc_cli.high_mmio_base {
934 PcieMmioRangeConfig::Fixed(
935 memory_range::MemoryRange::try_new(base..base.wrapping_add(high_mmio_size))
936 .context("invalid high MMIO range")?,
937 )
938 } else {
939 PcieMmioRangeConfig::Dynamic {
940 size: high_mmio_size,
941 }
942 },
943 cxl,
944 ports,
945 #[cfg(guest_arch = "aarch64")]
946 iommu: smmu_names.remove(rc_cli.name.as_str()).map(|s| {
947 openvmm_defs::config::PcieIommuConfig::Smmu {
948 accel: s.accel,
949 oas: match s.oas {
950 cli_args::SmmuOasCli::Auto => openvmm_defs::config::SmmuOas::Auto,
951 cli_args::SmmuOasCli::Fixed(bits) => {
952 openvmm_defs::config::SmmuOas::Fixed(bits)
953 }
954 },
955 }
956 }),
957 #[cfg(guest_arch = "x86_64")]
958 iommu: if amd_iommu_names.remove(rc_cli.name.as_str()) {
959 Some(openvmm_defs::config::PcieIommuConfig::AmdVi)
960 } else if vtd_names.remove(rc_cli.name.as_str()) {
961 Some(openvmm_defs::config::PcieIommuConfig::IntelVtd)
962 } else {
963 None
964 },
965 vnode: rc_cli.vnode,
966 preserve_bars: rc_cli.preserve_bars,
967 });
968 }
969
970 #[cfg(guest_arch = "aarch64")]
971 if let Some(name) = smmu_names.into_keys().next() {
972 anyhow::bail!("--smmu refers to unknown root complex '{name}'");
973 }
974 #[cfg(guest_arch = "x86_64")]
975 if let Some(name) = amd_iommu_names.into_iter().next() {
976 anyhow::bail!("--amd-iommu refers to unknown root complex '{name}'");
977 }
978 #[cfg(guest_arch = "x86_64")]
979 if let Some(name) = vtd_names.into_iter().next() {
980 anyhow::bail!("--intel-vtd refers to unknown root complex '{name}'");
981 }
982
983 let pcie_switches = build_switch_list(&opt.pcie_switch);
984 let pcie_generic_initiators = opt
985 .pcie_generic_initiator
986 .iter()
987 .map(|gi| openvmm_defs::config::PcieGenericInitiatorConfig {
988 port_name: gi.port_name.clone(),
989 node: gi.node,
990 })
991 .collect();
992 #[cfg(target_os = "linux")]
993 let vfio_pcie_devices: Vec<PcieDeviceConfig> = {
994 use std::collections::HashMap;
995 use vm_resource::IntoResource;
996
997 let mut iommu_map: HashMap<String, std::fs::File> = HashMap::new();
999 for iommu_cli in &opt.iommu {
1000 anyhow::ensure!(
1001 !iommu_map.contains_key(&iommu_cli.id),
1002 "duplicate --iommu id={}",
1003 iommu_cli.id
1004 );
1005 let file = std::fs::OpenOptions::new()
1006 .read(true)
1007 .write(true)
1008 .open("/dev/iommu")
1009 .context("failed to open /dev/iommu (is iommufd available?)")?;
1010 iommu_map.insert(iommu_cli.id.clone(), file);
1011 }
1012
1013 opt.vfio
1014 .iter()
1015 .map(|cli_cfg| {
1016 let sysfs_path = Path::new("/sys/bus/pci/devices").join(&cli_cfg.pci_id);
1017
1018 if let Some(iommu_id) = &cli_cfg.iommu {
1019 let iommufd = iommu_map.get(iommu_id).with_context(|| {
1021 format!(
1022 "--vfio device {} references iommu={iommu_id}, \
1023 but no --iommu id={iommu_id} was specified",
1024 cli_cfg.pci_id
1025 )
1026 })?;
1027 let iommufd = iommufd.try_clone().with_context(|| {
1032 format!("failed to dup iommufd fd for iommu={iommu_id}")
1033 })?;
1034
1035 let vfio_dev_dir = sysfs_path.join("vfio-dev");
1037 let entry = std::fs::read_dir(&vfio_dev_dir)
1038 .with_context(|| {
1039 format!(
1040 "failed to read {}: is {} bound to vfio-pci?",
1041 vfio_dev_dir.display(),
1042 cli_cfg.pci_id
1043 )
1044 })?
1045 .next()
1046 .context("no vfio-dev entry found")?
1047 .context("failed to read vfio-dev entry")?;
1048 let dev_path = Path::new("/dev/vfio/devices").join(entry.file_name());
1049 let cdev = std::fs::OpenOptions::new()
1050 .read(true)
1051 .write(true)
1052 .open(&dev_path)
1053 .with_context(|| format!("failed to open {}", dev_path.display()))?;
1054
1055 Ok(PcieDeviceConfig {
1056 port_name: cli_cfg.port_name.clone(),
1057 resource: vfio_assigned_device_resources::VfioCdevDeviceHandle {
1058 pci_id: cli_cfg.pci_id.clone(),
1059 cdev,
1060 iommufd,
1061 iommu_id: iommu_id.clone(),
1062 bar_pt: cli_cfg.bar_pt,
1063 }
1064 .into_resource(),
1065 })
1066 } else {
1067 let iommu_group_link = std::fs::read_link(sysfs_path.join("iommu_group"))
1069 .with_context(|| {
1070 format!("failed to read IOMMU group for {}", cli_cfg.pci_id)
1071 })?;
1072 let group_id: u64 = iommu_group_link
1073 .file_name()
1074 .and_then(|s| s.to_str())
1075 .context("invalid iommu_group symlink")?
1076 .parse()
1077 .context("failed to parse IOMMU group ID")?;
1078 let group = std::fs::OpenOptions::new()
1079 .read(true)
1080 .write(true)
1081 .open(format!("/dev/vfio/{group_id}"))
1082 .with_context(|| format!("failed to open /dev/vfio/{group_id}"))?;
1083
1084 Ok(PcieDeviceConfig {
1085 port_name: cli_cfg.port_name.clone(),
1086 resource: vfio_assigned_device_resources::VfioDeviceHandle {
1087 pci_id: cli_cfg.pci_id.clone(),
1088 group,
1089 bar_pt: cli_cfg.bar_pt,
1090 }
1091 .into_resource(),
1092 })
1093 }
1094 })
1095 .collect::<anyhow::Result<Vec<_>>>()?
1096 };
1097
1098 #[cfg(windows)]
1099 let vpci_resources: Vec<_> = opt
1100 .device
1101 .iter()
1102 .map(|path| -> anyhow::Result<_> {
1103 Ok(virt_whp::device::DeviceHandle(
1104 whp::VpciResource::new(
1105 None,
1106 Default::default(),
1107 &whp::VpciResourceDescriptor::Sriov(path, 0, 0),
1108 )
1109 .with_context(|| format!("opening PCI device {}", path))?,
1110 ))
1111 })
1112 .collect::<Result<_, _>>()?;
1113
1114 #[cfg(windows)]
1116 let vmbusproxy_handle = if !kernel_vmnics.is_empty() {
1117 Some(vmbus_proxy::ProxyHandle::new().context("failed to open vmbusproxy handle")?)
1118 } else {
1119 None
1120 };
1121
1122 let framebuffer = if opt.gfx || opt.vtl2_gfx || opt.vnc.vnc || opt.pcat {
1123 let vram = alloc_shared_memory(FRAMEBUFFER_SIZE, "vram")?;
1124 let (fb, fba) =
1125 framebuffer::framebuffer(vram, FRAMEBUFFER_SIZE, 0).context("creating framebuffer")?;
1126 resources.framebuffer_access = Some(fba);
1127 Some(fb)
1128 } else {
1129 None
1130 };
1131
1132 let load_mode;
1133 let with_hv;
1134
1135 let any_serial_configured = serial0_cfg.is_some()
1136 || serial1_cfg.is_some()
1137 || serial2_cfg.is_some()
1138 || serial3_cfg.is_some();
1139
1140 let has_com3 = serial2_cfg.is_some();
1141
1142 let mut chipset = VmManifestBuilder::new(
1143 if opt.igvm.is_some() {
1144 BaseChipsetType::HclHost
1145 } else if opt.pcat {
1146 BaseChipsetType::HypervGen1
1147 } else if opt.uefi {
1148 BaseChipsetType::HypervGen2Uefi
1149 } else if opt.hv {
1150 BaseChipsetType::HyperVGen2LinuxDirect
1151 } else {
1152 BaseChipsetType::UnenlightenedLinuxDirect
1153 },
1154 arch,
1155 );
1156
1157 if framebuffer.is_some() {
1158 chipset = chipset.with_framebuffer();
1159 }
1160 if opt.guest_watchdog {
1161 chipset = chipset.with_guest_watchdog();
1162 }
1163 if any_serial_configured {
1164 chipset = chipset.with_serial([serial0_cfg, serial1_cfg, serial2_cfg, serial3_cfg]);
1165 }
1166 chipset = chipset.with_serial_debugger_mode(com_debugger_mode);
1167 if opt.battery {
1168 let (tx, rx) = mesh::channel();
1169 tx.send(HostBatteryUpdate::default_present());
1170 chipset = chipset.with_battery(rx);
1171 }
1172 if opt.no_vmbus {
1173 chipset = chipset.without_vmbus();
1174 }
1175 if let Some(cfg) = &opt.debugcon {
1176 chipset = chipset.with_debugcon(
1177 debugcon_cfg.unwrap_or_else(|| DisconnectedSerialBackendHandle.into_resource()),
1178 cfg.port,
1179 );
1180 }
1181
1182 let custom_uefi_vars = {
1183 use firmware_uefi_custom_vars::CustomVars;
1184
1185 let base_vars = match opt.secure_boot_template {
1188 Some(template) => match (arch, template) {
1189 (MachineArch::X86_64, SecureBootTemplateCli::Windows) => {
1190 hyperv_secure_boot_templates::x64::microsoft_windows()
1191 }
1192 (MachineArch::X86_64, SecureBootTemplateCli::UefiCa) => {
1193 hyperv_secure_boot_templates::x64::microsoft_uefi_ca()
1194 }
1195 (MachineArch::Aarch64, SecureBootTemplateCli::Windows) => {
1196 hyperv_secure_boot_templates::aarch64::microsoft_windows()
1197 }
1198 (MachineArch::Aarch64, SecureBootTemplateCli::UefiCa) => {
1199 hyperv_secure_boot_templates::aarch64::microsoft_uefi_ca()
1200 }
1201 },
1202 None => CustomVars::default(),
1203 };
1204
1205 let custom_uefi_json_data = match &opt.custom_uefi_json {
1208 Some(file) => Some(fs_err::read(file).context("opening custom uefi json file")?),
1209 None => None,
1210 };
1211
1212 match custom_uefi_json_data {
1214 Some(data) => {
1215 let delta = hyperv_uefi_custom_vars_json::load_delta_from_json(&data)?;
1216 base_vars.apply_delta(delta)?
1217 }
1218 None => base_vars,
1219 }
1220 };
1221
1222 if opt.uefi {
1223 let log_level = match opt.efi_diagnostics_log_level.unwrap_or_default() {
1224 EfiDiagnosticsLogLevelCli::Default => firmware_uefi_resources::LogLevel::make_default(),
1225 EfiDiagnosticsLogLevelCli::Info => firmware_uefi_resources::LogLevel::make_info(),
1226 EfiDiagnosticsLogLevelCli::Full => firmware_uefi_resources::LogLevel::make_full(),
1227 };
1228 let nvram_storage = if opt.vmgs.is_some() {
1229 VmgsFileHandle::new(vmgs_format::FileId::BIOS_NVRAM, true).into_resource()
1230 } else {
1231 EphemeralNonVolatileStoreHandle.into_resource()
1232 };
1233 chipset = chipset.with_uefi(vm_manifest_builder::UefiManifest::new(
1234 arch,
1235 custom_uefi_vars,
1236 opt.secure_boot,
1237 log_level,
1238 None,
1239 nvram_storage,
1240 None,
1241 ));
1242 }
1243
1244 let bios_guid = Guid::new_random();
1246
1247 let layout_config = chipset.layout_config();
1248 let VmChipsetResult {
1249 chipset,
1250 mut chipset_devices,
1251 pci_chipset_devices,
1252 isa_dma_controller,
1253 capabilities,
1254 } = chipset
1255 .build()
1256 .context("failed to build chipset configuration")?;
1257
1258 if opt.restore_snapshot.is_some() {
1259 load_mode = LoadMode::None;
1262 with_hv = true;
1263 } else if let Some(path) = &opt.igvm {
1264 let file = fs_err::File::open(path)
1265 .context("failed to open igvm file")?
1266 .into();
1267 let cmdline = opt.cmdline.join(" ");
1268 with_hv = true;
1269
1270 load_mode = LoadMode::Igvm {
1271 file,
1272 cmdline,
1273 vtl2_base_address: opt.igvm_vtl2_relocation_type,
1274 com_serial: has_com3.then(|| SerialInformation {
1275 io_port: ComPort::Com3.io_port(),
1276 irq: ComPort::Com3.irq().into(),
1277 }),
1278 };
1279 } else if opt.pcat {
1280 if arch != MachineArch::X86_64 {
1282 anyhow::bail!("pcat not supported on this architecture");
1283 }
1284 with_hv = true;
1285
1286 let firmware = openvmm_pcat_locator::find_pcat_bios(opt.pcat_firmware.as_deref())?;
1287 load_mode = LoadMode::Pcat {
1288 firmware,
1289 boot_order: opt
1290 .pcat_boot_order
1291 .map(|x| x.0)
1292 .unwrap_or(DEFAULT_PCAT_BOOT_ORDER),
1293 };
1294 } else if opt.uefi {
1295 use openvmm_defs::config::UefiConsoleMode;
1296
1297 with_hv = true;
1298
1299 let firmware = fs_err::File::open(
1300 (opt.uefi_firmware.0)
1301 .as_ref()
1302 .context("must provide uefi firmware when booting with uefi")?,
1303 )
1304 .context("failed to open uefi firmware")?;
1305
1306 load_mode = LoadMode::Uefi {
1309 firmware: firmware.into(),
1310 enable_debugging: opt.uefi_debug,
1311 enable_memory_protections: opt.uefi_enable_memory_protections,
1312 disable_frontpage: opt.disable_frontpage,
1313 enable_tpm: opt.tpm,
1314 enable_battery: opt.battery,
1315 enable_serial: any_serial_configured,
1316 enable_vpci_boot: false,
1317 uefi_console_mode: opt.uefi_console_mode.map(|m| match m {
1318 UefiConsoleModeCli::Default => UefiConsoleMode::Default,
1319 UefiConsoleModeCli::Com1 => UefiConsoleMode::Com1,
1320 UefiConsoleModeCli::Com2 => UefiConsoleMode::Com2,
1321 UefiConsoleModeCli::None => UefiConsoleMode::None,
1322 }),
1323 default_boot_always_attempt: opt.default_boot_always_attempt,
1324 bios_guid,
1325 enable_vmbus: !opt.no_vmbus,
1326 force_dma_bounce: opt.uefi_force_dma_bounce,
1327 };
1328 } else {
1329 let mut cmdline = "panic=-1 debug".to_string();
1331
1332 with_hv = opt.hv;
1333 if with_hv && opt.pcie_root_complex.is_empty() {
1334 cmdline += " pci=off";
1335 }
1336
1337 if !console_str.is_empty() {
1338 let _ = write!(&mut cmdline, " console={}", console_str);
1339 }
1340
1341 if opt.gfx {
1342 cmdline += " console=tty";
1343 }
1344 for extra in &opt.cmdline {
1345 let _ = write!(&mut cmdline, " {}", extra);
1346 }
1347
1348 let kernel = fs_err::File::open(
1349 (opt.kernel.0)
1350 .as_ref()
1351 .context("must provide kernel when booting with linux direct")?,
1352 )
1353 .context("failed to open kernel")?;
1354 let initrd = (opt.initrd.0)
1355 .as_ref()
1356 .map(fs_err::File::open)
1357 .transpose()
1358 .context("failed to open initrd")?;
1359
1360 load_mode = LoadMode::Linux {
1361 kernel: kernel.into(),
1362 initrd: initrd.map(Into::into),
1363 cmdline,
1364 enable_serial: any_serial_configured,
1365 boot_mode: if opt.device_tree {
1366 openvmm_defs::config::LinuxDirectBootMode::DeviceTree
1367 } else {
1368 openvmm_defs::config::LinuxDirectBootMode::Acpi
1369 },
1370 };
1371 }
1372
1373 let mut vmgs = Some(if let Some(VmgsCli { kind, provision }) = &opt.vmgs {
1374 let disk = VmgsDisk {
1375 disk: disk_open(kind, false)
1376 .await
1377 .context("failed to open vmgs disk")?,
1378 encryption_policy: if opt.test_gsp_by_id {
1379 GuestStateEncryptionPolicy::GspById(true)
1380 } else {
1381 GuestStateEncryptionPolicy::None(true)
1382 },
1383 };
1384 match provision {
1385 ProvisionVmgs::OnEmpty => VmgsResource::Disk(disk),
1386 ProvisionVmgs::OnFailure => VmgsResource::ReprovisionOnFailure(disk),
1387 ProvisionVmgs::True => VmgsResource::Reprovision(disk),
1388 }
1389 } else {
1390 VmgsResource::Ephemeral
1391 });
1392
1393 if with_get && with_hv {
1394 let has_vtl0_nvme = storage.has_vtl0_nvme();
1395 let vtl2_settings = vtl2_settings_proto::Vtl2Settings {
1396 version: vtl2_settings_proto::vtl2_settings_base::Version::V1.into(),
1397 fixed: Some(Default::default()),
1398 dynamic: Some(vtl2_settings_proto::Vtl2SettingsDynamic {
1399 storage_controllers: storage.build_openhcl_settings(opt.vmbus_redirect),
1400 nic_devices: underhill_nics,
1401 }),
1402 namespace_settings: Vec::default(),
1403 };
1404
1405 resources.vtl2_settings = Some(vtl2_settings.clone());
1407
1408 let (send, guest_request_recv) = mesh::channel();
1409 resources.ged_rpc = Some(send);
1410
1411 let vmgs = vmgs.take().unwrap();
1412
1413 vmbus_devices.extend([
1414 (
1415 openhcl_vtl,
1416 get_resources::gel::GuestEmulationLogHandle.into_resource(),
1417 ),
1418 (
1419 openhcl_vtl,
1420 get_resources::ged::GuestEmulationDeviceHandle {
1421 firmware: if opt.pcat {
1422 get_resources::ged::GuestFirmwareConfig::Pcat {
1423 boot_order: opt
1424 .pcat_boot_order
1425 .map_or(DEFAULT_PCAT_BOOT_ORDER, |x| x.0)
1426 .map(|x| match x {
1427 openvmm_defs::config::PcatBootDevice::Floppy => {
1428 get_resources::ged::PcatBootDevice::Floppy
1429 }
1430 openvmm_defs::config::PcatBootDevice::HardDrive => {
1431 get_resources::ged::PcatBootDevice::HardDrive
1432 }
1433 openvmm_defs::config::PcatBootDevice::Optical => {
1434 get_resources::ged::PcatBootDevice::Optical
1435 }
1436 openvmm_defs::config::PcatBootDevice::Network => {
1437 get_resources::ged::PcatBootDevice::Network
1438 }
1439 }),
1440 }
1441 } else {
1442 use get_resources::ged::UefiConsoleMode;
1443
1444 get_resources::ged::GuestFirmwareConfig::Uefi {
1445 enable_vpci_boot: has_vtl0_nvme,
1446 firmware_debug: opt.uefi_debug,
1447 disable_frontpage: opt.disable_frontpage,
1448 console_mode: match opt.uefi_console_mode.unwrap_or(UefiConsoleModeCli::Default) {
1449 UefiConsoleModeCli::Default => UefiConsoleMode::Default,
1450 UefiConsoleModeCli::Com1 => UefiConsoleMode::COM1,
1451 UefiConsoleModeCli::Com2 => UefiConsoleMode::COM2,
1452 UefiConsoleModeCli::None => UefiConsoleMode::None,
1453 },
1454 default_boot_always_attempt: opt.default_boot_always_attempt,
1455 }
1456 },
1457 com1: with_vmbus_com1_serial,
1458 com2: with_vmbus_com2_serial,
1459 serial_tx_only: opt.serial_tx_only,
1460 vtl2_settings: Some(prost::Message::encode_to_vec(&vtl2_settings)),
1461 vmbus_redirection: opt.vmbus_redirect,
1462 vmgs,
1463 framebuffer: opt
1464 .vtl2_gfx
1465 .then(|| SharedFramebufferHandle.into_resource()),
1466 guest_request_recv,
1467 enable_tpm: opt.tpm,
1468 firmware_event_send: None,
1469 secure_boot_enabled: opt.secure_boot,
1470 secure_boot_template: match opt.secure_boot_template {
1471 Some(SecureBootTemplateCli::Windows) => {
1472 get_resources::ged::GuestSecureBootTemplateType::MicrosoftWindows
1473 },
1474 Some(SecureBootTemplateCli::UefiCa) => {
1475 get_resources::ged::GuestSecureBootTemplateType::MicrosoftUefiCertificateAuthority
1476 }
1477 None => {
1478 get_resources::ged::GuestSecureBootTemplateType::None
1479 },
1480 },
1481 enable_battery: opt.battery,
1482 no_persistent_secrets: true,
1483 igvm_attest_test_config: None,
1484 test_gsp_by_id: opt.test_gsp_by_id,
1485 efi_diagnostics_log_level: {
1486 match opt.efi_diagnostics_log_level.unwrap_or_default() {
1487 EfiDiagnosticsLogLevelCli::Default => get_resources::ged::EfiDiagnosticsLogLevelType::Default,
1488 EfiDiagnosticsLogLevelCli::Info => get_resources::ged::EfiDiagnosticsLogLevelType::Info,
1489 EfiDiagnosticsLogLevelCli::Full => get_resources::ged::EfiDiagnosticsLogLevelType::Full,
1490 }
1491 },
1492 force_dma_bounce_enabled: opt.uefi_force_dma_bounce,
1493 }
1494 .into_resource(),
1495 ),
1496 ]);
1497 }
1498
1499 if opt.tpm && !opt.vtl2 {
1500 let register_layout = if cfg!(guest_arch = "x86_64") {
1501 TpmRegisterLayout::IoPort
1502 } else {
1503 TpmRegisterLayout::Mmio
1504 };
1505
1506 let (ppi_store, nvram_store) = if opt.vmgs.is_some() {
1507 (
1508 VmgsFileHandle::new(vmgs_format::FileId::TPM_PPI, true).into_resource(),
1509 VmgsFileHandle::new(vmgs_format::FileId::TPM_NVRAM, true).into_resource(),
1510 )
1511 } else {
1512 (
1513 EphemeralNonVolatileStoreHandle.into_resource(),
1514 EphemeralNonVolatileStoreHandle.into_resource(),
1515 )
1516 };
1517
1518 chipset_devices.push(ChipsetDeviceHandle {
1519 name: "tpm".to_string(),
1520 resource: chipset_device_worker_defs::RemoteChipsetDeviceHandle {
1521 device: TpmDeviceHandle {
1522 ppi_store,
1523 nvram_store,
1524 nvram_size: None,
1525 refresh_tpm_seeds: false,
1526 ak_cert_type: tpm_resources::TpmAkCertTypeResource::None,
1527 register_layout,
1528 guest_secret_key: None,
1529 logger: None,
1530 is_confidential_vm: false,
1531 bios_guid,
1532 }
1533 .into_resource(),
1534 worker_host: mesh.make_host("tpm", None).await?,
1535 }
1536 .into_resource(),
1537 });
1538 }
1539
1540 let vga_firmware = if opt.pcat {
1541 Some(openvmm_pcat_locator::find_svga_bios(
1542 opt.vga_firmware.as_deref(),
1543 )?)
1544 } else {
1545 None
1546 };
1547
1548 if opt.gfx {
1549 let (dirt_send, dirt_recv) = mesh::channel();
1551 resources.dirty_rect_recv = Some(dirt_recv);
1552
1553 vmbus_devices.extend([
1554 (
1555 DeviceVtl::Vtl0,
1556 SynthVideoHandle {
1557 framebuffer: SharedFramebufferHandle.into_resource(),
1558 dirt_send: Some(dirt_send),
1559 }
1560 .into_resource(),
1561 ),
1562 (
1563 DeviceVtl::Vtl0,
1564 SynthKeyboardHandle {
1565 source: MultiplexedInputHandle {
1566 elevation: 1,
1568 }
1569 .into_resource(),
1570 }
1571 .into_resource(),
1572 ),
1573 (
1574 DeviceVtl::Vtl0,
1575 SynthMouseHandle {
1576 source: MultiplexedInputHandle {
1577 elevation: 1,
1579 }
1580 .into_resource(),
1581 }
1582 .into_resource(),
1583 ),
1584 ]);
1585 }
1586
1587 let vsock_listener = |path: Option<&str>| -> anyhow::Result<_> {
1588 if let Some(path) = path {
1589 cleanup_socket(path.as_ref());
1590 let listener = unix_socket::UnixListener::bind(path)
1591 .with_context(|| format!("failed to bind to hybrid vsock path: {}", path))?;
1592 Ok(Some(listener))
1593 } else {
1594 Ok(None)
1595 }
1596 };
1597
1598 let vtl0_vsock_listener = vsock_listener(opt.vmbus_vsock_path.as_deref())?;
1599 let vtl2_vsock_listener = vsock_listener(opt.vmbus_vtl2_vsock_path.as_deref())?;
1600
1601 if let Some(path) = &opt.openhcl_dump_path {
1602 let (resource, task) = spawn_dump_handler(&spawner, path.clone(), None);
1603 task.detach();
1604 vmbus_devices.push((openhcl_vtl, resource));
1605 }
1606
1607 #[cfg(guest_arch = "aarch64")]
1608 let topology_arch = openvmm_defs::config::ArchTopologyConfig::Aarch64(
1609 openvmm_defs::config::Aarch64TopologyConfig {
1610 gic_config: None,
1612 pmu_gsiv: openvmm_defs::config::PmuGsivConfig::Platform,
1613 gic_msi: match opt.gic_msi {
1614 cli_args::GicMsiCli::Auto => openvmm_defs::config::GicMsiConfig::Auto,
1615 cli_args::GicMsiCli::Its => openvmm_defs::config::GicMsiConfig::Its,
1616 cli_args::GicMsiCli::V2m => {
1617 openvmm_defs::config::GicMsiConfig::V2m { spi_count: None }
1618 }
1619 },
1620 },
1621 );
1622 #[cfg(guest_arch = "x86_64")]
1623 let topology_arch =
1624 openvmm_defs::config::ArchTopologyConfig::X86(openvmm_defs::config::X86TopologyConfig {
1625 apic_id_offset: opt.apic_id_offset,
1626 x2apic: opt.x2apic,
1627 });
1628
1629 let with_isolation = if let Some(isolation) = &opt.isolation {
1630 if !opt.vtl2 {
1632 anyhow::bail!("isolation is only currently supported with vtl2");
1633 }
1634
1635 if !opt.no_alias_map {
1637 anyhow::bail!("alias map not supported with isolation");
1638 }
1639
1640 match isolation {
1641 cli_args::IsolationCli::Vbs => Some(openvmm_defs::config::IsolationType::Vbs),
1642 }
1643 } else {
1644 None
1645 };
1646
1647 if with_hv && !opt.no_vmbus {
1648 let (shutdown_send, shutdown_recv) = mesh::channel();
1649 resources.shutdown_ic = Some(shutdown_send);
1650 let (kvp_send, kvp_recv) = mesh::channel();
1651 resources.kvp_ic = Some(kvp_send);
1652 vmbus_devices.extend(
1653 [
1654 hyperv_ic_resources::shutdown::ShutdownIcHandle {
1655 recv: shutdown_recv,
1656 }
1657 .into_resource(),
1658 hyperv_ic_resources::kvp::KvpIcHandle { recv: kvp_recv }.into_resource(),
1659 hyperv_ic_resources::timesync::TimesyncIcHandle.into_resource(),
1660 ]
1661 .map(|r| (DeviceVtl::Vtl0, r)),
1662 );
1663 }
1664
1665 if let Some(hive_path) = &opt.imc {
1666 let file = fs_err::File::open(hive_path).context("failed to open imc hive")?;
1667 vmbus_devices.push((
1668 DeviceVtl::Vtl0,
1669 vmbfs_resources::VmbfsImcDeviceHandle { file: file.into() }.into_resource(),
1670 ));
1671 }
1672
1673 let mut virtio_devices = Vec::new();
1674 let mut add_virtio_device = |bus, resource: Resource<VirtioDeviceHandle>| {
1675 let bus = match bus {
1676 VirtioBusCli::Auto => {
1677 if with_hv && (cfg!(windows) || cfg!(target_os = "macos")) {
1680 None
1681 } else {
1682 Some(VirtioBus::Pci)
1683 }
1684 }
1685 VirtioBusCli::Mmio => Some(VirtioBus::Mmio),
1686 VirtioBusCli::Pci => Some(VirtioBus::Pci),
1687 VirtioBusCli::Vpci => None,
1688 };
1689 if let Some(bus) = bus {
1690 virtio_devices.push((bus, resource));
1691 } else {
1692 vpci_devices.push(VpciDeviceConfig {
1693 vtl: DeviceVtl::Vtl0,
1694 instance_id: Guid::new_random(),
1695 resource: VirtioPciDeviceHandle(resource).into_resource(),
1696 vnode: None,
1697 });
1698 }
1699 };
1700
1701 for cli_cfg in &opt.virtio_net {
1702 if cli_cfg.underhill {
1703 anyhow::bail!("use --net uh:[...] to add underhill NICs")
1704 }
1705 let vport = parse_endpoint(cli_cfg, &mut nic_index, &mut resources)?;
1706 let resource = virtio_resources::net::VirtioNetHandle {
1707 max_queues: vport.max_queues,
1708 mac_address: vport.mac_address,
1709 endpoint: vport.endpoint,
1710 }
1711 .into_resource();
1712 if let Some(pcie_port) = &cli_cfg.pcie_port {
1713 pcie_devices.push(PcieDeviceConfig {
1714 port_name: pcie_port.clone(),
1715 resource: VirtioPciDeviceHandle(resource).into_resource(),
1716 });
1717 } else {
1718 add_virtio_device(VirtioBusCli::Auto, resource);
1719 }
1720 }
1721
1722 for args in &opt.virtio_fs {
1723 let resource: Resource<VirtioDeviceHandle> = virtio_resources::fs::VirtioFsHandle {
1724 tag: args.tag.clone(),
1725 fs: virtio_resources::fs::VirtioFsBackend::HostFs {
1726 root_path: args.path.clone(),
1727 mount_options: args.options.clone(),
1728 },
1729 }
1730 .into_resource();
1731 if let Some(pcie_port) = &args.pcie_port {
1732 pcie_devices.push(PcieDeviceConfig {
1733 port_name: pcie_port.clone(),
1734 resource: VirtioPciDeviceHandle(resource).into_resource(),
1735 });
1736 } else {
1737 add_virtio_device(opt.virtio_fs_bus, resource);
1738 }
1739 }
1740
1741 for args in &opt.virtio_fs_shmem {
1742 let resource: Resource<VirtioDeviceHandle> = virtio_resources::fs::VirtioFsHandle {
1743 tag: args.tag.clone(),
1744 fs: virtio_resources::fs::VirtioFsBackend::SectionFs {
1745 root_path: args.path.clone(),
1746 },
1747 }
1748 .into_resource();
1749 if let Some(pcie_port) = &args.pcie_port {
1750 pcie_devices.push(PcieDeviceConfig {
1751 port_name: pcie_port.clone(),
1752 resource: VirtioPciDeviceHandle(resource).into_resource(),
1753 });
1754 } else {
1755 add_virtio_device(opt.virtio_fs_bus, resource);
1756 }
1757 }
1758
1759 for args in &opt.virtio_9p {
1760 let resource: Resource<VirtioDeviceHandle> = virtio_resources::p9::VirtioPlan9Handle {
1761 tag: args.tag.clone(),
1762 root_path: args.path.clone(),
1763 debug: opt.virtio_9p_debug,
1764 }
1765 .into_resource();
1766 if let Some(pcie_port) = &args.pcie_port {
1767 pcie_devices.push(PcieDeviceConfig {
1768 port_name: pcie_port.clone(),
1769 resource: VirtioPciDeviceHandle(resource).into_resource(),
1770 });
1771 } else {
1772 add_virtio_device(VirtioBusCli::Auto, resource);
1773 }
1774 }
1775
1776 if let Some(pmem_args) = &opt.virtio_pmem {
1777 let resource: Resource<VirtioDeviceHandle> = virtio_resources::pmem::VirtioPmemHandle {
1778 path: pmem_args.path.clone(),
1779 }
1780 .into_resource();
1781 if let Some(pcie_port) = &pmem_args.pcie_port {
1782 pcie_devices.push(PcieDeviceConfig {
1783 port_name: pcie_port.clone(),
1784 resource: VirtioPciDeviceHandle(resource).into_resource(),
1785 });
1786 } else {
1787 add_virtio_device(VirtioBusCli::Auto, resource);
1788 }
1789 }
1790
1791 if opt.virtio_rng {
1792 let resource: Resource<VirtioDeviceHandle> =
1793 virtio_resources::rng::VirtioRngHandle.into_resource();
1794 if let Some(pcie_port) = &opt.virtio_rng_pcie_port {
1795 pcie_devices.push(PcieDeviceConfig {
1796 port_name: pcie_port.clone(),
1797 resource: VirtioPciDeviceHandle(resource).into_resource(),
1798 });
1799 } else {
1800 add_virtio_device(opt.virtio_rng_bus, resource);
1801 }
1802 }
1803
1804 if let Some(backend) = virtio_console_backend {
1805 let resource: Resource<VirtioDeviceHandle> =
1806 virtio_resources::console::VirtioConsoleHandle { backend }.into_resource();
1807 if let Some(pcie_port) = &opt.virtio_console_pcie_port {
1808 pcie_devices.push(PcieDeviceConfig {
1809 port_name: pcie_port.clone(),
1810 resource: VirtioPciDeviceHandle(resource).into_resource(),
1811 });
1812 } else {
1813 add_virtio_device(VirtioBusCli::Auto, resource);
1814 }
1815 }
1816
1817 #[cfg(target_os = "linux")]
1819 for vhost_cli in &opt.vhost_user {
1820 let stream =
1821 unix_socket::UnixStream::connect(&vhost_cli.socket_path).with_context(|| {
1822 format!(
1823 "failed to connect to vhost-user socket: {}",
1824 vhost_cli.socket_path
1825 )
1826 })?;
1827
1828 use crate::cli_args::VhostUserDeviceTypeCli;
1829 let resource: Resource<VirtioDeviceHandle> = match vhost_cli.device_type {
1830 VhostUserDeviceTypeCli::Fs {
1831 ref tag,
1832 num_queues,
1833 queue_size,
1834 } => virtio_resources::vhost_user::VhostUserFsHandle {
1835 socket: stream.into(),
1836 tag: tag.clone(),
1837 num_queues,
1838 queue_size,
1839 }
1840 .into_resource(),
1841 VhostUserDeviceTypeCli::Blk {
1842 num_queues,
1843 queue_size,
1844 } => virtio_resources::vhost_user::VhostUserBlkHandle {
1845 socket: stream.into(),
1846 num_queues,
1847 queue_size,
1848 }
1849 .into_resource(),
1850 VhostUserDeviceTypeCli::Other {
1851 device_id,
1852 ref queue_sizes,
1853 } => virtio_resources::vhost_user::VhostUserGenericHandle {
1854 socket: stream.into(),
1855 device_id,
1856 queue_sizes: queue_sizes.clone(),
1857 }
1858 .into_resource(),
1859 };
1860 if let Some(pcie_port) = &vhost_cli.pcie_port {
1861 pcie_devices.push(PcieDeviceConfig {
1862 port_name: pcie_port.clone(),
1863 resource: VirtioPciDeviceHandle(resource).into_resource(),
1864 });
1865 } else {
1866 add_virtio_device(VirtioBusCli::Auto, resource);
1867 }
1868 }
1869
1870 if let Some(vsock_path) = &opt.virtio_vsock_path {
1871 let listener = vsock_listener(Some(vsock_path))?.unwrap();
1872 add_virtio_device(
1873 VirtioBusCli::Auto,
1874 virtio_resources::vsock::VirtioVsockHandle {
1875 guest_cid: 0x3,
1878 base_path: vsock_path.clone(),
1879 listener,
1880 }
1881 .into_resource(),
1882 );
1883 }
1884
1885 let mut cfg = Config {
1886 chipset,
1887 load_mode,
1888 floppy_disks,
1889 pcie_root_complexes,
1890 #[cfg(target_os = "linux")]
1891 pcie_devices: {
1892 let mut devs = pcie_devices;
1893 devs.extend(vfio_pcie_devices);
1894 devs
1895 },
1896 #[cfg(not(target_os = "linux"))]
1897 pcie_devices,
1898 pcie_switches,
1899 pcie_generic_initiators,
1900 vpci_devices,
1901 ide_disks: Vec::new(),
1902 numa: {
1903 if let Some(ref nodes) = opt.numa {
1904 NumaTopology {
1906 nodes: nodes
1907 .iter()
1908 .map(|n| {
1909 let vps = match &n.vps {
1910 Some(vps) if vps.0.is_empty() => VpAssignment::Empty,
1911 Some(vps) => {
1912 VpAssignment::Explicit(vps.expand_below(opt.processors)?)
1913 }
1914 None => VpAssignment::FromTopology,
1915 };
1916 Ok(NumaNode {
1917 mem: Some(MemoryConfig {
1918 mem_size: n
1919 .memory
1920 .size
1921 .expect("NUMA memory size was validated")
1922 .0,
1923 prefetch_memory: n.memory.prefetch,
1924 private_memory: n.memory.shared == Some(false),
1925 transparent_hugepages: n
1926 .memory
1927 .transparent_hugepages
1928 .unwrap_or(!n.memory.hugepages),
1929 hugepages: n.memory.hugepages,
1930 hugepage_size: n.memory.hugepage_size.map(|m| m.0),
1931 host_numa_node: n.host_numa_node,
1932 }),
1933 vps,
1934 })
1935 })
1936 .collect::<anyhow::Result<Vec<_>>>()?,
1937 distances: opt
1938 .numa_distance
1939 .as_deref()
1940 .unwrap_or(&[])
1941 .iter()
1942 .map(|d| NumaDistance {
1943 src: d.src,
1944 dst: d.dst,
1945 distance: d.distance,
1946 })
1947 .collect(),
1948 }
1949 } else {
1950 NumaTopology {
1952 nodes: vec![NumaNode {
1953 mem: Some(MemoryConfig {
1954 mem_size: opt.memory_size(),
1955 prefetch_memory: opt.prefetch_memory(),
1956 private_memory: opt.private_memory(),
1957 transparent_hugepages: opt.transparent_hugepages(),
1958 hugepages: opt.memory.hugepages,
1959 hugepage_size: opt.memory.hugepage_size.map(|m| m.0),
1960 host_numa_node: None,
1961 }),
1962 vps: VpAssignment::FromTopology,
1963 }],
1964 distances: vec![],
1965 }
1966 }
1967 },
1968 processor_topology: ProcessorTopologyConfig {
1969 proc_count: opt.processors,
1970 vps_per_socket: opt.vps_per_socket,
1971 enable_smt: match opt.smt {
1972 cli_args::SmtConfigCli::Auto => None,
1973 cli_args::SmtConfigCli::Force => Some(true),
1974 cli_args::SmtConfigCli::Off => Some(false),
1975 },
1976 arch: Some(topology_arch),
1977 },
1978 hypervisor: HypervisorConfig {
1979 with_hv,
1980 with_vtl2: opt.vtl2.then_some(Vtl2Config {
1981 vtl0_alias_map: !opt.no_alias_map,
1982 late_map_vtl0_memory: match opt.late_map_vtl0_policy {
1983 cli_args::Vtl0LateMapPolicyCli::Off => None,
1984 cli_args::Vtl0LateMapPolicyCli::Log => Some(LateMapVtl0MemoryPolicy::Log),
1985 cli_args::Vtl0LateMapPolicyCli::Halt => Some(LateMapVtl0MemoryPolicy::Halt),
1986 cli_args::Vtl0LateMapPolicyCli::Exception => {
1987 Some(LateMapVtl0MemoryPolicy::InjectException)
1988 }
1989 },
1990 }),
1991 with_isolation,
1992 nested_virt: opt.nested_virt,
1993 },
1994 #[cfg(windows)]
1995 kernel_vmnics,
1996 input: mesh::Receiver::new(),
1997 framebuffer,
1998 vga_firmware,
1999 vtl2_gfx: opt.vtl2_gfx,
2000 virtio_devices,
2001 vmbus: (with_hv && !opt.no_vmbus).then_some(VmbusConfig {
2002 vsock_listener: vtl0_vsock_listener,
2003 vsock_path: opt.vmbus_vsock_path.clone(),
2004 vtl2_redirect: opt.vmbus_redirect,
2005 vmbus_max_version: opt.vmbus_max_version,
2006 #[cfg(windows)]
2007 vmbusproxy_handle,
2008 }),
2009 vtl2_vmbus: (with_hv && opt.vtl2).then_some(VmbusConfig {
2010 vsock_listener: vtl2_vsock_listener,
2011 vsock_path: opt.vmbus_vtl2_vsock_path.clone(),
2012 ..Default::default()
2013 }),
2014 vmbus_devices,
2015 chipset_devices,
2016 pci_chipset_devices,
2017 isa_dma_controller,
2018 chipset_capabilities: capabilities,
2019 layout: layout_config,
2020 #[cfg(windows)]
2021 vpci_resources,
2022 vmgs,
2023 firmware_event_send: None,
2024 debugger_rpc: None,
2025 rtc_delta_milliseconds: 0,
2026 automatic_guest_reset: matches!(opt.guest_reset_action, GuestPowerAction::Reset),
2030 };
2031
2032 storage.build_config(&mut cfg, &mut resources, opt.scsi_sub_channels)?;
2033 resources.serial_driver = Some(serial_driver);
2034 Ok((cfg, resources))
2035}
2036
2037pub(crate) fn openvmm_terminal_app() -> Option<PathBuf> {
2039 std::env::var_os("OPENVMM_TERM")
2040 .or_else(|| std::env::var_os("HVLITE_TERM"))
2041 .map(Into::into)
2042}
2043
2044fn cleanup_socket(path: &Path) {
2046 #[cfg(windows)]
2047 let is_socket = pal::windows::fs::is_unix_socket(path).unwrap_or(false);
2048 #[cfg(not(windows))]
2049 let is_socket = path
2050 .metadata()
2051 .is_ok_and(|meta| std::os::unix::fs::FileTypeExt::is_socket(&meta.file_type()));
2052
2053 if is_socket {
2054 let _ = std::fs::remove_file(path);
2055 }
2056}
2057
2058#[cfg(windows)]
2059fn new_switch_port(
2060 switch_id: Option<&str>,
2061) -> anyhow::Result<(
2062 openvmm_defs::config::SwitchPortId,
2063 vmswitch::kernel::SwitchPort,
2064)> {
2065 let id = vmswitch::kernel::SwitchPortId {
2066 switch: match switch_id {
2067 Some(s) => s.parse().context("invalid switch id")?,
2068 None => vmswitch::hcn::DEFAULT_SWITCH,
2069 },
2070 port: Guid::new_random(),
2071 };
2072 let _ = vmswitch::hcn::Network::open(&id.switch)
2073 .with_context(|| format!("could not find switch {}", id.switch))?;
2074
2075 let port = vmswitch::kernel::SwitchPort::new(&id).context("failed to create switch port")?;
2076
2077 let id = openvmm_defs::config::SwitchPortId {
2078 switch: id.switch,
2079 port: id.port,
2080 };
2081 Ok((id, port))
2082}
2083
2084fn parse_endpoint(
2085 cli_cfg: &NicConfigCli,
2086 index: &mut usize,
2087 resources: &mut VmResources,
2088) -> anyhow::Result<NicConfig> {
2089 let _ = resources;
2090 let endpoint = match &cli_cfg.endpoint {
2091 EndpointConfigCli::Consomme { cidr, host_fwd } => {
2092 let ports = host_fwd
2093 .iter()
2094 .map(|fwd| {
2095 use net_backend_resources::consomme::HostPortProtocol;
2096 net_backend_resources::consomme::HostPortConfig {
2097 protocol: match fwd.protocol {
2098 cli_args::HostPortProtocolCli::Tcp => HostPortProtocol::Tcp,
2099 cli_args::HostPortProtocolCli::Udp => HostPortProtocol::Udp,
2100 },
2101 host_address: fwd
2102 .host_address
2103 .map(net_backend_resources::consomme::HostIpAddress::from),
2104 host_port: net_backend_resources::consomme::HostPort::Fixed(fwd.host_port),
2105 guest_port: fwd.guest_port,
2106 }
2107 })
2108 .collect();
2109 let recv = if resources.consomme_rpc.is_none() {
2113 let (send, recv) = mesh::channel();
2114 resources.consomme_rpc = Some(send);
2115 Some(recv)
2116 } else {
2117 None
2118 };
2119 net_backend_resources::consomme::ConsommeHandle {
2120 cidr: cidr.clone(),
2121 ports,
2122 recv,
2123 }
2124 .into_resource()
2125 }
2126 EndpointConfigCli::None => net_backend_resources::null::NullHandle.into_resource(),
2127 EndpointConfigCli::Dio { id } => {
2128 #[cfg(windows)]
2129 {
2130 let (port_id, port) = new_switch_port(id.as_deref())?;
2131 resources.switch_ports.push(port);
2132 net_backend_resources::dio::WindowsDirectIoHandle {
2133 switch_port_id: net_backend_resources::dio::SwitchPortId {
2134 switch: port_id.switch,
2135 port: port_id.port,
2136 },
2137 }
2138 .into_resource()
2139 }
2140
2141 #[cfg(not(windows))]
2142 {
2143 let _ = id;
2144 bail!("cannot use dio on non-windows platforms")
2145 }
2146 }
2147 EndpointConfigCli::Tap { name } => {
2148 #[cfg(target_os = "linux")]
2149 {
2150 let fd = net_tap::tap::open_tap(name)
2151 .with_context(|| format!("failed to open TAP device '{name}'"))?;
2152 net_backend_resources::tap::TapHandle { fd }.into_resource()
2153 }
2154
2155 #[cfg(not(target_os = "linux"))]
2156 {
2157 let _ = name;
2158 bail!("TAP backend is only supported on Linux")
2159 }
2160 }
2161 };
2162
2163 let mut mac_address = [0x00, 0x15, 0x5D, 0, 0, 0];
2165 getrandom::fill(&mut mac_address[3..]).expect("rng failure");
2166
2167 const BASE_INSTANCE_ID: Guid = guid::guid!("00000000-da43-11ed-936a-00155d6db52f");
2169 let instance_id = Guid {
2170 data1: *index as u32,
2171 ..BASE_INSTANCE_ID
2172 };
2173 *index += 1;
2174
2175 Ok(NicConfig {
2176 vtl: cli_cfg.vtl,
2177 instance_id,
2178 endpoint,
2179 mac_address: mac_address.into(),
2180 max_queues: cli_cfg.max_queues,
2181 pcie_port: cli_cfg.pcie_port.clone(),
2182 })
2183}
2184
2185#[derive(Debug)]
2186struct NicConfig {
2187 vtl: DeviceVtl,
2188 instance_id: Guid,
2189 mac_address: MacAddress,
2190 endpoint: Resource<NetEndpointHandleKind>,
2191 max_queues: Option<u16>,
2192 pcie_port: Option<String>,
2193}
2194
2195impl NicConfig {
2196 fn into_netvsp_handle(self) -> (DeviceVtl, Resource<VmbusDeviceHandleKind>) {
2197 (
2198 self.vtl,
2199 netvsp_resources::NetvspHandle {
2200 instance_id: self.instance_id,
2201 mac_address: self.mac_address,
2202 endpoint: self.endpoint,
2203 max_queues: self.max_queues,
2204 }
2205 .into_resource(),
2206 )
2207 }
2208}
2209
2210enum LayerOrDisk {
2211 Layer(DiskLayerDescription),
2212 Disk(Resource<DiskHandleKind>),
2213}
2214
2215async fn disk_open(
2216 disk_cli: &DiskCliKind,
2217 read_only: bool,
2218) -> anyhow::Result<Resource<DiskHandleKind>> {
2219 let mut layers = Vec::new();
2220 disk_open_inner(disk_cli, read_only, &mut layers).await?;
2221 if layers.len() == 1 && matches!(layers[0], LayerOrDisk::Disk(_)) {
2222 let LayerOrDisk::Disk(disk) = layers.pop().unwrap() else {
2223 unreachable!()
2224 };
2225 Ok(disk)
2226 } else {
2227 Ok(Resource::new(disk_backend_resources::LayeredDiskHandle {
2228 layers: layers
2229 .into_iter()
2230 .map(|layer| match layer {
2231 LayerOrDisk::Layer(layer) => layer,
2232 LayerOrDisk::Disk(disk) => DiskLayerDescription {
2233 layer: DiskLayerHandle(disk).into_resource(),
2234 read_cache: false,
2235 write_through: false,
2236 },
2237 })
2238 .collect(),
2239 }))
2240 }
2241}
2242
2243fn disk_open_inner<'a>(
2244 disk_cli: &'a DiskCliKind,
2245 read_only: bool,
2246 layers: &'a mut Vec<LayerOrDisk>,
2247) -> futures::future::BoxFuture<'a, anyhow::Result<()>> {
2248 Box::pin(async move {
2249 fn layer<T: IntoResource<DiskLayerHandleKind>>(layer: T) -> LayerOrDisk {
2250 LayerOrDisk::Layer(layer.into_resource().into())
2251 }
2252 fn disk<T: IntoResource<DiskHandleKind>>(disk: T) -> LayerOrDisk {
2253 LayerOrDisk::Disk(disk.into_resource())
2254 }
2255 match disk_cli {
2256 &DiskCliKind::Memory(len) => {
2257 layers.push(layer(RamDiskLayerHandle {
2258 len: Some(len),
2259 sector_size: None,
2260 }));
2261 }
2262 DiskCliKind::File {
2263 path,
2264 create_with_len,
2265 direct,
2266 } => layers.push(LayerOrDisk::Disk(if let Some(size) = create_with_len {
2267 create_disk_type(
2268 path,
2269 *size,
2270 OpenDiskOptions {
2271 read_only: false,
2272 direct: *direct,
2273 },
2274 )
2275 .with_context(|| format!("failed to create {}", path.display()))?
2276 } else {
2277 open_disk_type(
2278 path,
2279 OpenDiskOptions {
2280 read_only,
2281 direct: *direct,
2282 },
2283 )
2284 .await
2285 .with_context(|| format!("failed to open {}", path.display()))?
2286 })),
2287 DiskCliKind::Blob { kind, url } => {
2288 layers.push(disk(disk_backend_resources::BlobDiskHandle {
2289 url: url.to_owned(),
2290 format: match kind {
2291 cli_args::BlobKind::Flat => disk_backend_resources::BlobDiskFormat::Flat,
2292 cli_args::BlobKind::Vhd1 => {
2293 disk_backend_resources::BlobDiskFormat::FixedVhd1
2294 }
2295 },
2296 }))
2297 }
2298 DiskCliKind::MemoryDiff(inner) => {
2299 layers.push(layer(RamDiskLayerHandle {
2300 len: None,
2301 sector_size: None,
2302 }));
2303 disk_open_inner(inner, true, layers).await?;
2304 }
2305 DiskCliKind::PersistentReservationsWrapper(inner) => {
2306 layers.push(disk(disk_backend_resources::DiskWithReservationsHandle(
2307 disk_open(inner, read_only).await?,
2308 )))
2309 }
2310 DiskCliKind::DelayDiskWrapper {
2311 delay_ms,
2312 disk: inner,
2313 } => layers.push(disk(DelayDiskHandle {
2314 delay: CellUpdater::new(Duration::from_millis(*delay_ms)).cell(),
2315 disk: disk_open(inner, read_only).await?,
2316 })),
2317 DiskCliKind::Crypt {
2318 disk: inner,
2319 cipher,
2320 key_file,
2321 } => layers.push(disk(disk_crypt_resources::DiskCryptHandle {
2322 disk: disk_open(inner, read_only).await?,
2323 cipher: match cipher {
2324 cli_args::DiskCipher::XtsAes256 => disk_crypt_resources::Cipher::XtsAes256,
2325 },
2326 key: fs_err::read(key_file).context("failed to read key file")?,
2327 })),
2328 DiskCliKind::Sqlite {
2329 path,
2330 create_with_len,
2331 } => {
2332 match (create_with_len.is_some(), path.exists()) {
2337 (true, true) => anyhow::bail!(
2338 "cannot create new sqlite disk at {} - file already exists",
2339 path.display()
2340 ),
2341 (false, false) => anyhow::bail!(
2342 "cannot open sqlite disk at {} - file not found",
2343 path.display()
2344 ),
2345 _ => {}
2346 }
2347
2348 layers.push(layer(SqliteDiskLayerHandle {
2349 dbhd_path: path.display().to_string(),
2350 format_dbhd: create_with_len.map(|len| {
2351 disk_backend_resources::layer::SqliteDiskLayerFormatParams {
2352 logically_read_only: false,
2353 len: Some(len),
2354 }
2355 }),
2356 }));
2357 }
2358 DiskCliKind::SqliteDiff { path, create, disk } => {
2359 match (create, path.exists()) {
2364 (true, true) => anyhow::bail!(
2365 "cannot create new sqlite disk at {} - file already exists",
2366 path.display()
2367 ),
2368 (false, false) => anyhow::bail!(
2369 "cannot open sqlite disk at {} - file not found",
2370 path.display()
2371 ),
2372 _ => {}
2373 }
2374
2375 layers.push(layer(SqliteDiskLayerHandle {
2376 dbhd_path: path.display().to_string(),
2377 format_dbhd: create.then_some(
2378 disk_backend_resources::layer::SqliteDiskLayerFormatParams {
2379 logically_read_only: false,
2380 len: None,
2381 },
2382 ),
2383 }));
2384 disk_open_inner(disk, true, layers).await?;
2385 }
2386 DiskCliKind::AutoCacheSqlite {
2387 cache_path,
2388 key,
2389 disk,
2390 } => {
2391 layers.push(LayerOrDisk::Layer(DiskLayerDescription {
2392 read_cache: true,
2393 write_through: false,
2394 layer: SqliteAutoCacheDiskLayerHandle {
2395 cache_path: cache_path.clone(),
2396 cache_key: key.clone(),
2397 }
2398 .into_resource(),
2399 }));
2400 disk_open_inner(disk, read_only, layers).await?;
2401 }
2402 }
2403 Ok(())
2404 })
2405}
2406
2407pub(crate) fn system_page_size() -> u32 {
2409 sparse_mmap::SparseMapping::page_size() as u32
2410}
2411
2412pub(crate) const GUEST_ARCH: &str = if cfg!(guest_arch = "x86_64") {
2414 "x86_64"
2415} else {
2416 "aarch64"
2417};
2418
2419fn prepare_snapshot_restore(
2422 snapshot_dir: &Path,
2423 opt: &Options,
2424) -> anyhow::Result<(
2425 openvmm_defs::worker::SharedMemoryFd,
2426 mesh::payload::message::ProtobufMessage,
2427)> {
2428 let (manifest, state_bytes) = openvmm_helpers::snapshot::read_snapshot(snapshot_dir)?;
2429
2430 openvmm_helpers::snapshot::validate_manifest(
2432 &manifest,
2433 GUEST_ARCH,
2434 opt.memory_size(),
2435 opt.processors,
2436 system_page_size(),
2437 )?;
2438
2439 let memory_file = fs_err::OpenOptions::new()
2441 .read(true)
2442 .write(true)
2443 .open(snapshot_dir.join("memory.bin"))?;
2444
2445 let file_size = memory_file.metadata()?.len();
2447 if file_size != manifest.memory_size_bytes {
2448 anyhow::bail!(
2449 "memory.bin size ({file_size} bytes) doesn't match manifest ({} bytes)",
2450 manifest.memory_size_bytes,
2451 );
2452 }
2453
2454 let shared_memory_fd =
2455 openvmm_helpers::shared_memory::file_to_shared_memory_fd(memory_file.into())?;
2456
2457 let state_msg: mesh::payload::message::ProtobufMessage = mesh::payload::decode(&state_bytes)
2461 .context("failed to decode saved state from snapshot")?;
2462
2463 Ok((shared_memory_fd, state_msg))
2464}
2465
2466fn do_main(pidfile_guard: &mut Option<pidfile::Pidfile>) -> anyhow::Result<i32> {
2467 #[cfg(windows)]
2468 pal::windows::disable_hard_error_dialog();
2469
2470 tracing_init::enable_tracing()?;
2471
2472 meshworker::run_vmm_mesh_host()?;
2476
2477 let opt = cli_args::parse_options();
2478 if let Some(path) = &opt.write_saved_state_proto {
2479 mesh::payload::protofile::DescriptorWriter::new(vmcore::save_restore::saved_state_roots())
2480 .write_to_path(path)
2481 .context("failed to write protobuf descriptors")?;
2482 return Ok(0);
2483 }
2484
2485 if let Some(ref path) = opt.pidfile {
2486 *pidfile_guard = Some(pidfile::Pidfile::new(path).context("failed to create pidfile")?);
2487 }
2488
2489 if let Some(path) = opt.relay_console_path {
2490 let console_title = opt.relay_console_title.unwrap_or_default();
2491 return console_relay::relay_console(&path, console_title.as_str()).map(|()| 0);
2492 }
2493
2494 #[cfg(any(feature = "grpc", feature = "ttrpc"))]
2495 {
2496 let rpc = opt
2497 .rpc
2498 .as_ref()
2499 .map(|rpc| {
2500 let transport = match rpc.transport {
2501 cli_args::RpcTransportCli::Auto => ttrpc::RpcTransport::Auto,
2502 cli_args::RpcTransportCli::Ttrpc => ttrpc::RpcTransport::Ttrpc,
2503 cli_args::RpcTransportCli::Grpc => ttrpc::RpcTransport::Grpc,
2504 };
2505 (rpc.path.as_path(), transport)
2506 })
2507 .or_else(|| {
2508 opt.ttrpc
2509 .as_deref()
2510 .map(|p| (p, ttrpc::RpcTransport::Ttrpc))
2511 })
2512 .or_else(|| opt.grpc.as_deref().map(|p| (p, ttrpc::RpcTransport::Grpc)));
2513
2514 if let Some((path, transport)) = rpc {
2515 return block_on(async {
2516 let _ = std::fs::remove_file(path);
2517 let listener =
2518 unix_socket::UnixListener::bind(path).context("failed to bind to socket")?;
2519
2520 let mut handle =
2522 mesh_worker::launch_local_worker::<ttrpc::TtrpcWorker>(ttrpc::Parameters {
2523 listener,
2524 transport,
2525 })
2526 .await?;
2527
2528 tracing::info!(%transport, path = %path.display(), "listening");
2529
2530 pal::close_stdout().context("failed to close stdout")?;
2532
2533 handle.join().await?;
2534
2535 Ok(0)
2536 });
2537 }
2538 }
2539
2540 DefaultPool::run_with(async |driver| run_control(&driver, opt).await)
2541}
2542
2543fn new_hvsock_service_id(port: u32) -> Guid {
2544 Guid {
2547 data1: port,
2548 .."00000000-facb-11e6-bd58-64006a7986d3".parse().unwrap()
2549 }
2550}
2551
2552async fn run_control(driver: &DefaultDriver, opt: Options) -> anyhow::Result<i32> {
2553 let mut mesh = Some(VmmMesh::new(&driver, opt.single_process)?);
2554 let result = run_control_inner(driver, &mut mesh, opt).await;
2555 if let Some(mesh) = mesh {
2558 mesh.shutdown().await;
2559 }
2560 result
2561}
2562
2563async fn run_control_inner(
2564 driver: &DefaultDriver,
2565 mesh_slot: &mut Option<VmmMesh>,
2566 opt: Options,
2567) -> anyhow::Result<i32> {
2568 let mesh = mesh_slot.as_ref().unwrap();
2569 let (mut vm_config, mut resources) = vm_config_from_command_line(driver, mesh, &opt).await?;
2570
2571 let mut vnc_worker = None;
2572 if opt.gfx || opt.vnc.vnc {
2573 let addr: std::net::SocketAddr = if let Ok(sa) =
2576 opt.vnc.vnc_listen.parse::<std::net::SocketAddr>()
2577 {
2578 sa
2579 } else {
2580 let ip: std::net::IpAddr = opt.vnc.vnc_listen.parse().with_context(|| {
2581 format!(
2582 "invalid VNC listen address: {} (expected IP address or socket address like [::1]:5900)",
2583 opt.vnc.vnc_listen
2584 )
2585 })?;
2586 std::net::SocketAddr::new(ip, opt.vnc.vnc_port)
2587 };
2588
2589 let socket = socket2::Socket::new(
2590 if addr.is_ipv6() {
2591 socket2::Domain::IPV6
2592 } else {
2593 socket2::Domain::IPV4
2594 },
2595 socket2::Type::STREAM,
2596 None,
2597 )
2598 .with_context(|| format!("creating VNC socket for {}", addr))?;
2599
2600 if addr.is_ipv6() {
2601 if let Err(e) = socket.set_only_v6(false) {
2602 tracing::warn!(
2603 error = %e,
2604 "failed to enable dual-stack on IPv6 VNC socket, IPv4 clients may not be able to connect"
2605 );
2606 }
2607 }
2608 socket.set_reuse_address(true)?;
2609 socket
2610 .bind(&addr.into())
2611 .with_context(|| format!("binding VNC socket to {}", addr))?;
2612 socket
2613 .listen(128)
2614 .with_context(|| format!("listening on VNC socket {}", addr))?;
2615 let listener: TcpListener = socket.into();
2616
2617 if !addr.ip().is_loopback() {
2618 tracing::warn!(
2619 address = %addr,
2620 "VNC server listening on non-localhost address without authentication"
2621 );
2622 }
2623
2624 let input_send = vm_config.input.sender();
2625 let framebuffer = resources
2626 .framebuffer_access
2627 .take()
2628 .expect("synth video enabled");
2629
2630 let vnc_host = mesh
2631 .make_host("vnc", None)
2632 .await
2633 .context("spawning vnc process failed")?;
2634
2635 vnc_worker = Some(
2636 vnc_host
2637 .launch_worker(
2638 vnc_worker_defs::VNC_WORKER_TCP,
2639 VncParameters {
2640 listener,
2641 framebuffer,
2642 input_send,
2643 dirty_recv: resources.dirty_rect_recv.take(),
2644 max_clients: opt.vnc.vnc_max_clients,
2645 evict_oldest: opt.vnc.vnc_evict_oldest,
2646 },
2647 )
2648 .await?,
2649 )
2650 }
2651
2652 let gdb_worker = if let Some(port) = opt.gdb {
2654 let listener = TcpListener::bind(format!("127.0.0.1:{}", port))
2655 .with_context(|| format!("binding to gdb port {}", port))?;
2656
2657 let (req_tx, req_rx) = mesh::channel();
2658 vm_config.debugger_rpc = Some(req_rx);
2659
2660 let gdb_host = mesh
2661 .make_host("gdb", None)
2662 .await
2663 .context("spawning gdbstub process failed")?;
2664
2665 Some(
2666 gdb_host
2667 .launch_worker(
2668 debug_worker_defs::DEBUGGER_WORKER,
2669 debug_worker_defs::DebuggerParameters {
2670 listener,
2671 req_chan: req_tx,
2672 vp_count: vm_config.processor_topology.proc_count,
2673 target_arch: if cfg!(guest_arch = "x86_64") {
2674 debug_worker_defs::TargetArch::X86_64
2675 } else {
2676 debug_worker_defs::TargetArch::Aarch64
2677 },
2678 },
2679 )
2680 .await
2681 .context("failed to launch gdbstub worker")?,
2682 )
2683 } else {
2684 None
2685 };
2686
2687 let (vm_rpc, rpc_recv) = mesh::channel();
2689 let (notify_send, notify_recv) = mesh::channel();
2690 let vm_worker = {
2691 let vm_host = mesh.make_host("vm", opt.log_file.clone()).await?;
2692
2693 let (shared_memory, saved_state) = if let Some(snapshot_dir) = &opt.restore_snapshot {
2694 let (fd, state_msg) = prepare_snapshot_restore(snapshot_dir, &opt)?;
2695 (Some(fd), Some(state_msg))
2696 } else {
2697 let shared_memory = opt
2698 .memory_backing_file()
2699 .map(|path| {
2700 openvmm_helpers::shared_memory::open_memory_backing_file(
2701 path,
2702 opt.memory_size(),
2703 )
2704 })
2705 .transpose()?;
2706 (shared_memory, None)
2707 };
2708
2709 let params = VmWorkerParameters {
2710 hypervisor: match &opt.hypervisor {
2711 Some(name) => openvmm_helpers::hypervisor::hypervisor_resource(name)?,
2712 None => openvmm_helpers::hypervisor::choose_hypervisor()?,
2713 },
2714 cfg: vm_config,
2715 saved_state,
2716 shared_memory,
2717 rpc: rpc_recv,
2718 notify: notify_send,
2719 };
2720 vm_host
2721 .launch_worker(VM_WORKER, params)
2722 .await
2723 .context("failed to launch vm worker")?
2724 };
2725
2726 if opt.restore_snapshot.is_some() {
2727 tracing::info!("restoring VM from snapshot");
2728 }
2729
2730 if !opt.paused {
2731 vm_rpc.call(VmRpc::Resume, ()).await?;
2732 }
2733
2734 let paravisor_diag = Arc::new(diag_client::DiagClient::from_dialer(
2735 driver.clone(),
2736 DiagDialer {
2737 driver: driver.clone(),
2738 vm_rpc: vm_rpc.clone(),
2739 openhcl_vtl: if opt.vtl2 {
2740 DeviceVtl::Vtl2
2741 } else {
2742 DeviceVtl::Vtl0
2743 },
2744 },
2745 ));
2746
2747 let diag_inspector = DiagInspector::new(driver.clone(), paravisor_diag.clone());
2748
2749 let (vm_controller_send, vm_controller_recv) = mesh::channel();
2751 let (vm_controller_event_send, vm_controller_event_recv) = mesh::channel();
2752
2753 let has_vtl2 = resources.vtl2_settings.is_some();
2754 let serial_driver = resources
2755 .serial_driver
2756 .take()
2757 .expect("serial driver must outlive serial resources");
2758
2759 let controller = vm_controller::VmController {
2761 mesh: mesh_slot.take().unwrap(),
2762 vm_worker,
2763 vnc_worker,
2764 gdb_worker,
2765 diag_inspector: Some(diag_inspector),
2766 vtl2_settings: resources.vtl2_settings,
2767 ged_rpc: resources.ged_rpc.clone(),
2768 vm_rpc: vm_rpc.clone(),
2769 paravisor_diag: Some(paravisor_diag),
2770 igvm_path: opt.igvm.clone(),
2771 memory_backing_file: opt.memory_backing_file().cloned(),
2772 memory: opt.memory_size(),
2773 processors: opt.processors,
2774 log_file: opt.log_file.clone(),
2775 guest_power_actions: vm_controller::GuestPowerActions {
2776 shutdown: opt.guest_shutdown_action,
2777 reset: opt.guest_reset_action,
2778 crash: opt.guest_crash_action,
2779 watchdog: opt.guest_watchdog_action,
2780 },
2781 };
2782
2783 let controller_task = driver.spawn(
2785 "vm-controller",
2786 controller.run(vm_controller_recv, vm_controller_event_send, notify_recv),
2787 );
2788
2789 let repl_result = repl::run_repl(
2791 driver,
2792 repl::ReplResources {
2793 vm_rpc,
2794 vm_controller: vm_controller_send,
2795 vm_controller_events: vm_controller_event_recv,
2796 scsi_rpc: resources.scsi_rpc,
2797 nvme_vtl2_rpc: resources.nvme_vtl2_rpc,
2798 consomme_rpc: resources.consomme_rpc,
2799 shutdown_ic: resources.shutdown_ic,
2800 kvp_ic: resources.kvp_ic,
2801 console_in: resources.console_in,
2802 has_vtl2,
2803 },
2804 )
2805 .await;
2806
2807 controller_task.await;
2810 drop(serial_driver);
2811
2812 repl_result
2815}
2816
2817struct DiagDialer {
2818 driver: DefaultDriver,
2819 vm_rpc: mesh::Sender<VmRpc>,
2820 openhcl_vtl: DeviceVtl,
2821}
2822
2823impl mesh_rpc::client::Dial for DiagDialer {
2824 type Stream = PolledSocket<unix_socket::UnixStream>;
2825
2826 async fn dial(&mut self) -> io::Result<Self::Stream> {
2827 let service_id = new_hvsock_service_id(1);
2828 let socket = self
2829 .vm_rpc
2830 .call_failable(
2831 VmRpc::ConnectHvsock,
2832 (
2833 CancelContext::new().with_timeout(Duration::from_secs(2)),
2834 service_id,
2835 self.openhcl_vtl,
2836 ),
2837 )
2838 .await
2839 .map_err(io::Error::other)?;
2840
2841 PolledSocket::new(&self.driver, socket)
2842 }
2843}
2844
2845pub(crate) struct DiagInspector(DiagInspectorInner);
2852
2853enum DiagInspectorInner {
2854 NotStarted(DefaultDriver, Arc<diag_client::DiagClient>),
2855 Started {
2856 send: mesh::Sender<inspect::Deferred>,
2857 _task: Task<()>,
2858 },
2859 Invalid,
2860}
2861
2862impl DiagInspector {
2863 pub fn new(driver: DefaultDriver, diag_client: Arc<diag_client::DiagClient>) -> Self {
2864 Self(DiagInspectorInner::NotStarted(driver, diag_client))
2865 }
2866
2867 fn start(&mut self) -> &mesh::Sender<inspect::Deferred> {
2868 loop {
2869 match self.0 {
2870 DiagInspectorInner::NotStarted { .. } => {
2871 let DiagInspectorInner::NotStarted(driver, client) =
2872 std::mem::replace(&mut self.0, DiagInspectorInner::Invalid)
2873 else {
2874 unreachable!()
2875 };
2876 let (send, recv) = mesh::channel();
2877 let task = driver.clone().spawn("diag-inspect", async move {
2878 Self::run(&client, recv).await
2879 });
2880
2881 self.0 = DiagInspectorInner::Started { send, _task: task };
2882 }
2883 DiagInspectorInner::Started { ref send, .. } => break send,
2884 DiagInspectorInner::Invalid => unreachable!(),
2885 }
2886 }
2887 }
2888
2889 async fn run(
2890 diag_client: &diag_client::DiagClient,
2891 mut recv: mesh::Receiver<inspect::Deferred>,
2892 ) {
2893 while let Some(deferred) = recv.next().await {
2894 let info = deferred.external_request();
2895 let result = match info.request_type {
2896 inspect::ExternalRequestType::Inspect { depth } => {
2897 if depth == 0 {
2898 Ok(inspect::Node::Unevaluated)
2899 } else {
2900 diag_client
2902 .inspect(info.path, Some(depth - 1), Some(Duration::from_secs(1)))
2903 .await
2904 }
2905 }
2906 inspect::ExternalRequestType::Update { value } => {
2907 (diag_client.update(info.path, value).await).map(inspect::Node::Value)
2908 }
2909 };
2910 deferred.complete_external(
2911 result.unwrap_or_else(|err| {
2912 inspect::Node::Failed(inspect::Error::Mesh(format!("{err:#}")))
2913 }),
2914 inspect::SensitivityLevel::Unspecified,
2915 )
2916 }
2917 }
2918}
2919
2920impl InspectMut for DiagInspector {
2921 fn inspect_mut(&mut self, req: inspect::Request<'_>) {
2922 self.start().send(req.defer());
2923 }
2924}