Struct vhost_user_backend::VringState

pub struct VringState<M: GuestAddressSpace = GuestMemoryAtomic<GuestMemoryMmap>> { /* private fields */ }

Struct to maintain raw state information for a vhost-user queue.

This struct maintains all information of a virito queue, and could be used as an VringT object for single-threaded context.

Implementations

impl<M: GuestAddressSpace> VringState<M>

pub fn get_queue(&self) -> &Queue<M>

Get an immutable reference to the underlying raw Queue object.

pub fn get_queue_mut(&mut self) -> &mut Queue<M>

Get a mutable reference to the underlying raw Queue object.

pub fn add_used(
    &mut self,
    desc_index: u16,
    len: u32
) -> Result<(), VirtQueError>

Add an used descriptor into the used queue.

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

Notify the vhost-user master that used descriptors have been put into the used queue.

pub fn enable_notification(&mut self) -> Result<bool, VirtQueError>

Enable event notification for queue.

pub fn disable_notification(&mut self) -> Result<(), VirtQueError>

Disable event notification for queue.

pub fn needs_notification(&mut self) -> Result<bool, VirtQueError>

Check whether a notification to the guest is needed.

pub fn set_enabled(&mut self, enabled: bool)

Set vring enabled state.

pub fn set_queue_info(
    &mut self,
    desc_table: u64,
    avail_ring: u64,
    used_ring: u64
)

Set queue addresses for descriptor table, available ring and used ring.

pub fn get_kick(&self) -> &Option<EventFd>

Get the EventFd for kick.

pub fn get_call(&self) -> &Option<EventFd>

Get the EventFd for call.