timekeeper_config/
timekeeper-config_rust_config_lib_source.rs

1use fidl::unpersist;
2use fidl_cf_sc_internal_timekeeperconfig::Config as FidlConfig;
3use fuchsia_inspect::Node;
4use fuchsia_runtime::{take_startup_handle, HandleInfo, HandleType};
5#[derive(Debug)]
6pub struct Config {
7    pub back_off_time_between_pull_samples_sec: i64,
8    pub disable_delays: bool,
9    pub early_exit: bool,
10    pub first_sampling_delay_sec: i64,
11    pub has_always_on_counter: bool,
12    pub has_real_time_clock: bool,
13    pub initial_frequency_ppm: u32,
14    pub max_frequency_error_ppm: u32,
15    pub monitor_time_source_url: String,
16    pub monitor_uses_pull: bool,
17    pub oscillator_error_std_dev_ppm: u32,
18    pub power_topology_integration_enabled: bool,
19    pub primary_time_source_url: String,
20    pub primary_uses_pull: bool,
21    pub serve_fuchsia_time_alarms: bool,
22    pub serve_fuchsia_time_external_adjust: bool,
23    pub serve_test_protocols: bool,
24    pub utc_start_at_startup: bool,
25    pub utc_start_at_startup_when_invalid_rtc: bool,
26}
27impl Config {
28    pub fn take_from_startup_handle() -> Self {
29        let config_vmo: zx::Vmo =
30            take_startup_handle(HandleInfo::new(HandleType::ComponentConfigVmo, 0))
31                .expect("Config VMO handle must be provided and cannot already have been taken.")
32                .into();
33        let config_size =
34            config_vmo.get_content_size().expect("must be able to read config vmo content size");
35        assert_ne!(config_size, 0, "config vmo must be non-empty");
36        let config_bytes =
37            config_vmo.read_to_vec(0, config_size).expect("must be able to read config vmo");
38        let checksum_length = u16::from_le_bytes([config_bytes[0], config_bytes[1]]) as usize;
39        let fidl_start = 2 + checksum_length;
40        let observed_checksum = &config_bytes[2..fidl_start];
41        let expected_checksum = vec![
42            0x57, 0xa4, 0xe0, 0xd6, 0xc8, 0x1e, 0xf3, 0xbc, 0x17, 0x95, 0x7d, 0x16, 0x09, 0xea,
43            0xd1, 0x4c, 0xc1, 0xf3, 0x35, 0xf6, 0x1e, 0x82, 0xf7, 0x9c, 0xcc, 0x85, 0x61, 0x0d,
44            0x64, 0x33, 0x38, 0xf4,
45        ];
46        assert_eq!(
47            observed_checksum, expected_checksum,
48            "checksum from config VMO does not match expected checksum"
49        );
50        let fidl_config: FidlConfig = unpersist(&config_bytes[fidl_start..])
51            .expect("must be able to parse bytes as config FIDL");
52        Self {
53            back_off_time_between_pull_samples_sec: fidl_config
54                .back_off_time_between_pull_samples_sec,
55            disable_delays: fidl_config.disable_delays,
56            early_exit: fidl_config.early_exit,
57            first_sampling_delay_sec: fidl_config.first_sampling_delay_sec,
58            has_always_on_counter: fidl_config.has_always_on_counter,
59            has_real_time_clock: fidl_config.has_real_time_clock,
60            initial_frequency_ppm: fidl_config.initial_frequency_ppm,
61            max_frequency_error_ppm: fidl_config.max_frequency_error_ppm,
62            monitor_time_source_url: fidl_config.monitor_time_source_url,
63            monitor_uses_pull: fidl_config.monitor_uses_pull,
64            oscillator_error_std_dev_ppm: fidl_config.oscillator_error_std_dev_ppm,
65            power_topology_integration_enabled: fidl_config.power_topology_integration_enabled,
66            primary_time_source_url: fidl_config.primary_time_source_url,
67            primary_uses_pull: fidl_config.primary_uses_pull,
68            serve_fuchsia_time_alarms: fidl_config.serve_fuchsia_time_alarms,
69            serve_fuchsia_time_external_adjust: fidl_config.serve_fuchsia_time_external_adjust,
70            serve_test_protocols: fidl_config.serve_test_protocols,
71            utc_start_at_startup: fidl_config.utc_start_at_startup,
72            utc_start_at_startup_when_invalid_rtc: fidl_config
73                .utc_start_at_startup_when_invalid_rtc,
74        }
75    }
76    pub fn record_inspect(&self, inspector_node: &Node) {
77        inspector_node.record_int(
78            "back_off_time_between_pull_samples_sec",
79            self.back_off_time_between_pull_samples_sec,
80        );
81        inspector_node.record_bool("disable_delays", self.disable_delays);
82        inspector_node.record_bool("early_exit", self.early_exit);
83        inspector_node.record_int("first_sampling_delay_sec", self.first_sampling_delay_sec);
84        inspector_node.record_bool("has_always_on_counter", self.has_always_on_counter);
85        inspector_node.record_bool("has_real_time_clock", self.has_real_time_clock);
86        inspector_node.record_uint("initial_frequency_ppm", self.initial_frequency_ppm as u64);
87        inspector_node.record_uint("max_frequency_error_ppm", self.max_frequency_error_ppm as u64);
88        inspector_node.record_string("monitor_time_source_url", &self.monitor_time_source_url);
89        inspector_node.record_bool("monitor_uses_pull", self.monitor_uses_pull);
90        inspector_node
91            .record_uint("oscillator_error_std_dev_ppm", self.oscillator_error_std_dev_ppm as u64);
92        inspector_node.record_bool(
93            "power_topology_integration_enabled",
94            self.power_topology_integration_enabled,
95        );
96        inspector_node.record_string("primary_time_source_url", &self.primary_time_source_url);
97        inspector_node.record_bool("primary_uses_pull", self.primary_uses_pull);
98        inspector_node.record_bool("serve_fuchsia_time_alarms", self.serve_fuchsia_time_alarms);
99        inspector_node.record_bool(
100            "serve_fuchsia_time_external_adjust",
101            self.serve_fuchsia_time_external_adjust,
102        );
103        inspector_node.record_bool("serve_test_protocols", self.serve_test_protocols);
104        inspector_node.record_bool("utc_start_at_startup", self.utc_start_at_startup);
105        inspector_node.record_bool(
106            "utc_start_at_startup_when_invalid_rtc",
107            self.utc_start_at_startup_when_invalid_rtc,
108        );
109    }
110}