Skip to content

feat: add crash logger macros #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LimiNode merged 2 commits into from
Sep 15, 2025
Merged

feat: add crash logger macros #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af3d940
feat(macros): add crash logger macros
LimiNode Sep 15, 2025
66bc2a2
fix(loggers): guard crash logger state for c++11
LimiNode Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions include/logit_cpp/logit/LogMacros.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1608,6 +1608,33 @@ static_assert(LOGIT_LEVEL_FATAL == static_cast<int>(logit::LogLevel::LOG_LVL_FAT
std::make_unique<logit::SimpleLogFormatter>(LOGIT_UNIQUE_FILE_LOGGER_PATTERN), \
true)

/// \brief Macro for adding a crash logger with custom configuration.
/// \param path Path where the crash log should be written.
/// \param buffer_size Size of the in-memory buffer preserving recent messages.
/// This version uses `std::make_unique`, available in C++17 and later.
#define LOGIT_ADD_CRASH_LOGGER(path, buffer_size) \
logit::Logger::get_instance().add_logger( \
std::make_unique<logit::CrashLogger>( \
logit::CrashLogger::Config{path, buffer_size}), \
std::make_unique<logit::SimpleLogFormatter>(LOGIT_FILE_LOGGER_PATTERN))

/// \brief Macro for adding a crash logger with custom configuration in single_mode.
/// In single_mode, the crash logger can only be invoked using macros like `LOGIT_TRACE_TO`.
/// This version uses `std::make_unique`, available in C++17 and later.
#define LOGIT_ADD_CRASH_LOGGER_SINGLE_MODE(path, buffer_size) \
logit::Logger::get_instance().add_logger( \
std::make_unique<logit::CrashLogger>( \
logit::CrashLogger::Config{path, buffer_size}), \
std::make_unique<logit::SimpleLogFormatter>(LOGIT_FILE_LOGGER_PATTERN), \
true)

/// \brief Macro for adding a crash logger with default configuration.
/// This version uses `std::make_unique`, available in C++17 and later.
#define LOGIT_ADD_CRASH_LOGGER_DEFAULT() \
logit::Logger::get_instance().add_logger( \
std::make_unique<logit::CrashLogger>(), \
std::make_unique<logit::SimpleLogFormatter>(LOGIT_FILE_LOGGER_PATTERN))

#define LOGIT_ADD_SYSLOG(ident, facility, async) \
logit::Logger::get_instance().add_logger( \
std::make_unique<logit::SyslogLogger>(ident, facility, async), \
Expand Down Expand Up @@ -1823,6 +1850,35 @@ static_assert(LOGIT_LEVEL_FATAL == static_cast<int>(logit::LogLevel::LOG_LVL_FAT
std::unique_ptr<logit::SimpleLogFormatter>(new logit::SimpleLogFormatter(LOGIT_UNIQUE_FILE_LOGGER_PATTERN)), \
true)

/// \brief Macro for adding a crash logger with custom configuration.
/// \param path Path where the crash log should be written.
/// \param buffer_size Size of the in-memory buffer preserving recent messages.
/// This version uses `new` and `std::unique_ptr` for C++11 compatibility.
#define LOGIT_ADD_CRASH_LOGGER(path, buffer_size) \
logit::Logger::get_instance().add_logger( \
std::unique_ptr<logit::CrashLogger>( \
new logit::CrashLogger( \
logit::CrashLogger::Config{path, buffer_size})), \
std::unique_ptr<logit::SimpleLogFormatter>(new logit::SimpleLogFormatter(LOGIT_FILE_LOGGER_PATTERN)))

/// \brief Macro for adding a crash logger with custom configuration in single_mode.
/// In single_mode, the crash logger can only be invoked using macros like `LOGIT_TRACE_TO`.
/// This version uses `new` and `std::unique_ptr` for C++11 compatibility.
#define LOGIT_ADD_CRASH_LOGGER_SINGLE_MODE(path, buffer_size) \
logit::Logger::get_instance().add_logger( \
std::unique_ptr<logit::CrashLogger>( \
new logit::CrashLogger( \
logit::CrashLogger::Config{path, buffer_size})), \
std::unique_ptr<logit::SimpleLogFormatter>(new logit::SimpleLogFormatter(LOGIT_FILE_LOGGER_PATTERN)), \
true)

/// \brief Macro for adding a crash logger with default configuration.
/// This version uses `new` and `std::unique_ptr` for C++11 compatibility.
#define LOGIT_ADD_CRASH_LOGGER_DEFAULT() \
logit::Logger::get_instance().add_logger( \
std::unique_ptr<logit::CrashLogger>(new logit::CrashLogger()), \
std::unique_ptr<logit::SimpleLogFormatter>(new logit::SimpleLogFormatter(LOGIT_FILE_LOGGER_PATTERN)))

#define LOGIT_ADD_SYSLOG(ident, facility, async) \
logit::Logger::get_instance().add_logger( \
std::unique_ptr<logit::SyslogLogger>(new logit::SyslogLogger(ident, facility, async)), \
Expand Down
11 changes: 7 additions & 4 deletions include/logit_cpp/logit/loggers/CrashWindowsLogger.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ namespace logit {
OPEN_ALWAYS,
FILE_ATTRIBUTE_NORMAL,
nullptr);
s_active_logger.store(this, std::memory_order_release);
active_logger().store(this, std::memory_order_release);
}

CrashWindowsLogger(const CrashWindowsLogger&) = delete;
Expand All @@ -76,7 +76,7 @@ namespace logit {
/// \\brief Close the crash log handle on destruction.
~CrashWindowsLogger() override {
CrashWindowsLogger* expected = this;
s_active_logger.compare_exchange_strong(
active_logger().compare_exchange_strong(
expected, nullptr, std::memory_order_release, std::memory_order_relaxed);
if (m_file != INVALID_HANDLE_VALUE) {
::CloseHandle(m_file);
Expand Down Expand Up @@ -180,7 +180,7 @@ namespace logit {

private:
static LONG WINAPI exception_filter(EXCEPTION_POINTERS* exception_info) {
CrashWindowsLogger* logger = s_active_logger.load(std::memory_order_acquire);
CrashWindowsLogger* logger = active_logger().load(std::memory_order_acquire);
if (logger != nullptr) {
DWORD code = 0;
if (exception_info != nullptr && exception_info->ExceptionRecord != nullptr) {
Expand Down Expand Up @@ -279,7 +279,10 @@ namespace logit {
std::atomic<int> m_log_level{static_cast<int>(LogLevel::LOG_LVL_TRACE)};
std::array<char, kMaxBufferSize> m_buffer{};

inline static std::atomic<CrashWindowsLogger*> s_active_logger{nullptr};
static std::atomic<CrashWindowsLogger*>& active_logger() noexcept {
static std::atomic<CrashWindowsLogger*> instance(nullptr);
return instance;
}
};

#else // Stub for non-Windows systems
Expand Down
Loading