Struct Wq

pub struct Wq { /* private fields */ }

A work queue (send or receive).

Implementations

impl Wq

pub fn new_sq(mem: MemoryBlock, doorbell: DoorbellPage, id: u32) -> Self

Creates a new send work queue.

pub fn new_rq(mem: MemoryBlock, doorbell: DoorbellPage, id: u32) -> Self

Creates a new receive work queue.

pub fn save(&self) -> WqSavedState

Save the state of the Wq for restoration after servicing

pub fn restore_rq( mem: MemoryBlock, state: WqSavedState, doorbell: DoorbellPage, ) -> Result<Self>

Restores an existing receive work queue.

pub fn restore_sq( mem: MemoryBlock, state: WqSavedState, doorbell: DoorbellPage, ) -> Result<Self>

Restores an existing send work queue.

pub fn id(&self) -> u32

Returns the queue ID.

pub fn advance_head(&mut self, n: u32)

Advances the head, indicating that n more bytes are available in the ring.

pub fn read(&mut self, offset: u32, n: usize) -> Vec<u8>

Reads from the offset, the first n bytes.

pub fn available(&self) -> u32

Returns the number of bytes available in the ring.

pub fn push<I: IntoIterator<Item = Sge>>( &mut self, oob: impl IntoBytes + Immutable + KnownLayout, sgl: I, ) -> Result<u32, QueueFull>

Pushes a new work queue entry with an inline out-of-band buffer and external data via a scatter-gather list.

pub fn wqe_builder( &mut self, oob: impl IntoBytes + Immutable + KnownLayout, ) -> WqeBuilder<'_>

Begins building a work queue entry with an inline out-of-band buffer.

pub fn commit(&mut self)

Commits all written entries by updating the doorbell value observed by the device.

pub fn get_tail(&mut self) -> u32

Reports tail value for diagnostics

Trait Implementations

impl Inspect for Wq

fn inspect(&self, req: Request<'_>)

Inspects the object.