Struct devices::virtio::vhost::user::device::net::NetBackend

pub struct NetBackend<T: TapT + IntoAsync> {
    tap: T,
    avail_features: u64,
    acked_features: u64,
    mtu: u16,
    workers: [Option<(TaskHandle<Queue>, Sender<()>)>; 3],
}

Fields

tap: T

avail_features: u64

acked_features: u64

mtu: u16

workers: [Option<(TaskHandle<Queue>, Sender<()>)>; 3]

Implementations

impl<T> NetBackend<T>

where T: TapT + IntoAsync + 'static,

fn new_from_config(config: &TapConfig) -> Result<Self>

fn new_from_name(name: &str) -> Result<Self>

pub fn new_from_tap_fd(tap_fd: RawDescriptor) -> Result<Self>

pub fn new(tap: T) -> Result<Self>

impl<T> NetBackend<T>

where T: TapT + IntoAsync + 'static,

fn max_vq_pairs() -> usize

Trait Implementations

impl<T> AsRawDescriptors for NetBackend<T>

where T: TapT + IntoAsync + AsRawDescriptors + 'static,

fn as_raw_descriptors(&self) -> Vec<RawDescriptor>

Returns the underlying raw descriptors.

impl<T> VhostUserDevice for NetBackend<T>

where T: TapT + IntoAsync + 'static,

fn max_queue_num(&self) -> usize

The maximum number of queues that this backend can manage.

fn features(&self) -> u64

The set of feature bits that this backend supports.

fn ack_features(&mut self, value: u64) -> Result<()>

Acknowledges that this set of features should be enabled.

fn protocol_features(&self) -> VhostUserProtocolFeatures

The set of protocol feature bits that this backend supports.

fn read_config(&self, offset: u64, data: &mut [u8])

Reads this device configuration space at offset.

fn reset(&mut self)

Resets the vhost-user backend.

fn start_queue( &mut self, idx: usize, queue: Queue, mem: GuestMemory ) -> Result<()>

Indicates that the backend should start processing requests for virtio queue number idx. This method must not block the current thread so device backends should either spawn an async task or another thread to handle messages from the Queue.

fn stop_queue(&mut self, idx: usize) -> Result<Queue>

Indicates that the backend should stop processing requests for virtio queue number idx. This method should return the queue passed to start_queue for the corresponding idx. This method will only be called for queues that were previously started by start_queue.

fn enter_suspended_state(&mut self) -> Result<()>

Enter the “suspended device state” described in the vhost-user spec. See the spec for requirements.

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

Snapshot device and return serialized state.

fn restore(&mut self, data: Value) -> Result<()>

Restore device state from a snapshot.

fn write_config(&self, _offset: u64, _data: &[u8])

writes data to this device’s configuration space at offset.

fn get_shared_memory_region(&self) -> Option<SharedMemoryRegion>

Returns the device’s shared memory region if present.

fn set_backend_req_connection(&mut self, _conn: Arc<VhostBackendReqConnection>)

Accepts VhostBackendReqConnection to conduct Vhost backend to frontend message handling.

impl<T> VhostUserDeviceBuilder for NetBackend<T>

where T: TapT + IntoAsync + 'static,

fn build(self: Box<Self>, ex: &Executor) -> Result<Box<dyn Backend>>

Create the vhost-user device.