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
111 lines
4.1 KiB
C++
111 lines
4.1 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 "util/repeatable_thread.h"
|
|
|
|
#include <atomic>
|
|
#include <memory>
|
|
|
|
#include "db/db_test_util.h"
|
|
#include "test_util/mock_time_env.h"
|
|
#include "test_util/sync_point.h"
|
|
#include "test_util/testharness.h"
|
|
|
|
class RepeatableThreadTest : public testing::Test {
|
|
public:
|
|
RepeatableThreadTest()
|
|
: mock_clock_(std::make_shared<ROCKSDB_NAMESPACE::MockSystemClock>(
|
|
ROCKSDB_NAMESPACE::SystemClock::Default())) {}
|
|
|
|
protected:
|
|
std::shared_ptr<ROCKSDB_NAMESPACE::MockSystemClock> mock_clock_;
|
|
};
|
|
|
|
TEST_F(RepeatableThreadTest, TimedTest) {
|
|
constexpr uint64_t kSecond = 1000000; // 1s = 1000000us
|
|
constexpr int kIteration = 3;
|
|
const auto& clock = ROCKSDB_NAMESPACE::SystemClock::Default();
|
|
ROCKSDB_NAMESPACE::port::Mutex mutex;
|
|
ROCKSDB_NAMESPACE::port::CondVar test_cv(&mutex);
|
|
int count = 0;
|
|
uint64_t prev_time = clock->NowMicros();
|
|
ROCKSDB_NAMESPACE::RepeatableThread thread(
|
|
[&] {
|
|
ROCKSDB_NAMESPACE::MutexLock l(&mutex);
|
|
count++;
|
|
uint64_t now = clock->NowMicros();
|
|
assert(count == 1 || prev_time + 1 * kSecond <= now);
|
|
prev_time = now;
|
|
if (count >= kIteration) {
|
|
test_cv.SignalAll();
|
|
}
|
|
},
|
|
"rt_test", clock, 1 * kSecond);
|
|
// Wait for execution finish.
|
|
{
|
|
ROCKSDB_NAMESPACE::MutexLock l(&mutex);
|
|
while (count < kIteration) {
|
|
test_cv.Wait();
|
|
}
|
|
}
|
|
|
|
// Test cancel
|
|
thread.cancel();
|
|
}
|
|
|
|
TEST_F(RepeatableThreadTest, MockEnvTest) {
|
|
constexpr uint64_t kSecond = 1000000; // 1s = 1000000us
|
|
constexpr int kIteration = 3;
|
|
mock_clock_->SetCurrentTime(0); // in seconds
|
|
std::atomic<int> count{0};
|
|
|
|
#if defined(OS_MACOSX) && !defined(NDEBUG)
|
|
ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->DisableProcessing();
|
|
ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->ClearAllCallBacks();
|
|
ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->SetCallBack(
|
|
"InstrumentedCondVar::TimedWaitInternal", [&](void* arg) {
|
|
// Obtain the current (real) time in seconds and add 1000 extra seconds
|
|
// to ensure that RepeatableThread::wait invokes TimedWait with a time
|
|
// greater than (real) current time. This is to prevent the TimedWait
|
|
// function from returning immediately without sleeping and releasing
|
|
// the mutex on certain platforms, e.g. OS X. If TimedWait returns
|
|
// immediately, the mutex will not be released, and
|
|
// RepeatableThread::TEST_WaitForRun never has a chance to execute the
|
|
// callback which, in this case, updates the result returned by
|
|
// mock_clock->NowMicros. Consequently, RepeatableThread::wait cannot
|
|
// break out of the loop, causing test to hang. The extra 1000 seconds
|
|
// is a best-effort approach because there seems no reliable and
|
|
// deterministic way to provide the aforementioned guarantee. By the
|
|
// time RepeatableThread::wait is called, it is no guarantee that the
|
|
// delay + mock_clock->NowMicros will be greater than the current real
|
|
// time. However, 1000 seconds should be sufficient in most cases.
|
|
uint64_t time_us = *reinterpret_cast<uint64_t*>(arg);
|
|
if (time_us < mock_clock_->RealNowMicros()) {
|
|
*reinterpret_cast<uint64_t*>(arg) =
|
|
mock_clock_->RealNowMicros() + 1000;
|
|
}
|
|
});
|
|
ROCKSDB_NAMESPACE::SyncPoint::GetInstance()->EnableProcessing();
|
|
#endif // OS_MACOSX && !NDEBUG
|
|
|
|
ROCKSDB_NAMESPACE::RepeatableThread thread(
|
|
[&] { count++; }, "rt_test", mock_clock_, 1 * kSecond, 1 * kSecond);
|
|
for (int i = 1; i <= kIteration; i++) {
|
|
// Bump current time
|
|
thread.TEST_WaitForRun([&] { mock_clock_->SetCurrentTime(i); });
|
|
}
|
|
// Test function should be exectued exactly kIteraion times.
|
|
ASSERT_EQ(kIteration, count.load());
|
|
|
|
// Test cancel
|
|
thread.cancel();
|
|
}
|
|
|
|
int main(int argc, char** argv) {
|
|
::testing::InitGoogleTest(&argc, argv);
|
|
|
|
return RUN_ALL_TESTS();
|
|
}
|