Add stacktrace (#674)

Related to #659 Adds backtrace printing to SIGSEGV signal handling. Tries to print file and line number with libbacktrace, falls back to using standard backtrace when debug info is unavailable. Before: <img width="715" alt="Screenshot 2024-07-11 at 15 58 52" src="https://github.com/urbit/vere/assets/22086553/3ba89d96-c50c-40a5-8fd4-f6e636b8aec3"> After (with dsyms): <img width="715" alt="Screenshot 2024-07-24 at 17 11 56" src="https://github.com/user-attachments/assets/b333516f-c36f-48ce-afd2-95de9f812843"> After (without dsyms): <img width="715" alt="Screenshot 2024-07-24 at 17 14 31" src="https://github.com/user-attachments/assets/59956429-2fc7-478e-a05d-1807db21b18f">
urbit · Sep 16, 2024 · 3761ed0 · 3761ed0
2 parents 5fcf117 + df8e34e
commit 3761ed0
Show file tree

Hide file tree

Showing 14 changed files with 301 additions and 29 deletions.
diff --git a/.github/workflows/shared.yml b/.github/workflows/shared.yml
@@ -56,6 +56,33 @@ jobs:
       #
       - uses: actions/checkout@v3
 
+      - name: Set swap space
+        if: ${{ matrix.target == 'linux-x86_64' || matrix.target == 'linux-aarch64'}}
+        run: |
+          echo "Memory and swap:"
+          free -h
+          echo
+          swapon --show
+          echo
+
+          export SWAP_FILE=$(swapon --show=NAME | tail -n 1)
+          if test -z "${SWAP_FILE}"; then
+              export SWAP_FILE=/swapfile
+          else
+              sudo swapoff -a
+              sudo rm "${SWAP_FILE}"
+          fi
+          sudo fallocate -l 10G "${SWAP_FILE}"
+          sudo chmod 600 "${SWAP_FILE}"
+          sudo mkswap "${SWAP_FILE}"
+          sudo swapon "${SWAP_FILE}"
+
+          echo "Memory and swap:"
+          free -h
+          echo
+          swapon --show
+          echo
+
       - name: chown /usr/local
         if: ${{ matrix.target == 'linux-x86_64' || matrix.target == 'linux-aarch64'}}
         run: |
@@ -64,7 +91,7 @@ jobs:
       - name: Set up build cache
         uses: actions/cache@v3
         with:
-          key: ${{ matrix.target }}-cache
+          key: ${{ matrix.target }}-cache-1
           path: |
             # # Cache bazel path on Linux.
             ~/.cache/bazel/_bazel_$(whoami)

diff --git a/BUILD.bazel b/BUILD.bazel
@@ -84,8 +84,8 @@ string_flag(
 # Version flag for gcc.
 string_flag(
     name = "gcc_version",
-    # musl-cross-make uses `gcc-9.4.0` by default.
-    build_setting_default = "9.4.0",
+    # musl-cross-make uses `gcc-11.4.0` by default.
+    build_setting_default = "11.4.0",
     visibility = ["//visibility:public"],
 )
 

diff --git a/WORKSPACE.bazel b/WORKSPACE.bazel
@@ -233,6 +233,24 @@ versioned_http_file(
     version = "255fb1ca8206072f1d09425f0db61ecfe7ff5b17",
 )
 
+versioned_http_archive(
+    name = "libbacktrace",
+    build_file = "//bazel/third_party/libbacktrace:libbacktrace.BUILD",
+    sha256 = "609c17352ec38eaf5ff6618fcbfb38cd8fa0e94a15a0d9aa259df514bbf47fcd",
+    url = "https://github.com/ianlancetaylor/libbacktrace/archive/{version}.tar.gz",
+    strip_prefix = "libbacktrace-{version}",
+    version = "4ead348bb45f753121ca0bd44170ff8352d4c514",
+)
+
+versioned_http_archive(
+    name = "libunwind",
+    build_file = "//bazel/third_party/libunwind:libunwind.BUILD",
+    sha256 = "ddf0e32dd5fafe5283198d37e4bf9decf7ba1770b6e7e006c33e6df79e6a6157",
+    url = "https://github.com/libunwind/libunwind/releases/download/v1.8.1/libunwind-1.8.1.tar.gz",
+    strip_prefix = "libunwind-{version}",
+    version = "1.8.1",
+)
+
 versioned_http_archive(
     name = "lmdb",
     build_file = "//bazel/third_party/lmdb:lmdb.BUILD",

diff --git a/bazel/common_settings.bzl b/bazel/common_settings.bzl
@@ -13,20 +13,14 @@ string_flag = rule(
 
 def vere_library(copts = [], linkopts = [], **kwargs):
   native.cc_library(
-    copts = copts + select({
+    copts = copts + [
+        "-fno-omit-frame-pointer",
+    ] + select({
         "//:debug": ["-O0", "-g3", "-DC3DBG", "-fdebug-compilation-dir=."],
-        "//conditions:default": ["-O3"]
+        "//conditions:default": ["-O3", "-g"]
     }) + select({
         "//:lto": ['-flto'],
-        "//:thinlto": ['-flto=thin'],
         "//conditions:default": []
-    }) + select({
-        # Don't include source level debug info on macOS. See
-        # https://github.com/urbit/urbit/issues/5561 and
-        # https://github.com/urbit/vere/issues/131.
-        "//:debug": [],
-        "@platforms//os:linux": ["-g"],
-        "//conditions:default": [],
     }),
     linkopts = linkopts + ['-g'] + select({
         "//:lto": ['-flto'],
@@ -38,17 +32,14 @@ def vere_library(copts = [], linkopts = [], **kwargs):
 
 def vere_binary(copts = [], linkopts = [], **kwargs):
   native.cc_binary(
-    copts = copts + select({
+    copts = copts + [
+        "-fno-omit-frame-pointer",
+    ] + select({
         "//:debug": ["-O0", "-g3", "-DC3DBG", "-fdebug-compilation-dir=."],
-        "//conditions:default": ["-O3"]
+        "//conditions:default": ["-O3", "-g"]
     }) + select({
         "//:lto": ['-flto'],
-        "//:thinlto": ['-flto=thin'],
         "//conditions:default": []
-    }) + select({
-        "//:debug": [],
-        "@platforms//os:linux": ["-g"],
-        "//conditions:default": [],
     }),
     linkopts = linkopts + ['-g'] + select({
         "//:lto": ['-flto'],

diff --git a/bazel/third_party/expat/expat.BUILD b/bazel/third_party/expat/expat.BUILD
@@ -11,6 +11,12 @@ configure_make(
         "@platforms//os:macos": ["--jobs=`sysctl -n hw.logicalcpu`"],
         "//conditions:default": ["--jobs=`nproc`"],
     }),
+    configure_options = [
+    ] + select({
+        "@//:linux_aarch64": ["--host=aarch64-linux-musl"],
+        "@//:linux_x86_64": ["--host=x86_64-linux-musl"],
+        "//conditions:default": [],
+    }),
     copts = ["-O3"],
     lib_source = ":all",
     out_static_libs = ["libexpat.a"],

diff --git a/bazel/third_party/libbacktrace/BUILD.bazel b/bazel/third_party/libbacktrace/BUILD.bazel
diff --git a/bazel/third_party/libbacktrace/libbacktrace.BUILD b/bazel/third_party/libbacktrace/libbacktrace.BUILD
@@ -0,0 +1,25 @@
+load("@rules_foreign_cc//foreign_cc:defs.bzl", "configure_make")
+
+filegroup(
+    name = "all",
+    srcs = glob(["**"]),
+)
+
+configure_make(
+    name = "libbacktrace",
+    args = [
+    ] + select({
+        "@platforms//os:macos": ["--jobs=`sysctl -n hw.logicalcpu`"],
+        "//conditions:default": ["--jobs=`nproc`"],
+    }),
+    configure_options = [
+    ] + select({
+        "@//:linux_aarch64": ["--host=aarch64-linux-musl"],
+        "@//:linux_x86_64": ["--host=x86_64-linux-musl"],
+        "//conditions:default": [],
+    }),
+    copts = ["-O3"],
+    lib_source = ":all",
+    out_static_libs = ["libbacktrace.a"],
+    visibility = ["//visibility:public"],
+)
diff --git a/bazel/third_party/libunwind/BUILD.bazel b/bazel/third_party/libunwind/BUILD.bazel
diff --git a/bazel/third_party/libunwind/libunwind.BUILD b/bazel/third_party/libunwind/libunwind.BUILD
@@ -0,0 +1,25 @@
+load("@rules_foreign_cc//foreign_cc:defs.bzl", "configure_make")
+
+filegroup(
+    name = "all",
+    srcs = glob(["**"]),
+)
+
+configure_make(
+    name = "libunwind",
+    args = select({
+        "@platforms//os:macos": ["--jobs=`sysctl -n hw.logicalcpu`"],
+        "//conditions:default": ["--jobs=`nproc`"],
+    }),
+    configure_options = [
+        "--enable-debug-frame",
+    ] + select({
+        "@//:linux_aarch64": ["--host=aarch64-linux-musl"],
+        "@//:linux_x86_64": ["--host=x86_64-linux-musl"],
+        "//conditions:default": [],
+    }),
+    copts = ["-O3 -g"],
+    lib_source = ":all",
+    out_static_libs = ["libunwind.a"],
+    visibility = ["//visibility:public"],
+)
diff --git a/bazel/third_party/urcrypt/urcrypt.BUILD b/bazel/third_party/urcrypt/urcrypt.BUILD
@@ -15,7 +15,7 @@ configure_make(
     copts = [
         "-Wall",
         "-g",
-        "-O3",
+        "-O2",
     ],
     deps = [
         "@aes_siv",

diff --git a/bazel/toolchain/BUILD.bazel b/bazel/toolchain/BUILD.bazel
@@ -335,9 +335,9 @@ toolchain(
 # so introduces a circular dependency during Bazel C/C++ toolchain resolution.
 
 # musl-cross-make builds musl-libc-compatible gcc toolchains from source.
-_musl_cross_make_version = "fe915821b652a7fa37b34a596f47d8e20bc72338"
+_musl_cross_make_version = "99f2cbc7e230f72bde3394be3ebd50497cb53e89"
 
-_musl_cross_make_archive = "https://github.com/richfelker/musl-cross-make/archive/{}.tar.gz".format(_musl_cross_make_version)
+_musl_cross_make_archive = "https://github.com/ripperi/musl-cross-make/archive/{}.tar.gz".format(_musl_cross_make_version)
 
 genrule(
     name = "install-aarch64-linux-musl-gcc",
@@ -349,6 +349,8 @@ genrule(
     echo '    tar -xf {}.tar.gz'                                                    >> $@
     echo '    archive=musl-cross-make-{}'                                           >> $@
     echo '    echo OUTPUT=$$aarch64_linux_musl_install > $$archive/config.mak'      >> $@
+    echo '    echo GCC_VER=11.4.0 >> $$archive/config.mak'                          >> $@
+    echo '    echo MUSL_VER=1.2.5 >> $$archive/config.mak'                          >> $@
     echo '    TARGET=aarch64-linux-musl make -s -C$$archive -j`nproc`'              >> $@
     echo '    sudo TARGET=aarch64-linux-musl make -s -C$$archive -j`nproc` install' >> $@
     echo '    sudo chown --recursive $$USER $$aarch64_linux_musl_install'           >> $@
@@ -382,6 +384,8 @@ genrule(
     echo '    tar -xf {}.tar.gz'                                                   >> $@
     echo '    archive=musl-cross-make-{}'                                          >> $@
     echo '    echo OUTPUT=$$x86_64_linux_musl_install > $$archive/config.mak'      >> $@
+    echo '    echo GCC_VER=11.4.0 >> $$archive/config.mak'                         >> $@
+    echo '    echo MUSL_VER=1.2.5 >> $$archive/config.mak'                         >> $@
     echo '    TARGET=x86_64-linux-musl make -s -C$$archive -j`nproc`'              >> $@
     echo '    sudo TARGET=x86_64-linux-musl make -s -C$$archive -j`nproc` install' >> $@
     echo '    sudo chown --recursive $$USER $$x86_64_linux_musl_install'           >> $@

diff --git a/pkg/noun/BUILD.bazel b/pkg/noun/BUILD.bazel
@@ -34,15 +34,20 @@ vere_library(
         "//pkg/ent",
         "//pkg/ur",
         "@gmp",
+        "@libbacktrace",
         "@murmur3",
         "@openssl",
         "@pdjson",
         "@sigsegv",
         "@softfloat",
         "@urcrypt",
+        "@whereami",
     ] + select({
         "@platforms//os:macos": ["//pkg/noun/platform/darwin"],
-        "@platforms//os:linux": ["//pkg/noun/platform/linux"],
+        "@platforms//os:linux": [
+            "//pkg/noun/platform/linux",
+            "@libunwind",
+        ],
         "//conditions:default": [],
     }),
 )