Changeset 0d2cd10

Timestamp:

2018-03-26T16:48:32Z (7 years ago)

Author:

dequis <dx@…>

Branches:

master

Children:

230f6f1

Parents:

e1e5bd6

git-author:

dequis <dx@…> (26-03-18 16:26:56)

git-committer:

dequis <dx@…> (26-03-18 16:48:32)

Message:

Write backtrace to /var/lib/bitlbee/crash.log on SIGSEGV

Async-signal-safe code is very restricted (nothing that may call malloc
indirectly), so this code tries its best to show meaningful stuff, but
the output is still fairly raw. The contents of the log file are:

• BITLBEE_VERSION, BITLBEE_CONFIGURE_ARGS
• Backtrace as generated by backtrace()/backtrace_symbols_fd()
• A small help text explaining how to get more useful symbol names
• Memory maps (/proc/self/maps), which also mentions loaded plugins

The backtrace() function is a GNU extension, /proc/ is a linux thing.
Non-glibc platforms (such as musl) won't show anything, non-linux
platforms will skip the memory maps when /proc/self/maps fails to open.

I'd like to include timestamps, but I can't find a safe way to format
them. Even turning raw unix timestamps to strings is hard. Fun stuff.

I used the config directory because it's the only place we can be sure
we can write to. The filename is hardcoded for the same reason there are
no timestamps.

Files:

• configure (modified) (3 diffs)
• unix.c (modified) (6 diffs)

configure

@@ -485 +485 @@
 '
 
+BACKTRACE_TESTCODE='
+#include <execinfo.h>
+
+int main()
+{
+        void *trace[16];
+        return backtrace(trace, 16);
+}
+'
+
 detect_resolv_dynamic()
 {
@@ -582 +592 @@
 }
 
+detect_backtrace()
+{
+        TMPFILE=$(mktemp /tmp/bitlbee-configure.XXXXXX)
+        ret=1
+        echo "$BACKTRACE_TESTCODE" | $CC -o $TMPFILE -x c -  >/dev/null 2>/dev/null
+        if [ "$?" = "0" ]; then
+                ret=0
+        fi
+
+        rm -f $TMPFILE
+        return $ret
+}
+
 if [ "$ssl" = "auto" ]; then
         detect_gnutls
@@ -647 +670 @@
 fi
 
+if detect_backtrace; then
+        echo '#define HAVE_BACKTRACE' >> config.h
+        echo '#define CRASHFILE "'$config'crash.log"' >> config.h
+fi
 
 STORAGES="xml"

unix.c

@@ -46 +46 @@
 #endif
 
+#ifdef HAVE_BACKTRACE
+#include <execinfo.h>
+#endif
+
 global_t global;        /* Against global namespace pollution */
 
@@ -63 +67 @@
         char *old_cwd = NULL;
         struct sigaction sig, old;
+#ifdef HAVE_BACKTRACE
+        void *unused[1];
+#endif
 
         /* Required to make iconv to ASCII//TRANSLIT work. This makes BitlBee
@@ -175 +182 @@
         sigaction(SIGINT, &sig, &old);
         sigaction(SIGTERM, &sig, &old);
+
+#ifdef HAVE_BACKTRACE
+        /* As per the backtrace(3) man page, call this outside of the signal
+         * handler once to ensure any dynamic libraries are loaded in an
+         * async-signal-safe environment to prevent deadlocks */
+        backtrace(unused, 1);
+#endif
 
         if (!getuid() || !geteuid()) {
@@ -292 +306 @@
 }
 
+#ifdef HAVE_BACKTRACE
+/* Writes a backtrace to (usually) /var/lib/bitlbee/crash.log
+ * No malloc allowed means not a lot can be written to that file */
+static void sighandler_crash_backtrace()
+{
+        int fd, mapsfd;
+        int size;
+        void *trace[128];
+        const char message[] = "## " PACKAGE " crashed\n"
+                "## Version: " BITLBEE_VERSION "\n"
+                "## Configure args: " BITLBEE_CONFIGURE_ARGS "\n"
+                "##\n"
+                "## Backtrace:\n\n";
+        const char message2[] = "\n"
+                "## Hint: To get details on addresses use\n"
+                "##   addr2line -e <binary> <address>\n"
+                "## or\n"
+                "##   gdb <binary> -ex 'l *<address>' -ex q\n"
+                "## where <binary> is a filename from above and <address> is the part between (...)\n"
+                "##\n\n";
+        const char message3[] = "\n## End of memory maps. See above for the backtrace\n\n";
+
+        fd = open(CRASHFILE, O_WRONLY | O_APPEND | O_CREAT, 0600);
+
+        if (fd == -1 || write(fd, message, sizeof(message) - 1) == -1) {
+                return;
+        }
+
+        size = backtrace(trace, 128);
+        backtrace_symbols_fd(trace, size, fd);
+
+        (void) write(fd, message2, sizeof(message2) - 1);
+
+        /* a bit too linux-specific, so fail gracefully */
+        mapsfd = open("/proc/self/maps", O_RDONLY, 0);
+
+        if (mapsfd != -1) {
+                char buf[4096] = {0};
+                ssize_t bytes;
+
+                while ((bytes = read(mapsfd, buf, sizeof(buf))) > 0) {
+                        (void) write(fd, buf, bytes);
+                }
+                (void) close(mapsfd);
+                (void) write(fd, message3, sizeof(message3) - 1);
+        }
+
+        (void) close(fd);
+}
+#endif
+
 /* Signal handler for SIGSEGV
  * A desperate attempt to tell the user that everything is wrong in the world.
@@ -298 +363 @@
 {
         GSList *l;
-        int unused G_GNUC_UNUSED;
-        const char *message = "ERROR :BitlBee crashed! (SIGSEGV received)\r\n";
-        int len = strlen(message);
+        const char message[] = "ERROR :BitlBee crashed! (SIGSEGV received)\r\n"
+#ifdef HAVE_BACKTRACE
+                "ERROR :Writing backtrace to " CRASHFILE "\r\n"
+#endif
+                "ERROR :This is a bug either in BitlBee or a plugin, ask us on IRC if unsure\r\n";
 
         for (l = irc_connection_list; l; l = l->next) {
@@ -306 +373 @@
                 sock_make_blocking(irc->fd);
                 if (irc->sendbuffer) {
-                        unused = write(irc->fd, irc->sendbuffer, strlen(irc->sendbuffer));
-                }
-                unused = write(irc->fd, message, len);
-        }
+                        (void) write(irc->fd, irc->sendbuffer, strlen(irc->sendbuffer));
+                }
+                (void) write(irc->fd, message, sizeof(message) - 1);
+        }
+
+#ifdef HAVE_BACKTRACE
+        sighandler_crash_backtrace();
+#endif
 
         raise(signal);