Add addr_mode attributes to ANR stack frames

The instruction addresses of native stack frames in thread dumps are
relative to the image file from which the code is loaded, and there
are no absolute mapping addresses of images available. So explicitly
inform the Sentry server about the correct images by using a relative
"addr_mode" attribute.

Also add the attribute to the SentryStackFrame class since it was not
yet supported by it. The field documentation is converted from
event.schema.json in the sentry server repo.

Author: Lauri Alanko

sentry-android-core/src/main/java/io/sentry/android/core/internal/threaddump/ThreadDumpParser.java

@@ -261,6 +261,8 @@ private SentryStackTrace parseStacktrace(
             debugImage.setCodeId(buildId);
             debugImages.put(debugId, debugImage);
           }
+          // The addresses in the thread dump are relative to the image
+          frame.setAddrMode("rel:" + debugId);
         }
 
         frames.add(frame);

sentry-android-core/src/test/java/io/sentry/android/core/AnrV2IntegrationTest.kt

@@ -305,14 +305,15 @@ class AnrV2IntegrationTest {
                 )
                 assertEquals("__start_thread", firstFrame.function)
                 assertEquals(64, firstFrame.lineno)
-		assertEquals("0x00000000000530b8", firstFrame.instructionAddr)
-		assertEquals("native", firstFrame.platform)
-
-		val image = it.debugMeta?.images?.find {
-		    it.debugId == "741f3301-bbb0-b92c-58bd-c15282b8ec7b"
-		}
-		assertNotNull(image)
-		assertEquals("/apex/com.android.runtime/lib64/bionic/libc.so", image.codeFile)
+                assertEquals("0x00000000000530b8", firstFrame.instructionAddr)
+                assertEquals("native", firstFrame.platform)
+                assertEquals("rel:741f3301-bbb0-b92c-58bd-c15282b8ec7b", firstFrame.addrMode)
+
+                val image = it.debugMeta?.images?.find {
+                    it.debugId == "741f3301-bbb0-b92c-58bd-c15282b8ec7b"
+                }
+                assertNotNull(image)
+                assertEquals("/apex/com.android.runtime/lib64/bionic/libc.so", image.codeFile)
             },
             argThat<Hint> {
                 val hint = HintUtils.getSentrySdkHint(this)

sentry-android-core/src/test/java/io/sentry/android/core/internal/threaddump/ThreadDumpParserTest.kt

@@ -116,43 +116,47 @@ class ThreadDumpParserTest {
         assertEquals("syscall", lastFrame.function)
         assertEquals(28, lastFrame.lineno)
         assertNull(lastFrame.isInApp)
-	assertEquals("0x000000000004c35c", lastFrame.instructionAddr)
-	assertEquals("native", lastFrame.platform)
-
-	val nosymFrame = frames.get(21)
-	assertEquals("/apex/com.android.art/javalib/core-oj.jar", nosymFrame.`package`)
-	assertNull(nosymFrame.function)
-	assertNull(nosymFrame.lineno)
-	assertEquals("0x00000000000ec474", nosymFrame.instructionAddr)
-
-	val spaceFrame = frames.get(14)
-	assertEquals(
-	    "[anon:dalvik-classes16.dex extracted in memory from /data/app/~~izn1xSZpFlzfVmWi_I0xlQ=="
-	    + "/io.sentry.samples.android-tQSGMNiGA-qdjZm6lPOcNw==/base.apk!classes16.dex]",
-	    spaceFrame.`package`)
-	assertNull(spaceFrame.function)
-	assertNull(spaceFrame.lineno)
-	assertEquals("0x00000000000306f0", spaceFrame.instructionAddr)
-
-	val offsetFrame = frames.get(145)
-	assertEquals("/system/framework/framework.jar (offset 0x12c2000)", offsetFrame.`package`)
-	assertNull(offsetFrame.function)
-	assertNull(offsetFrame.lineno)
-	assertEquals("0x00000000002c8e18", offsetFrame.instructionAddr)
-	assertNull(offsetFrame.addrMode)
-
-	val deletedFrame = frames.get(117)
-	assertEquals("/memfd:jit-cache (deleted) (offset 0x2000000)", deletedFrame.`package`)
-	assertEquals("kotlinx.coroutines.DispatchedTask.run", deletedFrame.function)
-	assertEquals(1816, deletedFrame.lineno)
-	assertEquals("0x00000000020b89d8", deletedFrame.instructionAddr)
-
-	val debugImages = parser.debugImages
-	val image = debugImages["499d48ba-c085-17cf-3209-da67405662f9"]
-	assertNotNull(image)
-	assertEquals("499d48ba-c085-17cf-3209-da67405662f9", image.debugId)
-	assertEquals("/apex/com.android.runtime/lib64/bionic/libc.so", image.codeFile)
-	assertEquals("ba489d4985c0cf173209da67405662f9", image.codeId)
+        assertEquals("0x000000000004c35c", lastFrame.instructionAddr)
+        assertEquals("rel:499d48ba-c085-17cf-3209-da67405662f9", lastFrame.addrMode)
+        assertEquals("native", lastFrame.platform)
+
+        val nosymFrame = frames.get(21)
+        assertEquals("/apex/com.android.art/javalib/core-oj.jar", nosymFrame.`package`)
+        assertNull(nosymFrame.function)
+        assertNull(nosymFrame.lineno)
+        assertEquals("0x00000000000ec474", nosymFrame.instructionAddr)
+        assertNull(nosymFrame.addrMode)
+
+        val spaceFrame = frames.get(14)
+        assertEquals(
+            "[anon:dalvik-classes16.dex extracted in memory from /data/app/~~izn1xSZpFlzfVmWi_I0xlQ=="
+            + "/io.sentry.samples.android-tQSGMNiGA-qdjZm6lPOcNw==/base.apk!classes16.dex]",
+            spaceFrame.`package`)
+        assertNull(spaceFrame.function)
+        assertNull(spaceFrame.lineno)
+        assertEquals("0x00000000000306f0", spaceFrame.instructionAddr)
+        assertNull(spaceFrame.addrMode)
+
+        val offsetFrame = frames.get(145)
+        assertEquals("/system/framework/framework.jar (offset 0x12c2000)", offsetFrame.`package`)
+        assertNull(offsetFrame.function)
+        assertNull(offsetFrame.lineno)
+        assertEquals("0x00000000002c8e18", offsetFrame.instructionAddr)
+        assertNull(offsetFrame.addrMode)
+
+        val deletedFrame = frames.get(117)
+        assertEquals("/memfd:jit-cache (deleted) (offset 0x2000000)", deletedFrame.`package`)
+        assertEquals("kotlinx.coroutines.DispatchedTask.run", deletedFrame.function)
+        assertEquals(1816, deletedFrame.lineno)
+        assertEquals("0x00000000020b89d8", deletedFrame.instructionAddr)
+        assertNull(deletedFrame.addrMode)
+
+        val debugImages = parser.debugImages
+        val image = debugImages["499d48ba-c085-17cf-3209-da67405662f9"]
+        assertNotNull(image)
+        assertEquals("499d48ba-c085-17cf-3209-da67405662f9", image.debugId)
+        assertEquals("/apex/com.android.runtime/lib64/bionic/libc.so", image.codeFile)
+        assertEquals("ba489d4985c0cf173209da67405662f9", image.codeId)
     }
 
     @Test

sentry/src/main/java/io/sentry/protocol/SentryStackFrame.java

@@ -93,6 +93,20 @@ public final class SentryStackFrame implements JsonUnknown, JsonSerializable {
    * take place.
    */
   private @Nullable String instructionAddr;
+  /**
+   * Defines the addressing mode for addresses.
+   *
+   * <p>This can be:
+   *
+   * <ul>
+   *   <li><code>"abs"</code> (the default): <code>instruction_addr</code> is absolute.
+   *   <li><code>"rel:$idx"</code>: <code>instruction_addr</code> is relative to the
+   *       <code>debug_meta.image</code> identified by its index in the list.
+   *   <li><code>"rel:$uuid"</code>: <code>instruction_addr</code> is relative to the
+   *       <code>debug_meta.image</code> identified by its <code>debug_id</code>.
+   * </ul>
+   */
+  private @Nullable String addrMode;
 
   /**
    * Potentially mangled name of the symbol as it appears in an executable.
@@ -263,6 +277,14 @@ public void setInstructionAddr(final @Nullable String instructionAddr) {
     this.instructionAddr = instructionAddr;
   }
 
+  public @Nullable String getAddrMode() {
+    return addrMode;
+  }
+
+  public void setAddrMode(final @Nullable String addrMode) {
+      this.addrMode = addrMode;
+  }
+
   public @Nullable Boolean isNative() {
     return _native;
   }
@@ -325,6 +347,7 @@ public static final class JsonKeys {
     public static final String IMAGE_ADDR = "image_addr";
     public static final String SYMBOL_ADDR = "symbol_addr";
     public static final String INSTRUCTION_ADDR = "instruction_addr";
+    public static final String ADDR_MODE = "addr_mode";
     public static final String RAW_FUNCTION = "raw_function";
     public static final String SYMBOL = "symbol";
     public static final String LOCK = "lock";
@@ -376,6 +399,9 @@ public void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger
     if (instructionAddr != null) {
       writer.name(JsonKeys.INSTRUCTION_ADDR).value(instructionAddr);
     }
+    if (addrMode != null) {
+      writer.name(JsonKeys.ADDR_MODE).value(addrMode);
+    }
     if (rawFunction != null) {
       writer.name(JsonKeys.RAW_FUNCTION).value(rawFunction);
     }
@@ -447,6 +473,9 @@ public static final class Deserializer implements JsonDeserializer<SentryStackFr
           case JsonKeys.INSTRUCTION_ADDR:
             sentryStackFrame.instructionAddr = reader.nextStringOrNull();
             break;
+          case JsonKeys.ADDR_MODE:
+            sentryStackFrame.addrMode = reader.nextStringOrNull();
+            break;
           case JsonKeys.RAW_FUNCTION:
             sentryStackFrame.rawFunction = reader.nextStringOrNull();
             break;

sentry/src/test/java/io/sentry/protocol/SentryStackFrameSerializationTest.kt

@@ -32,6 +32,7 @@ class SentryStackFrameSerializationTest {
             imageAddr = "27ec1be5-e8a1-485c-b020-f4d9f80a6624"
             symbolAddr = "180e12cd-1fa8-405d-8dd8-e87b33fa2eb0"
             instructionAddr = "19864a78-2466-461f-9f0b-93a5c9ae7622"
+            addrMode = "49d415f3-1be5-422c-b877-b82b4e4c2990"
             rawFunction = "f33035a4-0cf0-453d-b6f4-d7c27e9af924"
             symbol = "d9807ffe-d517-11ed-afa1-0242ac120002"
             lock = SentryLockReason().apply {

sentry/src/test/resources/json/sentry_stack_frame.json

@@ -13,6 +13,7 @@
     "image_addr": "27ec1be5-e8a1-485c-b020-f4d9f80a6624",
     "symbol_addr": "180e12cd-1fa8-405d-8dd8-e87b33fa2eb0",
     "instruction_addr": "19864a78-2466-461f-9f0b-93a5c9ae7622",
+    "addr_mode": "49d415f3-1be5-422c-b877-b82b4e4c2990",
     "raw_function": "f33035a4-0cf0-453d-b6f4-d7c27e9af924",
     "symbol": "d9807ffe-d517-11ed-afa1-0242ac120002",
     "lock": {