diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml index 8d81ec38c0..3278d9d014 100644 --- a/.github/workflows/e2e-test.yml +++ b/.github/workflows/e2e-test.yml @@ -76,6 +76,18 @@ jobs: fail-fast: false matrix: include: + - name: E2E Test (Android API 21, NDK 23) + ANDROID_API: 21 + ANDROID_NDK_VERSION: 23.2.8568313 + - name: E2E Test (Android API 26, NDK 27) + ANDROID_API: 26 + ANDROID_NDK_VERSION: 27.3.13750724 + - name: E2E Test (Android API 31, NDK 27) + ANDROID_API: 31 + ANDROID_NDK_VERSION: 27.3.13750724 + - name: E2E Test (Android API 35, NDK 29) + ANDROID_API: 35 + ANDROID_NDK_VERSION: 29.0.14206865 - name: E2E Test (Android API 36, NDK 30) ANDROID_API: 36 ANDROID_NDK_VERSION: 30.0.16138531 @@ -99,7 +111,8 @@ jobs: repository: getsentry/sentry-java # first release with sentry-android-ndk-outproc, bump only when # sentry-native-ndk-outproc changes need matching sentry-java changes - ref: 8.64.0 + # ref: 8.64.0 + ref: jpnurmi/fix/native-android-21 # TODO: pin release path: sentry-java - name: Set up Python @@ -136,7 +149,7 @@ jobs: api-level: ${{ env.ANDROID_API }} ndk: ${{ env.ANDROID_NDK_VERSION }} arch: ${{ env.ANDROID_ARCH }} - target: google_apis + target: default emulator-boot-timeout: 1200 script: | export ANDROID_NDK="$ANDROID_HOME/ndk/$ANDROID_NDK_VERSION" diff --git a/CHANGELOG.md b/CHANGELOG.md index 69f0d37608..cb094637c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## Unreleased + +**Fixes**: + +- Native/Android: support API 21+ (previously API 30+) with a file fallback for kernels without memfd. ([#2301](https://github.com/getsentry/sentry-native/pull/2301)) + ## 1.0.0-beta.1 **Breaking / Important behavior changes**: diff --git a/ndk/lib/api/sentry-native-ndk.api b/ndk/lib/api/sentry-native-ndk.api index 072749ecb6..a3b63da1e0 100644 --- a/ndk/lib/api/sentry-native-ndk.api +++ b/ndk/lib/api/sentry-native-ndk.api @@ -110,6 +110,7 @@ public final class io/sentry/ndk/NdkOptions { public final class io/sentry/ndk/SentryNdk { public static fun close ()V public static fun createCrashShm ()I + public static fun createCrashShm (Ljava/lang/String;)I public static fun dupCrashShmFd ()I public static fun init (Lio/sentry/ndk/NdkOptions;)V public static fun initCrashDaemon (IIII)V diff --git a/ndk/lib/src/main/java/io/sentry/ndk/SentryNdk.java b/ndk/lib/src/main/java/io/sentry/ndk/SentryNdk.java index 5281676f3f..d244ce92ee 100644 --- a/ndk/lib/src/main/java/io/sentry/ndk/SentryNdk.java +++ b/ndk/lib/src/main/java/io/sentry/ndk/SentryNdk.java @@ -21,7 +21,7 @@ private SentryNdk() {} */ private static native int initSentryNative(@NotNull final NdkOptions options); - private static native int nativeCreateCrashShm(); + private static native int nativeCreateCrashShm(@Nullable String databasePath); private static native void nativeInitCrashDaemon( int shmFd, int notifyFd, int readyFd, int messageFd); @@ -75,10 +75,18 @@ public static void init(@NotNull final NdkOptions options) { } } - /** Creates the shared memory of the crash IPC, or returns -1 if that fails. Needs API 30+. */ + /** Creates the shared memory of the crash IPC, or returns -1 if that fails. Needs memfd. */ public static int createCrashShm() { + return createCrashShm(null); + } + + /** + * Creates the shared memory of the crash IPC, or returns -1 if that fails. Falls back to a file + * in the database directory on kernels without memfd. + */ + public static int createCrashShm(@Nullable String databasePath) { loadNativeLibraries(); - return nativeCreateCrashShm(); + return nativeCreateCrashShm(databasePath); } public static void initCrashDaemon(int shmFd, int notifyFd, int readyFd, int messageFd) { diff --git a/ndk/lib/src/main/jni/sentry.c b/ndk/lib/src/main/jni/sentry.c index 92d8d9355a..38d1f48bab 100644 --- a/ndk/lib/src/main/jni/sentry.c +++ b/ndk/lib/src/main/jni/sentry.c @@ -11,7 +11,8 @@ #include "sentry_http.h" -extern int sentry_android_crash_daemon_create_shm(void) __attribute__((weak)); +extern int sentry_android_crash_daemon_create_shm(const char *database_path) + __attribute__((weak)); extern void sentry_android_crash_daemon_init(int shm_fd, int notify_fd, int ready_fd, int message_fd) __attribute__((weak)); typedef struct sentry_crash_daemon_s sentry_crash_daemon_t; @@ -568,10 +569,21 @@ Java_io_sentry_ndk_SentryNdk_initSentryNative( } JNIEXPORT jint JNICALL -Java_io_sentry_ndk_SentryNdk_nativeCreateCrashShm(JNIEnv *env, jclass cls) { - return sentry_android_crash_daemon_create_shm - ? (jint) sentry_android_crash_daemon_create_shm() - : -1; +Java_io_sentry_ndk_SentryNdk_nativeCreateCrashShm( + JNIEnv *env, + jclass cls, + jstring database_path) { + if (!sentry_android_crash_daemon_create_shm) { + return -1; + } + const char *path_chars = database_path + ? (*env)->GetStringUTFChars(env, database_path, 0) + : NULL; + int fd = sentry_android_crash_daemon_create_shm(path_chars); + if (path_chars) { + (*env)->ReleaseStringUTFChars(env, database_path, path_chars); + } + return (jint) fd; } JNIEXPORT void JNICALL diff --git a/src/backends/native/sentry_crash_ipc.c b/src/backends/native/sentry_crash_ipc.c index 84060cc076..7ca976a5da 100644 --- a/src/backends/native/sentry_crash_ipc.c +++ b/src/backends/native/sentry_crash_ipc.c @@ -162,6 +162,7 @@ sentry__crash_ipc_message_decode( # include # include # include +# include # include # include # include @@ -220,6 +221,28 @@ init_unlock(sentry_crash_ipc_t *ipc) sentry__mutex_unlock(ipc->init_mutex); } } + +int +sentry__crash_ipc_create_shm_file(const char *dir) +{ + char path[SENTRY_CRASH_MAX_PATH]; + int len = snprintf(path, sizeof(path), "%s/.sentry-shm-XXXXXX", dir); + if (len < 0 || (size_t)len >= sizeof(path)) { + return -1; + } + int fd = mkstemp(path); + if (fd < 0) { + return -1; + } + unlink(path); + // a sparse file raises SIGBUS on write when the disk is full + if (fcntl(fd, F_SETFD, FD_CLOEXEC) < 0 + || posix_fallocate(fd, 0, SENTRY_CRASH_SHM_SIZE) != 0) { + close(fd); + return -1; + } + return fd; +} # else static int shm_create(sentry_crash_ipc_t *ipc) diff --git a/src/backends/native/sentry_crash_ipc.h b/src/backends/native/sentry_crash_ipc.h index d879345b9f..3d3889c598 100644 --- a/src/backends/native/sentry_crash_ipc.h +++ b/src/backends/native/sentry_crash_ipc.h @@ -212,6 +212,14 @@ sentry_crash_ipc_t *sentry__crash_ipc_init_app(void); int sentry__crash_ipc_create_memfd(void); #endif +#if defined(SENTRY_PLATFORM_ANDROID) +/** + * Creates shared memory backed by an unlinked, preallocated file in `dir`, for + * kernels without memfd. Returns -1 on failure. + */ +int sentry__crash_ipc_create_shm_file(const char *dir); +#endif + /** * Initialize IPC for daemon process. * Attaches to existing shared memory created by app. diff --git a/src/backends/sentry_backend_native.c b/src/backends/sentry_backend_native.c index 513f0af2aa..00111c6abc 100644 --- a/src/backends/sentry_backend_native.c +++ b/src/backends/sentry_backend_native.c @@ -77,9 +77,14 @@ static android_crash_daemon_config_t g_android_crash_daemon_config = { false, -1, -1, -1, -1 }; __attribute__((visibility("default"))) int -sentry_android_crash_daemon_create_shm(void) +sentry_android_crash_daemon_create_shm(const char *database_path) { - return sentry__crash_ipc_create_memfd(); + int fd = sentry__crash_ipc_create_memfd(); + if (fd < 0 && database_path) { + // no memfd before kernel 3.17, e.g. below API 26 + fd = sentry__crash_ipc_create_shm_file(database_path); + } + return fd; } __attribute__((visibility("default"))) void diff --git a/tests/conditions.py b/tests/conditions.py index e4dccc157a..c8124aa4f1 100644 --- a/tests/conditions.py +++ b/tests/conditions.py @@ -55,8 +55,6 @@ # Native backend works on all platforms (lightweight, no external dependencies) # It's always available - tests explicitly set SENTRY_BACKEND: native in cmake # On macOS ASAN, the signal handling conflicts with ASAN's memory interception -has_native = not (is_asan and sys.platform == "darwin") and ( - not is_android or is_android >= 23 -) +has_native = not (is_asan and sys.platform == "darwin") has_sccache = os.environ.get("USE_SCCACHE") and shutil.which("sccache") diff --git a/tests/fixtures/android_e2e/README.md b/tests/fixtures/android_e2e/README.md index ae25b26c35..b850b284ba 100644 --- a/tests/fixtures/android_e2e/README.md +++ b/tests/fixtures/android_e2e/README.md @@ -11,7 +11,7 @@ pytest -s -v tests/test_e2e_sentry.py Run these commands from the sentry-native root. Testing needs a running emulator or device, `ANDROID_API`, and the `SENTRY_E2E_*` credentials documented in the test -module. The crash service needs API 30+; tombstone merging needs API 31+. +module. Tombstone merging needs API 31+. The setup script builds this checkout's native NDK package and the Java SDK into an isolated Maven repository, overriding the Java SDK's pinned NDK dependency. diff --git a/tests/fixtures/android_e2e/build.gradle b/tests/fixtures/android_e2e/build.gradle index 17b59b228a..db80d35dee 100644 --- a/tests/fixtures/android_e2e/build.gradle +++ b/tests/fixtures/android_e2e/build.gradle @@ -18,7 +18,7 @@ android { defaultConfig { applicationId = "io.sentry.e2e" - minSdk = 30 + minSdk = 21 targetSdk = project.property("targetSdk").toInteger() ndk { abiFilters.add(System.getenv("ANDROID_ARCH")) } } diff --git a/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/CrashReceiver.java b/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/CrashReceiver.java index 1be9fb5722..5310077566 100644 --- a/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/CrashReceiver.java +++ b/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/CrashReceiver.java @@ -3,8 +3,6 @@ import android.content.BroadcastReceiver; import android.content.Context; import android.content.Intent; -import android.os.Handler; -import android.os.Looper; import io.sentry.Sentry; public class CrashReceiver extends BroadcastReceiver { @@ -19,6 +17,6 @@ public void onReceive(Context context, Intent intent) { } // keep the process active until the crash goAsync(); - new Handler(Looper.getMainLooper()).postDelayed(MainActivity::triggerNativeCrash, 1000); + MainActivity.crashLater(); } } diff --git a/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/MainActivity.java b/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/MainActivity.java index a9f0bd6ff6..2f62f21046 100644 --- a/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/MainActivity.java +++ b/tests/fixtures/android_e2e/src/main/java/io/sentry/e2e/MainActivity.java @@ -5,6 +5,7 @@ import android.content.Intent; import android.os.Bundle; import android.os.Handler; +import android.os.Looper; import io.sentry.Sentry; import io.sentry.android.core.SentryAndroid; import io.sentry.protocol.User; @@ -17,7 +18,7 @@ public void onCreate(Bundle state) { super.onCreate(state); init(getApplicationContext(), getIntent()); if (getIntent().getBooleanExtra("crash", true)) { - new Handler(getMainLooper()).postDelayed(MainActivity::triggerNativeCrash, 1000); + crashLater(); } } @@ -43,6 +44,15 @@ static void init(Context context, Intent intent) { }); } + static void crashLater() { + Handler handler = new Handler(Looper.getMainLooper()); + // the SDK executor syncs the scope to native first + Sentry.getCurrentScopes() + .getOptions() + .getExecutorService() + .submit(() -> handler.postDelayed(MainActivity::triggerNativeCrash, 1000)); + } + private static void callNativeCrash() { crash(); } diff --git a/tests/test_e2e_sentry.py b/tests/test_e2e_sentry.py index 21c91228d1..081be02cd3 100644 --- a/tests/test_e2e_sentry.py +++ b/tests/test_e2e_sentry.py @@ -1049,6 +1049,18 @@ def android_e2e_app(request): adb("uninstall", package, check=False) +@pytest.fixture +def android_logcat(request): + adb("logcat", "-c", check=False) + failed = request.session.testsfailed + yield + if request.session.testsfailed > failed: + logcat = adb( + "logcat", "-d", capture_output=True, text=True, errors="replace" + ).stdout + print(f"\nlogcat:\n{logcat}") + + def assert_android_native_event(event, test_id, tombstone, debuggable=True): assert event["platform"] == "native" assert event["release"]["version"] == "sentry-native-e2e" @@ -1067,14 +1079,16 @@ def assert_android_native_event(event, test_id, tombstone, debuggable=True): if tombstone: functions = [frame.get("function") or "" for frame in frames] assert {"e2e_segfault", "e2e_native_crash"}.issubset(functions) - assert any( - "io.sentry.e2e.MainActivity.triggerNativeCrash" in function - for function in functions - ) - assert any( - "io.sentry.e2e.MainActivity.callNativeCrash" in function - for function in functions - ) + # API 31 tombstones leave dex frames unnamed + if is_android > 31: + assert any( + "io.sentry.e2e.MainActivity.triggerNativeCrash" in function + for function in functions + ) + assert any( + "io.sentry.e2e.MainActivity.callNativeCrash" in function + for function in functions + ) threads = get_threads_from_event(event) # a single thread means the daemon could not read the app's /proc @@ -1092,9 +1106,6 @@ def assert_android_native_event(event, test_id, tombstone, debuggable=True): @pytest.mark.skipif( not is_android or not has_native, reason="Tests need Android + native" ) -@pytest.mark.skipif( - is_android < 30, reason="The native crash service needs Android API 30+" -) @pytest.mark.parametrize( "android_e2e_app, debuggable", [("debug", True), ("nondebuggable", False)], @@ -1103,7 +1114,7 @@ def assert_android_native_event(event, test_id, tombstone, debuggable=True): scope="module", ) @pytest.mark.parametrize("tombstone", [False, True], ids=["native", "tombstone"]) -def test_e2e_android_native(android_e2e_app, debuggable, tombstone): +def test_e2e_android_native(android_e2e_app, android_logcat, debuggable, tombstone): """The crash service sends native crashes, optionally merged with a tombstone.""" if tombstone and is_android < 31: pytest.skip("Tombstone merging needs Android API 31+") @@ -1139,10 +1150,7 @@ def test_e2e_android_native(android_e2e_app, debuggable, tombstone): @pytest.mark.skipif( not is_android or not has_native, reason="Tests need Android + native" ) -@pytest.mark.skipif( - is_android < 30, reason="The native crash service needs Android API 30+" -) -def test_e2e_android_native_broadcast(android_e2e_app): +def test_e2e_android_native_broadcast(android_e2e_app, android_logcat): """A process that a broadcast starts in the background gets the crash service.""" test_id = str(uuid.uuid4()) package = android_e2e_app @@ -1173,10 +1181,7 @@ def test_e2e_android_native_broadcast(android_e2e_app): @pytest.mark.skipif( not is_android or not has_native, reason="Tests need Android + native" ) -@pytest.mark.skipif( - is_android < 30, reason="The native crash service needs Android API 30+" -) -def test_e2e_android_native_background(android_e2e_app): +def test_e2e_android_native_background(android_e2e_app, android_logcat): """The crash service outlives the idle timeout of background services.""" test_id = str(uuid.uuid4()) package = android_e2e_app diff --git a/tests/test_integration_android.py b/tests/test_integration_android.py index 535fc85193..08a0abd8e3 100644 --- a/tests/test_integration_android.py +++ b/tests/test_integration_android.py @@ -15,10 +15,6 @@ not has_native, reason="Tests need the native backend enabled", ) -@pytest.mark.skipif( - 0 < is_android < 23, - reason="Android native backend test needs API 23+ (process_vm_readv)", -) def test_native_android(cmake): database_path = "/data/local/tmp/.sentry-native"