feat: Support reading .NET 11 Android assembly stores

src/Sentry.Android.AssemblyReader/ArchiveUtils.cs

@@ -42,6 +42,12 @@ internal static MemoryStream Extract(this ZipArchiveEntry zipEntry)
             inputStream.Position = 0;
             return null;
         }
+#if !NET11_0_OR_GREATER
+        if (magic == ZstandardMagic)
+        {
+            throw new NotSupportedException($"Assembly {assemblyName} is Zstandard compressed, which requires .NET 11 or later");
+        }
+#endif
         reader.ReadUInt32(); // ignore descriptor index, we don't need it
         var decompressedLength = reader.ReadInt32();
         Debug.Assert(inputStream.Position == payloadOffset);
@@ -58,20 +64,14 @@ internal static MemoryStream Extract(this ZipArchiveEntry zipEntry)
 
         var inputBuffer = inputStream is MemorySlice slice ? slice.FullBuffer : inputStream.GetBuffer();
         var offset = inputStream is MemorySlice memorySlice ? memorySlice.Offset + payloadOffset : payloadOffset;
-        int decoded;
-        if (magic == Lz4Magic)
-        {
-            decoded = LZ4Codec.Decode(inputBuffer, offset, inputLength, outputBuffer, 0, decompressedLength);
-        }
-        else
-        {
 #if NET11_0_OR_GREATER
-            decoded = ZstandardDecoder.TryDecompress(inputBuffer.AsSpan(offset, inputLength),
+        var decoded = magic == Lz4Magic
+            ? LZ4Codec.Decode(inputBuffer, offset, inputLength, outputBuffer, 0, decompressedLength)
+            : ZstandardDecoder.TryDecompress(inputBuffer.AsSpan(offset, inputLength),
                 outputBuffer.AsSpan(0, decompressedLength), out var bytesWritten) ? bytesWritten : -1;
 #else
-            throw new NotSupportedException($"Assembly {assemblyName} is Zstandard compressed, which requires .NET 11 or later");
+        var decoded = LZ4Codec.Decode(inputBuffer, offset, inputLength, outputBuffer, 0, decompressedLength);
 #endif
-        }
         if (decoded != decompressedLength)
         {
             throw new Exception($"Failed to decompress {format} data of assembly {assemblyName} - decoded {decoded} instead of expected {decompressedLength} bytes");

src/Sentry.Android.AssemblyReader/V2/ATTRIBUTION.txt

@@ -1,6 +1,16 @@
 Parts of the code in this subdirectory have been adapted from
 https://github.com/dotnet/android/blob/5ebcb1dd1503648391e3c0548200495f634d90c6/tools/assembly-store-reader-mk2/assembly-store-reader.csproj
 
+and subsequently updated from:
+- https://github.com/dotnet/android/tree/64018e13e53cec7246e54866b520d3284de344e0/tools/assembly-store-reader-mk2
+  (assembly store v3, .NET 10)
+- https://github.com/dotnet/android/tree/f1aecf9e6ae80fe3f3992ec1f52ef953dac7c06b/.github/skills/read-assembly-store
+  (assembly store v4 and index entry sizing, .NET 11 previews)
+- https://github.com/dotnet/android/commit/8f7c4d4fa53c6682f2c4f2d2caf08e9fb4d8cd60
+  (v4 reverted to v3 before .NET 11 GA)
+
+Individual files note which of these they were updated from.
+
 The original license is as follows:
 
 The MIT License (MIT)

src/Sentry.Android.AssemblyReader/V2/StoreReader.Classes.cs

@@ -3,7 +3,9 @@
  * Updated from https://github.com/dotnet/android/blob/64018e13e53cec7246e54866b520d3284de344e0/tools/assembly-store-reader-mk2/AssemblyStore/StoreReader_V2.Classes.cs
  *     - Adding support for AssemblyStore v3 format that shipped in .NET 10 (https://github.com/dotnet/android/pull/10249)
  * Updated from https://github.com/dotnet/android/blob/f1aecf9e6ae80fe3f3992ec1f52ef953dac7c06b/.github/skills/read-assembly-store/src/AssemblyStore/StoreReader_V2.Classes.cs
- *     - Adding support for AssemblyStore v4 format (CoreCLR) that ships in .NET 11
+ *     - Adding support for AssemblyStore v4 format (CoreCLR), which only ever shipped in .NET 11 previews
+ * Reviewed against https://github.com/dotnet/android/commit/8f7c4d4fa53c6682f2c4f2d2caf08e9fb4d8cd60
+ *     - v4 was reverted before .NET 11 GA (dotnet/android#12780); CoreCLR emits v3 again
  * Original code licensed under the MIT License (https://github.com/dotnet/android/blob/5ebcb1dd1503648391e3c0548200495f634d90c6/LICENSE.TXT)
  */
 
@@ -38,6 +40,9 @@ public Header(uint magic, uint version, uint entry_count, uint index_entry_count
 
     internal sealed class IndexEntry
     {
+        public const uint NativeSize32 = 2 * sizeof(uint) + sizeof(byte);
+        public const uint NativeSize64 = sizeof(ulong) + sizeof(uint) + sizeof(byte);
+
         public readonly ulong name_hash;
         public readonly uint descriptor_index;
         public readonly bool ignore;

src/Sentry.Android.AssemblyReader/V2/StoreReader.cs

@@ -3,7 +3,10 @@
  * Updated from https://github.com/dotnet/android/blob/64018e13e53cec7246e54866b520d3284de344e0/tools/assembly-store-reader-mk2/AssemblyStore/StoreReader_V2.cs
  *     - Adding support for AssemblyStore v3 format that shipped in .NET 10 (https://github.com/dotnet/android/pull/10249)
  * Updated from https://github.com/dotnet/android/blob/f1aecf9e6ae80fe3f3992ec1f52ef953dac7c06b/.github/skills/read-assembly-store/src/AssemblyStore/StoreReader_V2.cs
- *     - Adding support for AssemblyStore v4 format (CoreCLR) that ships in .NET 11
+ *     - Adding support for AssemblyStore v4 format (CoreCLR), which only ever shipped in .NET 11 previews
+ *     - Deriving the index entry size from the header rather than the ABI
+ * Reviewed against https://github.com/dotnet/android/commit/8f7c4d4fa53c6682f2c4f2d2caf08e9fb4d8cd60
+ *     - v4 was reverted before .NET 11 GA (dotnet/android#12780); CoreCLR emits v3 again
  * Original code licensed under the MIT License (https://github.com/dotnet/android/blob/5ebcb1dd1503648391e3c0548200495f634d90c6/LICENSE.TXT)
  */
 
@@ -14,10 +17,11 @@ internal partial class StoreReader : AssemblyStoreReader
     // Bit 31 is set for 64-bit platforms, cleared for the 32-bit ones
     private const uint ASSEMBLY_STORE_FORMAT_VERSION_64BIT_V3 = 0x80000003;
     private const uint ASSEMBLY_STORE_FORMAT_VERSION_32BIT_V3 = 0x00000003;
-    private const uint ASSEMBLY_STORE_FORMAT_VERSION_CORECLR_64BIT_V4 = 0x80000004; // Must match the ASSEMBLY_STORE_FORMAT_VERSION native constant
+    // v4 was only emitted by .NET 11 previews; it was reverted to v3 before GA by dotnet/android#12780
+    private const uint ASSEMBLY_STORE_FORMAT_VERSION_CORECLR_64BIT_V4 = 0x80000004;
     private const uint ASSEMBLY_STORE_FORMAT_VERSION_CORECLR_32BIT_V4 = 0x00000004;
     private const uint ASSEMBLY_STORE_FORMAT_VERSION_MASK = 0xF0000000;
-    private const uint ASSEMBLY_STORE_FORMAT_NUMBER_MASK = 0x0000FFFF;
+    internal const uint ASSEMBLY_STORE_FORMAT_NUMBER_MASK = 0x0000FFFF;
     private const uint ASSEMBLY_STORE_ABI_AARCH64 = 0x00010000;
     private const uint ASSEMBLY_STORE_ABI_ARM = 0x00020000;
     private const uint ASSEMBLY_STORE_ABI_X64 = 0x00030000;
@@ -192,25 +196,18 @@ protected override void Prepare()
             StoreStream.Seek((long)elfOffset + header.NativeSize, SeekOrigin.Begin);
             using var reader = CreateReader();
 
+            var indexEntrySize = GetIndexEntrySize(header);
             var index = new List<IndexEntry>();
             for (uint i = 0; i < header.index_entry_count; i++)
             {
-                ulong name_hash;
-                if (Is64Bit)
+                var name_hash = indexEntrySize switch
                 {
-                    name_hash = reader.ReadUInt64();
-                }
-                else
-                {
-                    name_hash = (ulong)reader.ReadUInt32();
-                }
-
+                    IndexEntry.NativeSize64 => reader.ReadUInt64(),
+                    IndexEntry.NativeSize32 => reader.ReadUInt32(),
+                    _ => throw new InvalidOperationException($"Assembly store '{StorePath}' index entry size {indexEntrySize} is not supported.")
+                };
                 uint descriptor_index = reader.ReadUInt32();
-#if NET10_0_OR_GREATER
                 bool ignore = reader.ReadByte() != 0;
-#else
-                bool ignore = false;
-#endif
                 index.Add(new IndexEntry(name_hash, descriptor_index, ignore));
             }
 
@@ -272,4 +269,20 @@ protected override void Prepare()
             Assemblies = storeItems.AsReadOnly();
         }
     }
+
+    // Name hash width depends on the runtime, not the ABI: CoreCLR stores use 32-bit CRC32 hashes on every ABI
+    private uint GetIndexEntrySize(Header header)
+    {
+        if (header.index_entry_count == 0)
+        {
+            return 0;
+        }
+
+        if (header.index_size % header.index_entry_count != 0)
+        {
+            throw new InvalidOperationException($"Assembly store '{StorePath}' index is corrupted: index size {header.index_size} is not evenly divisible by entry count {header.index_entry_count}.");
+        }
+
+        return header.index_size / header.index_entry_count;
+    }
 }

src/Sentry/Internal/DebugStackTrace.cs

@@ -518,29 +518,31 @@ private static void DemangleLambdaReturnType(SentryStackFrame frame)
     {
         try
         {
-            assemblyName = module.FullyQualifiedName;
-            // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract
-            if (assemblyName is null or ModuleExtensions.UnknownLocation)
+            var location = module.FullyQualifiedName is { } name and not ModuleExtensions.UnknownLocation ? name : null;
+            if (options.AssemblyReader is { } reader)
+            {
+                // CoreCLR on Android loads assemblies from the APK, so they have no location
+                assemblyName = location ?? module.ScopeName;
+                return reader.Invoke(assemblyName);
+            }
+            if (location is null)
             {
                 // When publishing as a single file or compiling AOT FullyQualifiedName will be null. This logic
                 // compensates for the UnconditionalSuppressMessage attribute applied to this method.
                 assemblyName = null;
                 return null;
             }
-            if (options.AssemblyReader is { } reader)
-            {
-                return reader.Invoke(assemblyName);
-            }
+            assemblyName = location;
 
             if (options.FileSystem.FileExists(assemblyName))
             {
                 var assembly = options.FileSystem.OpenFileForReading(assemblyName);
                 return new PEReader(assembly);
             }
         }
-        catch
+        catch (Exception e)
         {
-            // Swallow and return null below
+            options.LogDebug("Failed to read assembly for module '{0}': {1}", module.GetNameOrScopeName(), e.Message);
         }
         assemblyName = null;
         return null;

test/Sentry.Android.AssemblyReader.Tests/AndroidAssemblyReaderTests.cs

@@ -15,18 +15,6 @@ public class AndroidAssemblyReaderTests
 #error "Target Framework not yet supported for AndroidAssemblyReader"
 #endif
 
-    // .NET 11 Android moved to CoreCLR and emits v4 assembly stores, which our vendored
-    // reader does not understand yet - it also changes ELF payload discovery, so even the
-    // non-store APKs fail. Tracked by https://github.com/getsentry/sentry-dotnet/issues/5454;
-    // re-enable these once that port lands.
-    private const string StoreV4SkipReason =
-        "Android assembly store v4 (.NET 11) is not supported yet - see getsentry/sentry-dotnet#5454";
-#if NET11_0_OR_GREATER
-    private const bool StoreV4Unsupported = true;
-#else
-    private const bool StoreV4Unsupported = false;
-#endif
-
     public AndroidAssemblyReaderTests(ITestOutputHelper output)
     {
         _output = output;
@@ -57,7 +45,6 @@ private IAndroidAssemblyReader GetSut(bool isAot, bool isAssemblyStore, bool isC
     [SkippableFact]
     public void CreatesCorrectStoreReader()
     {
-        Skip.If(StoreV4Unsupported, StoreV4SkipReason);
 #if ANDROID
         Skip.If(true, "It's unknown whether the current Android app APK is an assembly store or not.");
 #endif
@@ -78,15 +65,15 @@ public void CreatesCorrectStoreReader()
     [SkippableFact]
     public void CreatesCorrectArchiveReader()
     {
-        Skip.If(StoreV4Unsupported, StoreV4SkipReason);
 #if ANDROID
         Skip.If(true, "It's unknown whether the current Android app APK is an assembly store or not.");
 #endif
         using var sut = GetSut(isAot: false, isAssemblyStore: false, isCompressed: true);
         switch (TargetFramework)
         {
             case "net11.0":
-                Assert.IsType<AndroidAssemblyDirectoryReader>(sut);
+                // CoreCLR ignores AndroidUseAssemblyStore=false: https://github.com/dotnet/android/pull/12033
+                Assert.IsType<AndroidAssemblyStoreReader>(sut);
                 break;
             case "net10.0":
                 Assert.IsType<AndroidAssemblyDirectoryReader>(sut);
@@ -101,7 +88,6 @@ public void CreatesCorrectArchiveReader()
     [InlineData(true)]
     public void ReturnsNullIfAssemblyDoesntExist(bool isAssemblyStore)
     {
-        Skip.If(StoreV4Unsupported, StoreV4SkipReason);
         using var sut = GetSut(isAot: false, isAssemblyStore, isCompressed: true);
         Assert.Null(sut.TryReadAssembly("NonExistent.dll"));
     }
@@ -117,7 +103,6 @@ public void ReturnsNullIfAssemblyDoesntExist(bool isAssemblyStore)
     [MemberData(nameof(ReadsAssemblyPermutations))]
     public void ReadsAssembly(bool isAot, bool isAssemblyStore, bool isCompressed, string assemblyName)
     {
-        Skip.If(StoreV4Unsupported, StoreV4SkipReason);
 #if ANDROID
         // No need to run all combinations - we only test the current APK which is likely JIT compressed assembly store.
         Skip.If(isAot);

test/Sentry.Android.AssemblyReader.Tests/ArchiveUtilsTests.cs

@@ -82,8 +82,9 @@ private static MemoryStream WithHeader(uint magic, ReadOnlySpan<byte> payload)
         var stream = new MemoryStream();
         using (var writer = new BinaryWriter(stream, Encoding.UTF8, leaveOpen: true))
         {
+            const uint descriptorIndex = 0;
             writer.Write(magic);
-            writer.Write(0u); // descriptor index
+            writer.Write(descriptorIndex);
             writer.Write(Assembly.Length);
             writer.Write(payload);
         }

test/Sentry.Android.AssemblyReader.Tests/Sentry.Android.AssemblyReader.Tests.csproj

@@ -43,8 +43,7 @@
       <_TestAPK Include="3" Properties="_Aot=False;_Store=True;_Compressed=False" />
       <_TestAPK Include="4" Properties="_Aot=False;_Store=True;_Compressed=True" />
       <!-- Mono AOT variants are net10-only: CoreCLR is the only supported runtime for MAUI mobile
-           apps from .NET 11 on. Every reader test also skips on assembly store v4 there (#5454),
-           so there would be nothing to read even if an AOT APK could be produced. -->
+           apps from .NET 11 on. -->
       <_TestAPK Include="5" Properties="_Aot=True;_Store=False;_Compressed=False" Condition="'$(TargetFramework)' == 'net10.0-android'" />
       <_TestAPK Include="6" Properties="_Aot=True;_Store=False;_Compressed=True" Condition="'$(TargetFramework)' == 'net10.0-android'" />
       <_TestAPK Include="7" Properties="_Aot=True;_Store=True;_Compressed=False" Condition="'$(TargetFramework)' == 'net10.0-android'" />