Merge pull request #1397 from WebPlatformForEmbedded/pgorszkowski/wpe-2.38/fix_backtrace_generation

[WPE][GTK] Symbolize `StackTrace` using `libbacktrace`

Author: magomez

Source/WTF/wtf/PlatformGTK.cmake

@@ -90,3 +90,9 @@ list(APPEND WTF_SYSTEM_INCLUDE_DIRECTORIES
     ${GIO_UNIX_INCLUDE_DIRS}
     ${GLIB_INCLUDE_DIRS}
 )
+
+if (USE_LIBBACKTRACE)
+    list(APPEND WTF_LIBRARIES
+        LIBBACKTRACE::LIBBACKTRACE
+    )
+endif ()

Source/WTF/wtf/PlatformWPE.cmake

@@ -62,3 +62,9 @@ list(APPEND WTF_SYSTEM_INCLUDE_DIRECTORIES
     ${GIO_UNIX_INCLUDE_DIRS}
     ${GLIB_INCLUDE_DIRS}
 )
+
+if (USE_LIBBACKTRACE)
+    list(APPEND WTF_LIBRARIES
+        LIBBACKTRACE::LIBBACKTRACE
+    )
+endif ()

Source/WTF/wtf/StackTrace.cpp

@@ -30,6 +30,11 @@
 #include <wtf/Assertions.h>
 #include <wtf/PrintStream.h>
 
+#if USE(LIBBACKTRACE)
+#include <string.h>
+#include <wtf/NeverDestroyed.h>
+#endif
+
 #if HAVE(BACKTRACE_SYMBOLS) || HAVE(BACKTRACE)
 #include <execinfo.h>
 #endif
