Module devices::virtio::vhost::user::device::handler

Library for implementing vhost-user device executables.

This crate provides

• VhostUserDevice trait, which is a collection of methods to handle vhost-user requests, and
• DeviceRequestHandler struct, which makes a connection to a VMM and starts an event loop.

They are expected to be used as follows:

1. Define a struct and implement VhostUserDevice for it.
2. Create a DeviceRequestHandler with the backend struct.
3. Drive the DeviceRequestHandler::run async fn with an executor.

struct MyBackend {
  /* fields */
}

impl VhostUserDevice for MyBackend {
  /* implement methods */
}

fn main() -> Result<(), Box<dyn Error>> {
  let backend = MyBackend { /* initialize fields */ };
  let handler = DeviceRequestHandler::new(backend);
  let socket = std::path::Path("/path/to/socket");
  let ex = cros_async::Executor::new()?;

  if let Err(e) = ex.run_until(handler.run(socket, &ex)) {
    eprintln!("error happened: {}", e);
  }
  Ok(())
}

Modules

• sys 🔒

Structs

• DeviceRequestHandler
  An adapter that implements vmm_vhost::Backend for any type implementing VhostUserDevice.
• DeviceRequestHandlerSnapshot
• MappingInfo
  Keeps a mapping from the vmm’s virtual addresses to guest addresses. used to translate messages from the vmm to guest offsets.
• ShmemInfo 🔒
• VhostBackendReqConnection
  Keeps track of Vhost user backend request connection.
• VhostShmemMapper 🔒
• VhostUserRegularOps 🔒
  Ops for running vhost-user over a stream (i.e. regular protocol).
• Vring 🔒
  A virtio ring entry.
• VringSnapshot 🔒
• WorkerState 🔒

Enums

• Error
  Errors for device operations
• VhostBackendReqConnectionState
  Indicates the state of backend request connection

Traits

• VhostUserDevice
  Trait for vhost-user devices. Analogous to the VirtioDevice trait.

Functions

• vmm_va_to_gpa