rocksdb/util/user_comparator_wrapper.h
Yanqin Jin 82b3888433 Enable backward iterator for keys with user-defined timestamp (#8035)
Summary:
This PR does the following:

- Enable backward iteration for keys with user-defined timestamp. Note that merge, single delete, range delete are not supported yet.
- Introduces a new helper API `Comparator::EqualWithoutTimestamp()`.
- Fix a typo in `SetTimestamp()`.
- Add/update unit tests

Run db_bench (built with DEBUG_LEVEL=0) to demonstrate that no overhead is introduced for CPU-intensive workloads with a lot of `Prev()`. Also provided results of iterating keys with timestamps.

1. Disable timestamp, run:
```
./db_bench -db=/dev/shm/rocksdb -disable_wal=1 -benchmarks=fillseq,seekrandom[-W1-X6] -reverse_iterator=1 -seek_nexts=5
```
Results:
> Baseline
> - seekrandom [AVG    6 runs] : 96115 ops/sec;   53.2 MB/sec
> - seekrandom [MEDIAN 6 runs] : 98075 ops/sec;   54.2 MB/sec
>
> This PR
> - seekrandom [AVG    6 runs] : 95521 ops/sec;   52.8 MB/sec
> - seekrandom [MEDIAN 6 runs] : 96338 ops/sec;   53.3 MB/sec

2. Enable timestamp, run:
```
./db_bench -user_timestamp_size=8  -db=/dev/shm/rocksdb -disable_wal=1 -benchmarks=fillseq,seekrandom[-W1-X6] -reverse_iterator=1 -seek_nexts=5
```
Result:
> Baseline: not supported
>
> This PR
> - seekrandom [AVG    6 runs] : 90514 ops/sec;   50.1 MB/sec
> - seekrandom [MEDIAN 6 runs] : 90834 ops/sec;   50.2 MB/sec

Pull Request resolved: https://github.com/facebook/rocksdb/pull/8035

Reviewed By: ltamasi

Differential Revision: D26926668

Pulled By: riversand963

fbshipit-source-id: 95330cc2242397c03e09d29e5417dfb0adc98ef5
2021-03-10 11:15:46 -08:00

85 lines
3.0 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).
// Copyright (c) 2011 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.
#pragma once
#include "monitoring/perf_context_imp.h"
#include "rocksdb/comparator.h"
namespace ROCKSDB_NAMESPACE {
// Wrapper of user comparator, with auto increment to
// perf_context.user_key_comparison_count.
class UserComparatorWrapper final : public Comparator {
public:
// `UserComparatorWrapper`s constructed with the default constructor are not
// usable and will segfault on any attempt to use them for comparisons.
UserComparatorWrapper() : user_comparator_(nullptr) {}
explicit UserComparatorWrapper(const Comparator* const user_cmp)
: Comparator(user_cmp->timestamp_size()), user_comparator_(user_cmp) {}
~UserComparatorWrapper() = default;
const Comparator* user_comparator() const { return user_comparator_; }
int Compare(const Slice& a, const Slice& b) const override {
PERF_COUNTER_ADD(user_key_comparison_count, 1);
return user_comparator_->Compare(a, b);
}
bool Equal(const Slice& a, const Slice& b) const override {
PERF_COUNTER_ADD(user_key_comparison_count, 1);
return user_comparator_->Equal(a, b);
}
const char* Name() const override { return user_comparator_->Name(); }
void FindShortestSeparator(std::string* start,
const Slice& limit) const override {
return user_comparator_->FindShortestSeparator(start, limit);
}
void FindShortSuccessor(std::string* key) const override {
return user_comparator_->FindShortSuccessor(key);
}
const Comparator* GetRootComparator() const override {
return user_comparator_->GetRootComparator();
}
bool IsSameLengthImmediateSuccessor(const Slice& s,
const Slice& t) const override {
return user_comparator_->IsSameLengthImmediateSuccessor(s, t);
}
bool CanKeysWithDifferentByteContentsBeEqual() const override {
return user_comparator_->CanKeysWithDifferentByteContentsBeEqual();
}
int CompareTimestamp(const Slice& ts1, const Slice& ts2) const override {
return user_comparator_->CompareTimestamp(ts1, ts2);
}
using Comparator::CompareWithoutTimestamp;
int CompareWithoutTimestamp(const Slice& a, bool a_has_ts, const Slice& b,
bool b_has_ts) const override {
PERF_COUNTER_ADD(user_key_comparison_count, 1);
return user_comparator_->CompareWithoutTimestamp(a, a_has_ts, b, b_has_ts);
}
bool EqualWithoutTimestamp(const Slice& a, const Slice& b) const override {
return user_comparator_->EqualWithoutTimestamp(a, b);
}
private:
const Comparator* user_comparator_;
};
} // namespace ROCKSDB_NAMESPACE