Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: IL2CPP Exception processor now checks for native support being enabled #1708

Merged
merged 4 commits into from
Jul 3, 2024
Merged

fix: IL2CPP Exception processor now checks for native support being enabled #1708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93b61b2
check for available native support
bitsandfoxes Jul 1, 2024
cbcec68
simplified change
bitsandfoxes Jul 1, 2024
64240ea
minimized change
bitsandfoxes Jul 1, 2024
d798472
Updated CHANGELOG.md
bitsandfoxes Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Fixes

- The IL2CPP exception processor no longer fails when the native support has been disabled ([#1708](https://github.com/getsentry/sentry-unity/pull/1708))

### Dependencies

- Bump Cocoa SDK from v8.29.1 to v8.30.0 ([#1702](https://github.com/getsentry/sentry-unity/pull/1702))
Expand Down
29 changes: 14 additions & 15 deletions src/Sentry.Unity/Il2CppEventProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,23 @@ namespace Sentry.Unity
{
internal class UnityIl2CppEventExceptionProcessor : ISentryEventExceptionProcessor
{
private readonly SentryUnityOptions _options;
private static SentryUnityOptions Options = null!; // private static will be initialized in the constructor
private static ISentryUnityInfo UnityInfo = null!; // private static will be initialized in the constructor
private readonly Il2CppMethods _il2CppMethods;

public UnityIl2CppEventExceptionProcessor(SentryUnityOptions options, ISentryUnityInfo unityInfo)
{
_options = options;
Options = options;
UnityInfo = unityInfo;
_il2CppMethods = unityInfo.Il2CppMethods ?? throw new ArgumentNullException(nameof(unityInfo.Il2CppMethods), "Unity IL2CPP methods are not available.");
_il2CppMethods = unityInfo.Il2CppMethods ?? throw new ArgumentNullException(nameof(unityInfo.Il2CppMethods),
"Unity IL2CPP methods are not available.");

_options.SdkIntegrationNames.Add("IL2CPPLineNumbers");
Options.SdkIntegrationNames.Add("IL2CPPLineNumbers");
}

public void Process(Exception incomingException, SentryEvent sentryEvent)
{
_options.DiagnosticLogger?.LogDebug("Running Unity IL2CPP event exception processor on: Event {0}", sentryEvent.EventId);
Options.DiagnosticLogger?.LogDebug("Running Unity IL2CPP event exception processor on: Event {0}", sentryEvent.EventId);

var sentryExceptions = sentryEvent.SentryExceptions;
if (sentryExceptions == null)
Expand All @@ -38,7 +39,6 @@ public void Process(Exception incomingException, SentryEvent sentryEvent)

var exceptions = EnumerateChainedExceptions(incomingException);
var usedImages = new HashSet<DebugImage>();
Logger = _options.DiagnosticLogger;

// Unity usually produces stack traces with relative offsets in the GameAssembly library.
// However, at least on Unity 2020 built Windows player, the offsets seem to be absolute.
Expand All @@ -61,7 +61,7 @@ public void Process(Exception incomingException, SentryEvent sentryEvent)

var nativeStackTrace = GetNativeStackTrace(exception);

_options.DiagnosticLogger?.LogDebug("NativeStackTrace Image: '{0}' (UUID: {1})", nativeStackTrace.ImageName, nativeStackTrace.ImageUuid);
Options.DiagnosticLogger?.LogDebug("NativeStackTrace Image: '{0}' (UUID: {1})", nativeStackTrace.ImageName, nativeStackTrace.ImageUuid);

// Unity by definition only builds a single library which we add once to our list of debug images.
// We use this when we encounter stack frames with relative addresses.
Expand All @@ -78,7 +78,7 @@ public void Process(Exception incomingException, SentryEvent sentryEvent)
var eventLen = sentryStacktrace.Frames.Count;
if (nativeLen != eventLen)
{
_options.DiagnosticLogger?.LogWarning(
Options.DiagnosticLogger?.LogWarning(
"Native and sentry stack trace lengths don't match '({0} != {1})' - this may cause invalid stack traces.",
nativeLen, eventLen);
}
Expand Down Expand Up @@ -127,7 +127,7 @@ public void Process(Exception incomingException, SentryEvent sentryEvent)
{
if (mainImageUUID is null)
{
_options.DiagnosticLogger?.LogWarning("Couldn't process stack trace - main image UUID reported as NULL by Unity");
Options.DiagnosticLogger?.LogWarning("Couldn't process stack trace - main image UUID reported as NULL by Unity");
continue;
}

Expand Down Expand Up @@ -174,7 +174,7 @@ public void Process(Exception incomingException, SentryEvent sentryEvent)
}
}

_options.DiagnosticLogger?.Log(logLevel, "Stack frame '{0}' at {1:X8} (originally {2:X8}) belongs to {3} {4}",
Options.DiagnosticLogger?.Log(logLevel, "Stack frame '{0}' at {1:X8} (originally {2:X8}) belongs to {3} {4}",
null, frame.Function, instructionAddress, nativeFrame.ToInt64(), image.CodeFile, notes ?? "");

_ = usedImages.Add(image);
Expand Down Expand Up @@ -217,21 +217,20 @@ public DebugImageInfo(DebugImage image)
public bool ContainsAddress(long address) => StartAddress <= address && address <= EndAddress;
}

private static IDiagnosticLogger? Logger;

private static readonly Lazy<List<DebugImageInfo>> DebugImagesSorted = new(() =>
{
var result = new List<DebugImageInfo>();
// Only on platforms where we actually use sentry-native.
if (UnityInfo.IsSupportedBySentryNative(Application.platform))
if (UnityInfo.IsSupportedBySentryNative(Application.platform) &&
UnityInfo.IsNativeSupportEnabled(Options, Application.platform))
{
var nativeDebugImages = C.DebugImages.Value;
foreach (var image in nativeDebugImages)
{
if (image.ImageSize is null)
{
Logger?.Log(SentryLevel.Debug,
Options.DiagnosticLogger?.Log(SentryLevel.Debug,
"Skipping debug image '{0}' (CodeId {1} | DebugId: {2}) because its size is NULL",
null, image.CodeFile, image.CodeId, image.DebugId);
continue;
Expand All @@ -249,7 +248,7 @@ public DebugImageInfo(DebugImage image)
}
result.Insert(i, info);
Logger?.Log(SentryLevel.Debug,
Options.DiagnosticLogger?.Log(SentryLevel.Debug,
"Found debug image '{0}' (CodeId {1} | DebugId: {2}) with addresses between {3:X8} and {4:X8}",
null, image.CodeFile, image.CodeId, image.DebugId, info.StartAddress, info.EndAddress);
}
Expand Down
Loading