destiny-2-Sunrise/Sunrise/src/core/logging/log.h

#pragma once

#include <array>
#include <cstddef>
#include <span>
#include <string_view>

namespace sunrise::core::log {

/** 1 KiB caps each serialized event, with room for a trailing null byte. */
inline constexpr std::size_t kLineCapacity = 1024;

/** Subsystem owning one structured log event. */
enum class Channel : std::size_t {
    core,
    client,
    state,
    server,
    middleware,
    count,
};

/** Minimum severity accepted by one log channel. */
enum class Level : unsigned char {
    error,
    warn,
    info,
    debug,
    off,
};

/** Process-wide logging thresholds and sink selection. */
struct Settings {
    std::array<Level, static_cast<std::size_t>(Channel::count)> levels{};
    bool debuggerSink{true};
    bool fileSink{false};
};

/** Returns logging defaults with persistent output disabled. */
[[nodiscard]] Settings defaults() noexcept;

/** Starts configured logging sinks relative to the DLL module. */
[[nodiscard]] bool initialize(void* module, const Settings& settings) noexcept;

/** Closes active sinks and clears the bounded in-memory log view. */
void shutdown() noexcept;

/** @return True while the channel threshold admits this severity. */
[[nodiscard]] bool accepts(Channel channel, Level level) noexcept;

/** Emits one structured event when allowed by the channel threshold. */
void write(Channel channel, Level level, std::string_view event) noexcept;

/**
 * Formats and emits one structured event when allowed by the channel threshold.
 *
 * The line is built in `kLineCapacity` storage and truncated to fit, which is what every caller
 * that spelled out its own array and `snprintf` did by hand. Nothing is formatted for a level the
 * channel refuses, so a debug line costs nothing when debug is off.
 *
 * @param channel Subsystem owning the event.
 * @param level Severity of the event.
 * @param format printf-style format; `%s` arguments must be NUL-terminated.
 */
void writef(Channel channel, Level level, const char* format, ...) noexcept;

/**
 * Emits one debug event carrying a duration in the ms field.
 * Timing is diagnostic, so it stays off at the levels a normal run uses.
 * @param channel Channel owning the measured boundary.
 * @param event Event and phase text the duration is appended to.
 * @param startedTick GetTickCount64 value taken when the boundary began.
 * @param result Outcome text for the log line.
 */
void write_elapsed(Channel channel,
                   std::string_view event,
                   unsigned long long startedTick,
                   std::string_view result) noexcept;

/**
 * Appends bytes as uppercase hex to a line that already holds its key prefix.
 * Stops before the first pair that would not fit, so a long payload truncates.
 * @param line Line storage holding the prefix.
 * @param length Bytes already written, raised by two for each encoded byte.
 * @param bytes Borrowed payload to encode.
 * @return True when every byte fit.
 */
bool append_hex(std::span<char> line,
                std::size_t& length,
                std::span<const std::byte> bytes) noexcept;

/**
 * Reports whether any thread is inside a sink write.
 * A sink holds an operating system lock this process shares, so a thread suspended there
 * blocks the next writer. Nothing may suspend process threads while this is true.
 * @return True while a sink write is in progress.
 */
[[nodiscard]] bool writers_active() noexcept;

/**
 * Writes one line straight to the debugger, bypassing the sinks and every threshold.
 * Settings are read before the sinks exist, so a boot failure there has no other channel.
 */
void early(std::string_view event) noexcept;

} // namespace sunrise::core::log