Struct devices::virtio::vhost_user_backend::wl::WlBackend

struct WlBackend {
    ex: Executor,
    wayland_paths: Option<BTreeMap<String, PathBuf>>,
    resource_bridge: Option<Tube>,
    use_transition_flags: bool,
    use_send_vfd_v2: bool,
    use_shmem: bool,
    features: u64,
    acked_features: u64,
    wlstate: Option<Rc<RefCell<WlState>>>,
    workers: [Option<WorkerState<Rc<RefCell<Queue>>, ()>>; 2],
    backend_req_conn: Option<VhostBackendReqConnection>,
}

Fields

ex: Executor

wayland_paths: Option<BTreeMap<String, PathBuf>>

resource_bridge: Option<Tube>

use_transition_flags: bool

use_send_vfd_v2: bool

use_shmem: bool

features: u64

acked_features: u64

wlstate: Option<Rc<RefCell<WlState>>>

workers: [Option<WorkerState<Rc<RefCell<Queue>>, ()>>; 2]

backend_req_conn: Option<VhostBackendReqConnection>

Implementations

impl WlBackend

fn new( ex: &Executor, wayland_paths: BTreeMap<String, PathBuf>, resource_bridge: Option<Tube>, ) -> WlBackend

Trait Implementations

impl VhostUserDevice for WlBackend

fn max_queue_num(&self) -> usize

The maximum number of queues that this backend can manage.

fn features(&self) -> u64

The set of feature bits that this backend supports.

fn ack_features(&mut self, value: u64) -> Result<()>

Acknowledges that this set of features should be enabled.

fn protocol_features(&self) -> VhostUserProtocolFeatures

The set of protocol feature bits that this backend supports.

fn read_config(&self, _offset: u64, _dst: &mut [u8])

Reads this device configuration space at offset.

fn start_queue( &mut self, idx: usize, queue: Queue, _mem: GuestMemory, ) -> Result<()>

Indicates that the backend should start processing requests for virtio queue number idx. This method must not block the current thread so device backends should either spawn an async task or another thread to handle messages from the Queue.

fn stop_queue(&mut self, idx: usize) -> Result<Queue>

Indicates that the backend should stop processing requests for virtio queue number idx. This method should return the queue passed to start_queue for the corresponding idx. This method will only be called for queues that were previously started by start_queue.

fn reset(&mut self)

Resets the vhost-user backend.

fn get_shared_memory_region(&self) -> Option<SharedMemoryRegion>

Returns the device’s shared memory region if present.

fn set_backend_req_connection(&mut self, conn: VhostBackendReqConnection)

Accepts VhostBackendReqConnection to conduct Vhost backend to frontend message handling.

fn enter_suspended_state(&mut self) -> Result<()>

Enter the “suspended device state” described in the vhost-user spec. See the spec for requirements.

fn snapshot(&mut self) -> Result<AnySnapshot>

Snapshot device and return serialized state.

fn restore(&mut self, _data: AnySnapshot) -> Result<()>

Restore device state from a snapshot.

fn write_config(&self, _offset: u64, _data: &[u8])

writes data to this device’s configuration space at offset.