builtins/
stall_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::{format_err, Error};
6use fidl_fuchsia_kernel as fkernel;
7use futures::prelude::*;
8use std::sync::Arc;
9use zx::{self as zx, HandleBased, Resource};
10
11/// An implementation of fuchsia.kernel.StallResource protocol.
12pub struct StallResource {
13    resource: Resource,
14}
15
16impl StallResource {
17    /// `resource` must be the stall 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_STALL_BASE
22            || resource_info.size != 1
23        {
24            return Err(format_err!("Stall 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::StallResourceRequestStream,
32    ) -> Result<(), Error> {
33        while let Some(fkernel::StallResourceRequest::Get { responder }) = stream.try_next().await?
34        {
35            responder.send(self.resource.duplicate_handle(zx::Rights::SAME_RIGHTS)?)?;
36        }
37        Ok(())
38    }
39}
40
41#[cfg(test)]
42mod tests {
43    use super::*;
44    use fuchsia_component::client::connect_to_protocol;
45    use {fidl_fuchsia_kernel as fkernel, fuchsia_async as fasync};
46
47    async fn get_stall_resource() -> Result<Resource, Error> {
48        let stall_resource_provider = connect_to_protocol::<fkernel::StallResourceMarker>()?;
49        let stall_resource_handle = stall_resource_provider.get().await?;
50        Ok(Resource::from(stall_resource_handle))
51    }
52
53    async fn serve_stall_resource() -> Result<fkernel::StallResourceProxy, Error> {
54        let stall_resource = get_stall_resource().await?;
55
56        let (proxy, stream) =
57            fidl::endpoints::create_proxy_and_stream::<fkernel::StallResourceMarker>();
58        fasync::Task::local(
59            StallResource::new(stall_resource)
60                .unwrap_or_else(|e| panic!("Error while creating stall resource service: {}", e))
61                .serve(stream)
62                .unwrap_or_else(|e| panic!("Error while serving stall resource service: {}", e)),
63        )
64        .detach();
65        Ok(proxy)
66    }
67
68    #[fuchsia::test]
69    async fn kind_type_is_stall() -> Result<(), Error> {
70        let stall_resource_provider = serve_stall_resource().await?;
71        let stall_resource: Resource = stall_resource_provider.get().await?;
72        let resource_info = stall_resource.info()?;
73        assert_eq!(resource_info.kind, zx::sys::ZX_RSRC_KIND_SYSTEM);
74        assert_eq!(resource_info.base, zx::sys::ZX_RSRC_SYSTEM_STALL_BASE);
75        assert_eq!(resource_info.size, 1);
76        Ok(())
77    }
78}