410 lines
13 KiB
C++
410 lines
13 KiB
C++
/*
|
|
* ThreadSafeTransaction.actor.cpp
|
|
*
|
|
* This source file is part of the FoundationDB open source project
|
|
*
|
|
* Copyright 2013-2018 Apple Inc. and the FoundationDB project authors
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#include "fdbclient/ThreadSafeTransaction.h"
|
|
#include "fdbclient/ReadYourWrites.h"
|
|
#include "fdbclient/DatabaseContext.h"
|
|
#if defined(CMAKE_BUILD) || !defined(WIN32)
|
|
#include "versions.h"
|
|
#endif
|
|
#include <new>
|
|
|
|
// Users of ThreadSafeTransaction might share Reference<ThreadSafe...> between different threads as long as they don't call addRef (e.g. C API follows this).
|
|
// Therefore, it is unsafe to call (explicitly or implicitly) this->addRef in any of these functions.
|
|
|
|
ThreadFuture<Void> ThreadSafeDatabase::onConnected() {
|
|
DatabaseContext *db = this->db;
|
|
return onMainThread( [db]() -> Future<Void> {
|
|
db->checkDeferredError();
|
|
return db->onConnected();
|
|
} );
|
|
}
|
|
|
|
ThreadFuture<Reference<IDatabase>> ThreadSafeDatabase::createFromExistingDatabase(Database db) {
|
|
return onMainThread( [db](){
|
|
db->checkDeferredError();
|
|
DatabaseContext *cx = db.getPtr();
|
|
cx->addref();
|
|
return Future<Reference<IDatabase>>(Reference<IDatabase>(new ThreadSafeDatabase(cx)));
|
|
});
|
|
}
|
|
|
|
Reference<ITransaction> ThreadSafeDatabase::createTransaction() {
|
|
return Reference<ITransaction>(new ThreadSafeTransaction(db));
|
|
}
|
|
|
|
void ThreadSafeDatabase::setOption( FDBDatabaseOptions::Option option, Optional<StringRef> value) {
|
|
auto itr = FDBDatabaseOptions::optionInfo.find(option);
|
|
if(itr != FDBDatabaseOptions::optionInfo.end()) {
|
|
TraceEvent("SetDatabaseOption").detail("Option", itr->second.name);
|
|
}
|
|
else {
|
|
TraceEvent("UnknownDatabaseOption").detail("Option", option);
|
|
throw invalid_option();
|
|
}
|
|
|
|
DatabaseContext *db = this->db;
|
|
Standalone<Optional<StringRef>> passValue = value;
|
|
|
|
// ThreadSafeDatabase is not allowed to do anything with options except pass them through to RYW.
|
|
onMainThreadVoid( [db, option, passValue](){
|
|
db->checkDeferredError();
|
|
db->setOption(option, passValue.contents());
|
|
}, &db->deferredError );
|
|
}
|
|
|
|
ThreadSafeDatabase::ThreadSafeDatabase(std::string connFilename, int apiVersion) {
|
|
ClusterConnectionFile *connFile = new ClusterConnectionFile(ClusterConnectionFile::lookupClusterFileName(connFilename).first);
|
|
|
|
// Allocate memory for the Database from this thread (so the pointer is known for subsequent method calls)
|
|
// but run its constructor on the main thread
|
|
DatabaseContext *db = this->db = DatabaseContext::allocateOnForeignThread();
|
|
|
|
onMainThreadVoid([db, connFile, apiVersion](){
|
|
try {
|
|
Database::createDatabase(Reference<ClusterConnectionFile>(connFile), apiVersion, false, LocalityData(), db).extractPtr();
|
|
}
|
|
catch(Error &e) {
|
|
new (db) DatabaseContext(e);
|
|
}
|
|
catch(...) {
|
|
new (db) DatabaseContext(unknown_error());
|
|
}
|
|
}, NULL);
|
|
}
|
|
|
|
ThreadSafeDatabase::~ThreadSafeDatabase() {
|
|
DatabaseContext *db = this->db;
|
|
onMainThreadVoid( [db](){ db->delref(); }, NULL );
|
|
}
|
|
|
|
ThreadSafeTransaction::ThreadSafeTransaction(DatabaseContext* cx) {
|
|
// Allocate memory for the transaction from this thread (so the pointer is known for subsequent method calls)
|
|
// but run its constructor on the main thread
|
|
|
|
// It looks strange that the DatabaseContext::addref is deferred by the onMainThreadVoid call, but it is safe
|
|
// because the reference count of the DatabaseContext is solely managed from the main thread. If cx is destructed
|
|
// immediately after this call, it will defer the DatabaseContext::delref (and onMainThread preserves the order of
|
|
// these operations).
|
|
ReadYourWritesTransaction *tr = this->tr = ReadYourWritesTransaction::allocateOnForeignThread();
|
|
// No deferred error -- if the construction of the RYW transaction fails, we have no where to put it
|
|
onMainThreadVoid(
|
|
[tr, cx]() {
|
|
cx->addref();
|
|
new (tr) ReadYourWritesTransaction(Database(cx));
|
|
},
|
|
NULL);
|
|
}
|
|
|
|
ThreadSafeTransaction::~ThreadSafeTransaction() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
if (tr)
|
|
onMainThreadVoid( [tr](){ tr->delref(); }, NULL );
|
|
}
|
|
|
|
void ThreadSafeTransaction::cancel() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr](){ tr->cancel(); }, NULL );
|
|
}
|
|
|
|
void ThreadSafeTransaction::setVersion( Version v ) {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, v](){ tr->setVersion(v); }, &tr->deferredError );
|
|
}
|
|
|
|
ThreadFuture<Version> ThreadSafeTransaction::getReadVersion() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr]() -> Future<Version> {
|
|
tr->checkDeferredError();
|
|
return tr->getReadVersion();
|
|
} );
|
|
}
|
|
|
|
ThreadFuture< Optional<Value> > ThreadSafeTransaction::get( const KeyRef& key, bool snapshot ) {
|
|
Key k = key;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr, k, snapshot]() -> Future< Optional<Value> > {
|
|
tr->checkDeferredError();
|
|
return tr->get(k, snapshot);
|
|
} );
|
|
}
|
|
|
|
ThreadFuture< Key > ThreadSafeTransaction::getKey( const KeySelectorRef& key, bool snapshot ) {
|
|
KeySelector k = key;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr, k, snapshot]() -> Future< Key > {
|
|
tr->checkDeferredError();
|
|
return tr->getKey(k, snapshot);
|
|
} );
|
|
}
|
|
|
|
ThreadFuture< Standalone<RangeResultRef> > ThreadSafeTransaction::getRange( const KeySelectorRef& begin, const KeySelectorRef& end, int limit, bool snapshot, bool reverse ) {
|
|
KeySelector b = begin;
|
|
KeySelector e = end;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr, b, e, limit, snapshot, reverse]() -> Future< Standalone<RangeResultRef> > {
|
|
tr->checkDeferredError();
|
|
return tr->getRange(b, e, limit, snapshot, reverse);
|
|
} );
|
|
}
|
|
|
|
ThreadFuture< Standalone<RangeResultRef> > ThreadSafeTransaction::getRange( const KeySelectorRef& begin, const KeySelectorRef& end, GetRangeLimits limits, bool snapshot, bool reverse ) {
|
|
KeySelector b = begin;
|
|
KeySelector e = end;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr, b, e, limits, snapshot, reverse]() -> Future< Standalone<RangeResultRef> > {
|
|
tr->checkDeferredError();
|
|
return tr->getRange(b, e, limits, snapshot, reverse);
|
|
} );
|
|
}
|
|
|
|
ThreadFuture<Standalone<VectorRef<const char*>>> ThreadSafeTransaction::getAddressesForKey( const KeyRef& key ) {
|
|
Key k = key;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr, k]() -> Future< Standalone<VectorRef<const char*> >> {
|
|
tr->checkDeferredError();
|
|
return tr->getAddressesForKey(k);
|
|
} );
|
|
}
|
|
|
|
void ThreadSafeTransaction::addReadConflictRange( const KeyRangeRef& keys) {
|
|
KeyRange r = keys;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, r](){ tr->addReadConflictRange(r); }, &tr->deferredError );
|
|
}
|
|
|
|
void ThreadSafeTransaction::makeSelfConflicting() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr](){ tr->makeSelfConflicting(); }, &tr->deferredError );
|
|
}
|
|
|
|
void ThreadSafeTransaction::atomicOp( const KeyRef& key, const ValueRef& value, uint32_t operationType ) {
|
|
Key k = key;
|
|
Value v = value;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, k, v, operationType](){ tr->atomicOp(k, v, operationType); }, &tr->deferredError );
|
|
}
|
|
|
|
void ThreadSafeTransaction::set( const KeyRef& key, const ValueRef& value ) {
|
|
Key k = key;
|
|
Value v = value;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, k, v](){ tr->set(k, v); }, &tr->deferredError );
|
|
}
|
|
|
|
void ThreadSafeTransaction::clear( const KeyRangeRef& range ) {
|
|
KeyRange r = range;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, r](){ tr->clear(r); }, &tr->deferredError );
|
|
}
|
|
|
|
void ThreadSafeTransaction::clear( const KeyRef& begin, const KeyRef& end ) {
|
|
Key b = begin;
|
|
Key e = end;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, b, e](){
|
|
if(b > e)
|
|
throw inverted_range();
|
|
|
|
tr->clear(KeyRangeRef(b, e));
|
|
}, &tr->deferredError );
|
|
}
|
|
|
|
void ThreadSafeTransaction::clear( const KeyRef& key ) {
|
|
Key k = key;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, k](){ tr->clear(k); }, &tr->deferredError );
|
|
}
|
|
|
|
ThreadFuture< Void > ThreadSafeTransaction::watch( const KeyRef& key ) {
|
|
Key k = key;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr, k]() -> Future< Void > {
|
|
tr->checkDeferredError();
|
|
return tr->watch(k);
|
|
});
|
|
}
|
|
|
|
void ThreadSafeTransaction::addWriteConflictRange( const KeyRangeRef& keys) {
|
|
KeyRange r = keys;
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr, r](){ tr->addWriteConflictRange(r); }, &tr->deferredError );
|
|
}
|
|
|
|
ThreadFuture< Void > ThreadSafeTransaction::commit() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr]() -> Future< Void > {
|
|
tr->checkDeferredError();
|
|
return tr->commit();
|
|
} );
|
|
}
|
|
|
|
Version ThreadSafeTransaction::getCommittedVersion() {
|
|
// This should be thread safe when called legally, but it is fragile
|
|
return tr->getCommittedVersion();
|
|
}
|
|
|
|
ThreadFuture<int64_t> ThreadSafeTransaction::getApproximateSize() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread([tr]() -> Future<int64_t> { return tr->getApproximateSize(); });
|
|
}
|
|
|
|
ThreadFuture<Standalone<StringRef>> ThreadSafeTransaction::getVersionstamp() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread([tr]() -> Future < Standalone<StringRef> > {
|
|
return tr->getVersionstamp();
|
|
});
|
|
}
|
|
|
|
void ThreadSafeTransaction::setOption( FDBTransactionOptions::Option option, Optional<StringRef> value ) {
|
|
auto itr = FDBTransactionOptions::optionInfo.find(option);
|
|
if(itr == FDBTransactionOptions::optionInfo.end()) {
|
|
TraceEvent("UnknownTransactionOption").detail("Option", option);
|
|
throw invalid_option();
|
|
}
|
|
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
Standalone<Optional<StringRef>> passValue = value;
|
|
|
|
// ThreadSafeTransaction is not allowed to do anything with options except pass them through to RYW.
|
|
onMainThreadVoid( [tr, option, passValue](){ tr->setOption(option, passValue.contents()); }, &tr->deferredError );
|
|
}
|
|
|
|
ThreadFuture<Void> ThreadSafeTransaction::checkDeferredError() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr](){
|
|
try {
|
|
tr->checkDeferredError();
|
|
} catch (Error &e) {
|
|
tr->deferredError = Error();
|
|
return Future<Void>(e);
|
|
}
|
|
return Future<Void>(Void());
|
|
} );
|
|
}
|
|
|
|
ThreadFuture<Void> ThreadSafeTransaction::onError( Error const& e ) {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
return onMainThread( [tr, e](){ return tr->onError(e); } );
|
|
}
|
|
|
|
void ThreadSafeTransaction::operator=(ThreadSafeTransaction&& r) BOOST_NOEXCEPT {
|
|
tr = r.tr;
|
|
r.tr = NULL;
|
|
}
|
|
|
|
ThreadSafeTransaction::ThreadSafeTransaction(ThreadSafeTransaction&& r) BOOST_NOEXCEPT {
|
|
tr = r.tr;
|
|
r.tr = NULL;
|
|
}
|
|
|
|
void ThreadSafeTransaction::reset() {
|
|
ReadYourWritesTransaction *tr = this->tr;
|
|
onMainThreadVoid( [tr](){ tr->reset(); }, NULL );
|
|
}
|
|
|
|
extern const char* getSourceVersion();
|
|
|
|
ThreadSafeApi::ThreadSafeApi() : apiVersion(-1), clientVersion(format("%s,%s,%llx", FDB_VT_VERSION, getSourceVersion(), currentProtocolVersion)), transportId(0) {}
|
|
|
|
void ThreadSafeApi::selectApiVersion(int apiVersion) {
|
|
this->apiVersion = apiVersion;
|
|
}
|
|
|
|
const char* ThreadSafeApi::getClientVersion() {
|
|
// There is only one copy of the ThreadSafeAPI, and it never gets deleted. Also, clientVersion is never modified.
|
|
return clientVersion.c_str();
|
|
}
|
|
|
|
void ThreadSafeApi::setNetworkOption(FDBNetworkOptions::Option option, Optional<StringRef> value) {
|
|
if (option == FDBNetworkOptions::EXTERNAL_CLIENT_TRANSPORT_ID) {
|
|
if(value.present()) {
|
|
transportId = std::stoull(value.get().toString().c_str());
|
|
}
|
|
}
|
|
else {
|
|
::setNetworkOption(option, value);
|
|
}
|
|
}
|
|
|
|
void ThreadSafeApi::setupNetwork() {
|
|
::setupNetwork(transportId);
|
|
}
|
|
|
|
void ThreadSafeApi::runNetwork() {
|
|
Optional<Error> runErr;
|
|
try {
|
|
::runNetwork();
|
|
}
|
|
catch(Error &e) {
|
|
runErr = e;
|
|
}
|
|
|
|
for(auto &hook : threadCompletionHooks) {
|
|
try {
|
|
hook.first(hook.second);
|
|
}
|
|
catch(Error &e) {
|
|
TraceEvent(SevError, "NetworkShutdownHookError").error(e);
|
|
}
|
|
catch(...) {
|
|
TraceEvent(SevError, "NetworkShutdownHookError").error(unknown_error());
|
|
}
|
|
}
|
|
|
|
if(runErr.present()) {
|
|
throw runErr.get();
|
|
}
|
|
|
|
}
|
|
|
|
void ThreadSafeApi::stopNetwork() {
|
|
::stopNetwork();
|
|
}
|
|
|
|
Reference<IDatabase> ThreadSafeApi::createDatabase(const char *clusterFilePath) {
|
|
return Reference<IDatabase>(new ThreadSafeDatabase(clusterFilePath, apiVersion));
|
|
}
|
|
|
|
void ThreadSafeApi::addNetworkThreadCompletionHook(void (*hook)(void*), void *hookParameter) {
|
|
if (!g_network) {
|
|
throw network_not_setup();
|
|
}
|
|
|
|
MutexHolder holder(lock); // We could use the network thread to protect this action, but then we can't guarantee upon return that the hook is set.
|
|
threadCompletionHooks.push_back(std::make_pair(hook, hookParameter));
|
|
}
|
|
|
|
|
|
IClientApi* ThreadSafeApi::api = new ThreadSafeApi();
|