pub enum AdminRequest {
    Mount {
        device: ClientEnd<BlockMarker>,
        name: String,
        options: MountOptions,
        responder: AdminMountResponder,
    },
    Unmount {
        name: String,
        responder: AdminUnmountResponder,
    },
    GetDevicePath {
        fs_id: u64,
        responder: AdminGetDevicePathResponder,
    },
    WriteDataFile {
        filename: String,
        payload: Vmo,
        responder: AdminWriteDataFileResponder,
    },
    WipeStorage {
        blobfs_root: Option<ServerEnd<DirectoryMarker>>,
        blob_creator: Option<ServerEnd<BlobCreatorMarker>>,
        responder: AdminWipeStorageResponder,
    },
    ShredDataVolume {
        responder: AdminShredDataVolumeResponder,
    },
}
Expand description

Manages fshost lifecycle

Variants§

§

Mount

Fields

§device: ClientEnd<BlockMarker>
§name: String

Mounts the filesystem on the block device. The filesystem will be mounted in /fs/mnt/ (in fshost’s outgoing directory). This may or may not be supported depending on fshost configuration.

§

Unmount

Fields

§name: String

Unmounts a previously mounted filesystem.

§

GetDevicePath

Fields

§fs_id: u64

Returns the device path for the filesystem with the given fs_id.

§

WriteDataFile

Fields

§filename: String
§payload: Vmo

Writes filename into the data partition with contents from payload, formatting the data partition if it isn’t already formatted. Overwrites file if it already exists.

This can only be called while the data partition isn’t already mounted, which is typically in recovery builds where fshost is running with the ramdisk_image flag set.

§

WipeStorage

Fields

§blobfs_root: Option<ServerEnd<DirectoryMarker>>
§blob_creator: Option<ServerEnd<BlobCreatorMarker>>

Reprovision the first non-ramdisk FVM volume, and format/mount the blob partition. The formatted Blobfs instance can be accessed via the client end of blobfs_root; if no handle is provided, then blobfs won’t be formatted.

If fxblob is configured, blob_creator will be connected with the fxfs BlobCreator protocol, which should be used instead of creating blobs in the blobfs_root. blobfs_root will still be connected and can be used to read blobs. If fxblob is configured, but no handle is provided for blob_creator or for blobfs_root, the blob volume won’t be formatted. If a handle is provided for blob_creator but fxblob is not configured, the channel will be closed.

This function will pause the fshost block watcher regardless of success or failure. Requires fshost to be started with the ramdisk_image config option set to true.

WARNING: This will cause irreversible data loss. Use with caution.

TODO(https://fxbug.dev/42063480): This function unbinds all child drivers of the volume to be wiped. This can race with the fshost block device manager, which attempts to bind the FVM driver and unseal the zxcrypt volume.

§

ShredDataVolume

Wipes the data volume which will get reinitialised upon next boot. This is not cryptographically secure; the caller should take care to reset hardware keys.

Implementations§

source§

impl AdminRequest

source

pub fn into_mount( self ) -> Option<(ClientEnd<BlockMarker>, String, MountOptions, AdminMountResponder)>

source

pub fn into_unmount(self) -> Option<(String, AdminUnmountResponder)>

source

pub fn into_get_device_path(self) -> Option<(u64, AdminGetDevicePathResponder)>

source

pub fn into_write_data_file( self ) -> Option<(String, Vmo, AdminWriteDataFileResponder)>

source

pub fn into_wipe_storage( self ) -> Option<(Option<ServerEnd<DirectoryMarker>>, Option<ServerEnd<BlobCreatorMarker>>, AdminWipeStorageResponder)>

source

pub fn into_shred_data_volume(self) -> Option<AdminShredDataVolumeResponder>

source

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations§

source§

impl Debug for AdminRequest

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more