LoggerManager.h

#pragma once

#include "quill/core/Attributes.h"
#include "quill/core/Common.h"
#include "quill/core/LogLevel.h"
#include "quill/core/LoggerBase.h"
#include "quill/core/PatternFormatterOptions.h"
#include "quill/core/QuillError.h"
#include "quill/core/Spinlock.h"

#include <algorithm>
#include <atomic>
#include <cstdlib>
#include <initializer_list>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <vector>

QUILL_BEGIN_NAMESPACE

QUILL_BEGIN_EXPORT

class Sink;
class UserClockSource;

QUILL_END_EXPORT

namespace detail
{
class LoggerManager
{
public:
  LoggerManager(LoggerManager const&) = delete;
  LoggerManager& operator=(LoggerManager const&) = delete;

  /***/
  QUILL_EXPORT static LoggerManager& instance() noexcept
  {
    static LoggerManager instance;
    return instance;
  }

  /***/
  QUILL_NODISCARD LoggerBase* get_logger(std::string const& logger_name) const
  {
    LockGuard const lock{_spinlock};
    LoggerBase* logger = _find_logger(logger_name);
    return logger && logger->is_valid_logger() ? logger : nullptr;
  }

  /***/
  QUILL_NODISCARD std::vector<LoggerBase*> get_all_loggers() const
  {
    LockGuard const lock{_spinlock};

    std::vector<LoggerBase*> loggers;

    for (auto const& elem : _loggers)
    {
      // we can not add invalidated loggers as they can be removed at any time
      if (elem->is_valid_logger())
      {
        loggers.push_back(elem.get());
      }
    }

    return loggers;
  }

  /***/
  QUILL_NODISCARD LoggerBase* get_valid_logger(std::string_view exclude_logger_substr = {}) const
  {
    // Retrieves any valid logger without the need for constructing a vector
    LockGuard const lock{_spinlock};

    for (auto const& elem : _loggers)
    {
      // we can not add invalidated loggers as they can be removed at any time
      if (elem->is_valid_logger())
      {
        // Return the logger only if it does not match the exclude_logger_substr
        if (exclude_logger_substr.empty() ||
            elem->get_logger_name().find(exclude_logger_substr) == std::string::npos)
        {
          // Return this logger if it's valid and not excluded
          return elem.get();
        }
      }
    }

    return nullptr;
  }

  /***/
  QUILL_NODISCARD LoggerBase* get_valid_logger(std::vector<std::string> const& exclude_logger_substrs) const
  {
    LockGuard const lock{_spinlock};
    for (auto const& elem : _loggers)
    {
      if (elem->is_valid_logger())
      {
        bool excluded = false;
        for (auto const& exclude_substr : exclude_logger_substrs)
        {
          if (!exclude_substr.empty() && elem->get_logger_name().find(exclude_substr) != std::string::npos)
          {
            excluded = true;
            break;
          }
        }

        if (!excluded)
        {
          return elem.get();
        }
      }
    }
    return nullptr;
  }

  /***/
  QUILL_NODISCARD size_t get_number_of_loggers() const noexcept
  {
    LockGuard const lock{_spinlock};
    return _loggers.size();
  }

  template <typename TCallback>
  void for_each_logger(TCallback cb) const
  {
    LockGuard const lock{_spinlock};

    for (auto const& elem : _loggers)
    {
      // Here we do not check for valid_logger() like in get_all_loggers() because this
      // function is only called by the backend
      if (cb(elem.get()))
      {
        // When the callback returns true stop the loop early
        break;
      }
    }
  }

