Version 3.5.1

* Fix non-strings also being escaped when copied

* Move copy escape logic into objdiff-core

.cargo/config.toml

@@ -1,5 +1,4 @@
-[target.x86_64-pc-windows-msvc]
-linker = "rust-lld"
-
-[target.aarch64-pc-windows-msvc]
-linker = "rust-lld"
+# statically link the C runtime so the executable does not depend on
+# that shared/dynamic library.
+[target.'cfg(all(target_env = "msvc", target_os = "windows"))']
+rustflags = ["-C", "target-feature=+crt-static"]

.github/workflows/build.yaml

@@ -36,9 +36,9 @@ jobs:
       - name: Cache Rust workspace
         uses: Swatinem/rust-cache@v2
       - name: Cargo check
-        run: cargo check --all-targets --all-features
+        run: cargo check --all-targets --all-features --workspace
       - name: Cargo clippy
-        run: cargo clippy --all-targets --all-features
+        run: cargo clippy --all-targets --all-features --workspace
 
   fmt:
     name: Format
@@ -92,7 +92,7 @@ jobs:
       - name: Cache Rust workspace
         uses: Swatinem/rust-cache@v2
       - name: Cargo test
-        run: cargo test --release --features all
+        run: cargo test --release --all-features --workspace
 
   build-cli:
     name: Build objdiff-cli
@@ -146,13 +146,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Install uv
+        if: matrix.build == 'zigbuild'
+        uses: astral-sh/setup-uv@v6
       - name: Install cargo-zigbuild
         if: matrix.build == 'zigbuild'
         run: |
-          python3 -m venv .venv
-          . .venv/bin/activate
-          echo PATH=$PATH >> $GITHUB_ENV
-          pip install ziglang==0.13.0.post1 cargo-zigbuild==0.19.8
+          uv tool install cargo-zigbuild==0.20.1 --with-executables-from ziglang==0.15.1
+          echo "CARGO_ZIGBUILD_ZIG_PATH=$(uv tool dir)/cargo-zigbuild/bin/python-zig" >> $GITHUB_ENV
       - name: Setup Rust toolchain
         uses: dtolnay/rust-toolchain@stable
         with:
@@ -213,13 +214,14 @@ jobs:
           sudo apt-get -y install ${{ matrix.packages }}
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Install uv
+        if: matrix.build == 'zigbuild'
+        uses: astral-sh/setup-uv@v6
       - name: Install cargo-zigbuild
         if: matrix.build == 'zigbuild'
         run: |
-          python3 -m venv .venv
-          . .venv/bin/activate
-          echo PATH=$PATH >> $GITHUB_ENV
-          pip install ziglang==0.13.0.post1 cargo-zigbuild==0.19.8
+          uv tool install cargo-zigbuild==0.20.1 --with-executables-from ziglang==0.15.1
+          echo "CARGO_ZIGBUILD_ZIG_PATH=$(uv tool dir)/cargo-zigbuild/bin/python-zig" >> $GITHUB_ENV
       - name: Setup Rust toolchain
         uses: dtolnay/rust-toolchain@stable
         with:

.pre-commit-config.yaml

@@ -24,7 +24,7 @@ repos:
         description: Run cargo clippy on all project files.
         language: system
         entry: cargo
-        args: ["+nightly", "clippy", "--all-targets", "--all-features"]
+        args: ["+nightly", "clippy", "--all-targets", "--all-features", "--workspace"]
         pass_filenames: false
       - id: cargo-deny
         name: cargo deny

AGENTS.md

