fidl_fuchsia_memory_sampler/

fidl_fuchsia_memory_sampler.rs

// WARNING: This file is machine generated by fidlgen.

#![warn(clippy::all)]
#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]

use bitflags::bitflags;
use fidl::client::QueryResponseFut;
use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
use fidl::endpoints::{ControlHandle as _, Responder as _};
pub use fidl_fuchsia_memory_sampler__common::*;
use futures::future::{self, MaybeDone, TryFutureExt};
use zx_status;

#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct SamplerMarker;

impl fidl::endpoints::ProtocolMarker for SamplerMarker {
    type Proxy = SamplerProxy;
    type RequestStream = SamplerRequestStream;
    #[cfg(target_os = "fuchsia")]
    type SynchronousProxy = SamplerSynchronousProxy;

    const DEBUG_NAME: &'static str = "fuchsia.memory.sampler.Sampler";
}
impl fidl::endpoints::DiscoverableProtocolMarker for SamplerMarker {}

pub trait SamplerProxyInterface: Send + Sync {
    fn r#record_allocation(
        &self,
        payload: &SamplerRecordAllocationRequest,
    ) -> Result<(), fidl::Error>;
    fn r#record_deallocation(
        &self,
        payload: &SamplerRecordDeallocationRequest,
    ) -> Result<(), fidl::Error>;
    fn r#set_process_info(&self, payload: &SamplerSetProcessInfoRequest)
    -> Result<(), fidl::Error>;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct SamplerSynchronousProxy {
    client: fidl::client::sync::Client,
}

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for SamplerSynchronousProxy {
    type Proxy = SamplerProxy;
    type Protocol = SamplerMarker;

    fn from_channel(inner: fidl::Channel) -> Self {
        Self::new(inner)
    }

    fn into_channel(self) -> fidl::Channel {
        self.client.into_channel()
    }

    fn as_channel(&self) -> &fidl::Channel {
        self.client.as_channel()
    }
}

#[cfg(target_os = "fuchsia")]
impl SamplerSynchronousProxy {
    pub fn new(channel: fidl::Channel) -> Self {
        let protocol_name = <SamplerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
        Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
    }

    pub fn into_channel(self) -> fidl::Channel {
        self.client.into_channel()
    }

    /// Waits until an event arrives and returns it. It is safe for other
    /// threads to make concurrent requests while waiting for an event.
    pub fn wait_for_event(
        &self,
        deadline: zx::MonotonicInstant,
    ) -> Result<SamplerEvent, fidl::Error> {
        SamplerEvent::decode(self.client.wait_for_event(deadline)?)
    }

    /// Record an allocation.
    pub fn r#record_allocation(
        &self,
        mut payload: &SamplerRecordAllocationRequest,
    ) -> Result<(), fidl::Error> {
        self.client.send::<SamplerRecordAllocationRequest>(
            payload,
            0x6b0add9f7769824d,
            fidl::encoding::DynamicFlags::FLEXIBLE,
        )
    }

    /// Record a deallocation.
    pub fn r#record_deallocation(
        &self,
        mut payload: &SamplerRecordDeallocationRequest,
    ) -> Result<(), fidl::Error> {
        self.client.send::<SamplerRecordDeallocationRequest>(
            payload,
            0x503bff5ec34dbeeb,
            fidl::encoding::DynamicFlags::FLEXIBLE,
        )
    }

    /// Communicate relevant process information to facilitate symbolization.
    ///
    /// If called several times, the last `process_name` prevails, but the
    /// `module_map` is added to the existing map for the process. If a client
    /// needs to send a `module_map` that does not fit in a single message, they
    /// can split it and send it across several messages.
    pub fn r#set_process_info(
        &self,
        mut payload: &SamplerSetProcessInfoRequest,
    ) -> Result<(), fidl::Error> {
        self.client.send::<SamplerSetProcessInfoRequest>(
            payload,
            0x68a0557106e51783,
            fidl::encoding::DynamicFlags::FLEXIBLE,
        )
    }
}

#[cfg(target_os = "fuchsia")]
impl From<SamplerSynchronousProxy> for zx::Handle {
    fn from(value: SamplerSynchronousProxy) -> Self {
        value.into_channel().into()
    }
}

