Struct devices::virtio::queue::packed_queue::PackedQueue

pub struct PackedQueue {
    mem: GuestMemory,
    event: Event,
    interrupt: Interrupt,
    size: u16,
    vector: u16,
    avail_index: PackedQueueIndex,
    use_index: PackedQueueIndex,
    signalled_used_index: PackedQueueIndex,
    features: u64,
    desc_table: GuestAddress,
    device_event_suppression: GuestAddress,
    driver_event_suppression: GuestAddress,
}

Fields

mem: GuestMemory

event: Event

interrupt: Interrupt

size: u16

vector: u16

avail_index: PackedQueueIndex

use_index: PackedQueueIndex

signalled_used_index: PackedQueueIndex

features: u64

desc_table: GuestAddress

device_event_suppression: GuestAddress

driver_event_suppression: GuestAddress

Implementations

impl PackedQueue

pub fn new( config: &QueueConfig, mem: &GuestMemory, event: Event, interrupt: Interrupt ) -> Result<Self>

Constructs an empty virtio queue with the given max_size.

pub fn vhost_user_reclaim(&mut self, _vring_base: u16)

pub fn next_avail_to_process(&self) -> u16

pub fn size(&self) -> u16

Return the actual size of the queue, as the driver may not set up a queue as big as the device allows.

pub fn vector(&self) -> u16

Getter for vector field

pub fn desc_table(&self) -> GuestAddress

Getter for descriptor area

pub fn avail_ring(&self) -> GuestAddress

Getter for driver area

pub fn used_ring(&self) -> GuestAddress

Getter for device area

pub fn event(&self) -> &Event

Get a reference to the queue’s “kick event”

pub fn interrupt(&self) -> &Interrupt

Get a reference to the queue’s interrupt

fn area_sizes( queue_size: u16, desc_table: GuestAddress, driver_area: GuestAddress, device_area: GuestAddress ) -> Vec<(GuestAddress, usize)>

fn set_avail_event(&mut self, event: PackedDescEvent)

Set the device event suppression

This field is used to specify the timing of when the driver notifies the device that the descriptor table is ready to be processed.

fn get_driver_event(&self) -> PackedDescEvent

pub fn peek(&mut self) -> Option<DescriptorChain>

Get the first available descriptor chain without removing it from the queue. Call pop_peeked to remove the returned descriptor chain from the queue.

pub(super) fn pop_peeked(&mut self, descriptor_chain: &DescriptorChain)

Remove the first available descriptor chain from the queue. This function should only be called immediately following peek and must be passed a reference to the same DescriptorChain returned by the most recent peek.

pub fn add_used(&mut self, desc_chain: DescriptorChain, len: u32)

Write to first descriptor in descriptor chain to mark descriptor chain as used

fn queue_wants_interrupt(&mut self) -> bool

Returns if the queue should have an interrupt sent based on its state.

pub fn trigger_interrupt(&mut self) -> bool

inject interrupt into guest on this queue return true: interrupt is injected into guest for this queue false: interrupt isn’t injected

pub fn ack_features(&mut self, features: u64)

Acknowledges that this set of features should be enabled on this queue.

pub fn snapshot(&self) -> Result<Value>

TODO: b/290307056 - Implement snapshot for packed virtqueue, add tests to validate.

pub fn restore( _queue_value: Value, _mem: &GuestMemory, _event: Event, _interrupt: Interrupt ) -> Result<PackedQueue>

TODO: b/290307056 - Implement restore for packed virtqueue, add tests to validate.

Trait Implementations

impl Debug for PackedQueue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.