@@ -0,0 +1,44 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+
+- `objdiff-core`: core library with diffing logic and shared components
+- `objdiff-cli`: CLI/TUI with `ratatui`
+- `objdiff-gui`: GUI with `eframe`/`egui`
+- `objdiff-wasm`: WebAssembly bindings
+
+objdiff has three main frontends: GUI, CLI/TUI, and [web](https://github.com/encounter/objdiff-web) (utilizing `objdiff-wasm`).
+
+`objdiff-gui` is the most fully-featured and is the primary target for new features.
+
+`objdiff-cli` has an interactive TUI `diff` mode (powered by `ratatui`) and a non-interactive `report` mode to generate detailed progress reports (e.g. for <https://decomp.dev>).
+
+`objdiff-wasm` is compiled into a [WebAssembly Component](https://component-model.bytecodealliance.org/). The [API](objdiff-wasm/wit/objdiff.wit) is defined using [WIT](https://component-model.bytecodealliance.org/design/wit.html). The web interface is separate, but mirrors the GUI in functionality.
+
+## Build, Test, and Development Commands
+
+Run `cargo build` for a debug build and `cargo build --release` for an optimized build.
+The CLI can be exercised with `cargo run --release --bin objdiff-cli -- --help`.
+
+The WASM build is not included in the workspace by default due to differences in toolchain and target; build it with `npm -C objdiff-wasm run build`. (nightly required)
+In general, do NOT use `--workspace`, as it will include the WASM crate and likely fail. Formatting and linting commands are exempt.
+
+Pre-commit tasks:
+
+- `cargo test` to run the test suite
+- `cargo +nightly fmt --all` to format code (nightly required)
+- `cargo +nightly clippy --all-targets --all-features --workspace -- -D warnings` to lint code (nightly required)
+- `cargo deny check` (`cargo install --locked cargo-deny` if needed) if dependencies change
+
+## Testing Guidelines
+
+Favor focused unit tests adjacent to the code, and integration scenarios in `objdiff-core/tests`.
+Integration tests utilize snapshots with the `insta` crate; run `curl -LsSf https://insta.rs/install.sh | sh` if needed.
+To generate updated snapshots, use `cargo insta test`, review diffs manually, then accept changes with `cargo insta accept` (or simply `mv` to accept specific snapshots).
+
+## Configuration Tips
+
+- `config.schema.json`: JSON schema for the user-facing project config file (`objdiff.json`)
+- `objdiff-core/config-schema.json`: Internal options schema to generate `DiffObjConfig` (see `objdiff-core/config_gen.rs`)
+
+The project configuration (`objdiff.json`) is intended to be generated by the projects' build system. It includes paths to the target (expected) and base (current) object files, along with build commands and file watch patterns. See `README.md` for a summary of key options.

Cargo.toml

@@ -5,18 +5,28 @@ members = [
     "objdiff-gui",
     "objdiff-wasm",
 ]
+default-members = [
+    "objdiff-cli",
+    "objdiff-core",
+    "objdiff-gui",
+    # Exclude objdiff-wasm by default
+]
 resolver = "3"
 
+[workspace.package]
+version = "3.5.1"
+authors = ["Luke Street <luke@street.dev>"]
+edition = "2024"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/encounter/objdiff"
+rust-version = "1.88"
+
 [profile.release-lto]
 inherits = "release"
 lto = "fat"
 strip = "debuginfo"
 codegen-units = 1
 
-[workspace.package]
-version = "3.0.0-beta.6"
-authors = ["Luke Street <luke@street.dev>"]
-edition = "2024"
-license = "MIT OR Apache-2.0"
-repository = "https://github.com/encounter/objdiff"
-rust-version = "1.85"
+[profile.release-min]
+inherits = "release-lto"
+opt-level = "z"

README.md

@@ -7,20 +7,23 @@ A local diffing tool for decompilation projects. Inspired by [decomp.me](https:/
 
 Features:
 
-- Compare entire object files: functions and data.
-- Built-in symbol demangling for C++. (CodeWarrior, Itanium & MSVC)
-- Automatic rebuild on source file changes.
-- Project integration via [configuration file](#configuration).
-- Search and filter all of a project's objects and quickly switch.
-- Click to highlight all instances of values and registers.
+- Compare entire object files: functions and data
+- Built-in C++ symbol demangling (GCC, MSVC, CodeWarrior, Itanium)
+- Automatic rebuild on source file changes
+- Project integration via [configuration file](#configuration)
+- Search and filter objects with quick switching
+- Click-to-highlight values and registers
+- Detailed progress reporting (powers [decomp.dev](https://decomp.dev))
+- WebAssembly API, [web interface](https://github.com/encounter/objdiff-web) and [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=decomp-dev.objdiff) (WIP)
 
 Supports:
 
-- PowerPC 750CL (GameCube, Wii)
-- MIPS (N64, PS1, PS2, PSP)
-- x86 (COFF only at the moment)
 - ARM (GBA, DS, 3DS)
-- ARM64 (Switch, experimental)
+- ARM64 (Switch)
+- MIPS (N64, PS1, PS2, PSP)
+- PowerPC (GameCube, Wii, PS3, Xbox 360)
+- SuperH (Saturn, Dreamcast)
+- x86, x86_64 (PC)
 
 See [Usage](#usage) for more information.
 
@@ -39,7 +42,7 @@ For Linux and macOS, run `chmod +x objdiff-*` to make the binary executable.
 
 ### CLI
 
-CLI binaries can be found on the [releases page](https://github.com/encounter/objdiff/releases).
+CLI binaries are available on the [releases page](https://github.com/encounter/objdiff/releases).
 
 ## Screenshots
 
@@ -48,33 +51,30 @@ CLI binaries can be found on the [releases page](https://github.com/encounter/ob
 
 ## Usage
 
-objdiff works by comparing two relocatable object files (`.o`). The objects are expected to have the same relative path
-from the "target" and "base" directories.
+objdiff compares two relocatable object files (`.o`). Here's how it works:
 
-For example, if the target ("expected") object is located at `build/asm/MetroTRK/mslsupp.o` and the base ("actual")
-object is located at `build/src/MetroTRK/mslsupp.o`, the following configuration would be used:
+1. **Create an `objdiff.json` configuration file** in your project root (or generate it with your build script).  
+  This file lists **all objects in the project** with their target ("expected") and base ("current") paths.
 
-- Target build directory: `build/asm`
-- Base build directory: `build/src`
-- Object: `MetroTRK/mslsupp.o`
+2. **Load the project** in objdiff.
 
-objdiff will then execute the build system from the project directory to build both objects:
+3. **Select an object** from the sidebar to begin diffing.
 
-```sh
-$ make build/asm/MetroTRK/mslsupp.o # Only if "Build target object" is enabled
-$ make build/src/MetroTRK/mslsupp.o
-```
+4. **objdiff automatically:**
+   - Executes the build system to compile the base object (from current source code)
+   - Compares the two objects and displays the differences
+   - Watches for source file changes and rebuilds when detected
 
-The objects will then be compared and the results will be displayed in the UI.
+The configuration file allows complete flexibility in project structure - your build directories can have any layout as long as the paths are specified correctly.
 
-See [Configuration](#configuration) for more information.
+See [Configuration](#configuration) for setup details.
 
 ## Configuration
 
-While **not required** (most settings can be specified in the UI), projects can add an `objdiff.json` file to configure the tool automatically. The configuration file must be located in
+Projects can add an `objdiff.json` file to configure the tool automatically. The configuration file must be located in
 the root project directory.
 
-If your project has a generator script (e.g. `configure.py`), it's recommended to generate the objdiff configuration
+If your project has a generator script (e.g. `configure.py`), it's highly recommended to generate the objdiff configuration
 file as well. You can then add `objdiff.json` to your `.gitignore` to prevent it from being committed.
 
 ```json
@@ -89,22 +89,31 @@ file as well. You can then add `objdiff.json` to your `.gitignore` to prevent it
   "build_base": true,
   "watch_patterns": [
     "*.c",
+    "*.cc",
     "*.cp",
     "*.cpp",
     "*.cxx",
+    "*.c++",
     "*.h",
+    "*.hh",
     "*.hp",
     "*.hpp",
     "*.hxx",
+    "*.h++",
+    "*.pch",
+    "*.pch++",
+    "*.inc",
     "*.s",
     "*.S",
     "*.asm",
-    "*.inc",
     "*.py",
     "*.yml",
     "*.txt",
     "*.json"
   ],
+  "ignore_patterns": [
+    "build/**/*"
+  ],
   "units": [
     {
       "name": "main/MetroTRK/mslsupp",
@@ -118,74 +127,69 @@ file as well. You can then add `objdiff.json` to your `.gitignore` to prevent it
 
 ### Schema
 
-View [config.schema.json](config.schema.json) for all available options. The below list is a summary of the most important options.
+> [!NOTE]  
+> View [config.schema.json](config.schema.json) for all available options. Below is a summary of the most important options.
 
-`custom_make` _(optional)_: By default, objdiff will use `make` to build the project.  
-If the project uses a different build system (e.g. `ninja`), specify it here.  
-The build command will be `[custom_make] [custom_args] path/to/object.o`.
+#### Build Configuration
 
-`custom_args` _(optional)_: Additional arguments to pass to the build command prior to the object path.
+**`custom_make`** _(optional, default: `"make"`)_  
+If the project uses a different build system (e.g. `ninja`), specify it here. The build command will be `[custom_make] [custom_args] path/to/object.o`.
 
-`build_target`: If true, objdiff will tell the build system to build the target objects before diffing (e.g.
-  `make path/to/target.o`).  
-This is useful if the target objects are not built by default or can change based on project configuration or edits
-to assembly files.  
-Requires the build system to be configured properly.
+**`custom_args`** _(optional)_  
+Additional arguments to pass to the build command prior to the object path.
 
-`build_base`: If true, objdiff will tell the build system to build the base objects before diffing (e.g. `make path/to/base.o`).  
-It's unlikely you'll want to disable this, unless you're using an external tool to rebuild the base object on source file changes.
+**`build_target`**  _(default: `false`)_  
+If true, objdiff will build the target objects before diffing (e.g. `make path/to/target.o`). Useful if target objects are not built by default or can change based on project configuration. Requires proper build system configuration.
 
-`watch_patterns` _(optional)_: A list of glob patterns to watch for changes.
-([Supported syntax](https://docs.rs/globset/latest/globset/#syntax))  
-If any of these files change, objdiff will automatically rebuild the objects and re-compare them.  
-If not specified, objdiff will use the default patterns listed above.
+**`build_base`**  _(default: `true`)_  
+If true, objdiff will build the base objects before diffing (e.g. `make path/to/base.o`). It's unlikely you'll want to disable this unless using an external tool to rebuild the base object.
 
-`units` _(optional)_: If specified, objdiff will display a list of objects in the sidebar for easy navigation.
+#### File Watching
 
-> `name` _(optional)_: The name of the object in the UI. If not specified, the object's `path` will be used.
->
-> `target_path`: Path to the "target" or "expected" object from the project root.  
-> This object is the **intended result** of the match.
->
-> `base_path`: Path to the "base" or "actual" object from the project root.  
-> This object is built from the **current source code**.
->
-> `metadata.auto_generated` _(optional)_: Hides the object from the object list, but still includes it in reports.
->
-> `metadata.complete` _(optional)_: Marks the object as "complete" (or "linked") in the object list.  
-> This is useful for marking objects that are fully decompiled. A value of `false` will mark the object as "incomplete".
+**`watch_patterns`** _(optional, default: listed above)_  
+A list of glob patterns to watch for changes ([supported syntax](https://docs.rs/globset/latest/globset/#syntax)). When these files change, objdiff automatically rebuilds and re-compares objects.
+
+**`ignore_patterns`** _(optional, default: listed above)_  
+A list of glob patterns to explicitly ignore when watching for changes ([supported syntax](https://docs.rs/globset/latest/globset/#syntax)).
+
+#### Units (Objects)
+
+**`units`** _(optional)_  
+If specified, objdiff displays a list of objects in the sidebar for easy navigation. Each unit contains:
+
+- **`name`** _(optional)_ - The display name in the UI. Defaults to the object's `path`.
+- **`target_path`** _(optional)_ - Path to the "target" or "expected" object (the **intended result**).
+- **`base_path`** _(optional)_ - Path to the "base" or "current" object (built from **current source code**). Omit if there is no source object yet.
+- **`metadata.auto_generated`** _(optional)_ - Hides the object from the sidebar but includes it in progress reports.
+- **`metadata.complete`** _(optional)_ - Marks the object as "complete" (linked) when `true` or "incomplete" when `false`.
 
 ## Building
 
 Install Rust via [rustup](https://rustup.rs).
 
 ```shell
-$ git clone https://github.com/encounter/objdiff.git
-$ cd objdiff
-$ cargo run --release
+git clone https://github.com/encounter/objdiff.git
+cd objdiff
+cargo run --release
 ```
 
-Or using `cargo install`.
+Or install directly with cargo:
 
 ```shell
-$ cargo install --locked --git https://github.com/encounter/objdiff.git objdiff-gui objdiff-cli
+cargo install --locked --git https://github.com/encounter/objdiff.git objdiff-gui objdiff-cli
 ```
 
-The binaries will be installed to `~/.cargo/bin` as `objdiff` and `objdiff-cli`.
+Binaries will be installed to `~/.cargo/bin` as `objdiff` and `objdiff-cli`.
 
-## Installing `pre-commit`
+## Contributing
 
-When contributing, it's recommended to install `pre-commit` to automatically run the linter and formatter before a commit.
-
-[`uv`](https://github.com/astral-sh/uv#installation) is recommended to manage Python version and tools.
-
-Rust nightly is required for `cargo +nightly fmt` and `cargo +nightly clippy`.
+Install `pre-commit` to run linting and formatting automatically:
 
 ```shell
-$ cargo install --locked cargo-deny
-$ rustup toolchain install nightly
-$ uv tool install pre-commit
-$ pre-commit install
+rustup toolchain install nightly  # Required for cargo fmt/clippy
+cargo install --locked cargo-deny # https://github.com/EmbarkStudios/cargo-deny
+uv tool install pre-commit        # https://docs.astral.sh/uv, or use pipx or pip
+pre-commit install
 ```
 
 ## License

config.schema.json

@@ -15,7 +15,7 @@
     },
     "custom_make": {
       "type": "string",
-      "description": "By default, objdiff will use make to build the project.\nIf the project uses a different build system (e.g. ninja), specify it here.\nThe build command will be `[custom_make] [custom_args] path/to/object.o`.",
+      "description": "If the project uses a different build system (e.g. ninja), specify it here.\nThe build command will be `[custom_make] [custom_args] path/to/object.o`.",
       "examples": [
         "make",
         "ninja"
@@ -41,39 +41,55 @@
     },
     "build_target": {
       "type": "boolean",
-      "description": "If true, objdiff will tell the build system to build the target objects before diffing (e.g. `make path/to/target.o`).\nThis is useful if the target objects are not built by default or can change based on project configuration or edits to assembly files.\nRequires the build system to be configured properly.",
+      "description": "If true, objdiff will build the target objects before diffing (e.g. `make path/to/target.o`).\nUseful if target objects are not built by default or can change based on project configuration.\nRequires proper build system configuration.",
       "default": false
     },
     "build_base": {
       "type": "boolean",
-      "description": "If true, objdiff will tell the build system to build the base objects before diffing (e.g. `make path/to/base.o`).\nIt's unlikely you'll want to disable this, unless you're using an external tool to rebuild the base object on source file changes.",
+      "description": "If true, objdiff will build the base objects before diffing (e.g. `make path/to/base.o`).\nIt's unlikely you'll want to disable this unless using an external tool to rebuild the base object.",
       "default": true
     },
     "watch_patterns": {
       "type": "array",
-      "description": "List of glob patterns to watch for changes in the project.\nIf any of these files change, objdiff will automatically rebuild the objects and re-compare them.\nSupported syntax: https://docs.rs/globset/latest/globset/#syntax",
+      "description": "A list of glob patterns to watch for changes.\nWhen these files change, objdiff automatically rebuilds and re-compares objects.\nSupported syntax: https://docs.rs/globset/latest/globset/#syntax",
       "items": {
         "type": "string"
       },
       "default": [
         "*.c",
+        "*.cc",
         "*.cp",
         "*.cpp",
         "*.cxx",
+        "*.c++",
         "*.h",
+        "*.hh",
         "*.hp",
         "*.hpp",
         "*.hxx",
+        "*.h++",
+        "*.pch",
+        "*.pch++",
+        "*.inc",
         "*.s",
         "*.S",
         "*.asm",
-        "*.inc",
         "*.py",
         "*.yml",
         "*.txt",
         "*.json"
       ]
     },
+    "ignore_patterns": {
+      "type": "array",
+      "description": "A list of glob patterns to explicitly ignore when watching for changes.\nSupported syntax: https://docs.rs/globset/latest/globset/#syntax",
+      "items": {
+        "type": "string"
+      },
+      "default": [
+        "build/**/*"
+      ]
+    },
     "objects": {
       "type": "array",
       "description": "Use units instead.",
@@ -95,6 +111,25 @@
       "items": {
         "$ref": "#/$defs/progress_category"
       }
+    },
+    "options": {
+      "type": "object",
+      "description": "Diff configuration options that should be applied automatically when the project is loaded.",
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "string"
+          }
+        ]
+      },
+      "examples": [
+        {
+          "demangler": "gnu_legacy"
+        }
+      ]
     }
   },
   "$defs": {
@@ -103,7 +138,7 @@
       "properties": {
         "name": {
           "type": "string",
-          "description": "The name of the object in the UI. If not specified, the object's path will be used."
+          "description": "The display name in the UI. Defaults to the object's path."
         },
         "path": {
           "type": "string",
@@ -112,11 +147,11 @@
         },
         "target_path": {
           "type": "string",
-          "description": "Path to the target object from the project root.\nRequired if path is not specified."
+          "description": "Path to the \"target\" or \"expected\" object (the intended result)."
         },
         "base_path": {
           "type": "string",
-          "description": "Path to the base object from the project root.\nRequired if path is not specified."
+          "description": "Path to the \"base\" or \"current\" object (built from current source code).\nOmit if there is no source object yet."
         },
         "reverse_fn_order": {
           "type": "boolean",
@@ -140,6 +175,20 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "options": {
+          "type": "object",
+          "description": "Diff configuration options that should be applied when this unit is active.",
+          "additionalProperties": {
+            "oneOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          }
         }
       }
     },
@@ -175,6 +224,10 @@
           "type": "boolean",
           "description": "If true, objdiff will run the build command with the context file as an argument to generate it.",
           "default": false
+        },
+        "preset_id": {
+          "type": "number",
+          "description": "The decomp.me preset ID to use for the scratch.\nCompiler and flags in the config will take precedence over the preset, but the preset is useful for organizational purposes."
         }
       },
       "required": [
@@ -187,7 +240,7 @@
       "properties": {
         "complete": {
           "type": "boolean",
-          "description": "Marks the object as \"complete\" (or \"linked\") in the object list.\nThis is useful for marking objects that are fully decompiled. A value of `false` will mark the object as \"incomplete\"."
+          "description": "Marks the object as \"complete\" (linked) when `true` or \"incomplete\" when `false`."
         },
         "reverse_fn_order": {
           "type": "boolean",
@@ -207,7 +260,7 @@
         },
         "auto_generated": {
           "type": "boolean",
-          "description": "Hides the object from the object list by default, but still includes it in reports."
+          "description": "Hides the object from the sidebar but includes it in progress reports."
         }
       }
     },

deny.toml

@@ -74,6 +74,9 @@ ignore = [
     #"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish
     #{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" },
     { id = "RUSTSEC-2024-0436", reason = "Unmaintained paste crate is an indirect dependency" },
+    { id = "RUSTSEC-2025-0052", reason = "Unmaintained async-std crate is an indirect dependency" },
+    { id = "RUSTSEC-2025-0119", reason = "Unmaintained number_prefix crate is an indirect dependency" },
+    { id = "RUSTSEC-2025-0134", reason = "Unmaintained rustls-pemfile crate is an indirect dependency" },
 ]
 # If this is true, then cargo deny will use the git executable to fetch advisory database.
 # If this is false, then it uses a built-in git library.
@@ -103,6 +106,7 @@ allow = [
     "0BSD",
     "OFL-1.1",
     "Ubuntu-font-1.0",
+    "CDLA-Permissive-2.0",
 ]
 # The confidence threshold for detecting a license from license text.
 # The higher the value, the more closely the license text must be to the
@@ -240,8 +244,8 @@ allow-git = []
 [sources.allow-org]
 # github.com organizations to allow git sources for
 github = [
-    "enarx", # flagset
     "encounter",
+    "gimli-rs",  # gimli
 ]
 # gitlab.com organizations to allow git sources for
 gitlab = []

objdiff-cli/Cargo.toml

@@ -15,20 +15,20 @@ publish = false
 [dependencies]
 anyhow = "1.0"
 argp = "0.4"
-crossterm = "0.28"
-enable-ansi-support = "0.2"
+crossterm = "0.29"
+enable-ansi-support = "0.3"
 memmap2 = "0.9"
 objdiff-core = { path = "../objdiff-core", features = ["all"] }
-prost = "0.13"
+prost = "0.14"
 ratatui = "0.29"
-rayon = "1.10"
+rayon = "1.11"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 supports-color = "3.0"
 time = { version = "0.3", features = ["formatting", "local-offset"] }
 tracing = "0.1"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
-typed-path = "0.10"
+typed-path = "0.12"
 
 [target.'cfg(target_env = "musl")'.dependencies]
 mimalloc = "0.1"

objdiff-cli/src/cmd/diff.rs

@@ -19,16 +19,16 @@ use crossterm::{
     },
 };
 use objdiff_core::{
-    bindings::diff::DiffResult,
     build::{
         BuildConfig, BuildStatus,
         watcher::{Watcher, create_watcher},
     },
     config::{
-        ProjectConfig, ProjectObject, ProjectObjectMetadata, build_globset,
+        ProjectConfig, ProjectObject, ProjectObjectMetadata, ProjectOptions, apply_project_options,
+        build_globset,
         path::{check_path_buf, platform_path, platform_path_serde_option},
     },
-    diff::{self, DiffObjConfig, MappingConfig, ObjectDiff},
+    diff::{DiffObjConfig, MappingConfig, ObjectDiff},
     jobs::{
         Job, JobQueue, JobResult,
         objdiff::{ObjDiffConfig, start_build},
@@ -40,10 +40,7 @@ use typed_path::{Utf8PlatformPath, Utf8PlatformPathBuf};
 
 use crate::{
     cmd::apply_config_args,
-    util::{
-        output::{OutputFormat, write_output},
-        term::crossterm_panic_handler,
-    },
+    util::term::crossterm_panic_handler,
     views::{EventControlFlow, EventResult, UiView, function_diff::FunctionDiffUi},
 };
 
@@ -63,35 +60,20 @@ pub struct Args {
     #[argp(option, short = 'u')]
     /// Unit name within project
     unit: Option<String>,
-    #[argp(option, short = 'o', from_str_fn(platform_path))]
-    /// Output file (one-shot mode) ("-" for stdout)
-    output: Option<Utf8PlatformPathBuf>,
-    #[argp(option)]
-    /// Output format (json, json-pretty, proto) (default: json)
-    format: Option<String>,
     #[argp(positional)]
     /// Function symbol to diff
     symbol: Option<String>,
     #[argp(option, short = 'c')]
     /// Configuration property (key=value)
     config: Vec<String>,
-    #[argp(option, short = 'm')]
-    /// Symbol mapping (target=base)
-    mapping: Vec<String>,
-    #[argp(option)]
-    /// Left symbol name for selection
-    selecting_left: Option<String>,
-    #[argp(option)]
-    /// Right symbol name for selection
-    selecting_right: Option<String>,
 }
 
 pub fn run(args: Args) -> Result<()> {
-    let (target_path, base_path, project_config) =
+    let (target_path, base_path, project_config, unit_options) =
         match (&args.target, &args.base, &args.project, &args.unit) {
             (Some(_), Some(_), None, None)
             | (Some(_), None, None, None)
-            | (None, Some(_), None, None) => (args.target.clone(), args.base.clone(), None),
+            | (None, Some(_), None, None) => (args.target.clone(), args.base.clone(), None, None),
             (None, None, p, u) => {
                 let project = match p {
                     Some(project) => project.clone(),
@@ -116,28 +98,32 @@ pub fn run(args: Args) -> Result<()> {
                     .base_dir
                     .as_ref()
                     .map(|p| project.join(p.with_platform_encoding()));
-                let objects = project_config
-                    .units
+                let units = project_config.units.as_deref().unwrap_or_default();
+                let objects = units
                     .iter()
-                    .flatten()
-                    .map(|o| {
-                        ObjectConfig::new(
-                            o,
-                            &project,
-                            target_obj_dir.as_deref(),
-                            base_obj_dir.as_deref(),
+                    .enumerate()
+                    .map(|(idx, o)| {
+                        (
+                            ObjectConfig::new(
+                                o,
+                                &project,
+                                target_obj_dir.as_deref(),
+                                base_obj_dir.as_deref(),
+                            ),
+                            idx,
                         )
                     })
                     .collect::<Vec<_>>();
-                let object = if let Some(u) = u {
+                let (object, unit_idx) = if let Some(u) = u {
                     objects
                         .iter()
-                        .find(|obj| obj.name == *u)
+                        .find(|(obj, _)| obj.name == *u)
+                        .map(|(obj, idx)| (obj, *idx))
                         .ok_or_else(|| anyhow!("Unit not found: {}", u))?
                 } else if let Some(symbol_name) = &args.symbol {
                     let mut idx = None;
                     let mut count = 0usize;
-                    for (i, obj) in objects.iter().enumerate() {
+                    for (i, (obj, unit_idx)) in objects.iter().enumerate() {
                         if obj
                             .target_path
                             .as_deref()
@@ -145,7 +131,7 @@ pub fn run(args: Args) -> Result<()> {
                             .transpose()?
                             .unwrap_or(false)
                         {
-                            idx = Some(i);
+                            idx = Some((i, *unit_idx));
                             count += 1;
                             if count > 1 {
                                 break;
@@ -154,7 +140,7 @@ pub fn run(args: Args) -> Result<()> {
                     }
                     match (count, idx) {
                         (0, None) => bail!("Symbol not found: {}", symbol_name),
-                        (1, Some(i)) => &objects[i],
+                        (1, Some((i, unit_idx))) => (&objects[i].0, unit_idx),
                         (2.., Some(_)) => bail!(
                             "Multiple instances of {} were found, try specifying a unit",
                             symbol_name
@@ -164,60 +150,31 @@ pub fn run(args: Args) -> Result<()> {
                 } else {
                     bail!("Must specify one of: symbol, project and unit, target and base objects")
                 };
+                let unit_options = units.get(unit_idx).and_then(|u| u.options().cloned());
                 let target_path = object.target_path.clone();
                 let base_path = object.base_path.clone();
-                (target_path, base_path, Some(project_config))
+                (target_path, base_path, Some(project_config), unit_options)
             }
             _ => bail!("Either target and base or project and unit must be specified"),
         };
 
-    if let Some(output) = &args.output {
-        run_oneshot(&args, output, target_path.as_deref(), base_path.as_deref())
-    } else {
-        run_interactive(args, target_path, base_path, project_config)
-    }
+    run_interactive(args, target_path, base_path, project_config, unit_options)
 }
 
-fn build_config_from_args(args: &Args) -> Result<(DiffObjConfig, MappingConfig)> {
-    let mut diff_config = DiffObjConfig::default();
-    apply_config_args(&mut diff_config, &args.config)?;
-    let mut mapping_config = MappingConfig {
-        mappings: Default::default(),
-        selecting_left: args.selecting_left.clone(),
-        selecting_right: args.selecting_right.clone(),
-    };
-    for mapping in &args.mapping {
-        let (target, base) =
-            mapping.split_once('=').context("--mapping expects \"target=base\"")?;
-        mapping_config.mappings.insert(target.to_string(), base.to_string());
-    }
-    Ok((diff_config, mapping_config))
-}
-
-fn run_oneshot(
+fn build_config_from_args(
     args: &Args,
-    output: &Utf8PlatformPath,
-    target_path: Option<&Utf8PlatformPath>,
-    base_path: Option<&Utf8PlatformPath>,
-) -> Result<()> {
-    let output_format = OutputFormat::from_option(args.format.as_deref())?;
-    let (diff_config, mapping_config) = build_config_from_args(args)?;
-    let target = target_path
-        .map(|p| {
-            obj::read::read(p.as_ref(), &diff_config).with_context(|| format!("Loading {}", p))
-        })
-        .transpose()?;
-    let base = base_path
-        .map(|p| {
-            obj::read::read(p.as_ref(), &diff_config).with_context(|| format!("Loading {}", p))
-        })
-        .transpose()?;
-    let result =
-        diff::diff_objs(target.as_ref(), base.as_ref(), None, &diff_config, &mapping_config)?;
-    let left = target.as_ref().and_then(|o| result.left.as_ref().map(|d| (o, d)));
-    let right = base.as_ref().and_then(|o| result.right.as_ref().map(|d| (o, d)));
-    write_output(&DiffResult::new(left, right), Some(output), output_format)?;
-    Ok(())
+    project_config: Option<&ProjectConfig>,
+    unit_options: Option<&ProjectOptions>,
+) -> Result<(DiffObjConfig, MappingConfig)> {
+    let mut diff_config = DiffObjConfig::default();
+    if let Some(options) = project_config.and_then(|config| config.options.as_ref()) {
+        apply_project_options(&mut diff_config, options)?;
+    }
+    if let Some(options) = unit_options {
+        apply_project_options(&mut diff_config, options)?;
+    }
+    apply_config_args(&mut diff_config, &args.config)?;
+    Ok((diff_config, MappingConfig::default()))
 }
 
 pub struct AppState {
@@ -356,11 +313,13 @@ fn run_interactive(
     target_path: Option<Utf8PlatformPathBuf>,
     base_path: Option<Utf8PlatformPathBuf>,
     project_config: Option<ProjectConfig>,
+    unit_options: Option<ProjectOptions>,
 ) -> Result<()> {
     let Some(symbol_name) = &args.symbol else { bail!("Interactive mode requires a symbol name") };
     let time_format = time::format_description::parse_borrowed::<2>("[hour]:[minute]:[second]")
         .context("Failed to parse time format")?;
-    let (diff_obj_config, mapping_config) = build_config_from_args(&args)?;
+    let (diff_obj_config, mapping_config) =
+        build_config_from_args(&args, project_config.as_ref(), unit_options.as_ref())?;
     let mut state = AppState {
         jobs: Default::default(),
         waker: Default::default(),
@@ -382,10 +341,12 @@ fn run_interactive(
     };
     if let (Some(project_dir), Some(project_config)) = (&state.project_dir, &state.project_config) {
         let watch_patterns = project_config.build_watch_patterns()?;
+        let ignore_patterns = project_config.build_ignore_patterns()?;
         state.watcher = Some(create_watcher(
             state.modified.clone(),
             project_dir.as_ref(),
             build_globset(&watch_patterns)?,
+            build_globset(&ignore_patterns)?,
             Waker::from(state.waker.clone()),
         )?);
     }
@@ -399,7 +360,7 @@ fn run_interactive(
         stdout(),
         EnterAlternateScreen,
         EnableMouseCapture,
-        SetTitle(format!("{} - objdiff", symbol_name)),
+        SetTitle(format!("{symbol_name} - objdiff")),
     )?;
     let backend = CrosstermBackend::new(stdout());
     let mut terminal = Terminal::new(backend)?;

objdiff-cli/src/cmd/report.rs

@@ -7,9 +7,9 @@ use objdiff_core::{
         ChangeItem, ChangeItemInfo, ChangeUnit, Changes, ChangesInput, Measures, REPORT_VERSION,
         Report, ReportCategory, ReportItem, ReportItemMetadata, ReportUnit, ReportUnitMetadata,
     },
-    config::path::platform_path,
-    diff, obj,
-    obj::{SectionKind, SymbolFlag},
+    config::{ProjectObject, ProjectOptions, apply_project_options, path::platform_path},
+    diff,
+    obj::{self, SectionKind, SymbolFlag, SymbolKind},
 };
 use prost::Message;
 use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
@@ -83,11 +83,13 @@ pub fn run(args: Args) -> Result<()> {
 }
 
 fn generate(args: GenerateArgs) -> Result<()> {
-    let mut diff_config = diff::DiffObjConfig {
+    let base_diff_config = diff::DiffObjConfig {
         function_reloc_diffs: diff::FunctionRelocDiffs::None,
+        combine_data_sections: true,
+        combine_text_sections: true,
+        ppc_calculate_pool_relocations: false,
         ..Default::default()
     };
-    apply_config_args(&mut diff_config, &args.config)?;
 
     let output_format = OutputFormat::from_option(args.format.as_deref())?;
     let project_dir = args.project.as_deref().unwrap_or_else(|| Utf8PlatformPath::new("."));
@@ -98,31 +100,44 @@ fn generate(args: GenerateArgs) -> Result<()> {
         Some((Err(err), _)) => bail!("Failed to load project configuration: {}", err),
         None => bail!("No project configuration found"),
     };
-    info!(
-        "Generating report for {} units (using {} threads)",
-        project.units().len(),
-        if args.deduplicate { 1 } else { rayon::current_num_threads() }
-    );
-
     let target_obj_dir =
         project.target_dir.as_ref().map(|p| project_dir.join(p.with_platform_encoding()));
     let base_obj_dir =
         project.base_dir.as_ref().map(|p| project_dir.join(p.with_platform_encoding()));
-    let objects = project
-        .units
+    let project_units = project.units.as_deref().unwrap_or_default();
+    let objects = project_units
         .iter()
-        .flatten()
-        .map(|o| {
-            ObjectConfig::new(o, project_dir, target_obj_dir.as_deref(), base_obj_dir.as_deref())
+        .enumerate()
+        .map(|(idx, o)| {
+            (
+                ObjectConfig::new(
+                    o,
+                    project_dir,
+                    target_obj_dir.as_deref(),
+                    base_obj_dir.as_deref(),
+                ),
+                idx,
+            )
         })
         .collect::<Vec<_>>();
+    info!(
+        "Generating report for {} units (using {} threads)",
+        objects.len(),
+        if args.deduplicate { 1 } else { rayon::current_num_threads() }
+    );
 
     let start = Instant::now();
     let mut units = vec![];
     let mut existing_functions: HashSet<String> = HashSet::new();
     if args.deduplicate {
         // If deduplicating, we need to run single-threaded
-        for object in &objects {
+        for (object, unit_idx) in &objects {
+            let diff_config = build_unit_diff_config(
+                &base_diff_config,
+                project.options.as_ref(),
+                project_units.get(*unit_idx).and_then(ProjectObject::options),
+                &args.config,
+            )?;
             if let Some(unit) = report_object(object, &diff_config, Some(&mut existing_functions))?
             {
                 units.push(unit);
@@ -131,7 +146,15 @@ fn generate(args: GenerateArgs) -> Result<()> {
     } else {
         let vec = objects
             .par_iter()
-            .map(|object| report_object(object, &diff_config, None))
+            .map(|(object, unit_idx)| {
+                let diff_config = build_unit_diff_config(
+                    &base_diff_config,
+                    project.options.as_ref(),
+                    project_units.get(*unit_idx).and_then(ProjectObject::options),
+                    &args.config,
+                )?;
+                report_object(object, &diff_config, None)
+            })
             .collect::<Result<Vec<Option<ReportUnit>>>>()?;
         units = vec.into_iter().flatten().collect();
     }
@@ -153,6 +176,24 @@ fn generate(args: GenerateArgs) -> Result<()> {
     Ok(())
 }
 
+fn build_unit_diff_config(
+    base: &diff::DiffObjConfig,
+    project_options: Option<&ProjectOptions>,
+    unit_options: Option<&ProjectOptions>,
+    cli_args: &[String],
+) -> Result<diff::DiffObjConfig> {
+    let mut diff_config = base.clone();
+    if let Some(options) = project_options {
+        apply_project_options(&mut diff_config, options)?;
+    }
+    if let Some(options) = unit_options {
+        apply_project_options(&mut diff_config, options)?;
+    }
+    // CLI args override project and unit options
+    apply_config_args(&mut diff_config, cli_args)?;
+    Ok(diff_config)
+}
+
 fn report_object(
     object: &ObjectConfig,
     diff_config: &diff::DiffObjConfig,
@@ -174,16 +215,16 @@ fn report_object(
         .target_path
         .as_ref()
         .map(|p| {
-            obj::read::read(p.as_ref(), diff_config)
-                .with_context(|| format!("Failed to open {}", p))
+            obj::read::read(p.as_ref(), diff_config, diff::DiffSide::Target)
+                .with_context(|| format!("Failed to open {p}"))
         })
         .transpose()?;
     let base = object
         .base_path
         .as_ref()
         .map(|p| {
-            obj::read::read(p.as_ref(), diff_config)
-                .with_context(|| format!("Failed to open {}", p))
+            obj::read::read(p.as_ref(), diff_config, diff::DiffSide::Base)
+                .with_context(|| format!("Failed to open {p}"))
         })
         .transpose()?;
     let result =
@@ -225,6 +266,7 @@ fn report_object(
                 demangled_name: None,
                 virtual_address: section.virtual_address,
             }),
+            address: None,
         });
 
         match section.kind {
@@ -243,16 +285,16 @@ fn report_object(
                 || symbol.size == 0
                 || symbol.flags.contains(SymbolFlag::Hidden)
                 || symbol.flags.contains(SymbolFlag::Ignored)
+                || symbol.kind == SymbolKind::Section
             {
                 continue;
             }
-            if let Some(existing_functions) = &mut existing_functions {
-                if (symbol.flags.contains(SymbolFlag::Global)
+            if let Some(existing_functions) = &mut existing_functions
+                && (symbol.flags.contains(SymbolFlag::Global)
                     || symbol.flags.contains(SymbolFlag::Weak))
-                    && !existing_functions.insert(symbol.name.clone())
-                {
-                    continue;
-                }
+                && !existing_functions.insert(symbol.name.clone())
+            {
+                continue;
             }
             let match_percent = symbol_diff.match_percent.unwrap_or_else(|| {
                 // Support cases where we don't have a target object,
@@ -272,6 +314,7 @@ fn report_object(
                     demangled_name: symbol.demangled_name.clone(),
                     virtual_address: symbol.virtual_address,
                 }),
+                address: symbol.address.checked_sub(section.address),
             });
             if match_percent == 100.0 {
                 measures.matched_functions += 1;
@@ -279,6 +322,16 @@ fn report_object(
             measures.total_functions += 1;
         }
     }
+    sections.sort_by(|a, b| a.name.cmp(&b.name));
+    let reverse_fn_order = object.metadata.reverse_fn_order.unwrap_or(false);
+    functions.sort_by(|a, b| {
+        if reverse_fn_order {
+            b.address.unwrap_or(0).cmp(&a.address.unwrap_or(0))
+        } else {
+            a.address.unwrap_or(u64::MAX).cmp(&b.address.unwrap_or(u64::MAX))
+        }
+        .then_with(|| a.size.cmp(&b.size))
+    });
     if metadata.complete.unwrap_or(false) {
         measures.complete_code = measures.total_code;
         measures.complete_data = measures.total_data;
@@ -418,8 +471,8 @@ fn read_report(path: &Utf8PlatformPath) -> Result<Report> {
         std::io::stdin().read_to_end(&mut data)?;
         return Report::parse(&data).with_context(|| "Failed to load report from stdin");
     }
-    let file = File::open(path).with_context(|| format!("Failed to open {}", path))?;
+    let file = File::open(path).with_context(|| format!("Failed to open {path}"))?;
     let mmap =
-        unsafe { memmap2::Mmap::map(&file) }.with_context(|| format!("Failed to map {}", path))?;
-    Report::parse(mmap.as_ref()).with_context(|| format!("Failed to load report {}", path))
+        unsafe { memmap2::Mmap::map(&file) }.with_context(|| format!("Failed to map {path}"))?;
+    Report::parse(mmap.as_ref()).with_context(|| format!("Failed to load report {path}"))
 }

objdiff-cli/src/views/function_diff.rs

@@ -87,7 +87,7 @@ impl UiView for FunctionDiffUi {
             .and_then(|(_, _, d)| d.match_percent)
         {
             line_r.spans.push(Span::styled(
-                format!("{:.2}% ", percent),
+                format!("{percent:.2}% "),
                 Style::new().fg(match_percent_color(percent)),
             ));
         }
@@ -97,7 +97,7 @@ impl UiView for FunctionDiffUi {
             .and_then(|t| t.format(&state.time_format).ok())
             .unwrap_or_else(|| "N/A".to_string());
         line_r.spans.push(Span::styled(
-            format!("Last reload: {}", reload_time),
+            format!("Last reload: {reload_time}"),
             Style::new().fg(Color::White),
         ));
         line_r.spans.push(Span::styled(
@@ -170,32 +170,31 @@ impl UiView for FunctionDiffUi {
 
         let mut prev_text = None;
         let mut prev_margin_text = None;
-        if self.three_way {
-            if let Some((obj, symbol_idx, symbol_diff)) =
+        if self.three_way
+            && let Some((obj, symbol_idx, symbol_diff)) =
                 get_symbol(state.prev_obj.as_ref(), self.prev_sym)
-            {
-                let mut text = Text::default();
-                let rect = content_chunks[4].inner(Margin::new(0, 1));
-                self.print_sym(
-                    &mut text,
-                    obj,
-                    symbol_idx,
-                    symbol_diff,
-                    &state.diff_obj_config,
-                    rect,
-                    &self.right_highlight,
-                    result,
-                    true,
-                );
-                max_width = max_width.max(text.width());
-                prev_text = Some(text);
+        {
+            let mut text = Text::default();
+            let rect = content_chunks[4].inner(Margin::new(0, 1));
+            self.print_sym(
+                &mut text,
+                obj,
+                symbol_idx,
+                symbol_diff,
+                &state.diff_obj_config,
+                rect,
+                &self.right_highlight,
+                result,
+                true,
+            );
+            max_width = max_width.max(text.width());
+            prev_text = Some(text);
 
-                // Render margin
-                let mut text = Text::default();
-                let rect = content_chunks[3].inner(Margin::new(1, 1));
-                self.print_margin(&mut text, symbol_diff, rect);
-                prev_margin_text = Some(text);
-            }
+            // Render margin
+            let mut text = Text::default();
+            let rect = content_chunks[3].inner(Margin::new(1, 1));
+            self.print_margin(&mut text, symbol_diff, rect);
+            prev_margin_text = Some(text);
         }
 
         let max_scroll_x =
@@ -379,7 +378,6 @@ impl UiView for FunctionDiffUi {
                     }
                     // Reload
                     KeyCode::Char('r') => {
-                        result.redraw = true;
                         return EventControlFlow::Reload;
                     }
                     // Scroll right
@@ -401,7 +399,6 @@ impl UiView for FunctionDiffUi {
                                 FunctionRelocDiffs::DataValue => FunctionRelocDiffs::All,
                                 FunctionRelocDiffs::All => FunctionRelocDiffs::None,
                             };
-                        result.redraw = true;
                         return EventControlFlow::Reload;
                     }
                     // Toggle three-way diff
@@ -450,11 +447,11 @@ impl UiView for FunctionDiffUi {
 
     fn reload(&mut self, state: &AppState) -> Result<()> {
         let left_sym =
-            state.left_obj.as_ref().and_then(|(o, _)| find_function(o, &self.symbol_name));
+            state.left_obj.as_ref().and_then(|(o, _)| o.symbol_by_name(&self.symbol_name));
         let right_sym =
-            state.right_obj.as_ref().and_then(|(o, _)| find_function(o, &self.symbol_name));
+            state.right_obj.as_ref().and_then(|(o, _)| o.symbol_by_name(&self.symbol_name));
         let prev_sym =
-            state.prev_obj.as_ref().and_then(|(o, _)| find_function(o, &self.symbol_name));
+            state.prev_obj.as_ref().and_then(|(o, _)| o.symbol_by_name(&self.symbol_name));
         self.num_rows = match (
             get_symbol(state.left_obj.as_ref(), left_sym),
             get_symbol(state.right_obj.as_ref(), right_sym),
@@ -538,15 +535,16 @@ impl FunctionDiffUi {
                 let label_text = match segment.text {
                     DiffText::Basic(text) => text.to_string(),
                     DiffText::Line(num) => format!("{num} "),
-                    DiffText::Address(addr) => format!("{:x}:", addr),
+                    DiffText::Address(addr) => format!("{addr:x}:"),
                     DiffText::Opcode(mnemonic, _op) => format!("{mnemonic} "),
                     DiffText::Argument(arg) => arg.to_string(),
                     DiffText::BranchDest(addr) => format!("{addr:x}"),
+                    DiffText::BranchArrow(_) => " ~> ".to_string(),
                     DiffText::Symbol(sym) => {
                         sym.demangled_name.as_ref().unwrap_or(&sym.name).clone()
                     }
                     DiffText::Addend(addend) => match addend.cmp(&0i64) {
-                        Ordering::Greater => format!("+{:#x}", addend),
+                        Ordering::Greater => format!("+{addend:#x}"),
                         Ordering::Less => format!("-{:#x}", -addend),
                         _ => String::new(),
                     },
@@ -561,15 +559,18 @@ impl FunctionDiffUi {
                 let len = label_text.len();
                 let highlighted =
                     highlight_kind != HighlightKind::None && *highlight == highlight_kind;
-                if let Some((cx, cy)) = result.click_xy {
-                    if cx >= sx && cx < sx + len as u16 && cy == sy {
-                        new_highlight = Some(highlight_kind);
-                    }
+                if let Some((cx, cy)) = result.click_xy
+                    && cx >= sx
+                    && cx < sx + len as u16
+                    && cy == sy
+                {
+                    new_highlight = Some(highlight_kind);
                 }
                 let mut style = Style::new().fg(match segment.color {
                     DiffTextColor::Normal => Color::Gray,
                     DiffTextColor::Dim => Color::DarkGray,
                     DiffTextColor::Bright => Color::White,
+                    DiffTextColor::DataFlow => Color::LightCyan,
                     DiffTextColor::Replace => Color::Cyan,
                     DiffTextColor::Delete => Color::Red,
                     DiffTextColor::Insert => Color::Green,
@@ -650,12 +651,3 @@ fn get_symbol(
     let sym = sym?;
     Some((obj, sym, &diff.symbols[sym]))
 }
-
-fn find_function(obj: &Object, name: &str) -> Option<usize> {
-    for (symbol_idx, symbol) in obj.symbols.iter().enumerate() {
-        if symbol.name == name {
-            return Some(symbol_idx);
-        }
-    }
-    None
-}

objdiff-core/Cargo.toml

@@ -41,6 +41,8 @@ any-arch = [
     "dep:regex",
     "dep:similar",
     "dep:syn",
+    "dep:encoding_rs",
+    "demangler",
 ]
 bindings = [
     "dep:prost",
@@ -61,7 +63,10 @@ config = [
     "dep:semver",
     "dep:typed-path",
 ]
-dwarf = ["dep:gimli"]
+dwarf = [
+    "dep:gimli",
+    "dep:typed-arena",
+]
 serde = [
     "dep:pbjson",
     "dep:pbjson-build",
@@ -77,44 +82,44 @@ std = [
     "prost?/std",
     "serde?/std",
     "similar?/std",
+    "typed-arena?/std",
     "typed-path?/std",
     "dep:filetime",
     "dep:memmap2",
 ]
 mips = [
     "any-arch",
-    "dep:cpp_demangle",
-    "dep:cwdemangle",
     "dep:rabbitizer",
 ]
 ppc = [
     "any-arch",
-    "dep:cwdemangle",
     "dep:cwextab",
-    "dep:ppc750cl",
+    "dep:powerpc",
     "dep:rlwinmdec",
 ]
 x86 = [
     "any-arch",
-    "dep:cpp_demangle",
     "dep:iced-x86",
-    "dep:msvc-demangler",
 ]
 arm = [
     "any-arch",
     "dep:arm-attr",
-    "dep:cpp_demangle",
     "dep:unarm",
 ]
 arm64 = [
     "any-arch",
-    "dep:cpp_demangle",
     "dep:yaxpeax-arch",
     "dep:yaxpeax-arm",
 ]
 superh = [
     "any-arch",
 ]
+demangler = [
+    "dep:cpp_demangle",
+    "dep:cwdemangle",
+    "dep:gnuv2_demangle",
+    "dep:msvc-demangler",
+]
 
 [package.metadata.docs.rs]
 features = ["all"]
@@ -122,18 +127,18 @@ features = ["all"]
 [dependencies]
 anyhow = { version = "1.0", default-features = false }
 filetime = { version = "0.2", optional = true }
-flagset = { version = "0.4", default-features = false, optional = true, git = "https://github.com/enarx/flagset.git", rev = "a1fe9369b3741e43fec45da1998e83b9d78966a2" }
+flagset = { version = "0.4", default-features = false, optional = true }
 itertools = { version = "0.14", default-features = false, features = ["use_alloc"] }
 log = { version = "0.4", default-features = false, optional = true }
 memmap2 = { version = "0.9", optional = true }
 num-traits = { version = "0.2", default-features = false, optional = true }
-object = { git = "https://github.com/gimli-rs/object", rev = "a74579249e21ab8fcd3a86be588de336f18297cb", default-features = false, features = ["read_core", "elf", "pe"] }
-pbjson = { version = "0.7", default-features = false, optional = true }
-prost = { version = "0.13", default-features = false, features = ["prost-derive"], optional = true }
-regex = { version = "1.11", default-features = false, features = [], optional = true }
+object = { version = "0.37", default-features = false, features = ["read_core", "elf", "coff"] }
+pbjson = { version = "0.8", default-features = false, optional = true }
+prost = { version = "0.14", default-features = false, features = ["derive"], optional = true }
+regex = { version = "1.12", default-features = false, features = [], optional = true }
 serde = { version = "1.0", default-features = false, features = ["derive"], optional = true }
-similar = { version = "2.7", default-features = false, features = ["hashbrown"], optional = true, git = "https://github.com/encounter/similar.git", branch = "no_std" }
-typed-path = { version = "0.10", default-features = false, optional = true }
+similar = { git = "https://github.com/encounter/similar.git", branch = "no_std", default-features = false, features = ["hashbrown"], optional = true }
+typed-path = { version = "0.12", default-features = false, optional = true }
 
 # config
 globset = { version = "0.4", default-features = false, optional = true }
@@ -141,24 +146,22 @@ semver = { version = "1.0", default-features = false, optional = true }
 serde_json = { version = "1.0", default-features = false, features = ["alloc"], optional = true }
 
 # dwarf
-gimli = { version = "0.31", default-features = false, features = ["read"], optional = true }
+gimli = { git = "https://github.com/gimli-rs/gimli", rev = "7335f00e7c39fd501511584fefb0ba974117c950", default-features = false, features = ["read"], optional = true }
+typed-arena = { version = "2.0", default-features = false, optional = true }
 
 # ppc
-cwdemangle = { version = "1.0", optional = true }
-cwextab = { version = "1.0", optional = true }
-ppc750cl = { version = "0.3", optional = true }
+cwextab = { version = "1.1", optional = true }
+powerpc = { version = "0.4", optional = true }
 rlwinmdec = { version = "1.1", optional = true }
 
 # mips
-rabbitizer = { version = "2.0.0-alpha.1", default-features = false, features = ["all_extensions"], optional = true }
+rabbitizer = { version = "2.0.0-alpha.7", default-features = false, features = ["all_extensions"], optional = true }
 
 # x86
-cpp_demangle = { version = "0.4", default-features = false, features = ["alloc"], optional = true }
 iced-x86 = { version = "1.21", default-features = false, features = ["decoder", "intel", "gas", "masm", "nasm", "exhaustive_enums", "no_std"], optional = true }
-msvc-demangler = { version = "0.11", optional = true }
 
 # arm
-unarm = { version = "1.7", optional = true }
+unarm = { version = "2.1", optional = true }
 arm-attr = { version = "0.2", optional = true }
 
 # arm64
@@ -166,15 +169,21 @@ yaxpeax-arch = { version = "0.3", default-features = false, optional = true }
 yaxpeax-arm = { version = "0.3", default-features = false, optional = true }
 
 # build
-notify = { version = "8.0.0", optional = true }
-notify-debouncer-full = { version = "0.5.0", optional = true }
+notify = { version = "8.2.0", optional = true }
+notify-debouncer-full = { version = "0.6.0", optional = true }
 shell-escape = { version = "0.1", optional = true }
-tempfile = { version = "3.19", optional = true }
+tempfile = { version = "3.23", optional = true }
 time = { version = "0.3", optional = true }
-encoding_rs = "0.8.35"
+encoding_rs = { version = "0.8.35", optional = true }
+
+# demangler
+cpp_demangle = { version = "0.5", optional = true, default-features = false, features = ["alloc"] }
+cwdemangle = { version = "1.0", optional = true }
+gnuv2_demangle = { version = "0.4", optional = true }
+msvc-demangler = { version = "0.11", optional = true }
 
 [target.'cfg(windows)'.dependencies]
-winapi = { version = "0.3", optional = true }
+winapi = { version = "0.3", optional = true, features = ["winbase"] }
 
 # For Linux static binaries, use rustls
 [target.'cfg(target_os = "linux")'.dependencies]
@@ -188,10 +197,10 @@ self_update = { version = "0.42", optional = true }
 
 [build-dependencies]
 heck = { version = "0.5", optional = true }
-pbjson-build = { version = "0.7", optional = true }
+pbjson-build = { version = "0.8", optional = true }
 prettyplease = { version = "0.2", optional = true }
 proc-macro2 = { version = "1.0", optional = true }
-prost-build = { version = "0.13", optional = true }
+prost-build = { version = "0.14", optional = true }
 quote = { version = "1.0", optional = true }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0" }
@@ -200,4 +209,4 @@ syn = { version = "2.0", optional = true }
 [dev-dependencies]
 # Enable all features for tests
 objdiff-core = { path = ".", features = ["all"] }
-insta = "1.42"
+insta = "1.43"

objdiff-core/README.md

@@ -5,11 +5,12 @@ objdiff-core contains the core functionality of [objdiff](https://github.com/enc
 ## Crate feature flags
 
 - **`all`**: Enables all main features.
+- **`bindings`**: Enables serialization and deserialization of objdiff data structures.
 - **`config`**: Enables objdiff configuration file support.
 - **`dwarf`**: Enables extraction of line number information from DWARF debug sections.
-- **`mips`**: Enables the MIPS backend powered by [rabbitizer](https://github.com/Decompollaborate/rabbitizer). (Note: C library with Rust bindings)
-- **`ppc`**: Enables the PowerPC backend powered by [ppc750cl](https://github.com/encounter/ppc750cl).
-- **`x86`**: Enables the x86 backend powered by [iced-x86](https://crates.io/crates/iced-x86).
-- **`arm`**: Enables the ARM backend powered by [unarm](https://github.com/AetiasHax/unarm).
 - **`arm64`**: Enables the ARM64 backend powered by [yaxpeax-arm](https://github.com/iximeow/yaxpeax-arm).
-- **`bindings`**: Enables serialization and deserialization of objdiff data structures.
+- **`arm`**: Enables the ARM backend powered by [unarm](https://github.com/AetiasHax/unarm).
+- **`mips`**: Enables the MIPS backend powered by [rabbitizer](https://github.com/Decompollaborate/rabbitizer).
+- **`ppc`**: Enables the PowerPC backend powered by [powerpc](https://github.com/encounter/powerpc-rs).
+- **`superh`**: Enables the SuperH backend powered by an included disassembler.
+- **`x86`**: Enables the x86 backend powered by [iced-x86](https://crates.io/crates/iced-x86).

objdiff-core/config-schema.json

@@ -25,6 +25,56 @@
         }
       ]
     },
+    {
+      "id": "demangler",
+      "type": "choice",
+      "default": "auto",
+      "name": "Demangler",
+      "description": "Which demangler should be used to demangle each symbol.",
+      "items": [
+        {
+          "value": "auto",
+          "name": "Auto",
+          "description": "Try to automatically guess the mangling format."
+        },
+        {
+          "value": "none",
+          "name": "None",
+          "description": "Disable demangling."
+        },
+        {
+          "value": "codewarrior",
+          "name": "CodeWarrior"
+        },
+        {
+          "value": "itanium",
+          "name": "Itanium"
+        },
+        {
+          "value": "msvc",
+          "name": "MSVC"
+        },
+        {
+          "value": "gnu_legacy",
+          "name": "GNU g++ (Legacy)",
+          "description": "Use the old GNU mangling ABI. Used up to g++ 2.9.x"
+        }
+      ]
+    },
+    {
+      "id": "analyzeDataFlow",
+      "type": "boolean",
+      "default": false,
+      "name": "(Experimental) Perform data flow analysis",
+      "description": "Use data flow analysis to display known information about register contents where possible"
+    },
+    {
+      "id": "showDataFlow",
+      "type": "boolean",
+      "default": true,
+      "name": "Show data flow",
+      "description": "Show data flow analysis results in place of register name where present"
+    },
     {
       "id": "spaceBetweenArgs",
       "type": "boolean",
@@ -32,6 +82,27 @@
       "name": "Space between args",
       "description": "Adds a space between arguments in the diff output."
     },
+    {
+      "id": "showSymbolSizes",
+      "type": "choice",
+      "default": "off",
+      "name": "Show symbol sizes",
+      "description": "Shows symbol sizes in the symbol view.",
+      "items": [
+        {
+          "value": "off",
+          "name": "Off"
+        },
+        {
+          "value": "hex",
+          "name": "Hex"
+        },
+        {
+          "value": "decimal",
+          "name": "Decimal"
+        }
+      ]
+    },
     {
       "id": "combineDataSections",
       "type": "boolean",
@@ -57,20 +128,43 @@
           "value": "auto",
           "name": "Auto"
         },
+        {
+          "value": "v4",
+          "name": "ARMv4"
+        },
         {
           "value": "v4t",
           "name": "ARMv4T (GBA)"
         },
+        {
+          "value": "v5t",
+          "name": "ARMv5T"
+        },
         {
           "value": "v5te",
           "name": "ARMv5TE (DS)"
         },
+        {
+          "value": "v5tej",
+          "name": "ARMv5TEJ"
+        },
+        {
+          "value": "v6",
+          "name": "ARMv6"
+        },
         {
           "value": "v6k",
           "name": "ARMv6K (3DS)"
         }
       ]
     },
+    {
+      "id": "arm.vfpV2",
+      "type": "boolean",
+      "default": true,
+      "name": "VFPv2 instructions",
+      "description": "Adds floating-point instructions from VFPv2."
+    },
     {
       "id": "arm.unifiedSyntax",
       "type": "boolean",
@@ -144,6 +238,10 @@
           "value": "o32",
           "name": "O32"
         },
+        {
+          "value": "o64",
+          "name": "O64"
+        },
         {
           "value": "n32",
           "name": "N32"
@@ -151,6 +249,14 @@
         {
           "value": "n64",
           "name": "N64"
+        },
+        {
+          "value": "eabi32",
+          "name": "eabi32"
+        },
+        {
+          "value": "eabi64",
+          "name": "eabi64"
         }
       ]
     },
@@ -233,6 +339,8 @@
       "name": "General",
       "properties": [
         "functionRelocDiffs",
+        "demangler",
+        "showSymbolSizes",
         "spaceBetweenArgs",
         "combineDataSections",
         "combineTextSections"
@@ -243,6 +351,7 @@
       "name": "ARM",
       "properties": [
         "arm.archVersion",
+        "arm.vfpV2",
         "arm.unifiedSyntax",
         "arm.avRegisters",
         "arm.r9Usage",
@@ -254,25 +363,17 @@
     {
       "id": "mips",
       "name": "MIPS",
-      "properties": [
-        "mips.abi",
-        "mips.instrCategory",
-        "mips.registerPrefix"
-      ]
+      "properties": ["mips.abi", "mips.instrCategory", "mips.registerPrefix"]
     },
     {
       "id": "ppc",
       "name": "PowerPC",
-      "properties": [
-        "ppc.calculatePoolRelocations"
-      ]
+      "properties": ["ppc.calculatePoolRelocations", "analyzeDataFlow"]
     },
     {
       "id": "x86",
       "name": "x86",
-      "properties": [
-        "x86.formatter"
-      ]
+      "properties": ["x86.formatter"]
     }
   ]
 }

objdiff-core/config_gen.rs

@@ -60,10 +60,10 @@ pub struct ConfigGroup {
 }
 
 fn build_doc(name: &str, description: Option<&str>) -> TokenStream {
-    let mut doc = format!(" {}", name);
+    let mut doc = format!(" {name}");
     let mut out = quote! { #[doc = #doc] };
     if let Some(description) = description {
-        doc = format!(" {}", description);
+        doc = format!(" {description}");
         out.extend(quote! { #[doc = ""] });
         out.extend(quote! { #[doc = #doc] });
     }
@@ -443,9 +443,9 @@ pub fn generate_diff_config() {
         }
         impl core::fmt::Display for ConfigPropertyValue {
             fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-                match self {
-                    ConfigPropertyValue::Boolean(value) => write!(f, "{}", value),
-                    ConfigPropertyValue::Choice(value) => write!(f, "{}", value),
+                match *self {
+                    ConfigPropertyValue::Boolean(value) => write!(f, "{value}"),
+                    ConfigPropertyValue::Choice(value) => f.write_str(value),
                 }
             }
         }

objdiff-core/protos/diff.proto

@@ -1,165 +0,0 @@
-syntax = "proto3";
-
-package objdiff.diff;
-
-// A symbol
-message Symbol {
-  // Name of the symbol
-  string name = 1;
-  // Demangled name of the symbol
-  optional string demangled_name = 2;
-  // Symbol address
-  uint64 address = 3;
-  // Symbol size
-  uint64 size = 4;
-  // Bitmask of SymbolFlag
-  uint32 flags = 5;
-}
-
-// Symbol visibility flags
-enum SymbolFlag {
-  SYMBOL_NONE = 0;
-  SYMBOL_GLOBAL = 1;
-  SYMBOL_LOCAL = 2;
-  SYMBOL_WEAK = 4;
-  SYMBOL_COMMON = 8;
-  SYMBOL_HIDDEN = 16;
-}
-
-// A single parsed instruction
-message Instruction {
-  // Instruction address
-  uint64 address = 1;
-  // Instruction size
-  uint32 size = 2;
-  // Instruction opcode
-  uint32 opcode = 3;
-  // Instruction mnemonic
-  string mnemonic = 4;
-  // Instruction formatted string
-  string formatted = 5;
-  // Original (unsimplified) instruction string
-  optional string original = 6;
-  // Instruction arguments
-  repeated Argument arguments = 7;
-  // Instruction relocation
-  optional Relocation relocation = 8;
-  // Instruction branch destination
-  optional uint64 branch_dest = 9;
-  // Instruction line number
-  optional uint32 line_number = 10;
-}
-
-// An instruction argument
-message Argument {
-  oneof value {
-    // Plain text
-    string plain_text = 1;
-    // Value
-    ArgumentValue argument = 2;
-    // Relocation
-    ArgumentRelocation relocation = 3;
-    // Branch destination
-    uint64 branch_dest = 4;
-  }
-}
-
-// An instruction argument value
-message ArgumentValue {
-  oneof value {
-    // Signed integer
-    int64 signed = 1;
-    // Unsigned integer
-    uint64 unsigned = 2;
-    // Opaque value
-    string opaque = 3;
-  }
-}
-
-// Marker type for relocation arguments
-message ArgumentRelocation {
-}
-
-message Relocation {
-  uint32 type = 1;
-  string type_name = 2;
-  RelocationTarget target = 3;
-}
-
-message RelocationTarget {
-  uint32 symbol_index = 1;
-  int64 addend = 2;
-}
-
-message InstructionDiffRow {
-  DiffKind diff_kind = 1;
-  optional Instruction instruction = 2;
-  optional InstructionBranchFrom branch_from = 3;
-  optional InstructionBranchTo branch_to = 4;
-  repeated ArgumentDiff arg_diff = 5;
-}
-
-message ArgumentDiff {
-  optional uint32 diff_index = 1;
-}
-
-enum DiffKind {
-  DIFF_NONE = 0;
-  DIFF_REPLACE = 1;
-  DIFF_DELETE = 2;
-  DIFF_INSERT = 3;
-  DIFF_OP_MISMATCH = 4;
-  DIFF_ARG_MISMATCH = 5;
-}
-
-message InstructionBranchFrom {
-  repeated uint32 instruction_index = 1;
-  uint32 branch_index = 2;
-}
-
-message InstructionBranchTo {
-  uint32 instruction_index = 1;
-  uint32 branch_index = 2;
-}
-
-message SymbolDiff {
-  Symbol symbol = 1;
-  repeated InstructionDiffRow instruction_rows = 2;
-  optional float match_percent = 3;
-  // The symbol index in the _other_ object that this symbol was diffed against
-  optional uint32 target_symbol = 5;
-}
-
-message DataDiff {
-  DiffKind kind = 1;
-  bytes data = 2;
-  // May be larger than data
-  uint64 size = 3;
-}
-
-message SectionDiff {
-  string name = 1;
-  SectionKind kind = 2;
-  uint64 size = 3;
-  uint64 address = 4;
-  reserved 5;
-  repeated DataDiff data = 6;
-  optional float match_percent = 7;
-}
-
-enum SectionKind {
-  SECTION_UNKNOWN = 0;
-  SECTION_TEXT = 1;
-  SECTION_DATA = 2;
-  SECTION_BSS = 3;
-}
-
-message ObjectDiff {
-  repeated SectionDiff sections = 1;
-  repeated SymbolDiff symbols = 2;
-}
-
-message DiffResult {
-  optional ObjectDiff left = 1;
-  optional ObjectDiff right = 2;
-}

objdiff-core/protos/report.proto

@@ -99,6 +99,8 @@ message ReportItem {
   float fuzzy_match_percent = 3;
   // Extra metadata for this item
   optional ReportItemMetadata metadata = 4;
+  // Address of the item (section-relative offset)
+  optional uint64 address = 5;
 }
 
 // Extra metadata for an item