builtins/
hypervisor_resource.rs

1// Copyright 2020 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.HypervisorResource protocol.
12pub struct HypervisorResource {
13    resource: Resource,
14}
15
16impl HypervisorResource {
17    /// `resource` must be the Hypervisor 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_HYPERVISOR_BASE
22            || resource_info.size != 1
23        {
24            return Err(format_err!("Hypervisor 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::HypervisorResourceRequestStream,
32    ) -> Result<(), Error> {
33        while let Some(fkernel::HypervisorResourceRequest::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 fuchsia_component::client::connect_to_protocol;
46    use {fidl_fuchsia_kernel as fkernel, fuchsia_async as fasync};
47
48    async fn get_hypervisor_resource() -> Result<Resource, Error> {
49        let hypervisor_resource_provider =
50            connect_to_protocol::<fkernel::HypervisorResourceMarker>()?;
51        let hypervisor_resource_handle = hypervisor_resource_provider.get().await?;
52        Ok(Resource::from(hypervisor_resource_handle))
53    }
54
55    async fn serve_hypervisor_resource() -> Result<fkernel::HypervisorResourceProxy, Error> {
56        let hypervisor_resource = get_hypervisor_resource().await?;
57
58        let (proxy, stream) =
59            fidl::endpoints::create_proxy_and_stream::<fkernel::HypervisorResourceMarker>();
60        fasync::Task::local(
61            HypervisorResource::new(hypervisor_resource)
62                .unwrap_or_else(|e| {
63                    panic!("Error while creating hypervisor resource service: {}", e)
64                })
65                .serve(stream)
66                .unwrap_or_else(|e| {
67                    panic!("Error while serving HYPERVISOR resource service: {}", e)
68                }),
69        )
70        .detach();
71        Ok(proxy)
72    }
73
74    #[fuchsia::test]
75    async fn kind_type_is_hypervisor() -> Result<(), Error> {
76        let hypervisor_resource_provider = serve_hypervisor_resource().await?;
77        let hypervisor_resource: Resource = hypervisor_resource_provider.get().await?;
78        let resource_info = hypervisor_resource.info()?;
79        assert_eq!(resource_info.kind, zx::sys::ZX_RSRC_KIND_SYSTEM);
80        assert_eq!(resource_info.base, zx::sys::ZX_RSRC_SYSTEM_HYPERVISOR_BASE);
81        assert_eq!(resource_info.size, 1);
82        Ok(())
83    }
84}