rocksdb-native 2.6.2 → 2.6.4

package/vendor/librocksdb/vendor/rocksdb/include/rocksdb/filter_policy.h

@@ -1,211 +0,0 @@
-// 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).
-// Copyright (c) 2012 The LevelDB Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file. See the AUTHORS file for names of contributors.
-//
-// A database can be configured with a custom FilterPolicy object.
-// This object is responsible for creating a small filter from a set
-// of keys.  These filters are stored in rocksdb and are consulted
-// automatically by rocksdb to decide whether or not to read some
-// information from disk. In many cases, a filter can cut down the
-// number of disk seeks form a handful to a single disk seek per
-// DB::Get() call.
-//
-// Most people will want to use the builtin bloom filter support (see
-// NewBloomFilterPolicy() below).
-
-#pragma once
-
-#include <stdlib.h>
-
-#include <algorithm>
-#include <memory>
-#include <stdexcept>
-#include <string>
-#include <vector>
-
-#include "rocksdb/advanced_options.h"
-#include "rocksdb/customizable.h"
-#include "rocksdb/status.h"
-#include "rocksdb/types.h"
-
-namespace ROCKSDB_NAMESPACE {
-
-class Slice;
-struct BlockBasedTableOptions;
-struct ConfigOptions;
-
-// As of RocksDB 7.0, the details of these classes are internal
-class FilterBitsBuilder;
-class FilterBitsReader;
-
-// Contextual information passed to BloomFilterPolicy at filter building time.
-// Used in overriding FilterPolicy::GetBuilderWithContext(). References other
-// structs because this is expected to be a temporary, stack-allocated object.
-struct FilterBuildingContext {
-  // This constructor is for internal use only and subject to change.
-  FilterBuildingContext(const BlockBasedTableOptions& table_options);
-
-  // Options for the table being built
-  const BlockBasedTableOptions& table_options;
-
-  // BEGIN from (DB|ColumnFamily)Options in effect at table creation time
-  CompactionStyle compaction_style = kCompactionStyleLevel;
-
-  // Number of LSM levels, or -1 if unknown
-  int num_levels = -1;
-
-  // An optional logger for reporting errors, warnings, etc.
-  Logger* info_log = nullptr;
-  // END from (DB|ColumnFamily)Options
-
-  // Name of the column family for the table (or empty string if unknown)
-  // TODO: consider changing to Slice
-  std::string column_family_name;
-
-  // The table level at time of constructing the SST file, or -1 if unknown
-  // or N/A as in SstFileWriter. (The table file could later be used at a
-  // different level.)
-  int level_at_creation = -1;
-
-  // True if known to be going into bottommost sorted run for applicable
-  // key range (which might not even be last level with data). False
-  // otherwise.
-  bool is_bottommost = false;
-
-  // Reason for creating the file with the filter
-  TableFileCreationReason reason = TableFileCreationReason::kMisc;
-};
-
-// Determines what kind of filter (if any) to generate in SST files, and under
-// which conditions. API users can create custom filter policies that
-// defer to other built-in policies (see NewBloomFilterPolicy and
-// NewRibbonFilterPolicy) based on the context provided to
-// GetBuilderWithContext.
-class FilterPolicy : public Customizable {
- public:
-  virtual ~FilterPolicy();
-  static const char* Type() { return "FilterPolicy"; }
-
-  // The name used for identifying whether a filter on disk is readable
-  // by this FilterPolicy. If this FilterPolicy is part of a family that
-  // can read each others filters, such as built-in BloomFilterPolcy and
-  // RibbonFilterPolicy, the CompatibilityName is a shared family name,
-  // while kinds of filters in the family can have distinct Customizable
-  // Names. This function is pure virtual so that wrappers around built-in
-  // policies are prompted to defer to CompatibilityName() of the wrapped
-  // policy, which is important for compatibility.
-  //
-  // For custom filter policies that are not part of a read-compatible
-  // family (rare), implementations may return Name().
-  virtual const char* CompatibilityName() const = 0;
-
-  // Creates a new FilterPolicy based on the input value string and returns the
-  // result The value might be an ID, and ID with properties, or an old-style
-  // policy string.
-  // The value describes the FilterPolicy being created.
-  // For BloomFilters, value may be a ":"-delimited value of the form:
-  //   "bloomfilter:[bits_per_key]",
-  //   e.g. ""bloomfilter:4"
-  //   The above string is equivalent to calling NewBloomFilterPolicy(4).
-  static Status CreateFromString(const ConfigOptions& config_options,
-                                 const std::string& value,
-                                 std::shared_ptr<const FilterPolicy>* result);
-
-  // Return a new FilterBitsBuilder for constructing full or partitioned
-  // filter blocks, or return nullptr to indicate "no filter". Custom
-  // implementations should defer to a built-in FilterPolicy to get a
-  // new FilterBitsBuilder, but the FilterBuildingContext can be used
-  // to decide which built-in FilterPolicy to defer to.
-  virtual FilterBitsBuilder* GetBuilderWithContext(
-      const FilterBuildingContext&) const = 0;
-
-  // Return a new FilterBitsReader for full or partitioned filter blocks.
-  // Caller retains ownership of any buffer pointed to by the input Slice.
-  // Custom implementation should defer to GetFilterBitsReader on any
-  // built-in FilterPolicy, which can read filters generated by any other
-  // built-in FilterPolicy.
-  virtual FilterBitsReader* GetFilterBitsReader(
-      const Slice& /*contents*/) const = 0;
-};
-
-// Return a new filter policy that uses a bloom filter with approximately
-// the specified number of bits per key. See
-// https://github.com/facebook/rocksdb/wiki/RocksDB-Bloom-Filter
-//
-// bits_per_key: average bits allocated per key in bloom filter. A good
-// choice is 9.9, which yields a filter with ~ 1% false positive rate.
-// When format_version < 5, the value will be rounded to the nearest
-// integer. Recommend using no more than three decimal digits after the
-// decimal point, as in 6.667.
-//
-// To avoid configurations that are unlikely to produce good filtering
-// value for the CPU overhead, bits_per_key < 0.5 is rounded down to 0.0
-// which means "generate no filter", and 0.5 <= bits_per_key < 1.0 is
-// rounded up to 1.0, for a 62% FP rate.
-//
-// The caller is responsible for eventually deleting the result, though
-// this is typically handled automatically with BlockBasedTableOptions:
-//   table_options.filter_policy.reset(NewBloomFilterPolicy(...));
-//
-// As of RocksDB 7.0, the use_block_based_builder parameter is ignored.
-// (The old, inefficient block-based filter is no longer accessible in
-// the public API.)
-//
-// Note: if you are using a custom comparator that ignores some parts
-// of the keys being compared, you must not use NewBloomFilterPolicy()
-// and must provide your own FilterPolicy that also ignores the
-// corresponding parts of the keys.  For example, if the comparator
-// ignores trailing spaces, it would be incorrect to use a
-// FilterPolicy (like NewBloomFilterPolicy) that does not ignore
-// trailing spaces in keys.
-const FilterPolicy* NewBloomFilterPolicy(
-    double bits_per_key, bool IGNORED_use_block_based_builder = false);
-
-// A new Bloom alternative that saves about 30% space compared to
-// Bloom filters, with similar query times but roughly 3-4x CPU time
-// and 3x temporary space usage during construction.  For example, if
-// you pass in 10 for bloom_equivalent_bits_per_key, you'll get the same
-// 0.95% FP rate as Bloom filter but only using about 7 bits per key.
-//
-// The space savings of Ribbon filters makes sense for lower (higher
-// numbered; larger; longer-lived) levels of LSM, whereas the speed of
-// Bloom filters make sense for highest levels of LSM. Setting
-// bloom_before_level allows for this design with Level and Universal
-// compaction styles. For example, bloom_before_level=1 means that Bloom
-// filters will be used in level 0, including flushes, and Ribbon
-// filters elsewhere, including FIFO compaction and external SST files.
-// For this option, memtable flushes are considered level -1 (so that
-// flushes can be distinguished from intra-L0 compaction).
-// bloom_before_level=0 (default) -> Generate Bloom filters only for
-// flushes under Level and Universal compaction styles.
-// bloom_before_level=-1 -> Always generate Ribbon filters (except in
-// some extreme or exceptional cases).
-// bloom_before_level=INT_MAX -> Always generate Bloom filters.
-//
-// The bloom_before_level option is mutable in the Configurable interface
-// and through the SetOptions() API, as in
-// db->SetOptions({{"table_factory.filter_policy.bloom_before_level", "3"}});
-//
-// Ribbon filters are compatible with RocksDB >= 6.15.0. Earlier
-// versions reading the data will behave as if no filter was used
-// (degraded performance until compaction rebuilds filters). All
-// built-in FilterPolicies (Bloom or Ribbon) are able to read other
-// kinds of built-in filters.
-//
-// Note: the current Ribbon filter schema uses some extra resources
-// when constructing very large filters. For example, for 100 million
-// keys in a single filter (one SST file without partitioned filters),
-// 3GB of temporary, untracked memory is used, vs. 1GB for Bloom.
-// However, the savings in filter space from just ~60 open SST files
-// makes up for the additional temporary memory use.
-//
-// Also consider using optimize_filters_for_memory to save filter
-// memory.
-FilterPolicy* NewRibbonFilterPolicy(double bloom_equivalent_bits_per_key,
-                                    int bloom_before_level = 0);
-
-}  // namespace ROCKSDB_NAMESPACE