  template <typename TLogger>
  LoggerBase* create_logger(std::string const& logger_name, std::vector<std::shared_ptr<Sink>> sinks,
                            PatternFormatterOptions const& pattern_formatter_options,
                            ClockSourceType clock_source, UserClockSource* user_clock)
  {
    LockGuard const lock{_spinlock};

    LoggerBase* logger_ptr = _find_logger(logger_name);

    if (logger_ptr && !logger_ptr->is_valid_logger())
    {
      QUILL_THROW(QuillError{"Logger with name \"" + logger_name +
                             "\" is pending removal and cannot be recreated until the backend "
                             "completes logger cleanup. Use remove_logger_blocking() if you need "
                             "to recreate the logger synchronously."});
    }

    if (logger_ptr)
    {
      QUILL_THROW(
        QuillError{"Logger with name \"" + logger_name +
                   "\" already exists. "
                   "Use create_or_get_logger() if you want to retrieve the existing logger, "
                   "or choose a different name."});
    }

    std::unique_ptr<LoggerBase> new_logger{
      new TLogger{logger_name, static_cast<std::vector<std::shared_ptr<Sink>>&&>(sinks),
                  pattern_formatter_options, clock_source, user_clock}};

    _insert_logger(static_cast<std::unique_ptr<LoggerBase>&&>(new_logger));

    logger_ptr = _find_logger(logger_name);

    if (logger_ptr && _env_log_level)
    {
      logger_ptr->set_log_level(*_env_log_level);
    }

    QUILL_ASSERT(logger_ptr, "logger_ptr is nullptr in LoggerManager::create_logger()");
    QUILL_ASSERT(logger_ptr->is_valid_logger(),
                 "logger is not valid in LoggerManager::create_logger()");
    return logger_ptr;
  }

  template <typename TLogger>
  LoggerBase* create_or_get_logger(std::string const& logger_name, std::vector<std::shared_ptr<Sink>> sinks,
                                   PatternFormatterOptions const& pattern_formatter_options,
                                   ClockSourceType clock_source, UserClockSource* user_clock)
  {
    LockGuard const lock{_spinlock};

    LoggerBase* logger_ptr = _find_logger(logger_name);

    if (logger_ptr && !logger_ptr->is_valid_logger())
    {
      QUILL_THROW(QuillError{"Logger with name \"" + logger_name +
                             "\" is pending removal and cannot be recreated until the backend "
                             "completes logger cleanup. Use remove_logger_blocking() if you need "
                             "to recreate the logger synchronously."});
    }

    if (!logger_ptr)
    {
      // If logger pointer is null, create a new logger instance.
      std::unique_ptr<LoggerBase> new_logger{
        new TLogger{logger_name, static_cast<std::vector<std::shared_ptr<Sink>>&&>(sinks),
                    pattern_formatter_options, clock_source, user_clock}};

      _insert_logger(static_cast<std::unique_ptr<LoggerBase>&&>(new_logger));

      // Although we could directly return .get() from the new_logger here,
      // we retain this portion of code for additional safety in case of potential re-lookup of
      // the logger. This section is not performance-critical.
      logger_ptr = _find_logger(logger_name);

      if (logger_ptr && _env_log_level)
      {
        logger_ptr->set_log_level(*_env_log_level);
      }
    }

    QUILL_ASSERT(logger_ptr, "logger_ptr is nullptr in LoggerManager::get_logger()");
    QUILL_ASSERT(logger_ptr->is_valid_logger(),
                 "logger is not valid in LoggerManager::get_logger()");
    return logger_ptr;
  }

  /***/
  template <typename TLogger>
  LoggerBase* create_or_get_logger(std::string const& logger_name, LoggerBase* source_logger)
  {
    if (!source_logger)
    {
      return get_logger(logger_name);
    }

    return create_or_get_logger<TLogger>(logger_name, source_logger->_sinks, source_logger->_pattern_formatter_options,
                                         source_logger->_clock_source, source_logger->_user_clock);
  }

  /***/
  void remove_logger(LoggerBase* logger)
  {
    logger->mark_invalid();
    _has_invalidated_loggers.store(true, std::memory_order_release);
  }

