Archivist.cpp

Go to the documentation of this file.

#include "Archivist.hpp"
#include "RealtimeEntry.hpp"
 
#include "Ansi.hpp"
#include "Sink.hpp"
 
#include "MayaFlux/Transitive/Memory/RingBuffer.hpp"
 
namespace MayaFlux::Journal {
 
static bool colors_enabled = AnsiColors::initialize_console_colors();
 
class Archivist::Impl {
public:
    static constexpr size_t RING_BUFFER_SIZE = 8192;
 
    Impl()
        : m_min_severity(Severity::WARN)
        , m_worker_running(false)
        , m_shutdown_in_progress(false)
    {
        m_component_filters.fill(true);
    }
 
    ~Impl()
    {
        m_worker_running.store(false, std::memory_order_release);
 
        if (m_worker_thread.joinable()) {
            auto start = std::chrono::steady_clock::now();
            while (m_worker_thread.joinable() && std::chrono::steady_clock::now() - start < std::chrono::milliseconds(500)) {
                std::this_thread::sleep_for(std::chrono::milliseconds(10));
            }
 
            if (m_worker_thread.joinable()) {
                m_worker_thread.detach();
            }
        }
    }
 
    void init()
    {
        std::lock_guard lock(m_mutex);
        if (m_initialized || m_shutdown_in_progress)
            return;
 
        m_initialized = true;
        m_worker_running.store(true, std::memory_order_release);
        start_worker();
        std::cout << "[MayaFlux::Journal] Initialized\n";
    }
 
    void shutdown()
    {
        std::unique_lock lock(m_mutex);
        if (!m_initialized || m_shutdown_in_progress)
            return;
 
        m_shutdown_in_progress = true;
        m_initialized = false;
        m_worker_running.store(false, std::memory_order_release);
 
        lock.unlock();
 
        if (m_worker_thread.joinable()) {
            m_worker_thread.join();
        }
 
        lock.lock();
        drain_ring_buffer();
        m_shutdown_in_progress = false;
        std::cout << "[MayaFlux::Journal] Shutdown\n";
    }
 
    void scribe(const JournalEntry& entry)
    {
        if (entry.severity < m_min_severity.load(std::memory_order_relaxed)) {
            return;
        }
 
        auto comp_idx = static_cast<size_t>(entry.component);
        if (comp_idx >= m_component_filters.size()) {
            return;
        }
 
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
        if (!m_component_filters[comp_idx]) {
            return;
        }
 
        std::lock_guard lock(m_mutex);
 
        if (m_sinks.empty()) {
            write_to_console(entry);
        } else {
            write_to_sinks(entry);
        }
    }
 
    void scribe_rt(Severity severity, Component component, Context context, std::string_view message, std::source_location location)
    {
        if (!should_log(severity, component)) {
            return;
        }
 
        RealtimeEntry entry(severity, component, context, message, location);
        if (!m_ring_buffer.push(entry)) {
            m_dropped_messages.fetch_add(1, std::memory_order_relaxed);
        }
    }
 
    void add_sink(std::unique_ptr<Sink> sink)
    {
        std::lock_guard lock(m_mutex);
        m_sinks.push_back(std::move(sink));
    }
 
    void clear_sinks()
    {
        std::lock_guard lock(m_mutex);
        m_sinks.clear();
    }
 
    void set_min_severity(Severity sev)
    {
        if (sev == Severity::NONE) {
            return;
        }
        m_min_severity.store(sev, std::memory_order_relaxed);
    }
 
    void set_component_filter(Component comp, bool enabled)
    {
        auto comp_idx = static_cast<size_t>(comp);
        if (comp_idx >= m_component_filters.size()) {
            return;
        }
 
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
        m_component_filters[comp_idx] = enabled;
    }
 
private:
    [[nodiscard]] bool should_log(Severity severity, Component component) const
    {
        if (severity != Severity::NONE && severity < m_min_severity.load(std::memory_order_relaxed)) {
            return false;
        }
 
        auto comp_idx = static_cast<size_t>(component);
        if (comp_idx >= m_component_filters.size()) {
            return false;
        }
 
        // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
        return m_component_filters[comp_idx];
    }
 
    static void write_to_console(const JournalEntry& entry)
    {
        if (colors_enabled) {
            switch (entry.severity) {
            case Severity::TRACE:
                std::cout << AnsiColors::Cyan;
                break;
            case Severity::DEBUG:
                std::cout << AnsiColors::Blue;
                break;
            case Severity::INFO:
                std::cout << AnsiColors::Green;
                break;
            case Severity::WARN:
                std::cout << AnsiColors::Yellow;
                break;
            case Severity::ERROR:
                std::cout << AnsiColors::BrightRed;
                break;
            case Severity::FATAL:
                std::cout << AnsiColors::BrightRed << AnsiColors::White;
                break;
            case Severity::NONE:
            default:
                std::cout << AnsiColors::Reset;
                break;
            }
        }
 
        std::cout << "[" << Reflect::enum_to_string(entry.severity) << "]" << AnsiColors::Reset;
 
        if (colors_enabled) {
            std::cout << AnsiColors::Magenta;
        }
        std::cout << "[" << Reflect::enum_to_string(entry.component) << "]" << AnsiColors::Reset;
 
        if (colors_enabled) {
            std::cout << AnsiColors::Cyan;
        }
        std::cout << "[" << Reflect::enum_to_string(entry.context) << "]" << AnsiColors::Reset << " ";
 
        std::cout << entry.message;
 
        if (entry.location.file_name() != nullptr && entry.location.line() != 0) {
            if (colors_enabled) {
                std::cout << AnsiColors::BrightBlue;
            }
            std::cout << " (" << entry.location.file_name()
                      << ":" << entry.location.line() << ")" << AnsiColors::Reset;
        }
 
        std::cout << '\n';
    }
 
