Struct dbs_virtio_devices::VirtioQueueConfig

pub struct VirtioQueueConfig<Q: QueueT = QueueSync> {
    pub queue: Q,
    pub eventfd: Arc<EventFd>,
    /* private fields */
}

Virtio queue configuration information.

The VirtioQueueConfig maintains configuration information for a Virtio queue. It also provides methods to access the queue and associated interrupt/event notifiers.

Fields

queue: Q

Virtio queue object to access the associated queue.

eventfd: Arc<EventFd>

EventFd to receive queue notification from guest.

Implementations

impl<Q: QueueT> VirtioQueueConfig<Q>

pub fn new( queue: Q, eventfd: Arc<EventFd>, notifier: Arc<dyn InterruptNotifier>, index: u16 ) -> Self

Create a VirtioQueueConfig object.

pub fn create(queue_size: u16, index: u16) -> Result<Self>

Create a VirtioQueueConfig object with the specified queue size and index.

pub fn index(&self) -> u16

Get queue index.

pub fn queue(&self) -> &Q

Get immutable reference to the associated Virtio queue.

pub fn queue_mut(&mut self) -> &mut Q

Get mutable reference to the associated Virtio queue.

pub fn max_size(&self) -> u16

Get the maximum queue size.

pub fn get_next_descriptor<M>( &mut self, mem: M ) -> Result<Option<DescriptorChain<M>>>where M: Deref + Clone, M::Target: GuestMemory + Sized,

Get the next available descriptor.

pub fn add_used<M: GuestMemory>(&mut self, mem: &M, desc_index: u16, len: u32)

Put a used descriptor into the used ring.

pub fn consume_event(&self) -> Result<u64>

Consume a queue notification event.

pub fn generate_event(&self) -> Result<()>

Produce a queue notification event.

pub fn notify(&self) -> Result<()>

Inject an interrupt to the guest for queue change events.

pub fn set_interrupt_notifier(&mut self, notifier: Arc<dyn InterruptNotifier>)

Set interrupt notifier to inject interrupts to the guest.

pub fn actual_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.

Trait Implementations

impl<Q: QueueT + Clone> Clone for VirtioQueueConfig<Q>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.