foundationdb/fdbclient/Tenant.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

251 lines
8.1 KiB
C++
Raw Normal View History

2022-02-24 00:06:39 +08:00
/*
* Tenant.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"
2022-02-24 00:06:39 +08:00
#include "fdbclient/SystemData.h"
#include "fdbclient/Tenant.h"
#include "fdbrpc/TenantInfo.h"
#include "flow/BooleanParam.h"
#include "flow/IRandom.h"
#include "libb64/decode.h"
#include "libb64/encode.h"
#include "flow/ApiVersion.h"
2022-02-24 00:06:39 +08:00
#include "flow/UnitTest.h"
FDB_DEFINE_BOOLEAN_PARAM(EnforceValidTenantId);
namespace Tenant {
Key idToPrefix(int64_t id) {
2022-05-27 03:49:22 +08:00
int64_t swapped = bigEndian64(id);
return StringRef(reinterpret_cast<const uint8_t*>(&swapped), Tenant::PREFIX_SIZE);
2022-05-27 03:49:22 +08:00
}
int64_t prefixToId(KeyRef prefix, EnforceValidTenantId enforceValidTenantId) {
ASSERT(prefix.size() == Tenant::PREFIX_SIZE);
2022-05-27 03:49:22 +08:00
int64_t id = *reinterpret_cast<const int64_t*>(prefix.begin());
id = bigEndian64(id);
if (enforceValidTenantId) {
ASSERT(id >= 0);
} else if (id < 0) {
return TenantInfo::INVALID_TENANT;
}
2022-05-27 03:49:22 +08:00
return id;
}
}; // namespace Tenant
2022-05-27 03:49:22 +08:00
std::string TenantMapEntry::tenantStateToString(TenantState tenantState) {
switch (tenantState) {
case TenantState::REGISTERING:
return "registering";
case TenantState::READY:
return "ready";
case TenantState::REMOVING:
return "removing";
case TenantState::UPDATING_CONFIGURATION:
return "updating configuration";
case TenantState::RENAMING_FROM:
return "renaming from";
case TenantState::RENAMING_TO:
return "renaming to";
2022-05-27 03:49:22 +08:00
case TenantState::ERROR:
return "error";
default:
UNREACHABLE();
2022-05-27 03:49:22 +08:00
}
}
TenantState TenantMapEntry::stringToTenantState(std::string stateStr) {
std::transform(stateStr.begin(), stateStr.end(), stateStr.begin(), [](unsigned char c) { return std::tolower(c); });
2022-05-27 03:49:22 +08:00
if (stateStr == "registering") {
return TenantState::REGISTERING;
} else if (stateStr == "ready") {
return TenantState::READY;
} else if (stateStr == "removing") {
return TenantState::REMOVING;
} else if (stateStr == "updating configuration") {
return TenantState::UPDATING_CONFIGURATION;
} else if (stateStr == "renaming from") {
return TenantState::RENAMING_FROM;
} else if (stateStr == "renaming to") {
return TenantState::RENAMING_TO;
2022-05-27 03:49:22 +08:00
} else if (stateStr == "error") {
return TenantState::ERROR;
}
throw invalid_option();
2022-05-27 03:49:22 +08:00
}
std::string TenantMapEntry::tenantLockStateToString(TenantLockState tenantState) {
switch (tenantState) {
case TenantLockState::UNLOCKED:
return "unlocked";
case TenantLockState::READ_ONLY:
return "read only";
case TenantLockState::LOCKED:
return "locked";
default:
UNREACHABLE();
}
}
TenantLockState TenantMapEntry::stringToTenantLockState(std::string stateStr) {
std::transform(stateStr.begin(), stateStr.end(), stateStr.begin(), [](unsigned char c) { return std::tolower(c); });
if (stateStr == "unlocked") {
return TenantLockState::UNLOCKED;
} else if (stateStr == "read only") {
return TenantLockState::READ_ONLY;
} else if (stateStr == "locked") {
return TenantLockState::LOCKED;
}
UNREACHABLE();
}
2022-05-27 03:49:22 +08:00
TenantMapEntry::TenantMapEntry() {}
2022-07-26 08:19:14 +08:00
TenantMapEntry::TenantMapEntry(int64_t id, TenantState tenantState, bool encrypted)
: tenantState(tenantState), encrypted(encrypted) {
2022-07-21 03:56:00 +08:00
setId(id);
}
2022-07-26 08:19:14 +08:00
TenantMapEntry::TenantMapEntry(int64_t id,
TenantState tenantState,
Optional<TenantGroupName> tenantGroup,
bool encrypted)
: tenantState(tenantState), tenantGroup(tenantGroup), encrypted(encrypted) {
2022-07-21 03:56:00 +08:00
setId(id);
}
void TenantMapEntry::setId(int64_t id) {
ASSERT(id >= 0);
this->id = id;
prefix = Tenant::idToPrefix(id);
2022-07-21 03:56:00 +08:00
}
2022-05-27 03:49:22 +08:00
std::string TenantMapEntry::toJson() const {
json_spirit::mObject tenantEntry;
tenantEntry["id"] = id;
2022-07-26 08:19:14 +08:00
tenantEntry["encrypted"] = encrypted;
json_spirit::mObject prefixObject;
std::string encodedPrefix = base64::encoder::from_string(prefix.toString());
// Remove trailing newline
encodedPrefix.resize(encodedPrefix.size() - 1);
prefixObject["base64"] = encodedPrefix;
prefixObject["printable"] = printable(prefix);
tenantEntry["prefix"] = prefixObject;
tenantEntry["tenant_state"] = TenantMapEntry::tenantStateToString(tenantState);
if (assignedCluster.present()) {
tenantEntry["assigned_cluster"] = assignedCluster.get().toString();
}
if (tenantGroup.present()) {
json_spirit::mObject tenantGroupObject;
std::string encodedTenantGroup = base64::encoder::from_string(tenantGroup.get().toString());
// Remove trailing newline
encodedTenantGroup.resize(encodedTenantGroup.size() - 1);
tenantGroupObject["base64"] = encodedTenantGroup;
tenantGroupObject["printable"] = printable(tenantGroup.get());
tenantEntry["tenant_group"] = tenantGroupObject;
}
return json_spirit::write_string(json_spirit::mValue(tenantEntry));
}
2022-07-09 06:56:22 +08:00
bool TenantMapEntry::matchesConfiguration(TenantMapEntry const& other) const {
return tenantGroup == other.tenantGroup && encrypted == other.encrypted;
}
void TenantMapEntry::configure(Standalone<StringRef> parameter, Optional<Value> value) {
if (parameter == "tenant_group"_sr) {
tenantGroup = value;
} else if (parameter == "assigned_cluster"_sr) {
assignedCluster = value;
} else {
TraceEvent(SevWarnAlways, "UnknownTenantConfigurationParameter").detail("Parameter", parameter);
throw invalid_tenant_configuration();
}
}
json_spirit::mObject TenantGroupEntry::toJson() const {
json_spirit::mObject tenantGroupEntry;
if (assignedCluster.present()) {
tenantGroupEntry["assigned_cluster"] = assignedCluster.get().toString();
}
return tenantGroupEntry;
}
TenantMetadataSpecification& TenantMetadata::instance() {
static TenantMetadataSpecification _instance = TenantMetadataSpecification("\xff/"_sr);
return _instance;
}
Key TenantMetadata::tenantMapPrivatePrefix() {
static Key _prefix = "\xff"_sr.withSuffix(tenantMap().subspace.begin);
return _prefix;
}
TEST_CASE("/fdbclient/libb64/base64decoder") {
Standalone<StringRef> buf = makeString(100);
for (int i = 0; i < 1000; ++i) {
int length = deterministicRandom()->randomInt(0, 100);
deterministicRandom()->randomBytes(mutateString(buf), length);
StringRef str = buf.substr(0, length);
std::string encodedStr = base64::encoder::from_string(str.toString());
// Remove trailing newline
encodedStr.resize(encodedStr.size() - 1);
std::string decodedStr = base64::decoder::from_string(encodedStr);
ASSERT(decodedStr == str.toString());
}
return Void();
}
2022-02-24 00:06:39 +08:00
TEST_CASE("/fdbclient/TenantMapEntry/Serialization") {
2022-07-26 08:19:14 +08:00
TenantMapEntry entry1(1, TenantState::READY, false);
2022-02-24 00:06:39 +08:00
ASSERT(entry1.prefix == "\x00\x00\x00\x00\x00\x00\x00\x01"_sr);
TenantMapEntry entry2 = TenantMapEntry::decode(entry1.encode());
2022-02-24 00:06:39 +08:00
ASSERT(entry1.id == entry2.id && entry1.prefix == entry2.prefix);
2022-07-26 08:19:14 +08:00
TenantMapEntry entry3(std::numeric_limits<int64_t>::max(), TenantState::READY, false);
ASSERT(entry3.prefix == "\x7f\xff\xff\xff\xff\xff\xff\xff"_sr);
TenantMapEntry entry4 = TenantMapEntry::decode(entry3.encode());
2022-02-24 00:06:39 +08:00
ASSERT(entry3.id == entry4.id && entry3.prefix == entry4.prefix);
for (int i = 0; i < 100; ++i) {
int bits = deterministicRandom()->randomInt(1, 64);
int64_t min = bits == 1 ? 0 : (UINT64_C(1) << (bits - 1));
int64_t maxPlusOne = std::min<uint64_t>(UINT64_C(1) << bits, std::numeric_limits<int64_t>::max());
2022-02-24 00:06:39 +08:00
int64_t id = deterministicRandom()->randomInt64(min, maxPlusOne);
2022-07-26 08:19:14 +08:00
TenantMapEntry entry(id, TenantState::READY, false);
2022-02-24 00:06:39 +08:00
int64_t bigEndianId = bigEndian64(id);
ASSERT(entry.id == id && entry.prefix == StringRef(reinterpret_cast<uint8_t*>(&bigEndianId), 8));
2022-02-24 00:06:39 +08:00
TenantMapEntry decodedEntry = TenantMapEntry::decode(entry.encode());
ASSERT(decodedEntry.id == entry.id && decodedEntry.prefix == entry.prefix);
2022-02-24 00:06:39 +08:00
}
return Void();
}