class Block
Defined at line 4333 of file fidling/gen/sdk/fidl/fuchsia.storage.block/fuchsia.storage.block/hlcpp/fuchsia/storage/block/cpp/fidl.h
Defines access to a device which is accessible in block-granularity chunks
for reading and writing.
Public Members
static const char[] Name_Public Methods
void ~Block ()void GetInfo (GetInfoCallback callback)Get information about the underlying block device.
void OpenSession (::fidl::InterfaceRequest< ::fuchsia::storage::block::Session> session)Opens a new FIFO-based session on the block device.
void OpenSessionWithOptions (::fidl::InterfaceRequest< ::fuchsia::storage::block::Session> session, ::std::vector< ::fuchsia::storage::block::BlockOffsetMapping> mappings)Opens a new FIFO-based session on the block device, with additional options.
# Mappings
The `mappings` argument is a list of logical -> physical block mappings, which the server
will transparently apply to device offsets in block FIFO requests within this session.
The mappings are logically contiguous starting from logical offset 0.
This interface is intended to be used internally between nested Block implementations, in
order to provide passthrough I/O. For example, a fixed partition map (e.g. GPT) will serve
a Block protocol for each partition, and will respond to OpenSession requests by calling
OpenSessionWithOptions on the underlying block device, providing mappings which translate
block offsets which are relative to (and bounded by) the partition to absolute offsets on
the device.
Mappings can only ever restrict the visible range of a device; servers will reject mappings
which exceed the range of the device.
If `mappings` is empty, the session channel will be closed with epitaph
`ZX_ERR_INVALID_ARGS`.
void GetTypeGuid (GetTypeGuidCallback callback)Gets the type GUID of the partition (if one exists).
If the partition has no type GUID, ZX_ERR_NOT_SUPPORTED is returned.
void GetInstanceGuid (GetInstanceGuidCallback callback)Gets the instance GUID of the partition (if one exists).
If the partition has no instance GUID, ZX_ERR_NOT_SUPPORTED is returned.
void GetName (GetNameCallback callback)Gets the name of the partition (if one exists).
If the partition has no name, ZX_ERR_NOT_SUPPORTED is returned.
void GetMetadata (GetMetadataCallback callback)Gets the metadata for the partition.
Fields may be absent if the partition doesn't have the given metadata.
void QuerySlices (::std::vector<uint64_t> start_slices, QuerySlicesCallback callback)Returns the number of contiguous allocated (or unallocated) vslices
starting from each vslice.
Returns ZX_ERR_NOT_SUPPORTED if the device is not a volume.
void GetVolumeInfo (GetVolumeInfoCallback callback)Returns the information about this volume and the volume manager it is embedded in.
Returns ZX_ERR_NOT_SUPPORTED if the device is not a volume.
void Extend (uint64_tstart_slice,uint64_tslice_count,ExtendCallbackcallback)
Extends the mapping of this partition.
The ability to extend the partition is dependent on having sufficient free space on the
underlying device, having sufficient free slots for tracking the bytes in the volume
manager header, and the partition limit (see VolumeManager.SetPartitionLimit).
Returns ZX_ERR_NOT_SUPPORTED if the device is not a volume.
void Shrink (uint64_tstart_slice,uint64_tslice_count,ShrinkCallbackcallback)
Shrinks a virtual partition. Returns `ZX_OK` if ANY slices are
freed, even if part of the requested range contains unallocated slices.
Returns ZX_ERR_NOT_SUPPORTED if the device is not a volume.
void Destroy (DestroyCallback callback)Destroys the current volume, removing it from the VolumeManager, and
freeing all underlying storage. The connection to the volume is also closed.
Returns ZX_ERR_NOT_SUPPORTED if the device is not a volume.