Log: Switch to enum class

Need to change the channel to a bitset too.. the string lookups are horribly slow, and conflict when one is a prefix of another.
stenzek · Sep 21, 2024 · 3dca598 · 3dca598
1 parent 8838120
commit 3dca598
Show file tree

Hide file tree

Showing 146 changed files with 292 additions and 292 deletions.
diff --git a/src/common/dynamic_library.cpp b/src/common/dynamic_library.cpp
@@ -22,7 +22,7 @@
 #endif
 #endif
 
-Log_SetChannel(DynamicLibrary);
+LOG_CHANNEL(DynamicLibrary);
 
 DynamicLibrary::DynamicLibrary() = default;
 

diff --git a/src/common/file_system.cpp b/src/common/file_system.cpp
@@ -45,7 +45,7 @@
 #include <unistd.h>
 #endif
 
-Log_SetChannel(FileSystem);
+LOG_CHANNEL(FileSystem);
 
 #ifndef __ANDROID__
 

diff --git a/src/common/log.cpp b/src/common/log.cpp
diff --git a/src/common/log.h b/src/common/log.h
@@ -12,24 +12,24 @@
 #include <mutex>
 #include <string_view>
 
-enum LOGLEVEL
+namespace Log {
+enum class Level
 {
-  LOGLEVEL_NONE, // Silences all log traffic
-  LOGLEVEL_ERROR,
-  LOGLEVEL_WARNING,
-  LOGLEVEL_INFO,
-  LOGLEVEL_VERBOSE,
-  LOGLEVEL_DEV,
-  LOGLEVEL_DEBUG,
-  LOGLEVEL_TRACE,
-
-  LOGLEVEL_COUNT
+  None, // Silences all log traffic
+  Error,
+  Warning,
+  Info,
+  Verbose,
+  Dev,
+  Debug,
+  Trace,
+
+  Count
 };
 
-namespace Log {
 // log message callback type
-using CallbackFunctionType = void (*)(void* pUserParam, const char* channelName, const char* functionName,
-                                      LOGLEVEL level, std::string_view message);
+using CallbackFunctionType = void (*)(void* pUserParam, const char* channelName, const char* functionName, Level level,
+                                      std::string_view message);
 
 // registers a log callback
 void RegisterCallback(CallbackFunctionType callbackFunction, void* pUserParam);
@@ -53,43 +53,43 @@ void SetDebugOutputParams(bool enabled);
 void SetFileOutputParams(bool enabled, const char* filename, bool timestamps = true);
 
 // Returns the current global filtering level.
-LOGLEVEL GetLogLevel();
+Level GetLogLevel();
 
 // Returns true if log messages for the specified log level/filter would not be filtered (and visible).
-bool IsLogVisible(LOGLEVEL level, const char* channelName);
+bool IsLogVisible(Level level, const char* channelName);
 
 // Sets global filtering level, messages below this level won't be sent to any of the logging sinks.
-void SetLogLevel(LOGLEVEL level);
+void SetLogLevel(Level level);
 
 // Sets global filter, any messages from these channels won't be sent to any of the logging sinks.
 void SetLogFilter(std::string_view filter);
 
 // writes a message to the log
-void Write(const char* channelName, LOGLEVEL level, std::string_view message);
-void Write(const char* channelName, const char* functionName, LOGLEVEL level, std::string_view message);
-void WriteFmtArgs(const char* channelName, LOGLEVEL level, fmt::string_view fmt, fmt::format_args args);
-void WriteFmtArgs(const char* channelName, const char* functionName, LOGLEVEL level, fmt::string_view fmt,
+void Write(const char* channelName, Level level, std::string_view message);
+void Write(const char* channelName, const char* functionName, Level level, std::string_view message);
+void WriteFmtArgs(const char* channelName, Level level, fmt::string_view fmt, fmt::format_args args);
+void WriteFmtArgs(const char* channelName, const char* functionName, Level level, fmt::string_view fmt,
                   fmt::format_args args);
 
-ALWAYS_INLINE static void FastWrite(const char* channelName, LOGLEVEL level, std::string_view message)
+ALWAYS_INLINE static void FastWrite(const char* channelName, Level level, std::string_view message)
 {
   if (level <= GetLogLevel()) [[unlikely]]
     Write(channelName, level, message);
 }
-ALWAYS_INLINE static void FastWrite(const char* channelName, const char* functionName, LOGLEVEL level,
+ALWAYS_INLINE static void FastWrite(const char* channelName, const char* functionName, Level level,
                                     std::string_view message)
 {
   if (level <= GetLogLevel()) [[unlikely]]
     Write(channelName, functionName, level, message);
 }
 template<typename... T>
-ALWAYS_INLINE static void FastWrite(const char* channelName, LOGLEVEL level, fmt::format_string<T...> fmt, T&&... args)
+ALWAYS_INLINE static void FastWrite(const char* channelName, Level level, fmt::format_string<T...> fmt, T&&... args)
 {
   if (level <= GetLogLevel()) [[unlikely]]
     WriteFmtArgs(channelName, level, fmt, fmt::make_format_args(args...));
 }
 template<typename... T>
-ALWAYS_INLINE static void FastWrite(const char* channelName, const char* functionName, LOGLEVEL level,
+ALWAYS_INLINE static void FastWrite(const char* channelName, const char* functionName, Level level,
                                     fmt::format_string<T...> fmt, T&&... args)
 {
   if (level <= GetLogLevel()) [[unlikely]]
@@ -98,17 +98,17 @@ ALWAYS_INLINE static void FastWrite(const char* channelName, const char* functio
 } // namespace Log
 
 // log wrappers
-#define Log_SetChannel(ChannelName) [[maybe_unused]] static const char* ___LogChannel___ = #ChannelName;
+#define LOG_CHANNEL(name) [[maybe_unused]] static const char* ___LogChannel___ = #name;
 
-#define ERROR_LOG(...) Log::FastWrite(___LogChannel___, __func__, LOGLEVEL_ERROR, __VA_ARGS__)
-#define WARNING_LOG(...) Log::FastWrite(___LogChannel___, __func__, LOGLEVEL_WARNING, __VA_ARGS__)
-#define INFO_LOG(...) Log::FastWrite(___LogChannel___, LOGLEVEL_INFO, __VA_ARGS__)
-#define VERBOSE_LOG(...) Log::FastWrite(___LogChannel___, LOGLEVEL_VERBOSE, __VA_ARGS__)
-#define DEV_LOG(...) Log::FastWrite(___LogChannel___, LOGLEVEL_DEV, __VA_ARGS__)
+#define ERROR_LOG(...) Log::FastWrite(___LogChannel___, __func__, Log::Level::Error, __VA_ARGS__)
+#define WARNING_LOG(...) Log::FastWrite(___LogChannel___, __func__, Log::Level::Warning, __VA_ARGS__)
+#define INFO_LOG(...) Log::FastWrite(___LogChannel___, Log::Level::Info, __VA_ARGS__)
+#define VERBOSE_LOG(...) Log::FastWrite(___LogChannel___, Log::Level::Verbose, __VA_ARGS__)
+#define DEV_LOG(...) Log::FastWrite(___LogChannel___, Log::Level::Dev, __VA_ARGS__)
 
 #ifdef _DEBUG
-#define DEBUG_LOG(...) Log::FastWrite(___LogChannel___, LOGLEVEL_DEBUG, __VA_ARGS__)
-#define TRACE_LOG(...) Log::FastWrite(___LogChannel___, LOGLEVEL_TRACE, __VA_ARGS__)
+#define DEBUG_LOG(...) Log::FastWrite(___LogChannel___, Log::Level::Debug, __VA_ARGS__)
+#define TRACE_LOG(...) Log::FastWrite(___LogChannel___, Log::Level::Trace, __VA_ARGS__)
 #else
 #define DEBUG_LOG(...)                                                                                                 \
   do                                                                                                                   \

diff --git a/src/common/memmap.cpp b/src/common/memmap.cpp
@@ -35,7 +35,7 @@
 #include <unistd.h>
 #endif
 
-Log_SetChannel(MemMap);
+LOG_CHANNEL(MemMap);
 
 namespace MemMap {
 /// Allocates RWX memory at the specified address.

diff --git a/src/common/progress_callback.cpp b/src/common/progress_callback.cpp
@@ -9,7 +9,7 @@
 #include <cstdio>
 #include <limits>
 
-Log_SetChannel(ProgressCallback);
+LOG_CHANNEL(ProgressCallback);
 
 static ProgressCallback s_nullProgressCallbacks;
 ProgressCallback* ProgressCallback::NullProgressCallback = &s_nullProgressCallbacks;

diff --git a/src/common/threading.cpp b/src/common/threading.cpp
@@ -41,7 +41,7 @@
 #endif
 #endif
 
-Log_SetChannel(Threading);
+LOG_CHANNEL(Threading);
 
 #ifdef _WIN32
 union FileTimeU64Union

diff --git a/src/core/achievements.cpp b/src/core/achievements.cpp
@@ -52,7 +52,7 @@
 #include <unordered_set>
 #include <vector>
 
-Log_SetChannel(Achievements);
+LOG_CHANNEL(Achievements);
 
 #ifdef ENABLE_RAINTEGRATION
 // RA_Interface ends up including windows.h, with its silly macros.

diff --git a/src/core/analog_controller.cpp b/src/core/analog_controller.cpp
@@ -20,7 +20,7 @@
 
 #include <cmath>
 
-Log_SetChannel(AnalogController);
+LOG_CHANNEL(AnalogController);
 
 AnalogController::AnalogController(u32 index) : Controller(index)
 {

diff --git a/src/core/analog_joystick.cpp b/src/core/analog_joystick.cpp
@@ -16,7 +16,7 @@
 #include "IconsPromptFont.h"
 #include "fmt/format.h"
 
-Log_SetChannel(AnalogJoystick);
+LOG_CHANNEL(AnalogJoystick);
 
 AnalogJoystick::AnalogJoystick(u32 index) : Controller(index)
 {

diff --git a/src/core/bios.cpp b/src/core/bios.cpp
@@ -15,7 +15,7 @@
 #include "common/path.h"
 #include "common/string_util.h"
 
-Log_SetChannel(BIOS);
+LOG_CHANNEL(BIOS);
 
 namespace BIOS {
 static const ImageInfo* GetInfoForHash(const std::span<u8> image, const ImageInfo::Hash& hash);

diff --git a/src/core/bus.cpp b/src/core/bus.cpp
@@ -38,7 +38,7 @@
 #include <tuple>
 #include <utility>
 
-Log_SetChannel(Bus);
+LOG_CHANNEL(Bus);
 
 // TODO: Get rid of page code bits, instead use page faults to track SMC.
 
@@ -933,7 +933,7 @@ void Bus::AddTTYCharacter(char ch)
   {
     if (!s_tty_line_buffer.empty())
     {
-      Log::FastWrite("TTY", "", LOGLEVEL_INFO, "\033[1;34m{}\033[0m", s_tty_line_buffer);
+      Log::FastWrite("TTY", "", Log::Level::Info, "\033[1;34m{}\033[0m", s_tty_line_buffer);
 #ifdef _DEBUG
       if (CPU::IsTraceEnabled())
         CPU::WriteToExecutionLog("TTY: %s\n", s_tty_line_buffer.c_str());

diff --git a/src/core/cdrom.cpp b/src/core/cdrom.cpp
@@ -32,7 +32,7 @@
 #include <map>
 #include <vector>
 
-Log_SetChannel(CDROM);
+LOG_CHANNEL(CDROM);
 
 namespace CDROM {
 namespace {
@@ -1621,7 +1621,7 @@ void CDROM::EndCommand()
 void CDROM::ExecuteCommand(void*, TickCount ticks, TickCount ticks_late)
 {
   const CommandInfo& ci = s_command_info[static_cast<u8>(s_command)];
-  if (Log::IsLogVisible(LOGLEVEL_DEV, ___LogChannel___)) [[unlikely]]
+  if (Log::IsLogVisible(Log::Level::Dev, ___LogChannel___)) [[unlikely]]
   {
     SmallString params;
     for (u32 i = 0; i < s_param_fifo.GetSize(); i++)

diff --git a/src/core/cdrom_async_reader.cpp b/src/core/cdrom_async_reader.cpp
@@ -5,7 +5,7 @@
 #include "common/assert.h"
 #include "common/log.h"
 #include "common/timer.h"
-Log_SetChannel(CDROMAsyncReader);
+LOG_CHANNEL(CDROMAsyncReader);
 
 CDROMAsyncReader::CDROMAsyncReader() = default;
 

diff --git a/src/core/cheats.cpp b/src/core/cheats.cpp
@@ -18,7 +18,7 @@
 #include <sstream>
 #include <type_traits>
 
-Log_SetChannel(Cheats);
+LOG_CHANNEL(Cheats);
 
 static std::array<u32, 256> cht_register; // Used for D7 ,51 & 52 cheat types
 

diff --git a/src/core/cpu_code_cache.cpp b/src/core/cpu_code_cache.cpp
@@ -21,7 +21,7 @@
 #include "common/log.h"
 #include "common/memmap.h"
 
-Log_SetChannel(CPU::CodeCache);
+LOG_CHANNEL(CPU::CodeCache);
 
 // Enable dumping of recompiled block code size statistics.
 // #define DUMP_CODE_SIZE_STATS 1

diff --git a/src/core/cpu_core.cpp b/src/core/cpu_core.cpp
@@ -26,7 +26,7 @@
 
 #include <cstdio>
 
-Log_SetChannel(CPU::Core);
+LOG_CHANNEL(CPU::Core);
 
 namespace CPU {
 enum class ExecutionBreakType

diff --git a/src/core/cpu_newrec_compiler.cpp b/src/core/cpu_newrec_compiler.cpp
@@ -15,7 +15,7 @@
 #include <cstdint>
 #include <limits>
 
-Log_SetChannel(NewRec::Compiler);
+LOG_CHANNEL(NewRec::Compiler);
 
 // TODO: direct link skip delay slot check
 // TODO: speculative constants

diff --git a/src/core/cpu_newrec_compiler_aarch32.cpp b/src/core/cpu_newrec_compiler_aarch32.cpp
@@ -19,7 +19,7 @@
 
 #ifdef CPU_ARCH_ARM32
 
-Log_SetChannel(CPU::NewRec);
+LOG_CHANNEL(CPU::NewRec);
 
 #define PTR(x) vixl::aarch32::MemOperand(RSTATE, (((u8*)(x)) - ((u8*)&g_state)))
 #define RMEMBASE vixl::aarch32::r3

diff --git a/src/core/cpu_newrec_compiler_aarch64.cpp b/src/core/cpu_newrec_compiler_aarch64.cpp
@@ -19,7 +19,7 @@
 
 #ifdef CPU_ARCH_ARM64
 
-Log_SetChannel(CPU::NewRec);
+LOG_CHANNEL(CPU::NewRec);
 
 #define PTR(x) vixl::aarch64::MemOperand(RSTATE, (((u8*)(x)) - ((u8*)&g_state)))
 

diff --git a/src/core/cpu_newrec_compiler_riscv64.cpp b/src/core/cpu_newrec_compiler_riscv64.cpp
@@ -20,7 +20,7 @@
 
 #ifdef CPU_ARCH_RISCV64
 
-Log_SetChannel(CPU::NewRec);
+LOG_CHANNEL(CPU::NewRec);
 
 #ifdef ENABLE_HOST_DISASSEMBLY
 extern "C" {

diff --git a/src/core/cpu_newrec_compiler_x64.cpp b/src/core/cpu_newrec_compiler_x64.cpp
@@ -20,7 +20,7 @@
 
 #ifdef CPU_ARCH_X64
 
-Log_SetChannel(CPU::NewRec);
+LOG_CHANNEL(CPU::NewRec);
 
 #define RMEMBASE cg->rbx
 #define RSTATE cg->rbp

diff --git a/src/core/cpu_pgxp.cpp b/src/core/cpu_pgxp.cpp
@@ -19,7 +19,7 @@
 #include <climits>
 #include <cmath>
 
-Log_SetChannel(CPU::PGXP);
+LOG_CHANNEL(CPU::PGXP);
 
 // #define LOG_VALUES 1
 // #define LOG_LOOKUPS 1

diff --git a/src/core/cpu_recompiler_code_generator.cpp b/src/core/cpu_recompiler_code_generator.cpp
@@ -11,7 +11,7 @@
 
 #include "common/log.h"
 
-Log_SetChannel(CPU::Recompiler);
+LOG_CHANNEL(CPU::Recompiler);
 
 // TODO: Turn load+sext/zext into a single signed/unsigned load
 // TODO: mulx/shlx/etc

diff --git a/src/core/cpu_recompiler_code_generator_aarch32.cpp b/src/core/cpu_recompiler_code_generator_aarch32.cpp
@@ -16,7 +16,7 @@
 
 #ifdef CPU_ARCH_ARM32
 
-Log_SetChannel(CPU::Recompiler);
+LOG_CHANNEL(CPU::Recompiler);
 
 #ifdef ENABLE_HOST_DISASSEMBLY
 #include "vixl/aarch32/disasm-aarch32.h"

diff --git a/src/core/cpu_recompiler_code_generator_aarch64.cpp b/src/core/cpu_recompiler_code_generator_aarch64.cpp
@@ -16,7 +16,7 @@
 
 #ifdef CPU_ARCH_ARM64
 
-Log_SetChannel(CPU::Recompiler);
+LOG_CHANNEL(CPU::Recompiler);
 
 #ifdef ENABLE_HOST_DISASSEMBLY
 #include "vixl/aarch64/disasm-aarch64.h"

diff --git a/src/core/cpu_recompiler_code_generator_generic.cpp b/src/core/cpu_recompiler_code_generator_generic.cpp
@@ -8,7 +8,7 @@
 
 #include "common/log.h"
 
-Log_SetChannel(Recompiler::CodeGenerator);
+LOG_CHANNEL(Recompiler::CodeGenerator);
 
 namespace CPU::Recompiler {
 

diff --git a/src/core/cpu_recompiler_code_generator_x64.cpp b/src/core/cpu_recompiler_code_generator_x64.cpp
@@ -16,7 +16,7 @@
 
 #ifdef CPU_ARCH_X64
 
-Log_SetChannel(Recompiler::CodeGenerator);
+LOG_CHANNEL(Recompiler::CodeGenerator);
 
 #ifdef ENABLE_HOST_DISASSEMBLY
 #include "Zycore/Format.h"
@@ -260,7 +260,7 @@ void CPU::CodeCache::DisassembleAndLogHostCode(const void* start, u32 size)
         else
           hex.append("   ");
       }
-      Log::FastWrite("HostCode", "", LOGLEVEL_DEBUG, "  {:016X} {} {}",
+      Log::FastWrite("HostCode", "", Log::Level::Debug, "  {:016X} {} {}",
                      static_cast<u64>(reinterpret_cast<uintptr_t>(ptr)), hex, buffer);
     }
 

diff --git a/src/core/cpu_recompiler_register_cache.cpp b/src/core/cpu_recompiler_register_cache.cpp
@@ -8,7 +8,7 @@
 
 #include <cinttypes>
 
-Log_SetChannel(CPU::Recompiler);
+LOG_CHANNEL(CPU::Recompiler);
 
 namespace CPU::Recompiler {
 

diff --git a/src/core/dma.cpp b/src/core/dma.cpp
@@ -26,7 +26,7 @@
 #include <memory>
 #include <vector>
 
-Log_SetChannel(DMA);
+LOG_CHANNEL(DMA);
 
 namespace DMA {
 namespace {