Support protobuf format for reports

This migrates to using protobuf to
define the "report" and "changes"
formats in objdiff-cli.

The JSON output now uses the Proto3
"JSON Mapping", which is slightly
incompatible with the existing JSON
format. Mainly, 64-bit numbers are
represented as strings, and addresses
are decimal strings instead of hex.

However, the older JSON format is
still accepted by "report changes"
to ease migration.

Author: encounter

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "objdiff-cli"
-version = "2.0.0-beta.3"
+version = "2.0.0-beta.4"
 edition = "2021"
 rust-version = "1.70"
 authors = ["Luke Street <[email protected]>"]
@@ -18,7 +18,10 @@ anyhow = "1.0.82"
 argp = "0.3.0"
 crossterm = "0.27.0"
 enable-ansi-support = "0.2.1"
+memmap2 = "0.9.4"
 objdiff-core = { path = "../objdiff-core", features = ["all"] }
+pbjson = "0.7.0"
+prost = "0.13.1"
 ratatui = "0.26.2"
 rayon = "1.10.0"
 serde = { version = "1", features = ["derive"] }
@@ -27,3 +30,8 @@ supports-color = "3.0.0"
 time = { version = "0.3.36", features = ["formatting", "local-offset"] }
 tracing = "0.1.40"
 tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
+
+[build-dependencies]
+prost-build = "0.13.1"
+pbjson-build = "0.7.0"
+

objdiff-cli/Cargo.toml

@@ -1,3 +1,5 @@
+use std::path::PathBuf;
+
 fn main() {
     let output = std::process::Command::new("git")
         .args(["rev-parse", "HEAD"])
@@ -6,4 +8,28 @@ fn main() {
     let rev = String::from_utf8(output.stdout).expect("Failed to parse git output");
     println!("cargo:rustc-env=GIT_COMMIT_SHA={rev}");
     println!("cargo:rustc-rerun-if-changed=.git/HEAD");
+
+    let root = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("protos");
+    let proto_files = vec![root.join("report.proto")];
+
+    // Tell cargo to recompile if any of these proto files are changed
+    for proto_file in &proto_files {
+        println!("cargo:rerun-if-changed={}", proto_file.display());
+    }
+
+    let descriptor_path =
+        PathBuf::from(std::env::var("OUT_DIR").unwrap()).join("proto_descriptor.bin");
+
+    prost_build::Config::new()
+        .file_descriptor_set_path(&descriptor_path)
+        .compile_protos(&proto_files, &[root])
+        .expect("Failed to compile protos");
+
+    let descriptor_set = std::fs::read(descriptor_path).expect("Failed to read descriptor set");
+    pbjson_build::Builder::new()
+        .register_descriptors(&descriptor_set)
+        .expect("Failed to register descriptors")
+        .preserve_proto_field_names()
+        .build(&[".objdiff"])
+        .expect("Failed to build pbjson");
 }

objdiff-cli/build.rs

@@ -0,0 +1,85 @@
+syntax = "proto3";
+
+package objdiff.report;
+
+message Report {
+  float fuzzy_match_percent = 1;
+  uint64 total_code = 2;
+  uint64 matched_code = 3;
+  float matched_code_percent = 4;
+  uint64 total_data = 5;
+  uint64 matched_data = 6;
+  float matched_data_percent = 7;
+  uint32 total_functions = 8;
+  uint32 matched_functions = 9;
+  float matched_functions_percent = 10;
+  repeated ReportUnit units = 11;
+}
+
+message ReportUnit {
+  string name = 1;
+  float fuzzy_match_percent = 2;
+  uint64 total_code = 3;
+  uint64 matched_code = 4;
+  uint64 total_data = 5;
+  uint64 matched_data = 6;
+  uint32 total_functions = 7;
+  uint32 matched_functions = 8;
+  optional bool complete = 9;
+  optional string module_name = 10;
+  optional uint32 module_id = 11;
+  repeated ReportItem sections = 12;
+  repeated ReportItem functions = 13;
+}
+
+message ReportItem {
+  string name = 1;
+  uint64 size = 2;
+  float fuzzy_match_percent = 3;
+  optional string demangled_name = 4;
+  optional uint64 address = 5;
+}
+
+// Used as stdin for the changes command
+message ChangesInput {
+  Report from = 1;
+  Report to = 2;
+}
+
+message Changes {
+  ChangeInfo from = 1;
+  ChangeInfo to = 2;
+  repeated ChangeUnit units = 3;
+}
+
+message ChangeInfo {
+  float fuzzy_match_percent = 1;
+  uint64 total_code = 2;
+  uint64 matched_code = 3;
+  float matched_code_percent = 4;
+  uint64 total_data = 5;
+  uint64 matched_data = 6;
+  float matched_data_percent = 7;
+  uint32 total_functions = 8;
+  uint32 matched_functions = 9;
+  float matched_functions_percent = 10;
+}
+
+message ChangeUnit {
+  string name = 1;
+  optional ChangeInfo from = 2;
+  optional ChangeInfo to = 3;
+  repeated ChangeItem sections = 4;
+  repeated ChangeItem functions = 5;
+}
+
+message ChangeItem {
+  string name = 1;
+  optional ChangeItemInfo from = 2;
+  optional ChangeItemInfo to = 3;
+}
+
+message ChangeItemInfo {
+  float fuzzy_match_percent = 1;
+  uint64 size = 2;
+}