From cc45cc3163304f661e1f1d11255dd522f38030a2 Mon Sep 17 00:00:00 2001
From: Kelebek1 <eeeedddccc@hotmail.co.uk>
Date: Sun, 31 Dec 2023 17:22:12 +0000
Subject: [PATCH] Add option to log synchronously, add tooltip to log filter.

---
 src/common/logging/backend.cpp             | 21 +++++++++++++++-----
 src/common/logging/filter.cpp              |  2 +-
 src/common/settings.h                      |  1 +
 src/yuzu/configuration/configure_debug.cpp |  2 ++
 src/yuzu/configuration/configure_debug.ui  | 23 +++++++++++++++++++++-
 5 files changed, 42 insertions(+), 7 deletions(-)

diff --git a/src/common/logging/backend.cpp b/src/common/logging/backend.cpp
index d4f27197c9..9fdf5d1d0c 100644
--- a/src/common/logging/backend.cpp
+++ b/src/common/logging/backend.cpp
@@ -4,6 +4,7 @@
 #include <atomic>
 #include <chrono>
 #include <climits>
+#include <mutex>
 #include <thread>
 
 #include <fmt/format.h>
@@ -227,8 +228,15 @@ public:
         if (!filter.CheckMessage(log_class, log_level)) {
             return;
         }
-        message_queue.EmplaceWait(
-            CreateEntry(log_class, log_level, filename, line_num, function, std::move(message)));
+
+        auto entry =
+            CreateEntry(log_class, log_level, filename, line_num, function, std::move(message));
+        if (Settings::values.log_async) {
+            message_queue.EmplaceWait(entry);
+        } else {
+            std::scoped_lock l{sync_mutex};
+            ForEachBackend([&entry](Backend& backend) { backend.Write(entry); });
+        }
     }
 
 private:
@@ -300,6 +308,7 @@ private:
 #endif
 
     MPSCQueue<Entry> message_queue{};
+    std::mutex sync_mutex;
     std::chrono::steady_clock::time_point time_origin{std::chrono::steady_clock::now()};
     std::jthread backend_thread;
 };
@@ -328,9 +337,11 @@ void SetColorConsoleBackendEnabled(bool enabled) {
 void FmtLogMessageImpl(Class log_class, Level log_level, const char* filename,
                        unsigned int line_num, const char* function, const char* format,
                        const fmt::format_args& args) {
-    if (!initialization_in_progress_suppress_logging) {
-        Impl::Instance().PushEntry(log_class, log_level, filename, line_num, function,
-                                   fmt::vformat(format, args));
+    if (initialization_in_progress_suppress_logging) {
+        return;
     }
+
+    Impl::Instance().PushEntry(log_class, log_level, filename, line_num, function,
+                               fmt::vformat(format, args));
 }
 } // namespace Common::Log
diff --git a/src/common/logging/filter.cpp b/src/common/logging/filter.cpp
index 4e3a614a45..642cf1e8ae 100644
--- a/src/common/logging/filter.cpp
+++ b/src/common/logging/filter.cpp
@@ -170,7 +170,7 @@ const char* GetLogClassName(Class log_class) {
         return #x;
 #define SUB(x, y)                                                                                  \
     case Class::x##_##y:                                                                           \
-        return #x "." #y;
+        return #x "_" #y;
         ALL_LOG_CLASSES()
 #undef CLS
 #undef SUB
diff --git a/src/common/settings.h b/src/common/settings.h
index 07dba53aba..e83490da39 100644
--- a/src/common/settings.h
+++ b/src/common/settings.h
@@ -559,6 +559,7 @@ struct Values {
 
     // Miscellaneous
     Setting<std::string> log_filter{linkage, "*:Info", "log_filter", Category::Miscellaneous};
+    Setting<bool> log_async{linkage, true, "log_async", Category::Miscellaneous};
     Setting<bool> use_dev_keys{linkage, false, "use_dev_keys", Category::Miscellaneous};
 
     // Network
diff --git a/src/yuzu/configuration/configure_debug.cpp b/src/yuzu/configuration/configure_debug.cpp
index 1010038b76..6844cccfbe 100644
--- a/src/yuzu/configuration/configure_debug.cpp
+++ b/src/yuzu/configuration/configure_debug.cpp
@@ -73,6 +73,7 @@ void ConfigureDebug::SetConfiguration() {
     ui->disable_loop_safety_checks->setChecked(
         Settings::values.disable_shader_loop_safety_checks.GetValue());
     ui->extended_logging->setChecked(Settings::values.extended_logging.GetValue());
+    ui->log_async->setChecked(Settings::values.log_async.GetValue());
     ui->perform_vulkan_check->setChecked(Settings::values.perform_vulkan_check.GetValue());
 
 #ifdef YUZU_USE_QT_WEB_ENGINE
@@ -115,6 +116,7 @@ void ConfigureDebug::ApplyConfiguration() {
     Common::Log::Filter filter;
     filter.ParseFilterString(Settings::values.log_filter.GetValue());
     Common::Log::SetGlobalFilter(filter);
+    Settings::values.log_async = ui->log_async->isChecked();
 }
 
 void ConfigureDebug::changeEvent(QEvent* event) {
diff --git a/src/yuzu/configuration/configure_debug.ui b/src/yuzu/configuration/configure_debug.ui
index d842b01352..6d0fb6996c 100644
--- a/src/yuzu/configuration/configure_debug.ui
+++ b/src/yuzu/configuration/configure_debug.ui
@@ -164,6 +164,20 @@
            </property>
           </widget>
          </item>
+         <item row="2" column="1">
+          <widget class="QCheckBox" name="log_async">
+           <property name="enabled">
+            <bool>true</bool>
+           </property>
+           <property name="toolTip">
+            <string>When checked, logging will run asynchronously. This may cut the log on crashes.
+When unchecked, logging will run synchronously. This will slow down the emulator, but allow all logs to be written. Useful for debugging.</string>
+           </property>
+           <property name="text">
+            <string>Log asynchronously</string>
+           </property>
+          </widget>
+         </item>
          <item row="0" column="0" colspan="2">
           <widget class="QWidget" name="logging_widget" native="true">
            <property name="sizePolicy">
@@ -199,7 +213,14 @@
              </widget>
             </item>
             <item>
-             <widget class="QLineEdit" name="log_filter_edit"/>
+             <widget class="QLineEdit" name="log_filter_edit">
+              <property name="toolTip">
+               <string>Log filter in the form ＜class＞:＜level＞.
+Separate multiple filters with a space.
+Levels: Trace, Debug, Info, Warning, Error, Critical
+Classes: See Common/logging/types.h</string>
+              </property>
+             </widget>
             </item>
            </layout>
           </widget>