fidl_fuchsia_driver_crash/

fidl_fuchsia_driver_crash.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_driver_crash_common::*;
use futures::future::{self, MaybeDone, TryFutureExt};
use zx_status;

#[derive(Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[repr(C)]
pub struct CrashIntrospectFindDriverCrashRequest {
    pub process_koid: u64,
    pub thread_koid: u64,
}

impl fidl::Standalone<fidl::encoding::DefaultFuchsiaResourceDialect>
    for CrashIntrospectFindDriverCrashRequest
{
}

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

impl fidl::endpoints::ProtocolMarker for CrashIntrospectMarker {
    type Proxy = CrashIntrospectProxy;
    type RequestStream = CrashIntrospectRequestStream;
    #[cfg(target_os = "fuchsia")]
    type SynchronousProxy = CrashIntrospectSynchronousProxy;

    const DEBUG_NAME: &'static str = "fuchsia.driver.crash.CrashIntrospect";
}
impl fidl::endpoints::DiscoverableProtocolMarker for CrashIntrospectMarker {}
pub type CrashIntrospectFindDriverCrashResult = Result<DriverCrashInfo, i32>;

pub trait CrashIntrospectProxyInterface: Send + Sync {
    type FindDriverCrashResponseFut: std::future::Future<Output = Result<CrashIntrospectFindDriverCrashResult, fidl::Error>>
        + Send;
    fn r#find_driver_crash(
        &self,
        process_koid: u64,
        thread_koid: u64,
    ) -> Self::FindDriverCrashResponseFut;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct CrashIntrospectSynchronousProxy {
    client: fidl::client::sync::Client,
}

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for CrashIntrospectSynchronousProxy {
    type Proxy = CrashIntrospectProxy;
    type Protocol = CrashIntrospectMarker;

    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 CrashIntrospectSynchronousProxy {
    pub fn new(channel: fidl::Channel) -> Self {
        Self { client: fidl::client::sync::Client::new(channel) }
    }

    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<CrashIntrospectEvent, fidl::Error> {
        CrashIntrospectEvent::decode(self.client.wait_for_event::<CrashIntrospectMarker>(deadline)?)
    }

    /// Given a process and thread koid, returns the information that was stored when the
    /// driver host observed a crash from that thread.
    ///
    /// The information for a crash is deleted when it is accessed.
    ///
    /// If there is no information available on the given thread koid,
    /// `zx::Status::NOT_FOUND` is returned.
    pub fn r#find_driver_crash(
        &self,
        mut process_koid: u64,
        mut thread_koid: u64,
        ___deadline: zx::MonotonicInstant,
    ) -> Result<CrashIntrospectFindDriverCrashResult, fidl::Error> {
        let _response = self.client.send_query::<
            CrashIntrospectFindDriverCrashRequest,
            fidl::encoding::ResultType<CrashIntrospectFindDriverCrashResponse, i32>,
            CrashIntrospectMarker,
        >(
            (process_koid, thread_koid,),
            0x41237ffcc46267bc,
            fidl::encoding::DynamicFlags::empty(),
            ___deadline,
        )?;
        Ok(_response.map(|x| x.info))
    }
}

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

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

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

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

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

impl fidl::endpoints::Proxy for CrashIntrospectProxy {
    type Protocol = CrashIntrospectMarker;

    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 CrashIntrospectProxy {
    /// Create a new Proxy for fuchsia.driver.crash/CrashIntrospect.
    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
        let protocol_name = <CrashIntrospectMarker 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) -> CrashIntrospectEventStream {
        CrashIntrospectEventStream { event_receiver: self.client.take_event_receiver() }
    }

    /// Given a process and thread koid, returns the information that was stored when the
    /// driver host observed a crash from that thread.
    ///
    /// The information for a crash is deleted when it is accessed.
    ///
    /// If there is no information available on the given thread koid,
    /// `zx::Status::NOT_FOUND` is returned.
    pub fn r#find_driver_crash(
        &self,
        mut process_koid: u64,
        mut thread_koid: u64,
    ) -> fidl::client::QueryResponseFut<
        CrashIntrospectFindDriverCrashResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    > {
        CrashIntrospectProxyInterface::r#find_driver_crash(self, process_koid, thread_koid)
    }
}

