grpc 1.41.1 → 1.44.0.pre2

data/src/core/ext/xds/xds_api.h

@@ -1,20 +1,18 @@
-/*
- *
- * 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.
- *
- */
+//
+// 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.
+//
 
 #ifndef GRPC_CORE_EXT_XDS_XDS_API_H
 #define GRPC_CORE_EXT_XDS_XDS_API_H
@@ -25,528 +23,53 @@
 
 #include <set>
 
-#include "absl/container/inlined_vector.h"
-#include "absl/types/optional.h"
 #include "envoy/admin/v3/config_dump.upb.h"
-#include "re2/re2.h"
 #include "upb/def.hpp"
 
-#include <grpc/slice_buffer.h>
+#include <grpc/slice.h>
 
-#include "src/core/ext/filters/client_channel/server_address.h"
+#include "src/core/ext/xds/upb_utils.h"
 #include "src/core/ext/xds/xds_bootstrap.h"
 #include "src/core/ext/xds/xds_client_stats.h"
 #include "src/core/ext/xds/xds_http_filters.h"
 #include "src/core/lib/channel/status_util.h"
 #include "src/core/lib/matchers/matchers.h"
+#include "src/core/lib/resolver/server_address.h"
 
 namespace grpc_core {
 
 class XdsClient;
 
+// TODO(roth): When we have time, split this into multiple pieces:
+// - a common upb-based parsing framework (combine with XdsEncodingContext)
+// - ADS request/response handling
+// - LRS request/response handling
+// - CSDS response generation
 class XdsApi {
  public:
-  static const char* kLdsTypeUrl;
-  static const char* kRdsTypeUrl;
-  static const char* kCdsTypeUrl;
-  static const char* kEdsTypeUrl;
-
-  struct Duration {
-    int64_t seconds = 0;
-    int32_t nanos = 0;
-    bool operator==(const Duration& other) const {
-      return seconds == other.seconds && nanos == other.nanos;
-    }
-    std::string ToString() const {
-      return absl::StrFormat("Duration seconds: %ld, nanos %d", seconds, nanos);
-    }
-  };
-
-  using TypedPerFilterConfig =
-      std::map<std::string, XdsHttpFilterImpl::FilterConfig>;
-
-  // TODO(donnadionne): When we can use absl::variant<>, consider using that
-  // for: PathMatcher, HeaderMatcher, cluster_name and weighted_clusters
-  struct Route {
-    // Matchers for this route.
-    struct Matchers {
-      StringMatcher path_matcher;
-      std::vector<HeaderMatcher> header_matchers;
-      absl::optional<uint32_t> fraction_per_million;
-
-      bool operator==(const Matchers& other) const {
-        return path_matcher == other.path_matcher &&
-               header_matchers == other.header_matchers &&
-               fraction_per_million == other.fraction_per_million;
-      }
-      std::string ToString() const;
-    };
-
-    struct HashPolicy {
-      enum Type { HEADER, CHANNEL_ID };
-      Type type;
-      bool terminal = false;
-      // Fields used for type HEADER.
-      std::string header_name;
-      std::unique_ptr<RE2> regex = nullptr;
-      std::string regex_substitution;
-
-      HashPolicy() {}
-
-      // Copyable.
-      HashPolicy(const HashPolicy& other);
-      HashPolicy& operator=(const HashPolicy& other);
-
-      // Moveable.
-      HashPolicy(HashPolicy&& other) noexcept;
-      HashPolicy& operator=(HashPolicy&& other) noexcept;
-
-      bool operator==(const HashPolicy& other) const;
-      std::string ToString() const;
-    };
-    Matchers matchers;
-    std::vector<HashPolicy> hash_policies;
-
-    struct RetryPolicy {
-      internal::StatusCodeSet retry_on;
-      uint32_t num_retries;
-
-      struct RetryBackOff {
-        Duration base_interval;
-        Duration max_interval;
-
-        bool operator==(const RetryBackOff& other) const {
-          return base_interval == other.base_interval &&
-                 max_interval == other.max_interval;
-        }
-        std::string ToString() const;
-      };
-      RetryBackOff retry_back_off;
-
-      bool operator==(const RetryPolicy& other) const {
-        return (retry_on == other.retry_on &&
-                num_retries == other.num_retries &&
-                retry_back_off == other.retry_back_off);
-      }
-      std::string ToString() const;
-    };
-    absl::optional<RetryPolicy> retry_policy;
-
-    // Action for this route.
-    // TODO(roth): When we can use absl::variant<>, consider using that
-    // here, to enforce the fact that only one of the two fields can be set.
-    std::string cluster_name;
-    struct ClusterWeight {
-      std::string name;
-      uint32_t weight;
-      TypedPerFilterConfig typed_per_filter_config;
-
-      bool operator==(const ClusterWeight& other) const {
-        return name == other.name && weight == other.weight &&
-               typed_per_filter_config == other.typed_per_filter_config;
-      }
-      std::string ToString() const;
-    };
-    std::vector<ClusterWeight> weighted_clusters;
-    // Storing the timeout duration from route action:
-    // RouteAction.max_stream_duration.grpc_timeout_header_max or
-    // RouteAction.max_stream_duration.max_stream_duration if the former is
-    // not set.
-    absl::optional<Duration> max_stream_duration;
-
-    TypedPerFilterConfig typed_per_filter_config;
-
-    bool operator==(const Route& other) const {
-      return matchers == other.matchers && cluster_name == other.cluster_name &&
-             retry_policy == other.retry_policy &&
-             weighted_clusters == other.weighted_clusters &&
-             max_stream_duration == other.max_stream_duration &&
-             typed_per_filter_config == other.typed_per_filter_config;
-    }
-    std::string ToString() const;
-  };
-
-  struct RdsUpdate {
-    struct VirtualHost {
-      std::vector<std::string> domains;
-      std::vector<Route> routes;
-      TypedPerFilterConfig typed_per_filter_config;
-
-      bool operator==(const VirtualHost& other) const {
-        return domains == other.domains && routes == other.routes &&
-               typed_per_filter_config == other.typed_per_filter_config;
-      }
-    };
-
-    std::vector<VirtualHost> virtual_hosts;
-
-    bool operator==(const RdsUpdate& other) const {
-      return virtual_hosts == other.virtual_hosts;
-    }
-    std::string ToString() const;
-    VirtualHost* FindVirtualHostForDomain(const std::string& domain);
-  };
-
-  struct CommonTlsContext {
-    struct CertificateProviderPluginInstance {
-      std::string instance_name;
-      std::string certificate_name;
-
-      bool operator==(const CertificateProviderPluginInstance& other) const {
-        return instance_name == other.instance_name &&
-               certificate_name == other.certificate_name;
-      }
-
-      std::string ToString() const;
-      bool Empty() const;
-    };
-
-    struct CertificateValidationContext {
-      CertificateProviderPluginInstance ca_certificate_provider_instance;
-      std::vector<StringMatcher> match_subject_alt_names;
-
-      bool operator==(const CertificateValidationContext& other) const {
-        return ca_certificate_provider_instance ==
-                   other.ca_certificate_provider_instance &&
-               match_subject_alt_names == other.match_subject_alt_names;
-      }
-
-      std::string ToString() const;
-      bool Empty() const;
+  // Interface defined by caller and passed to ParseAdsResponse().
+  class AdsResponseParserInterface {
+   public:
+    struct AdsResponseFields {
+      std::string type_url;
+      std::string version;
+      std::string nonce;
+      size_t num_resources;
     };
 
-    CertificateValidationContext certificate_validation_context;
-    CertificateProviderPluginInstance tls_certificate_provider_instance;
+    virtual ~AdsResponseParserInterface() = default;
 
-    bool operator==(const CommonTlsContext& other) const {
-      return certificate_validation_context ==
-                 other.certificate_validation_context &&
-             tls_certificate_provider_instance ==
-                 other.tls_certificate_provider_instance;
-    }
+    // Called when the top-level ADS fields are parsed.
+    // If this returns non-OK, parsing will stop, and the individual
+    // resources will not be processed.
+    virtual absl::Status ProcessAdsResponseFields(AdsResponseFields fields) = 0;
 
-    std::string ToString() const;
-    bool Empty() const;
+    // Called to parse each individual resource in the ADS response.
+    virtual void ParseResource(const XdsEncodingContext& context, size_t idx,
+                               absl::string_view type_url,
+                               absl::string_view serialized_resource) = 0;
   };
 
-  struct DownstreamTlsContext {
-    CommonTlsContext common_tls_context;
-    bool require_client_certificate = false;
-
-    bool operator==(const DownstreamTlsContext& other) const {
-      return common_tls_context == other.common_tls_context &&
-             require_client_certificate == other.require_client_certificate;
-    }
-
-    std::string ToString() const;
-    bool Empty() const;
-  };
-
-  // TODO(roth): When we can use absl::variant<>, consider using that
-  // here, to enforce the fact that only one of the two fields can be set.
-  struct LdsUpdate {
-    enum class ListenerType {
-      kTcpListener = 0,
-      kHttpApiListener,
-    } type;
-
-    struct HttpConnectionManager {
-      // The name to use in the RDS request.
-      std::string route_config_name;
-      // Storing the Http Connection Manager Common Http Protocol Option
-      // max_stream_duration
-      Duration http_max_stream_duration;
-      // The RouteConfiguration to use for this listener.
-      // Present only if it is inlined in the LDS response.
-      absl::optional<RdsUpdate> rds_update;
-
-      struct HttpFilter {
-        std::string name;
-        XdsHttpFilterImpl::FilterConfig config;
-
-        bool operator==(const HttpFilter& other) const {
-          return name == other.name && config == other.config;
-        }
-
-        std::string ToString() const;
-      };
-      std::vector<HttpFilter> http_filters;
-
-      bool operator==(const HttpConnectionManager& other) const {
-        return route_config_name == other.route_config_name &&
-               http_max_stream_duration == other.http_max_stream_duration &&
-               rds_update == other.rds_update &&
-               http_filters == other.http_filters;
-      }
-
-      std::string ToString() const;
-    };
-
-    // Populated for type=kHttpApiListener.
-    HttpConnectionManager http_connection_manager;
-
-    // Populated for type=kTcpListener.
-    // host:port listening_address set when type is kTcpListener
-    std::string address;
-
-    struct FilterChainData {
-      DownstreamTlsContext downstream_tls_context;
-      // This is in principle the filter list.
-      // We currently require exactly one filter, which is the HCM.
-      HttpConnectionManager http_connection_manager;
-
-      bool operator==(const FilterChainData& other) const {
-        return downstream_tls_context == other.downstream_tls_context &&
-               http_connection_manager == other.http_connection_manager;
-      }
-
-      std::string ToString() const;
-    } filter_chain_data;
-
-    // A multi-level map used to determine which filter chain to use for a given
-    // incoming connection. Determining the right filter chain for a given
-    // connection checks the following properties, in order:
-    // - destination port (never matched, so not present in map)
-    // - destination IP address
-    // - server name (never matched, so not present in map)
-    // - transport protocol (allows only "raw_buffer" or unset, prefers the
-    //   former, so only one of those two types is present in map)
-    // - application protocol (never matched, so not present in map)
-    // - connection source type (any, local or external)
-    // - source IP address
-    // - source port
-    // https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/listener/v3/listener_components.proto#config-listener-v3-filterchainmatch
-    // for more details
-    struct FilterChainMap {
-      struct FilterChainDataSharedPtr {
-        std::shared_ptr<FilterChainData> data;
-        bool operator==(const FilterChainDataSharedPtr& other) const {
-          return *data == *other.data;
-        }
-      };
-      struct CidrRange {
-        grpc_resolved_address address;
-        uint32_t prefix_len;
-
-        bool operator==(const CidrRange& other) const {
-          return memcmp(&address, &other.address, sizeof(address)) == 0 &&
-                 prefix_len == other.prefix_len;
-        }
-
-        std::string ToString() const;
-      };
-      using SourcePortsMap = std::map<uint16_t, FilterChainDataSharedPtr>;
-      struct SourceIp {
-        absl::optional<CidrRange> prefix_range;
-        SourcePortsMap ports_map;
-
-        bool operator==(const SourceIp& other) const {
-          return prefix_range == other.prefix_range &&
-                 ports_map == other.ports_map;
-        }
-      };
-      using SourceIpVector = std::vector<SourceIp>;
-      enum class ConnectionSourceType {
-        kAny = 0,
-        kSameIpOrLoopback,
-        kExternal
-      };
-      using ConnectionSourceTypesArray = std::array<SourceIpVector, 3>;
-      struct DestinationIp {
-        absl::optional<CidrRange> prefix_range;
-        // We always fail match on server name, so those filter chains are not
-        // included here.
-        ConnectionSourceTypesArray source_types_array;
-
-        bool operator==(const DestinationIp& other) const {
-          return prefix_range == other.prefix_range &&
-                 source_types_array == other.source_types_array;
-        }
-      };
-      // We always fail match on destination ports map
-      using DestinationIpVector = std::vector<DestinationIp>;
-      DestinationIpVector destination_ip_vector;
-
-      bool operator==(const FilterChainMap& other) const {
-        return destination_ip_vector == other.destination_ip_vector;
-      }
-
-      std::string ToString() const;
-    } filter_chain_map;
-
-    absl::optional<FilterChainData> default_filter_chain;
-
-    bool operator==(const LdsUpdate& other) const {
-      return http_connection_manager == other.http_connection_manager &&
-             address == other.address &&
-             filter_chain_map == other.filter_chain_map &&
-             default_filter_chain == other.default_filter_chain;
-    }
-
-    std::string ToString() const;
-  };
-
-  struct LdsResourceData {
-    LdsUpdate resource;
-    std::string serialized_proto;
-  };
-
-  using LdsUpdateMap = std::map<std::string /*server_name*/, LdsResourceData>;
-
-  struct RdsResourceData {
-    RdsUpdate resource;
-    std::string serialized_proto;
-  };
-
-  using RdsUpdateMap =
-      std::map<std::string /*route_config_name*/, RdsResourceData>;
-
-  struct CdsUpdate {
-    enum ClusterType { EDS, LOGICAL_DNS, AGGREGATE };
-    ClusterType cluster_type;
-    // For cluster type EDS.
-    // The name to use in the EDS request.
-    // If empty, the cluster name will be used.
-    std::string eds_service_name;
-    // For cluster type LOGICAL_DNS.
-    // The hostname to lookup in DNS.
-    std::string dns_hostname;
-    // For cluster type AGGREGATE.
-    // The prioritized list of cluster names.
-    std::vector<std::string> prioritized_cluster_names;
-
-    // Tls Context used by clients
-    CommonTlsContext common_tls_context;
-
-    // The LRS server to use for load reporting.
-    // If not set, load reporting will be disabled.
-    // If set to the empty string, will use the same server we obtained the CDS
-    // data from.
-    absl::optional<std::string> lrs_load_reporting_server_name;
-
-    // The LB policy to use (e.g., "ROUND_ROBIN" or "RING_HASH").
-    std::string lb_policy;
-    // Used for RING_HASH LB policy only.
-    uint64_t min_ring_size = 1024;
-    uint64_t max_ring_size = 8388608;
-    // Maximum number of outstanding requests can be made to the upstream
-    // cluster.
-    uint32_t max_concurrent_requests = 1024;
-
-    bool operator==(const CdsUpdate& other) const {
-      return cluster_type == other.cluster_type &&
-             eds_service_name == other.eds_service_name &&
-             dns_hostname == other.dns_hostname &&
-             prioritized_cluster_names == other.prioritized_cluster_names &&
-             common_tls_context == other.common_tls_context &&
-             lrs_load_reporting_server_name ==
-                 other.lrs_load_reporting_server_name &&
-             lb_policy == other.lb_policy &&
-             min_ring_size == other.min_ring_size &&
-             max_ring_size == other.max_ring_size &&
-             max_concurrent_requests == other.max_concurrent_requests;
-    }
-
-    std::string ToString() const;
-  };
-
-  struct CdsResourceData {
-    CdsUpdate resource;
-    std::string serialized_proto;
-  };
-
-  using CdsUpdateMap = std::map<std::string /*cluster_name*/, CdsResourceData>;
-
-  struct EdsUpdate {
-    struct Priority {
-      struct Locality {
-        RefCountedPtr<XdsLocalityName> name;
-        uint32_t lb_weight;
-        ServerAddressList endpoints;
-
-        bool operator==(const Locality& other) const {
-          return *name == *other.name && lb_weight == other.lb_weight &&
-                 endpoints == other.endpoints;
-        }
-        bool operator!=(const Locality& other) const {
-          return !(*this == other);
-        }
-        std::string ToString() const;
-      };
-
-      std::map<XdsLocalityName*, Locality, XdsLocalityName::Less> localities;
-
-      bool operator==(const Priority& other) const;
-      std::string ToString() const;
-    };
-    using PriorityList = absl::InlinedVector<Priority, 2>;
-
-    // There are two phases of accessing this class's content:
-    // 1. to initialize in the control plane combiner;
-    // 2. to use in the data plane combiner.
-    // So no additional synchronization is needed.
-    class DropConfig : public RefCounted<DropConfig> {
-     public:
-      struct DropCategory {
-        bool operator==(const DropCategory& other) const {
-          return name == other.name &&
-                 parts_per_million == other.parts_per_million;
-        }
-
-        std::string name;
-        const uint32_t parts_per_million;
-      };
-
-      using DropCategoryList = absl::InlinedVector<DropCategory, 2>;
-
-      void AddCategory(std::string name, uint32_t parts_per_million) {
-        drop_category_list_.emplace_back(
-            DropCategory{std::move(name), parts_per_million});
-        if (parts_per_million == 1000000) drop_all_ = true;
-      }
-
-      // The only method invoked from outside the WorkSerializer (used in
-      // the data plane).
-      bool ShouldDrop(const std::string** category_name) const;
-
-      const DropCategoryList& drop_category_list() const {
-        return drop_category_list_;
-      }
-
-      bool drop_all() const { return drop_all_; }
-
-      bool operator==(const DropConfig& other) const {
-        return drop_category_list_ == other.drop_category_list_;
-      }
-      bool operator!=(const DropConfig& other) const {
-        return !(*this == other);
-      }
-
-      std::string ToString() const;
-
-     private:
-      DropCategoryList drop_category_list_;
-      bool drop_all_ = false;
-    };
-
-    PriorityList priorities;
-    RefCountedPtr<DropConfig> drop_config;
-
-    bool operator==(const EdsUpdate& other) const {
-      return priorities == other.priorities &&
-             *drop_config == *other.drop_config;
-    }
-    std::string ToString() const;
-  };
-
-  struct EdsResourceData {
-    EdsUpdate resource;
-    std::string serialized_proto;
-  };
-
-  using EdsUpdateMap =
-      std::map<std::string /*eds_service_name*/, EdsResourceData>;
-
   struct ClusterLoadReport {
     XdsClusterDropStats::Snapshot dropped_requests;
     std::map<RefCountedPtr<XdsLocalityName>, XdsClusterLocalityStats::Snapshot,
@@ -594,13 +117,9 @@ class XdsApi {
     grpc_millis failed_update_time = 0;
   };
   using ResourceMetadataMap =
-      std::map<absl::string_view /*resource_name*/, const ResourceMetadata*>;
-  struct ResourceTypeMetadata {
-    absl::string_view version;
-    ResourceMetadataMap resource_metadata_map;
-  };
+      std::map<std::string /*resource_name*/, const ResourceMetadata*>;
   using ResourceTypeMetadataMap =
-      std::map<absl::string_view /*type_url*/, ResourceTypeMetadata>;
+      std::map<absl::string_view /*type_url*/, ResourceMetadataMap>;
   static_assert(static_cast<ResourceMetadata::ClientResourceStatus>(
                     envoy_admin_v3_REQUESTED) ==
                     ResourceMetadata::ClientResourceStatus::REQUESTED,
@@ -618,44 +137,24 @@ class XdsApi {
                     ResourceMetadata::ClientResourceStatus::NACKED,
                 "");
 
-  // If the response can't be parsed at the top level, the resulting
-  // type_url will be empty.
-  // If there is any other type of validation error, the parse_error
-  // field will be set to something other than GRPC_ERROR_NONE and the
-  // resource_names_failed field will be populated.
-  // Otherwise, one of the *_update_map fields will be populated, based
-  // on the type_url field.
-  struct AdsParseResult {
-    grpc_error_handle parse_error = GRPC_ERROR_NONE;
-    std::string version;
-    std::string nonce;
-    std::string type_url;
-    LdsUpdateMap lds_update_map;
-    RdsUpdateMap rds_update_map;
-    CdsUpdateMap cds_update_map;
-    EdsUpdateMap eds_update_map;
-    std::set<std::string> resource_names_failed;
-  };
-
   XdsApi(XdsClient* client, TraceFlag* tracer, const XdsBootstrap::Node* node,
-         const CertificateProviderStore::PluginDefinitionMap* map);
+         const CertificateProviderStore::PluginDefinitionMap* map,
+         upb::SymbolTable* symtab);
 
   // Creates an ADS request.
   // Takes ownership of \a error.
   grpc_slice CreateAdsRequest(const XdsBootstrap::XdsServer& server,
-                              const std::string& type_url,
-                              const std::set<absl::string_view>& resource_names,
-                              const std::string& version,
-                              const std::string& nonce, grpc_error_handle error,
-                              bool populate_node);
-
-  // Parses an ADS response.
-  AdsParseResult ParseAdsResponse(
-      const XdsBootstrap::XdsServer& server, const grpc_slice& encoded_response,
-      const std::set<absl::string_view>& expected_listener_names,
-      const std::set<absl::string_view>& expected_route_configuration_names,
-      const std::set<absl::string_view>& expected_cluster_names,
-      const std::set<absl::string_view>& expected_eds_service_names);
+                              absl::string_view type_url,
+                              absl::string_view version,
+                              absl::string_view nonce,
+                              const std::vector<std::string>& resource_names,
+                              grpc_error_handle error, bool populate_node);
+
+  // Returns non-OK when failing to deserialize response message.
+  // Otherwise, all events are reported to the parser.
+  absl::Status ParseAdsResponse(const XdsBootstrap::XdsServer& server,
+                                const grpc_slice& encoded_response,
+                                AdsResponseParserInterface* parser);
 
   // Creates an initial LRS request.
   grpc_slice CreateLrsInitialRequest(const XdsBootstrap::XdsServer& server);
@@ -681,7 +180,7 @@ class XdsApi {
   const XdsBootstrap::Node* node_;  // Do not own.
   const CertificateProviderStore::PluginDefinitionMap*
       certificate_provider_definition_map_;  // Do not own.
-  upb::SymbolTable symtab_;
+  upb::SymbolTable* symtab_;                 // Do not own.
   const std::string build_version_;
   const std::string user_agent_name_;
   const std::string user_agent_version_;
@@ -689,4 +188,4 @@ class XdsApi {
 
 }  // namespace grpc_core
 
-#endif /* GRPC_CORE_EXT_XDS_XDS_API_H */
+#endif  // GRPC_CORE_EXT_XDS_XDS_API_H