feat(log): unit-registered event

Author: weihanglo

src/cargo/core/compiler/build_context/mod.rs

@@ -78,6 +78,9 @@ pub struct BuildContext<'a, 'gctx> {
     /// The dependency graph of units to compile.
     pub unit_graph: UnitGraph,
 
+    /// A map from unit to index.
+    pub unit_to_index: HashMap<Unit, u64>,
+
     /// Reverse-dependencies of documented units, used by the `rustdoc --scrape-examples` flag.
     pub scrape_units: Vec<Unit>,
 
@@ -96,6 +99,7 @@ impl<'a, 'gctx> BuildContext<'a, 'gctx> {
         target_data: RustcTargetData<'gctx>,
         roots: Vec<Unit>,
         unit_graph: UnitGraph,
+        unit_to_index: HashMap<Unit, u64>,
         scrape_units: Vec<Unit>,
     ) -> CargoResult<BuildContext<'a, 'gctx>> {
         let all_kinds = unit_graph
@@ -116,6 +120,7 @@ impl<'a, 'gctx> BuildContext<'a, 'gctx> {
             target_data,
             roots,
             unit_graph,
+            unit_to_index,
             scrape_units,
             all_kinds,
         })

src/cargo/ops/cargo_compile/mod.rs

@@ -64,6 +64,7 @@ use annotate_snippets::{Group, Level, Origin};
 pub use compile_filter::{CompileFilter, FilterRule, LibRule};
 
 pub(super) mod unit_generator;
+use itertools::Itertools as _;
 use unit_generator::UnitGenerator;
 
 mod packages;
@@ -520,7 +521,23 @@ pub fn create_bcx<'a, 'gctx>(
         build_config.compile_time_deps_only,
     );
 
+    // unit_graph must be immutable after this point.
+    let unit_graph = unit_graph;
+    let units: Vec<_> = unit_graph.keys().sorted().collect();
+    let unit_to_index: HashMap<_, _> = units
+        .iter()
+        .enumerate()
+        .map(|(i, &unit)| (unit.clone(), i as u64))
+        .collect();
     if let Some(logger) = logger {
+        for (i, unit) in units.into_iter().enumerate() {
+            logger.log(LogMessage::UnitRegistered {
+                package_id: unit.pkg.package_id().to_spec(),
+                target: (&unit.target).into(),
+                mode: unit.mode,
+                index: i as u64,
+            });
+        }
         let elapsed = ws.gctx().creation_time().elapsed().as_secs_f64();
         logger.log(LogMessage::UnitGraphFinished { elapsed });
     }
@@ -641,6 +658,7 @@ where `<compatible-ver>` is the latest version supporting rustc {rustc_version}"
         target_data,
         root_units,
         unit_graph,
+        unit_to_index,
         scrape_units,
     )?;
 

src/cargo/util/log_message.rs

@@ -59,6 +59,19 @@ pub enum LogMessage {
         /// Seconds elapsed from build start.
         elapsed: f64,
     },
+    /// Emitted when a compilation unit is registered in the unit graph,
+    /// right before [`LogMessage::UnitGraphFinished`] that Cargo finalizes
+    /// the unit graph.
+    UnitRegistered {
+        /// Package ID specification.
+        package_id: PackageIdSpec,
+        /// Cargo target (lib, bin, example, etc.).
+        target: Target,
+        /// The compilation action this unit is for (check, build, test, etc.).
+        mode: CompileMode,
+        /// Unit index for compact reference in subsequent events.
+        index: u64,
+    },
     /// Emitted when a compilation unit starts.
     UnitStarted {
         /// Package ID specification.

tests/testsuite/build_analysis.rs

@@ -535,6 +535,66 @@ fn log_msg_unit_graph() {
     "run_id": "[..]T[..]Z-[..]",
     "timestamp": "[..]T[..]Z"
   },
+  {
+    "index": 0,
+    "mode": "check",
+    "package_id": "path+[ROOTURL]/foo/bar#0.0.0",
+    "reason": "unit-registered",
+    "run_id": "[..]T[..]Z-[..]",
+    "target": {
+      "kind": "lib",
+      "name": "bar"
+    },
+    "timestamp": "[..]T[..]Z"
+  },
+  {
+    "index": 1,
+    "mode": "doc",
+    "package_id": "path+[ROOTURL]/foo/bar#0.0.0",
+    "reason": "unit-registered",
+    "run_id": "[..]T[..]Z-[..]",
+    "target": {
+      "kind": "lib",
+      "name": "bar"
+    },
+    "timestamp": "[..]T[..]Z"
+  },
+  {
+    "index": 2,
+    "mode": "doc",
+    "package_id": "path+[ROOTURL]/foo#0.0.0",
+    "reason": "unit-registered",
+    "run_id": "[..]T[..]Z-[..]",
+    "target": {
+      "kind": "lib",
+      "name": "foo"
+    },
+    "timestamp": "[..]T[..]Z"
+  },
+  {
+    "index": 3,
+    "mode": "build",
+    "package_id": "path+[ROOTURL]/foo#0.0.0",
+    "reason": "unit-registered",
+    "run_id": "[..]T[..]Z-[..]",
+    "target": {
+      "kind": "build-script",
+      "name": "build-script-build"
+    },
+    "timestamp": "[..]T[..]Z"
+  },
+  {
+    "index": 4,
+    "mode": "run-custom-build",
+    "package_id": "path+[ROOTURL]/foo#0.0.0",
+    "reason": "unit-registered",
+    "run_id": "[..]T[..]Z-[..]",
+    "target": {
+      "kind": "build-script",
+      "name": "build-script-build"
+    },
+    "timestamp": "[..]T[..]Z"
+  },
   {
     "elapsed": "{...}",
     "reason": "unit-graph-finished",