Struct devices::virtio::video::worker::Worker

pub struct Worker {
    cmd_queue: Queue,
    event_queue: Queue,
    desc_map: AsyncCmdDescMap,
}

Worker that takes care of running the virtio video device.

Fields

cmd_queue: Queue

VirtIO queue for Command queue

event_queue: Queue

VirtIO queue for Event queue

desc_map: AsyncCmdDescMap

Stores descriptor chains in which responses for asynchronous commands will be written

Implementations

impl Worker

pub fn new(cmd_queue: Queue, event_queue: Queue) -> Self

fn write_responses( &mut self, responses: &mut VecDeque<(DescriptorChain, CmdResponse)>, ) -> Result<(), Error>

Writes responses into the command queue.

fn write_event(&mut self, event: VideoEvt) -> Result<(), Error>

Writes a VideoEvt into the event queue.

fn write_event_responses( &mut self, event_responses: Vec<VideoEvtResponseType>, stream_id: u32, ) -> Result<(), Error>

Writes the event_responses into the command queue or the event queue according to each response’s type.

Arguments

• event_responses - Responses to write
• stream_id - Stream session ID of the responses

fn handle_command_desc( &mut self, device: &mut dyn Device, wait_ctx: &WaitContext<Token>, desc: DescriptorChain, ) -> Result<VecDeque<(DescriptorChain, CmdResponse)>, Error>

Handles a DescriptorChain value sent via the command queue and returns a VecDeque of WritableResp to be sent to the guest.

Arguments

• device - Instance of backend device
• wait_ctx - device may register a new Token::Event for a new stream session to wait_ctx
• desc - DescriptorChain to handle

fn handle_command_queue( &mut self, device: &mut dyn Device, wait_ctx: &WaitContext<Token>, ) -> Result<(), Error>

Handles each command in the command queue.

Arguments

• device - Instance of backend device
• wait_ctx - device may register a new Token::Event for a new stream session to wait_ctx

fn handle_event( &mut self, device: &mut dyn Device, stream_id: u32, wait_ctx: &WaitContext<Token>, ) -> Result<(), Error>

Handles an event notified via an event.

Arguments

• device - Instance of backend device
• stream_id - Stream session ID of the event
• wait_ctx - device may register a new Token::Buffer for a new stream session to wait_ctx

fn handle_buffer_barrier( &mut self, device: &mut dyn Device, stream_id: u32, wait_ctx: &WaitContext<Token>, ) -> Result<(), Error>

Handles a completed buffer barrier.

Arguments

• device - Instance of backend device
• stream_id - Stream session ID of the event
• wait_ctx - device may deregister the completed Token::BufferBarrier from wait_ctx.

pub fn run( &mut self, device: Box<dyn Device>, kill_evt: &Event, ) -> Result<(), Error>

Runs the video device virtio queues in a blocking way.

Arguments

• device - Instance of backend device
• kill_evt - Event notified to make run stop and return

pub async fn run_async( self, device: Box<dyn Device>, ex: Executor, cmd_evt: Event, event_evt: Event, ) -> Result<(), Error>

Runs the video device virtio queues asynchronously.

Arguments

• device - Instance of backend device
• ex - Instance of Executor of asynchronous operations
• cmd_evt - Driver-to-device kick event for the command queue
• event_evt - Driver-to-device kick event for the event queue