Merged PR godotengine#56014 Add Breakpad for crash dump generation and show GUI Alert when crashing on desktop

Merged PR godotengine#56014 Add Breakpad for crash dump generation

use_breakpad=yes use_lto=yes debug_symbols=yes separate_debug_symbols=no use_static_cpp=yes

Fixed compiling on Windows

Make crash dump printing work better on Windows

Tweaked Breakpad build

Fixed Breakpad build for Godot 4

Switched to WINDOWS_ENABLED

Removed some non buildable files listed in the files to build

Ran clang format

Fixed the other formatting issues detected by CI

Removed a comment and added clarifying comment on crash dump message

as to why it is printed twice on Windows

Make an ugly string conversion to make Windows build work

Tweaked the build configuration and formatted again

removed lss

Add lss properly

Reinitialize breakpad after mono initialization on Linux

otherwise the breakpad signal handlers are not active

Disable Windows crash handler on destruction similarly to Linux

Renamed breakpad_enabled to use_breakpad

Forgot to wrap one piece of code inside ifdef USE_BREAKPAD

Updated copyright years in the added files

Fix register types for breakpad

Fixed dir access

Removed musl and elf_reader

which was the only thing seemingly depending on it

Updated header guards

Removed the memdelete call

Made copyright header changes that the checks wanted

Update the version hash breakpad is said to be used from

Try to fix .gitignore matching Breakpad source files

Added missing breakpad source file compile for Linux

Delete unused files

Update breakpad

Remove mono re-registration, replace accidentally removed line

Fixups

Show a GUI alert when crashing on desktop platforms

This makes it possible to know that Godot has crashed without looking
at the console (which may not be visible to the user).

- Change the window title while dumping the backtrace, as this can
  take a while to finish.
- If file logging is enabled, print path to log file to standard error
  and the GUI alert. Clicking OK will open the log file in the default
  program associated with `.log` files. Notepad has native associations
  for `.log` on Windows, so this works on Windows too.

Co-Authored-By: bruvzg <[email protected]>

Author: 2 people

.gitignore

@@ -271,6 +271,8 @@ thirdparty/swappy-frame-pacing/arm64-v8a/abi.json
 thirdparty/swappy-frame-pacing/armeabi-v7a/abi.json
 thirdparty/swappy-frame-pacing/x86/abi.json
 thirdparty/swappy-frame-pacing/x86_64/abi.json
+# Do not ignore breakpad source files
+!thirdparty/breakpad/src/client/linux/log
 
 # Visual Studio 2015/2017 cache/options directory
 .vs/

COPYRIGHT.txt

@@ -217,7 +217,12 @@ Comment: Basis Universal
 Copyright: 2019-2024, Binomial LLC.
 License: Apache-2.0
 
-Files: thirdparty/brotli/*
+Files: ./thirdparty/breakpad/
+Comment: Breakpad is a set of client and server components which implement a crash-reporting system.
+Copyright: 2006, Google Inc.
+License: BSD-3-clause
+
+Files: ./thirdparty/brotli/
 Comment: Brotli
 Copyright: 2009, 2010, 2013-2016 by the Brotli Authors.
 License: Expat

SConstruct

@@ -202,7 +202,7 @@ opts.Add(BoolVariable("use_volk", "Use the volk library to load the Vulkan loade
 opts.Add(BoolVariable("accesskit", "Use AccessKit C SDK", True))
 opts.Add(("accesskit_sdk_path", "Path to the AccessKit C SDK", ""))
 opts.Add(BoolVariable("sdl", "Enable the SDL3 input driver", True))
-
+opts.Add(BoolVariable("use_breakpad", "Enable Breakpad crash dump creation.", False))
 # Advanced options
 opts.Add(
     BoolVariable(
@@ -556,6 +556,9 @@ if not env["deprecated"]:
 if env["precision"] == "double":
     env.Append(CPPDEFINES=["REAL_T_IS_DOUBLE"])
 
+if env["use_breakpad"]:
+    env.Append(CPPDEFINES=["USE_BREAKPAD"])
+
 # Default num_jobs to local cpu count if not user specified.
 # SCons has a peculiarity where user-specified options won't be overridden
 # by SetOption, so we can rely on this to know if we should use our default.

main/main.cpp

@@ -147,6 +147,10 @@
 #endif // TOOLS_ENABLED && !GDSCRIPT_NO_LSP
 #endif // MODULE_GDSCRIPT_ENABLED
 
+#ifdef USE_BREAKPAD
+#include "modules/breakpad/breakpad.h"
+#endif
+
 /* Static members */
 
 // Singletons
