Upstream sentry-native (does not update crashpad and breakpad refs)

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.4.13
+
+**Features**
+
+- Add client-side stackwalking on Linux, Windows, and macOS (disabled by default).
+- CMake: add ability to set solution folder name.
+- Add AIX support.
+
+**Fixes**
+
+- CMake: check whether libcurl was already found.
+- Increment CXX standard version to 14 to allow crashpad to build.
+
+**Internal**:
+
+- Update Crashpad and Breakpad submodules to 2021-12-03.
+
+**Thank you**:
+
+Features, fixes and improvements in this release have been contributed by:
+
+- [@Mixaill](https://github.com/Mixaill)
+- [@ladislavmacoun](https://github.com/ladislavmacoun)
+- [@NattyNarwhal](https://github.com/NattyNarwhal)
+- [@mjvankampen](https://github.com/mjvankampen)
+
 ## 0.4.12
 
 **Features**:

CMakeLists.txt

@@ -47,6 +47,8 @@ set(CMAKE_INSTALL_CMAKEDIR "${CMAKE_INSTALL_LIBDIR}/cmake/sentry")
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
 	set(LINUX TRUE)
+elseif(CMAKE_SYSTEM_NAME STREQUAL "AIX" OR CMAKE_SYSTEM_NAME STREQUAL "OS400")
+	set(AIX TRUE)
 endif()
 
 #setup sentry library type
@@ -93,7 +95,7 @@ endif()
 
 if(WIN32)
 	set(SENTRY_DEFAULT_TRANSPORT "winhttp")
-elseif((APPLE AND NOT IOS) OR LINUX)
+elseif((APPLE AND NOT IOS) OR LINUX OR AIX)
 	set(SENTRY_DEFAULT_TRANSPORT "curl")
 else()
 	set(SENTRY_DEFAULT_TRANSPORT "none")
@@ -137,8 +139,10 @@ else()
 	set(SENTRY_DEFAULT_BACKEND "inproc")
 endif()
 
-set(SENTRY_BACKEND ${SENTRY_DEFAULT_BACKEND} CACHE STRING
-  "The sentry backend responsible for reporting crashes, can be either 'none', 'inproc', 'breakpad' or 'crashpad'.")
+if(NOT DEFINED SENTRY_BACKEND)
+	set(SENTRY_BACKEND ${SENTRY_DEFAULT_BACKEND} CACHE STRING
+		"The sentry backend responsible for reporting crashes, can be either 'none', 'inproc', 'breakpad' or 'crashpad'.")
+endif()
 
 if(SENTRY_BACKEND STREQUAL "crashpad")
 	set(SENTRY_BACKEND_CRASHPAD TRUE)
@@ -236,6 +240,10 @@ endif()
 
 set_target_properties(sentry PROPERTIES PUBLIC_HEADER "include/sentry.h")
 
+if(DEFINED SENTRY_FOLDER)
+	set_target_properties(sentry PROPERTIES FOLDER ${SENTRY_FOLDER})
+endif()
+
 # check size type
 include(CheckTypeSize)
 check_type_size("long" CMAKE_SIZEOF_LONG)
@@ -257,8 +265,20 @@ else()
 endif()
 target_compile_definitions(sentry PRIVATE SIZEOF_LONG=${CMAKE_SIZEOF_LONG})
 
+# AIX needs libm for isnan used in test suite
+if(CMAKE_SYSTEM_NAME STREQUAL "AIX" OR CMAKE_SYSTEM_NAME STREQUAL "OS400")
+	target_link_libraries(sentry PRIVATE m)
+endif()
+# On IBM i PASE, flock is in libutil. Here because "sentry" exists now.
+if(CMAKE_SYSTEM_NAME STREQUAL "OS400")
+	target_link_libraries(sentry PRIVATE util)
+endif()
+
 if(SENTRY_TRANSPORT_CURL)
-	find_package(CURL REQUIRED)
+	if(NOT CURL_FOUND) # Some other lib might bring libcurl already
+		find_package(CURL REQUIRED)
+	endif()
+
 	if(TARGET CURL::libcurl) # Only available in cmake 3.12+
 		target_link_libraries(sentry PRIVATE CURL::libcurl)
 	else()
@@ -434,6 +454,20 @@ if(SENTRY_BACKEND_CRASHPAD)
 			set_property(TARGET mini_chromium PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 		endif()
 
+		if(DEFINED SENTRY_FOLDER)
+			set_target_properties(crashpad_client PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_compat PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_getopt PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_handler PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_handler_lib PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_minidump PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_snapshot PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_tools PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_util PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(crashpad_zlib PROPERTIES FOLDER ${SENTRY_FOLDER})
+			set_target_properties(mini_chromium PROPERTIES FOLDER ${SENTRY_FOLDER})
+		endif()
+
 		target_link_libraries(sentry PRIVATE
 			$<BUILD_INTERFACE:crashpad::client>
 			$<INSTALL_INTERFACE:sentry_crashpad::client>
@@ -462,6 +496,11 @@ elseif(SENTRY_BACKEND_BREAKPAD)
 		target_link_libraries(sentry PRIVATE
 			breakpad_client
 		)
+
+		if(DEFINED SENTRY_FOLDER)
+			set_target_properties(breakpad_client PROPERTIES FOLDER ${SENTRY_FOLDER})
+		endif()
+
 		if(NOT SENTRY_BUILD_SHARED_LIBS)
 			sentry_install(TARGETS breakpad_client EXPORT sentry
 				LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
@@ -538,5 +577,9 @@ if(SENTRY_BUILD_EXAMPLES)
 		set_property(TARGET sentry_example PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 	endif()
 
+	if(DEFINED SENTRY_FOLDER)
+		set_target_properties(sentry_example PROPERTIES FOLDER ${SENTRY_FOLDER})
+	endif()
+
 	add_test(NAME sentry_example COMMAND sentry_example)
 endif()

CONTRIBUTING.md

@@ -37,7 +37,7 @@ be done manually.
 
 Creates a python virtualenv, and runs all the tests through `pytest`.
 
-**Running integration-tests manually**:
+**Running integration tests manually**:
 
     $ pytest --verbose --maxfail=1 --capture=no tests/
 
@@ -47,13 +47,20 @@ can also be invoked directly.
 The `maxfail` parameter will abort after the first failure, and `capture=no`
 will print the complete compiler output, and test log.
 
-**Running unit-tests manually**:
+**Running unit tests**:
+
+    $ make test-unit
+
+Unit tests also have a dedicated `make` target, if they need to be run separately
+from the integration tests.
+
+**Running unit tests manually**:
 
     $ cmake -B build -D CMAKE_RUNTIME_OUTPUT_DIRECTORY=$(pwd)/build
     $ cmake --build build --target sentry_test_unit
     $ ./build/sentry_test_unit
 
-The unit-tests are a separate executable target and can be built and run on
+The unit tests are a separate executable target and can be built and run on
 their own.
 
 ## How to interpret CI failures

Makefile

@@ -18,6 +18,10 @@ build/sentry_test_unit: build
 test: update-test-discovery test-integration
 .PHONY: test
 
+test-unit: update-test-discovery build/sentry_test_unit
+	./build/sentry_test_unit
+.PHONY: test-unit
+
 test-integration: setup-venv
 	.venv/bin/pytest tests --verbose
 .PHONY: test-integration

README.md

@@ -92,6 +92,7 @@ The SDK supports different features on the target platform:
   have the `curl` library available. On other platforms, library users need to
   implement their own transport, based on the `function transport` API.
 - **Crashpad Backend** is currently only supported on Linux, Windows and macOS.
+- **Client-side stackwalking** is currently only supported on Linux, Windows, and macOS.
 
 ## Building and Installation
 
@@ -277,6 +278,15 @@ Legend:
 - ✓ supported
 - unsupported
 
+- `SENTRY_FOLDER` (Default: not defined):
+  Sets the sentry-native projects folder name for generators which support project hierarchy (like Microsoft Visual Studio).
+  To use this feature you need to enable hierarchy via [`USE_FOLDERS` property](https://cmake.org/cmake/help/latest/prop_gbl/USE_FOLDERS.html)
+
+- `CRASHPAD_ENABLE_STACKTRACE` (Default: OFF):
+  This enables client-side stackwalking when using the crashpad backend. Stack unwinding will happen on the client's machine
+  and the result will be submitted to Sentry attached to the generated minidump.
+  Note that this feature is still experimental.
+
 ### Build Targets
 
 - `sentry`: This is the main library and the only default build target.

examples/example.c

@@ -45,7 +45,14 @@ has_arg(int argc, char **argv, const char *arg)
     return false;
 }
 
+#ifdef SENTRY_PLATFORM_AIX
+// AIX has a null page mapped to the bottom of memory, which means null derefs
+// don't segfault. try dereferencing the top of memory instead; the top nibble
+// seems to be unusable.
+static void *invalid_mem = (void *)0xFFFFFFFFFFFFFF9B; // -100 for memset
+#else
 static void *invalid_mem = (void *)1;
+#endif
 
 static void
 trigger_crash()
@@ -86,6 +93,10 @@ main(int argc, char **argv)
             options, sentry_transport_new(print_envelope));
     }
 
+    if (has_arg(argc, argv, "capture-transaction")) {
+        sentry_options_set_traces_sample_rate(options, 1.0);
+    }
+
     sentry_init(options);
 
     if (!has_arg(argc, argv, "no-setup")) {
@@ -201,6 +212,19 @@ main(int argc, char **argv)
         sentry_capture_event(event);
     }
 
+    if (has_arg(argc, argv, "capture-transaction")) {
+        sentry_value_t tx_ctx
+            = sentry_value_new_transaction_context("I'm a little teapot",
+                "Short and stout here is my handle and here is my spout");
+
+        if (has_arg(argc, argv, "unsample-tx")) {
+            sentry_transaction_context_set_sampled(tx_ctx, 0);
+        }
+
+        sentry_value_t tx = sentry_transaction_start(tx_ctx);
+        sentry_transaction_finish(tx);
+    }
+
     // make sure everything flushes
     sentry_close();