1use fidl::unpersist;
2use fidl_cf_sc_internal_driverindexconfig::Config as FidlConfig;
3use fuchsia_inspect::{ArrayProperty, Node};
4use fuchsia_runtime::{take_startup_handle, HandleInfo, HandleType};
5use std::convert::TryInto;
6const EXPECTED_CHECKSUM: &[u8] = &[
7 0x3c, 0x8f, 0x22, 0x9c, 0xa6, 0x41, 0xb9, 0x6e, 0xb8, 0x3e, 0x8c, 0xe1, 0xfd, 0xa9, 0x89, 0xbc,
8 0x75, 0x5b, 0xf0, 0xf0, 0x50, 0xc1, 0x55, 0xc8, 0x1a, 0xeb, 0xb0, 0x34, 0xce, 0x53, 0xe0, 0x43,
9];
10#[derive(Debug)]
11pub struct Config {
12 pub base_drivers: Vec<String>,
13 pub bind_eager: Vec<String>,
14 pub boot_drivers: Vec<String>,
15 pub delay_fallback_until_base_drivers_indexed: bool,
16 pub disabled_drivers: Vec<String>,
17 pub driver_load_fuzzer_max_delay_ms: i64,
18 pub enable_driver_load_fuzzer: bool,
19 pub enable_ephemeral_drivers: bool,
20 pub stop_on_idle_timeout_millis: i64,
21}
22impl Config {
23 #[doc = r" Take the config startup handle and parse its contents."]
24 #[doc = r""]
25 #[doc = r" # Panics"]
26 #[doc = r""]
27 #[doc = r" If the config startup handle was already taken or if it is not valid."]
28 pub fn take_from_startup_handle() -> Self {
29 let handle_info = HandleInfo::new(HandleType::ComponentConfigVmo, 0);
30 let config_vmo: zx::Vmo =
31 take_startup_handle(handle_info).expect("Config VMO handle must be present.").into();
32 Self::from_vmo(&config_vmo).expect("Config VMO handle must be valid.")
33 }
34 #[doc = r" Parse `Self` from `vmo`."]
35 pub fn from_vmo(vmo: &zx::Vmo) -> Result<Self, Error> {
36 let config_size = vmo.get_content_size().map_err(Error::GettingContentSize)?;
37 let config_bytes = vmo.read_to_vec(0, config_size).map_err(Error::ReadingConfigBytes)?;
38 Self::from_bytes(&config_bytes)
39 }
40 #[doc = r" Parse `Self` from `bytes`."]
41 pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
42 let (checksum_len_bytes, bytes) = bytes.split_at_checked(2).ok_or(Error::TooFewBytes)?;
43 let checksum_len_bytes: [u8; 2] =
44 checksum_len_bytes.try_into().expect("previous call guaranteed 2 element slice");
45 let checksum_length = u16::from_le_bytes(checksum_len_bytes) as usize;
46 let (observed_checksum, bytes) =
47 bytes.split_at_checked(checksum_length).ok_or(Error::TooFewBytes)?;
48 if observed_checksum != EXPECTED_CHECKSUM {
49 return Err(Error::ChecksumMismatch { observed_checksum: observed_checksum.to_vec() });
50 }
51 let fidl_config: FidlConfig = unpersist(bytes).map_err(Error::Unpersist)?;
52 Ok(Self {
53 base_drivers: fidl_config.base_drivers,
54 bind_eager: fidl_config.bind_eager,
55 boot_drivers: fidl_config.boot_drivers,
56 delay_fallback_until_base_drivers_indexed: fidl_config
57 .delay_fallback_until_base_drivers_indexed,
58 disabled_drivers: fidl_config.disabled_drivers,
59 driver_load_fuzzer_max_delay_ms: fidl_config.driver_load_fuzzer_max_delay_ms,
60 enable_driver_load_fuzzer: fidl_config.enable_driver_load_fuzzer,
61 enable_ephemeral_drivers: fidl_config.enable_ephemeral_drivers,
62 stop_on_idle_timeout_millis: fidl_config.stop_on_idle_timeout_millis,
63 })
64 }
65 pub fn record_inspect(&self, inspector_node: &Node) {
66 let arr = inspector_node.create_string_array("base_drivers", self.base_drivers.len());
67 for i in 0..self.base_drivers.len() {
68 arr.set(i, &self.base_drivers[i]);
69 }
70 inspector_node.record(arr);
71 let arr = inspector_node.create_string_array("bind_eager", self.bind_eager.len());
72 for i in 0..self.bind_eager.len() {
73 arr.set(i, &self.bind_eager[i]);
74 }
75 inspector_node.record(arr);
76 let arr = inspector_node.create_string_array("boot_drivers", self.boot_drivers.len());
77 for i in 0..self.boot_drivers.len() {
78 arr.set(i, &self.boot_drivers[i]);
79 }
80 inspector_node.record(arr);
81 inspector_node.record_bool(
82 "delay_fallback_until_base_drivers_indexed",
83 self.delay_fallback_until_base_drivers_indexed,
84 );
85 let arr =
86 inspector_node.create_string_array("disabled_drivers", self.disabled_drivers.len());
87 for i in 0..self.disabled_drivers.len() {
88 arr.set(i, &self.disabled_drivers[i]);
89 }
90 inspector_node.record(arr);
91 inspector_node
92 .record_int("driver_load_fuzzer_max_delay_ms", self.driver_load_fuzzer_max_delay_ms);
93 inspector_node.record_bool("enable_driver_load_fuzzer", self.enable_driver_load_fuzzer);
94 inspector_node.record_bool("enable_ephemeral_drivers", self.enable_ephemeral_drivers);
95 inspector_node.record_int("stop_on_idle_timeout_millis", self.stop_on_idle_timeout_millis);
96 }
97}
98#[derive(Debug)]
99pub enum Error {
100 #[doc = r" Failed to read the content size of the VMO."]
101 GettingContentSize(zx::Status),
102 #[doc = r" Failed to read the content of the VMO."]
103 ReadingConfigBytes(zx::Status),
104 #[doc = r" The VMO was too small for this config library."]
105 TooFewBytes,
106 #[doc = r" The VMO's config ABI checksum did not match this library's."]
107 ChecksumMismatch { observed_checksum: Vec<u8> },
108 #[doc = r" Failed to parse the non-checksum bytes of the VMO as this library's FIDL type."]
109 Unpersist(fidl::Error),
110}
111impl std::fmt::Display for Error {
112 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
113 match self {
114 Self::GettingContentSize(status) => {
115 write!(f, "Failed to get content size: {status}")
116 }
117 Self::ReadingConfigBytes(status) => {
118 write!(f, "Failed to read VMO content: {status}")
119 }
120 Self::TooFewBytes => {
121 write!(f, "VMO content is not large enough for this config library.")
122 }
123 Self::ChecksumMismatch { observed_checksum } => {
124 write!(
125 f,
126 "ABI checksum mismatch, expected {:?}, got {:?}",
127 EXPECTED_CHECKSUM, observed_checksum,
128 )
129 }
130 Self::Unpersist(fidl_error) => {
131 write!(f, "Failed to parse contents of config VMO: {fidl_error}")
132 }
133 }
134 }
135}
136impl std::error::Error for Error {
137 #[allow(unused_parens, reason = "rustfmt errors without parens here")]
138 fn source(&self) -> Option<(&'_ (dyn std::error::Error + 'static))> {
139 match self {
140 Self::GettingContentSize(ref status) | Self::ReadingConfigBytes(ref status) => {
141 Some(status)
142 }
143 Self::TooFewBytes => None,
144 Self::ChecksumMismatch { .. } => None,
145 Self::Unpersist(ref fidl_error) => Some(fidl_error),
146 }
147 }
148 fn description(&self) -> &str {
149 match self {
150 Self::GettingContentSize(_) => "getting content size",
151 Self::ReadingConfigBytes(_) => "reading VMO contents",
152 Self::TooFewBytes => "VMO contents too small",
153 Self::ChecksumMismatch { .. } => "ABI checksum mismatch",
154 Self::Unpersist(_) => "FIDL parsing error",
155 }
156 }
157}