package/vendor/librocksdb/vendor/rocksdb/include/rocksdb/flush_block_policy.h

@@ -1,75 +0,0 @@
-// 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 <string>
-
-#include "rocksdb/customizable.h"
-#include "rocksdb/table.h"
-
-namespace ROCKSDB_NAMESPACE {
-
-class Slice;
-class BlockBuilder;
-struct ConfigOptions;
-struct Options;
-
-// FlushBlockPolicy provides a configurable way to determine when to flush a
-// block in the block based tables.
-//
-// Exceptions MUST NOT propagate out of overridden functions into RocksDB,
-// because RocksDB is not exception-safe. This could cause undefined behavior
-// including data loss, unreported corruption, deadlocks, and more.
-class FlushBlockPolicy {
- public:
-  // Keep track of the key/value sequences and return the boolean value to
-  // determine if table builder should flush current data block.
-  virtual bool Update(const Slice& key, const Slice& value) = 0;
-
-  virtual ~FlushBlockPolicy() {}
-};
-
-class FlushBlockPolicyFactory : public Customizable {
- public:
-  static const char* Type() { return "FlushBlockPolicyFactory"; }
-
-  // Creates a FlushBlockPolicyFactory based on the input value.
-  // By default, this method can create EveryKey or BySize PolicyFactory,
-  // which take now config_options.
-  static Status CreateFromString(
-      const ConfigOptions& config_options, const std::string& value,
-      std::shared_ptr<FlushBlockPolicyFactory>* result);
-
-  // Return a new block flush policy that flushes data blocks by data size.
-  // FlushBlockPolicy may need to access the metadata of the data block
-  // builder to determine when to flush the blocks.
-  //
-  // Callers must delete the result after any database that is using the
-  // result has been closed.
-  virtual FlushBlockPolicy* NewFlushBlockPolicy(
-      const BlockBasedTableOptions& table_options,
-      const BlockBuilder& data_block_builder) const = 0;
-
-  virtual ~FlushBlockPolicyFactory() {}
-};
-
-class FlushBlockBySizePolicyFactory : public FlushBlockPolicyFactory {
- public:
-  FlushBlockBySizePolicyFactory();
-
-  static const char* kClassName() { return "FlushBlockBySizePolicyFactory"; }
-  const char* Name() const override { return kClassName(); }
-
-  FlushBlockPolicy* NewFlushBlockPolicy(
-      const BlockBasedTableOptions& table_options,
-      const BlockBuilder& data_block_builder) const override;
-
-  static FlushBlockPolicy* NewFlushBlockPolicy(
-      const uint64_t size, const int deviation,
-      const BlockBuilder& data_block_builder);
-};
-
-}  // namespace ROCKSDB_NAMESPACE

