Struct GuestMemoryVirtQueue 

pub struct GuestMemoryVirtQueue { /* private fields */ }

A VirtIO split virtqueue backed by guest physical memory.

The queue addresses (desc, avail, used) are guest physical addresses set by the guest driver during device initialization. The ram_base pointer is the host virtual address corresponding to GPA 0.

Implementations

impl GuestMemoryVirtQueue

pub unsafe fn new( queue_idx: u16, size: u16, desc_gpa: u64, avail_gpa: u64, used_gpa: u64, ram_base: *mut u8, ram_size: usize, ) -> GuestMemoryVirtQueue

Creates a new guest memory virtqueue.

Safety

ram_base must point to a valid allocation of at least ram_size bytes that remains valid for the lifetime of this queue.

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

Enables event index feature (VIRTIO_F_EVENT_IDX).

pub fn queue_idx(&self) -> u16

Returns the queue index.

pub fn has_avail(&self) -> bool

Returns whether there are available descriptors to process.

pub fn pop_avail(&mut self) -> Option<DescriptorChain>

Pops the next available descriptor chain.

pub fn push_used(&mut self, head_idx: u16, len: u32)

Pushes a used buffer notification.

pub fn push_used_batch(&mut self, completions: &[(u16, u32)])

Pushes multiple used buffers with a single index update.

pub fn read_buffer(&self, gpa: u64, len: u32) -> Option<Vec<u8>>

Reads bytes from a guest buffer into a host Vec.

pub fn write_buffer(&self, gpa: u64, data: &[u8]) -> bool

Writes bytes from a host buffer into guest memory.

pub unsafe fn guest_slice(&self, gpa: u64, len: usize) -> Option<&[u8]>

Returns a raw host pointer for zero-copy access to a guest buffer.

Safety

The caller must ensure no concurrent modifications to the same guest memory region and that the returned pointer is not used after the queue (and its backing RAM) is dropped.

pub unsafe fn guest_slice_mut( &mut self, gpa: u64, len: usize, ) -> Option<&mut [u8]>

Returns a mutable raw host pointer for zero-copy write access.

Safety

Same requirements as guest_slice, plus exclusive access guarantee.

Trait Implementations

impl Send for GuestMemoryVirtQueue

impl Sync for GuestMemoryVirtQueue