Struct vhost::net::Net

pub struct Net<T> {
    descriptor: File,
    phantom: PhantomData<T>,
}

Handle to run VHOST_NET ioctls.

This provides a simple wrapper around a VHOST_NET file descriptor and methods that safely run ioctls on that file descriptor.

Fields

descriptor: File

phantom: PhantomData<T>

Trait Implementations

impl<T> AsRawDescriptor for Net<T>

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl<T> NetT<T> for Net<T>

where T: TapT,

fn new(vhost_net_device_path: &Path) -> Result<Net<T>>

Opens /dev/vhost-net and holds a file descriptor open for it.

Arguments

• mem - Guest memory mapping.

fn set_backend(&self, queue_index: usize, event: Option<&T>) -> Result<()>

Set the tap file descriptor that will serve as the VHOST_NET backend. This will start the vhost worker for the given queue.

impl<T> Vhost for Net<T>

fn set_owner(&self) -> Result<()>

Set the current process as the owner of this file descriptor. This must be run before any other vhost ioctls.

fn reset_owner(&self) -> Result<()>

Give up ownership and reset the device to default values. Allows a subsequent call to set_owner to succeed.

fn get_features(&self) -> Result<u64>

Get a bitmask of supported virtio/vhost features.

fn set_features(&self, features: u64) -> Result<()>

Inform the vhost subsystem which features to enable. This should be a subset of supported features from VHOST_GET_FEATURES.

fn set_mem_table(&self, mem: &GuestMemory) -> Result<()>

Set the guest memory mappings for vhost to use.

fn set_vring_num(&self, queue_index: usize, num: u16) -> Result<()>

Set the number of descriptors in the vring.

fn set_vring_addr( &self, mem: &GuestMemory, queue_max_size: u16, queue_size: u16, queue_index: usize, flags: u32, desc_addr: GuestAddress, used_addr: GuestAddress, avail_addr: GuestAddress, log_addr: Option<GuestAddress> ) -> Result<()>

Set the addresses for a given vring.

fn set_vring_base(&self, queue_index: usize, num: u16) -> Result<()>

Set the first index to look for available descriptors.

fn get_vring_base(&self, queue_index: usize) -> Result<u16>

Gets the index of the next available descriptor in the queue.

fn set_vring_call(&self, queue_index: usize, event: &Event) -> Result<()>

Set the event to trigger when buffers have been used by the host.

fn set_vring_err(&self, queue_index: usize, event: &Event) -> Result<()>

Set the event to trigger to signal an error.

fn set_vring_kick(&self, queue_index: usize, event: &Event) -> Result<()>

Set the event that will be signaled by the guest when buffers are available for the host to process.