mirror of
https://github.com/facebook/rocksdb.git
synced 2024-11-29 18:33:58 +00:00
12f1137355
Summary: Introduces and uses a SystemClock class to RocksDB. This class contains the time-related functions of an Env and these functions can be redirected from the Env to the SystemClock. Many of the places that used an Env (Timer, PerfStepTimer, RepeatableThread, RateLimiter, WriteController) for time-related functions have been changed to use SystemClock instead. There are likely more places that can be changed, but this is a start to show what can/should be done. Over time it would be nice to migrate most (if not all) of the uses of the time functions from the Env to the SystemClock. There are several Env classes that implement these functions. Most of these have not been converted yet to SystemClock implementations; that will come in a subsequent PR. It would be good to unify many of the Mock Timer implementations, so that they behave similarly and be tested similarly (some override Sleep, some use a MockSleep, etc). Additionally, this change will allow new methods to be introduced to the SystemClock (like https://github.com/facebook/rocksdb/issues/7101 WaitFor) in a consistent manner across a smaller number of classes. Pull Request resolved: https://github.com/facebook/rocksdb/pull/7858 Reviewed By: pdillinger Differential Revision: D26006406 Pulled By: mrambacher fbshipit-source-id: ed10a8abbdab7ff2e23d69d85bd25b3e7e899e90
78 lines
2.7 KiB
C++
78 lines
2.7 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).
|
|
|
|
#pragma once
|
|
|
|
#include <atomic>
|
|
#include <limits>
|
|
|
|
#include "rocksdb/system_clock.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
// NOTE: SpecialEnv offers most of this functionality, along with hooks
|
|
// for safe DB behavior under a mock time environment, so should be used
|
|
// instead of MockSystemClock for DB tests.
|
|
class MockSystemClock : public SystemClockWrapper {
|
|
public:
|
|
explicit MockSystemClock(const std::shared_ptr<SystemClock>& base)
|
|
: SystemClockWrapper(base) {}
|
|
|
|
const char* Name() const override { return "MockSystemClock"; }
|
|
virtual Status GetCurrentTime(int64_t* time_sec) override {
|
|
assert(time_sec != nullptr);
|
|
*time_sec = static_cast<int64_t>(current_time_us_ / kMicrosInSecond);
|
|
return Status::OK();
|
|
}
|
|
|
|
virtual uint64_t NowSeconds() { return current_time_us_ / kMicrosInSecond; }
|
|
|
|
virtual uint64_t NowMicros() override { return current_time_us_; }
|
|
|
|
virtual uint64_t NowNanos() override {
|
|
assert(current_time_us_ <= std::numeric_limits<uint64_t>::max() / 1000);
|
|
return current_time_us_ * 1000;
|
|
}
|
|
|
|
uint64_t RealNowMicros() { return target_->NowMicros(); }
|
|
|
|
void SetCurrentTime(uint64_t time_sec) {
|
|
assert(time_sec < std::numeric_limits<uint64_t>::max() / kMicrosInSecond);
|
|
assert(time_sec * kMicrosInSecond >= current_time_us_);
|
|
current_time_us_ = time_sec * kMicrosInSecond;
|
|
}
|
|
|
|
// It's a fake sleep that just updates the Env current time, which is similar
|
|
// to `NoSleepEnv.SleepForMicroseconds()` and
|
|
// `SpecialEnv.MockSleepForMicroseconds()`.
|
|
// It's also similar to `set_current_time()`, which takes an absolute time in
|
|
// seconds, vs. this one takes the sleep in microseconds.
|
|
// Note: Not thread safe.
|
|
void MockSleepForMicroseconds(int micros) {
|
|
assert(micros >= 0);
|
|
assert(current_time_us_ + static_cast<uint64_t>(micros) >=
|
|
current_time_us_);
|
|
current_time_us_.fetch_add(micros);
|
|
}
|
|
|
|
void MockSleepForSeconds(int seconds) {
|
|
assert(seconds >= 0);
|
|
uint64_t micros = static_cast<uint64_t>(seconds) * kMicrosInSecond;
|
|
assert(current_time_us_ + micros >= current_time_us_);
|
|
current_time_us_.fetch_add(micros);
|
|
}
|
|
|
|
// TODO: this is a workaround for the different behavior on different platform
|
|
// for timedwait timeout. Ideally timedwait API should be moved to env.
|
|
// details: PR #7101.
|
|
void InstallTimedWaitFixCallback();
|
|
|
|
private:
|
|
std::atomic<uint64_t> current_time_us_{0};
|
|
static constexpr uint64_t kMicrosInSecond = 1000U * 1000U;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|