Feature/ndk16bsupport and feature/IncreaseClientSideUnwidingRobustness (#30)

Add support for NDK 16b and bug fixes for client side unwinding so it works on all supported API/NDK levels when the Crashpad backend is used

Author: rqbacktrace

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "backtrace-library/src/main/cpp/libbun"]
 	path = backtrace-library/src/main/cpp/libbun
 	url = git@github.com:backtrace-labs/libbun.git
+[submodule "backtrace-library/src/main/cpp/breakpad-builds"]
+	path = backtrace-library/src/main/cpp/breakpad-builds
+	url = git@github.com:backtrace-labs/breakpad-builds.git

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Backtrace Android Release Notes
 
+## Version 3.5.0 - 14.09.2021
+- Added support for native crash reporting in NDK 16b
+- Bug fixes and expanded supported NDK versions for client side unwinding
+
 ## Version 3.4.0 - 07.09.2021
 - Added support for NDK 22
 

README.md

@@ -72,8 +72,8 @@ catch (e: Exception) {
 
 # Supported SDKs <a name="supported-sdks"></a>
 * Minimum SDK version 21 (Android 5.0)
-* Target SDK version 28 (Android 9.0)
-* Minimum NDK version 17c
+* Target SDK version 30 (Android 11.0)
+* Minimum NDK version 16b
 * Maximum NDK version 22
 
 # Supported platforms
@@ -516,6 +516,10 @@ In addition, you may need to add the [extractNativeLibs](https://developer.andro
 ```
 More details about [extractNativeLibs](https://developer.android.com/guide/topics/manifest/application-element#extractNativeLibs) are available from the Android documentation
 
+**NOTE:** If your native app is built with NDK 16b, the Breakpad native crash client will be used instead of our recommended Crashpad crash client. To avoid this please use NDK 17c+ to build your native app.
+
+**NOTE:** Breakpad crash reports are submitted on the next app startup, instead of at crash time like Crashpad crash reports
+
 ## Uploading symbols to Backtrace
 For an NDK application, debugging symbols are not available to Backtrace by default. You will need to upload the application symbols for your native code to Backtrace. You can do this by uploading the native libraries themselves, which are usually found in the .apk bundle. [Click here to learn more about symbolification](https://support.backtrace.io/hc/en-us/articles/360040517071-Symbolication-Overview)
 
@@ -527,12 +531,12 @@ To enable client side unwinding, you can call the `setupNativeIntegration` metho
 database.setupNativeIntegration(backtraceClient, credentials, true);
 ```
 
-**NOTE:** Client side unwinding is only available in API level 23+ (Android 6.0)+
-
 **NOTE:** When viewing a crash in the Backtrace Debugger, it may still show warning messages that symbols are missing from certain frames after client-side unwinding is performed. This warning is expected if these symbols are not available on the Backtrace server, and should have no impact to the end-user's ability to read the call stack.
 
 **NOTE:** Client side unwinding is only available for fatal crashes. Non-fatal Crashpad dumps you generate via `DumpWithoutCrash` for instance will not use client side unwinding.
 
+**NOTE:** Client side unwinding is only available in NDK level 17+ (i.e: Only with the Crashpad crash reporting backend)
+
 ### Unwinding Modes and Options
 
 You can optionally specify the unwinding mode (`REMOTE_DUMPWITHOUTCRASH` is the default)

backtrace-library/build.gradle

@@ -2,13 +2,13 @@ apply plugin: 'com.android.library'
 apply from: 'publish.gradle'
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 30
 
     defaultConfig {
         minSdkVersion 21
-        targetSdkVersion 28
-        versionCode 340
-        versionName "3.4.0"
+        targetSdkVersion 30
+        versionCode 350
+        versionName "3.5.0"
 
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
 
@@ -17,6 +17,9 @@ android {
                 cppFlags ""
             }
         }
+        ndk {
+            abiFilters 'x86', 'x86_64', 'armeabi-v7a', 'arm64-v8a'
+        }
     }
 
     buildTypes {

backtrace-library/src/main/cpp/CMakeLists.txt

@@ -5,36 +5,87 @@
 
 cmake_minimum_required(VERSION 3.4.1)
 
-# Creates and names a library, sets it as either STATIC
-# or SHARED, and provides the relative paths to its source code.
-# You can define multiple libraries, and CMake builds them for you.
-# Gradle automatically packages shared libraries with your APK.
-
-add_library( # Sets the name of the library.
-             backtrace-native
-
-             # Sets the library as a shared library.
-             SHARED
-
-             # Provides a relative path to your source file(s).
-        backtrace-native.cpp)
-
-# Crashpad Libraries
-add_library(crashpad_client STATIC IMPORTED)
-set_property(TARGET crashpad_client PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/crashpad-builds/${ANDROID_ABI}/client/libcrashpad_client.a)
-
-add_library(crashpad_util STATIC IMPORTED)
-set_property(TARGET crashpad_util PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/crashpad-builds/${ANDROID_ABI}/util/libcrashpad_util.a)
-
-add_library(base STATIC IMPORTED)
-set_property(TARGET base PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/crashpad-builds/${ANDROID_ABI}/third_party/mini_chromium/mini_chromium/base/libbase.a)
-
-# Crashpad Headers
-include_directories(${PROJECT_SOURCE_DIR}/crashpad-builds/headers/ ${PROJECT_SOURCE_DIR}/crashpad-builds/headers/third_party/mini_chromium/mini_chromium/)
-
-# Bun Libraries
-set(LIBUNWINDSTACK_ENABLED TRUE)
-add_subdirectory(libbun)
+# Determine native crash backend
+# ANDROID_NDK_MAJOR not defined until ndk 17+
+# https://github.com/android/ndk/issues/596
+if (ANDROID_ABI STREQUAL "x86")
+    message("Native crash reporting not supported for x86 emulator")
+elseif(ANDROID_ABI STREQUAL "x86_64" AND (NOT ANDROID_NDK_MAJOR OR ANDROID_NDK_MAJOR LESS 17))
+    message("Breakpad not supported for x86_64 emulator")
+elseif (NOT ANDROID_NDK_MAJOR)
+    set(BACKEND "BREAKPAD_BACKEND")
+elseif(ANDROID_NDK_MAJOR LESS 17)
+    set(BACKEND "BREAKPAD_BACKEND")
+else()
+    set(BACKEND "CRASHPAD_BACKEND")
+    set(CLIENT_SIDE_UNWINDING TRUE)
+endif()
+
+# Sources
+list(APPEND SOURCES backtrace-native.cpp)
+list(APPEND SOURCES backends/backend.cpp)
+list(APPEND SOURCES client-side-unwinding.cpp)
+if(BACKEND STREQUAL "CRASHPAD_BACKEND")
+    list(APPEND SOURCES backends/crashpad-backend.cpp)
+elseif(BACKEND STREQUAL "BREAKPAD_BACKEND")
+    list(APPEND SOURCES backends/breakpad-backend.cpp)
+else()
+    message("No native debugging backend selected")
+endif()
+
+add_library(# Sets the name of the library.
+            backtrace-native
+
+            # Sets the library as a shared library.
+            SHARED
+
+            # Provides a relative path to your source file(s).
+            ${SOURCES})
+
+target_compile_features(backtrace-native PRIVATE cxx_std_17)
+
+if(BACKEND STREQUAL "CRASHPAD_BACKEND")
+    target_compile_definitions(backtrace-native PRIVATE -DCRASHPAD_BACKEND)
+
+    # Crashpad Libraries
+    add_library(crashpad_client STATIC IMPORTED)
+    set_property(TARGET crashpad_client PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/crashpad-builds/${ANDROID_ABI}/client/libcrashpad_client.a)
+
+    add_library(crashpad_util STATIC IMPORTED)
+    set_property(TARGET crashpad_util PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/crashpad-builds/${ANDROID_ABI}/util/libcrashpad_util.a)
+
+    add_library(base STATIC IMPORTED)
+    set_property(TARGET base PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/crashpad-builds/${ANDROID_ABI}/third_party/mini_chromium/mini_chromium/base/libbase.a)
+
+    # Crashpad Headers
+    include_directories(${PROJECT_SOURCE_DIR}/crashpad-builds/headers/ ${PROJECT_SOURCE_DIR}/crashpad-builds/headers/third_party/mini_chromium/mini_chromium/)
+elseif(BACKEND STREQUAL "BREAKPAD_BACKEND")
+    target_compile_definitions(backtrace-native PRIVATE -DBREAKPAD_BACKEND)
+
+    # Breakpad Libraries
+    add_library(breakpad_client STATIC IMPORTED)
+    set_property(TARGET breakpad_client PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/breakpad-builds/${ANDROID_ABI}/libbreakpad_client.a)
+
+    # Curl Libraries
+    add_library(curl SHARED IMPORTED)
+    set_property(TARGET curl PROPERTY IMPORTED_LOCATION ${PROJECT_SOURCE_DIR}/curl-builds/${ANDROID_ABI}/libcurl.so)
+
+    # Breakpad Headers
+    include_directories(${PROJECT_SOURCE_DIR}/breakpad-builds/${ANDROID_ABI} ${PROJECT_SOURCE_DIR}/breakpad-builds/${ANDROID_ABI}/src ${PROJECT_SOURCE_DIR}/breakpad-builds/${ANDROID_ABI}/src/common/android/include)
+else()
+    message("No native debugging backend selected")
+endif()
+
+# Includes
+include_directories(${PROJECT_SOURCE_DIR}/include)
+
+if (CLIENT_SIDE_UNWINDING)
+    target_compile_definitions(backtrace-native PRIVATE -DCLIENT_SIDE_UNWINDING)
+
+    # Bun Libraries
+    set(LIBUNWINDSTACK_ENABLED TRUE)
+    add_subdirectory(libbun)
+endif()
 
 # Searches for a specified prebuilt library and stores the path as a
 # variable. Because CMake includes system libraries in the search path by
@@ -50,19 +101,28 @@ find_library( # Sets the name of the path variable.
               log
             )
 
-
-
 # Specifies libraries CMake should link to your target library. You
 # can link multiple libraries, such as libraries you define in this
 # build script, prebuilt third-party libraries, or system libraries.
 
-target_link_libraries( # Specifies the target library.
-                        backtrace-native
-                       # Links the target library to the log library
-                       # included in the NDK.
-                       ${log-lib}
-                        crashpad_client
-                        crashpad_util
-                        base
-                        bun
-                     )
+list(APPEND LIBS backtrace-native)
+list(APPEND LIBS ${log-lib})
+
+if(BACKEND STREQUAL "CRASHPAD_BACKEND")
+    list(APPEND LIBS crashpad_client)
+    list(APPEND LIBS crashpad_util)
+    list(APPEND LIBS base)
+elseif(BACKEND STREQUAL "BREAKPAD_BACKEND")
+    list(APPEND LIBS breakpad_client)
+    list(APPEND LIBS curl)
+else()
+    message("No native debugging backend selected")
+endif()
+
+if (CLIENT_SIDE_UNWINDING)
+    list(APPEND LIBS bun)
+endif()
+
+target_link_libraries(${LIBS})
+
+

backtrace-library/src/main/cpp/backends/backend.cpp

@@ -0,0 +1,69 @@
+#include "backend.h"
+#include "client-side-unwinding.h"
+#include <android/log.h>
+#include <atomic>
+#include <mutex>
+
+#ifdef CRASHPAD_BACKEND
+#include "crashpad-backend.h"
+#elif BREAKPAD_BACKEND
+#include "breakpad-backend.h"
+#endif
+
+extern std::atomic_bool initialized;
+
+extern "C" {
+bool Initialize(jstring url,
+                jstring database_path,
+                jstring handler_path,
+                jobjectArray attributeKeys,
+                jobjectArray attributeValues,
+                jobjectArray attachmentPaths,
+                jboolean enableClientSideUnwinding,
+                jint unwindingMode) {
+    static std::once_flag initialize_flag;
+
+    std::call_once(initialize_flag, [&] {
+#ifdef CRASHPAD_BACKEND
+        initialized = InitializeCrashpad(url,
+                                         database_path, handler_path,
+                                         attributeKeys, attributeValues,
+                                         attachmentPaths, enableClientSideUnwinding,
+                                         unwindingMode);
+#elif BREAKPAD_BACKEND
+        initialized = InitializeBreakpad(url,
+                                         database_path, handler_path,
+                                         attributeKeys, attributeValues,
+                                         attachmentPaths, enableClientSideUnwinding,
+                                         unwindingMode);
+#else
+        initialized = false;
+        __android_log_print(ANDROID_LOG_ERROR, "Backtrace-Android",
+                            "No native crash reporting backend defined");
+#endif
+    });
+    return initialized;
+}
+
+void DumpWithoutCrash(jstring message, jboolean set_main_thread_as_faulting_thread) {
+#ifdef CRASHPAD_BACKEND
+    DumpWithoutCrashCrashpad(message, set_main_thread_as_faulting_thread);
+#elif BREAKPAD_BACKEND
+    DumpWithoutCrashBreakpad(message, set_main_thread_as_faulting_thread);
+#else
+    __android_log_print(ANDROID_LOG_ERROR, "Backtrace-Android",
+                        "DumpWithoutCrash not supported on this backend");
+#endif
+}
+
+void AddAttribute(jstring key, jstring value) {
+#ifdef CRASHPAD_BACKEND
+    AddAttributeCrashpad(key, value);
+#elif BREAKPAD_BACKEND
+    AddAttributeBreakpad(key, value);
+#else
+    __android_log_print(ANDROID_LOG_ERROR, "Backtrace-Android",
+                        "AddAttribute not supported on this backend");
+#endif
+}
+}