8000 Add locking to setting and getting the default Logger by tgoyne · Pull Request #6398 · realm/realm-core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add locking to setting and getting the default Logger #6398

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.

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
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

### Fixed
* `SyncSession::pause()` could hold a reference to the database open after shutting down the sync session, preventing users from being able to delete the realm. ([#6372](https://github.com/realm/realm-core/issues/6372), since v13.3.0)
* `Logger::set_default_logger()` did not perform any locking, resulting in data races if it was called while the default logger was being read on another thread ([PR #6398](https://github.com/realm/realm-core/pull/6398), since v13.7.0).

### Breaking changes
* None.
Expand Down
5 changes: 2 additions & 3 deletions src/realm/object-store/sync/app.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ void App::configure(const SyncClientConfig& sync_client_config)
}
}

inline bool App::init_logger()
bool App::init_logger()
{
if (!m_logger_ptr) {
m_logger_ptr = util::Logger::get_default_logger();
Expand All @@ -279,8 +279,7 @@ inline bool App::init_logger()

bool App::would_log(util::Logger::Level level)
{
init_logger();
return m_logger_ptr && m_logger_ptr->would_log(level);
return init_logger() && m_logger_ptr->would_log(level);
}

template <class... Params>
Expand Down
2 changes: 1 addition & 1 deletion src/realm/object-store/sync/app.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ class App : public std::enable_shared_from_this<App>,
std::shared_ptr<SyncManager> m_sync_manager;
std::shared_ptr<util::Logger> m_logger_ptr;

/// m_Logger_ptr is not set until the first call to one of these functions.
/// m_logger_ptr is not set until the first call to one of these functions.
/// If configure() not been called, a logger will not be available yet.
/// @returns true if the logger was set, otherwise false.
bool init_logger();
Expand Down
13 changes: 10 additions & 3 deletions src/realm/util/logger.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,25 @@
#include <realm/util/logger.hpp>

#include <iostream>
#include <mutex>

namespace realm::util {

std::shared_ptr<util::Logger> Logger::s_default_logger;
Logger::Level Logger::s_default_level = Level::info;
namespace {
auto& s_logger_mutex = *new std::mutex;
std::shared_ptr<util::Logger> s_default_logger;
std::atomic<Logger::Level> s_default_level = Logger::Level::info;
} // anonymous namespace

void Logger::set_default_logger(std::shared_ptr<util::Logger> logger) noexcept
{
std::lock_guard lock(s_logger_mutex);
s_default_logger = logger;
}

std::shared_ptr<util::Logger>& Logger::get_default_logger() noexcept
{
std::lock_guard lock(s_logger_mutex);
if (!s_default_logger) {
s_default_logger = std::make_shared<StderrLogger>();
s_default_logger->set_level_threshold(s_default_level);
Expand All @@ -42,14 +48,15 @@ std::shared_ptr<util::Logger>& Logger::get_default_logger() noexcept

void Logger::set_default_level_threshold(Level level) noexcept
{
std::lock_guard lock(s_logger_mutex);
s_default_level = level;
if (s_default_logger)
s_default_logger->set_level_threshold(level);
}

Logger::Level Logger::get_default_level_threshold() noexcept
{
return s_default_level;
return s_default_level.load(std::memory_order_relaxed);
}

const char* Logger::get_level_prefix(Level level) noexcept
Expand Down
4 changes: 1 addition & 3 deletions src/realm/util/logger.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ class Logger {

Logger() noexcept
: m_level_threshold{m_threshold_base}
, m_threshold_base{Logger::s_default_level}
, m_threshold_base{get_default_level_threshold()}
{
}

Expand All @@ -140,8 +140,6 @@ class Logger {
static const char* get_level_prefix(Level) noexcept;

private:
static std::shared_ptr<util::Logger> s_default_logger;
static Level s_default_level;
// Only used by the base Logger class
std::atomic<Level> m_threshold_base;

Expand Down
0