#[cfg(target_os = "fuchsia")]
impl From<fidl::Channel> for SamplerSynchronousProxy {
    fn from(value: fidl::Channel) -> Self {
        Self::new(value)
    }
}

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::FromClient for SamplerSynchronousProxy {
    type Protocol = SamplerMarker;

    fn from_client(value: fidl::endpoints::ClientEnd<SamplerMarker>) -> Self {
        Self::new(value.into_channel())
    }
}

#[derive(Debug, Clone)]
pub struct SamplerProxy {
    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
}

impl fidl::endpoints::Proxy for SamplerProxy {
    type Protocol = SamplerMarker;

    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
        Self::new(inner)
    }

    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
        self.client.into_channel().map_err(|client| Self { client })
    }

    fn as_channel(&self) -> &::fidl::AsyncChannel {
        self.client.as_channel()
    }
}

impl SamplerProxy {
    /// Create a new Proxy for fuchsia.memory.sampler/Sampler.
    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
        let protocol_name = <SamplerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
        Self { client: fidl::client::Client::new(channel, protocol_name) }
    }

    /// Get a Stream of events from the remote end of the protocol.
    ///
    /// # Panics
    ///
    /// Panics if the event stream was already taken.
    pub fn take_event_stream(&self) -> SamplerEventStream {
        SamplerEventStream { event_receiver: self.client.take_event_receiver() }
    }

    /// Record an allocation.
    pub fn r#record_allocation(
        &self,
        mut payload: &SamplerRecordAllocationRequest,
    ) -> Result<(), fidl::Error> {
        SamplerProxyInterface::r#record_allocation(self, payload)
    }

    /// Record a deallocation.
    pub fn r#record_deallocation(
        &self,
        mut payload: &SamplerRecordDeallocationRequest,
    ) -> Result<(), fidl::Error> {
        SamplerProxyInterface::r#record_deallocation(self, payload)
    }

    /// Communicate relevant process information to facilitate symbolization.
    ///
    /// If called several times, the last `process_name` prevails, but the
    /// `module_map` is added to the existing map for the process. If a client
    /// needs to send a `module_map` that does not fit in a single message, they
    /// can split it and send it across several messages.
    pub fn r#set_process_info(
        &self,
        mut payload: &SamplerSetProcessInfoRequest,
    ) -> Result<(), fidl::Error> {
        SamplerProxyInterface::r#set_process_info(self, payload)
    }
}

impl SamplerProxyInterface for SamplerProxy {
    fn r#record_allocation(
        &self,
        mut payload: &SamplerRecordAllocationRequest,
    ) -> Result<(), fidl::Error> {
        self.client.send::<SamplerRecordAllocationRequest>(
            payload,
            0x6b0add9f7769824d,
            fidl::encoding::DynamicFlags::FLEXIBLE,
        )
    }

    fn r#record_deallocation(
        &self,
        mut payload: &SamplerRecordDeallocationRequest,
    ) -> Result<(), fidl::Error> {
        self.client.send::<SamplerRecordDeallocationRequest>(
            payload,
            0x503bff5ec34dbeeb,
            fidl::encoding::DynamicFlags::FLEXIBLE,
        )
    }

    fn r#set_process_info(
        &self,
        mut payload: &SamplerSetProcessInfoRequest,
    ) -> Result<(), fidl::Error> {
        self.client.send::<SamplerSetProcessInfoRequest>(
            payload,
            0x68a0557106e51783,
            fidl::encoding::DynamicFlags::FLEXIBLE,
        )
    }
}

pub struct SamplerEventStream {
    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
}

impl std::marker::Unpin for SamplerEventStream {}

impl futures::stream::FusedStream for SamplerEventStream {
    fn is_terminated(&self) -> bool {
        self.event_receiver.is_terminated()
    }
}

impl futures::Stream for SamplerEventStream {
    type Item = Result<SamplerEvent, fidl::Error>;

    fn poll_next(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
            &mut self.event_receiver,
            cx
        )?) {
            Some(buf) => std::task::Poll::Ready(Some(SamplerEvent::decode(buf))),
            None => std::task::Poll::Ready(None),
        }
    }
}

#[derive(Debug)]
pub enum SamplerEvent {
    #[non_exhaustive]
    _UnknownEvent {
        /// Ordinal of the event that was sent.
        ordinal: u64,
    },
}

