blob: f2dc8bad112fe5df6d686e69110b60ad6e5fd913 [file] [log] [blame]
//
// Copyright 2018 gRPC 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 <grpc/support/port_platform.h>
#include "src/core/ext/xds/xds_route_config.h"
#include <stddef.h>
#include <stdint.h>
#include <initializer_list>
#include <limits>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/str_cat.h"
#include "absl/strings/str_format.h"
#include "absl/strings/str_join.h"
#include "absl/strings/str_split.h"
#include "absl/strings/string_view.h"
#include "absl/types/optional.h"
#include "absl/types/variant.h"
#include "envoy/config/core/v3/base.upb.h"
#include "envoy/config/core/v3/extension.upb.h"
#include "envoy/config/route/v3/route.upb.h"
#include "envoy/config/route/v3/route.upbdefs.h"
#include "envoy/config/route/v3/route_components.upb.h"
#include "envoy/type/matcher/v3/regex.upb.h"
#include "envoy/type/matcher/v3/string.upb.h"
#include "envoy/type/v3/percent.upb.h"
#include "envoy/type/v3/range.upb.h"
#include "google/protobuf/any.upb.h"
#include "google/protobuf/duration.upb.h"
#include "google/protobuf/wrappers.upb.h"
#include "re2/re2.h"
#include "upb/base/string_view.h"
#include "upb/collections/map.h"
#include "upb/text/encode.h"
#include <grpc/status.h>
#include <grpc/support/log.h>
#include "src/core/ext/xds/upb_utils.h"
#include "src/core/ext/xds/xds_cluster_specifier_plugin.h"
#include "src/core/ext/xds/xds_common_types.h"
#include "src/core/ext/xds/xds_http_filters.h"
#include "src/core/ext/xds/xds_resource_type.h"
#include "src/core/ext/xds/xds_routing.h"
#include "src/core/lib/channel/status_util.h"
#include "src/core/lib/config/core_configuration.h"
#include "src/core/lib/debug/trace.h"
#include "src/core/lib/gpr/string.h"
#include "src/core/lib/gprpp/env.h"
#include "src/core/lib/gprpp/match.h"
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/time.h"
#include "src/core/lib/json/json.h"
#include "src/core/lib/json/json_writer.h"
#include "src/core/lib/load_balancing/lb_policy_registry.h"
#include "src/core/lib/matchers/matchers.h"
namespace grpc_core {
// TODO(apolcyn): remove this flag by the 1.58 release
bool XdsRlsEnabled() {
auto value = GetEnv("GRPC_EXPERIMENTAL_XDS_RLS_LB");
if (!value.has_value()) return true;
bool parsed_value;
bool parse_succeeded = gpr_parse_bool_value(value->c_str(), &parsed_value);
return parse_succeeded && parsed_value;
}
//
// XdsRouteConfigResource::RetryPolicy
//
std::string XdsRouteConfigResource::RetryPolicy::RetryBackOff::ToString()
const {
std::vector<std::string> contents;
contents.push_back(
absl::StrCat("RetryBackOff Base: ", base_interval.ToString()));
contents.push_back(
absl::StrCat("RetryBackOff max: ", max_interval.ToString()));
return absl::StrJoin(contents, ",");
}
std::string XdsRouteConfigResource::RetryPolicy::ToString() const {
std::vector<std::string> contents;
contents.push_back(absl::StrFormat("num_retries=%d", num_retries));
contents.push_back(retry_back_off.ToString());
return absl::StrCat("{", absl::StrJoin(contents, ","), "}");
}
//
// XdsRouteConfigResource::Route::Matchers
//
std::string XdsRouteConfigResource::Route::Matchers::ToString() const {
std::vector<std::string> contents;
contents.push_back(
absl::StrFormat("PathMatcher{%s}", path_matcher.ToString()));
for (const HeaderMatcher& header_matcher : header_matchers) {
contents.push_back(header_matcher.ToString());
}
if (fraction_per_million.has_value()) {
contents.push_back(absl::StrFormat("Fraction Per Million %d",
fraction_per_million.value()));
}
return absl::StrJoin(contents, "\n");
}
//
// XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header
//
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header::Header(
const Header& other)
: header_name(other.header_name),
regex_substitution(other.regex_substitution) {
if (other.regex != nullptr) {
regex =
std::make_unique<RE2>(other.regex->pattern(), other.regex->options());
}
}
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header&
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header::operator=(
const Header& other) {
header_name = other.header_name;
if (other.regex != nullptr) {
regex =
std::make_unique<RE2>(other.regex->pattern(), other.regex->options());
}
regex_substitution = other.regex_substitution;
return *this;
}
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header::Header(
Header&& other) noexcept
: header_name(std::move(other.header_name)),
regex(std::move(other.regex)),
regex_substitution(std::move(other.regex_substitution)) {}
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header&
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header::operator=(
Header&& other) noexcept {
header_name = std::move(other.header_name);
regex = std::move(other.regex);
regex_substitution = std::move(other.regex_substitution);
return *this;
}
bool XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header::operator==(
const Header& other) const {
if (header_name != other.header_name) return false;
if (regex == nullptr) {
if (other.regex != nullptr) return false;
} else {
if (other.regex == nullptr) return false;
if (regex->pattern() != other.regex->pattern()) return false;
}
return regex_substitution == other.regex_substitution;
}
std::string
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header::ToString()
const {
return absl::StrCat("Header ", header_name, "/",
(regex == nullptr) ? "" : regex->pattern(), "/",
regex_substitution);
}
//
// XdsRouteConfigResource::Route::RouteAction::HashPolicy
//
std::string XdsRouteConfigResource::Route::RouteAction::HashPolicy::ToString()
const {
std::string type = Match(
policy, [](const Header& header) { return header.ToString(); },
[](const ChannelId&) -> std::string { return "ChannelId"; });
return absl::StrCat("{", type, ", terminal=", terminal ? "true" : "false",
"}");
}
//
// XdsRouteConfigResource::Route::RouteAction::ClusterWeight
//
std::string
XdsRouteConfigResource::Route::RouteAction::ClusterWeight::ToString() const {
std::vector<std::string> contents;
contents.push_back(absl::StrCat("cluster=", name));
contents.push_back(absl::StrCat("weight=", weight));
if (!typed_per_filter_config.empty()) {
std::vector<std::string> parts;
for (const auto& p : typed_per_filter_config) {
const std::string& key = p.first;
const auto& config = p.second;
parts.push_back(absl::StrCat(key, "=", config.ToString()));
}
contents.push_back(absl::StrCat("typed_per_filter_config={",
absl::StrJoin(parts, ", "), "}"));
}
return absl::StrCat("{", absl::StrJoin(contents, ", "), "}");
}
//
// XdsRouteConfigResource::Route::RouteAction
//
std::string XdsRouteConfigResource::Route::RouteAction::ToString() const {
std::vector<std::string> contents;
contents.reserve(hash_policies.size());
for (const HashPolicy& hash_policy : hash_policies) {
contents.push_back(absl::StrCat("hash_policy=", hash_policy.ToString()));
}
if (retry_policy.has_value()) {
contents.push_back(absl::StrCat("retry_policy=", retry_policy->ToString()));
}
Match(
action,
[&contents](const ClusterName& cluster_name) {
contents.push_back(
absl::StrFormat("Cluster name: %s", cluster_name.cluster_name));
},
[&contents](const std::vector<ClusterWeight>& weighted_clusters) {
for (const ClusterWeight& cluster_weight : weighted_clusters) {
contents.push_back(cluster_weight.ToString());
}
},
[&contents](
const ClusterSpecifierPluginName& cluster_specifier_plugin_name) {
contents.push_back(absl::StrFormat(
"Cluster specifier plugin name: %s",
cluster_specifier_plugin_name.cluster_specifier_plugin_name));
});
if (max_stream_duration.has_value()) {
contents.push_back(max_stream_duration->ToString());
}
return absl::StrCat("{", absl::StrJoin(contents, ", "), "}");
}
//
// XdsRouteConfigResource::Route
//
std::string XdsRouteConfigResource::Route::ToString() const {
std::vector<std::string> contents;
contents.push_back(matchers.ToString());
auto* route_action =
absl::get_if<XdsRouteConfigResource::Route::RouteAction>(&action);
if (route_action != nullptr) {
contents.push_back(absl::StrCat("route=", route_action->ToString()));
} else if (absl::holds_alternative<
XdsRouteConfigResource::Route::NonForwardingAction>(action)) {
contents.push_back("non_forwarding_action={}");
} else {
contents.push_back("unknown_action={}");
}
if (!typed_per_filter_config.empty()) {
contents.push_back("typed_per_filter_config={");
for (const auto& p : typed_per_filter_config) {
const std::string& name = p.first;
const auto& config = p.second;
contents.push_back(absl::StrCat(" ", name, "=", config.ToString()));
}
contents.push_back("}");
}
return absl::StrJoin(contents, "\n");
}
//
// XdsRouteConfigResource
//
std::string XdsRouteConfigResource::ToString() const {
std::vector<std::string> parts;
for (const VirtualHost& vhost : virtual_hosts) {
parts.push_back(
absl::StrCat("vhost={\n"
" domains=[",
absl::StrJoin(vhost.domains, ", "),
"]\n"
" routes=[\n"));
for (const XdsRouteConfigResource::Route& route : vhost.routes) {
parts.push_back(" {\n");
parts.push_back(route.ToString());
parts.push_back("\n }\n");
}
parts.push_back(" ]\n");
parts.push_back(" typed_per_filter_config={\n");
for (const auto& p : vhost.typed_per_filter_config) {
const std::string& name = p.first;
const auto& config = p.second;
parts.push_back(absl::StrCat(" ", name, "=", config.ToString(), "\n"));
}
parts.push_back(" }\n");
parts.push_back("]\n");
}
parts.push_back("cluster_specifier_plugins={\n");
for (const auto& it : cluster_specifier_plugin_map) {
parts.push_back(absl::StrFormat("%s={%s}\n", it.first, it.second));
}
parts.push_back("}");
return absl::StrJoin(parts, "");
}
namespace {
XdsRouteConfigResource::ClusterSpecifierPluginMap ClusterSpecifierPluginParse(
const XdsResourceType::DecodeContext& context,
const envoy_config_route_v3_RouteConfiguration* route_config,
ValidationErrors* errors) {
XdsRouteConfigResource::ClusterSpecifierPluginMap
cluster_specifier_plugin_map;
const auto& cluster_specifier_plugin_registry =
static_cast<const GrpcXdsBootstrap&>(context.client->bootstrap())
.cluster_specifier_plugin_registry();
size_t num_cluster_specifier_plugins;
const envoy_config_route_v3_ClusterSpecifierPlugin* const*
cluster_specifier_plugin =
envoy_config_route_v3_RouteConfiguration_cluster_specifier_plugins(
route_config, &num_cluster_specifier_plugins);
for (size_t i = 0; i < num_cluster_specifier_plugins; ++i) {
bool is_optional = envoy_config_route_v3_ClusterSpecifierPlugin_is_optional(
cluster_specifier_plugin[i]);
ValidationErrors::ScopedField field(
errors, absl::StrCat(".cluster_specifier_plugins[", i, "].extension"));
const envoy_config_core_v3_TypedExtensionConfig* typed_extension_config =
envoy_config_route_v3_ClusterSpecifierPlugin_extension(
cluster_specifier_plugin[i]);
std::string name = UpbStringToStdString(
envoy_config_core_v3_TypedExtensionConfig_name(typed_extension_config));
if (cluster_specifier_plugin_map.find(name) !=
cluster_specifier_plugin_map.end()) {
ValidationErrors::ScopedField field(errors, ".name");
errors->AddError(absl::StrCat("duplicate name \"", name, "\""));
} else {
// Add a sentinel entry in case we encounter an error later, just so we
// don't generate duplicate errors for each route that uses this plugin.
cluster_specifier_plugin_map[name] = "<sentinel>";
}
ValidationErrors::ScopedField field2(errors, ".typed_config");
const google_protobuf_Any* any =
envoy_config_core_v3_TypedExtensionConfig_typed_config(
typed_extension_config);
auto extension = ExtractXdsExtension(context, any, errors);
if (!extension.has_value()) continue;
const XdsClusterSpecifierPluginImpl* cluster_specifier_plugin_impl =
cluster_specifier_plugin_registry.GetPluginForType(extension->type);
if (cluster_specifier_plugin_impl == nullptr) {
if (is_optional) {
// Empty string indicates an optional plugin.
// This is used later when validating routes, and since we will skip
// any routes that refer to this plugin, we won't wind up including
// this plugin in the resource that we return to the watcher.
cluster_specifier_plugin_map[std::move(name)] = "";
} else {
// Not optional, report error.
errors->AddError("unsupported ClusterSpecifierPlugin type");
}
continue;
}
const size_t original_error_size = errors->size();
Json lb_policy_config =
cluster_specifier_plugin_impl->GenerateLoadBalancingPolicyConfig(
std::move(*extension), context.arena, context.symtab, errors);
if (errors->size() != original_error_size) continue;
auto config =
CoreConfiguration::Get().lb_policy_registry().ParseLoadBalancingConfig(
lb_policy_config);
if (!config.ok()) {
errors->AddError(absl::StrCat(
"ClusterSpecifierPlugin returned invalid LB policy config: ",
config.status().message()));
} else {
cluster_specifier_plugin_map[std::move(name)] =
JsonDump(lb_policy_config);
}
}
return cluster_specifier_plugin_map;
}
absl::optional<StringMatcher> RoutePathMatchParse(
const envoy_config_route_v3_RouteMatch* match, ValidationErrors* errors) {
bool case_sensitive = true;
auto* case_sensitive_ptr =
envoy_config_route_v3_RouteMatch_case_sensitive(match);
if (case_sensitive_ptr != nullptr) {
case_sensitive = google_protobuf_BoolValue_value(case_sensitive_ptr);
}
StringMatcher::Type type;
std::string match_string;
if (envoy_config_route_v3_RouteMatch_has_prefix(match)) {
absl::string_view prefix =
UpbStringToAbsl(envoy_config_route_v3_RouteMatch_prefix(match));
// For any prefix that cannot match a path of the form "/service/method",
// ignore the route.
if (!prefix.empty()) {
// Does not start with a slash.
if (prefix[0] != '/') return absl::nullopt;
std::vector<absl::string_view> prefix_elements =
absl::StrSplit(prefix.substr(1), absl::MaxSplits('/', 2));
// More than 2 slashes.
if (prefix_elements.size() > 2) return absl::nullopt;
// Two consecutive slashes.
if (prefix_elements.size() == 2 && prefix_elements[0].empty()) {
return absl::nullopt;
}
}
type = StringMatcher::Type::kPrefix;
match_string = std::string(prefix);
} else if (envoy_config_route_v3_RouteMatch_has_path(match)) {
absl::string_view path =
UpbStringToAbsl(envoy_config_route_v3_RouteMatch_path(match));
// For any path not of the form "/service/method", ignore the route.
// Empty path.
if (path.empty()) return absl::nullopt;
// Does not start with a slash.
if (path[0] != '/') return absl::nullopt;
std::vector<absl::string_view> path_elements =
absl::StrSplit(path.substr(1), absl::MaxSplits('/', 2));
// Number of slashes does not equal 2.
if (path_elements.size() != 2) return absl::nullopt;
// Empty service name.
if (path_elements[0].empty()) return absl::nullopt;
// Empty method name.
if (path_elements[1].empty()) return absl::nullopt;
type = StringMatcher::Type::kExact;
match_string = std::string(path);
} else if (envoy_config_route_v3_RouteMatch_has_safe_regex(match)) {
const envoy_type_matcher_v3_RegexMatcher* regex_matcher =
envoy_config_route_v3_RouteMatch_safe_regex(match);
GPR_ASSERT(regex_matcher != nullptr);
type = StringMatcher::Type::kSafeRegex;
match_string = UpbStringToStdString(
envoy_type_matcher_v3_RegexMatcher_regex(regex_matcher));
} else {
errors->AddError("invalid path specifier");
return absl::nullopt;
}
absl::StatusOr<StringMatcher> string_matcher =
StringMatcher::Create(type, match_string, case_sensitive);
if (!string_matcher.ok()) {
errors->AddError(absl::StrCat("error creating path matcher: ",
string_matcher.status().message()));
return absl::nullopt;
}
return std::move(*string_matcher);
}
void RouteHeaderMatchersParse(const envoy_config_route_v3_RouteMatch* match,
XdsRouteConfigResource::Route* route,
ValidationErrors* errors) {
size_t size;
const envoy_config_route_v3_HeaderMatcher* const* headers =
envoy_config_route_v3_RouteMatch_headers(match, &size);
for (size_t i = 0; i < size; ++i) {
ValidationErrors::ScopedField field(errors,
absl::StrCat(".headers[", i, "]"));
const envoy_config_route_v3_HeaderMatcher* header = headers[i];
GPR_ASSERT(header != nullptr);
const std::string name =
UpbStringToStdString(envoy_config_route_v3_HeaderMatcher_name(header));
HeaderMatcher::Type type;
std::string match_string;
int64_t range_start = 0;
int64_t range_end = 0;
bool present_match = false;
bool case_sensitive = true;
if (envoy_config_route_v3_HeaderMatcher_has_exact_match(header)) {
type = HeaderMatcher::Type::kExact;
match_string = UpbStringToStdString(
envoy_config_route_v3_HeaderMatcher_exact_match(header));
} else if (envoy_config_route_v3_HeaderMatcher_has_prefix_match(header)) {
type = HeaderMatcher::Type::kPrefix;
match_string = UpbStringToStdString(
envoy_config_route_v3_HeaderMatcher_prefix_match(header));
} else if (envoy_config_route_v3_HeaderMatcher_has_suffix_match(header)) {
type = HeaderMatcher::Type::kSuffix;
match_string = UpbStringToStdString(
envoy_config_route_v3_HeaderMatcher_suffix_match(header));
} else if (envoy_config_route_v3_HeaderMatcher_has_contains_match(header)) {
type = HeaderMatcher::Type::kContains;
match_string = UpbStringToStdString(
envoy_config_route_v3_HeaderMatcher_contains_match(header));
} else if (envoy_config_route_v3_HeaderMatcher_has_safe_regex_match(
header)) {
const envoy_type_matcher_v3_RegexMatcher* regex_matcher =
envoy_config_route_v3_HeaderMatcher_safe_regex_match(header);
GPR_ASSERT(regex_matcher != nullptr);
type = HeaderMatcher::Type::kSafeRegex;
match_string = UpbStringToStdString(
envoy_type_matcher_v3_RegexMatcher_regex(regex_matcher));
} else if (envoy_config_route_v3_HeaderMatcher_has_range_match(header)) {
type = HeaderMatcher::Type::kRange;
const envoy_type_v3_Int64Range* range_matcher =
envoy_config_route_v3_HeaderMatcher_range_match(header);
GPR_ASSERT(range_matcher != nullptr);
range_start = envoy_type_v3_Int64Range_start(range_matcher);
range_end = envoy_type_v3_Int64Range_end(range_matcher);
} else if (envoy_config_route_v3_HeaderMatcher_has_present_match(header)) {
type = HeaderMatcher::Type::kPresent;
present_match = envoy_config_route_v3_HeaderMatcher_present_match(header);
} else if (envoy_config_route_v3_HeaderMatcher_has_string_match(header)) {
ValidationErrors::ScopedField field(errors, ".string_match");
const auto* matcher =
envoy_config_route_v3_HeaderMatcher_string_match(header);
GPR_ASSERT(matcher != nullptr);
if (envoy_type_matcher_v3_StringMatcher_has_exact(matcher)) {
type = HeaderMatcher::Type::kExact;
match_string = UpbStringToStdString(
envoy_type_matcher_v3_StringMatcher_exact(matcher));
} else if (envoy_type_matcher_v3_StringMatcher_has_prefix(matcher)) {
type = HeaderMatcher::Type::kPrefix;
match_string = UpbStringToStdString(
envoy_type_matcher_v3_StringMatcher_prefix(matcher));
} else if (envoy_type_matcher_v3_StringMatcher_has_suffix(matcher)) {
type = HeaderMatcher::Type::kSuffix;
match_string = UpbStringToStdString(
envoy_type_matcher_v3_StringMatcher_suffix(matcher));
} else if (envoy_type_matcher_v3_StringMatcher_has_contains(matcher)) {
type = HeaderMatcher::Type::kContains;
match_string = UpbStringToStdString(
envoy_type_matcher_v3_StringMatcher_contains(matcher));
} else if (envoy_type_matcher_v3_StringMatcher_has_safe_regex(matcher)) {
type = HeaderMatcher::Type::kSafeRegex;
const auto* regex_matcher =
envoy_type_matcher_v3_StringMatcher_safe_regex(matcher);
GPR_ASSERT(regex_matcher != nullptr);
match_string = UpbStringToStdString(
envoy_type_matcher_v3_RegexMatcher_regex(regex_matcher));
} else {
errors->AddError("invalid string matcher");
continue;
}
case_sensitive =
!envoy_type_matcher_v3_StringMatcher_ignore_case(matcher);
} else {
errors->AddError("invalid header matcher");
continue;
}
bool invert_match =
envoy_config_route_v3_HeaderMatcher_invert_match(header);
absl::StatusOr<HeaderMatcher> header_matcher =
HeaderMatcher::Create(name, type, match_string, range_start, range_end,
present_match, invert_match, case_sensitive);
if (!header_matcher.ok()) {
errors->AddError(absl::StrCat("cannot create header matcher: ",
header_matcher.status().message()));
} else {
route->matchers.header_matchers.emplace_back(std::move(*header_matcher));
}
}
}
void RouteRuntimeFractionParse(const envoy_config_route_v3_RouteMatch* match,
XdsRouteConfigResource::Route* route,
ValidationErrors* errors) {
const envoy_config_core_v3_RuntimeFractionalPercent* runtime_fraction =
envoy_config_route_v3_RouteMatch_runtime_fraction(match);
if (runtime_fraction != nullptr) {
const envoy_type_v3_FractionalPercent* fraction =
envoy_config_core_v3_RuntimeFractionalPercent_default_value(
runtime_fraction);
if (fraction != nullptr) {
uint32_t numerator = envoy_type_v3_FractionalPercent_numerator(fraction);
const uint32_t denominator =
envoy_type_v3_FractionalPercent_denominator(fraction);
// Normalize to million.
switch (denominator) {
case envoy_type_v3_FractionalPercent_HUNDRED:
numerator *= 10000;
break;
case envoy_type_v3_FractionalPercent_TEN_THOUSAND:
numerator *= 100;
break;
case envoy_type_v3_FractionalPercent_MILLION:
break;
default: {
ValidationErrors::ScopedField field(
errors, ".runtime_fraction.default_value.denominator");
errors->AddError("unknown denominator type");
return;
}
}
route->matchers.fraction_per_million = numerator;
}
}
}
template <typename ParentType, typename EntryType>
XdsRouteConfigResource::TypedPerFilterConfig ParseTypedPerFilterConfig(
const XdsResourceType::DecodeContext& context, const ParentType* parent,
const EntryType* (*entry_func)(const ParentType*, size_t*),
upb_StringView (*key_func)(const EntryType*),
const google_protobuf_Any* (*value_func)(const EntryType*),
ValidationErrors* errors) {
XdsRouteConfigResource::TypedPerFilterConfig typed_per_filter_config;
size_t filter_it = kUpb_Map_Begin;
while (true) {
const auto* filter_entry = entry_func(parent, &filter_it);
if (filter_entry == nullptr) break;
absl::string_view key = UpbStringToAbsl(key_func(filter_entry));
ValidationErrors::ScopedField field(errors, absl::StrCat("[", key, "]"));
if (key.empty()) errors->AddError("filter name must be non-empty");
const google_protobuf_Any* any = value_func(filter_entry);
auto extension = ExtractXdsExtension(context, any, errors);
if (!extension.has_value()) continue;
auto* extension_to_use = &*extension;
absl::optional<XdsExtension> nested_extension;
bool is_optional = false;
if (extension->type == "envoy.config.route.v3.FilterConfig") {
absl::string_view* serialized_config =
absl::get_if<absl::string_view>(&extension->value);
if (serialized_config == nullptr) {
errors->AddError("could not parse FilterConfig");
continue;
}
const auto* filter_config = envoy_config_route_v3_FilterConfig_parse(
serialized_config->data(), serialized_config->size(), context.arena);
if (filter_config == nullptr) {
errors->AddError("could not parse FilterConfig");
continue;
}
is_optional =
envoy_config_route_v3_FilterConfig_is_optional(filter_config);
any = envoy_config_route_v3_FilterConfig_config(filter_config);
extension->validation_fields.emplace_back(errors, ".config");
nested_extension = ExtractXdsExtension(context, any, errors);
if (!nested_extension.has_value()) continue;
extension_to_use = &*nested_extension;
}
const auto& http_filter_registry =
static_cast<const GrpcXdsBootstrap&>(context.client->bootstrap())
.http_filter_registry();
const XdsHttpFilterImpl* filter_impl =
http_filter_registry.GetFilterForType(extension_to_use->type);
if (filter_impl == nullptr) {
if (!is_optional) errors->AddError("unsupported filter type");
continue;
}
absl::optional<XdsHttpFilterImpl::FilterConfig> filter_config =
filter_impl->GenerateFilterConfigOverride(
context, std::move(*extension_to_use), errors);
if (filter_config.has_value()) {
typed_per_filter_config[std::string(key)] = std::move(*filter_config);
}
}
return typed_per_filter_config;
}
XdsRouteConfigResource::RetryPolicy RetryPolicyParse(
const XdsResourceType::DecodeContext& context,
const envoy_config_route_v3_RetryPolicy* retry_policy_proto,
ValidationErrors* errors) {
XdsRouteConfigResource::RetryPolicy retry_policy;
auto retry_on = UpbStringToStdString(
envoy_config_route_v3_RetryPolicy_retry_on(retry_policy_proto));
std::vector<absl::string_view> codes = absl::StrSplit(retry_on, ',');
for (const auto& code : codes) {
if (code == "cancelled") {
retry_policy.retry_on.Add(GRPC_STATUS_CANCELLED);
} else if (code == "deadline-exceeded") {
retry_policy.retry_on.Add(GRPC_STATUS_DEADLINE_EXCEEDED);
} else if (code == "internal") {
retry_policy.retry_on.Add(GRPC_STATUS_INTERNAL);
} else if (code == "resource-exhausted") {
retry_policy.retry_on.Add(GRPC_STATUS_RESOURCE_EXHAUSTED);
} else if (code == "unavailable") {
retry_policy.retry_on.Add(GRPC_STATUS_UNAVAILABLE);
} else {
if (GRPC_TRACE_FLAG_ENABLED(*context.tracer)) {
gpr_log(GPR_INFO, "Unsupported retry_on policy %s.",
std::string(code).c_str());
}
}
}
const google_protobuf_UInt32Value* num_retries =
envoy_config_route_v3_RetryPolicy_num_retries(retry_policy_proto);
if (num_retries != nullptr) {
uint32_t num_retries_value = google_protobuf_UInt32Value_value(num_retries);
if (num_retries_value == 0) {
ValidationErrors::ScopedField field(errors, ".num_retries");
errors->AddError("must be greater than 0");
} else {
retry_policy.num_retries = num_retries_value;
}
} else {
retry_policy.num_retries = 1;
}
const envoy_config_route_v3_RetryPolicy_RetryBackOff* backoff =
envoy_config_route_v3_RetryPolicy_retry_back_off(retry_policy_proto);
if (backoff != nullptr) {
ValidationErrors::ScopedField field(errors, ".retry_back_off");
{
ValidationErrors::ScopedField field(errors, ".base_interval");
const google_protobuf_Duration* base_interval =
envoy_config_route_v3_RetryPolicy_RetryBackOff_base_interval(backoff);
if (base_interval == nullptr) {
errors->AddError("field not present");
} else {
retry_policy.retry_back_off.base_interval =
ParseDuration(base_interval, errors);
}
}
{
ValidationErrors::ScopedField field(errors, ".max_interval");
const google_protobuf_Duration* max_interval =
envoy_config_route_v3_RetryPolicy_RetryBackOff_max_interval(backoff);
Duration max;
if (max_interval != nullptr) {
max = ParseDuration(max_interval, errors);
} else {
// if max interval is not set, it is 10x the base.
max = 10 * retry_policy.retry_back_off.base_interval;
}
retry_policy.retry_back_off.max_interval = max;
}
} else {
retry_policy.retry_back_off.base_interval = Duration::Milliseconds(25);
retry_policy.retry_back_off.max_interval = Duration::Milliseconds(250);
}
return retry_policy;
}
absl::optional<XdsRouteConfigResource::Route::RouteAction> RouteActionParse(
const XdsResourceType::DecodeContext& context,
const envoy_config_route_v3_RouteAction* route_action_proto,
const std::map<std::string /*cluster_specifier_plugin_name*/,
std::string /*LB policy config*/>&
cluster_specifier_plugin_map,
ValidationErrors* errors) {
XdsRouteConfigResource::Route::RouteAction route_action;
// grpc_timeout_header_max or max_stream_duration
const auto* max_stream_duration =
envoy_config_route_v3_RouteAction_max_stream_duration(route_action_proto);
if (max_stream_duration != nullptr) {
ValidationErrors::ScopedField field(errors, ".max_stream_duration");
const google_protobuf_Duration* duration =
envoy_config_route_v3_RouteAction_MaxStreamDuration_grpc_timeout_header_max(
max_stream_duration);
if (duration != nullptr) {
ValidationErrors::ScopedField field(errors, ".grpc_timeout_header_max");
route_action.max_stream_duration = ParseDuration(duration, errors);
} else {
duration =
envoy_config_route_v3_RouteAction_MaxStreamDuration_max_stream_duration(
max_stream_duration);
if (duration != nullptr) {
ValidationErrors::ScopedField field(errors, ".max_stream_duration");
route_action.max_stream_duration = ParseDuration(duration, errors);
}
}
}
// hash_policy
size_t size = 0;
const envoy_config_route_v3_RouteAction_HashPolicy* const* hash_policies =
envoy_config_route_v3_RouteAction_hash_policy(route_action_proto, &size);
for (size_t i = 0; i < size; ++i) {
ValidationErrors::ScopedField field(errors,
absl::StrCat(".hash_policy[", i, "]"));
const auto* hash_policy = hash_policies[i];
XdsRouteConfigResource::Route::RouteAction::HashPolicy policy;
policy.terminal =
envoy_config_route_v3_RouteAction_HashPolicy_terminal(hash_policy);
const envoy_config_route_v3_RouteAction_HashPolicy_Header* header;
const envoy_config_route_v3_RouteAction_HashPolicy_FilterState*
filter_state;
if ((header = envoy_config_route_v3_RouteAction_HashPolicy_header(
hash_policy)) != nullptr) {
// header
ValidationErrors::ScopedField field(errors, ".header");
XdsRouteConfigResource::Route::RouteAction::HashPolicy::Header
header_policy;
header_policy.header_name = UpbStringToStdString(
envoy_config_route_v3_RouteAction_HashPolicy_Header_header_name(
header));
if (header_policy.header_name.empty()) {
ValidationErrors::ScopedField field(errors, ".header_name");
errors->AddError("must be non-empty");
}
// regex_rewrite
const auto* regex_rewrite =
envoy_config_route_v3_RouteAction_HashPolicy_Header_regex_rewrite(
header);
if (regex_rewrite != nullptr) {
ValidationErrors::ScopedField field(errors, ".regex_rewrite.pattern");
const auto* pattern =
envoy_type_matcher_v3_RegexMatchAndSubstitute_pattern(
regex_rewrite);
if (pattern == nullptr) {
errors->AddError("field not present");
continue;
}
ValidationErrors::ScopedField field2(errors, ".regex");
std::string regex = UpbStringToStdString(
envoy_type_matcher_v3_RegexMatcher_regex(pattern));
if (regex.empty()) {
errors->AddError("field not present");
continue;
}
RE2::Options options;
header_policy.regex = std::make_unique<RE2>(regex, options);
if (!header_policy.regex->ok()) {
errors->AddError(absl::StrCat("errors compiling regex: ",
header_policy.regex->error()));
continue;
}
header_policy.regex_substitution = UpbStringToStdString(
envoy_type_matcher_v3_RegexMatchAndSubstitute_substitution(
regex_rewrite));
}
policy.policy = std::move(header_policy);
} else if ((filter_state =
envoy_config_route_v3_RouteAction_HashPolicy_filter_state(
hash_policy)) != nullptr) {
// filter_state
std::string key = UpbStringToStdString(
envoy_config_route_v3_RouteAction_HashPolicy_FilterState_key(
filter_state));
if (key != "io.grpc.channel_id") continue;
policy.policy =
XdsRouteConfigResource::Route::RouteAction::HashPolicy::ChannelId();
} else {
// Unsupported hash policy type, ignore it.
continue;
}
route_action.hash_policies.emplace_back(std::move(policy));
}
// Get retry policy
const envoy_config_route_v3_RetryPolicy* retry_policy =
envoy_config_route_v3_RouteAction_retry_policy(route_action_proto);
if (retry_policy != nullptr) {
ValidationErrors::ScopedField field(errors, ".retry_policy");
route_action.retry_policy = RetryPolicyParse(context, retry_policy, errors);
}
// Parse cluster specifier, which is one of several options.
if (envoy_config_route_v3_RouteAction_has_cluster(route_action_proto)) {
// Cluster name.
std::string cluster_name = UpbStringToStdString(
envoy_config_route_v3_RouteAction_cluster(route_action_proto));
if (cluster_name.empty()) {
ValidationErrors::ScopedField field(errors, ".cluster");
errors->AddError("must be non-empty");
}
route_action.action =
XdsRouteConfigResource::Route::RouteAction::ClusterName{
std::move(cluster_name)};
} else if (envoy_config_route_v3_RouteAction_has_weighted_clusters(
route_action_proto)) {
// WeightedClusters.
ValidationErrors::ScopedField field(errors, ".weighted_clusters");
const envoy_config_route_v3_WeightedCluster* weighted_clusters_proto =
envoy_config_route_v3_RouteAction_weighted_clusters(route_action_proto);
GPR_ASSERT(weighted_clusters_proto != nullptr);
std::vector<XdsRouteConfigResource::Route::RouteAction::ClusterWeight>
action_weighted_clusters;
uint64_t total_weight = 0;
size_t clusters_size;
const envoy_config_route_v3_WeightedCluster_ClusterWeight* const* clusters =
envoy_config_route_v3_WeightedCluster_clusters(weighted_clusters_proto,
&clusters_size);
for (size_t i = 0; i < clusters_size; ++i) {
ValidationErrors::ScopedField field(errors,
absl::StrCat(".clusters[", i, "]"));
const auto* cluster_proto = clusters[i];
XdsRouteConfigResource::Route::RouteAction::ClusterWeight cluster;
// typed_per_filter_config
{
ValidationErrors::ScopedField field(errors, ".typed_per_filter_config");
cluster.typed_per_filter_config = ParseTypedPerFilterConfig<
envoy_config_route_v3_WeightedCluster_ClusterWeight,
envoy_config_route_v3_WeightedCluster_ClusterWeight_TypedPerFilterConfigEntry>(
context, cluster_proto,
envoy_config_route_v3_WeightedCluster_ClusterWeight_typed_per_filter_config_next,
envoy_config_route_v3_WeightedCluster_ClusterWeight_TypedPerFilterConfigEntry_key,
envoy_config_route_v3_WeightedCluster_ClusterWeight_TypedPerFilterConfigEntry_value,
errors);
}
// name
cluster.name = UpbStringToStdString(
envoy_config_route_v3_WeightedCluster_ClusterWeight_name(
cluster_proto));
if (cluster.name.empty()) {
ValidationErrors::ScopedField field(errors, ".name");
errors->AddError("must be non-empty");
}
// weight
const google_protobuf_UInt32Value* weight_proto =
envoy_config_route_v3_WeightedCluster_ClusterWeight_weight(
cluster_proto);
if (weight_proto == nullptr) {
ValidationErrors::ScopedField field(errors, ".weight");
errors->AddError("field not present");
} else {
cluster.weight = google_protobuf_UInt32Value_value(weight_proto);
if (cluster.weight == 0) continue;
total_weight += cluster.weight;
}
// Add entry to WeightedClusters.
action_weighted_clusters.emplace_back(std::move(cluster));
}
if (action_weighted_clusters.empty()) {
errors->AddError("no valid clusters specified");
} else if (total_weight > std::numeric_limits<uint32_t>::max()) {
errors->AddError("sum of cluster weights exceeds uint32 max");
}
route_action.action = std::move(action_weighted_clusters);
} else if (XdsRlsEnabled() &&
envoy_config_route_v3_RouteAction_has_cluster_specifier_plugin(
route_action_proto)) {
// ClusterSpecifierPlugin
ValidationErrors::ScopedField field(errors, ".cluster_specifier_plugin");
std::string plugin_name = UpbStringToStdString(
envoy_config_route_v3_RouteAction_cluster_specifier_plugin(
route_action_proto));
if (plugin_name.empty()) {
errors->AddError("must be non-empty");
return absl::nullopt;
}
auto it = cluster_specifier_plugin_map.find(plugin_name);
if (it == cluster_specifier_plugin_map.end()) {
errors->AddError(absl::StrCat("unknown cluster specifier plugin name \"",
plugin_name, "\""));
} else {
// If the cluster specifier config is empty, that means that the
// plugin was unsupported but optional. In that case, skip this route.
if (it->second.empty()) return absl::nullopt;
}
route_action.action =
XdsRouteConfigResource::Route::RouteAction::ClusterSpecifierPluginName{
std::move(plugin_name)};
} else {
// Not a supported cluster specifier, so ignore this route.
return absl::nullopt;
}
return route_action;
}
absl::optional<XdsRouteConfigResource::Route> ParseRoute(
const XdsResourceType::DecodeContext& context,
const envoy_config_route_v3_Route* route_proto,
const absl::optional<XdsRouteConfigResource::RetryPolicy>&
virtual_host_retry_policy,
const XdsRouteConfigResource::ClusterSpecifierPluginMap&
cluster_specifier_plugin_map,
std::set<absl::string_view>* cluster_specifier_plugins_not_seen,
ValidationErrors* errors) {
XdsRouteConfigResource::Route route;
// Parse route match.
{
ValidationErrors::ScopedField field(errors, ".match");
const auto* match = envoy_config_route_v3_Route_match(route_proto);
if (match == nullptr) {
errors->AddError("field not present");
return absl::nullopt;
}
// Skip routes with query_parameters set.
size_t query_parameters_size;
static_cast<void>(envoy_config_route_v3_RouteMatch_query_parameters(
match, &query_parameters_size));
if (query_parameters_size > 0) return absl::nullopt;
// Parse matchers.
auto path_matcher = RoutePathMatchParse(match, errors);
if (!path_matcher.has_value()) return absl::nullopt;
route.matchers.path_matcher = std::move(*path_matcher);
RouteHeaderMatchersParse(match, &route, errors);
RouteRuntimeFractionParse(match, &route, errors);
}
// Parse route action.
const envoy_config_route_v3_RouteAction* route_action_proto =
envoy_config_route_v3_Route_route(route_proto);
if (route_action_proto != nullptr) {
ValidationErrors::ScopedField field(errors, ".route");
auto route_action = RouteActionParse(context, route_action_proto,
cluster_specifier_plugin_map, errors);
if (!route_action.has_value()) return absl::nullopt;
// If the route does not have a retry policy but the vhost does,
// use the vhost retry policy for this route.
if (!route_action->retry_policy.has_value()) {
route_action->retry_policy = virtual_host_retry_policy;
}
// Mark off plugins used in route action.
auto* cluster_specifier_action = absl::get_if<
XdsRouteConfigResource::Route::RouteAction::ClusterSpecifierPluginName>(
&route_action->action);
if (cluster_specifier_action != nullptr) {
cluster_specifier_plugins_not_seen->erase(
cluster_specifier_action->cluster_specifier_plugin_name);
}
route.action = std::move(*route_action);
} else if (envoy_config_route_v3_Route_has_non_forwarding_action(
route_proto)) {
route.action = XdsRouteConfigResource::Route::NonForwardingAction();
} else {
// Leave route.action initialized to UnknownAction (its default).
}
// Parse typed_per_filter_config.
{
ValidationErrors::ScopedField field(errors, ".typed_per_filter_config");
route.typed_per_filter_config = ParseTypedPerFilterConfig<
envoy_config_route_v3_Route,
envoy_config_route_v3_Route_TypedPerFilterConfigEntry>(
context, route_proto,
envoy_config_route_v3_Route_typed_per_filter_config_next,
envoy_config_route_v3_Route_TypedPerFilterConfigEntry_key,
envoy_config_route_v3_Route_TypedPerFilterConfigEntry_value, errors);
}
return route;
}
} // namespace
XdsRouteConfigResource XdsRouteConfigResource::Parse(
const XdsResourceType::DecodeContext& context,
const envoy_config_route_v3_RouteConfiguration* route_config,
ValidationErrors* errors) {
XdsRouteConfigResource rds_update;
// Get the cluster spcifier plugin map.
if (XdsRlsEnabled()) {
rds_update.cluster_specifier_plugin_map =
ClusterSpecifierPluginParse(context, route_config, errors);
}
// Build a set of configured cluster_specifier_plugin names to make sure
// each is actually referenced by a route action.
std::set<absl::string_view> cluster_specifier_plugins_not_seen;
for (auto& plugin : rds_update.cluster_specifier_plugin_map) {
cluster_specifier_plugins_not_seen.emplace(plugin.first);
}
// Get the virtual hosts.
size_t num_virtual_hosts;
const envoy_config_route_v3_VirtualHost* const* virtual_hosts =
envoy_config_route_v3_RouteConfiguration_virtual_hosts(
route_config, &num_virtual_hosts);
for (size_t i = 0; i < num_virtual_hosts; ++i) {
ValidationErrors::ScopedField field(
errors, absl::StrCat(".virtual_hosts[", i, "]"));
rds_update.virtual_hosts.emplace_back();
XdsRouteConfigResource::VirtualHost& vhost =
rds_update.virtual_hosts.back();
// Parse domains.
size_t domain_size;
upb_StringView const* domains = envoy_config_route_v3_VirtualHost_domains(
virtual_hosts[i], &domain_size);
for (size_t j = 0; j < domain_size; ++j) {
std::string domain_pattern = UpbStringToStdString(domains[j]);
if (!XdsRouting::IsValidDomainPattern(domain_pattern)) {
ValidationErrors::ScopedField field(errors,
absl::StrCat(".domains[", j, "]"));
errors->AddError(
absl::StrCat("invalid domain pattern \"", domain_pattern, "\""));
}
vhost.domains.emplace_back(std::move(domain_pattern));
}
if (vhost.domains.empty()) {
ValidationErrors::ScopedField field(errors, ".domains");
errors->AddError("must be non-empty");
}
// Parse typed_per_filter_config.
{
ValidationErrors::ScopedField field(errors, ".typed_per_filter_config");
vhost.typed_per_filter_config = ParseTypedPerFilterConfig<
envoy_config_route_v3_VirtualHost,
envoy_config_route_v3_VirtualHost_TypedPerFilterConfigEntry>(
context, virtual_hosts[i],
envoy_config_route_v3_VirtualHost_typed_per_filter_config_next,
envoy_config_route_v3_VirtualHost_TypedPerFilterConfigEntry_key,
envoy_config_route_v3_VirtualHost_TypedPerFilterConfigEntry_value,
errors);
}
// Parse retry policy.
absl::optional<XdsRouteConfigResource::RetryPolicy>
virtual_host_retry_policy;
const envoy_config_route_v3_RetryPolicy* retry_policy =
envoy_config_route_v3_VirtualHost_retry_policy(virtual_hosts[i]);
if (retry_policy != nullptr) {
ValidationErrors::ScopedField field(errors, ".retry_policy");
virtual_host_retry_policy =
RetryPolicyParse(context, retry_policy, errors);
}
// Parse routes.
ValidationErrors::ScopedField field2(errors, ".routes");
size_t num_routes;
const envoy_config_route_v3_Route* const* routes =
envoy_config_route_v3_VirtualHost_routes(virtual_hosts[i], &num_routes);
for (size_t j = 0; j < num_routes; ++j) {
ValidationErrors::ScopedField field(errors, absl::StrCat("[", j, "]"));
auto route = ParseRoute(context, routes[j], virtual_host_retry_policy,
rds_update.cluster_specifier_plugin_map,
&cluster_specifier_plugins_not_seen, errors);
if (route.has_value()) vhost.routes.emplace_back(std::move(*route));
}
}
// For cluster specifier plugins that were not used in any route action,
// delete them from the update, since they will never be used.
for (auto& unused_plugin : cluster_specifier_plugins_not_seen) {
rds_update.cluster_specifier_plugin_map.erase(std::string(unused_plugin));
}
return rds_update;
}
//
// XdsRouteConfigResourceType
//
namespace {
void MaybeLogRouteConfiguration(
const XdsResourceType::DecodeContext& context,
const envoy_config_route_v3_RouteConfiguration* route_config) {
if (GRPC_TRACE_FLAG_ENABLED(*context.tracer) &&
gpr_should_log(GPR_LOG_SEVERITY_DEBUG)) {
const upb_MessageDef* msg_type =
envoy_config_route_v3_RouteConfiguration_getmsgdef(context.symtab);
char buf[10240];
upb_TextEncode(route_config, msg_type, nullptr, 0, buf, sizeof(buf));
gpr_log(GPR_DEBUG, "[xds_client %p] RouteConfiguration: %s", context.client,
buf);
}
}
} // namespace
XdsResourceType::DecodeResult XdsRouteConfigResourceType::Decode(
const XdsResourceType::DecodeContext& context,
absl::string_view serialized_resource) const {
DecodeResult result;
// Parse serialized proto.
auto* resource = envoy_config_route_v3_RouteConfiguration_parse(
serialized_resource.data(), serialized_resource.size(), context.arena);
if (resource == nullptr) {
result.resource =
absl::InvalidArgumentError("Can't parse RouteConfiguration resource.");
return result;
}
MaybeLogRouteConfiguration(context, resource);
// Validate resource.
result.name = UpbStringToStdString(
envoy_config_route_v3_RouteConfiguration_name(resource));
ValidationErrors errors;
auto rds_update = XdsRouteConfigResource::Parse(context, resource, &errors);
if (!errors.ok()) {
absl::Status status =
errors.status(absl::StatusCode::kInvalidArgument,
"errors validating RouteConfiguration resource");
if (GRPC_TRACE_FLAG_ENABLED(*context.tracer)) {
gpr_log(GPR_ERROR, "[xds_client %p] invalid RouteConfiguration %s: %s",
context.client, result.name->c_str(), status.ToString().c_str());
}
result.resource = std::move(status);
} else {
if (GRPC_TRACE_FLAG_ENABLED(*context.tracer)) {
gpr_log(GPR_INFO, "[xds_client %p] parsed RouteConfiguration %s: %s",
context.client, result.name->c_str(),
rds_update.ToString().c_str());
}
result.resource =
std::make_unique<XdsRouteConfigResource>(std::move(rds_update));
}
return result;
}
} // namespace grpc_core