sl4f_lib/tracing/
types.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 serde::{Deserialize, Serialize};
6
7/// Enum for supported Tracing commands.
8pub enum TracingMethod {
9    Initialize,
10    Start,
11    Stop,
12    Terminate,
13}
14
15#[derive(Deserialize)]
16pub struct InitializeRequest {
17    /// Categories to trace.
18    ///
19    /// Possible values:
20    /// * Omitted (None) for default categories
21    /// * Explicit empty list for all categories
22    /// * Explicit list of categories to trace
23    pub categories: Option<Vec<String>>,
24    /// Buffer size to use in MB
25    ///
26    /// Note: This size is only a suggestion to trace_manager. In particular, very large values
27    /// will likely not be respected.
28    pub buffer_size: Option<u32>,
29}
30
31/// What to do with trace data
32#[derive(Deserialize)]
33pub enum ResultsDestination {
34    /// Completely ignore trace data. Generally used to clean up a trace session left behind by
35    /// another trace controller.
36    Ignore,
37    /// Have trace manager write out the trace data, have the facade read it and return it in the
38    /// response to the terminate request.
39    WriteAndReturn,
40}
41
42impl Default for ResultsDestination {
43    fn default() -> Self {
44        ResultsDestination::WriteAndReturn
45    }
46}
47
48#[derive(Deserialize)]
49pub struct TerminateRequest {
50    /// Whether to download results from the trace. Defaults to ResultsDestination::WriteAndReturn
51    ///
52    /// Currently, the main use for ResultsDestination::Ignore to clean up a trace session left
53    /// behind by another trace controller.
54    #[serde(default)]
55    pub results_destination: ResultsDestination,
56}
57
58#[derive(Serialize)]
59pub struct TerminateResponse {
60    #[serde(skip_serializing_if = "Option::is_none")]
61    pub data: Option<String>,
62}
63
64impl std::str::FromStr for TracingMethod {
65    type Err = anyhow::Error;
66
67    fn from_str(method: &str) -> Result<Self, Self::Err> {
68        match method {
69            "Initialize" => Ok(TracingMethod::Initialize),
70            "Start" => Ok(TracingMethod::Start),
71            "Stop" => Ok(TracingMethod::Stop),
72            "Terminate" => Ok(TracingMethod::Terminate),
73            _ => return Err(format_err!("invalid Traceutil Facade method: {}", method)),
74        }
75    }
76}
sl4f_lib/tracing/types.rs

sl4f_lib/tracing/
types.rs
