Struct SplitQueue 

pub struct SplitQueue { /* private fields */ }

Single-owner, bounded split-virtqueue reference model.

Configuration preallocates descriptor, available, used, and ownership tables. Publication, consumption, completion, notification control, and reset perform no allocation or payload copy.

Implementations

impl SplitQueue

pub fn new( max_size: QueueSize, max_chain_descriptors: u16, ) -> Result<Self, SplitQueueInitError>

Construct an unconfigured queue.

pub const fn max_chain_descriptors(&self) -> u16

Maximum flattened descriptor count accepted by normal publication.

pub fn inject_available( &mut self, chain: DriverChain, ) -> Result<PublishedChain, PublishError<DriverChain, SplitQueueError>>

Inject a raw chain into the available ring, retaining malformed topology for device tests.

This differs from DriverQueue::publish only by bypassing profile validation. Descriptor table and available-ring capacity checks still apply.

pub fn set_empty_ring_index( &mut self, index: u16, ) -> Result<(), QueueError<SplitQueueError>>

Set all four ring indices while the configured queue owns no chains.

pub fn set_next_descriptor( &mut self, index: u16, ) -> Result<(), QueueError<SplitQueueError>>

Select the descriptor index at which the next bounded allocation scan begins.

pub fn ring_counters(&self) -> Option<RingCounters>

Return ring counters when storage is configured.

pub fn free_descriptors(&self) -> Option<u16>

Return the number of currently free descriptor-table entries.

Trait Implementations

impl Debug for SplitQueue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeviceQueue for SplitQueue

type Chain = SplitDeviceChain

Owned consumed-chain type.

type Error = SplitQueueError

Concrete transport failure.

fn pop_available( &mut self, ) -> Result<Option<Self::Chain>, QueueError<Self::Error>>

Consume one available descriptor chain.

fn complete( &mut self, chain: Self::Chain, used: UsedLength, ) -> Result<NotificationHint, QueueError<Self::Error>>

Publish one chain completion and consume its ownership token.

fn disable_available_notifications( &mut self, ) -> Result<(), QueueError<Self::Error>>

Disable available-ring notifications before draining work.

fn enable_available_notifications( &mut self, ) -> Result<NotificationRecheck, QueueError<Self::Error>>

Enable available-ring notifications and atomically recheck for missed work.

fn reset( &mut self, next_epoch: QueueEpoch, ) -> Result<(), QueueError<Self::Error>>

Invalidate all consumed chains from the old epoch and return the queue to its base state.

impl DriverQueue for SplitQueue

type Chain = DriverChain

Driver-owned command and descriptor resources.

type Reclaimed = ReclaimedChains

Owned collection of chains reclaimed by reset.

type Error = SplitQueueError

Concrete transport failure.

fn publish( &mut self, chain: Self::Chain, ) -> Result<PublishedChain, PublishError<Self::Chain, Self::Error>>

Publish a complete chain or return it unchanged on pre-publication backpressure.

fn pop_used( &mut self, ) -> Result<Option<UsedChain<Self::Chain>>, QueueError<Self::Error>>

Consume one used entry and recover the corresponding driver chain.

fn disable_used_notifications(&mut self) -> Result<(), QueueError<Self::Error>>

Disable used-ring notifications before draining completions.

fn enable_used_notifications( &mut self, ) -> Result<NotificationRecheck, QueueError<Self::Error>>

Enable used-ring notifications and atomically recheck for missed completions.

fn reset( &mut self, next_epoch: QueueEpoch, ) -> Result<Self::Reclaimed, QueueError<Self::Error>>

Invalidate the old epoch and recover every chain still owned by the queue.

impl QueueControl for SplitQueue

type Error = SplitQueueError

Concrete transport configuration error.

fn configure(&mut self, size: QueueSize) -> Result<(), QueueError<Self::Error>>

Configure queue size while the queue is not ready.

fn set_ready(&mut self, ready: bool) -> Result<(), QueueError<Self::Error>>

Enable or disable queue descriptor processing.

impl QueuePort for SplitQueue

fn state(&self) -> QueueState

Return a coherent queue-state snapshot.