package/vendor/librocksdb/vendor/rocksdb/include/rocksdb/functor_wrapper.h

@@ -1,56 +0,0 @@
-//  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 <functional>
-#include <memory>
-#include <utility>
-
-#include "rocksdb/rocksdb_namespace.h"
-
-namespace ROCKSDB_NAMESPACE {
-
-namespace detail {
-template <std::size_t...>
-struct IndexSequence {};
-
-template <std::size_t N, std::size_t... Next>
-struct IndexSequenceHelper
-    : public IndexSequenceHelper<N - 1U, N - 1U, Next...> {};
-
-template <std::size_t... Next>
-struct IndexSequenceHelper<0U, Next...> {
-  using type = IndexSequence<Next...>;
-};
-
-template <std::size_t N>
-using make_index_sequence = typename IndexSequenceHelper<N>::type;
-
-template <typename Function, typename Tuple, size_t... I>
-void call(Function f, Tuple t, IndexSequence<I...>) {
-  f(std::get<I>(t)...);
-}
-
-template <typename Function, typename Tuple>
-void call(Function f, Tuple t) {
-  static constexpr auto size = std::tuple_size<Tuple>::value;
-  call(f, t, make_index_sequence<size>{});
-}
-}  // namespace detail
-
-template <typename... Args>
-class FunctorWrapper {
- public:
-  explicit FunctorWrapper(std::function<void(Args...)> functor, Args &&...args)
-      : functor_(std::move(functor)), args_(std::forward<Args>(args)...) {}
-
-  void invoke() { detail::call(functor_, args_); }
-
- private:
-  std::function<void(Args...)> functor_;
-  std::tuple<Args...> args_;
-};
-}  // namespace ROCKSDB_NAMESPACE

