builtins/
debuglog_resource.rs

1// Copyright 2024 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use anyhow::{Error, format_err};
6use fidl_fuchsia_kernel as fkernel;
7use futures::prelude::*;
8use std::sync::Arc;
9use zx::Resource;
10
11/// An implementation of fuchsia.kernel.DebuglogResource protocol.
12pub struct DebuglogResource {
13    resource: Resource,
14}
15
16impl DebuglogResource {
17    /// `resource` must be the Debuglog resource.
18    pub fn new(resource: Resource) -> Result<Arc<Self>, Error> {
19        let resource_info = resource.info()?;
20        if resource_info.kind != zx::sys::ZX_RSRC_KIND_SYSTEM
21            || resource_info.base != zx::sys::ZX_RSRC_SYSTEM_DEBUGLOG_BASE
22            || resource_info.size != 1
23        {
24            return Err(format_err!("Debuglog resource not available."));
25        }
26        Ok(Arc::new(Self { resource }))
27    }
28
29    pub async fn serve(
30        self: Arc<Self>,
31        mut stream: fkernel::DebuglogResourceRequestStream,
32    ) -> Result<(), Error> {
33        while let Some(fkernel::DebuglogResourceRequest::Get { responder }) =
34            stream.try_next().await?
35        {
36            responder.send(self.resource.duplicate_handle(zx::Rights::SAME_RIGHTS)?)?;
37        }
38        Ok(())
39    }
40}
41
42#[cfg(test)]
43mod tests {
44    use super::*;
45    use fidl_fuchsia_kernel as fkernel;
46    use fuchsia_async as fasync;
47    use fuchsia_component::client::connect_to_protocol;
48
49    async fn get_debuglog_resource() -> Result<Resource, Error> {
50        let debuglog_resource_provider = connect_to_protocol::<fkernel::DebuglogResourceMarker>()?;
51        let debuglog_resource_handle = debuglog_resource_provider.get().await?;
52        Ok(Resource::from(debuglog_resource_handle))
53    }
54
55    async fn serve_debuglog_resource() -> Result<fkernel::DebuglogResourceProxy, Error> {
56        let debuglog_resource = get_debuglog_resource().await?;
57
58        let (proxy, stream) =
59            fidl::endpoints::create_proxy_and_stream::<fkernel::DebuglogResourceMarker>();
60        fasync::Task::local(
61            DebuglogResource::new(debuglog_resource)
62                .unwrap_or_else(|e| panic!("Error while creating debuglog resource service: {}", e))
63                .serve(stream)
64                .unwrap_or_else(|e| panic!("Error while serving debuglog resource service: {}", e)),
65        )
66        .detach();
67        Ok(proxy)
68    }
69
70    #[fuchsia::test]
71    async fn base_type_is_debuglog() -> Result<(), Error> {
72        let debuglog_resource_provider = serve_debuglog_resource().await?;
73        let debuglog_resource: Resource = debuglog_resource_provider.get().await?;
74        let resource_info = debuglog_resource.info()?;
75        assert_eq!(resource_info.kind, zx::sys::ZX_RSRC_KIND_SYSTEM);
76        assert_eq!(resource_info.base, zx::sys::ZX_RSRC_SYSTEM_DEBUGLOG_BASE);
77        assert_eq!(resource_info.size, 1);
78        Ok(())
79    }
80}
builtins/debuglog_resource.rs

builtins/
debuglog_resource.rs
