feat: iOS Native AOT support

Author: vaind

src/Sentry/Internal/DebugStackTrace.cs

@@ -1,6 +1,5 @@
 using Sentry.Internal.Extensions;
 using Sentry.Extensibility;
-using Sentry.Native;
 using Sentry.Internal.ILSpy;
 using Sentry.Protocol;
 
@@ -17,8 +16,11 @@ internal class DebugStackTrace : SentryStackTrace
     private readonly Dictionary<Guid, int> _debugImageIndexByModule = new();
     private const int DebugImageMissing = -1;
     private bool _debugImagesMerged;
+
+#if NET6_0_OR_GREATER
     private Dictionary<long, DebugImage>? _nativeDebugImages;
     private HashSet<long> _usedNativeDebugImages = new();
+#endif
 
     /*
      *  NOTE: While we could improve these regexes, doing so might break exception grouping on the backend.
@@ -220,6 +222,7 @@ private IEnumerable<SentryStackFrame> CreateFrames(StackTrace stackTrace, bool i
         }
     }
 
+#if NET6_0_OR_GREATER
     /// <summary>
     /// Native AOT implementation of CreateFrame.
     /// Native frames have only limited method information at runtime (and even that can be disabled).
@@ -237,7 +240,15 @@ private IEnumerable<SentryStackFrame> CreateFrames(StackTrace stackTrace, bool i
         frame.ImageAddress = imageAddress;
         frame.InstructionAddress = stackFrame.GetNativeIP();
 
-        _nativeDebugImages ??= C.LoadDebugImages(_options.DiagnosticLogger);
+#if __ANDROID__
+        // TODO there will be support for NativeAOT in the future.
+        _nativeDebugImages ??= new();
+#elif __IOS__ || MACCATALYST
+        _nativeDebugImages ??= Sentry.iOS.C.LoadDebugImages(_options.DiagnosticLogger);
+#else
+        _nativeDebugImages ??= Sentry.Native.C.LoadDebugImages(_options.DiagnosticLogger);
+#endif
+
         if (!_usedNativeDebugImages.Contains(imageAddress) && _nativeDebugImages.TryGetValue(imageAddress, out var debugImage))
         {
             _usedNativeDebugImages.Add(imageAddress);
@@ -261,6 +272,7 @@ internal static SentryStackFrame ParseNativeAOTToString(string info)
         }
         return frame;
     }
+#endif
 
     /// <summary>
     /// Default the implementation of CreateFrame.
@@ -352,7 +364,9 @@ internal static SentryStackFrame ParseNativeAOTToString(string info)
     internal SentryStackFrame? CreateFrame(IStackFrame stackFrame)
     {
         var frame = TryCreateManagedFrame(stackFrame);
+#if NET6_0_OR_GREATER
         frame ??= TryCreateNativeAOTFrame(stackFrame);
+#endif
         if (frame is null)
         {
             return null;

src/Sentry/Platforms/iOS/CFunctions.cs

@@ -0,0 +1,37 @@
+using Sentry.Extensibility;
+using Sentry.Internal.Extensions;
+
+namespace Sentry.iOS;
+
+internal static class C
+{
+    internal static Dictionary<long, DebugImage> LoadDebugImages(IDiagnosticLogger? logger)
+    {
+        logger?.LogDebug("Collecting a list of native debug images.");
+        var result = new Dictionary<long, DebugImage>();
+        try
+        {
+            var cList = SentryCocoaHybridSdk.DebugImages;
+            logger?.LogDebug("There are {0} native debug images, parsing the information.", cList.Length);
+            foreach (var cItem in cList)
+            {
+                if (cItem.ImageAddress?.ParseHexAsLong() is { } imageAddress)
+                {
+                    result.Add(imageAddress, new DebugImage()
+                    {
+                        CodeFile = cItem.CodeFile,
+                        ImageAddress = imageAddress,
+                        ImageSize = cItem.ImageSize?.LongValue,
+                        DebugId = cItem.DebugID,
+                        Type = cItem.Type,
+                    });
+                }
+            }
+        }
+        catch (Exception e)
+        {
+            logger?.LogWarning("Error loading the list of debug images", e);
+        }
+        return result;
+    }
+}

src/Sentry/Sentry.csproj

@@ -21,7 +21,8 @@
   <!-- Platform-specific props included here -->
   <Import Project="Platforms\Android\Sentry.Android.props" Condition="'$(TargetPlatformIdentifier)' == 'android'" />
   <Import Project="Platforms\iOS\Sentry.iOS.props" Condition="'$(TargetPlatformIdentifier)' == 'ios' Or '$(TargetPlatformIdentifier)' == 'maccatalyst'" />
-  <Import Project="Platforms\Native\Sentry.Native.targets"/>
+  <Import Project="Platforms\Native\Sentry.Native.targets"
+        Condition="'$(TargetPlatformIdentifier)' != 'android' and '$(TargetPlatformIdentifier)' != 'ios' and '$(TargetPlatformIdentifier)' != 'maccatalyst'"/>
 
   <PropertyGroup Condition="'$(FrameworkSupportsAot)' == 'true'">
     <IsAotCompatible>true</IsAotCompatible>

src/Sentry/buildTransitive/Sentry.targets

@@ -128,7 +128,12 @@
   <!-- Native AOT publishing
        While '_IsPublishing' looks a bit "private", it's also OK if it suddenly stops working and this step runs anyway.
        See https://github.com/dotnet/sdk/issues/26324#issuecomment-1169236993 -->
-  <PropertyGroup Condition="'$(PublishDir)' != '' and '$(PublishAot)' == 'true' and '$(_IsPublishing)' == 'true'">
+  <PropertyGroup Condition="
+      '$(PublishDir)' != ''
+      and '$(PublishAot)' == 'true'
+      and '$(_IsPublishing)' == 'true'
+      and $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) != 'ios'
+      and $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) != 'maccatalyst'">
     <SentryCLIUploadNativeAOT>true</SentryCLIUploadNativeAOT>
     <SentryCLIUploadDirectory>$(PublishDir)</SentryCLIUploadDirectory>
     <!-- We must run after "_CopyAotSymbols" (not "Publish"), because that is the one that actually copies debug symbols to the publish directory. -->