Struct BlockDevice

pub struct BlockDevice { /* private fields */ }

A storvsp disk backed by a raw block device.

Implementations

impl BlockDevice

pub async fn new( file: File, read_only: bool, uring: Arc<dyn Initiate>, uevent_listener: Option<&UeventListener>, bounce_buffer_tracker: Arc<BounceBufferTracker>, always_bounce: bool, ) -> Result<BlockDevice, NewDeviceError>

Constructs a new BlockDevice backed by the specified file.

Arguments

• file - The backing device opened for raw access.
• read_only - Indicates whether the device is opened for read-only access.
• uring - The IO uring to use for issuing IOs.
• always_bounce - Whether to always use bounce buffers for IOs, even for those that are aligned.

Trait Implementations

impl DiskIo for BlockDevice

fn disk_type(&self) -> &str

Returns the disk type name as a string.

fn sector_count(&self) -> u64

Returns the current sector count.

fn sector_size(&self) -> u32

Returns the logical sector size of the backing store.

fn disk_id(&self) -> Option<[u8; 16]>

Optionally returns a 16-byte identifier for the disk, if there is a natural one for this backing store.

fn physical_sector_size(&self) -> u32

Returns the physical sector size of the backing store.

fn is_fua_respected(&self) -> bool

Returns true if the fua parameter to [DiskIo::write_vectored] is respected by the backing store by ensuring that the IO is immediately committed to disk.

fn is_read_only(&self) -> bool

Returns true if the disk is read only.

fn pr(&self) -> Option<&dyn PersistentReservation>

Optionally returns a trait object to issue persistent reservation requests.

async fn eject(&self) -> Result<(), DiskError>

Issues an asynchronous eject media operation to the disk.

async fn read_vectored( &self, buffers: &RequestBuffers<'_>, sector: u64, ) -> Result<(), DiskError>

Issues an asynchronous read-scatter operation to the disk.

async fn write_vectored( &self, buffers: &RequestBuffers<'_>, sector: u64, fua: bool, ) -> Result<(), DiskError>

Issues an asynchronous write-gather operation to the disk.

async fn sync_cache(&self) -> Result<(), DiskError>

Issues an asynchronous flush operation to the disk.

async fn wait_resize(&self, sector_count: u64) -> u64

Waits for the disk sector size to be different than the specified value.

async fn unmap( &self, sector_offset: u64, sector_count: u64, _block_level_only: bool, ) -> Result<(), DiskError>

Unmap sectors from the layer.

fn unmap_behavior(&self) -> UnmapBehavior

Returns the behavior of the unmap operation.

fn optimal_unmap_sectors(&self) -> u32

Returns the optimal granularity for unmaps, in sectors.

impl Inspect for BlockDevice

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

Inspects the object.

impl PersistentReservation for BlockDevice

fn capabilities(&self) -> ReservationCapabilities

Returns the disk’s capabilities.

fn report<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ReservationReport, DiskError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a report of the current registration and reservation state.

fn register<'life0, 'async_trait>( &'life0 self, current_key: Option<u64>, new_key: u64, ptpl: Option<bool>, ) -> Pin<Box<dyn Future<Output = Result<(), DiskError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the registration for this client.

fn reserve<'life0, 'async_trait>( &'life0 self, key: u64, reservation_type: ReservationType, ) -> Pin<Box<dyn Future<Output = Result<(), DiskError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a reservation for this client with type reservation_type.

fn release<'life0, 'async_trait>( &'life0 self, key: u64, reservation_type: ReservationType, ) -> Pin<Box<dyn Future<Output = Result<(), DiskError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Releases the reservation for this client with type reservation_type.

fn clear<'life0, 'async_trait>( &'life0 self, key: u64, ) -> Pin<Box<dyn Future<Output = Result<(), DiskError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clears any reservation and registration for this client.

fn preempt<'life0, 'async_trait>( &'life0 self, current_key: u64, preempt_key: u64, reservation_type: ReservationType, abort: bool, ) -> Pin<Box<dyn Future<Output = Result<(), DiskError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Preempts an existing reservation. See the SCSI spec for the precise behavior of this.