impl CrashIntrospectProxyInterface for CrashIntrospectProxy {
    type FindDriverCrashResponseFut = fidl::client::QueryResponseFut<
        CrashIntrospectFindDriverCrashResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    >;
    fn r#find_driver_crash(
        &self,
        mut process_koid: u64,
        mut thread_koid: u64,
    ) -> Self::FindDriverCrashResponseFut {
        fn _decode(
            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
        ) -> Result<CrashIntrospectFindDriverCrashResult, fidl::Error> {
            let _response = fidl::client::decode_transaction_body::<
                fidl::encoding::ResultType<CrashIntrospectFindDriverCrashResponse, i32>,
                fidl::encoding::DefaultFuchsiaResourceDialect,
                0x41237ffcc46267bc,
            >(_buf?)?;
            Ok(_response.map(|x| x.info))
        }
        self.client.send_query_and_decode::<
            CrashIntrospectFindDriverCrashRequest,
            CrashIntrospectFindDriverCrashResult,
        >(
            (process_koid, thread_koid,),
            0x41237ffcc46267bc,
            fidl::encoding::DynamicFlags::empty(),
            _decode,
        )
    }
}

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

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

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

impl futures::Stream for CrashIntrospectEventStream {
    type Item = Result<CrashIntrospectEvent, 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(CrashIntrospectEvent::decode(buf))),
            None => std::task::Poll::Ready(None),
        }
    }
}

#[derive(Debug)]
pub enum CrashIntrospectEvent {}

impl CrashIntrospectEvent {
    /// Decodes a message buffer as a [`CrashIntrospectEvent`].
    fn decode(
        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
    ) -> Result<CrashIntrospectEvent, 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 {
            _ => Err(fidl::Error::UnknownOrdinal {
                ordinal: tx_header.ordinal,
                protocol_name:
                    <CrashIntrospectMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
            }),
        }
    }
}

/// A Stream of incoming requests for fuchsia.driver.crash/CrashIntrospect.
pub struct CrashIntrospectRequestStream {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
    is_terminated: bool,
}

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

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

impl fidl::endpoints::RequestStream for CrashIntrospectRequestStream {
    type Protocol = CrashIntrospectMarker;
    type ControlHandle = CrashIntrospectControlHandle;

    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 {
        CrashIntrospectControlHandle { 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 CrashIntrospectRequestStream {
    type Item = Result<CrashIntrospectRequest, 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 CrashIntrospectRequestStream 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 {
                    0x41237ffcc46267bc => {
                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
                        let mut req = fidl::new_empty!(
                            CrashIntrospectFindDriverCrashRequest,
                            fidl::encoding::DefaultFuchsiaResourceDialect
                        );
                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<CrashIntrospectFindDriverCrashRequest>(&header, _body_bytes, handles, &mut req)?;
                        let control_handle =
                            CrashIntrospectControlHandle { inner: this.inner.clone() };
                        Ok(CrashIntrospectRequest::FindDriverCrash {
                            process_koid: req.process_koid,
                            thread_koid: req.thread_koid,

                            responder: CrashIntrospectFindDriverCrashResponder {
                                control_handle: std::mem::ManuallyDrop::new(control_handle),
                                tx_id: header.tx_id,
                            },
                        })
                    }
                    _ => Err(fidl::Error::UnknownOrdinal {
                        ordinal: header.ordinal,
                        protocol_name:
                            <CrashIntrospectMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
                    }),
                }))
            },
        )
    }
}

