[android] run a subset of lldb tests on arm64 (#157)

## Purpose
Enable a small subset of lldb tests to run on Android `arm64-v8a`
emulator for better test coverage.
Resolves #161

## Overview
* Rework the test matrix in the `test-android` job to include a single
`arm64-v8a` instance that runs tests from a subset of lldb test
directories (android, api, linux, and sanity).
* Add `emulator-build` field to test matrix so that the `arm64-v8a`
variant can select version 35.1.21.0 (build_id 12325540), which supports
arm images. Leave this field unspecified in the `x86_64` jobs because
they don't need it.
* Add `emulator-options` field to test matrix inputs and specify `-qemu
-machine virt -cpu max` options. Leave this field unspecified in the
`x86_64` jobs because they don't need it.
* Rename `api-level` matrix field to `android-api-level` for clarity.
* Pass `-gpu swiftshader_indirect` argument to all emulator instances
(arm and x86). This shouldn't really matter since we're running headless
tests anyway.
* Split the `processor` matrix field and into two fields: `arch` and
`llvm-arch`. For `x86_64`, these fields are set to the same value. For
`arm64-v8a`, the `llvm-arch` field is set to `aarch64` which is the
value expected by the lldb test suite.
* Add an upstream test exclusion list for the test cases that fail
running lldb-server on arm64 Android.
* Add a ds2 test exclusion list for the test cases that fail running ds2
on arm64 Android (that don't fail with lldb-server).

## Background
By using a slightly outdated version of the Android emulator (see
https://issuetracker.google.com/u/1/issues/373790939) and passing some
extra flags to qemu (-machine virt, -cpu max), it is possible to run an
Android arm64-v8a guest on an x86_64 host on an GitHub runner.

Because a qemu arm guest running on an x86_64 host uses software
emulation instead of virtualization, we'll limit the number of tests
that run to keep the job run time down.

Passing the `-machine virt` argument to qemu selects the generic virtual
hardware platform described
[here](https://www.qemu.org/docs/master/system/arm/virt.html).

Passing the `-cpu max` argument to qemu selects the best emulated cpu
option available.

## Validation
Verified the job runs and passes on this PR. Job run time is ~5 min,
which is briefer than the longest x86_64 test job which takes ~8 min.

Author: andrurogerz

.github/workflows/build.yml

@@ -408,12 +408,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # We don't currently have a good way to run arm64 Android emulator on
-        # the available GitHub test runners.
         include:
           - test-category: misc
-            processor: x86_64
-            api-level: 28
+            arch: x86_64
+            llvm-arch: x86_64
+            android-api-level: 28
             test-subdirs: >-
               SourceCache/llvm/lldb/test/API/android
               SourceCache/llvm/lldb/test/API/api
@@ -424,24 +423,45 @@ jobs:
               SourceCache/llvm/lldb/test/API/types
 
           - test-category: commands
-            processor: x86_64
-            api-level: 28
+            arch: x86_64
+            llvm-arch: x86_64
+            android-api-level: 28
             test-subdirs: >-
               SourceCache/llvm/lldb/test/API/commands
 
           - test-category: Python API
-            processor: x86_64
-            api-level: 28
+            arch: x86_64
+            llvm-arch: x86_64
+            android-api-level: 28
             test-subdirs: >-
               SourceCache/llvm/lldb/test/API/python_api
 
           - test-category: functionalities
-            processor: x86_64
-            api-level: 28
+            arch: x86_64
+            llvm-arch: x86_64
+            android-api-level: 28
             test-subdirs: >-
               SourceCache/llvm/lldb/test/API/functionalities
 
-    name: Android ${{ matrix.processor }} test ${{ matrix.test-category}}
+          # Run a small sub-set of tests on arm64. The emulator is very slow
+          # so it is not practical to run more tests until we can run on an
+          # arm64 runner with virtualization.
+          - test-category: sanity
+            arch: arm64-v8a
+            llvm-arch: aarch64
+            # Android emulator supports ARM on x86 only on API < 28
+            android-api-level: 27
+            # This is the most recent build of the emulator that supports
+            # booting arm64 images.
+            emulator-build: 12234392
+            emulator-options: -qemu -machine virt -cpu max
+            test-subdirs: >-
+              SourceCache/llvm/lldb/test/API/android
+              SourceCache/llvm/lldb/test/API/api
+              SourceCache/llvm/lldb/test/API/linux
+              SourceCache/llvm/lldb/test/API/sanity
+
+    name: Test Android ${{ matrix.arch}} ${{ matrix.test-category }}
 
     steps:
       - uses: actions/download-artifact@v4
@@ -454,7 +474,7 @@ jobs:
 
       - uses: actions/download-artifact@v4
         with:
-          name: android-${{ matrix.processor }}-ds2
+          name: android-${{ matrix.arch }}-ds2
           path: ${{ github.workspace }}/BinaryCache
       - name: untar ds2 artifacts
         run: |
@@ -479,7 +499,7 @@ jobs:
         id: avd-cache
         with:
           path: ~/.android/**
-          key: avd-${{ runner.os }}-${{ matrix.processor }}-${{ matrix.api-level }}
+          key: avd-${{ runner.os }}-${{ matrix.arch }}-${{ matrix.android-api-level }}
 
       - name: Enable KVM
         run: |
@@ -491,26 +511,28 @@ jobs:
         if: steps.avd-cache.outputs.cache-hit != 'true'
         uses: reactivecircus/android-emulator-runner@v2
         with:
-          api-level: ${{ matrix.api-level }}
-          arch: ${{ matrix.processor }}
+          emulator-build: ${{ matrix.emulator-build }}
+          api-level: ${{ matrix.android-api-level }}
+          arch: ${{ matrix.arch }}
           force-avd-creation: false
-          emulator-options: -no-window -noaudio -no-boot-anim -camera-back none
+          emulator-options: -no-window -noaudio -no-boot-anim -camera-back none -gpu swiftshader_indirect ${{ matrix.emulator-options }}
           disable-animations: false
           script: echo "Generated AVD snapshot for caching."
 
       - name: Run lldb tests against ds2 on Android emulator
         uses: reactivecircus/android-emulator-runner@v2
         with:
-          api-level: ${{ matrix.api-level }}
-          arch: ${{ matrix.processor }}
+          emulator-build: ${{ matrix.emulator-build }}
+          api-level: ${{ matrix.android-api-level }}
+          arch: ${{ matrix.arch }}
           force-avd-creation: false
           # NOTE: -no-snapshot will not load or save state and the emulator will
           # cold boot. Ideally, we would specify -no-snapshot-save instead so it
           # would load the snapshot created in the caching step (but not save a
           # new one). However, doing that causes the emulator to hang during
           # shutdown. We're still saving time by reusing the device created in
           # the caching step and not wiping userdata on boot.
-          emulator-options: -no-snapshot -no-window -noaudio -no-boot-anim -camera-back none
+          emulator-options: -no-snapshot -no-window -noaudio -no-boot-anim -camera-back none -gpu swiftshader_indirect ${{ matrix.emulator-options }}
           disable-animations: true
           script: >
             $ANDROID_SDK_ROOT/platform-tools/adb forward tcp:5432 tcp:5432
@@ -523,12 +545,12 @@ jobs:
 
             ${{ github.workspace }}/BinaryCache/llvm/bin/lldb-dotest
             --out-of-tree-debugserver
-            --arch ${{ matrix.processor}}
+            --arch ${{ matrix.llvm-arch }}
             --platform-name remote-android
             --platform-url connect://localhost:5432
             --platform-working-dir /data/local/tmp
-            --compiler=$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/${{ matrix.processor }}-linux-android${{ matrix.api-level }}-clang
-            --excluded ${{ github.workspace }}/SourceCache/ds2/Support/Testing/Excluded/ds2/android-${{ matrix.processor }}.excluded
-            --excluded ${{ github.workspace }}/SourceCache/ds2/Support/Testing/Excluded/upstream/android-${{ matrix.processor }}.excluded
+            --compiler=$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/${{ matrix.llvm-arch }}-linux-android${{ matrix.android-api-level }}-clang
+            --excluded ${{ github.workspace }}/SourceCache/ds2/Support/Testing/Excluded/ds2/android-${{ matrix.llvm-arch }}.excluded
+            --excluded ${{ github.workspace }}/SourceCache/ds2/Support/Testing/Excluded/upstream/android-${{ matrix.llvm-arch }}.excluded
             --excluded ${{ github.workspace }}/SourceCache/ds2/Support/Testing/Excluded/upstream/non-debugserver-tests.excluded
             ${{ matrix.test-subdirs }}

Support/Testing/Excluded/ds2/android-aarch64.excluded

@@ -0,0 +1,5 @@
+skip
+TestAArch64LinuxTaggedMemoryAccess.AArch64LinuxTaggedMemoryReadTestCase.test_tagged_memory_find
+TestAArch64LinuxTaggedMemoryAccess.AArch64LinuxTaggedMemoryReadTestCase.test_tagged_memory_read
+TestAArch64LinuxTaggedMemoryRegion.AArch64LinuxTaggedMemoryRegionTestCase.test_mte_regions
+TestUnwindSignal.UnwindSignalTestCase.test_unwind_signal

Support/Testing/Excluded/upstream/android-aarch64.excluded

@@ -0,0 +1,10 @@
+skip
+TestGdbRemoteMemoryTagging.TestGdbRemoteMemoryTagging.test_tag_write_QMemTags_packets_llgs
+TestGdbRemoteMemoryTagging.TestGdbRemoteMemoryTagging.test_tag_read_qMemTags_packets_llgs
+TestGdbRemotePlatformFile.TestGdbRemotePlatformFile.test_platform_file_wronly_creat_llgs
+TestGdbRemotePlatformFile.TestGdbRemotePlatformFile.test_platform_file_wronly_creat_excl_llgs
+TestGdbRemotePlatformFile.TestGdbRemotePlatformFile.test_platform_file_mode_llgs
+TestGdbRemotePlatformFile.TestGdbRemotePlatformFile.test_platform_file_fstat_llgs
+TestLldbGdbServer.LldbGdbServerTestCase.test_qMemoryRegionInfo_reports_heap_address_as_rw_llgs
+TestAArch64LinuxTLSRegisters.AArch64LinuxTLSRegisters.test_tpidr2_no_sme
+TestAArch64LinuxTLSRegisters.AArch64LinuxTLSRegisters.test_tls_no_sme