More updates to report types

Author: encounter

objdiff-cli/protos/proto_descriptor.bin

@@ -2,84 +2,134 @@ syntax = "proto3";
 
 package objdiff.report;
 
-message Report {
+// Progress info for a report or unit
+message Measures {
+  // Overall match percent, including partially matched functions and data
   float fuzzy_match_percent = 1;
+  // Total size of code in bytes
   uint64 total_code = 2;
+  // Fully matched code size in bytes
   uint64 matched_code = 3;
+  // Fully matched code percent
   float matched_code_percent = 4;
+  // Total size of data in bytes
   uint64 total_data = 5;
+  // Fully matched data size in bytes
   uint64 matched_data = 6;
+  // Fully matched data percent
   float matched_data_percent = 7;
+  // Total number of functions
   uint32 total_functions = 8;
+  // Fully matched functions
   uint32 matched_functions = 9;
+  // Fully matched functions percent
   float matched_functions_percent = 10;
-  repeated ReportUnit units = 11;
 }
 
+// Project progress report
+message Report {
+  // Overall progress info
+  Measures measures = 1;
+  // Units within this report
+  repeated ReportUnit units = 2;
+}
+
+// A unit of the report (usually a translation unit)
 message ReportUnit {
+  // The name of the unit
   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;
+  // Progress info for this unit
+  Measures measures = 2;
+  // Sections within this unit
+  repeated ReportItem sections = 3;
+  // Functions within this unit
+  repeated ReportItem functions = 4;
+  // Extra metadata for this unit
+  optional ReportUnitMetadata metadata = 5;
 }
 
+// Extra metadata for a unit
+message ReportUnitMetadata {
+  // Whether this unit is marked as complete (or "linked")
+  optional bool complete = 1;
+  // The name of the module this unit belongs to
+  optional string module_name = 2;
+  // The ID of the module this unit belongs to
+  optional uint32 module_id = 3;
+  // The path to the source file of this unit
+  optional string source_path = 4;
+}
+
+// A section or function within a unit
 message ReportItem {
+  // The name of the item
   string name = 1;
+  // The size of the item in bytes
   uint64 size = 2;
+  // The overall match percent for this item
   float fuzzy_match_percent = 3;
-  optional string demangled_name = 4;
-  optional uint64 address = 5;
+  // Extra metadata for this item
+  optional ReportItemMetadata metadata = 4;
+}
+
+// Extra metadata for an item
+message ReportItemMetadata {
+  // The demangled name of the function
+  optional string demangled_name = 1;
+  // The virtual address of the function or section
+  optional uint64 virtual_address = 2;
 }
 
-// Used as stdin for the changes command
+// A pair of reports to compare and generate changes
 message ChangesInput {
+  // The previous report
   Report from = 1;
+  // The current report
   Report to = 2;
 }
 
+// Changes between two reports
 message Changes {
-  ChangeInfo from = 1;
-  ChangeInfo to = 2;
+  // The progress info for the previous report
+  Measures from = 1;
+  // The progress info for the current report
+  Measures to = 2;
+  // Units that changed
   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;
-}
-
+// A changed unit
 message ChangeUnit {
+  // The name of the unit
   string name = 1;
-  optional ChangeInfo from = 2;
-  optional ChangeInfo to = 3;
+  // The previous progress info (omitted if new)
+  optional Measures from = 2;
+  // The current progress info (omitted if removed)
+  optional Measures to = 3;
+  // Sections that changed
   repeated ChangeItem sections = 4;
+  // Functions that changed
   repeated ChangeItem functions = 5;
+  // Extra metadata for this unit
+  optional ReportUnitMetadata metadata = 6;
 }
 
+// A changed section or function
 message ChangeItem {
+  // The name of the item
   string name = 1;
+  // The previous progress info (omitted if new)
   optional ChangeItemInfo from = 2;
+  // The current progress info (omitted if removed)
   optional ChangeItemInfo to = 3;
+  // Extra metadata for this item
+  optional ReportItemMetadata metadata = 4;
 }
 
+// Progress info for a section or function
 message ChangeItemInfo {
+  // The overall match percent for this item
   float fuzzy_match_percent = 1;
+  // The size of the item in bytes
   uint64 size = 2;
-}
+}