/// When a thread from a component using the driver runner crashes, the thread
/// koid along with other information is stored. This protocol can be used to
/// retrieve that stored information.
#[derive(Debug)]
pub enum CrashIntrospectRequest {
    /// Given a process and thread koid, returns the information that was stored when the
    /// driver host observed a crash from that thread.
    ///
    /// The information for a crash is deleted when it is accessed.
    ///
    /// If there is no information available on the given thread koid,
    /// `zx::Status::NOT_FOUND` is returned.
    FindDriverCrash {
        process_koid: u64,
        thread_koid: u64,
        responder: CrashIntrospectFindDriverCrashResponder,
    },
}

impl CrashIntrospectRequest {
    #[allow(irrefutable_let_patterns)]
    pub fn into_find_driver_crash(
        self,
    ) -> Option<(u64, u64, CrashIntrospectFindDriverCrashResponder)> {
        if let CrashIntrospectRequest::FindDriverCrash { process_koid, thread_koid, responder } =
            self
        {
            Some((process_koid, thread_koid, responder))
        } else {
            None
        }
    }

    /// Name of the method defined in FIDL
    pub fn method_name(&self) -> &'static str {
        match *self {
            CrashIntrospectRequest::FindDriverCrash { .. } => "find_driver_crash",
        }
    }
}

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

impl CrashIntrospectControlHandle {
    pub fn shutdown_with_epitaph(&self, status: impl Into<fidl::Epitaph>) {
        self.inner.shutdown_with_epitaph(status.into())
    }
}

impl fidl::endpoints::ControlHandle for CrashIntrospectControlHandle {
    fn shutdown(&self) {
        self.inner.shutdown()
    }

    fn shutdown_with_epitaph(&self, status: fidl::Epitaph) {
        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 CrashIntrospectControlHandle {}

#[must_use = "FIDL methods require a response to be sent"]
#[derive(Debug)]
pub struct CrashIntrospectFindDriverCrashResponder {
    control_handle: std::mem::ManuallyDrop<CrashIntrospectControlHandle>,
    tx_id: u32,
}

/// Set the the channel to be shutdown (see [`CrashIntrospectControlHandle::shutdown`])
/// if the responder is dropped without sending a response, so that the client
/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
impl std::ops::Drop for CrashIntrospectFindDriverCrashResponder {
    fn drop(&mut self) {
        self.control_handle.shutdown();
        // Safety: drops once, never accessed again
        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
    }
}

impl fidl::endpoints::Responder for CrashIntrospectFindDriverCrashResponder {
    type ControlHandle = CrashIntrospectControlHandle;

    fn control_handle(&self) -> &CrashIntrospectControlHandle {
        &self.control_handle
    }

    fn drop_without_shutdown(mut self) {
        // Safety: drops once, never accessed again due to mem::forget
        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
        // Prevent Drop from running (which would shut down the channel)
        std::mem::forget(self);
    }
}

impl CrashIntrospectFindDriverCrashResponder {
    /// Sends a response to the FIDL transaction.
    ///
    /// Sets the channel to shutdown if an error occurs.
    pub fn send(self, mut result: Result<&DriverCrashInfo, i32>) -> Result<(), fidl::Error> {
        let _result = self.send_raw(result);
        if _result.is_err() {
            self.control_handle.shutdown();
        }
        self.drop_without_shutdown();
        _result
    }

    /// Similar to "send" but does not shutdown the channel if an error occurs.
    pub fn send_no_shutdown_on_err(
        self,
        mut result: Result<&DriverCrashInfo, i32>,
    ) -> Result<(), fidl::Error> {
        let _result = self.send_raw(result);
        self.drop_without_shutdown();
        _result
    }

    fn send_raw(&self, mut result: Result<&DriverCrashInfo, i32>) -> Result<(), fidl::Error> {
        self.control_handle.inner.send::<fidl::encoding::ResultType<
            CrashIntrospectFindDriverCrashResponse,
            i32,
        >>(
            result.map(|info| (info,)),
            self.tx_id,
            0x41237ffcc46267bc,
            fidl::encoding::DynamicFlags::empty(),
        )
    }
}

mod internal {
    use super::*;

    impl fidl::encoding::ResourceTypeMarker for CrashIntrospectFindDriverCrashRequest {
        type Borrowed<'a> = &'a mut Self;
        fn take_or_borrow<'a>(
            value: &'a mut <Self as fidl::encoding::TypeMarker>::Owned,
        ) -> Self::Borrowed<'a> {
            value
        }
    }