impl SamplerEvent {
    /// Decodes a message buffer as a [`SamplerEvent`].
    fn decode(
        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
    ) -> Result<SamplerEvent, fidl::Error> {
        let (bytes, _handles) = buf.split_mut();
        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
        debug_assert_eq!(tx_header.tx_id, 0);
        match tx_header.ordinal {
            _ if tx_header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => {
                Ok(SamplerEvent::_UnknownEvent { ordinal: tx_header.ordinal })
            }
            _ => Err(fidl::Error::UnknownOrdinal {
                ordinal: tx_header.ordinal,
                protocol_name: <SamplerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
            }),
        }
    }
}

/// A Stream of incoming requests for fuchsia.memory.sampler/Sampler.
pub struct SamplerRequestStream {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
    is_terminated: bool,
}

impl std::marker::Unpin for SamplerRequestStream {}

impl futures::stream::FusedStream for SamplerRequestStream {
    fn is_terminated(&self) -> bool {
        self.is_terminated
    }
}

impl fidl::endpoints::RequestStream for SamplerRequestStream {
    type Protocol = SamplerMarker;
    type ControlHandle = SamplerControlHandle;

    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
    }

    fn control_handle(&self) -> Self::ControlHandle {
        SamplerControlHandle { inner: self.inner.clone() }
    }

    fn into_inner(
        self,
    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
    {
        (self.inner, self.is_terminated)
    }

    fn from_inner(
        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
        is_terminated: bool,
    ) -> Self {
        Self { inner, is_terminated }
    }
}

impl futures::Stream for SamplerRequestStream {
    type Item = Result<SamplerRequest, fidl::Error>;

    fn poll_next(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        let this = &mut *self;
        if this.inner.check_shutdown(cx) {
            this.is_terminated = true;
            return std::task::Poll::Ready(None);
        }
        if this.is_terminated {
            panic!("polled SamplerRequestStream after completion");
        }
        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
            |bytes, handles| {
                match this.inner.channel().read_etc(cx, bytes, handles) {
                    std::task::Poll::Ready(Ok(())) => {}
                    std::task::Poll::Pending => return std::task::Poll::Pending,
                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
                        this.is_terminated = true;
                        return std::task::Poll::Ready(None);
                    }
                    std::task::Poll::Ready(Err(e)) => {
                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
                            e.into(),
                        ))));
                    }
                }

                // A message has been received from the channel
                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;

                std::task::Poll::Ready(Some(match header.ordinal {
                    0x6b0add9f7769824d => {
                        header.validate_request_tx_id(fidl::MethodType::OneWay)?;
                        let mut req = fidl::new_empty!(
                            SamplerRecordAllocationRequest,
                            fidl::encoding::DefaultFuchsiaResourceDialect
                        );
                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<SamplerRecordAllocationRequest>(&header, _body_bytes, handles, &mut req)?;
                        let control_handle = SamplerControlHandle { inner: this.inner.clone() };
                        Ok(SamplerRequest::RecordAllocation { payload: req, control_handle })
                    }
                    0x503bff5ec34dbeeb => {
                        header.validate_request_tx_id(fidl::MethodType::OneWay)?;
                        let mut req = fidl::new_empty!(
                            SamplerRecordDeallocationRequest,
                            fidl::encoding::DefaultFuchsiaResourceDialect
                        );
                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<SamplerRecordDeallocationRequest>(&header, _body_bytes, handles, &mut req)?;
                        let control_handle = SamplerControlHandle { inner: this.inner.clone() };
                        Ok(SamplerRequest::RecordDeallocation { payload: req, control_handle })
                    }
                    0x68a0557106e51783 => {
                        header.validate_request_tx_id(fidl::MethodType::OneWay)?;
                        let mut req = fidl::new_empty!(
                            SamplerSetProcessInfoRequest,
                            fidl::encoding::DefaultFuchsiaResourceDialect
                        );
                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<SamplerSetProcessInfoRequest>(&header, _body_bytes, handles, &mut req)?;
                        let control_handle = SamplerControlHandle { inner: this.inner.clone() };
                        Ok(SamplerRequest::SetProcessInfo { payload: req, control_handle })
                    }
                    _ if header.tx_id == 0
                        && header
                            .dynamic_flags()
                            .contains(fidl::encoding::DynamicFlags::FLEXIBLE) =>
                    {
                        Ok(SamplerRequest::_UnknownMethod {
                            ordinal: header.ordinal,
                            control_handle: SamplerControlHandle { inner: this.inner.clone() },
                            method_type: fidl::MethodType::OneWay,
                        })
                    }
                    _ if header
                        .dynamic_flags()
                        .contains(fidl::encoding::DynamicFlags::FLEXIBLE) =>
                    {
                        this.inner.send_framework_err(
                            fidl::encoding::FrameworkErr::UnknownMethod,
                            header.tx_id,
                            header.ordinal,
                            header.dynamic_flags(),
                            (bytes, handles),
                        )?;
                        Ok(SamplerRequest::_UnknownMethod {
                            ordinal: header.ordinal,
                            control_handle: SamplerControlHandle { inner: this.inner.clone() },
                            method_type: fidl::MethodType::TwoWay,
                        })
                    }
                    _ => Err(fidl::Error::UnknownOrdinal {
                        ordinal: header.ordinal,
                        protocol_name:
                            <SamplerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
                    }),
                }))
            },
        )
    }
}

