feat: Add SIGTERM support (#3895)

Add support for catching sigterm signals.

Co-authored-by: Philipp Hofmann <[email protected]>

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add SIGTERM support ([#3895](https://github.com/getsentry/sentry-cocoa/pull/3895))
+
 ### Improvements
 
 - Send Cocoa SDK features (#3948)

Sources/SentryCrash/Recording/SentryCrashDoctor.m

@@ -351,6 +351,11 @@ - (BOOL)isMemoryCorruption:(NSDictionary *)report
  return NO;
 }
 
+- (BOOL)wasProgramTerminationRequested:(NSDictionary *)errorReport
+{
+ return [(errorReport[@SentryCrashField_Signal][@SentryCrashField_Signal]) intValue] == SIGTERM;
+}
+
 - (SentryCrashDoctorFunctionCall *)lastFunctionCall:(NSDictionary *)report
 {
  SentryCrashDoctorFunctionCall *function = [[SentryCrashDoctorFunctionCall alloc] init];
@@ -472,6 +477,10 @@ - (NSString *)diagnoseCrash:(NSDictionary *)report
  }
  }
 
+ if ([self wasProgramTerminationRequested:errorReport]) {
+ return @"Graceful OS termination requested.";
+ }
+
  return nil;
  } @catch (NSException *e) {
  NSArray *symbols = [e callStackSymbols];

Sources/SentryCrash/Recording/Tools/SentryCrashSignalInfo.c

@@ -106,7 +106,8 @@ static const SentryCrashSignalInfo g_fatalSignalData[] = {
  SIGNAL_INFO_NOCODES(SIGPIPE),
  SIGNAL_INFO(SIGSEGV, g_sigSegVCodes),
  SIGNAL_INFO_NOCODES(SIGSYS),
- SIGNAL_INFO(SIGTERM, g_sigTrapCodes),
+ SIGNAL_INFO(SIGTRAP, g_sigTrapCodes),
+ SIGNAL_INFO_NOCODES(SIGTERM),
 };
 static const int g_fatalSignalsCount = sizeof(g_fatalSignalData) / sizeof(*g_fatalSignalData);
 
@@ -121,6 +122,15 @@ static const int g_fatalSignals[] = {
  SIGSEGV,
  SIGSYS,
  SIGTRAP,
+
+ // SIGTERM can be caught and is usually sent by iOS and variants
+ // when Apple wants to try and gracefully shutdown the app
+ // before sending a SIGKILL (which can't be caught).
+ // Some areas I've seen this happen are:
+ // - When the OS updates an app.
+ // - In some circumstances for Watchdog Events.
+ // - Resource overuse (CPU, Disk, ...).
+ SIGTERM,
 };
 
 const char *

Tests/Resources/crash-sigterm.json

@@ -0,0 +1,259 @@
+{
+ "report": {
+ "version": "3.2.0",
+ "id": "42A64046-9255-4995-98C2-553FA204DF4D",
+ "process_name": "iOS-Swift",
+ "timestamp": 1675069636,
+ "type": "standard"
+ },
+ "process": {},
+ "system": {
+ "system_name": "iOS",
+ "system_version": "16.2",
+ "machine": "iPhone11,8",
+ "model": "N841AP",
+ "kernel_version": "Darwin Kernel Version 22.2.0: Tue Nov 1 21:21:17 PDT 2022; root:xnu-8792.60.51.122.1~1/RELEASE_ARM64_T8020",
+ "os_version": "20C5043e",
+ "jailbroken": false,
+ "boot_time": "2023-01-30T08:43:25Z",
+ "app_start_time": "2023-01-30T09:05:01Z",
+ "CFBundleExecutablePath": "/private/var/containers/Bundle/Application/53C684E3-9F0E-4FE3-8291-88677BAB718C/iOS-Swift.app/iOS-Swift",
+ "CFBundleExecutable": "iOS-Swift",
+ "CFBundleIdentifier": "io.sentry.sample.iOS-Swift",
+ "CFBundleName": "iOS-Swift",
+ "CFBundleVersion": "1",
+ "CFBundleShortVersionString": "7.31.5",
+ "app_uuid": "C488D0BE-E733-3031-AEF3-CC5182AB1E3B",
+ "cpu_arch": "arm64",
+ "cpu_type": 16777228,
+ "cpu_subtype": 2,
+ "binary_cpu_type": 16777228,
+ "binary_cpu_subtype": 0,
+ "process_name": "iOS-Swift",
+ "process_id": 495,
+ "parent_process_id": 1,
+ "device_app_hash": "9116712086e95f0c91b259ee97270e8f6a8a7768",
+ "build_type": "debug",
+ "total_storage": 63933894656,
+ "free_storage": 26521919488,
+ "memory": {
+ "size": 2976202752,
+ "usable": 2550726656,
+ "free": 66846720
+ },
+ "application_stats": {
+ "application_active": true,
+ "application_in_foreground": true,
+ "launches_since_last_crash": 1,
+ "sessions_since_last_crash": 2,
+ "active_time_since_last_crash": 120.664,
+ "background_time_since_last_crash": 12.2669,
+ "sessions_since_launch": 2,
+ "active_time_since_launch": 120.664,
+ "background_time_since_launch": 12.2669
+ }
+ },
+ "crash": {
+ "error": {
+ "signal": {
+ "signal": 15,
+ "name": "SIGTERM",
+ "code": 0,
+ "code_name": ""
+ },
+ "address": 5365848110,
+ "type": "signal"
+ }
+ },
+ "sentry_sdk_scope": {
+ "user": {
+ "email": "[email protected]",
+ "id": "1"
+ },
+ "environment": "debug",
+ "tags": {
+ "language": "swift"
+ },
+ "extra": {
+ "currentViewController": "<iOS_Swift.ViewController: 0x159d05ac0>"
+ },
+ "breadcrumbs": [
+ {
+ "category": "started",
+ "level": "info",
+ "message": "Breadcrumb Tracking",
+ "timestamp": "2023-01-30T09:05:01.740Z",
+ "type": "debug"
+ },
+ {
+ "category": "device.orientation",
+ "data": {
+ "position": "portrait"
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:05:01.757Z",
+ "type": "navigation"
+ },
+ {
+ "category": "ui.lifecycle",
+ "data": {
+ "beingPresented": "false",
+ "is_window_rootViewController": "true",
+ "screen": "UINavigationController",
+ "window": "<UIWindow: 0x159d0af90; frame = (0 0; 414 896); gestureRecognizers = <NSArray: 0x282ec60a0>; backgroundColor = <UIDynamicSystemColor: 0x2835fe280; name = _windowBackgroundColor>; layer = <UIWindowLayer: 0x282ec6400>>",
+ "window_isKeyWindow": "true",
+ "window_windowLevel": "0.000000"
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:05:01.819Z",
+ "type": "navigation"
+ },
+ {
+ "category": "ui.lifecycle",
+ "data": {
+ "beingPresented": "false",
+ "is_window_rootViewController": "false",
+ "parentViewController": "UINavigationController",
+ "screen": "ViewController",
+ "title": "Sentry Test App (Swift)",
+ "window": "<UIWindow: 0x159d0af90; frame = (0 0; 414 896); gestureRecognizers = <NSArray: 0x282ec60a0>; backgroundColor = <UIDynamicSystemColor: 0x2835fe280; name = _windowBackgroundColor>; layer = <UIWindowLayer: 0x282ec6400>>",
+ "window_isKeyWindow": "true",
+ "window_windowLevel": "0.000000"
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:05:01.819Z",
+ "type": "navigation"
+ },
+ {
+ "category": "app.lifecycle",
+ "data": {
+ "state": "foreground"
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:05:01.987Z",
+ "type": "navigation"
+ },
+ {
+ "category": "device.event",
+ "data": {
+ "action": "BATTERY_STATE_CHANGE",
+ "level": 4,
+ "plugged": true
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:05:21.053Z",
+ "type": "system"
+ },
+ {
+ "category": "device.event",
+ "data": {
+ "action": "BATTERY_STATE_CHANGE",
+ "level": 3,
+ "plugged": true
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:05:41.050Z",
+ "type": "system"
+ },
+ {
+ "category": "device.event",
+ "data": {
+ "action": "BATTERY_STATE_CHANGE",
+ "level": 4,
+ "plugged": true
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:06:01.086Z",
+ "type": "system"
+ },
+ {
+ "category": "device.event",
+ "data": {
+ "action": "BATTERY_STATE_CHANGE",
+ "level": 3,
+ "plugged": true
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:06:21.115Z",
+ "type": "system"
+ },
+ {
+ "category": "app.lifecycle",
+ "data": {
+ "state": "background"
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:07:02.658Z",
+ "type": "navigation"
+ },
+ {
+ "category": "device.orientation",
+ "data": {
+ "position": "portrait"
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:07:14.286Z",
+ "type": "navigation"
+ },
+ {
+ "category": "app.lifecycle",
+ "data": {
+ "state": "foreground"
+ },
+ "level": "info",
+ "timestamp": "2023-01-30T09:07:15.480Z",
+ "type": "navigation"
+ },
+ {
+ "category": "touch",
+ "data": {
+ "title": "crash",
+ "view": "<UIButton: 0x159e43020; frame = (0 210; 181.5 30); opaque = NO; autoresize = RM+BM; layer = <CALayer: 0x2820d8980>>"
+ },
+ "level": "info",
+ "message": "crash:",
+ "timestamp": "2023-01-30T09:07:16.198Z",
+ "type": "user"
+ }
+ ]
+ },
+ "user": {
+ "context": {
+ "app": {
+ "app_build": "1",
+ "app_id": "C488D0BE-E733-3031-AEF3-CC5182AB1E3B",
+ "app_identifier": "io.sentry.sample.iOS-Swift",
+ "app_name": "iOS-Swift",
+ "app_start_time": "2023-01-30T09:05:01Z",
+ "app_version": "7.31.5",
+ "build_type": "debug",
+ "device_app_hash": "9116712086e95f0c91b259ee97270e8f6a8a7768"
+ },
+ "device": {
+ "arch": "arm64",
+ "boot_time": "2023-01-30T08:43:25Z",
+ "family": "iOS",
+ "free_memory": 38764544,
+ "free_storage": 26521919488,
+ "locale": "en_AT",
+ "memory_size": 2976202752,
+ "model": "iPhone11,8",
+ "model_id": "N841AP",
+ "screen_height_pixels": 896,
+ "screen_width_pixels": 414,
+ "simulator": false,
+ "storage_size": 63933894656,
+ "usable_memory": 2552430592
+ },
+ "os": {
+ "build": "20C5043e",
+ "kernel_version": "Darwin Kernel Version 22.2.0: Tue Nov 1 21:21:17 PDT 2022; root:xnu-8792.60.51.122.1~1/RELEASE_ARM64_T8020",
+ "name": "iOS",
+ "rooted": false,
+ "version": "16.2"
+ }
+ },
+ "release": "[email protected]+1"
+ },
+ "debug": {}
+}

Tests/SentryTests/SentryCrash/SentryCrashDoctorTests.swift

@@ -17,4 +17,13 @@ final class SentryCrashDoctorTests: XCTestCase {
 
  XCTAssertEqual("Attempted to dereference garbage pointer at 0x13fd4582e.", diagnose)
  }
+
+ // Testing support for SIGTERM sent by the OS
+ func testGracefulTerminationRequest() throws {
+ let report = try getCrashReport(resource: "Resources/crash-sigterm")
+
+ let diagnose = SentryCrashDoctor().diagnoseCrash(report)
+
+ XCTAssertEqual("Graceful OS termination requested.", diagnose)
+ }
 }