package/vendor/librocksdb/vendor/rocksdb/include/rocksdb/io_status.h

@@ -1,244 +0,0 @@
-// Copyright (c) 2019-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).
-//
-// An IOStatus encapsulates the result of an operation.  It may indicate
-// success, or it may indicate an error with an associated error message.
-//
-// Multiple threads can invoke const methods on an IOStatus without
-// external synchronization, but if any of the threads may call a
-// non-const method, all threads accessing the same IOStatus must use
-// external synchronization.
-
-#pragma once
-
-#include <string>
-
-#include "rocksdb/slice.h"
-#ifdef OS_WIN
-#include <string.h>
-#endif
-#include <cstring>
-
-#include "status.h"
-
-namespace ROCKSDB_NAMESPACE {
-
-class IOStatus : public Status {
- public:
-  using Code = Status::Code;
-  using SubCode = Status::SubCode;
-
-  enum IOErrorScope : unsigned char {
-    kIOErrorScopeFileSystem,
-    kIOErrorScopeFile,
-    kIOErrorScopeRange,
-    kIOErrorScopeMax,
-  };
-
-  // Create a success status.
-  IOStatus() : IOStatus(kOk, kNone) {}
-  ~IOStatus() {}
-
-  // Copy the specified status.
-  IOStatus(const IOStatus& s);
-  IOStatus& operator=(const IOStatus& s);
-  IOStatus(IOStatus&& s) noexcept;
-  IOStatus& operator=(IOStatus&& s) noexcept;
-  bool operator==(const IOStatus& rhs) const;
-  bool operator!=(const IOStatus& rhs) const;
-
-  void SetRetryable(bool retryable) { retryable_ = retryable; }
-  void SetDataLoss(bool data_loss) { data_loss_ = data_loss; }
-  void SetScope(IOErrorScope scope) {
-    scope_ = static_cast<unsigned char>(scope);
-  }
-
-  bool GetRetryable() const { return retryable_; }
-  bool GetDataLoss() const { return data_loss_; }
-  IOErrorScope GetScope() const { return static_cast<IOErrorScope>(scope_); }
-
-  // Return a success status.
-  static IOStatus OK() { return IOStatus(); }
-
-  static IOStatus NotSupported(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kNotSupported, msg, msg2);
-  }
-  static IOStatus NotSupported(SubCode msg = kNone) {
-    return IOStatus(kNotSupported, msg);
-  }
-
-  // Return error status of an appropriate type.
-  static IOStatus NotFound(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kNotFound, msg, msg2);
-  }
-  // Fast path for not found without malloc;
-  static IOStatus NotFound(SubCode msg = kNone) {
-    return IOStatus(kNotFound, msg);
-  }
-
-  static IOStatus Corruption(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kCorruption, msg, msg2);
-  }
-  static IOStatus Corruption(SubCode msg = kNone) {
-    return IOStatus(kCorruption, msg);
-  }
-
-  static IOStatus InvalidArgument(const Slice& msg,
-                                  const Slice& msg2 = Slice()) {
-    return IOStatus(kInvalidArgument, msg, msg2);
-  }
-  static IOStatus InvalidArgument(SubCode msg = kNone) {
-    return IOStatus(kInvalidArgument, msg);
-  }
-
-  static IOStatus IOError(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kIOError, msg, msg2);
-  }
-  static IOStatus IOError(SubCode msg = kNone) {
-    return IOStatus(kIOError, msg);
-  }
-
-  static IOStatus Busy(SubCode msg = kNone) { return IOStatus(kBusy, msg); }
-  static IOStatus Busy(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kBusy, msg, msg2);
-  }
-
-  static IOStatus TimedOut(SubCode msg = kNone) {
-    return IOStatus(kTimedOut, msg);
-  }
-  static IOStatus TimedOut(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kTimedOut, msg, msg2);
-  }
-
-  static IOStatus NoSpace() { return IOStatus(kIOError, kNoSpace); }
-  static IOStatus NoSpace(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kIOError, kNoSpace, msg, msg2);
-  }
-
-  static IOStatus PathNotFound() { return IOStatus(kIOError, kPathNotFound); }
-  static IOStatus PathNotFound(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kIOError, kPathNotFound, msg, msg2);
-  }
-
-  static IOStatus IOFenced() { return IOStatus(kIOError, kIOFenced); }
-  static IOStatus IOFenced(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kIOError, kIOFenced, msg, msg2);
-  }
-
-  static IOStatus Aborted(SubCode msg = kNone) {
-    return IOStatus(kAborted, msg);
-  }
-  static IOStatus Aborted(const Slice& msg, const Slice& msg2 = Slice()) {
-    return IOStatus(kAborted, msg, msg2);
-  }
-
-  // Return a string representation of this status suitable for printing.
-  // Returns the string "OK" for success.
-  // std::string ToString() const;
-
- private:
-  friend IOStatus status_to_io_status(Status&&);
-
-  explicit IOStatus(Code _code, SubCode _subcode = kNone)
-      : Status(_code, _subcode, false, false, kIOErrorScopeFileSystem) {}
-
-  IOStatus(Code _code, SubCode _subcode, const Slice& msg, const Slice& msg2);
-  IOStatus(Code _code, const Slice& msg, const Slice& msg2)
-      : IOStatus(_code, kNone, msg, msg2) {}
-};
-
-inline IOStatus::IOStatus(Code _code, SubCode _subcode, const Slice& msg,
-                          const Slice& msg2)
-    : Status(_code, _subcode, false, false, kIOErrorScopeFileSystem) {
-  assert(code_ != kOk);
-  assert(subcode_ != kMaxSubCode);
-  const size_t len1 = msg.size();
-  const size_t len2 = msg2.size();
-  const size_t size = len1 + (len2 ? (2 + len2) : 0);
-  char* const result = new char[size + 1];  // +1 for null terminator
-  memcpy(result, msg.data(), len1);
-  if (len2) {
-    result[len1] = ':';
-    result[len1 + 1] = ' ';
-    memcpy(result + len1 + 2, msg2.data(), len2);
-  }
-  result[size] = '\0';  // null terminator for C style string
-  state_.reset(result);
-}
-
-inline IOStatus::IOStatus(const IOStatus& s) : Status(s.code_, s.subcode_) {
-#ifdef ROCKSDB_ASSERT_STATUS_CHECKED
-  s.checked_ = true;
-#endif  // ROCKSDB_ASSERT_STATUS_CHECKED
-  retryable_ = s.retryable_;
-  data_loss_ = s.data_loss_;
-  scope_ = s.scope_;
-  state_ = (s.state_ == nullptr) ? nullptr : CopyState(s.state_.get());
-}
-inline IOStatus& IOStatus::operator=(const IOStatus& s) {
-  // The following condition catches both aliasing (when this == &s),
-  // and the common case where both s and *this are ok.
-  if (this != &s) {
-#ifdef ROCKSDB_ASSERT_STATUS_CHECKED
-    s.checked_ = true;
-    checked_ = false;
-#endif  // ROCKSDB_ASSERT_STATUS_CHECKED
-    code_ = s.code_;
-    subcode_ = s.subcode_;
-    retryable_ = s.retryable_;
-    data_loss_ = s.data_loss_;
-    scope_ = s.scope_;
-    state_ = (s.state_ == nullptr) ? nullptr : CopyState(s.state_.get());
-  }
-  return *this;
-}
-
-inline IOStatus::IOStatus(IOStatus&& s) noexcept : IOStatus() {
-  *this = std::move(s);
-}
-
-inline IOStatus& IOStatus::operator=(IOStatus&& s) noexcept {
-  if (this != &s) {
-#ifdef ROCKSDB_ASSERT_STATUS_CHECKED
-    s.checked_ = true;
-    checked_ = false;
-#endif  // ROCKSDB_ASSERT_STATUS_CHECKED
-    code_ = std::move(s.code_);
-    s.code_ = kOk;
-    subcode_ = std::move(s.subcode_);
-    s.subcode_ = kNone;
-    retryable_ = s.retryable_;
-    data_loss_ = s.data_loss_;
-    scope_ = s.scope_;
-    s.scope_ = kIOErrorScopeFileSystem;
-    state_ = std::move(s.state_);
-  }
-  return *this;
-}
-
-inline bool IOStatus::operator==(const IOStatus& rhs) const {
-#ifdef ROCKSDB_ASSERT_STATUS_CHECKED
-  checked_ = true;
-  rhs.checked_ = true;
-#endif  // ROCKSDB_ASSERT_STATUS_CHECKED
-  return (code_ == rhs.code_);
-}
-
-inline bool IOStatus::operator!=(const IOStatus& rhs) const {
-#ifdef ROCKSDB_ASSERT_STATUS_CHECKED
-  checked_ = true;
-  rhs.checked_ = true;
-#endif  // ROCKSDB_ASSERT_STATUS_CHECKED
-  return !(*this == rhs);
-}
-
-inline IOStatus status_to_io_status(Status&& status) {
-  IOStatus io_s;
-  Status& s = io_s;
-  s = std::move(status);
-  return io_s;
-}
-
-}  // namespace ROCKSDB_NAMESPACE

