Enable boost stacktrace backtrace

Author: kyechou

.gitmodules

@@ -9,6 +9,7 @@
 [submodule "vcpkg"]
 	path = depends/vcpkg
 	url = https://github.com/microsoft/vcpkg.git
+	ignore = dirty
 [submodule "libnet"]
 	path = third_party/libnet/libnet
 	url = https://github.com/libnet/libnet.git

CMakeLists.txt

@@ -63,7 +63,7 @@ add_subdirectory(third_party/bpftool EXCLUDE_FROM_ALL)
 add_subdirectory(third_party/libbpf EXCLUDE_FROM_ALL)
 add_subdirectory(third_party/libnet EXCLUDE_FROM_ALL)
 find_package(boost_program_options CONFIG REQUIRED)
-find_package(boost_stacktrace_addr2line CONFIG REQUIRED)
+find_package(boost_stacktrace_backtrace CONFIG REQUIRED)
 find_package(boost_stacktrace_basic CONFIG REQUIRED)
 find_package(boost_stacktrace_noop CONFIG REQUIRED)
 find_package(BpfObject REQUIRED)
@@ -80,10 +80,14 @@ find_package(ZLIB REQUIRED) # required by `FindBpfObject.cmake`
 
 #
 # stacktrace
+# https://www.boost.org/doc/libs/master/doc/html/stacktrace/configuration_and_build.html
 #
 add_library(stacktrace_config INTERFACE)
+target_compile_definitions(stacktrace_config INTERFACE BOOST_STACKTRACE_LINK)
 if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
-    target_link_libraries(stacktrace_config INTERFACE Boost::stacktrace_addr2line dl)
+    # libbacktrace is already linked statically with Boost::stacktrace_backtrace
+    # through our patched vcpkg, so `-lbacktrace` is not needed.
+    target_link_libraries(stacktrace_config INTERFACE Boost::stacktrace_backtrace dl)
 else()
     target_link_libraries(stacktrace_config INTERFACE Boost::stacktrace_noop)
 endif()

depends/vcpkg.json

@@ -12,18 +12,14 @@
         {
             "name": "curl",
             "features": [
-                "brotli",
                 "c-ares",
-                "gssapi",
                 "http2",
                 "idn",
                 "idn2",
-                "ldap",
                 "openssl",
                 "psl",
                 "ssh",
-                "ssl",
-                "zstd"
+                "ssl"
             ]
         },
         "pcapplusplus",

depends/vcpkg.patch

