Merge branch 'main' into node-gats

m4tx · web-flow · commit 10d597eb1966 · 2026-06-16T16:30:09.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,28 @@
+## [0.2.1] - 2026-06-16
+
+### Bug Fixes
+
+- Validate `off_mem_rsvmap` and `off_dt_struct` in the FDT parser ([#38](https://github.com/google/dtoolkit/pull/38))
+- Return error when accessing data at invalid offsets in the FDT parser instead of panicking ([#40](https://github.com/google/dtoolkit/pull/40))
+
+## [0.2.0] - 2026-06-01
+
+### Features
+
+- [**breaking**] Validate node and property names ([#35](https://github.com/google/dtoolkit/pull/35))
+
+### Refactor
+
+- [**breaking**] Implement generic `From<T>` for `DeviceTreeNode` ([#28](https://github.com/google/dtoolkit/pull/28))
+
+## [0.1.1] - 2026-01-12
+
+### Miscellaneous
+
+- Add docs.rs metadata to Cargo.toml and use `doc_cfg` ([#26](https://github.com/google/dtoolkit/pull/26))
+
+## [0.1.0] - 2026-01-09
+
+### Features
+
+- First version published on crates.io
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -41,4 +41,20 @@ information on using pull requests.
   (beyond performance optimization) it must be accompanied by
   an `#[expect(unsafe_code)]` attribute, stating the rationale.
 * All `unsafe` code must be tested. The CI suite includes Miri to detect any
-  undefined behavior.
+  undefined behavior.
+
+## Releasing a new version
+
+This project uses [git-cliff](https://git-cliff.org/) to generate changelogs.
+When releasing a new version, run:
+
+```
+git-cliff --unreleased --tag <version>
+```
+
+(where `<version>` is the version number to be released)
+
+Append the output to the `CHANGELOG.md` file and make changes if necessary.
+
+Note that in order for this to work properly, the commit messages must follow
+[Conventional Commits](https://git-cliff.org/docs/#how-should-i-write-my-commits).
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "dtoolkit"
-version = "0.1.1"
+version = "0.2.1"
 edition = "2024"
 license = "Apache-2.0 OR MIT"
 rust-version = "1.88"
diff --git a/README.md b/README.md
@@ -29,6 +29,31 @@ See LICENSE for details.
 If you want to contribute to the project, see details of
 [how we accept contributions](CONTRIBUTING.md).
 
+## Fuzzing
+
+Fuzzing helps prevent unexpected panics and ensures correct behavior on
+unexpected inputs. The project uses `cargo-fuzz`, which is not part of the
+default Rust installation.  It is recommended to run the relevant fuzzer for a
+while before pushing a change.
+
+Install `cargo-fuzz` with:
+
+```sh
+cargo +nightly install cargo-fuzz
+```
+
+Run a fuzz target by name from the repository root:
+
+```sh
+cargo +nightly fuzz run <fuzzer name>
+```
+
+For example, to run the `parse` fuzzer:
+
+```sh
+cargo +nightly fuzz run parse
+```
+
 ## Disclaimer
 
 This is not an officially supported Google product. This project is not
diff --git a/cliff.toml b/cliff.toml
@@ -0,0 +1,90 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+
+[changelog]
+# See https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}
+"""
+# Remove leading and trailing whitespaces from the changelog's body.
+trim = true
+# Render body even when there are no releases to process.
+render_always = true
+# An array of regex based postprocessors to modify the changelog.
+postprocessors = [
+    # Replace the placeholder <REPO> with a URL.
+    #{ pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" },
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[git]
+# Parse commits according to the conventional commits specification.
+# See https://www.conventionalcommits.org
+conventional_commits = true
+# Exclude commits that do not match the conventional commits specification.
+filter_unconventional = true
+# Require all commits to be conventional.
+# Takes precedence over filter_unconventional.
+require_conventional = false
+# Split commits on newlines, treating each line as an individual commit.
+split_commits = false
+# An array of regex based parsers to modify commit messages prior to further processing.
+commit_preprocessors = [
+    # Replace the issue/PR number with the link. It will work for issues as well as GitHub has a redirect.
+    { pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](https://github.com/google/dtoolkit/pull/${1}))" },
+]
+# Prevent commits that are breaking from being excluded by commit parsers.
+protect_breaking_commits = false
+# An array of regex based parsers for extracting data from the commit message.
+# Assigns commits to groups.
+# Optionally sets the commit's scope and can decide to exclude commits from further processing.
+commit_parsers = [
+    { message = "^feat", group = "<!-- 0 -->Features" },
+    { message = "^fix", group = "<!-- 1 -->Bug Fixes" },
+    { message = "^doc", group = "<!-- 3 -->Documentation" },
+    { message = "^perf", group = "<!-- 4 -->Performance" },
+    { message = "^refactor", group = "<!-- 2 -->Refactor" },
+    { message = "^style", group = "<!-- 5 -->Styling" },
+    { message = "^test", group = "<!-- 6 -->Testing" },
+    { message = "^chore\\(release\\): prepare for", skip = true },
+    { message = "^chore\\(deps.*\\)", skip = true },
+    { message = "^chore\\(pr\\)", skip = true },
+    { message = "^chore\\(pull\\)", skip = true },
+    { message = "^chore|^ci", group = "<!-- 7 -->Miscellaneous" },
+    { body = ".*security", group = "<!-- 8 -->Security" },
+    { message = "^revert", group = "<!-- 9 -->Revert" },
+    { message = ".*", group = "<!-- 10 -->Other" },
+]
+# Exclude commits that are not matched by any commit parser.
+filter_commits = false
+# Fail on a commit that is not matched by any commit parser.
+fail_on_unmatched_commit = false
+# An array of link parsers for extracting external references, and turning them into URLs, using regex.
+link_parsers = []
+# Include only the tags that belong to the current branch.
+use_branch_tags = false
+# Order releases topologically instead of chronologically.
+topo_order = false
+# Order commits topologically instead of chronologically.
+topo_order_commits = true
+# Order of commits in each group/release within the changelog.
+# Allowed values: newest, oldest
+sort_commits = "oldest"
+# Process submodules commits
+recurse_submodules = false
diff --git a/fuzz/.gitignore b/fuzz/.gitignore
@@ -0,0 +1,4 @@
+target
+corpus
+artifacts
+coverage
diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml
@@ -0,0 +1,21 @@
+[package]
+name = "dtoolkit-fuzz"
+version = "0.0.0"
+publish = false
+edition = "2024"
+
+[package.metadata]
+cargo-fuzz = true
+
+[dependencies]
+libfuzzer-sys = "0.4"
+
+[dependencies.dtoolkit]
+path = ".."
+
+[[bin]]
+name = "parse"
+path = "fuzz_targets/parse.rs"
+test = false
+doc = false
+bench = false
diff --git a/fuzz/corpus-src/all.dts b/fuzz/corpus-src/all.dts
@@ -0,0 +1,149 @@
+/*
+ * Copyright 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
+ *
+ * Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+ * https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+ * <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+ * option. This file may not be copied, modified, or distributed
+ * except according to those terms.
+ */
+
+/dts-v1/;
+
+/memreserve/ 0x0000000080000000 0x0000000000010000;
+/memreserve/ 0x00000000c0000000 0x0000000000010000;
+
+/ {
+	#address-cells = <2>;
+	#size-cells = <2>;
+	model = "dtoolkit fuzzer corpus";
+	compatible = "dtoolkit,test";
+	serial-nnumber = "1234";
+	chassis-type = "desktop";
+	phandle = <1>;
+	status = "okay";
+
+	virtual-reg = <0x80000000>;
+	dma-coherent;
+
+	aliases {
+		serial1 = "/soc@1/serial@1000";
+		ethernet0 = "/soc@1/dma@2000";
+
+		serial0 = &uart0;
+		cpu0 = &cpu0;
+	};
+
+	memory@100000002 {
+		device_type = "memory";
+		reg = <0x00000001 0x00000002 0x00000003 0x00000004>,
+			<0x00000005 0x00000006 0x00000007 0x00000008>;
+		initial-mapped-area = <0x00000001 0x00000002 0x00000003 0x00000004>,
+			<0x00000005 0x00000006 0x00000007 0x00000008>;
+		hotpluggable;
+		status = "okay";
+	};
+
+	reserved-memory {
+		#address-cells = <2>;
+		#size-cells = <2>;
+		ranges;
+
+		mem1@80000000 {
+			reg = <0x00000001 0x00000002 0x00000003 0x00000004>;
+			size = <0x00000005 0x00000006>;
+			alignment = <0x00000007 0x00000008>;
+			alloc-ranges = <0x00000009 0x0000000a 0x0000000b 0x0000000c>;
+			compatible = "shared-dma-pool";
+			no-map;
+			status = "fail";
+		};
+
+		mem2@a0000000 {
+			reg = <0x00000001 0x00000002 0x00000003 0x00000004>;
+			size = <0x00000005 0x00000006>;
+			alignment = <0x00000007 0x00000008>;
+			reusable;
+			status = "okay";
+		};
+	};
+
+	chosen {
+		bootargs = "console=ttyS0 root=/dev/ram0";
+		stdout-path = "/soc@1/serial@1000:115200n8";
+		stdin-path = "/soc@1/serial@1000";
+	};
+
+	cpus {
+		#address-cells = <2>;
+		#size-cells = <0>;
+
+		cpu0: cpu@0 {
+			device_type = "cpu";
+			compatible = "arm,armv8";
+			reg = <0x00000000 0x00000000>;
+			clock-frequency = <1000000000>;
+			timebase-frequency = <1000000>;
+			status = "okay";
+			enable-method = "spin-table";
+			cpu-release-addr = <0x00000000 0x80000000>;
+			phandle = <2>;
+
+		};
+
+		cpu@1 {
+			device_type = "cpu";
+			compatible = "arm,armv8";
+			reg = <0x00000000 0x00000001>;
+			status = "disabled";
+			enable-method = "spin-table";
+			cpu-release-addr = <0xffffffff 0xffffffff>;
+
+			tlb-split;
+			tlb-size = <2>;
+			tlb-sets = <3>;
+			d-tlb-size = <4>;
+			d-tlb-sets = <5>;
+			i-tlb-size = <6>;
+			i-tlb-sets = <7>;
+			cache-unified;
+			cache-size = <8>;
+			cache-sets = <9>;
+			cache-block-size = <10>;
+			cache-line-size = <11>;
+			i-cache-size = <12>;
+			i-cache-sets = <13>;
+			i-cache-block-size = <14>;
+			i-cache-line-size = <15>;
+			d-cache-size = <16>;
+			d-cache-sets = <17>;
+			d-cache-block-size = <18>;
+			d-cache-line-size = <19>;
+		};
+	};
+
+	soc@1 {
+		compatible = "dummy-soc";
+		#address-cells = <1>;
+		#size-cells = <1>;
+		ranges = <0x00000001 0x00000002 0x00000003 0x00000004>;
+		dma-ranges = <0x00000005 0x00000006 0x00000007 0x00000008>;
+		dma-coherent;
+		status = "okay";
+
+		uart0: serial@1000 {
+			compatible = "pl011";
+			reg = <0x00000001 0x00000002>;
+			virtual-reg = <0x00000003>;
+			phandle = <3>;
+			status = "okay";
+		};
+
+		dma@2000 {
+			compatible = "dma";
+			reg = <0x00000001 0x00000002>;
+			dma-coherent;
+			status = "reserved";
+		};
+	};
+};
diff --git a/fuzz/corpus-src/generate.sh b/fuzz/corpus-src/generate.sh
@@ -0,0 +1,25 @@
+#!/bin/sh
+
+# Copyright 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+# Generate DTB corpus files from DTS files.
+
+if [ $# -ne 2 ]; then
+    echo "error: input and output directories are required" >&2
+    echo "usage: $0 <input dir> <output dir>" >&2
+    exit 1
+fi
+
+input_dir=$1
+output_dir=$2
+
+for dts in "$input_dir"/*.dts; do
+    dtb="${dts%.dts}.dtb"
+    dtc -Idts -Odtb -o "$output_dir/$dtb" "$dts"
+done
diff --git a/fuzz/corpus/parse/all.dtb b/fuzz/corpus/parse/all.dtb
diff --git a/fuzz/fuzz_targets/parse.rs b/fuzz/fuzz_targets/parse.rs
diff --git a/src/fdt.rs b/src/fdt.rs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +target
 +corpus
 +artifacts
 +coverage