Module devices::virtio

Implements virtio devices, queues, and transport mechanisms.

Re-exports

• pub use self::block::BlockAsync;
• pub use self::console::Console;
• pub use self::gpu::DisplayBackend;
• pub use self::gpu::Gpu;
• pub use self::gpu::GpuMode;
• pub use self::gpu::GpuParameters;
• pub use self::gpu::GpuWsi;
• pub use self::net::Net;
• pub use self::net::NetError;
• pub use self::net::NetParameters;
• pub use self::net::NetParametersMode;
• pub use self::scsi::Controller as ScsiController;
• pub use self::scsi::DiskConfig as ScsiDiskConfig;
• pub use self::vhost_user_frontend::VhostUserFrontend;
• pub use self::DeviceType::Pvclock;
• pub use self::net::VhostNetParameters;
• pub use self::net::VHOST_NET_DEFAULT_PATH;
• pub use self::snd::new_sound;
• pub use self::wl::Wl;

Modules

• async_device 🔒
  Provides helpers that make it easier to process virtio queues on an async executor.
• async_utils 🔒
  Virtio device async helper functions.
• balloon 🔒
• block
• console
  Legacy console device that uses a polling thread. This is kept because it is still used by Windows ; outside of this use-case, please use [asynchronous::AsyncConsole] instead.
• descriptor_chain 🔒
  Virtqueue descriptor chain abstraction
• descriptor_utils 🔒
• device_constants
  Contains constants and struct definitions used for implementing vhost-user frontend devices without compile-time dependencies on their corresponding backend devices.
• fs
• gpu
• input
• interrupt 🔒
• iommu 🔒
• ipc_memory_mapper
  Provide utility to communicate with an iommu in another process
• memory_mapper
  MemoryMapper trait and basic impl for virtio-iommu implementation
• net
• p9 🔒
• pmem 🔒
• pvclock
  Virtio version of a linux pvclock clocksource.
• queue 🔒
  virtqueue interface
• resource_bridge
  This module defines the protocol between virtio-wayland and virtio-gpu for sharing resources that are backed by file descriptors.
• rng 🔒
• scsi
• snd
• tpm 🔒
• vfio_wrapper
  Wraps VfioContainer for virtio-iommu implementation
• vhost
  Implements vhost-based virtio devices.
• vhost_user_frontend
  VirtioDevice implementation for the VMM side of a vhost-user connection.
• video 🔒
  This module implements the virtio video encoder and decoder devices. The current implementation uses v3 RFC of the virtio-video protocol.
• virtio_device 🔒
• virtio_mmio_device 🔒
• virtio_pci_common_config 🔒
• virtio_pci_device 🔒
• vsock
  This module implements the virtio vsock device.
• wl
  This module implements the virtio wayland used by the guest to access the host’s wayland server.

Structs

• Balloon
  Virtio device for memory balloon inflation/deflation.
• Desc
  A single virtio split queue descriptor (struct virtq_desc in the spec).
• DescriptorChain
  A virtio descriptor chain.
• GpuDisplayParameters
• Interrupt
• InterruptSnapshot
• Iommu
  Virtio device for IOMMU memory management.
• P9
  Virtio device for sharing specific directories on the host system with the guest VM.
• PeekedDescriptorChain
  A DescriptorChain that has been peeked from a Queue but not popped yet.
• Pmem
• QueueConfig
  A virtio queue’s parameters.
• Reader
  Provides high-level interface over the sequence of memory regions defined by readable descriptors in the descriptor chain.
• Rng
  Virtio device for exposing entropy to the guest OS through virtio.
• SharedMemoryRegion
• SplitDescriptorChain
  Iterator over the descriptors of a split virtqueue descriptor chain.
• Tpm
  Virtio vTPM device.
• VideoDevice
• VirtioMmioDevice
  Implements the MMIO transport for virtio devices.
• VirtioPciCap
• VirtioPciDevice
  Implements the PCI transport for virtio devices.
• VirtioPciShmCap
• Writer
  Provides high-level interface over the sequence of memory regions defined by writable descriptors in the descriptor chain.

Enums

• BalloonFeatures
• BalloonMode
  Operation mode of the balloon.
• DescriptorType
• DeviceType
• GpuDisplayMode
• GpuMouseMode
• IommuError
• PciCapabilityType
• Queue
  Virtqueue interface representing different types of virtqueues The struct of each queue type is wrapped in the enum variants
• StoppedWorker 🔒
  When we request to stop the worker, this represents the terminal state for the thread (if it exists).
• VirtioDeviceType
  Type of virtio transport.
• VirtioTransportType

Constants

• DEVICE_RESET 🔒
• INTERRUPT_STATUS_CONFIG_CHANGED 🔒
• INTERRUPT_STATUS_USED_RING 🔒
• VIRTIO_MSI_NO_VECTOR 🔒

Traits

• DescriptorChainIter
  Iterator over the descriptors of a descriptor chain.
• SharedMemoryMapper
  Trait for mapping memory into the device’s shared memory region.
• TpmBackend
• VirtioDevice
  Trait for virtio devices to be driven by a virtio transport.

Functions

• base_features
  Returns the set of reserved base features common to all virtio devices.
• copy_config
  Copy virtio device configuration data from a subslice of src to a subslice of dst. Unlike std::slice::copy_from_slice(), this function copies as much as possible within the common subset of the two slices, truncating the requested range instead of panicking if the slices do not match in size.
• create_descriptor_chain
  Test utility function to create a descriptor chain in guest memory.
• create_stop_oneshot 🔒
  Creates a oneshot channel, returning the rx end and adding the tx end to the provided Vec. Useful for creating oneshots that signal a virtqueue future to stop processing and exit.