Summary: Xfunc is hardly used. Remove it to keep the code simple. Closes https://github.com/facebook/rocksdb/pull/1905 Differential Revision: D4603220 Pulled By: siying fbshipit-source-id: 731f96dmain
Siying Dong
8 years ago
committed by
Facebook Github Bot
parent
e7d902e693
commit
1ba2804b7f
@ -1,145 +0,0 @@ |
||||
// Copyright (c) 2011-present, 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.
|
||||
|
||||
#include "db/xfunc_test_points.h" |
||||
#include "util/xfunc.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
#ifdef XFUNC |
||||
|
||||
void xf_manage_release(ManagedIterator* iter) { |
||||
if (!(XFuncPoint::GetSkip() & kSkipNoPrefix)) { |
||||
iter->ReleaseIter(false); |
||||
} |
||||
} |
||||
|
||||
void xf_manage_create(ManagedIterator* iter) { iter->SetDropOld(false); } |
||||
|
||||
void xf_manage_new(DBImpl* db, ReadOptions* read_options, |
||||
bool is_snapshot_supported) { |
||||
if ((!XFuncPoint::Check("managed_xftest_dropold") && |
||||
(!XFuncPoint::Check("managed_xftest_release"))) || |
||||
(!read_options->managed)) { |
||||
return; |
||||
} |
||||
if ((!read_options->tailing) && (read_options->snapshot == nullptr) && |
||||
(!is_snapshot_supported)) { |
||||
read_options->managed = false; |
||||
return; |
||||
} |
||||
if (db->GetOptions().prefix_extractor != nullptr) { |
||||
if (strcmp(db->GetOptions().table_factory.get()->Name(), "PlainTable")) { |
||||
if (!(XFuncPoint::GetSkip() & kSkipNoPrefix)) { |
||||
read_options->total_order_seek = true; |
||||
} |
||||
} else { |
||||
read_options->managed = false; |
||||
} |
||||
} |
||||
} |
||||
|
||||
class XFTransactionWriteHandler : public WriteBatch::Handler { |
||||
public: |
||||
Transaction* txn_; |
||||
DBImpl* db_impl_; |
||||
|
||||
XFTransactionWriteHandler(Transaction* txn, DBImpl* db_impl) |
||||
: txn_(txn), db_impl_(db_impl) {} |
||||
|
||||
virtual Status PutCF(uint32_t column_family_id, const Slice& key, |
||||
const Slice& value) override { |
||||
InstrumentedMutexLock l(&db_impl_->mutex_); |
||||
|
||||
ColumnFamilyHandle* cfh = db_impl_->GetColumnFamilyHandle(column_family_id); |
||||
if (cfh == nullptr) { |
||||
return Status::InvalidArgument( |
||||
"XFUNC test could not find column family " |
||||
"handle for id ", |
||||
ToString(column_family_id)); |
||||
} |
||||
|
||||
txn_->Put(cfh, key, value); |
||||
|
||||
return Status::OK(); |
||||
} |
||||
|
||||
virtual Status MergeCF(uint32_t column_family_id, const Slice& key, |
||||
const Slice& value) override { |
||||
InstrumentedMutexLock l(&db_impl_->mutex_); |
||||
|
||||
ColumnFamilyHandle* cfh = db_impl_->GetColumnFamilyHandle(column_family_id); |
||||
if (cfh == nullptr) { |
||||
return Status::InvalidArgument( |
||||
"XFUNC test could not find column family " |
||||
"handle for id ", |
||||
ToString(column_family_id)); |
||||
} |
||||
|
||||
txn_->Merge(cfh, key, value); |
||||
|
||||
return Status::OK(); |
||||
} |
||||
|
||||
virtual Status DeleteCF(uint32_t column_family_id, |
||||
const Slice& key) override { |
||||
InstrumentedMutexLock l(&db_impl_->mutex_); |
||||
|
||||
ColumnFamilyHandle* cfh = db_impl_->GetColumnFamilyHandle(column_family_id); |
||||
if (cfh == nullptr) { |
||||
return Status::InvalidArgument( |
||||
"XFUNC test could not find column family " |
||||
"handle for id ", |
||||
ToString(column_family_id)); |
||||
} |
||||
|
||||
txn_->Delete(cfh, key); |
||||
|
||||
return Status::OK(); |
||||
} |
||||
|
||||
virtual void LogData(const Slice& blob) override { txn_->PutLogData(blob); } |
||||
}; |
||||
|
||||
// Whenever DBImpl::Write is called, create a transaction and do the write via
|
||||
// the transaction.
|
||||
void xf_transaction_write(const WriteOptions& write_options, |
||||
const DBOptions& db_options, WriteBatch* my_batch, |
||||
WriteCallback* callback, DBImpl* db_impl, Status* s, |
||||
bool* write_attempted) { |
||||
if (callback != nullptr) { |
||||
// We may already be in a transaction, don't force a transaction
|
||||
*write_attempted = false; |
||||
return; |
||||
} |
||||
|
||||
OptimisticTransactionDB* txn_db = new OptimisticTransactionDB(db_impl); |
||||
Transaction* txn = Transaction::BeginTransaction(txn_db, write_options); |
||||
|
||||
XFTransactionWriteHandler handler(txn, db_impl); |
||||
*s = my_batch->Iterate(&handler); |
||||
|
||||
if (!s->ok()) { |
||||
Log(InfoLogLevel::ERROR_LEVEL, db_options.info_log, |
||||
"XFUNC test could not iterate batch. status: $s\n", |
||||
s->ToString().c_str()); |
||||
} |
||||
|
||||
*s = txn->Commit(); |
||||
|
||||
if (!s->ok()) { |
||||
Log(InfoLogLevel::ERROR_LEVEL, db_options.info_log, |
||||
"XFUNC test could not commit transaction. status: $s\n", |
||||
s->ToString().c_str()); |
||||
} |
||||
|
||||
*write_attempted = true; |
||||
delete txn; |
||||
delete txn_db; |
||||
} |
||||
|
||||
#endif // XFUNC
|
||||
|
||||
} // namespace rocksdb
|
||||
@ -1,33 +0,0 @@ |
||||
// Copyright (c) 2011-present, 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 |
||||
|
||||
#include "db/db_impl.h" |
||||
#include "db/managed_iterator.h" |
||||
#include "db/write_callback.h" |
||||
#include "rocksdb/options.h" |
||||
#include "rocksdb/write_batch.h" |
||||
#include "util/xfunc.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
#ifdef XFUNC |
||||
|
||||
// DB-specific test points for the cross-functional test framework (see
|
||||
// util/xfunc.h).
|
||||
void xf_manage_release(ManagedIterator* iter); |
||||
void xf_manage_create(ManagedIterator* iter); |
||||
void xf_manage_new(DBImpl* db, ReadOptions* readoptions, |
||||
bool is_snapshot_supported); |
||||
void xf_transaction_write(const WriteOptions& write_options, |
||||
const DBOptions& db_options, |
||||
class WriteBatch* my_batch, |
||||
class WriteCallback* callback, DBImpl* db_impl, |
||||
Status* success, bool* write_attempted); |
||||
|
||||
#endif // XFUNC
|
||||
|
||||
} // namespace rocksdb
|
||||
@ -1,50 +0,0 @@ |
||||
// Copyright (c) 2011-present, 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.
|
||||
|
||||
#ifdef XFUNC |
||||
#include "util/xfunc.h" |
||||
|
||||
#include <string> |
||||
|
||||
#include "rocksdb/db.h" |
||||
#include "rocksdb/options.h" |
||||
#include "rocksdb/utilities/optimistic_transaction_db.h" |
||||
#include "rocksdb/write_batch.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
std::string XFuncPoint::xfunc_test_; |
||||
bool XFuncPoint::initialized_ = false; |
||||
bool XFuncPoint::enabled_ = false; |
||||
int XFuncPoint::skip_policy_ = 0; |
||||
|
||||
void GetXFTestOptions(Options* options, int skip_policy) { |
||||
if (XFuncPoint::Check("inplace_lock_test") && |
||||
(!(skip_policy & kSkipNoSnapshot))) { |
||||
options->inplace_update_support = true; |
||||
} |
||||
} |
||||
|
||||
void xf_manage_options(ReadOptions* read_options) { |
||||
if (!XFuncPoint::Check("managed_xftest_dropold") && |
||||
(!XFuncPoint::Check("managed_xftest_release"))) { |
||||
return; |
||||
} |
||||
read_options->managed = true; |
||||
} |
||||
|
||||
void xf_transaction_set_memtable_history( |
||||
int32_t* max_write_buffer_number_to_maintain) { |
||||
*max_write_buffer_number_to_maintain = 10; |
||||
} |
||||
|
||||
void xf_transaction_clear_memtable_history( |
||||
int32_t* max_write_buffer_number_to_maintain) { |
||||
*max_write_buffer_number_to_maintain = 0; |
||||
} |
||||
|
||||
} // namespace rocksdb
|
||||
|
||||
#endif // XFUNC
|
||||
@ -1,113 +0,0 @@ |
||||
// Copyright (c) 2011-present, 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 |
||||
|
||||
#include <cstdlib> |
||||
#include <functional> |
||||
#include <string> |
||||
|
||||
#include "rocksdb/options.h" |
||||
|
||||
namespace rocksdb { |
||||
|
||||
/*
|
||||
* If ROCKSDB_XFTEST_FORCE has a value of 1, XFUNC is forced to be defined. |
||||
* If ROCKSDB_XFTEST_FORCE has a value other than 1, |
||||
* XFUNC is forced to be undefined. |
||||
* If ROCKSDB_XFTEST_FORCE is undefined, XFUNC is defined based on NDEBUG, |
||||
* with XFUNC only being set for debug builds. |
||||
*/ |
||||
#if defined(ROCKSDB_XFTEST_FORCE) |
||||
#ifndef ROCKSDB_LITE |
||||
#if (ROCKSDB_XFTEST_FORCE == 1) |
||||
#define XFUNC |
||||
#endif // ROCKSDB_XFTEST_FORCE == 1
|
||||
#elif defined(NDEBUG) |
||||
#else |
||||
#define XFUNC |
||||
#endif // defined(ROCKSDB_XFTEST_FORCE)
|
||||
#endif // !ROCKSDB_LITE
|
||||
|
||||
#ifndef XFUNC |
||||
#define XFUNC_TEST(condition, location, lfname, fname, ...) |
||||
#else |
||||
|
||||
void GetXFTestOptions(Options* options, int skip_policy); |
||||
void xf_manage_options(ReadOptions* read_options); |
||||
void xf_transaction_set_memtable_history( |
||||
int32_t* max_write_buffer_number_to_maintain); |
||||
void xf_transaction_clear_memtable_history( |
||||
int32_t* max_write_buffer_number_to_maintain); |
||||
|
||||
// This class provides the facility to run custom code to test a specific
|
||||
// feature typically with all existing unit tests.
|
||||
// A developer could specify cross functional test points in the codebase
|
||||
// via XFUNC_TEST.
|
||||
// Each xfunc test represents a position in the execution stream of a thread.
|
||||
// Whenever that particular piece of code is called, the given cross-functional
|
||||
// test point is executed.
|
||||
// eg. on DBOpen, a particular option can be set.
|
||||
// on Get, a particular option can be set, or a specific check can be invoked.
|
||||
// XFUNC_TEST(TestName, location, lfname, FunctionName, Args)
|
||||
// Turn on a specific cross functional test by setting the environment variable
|
||||
// ROCKSDB_XFUNC_TEST
|
||||
|
||||
class XFuncPoint { |
||||
public: |
||||
// call once at the beginning of a test to get the test name
|
||||
static void Init() { |
||||
char* s = getenv("ROCKSDB_XFUNC_TEST"); |
||||
if (s == nullptr) { |
||||
xfunc_test_ = ""; |
||||
enabled_ = false; |
||||
} else { |
||||
xfunc_test_ = s; |
||||
enabled_ = true; |
||||
} |
||||
initialized_ = true; |
||||
} |
||||
|
||||
static bool Initialized() { return initialized_; } |
||||
|
||||
static bool Check(std::string test) { |
||||
return (enabled_ && |
||||
((test.compare("") == 0) || (test.compare(xfunc_test_) == 0))); |
||||
} |
||||
|
||||
static void SetSkip(int skip) { skip_policy_ = skip; } |
||||
static int GetSkip(void) { return skip_policy_; } |
||||
|
||||
private: |
||||
static std::string xfunc_test_; |
||||
static bool initialized_; |
||||
static bool enabled_; |
||||
static int skip_policy_; |
||||
}; |
||||
|
||||
// Use XFUNC_TEST to specify cross functional test points inside the code base.
|
||||
// By setting ROCKSDB_XFUNC_TEST, all XFUNC_TEST having that
|
||||
// value in the condition field will be executed.
|
||||
// The second argument specifies a string representing the calling location
|
||||
// The third argument, lfname, is the name of the function which will be created
|
||||
// and called.
|
||||
// The fourth argument fname represents the function to be called
|
||||
// The arguments following that are the arguments to fname
|
||||
// See Options::Options in options.h for an example use case.
|
||||
// XFUNC_TEST is no op in release build.
|
||||
#define XFUNC_TEST(condition, location, lfname, fname, ...) \ |
||||
{ \
|
||||
if (!XFuncPoint::Initialized()) { \
|
||||
XFuncPoint::Init(); \
|
||||
} \
|
||||
if (XFuncPoint::Check(condition)) { \
|
||||
std::function<void()> lfname = std::bind(fname, __VA_ARGS__); \
|
||||
lfname(); \
|
||||
} \
|
||||
} |
||||
|
||||
#endif // XFUNC
|
||||
|
||||
enum SkipPolicy { kSkipNone = 0, kSkipNoSnapshot = 1, kSkipNoPrefix = 2 }; |
||||
} // namespace rocksdb
|
||||
Loading…
Reference in new issue