Files
scylladb/mutation/mutation_fragment_stream_validator.cc
Kefu Chai 3e84d43f93 treewide: use seastar::format() or fmt::format() explicitly
before this change, we rely on `using namespace seastar` to use
`seastar::format()` without qualifying the `format()` with its
namespace. this works fine until we changed the parameter type
of format string `seastar::format()` from `const char*` to
`fmt::format_string<...>`. this change practically invited
`seastar::format()` to the club of `std::format()` and `fmt::format()`,
where all members accept a templated parameter as its `fmt`
parameter. and `seastar::format()` is not the best candidate anymore.
despite that argument-dependent lookup (ADT for short) favors the
function which is in the same namespace as its parameter, but
`using namespace` makes `seastar::format()` more competitive,
so both `std::format()` and `seastar::format()` are considered
as the condidates.

that is what is happening scylladb in quite a few caller sites of
`format()`, hence ADT is not able to tell which function the winner
in the name lookup:

```
/__w/scylladb/scylladb/mutation/mutation_fragment_stream_validator.cc:265:12: error: call to 'format' is ambiguous
  265 |     return format("{} ({}.{} {})", _name_view, s.ks_name(), s.cf_name(), s.id());
      |            ^~~~~~
/usr/bin/../lib/gcc/x86_64-redhat-linux/14/../../../../include/c++/14/format:4290:5: note: candidate function [with _Args = <const std::basic_string_view<char> &, const seastar::basic_sstring<char, unsigned int, 15> &, const seastar::basic_sstring<char, unsigned int, 15> &, const utils::tagged_uuid<table_id_tag> &>]
 4290 |     format(format_string<_Args...> __fmt, _Args&&... __args)
      |     ^
/__w/scylladb/scylladb/seastar/include/seastar/core/print.hh:143:1: note: candidate function [with A = <const std::basic_string_view<char> &, const seastar::basic_sstring<char, unsigned int, 15> &, const seastar::basic_sstring<char, unsigned int, 15> &, const utils::tagged_uuid<table_id_tag> &>]
  143 | format(fmt::format_string<A...> fmt, A&&... a) {
      | ^
```

in this change, we

change all `format()` to either `fmt::format()` or `seastar::format()`
with following rules:
- if the caller expects an `sstring` or `std::string_view`, change to
  `seastar::format()`
- if the caller expects an `std::string`, change to `fmt::format()`.
  because, `sstring::operator std::basic_string` would incur a deep
  copy.

we will need another change to enable scylladb to compile with the
latest seastar. namely, to pass the format string as a templated
parameter down to helper functions which format their parameters.
to miminize the scope of this change, let's include that change when
bumping up the seastar submodule. as that change will depend on
the seastar change.

Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
2024-09-11 23:21:40 +03:00

382 lines
16 KiB
C++

