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_max_allowed_delta_future_sec: i64,
25    pub utc_max_allowed_delta_past_sec: i64,
26    pub utc_start_at_startup: bool,
27    pub utc_start_at_startup_when_invalid_rtc: bool,
28}
29impl Config {
30    pub fn take_from_startup_handle() -> Self {
31        let config_vmo: zx::Vmo =
32            take_startup_handle(HandleInfo::new(HandleType::ComponentConfigVmo, 0))
33                .expect("Config VMO handle must be provided and cannot already have been taken.")
34                .into();
35        let config_size =
36            config_vmo.get_content_size().expect("must be able to read config vmo content size");
37        assert_ne!(config_size, 0, "config vmo must be non-empty");
38        let config_bytes =
39            config_vmo.read_to_vec(0, config_size).expect("must be able to read config vmo");
40        let checksum_length = u16::from_le_bytes([config_bytes[0], config_bytes[1]]) as usize;
41        let fidl_start = 2 + checksum_length;
42        let observed_checksum = &config_bytes[2..fidl_start];
43        let expected_checksum = vec![
44            0xfc, 0x9e, 0xf3, 0x32, 0x8a, 0xf5, 0x15, 0xde, 0x2a, 0xa7, 0x3f, 0x33, 0xbb, 0x0e,
45            0x65, 0x2c, 0x67, 0xcb, 0x4c, 0xed, 0xaa, 0xe5, 0x3a, 0x51, 0x9c, 0x63, 0x44, 0x8b,
46            0xd9, 0x61, 0x86, 0xcc,
47        ];
48        assert_eq!(
49            observed_checksum, expected_checksum,
50            "checksum from config VMO does not match expected checksum"
51        );
52        let fidl_config: FidlConfig = unpersist(&config_bytes[fidl_start..])
53            .expect("must be able to parse bytes as config FIDL");
54        Self {
55            back_off_time_between_pull_samples_sec: fidl_config
56                .back_off_time_between_pull_samples_sec,
57            disable_delays: fidl_config.disable_delays,
58            early_exit: fidl_config.early_exit,
59            first_sampling_delay_sec: fidl_config.first_sampling_delay_sec,
60            has_always_on_counter: fidl_config.has_always_on_counter,
61            has_real_time_clock: fidl_config.has_real_time_clock,
62            initial_frequency_ppm: fidl_config.initial_frequency_ppm,
63            max_frequency_error_ppm: fidl_config.max_frequency_error_ppm,
64            monitor_time_source_url: fidl_config.monitor_time_source_url,
65            monitor_uses_pull: fidl_config.monitor_uses_pull,
66            oscillator_error_std_dev_ppm: fidl_config.oscillator_error_std_dev_ppm,
67            power_topology_integration_enabled: fidl_config.power_topology_integration_enabled,
68            primary_time_source_url: fidl_config.primary_time_source_url,
69            primary_uses_pull: fidl_config.primary_uses_pull,
70            serve_fuchsia_time_alarms: fidl_config.serve_fuchsia_time_alarms,
71            serve_fuchsia_time_external_adjust: fidl_config.serve_fuchsia_time_external_adjust,
72            serve_test_protocols: fidl_config.serve_test_protocols,
73            utc_max_allowed_delta_future_sec: fidl_config.utc_max_allowed_delta_future_sec,
74            utc_max_allowed_delta_past_sec: fidl_config.utc_max_allowed_delta_past_sec,
75            utc_start_at_startup: fidl_config.utc_start_at_startup,
76            utc_start_at_startup_when_invalid_rtc: fidl_config
77                .utc_start_at_startup_when_invalid_rtc,
78        }
79    }
80    pub fn record_inspect(&self, inspector_node: &Node) {
81        inspector_node.record_int(
82            "back_off_time_between_pull_samples_sec",
83            self.back_off_time_between_pull_samples_sec,
84        );
85        inspector_node.record_bool("disable_delays", self.disable_delays);
86        inspector_node.record_bool("early_exit", self.early_exit);
87        inspector_node.record_int("first_sampling_delay_sec", self.first_sampling_delay_sec);
88        inspector_node.record_bool("has_always_on_counter", self.has_always_on_counter);
89        inspector_node.record_bool("has_real_time_clock", self.has_real_time_clock);
90        inspector_node.record_uint("initial_frequency_ppm", self.initial_frequency_ppm as u64);
91        inspector_node.record_uint("max_frequency_error_ppm", self.max_frequency_error_ppm as u64);
92        inspector_node.record_string("monitor_time_source_url", &self.monitor_time_source_url);
93        inspector_node.record_bool("monitor_uses_pull", self.monitor_uses_pull);
94        inspector_node
95            .record_uint("oscillator_error_std_dev_ppm", self.oscillator_error_std_dev_ppm as u64);
96        inspector_node.record_bool(
97            "power_topology_integration_enabled",
98            self.power_topology_integration_enabled,
99        );
100        inspector_node.record_string("primary_time_source_url", &self.primary_time_source_url);
101        inspector_node.record_bool("primary_uses_pull", self.primary_uses_pull);
102        inspector_node.record_bool("serve_fuchsia_time_alarms", self.serve_fuchsia_time_alarms);
103        inspector_node.record_bool(
104            "serve_fuchsia_time_external_adjust",
105            self.serve_fuchsia_time_external_adjust,
106        );
107        inspector_node.record_bool("serve_test_protocols", self.serve_test_protocols);
108        inspector_node
109            .record_int("utc_max_allowed_delta_future_sec", self.utc_max_allowed_delta_future_sec);
110        inspector_node
111            .record_int("utc_max_allowed_delta_past_sec", self.utc_max_allowed_delta_past_sec);
112        inspector_node.record_bool("utc_start_at_startup", self.utc_start_at_startup);
113        inspector_node.record_bool(
114            "utc_start_at_startup_when_invalid_rtc",
115            self.utc_start_at_startup_when_invalid_rtc,
116        );
117    }
118}