Skip to main content

timekeeper_config/
timekeeper-config_rust_config_lib_source.rs

1use fidl::unpersist;
2use fidl_cf_sc_internal_timekeeperconfig::Config as FidlConfig;
3use fuchsia_component_config::{Config as ComponentConfig, Error};
4use fuchsia_inspect::Node;
5use std::convert::TryInto;
6const EXPECTED_CHECKSUM: &[u8] = &[
7    0x65, 0x89, 0xb7, 0x18, 0x1a, 0x7f, 0x80, 0xc4, 0x5f, 0x0f, 0x25, 0x9f, 0xab, 0x16, 0x65, 0x16,
8    0xd1, 0x28, 0x26, 0x91, 0xe2, 0x92, 0x30, 0x13, 0x5a, 0x4e, 0xf5, 0xd0, 0x4c, 0xe4, 0xa8, 0xbe,
9];
10const EXPECTED_CHECKSUM_LENGTH: [u8; 2] = (EXPECTED_CHECKSUM.len() as u16).to_le_bytes();
11#[derive(Debug)]
12pub struct Config {
13    pub back_off_time_between_pull_samples_sec: i64,
14    pub disable_delays: bool,
15    pub early_exit: bool,
16    pub first_sampling_delay_sec: i64,
17    pub has_always_on_counter: bool,
18    pub has_real_time_clock: bool,
19    pub initial_frequency_ppm: u32,
20    pub max_frequency_error_ppm: u32,
21    pub min_utc_reference_to_backstop_diff_minutes: u64,
22    pub monitor_time_source_url: String,
23    pub monitor_uses_pull: bool,
24    pub oscillator_error_std_dev_ppm: u32,
25    pub periodic_rtc_update_interval_minutes: u32,
26    pub power_topology_integration_enabled: bool,
27    pub primary_time_source_url: String,
28    pub primary_uses_pull: bool,
29    pub rtc_allow_setting_past_utc: String,
30    pub serve_fuchsia_time_alarms: bool,
31    pub serve_fuchsia_time_external_adjust: bool,
32    pub serve_test_protocols: bool,
33    pub use_connectivity: bool,
34    pub utc_max_allowed_delta_future_sec: i64,
35    pub utc_max_allowed_delta_past_sec: i64,
36    pub utc_start_at_startup: bool,
37    pub utc_start_at_startup_when_invalid_rtc: bool,
38}
39impl Config {
40    #[doc = r" Take the config startup handle and parse its contents."]
41    #[doc = r""]
42    #[doc = r" # Panics"]
43    #[doc = r""]
44    #[doc = r" If the config startup handle was already taken or if it is not valid."]
45    pub fn take_from_startup_handle() -> Self {
46        <Self as ComponentConfig>::take_from_startup_handle()
47    }
48    #[doc = r" Parse `Self` from `vmo`."]
49    pub fn from_vmo(vmo: &zx::Vmo) -> Result<Self, Error> {
50        <Self as ComponentConfig>::from_vmo(vmo)
51    }
52    #[doc = r" Parse `Self` from `bytes`."]
53    pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
54        <Self as ComponentConfig>::from_bytes(bytes)
55    }
56    pub fn record_inspect(&self, inspector_node: &Node) {
57        <Self as ComponentConfig>::record_inspect(self, inspector_node)
58    }
59}
60impl ComponentConfig for Config {
61    #[doc = r" Parse `Self` from `bytes`."]
62    fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
63        let (checksum_len_bytes, bytes) = bytes.split_at_checked(2).ok_or(Error::TooFewBytes)?;
64        let checksum_len_bytes: [u8; 2] =
65            checksum_len_bytes.try_into().expect("previous call guaranteed 2 element slice");
66        let checksum_length = u16::from_le_bytes(checksum_len_bytes) as usize;
67        let (observed_checksum, bytes) =
68            bytes.split_at_checked(checksum_length).ok_or(Error::TooFewBytes)?;
69        if observed_checksum != EXPECTED_CHECKSUM {
70            return Err(Error::ChecksumMismatch {
71                expected_checksum: EXPECTED_CHECKSUM.to_vec(),
72                observed_checksum: observed_checksum.to_vec(),
73            });
74        }
75        let fidl_config: FidlConfig = unpersist(bytes).map_err(Error::Unpersist)?;
76        Ok(Self {
77            back_off_time_between_pull_samples_sec: fidl_config
78                .back_off_time_between_pull_samples_sec,
79            disable_delays: fidl_config.disable_delays,
80            early_exit: fidl_config.early_exit,
81            first_sampling_delay_sec: fidl_config.first_sampling_delay_sec,
82            has_always_on_counter: fidl_config.has_always_on_counter,
83            has_real_time_clock: fidl_config.has_real_time_clock,
84            initial_frequency_ppm: fidl_config.initial_frequency_ppm,
85            max_frequency_error_ppm: fidl_config.max_frequency_error_ppm,
86            min_utc_reference_to_backstop_diff_minutes: fidl_config
87                .min_utc_reference_to_backstop_diff_minutes,
88            monitor_time_source_url: fidl_config.monitor_time_source_url,
89            monitor_uses_pull: fidl_config.monitor_uses_pull,
90            oscillator_error_std_dev_ppm: fidl_config.oscillator_error_std_dev_ppm,
91            periodic_rtc_update_interval_minutes: fidl_config.periodic_rtc_update_interval_minutes,
92            power_topology_integration_enabled: fidl_config.power_topology_integration_enabled,
93            primary_time_source_url: fidl_config.primary_time_source_url,
94            primary_uses_pull: fidl_config.primary_uses_pull,
95            rtc_allow_setting_past_utc: fidl_config.rtc_allow_setting_past_utc,
96            serve_fuchsia_time_alarms: fidl_config.serve_fuchsia_time_alarms,
97            serve_fuchsia_time_external_adjust: fidl_config.serve_fuchsia_time_external_adjust,
98            serve_test_protocols: fidl_config.serve_test_protocols,
99            use_connectivity: fidl_config.use_connectivity,
100            utc_max_allowed_delta_future_sec: fidl_config.utc_max_allowed_delta_future_sec,
101            utc_max_allowed_delta_past_sec: fidl_config.utc_max_allowed_delta_past_sec,
102            utc_start_at_startup: fidl_config.utc_start_at_startup,
103            utc_start_at_startup_when_invalid_rtc: fidl_config
104                .utc_start_at_startup_when_invalid_rtc,
105        })
106    }
107    fn to_bytes(&self) -> Result<Vec<u8>, Error> {
108        let fidl_config = FidlConfig {
109            back_off_time_between_pull_samples_sec: self
110                .back_off_time_between_pull_samples_sec
111                .clone(),
112            disable_delays: self.disable_delays.clone(),
113            early_exit: self.early_exit.clone(),
114            first_sampling_delay_sec: self.first_sampling_delay_sec.clone(),
115            has_always_on_counter: self.has_always_on_counter.clone(),
116            has_real_time_clock: self.has_real_time_clock.clone(),
117            initial_frequency_ppm: self.initial_frequency_ppm.clone(),
118            max_frequency_error_ppm: self.max_frequency_error_ppm.clone(),
119            min_utc_reference_to_backstop_diff_minutes: self
120                .min_utc_reference_to_backstop_diff_minutes
121                .clone(),
122            monitor_time_source_url: self.monitor_time_source_url.clone(),
123            monitor_uses_pull: self.monitor_uses_pull.clone(),
124            oscillator_error_std_dev_ppm: self.oscillator_error_std_dev_ppm.clone(),
125            periodic_rtc_update_interval_minutes: self.periodic_rtc_update_interval_minutes.clone(),
126            power_topology_integration_enabled: self.power_topology_integration_enabled.clone(),
127            primary_time_source_url: self.primary_time_source_url.clone(),
128            primary_uses_pull: self.primary_uses_pull.clone(),
129            rtc_allow_setting_past_utc: self.rtc_allow_setting_past_utc.clone(),
130            serve_fuchsia_time_alarms: self.serve_fuchsia_time_alarms.clone(),
131            serve_fuchsia_time_external_adjust: self.serve_fuchsia_time_external_adjust.clone(),
132            serve_test_protocols: self.serve_test_protocols.clone(),
133            use_connectivity: self.use_connectivity.clone(),
134            utc_max_allowed_delta_future_sec: self.utc_max_allowed_delta_future_sec.clone(),
135            utc_max_allowed_delta_past_sec: self.utc_max_allowed_delta_past_sec.clone(),
136            utc_start_at_startup: self.utc_start_at_startup.clone(),
137            utc_start_at_startup_when_invalid_rtc: self
138                .utc_start_at_startup_when_invalid_rtc
139                .clone(),
140        };
141        let mut fidl_bytes = fidl::persist(&fidl_config).map_err(Error::Persist)?;
142        let mut bytes = Vec::with_capacity(
143            EXPECTED_CHECKSUM_LENGTH.len() + EXPECTED_CHECKSUM.len() + fidl_bytes.len(),
144        );
145        bytes.extend_from_slice(&EXPECTED_CHECKSUM_LENGTH);
146        bytes.extend_from_slice(EXPECTED_CHECKSUM);
147        bytes.append(&mut fidl_bytes);
148        Ok(bytes)
149    }
150    fn record_inspect(&self, inspector_node: &Node) {
151        inspector_node.record_int(
152            "back_off_time_between_pull_samples_sec",
153            self.back_off_time_between_pull_samples_sec,
154        );
155        inspector_node.record_bool("disable_delays", self.disable_delays);
156        inspector_node.record_bool("early_exit", self.early_exit);
157        inspector_node.record_int("first_sampling_delay_sec", self.first_sampling_delay_sec);
158        inspector_node.record_bool("has_always_on_counter", self.has_always_on_counter);
159        inspector_node.record_bool("has_real_time_clock", self.has_real_time_clock);
160        inspector_node.record_uint("initial_frequency_ppm", self.initial_frequency_ppm as u64);
161        inspector_node.record_uint("max_frequency_error_ppm", self.max_frequency_error_ppm as u64);
162        inspector_node.record_uint(
163            "min_utc_reference_to_backstop_diff_minutes",
164            self.min_utc_reference_to_backstop_diff_minutes,
165        );
166        inspector_node.record_string("monitor_time_source_url", &self.monitor_time_source_url);
167        inspector_node.record_bool("monitor_uses_pull", self.monitor_uses_pull);
168        inspector_node
169            .record_uint("oscillator_error_std_dev_ppm", self.oscillator_error_std_dev_ppm as u64);
170        inspector_node.record_uint(
171            "periodic_rtc_update_interval_minutes",
172            self.periodic_rtc_update_interval_minutes as u64,
173        );
174        inspector_node.record_bool(
175            "power_topology_integration_enabled",
176            self.power_topology_integration_enabled,
177        );
178        inspector_node.record_string("primary_time_source_url", &self.primary_time_source_url);
179        inspector_node.record_bool("primary_uses_pull", self.primary_uses_pull);
180        inspector_node
181            .record_string("rtc_allow_setting_past_utc", &self.rtc_allow_setting_past_utc);
182        inspector_node.record_bool("serve_fuchsia_time_alarms", self.serve_fuchsia_time_alarms);
183        inspector_node.record_bool(
184            "serve_fuchsia_time_external_adjust",
185            self.serve_fuchsia_time_external_adjust,
186        );
187        inspector_node.record_bool("serve_test_protocols", self.serve_test_protocols);
188        inspector_node.record_bool("use_connectivity", self.use_connectivity);
189        inspector_node
190            .record_int("utc_max_allowed_delta_future_sec", self.utc_max_allowed_delta_future_sec);
191        inspector_node
192            .record_int("utc_max_allowed_delta_past_sec", self.utc_max_allowed_delta_past_sec);
193        inspector_node.record_bool("utc_start_at_startup", self.utc_start_at_startup);
194        inspector_node.record_bool(
195            "utc_start_at_startup_when_invalid_rtc",
196            self.utc_start_at_startup_when_invalid_rtc,
197        );
198    }
199}