From f9fcf15d41621d0788a2a311c4cbacae3ab30d35 Mon Sep 17 00:00:00 2001
From: Arpad Borsos <arpad.borsos@sentry.io>
Date: Fri, 22 Sep 2023 14:00:44 +0200
Subject: [PATCH] Emit a MODULE record for PE files

PE files reference their corresponding debug file via name and DebugId.
We can put these in a CfiCache `MODULE` entry to be able to backfill a missing DebugFile/DebugId in
a minidump.
---
 Cargo.lock              | 51 ++++++++++++++++++++++++-----------------
 symbolic-cfi/src/lib.rs | 13 +++++++++++
 2 files changed, 43 insertions(+), 21 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 5844aa24..499c291e 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -23,7 +23,7 @@ dependencies = [
 
 [[package]]
 name = "addr2line"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "anyhow",
  "clap",
@@ -476,7 +476,7 @@ dependencies = [
 
 [[package]]
 name = "debuginfo_debug"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "anyhow",
  "clap",
@@ -497,7 +497,7 @@ checksum = "f0bc8fbe9441c17c9f46f75dfe27fa1ddb6c68a461ccaed0481419219d4f10d3"
 
 [[package]]
 name = "dump_cfi"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "anyhow",
  "clap",
@@ -506,7 +506,7 @@ dependencies = [
 
 [[package]]
 name = "dump_sources"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "clap",
  "symbolic",
@@ -626,6 +626,15 @@ dependencies = [
  "percent-encoding",
 ]
 
+[[package]]
+name = "frame-dedupe"
+version = "0.1.0"
+dependencies = [
+ "indexmap 1.9.3",
+ "serde",
+ "serde_json",
+]
+
 [[package]]
 name = "from_variant"
 version = "0.1.6"
@@ -1125,7 +1134,7 @@ dependencies = [
 
 [[package]]
 name = "minidump_stackwalk"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "async-trait",
  "clap",
@@ -1286,7 +1295,7 @@ dependencies = [
 
 [[package]]
 name = "object_debug"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "clap",
  "symbolic",
@@ -1897,7 +1906,7 @@ dependencies = [
 
 [[package]]
 name = "sourcemapcache_debug"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "anyhow",
  "clap",
@@ -2116,7 +2125,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "symbolic-cfi",
  "symbolic-common",
@@ -2131,7 +2140,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-cabi"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "proguard",
  "sourcemap",
@@ -2141,7 +2150,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-cfi"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "insta",
  "similar-asserts",
@@ -2153,7 +2162,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-common"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "debugid",
  "memmap2",
@@ -2167,7 +2176,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-debuginfo"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "criterion",
  "debugid",
@@ -2202,7 +2211,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-demangle"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "cc",
  "cpp_demangle",
@@ -2214,7 +2223,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-il2cpp"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "indexmap 2.0.0",
  "serde_json",
@@ -2224,7 +2233,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-ppdb"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "flate2",
  "indexmap 1.9.3",
@@ -2240,7 +2249,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-sourcemapcache"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "itertools",
  "js-source-scopes",
@@ -2254,7 +2263,7 @@ dependencies = [
 
 [[package]]
 name = "symbolic-symcache"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "criterion",
  "indexmap 2.0.0",
@@ -2271,11 +2280,11 @@ dependencies = [
 
 [[package]]
 name = "symbolic-testutils"
-version = "12.4.0"
+version = "12.4.1"
 
 [[package]]
 name = "symbolic-unreal"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "anylog",
  "bytes",
@@ -2295,7 +2304,7 @@ dependencies = [
 
 [[package]]
 name = "symcache_debug"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "anyhow",
  "clap",
@@ -2577,7 +2586,7 @@ checksum = "c0edd1e5b14653f783770bce4a4dabb4a5108a5370a5f5d8cfe8710c361f6c8b"
 
 [[package]]
 name = "unreal_engine_crash"
-version = "12.4.0"
+version = "12.4.1"
 dependencies = [
  "clap",
  "symbolic",
diff --git a/symbolic-cfi/src/lib.rs b/symbolic-cfi/src/lib.rs
index c014e512..b78f9c04 100644
--- a/symbolic-cfi/src/lib.rs
+++ b/symbolic-cfi/src/lib.rs
@@ -1240,6 +1240,19 @@ impl CfiCache<'static> {
     pub fn from_object(object: &Object<'_>) -> Result<Self, CfiError> {
         let mut buffer = vec![];
         write_preamble(&mut buffer, CFICACHE_LATEST_VERSION)?;
+
+        if let Object::Pe(pe) = object {
+            let debug_file = pe.debug_file_name();
+            if let Some(debug_file) = debug_file {
+                write!(
+                    buffer,
+                    "MODULE windows {} {} {debug_file}",
+                    object.arch().name(),
+                    object.debug_id().breakpad(),
+                )?;
+            }
+        }
+
         AsciiCfiWriter::new(&mut buffer).process(object)?;
 
         let byteview = ByteView::from_vec(buffer);