  /***/
  template <typename TCheckQueuesEmpty>
  void cleanup_invalidated_loggers(TCheckQueuesEmpty check_queues_empty, std::vector<std::string>& removed_loggers)
  {
    if (_has_invalidated_loggers.exchange(false, std::memory_order_acq_rel))
    {
      // Defer logger destruction until after _spinlock is released. Destroying a logger drops
      // its sink refcounts, and the last owner runs the sink destructor here, which may invoke
      // user-provided file-event callbacks (e.g. before_close/after_close). Running arbitrary
      // user code under _spinlock could stall frontend logger lookups or deadlock.
      std::vector<std::unique_ptr<LoggerBase>> loggers_to_destroy;

      {
        LockGuard const lock{_spinlock};
        for (auto it = _loggers.begin(); it != _loggers.end();)
        {
          if (!it->get()->is_valid_logger())
          {
            // invalid logger, check if the logger has any pending records in the queue
            if (!check_queues_empty())
            {
              // we have pending records in the queue, we can not remove the logger yet
              ++it;
              _has_invalidated_loggers.store(true, std::memory_order_release);
            }
            else
            {
              removed_loggers.push_back(it->get()->get_logger_name());
              loggers_to_destroy.push_back(static_cast<std::unique_ptr<LoggerBase>&&>(*it));
              it = _loggers.erase(it);
            }
          }
          else
          {
            ++it;
          }
        }
      }
    }
  }

  /***/
  QUILL_NODISCARD bool has_invalidated_loggers() const noexcept
  {
    return _has_invalidated_loggers.load(std::memory_order_acquire);
  }

  QUILL_ATTRIBUTE_COLD void parse_log_level_from_env()
  {
    constexpr char const* field = "QUILL_LOG_LEVEL";

    std::string log_level;

#if defined(_MSC_VER)
    size_t len = 0;
    char buf[128]{};
    bool const ok = ::getenv_s(&len, buf, sizeof(buf), field) == 0;
    if (ok && len > 0)
    {
      log_level = buf;
    }
#else // revert to getenv
    char* buf = ::getenv(field);
    if (buf)
    {
      log_level = buf;
    }
#endif

    if (!log_level.empty())
    {
      QUILL_TRY { _env_log_level = loglevel_from_string(log_level); }
#if !defined(QUILL_NO_EXCEPTIONS)
      QUILL_CATCH(QuillError const& e)
      {
        // Add the environment variable name to the error, otherwise the failure surfaces from
        // the first logger creation with no hint about where the invalid value came from
        QUILL_THROW(QuillError{
          std::string{"invalid \"QUILL_LOG_LEVEL\" environment variable value - "} + e.what()});
      }
#endif
    }
  }

private:
  LoggerManager() { parse_log_level_from_env(); }

  ~LoggerManager() = default;

  /***/
  void _insert_logger(std::unique_ptr<LoggerBase> logger)
  {
    auto search_it = std::lower_bound(_loggers.begin(), _loggers.end(), logger->get_logger_name(),
                                      [](std::unique_ptr<LoggerBase> const& a, std::string const& b)
                                      { return a->get_logger_name() < b; });

    _loggers.insert(search_it, static_cast<std::unique_ptr<LoggerBase>&&>(logger));
  }

  /***/
  QUILL_NODISCARD LoggerBase* _find_logger(std::string const& target) const noexcept
  {
    auto search_it = std::lower_bound(_loggers.begin(), _loggers.end(), target,
                                      [](std::unique_ptr<LoggerBase> const& a, std::string const& b)
                                      { return a->get_logger_name() < b; });

    return (search_it != std::end(_loggers) && search_it->get()->get_logger_name() == target)
      ? search_it->get()
      : nullptr;
  }

private:
  std::vector<std::unique_ptr<LoggerBase>> _loggers;
  std::optional<LogLevel> _env_log_level;
  mutable Spinlock _spinlock;
  std::atomic<bool> _has_invalidated_loggers{false};
};
} // namespace detail

QUILL_END_NAMESPACE