@@ -0,0 +1,72 @@
+diff --git a/ports/boost-stacktrace/features.cmake b/ports/boost-stacktrace/features.cmake
+index 3491066c4..9d4e1c242 100644
+--- a/ports/boost-stacktrace/features.cmake
++++ b/ports/boost-stacktrace/features.cmake
+@@ -23,7 +23,7 @@
+     # When ON, builds the boost_stacktrace_windbg_cached library variant. Defaults to ON under Windows when WinDbg support is autodetected and when thread_local is supported, otherwise OFF.
+ 
+ list(APPEND FEATURE_OPTIONS 
+-  -DBOOST_STACKTRACE_ENABLE_BACKTRACE=OFF 
++  -DBOOST_STACKTRACE_ENABLE_BACKTRACE=ON 
+   )
+ 
+ if(VCPKG_TARGET_IS_WINDOWS)
+@@ -34,4 +34,4 @@ else()
+   list(APPEND FEATURE_OPTIONS 
+    -DBOOST_STACKTRACE_ENABLE_WINDBG=OFF
+   )
+-endif()
+\ No newline at end of file
++endif()
+diff --git a/ports/boost-stacktrace/fix_backtrace.diff b/ports/boost-stacktrace/fix_backtrace.diff
+new file mode 100644
+index 000000000..cb73ddb23
+--- /dev/null
++++ b/ports/boost-stacktrace/fix_backtrace.diff
+@@ -0,0 +1,22 @@
++diff --git a/CMakeLists.txt b/CMakeLists.txt
++index 4638618..6825856 100644
++--- a/CMakeLists.txt
+++++ b/CMakeLists.txt
++@@ -61,7 +61,7 @@ function(stacktrace_check var source incs libs defs)
++ 
++ endfunction()
++ 
++-stacktrace_check(BOOST_STACKTRACE_HAS_BACKTRACE has_backtrace.cpp "" "backtrace" "")
+++stacktrace_check(BOOST_STACKTRACE_HAS_BACKTRACE has_backtrace.cpp "" "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/libbacktrace.a" "")
++ 
++ set(_default_addr2line ON)
++ if(WIN32 AND NOT CMAKE_CXX_PLATFORM_ID MATCHES "Cygwin")
++@@ -90,7 +90,7 @@ message(STATUS "Boost.Stacktrace: "
++ )
++ 
++ stacktrace_add_library(noop ${BOOST_STACKTRACE_ENABLE_NOOP} "" "")
++-stacktrace_add_library(backtrace ${BOOST_STACKTRACE_ENABLE_BACKTRACE} "backtrace" "")
+++stacktrace_add_library(backtrace ${BOOST_STACKTRACE_ENABLE_BACKTRACE} "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/libbacktrace.a" "")
++ stacktrace_add_library(addr2line ${BOOST_STACKTRACE_ENABLE_ADDR2LINE} "" "")
++ stacktrace_add_library(basic ${BOOST_STACKTRACE_ENABLE_BASIC} "" "")
++ stacktrace_add_library(windbg ${BOOST_STACKTRACE_ENABLE_WINDBG} "dbgeng;ole32" "_GNU_SOURCE=1")
+diff --git a/ports/boost-stacktrace/portfile.cmake b/ports/boost-stacktrace/portfile.cmake
+index cd2a782af..ccd630570 100644
+--- a/ports/boost-stacktrace/portfile.cmake
++++ b/ports/boost-stacktrace/portfile.cmake
+@@ -8,6 +8,7 @@ vcpkg_from_github(
+     HEAD_REF master
+     PATCHES
+         fix_config-check.diff
++        fix_backtrace.diff
+ )
+ 
+ set(FEATURE_OPTIONS "")
+diff --git a/ports/boost-stacktrace/vcpkg.json b/ports/boost-stacktrace/vcpkg.json
+index e734e9917..e9533afbc 100644
+--- a/ports/boost-stacktrace/vcpkg.json
++++ b/ports/boost-stacktrace/vcpkg.json
+@@ -8,6 +8,7 @@
+   "license": "BSL-1.0",
+   "supports": "!uwp",
+   "dependencies": [
++    "libbacktrace",
+     {
+       "name": "boost-assert",
+       "version>=": "1.85.0"

scripts/configure.sh

@@ -81,11 +81,21 @@ reset_files() {
     git -C "$PROJECT_DIR" submodule update --init --recursive
     for submod in "${in_tree_submods[@]}"; do
         msg "Cleaning $submod"
+        git -C "$submod" restore .
         git -C "$submod" clean -xdf
     done
+
     msg "Removing $BUILD_DIR"
     rm -rf "$BUILD_DIR"
 
+    msg "Patching vcpkg"
+    git -C "$PROJECT_DIR/depends/vcpkg" restore .
+    local out
+    out="$(patch -d "$PROJECT_DIR/depends/vcpkg" -Np1 \
+        -i "$PROJECT_DIR/depends/vcpkg.patch")" ||
+        echo "$out" | grep -q 'Skipping patch' ||
+        die "$out"
+
     if [[ $CLEAN -ne 0 ]]; then
         exit 0
     fi

src/logger.cpp

@@ -15,7 +15,6 @@
 #define LOG_PATTERN "[%E.%f] [%P] [%^%L%L%$] %v"
 
 using namespace std;
-namespace st = boost::stacktrace;
 
 Logger logger; // global logger
 
@@ -101,11 +100,11 @@ void Logger::warn(const string &msg) {
 }
 
 void Logger::error(const string &msg) {
-    auto trace            = st::stacktrace();
+    auto trace            = boost::stacktrace::stacktrace();
     string msg_with_trace = msg;
 
     if (!trace.empty()) {
-        msg_with_trace += "\n" + st::to_string(trace);
+        msg_with_trace += "\n" + boost::stacktrace::to_string(trace);
     }
 
     if (this->_stdout_logger) {