fcb8d040e8
Instead of lengthy blurbs, switch to single-line, machine-readable standardized (https://spdx.dev) license identifiers. The Linux kernel switched long ago, so there is strong precedent. Three cases are handled: AGPL-only, Apache-only, and dual licensed. For the latter case, I chose (AGPL-3.0-or-later and Apache-2.0), reasoning that our changes are extensive enough to apply our license. The changes we applied mechanically with a script, except to licenses/README.md. Closes #9937
96 lines
3.1 KiB
C++
96 lines
3.1 KiB
C++
/*
|
|
* Copyright (C) 2020-present ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "dht/token.hh"
|
|
#include <seastar/core/smp.hh>
|
|
|
|
namespace dht {
|
|
|
|
inline sstring cpu_sharding_algorithm_name() {
|
|
return "biased-token-round-robin";
|
|
}
|
|
|
|
std::vector<uint64_t> init_zero_based_shard_start(unsigned shards, unsigned sharding_ignore_msb_bits);
|
|
|
|
unsigned shard_of(unsigned shard_count, unsigned sharding_ignore_msb_bits, const token& t);
|
|
|
|
token token_for_next_shard(const std::vector<uint64_t>& shard_start, unsigned shard_count, unsigned sharding_ignore_msb_bits, const token& t, shard_id shard, unsigned spans);
|
|
|
|
class sharder {
|
|
protected:
|
|
unsigned _shard_count;
|
|
unsigned _sharding_ignore_msb_bits;
|
|
std::vector<uint64_t> _shard_start;
|
|
public:
|
|
sharder(unsigned shard_count = smp::count, unsigned sharding_ignore_msb_bits = 0);
|
|
virtual ~sharder() = default;
|
|
/**
|
|
* Calculates the shard that handles a particular token.
|
|
*/
|
|
virtual unsigned shard_of(const token& t) const;
|
|
|
|
/**
|
|
* Gets the first token greater than `t` that is in shard `shard`, and is a shard boundary (its first token).
|
|
*
|
|
* If the `spans` parameter is greater than zero, the result is the same as if the function
|
|
* is called `spans` times, each time applied to its return value, but efficiently. This allows
|
|
* selecting ranges that include multiple round trips around the 0..smp::count-1 shard span:
|
|
*
|
|
* token_for_next_shard(t, shard, spans) == token_for_next_shard(token_for_next_shard(t, shard, 1), spans - 1)
|
|
*
|
|
* On overflow, maximum_token() is returned.
|
|
*/
|
|
virtual token token_for_next_shard(const token& t, shard_id shard, unsigned spans = 1) const;
|
|
|
|
/**
|
|
* @return number of shards configured for this partitioner
|
|
*/
|
|
unsigned shard_count() const {
|
|
return _shard_count;
|
|
}
|
|
|
|
unsigned sharding_ignore_msb() const {
|
|
return _sharding_ignore_msb_bits;
|
|
}
|
|
|
|
bool operator==(const sharder& o) const {
|
|
return _shard_count == o._shard_count && _sharding_ignore_msb_bits == o._sharding_ignore_msb_bits;
|
|
}
|
|
|
|
bool operator!=(const sharder& o) const {
|
|
return !(*this == o);
|
|
}
|
|
|
|
};
|
|
|
|
inline std::ostream& operator<<(std::ostream& os, const sharder& sharder) {
|
|
os << "sharder[shard_count=" << sharder.shard_count()
|
|
<< ", ignore_msb_bits="<< sharder.sharding_ignore_msb() << "]";
|
|
return os;
|
|
}
|
|
|
|
/*
|
|
* Finds the first token in token range (`start`, `end`] that belongs to shard shard_idx.
|
|
*
|
|
* If there is no token that belongs to shard shard_idx in this range,
|
|
* `end` is returned.
|
|
*
|
|
* The first token means the one that appears first on the ring when going
|
|
* from `start` to `end`.
|
|
* 'first token' is not always the smallest.
|
|
* For example, if in vnode (100, 10] only tokens 110 and 1 belong to
|
|
* shard shard_idx then token 110 is the first because it appears first
|
|
* when going from 100 to 10 on the ring.
|
|
*/
|
|
dht::token find_first_token_for_shard(
|
|
const dht::sharder& sharder, dht::token start, dht::token end, size_t shard_idx);
|
|
|
|
} //namespace dht
|