Move system signal related functions to its own file

And revise "signal safe print" function. PR #16953.
2025-12-17 06:01:33 -06:00 · 2022-05-01 12:32:51 +08:00
parent 7b608fd0c9
commit 64d8db0c93
5 changed files with 193 additions and 110 deletions
--- a/src/app/signalhandler.cpp
+++ b/src/app/signalhandler.cpp
@@ -0,0 +1,141 @@
+/*
+ * Bittorrent Client using Qt and libtorrent.
+ * Copyright (C) 2022  Mike Tzou (Chocobo1)
+ * Copyright (C) 2014  Vladimir Golovnev <glassez@yandex.ru>
+ * Copyright (C) 2006  Christophe Dumez <chris@qbittorrent.org>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * In addition, as a special exception, the copyright holders give permission to
+ * link this program with the OpenSSL project's "OpenSSL" library (or with
+ * modified versions of it that use the same license as the "OpenSSL" library),
+ * and distribute the linked executables. You must obey the GNU General Public
+ * License in all respects for all of the code used other than "OpenSSL".  If you
+ * modify file(s), you may extend this exception to your version of the file(s),
+ * but you are not obligated to do so. If you do not wish to do so, delete this
+ * exception statement from your version.
+ */
+
+#include "signalhandler.h"
+
+#include <QtGlobal>
+
+#include <algorithm>
+#include <csignal>
+#include <tuple>
+
+#ifndef Q_OS_WIN
+#ifndef Q_OS_HAIKU
+#include <unistd.h>
+#endif
+#elif defined DISABLE_GUI
+#include <io.h>
+#endif
+
+#include <QCoreApplication>
+
+#include "base/version.h"
+
+#ifdef STACKTRACE
+#ifdef Q_OS_UNIX
+#include "stacktrace.h"
+#else
+#include "stacktrace_win.h"
+#ifndef DISABLE_GUI
+#include "stacktracedialog.h"
+#endif // DISABLE_GUI
+#endif // Q_OS_UNIX
+#endif //STACKTRACE
+
+namespace
+{
+    // sys_signame[] is only defined in BSD
+    const char *const sysSigName[] =
+    {
+#ifdef Q_OS_WIN
+        "", "", "SIGINT", "", "SIGILL", "", "SIGABRT_COMPAT", "", "SIGFPE", "",
+        "", "SIGSEGV", "", "", "", "SIGTERM", "", "", "", "",
+        "", "SIGBREAK", "SIGABRT", "", "", "", "", "", "", "",
+        "", ""
+#else
+        "", "SIGHUP", "SIGINT", "SIGQUIT", "SIGILL", "SIGTRAP", "SIGABRT", "SIGBUS", "SIGFPE", "SIGKILL",
+        "SIGUSR1", "SIGSEGV", "SIGUSR2", "SIGPIPE", "SIGALRM", "SIGTERM", "SIGSTKFLT", "SIGCHLD", "SIGCONT", "SIGSTOP",
+        "SIGTSTP", "SIGTTIN", "SIGTTOU", "SIGURG", "SIGXCPU", "SIGXFSZ", "SIGVTALRM", "SIGPROF", "SIGWINCH", "SIGIO",
+        "SIGPWR", "SIGUNUSED"
+#endif
+    };
+
+#if !(defined Q_OS_WIN && !defined DISABLE_GUI) && !defined Q_OS_HAIKU
+    void safePrint(const char *str)
+    {
+        const size_t strLen = strlen(str);
+#ifdef Q_OS_WIN
+        if (_write(_fileno(stderr), str, strLen) < static_cast<int>(strLen))
+            std::ignore = _write(_fileno(stdout), str, strLen);
+#else
+        if (write(STDERR_FILENO, str, strLen) < static_cast<ssize_t>(strLen))
+            std::ignore = write(STDOUT_FILENO, str, strLen);
+#endif
+    }
+#endif
+
+    void normalExitHandler(const int signum)
+    {
+#if !(defined Q_OS_WIN && !defined DISABLE_GUI) && !defined Q_OS_HAIKU
+        const char *msgs[] = {"Catching signal: ", sysSigName[signum], "\nExiting cleanly\n"};
+        std::for_each(std::begin(msgs), std::end(msgs), safePrint);
+#endif // !defined Q_OS_WIN && !defined Q_OS_HAIKU
+        signal(signum, SIG_DFL);
+        QCoreApplication::exit();  // unsafe, but exit anyway
+    }
+
+#ifdef STACKTRACE
+    void abnormalExitHandler(const int signum)
+    {
+        const char *sigName = sysSigName[signum];
+
+#if !(defined Q_OS_WIN && !defined DISABLE_GUI) && !defined Q_OS_HAIKU
+        const char msg[] = "\n\n*************************************************************\n"
+            "Please file a bug report at http://bug.qbittorrent.org and provide the following information:\n\n"
+            "qBittorrent version: " QBT_VERSION "\n\n"
+            "Caught signal: ";
+        const char *msgs[] = {msg, sigName, "\n"};
+        std::for_each(std::begin(msgs), std::end(msgs), safePrint);
+#if !defined Q_OS_WIN
+        print_stacktrace();  // unsafe
+#endif
+#endif
+
+#if defined Q_OS_WIN && !defined DISABLE_GUI
+        StacktraceDialog dlg;  // unsafe
+        dlg.setStacktraceString(QString::fromLatin1(sigName), straceWin::getBacktrace());
+        dlg.exec();
+#endif
+
+        signal(signum, SIG_DFL);
+        raise(signum);
+    }
+#endif // STACKTRACE
+}
+
+void registerSignalHandlers()
+{
+    signal(SIGINT, normalExitHandler);
+    signal(SIGTERM, normalExitHandler);
+#ifdef STACKTRACE
+    signal(SIGABRT, abnormalExitHandler);
+    signal(SIGSEGV, abnormalExitHandler);
+#endif
+}