Summary: As I keep adding new features to transactions, I keep creating more duplicate code. This diff cleans this up by creating a base implementation class for Transaction and OptimisticTransaction to inherit from. The code in TransactionBase.h/.cc is all just copied from elsewhere. The only entertaining part of this class worth looking at is the virtual TryLock method which allows OptimisticTransactions and Transactions to share the same common code for Put/Get/etc. The rest of this diff is mostly red and easy on the eyes. Test Plan: No functionality change. existing tests pass. Reviewers: sdong, jkedgar, rven, igor Reviewed By: igor Subscribers: dhruba, leveldb Differential Revision: https://reviews.facebook.net/D45135main
agiardullo
9 years ago
parent
2050832974
commit
20d1e547d1
@ -0,0 +1,278 @@ |
||||
// Copyright (c) 2015, Facebook, Inc. All rights reserved.
|
||||
// This source code is licensed under the BSD-style license found in the
|
||||
// LICENSE file in the root directory of this source tree. An additional grant
|
||||
// of patent rights can be found in the PATENTS file in the same directory.
|
||||
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include "utilities/transactions/transaction_base.h" |
||||
|
||||
#include "db/column_family.h" |
||||
#include "rocksdb/comparator.h" |
||||
#include "rocksdb/db.h" |
||||
#include "rocksdb/status.h" |
||||
#include "util/string_util.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
TransactionBaseImpl::TransactionBaseImpl(DB* db, |
||||
const WriteOptions& write_options) |
||||
: db_(db), |
||||
write_options_(write_options), |
||||
cmp_(GetColumnFamilyUserComparator(db->DefaultColumnFamily())), |
||||
write_batch_(new WriteBatchWithIndex(cmp_, 0, true)), |
||||
start_time_(db_->GetEnv()->NowMicros()) {} |
||||
|
||||
TransactionBaseImpl::~TransactionBaseImpl() {} |
||||
|
||||
void TransactionBaseImpl::SetSnapshot() { |
||||
snapshot_.reset(new ManagedSnapshot(db_)); |
||||
} |
||||
|
||||
Status TransactionBaseImpl::TryLock(ColumnFamilyHandle* column_family, |
||||
const SliceParts& key, bool untracked) { |
||||
size_t key_size = 0; |
||||
for (int i = 0; i < key.num_parts; ++i) { |
||||
key_size += key.parts[i].size(); |
||||
} |
||||
|
||||
std::string str; |
||||
str.reserve(key_size); |
||||
|
||||
for (int i = 0; i < key.num_parts; ++i) { |
||||
str.append(key.parts[i].data(), key.parts[i].size()); |
||||
} |
||||
|
||||
return TryLock(column_family, str, untracked); |
||||
} |
||||
|
||||
void TransactionBaseImpl::SetSavePoint() { |
||||
if (save_points_ == nullptr) { |
||||
save_points_.reset(new std::stack<std::shared_ptr<ManagedSnapshot>>()); |
||||
} |
||||
save_points_->push(snapshot_); |
||||
write_batch_->SetSavePoint(); |
||||
} |
||||
|
||||
Status TransactionBaseImpl::RollbackToSavePoint() { |
||||
if (save_points_ != nullptr && save_points_->size() > 0) { |
||||
// Restore saved snapshot
|
||||
snapshot_ = save_points_->top(); |
||||
save_points_->pop(); |
||||
|
||||
// Rollback batch
|
||||
Status s = write_batch_->RollbackToSavePoint(); |
||||
assert(s.ok()); |
||||
|
||||
return s; |
||||
} else { |
||||
assert(write_batch_->RollbackToSavePoint().IsNotFound()); |
||||
return Status::NotFound(); |
||||
} |
||||
} |
||||
|
||||
Status TransactionBaseImpl::Get(const ReadOptions& read_options, |
||||
ColumnFamilyHandle* column_family, |
||||
const Slice& key, std::string* value) { |
||||
return write_batch_->GetFromBatchAndDB(db_, read_options, column_family, key, |
||||
value); |
||||
} |
||||
|
||||
Status TransactionBaseImpl::GetForUpdate(const ReadOptions& read_options, |
||||
ColumnFamilyHandle* column_family, |
||||
const Slice& key, std::string* value) { |
||||
Status s = TryLock(column_family, key); |
||||
|
||||
if (s.ok() && value != nullptr) { |
||||
s = Get(read_options, column_family, key, value); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
std::vector<Status> TransactionBaseImpl::MultiGet( |
||||
const ReadOptions& read_options, |
||||
const std::vector<ColumnFamilyHandle*>& column_family, |
||||
const std::vector<Slice>& keys, std::vector<std::string>* values) { |
||||
size_t num_keys = keys.size(); |
||||
values->resize(num_keys); |
||||
|
||||
std::vector<Status> stat_list(num_keys); |
||||
for (size_t i = 0; i < num_keys; ++i) { |
||||
std::string* value = values ? &(*values)[i] : nullptr; |
||||
stat_list[i] = Get(read_options, column_family[i], keys[i], value); |
||||
} |
||||
|
||||
return stat_list; |
||||
} |
||||
|
||||
std::vector<Status> TransactionBaseImpl::MultiGetForUpdate( |
||||
const ReadOptions& read_options, |
||||
const std::vector<ColumnFamilyHandle*>& column_family, |
||||
const std::vector<Slice>& keys, std::vector<std::string>* values) { |
||||
// Regardless of whether the MultiGet succeeded, track these keys.
|
||||
size_t num_keys = keys.size(); |
||||
values->resize(num_keys); |
||||
|
||||
// Lock all keys
|
||||
for (size_t i = 0; i < num_keys; ++i) { |
||||
Status s = TryLock(column_family[i], keys[i]); |
||||
if (!s.ok()) { |
||||
// Fail entire multiget if we cannot lock all keys
|
||||
return std::vector<Status>(num_keys, s); |
||||
} |
||||
} |
||||
|
||||
// TODO(agiardullo): optimize multiget?
|
||||
std::vector<Status> stat_list(num_keys); |
||||
for (size_t i = 0; i < num_keys; ++i) { |
||||
std::string* value = values ? &(*values)[i] : nullptr; |
||||
stat_list[i] = Get(read_options, column_family[i], keys[i], value); |
||||
} |
||||
|
||||
return stat_list; |
||||
} |
||||
|
||||
Iterator* TransactionBaseImpl::GetIterator(const ReadOptions& read_options) { |
||||
Iterator* db_iter = db_->NewIterator(read_options); |
||||
assert(db_iter); |
||||
|
||||
return write_batch_->NewIteratorWithBase(db_iter); |
||||
} |
||||
|
||||
Iterator* TransactionBaseImpl::GetIterator(const ReadOptions& read_options, |
||||
ColumnFamilyHandle* column_family) { |
||||
Iterator* db_iter = db_->NewIterator(read_options, column_family); |
||||
assert(db_iter); |
||||
|
||||
return write_batch_->NewIteratorWithBase(column_family, db_iter); |
||||
} |
||||
|
||||
Status TransactionBaseImpl::Put(ColumnFamilyHandle* column_family, |
||||
const Slice& key, const Slice& value) { |
||||
Status s = TryLock(column_family, key); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Put(column_family, key, value); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::Put(ColumnFamilyHandle* column_family, |
||||
const SliceParts& key, |
||||
const SliceParts& value) { |
||||
Status s = TryLock(column_family, key); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Put(column_family, key, value); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::Merge(ColumnFamilyHandle* column_family, |
||||
const Slice& key, const Slice& value) { |
||||
Status s = TryLock(column_family, key); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Merge(column_family, key, value); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::Delete(ColumnFamilyHandle* column_family, |
||||
const Slice& key) { |
||||
Status s = TryLock(column_family, key); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Delete(column_family, key); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::Delete(ColumnFamilyHandle* column_family, |
||||
const SliceParts& key) { |
||||
Status s = TryLock(column_family, key); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Delete(column_family, key); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::PutUntracked(ColumnFamilyHandle* column_family, |
||||
const Slice& key, const Slice& value) { |
||||
bool untracked = true; |
||||
Status s = TryLock(column_family, key, untracked); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Put(column_family, key, value); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::PutUntracked(ColumnFamilyHandle* column_family, |
||||
const SliceParts& key, |
||||
const SliceParts& value) { |
||||
bool untracked = true; |
||||
Status s = TryLock(column_family, key, untracked); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Put(column_family, key, value); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::MergeUntracked(ColumnFamilyHandle* column_family, |
||||
const Slice& key, |
||||
const Slice& value) { |
||||
bool untracked = true; |
||||
Status s = TryLock(column_family, key, untracked); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Merge(column_family, key, value); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::DeleteUntracked(ColumnFamilyHandle* column_family, |
||||
const Slice& key) { |
||||
bool untracked = true; |
||||
Status s = TryLock(column_family, key, untracked); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Delete(column_family, key); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
Status TransactionBaseImpl::DeleteUntracked(ColumnFamilyHandle* column_family, |
||||
const SliceParts& key) { |
||||
bool untracked = true; |
||||
Status s = TryLock(column_family, key, untracked); |
||||
|
||||
if (s.ok()) { |
||||
write_batch_->Delete(column_family, key); |
||||
} |
||||
|
||||
return s; |
||||
} |
||||
|
||||
void TransactionBaseImpl::PutLogData(const Slice& blob) { |
||||
write_batch_->PutLogData(blob); |
||||
} |
||||
|
||||
WriteBatchWithIndex* TransactionBaseImpl::GetWriteBatch() { |
||||
return write_batch_.get(); |
||||
} |
||||
|
||||
} // namespace rocksdb
|
||||
|
||||
#endif // ROCKSDB_LITE
|
||||
@ -0,0 +1,183 @@ |
||||
// Copyright (c) 2015, Facebook, Inc. All rights reserved.
|
||||
// This source code is licensed under the BSD-style license found in the
|
||||
// LICENSE file in the root directory of this source tree. An additional grant
|
||||
// of patent rights can be found in the PATENTS file in the same directory.
|
||||
|
||||
#pragma once |
||||
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include <stack> |
||||
#include <string> |
||||
#include <vector> |
||||
|
||||
#include "rocksdb/db.h" |
||||
#include "rocksdb/slice.h" |
||||
#include "rocksdb/snapshot.h" |
||||
#include "rocksdb/status.h" |
||||
#include "rocksdb/types.h" |
||||
#include "rocksdb/utilities/transaction.h" |
||||
#include "rocksdb/utilities/transaction_db.h" |
||||
#include "rocksdb/utilities/write_batch_with_index.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
class TransactionBaseImpl : public Transaction { |
||||
public: |
||||
TransactionBaseImpl(DB* db, const WriteOptions& write_options); |
||||
|
||||
virtual ~TransactionBaseImpl(); |
||||
|
||||
// Called before executing Put, Merge, Delete, and GetForUpdate. If TryLock
|
||||
// returns non-OK, the Put/Merge/Delete/GetForUpdate will be failed.
|
||||
// untracked will be true if called from PutUntracked, DeleteUntracked, or
|
||||
// MergeUntracked.
|
||||
virtual Status TryLock(ColumnFamilyHandle* column_family, const Slice& key, |
||||
bool untracked = false) = 0; |
||||
|
||||
void SetSavePoint() override; |
||||
|
||||
Status RollbackToSavePoint() override; |
||||
|
||||
Status Get(const ReadOptions& options, ColumnFamilyHandle* column_family, |
||||
const Slice& key, std::string* value) override; |
||||
|
||||
Status Get(const ReadOptions& options, const Slice& key, |
||||
std::string* value) override { |
||||
return Get(options, db_->DefaultColumnFamily(), key, value); |
||||
} |
||||
|
||||
Status GetForUpdate(const ReadOptions& options, |
||||
ColumnFamilyHandle* column_family, const Slice& key, |
||||
std::string* value) override; |
||||
|
||||
Status GetForUpdate(const ReadOptions& options, const Slice& key, |
||||
std::string* value) override { |
||||
return GetForUpdate(options, db_->DefaultColumnFamily(), key, value); |
||||
} |
||||
|
||||
std::vector<Status> MultiGet( |
||||
const ReadOptions& options, |
||||
const std::vector<ColumnFamilyHandle*>& column_family, |
||||
const std::vector<Slice>& keys, |
||||
std::vector<std::string>* values) override; |
||||
|
||||
std::vector<Status> MultiGet(const ReadOptions& options, |
||||
const std::vector<Slice>& keys, |
||||
std::vector<std::string>* values) override { |
||||
return MultiGet(options, std::vector<ColumnFamilyHandle*>( |
||||
keys.size(), db_->DefaultColumnFamily()), |
||||
keys, values); |
||||
} |
||||
|
||||
std::vector<Status> MultiGetForUpdate( |
||||
const ReadOptions& options, |
||||
const std::vector<ColumnFamilyHandle*>& column_family, |
||||
const std::vector<Slice>& keys, |
||||
std::vector<std::string>* values) override; |
||||
|
||||
std::vector<Status> MultiGetForUpdate( |
||||
const ReadOptions& options, const std::vector<Slice>& keys, |
||||
std::vector<std::string>* values) override { |
||||
return MultiGetForUpdate(options, |
||||
std::vector<ColumnFamilyHandle*>( |
||||
keys.size(), db_->DefaultColumnFamily()), |
||||
keys, values); |
||||
} |
||||
|
||||
Iterator* GetIterator(const ReadOptions& read_options) override; |
||||
Iterator* GetIterator(const ReadOptions& read_options, |
||||
ColumnFamilyHandle* column_family) override; |
||||
|
||||
Status Put(ColumnFamilyHandle* column_family, const Slice& key, |
||||
const Slice& value) override; |
||||
Status Put(const Slice& key, const Slice& value) override { |
||||
return Put(nullptr, key, value); |
||||
} |
||||
|
||||
Status Put(ColumnFamilyHandle* column_family, const SliceParts& key, |
||||
const SliceParts& value) override; |
||||
Status Put(const SliceParts& key, const SliceParts& value) override { |
||||
return Put(nullptr, key, value); |
||||
} |
||||
|
||||
Status Merge(ColumnFamilyHandle* column_family, const Slice& key, |
||||
const Slice& value) override; |
||||
Status Merge(const Slice& key, const Slice& value) override { |
||||
return Merge(nullptr, key, value); |
||||
} |
||||
|
||||
Status Delete(ColumnFamilyHandle* column_family, const Slice& key) override; |
||||
Status Delete(const Slice& key) override { return Delete(nullptr, key); } |
||||
Status Delete(ColumnFamilyHandle* column_family, |
||||
const SliceParts& key) override; |
||||
Status Delete(const SliceParts& key) override { return Delete(nullptr, key); } |
||||
|
||||
Status PutUntracked(ColumnFamilyHandle* column_family, const Slice& key, |
||||
const Slice& value) override; |
||||
Status PutUntracked(const Slice& key, const Slice& value) override { |
||||
return PutUntracked(nullptr, key, value); |
||||
} |
||||
|
||||
Status PutUntracked(ColumnFamilyHandle* column_family, const SliceParts& key, |
||||
const SliceParts& value) override; |
||||
Status PutUntracked(const SliceParts& key, const SliceParts& value) override { |
||||
return PutUntracked(nullptr, key, value); |
||||
} |
||||
|
||||
Status MergeUntracked(ColumnFamilyHandle* column_family, const Slice& key, |
||||
const Slice& value) override; |
||||
Status MergeUntracked(const Slice& key, const Slice& value) override { |
||||
return MergeUntracked(nullptr, key, value); |
||||
} |
||||
|
||||
Status DeleteUntracked(ColumnFamilyHandle* column_family, |
||||
const Slice& key) override; |
||||
Status DeleteUntracked(const Slice& key) override { |
||||
return DeleteUntracked(nullptr, key); |
||||
} |
||||
Status DeleteUntracked(ColumnFamilyHandle* column_family, |
||||
const SliceParts& key) override; |
||||
Status DeleteUntracked(const SliceParts& key) override { |
||||
return DeleteUntracked(nullptr, key); |
||||
} |
||||
|
||||
void PutLogData(const Slice& blob) override; |
||||
|
||||
WriteBatchWithIndex* GetWriteBatch() override; |
||||
|
||||
const Snapshot* GetSnapshot() const override { |
||||
return snapshot_ ? snapshot_->snapshot() : nullptr; |
||||
} |
||||
|
||||
void SetSnapshot() override; |
||||
|
||||
protected: |
||||
DB* const db_; |
||||
|
||||
const WriteOptions write_options_; |
||||
|
||||
const Comparator* cmp_; |
||||
|
||||
// Records writes pending in this transaction
|
||||
std::unique_ptr<WriteBatchWithIndex> write_batch_; |
||||
|
||||
// Stores that time the txn was constructed, in microseconds.
|
||||
const uint64_t start_time_; |
||||
|
||||
// Stores the current snapshot that was was set by SetSnapshot or null if
|
||||
// no snapshot is currently set.
|
||||
std::shared_ptr<ManagedSnapshot> snapshot_; |
||||
|
||||
// Stack of the Snapshot saved at each save point. Saved snapshots may be
|
||||
// nullptr if there was no snapshot at the time SetSavePoint() was called.
|
||||
std::unique_ptr<std::stack<std::shared_ptr<ManagedSnapshot>>> save_points_; |
||||
|
||||
private: |
||||
Status TryLock(ColumnFamilyHandle* column_family, const SliceParts& key, |
||||
bool untracked = false); |
||||
}; |
||||
|
||||
} // namespace rocksdb
|
||||
|
||||
#endif // ROCKSDB_LITE
|
||||
Loading…
Reference in new issue