/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you 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. */ /* * Copyright (C) 2015 ScyllaDB * * Modified by ScyllaDB */ /* * This file is part of Scylla. * * Scylla is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * Scylla is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Scylla. If not, see . */ #include "maps.hh" #include "cql3/abstract_marker.hh" #include "cql3/term.hh" #include "operation.hh" #include "update_parameters.hh" #include "exceptions/exceptions.hh" #include "cql3/cql3_type.hh" #include "constants.hh" namespace cql3 { shared_ptr maps::key_spec_of(column_specification& column) { return ::make_shared(column.ks_name, column.cf_name, ::make_shared(sprint("key(%s)", *column.name), true), dynamic_pointer_cast(column.type)->get_keys_type()); } shared_ptr maps::value_spec_of(column_specification& column) { return ::make_shared(column.ks_name, column.cf_name, ::make_shared(sprint("value(%s)", *column.name), true), dynamic_pointer_cast(column.type)->get_values_type()); } ::shared_ptr maps::literal::prepare(database& db, const sstring& keyspace, ::shared_ptr receiver) { validate_assignable_to(db, keyspace, *receiver); auto key_spec = maps::key_spec_of(*receiver); auto value_spec = maps::value_spec_of(*receiver); std::unordered_map, shared_ptr> values; values.reserve(entries.size()); bool all_terminal = true; for (auto&& entry : entries) { auto k = entry.first->prepare(db, keyspace, key_spec); auto v = entry.second->prepare(db, keyspace, value_spec); if (k->contains_bind_marker() || v->contains_bind_marker()) { throw exceptions::invalid_request_exception(sprint("Invalid map literal for %s: bind variables are not supported inside collection literals", *receiver->name)); } if (dynamic_pointer_cast(k) || dynamic_pointer_cast(v)) { all_terminal = false; } values.emplace(k, v); } delayed_value value(static_pointer_cast(receiver->type)->get_keys_type()->as_less_comparator(), values); if (all_terminal) { return value.bind(query_options::DEFAULT); } else { return make_shared(std::move(value)); } } void maps::literal::validate_assignable_to(database& db, const sstring& keyspace, column_specification& receiver) { if (!dynamic_pointer_cast(receiver.type)) { throw exceptions::invalid_request_exception(sprint("Invalid map literal for %s of type %s", *receiver.name, *receiver.type->as_cql3_type())); } auto&& key_spec = maps::key_spec_of(receiver); auto&& value_spec = maps::value_spec_of(receiver); for (auto&& entry : entries) { if (!is_assignable(entry.first->test_assignment(db, keyspace, key_spec))) { throw exceptions::invalid_request_exception(sprint("Invalid map literal for %s: key %s is not of type %s", *receiver.name, *entry.first, *key_spec->type->as_cql3_type())); } if (!is_assignable(entry.second->test_assignment(db, keyspace, value_spec))) { throw exceptions::invalid_request_exception(sprint("Invalid map literal for %s: value %s is not of type %s", *receiver.name, *entry.second, *value_spec->type->as_cql3_type())); } } } assignment_testable::test_result maps::literal::test_assignment(database& db, const sstring& keyspace, ::shared_ptr receiver) { if (!dynamic_pointer_cast(receiver->type)) { return assignment_testable::test_result::NOT_ASSIGNABLE; } // If there is no elements, we can't say it's an exact match (an empty map if fundamentally polymorphic). if (entries.empty()) { return assignment_testable::test_result::WEAKLY_ASSIGNABLE; } auto key_spec = maps::key_spec_of(*receiver); auto value_spec = maps::value_spec_of(*receiver); // It's an exact match if all are exact match, but is not assignable as soon as any is non assignable. auto res = assignment_testable::test_result::EXACT_MATCH; for (auto entry : entries) { auto t1 = entry.first->test_assignment(db, keyspace, key_spec); auto t2 = entry.second->test_assignment(db, keyspace, value_spec); if (t1 == assignment_testable::test_result::NOT_ASSIGNABLE || t2 == assignment_testable::test_result::NOT_ASSIGNABLE) return assignment_testable::test_result::NOT_ASSIGNABLE; if (t1 != assignment_testable::test_result::EXACT_MATCH || t2 != assignment_testable::test_result::EXACT_MATCH) res = assignment_testable::test_result::WEAKLY_ASSIGNABLE; } return res; } sstring maps::literal::to_string() const { sstring result = "{"; for (size_t i = 0; i < entries.size(); i++) { if (i > 0) { result += ", "; } result += entries[i].first->to_string(); result += ":"; result += entries[i].second->to_string(); } result += "}"; return result; } maps::value maps::value::from_serialized(bytes_view value, map_type type, cql_serialization_format sf) { try { // Collections have this small hack that validate cannot be called on a serialized object, // but compose does the validation (so we're fine). // FIXME: deserialize_for_native_protocol?! auto m = value_cast(type->deserialize(value, sf)); std::map map(type->get_keys_type()->as_less_comparator()); for (auto&& e : m) { map.emplace(type->get_keys_type()->decompose(e.first), type->get_values_type()->decompose(e.second)); } return { std::move(map) }; } catch (marshal_exception& e) { throw exceptions::invalid_request_exception(e.what()); } } bytes_opt maps::value::get(const query_options& options) { return get_with_protocol_version(options.get_cql_serialization_format()); } bytes maps::value::get_with_protocol_version(cql_serialization_format sf) { //FIXME: share code with serialize_partially_deserialized_form size_t len = collection_value_len(sf) * map.size() * 2 + collection_size_len(sf); for (auto&& e : map) { len += e.first.size() + e.second.size(); } bytes b(bytes::initialized_later(), len); bytes::iterator out = b.begin(); write_collection_size(out, map.size(), sf); for (auto&& e : map) { write_collection_value(out, sf, e.first); write_collection_value(out, sf, e.second); } return b; } bool maps::value::equals(map_type mt, const value& v) { return std::equal(map.begin(), map.end(), v.map.begin(), v.map.end(), [mt] (auto&& e1, auto&& e2) { return mt->get_keys_type()->compare(e1.first, e2.first) == 0 && mt->get_values_type()->compare(e1.second, e2.second) == 0; }); } sstring maps::value::to_string() const { // FIXME: abort(); } bool maps::delayed_value::contains_bind_marker() const { // False since we don't support them in collection return false; } void maps::delayed_value::collect_marker_specification(shared_ptr bound_names) { } shared_ptr maps::delayed_value::bind(const query_options& options) { std::map buffers(_comparator); for (auto&& entry : _elements) { auto&& key = entry.first; auto&& value = entry.second; // We don't support values > 64K because the serialization format encode the length as an unsigned short. auto key_bytes = key->bind_and_get(options); if (!key_bytes) { throw exceptions::invalid_request_exception("null is not supported inside collections"); } if (key_bytes->size() > std::numeric_limits::max()) { throw exceptions::invalid_request_exception(sprint("Map key is too long. Map keys are limited to %d bytes but %d bytes keys provided", std::numeric_limits::max(), key_bytes->size())); } auto value_bytes = value->bind_and_get(options); if (!value_bytes) { throw exceptions::invalid_request_exception("null is not supported inside collections");\ } if (value_bytes->size() > std::numeric_limits::max()) { throw exceptions::invalid_request_exception(sprint("Map value is too long. Map values are limited to %d bytes but %d bytes value provided", std::numeric_limits::max(), value_bytes->size())); } buffers.emplace(std::move(to_bytes(*key_bytes)), std::move(to_bytes(*value_bytes))); } return ::make_shared(std::move(buffers)); } ::shared_ptr maps::marker::bind(const query_options& options) { auto val = options.get_value_at(_bind_index); return val ? ::make_shared( maps::value::from_serialized(*val, static_pointer_cast( _receiver->type), options.get_cql_serialization_format())) : nullptr; } void maps::setter::execute(mutation& m, const exploded_clustering_prefix& row_key, const update_parameters& params) { if (column.type->is_multi_cell()) { // delete + put collection_type_impl::mutation mut; mut.tomb = params.make_tombstone_just_before(); auto ctype = static_pointer_cast(column.type); auto col_mut = ctype->serialize_mutation_form(std::move(mut)); m.set_cell(row_key, column, std::move(col_mut)); } do_put(m, row_key, params, _t, column); } void maps::setter_by_key::collect_marker_specification(shared_ptr bound_names) { operation::collect_marker_specification(bound_names); _k->collect_marker_specification(bound_names); } void maps::setter_by_key::execute(mutation& m, const exploded_clustering_prefix& prefix, const update_parameters& params) { using exceptions::invalid_request_exception; assert(column.type->is_multi_cell()); // "Attempted to set a value for a single key on a frozen map"m auto key = _k->bind_and_get(params._options); auto value = _t->bind_and_get(params._options); if (!key) { throw invalid_request_exception("Invalid null map key"); } if (value && value->size() >= std::numeric_limits::max()) { throw invalid_request_exception( sprint("Map value is too long. Map values are limited to %d bytes but %d bytes value provided", std::numeric_limits::max(), value->size())); } auto avalue = value ? params.make_cell(*value) : params.make_dead_cell(); map_type_impl::mutation update = { {}, { { std::move(to_bytes(*key)), std::move(avalue) } } }; // should have been verified as map earlier? auto ctype = static_pointer_cast(column.type); auto col_mut = ctype->serialize_mutation_form(std::move(update)); m.set_cell(prefix, column, std::move(col_mut)); } void maps::putter::execute(mutation& m, const exploded_clustering_prefix& prefix, const update_parameters& params) { assert(column.type->is_multi_cell()); // "Attempted to add items to a frozen map"; do_put(m, prefix, params, _t, column); } void maps::do_put(mutation& m, const exploded_clustering_prefix& prefix, const update_parameters& params, shared_ptr t, const column_definition& column) { auto value = t->bind(params._options); auto map_value = dynamic_pointer_cast(value); if (column.type->is_multi_cell()) { collection_type_impl::mutation mut; if (!value) { return; } for (auto&& e : map_value->map) { mut.cells.emplace_back(e.first, params.make_cell(e.second)); } auto ctype = static_pointer_cast(column.type); auto col_mut = ctype->serialize_mutation_form(std::move(mut)); m.set_cell(prefix, column, std::move(col_mut)); } else { // for frozen maps, we're overwriting the whole cell if (!value) { m.set_cell(prefix, column, params.make_dead_cell()); } else { auto v = map_type_impl::serialize_partially_deserialized_form({map_value->map.begin(), map_value->map.end()}, cql_serialization_format::internal()); m.set_cell(prefix, column, params.make_cell(std::move(v))); } } } void maps::discarder_by_key::execute(mutation& m, const exploded_clustering_prefix& prefix, const update_parameters& params) { assert(column.type->is_multi_cell()); // "Attempted to delete a single key in a frozen map"; auto&& key = _t->bind(params._options); if (!key) { throw exceptions::invalid_request_exception("Invalid null map key"); } collection_type_impl::mutation mut; mut.cells.emplace_back(*key->get(params._options), params.make_dead_cell()); auto mtype = static_cast(column.type.get()); m.set_cell(prefix, column, mtype->serialize_mutation_form(mut)); } }