mirror of
https://github.com/RPCS3/rpcs3.git
synced 2024-11-23 03:02:53 +01:00
8f604ddded
Harden log channel methods against non-constant string.
124 lines
2.9 KiB
C++
124 lines
2.9 KiB
C++
#pragma once
|
|
|
|
#include "types.h"
|
|
#include "util/atomic.hpp"
|
|
#include "StrFmt.h"
|
|
#include <climits>
|
|
|
|
namespace logs
|
|
{
|
|
enum class level : uint
|
|
{
|
|
always, // Highest log severity (unused, cannot be disabled)
|
|
fatal,
|
|
error,
|
|
todo,
|
|
success,
|
|
warning,
|
|
notice,
|
|
trace, // Lowest severity (usually disabled)
|
|
|
|
_uninit = UINT_MAX, // Special value for delayed initialization
|
|
};
|
|
|
|
struct channel;
|
|
|
|
// Message information
|
|
struct message
|
|
{
|
|
channel* ch;
|
|
level sev;
|
|
|
|
private:
|
|
// Send log message to global logger instance
|
|
void broadcast(const char*, const fmt_type_info*, ...) const;
|
|
|
|
friend struct channel;
|
|
};
|
|
|
|
class listener
|
|
{
|
|
// Next listener (linked list)
|
|
atomic_t<listener*> m_next{};
|
|
|
|
friend struct message;
|
|
|
|
public:
|
|
constexpr listener() = default;
|
|
|
|
virtual ~listener();
|
|
|
|
// Process log message
|
|
virtual void log(u64 stamp, const message& msg, const std::string& prefix, const std::string& text) = 0;
|
|
|
|
// Add new listener
|
|
static void add(listener*);
|
|
};
|
|
|
|
struct channel
|
|
{
|
|
// Channel prefix (added to every log message)
|
|
const char* const name;
|
|
|
|
// The lowest logging level enabled for this channel (used for early filtering)
|
|
atomic_t<level> enabled;
|
|
|
|
// Constant initialization: channel name
|
|
constexpr channel(const char* name)
|
|
: name(name)
|
|
, enabled(level::_uninit)
|
|
{
|
|
}
|
|
|
|
#define GEN_LOG_METHOD(_sev)\
|
|
const message msg_##_sev{this, level::_sev};\
|
|
template <std::size_t N, typename... Args>\
|
|
void _sev(const char(&fmt)[N], const Args&... args)\
|
|
{\
|
|
if (UNLIKELY(level::_sev <= enabled))\
|
|
{\
|
|
static constexpr fmt_type_info type_list[sizeof...(Args) + 1]{fmt_type_info::make<fmt_unveil_t<Args>>()...};\
|
|
msg_##_sev.broadcast(fmt, type_list, u64{fmt_unveil<Args>::get(args)}...);\
|
|
}\
|
|
}
|
|
|
|
GEN_LOG_METHOD(fatal)
|
|
GEN_LOG_METHOD(error)
|
|
GEN_LOG_METHOD(todo)
|
|
GEN_LOG_METHOD(success)
|
|
GEN_LOG_METHOD(warning)
|
|
GEN_LOG_METHOD(notice)
|
|
GEN_LOG_METHOD(trace)
|
|
|
|
#undef GEN_LOG_METHOD
|
|
};
|
|
|
|
/* Small set of predefined channels */
|
|
|
|
extern channel GENERAL;
|
|
extern channel LOADER;
|
|
extern channel MEMORY;
|
|
extern channel RSX;
|
|
extern channel HLE;
|
|
extern channel PPU;
|
|
extern channel SPU;
|
|
|
|
// Log level control: set all channels to level::notice
|
|
void reset();
|
|
|
|
// Log level control: register channel if necessary, set channel level
|
|
void set_level(const std::string&, level);
|
|
}
|
|
|
|
#define LOG_CHANNEL(ch, ...) ::logs::channel ch(#ch, ##__VA_ARGS__)
|
|
|
|
// Legacy:
|
|
|
|
#define LOG_SUCCESS(ch, fmt, ...) logs::ch.success("" fmt, ##__VA_ARGS__)
|
|
#define LOG_NOTICE(ch, fmt, ...) logs::ch.notice ("" fmt, ##__VA_ARGS__)
|
|
#define LOG_WARNING(ch, fmt, ...) logs::ch.warning("" fmt, ##__VA_ARGS__)
|
|
#define LOG_ERROR(ch, fmt, ...) logs::ch.error ("" fmt, ##__VA_ARGS__)
|
|
#define LOG_TODO(ch, fmt, ...) logs::ch.todo ("" fmt, ##__VA_ARGS__)
|
|
#define LOG_TRACE(ch, fmt, ...) logs::ch.trace ("" fmt, ##__VA_ARGS__)
|
|
#define LOG_FATAL(ch, fmt, ...) logs::ch.fatal ("" fmt, ##__VA_ARGS__)
|