@@ -2093,6 +2097,10 @@ Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_ph
 
 	ResourceUID::get_singleton()->load_from_cache(true); // load UUIDs from cache.
 
+#ifdef USE_BREAKPAD
+report_user_data_dir_usable();
+#endif
+
 	if (ProjectSettings::get_singleton()->has_custom_feature("dedicated_server")) {
 		audio_driver = NULL_AUDIO_DRIVER;
 		display_driver = NULL_DISPLAY_DRIVER;

modules/breakpad/SCsub

@@ -0,0 +1,187 @@
+#!/usr/bin/env python
+
+Import("env")
+Import("env_modules")
+
+env_breakpad = env_modules.Clone()
+
+# Thirdparty source files
+
+thirdparty_obj = []
+
+thirdparty_dir = "#thirdparty/breakpad/"
+
+# TODO: find out when these are needed (if at all)
+dwarf_module = False
+stabs_module = False
+
+# Parts of this build script is based on the previous PR trying to implement this
+# https://github.com/godotengine/godot/pull/22778/files
+
+env_breakpad.Append(
+    CPPDEFINES=[
+        "PUBLIC",
+        "_HAS_EXCEPTIONS=0",
+        "_SILENCE_ALL_CXX17_DEPRECATION_WARNINGS",
+    ]
+)
+
+breakpad_src = [
+    "src/common/convert_UTF.cc",
+    "src/common/md5.cc",
+    "src/common/string_conversion.cc",
+]
+
+if env["platform"] == "linuxbsd":
+    breakpad_src += [
+        "src/client/linux/crash_generation/crash_generation_client.cc",
+        "src/client/linux/crash_generation/crash_generation_server.cc",
+        "src/client/linux/dump_writer_common/thread_info.cc",
+        "src/client/linux/dump_writer_common/ucontext_reader.cc",
+        "src/client/linux/handler/exception_handler.cc",
+        "src/client/linux/handler/minidump_descriptor.cc",
+        "src/client/linux/log/log.cc",
+        "src/client/linux/microdump_writer/microdump_writer.cc",
+        "src/client/linux/minidump_writer/pe_file.cc",
+        "src/client/linux/minidump_writer/linux_core_dumper.cc",
+        "src/client/linux/minidump_writer/linux_dumper.cc",
+        "src/client/linux/minidump_writer/linux_ptrace_dumper.cc",
+        "src/client/linux/minidump_writer/minidump_writer.cc",
+        "src/client/minidump_file_writer.cc",
+        "src/common/language.cc",
+        "src/common/linux/breakpad_getcontext.S",
+        "src/common/linux/crc32.cc",
+        "src/common/linux/elf_core_dump.cc",
+        "src/common/linux/elf_symbols_to_module.cc",
+        "src/common/linux/elfutils.cc",
+        "src/common/linux/file_id.cc",
+        "src/common/linux/guid_creator.cc",
+        "src/common/linux/linux_libc_support.cc",
+        "src/common/linux/memory_mapped_file.cc",
+        "src/common/linux/safe_readlink.cc",
+        "src/common/path_helper.cc",
+    ]
+
+if env["platform"] == "windows":
+    env_breakpad.Append(
+        CPPDEFINES=[
+            "_CRT_SECURE_NO_WARNINGS",
+            "NOMINMAX",
+            "WIN32_LEAN_AND_MEAN",
+            "_UNICODE",
+            "UNICODE",
+        ]
+    )
+
+    breakpad_src += [
+        "src/client/windows/crash_generation/client_info.cc",
+        "src/client/windows/crash_generation/crash_generation_client.cc",
+        "src/client/windows/crash_generation/crash_generation_server.cc",
+        "src/client/windows/crash_generation/minidump_generator.cc",
+        "src/client/windows/handler/exception_handler.cc",
+        "src/common/windows/guid_string.cc",
+        "src/common/windows/pe_source_line_writer.cc",
+        "src/common/windows/string_utils.cc",
+    ]
+
+
+if env["platform"] == "osx" or env["platform"] == "iphone":
+    breakpad_src += [
+        "src/common/simple_string_dictionary.cc",
+    ]
+
+if env["platform"] == "osx":
+    breakpad_src += [
+        "src/client/mac/Framework/Breakpad.mm",
+        "src/client/mac/Framework/OnDemandServer.mm",
+        "src/client/mac/crash_generation/ConfigFile.mm",
+        "src/client/mac/crash_generation/Inspector.mm",
+        "src/client/mac/crash_generation/InspectorMain.mm",
+        "src/client/mac/crash_generation/crash_generation_client.cc",
+        "src/client/mac/crash_generation/crash_generation_server.cc",
+        "src/client/mac/handler/breakpad_nlist_64.cc",
+        "src/client/mac/handler/dynamic_images.cc",
+        "src/client/mac/handler/exception_handler.cc",
+        "src/client/mac/handler/minidump_generator.cc",
+        "src/client/mac/handler/protected_memory_allocator.cc",
+        "src/common/mac/GTMLogger.m",
+        "src/common/mac/HTTPGetRequest.m",
+        "src/common/mac/HTTPPutRequest.m",
+        "src/common/mac/HTTPRequest.m",
+        "src/common/mac/HTTPSimplePostRequest.m",
+        "src/common/mac/MachIPC.mm",
+        "src/common/mac/arch_utilities.cc",
+        "src/common/mac/bootstrap_compat.cc",
+        "src/common/mac/encoding_util.m",
+        "src/common/mac/file_id.cc",
+        "src/common/mac/launch_reporter.cc",
+        "src/common/mac/macho_id.cc",
+        "src/common/mac/macho_reader.cc",
+        "src/common/mac/macho_utilities.cc",
+        "src/common/mac/macho_walker.cc",
+        "src/common/mac/string_utilities.cc",
+    ]
+
+if env["platform"] == "iphone":
+    breakpad_src += [
+        "src/client/ios/Breakpad.mm",
+        "src/client/ios/BreakpadController.mm",
+        "src/client/ios/exception_handler_no_mach.cc",
+        "src/client/ios/handler/ios_exception_minidump_generator.mm",
+        "src/common/long_string_dictionary.cc",
+    ]
+
+# if solaris:
+#     breakpad_src += [
+#         "src/client/solaris/handler/Makefile",
+#         "src/client/solaris/handler/exception_handler.cc",
+#         "src/client/solaris/handler/minidump_generator.cc",
+#         "src/client/solaris/handler/solaris_lwp.cc",
+#         "src/common/solaris/file_id.cc",
+#         "src/common/solaris/guid_creator.cc",
+#     ]
+
+if dwarf_module:
+    breakpad_src += [
+        "src/common/dwarf/bytereader.cc",
+        "src/common/dwarf/cfi_assembler.cc",
+        "src/common/dwarf/dwarf2diehandler.cc",
+        "src/common/dwarf/dwarf2reader.cc",
+        "src/common/dwarf/elf_reader.cc",
+        "src/common/dwarf/functioninfo.cc",
+        "src/common/dwarf_cfi_to_module.cc",
+        "src/common/dwarf_cu_to_module.cc",
+        "src/common/dwarf_line_to_module.cc",
+        "src/common/dwarf_range_list_handler.cc",
+        "src/common/module.cc",
+    ]
+
+if stabs_module:
+    breakpad_src += [
+        "src/common/stabs_reader.cc",
+        "src/common/stabs_to_module.cc",
+    ]
+
+breakpad_src = [thirdparty_dir + file for file in breakpad_src]
+
+env_breakpad.Prepend(CPPPATH=[thirdparty_dir + "src"])
+
+env_thirdparty = env_breakpad.Clone()
+env_thirdparty.disable_warnings()
+env_thirdparty.add_source_files(thirdparty_obj, breakpad_src)
+env.modules_sources += thirdparty_obj
+
+
+# Godot source files
+
+module_obj = []
+
+if env["platform"] == "linuxbsd" or env["platform"] == "windows":
+    env_breakpad.add_source_files(module_obj, ["breakpad_linuxbsd_windows.cpp"])
+else:
+    raise Exception("Breakpad not implemented for selected platform")
+
+env.modules_sources += module_obj
+
+# Needed to force rebuilding the module files when the thirdparty library is updated.
+env.Depends(module_obj, thirdparty_obj)

modules/breakpad/breakpad.h

@@ -0,0 +1,48 @@
+/**************************************************************************/
+/*  breakpad.h                                                            */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#ifndef BREAKPAD_H
+#define BREAKPAD_H
+
+void initialize_breakpad(bool register_handlers);
+void disable_breakpad();
+void report_user_data_dir_usable();
+
+// Due to Mono runtime initialization in release mode overriding signal handlers, Breakpad needs re-initialization after loading it
+void report_mono_loaded_to_breakpad();
+
+// Linux crash handling goes through this
+void breakpad_handle_signal(int sig);
+
+// Windows crash handling goes through this
+// TODO: should Windows header be included here to use an actual type?
+void breakpad_handle_exception_pointers(void *exinfo);
+
+#endif // BREAKPAD_H