/*
* Copyright (C) 2023-present ScyllaDB
*/
/*
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
#include "mutation/mutation_fragment_stream_validator.hh"
#include "utils/to_string.hh"
#include "seastarx.hh"
logging::logger validator_log("mutation_fragment_stream_validator");
invalid_mutation_fragment_stream::invalid_mutation_fragment_stream(std::runtime_error e) : std::runtime_error(std::move(e)) {
}
static mutation_fragment_v2::kind to_mutation_fragment_kind_v2(mutation_fragment::kind k) {
switch (k) {
case mutation_fragment::kind::partition_start:
return mutation_fragment_v2::kind::partition_start;
case mutation_fragment::kind::static_row:
return mutation_fragment_v2::kind::static_row;
case mutation_fragment::kind::clustering_row:
return mutation_fragment_v2::kind::clustering_row;
case mutation_fragment::kind::range_tombstone:
return mutation_fragment_v2::kind::range_tombstone_change;
case mutation_fragment::kind::partition_end:
return mutation_fragment_v2::kind::partition_end;
}
std::abort();
}
mutation_fragment_stream_validator::mutation_fragment_stream_validator(const ::schema& s)
: _schema(s)
, _prev_kind(mutation_fragment_v2::kind::partition_end)
, _prev_pos(position_in_partition::end_of_partition_tag_t{})
, _prev_partition_key(dht::minimum_token(), partition_key::make_empty()) {
}
static sstring
format_partition_key(const schema& s, const dht::decorated_key& pkey, const char* prefix = "") {
if (pkey.key().is_empty()) {
return "";
}
return format("{}{} ({})", prefix, pkey.key().with_schema(s), pkey);
}
static mutation_fragment_stream_validator::validation_result
ooo_key_result(const schema& s, dht::token t, const partition_key* pkey, dht::decorated_key prev_key) {
return mutation_fragment_stream_validator::validation_result::invalid(format("out-of-order {} {}, previous {} was {}",
pkey ? "partition key" : "token",
pkey ? format("{} ({{key: {}, token: {}}})", pkey->with_schema(s), *pkey, t) : format("{}", t),
prev_key.key().is_empty() ? "token" : "partition key",
prev_key.key().is_empty() ? format("{}", prev_key.token()) : format_partition_key(s, prev_key)));
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::validate(dht::token t, const partition_key* pkey) {
if (_prev_partition_key.token() > t) {
return ooo_key_result(_schema, t, pkey, _prev_partition_key);
}
partition_key::tri_compare cmp(_schema);
if (_prev_partition_key.token() == t && pkey && cmp(_prev_partition_key.key(), *pkey) >= 0) {
return ooo_key_result(_schema, t, pkey, _prev_partition_key);
}
_prev_partition_key._token = t;
if (pkey) {
_prev_partition_key._key = *pkey;
} else {
// If new partition-key is not supplied, we reset it to empty one, which
// will compare less than any other key, making sure we don't attempt to
// compare partition-keys belonging to different tokens.
if (!_prev_partition_key.key().is_empty()) {
_prev_partition_key._key = partition_key::make_empty();
}
}
return validation_result::valid();
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(const dht::decorated_key& dk) {
return validate(dk.token(), &dk.key());
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(dht::token t) {
return validate(t, nullptr);
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::validate(mutation_fragment_v2::kind kind, std::optional<position_in_partition_view> pos,
std::optional<tombstone> new_current_tombstone) {
// Check for unclosed range tombstone on partition end
if (kind == mutation_fragment_v2::kind::partition_end && _current_tombstone) {
return validation_result::invalid(format("invalid partition-end, partition {} has an active range tombstone {}",
format_partition_key(_schema, _prev_partition_key), _current_tombstone));
}
auto valid = true;
// Check fragment kind order
switch (_prev_kind) {
case mutation_fragment_v2::kind::partition_start:
valid = kind != mutation_fragment_v2::kind::partition_start;
break;
case mutation_fragment_v2::kind::static_row: // fall-through
case mutation_fragment_v2::kind::clustering_row: // fall-through
case mutation_fragment_v2::kind::range_tombstone_change:
valid = kind != mutation_fragment_v2::kind::partition_start &&
kind != mutation_fragment_v2::kind::static_row;
break;
case mutation_fragment_v2::kind::partition_end:
valid = kind == mutation_fragment_v2::kind::partition_start;
break;
}
if (!valid) {
return validation_result::invalid(format("out-of-order mutation fragment {}{}, previous mutation fragment was {}",
kind,
format_partition_key(_schema, _prev_partition_key, " in partition "),
_prev_kind));
}
if (pos && _prev_kind != mutation_fragment_v2::kind::partition_end) {
auto cmp = position_in_partition::tri_compare(_schema);
auto res = cmp(_prev_pos, *pos);
if (_prev_kind == mutation_fragment_v2::kind::range_tombstone_change) {
valid = res <= 0;
} else {
valid = res < 0;
}
if (!valid) {
return validation_result::invalid(format("out-of-order {} at position {}{}, previous clustering element was {} at position {}",
kind,
*pos,
format_partition_key(_schema, _prev_partition_key, " in partition "),
_prev_pos,
_prev_kind));
}
}
_prev_kind = kind;
if (pos) {
_prev_pos = *pos;
} else {
switch (kind) {
case mutation_fragment_v2::kind::partition_start:
_prev_pos = position_in_partition::for_partition_start();
break;
case mutation_fragment_v2::kind::static_row:
_prev_pos = position_in_partition(position_in_partition::static_row_tag_t{});
break;
case mutation_fragment_v2::kind::clustering_row:
[[fallthrough]];
case mutation_fragment_v2::kind::range_tombstone_change:
if (_prev_pos.region() != partition_region::clustered) { // don't move pos if it is already a clustering one
_prev_pos = position_in_partition(position_in_partition::before_clustering_row_tag_t{}, clustering_key::make_empty());
}
break;
case mutation_fragment_v2::kind::partition_end:
_prev_pos = position_in_partition(position_in_partition::end_of_partition_tag_t{});
break;
}
}
if (new_current_tombstone) {
_current_tombstone = *new_current_tombstone;
}
return validation_result::valid();
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(mutation_fragment_v2::kind kind, position_in_partition_view pos,
std::optional<tombstone> new_current_tombstone) {
return validate(kind, pos, new_current_tombstone);
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(mutation_fragment::kind kind, position_in_partition_view pos) {
return validate(to_mutation_fragment_kind_v2(kind), pos, {});
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(const mutation_fragment_v2& mf) {
return validate(mf.mutation_fragment_kind(), mf.position(),
mf.is_range_tombstone_change() ? std::optional(mf.as_range_tombstone_change().tombstone()) : std::nullopt);
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(const mutation_fragment& mf) {
return validate(to_mutation_fragment_kind_v2(mf.mutation_fragment_kind()), mf.position(), {});
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(mutation_fragment_v2::kind kind, std::optional<tombstone> new_current_tombstone) {
return validate(kind, {}, new_current_tombstone);
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::operator()(mutation_fragment::kind kind) {
return validate(to_mutation_fragment_kind_v2(kind), {}, {});
}
mutation_fragment_stream_validator::validation_result
mutation_fragment_stream_validator::on_end_of_stream() {
if (_prev_kind == mutation_fragment_v2::kind::partition_end) {
return validation_result::valid();
}
return validation_result::invalid(format("invalid end-of-stream, last partition{} was not closed, last fragment was {}",
format_partition_key(_schema, _prev_partition_key, " "),
_prev_kind));
}
void mutation_fragment_stream_validator::reset(dht::decorated_key dk) {
_prev_partition_key = std::move(dk);
_prev_pos = position_in_partition::for_partition_start();
_prev_kind = mutation_fragment_v2::kind::partition_start;
_current_tombstone = {};
}
void mutation_fragment_stream_validator::reset(mutation_fragment_v2::kind kind, position_in_partition_view pos, std::optional<tombstone> new_current_tombstone) {
_prev_pos = pos;
_prev_kind = kind;
if (new_current_tombstone) {
_current_tombstone = *new_current_tombstone;
}
}
void mutation_fragment_stream_validator::reset(const mutation_fragment_v2& mf) {
reset(mf.mutation_fragment_kind(), mf.position(), mf.is_range_tombstone_change() ? std::optional(mf.as_range_tombstone_change().tombstone()) : std::nullopt);
}
void mutation_fragment_stream_validator::reset(const mutation_fragment& mf) {
reset(to_mutation_fragment_kind_v2(mf.mutation_fragment_kind()), mf.position(), std::nullopt);
}
namespace {
bool on_validation_error(seastar::logger& l, const mutation_fragment_stream_validating_filter& zis, mutation_fragment_stream_validator::validation_result res) {
if (!zis.raise_errors()) {
l.error("[validator {} for {}] {}", fmt::ptr(&zis), zis.full_name(), res.what());
return false;
}
try {
on_internal_error(l, format("[validator {} for {}] {}", fmt::ptr(&zis), zis.full_name(), res.what()));
} catch (std::runtime_error& e) {
throw invalid_mutation_fragment_stream(e);
}
}
}
bool mutation_fragment_stream_validating_filter::operator()(const dht::decorated_key& dk) {
if (_validation_level < mutation_fragment_stream_validation_level::token) {
return true;
}
if (_validation_level == mutation_fragment_stream_validation_level::token) {
if (auto res = _validator(dk.token()); !res) {
return on_validation_error(validator_log, *this, res);
}
return true;
} else {
if (auto res = _validator(dk); !res) {
return on_validation_error(validator_log, *this, res);
}
return true;
}
}
sstring mutation_fragment_stream_validating_filter::full_name() const {
const auto& s = _validator.schema();
return seastar::format("{} ({}.{} {})", _name_view, s.ks_name(), s.cf_name(), s.id());
}
mutation_fragment_stream_validating_filter::mutation_fragment_stream_validating_filter(const char* name_literal, sstring name_value, const schema& s,
mutation_fragment_stream_validation_level level, bool raise_errors)
: _validator(s)
, _name_storage(std::move(name_value))
, _validation_level(level)
, _raise_errors(raise_errors)
{
if (name_literal) {
_name_view = name_literal;
} else {
_name_view = _name_storage;
}
if (validator_log.is_enabled(log_level::debug)) {
std::string_view what;
switch (_validation_level) {
case mutation_fragment_stream_validation_level::none:
what = "no";
break;
case mutation_fragment_stream_validation_level::partition_region:
what = "partition region";
break;
case mutation_fragment_stream_validation_level::token:
what = "partition region and token";
break;
case mutation_fragment_stream_validation_level::partition_key:
what = "partition region and partition key";
break;
case mutation_fragment_stream_validation_level::clustering_key:
what = "partition region, partition key and clustering key";
break;
}
validator_log.debug("[validator {} for {}] Will validate {} monotonicity.", static_cast<void*>(this), full_name(), what);
}
}
mutation_fragment_stream_validating_filter::mutation_fragment_stream_validating_filter(sstring name, const schema& s,
mutation_fragment_stream_validation_level level, bool raise_errors)
: mutation_fragment_stream_validating_filter(nullptr, std::move(name), s, level, raise_errors)
{ }
mutation_fragment_stream_validating_filter::mutation_fragment_stream_validating_filter(const char* name, const schema& s,
mutation_fragment_stream_validation_level level, bool raise_errors)
: mutation_fragment_stream_validating_filter(name, {}, s, level, raise_errors)
{ }
bool mutation_fragment_stream_validating_filter::operator()(mutation_fragment_v2::kind kind, position_in_partition_view pos,
std::optional<tombstone> new_current_tombstone) {
std::optional<mutation_fragment_stream_validator::validation_result> res;
validator_log.debug("[validator {}] {}:{} new_current_tombstone: {}", static_cast<void*>(this), kind, pos, new_current_tombstone);
if (_validation_level == mutation_fragment_stream_validation_level::none) {
return true;
} else if (_validation_level >= mutation_fragment_stream_validation_level::clustering_key) {
res = _validator(kind, pos, new_current_tombstone);
} else {
res = _validator(kind, new_current_tombstone);
}
if (__builtin_expect(!res->is_valid(), false)) {
return on_validation_error(validator_log, *this, *res);
}
return true;
}
bool mutation_fragment_stream_validating_filter::operator()(mutation_fragment::kind kind, position_in_partition_view pos) {
return (*this)(to_mutation_fragment_kind_v2(kind), pos, {});
}
bool mutation_fragment_stream_validating_filter::operator()(const mutation_fragment_v2& mv) {
return (*this)(mv.mutation_fragment_kind(), mv.position(),
mv.is_range_tombstone_change() ? std::optional(mv.as_range_tombstone_change().tombstone()) : std::nullopt);
}
bool mutation_fragment_stream_validating_filter::operator()(const mutation_fragment& mv) {
return (*this)(to_mutation_fragment_kind_v2(mv.mutation_fragment_kind()), mv.position(), {});
}
void mutation_fragment_stream_validating_filter::reset(mutation_fragment_v2::kind kind, position_in_partition_view pos,
std::optional<tombstone> new_current_tombstone) {
validator_log.debug("[validator {}] reset to {} @ {}{}", static_cast<const void*>(this), kind, pos, value_of([t = new_current_tombstone] () -> sstring {
if (!t) {
return "";
}
return format(" (new tombstone: {})", *t);
}));
_validator.reset(kind, pos, new_current_tombstone);
}
void mutation_fragment_stream_validating_filter::reset(const mutation_fragment_v2& mf) {
validator_log.debug("[validator {}] reset to {} @ {}{}", static_cast<const void*>(this), mf.mutation_fragment_kind(), mf.position(), value_of([&mf] () -> sstring {
if (!mf.is_range_tombstone_change()) {
return "";
}
return format(" (new tombstone: {})", mf.as_range_tombstone_change().tombstone());
}));
_validator.reset(mf);
}
bool mutation_fragment_stream_validating_filter::on_end_of_partition() {
return (*this)(mutation_fragment::kind::partition_end, position_in_partition_view(position_in_partition_view::end_of_partition_tag_t()));
}
bool mutation_fragment_stream_validating_filter::on_end_of_stream() {
if (_validation_level < mutation_fragment_stream_validation_level::partition_region) {
return true;
}
validator_log.debug("[validator {}] EOS", static_cast<const void*>(this));
if (auto res = _validator.on_end_of_stream(); !res) {
return on_validation_error(validator_log, *this, res);
}
return true;
}