1use fidl::unpersist;
2use fidl_cf_sc_internal_fshostconfig::Config as FidlConfig;
3use fuchsia_inspect::Node;
4use fuchsia_runtime::{take_startup_handle, HandleInfo, HandleType};
5use std::convert::TryInto;
6const EXPECTED_CHECKSUM: &[u8] = &[
7 0x9b, 0xce, 0x7a, 0x77, 0xf1, 0x44, 0xd5, 0x19, 0x26, 0xfc, 0x29, 0x00, 0xed, 0xbe, 0x9b, 0xfa,
8 0x37, 0xa3, 0x52, 0x65, 0xb4, 0x72, 0x48, 0xac, 0x1f, 0x94, 0xa8, 0x94, 0xb3, 0x4b, 0x39, 0x75,
9];
10#[derive(Debug)]
11pub struct Config {
12 pub blobfs: bool,
13 pub blobfs_cache_eviction_policy: String,
14 pub blobfs_initial_inodes: u64,
15 pub blobfs_max_bytes: u64,
16 pub blobfs_use_deprecated_padded_format: bool,
17 pub blobfs_write_compression_algorithm: String,
18 pub bootpart: bool,
19 pub check_filesystems: bool,
20 pub data: bool,
21 pub data_filesystem_format: String,
22 pub data_max_bytes: u64,
23 pub disable_automount: bool,
24 pub disable_block_watcher: bool,
25 pub factory: bool,
26 pub format_data_on_corruption: bool,
27 pub fvm: bool,
28 pub fvm_slice_size: u64,
29 pub fxfs_blob: bool,
30 pub fxfs_crypt_url: String,
31 pub gpt: bool,
32 pub gpt_all: bool,
33 pub inline_crypto: bool,
34 pub mbr: bool,
35 pub nand: bool,
36 pub netboot: bool,
37 pub no_zxcrypt: bool,
38 pub ramdisk_image: bool,
39 pub starnix_volume_name: String,
40 pub storage_host: bool,
41 pub use_disk_migration: bool,
42}
43impl Config {
44 #[doc = r" Take the config startup handle and parse its contents."]
45 #[doc = r""]
46 #[doc = r" # Panics"]
47 #[doc = r""]
48 #[doc = r" If the config startup handle was already taken or if it is not valid."]
49 pub fn take_from_startup_handle() -> Self {
50 let handle_info = HandleInfo::new(HandleType::ComponentConfigVmo, 0);
51 let config_vmo: zx::Vmo =
52 take_startup_handle(handle_info).expect("Config VMO handle must be present.").into();
53 Self::from_vmo(&config_vmo).expect("Config VMO handle must be valid.")
54 }
55 #[doc = r" Parse `Self` from `vmo`."]
56 pub fn from_vmo(vmo: &zx::Vmo) -> Result<Self, Error> {
57 let config_size = vmo.get_content_size().map_err(Error::GettingContentSize)?;
58 let config_bytes = vmo.read_to_vec(0, config_size).map_err(Error::ReadingConfigBytes)?;
59 Self::from_bytes(&config_bytes)
60 }
61 #[doc = r" Parse `Self` from `bytes`."]
62 pub 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 { observed_checksum: observed_checksum.to_vec() });
71 }
72 let fidl_config: FidlConfig = unpersist(bytes).map_err(Error::Unpersist)?;
73 Ok(Self {
74 blobfs: fidl_config.blobfs,
75 blobfs_cache_eviction_policy: fidl_config.blobfs_cache_eviction_policy,
76 blobfs_initial_inodes: fidl_config.blobfs_initial_inodes,
77 blobfs_max_bytes: fidl_config.blobfs_max_bytes,
78 blobfs_use_deprecated_padded_format: fidl_config.blobfs_use_deprecated_padded_format,
79 blobfs_write_compression_algorithm: fidl_config.blobfs_write_compression_algorithm,
80 bootpart: fidl_config.bootpart,
81 check_filesystems: fidl_config.check_filesystems,
82 data: fidl_config.data,
83 data_filesystem_format: fidl_config.data_filesystem_format,
84 data_max_bytes: fidl_config.data_max_bytes,
85 disable_automount: fidl_config.disable_automount,
86 disable_block_watcher: fidl_config.disable_block_watcher,
87 factory: fidl_config.factory,
88 format_data_on_corruption: fidl_config.format_data_on_corruption,
89 fvm: fidl_config.fvm,
90 fvm_slice_size: fidl_config.fvm_slice_size,
91 fxfs_blob: fidl_config.fxfs_blob,
92 fxfs_crypt_url: fidl_config.fxfs_crypt_url,
93 gpt: fidl_config.gpt,
94 gpt_all: fidl_config.gpt_all,
95 inline_crypto: fidl_config.inline_crypto,
96 mbr: fidl_config.mbr,
97 nand: fidl_config.nand,
98 netboot: fidl_config.netboot,
99 no_zxcrypt: fidl_config.no_zxcrypt,
100 ramdisk_image: fidl_config.ramdisk_image,
101 starnix_volume_name: fidl_config.starnix_volume_name,
102 storage_host: fidl_config.storage_host,
103 use_disk_migration: fidl_config.use_disk_migration,
104 })
105 }
106 pub fn record_inspect(&self, inspector_node: &Node) {
107 inspector_node.record_bool("blobfs", self.blobfs);
108 inspector_node
109 .record_string("blobfs_cache_eviction_policy", &self.blobfs_cache_eviction_policy);
110 inspector_node.record_uint("blobfs_initial_inodes", self.blobfs_initial_inodes);
111 inspector_node.record_uint("blobfs_max_bytes", self.blobfs_max_bytes);
112 inspector_node.record_bool(
113 "blobfs_use_deprecated_padded_format",
114 self.blobfs_use_deprecated_padded_format,
115 );
116 inspector_node.record_string(
117 "blobfs_write_compression_algorithm",
118 &self.blobfs_write_compression_algorithm,
119 );
120 inspector_node.record_bool("bootpart", self.bootpart);
121 inspector_node.record_bool("check_filesystems", self.check_filesystems);
122 inspector_node.record_bool("data", self.data);
123 inspector_node.record_string("data_filesystem_format", &self.data_filesystem_format);
124 inspector_node.record_uint("data_max_bytes", self.data_max_bytes);
125 inspector_node.record_bool("disable_automount", self.disable_automount);
126 inspector_node.record_bool("disable_block_watcher", self.disable_block_watcher);
127 inspector_node.record_bool("factory", self.factory);
128 inspector_node.record_bool("format_data_on_corruption", self.format_data_on_corruption);
129 inspector_node.record_bool("fvm", self.fvm);
130 inspector_node.record_uint("fvm_slice_size", self.fvm_slice_size);
131 inspector_node.record_bool("fxfs_blob", self.fxfs_blob);
132 inspector_node.record_string("fxfs_crypt_url", &self.fxfs_crypt_url);
133 inspector_node.record_bool("gpt", self.gpt);
134 inspector_node.record_bool("gpt_all", self.gpt_all);
135 inspector_node.record_bool("inline_crypto", self.inline_crypto);
136 inspector_node.record_bool("mbr", self.mbr);
137 inspector_node.record_bool("nand", self.nand);
138 inspector_node.record_bool("netboot", self.netboot);
139 inspector_node.record_bool("no_zxcrypt", self.no_zxcrypt);
140 inspector_node.record_bool("ramdisk_image", self.ramdisk_image);
141 inspector_node.record_string("starnix_volume_name", &self.starnix_volume_name);
142 inspector_node.record_bool("storage_host", self.storage_host);
143 inspector_node.record_bool("use_disk_migration", self.use_disk_migration);
144 }
145}
146#[derive(Debug)]
147pub enum Error {
148 #[doc = r" Failed to read the content size of the VMO."]
149 GettingContentSize(zx::Status),
150 #[doc = r" Failed to read the content of the VMO."]
151 ReadingConfigBytes(zx::Status),
152 #[doc = r" The VMO was too small for this config library."]
153 TooFewBytes,
154 #[doc = r" The VMO's config ABI checksum did not match this library's."]
155 ChecksumMismatch { observed_checksum: Vec<u8> },
156 #[doc = r" Failed to parse the non-checksum bytes of the VMO as this library's FIDL type."]
157 Unpersist(fidl::Error),
158}
159impl std::fmt::Display for Error {
160 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
161 match self {
162 Self::GettingContentSize(status) => {
163 write!(f, "Failed to get content size: {status}")
164 }
165 Self::ReadingConfigBytes(status) => {
166 write!(f, "Failed to read VMO content: {status}")
167 }
168 Self::TooFewBytes => {
169 write!(f, "VMO content is not large enough for this config library.")
170 }
171 Self::ChecksumMismatch { observed_checksum } => {
172 write!(
173 f,
174 "ABI checksum mismatch, expected {:?}, got {:?}",
175 EXPECTED_CHECKSUM, observed_checksum,
176 )
177 }
178 Self::Unpersist(fidl_error) => {
179 write!(f, "Failed to parse contents of config VMO: {fidl_error}")
180 }
181 }
182 }
183}
184impl std::error::Error for Error {
185 #[allow(unused_parens, reason = "rustfmt errors without parens here")]
186 fn source(&self) -> Option<(&'_ (dyn std::error::Error + 'static))> {
187 match self {
188 Self::GettingContentSize(ref status) | Self::ReadingConfigBytes(ref status) => {
189 Some(status)
190 }
191 Self::TooFewBytes => None,
192 Self::ChecksumMismatch { .. } => None,
193 Self::Unpersist(ref fidl_error) => Some(fidl_error),
194 }
195 }
196 fn description(&self) -> &str {
197 match self {
198 Self::GettingContentSize(_) => "getting content size",
199 Self::ReadingConfigBytes(_) => "reading VMO contents",
200 Self::TooFewBytes => "VMO contents too small",
201 Self::ChecksumMismatch { .. } => "ABI checksum mismatch",
202 Self::Unpersist(_) => "FIDL parsing error",
203 }
204 }
205}