390 lines
15 KiB
C++
390 lines
15 KiB
C++
/*
|
|
* ConflictRange.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 "fdbclient/NativeAPI.actor.h"
|
|
#include "fdbserver/TesterInterface.actor.h"
|
|
#include "fdbclient/ReadYourWrites.h"
|
|
#include "fdbserver/workloads/workloads.actor.h"
|
|
#include "fdbclient/ManagementAPI.actor.h"
|
|
#include "flow/actorcompiler.h" // This must be the last #include.
|
|
|
|
// For this test to report properly buggify must be disabled (flow.h) , and failConnection must be disabled in
|
|
// (sim2.actor.cpp)
|
|
|
|
struct ConflictRangeWorkload : TestWorkload {
|
|
int minOperationsPerTransaction, maxOperationsPerTransaction, maxKeySpace, maxOffset, minInitialAmount,
|
|
maxInitialAmount;
|
|
double testDuration;
|
|
bool testReadYourWrites;
|
|
|
|
std::vector<Future<Void>> clients;
|
|
PerfIntCounter withConflicts, withoutConflicts, retries;
|
|
|
|
ConflictRangeWorkload(WorkloadContext const& wcx)
|
|
: TestWorkload(wcx), withConflicts("WithConflicts"), withoutConflicts("withoutConflicts"), retries("Retries") {
|
|
minOperationsPerTransaction = getOption(options, LiteralStringRef("minOperationsPerTransaction"), 2);
|
|
maxOperationsPerTransaction = getOption(options, LiteralStringRef("minOperationsPerTransaction"), 4);
|
|
maxKeySpace = getOption(options, LiteralStringRef("maxKeySpace"), 100);
|
|
maxOffset = getOption(options, LiteralStringRef("maxOffset"), 5);
|
|
testDuration = getOption(options, LiteralStringRef("testDuration"), 10.0);
|
|
testReadYourWrites = getOption(options, LiteralStringRef("testReadYourWrites"), false);
|
|
}
|
|
|
|
std::string description() const override { return "ConflictRange"; }
|
|
|
|
Future<Void> setup(Database const& cx) override { return Void(); }
|
|
|
|
Future<Void> start(Database const& cx) override { return _start(cx, this); }
|
|
|
|
Future<bool> check(Database const& cx) override {
|
|
clients.clear();
|
|
return true;
|
|
}
|
|
|
|
void getMetrics(std::vector<PerfMetric>& m) override {
|
|
m.push_back(withConflicts.getMetric());
|
|
m.push_back(withoutConflicts.getMetric());
|
|
m.push_back(retries.getMetric());
|
|
}
|
|
|
|
ACTOR Future<Void> _start(Database cx, ConflictRangeWorkload* self) {
|
|
if (self->clientId == 0)
|
|
wait(timeout(self->conflictRangeClient(cx, self), self->testDuration, Void()));
|
|
return Void();
|
|
}
|
|
|
|
ACTOR Future<Void> conflictRangeClient(Database cx, ConflictRangeWorkload* self) {
|
|
state std::string clientID;
|
|
state std::string myKeyA;
|
|
state std::string myKeyB;
|
|
state std::string myValue;
|
|
state bool onEqualA;
|
|
state bool onEqualB;
|
|
state int offsetA;
|
|
state int offsetB;
|
|
state int randomLimit;
|
|
state bool randomSets = false;
|
|
state std::set<int> insertedSet;
|
|
state RangeResult originalResults;
|
|
state Standalone<StringRef> firstElement;
|
|
|
|
state std::set<int> clearedSet;
|
|
state int clearedBegin;
|
|
state int clearedEnd;
|
|
|
|
if (g_network->isSimulated()) {
|
|
wait(timeKeeperSetDisable(cx));
|
|
}
|
|
|
|
// Set one key after the end of the tested range. If this key is included in the result, then
|
|
// we may have drifted into the system key-space and cannot evaluate the result.
|
|
state Key sentinelKey = StringRef(format("%010d", self->maxKeySpace));
|
|
|
|
loop {
|
|
randomSets = !randomSets;
|
|
|
|
// Initialize the database with random values.
|
|
loop {
|
|
state Transaction tr0(cx);
|
|
try {
|
|
TraceEvent("ConflictRangeReset").log();
|
|
insertedSet.clear();
|
|
|
|
if (self->testReadYourWrites) {
|
|
clearedSet.clear();
|
|
int clearedA = deterministicRandom()->randomInt(0, self->maxKeySpace - 1);
|
|
int clearedB = deterministicRandom()->randomInt(0, self->maxKeySpace - 1);
|
|
clearedBegin = std::min(clearedA, clearedB);
|
|
clearedEnd = std::max(clearedA, clearedB) + 1;
|
|
TraceEvent("ConflictRangeClear").detail("Begin", clearedBegin).detail("End", clearedEnd);
|
|
}
|
|
|
|
tr0.clear(
|
|
KeyRangeRef(StringRef(format("%010d", 0)), StringRef(format("%010d", self->maxKeySpace))));
|
|
for (int i = 0; i < self->maxKeySpace; i++) {
|
|
if (deterministicRandom()->random01() > 0.5) {
|
|
TraceEvent("ConflictRangeInit").detail("Key", i);
|
|
if (self->testReadYourWrites && i >= clearedBegin && i < clearedEnd)
|
|
clearedSet.insert(i);
|
|
else {
|
|
insertedSet.insert(i);
|
|
tr0.set(StringRef(format("%010d", i)),
|
|
deterministicRandom()->randomUniqueID().toString());
|
|
}
|
|
}
|
|
}
|
|
|
|
tr0.set(sentinelKey, deterministicRandom()->randomUniqueID().toString());
|
|
|
|
wait(tr0.commit());
|
|
break;
|
|
} catch (Error& e) {
|
|
wait(tr0.onError(e));
|
|
}
|
|
}
|
|
|
|
firstElement = Key(StringRef(format("%010d", *(insertedSet.begin()))));
|
|
|
|
state Transaction tr1(cx);
|
|
state Transaction tr2(cx);
|
|
state Transaction tr3(cx);
|
|
state Transaction tr4(cx);
|
|
state ReadYourWritesTransaction trRYOW(cx);
|
|
|
|
try {
|
|
// Generate a random getRange operation and execute it, if it produces results, save them, otherwise
|
|
// retry.
|
|
loop {
|
|
myKeyA = format("%010d", deterministicRandom()->randomInt(0, self->maxKeySpace));
|
|
myKeyB = format("%010d", deterministicRandom()->randomInt(0, self->maxKeySpace));
|
|
onEqualA = deterministicRandom()->randomInt(0, 2) != 0;
|
|
onEqualB = deterministicRandom()->randomInt(0, 2) != 0;
|
|
offsetA = deterministicRandom()->randomInt(-1 * self->maxOffset, self->maxOffset);
|
|
offsetB = deterministicRandom()->randomInt(-1 * self->maxOffset, self->maxOffset);
|
|
randomLimit = deterministicRandom()->randomInt(1, self->maxKeySpace);
|
|
|
|
RangeResult res = wait(tr1.getRange(KeySelectorRef(StringRef(myKeyA), onEqualA, offsetA),
|
|
KeySelectorRef(StringRef(myKeyB), onEqualB, offsetB),
|
|
randomLimit));
|
|
if (res.size()) {
|
|
originalResults = res;
|
|
break;
|
|
}
|
|
tr1 = Transaction(cx);
|
|
}
|
|
|
|
if (self->testReadYourWrites) {
|
|
for (auto iter = clearedSet.begin(); iter != clearedSet.end(); ++iter)
|
|
tr1.set(StringRef(format("%010d", (*iter))),
|
|
deterministicRandom()->randomUniqueID().toString());
|
|
wait(tr1.commit());
|
|
tr1 = Transaction(cx);
|
|
}
|
|
|
|
// Create two transactions with the same read version
|
|
Version readVersion = wait(tr2.getReadVersion());
|
|
|
|
if (self->testReadYourWrites) {
|
|
trRYOW.setVersion(readVersion);
|
|
} else
|
|
tr3.setVersion(readVersion);
|
|
|
|
// Do random operations in one of the transactions and commit.
|
|
// Either do all sets in locations without existing data or all clears in locations with data.
|
|
for (int i = 0; i < deterministicRandom()->randomInt(self->minOperationsPerTransaction,
|
|
self->maxOperationsPerTransaction + 1);
|
|
i++) {
|
|
if (randomSets) {
|
|
for (int j = 0; j < 5; j++) {
|
|
int proposedKey = deterministicRandom()->randomInt(0, self->maxKeySpace);
|
|
if (!insertedSet.count(proposedKey)) {
|
|
TraceEvent("ConflictRangeSet").detail("Key", proposedKey);
|
|
insertedSet.insert(proposedKey);
|
|
tr2.set(StringRef(format("%010d", proposedKey)),
|
|
deterministicRandom()->randomUniqueID().toString());
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
for (int j = 0; j < 5; j++) {
|
|
int proposedKey = deterministicRandom()->randomInt(0, self->maxKeySpace);
|
|
if (insertedSet.count(proposedKey)) {
|
|
TraceEvent("ConflictRangeClear").detail("Key", proposedKey);
|
|
insertedSet.erase(proposedKey);
|
|
tr2.clear(StringRef(format("%010d", proposedKey)));
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
wait(tr2.commit());
|
|
|
|
state bool foundConflict = false;
|
|
try {
|
|
// Do the generated getRange in the other transaction and commit.
|
|
if (self->testReadYourWrites) {
|
|
trRYOW.clear(KeyRangeRef(StringRef(format("%010d", clearedBegin)),
|
|
StringRef(format("%010d", clearedEnd))));
|
|
RangeResult res = wait(trRYOW.getRange(KeySelectorRef(StringRef(myKeyA), onEqualA, offsetA),
|
|
KeySelectorRef(StringRef(myKeyB), onEqualB, offsetB),
|
|
randomLimit));
|
|
wait(trRYOW.commit());
|
|
} else {
|
|
tr3.clear(StringRef(format("%010d", self->maxKeySpace + 1)));
|
|
RangeResult res = wait(tr3.getRange(KeySelectorRef(StringRef(myKeyA), onEqualA, offsetA),
|
|
KeySelectorRef(StringRef(myKeyB), onEqualB, offsetB),
|
|
randomLimit));
|
|
wait(tr3.commit());
|
|
}
|
|
} catch (Error& e) {
|
|
if (e.code() != error_code_not_committed)
|
|
throw e;
|
|
foundConflict = true;
|
|
}
|
|
|
|
if (foundConflict) {
|
|
// If the commit fails, do the getRange again and check that the results are different from the
|
|
// first execution.
|
|
if (self->testReadYourWrites) {
|
|
tr1.clear(KeyRangeRef(StringRef(format("%010d", clearedBegin)),
|
|
StringRef(format("%010d", clearedEnd))));
|
|
wait(tr1.commit());
|
|
tr1 = Transaction(cx);
|
|
}
|
|
|
|
RangeResult res = wait(tr4.getRange(KeySelectorRef(StringRef(myKeyA), onEqualA, offsetA),
|
|
KeySelectorRef(StringRef(myKeyB), onEqualB, offsetB),
|
|
randomLimit));
|
|
++self->withConflicts;
|
|
|
|
if (res.size() == originalResults.size()) {
|
|
for (int i = 0; i < res.size(); i++)
|
|
if (res[i] != originalResults[i])
|
|
throw not_committed();
|
|
|
|
// Discard known cases where conflicts do not change the results
|
|
if (originalResults.size() == randomLimit && offsetB <= 0) {
|
|
// Hit limit but end offset goes backwards, so changes could effect results even though in
|
|
// this instance they did not
|
|
throw not_committed();
|
|
}
|
|
|
|
if (originalResults[originalResults.size() - 1].key >= sentinelKey) {
|
|
// Results go into server keyspace, so if a key selector does not fully resolve offset, a
|
|
// change won't effect results
|
|
throw not_committed();
|
|
}
|
|
|
|
if ((originalResults[0].key == firstElement ||
|
|
originalResults[0].key == StringRef(format("%010d", *(insertedSet.begin())))) &&
|
|
offsetA < 0) {
|
|
// Results return the first element, and the begin offset is negative, so if a key selector
|
|
// does not fully resolve the offset, a change won't effect results
|
|
throw not_committed();
|
|
}
|
|
|
|
if ((myKeyA > myKeyB || (myKeyA == myKeyB && onEqualA && !onEqualB)) &&
|
|
originalResults.size() == randomLimit) {
|
|
// The begin key is less than the end key, so changes in this range only effect the end key
|
|
// selector, but because we hit the limit this does not change the results
|
|
throw not_committed();
|
|
}
|
|
|
|
std::string keyStr1 = "";
|
|
for (int i = 0; i < res.size(); i++) {
|
|
keyStr1 += printable(res[i].key) + " ";
|
|
}
|
|
|
|
std::string keyStr2 = "";
|
|
for (int i = 0; i < originalResults.size(); i++) {
|
|
keyStr2 += printable(originalResults[i].key) + " ";
|
|
}
|
|
|
|
TraceEvent(SevError, "ConflictRangeError")
|
|
.detail("Info", "Conflict returned, however results are the same")
|
|
.detail("RandomSets", randomSets)
|
|
.detail("MyKeyA", myKeyA)
|
|
.detail("MyKeyB", myKeyB)
|
|
.detail("OnEqualA", onEqualA)
|
|
.detail("OnEqualB", onEqualB)
|
|
.detail("OffsetA", offsetA)
|
|
.detail("OffsetB", offsetB)
|
|
.detail("RandomLimit", randomLimit)
|
|
.detail("Size", originalResults.size())
|
|
.detail("Results", keyStr1)
|
|
.detail("Original", keyStr2);
|
|
|
|
tr4 = Transaction(cx);
|
|
RangeResult res = wait(tr4.getRange(
|
|
KeyRangeRef(StringRef(format("%010d", 0)), StringRef(format("%010d", self->maxKeySpace))),
|
|
200));
|
|
std::string allKeyEntries = "";
|
|
for (int i = 0; i < res.size(); i++) {
|
|
allKeyEntries += printable(res[i].key) + " ";
|
|
}
|
|
|
|
TraceEvent("ConflictRangeDump").setMaxFieldLength(10000).detail("Keys", allKeyEntries);
|
|
}
|
|
throw not_committed();
|
|
} else {
|
|
// If the commit is successful, check that the result matches the first execution.
|
|
RangeResult res = wait(tr4.getRange(KeySelectorRef(StringRef(myKeyA), onEqualA, offsetA),
|
|
KeySelectorRef(StringRef(myKeyB), onEqualB, offsetB),
|
|
randomLimit));
|
|
++self->withoutConflicts;
|
|
|
|
if (res.size() == originalResults.size()) {
|
|
for (int i = 0; i < res.size(); i++) {
|
|
if (res[i] != originalResults[i] &&
|
|
!(res[i].key.startsWith("\xff"_sr) && originalResults[i].key.startsWith("\xff"_sr))) {
|
|
TraceEvent(SevError, "ConflictRangeError")
|
|
.detail("Info", "No conflict returned, however results do not match")
|
|
.detail("Original",
|
|
printable(originalResults[i].key) + " " +
|
|
printable(originalResults[i].value))
|
|
.detail("New", printable(res[i].key) + " " + printable(res[i].value));
|
|
}
|
|
}
|
|
} else {
|
|
std::string keyStr1 = "";
|
|
for (int i = 0; i < res.size(); i++) {
|
|
keyStr1 += printable(res[i].key) + " ";
|
|
}
|
|
|
|
std::string keyStr2 = "";
|
|
for (int i = 0; i < originalResults.size(); i++) {
|
|
keyStr2 += printable(originalResults[i].key) + " ";
|
|
}
|
|
|
|
TraceEvent(SevError, "ConflictRangeError")
|
|
.detail("Info", "No conflict returned, however result sizes do not match")
|
|
.detail("OriginalSize", originalResults.size())
|
|
.detail("NewSize", res.size())
|
|
.detail("RandomSets", randomSets)
|
|
.detail("MyKeyA", myKeyA)
|
|
.detail("MyKeyB", myKeyB)
|
|
.detail("OnEqualA", onEqualA)
|
|
.detail("OnEqualB", onEqualB)
|
|
.detail("OffsetA", offsetA)
|
|
.detail("OffsetB", offsetB)
|
|
.detail("RandomLimit", randomLimit)
|
|
.detail("Size", originalResults.size())
|
|
.detail("Results", keyStr1)
|
|
.detail("Original", keyStr2);
|
|
}
|
|
}
|
|
} catch (Error& e) {
|
|
state Error e2 = e;
|
|
if (e2.code() != error_code_not_committed)
|
|
++self->retries;
|
|
|
|
wait(tr1.onError(e2));
|
|
wait(tr2.onError(e2));
|
|
wait(tr3.onError(e2));
|
|
wait(tr4.onError(e2));
|
|
wait(trRYOW.onError(e2));
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
WorkloadFactory<ConflictRangeWorkload> ConflictRangeWorkloadFactory("ConflictRange");
|