package/vendor/librocksdb/vendor/rocksdb/include/rocksdb/iostats_context.h

@@ -1,98 +0,0 @@
-// 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 <stdint.h>
-
-#include <string>
-
-#include "rocksdb/perf_level.h"
-
-// A thread local context for gathering io-stats efficiently and transparently.
-// Use SetPerfLevel(PerfLevel::kEnableTime) to enable time stats.
-
-namespace ROCKSDB_NAMESPACE {
-
-// EXPERIMENTAL: the IO statistics for tiered storage. It matches with each
-// item in Temperature class.
-struct FileIOByTemperature {
-  // the number of bytes read to Temperature::kHot file
-  uint64_t hot_file_bytes_read;
-  // the number of bytes read to Temperature::kWarm file
-  uint64_t warm_file_bytes_read;
-  // the number of bytes read to Temperature::kCold file
-  uint64_t cold_file_bytes_read;
-  // total number of reads to Temperature::kHot file
-  uint64_t hot_file_read_count;
-  // total number of reads to Temperature::kWarm file
-  uint64_t warm_file_read_count;
-  // total number of reads to Temperature::kCold file
-  uint64_t cold_file_read_count;
-  // reset all the statistics to 0.
-  void Reset() {
-    hot_file_bytes_read = 0;
-    warm_file_bytes_read = 0;
-    cold_file_bytes_read = 0;
-    hot_file_read_count = 0;
-    warm_file_read_count = 0;
-    cold_file_read_count = 0;
-  }
-};
-
-struct IOStatsContext {
-  // reset all io-stats counter to zero
-  void Reset();
-
-  std::string ToString(bool exclude_zero_counters = false) const;
-
-  // the thread pool id
-  uint64_t thread_pool_id;
-
-  // number of bytes that has been written.
-  uint64_t bytes_written;
-  // number of bytes that has been read.
-  uint64_t bytes_read;
-
-  // time spent in open() and fopen().
-  uint64_t open_nanos;
-  // time spent in fallocate().
-  uint64_t allocate_nanos;
-  // time spent in write() and pwrite().
-  uint64_t write_nanos;
-  // time spent in read() and pread()
-  uint64_t read_nanos;
-  // time spent in sync_file_range().
-  uint64_t range_sync_nanos;
-  // time spent in fsync
-  uint64_t fsync_nanos;
-  // time spent in preparing write (fallocate etc).
-  uint64_t prepare_write_nanos;
-  // time spent in Logger::Logv().
-  uint64_t logger_nanos;
-  // CPU time spent in write() and pwrite()
-  uint64_t cpu_write_nanos;
-  // CPU time spent in read() and pread()
-  uint64_t cpu_read_nanos;
-
-  FileIOByTemperature file_io_stats_by_temperature;
-
-  // It is not consistent that whether iostats follows PerfLevel.Timer counters
-  // follows it but BackupEngine relies on counter metrics to always be there.
-  // Here we create a backdoor option to disable some counters, so that some
-  // existing stats are not polluted by file operations, such as logging, by
-  // turning this off.
-  bool disable_iostats = false;
-};
-
-// If RocksDB is compiled with -DNIOSTATS_CONTEXT, then a pointer to a global,
-// non-thread-local IOStatsContext object will be returned. Attempts to update
-// this object will be ignored, and reading from it will also be no-op.
-// Otherwise, a pointer to a thread-local IOStatsContext object will be
-// returned.
-//
-// This function never returns nullptr.
-IOStatsContext* get_iostats_context();
-
-}  // namespace ROCKSDB_NAMESPACE