09b0e8f2c7
Summary: Timer crash when multiple DB instances doing heavy DB open and close operations concurrently. Which is caused by adding a timer task with smaller timestamp than the current running task. Fix it by moving the getting new task timestamp part within timer mutex protection. And other fixes: - Disallow adding duplicated function name to timer - Fix a minor memory leak in timer when a running task is cancelled Pull Request resolved: https://github.com/facebook/rocksdb/pull/9656 Reviewed By: ajkr Differential Revision: D34626296 Pulled By: jay-zhuang fbshipit-source-id: 6b6d96a5149746bf503546244912a9e41a0c5f6b
128 lines
4.3 KiB
C++
128 lines
4.3 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
// (found in the LICENSE.Apache file in the root directory).
|
|
|
|
#include "db/periodic_work_scheduler.h"
|
|
|
|
#include "db/db_impl/db_impl.h"
|
|
#include "rocksdb/system_clock.h"
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
PeriodicWorkScheduler::PeriodicWorkScheduler(
|
|
const std::shared_ptr<SystemClock>& clock) {
|
|
timer = std::unique_ptr<Timer>(new Timer(clock.get()));
|
|
}
|
|
|
|
Status PeriodicWorkScheduler::Register(DBImpl* dbi,
|
|
unsigned int stats_dump_period_sec,
|
|
unsigned int stats_persist_period_sec) {
|
|
MutexLock l(&timer_mu_);
|
|
static std::atomic<uint64_t> initial_delay(0);
|
|
timer->Start();
|
|
if (stats_dump_period_sec > 0) {
|
|
bool succeeded = timer->Add(
|
|
[dbi]() { dbi->DumpStats(); }, GetTaskName(dbi, "dump_st"),
|
|
initial_delay.fetch_add(1) %
|
|
static_cast<uint64_t>(stats_dump_period_sec) * kMicrosInSecond,
|
|
static_cast<uint64_t>(stats_dump_period_sec) * kMicrosInSecond);
|
|
if (!succeeded) {
|
|
return Status::Aborted("Unable to add periodic task DumpStats");
|
|
}
|
|
}
|
|
if (stats_persist_period_sec > 0) {
|
|
bool succeeded = timer->Add(
|
|
[dbi]() { dbi->PersistStats(); }, GetTaskName(dbi, "pst_st"),
|
|
initial_delay.fetch_add(1) %
|
|
static_cast<uint64_t>(stats_persist_period_sec) * kMicrosInSecond,
|
|
static_cast<uint64_t>(stats_persist_period_sec) * kMicrosInSecond);
|
|
if (!succeeded) {
|
|
return Status::Aborted("Unable to add periodic task PersistStats");
|
|
}
|
|
}
|
|
bool succeeded = timer->Add(
|
|
[dbi]() { dbi->FlushInfoLog(); }, GetTaskName(dbi, "flush_info_log"),
|
|
initial_delay.fetch_add(1) % kDefaultFlushInfoLogPeriodSec *
|
|
kMicrosInSecond,
|
|
kDefaultFlushInfoLogPeriodSec * kMicrosInSecond);
|
|
if (!succeeded) {
|
|
return Status::Aborted("Unable to add periodic task PersistStats");
|
|
}
|
|
return Status::OK();
|
|
}
|
|
|
|
void PeriodicWorkScheduler::Unregister(DBImpl* dbi) {
|
|
MutexLock l(&timer_mu_);
|
|
timer->Cancel(GetTaskName(dbi, "dump_st"));
|
|
timer->Cancel(GetTaskName(dbi, "pst_st"));
|
|
timer->Cancel(GetTaskName(dbi, "flush_info_log"));
|
|
if (!timer->HasPendingTask()) {
|
|
timer->Shutdown();
|
|
}
|
|
}
|
|
|
|
PeriodicWorkScheduler* PeriodicWorkScheduler::Default() {
|
|
// Always use the default SystemClock for the scheduler, as we only use the
|
|
// NowMicros which is the same for all clocks. The Env could only be
|
|
// overridden in test.
|
|
static PeriodicWorkScheduler scheduler(SystemClock::Default());
|
|
return &scheduler;
|
|
}
|
|
|
|
std::string PeriodicWorkScheduler::GetTaskName(DBImpl* dbi,
|
|
const std::string& func_name) {
|
|
std::string db_session_id;
|
|
// TODO: Should this error be ignored?
|
|
dbi->GetDbSessionId(db_session_id).PermitUncheckedError();
|
|
return db_session_id + ":" + func_name;
|
|
}
|
|
|
|
#ifndef NDEBUG
|
|
|
|
// Get the static scheduler. For a new SystemClock, it needs to re-create the
|
|
// internal timer, so only re-create it when there's no running task. Otherwise,
|
|
// return the existing scheduler. Which means if the unittest needs to update
|
|
// MockClock, Close all db instances and then re-open them.
|
|
PeriodicWorkTestScheduler* PeriodicWorkTestScheduler::Default(
|
|
const std::shared_ptr<SystemClock>& clock) {
|
|
static PeriodicWorkTestScheduler scheduler(clock);
|
|
static port::Mutex mutex;
|
|
{
|
|
MutexLock l(&mutex);
|
|
if (scheduler.timer.get() != nullptr &&
|
|
scheduler.timer->TEST_GetPendingTaskNum() == 0) {
|
|
{
|
|
MutexLock timer_mu_guard(&scheduler.timer_mu_);
|
|
scheduler.timer->Shutdown();
|
|
}
|
|
scheduler.timer.reset(new Timer(clock.get()));
|
|
}
|
|
}
|
|
return &scheduler;
|
|
}
|
|
|
|
void PeriodicWorkTestScheduler::TEST_WaitForRun(
|
|
std::function<void()> callback) const {
|
|
if (timer != nullptr) {
|
|
timer->TEST_WaitForRun(callback);
|
|
}
|
|
}
|
|
|
|
size_t PeriodicWorkTestScheduler::TEST_GetValidTaskNum() const {
|
|
if (timer != nullptr) {
|
|
return timer->TEST_GetPendingTaskNum();
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
PeriodicWorkTestScheduler::PeriodicWorkTestScheduler(
|
|
const std::shared_ptr<SystemClock>& clock)
|
|
: PeriodicWorkScheduler(clock) {}
|
|
|
|
#endif // !NDEBUG
|
|
} // namespace ROCKSDB_NAMESPACE
|
|
|
|
#endif // ROCKSDB_LITE
|