@@ -58,6 +63,55 @@ void WTFGetBacktrace(void** stack, int* size)
 
 namespace WTF {
 
+#if USE(LIBBACKTRACE)
+static struct backtrace_state* backtraceState()
+{
+    static NeverDestroyed<struct backtrace_state*> backtraceState = backtrace_create_state(nullptr, 1, nullptr, nullptr);
+    return backtraceState;
+}
+
+static void backtraceSyminfoCallback(void* data, uintptr_t, const char* symname, uintptr_t, uintptr_t)
+{
+    const char** symbol = static_cast<const char**>(data);
+    *symbol = symname;
+}
+
+static int backtraceFullCallback(void* data, uintptr_t, const char*, int, const char* function)
+{
+    const char** symbol = static_cast<const char**>(data);
+    *symbol = function;
+    return 0;
+}
+
+char** symbolize(void* const* addresses, int size)
+{
+    struct backtrace_state* state = backtraceState();
+    if (!state)
+        return nullptr;
+
+    char** symbols = static_cast<char**>(malloc(sizeof(char*) * size));
+
+    for (int i = 0; i < size; ++i) {
+        uintptr_t pc = reinterpret_cast<uintptr_t>(addresses[i]);
+        char* symbol;
+
+        backtrace_pcinfo(state, pc, backtraceFullCallback, nullptr, &symbol);
+        if (!symbol)
+            backtrace_syminfo(backtraceState(), pc, backtraceSyminfoCallback, nullptr, &symbol);
+
+        if (symbol) {
+            char* demangled = abi::__cxa_demangle(symbol, nullptr, nullptr, nullptr);
+            if (demangled)
+                symbols[i] = demangled;
+            else
+                symbols[i] = strdup(symbol);
+        } else
+            symbols[i] = strdup("???");
+    }
+    return symbols;
+}
+#endif
+
 ALWAYS_INLINE size_t StackTrace::instanceSize(int capacity)
 {
     ASSERT(capacity >= 1);
@@ -110,7 +164,11 @@ auto StackTrace::demangle(void* pc) -> std::optional<DemangleEntry>
 void StackTrace::dump(PrintStream& out, const char* indentString) const
 {
     const auto* stack = this->stack();
-#if HAVE(BACKTRACE_SYMBOLS)
+#if USE(LIBBACKTRACE)
+    char** symbols = symbolize(stack, m_size);
+    if (!symbols)
+        return;
+#elif HAVE(BACKTRACE_SYMBOLS)
     char** symbols = backtrace_symbols(stack, m_size);
     if (!symbols)
         return;
@@ -146,7 +204,11 @@ void StackTrace::dump(PrintStream& out, const char* indentString) const
             out.printf("%s%s%-3d %p\n", m_prefix ? m_prefix : "", indentString, frameNumber, stack[i]);
     }
 
-#if HAVE(BACKTRACE_SYMBOLS)
+#if USE(LIBBACKTRACE)
+    for (int i = 0; i < m_size; ++i)
+        free(symbols[i]);
+    free(symbols);
+#elif HAVE(BACKTRACE_SYMBOLS)
     free(symbols);
 #endif
 }

Source/WTF/wtf/StackTrace.h

@@ -29,10 +29,18 @@
 #include <optional>
 #include <wtf/SystemFree.h>
 
+#if USE(LIBBACKTRACE)
+#include <backtrace.h>
+#endif
+
 namespace WTF {
 
 class PrintStream;
 
+#if USE(LIBBACKTRACE)
+WTF_EXPORT_PRIVATE char** symbolize(void* const*, int);
+#endif
+
 class StackTrace {
     WTF_MAKE_FAST_ALLOCATED;
 public:

Source/cmake/FindLibBacktrace.cmake

@@ -0,0 +1,71 @@
+# - Try to find libbacktrace.
+# Once done, this will define
+#
+#  LIBBACKTRACE_FOUND - libbacktrace was found
+#  LIBBACKTRACE_INCLUDE_DIRS - the libbacktrace include directories
+#  LIBBACKTRACE_LIBRARIES - link these to use libbacktrace.
+#
+# Copyright (C) 2023 Igalia S.L.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1.  Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+# 2.  Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND ITS CONTRIBUTORS ``AS
+# IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR ITS
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+find_package(PkgConfig QUIET)
+pkg_check_modules(PC_LIBBACKTRACE QUIET backtrace)
+set(LIBBACKTRACE_COMPILE_OPTIONS ${PC_LIBBACKTRACE_CFLAGS_OTHER})
+set(LIBBACKTRACE_VERSION ${PC_LIBBACKTRACE_VERSION})
+
+find_path(LIBBACKTRACE_INCLUDE_DIR
+    NAMES backtrace.h
+    HINTS ${PC_LIBBACKTRACE_INCLUDEDIR}
+          ${PC_LIBBACKTRACE_INCLUDE_DIRS}
+)
+
+find_library(LIBBACKTRACE_LIBRARY
+    NAMES backtrace
+    HINTS ${PC_LIBBACKTRACE_LIBDIR}
+          ${PC_LIBBACKTRACE_LIBRARY_DIRS}
+)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(LibBacktrace
+  REQUIRED_VARS LIBBACKTRACE_INCLUDE_DIR LIBBACKTRACE_LIBRARY
+  VERSION_VAR LIBBACKTRACE_VERSION
+)
+
+if (LIBBACKTRACE_LIBRARY AND NOT TARGET LIBBACKTRACE::LIBBACKTRACE)
+    add_library(LIBBACKTRACE::LIBBACKTRACE UNKNOWN IMPORTED GLOBAL)
+    set_target_properties(LIBBACKTRACE::LIBBACKTRACE PROPERTIES
+        IMPORTED_LOCATION "${LIBBACKTRACE_LIBRARY}"
+        INTERFACE_COMPILE_OPTIONS "${LIBBACKTRACE_COMPILE_OPTIONS}"
+        INTERFACE_INCLUDE_DIRECTORIES "${LIBBACKTRACE_INCLUDE_DIR}"
+    )
+endif ()
+
+mark_as_advanced(
+  LIBBACKTRACE_INCLUDE_DIR
+  LIBBACKTRACE_LIBRARY
+)
+
+if (LIBBACKTRACE_FOUND)
+    set(LIBBACKTRACE_LIBRARIES ${LIBBACKTRACE_LIBRARY})
+    set(LIBBACKTRACE_INCLUDE_DIRS ${LIBBACKTRACE_INCLUDE_DIR})
+endif ()

Source/cmake/OptionsGTK.cmake

@@ -68,6 +68,7 @@ WEBKIT_OPTION_DEFINE(USE_AVIF "Whether to enable support for AVIF images." PUBLI
 WEBKIT_OPTION_DEFINE(USE_GTK4 "Whether to enable usage of GTK4 instead of GTK3." PUBLIC OFF)
 WEBKIT_OPTION_DEFINE(USE_JPEGXL "Whether to enable support for JPEG-XL images." PUBLIC ${ENABLE_EXPERIMENTAL_FEATURES})
 WEBKIT_OPTION_DEFINE(USE_LCMS "Whether to enable support for image color management using libcms2." PUBLIC ON)
+WEBKIT_OPTION_DEFINE(USE_LIBBACKTRACE "Whether to enable usage of libbacktrace." PUBLIC OFF)
 WEBKIT_OPTION_DEFINE(USE_LIBHYPHEN "Whether to enable the default automatic hyphenation implementation." PUBLIC ON)
 WEBKIT_OPTION_DEFINE(USE_LIBSECRET "Whether to enable the persistent credential storage using libsecret." PUBLIC ON)
 WEBKIT_OPTION_DEFINE(USE_OPENGL_OR_ES "Whether to use OpenGL or ES." PUBLIC ON)
@@ -476,6 +477,13 @@ if (USE_LCMS)
     endif ()
 endif ()
 
+if (USE_LIBBACKTRACE)
+  find_package(LibBacktrace)
+  if (NOT LIBBACKTRACE_FOUND)
+        message(FATAL_ERROR "libbacktrace is required for USE_LIBBACKTRACE")
+    endif ()
+endif ()
+
 # Override the cached variable, gtk-doc does not really work when building on Mac.
 if (APPLE)
     set(ENABLE_GTKDOC OFF)

Source/cmake/OptionsWPE.cmake

@@ -95,6 +95,7 @@ WEBKIT_OPTION_DEFINE(ENABLE_WPE_QT_API "Whether to enable support for the Qt5/QM
 WEBKIT_OPTION_DEFINE(USE_AVIF "Whether to enable support for AVIF images." PUBLIC ${ENABLE_EXPERIMENTAL_FEATURES})
 WEBKIT_OPTION_DEFINE(USE_JPEGXL "Whether to enable support for JPEG-XL images." PUBLIC ${ENABLE_EXPERIMENTAL_FEATURES})
 WEBKIT_OPTION_DEFINE(USE_LCMS "Whether to enable support for image color management using libcms2." PUBLIC ON)
+WEBKIT_OPTION_DEFINE(USE_LIBBACKTRACE "Whether to enable usage of libbacktrace." PUBLIC OFF)
 WEBKIT_OPTION_DEFINE(USE_OPENJPEG "Whether to enable support for JPEG2000 images." PUBLIC ON)
 WEBKIT_OPTION_DEFINE(USE_SOUP2 "Whether to enable usage of Soup 2 instead of Soup 3." PUBLIC OFF)
 WEBKIT_OPTION_DEFINE(USE_WOFF2 "Whether to enable support for WOFF2 Web Fonts." PUBLIC ON)
@@ -366,6 +367,13 @@ SET_AND_EXPOSE_TO_BUILD(USE_COORDINATED_GRAPHICS TRUE)
 SET_AND_EXPOSE_TO_BUILD(USE_NICOSIA TRUE)
 SET_AND_EXPOSE_TO_BUILD(HAVE_OS_DARK_MODE_SUPPORT 1)
 
+if (USE_LIBBACKTRACE)
+  find_package(LibBacktrace)
+  if (NOT LIBBACKTRACE_FOUND)
+        message(FATAL_ERROR "libbacktrace is required for USE_LIBBACKTRACE")
+    endif ()
+endif ()
+
 # GUri is available in GLib since version 2.66, but we only want to use it if version is >= 2.67.1.
 if (PC_GLIB_VERSION VERSION_GREATER "2.67.1" OR PC_GLIB_VERSION STREQUAL "2.67.1")
     SET_AND_EXPOSE_TO_BUILD(HAVE_GURI 1)
@@ -427,3 +435,9 @@ if (COMPILER_IS_GCC_OR_CLANG AND UNIX AND NOT APPLE)
     set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}${CMAKE_COMPILER_SIZE_OPT_FLAGS} -ffunction-sections -fdata-sections -fno-rtti")
     set(CMAKE_SHARED_LINKER_FLAGS_DEBUG "${CMAKE_SHARED_LINKER_FLAGS_DEBUG} -Wl,--gc-sections")
 endif ()
+
+if (USE_LIBBACKTRACE)
+    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}${CMAKE_COMPILER_SIZE_OPT_FLAGS} -funwind-tables")
+
+    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}${CMAKE_COMPILER_SIZE_OPT_FLAGS} -funwind-tables")
+endif ()