Add configurable per-class log filtering

This commit is contained in:
Yuri Kunde Schlesner 2014-12-06 20:00:08 -02:00
parent 0600e2d8b5
commit 0e0a007a25
11 changed files with 223 additions and 14 deletions

View File

@ -7,6 +7,7 @@
#include "common/common.h" #include "common/common.h"
#include "common/logging/text_formatter.h" #include "common/logging/text_formatter.h"
#include "common/logging/backend.h" #include "common/logging/backend.h"
#include "common/logging/filter.h"
#include "common/scope_exit.h" #include "common/scope_exit.h"
#include "core/settings.h" #include "core/settings.h"
@ -20,7 +21,8 @@
/// Application entry point /// Application entry point
int __cdecl main(int argc, char **argv) { int __cdecl main(int argc, char **argv) {
std::shared_ptr<Log::Logger> logger = Log::InitGlobalLogger(); std::shared_ptr<Log::Logger> logger = Log::InitGlobalLogger();
std::thread logging_thread(Log::TextLoggingLoop, logger); Log::Filter log_filter(Log::Level::Debug);
std::thread logging_thread(Log::TextLoggingLoop, logger, &log_filter);
SCOPE_EXIT({ SCOPE_EXIT({
logger->Close(); logger->Close();
logging_thread.join(); logging_thread.join();
@ -32,6 +34,7 @@ int __cdecl main(int argc, char **argv) {
} }
Config config; Config config;
log_filter.ParseFilterString(Settings::values.log_filter);
std::string boot_filename = argv[1]; std::string boot_filename = argv[1];
EmuWindow_GLFW* emu_window = new EmuWindow_GLFW; EmuWindow_GLFW* emu_window = new EmuWindow_GLFW;

View File

@ -64,7 +64,7 @@ void Config::ReadValues() {
Settings::values.use_virtual_sd = glfw_config->GetBoolean("Data Storage", "use_virtual_sd", true); Settings::values.use_virtual_sd = glfw_config->GetBoolean("Data Storage", "use_virtual_sd", true);
// Miscellaneous // Miscellaneous
Settings::values.enable_log = glfw_config->GetBoolean("Miscellaneous", "enable_log", true); Settings::values.log_filter = glfw_config->Get("Miscellaneous", "log_filter", "*:Info");
} }
void Config::Reload() { void Config::Reload() {

View File

@ -34,7 +34,7 @@ gpu_refresh_rate = ## 60 (default)
use_virtual_sd = use_virtual_sd =
[Miscellaneous] [Miscellaneous]
enable_log = log_filter = *:Info ## Examples: *:Debug Kernel.SVC:Trace Service.*:Critical
)"; )";
} }

View File

@ -52,7 +52,7 @@ void Config::ReadValues() {
qt_config->endGroup(); qt_config->endGroup();
qt_config->beginGroup("Miscellaneous"); qt_config->beginGroup("Miscellaneous");
Settings::values.enable_log = qt_config->value("enable_log", true).toBool(); Settings::values.log_filter = qt_config->value("log_filter", "*:Info").toString().toStdString();
qt_config->endGroup(); qt_config->endGroup();
} }
@ -87,7 +87,7 @@ void Config::SaveValues() {
qt_config->endGroup(); qt_config->endGroup();
qt_config->beginGroup("Miscellaneous"); qt_config->beginGroup("Miscellaneous");
qt_config->setValue("enable_log", Settings::values.enable_log); qt_config->setValue("log_filter", QString::fromStdString(Settings::values.log_filter));
qt_config->endGroup(); qt_config->endGroup();
} }

View File

@ -11,6 +11,7 @@
#include "common/logging/text_formatter.h" #include "common/logging/text_formatter.h"
#include "common/logging/log.h" #include "common/logging/log.h"
#include "common/logging/backend.h" #include "common/logging/backend.h"
#include "common/logging/filter.h"
#include "common/platform.h" #include "common/platform.h"
#include "common/scope_exit.h" #include "common/scope_exit.h"
@ -42,14 +43,10 @@
GMainWindow::GMainWindow() GMainWindow::GMainWindow()
{ {
Pica::g_debug_context = Pica::DebugContext::Construct(); Pica::g_debug_context = Pica::DebugContext::Construct();
Config config; Config config;
if (!Settings::values.enable_log)
LogManager::Shutdown();
ui.setupUi(this); ui.setupUi(this);
statusBar()->hide(); statusBar()->hide();
@ -277,7 +274,8 @@ void GMainWindow::closeEvent(QCloseEvent* event)
int __cdecl main(int argc, char* argv[]) int __cdecl main(int argc, char* argv[])
{ {
std::shared_ptr<Log::Logger> logger = Log::InitGlobalLogger(); std::shared_ptr<Log::Logger> logger = Log::InitGlobalLogger();
std::thread logging_thread(Log::TextLoggingLoop, logger); Log::Filter log_filter(Log::Level::Info);
std::thread logging_thread(Log::TextLoggingLoop, logger, &log_filter);
SCOPE_EXIT({ SCOPE_EXIT({
logger->Close(); logger->Close();
logging_thread.join(); logging_thread.join();
@ -285,7 +283,11 @@ int __cdecl main(int argc, char* argv[])
QApplication::setAttribute(Qt::AA_X11InitThreads); QApplication::setAttribute(Qt::AA_X11InitThreads);
QApplication app(argc, argv); QApplication app(argc, argv);
GMainWindow main_window; GMainWindow main_window;
// After settings have been loaded by GMainWindow, apply the filter
log_filter.ParseFilterString(Settings::values.log_filter);
main_window.show(); main_window.show();
return app.exec(); return app.exec();
} }

View File

@ -11,6 +11,7 @@ set(SRCS
hash.cpp hash.cpp
key_map.cpp key_map.cpp
log_manager.cpp log_manager.cpp
logging/filter.cpp
logging/text_formatter.cpp logging/text_formatter.cpp
logging/backend.cpp logging/backend.cpp
math_util.cpp math_util.cpp
@ -49,6 +50,7 @@ set(HEADERS
log.h log.h
log_manager.h log_manager.h
logging/text_formatter.h logging/text_formatter.h
logging/filter.h
logging/log.h logging/log.h
logging/backend.h logging/backend.h
math_util.h math_util.h

View File

@ -0,0 +1,132 @@
// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.
#include <algorithm>
#include "common/logging/filter.h"
#include "common/logging/backend.h"
#include "common/string_util.h"
namespace Log {
Filter::Filter(Level default_level) {
ResetAll(default_level);
}
void Filter::ResetAll(Level level) {
class_levels.fill(level);
}
void Filter::SetClassLevel(Class log_class, Level level) {
class_levels[static_cast<size_t>(log_class)] = level;
}
void Filter::SetSubclassesLevel(const ClassInfo& log_class, Level level) {
const size_t log_class_i = static_cast<size_t>(log_class.log_class);
const size_t begin = log_class_i + 1;
const size_t end = begin + log_class.num_children;
for (size_t i = begin; begin < end; ++i) {
class_levels[i] = level;
}
}
void Filter::ParseFilterString(const std::string& filter_str) {
auto clause_begin = filter_str.cbegin();
while (clause_begin != filter_str.cend()) {
auto clause_end = std::find(clause_begin, filter_str.cend(), ' ');
// If clause isn't empty
if (clause_end != clause_begin) {
ParseFilterRule(clause_begin, clause_end);
}
if (clause_end != filter_str.cend()) {
// Skip over the whitespace
++clause_end;
}
clause_begin = clause_end;
}
}
template <typename It>
static Level GetLevelByName(const It begin, const It end) {
for (u8 i = 0; i < static_cast<u8>(Level::Count); ++i) {
const char* level_name = Logger::GetLevelName(static_cast<Level>(i));
if (Common::ComparePartialString(begin, end, level_name)) {
return static_cast<Level>(i);
}
}
return Level::Count;
}
template <typename It>
static Class GetClassByName(const It begin, const It end) {
for (ClassType i = 0; i < static_cast<ClassType>(Class::Count); ++i) {
const char* level_name = Logger::GetLogClassName(static_cast<Class>(i));
if (Common::ComparePartialString(begin, end, level_name)) {
return static_cast<Class>(i);
}
}
return Class::Count;
}
template <typename InputIt, typename T>
static InputIt find_last(InputIt begin, const InputIt end, const T& value) {
auto match = end;
while (begin != end) {
auto new_match = std::find(begin, end, value);
if (new_match != end) {
match = new_match;
++new_match;
}
begin = new_match;
}
return match;
}
bool Filter::ParseFilterRule(const std::string::const_iterator begin,
const std::string::const_iterator end) {
auto level_separator = std::find(begin, end, ':');
if (level_separator == end) {
LOG_ERROR(Log, "Invalid log filter. Must specify a log level after `:`: %s",
std::string(begin, end).c_str());
return false;
}
const Level level = GetLevelByName(level_separator + 1, end);
if (level == Level::Count) {
LOG_ERROR(Log, "Unknown log level in filter: %s", std::string(begin, end).c_str());
return false;
}
if (Common::ComparePartialString(begin, level_separator, "*")) {
ResetAll(level);
return true;
}
auto class_name_end = find_last(begin, level_separator, '.');
if (class_name_end != level_separator &&
!Common::ComparePartialString(class_name_end + 1, level_separator, "*")) {
class_name_end = level_separator;
}
const Class log_class = GetClassByName(begin, class_name_end);
if (log_class == Class::Count) {
LOG_ERROR(Log, "Unknown log class in filter: %s", std::string(begin, end).c_str());
return false;
}
if (class_name_end == level_separator) {
SetClassLevel(log_class, level);
}
SetSubclassesLevel(log_class, level);
return true;
}
bool Filter::CheckMessage(Class log_class, Level level) const {
return static_cast<u8>(level) >= static_cast<u8>(class_levels[static_cast<size_t>(log_class)]);
}
}

View File

@ -0,0 +1,63 @@
// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.
#include <array>
#include <string>
#include "common/logging/log.h"
namespace Log {
struct ClassInfo;
/**
* Implements a log message filter which allows different log classes to have different minimum
* severity levels. The filter can be changed at runtime and can be parsed from a string to allow
* editing via the interface or loading from a configuration file.
*/
class Filter {
public:
/// Initializes the filter with all classes having `default_level` as the minimum level.
Filter(Level default_level);
/// Resets the filter so that all classes have `level` as the minimum displayed level.
void ResetAll(Level level);
/// Sets the minimum level of `log_class` (and not of its subclasses) to `level`.
void SetClassLevel(Class log_class, Level level);
/**
* Sets the minimum level of all of `log_class` subclasses to `level`. The level of `log_class`
* itself is not changed.
*/
void SetSubclassesLevel(const ClassInfo& log_class, Level level);
/**
* Parses a filter string and applies it to this filter.
*
* A filter string consists of a space-separated list of filter rules, each of the format
* `<class>:<level>`. `<class>` is a log class name, with subclasses separated using periods.
* A rule for a given class also affects all of its subclasses. `*` wildcards are allowed and
* can be used to apply a rule to all classes or to all subclasses of a class without affecting
* the parent class. `<level>` a severity level name which will be set as the minimum logging
* level of the matched classes. Rules are applied left to right, with each rule overriding
* previous ones in the sequence.
*
* A few examples of filter rules:
* - `*:Info` -- Resets the level of all classes to Info.
* - `Service:Info` -- Sets the level of Service and all subclasses (Service.FS, Service.APT,
* etc.) to Info.
* - `Service.*:Debug` -- Sets the level of all Service subclasses to Debug, while leaving the
* level of Service unchanged.
* - `Service.FS:Trace` -- Sets the level of the Service.FS class to Trace.
*/
void ParseFilterString(const std::string& filter_str);
bool ParseFilterRule(const std::string::const_iterator start, const std::string::const_iterator end);
/// Matches class/level combination against the filter, returning true if it passed.
bool CheckMessage(Class log_class, Level level) const;
private:
std::array<Level, (size_t)Class::Count> class_levels;
};
}

View File

@ -11,6 +11,7 @@
#endif #endif
#include "common/logging/backend.h" #include "common/logging/backend.h"
#include "common/logging/filter.h"
#include "common/logging/log.h" #include "common/logging/log.h"
#include "common/logging/text_formatter.h" #include "common/logging/text_formatter.h"
@ -105,7 +106,7 @@ void PrintMessage(const Entry& entry) {
fputc('\n', stderr); fputc('\n', stderr);
} }
void TextLoggingLoop(std::shared_ptr<Logger> logger) { void TextLoggingLoop(std::shared_ptr<Logger> logger, const Filter* filter) {
std::array<Entry, 256> entry_buffer; std::array<Entry, 256> entry_buffer;
while (true) { while (true) {
@ -114,7 +115,10 @@ void TextLoggingLoop(std::shared_ptr<Logger> logger) {
break; break;
} }
for (size_t i = 0; i < num_entries; ++i) { for (size_t i = 0; i < num_entries; ++i) {
PrintMessage(entry_buffer[i]); const Entry& entry = entry_buffer[i];
if (filter->CheckMessage(entry.log_class, entry.log_level)) {
PrintMessage(entry);
}
} }
} }
} }

View File

@ -11,6 +11,7 @@ namespace Log {
class Logger; class Logger;
struct Entry; struct Entry;
class Filter;
/** /**
* Attempts to trim an arbitrary prefix from `path`, leaving only the part starting at `root`. It's * Attempts to trim an arbitrary prefix from `path`, leaving only the part starting at `root`. It's
@ -33,6 +34,6 @@ void PrintMessage(const Entry& entry);
* Logging loop that repeatedly reads messages from the provided logger and prints them to the * Logging loop that repeatedly reads messages from the provided logger and prints them to the
* console. It is the baseline barebones log outputter. * console. It is the baseline barebones log outputter.
*/ */
void TextLoggingLoop(std::shared_ptr<Logger> logger); void TextLoggingLoop(std::shared_ptr<Logger> logger, const Filter* filter);
} }

View File

@ -4,6 +4,8 @@
#pragma once #pragma once
#include <string>
namespace Settings { namespace Settings {
struct Values { struct Values {
@ -33,7 +35,7 @@ struct Values {
// Data Storage // Data Storage
bool use_virtual_sd; bool use_virtual_sd;
bool enable_log; std::string log_filter;
} extern values; } extern values;
} }