diagnostics/task_metrics/
runtime_stats_source.rs

1// Copyright 2021 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 async_trait::async_trait;
6use fidl_fuchsia_component_runner::{ComponentDiagnostics, Task as DiagnosticsTask, TaskUnknown};
7use futures::channel::oneshot;
8use hooks::RuntimeInfo;
9use zx::{self as zx, sys as zx_sys, AsHandleRef, Task};
10
11/// Trait that all structs that behave as Task's implement.
12/// Used for simplying testing.
13#[async_trait]
14pub trait RuntimeStatsSource {
15    /// The koid of the Cpu stats source.
16    fn koid(&self) -> Result<zx_sys::zx_koid_t, zx::Status>;
17    /// The returned future will resolve when the task is terminated.
18    fn handle_ref(&self) -> zx::HandleRef<'_>;
19    /// Provides the runtime info containing the stats.
20    async fn get_runtime_info(&self) -> Result<zx::TaskRuntimeInfo, zx::Status>;
21}
22
23/// Trait for the container returned by a `DiagnosticsReceiverProvider`.
24/// Used for simplying testing.
25#[async_trait]
26pub trait RuntimeStatsContainer<T: RuntimeStatsSource> {
27    /// The task running a component.
28    fn take_component_task(&mut self) -> Option<T>;
29    /// An optional parent task running multiple components including `component_task`.
30    fn take_parent_task(&mut self) -> Option<T>;
31}
32
33/// Trait for the providers of asynchronous receivers where the diagnostics data is sent.
34/// Used for simplying testing.
35#[async_trait]
36pub trait ComponentStartedInfo<T, S>
37where
38    T: RuntimeStatsContainer<S>,
39    S: RuntimeStatsSource,
40{
41    /// Fetches a oneshot receiver that will eventually resolve to the diagnostics of a component
42    /// if the runner provides them.
43    async fn get_receiver(&self) -> Option<oneshot::Receiver<T>>;
44
45    /// Returns the reported start time.
46    fn start_time(&self) -> zx::BootInstant;
47}
48
49#[async_trait]
50impl RuntimeStatsSource for DiagnosticsTask {
51    fn koid(&self) -> Result<zx_sys::zx_koid_t, zx::Status> {
52        let info = match &self {
53            DiagnosticsTask::Job(job) => job.basic_info(),
54            DiagnosticsTask::Process(process) => process.basic_info(),
55            DiagnosticsTask::Thread(thread) => thread.basic_info(),
56            TaskUnknown!() => {
57                unreachable!("only jobs, threads and processes are tasks");
58            }
59        }?;
60        Ok(info.koid.raw_koid())
61    }
62
63    fn handle_ref(&self) -> zx::HandleRef<'_> {
64        match &self {
65            DiagnosticsTask::Job(job) => job.as_handle_ref(),
66            DiagnosticsTask::Process(process) => process.as_handle_ref(),
67            DiagnosticsTask::Thread(thread) => thread.as_handle_ref(),
68            TaskUnknown!() => {
69                unreachable!("only jobs, threads and processes are tasks");
70            }
71        }
72    }
73
74    async fn get_runtime_info(&self) -> Result<zx::TaskRuntimeInfo, zx::Status> {
75        match &self {
76            DiagnosticsTask::Job(job) => job.get_runtime_info(),
77            DiagnosticsTask::Process(process) => process.get_runtime_info(),
78            DiagnosticsTask::Thread(thread) => thread.get_runtime_info(),
79            TaskUnknown!() => {
80                unreachable!("only jobs, threads and processes are tasks");
81            }
82        }
83    }
84}
85
86#[async_trait]
87impl RuntimeStatsContainer<DiagnosticsTask> for ComponentDiagnostics {
88    fn take_component_task(&mut self) -> Option<DiagnosticsTask> {
89        self.tasks.as_mut().and_then(|tasks| tasks.component_task.take())
90    }
91
92    fn take_parent_task(&mut self) -> Option<DiagnosticsTask> {
93        self.tasks.as_mut().and_then(|tasks| tasks.parent_task.take())
94    }
95}
96
97#[async_trait]
98impl ComponentStartedInfo<ComponentDiagnostics, DiagnosticsTask> for RuntimeInfo {
99    async fn get_receiver(&self) -> Option<oneshot::Receiver<ComponentDiagnostics>> {
100        let mut receiver_guard = self.diagnostics_receiver.lock().await;
101        receiver_guard.take()
102    }
103
104    fn start_time(&self) -> zx::BootInstant {
105        self.start_time
106    }
107}
diagnostics/task_metrics/runtime_stats_source.rs

diagnostics/task_metrics/
runtime_stats_source.rs
