diff --git a/Cargo.lock b/Cargo.lock index 5c4e4dc9..879304c2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -268,6 +268,16 @@ dependencies = [ "zip_structs", ] +[[package]] +name = "apple-device-tree" +version = "0.1.0" +dependencies = [ + "clap", + "scroll", + "serde", + "serde_json", +] + [[package]] name = "apple-dmg" version = "0.5.0" diff --git a/Cargo.toml b/Cargo.toml index 5b575c66..c38c62ad 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,6 +5,7 @@ members = [ 'apple-bom', 'apple-bundles', 'apple-codesign', + 'apple-device-tree', 'apple-dmg', 'apple-flat-package', 'apple-sdk', diff --git a/apple-device-tree/Cargo.toml b/apple-device-tree/Cargo.toml new file mode 100644 index 00000000..dc6d5e1e --- /dev/null +++ b/apple-device-tree/Cargo.toml @@ -0,0 +1,30 @@ +[package] +name = "apple-device-tree" +version = "0.1.0" +edition = "2021" +rust-version = "1.78" +license = "MIT OR Apache-2.0" +description = "Apple device tree format" +keywords = ["apple", "device-tree", "dtb"] +homepage = "https://github.com/indygreg/apple-platform-rs" +repository = "https://github.com/indygreg/apple-platform-rs.git" +readme = "README.md" + +[dependencies] +scroll = { version = "0.12.0", default-features = false, features = ["derive"] } +serde = { version = "1.0.207", default-features = false, features = [ + "derive", +], optional = true } + +[dev-dependencies] +clap = { version = "4.5.15", features = ["derive"] } +serde_json = "1.0.124" + +[features] +default = [] +serde = ["dep:serde"] + +[[example]] +name = "dtb-parse" +path = "examples/dtb-parse.rs" +required-features = ["serde"] diff --git a/apple-device-tree/LICENSE-APACHE b/apple-device-tree/LICENSE-APACHE new file mode 100644 index 00000000..605c0089 --- /dev/null +++ b/apple-device-tree/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 Gregory Szorc + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/apple-device-tree/LICENSE-MIT b/apple-device-tree/LICENSE-MIT new file mode 100644 index 00000000..155e26fa --- /dev/null +++ b/apple-device-tree/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright 2022 Gregory Szorc + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the +Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/apple-device-tree/examples/dtb-parse.rs b/apple-device-tree/examples/dtb-parse.rs new file mode 100644 index 00000000..4fcff2ce --- /dev/null +++ b/apple-device-tree/examples/dtb-parse.rs @@ -0,0 +1,43 @@ +use apple_device_tree::{serialize::string_for_node, DeviceTreeNode}; +use clap::Parser; +use scroll::ctx::TryFromCtx; +use scroll::Endian; +use std::fs::File; +use std::io::Read; +use std::path::Path; +use std::process::exit; + +#[derive(Parser)] +struct Opts { + #[clap(short, long)] + file: String, +} + +// Parse a device tree from a file +fn main() { + let opts: Opts = Opts::parse(); + let path = Path::new(&opts.file); + let mut file = match File::open(path) { + Ok(file) => file, + Err(e) => { + eprintln!("Failed to open file: {}", e); + exit(1); + } + }; + let mut buf = Vec::new(); + if let Err(e) = file.read_to_end(&mut buf) { + eprintln!("Failed to read file: {}", e); + exit(1); + } + + match DeviceTreeNode::try_from_ctx(&buf, Endian::Little) { + Ok((root_node, _)) => { + let json_output = string_for_node(&root_node); + println!("{}", serde_json::to_string_pretty(&json_output).unwrap()); + } + Err(e) => { + eprintln!("Failed to parse device tree: {}", e); + exit(1); + } + } +} diff --git a/apple-device-tree/src/deserialize.rs b/apple-device-tree/src/deserialize.rs new file mode 100644 index 00000000..bce05a13 --- /dev/null +++ b/apple-device-tree/src/deserialize.rs @@ -0,0 +1,68 @@ +use alloc::{string::ToString, vec::Vec}; +use scroll::{ + ctx::{self, StrCtx, TryFromCtx}, + Endian, Pread, +}; + +use crate::{DeviceTreeNode, DeviceTreeNodeProperty, PROP_NAME_LENGTH}; + +impl<'a> ctx::TryFromCtx<'a, Endian> for DeviceTreeNodeProperty { + type Error = scroll::Error; + + fn try_from_ctx(src: &'a [u8], ctx: Endian) -> Result<(Self, usize), Self::Error> { + let offset = &mut 0; + let name = src.gread_with::<&str>(offset, StrCtx::Length(PROP_NAME_LENGTH))?; + let length_with_flag: u32 = src.gread_with(offset, ctx)?; + let is_placeholder = (length_with_flag & (1 << 31)) != 0; + let length = length_with_flag & 0x7fffffff; + let aligned_length = (length + 3) & !3; + let mut value = Vec::new(); + for _ in 0..aligned_length { + value.push(src.gread_with(offset, ctx)?); + } + + Ok(( + DeviceTreeNodeProperty { + name: name.trim_end_matches('\0').to_string(), + length, + value, + is_placeholder, + }, + *offset, + )) + } +} + +impl<'a> ctx::TryFromCtx<'a, Endian> for DeviceTreeNode { + type Error = scroll::Error; + + fn try_from_ctx(src: &'a [u8], ctx: Endian) -> Result<(Self, usize), Self::Error> { + let offset = &mut 0; + let n_properties: u32 = src.gread_with(offset, ctx)?; + let n_children: u32 = src.gread_with(offset, ctx)?; + + let mut properties = Vec::new(); + for _ in 0..n_properties { + let prop: DeviceTreeNodeProperty = src.gread_with(offset, ctx)?; + properties.push(prop); + } + + let mut children = Vec::new(); + for _ in 0..n_children { + let child: DeviceTreeNode = src.gread_with(offset, ctx)?; + children.push(child); + } + + Ok(( + DeviceTreeNode { + properties, + children, + }, + *offset, + )) + } +} + +pub fn parse_device_tree(data: &[u8]) -> Result { + DeviceTreeNode::try_from_ctx(data, Endian::Little).map(|(node, _)| node) +} diff --git a/apple-device-tree/src/lib.rs b/apple-device-tree/src/lib.rs new file mode 100644 index 00000000..0b42964b --- /dev/null +++ b/apple-device-tree/src/lib.rs @@ -0,0 +1,43 @@ +#![no_std] + +extern crate alloc; + +pub mod deserialize; +pub mod serialize; + +use alloc::string::String; +use alloc::vec::Vec; +use scroll::ctx::SizeWith; +use scroll::Endian; + +pub const PROP_NAME_LENGTH: usize = 32; + +#[derive(Debug, Clone)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +#[repr(C)] +pub struct DeviceTreeNodeProperty { + pub name: String, + pub length: u32, + pub value: Vec, + pub is_placeholder: bool, +} + +#[derive(Debug, Clone)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +#[repr(C)] +pub struct DeviceTreeNode { + pub properties: Vec, + pub children: Vec, +} + +impl SizeWith for DeviceTreeNode { + fn size_with(_ctx: &Endian) -> usize { + core::mem::size_of::() + } +} + +impl SizeWith for DeviceTreeNodeProperty { + fn size_with(_ctx: &Endian) -> usize { + core::mem::size_of::() + core::mem::size_of::() + } +} diff --git a/apple-device-tree/src/serialize.rs b/apple-device-tree/src/serialize.rs new file mode 100644 index 00000000..730311cb --- /dev/null +++ b/apple-device-tree/src/serialize.rs @@ -0,0 +1,167 @@ +use core::str; + +use crate::{DeviceTreeNode, DeviceTreeNodeProperty, PROP_NAME_LENGTH}; +use alloc::{ + collections::btree_map::BTreeMap, + string::{String, ToString}, + vec::Vec, +}; +use scroll::{ + ctx::{self}, + Endian, Pread, Pwrite, +}; + +#[derive(Debug)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +#[cfg_attr(feature = "serde", serde(tag = "variant", content = "value"))] +#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))] +pub enum PropertyValue { + Empty, + StringArray(Vec), + String(String), + Placeholder(String), + Number(u64), + Bytes(Vec), +} + +fn value_for_property(property: &DeviceTreeNodeProperty) -> (String, PropertyValue) { + if property.length == 0 { + return (property.length.to_string(), PropertyValue::Empty); + } + + let (str_arr, is_str) = strings_from_property(property); + if is_str && !str_arr.is_empty() && str_arr[0].len() != 1 { + if str_arr.len() != 1 { + return ( + property.length.to_string(), + PropertyValue::StringArray(str_arr), + ); + } + if property.is_placeholder { + return ( + property.length.to_string(), + PropertyValue::Placeholder(str_arr[0].clone()), + ); + } else { + return ( + property.length.to_string(), + PropertyValue::String(str_arr[0].clone()), + ); + } + } + + if property.length == 4 { + let value: u32 = property.value.pread_with(0, Endian::Little).unwrap_or(0); + return ( + property.length.to_string(), + PropertyValue::Number(value as u64), + ); + } + + if property.length == 8 { + let value: u64 = property.value.pread_with(0, Endian::Little).unwrap_or(0); + return (property.length.to_string(), PropertyValue::Number(value)); + } + + ( + property.length.to_string(), + PropertyValue::Bytes(property.value.clone()), + ) +} + +pub fn string_for_node(node: &DeviceTreeNode) -> BTreeMap> { + let mut properties = BTreeMap::new(); + let mut node_name = String::new(); + + for property in &node.properties { + let prop_name = property.name.trim_end_matches('\0'); + if prop_name == "name" { + if let (_, PropertyValue::String(name)) = value_for_property(property) { + node_name = name; + } + } else { + let (_size, property_value) = value_for_property(property); + properties.insert(prop_name.to_string(), property_value); + } + } + + if !node.children.is_empty() { + let children: BTreeMap> = + node.children.iter().flat_map(string_for_node).collect(); + + properties.insert( + "children".to_string(), + PropertyValue::StringArray(children.keys().cloned().collect()), + ); + } + + BTreeMap::from([(node_name, properties)]) +} + +pub fn strings_from_property(property: &DeviceTreeNodeProperty) -> (Vec, bool) { + let mut str_arr = Vec::new(); + let mut curr_str = Vec::new(); + let mut is_str = true; + + for &c in &property.value { + if (c != 0 && c < 0x20) || c >= 0x7f || property.name.trim_end_matches('\0') == "reg" { + is_str = false; + break; + } else if c == 0 && !curr_str.is_empty() { + if let Ok(s) = str::from_utf8(&curr_str) { + str_arr.push(s.to_string()); + } + curr_str.clear(); + } else if c != 0 { + curr_str.push(c); + } + } + + (str_arr, is_str) +} + +impl<'a> ctx::TryIntoCtx for &'a DeviceTreeNodeProperty { + type Error = scroll::Error; + + fn try_into_ctx(self, dst: &mut [u8], ctx: Endian) -> Result { + let offset = &mut 0; + + let mut name_bytes = [0u8; PROP_NAME_LENGTH]; + let name_slice = self.name.as_bytes(); + name_bytes[..name_slice.len().min(PROP_NAME_LENGTH)] + .copy_from_slice(&name_slice[..name_slice.len().min(PROP_NAME_LENGTH)]); + dst.gwrite_with(name_bytes, offset, ctx)?; + + let length_with_flag = self.length | if self.is_placeholder { 1 << 31 } else { 0 }; + dst.gwrite_with(length_with_flag, offset, ctx)?; + + let aligned_length = (self.length + 3) & !3; + let mut padded_value = self.value.clone(); + padded_value.resize(aligned_length as usize, 0); + dst.gwrite_with(padded_value.as_slice(), offset, ())?; + + Ok(*offset) + } +} + +impl<'a> ctx::TryIntoCtx for &'a DeviceTreeNode { + type Error = scroll::Error; + + fn try_into_ctx(self, dst: &mut [u8], ctx: Endian) -> Result { + let mut offset = 0; + + dst.gwrite_with(self.properties.len() as u32, &mut offset, ctx)?; + dst.gwrite_with(self.children.len() as u32, &mut offset, ctx)?; + + for prop in &self.properties { + offset += prop.try_into_ctx(&mut dst[offset..], ctx)?; + } + + // Write children + for child in &self.children { + offset += child.try_into_ctx(&mut dst[offset..], ctx)?; + } + + Ok(offset) + } +}