    static void write_to_console(const RealtimeEntry& entry)
    {
        if (colors_enabled) {
            switch (entry.severity) {
            case Severity::TRACE:
                std::cout << AnsiColors::Cyan;
                break;
            case Severity::DEBUG:
                std::cout << AnsiColors::Blue;
                break;
            case Severity::INFO:
                std::cout << AnsiColors::Green;
                break;
            case Severity::WARN:
                std::cout << AnsiColors::Yellow;
                break;
            case Severity::ERROR:
                std::cout << AnsiColors::BrightRed;
                break;
            case Severity::FATAL:
                std::cout << AnsiColors::BrightRed << AnsiColors::White;
                break;
            case Severity::NONE:
            default:
                std::cout << AnsiColors::Reset;
                break;
            }
        }
 
        std::cout << "[" << Reflect::enum_to_string(entry.severity) << "]" << AnsiColors::Reset;
 
        if (colors_enabled) {
            std::cout << AnsiColors::Magenta;
        }
        std::cout << "[" << Reflect::enum_to_string(entry.component) << "]" << AnsiColors::Reset;
 
        if (colors_enabled) {
            std::cout << AnsiColors::Cyan;
        }
        std::cout << "[" << Reflect::enum_to_string(entry.context) << "]" << AnsiColors::Reset << " ";
 
        std::cout << entry.message;
 
        if (entry.file_name != nullptr) {
            if (colors_enabled) {
                std::cout << AnsiColors::BrightBlue;
            }
            std::cout << " (" << entry.file_name
                      << ":" << entry.line << ")" << AnsiColors::Reset;
        }
 
        std::cout << '\n';
    }
 
    std::vector<std::unique_ptr<Sink>> m_sinks;
 
    void write_to_sinks(const JournalEntry& entry)
    {
        for (auto& sink : m_sinks) {
            if (sink->is_available()) {
                sink->write(entry);
            }
        }
    }
 
    void write_to_sinks(const RealtimeEntry& entry)
    {
        for (auto& sink : m_sinks) {
            if (sink->is_available()) {
                sink->write(entry);
            }
        }
    }
 
    void start_worker()
    {
        m_worker_running.store(true, std::memory_order_release);
        m_worker_thread = std::thread([this]() { worker_loop(); });
    }
 
    void stop_worker()
    {
        if (m_worker_thread.joinable()) {
            m_worker_running.store(false, std::memory_order_release);
            m_worker_thread.join();
 
            drain_ring_buffer();
        }
    }
 
    void worker_loop()
    {
        using namespace std::chrono_literals;
 
        while (m_worker_running.load(std::memory_order_acquire)) {
            if (m_initialized) {
                drain_ring_buffer();
            }
            std::this_thread::sleep_for(10ms);
        }
 
        if (m_initialized) {
            drain_ring_buffer();
        }
    }
 
    void drain_ring_buffer()
    {
        while (auto entry = m_ring_buffer.pop()) {
 
            std::lock_guard lock(m_mutex);
            if (m_sinks.empty()) {
                write_to_console(*entry);
            } else {
                write_to_sinks(*entry);
            }
        }
 
        auto dropped = m_dropped_messages.exchange(0, std::memory_order_acquire);
        if (dropped > 0) {
            std::lock_guard lock(m_mutex);
            std::cout << "[MayaFlux::Journal] WARNING: Dropped " << dropped
                      << " realtime log messages (buffer full)\n";
        }
    }
 
    std::mutex m_mutex;
    std::atomic<Severity> m_min_severity;
    std::array<bool, magic_enum::enum_count<Component>()> m_component_filters {};
    bool m_initialized {};
 
    Memory::LockFreeQueue<RealtimeEntry, RING_BUFFER_SIZE> m_ring_buffer;
    std::atomic<bool> m_worker_running;
    std::thread m_worker_thread;
    std::atomic<uint64_t> m_dropped_messages { 0 };
 
    std::atomic<bool> m_shutdown_in_progress;
};
 
Archivist& Archivist::instance()
{
    static Archivist archivist;
    return archivist;
}
 
Archivist::Archivist()
    : m_impl(std::make_unique<Impl>())
{
    m_impl->init();
}
 
Archivist::~Archivist() = default;
 
void Archivist::shutdown()
{
    instance().m_impl->shutdown();
}
 
void Archivist::scribe(Severity severity, Component component, Context context,
    std::string_view message, std::source_location location)
{
    JournalEntry entry(severity, component, context, message, location);
    m_impl->scribe(entry);
}
 
void Archivist::scribe_rt(Severity severity, Component component, Context context,
    std::string_view message, std::source_location location)
{
    m_impl->scribe_rt(severity, component, context, message, location);
}
 
void Archivist::scribe_simple(Component component, Context context,
    std::string_view message)
{
    JournalEntry entry(Severity::NONE, component, context, message, std::source_location {});
    m_impl->scribe(entry);
}
 
void Archivist::add_sink(std::unique_ptr<Sink> sink)
{
    m_impl->add_sink(std::move(sink));
}
 
void Archivist::clear_sinks()
{
    m_impl->clear_sinks();
}
 
void Archivist::set_min_severity(Severity min_sev)
{
    m_impl->set_min_severity(min_sev);
}
 
void Archivist::set_component_filter(Component comp, bool enabled)
{
    m_impl->set_component_filter(comp, enabled);
}
 
} // namespace MayaFlux::Journal