mirror of
https://github.com/luanti-org/luanti.git
synced 2025-06-27 16:36:03 +00:00
Make logging cost free when there is no output target (#12247)
The logging streams now do almost no work when there is no output target for them. For example, if LL_VERBOSE has no output targets, then `verbosestream << x` will return a StreamProxy with a null target. Any further `<<` operations applied to it will do nothing.
This commit is contained in:
paradust7
GitHub
parent
ae7664597e
commit
0704ca0550
14 changed files with 336 additions and 192 deletions
183
src/log.cpp
183
src/log.cpp
|
|
@ -35,43 +35,30 @@ with this program; if not, write to the Free Software Foundation, Inc.,
|
|||
#include <cerrno>
|
||||
#include <cstring>
|
||||
|
||||
const int BUFFER_LENGTH = 256;
|
||||
|
||||
class StringBuffer : public std::streambuf {
|
||||
class LevelTarget : public LogTarget {
|
||||
public:
|
||||
StringBuffer() {
|
||||
buffer_index = 0;
|
||||
}
|
||||
|
||||
int overflow(int c);
|
||||
virtual void flush(const std::string &buf) = 0;
|
||||
std::streamsize xsputn(const char *s, std::streamsize n);
|
||||
void push_back(char c);
|
||||
|
||||
private:
|
||||
char buffer[BUFFER_LENGTH];
|
||||
int buffer_index;
|
||||
};
|
||||
|
||||
|
||||
class LogBuffer : public StringBuffer {
|
||||
public:
|
||||
LogBuffer(Logger &logger, LogLevel lev) :
|
||||
logger(logger),
|
||||
level(lev)
|
||||
LevelTarget(Logger &logger, LogLevel level, bool raw = false) :
|
||||
m_logger(logger),
|
||||
m_level(level),
|
||||
m_raw(raw)
|
||||
{}
|
||||
|
||||
void flush(const std::string &buffer);
|
||||
virtual bool hasOutput() override {
|
||||
return m_logger.hasOutput(m_level);
|
||||
}
|
||||
|
||||
virtual void log(const std::string &buf) override {
|
||||
if (!m_raw) {
|
||||
m_logger.log(m_level, buf);
|
||||
} else {
|
||||
m_logger.logRaw(m_level, buf);
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
Logger &logger;
|
||||
LogLevel level;
|
||||
};
|
||||
|
||||
|
||||
class RawLogBuffer : public StringBuffer {
|
||||
public:
|
||||
void flush(const std::string &buffer);
|
||||
Logger &m_logger;
|
||||
LogLevel m_level;
|
||||
bool m_raw;
|
||||
};
|
||||
|
||||
////
|
||||
|
|
@ -80,31 +67,33 @@ public:
|
|||
|
||||
Logger g_logger;
|
||||
|
||||
#ifdef __ANDROID__
|
||||
AndroidLogOutput stdout_output;
|
||||
AndroidLogOutput stderr_output;
|
||||
#else
|
||||
StreamLogOutput stdout_output(std::cout);
|
||||
StreamLogOutput stderr_output(std::cerr);
|
||||
std::ostream null_stream(NULL);
|
||||
#endif
|
||||
|
||||
RawLogBuffer raw_buf;
|
||||
LevelTarget none_target_raw(g_logger, LL_NONE, true);
|
||||
LevelTarget none_target(g_logger, LL_NONE);
|
||||
LevelTarget error_target(g_logger, LL_ERROR);
|
||||
LevelTarget warning_target(g_logger, LL_WARNING);
|
||||
LevelTarget action_target(g_logger, LL_ACTION);
|
||||
LevelTarget info_target(g_logger, LL_INFO);
|
||||
LevelTarget verbose_target(g_logger, LL_VERBOSE);
|
||||
LevelTarget trace_target(g_logger, LL_TRACE);
|
||||
|
||||
LogBuffer none_buf(g_logger, LL_NONE);
|
||||
LogBuffer error_buf(g_logger, LL_ERROR);
|
||||
LogBuffer warning_buf(g_logger, LL_WARNING);
|
||||
LogBuffer action_buf(g_logger, LL_ACTION);
|
||||
LogBuffer info_buf(g_logger, LL_INFO);
|
||||
LogBuffer verbose_buf(g_logger, LL_VERBOSE);
|
||||
|
||||
// Connection
|
||||
std::ostream *dout_con_ptr = &null_stream;
|
||||
std::ostream *derr_con_ptr = &verbosestream;
|
||||
|
||||
// Common streams
|
||||
std::ostream rawstream(&raw_buf);
|
||||
std::ostream dstream(&none_buf);
|
||||
std::ostream errorstream(&error_buf);
|
||||
std::ostream warningstream(&warning_buf);
|
||||
std::ostream actionstream(&action_buf);
|
||||
std::ostream infostream(&info_buf);
|
||||
std::ostream verbosestream(&verbose_buf);
|
||||
thread_local LogStream dstream(none_target);
|
||||
thread_local LogStream rawstream(none_target_raw);
|
||||
thread_local LogStream errorstream(error_target);
|
||||
thread_local LogStream warningstream(warning_target);
|
||||
thread_local LogStream actionstream(action_target);
|
||||
thread_local LogStream infostream(info_target);
|
||||
thread_local LogStream verbosestream(verbose_target);
|
||||
thread_local LogStream tracestream(trace_target);
|
||||
thread_local LogStream derr_con(verbose_target);
|
||||
thread_local LogStream dout_con(trace_target);
|
||||
|
||||
// Android
|
||||
#ifdef __ANDROID__
|
||||
|
|
@ -118,29 +107,15 @@ static unsigned int g_level_to_android[] = {
|
|||
//ANDROID_LOG_INFO,
|
||||
ANDROID_LOG_DEBUG, // LL_INFO
|
||||
ANDROID_LOG_VERBOSE, // LL_VERBOSE
|
||||
ANDROID_LOG_VERBOSE, // LL_TRACE
|
||||
};
|
||||
|
||||
class AndroidSystemLogOutput : public ICombinedLogOutput {
|
||||
public:
|
||||
AndroidSystemLogOutput()
|
||||
{
|
||||
g_logger.addOutput(this);
|
||||
}
|
||||
~AndroidSystemLogOutput()
|
||||
{
|
||||
g_logger.removeOutput(this);
|
||||
}
|
||||
void logRaw(LogLevel lev, const std::string &line)
|
||||
{
|
||||
STATIC_ASSERT(ARRLEN(g_level_to_android) == LL_MAX,
|
||||
mismatch_between_android_and_internal_loglevels);
|
||||
__android_log_print(g_level_to_android[lev],
|
||||
PROJECT_NAME_C, "%s", line.c_str());
|
||||
}
|
||||
};
|
||||
|
||||
AndroidSystemLogOutput g_android_log_output;
|
||||
|
||||
void AndroidLogOutput::logRaw(LogLevel lev, const std::string &line) {
|
||||
STATIC_ASSERT(ARRLEN(g_level_to_android) == LL_MAX,
|
||||
mismatch_between_android_and_internal_loglevels);
|
||||
__android_log_print(g_level_to_android[lev],
|
||||
PROJECT_NAME_C, "%s", line.c_str());
|
||||
}
|
||||
#endif
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
|
|
@ -164,6 +139,8 @@ LogLevel Logger::stringToLevel(const std::string &name)
|
|||
return LL_INFO;
|
||||
else if (name == "verbose")
|
||||
return LL_VERBOSE;
|
||||
else if (name == "trace")
|
||||
return LL_TRACE;
|
||||
else
|
||||
return LL_MAX;
|
||||
}
|
||||
|
|
@ -176,21 +153,26 @@ void Logger::addOutput(ILogOutput *out)
|
|||
void Logger::addOutput(ILogOutput *out, LogLevel lev)
|
||||
{
|
||||
m_outputs[lev].push_back(out);
|
||||
m_has_outputs[lev] = true;
|
||||
}
|
||||
|
||||
void Logger::addOutputMasked(ILogOutput *out, LogLevelMask mask)
|
||||
{
|
||||
for (size_t i = 0; i < LL_MAX; i++) {
|
||||
if (mask & LOGLEVEL_TO_MASKLEVEL(i))
|
||||
if (mask & LOGLEVEL_TO_MASKLEVEL(i)) {
|
||||
m_outputs[i].push_back(out);
|
||||
m_has_outputs[i] = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::addOutputMaxLevel(ILogOutput *out, LogLevel lev)
|
||||
{
|
||||
assert(lev < LL_MAX);
|
||||
for (size_t i = 0; i <= lev; i++)
|
||||
for (size_t i = 0; i <= lev; i++) {
|
||||
m_outputs[i].push_back(out);
|
||||
m_has_outputs[i] = true;
|
||||
}
|
||||
}
|
||||
|
||||
LogLevelMask Logger::removeOutput(ILogOutput *out)
|
||||
|
|
@ -203,6 +185,7 @@ LogLevelMask Logger::removeOutput(ILogOutput *out)
|
|||
if (it != m_outputs[i].end()) {
|
||||
ret_mask |= LOGLEVEL_TO_MASKLEVEL(i);
|
||||
m_outputs[i].erase(it);
|
||||
m_has_outputs[i] = !m_outputs[i].empty();
|
||||
}
|
||||
}
|
||||
return ret_mask;
|
||||
|
|
@ -236,6 +219,7 @@ const std::string Logger::getLevelLabel(LogLevel lev)
|
|||
"ACTION",
|
||||
"INFO",
|
||||
"VERBOSE",
|
||||
"TRACE",
|
||||
};
|
||||
assert(lev < LL_MAX && lev >= 0);
|
||||
STATIC_ASSERT(ARRLEN(names) == LL_MAX,
|
||||
|
|
@ -297,7 +281,6 @@ void Logger::logToOutputs(LogLevel lev, const std::string &combined,
|
|||
m_outputs[lev][i]->log(lev, combined, time, thread_name, payload_text);
|
||||
}
|
||||
|
||||
|
||||
////
|
||||
//// *LogOutput methods
|
||||
////
|
||||
|
|
@ -349,6 +332,7 @@ void StreamLogOutput::logRaw(LogLevel lev, const std::string &line)
|
|||
m_stream << "\033[37m";
|
||||
break;
|
||||
case LL_VERBOSE:
|
||||
case LL_TRACE:
|
||||
// verbose is darker than info
|
||||
m_stream << "\033[2m";
|
||||
break;
|
||||
|
|
@ -396,6 +380,7 @@ void LogOutputBuffer::logRaw(LogLevel lev, const std::string &line)
|
|||
color = "\x1b(c@#BBB)";
|
||||
break;
|
||||
case LL_VERBOSE: // dark grey
|
||||
case LL_TRACE:
|
||||
color = "\x1b(c@#888)";
|
||||
break;
|
||||
default: break;
|
||||
|
|
@ -404,47 +389,3 @@ void LogOutputBuffer::logRaw(LogLevel lev, const std::string &line)
|
|||
|
||||
m_buffer.push(color.append(line));
|
||||
}
|
||||
|
||||
////
|
||||
//// *Buffer methods
|
||||
////
|
||||
|
||||
int StringBuffer::overflow(int c)
|
||||
{
|
||||
push_back(c);
|
||||
return c;
|
||||
}
|
||||
|
||||
|
||||
std::streamsize StringBuffer::xsputn(const char *s, std::streamsize n)
|
||||
{
|
||||
for (int i = 0; i < n; ++i)
|
||||
push_back(s[i]);
|
||||
return n;
|
||||
}
|
||||
|
||||
void StringBuffer::push_back(char c)
|
||||
{
|
||||
if (c == '\n' || c == '\r') {
|
||||
if (buffer_index)
|
||||
flush(std::string(buffer, buffer_index));
|
||||
buffer_index = 0;
|
||||
} else {
|
||||
buffer[buffer_index++] = c;
|
||||
if (buffer_index >= BUFFER_LENGTH) {
|
||||
flush(std::string(buffer, buffer_index));
|
||||
buffer_index = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void LogBuffer::flush(const std::string &buffer)
|
||||
{
|
||||
logger.log(level, buffer);
|
||||
}
|
||||
|
||||
void RawLogBuffer::flush(const std::string &buffer)
|
||||
{
|
||||
g_logger.logRaw(LL_NONE, buffer);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue