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
120 lines
3.6 KiB
C++
120 lines
3.6 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 "monitoring/statistics.h"
|
|
#include "rocksdb/system_clock.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
// Auto-scoped.
|
|
// Records the measure time into the corresponding histogram if statistics
|
|
// is not nullptr. It is also saved into *elapsed if the pointer is not nullptr
|
|
// and overwrite is true, it will be added to *elapsed if overwrite is false.
|
|
class StopWatch {
|
|
public:
|
|
StopWatch(const std::shared_ptr<SystemClock>& clock, Statistics* statistics,
|
|
const uint32_t hist_type, uint64_t* elapsed = nullptr,
|
|
bool overwrite = true, bool delay_enabled = false)
|
|
: clock_(clock),
|
|
statistics_(statistics),
|
|
hist_type_(hist_type),
|
|
elapsed_(elapsed),
|
|
overwrite_(overwrite),
|
|
stats_enabled_(statistics &&
|
|
statistics->get_stats_level() >=
|
|
StatsLevel::kExceptTimers &&
|
|
statistics->HistEnabledForType(hist_type)),
|
|
delay_enabled_(delay_enabled),
|
|
total_delay_(0),
|
|
delay_start_time_(0),
|
|
start_time_((stats_enabled_ || elapsed != nullptr) ? clock->NowMicros()
|
|
: 0) {}
|
|
|
|
~StopWatch() {
|
|
if (elapsed_) {
|
|
if (overwrite_) {
|
|
*elapsed_ = clock_->NowMicros() - start_time_;
|
|
} else {
|
|
*elapsed_ += clock_->NowMicros() - start_time_;
|
|
}
|
|
}
|
|
if (elapsed_ && delay_enabled_) {
|
|
*elapsed_ -= total_delay_;
|
|
}
|
|
if (stats_enabled_) {
|
|
statistics_->reportTimeToHistogram(
|
|
hist_type_, (elapsed_ != nullptr)
|
|
? *elapsed_
|
|
: (clock_->NowMicros() - start_time_));
|
|
}
|
|
}
|
|
|
|
void DelayStart() {
|
|
// if delay_start_time_ is not 0, it means we are already tracking delay,
|
|
// so delay_start_time_ should not be overwritten
|
|
if (elapsed_ && delay_enabled_ && delay_start_time_ == 0) {
|
|
delay_start_time_ = clock_->NowMicros();
|
|
}
|
|
}
|
|
|
|
void DelayStop() {
|
|
if (elapsed_ && delay_enabled_ && delay_start_time_ != 0) {
|
|
total_delay_ += clock_->NowMicros() - delay_start_time_;
|
|
}
|
|
// reset to 0 means currently no delay is being tracked, so two consecutive
|
|
// calls to DelayStop will not increase total_delay_
|
|
delay_start_time_ = 0;
|
|
}
|
|
|
|
uint64_t GetDelay() const { return delay_enabled_ ? total_delay_ : 0; }
|
|
|
|
uint64_t start_time() const { return start_time_; }
|
|
|
|
private:
|
|
const std::shared_ptr<SystemClock> clock_;
|
|
Statistics* statistics_;
|
|
const uint32_t hist_type_;
|
|
uint64_t* elapsed_;
|
|
bool overwrite_;
|
|
bool stats_enabled_;
|
|
bool delay_enabled_;
|
|
uint64_t total_delay_;
|
|
uint64_t delay_start_time_;
|
|
const uint64_t start_time_;
|
|
};
|
|
|
|
// a nano second precision stopwatch
|
|
class StopWatchNano {
|
|
public:
|
|
explicit StopWatchNano(const std::shared_ptr<SystemClock>& clock,
|
|
bool auto_start = false)
|
|
: clock_(clock), start_(0) {
|
|
if (auto_start) {
|
|
Start();
|
|
}
|
|
}
|
|
|
|
void Start() { start_ = clock_->NowNanos(); }
|
|
|
|
uint64_t ElapsedNanos(bool reset = false) {
|
|
auto now = clock_->NowNanos();
|
|
auto elapsed = now - start_;
|
|
if (reset) {
|
|
start_ = now;
|
|
}
|
|
return elapsed;
|
|
}
|
|
|
|
uint64_t ElapsedNanosSafe(bool reset = false) {
|
|
return (clock_ != nullptr) ? ElapsedNanos(reset) : 0U;
|
|
}
|
|
|
|
private:
|
|
const std::shared_ptr<SystemClock> clock_;
|
|
uint64_t start_;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|