foundationdb/fdbserver/workloads/MetaclusterManagementConcur...

458 lines
19 KiB
C++

/*
* MetaclusterManagementConcurrencyWorkload.actor.cpp
*
* This source file is part of the FoundationDB open source project
*
* Copyright 2013-2022 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 <cstdint>
#include <limits>
#include "fdbclient/DatabaseContext.h"
#include "fdbclient/FDBOptions.g.h"
#include "fdbclient/FDBTypes.h"
#include "fdbclient/GenericManagementAPI.actor.h"
#include "fdbclient/MetaclusterManagement.actor.h"
#include "fdbclient/ReadYourWrites.h"
#include "fdbclient/RunTransaction.actor.h"
#include "fdbclient/TenantManagement.actor.h"
#include "fdbclient/ThreadSafeTransaction.h"
#include "fdbrpc/simulator.h"
#include "fdbserver/workloads/MetaclusterConsistency.actor.h"
#include "fdbserver/workloads/TenantConsistency.actor.h"
#include "fdbserver/workloads/workloads.actor.h"
#include "fdbserver/Knobs.h"
#include "flow/Error.h"
#include "flow/IRandom.h"
#include "flow/ProtocolVersion.h"
#include "flow/flow.h"
#include "flow/actorcompiler.h" // This must be the last #include.
struct MetaclusterManagementConcurrencyWorkload : TestWorkload {
static constexpr auto NAME = "MetaclusterManagementConcurrency";
Reference<IDatabase> managementDb;
std::map<ClusterName, Database> dataDbs;
std::vector<ClusterName> dataDbIndex;
double testDuration;
MetaclusterManagementConcurrencyWorkload(WorkloadContext const& wcx) : TestWorkload(wcx) {
testDuration = getOption(options, "testDuration"_sr, 90.0);
}
Future<Void> setup(Database const& cx) override { return _setup(cx, this); }
ACTOR static Future<Void> _setup(Database cx, MetaclusterManagementConcurrencyWorkload* self) {
Reference<IDatabase> threadSafeHandle =
wait(unsafeThreadFutureToFuture(ThreadSafeDatabase::createFromExistingDatabase(cx)));
MultiVersionApi::api->selectApiVersion(cx->apiVersion.version());
self->managementDb = MultiVersionDatabase::debugCreateFromExistingDatabase(threadSafeHandle);
ASSERT(g_simulator->extraDatabases.size() > 0);
for (auto connectionString : g_simulator->extraDatabases) {
ClusterConnectionString ccs(connectionString);
self->dataDbIndex.push_back(ClusterName(format("cluster_%08d", self->dataDbs.size())));
self->dataDbs[self->dataDbIndex.back()] =
Database::createSimulatedExtraDatabase(connectionString, cx->defaultTenant);
}
if (self->clientId == 0) {
wait(success(MetaclusterAPI::createMetacluster(
cx.getReference(),
"management_cluster"_sr,
deterministicRandom()->randomInt(TenantAPI::TENANT_ID_PREFIX_MIN_VALUE,
TenantAPI::TENANT_ID_PREFIX_MAX_VALUE + 1),
false)));
}
return Void();
}
ClusterName chooseClusterName() { return dataDbIndex[deterministicRandom()->randomInt(0, dataDbIndex.size())]; }
ACTOR static Future<Void> registerCluster(MetaclusterManagementConcurrencyWorkload* self) {
state ClusterName clusterName = self->chooseClusterName();
state Database dataDb = self->dataDbs[clusterName];
state UID debugId = deterministicRandom()->randomUniqueID();
try {
state DataClusterEntry entry;
entry.capacity.numTenantGroups = deterministicRandom()->randomInt(0, 4);
loop {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRegisteringCluster", debugId)
.detail("ClusterName", clusterName)
.detail("NumTenantGroups", entry.capacity.numTenantGroups);
Future<Void> registerFuture =
MetaclusterAPI::registerCluster(self->managementDb,
clusterName,
dataDb.getReference()->getConnectionRecord()->getConnectionString(),
entry);
Optional<Void> result = wait(timeout(registerFuture, deterministicRandom()->randomInt(1, 30)));
if (result.present()) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRegisteredCluster", debugId)
.detail("ClusterName", clusterName)
.detail("NumTenantGroups", entry.capacity.numTenantGroups);
break;
}
}
} catch (Error& e) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRegisterClusterError", debugId)
.error(e)
.detail("ClusterName", clusterName);
if (e.code() != error_code_cluster_already_exists && e.code() != error_code_cluster_not_empty &&
e.code() != error_code_cluster_already_registered && e.code() != error_code_cluster_removed &&
e.code() != error_code_cluster_restoring) {
TraceEvent(SevError, "MetaclusterManagementConcurrencyRegisterClusterFailure", debugId)
.error(e)
.detail("ClusterName", clusterName);
ASSERT(false);
}
wait(success(errorOr(MetaclusterAPI::removeCluster(
self->managementDb, clusterName, ClusterType::METACLUSTER_MANAGEMENT, ForceRemove::True))));
return Void();
}
return Void();
}
ACTOR static Future<Void> removeCluster(MetaclusterManagementConcurrencyWorkload* self) {
state ClusterName clusterName = self->chooseClusterName();
state Database dataDb = self->dataDbs[clusterName];
state ForceRemove forceRemove(deterministicRandom()->coinflip());
state UID debugId = deterministicRandom()->randomUniqueID();
try {
loop {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRemovingCluster", debugId)
.detail("ClusterName", clusterName);
Future<bool> removeFuture = MetaclusterAPI::removeCluster(
self->managementDb, clusterName, ClusterType::METACLUSTER_MANAGEMENT, ForceRemove::False);
Optional<bool> result = wait(timeout(removeFuture, deterministicRandom()->randomInt(1, 30)));
if (result.present()) {
ASSERT(result.get());
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRemovedCluster", debugId)
.detail("ClusterName", clusterName);
break;
}
}
} catch (Error& e) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRemoveClusterError", debugId)
.error(e)
.detail("ClusterName", clusterName);
if (e.code() != error_code_cluster_not_found && e.code() != error_code_cluster_not_empty) {
TraceEvent(SevError, "MetaclusterManagementConcurrencyRemoveClusterFailure", debugId)
.error(e)
.detail("ClusterName", clusterName);
ASSERT(false);
}
return Void();
}
return Void();
}
ACTOR static Future<Void> listClusters(MetaclusterManagementConcurrencyWorkload* self) {
state ClusterName clusterName1 = self->chooseClusterName();
state ClusterName clusterName2 = self->chooseClusterName();
state int limit = deterministicRandom()->randomInt(1, self->dataDbs.size() + 1);
try {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyListClusters")
.detail("StartClusterName", clusterName1)
.detail("EndClusterName", clusterName2)
.detail("Limit", limit);
std::map<ClusterName, DataClusterMetadata> clusterList =
wait(MetaclusterAPI::listClusters(self->managementDb, clusterName1, clusterName2, limit));
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyListedClusters")
.detail("StartClusterName", clusterName1)
.detail("EndClusterName", clusterName2)
.detail("Limit", limit);
ASSERT(clusterName1 <= clusterName2);
ASSERT(clusterList.size() <= limit);
} catch (Error& e) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyListClustersError")
.error(e)
.detail("StartClusterName", clusterName1)
.detail("EndClusterName", clusterName2)
.detail("Limit", limit);
if (e.code() != error_code_inverted_range) {
TraceEvent(SevError, "MetaclusterManagementConcurrencyListClusterFailure")
.error(e)
.detail("ClusterName1", clusterName1)
.detail("ClusterName2", clusterName2);
ASSERT(false);
}
return Void();
}
return Void();
}
ACTOR static Future<Void> getCluster(MetaclusterManagementConcurrencyWorkload* self) {
state ClusterName clusterName = self->chooseClusterName();
state Database dataDb = self->dataDbs[clusterName];
try {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyGetCluster").detail("ClusterName", clusterName);
DataClusterMetadata clusterMetadata = wait(MetaclusterAPI::getCluster(self->managementDb, clusterName));
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyGotCluster").detail("ClusterName", clusterName);
ASSERT(dataDb.getReference()->getConnectionRecord()->getConnectionString() ==
clusterMetadata.connectionString);
} catch (Error& e) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyGetClusterError")
.error(e)
.detail("ClusterName", clusterName);
if (e.code() != error_code_cluster_not_found) {
TraceEvent(SevError, "MetaclusterManagementConcurrencyGetClusterFailure")
.error(e)
.detail("ClusterName", clusterName);
ASSERT(false);
}
return Void();
}
return Void();
}
ACTOR static Future<Optional<DataClusterEntry>> configureImpl(MetaclusterManagementConcurrencyWorkload* self,
ClusterName clusterName,
Optional<int64_t> numTenantGroups,
Optional<ClusterConnectionString> connectionString) {
state Reference<ITransaction> tr = self->managementDb->createTransaction();
loop {
try {
tr->setOption(FDBTransactionOptions::ACCESS_SYSTEM_KEYS);
Optional<DataClusterMetadata> clusterMetadata =
wait(MetaclusterAPI::tryGetClusterTransaction(tr, clusterName));
state Optional<DataClusterEntry> entry;
if (clusterMetadata.present()) {
if (numTenantGroups.present()) {
entry = clusterMetadata.get().entry;
entry.get().capacity.numTenantGroups = numTenantGroups.get();
}
MetaclusterAPI::updateClusterMetadata(
tr, clusterName, clusterMetadata.get(), connectionString, entry);
wait(buggifiedCommit(tr, BUGGIFY_WITH_PROB(0.1)));
}
return entry;
} catch (Error& e) {
wait(safeThreadFutureToFuture(tr->onError(e)));
}
}
}
ACTOR static Future<Void> configureCluster(MetaclusterManagementConcurrencyWorkload* self) {
state ClusterName clusterName = self->chooseClusterName();
state Database dataDb = self->dataDbs[clusterName];
state UID debugId = deterministicRandom()->randomUniqueID();
state Optional<int64_t> newNumTenantGroups;
state Optional<ClusterConnectionString> connectionString;
if (deterministicRandom()->coinflip()) {
newNumTenantGroups = deterministicRandom()->randomInt(0, 4);
}
if (deterministicRandom()->coinflip()) {
connectionString = dataDb.getReference()->getConnectionRecord()->getConnectionString();
}
try {
loop {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyConfigureCluster", debugId)
.detail("ClusterName", clusterName)
.detail("NewNumTenantGroups", newNumTenantGroups.orDefault(-1))
.detail("NewConnectionString",
connectionString.map(&ClusterConnectionString::toString).orDefault(""));
Optional<Optional<DataClusterEntry>> result =
wait(timeout(configureImpl(self, clusterName, newNumTenantGroups, connectionString),
deterministicRandom()->randomInt(1, 30)));
if (result.present()) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyConfiguredCluster", debugId)
.detail("ClusterName", clusterName)
.detail("NewNumTenantGroups", newNumTenantGroups.orDefault(-1))
.detail("NewConnectionString",
connectionString.map(&ClusterConnectionString::toString).orDefault(""));
break;
}
}
} catch (Error& e) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyConfigureClusterError", debugId)
.error(e)
.detail("ClusterName", clusterName)
.detail("NewNumTenantGroups", newNumTenantGroups.orDefault(-1))
.detail("NewConnectionString", connectionString.map(&ClusterConnectionString::toString).orDefault(""));
if (e.code() != error_code_cluster_not_found && e.code() != error_code_cluster_removed &&
e.code() != error_code_invalid_metacluster_operation && e.code() != error_code_cluster_restoring) {
TraceEvent(SevError, "MetaclusterManagementConcurrencyConfigureClusterFailure")
.error(e)
.detail("ClusterName", clusterName);
ASSERT(false);
}
}
return Void();
}
ACTOR static Future<Void> restoreCluster(MetaclusterManagementConcurrencyWorkload* self) {
state ClusterName clusterName = self->chooseClusterName();
state Database db = self->dataDbs[clusterName];
state ApplyManagementClusterUpdates applyManagementClusterUpdates(deterministicRandom()->coinflip());
state ForceJoin forceJoin(deterministicRandom()->coinflip());
state bool removeFirst = !applyManagementClusterUpdates && deterministicRandom()->coinflip();
state UID debugId = deterministicRandom()->randomUniqueID();
try {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRestore", debugId)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
if (removeFirst) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRestoreRemoveDataCluster", debugId)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
wait(success(MetaclusterAPI::removeCluster(
self->managementDb, clusterName, ClusterType::METACLUSTER_MANAGEMENT, ForceRemove::True)));
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRestoreRemovedDataCluster", debugId)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
}
state std::vector<std::string> messages;
if (deterministicRandom()->coinflip()) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRestoreDryRun", debugId)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
wait(MetaclusterAPI::restoreCluster(self->managementDb,
clusterName,
db->getConnectionRecord()->getConnectionString(),
applyManagementClusterUpdates,
RestoreDryRun::True,
forceJoin,
ForceReuseTenantIdPrefix::True,
&messages));
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRestoreDryRunDone", debugId)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
messages.clear();
}
wait(MetaclusterAPI::restoreCluster(self->managementDb,
clusterName,
db->getConnectionRecord()->getConnectionString(),
applyManagementClusterUpdates,
RestoreDryRun::False,
forceJoin,
ForceReuseTenantIdPrefix::True,
&messages));
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRestoreComplete", debugId)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
} catch (Error& e) {
TraceEvent(SevDebug, "MetaclusterManagementConcurrencyRestoreError", debugId)
.error(e)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
if (e.code() == error_code_cluster_already_registered) {
ASSERT(!forceJoin || applyManagementClusterUpdates == ApplyManagementClusterUpdates::False);
} else if (applyManagementClusterUpdates == ApplyManagementClusterUpdates::True &&
e.code() == error_code_invalid_data_cluster) {
// Restoring a data cluster can fail if the cluster is not actually a data cluster registered with
// the metacluster
} else if (applyManagementClusterUpdates == ApplyManagementClusterUpdates::False &&
(e.code() == error_code_cluster_already_exists || e.code() == error_code_tenant_already_exists ||
e.code() == error_code_invalid_tenant_configuration)) {
// Repopulating a management cluster can fail if the cluster is already in the metacluster
} else if (e.code() != error_code_cluster_not_found && e.code() != error_code_cluster_removed &&
e.code() != error_code_conflicting_restore) {
TraceEvent(SevError, "MetaclusterManagementConcurrencyRestoreFailure", debugId)
.error(e)
.detail("ClusterName", clusterName)
.detail("ApplyManagementClusterUpdates", applyManagementClusterUpdates);
ASSERT(false);
}
wait(success(errorOr(MetaclusterAPI::removeCluster(
self->managementDb, clusterName, ClusterType::METACLUSTER_MANAGEMENT, ForceRemove::True))));
}
return Void();
}
Future<Void> start(Database const& cx) override { return _start(cx, this); }
ACTOR static Future<Void> _start(Database cx, MetaclusterManagementConcurrencyWorkload* self) {
state double start = now();
// Run a random sequence of metacluster management operations for the duration of the test
while (now() < start + self->testDuration) {
state int operation = deterministicRandom()->randomInt(0, 6);
if (operation == 0) {
wait(registerCluster(self));
} else if (operation == 1) {
wait(removeCluster(self));
} else if (operation == 2) {
wait(listClusters(self));
} else if (operation == 3) {
wait(getCluster(self));
} else if (operation == 4) {
wait(configureCluster(self));
} else if (operation == 5) {
wait(restoreCluster(self));
}
}
return Void();
}
Future<bool> check(Database const& cx) override {
if (clientId == 0) {
return _check(cx, this);
} else {
return true;
}
}
ACTOR static Future<bool> _check(Database cx, MetaclusterManagementConcurrencyWorkload* self) {
// The metacluster consistency check runs the tenant consistency check for each cluster
state MetaclusterConsistencyCheck<IDatabase> metaclusterConsistencyCheck(
self->managementDb, AllowPartialMetaclusterOperations::True);
wait(metaclusterConsistencyCheck.run());
return true;
}
void getMetrics(std::vector<PerfMetric>& m) override {}
};
WorkloadFactory<MetaclusterManagementConcurrencyWorkload> MetaclusterManagementConcurrencyWorkloadFactory;