omaha_client_structured_config/
omaha-client-structured-config-lib_rust_config_lib_source.rs

1use fidl::unpersist;
2use fidl_cf_sc_internal_omahaclientstructuredconfig::Config as FidlConfig;
3use fuchsia_inspect::Node;
4use fuchsia_runtime::{take_startup_handle, HandleInfo, HandleType};
5use std::convert::TryInto;
6const EXPECTED_CHECKSUM: &[u8] = &[
7    0x70, 0x33, 0xd6, 0x73, 0x02, 0x0a, 0x40, 0x60, 0x94, 0xfa, 0x2b, 0x27, 0x15, 0x17, 0x86, 0x3c,
8    0x72, 0x5b, 0x0c, 0xd1, 0x8d, 0x78, 0xcc, 0xec, 0xce, 0x1b, 0xe8, 0x41, 0xed, 0x16, 0x58, 0xd4,
9];
10#[derive(Debug)]
11pub struct Config {
12    pub allow_reboot_when_idle: bool,
13    pub fuzz_percentage_range: u8,
14    pub periodic_interval_minutes: u16,
15    pub retry_delay_seconds: u16,
16    pub startup_delay_seconds: u16,
17}
18impl Config {
19    #[doc = r" Take the config startup handle and parse its contents."]
20    #[doc = r""]
21    #[doc = r" # Panics"]
22    #[doc = r""]
23    #[doc = r" If the config startup handle was already taken or if it is not valid."]
24    pub fn take_from_startup_handle() -> Self {
25        let handle_info = HandleInfo::new(HandleType::ComponentConfigVmo, 0);
26        let config_vmo: zx::Vmo =
27            take_startup_handle(handle_info).expect("Config VMO handle must be present.").into();
28        Self::from_vmo(&config_vmo).expect("Config VMO handle must be valid.")
29    }
30    #[doc = r" Parse `Self` from `vmo`."]
31    pub fn from_vmo(vmo: &zx::Vmo) -> Result<Self, Error> {
32        let config_size = vmo.get_content_size().map_err(Error::GettingContentSize)?;
33        let config_bytes = vmo.read_to_vec(0, config_size).map_err(Error::ReadingConfigBytes)?;
34        Self::from_bytes(&config_bytes)
35    }
36    #[doc = r" Parse `Self` from `bytes`."]
37    pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
38        let (checksum_len_bytes, bytes) = bytes.split_at_checked(2).ok_or(Error::TooFewBytes)?;
39        let checksum_len_bytes: [u8; 2] =
40            checksum_len_bytes.try_into().expect("previous call guaranteed 2 element slice");
41        let checksum_length = u16::from_le_bytes(checksum_len_bytes) as usize;
42        let (observed_checksum, bytes) =
43            bytes.split_at_checked(checksum_length).ok_or(Error::TooFewBytes)?;
44        if observed_checksum != EXPECTED_CHECKSUM {
45            return Err(Error::ChecksumMismatch { observed_checksum: observed_checksum.to_vec() });
46        }
47        let fidl_config: FidlConfig = unpersist(bytes).map_err(Error::Unpersist)?;
48        Ok(Self {
49            allow_reboot_when_idle: fidl_config.allow_reboot_when_idle,
50            fuzz_percentage_range: fidl_config.fuzz_percentage_range,
51            periodic_interval_minutes: fidl_config.periodic_interval_minutes,
52            retry_delay_seconds: fidl_config.retry_delay_seconds,
53            startup_delay_seconds: fidl_config.startup_delay_seconds,
54        })
55    }
56    pub fn record_inspect(&self, inspector_node: &Node) {
57        inspector_node.record_bool("allow_reboot_when_idle", self.allow_reboot_when_idle);
58        inspector_node.record_uint("fuzz_percentage_range", self.fuzz_percentage_range as u64);
59        inspector_node
60            .record_uint("periodic_interval_minutes", self.periodic_interval_minutes as u64);
61        inspector_node.record_uint("retry_delay_seconds", self.retry_delay_seconds as u64);
62        inspector_node.record_uint("startup_delay_seconds", self.startup_delay_seconds as u64);
63    }
64}
65#[derive(Debug)]
66pub enum Error {
67    #[doc = r" Failed to read the content size of the VMO."]
68    GettingContentSize(zx::Status),
69    #[doc = r" Failed to read the content of the VMO."]
70    ReadingConfigBytes(zx::Status),
71    #[doc = r" The VMO was too small for this config library."]
72    TooFewBytes,
73    #[doc = r" The VMO's config ABI checksum did not match this library's."]
74    ChecksumMismatch { observed_checksum: Vec<u8> },
75    #[doc = r" Failed to parse the non-checksum bytes of the VMO as this library's FIDL type."]
76    Unpersist(fidl::Error),
77}
78impl std::fmt::Display for Error {
79    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
80        match self {
81            Self::GettingContentSize(status) => {
82                write!(f, "Failed to get content size: {status}")
83            }
84            Self::ReadingConfigBytes(status) => {
85                write!(f, "Failed to read VMO content: {status}")
86            }
87            Self::TooFewBytes => {
88                write!(f, "VMO content is not large enough for this config library.")
89            }
90            Self::ChecksumMismatch { observed_checksum } => {
91                write!(
92                    f,
93                    "ABI checksum mismatch, expected {:?}, got {:?}",
94                    EXPECTED_CHECKSUM, observed_checksum,
95                )
96            }
97            Self::Unpersist(fidl_error) => {
98                write!(f, "Failed to parse contents of config VMO: {fidl_error}")
99            }
100        }
101    }
102}
103impl std::error::Error for Error {
104    #[allow(unused_parens, reason = "rustfmt errors without parens here")]
105    fn source(&self) -> Option<(&'_ (dyn std::error::Error + 'static))> {
106        match self {
107            Self::GettingContentSize(ref status) | Self::ReadingConfigBytes(ref status) => {
108                Some(status)
109            }
110            Self::TooFewBytes => None,
111            Self::ChecksumMismatch { .. } => None,
112            Self::Unpersist(ref fidl_error) => Some(fidl_error),
113        }
114    }
115    fn description(&self) -> &str {
116        match self {
117            Self::GettingContentSize(_) => "getting content size",
118            Self::ReadingConfigBytes(_) => "reading VMO contents",
119            Self::TooFewBytes => "VMO contents too small",
120            Self::ChecksumMismatch { .. } => "ABI checksum mismatch",
121            Self::Unpersist(_) => "FIDL parsing error",
122        }
123    }
124}
omaha_client_structured_config/omaha-client-structured-config-lib_rust_config_lib_source.rs

omaha_client_structured_config/
omaha-client-structured-config-lib_rust_config_lib_source.rs
