-
-
Notifications
You must be signed in to change notification settings - Fork 206
/
DebugStackTrace.cs
458 lines (393 loc) · 17 KB
/
DebugStackTrace.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
using Sentry.Internal.Extensions;
using Sentry.Extensibility;
namespace Sentry.Internal;
/// <summary>
/// Sentry Stacktrace with debug images.
/// </summary>
internal class DebugStackTrace : SentryStackTrace
{
private readonly SentryOptions _options;
// Debug images referenced by frames in this StackTrace
private readonly Dictionary<Guid, int> _debugImageIndexByModule = new();
private const int DebugImageMissing = -1;
private bool _debugImagesMerged;
/*
* NOTE: While we could improve these regexes, doing so might break exception grouping on the backend.
* Specifically, RegexAsyncFunctionName would be better as: @"^(.*)\+<(\w*|<\w*>b__\d*)>d(?:__\d*)?$"
* But we cannot make this change without consequences of ignored events coming back to life in Sentry.
*/
private static readonly Regex RegexAsyncFunctionName = new(@"^(.*)\+<(\w*)>d__\d*$",
RegexOptions.Compiled | RegexOptions.CultureInvariant);
private static readonly Regex RegexAnonymousFunction = new(@"^<(\w*)>b__\w+$",
RegexOptions.Compiled | RegexOptions.CultureInvariant);
private static readonly Regex RegexAsyncReturn = new(@"^(.+`[0-9]+)\[\[",
RegexOptions.Compiled | RegexOptions.CultureInvariant);
internal DebugStackTrace(SentryOptions options)
{
_options = options;
}
protected List<DebugImage> DebugImages { get; } = new();
internal static DebugStackTrace Create(SentryOptions options, StackTrace stackTrace, bool isCurrentStackTrace)
{
var result = new DebugStackTrace(options);
var frames = result.CreateFrames(stackTrace, isCurrentStackTrace)
.Reverse(); // Sentry expects the frames to be sent in reversed order
foreach (var frame in frames)
{
result.Frames.Add(frame);
}
return result;
}
internal void MergeDebugImagesInto(SentryEvent @event)
{
// This operation may only be run once because it is destructive to the object state;
// Frame indexes may be changed as well as _debugImageIndexByModule becoming invalid.
if (_debugImagesMerged)
{
throw new InvalidOperationException("Cannot call MergeDebugImagesInto multiple times");
}
_debugImagesMerged = true;
_options.LogDebug("Merging {0} debug images from stacktrace.", DebugImages.Count);
if (DebugImages.Count == 0)
{
return;
}
@event.DebugImages ??= new();
if (@event.DebugImages.Count == 0)
{
// Default case when there's just a single stacktrace (i.e. no inner exceptions).
@event.DebugImages.AddRange(DebugImages);
return;
}
// Otherwise, we must merge new images into an existing list, which means their relative indexes change.
// Therefore, we must also update indices specified in frame.AddressMode for each affected frame.
// We could just append _debugImages to @event.DebugImages and shift all indexes but merging is simple too.
var originalCount = @event.DebugImages.Count;
Dictionary<string, string> relocations = new();
for (var i = 0; i < DebugImages.Count; i++)
{
// First check if the image is already present on the event. Simple lookup should be faster than
// constructing a map first, assuming there are normally just a few debug images affected.
var found = false;
for (var j = 0; j < originalCount; j++)
{
if (DebugImages[i].ModuleVersionId == @event.DebugImages[j].ModuleVersionId)
{
if (i != j)
{
relocations.Add(DebugStackTrace.GetRelativeAddressMode(i), DebugStackTrace.GetRelativeAddressMode(j));
}
found = true;
}
}
if (!found)
{
relocations.Add(DebugStackTrace.GetRelativeAddressMode(i), DebugStackTrace.GetRelativeAddressMode(@event.DebugImages.Count));
@event.DebugImages.Add(DebugImages[i]);
}
}
foreach (var frame in Frames)
{
if (frame.AddressMode is not null && relocations.TryGetValue(frame.AddressMode, out var newAddressMode))
{
frame.AddressMode = newAddressMode;
}
}
}
/// <summary>
/// Creates an enumerator of <see cref="SentryStackFrame"/> from a <see cref="StackTrace"/>.
/// </summary>
private IEnumerable<SentryStackFrame> CreateFrames(StackTrace stackTrace, bool isCurrentStackTrace)
{
var frames = _options.StackTraceMode switch
{
StackTraceMode.Enhanced => EnhancedStackTrace.GetFrames(stackTrace).Select(p => p as StackFrame),
_ => stackTrace.GetFrames()
// error CS8619: Nullability of reference types in value of type 'StackFrame?[]' doesn't match target type 'IEnumerable<StackFrame>'.
#if NETCOREAPP3_0
.Where(f => f is not null)
#endif
};
// Not to throw on code that ignores nullability warnings.
if (frames.IsNull())
{
_options.LogDebug("No stack frames found. AttachStacktrace: '{0}', isCurrentStackTrace: '{1}'",
_options.AttachStacktrace, isCurrentStackTrace);
yield break;
}
Debug.Assert(frames != null);
var firstFrame = true;
foreach (var stackFrame in frames)
{
#if !NET5_0_OR_GREATER
if (stackFrame is null)
{
continue;
}
#endif
// Remove the frames until the call for capture with the SDK
if (firstFrame
&& isCurrentStackTrace
&& stackFrame.GetMethod() is { } method
&& method.DeclaringType?.AssemblyQualifiedName?.StartsWith("Sentry") == true)
{
_options.LogDebug("Skipping initial stack frame '{0}'", method.Name);
continue;
}
firstFrame = false;
yield return CreateFrame(stackFrame);
}
}
/// <summary>
/// Create a <see cref="SentryStackFrame"/> from a <see cref="StackFrame"/>.
/// </summary>
internal SentryStackFrame CreateFrame(StackFrame stackFrame) => InternalCreateFrame(stackFrame, true);
/// <summary>
/// Default the implementation of CreateFrame.
/// </summary>
private SentryStackFrame InternalCreateFrame(StackFrame stackFrame, bool demangle)
{
const string unknownRequiredField = "(unknown)";
string? projectPath = null;
var frame = new SentryStackFrame();
if (stackFrame.GetMethod() is { } method)
{
frame.Module = method.DeclaringType?.FullName ?? unknownRequiredField;
frame.Package = method.DeclaringType?.Assembly.FullName;
if (_options.StackTraceMode == StackTraceMode.Enhanced &&
stackFrame is EnhancedStackFrame enhancedStackFrame)
{
var stringBuilder = new StringBuilder();
frame.Function = enhancedStackFrame.MethodInfo.Append(stringBuilder, false).ToString();
if (enhancedStackFrame.MethodInfo.DeclaringType is { } declaringType)
{
stringBuilder.Clear();
stringBuilder.AppendTypeDisplayName(declaringType);
frame.Module = stringBuilder.ToString();
}
}
else
{
frame.Function = method.Name;
}
// Originally we didn't skip methods from dynamic assemblies, so not to break compatibility:
if (_options.StackTraceMode != StackTraceMode.Original && method.Module.Assembly.IsDynamic)
{
frame.InApp = false;
}
AttributeReader.TryGetProjectDirectory(method.Module.Assembly, out projectPath);
if (AddDebugImage(method.Module) is { } moduleIdx && moduleIdx != DebugImageMissing)
{
frame.AddressMode = DebugStackTrace.GetRelativeAddressMode(moduleIdx);
try
{
var token = method.MetadataToken;
// The top byte is the token type, the lower three bytes are the record id.
// See: https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ms404456(v=vs.100)#metadata-token-structure
var tokenType = token & 0xff000000;
// See https://docs.microsoft.com/en-us/dotnet/framework/unmanaged-api/metadata/cortokentype-enumeration
if (tokenType == 0x06000000) // CorTokenType.mdtMethodDef
{
var recordId = token & 0x00ffffff;
frame.FunctionId = $"0x{recordId:x}";
}
}
catch (InvalidOperationException)
{
// method.MetadataToken may throw
// see https://learn.microsoft.com/en-us/dotnet/api/system.reflection.memberinfo.metadatatoken?view=net-6.0
_options.LogDebug("Could not get MetadataToken for stack frame {0} from {1}", frame.Function, method.Module.Name);
}
}
}
frame.ConfigureAppFrame(_options);
if (stackFrame.GetFileName() is { } frameFileName)
{
if (projectPath != null && frameFileName.StartsWith(projectPath, StringComparison.OrdinalIgnoreCase))
{
frame.AbsolutePath = frameFileName;
frameFileName = frameFileName.Substring(projectPath.Length);
}
frame.FileName = frameFileName;
}
// stackFrame.HasILOffset() throws NotImplemented on Mono 5.12
var ilOffset = stackFrame.GetILOffset();
if (ilOffset != StackFrame.OFFSET_UNKNOWN)
{
frame.InstructionAddress = $"0x{ilOffset:x}";
}
var lineNo = stackFrame.GetFileLineNumber();
if (lineNo > 0)
{
frame.LineNumber = lineNo;
}
var colNo = stackFrame.GetFileColumnNumber();
if (lineNo > 0)
{
frame.ColumnNumber = colNo;
}
if (demangle && _options.StackTraceMode != StackTraceMode.Enhanced)
{
DemangleAsyncFunctionName(frame);
DemangleAnonymousFunction(frame);
DemangleLambdaReturnType(frame);
}
if (_options.StackTraceMode == StackTraceMode.Enhanced)
{
// In Enhanced mode, Module (which in this case is the Namespace)
// is already prepended to the function, after return type.
// Removing here at the end because this is used to resolve InApp=true/false
frame.Module = null;
}
return frame;
}
private static string GetRelativeAddressMode(int moduleIndex) => $"rel:{moduleIndex}";
/// <summary>
/// Clean up function and module names produced from `async` state machine calls.
/// </summary>
/// <para>
/// When the Microsoft cs.exe compiler compiles some modern C# features,
/// such as async/await calls, it can create synthetic function names that
/// do not match the function names in the original source code. Here we
/// reverse some of these transformations, so that the function and module
/// names that appears in the Sentry UI will match the function and module
/// names in the original source-code.
/// </para>
private static void DemangleAsyncFunctionName(SentryStackFrame frame)
{
if (frame.Module == null || frame.Function != "MoveNext")
{
return;
}
// Search for the function name in angle brackets followed by d__<digits>.
//
// Change:
// RemotePrinterService+<UpdateNotification>d__24 in MoveNext at line 457:13
// to:
// RemotePrinterService in UpdateNotification at line 457:13
var match = RegexAsyncFunctionName.Match(frame.Module);
if (match is {Success: true, Groups.Count: 3})
{
frame.Module = match.Groups[1].Value;
frame.Function = match.Groups[2].Value;
}
}
/// <summary>
/// Clean up function names for anonymous lambda calls.
/// </summary>
internal static void DemangleAnonymousFunction(SentryStackFrame frame)
{
if (frame.Function == null)
{
return;
}
// Search for the function name in angle brackets followed by b__<digits/letters>.
//
// Change:
// <BeginInvokeAsynchronousActionMethod>b__36
// to:
// BeginInvokeAsynchronousActionMethod { <lambda> }
var match = RegexAnonymousFunction.Match(frame.Function);
if (match is {Success: true, Groups.Count: 2})
{
frame.Function = match.Groups[1].Value + " { <lambda> }";
}
}
/// <summary>
/// Remove return type from module in a Task with a Lambda with a return value.
/// This was seen in Unity, see https://github.com/getsentry/sentry-unity/issues/845
/// </summary>
private static void DemangleLambdaReturnType(SentryStackFrame frame)
{
if (frame.Module == null)
{
return;
}
// Change:
// System.Threading.Tasks.Task`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] in InnerInvoke
// or System.Collections.Generic.List`1[[UnityEngine.Events.PersistentCall, UnityEngine.CoreModule, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] in get_Item
// to:
// System.Threading.Tasks.Task`1 in InnerInvoke`
// or System.Collections.Generic.List`1 in get_Item
var match = RegexAsyncReturn.Match(frame.Module);
if (match is {Success: true, Groups.Count: 2})
{
frame.Module = match.Groups[1].Value;
}
}
private PEReader? TryReadAssembly(string assemblyName)
{
if (_options.AssemblyReader is { } reader)
{
return reader.Invoke(assemblyName);
}
return File.Exists(assemblyName) ? new PEReader(File.OpenRead(assemblyName)) : null;
}
private int? AddDebugImage(Module module)
{
var id = module.ModuleVersionId;
if (_debugImageIndexByModule.TryGetValue(id, out var idx))
{
return idx;
}
var assemblyName = module.FullyQualifiedName;
using var peReader = TryReadAssembly(assemblyName);
if (peReader is null)
{
_options.LogDebug("Skipping DebugImage for module '{0}' because assembly wasn't found: '{1}'",
module.Name, assemblyName);
_debugImageIndexByModule.Add(id, DebugImageMissing); // don't try to resolve again
return null;
}
string? codeId = null;
var headers = peReader.PEHeaders;
if (headers.PEHeader is { } peHeader)
{
codeId = $"{headers.CoffHeader.TimeDateStamp:X8}{peHeader.SizeOfImage:x}";
}
string? debugId = null;
string? debugFile = null;
string? debugChecksum = null;
var debugDirs = peReader.ReadDebugDirectory();
foreach (var entry in debugDirs)
{
if (entry.Type == DebugDirectoryEntryType.PdbChecksum)
{
var checksum = peReader.ReadPdbChecksumDebugDirectoryData(entry);
var checksumHex = checksum.Checksum.AsSpan().ToHexString();
debugChecksum = $"{checksum.AlgorithmName}:{checksumHex}";
}
if (!entry.IsPortableCodeView)
{
continue;
}
var codeView = peReader.ReadCodeViewDebugDirectoryData(entry);
// Together 16B of the Guid concatenated with 4B of the TimeDateStamp field of the entry form a PDB ID that
// should be used to match the PE/COFF image with the associated PDB (instead of Guid and Age).
// Matching PDB ID is stored in the #Pdb stream of the .pdb file.
// See https://github.com/dotnet/runtime/blob/main/docs/design/specs/PE-COFF.md#codeview-debug-directory-entry-type-2
debugId = $"{codeView.Guid}-{entry.Stamp:x8}";
debugFile = codeView.Path;
}
// well, we are out of luck :-(
if (debugId == null)
{
_options.LogInfo("Skipping DebugImage for module '{0}' because DebugId couldn't be determined", module.Name);
_debugImageIndexByModule.Add(id, DebugImageMissing); // don't try to resolve again
return null;
}
idx = DebugImages.Count;
DebugImages.Add(new DebugImage
{
Type = "pe_dotnet",
CodeId = codeId,
CodeFile = assemblyName,
DebugId = debugId,
DebugChecksum = debugChecksum,
DebugFile = debugFile,
ModuleVersionId = id,
});
_debugImageIndexByModule.Add(id, idx);
return idx;
}
}