hwinfo_structured_config/
hwinfo_structured_config_rust_config_lib_source.rs

1use fidl::unpersist;
2use fidl_cf_sc_internal_hwinfostructuredconfig::Config as FidlConfig;
3use fuchsia_inspect::Node;
4use fuchsia_runtime::{take_startup_handle, HandleInfo, HandleType};
5use std::convert::TryInto;
6const EXPECTED_CHECKSUM: &[u8] = &[
7    0xa4, 0x87, 0x1c, 0x22, 0x13, 0xd9, 0x41, 0xa7, 0xe1, 0xad, 0xa4, 0xf0, 0xc3, 0xb2, 0xdf, 0xbb,
8    0x24, 0x49, 0x70, 0x36, 0x35, 0xf0, 0x46, 0xeb, 0x1a, 0x5b, 0x0f, 0xaf, 0x13, 0x4c, 0x83, 0xcc,
9];
10#[derive(Debug)]
11pub struct Config {
12    pub product_manufacturer: String,
13    pub product_model: String,
14    pub product_name: String,
15}
16impl Config {
17    #[doc = r" Take the config startup handle and parse its contents."]
18    #[doc = r""]
19    #[doc = r" # Panics"]
20    #[doc = r""]
21    #[doc = r" If the config startup handle was already taken or if it is not valid."]
22    pub fn take_from_startup_handle() -> Self {
23        let handle_info = HandleInfo::new(HandleType::ComponentConfigVmo, 0);
24        let config_vmo: zx::Vmo =
25            take_startup_handle(handle_info).expect("Config VMO handle must be present.").into();
26        Self::from_vmo(&config_vmo).expect("Config VMO handle must be valid.")
27    }
28    #[doc = r" Parse `Self` from `vmo`."]
29    pub fn from_vmo(vmo: &zx::Vmo) -> Result<Self, Error> {
30        let config_size = vmo.get_content_size().map_err(Error::GettingContentSize)?;
31        let config_bytes = vmo.read_to_vec(0, config_size).map_err(Error::ReadingConfigBytes)?;
32        Self::from_bytes(&config_bytes)
33    }
34    #[doc = r" Parse `Self` from `bytes`."]
35    pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
36        let (checksum_len_bytes, bytes) = bytes.split_at_checked(2).ok_or(Error::TooFewBytes)?;
37        let checksum_len_bytes: [u8; 2] =
38            checksum_len_bytes.try_into().expect("previous call guaranteed 2 element slice");
39        let checksum_length = u16::from_le_bytes(checksum_len_bytes) as usize;
40        let (observed_checksum, bytes) =
41            bytes.split_at_checked(checksum_length).ok_or(Error::TooFewBytes)?;
42        if observed_checksum != EXPECTED_CHECKSUM {
43            return Err(Error::ChecksumMismatch { observed_checksum: observed_checksum.to_vec() });
44        }
45        let fidl_config: FidlConfig = unpersist(bytes).map_err(Error::Unpersist)?;
46        Ok(Self {
47            product_manufacturer: fidl_config.product_manufacturer,
48            product_model: fidl_config.product_model,
49            product_name: fidl_config.product_name,
50        })
51    }
52    pub fn record_inspect(&self, inspector_node: &Node) {
53        inspector_node.record_string("product_manufacturer", &self.product_manufacturer);
54        inspector_node.record_string("product_model", &self.product_model);
55        inspector_node.record_string("product_name", &self.product_name);
56    }
57}
58#[derive(Debug)]
59pub enum Error {
60    #[doc = r" Failed to read the content size of the VMO."]
61    GettingContentSize(zx::Status),
62    #[doc = r" Failed to read the content of the VMO."]
63    ReadingConfigBytes(zx::Status),
64    #[doc = r" The VMO was too small for this config library."]
65    TooFewBytes,
66    #[doc = r" The VMO's config ABI checksum did not match this library's."]
67    ChecksumMismatch { observed_checksum: Vec<u8> },
68    #[doc = r" Failed to parse the non-checksum bytes of the VMO as this library's FIDL type."]
69    Unpersist(fidl::Error),
70}
71impl std::fmt::Display for Error {
72    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
73        match self {
74            Self::GettingContentSize(status) => {
75                write!(f, "Failed to get content size: {status}")
76            }
77            Self::ReadingConfigBytes(status) => {
78                write!(f, "Failed to read VMO content: {status}")
79            }
80            Self::TooFewBytes => {
81                write!(f, "VMO content is not large enough for this config library.")
82            }
83            Self::ChecksumMismatch { observed_checksum } => {
84                write!(
85                    f,
86                    "ABI checksum mismatch, expected {:?}, got {:?}",
87                    EXPECTED_CHECKSUM, observed_checksum,
88                )
89            }
90            Self::Unpersist(fidl_error) => {
91                write!(f, "Failed to parse contents of config VMO: {fidl_error}")
92            }
93        }
94    }
95}
96impl std::error::Error for Error {
97    #[allow(unused_parens, reason = "rustfmt errors without parens here")]
98    fn source(&self) -> Option<(&'_ (dyn std::error::Error + 'static))> {
99        match self {
100            Self::GettingContentSize(ref status) | Self::ReadingConfigBytes(ref status) => {
101                Some(status)
102            }
103            Self::TooFewBytes => None,
104            Self::ChecksumMismatch { .. } => None,
105            Self::Unpersist(ref fidl_error) => Some(fidl_error),
106        }
107    }
108    fn description(&self) -> &str {
109        match self {
110            Self::GettingContentSize(_) => "getting content size",
111            Self::ReadingConfigBytes(_) => "reading VMO contents",
112            Self::TooFewBytes => "VMO contents too small",
113            Self::ChecksumMismatch { .. } => "ABI checksum mismatch",
114            Self::Unpersist(_) => "FIDL parsing error",
115        }
116    }
117}
hwinfo_structured_config/hwinfo_structured_config_rust_config_lib_source.rs

hwinfo_structured_config/
hwinfo_structured_config_rust_config_lib_source.rs