    unsafe impl fidl::encoding::TypeMarker for CrashIntrospectFindDriverCrashRequest {
        type Owned = Self;

        #[inline(always)]
        fn inline_align(_context: fidl::encoding::Context) -> usize {
            8
        }

        #[inline(always)]
        fn inline_size(_context: fidl::encoding::Context) -> usize {
            16
        }
        #[inline(always)]
        fn encode_is_copy() -> bool {
            true
        }

        #[inline(always)]
        fn decode_is_copy() -> bool {
            true
        }
    }

    unsafe impl
        fidl::encoding::Encode<
            CrashIntrospectFindDriverCrashRequest,
            fidl::encoding::DefaultFuchsiaResourceDialect,
        > for &mut CrashIntrospectFindDriverCrashRequest
    {
        #[inline]
        unsafe fn encode(
            self,
            encoder: &mut fidl::encoding::Encoder<
                '_,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
            offset: usize,
            _depth: fidl::encoding::Depth,
        ) -> fidl::Result<()> {
            encoder.debug_check_bounds::<CrashIntrospectFindDriverCrashRequest>(offset);
            unsafe {
                // Copy the object into the buffer.
                let buf_ptr = encoder.buf.as_mut_ptr().add(offset);
                (buf_ptr as *mut CrashIntrospectFindDriverCrashRequest)
                    .write_unaligned((self as *const CrashIntrospectFindDriverCrashRequest).read());
                // Zero out padding regions. Unlike `fidl_struct_impl_noncopy!`, this must be
                // done second because the memcpy will write garbage to these bytes.
            }
            Ok(())
        }
    }
    unsafe impl<
        T0: fidl::encoding::Encode<u64, fidl::encoding::DefaultFuchsiaResourceDialect>,
        T1: fidl::encoding::Encode<u64, fidl::encoding::DefaultFuchsiaResourceDialect>,
    >
        fidl::encoding::Encode<
            CrashIntrospectFindDriverCrashRequest,
            fidl::encoding::DefaultFuchsiaResourceDialect,
        > for (T0, T1)
    {
        #[inline]
        unsafe fn encode(
            self,
            encoder: &mut fidl::encoding::Encoder<
                '_,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
            offset: usize,
            depth: fidl::encoding::Depth,
        ) -> fidl::Result<()> {
            encoder.debug_check_bounds::<CrashIntrospectFindDriverCrashRequest>(offset);
            // Zero out padding regions. There's no need to apply masks
            // because the unmasked parts will be overwritten by fields.
            // Write the fields.
            self.0.encode(encoder, offset + 0, depth)?;
            self.1.encode(encoder, offset + 8, depth)?;
            Ok(())
        }
    }

    impl fidl::encoding::Decode<Self, fidl::encoding::DefaultFuchsiaResourceDialect>
        for CrashIntrospectFindDriverCrashRequest
    {
        #[inline(always)]
        fn new_empty() -> Self {
            Self {
                process_koid: fidl::new_empty!(u64, fidl::encoding::DefaultFuchsiaResourceDialect),
                thread_koid: fidl::new_empty!(u64, fidl::encoding::DefaultFuchsiaResourceDialect),
            }
        }

        #[inline]
        unsafe fn decode(
            &mut self,
            decoder: &mut fidl::encoding::Decoder<
                '_,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
            offset: usize,
            _depth: fidl::encoding::Depth,
        ) -> fidl::Result<()> {
            decoder.debug_check_bounds::<Self>(offset);
            let buf_ptr = unsafe { decoder.buf.as_ptr().add(offset) };
            // Verify that padding bytes are zero.
            // Copy from the buffer into the object.
            unsafe {
                std::ptr::copy_nonoverlapping(buf_ptr, self as *mut Self as *mut u8, 16);
            }
            Ok(())
        }
    }
}