Struct DebugProxy 

pub struct DebugProxy { /* private fields */ }

Implementations

impl DebugProxy

pub fn new(channel: Channel) -> Self

Create a new Proxy for fuchsia.fxfs/Debug.

pub fn take_event_stream(&self) -> DebugEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn compact( &self, ) -> QueryResponseFut<DebugCompactResult, FDomainResourceDialect>

Forces a compaction.

pub fn delete_profile( &self, volume: &str, profile: &str, ) -> QueryResponseFut<DebugDeleteProfileResult, FDomainResourceDialect>

Deletes a recorded profile from a volume. Fails if the volume isn’t mounted or there is active profile recording or replay.

pub fn record_and_replay_profile( &self, volume: Option<&str>, profile: &str, duration_secs: u32, ) -> QueryResponseFut<DebugRecordAndReplayProfileResult, FDomainResourceDialect>

Begins recording a profile for a named volume for up to the given duration in seconds. If a profile already exists under the given name then it will begin replaying it as well. Fails if the volume isn’t mounted or there is active profile recording or replay on the volume. Page faults for objects that do not get opened by a caller during the recording period will will be filtered out of the profile.

This “record-while-replaying” strategy is meant to support boot-profiling in an environment where we don’t explicitly know when the system has updated. By recording during replay and filtering objects without open events, Fxfs drops dead/replaced objects to refresh the profile.

pub fn replay_xor_record_profile( &self, volume: &str, profile: &str, duration_secs: u32, ) -> QueryResponseFut<DebugReplayXorRecordProfileResult, FDomainResourceDialect>

Replays a profile if one exists, and only records if one does not exist. Fails if the volume isn’t mounted or there is active profile recording or replay on the volume.

This profile method is meant to support app launch profiling. These profiles do not filter entries based on Open events since outside of the boot process objects may already be opened or cached in overlays like Starnix.

pub fn stop_profile_tasks( &self, ) -> QueryResponseFut<DebugStopProfileTasksResult, FDomainResourceDialect>

Stops all profile recording and replay activity. Ongoing recordings are completed and persisted.

Trait Implementations

impl Clone for DebugProxy

fn clone(&self) -> DebugProxy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DebugProxy

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

Formats the value using the given formatter.

impl DebugProxyInterface for DebugProxy

type CompactResponseFut = QueryResponseFut<Result<(), i32>, FDomainResourceDialect>

type DeleteProfileResponseFut = QueryResponseFut<Result<(), i32>, FDomainResourceDialect>

type RecordAndReplayProfileResponseFut = QueryResponseFut<Result<(), i32>, FDomainResourceDialect>

type ReplayXorRecordProfileResponseFut = QueryResponseFut<Result<(), i32>, FDomainResourceDialect>

type StopProfileTasksResponseFut = QueryResponseFut<Result<(), i32>, FDomainResourceDialect>

fn compact(&self) -> Self::CompactResponseFut

fn delete_profile( &self, volume: &str, profile: &str, ) -> Self::DeleteProfileResponseFut

fn record_and_replay_profile( &self, volume: Option<&str>, profile: &str, duration_secs: u32, ) -> Self::RecordAndReplayProfileResponseFut

fn replay_xor_record_profile( &self, volume: &str, profile: &str, duration_secs: u32, ) -> Self::ReplayXorRecordProfileResponseFut

fn stop_profile_tasks(&self) -> Self::StopProfileTasksResponseFut

impl Proxy for DebugProxy

type Protocol = DebugMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<Channel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn domain(&self) -> Arc<Client>

Get the client supporting this proxy. We call this a “domain” here because:

fn on_closed(&self) -> OnFDomainSignals

Returns a future that completes when the server receives the PEER_CLOSED signal.