/// Interface used to exfiltrate process allocation information.
#[derive(Debug)]
pub enum SamplerRequest {
    /// Record an allocation.
    RecordAllocation {
        payload: SamplerRecordAllocationRequest,
        control_handle: SamplerControlHandle,
    },
    /// Record a deallocation.
    RecordDeallocation {
        payload: SamplerRecordDeallocationRequest,
        control_handle: SamplerControlHandle,
    },
    /// Communicate relevant process information to facilitate symbolization.
    ///
    /// If called several times, the last `process_name` prevails, but the
    /// `module_map` is added to the existing map for the process. If a client
    /// needs to send a `module_map` that does not fit in a single message, they
    /// can split it and send it across several messages.
    SetProcessInfo { payload: SamplerSetProcessInfoRequest, control_handle: SamplerControlHandle },
    /// An interaction was received which does not match any known method.
    #[non_exhaustive]
    _UnknownMethod {
        /// Ordinal of the method that was called.
        ordinal: u64,
        control_handle: SamplerControlHandle,
        method_type: fidl::MethodType,
    },
}

impl SamplerRequest {
    #[allow(irrefutable_let_patterns)]
    pub fn into_record_allocation(
        self,
    ) -> Option<(SamplerRecordAllocationRequest, SamplerControlHandle)> {
        if let SamplerRequest::RecordAllocation { payload, control_handle } = self {
            Some((payload, control_handle))
        } else {
            None
        }
    }

    #[allow(irrefutable_let_patterns)]
    pub fn into_record_deallocation(
        self,
    ) -> Option<(SamplerRecordDeallocationRequest, SamplerControlHandle)> {
        if let SamplerRequest::RecordDeallocation { payload, control_handle } = self {
            Some((payload, control_handle))
        } else {
            None
        }
    }

    #[allow(irrefutable_let_patterns)]
    pub fn into_set_process_info(
        self,
    ) -> Option<(SamplerSetProcessInfoRequest, SamplerControlHandle)> {
        if let SamplerRequest::SetProcessInfo { payload, control_handle } = self {
            Some((payload, control_handle))
        } else {
            None
        }
    }

    /// Name of the method defined in FIDL
    pub fn method_name(&self) -> &'static str {
        match *self {
            SamplerRequest::RecordAllocation { .. } => "record_allocation",
            SamplerRequest::RecordDeallocation { .. } => "record_deallocation",
            SamplerRequest::SetProcessInfo { .. } => "set_process_info",
            SamplerRequest::_UnknownMethod { method_type: fidl::MethodType::OneWay, .. } => {
                "unknown one-way method"
            }
            SamplerRequest::_UnknownMethod { method_type: fidl::MethodType::TwoWay, .. } => {
                "unknown two-way method"
            }
        }
    }
}

#[derive(Debug, Clone)]
pub struct SamplerControlHandle {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
}

impl fidl::endpoints::ControlHandle for SamplerControlHandle {
    fn shutdown(&self) {
        self.inner.shutdown()
    }
    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
        self.inner.shutdown_with_epitaph(status)
    }

    fn is_closed(&self) -> bool {
        self.inner.channel().is_closed()
    }
    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
        self.inner.channel().on_closed()
    }

    #[cfg(target_os = "fuchsia")]
    fn signal_peer(
        &self,
        clear_mask: zx::Signals,
        set_mask: zx::Signals,
    ) -> Result<(), zx_status::Status> {
        use fidl::Peered;
        self.inner.channel().signal_peer(clear_mask, set_mask)
    }
}

impl SamplerControlHandle {}

mod internal {
    use super::*;
}