1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
//
// 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_SRC_CORE_EXT_XDS_XDS_API_H
#define GRPC_SRC_CORE_EXT_XDS_XDS_API_H
#include <grpc/support/port_platform.h>
#include <stddef.h>
#include <map>
#include <set>
#include <util/generic/string.h>
#include <util/string/cast.h>
#include <utility>
#include <vector>
#include "y_absl/status/status.h"
#include "y_absl/strings/string_view.h"
#include "envoy/admin/v3/config_dump_shared.upb.h"
#include "upb/arena.h"
#include "upb/def.hpp"
#include "src/core/ext/xds/xds_bootstrap.h"
#include "src/core/ext/xds/xds_client_stats.h"
#include "src/core/lib/debug/trace.h"
#include "src/core/lib/gprpp/ref_counted_ptr.h"
#include "src/core/lib/gprpp/time.h"
namespace grpc_core {
class XdsClient;
// TODO(roth): When we have time, split this into multiple pieces:
// - ADS request/response handling
// - LRS request/response handling
// - CSDS response generation
class XdsApi {
public:
// Interface defined by caller and passed to ParseAdsResponse().
class AdsResponseParserInterface {
public:
struct AdsResponseFields {
TString type_url;
TString version;
TString nonce;
size_t num_resources;
};
virtual ~AdsResponseParserInterface() = default;
// 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 y_absl::Status ProcessAdsResponseFields(AdsResponseFields fields) = 0;
// Called to parse each individual resource in the ADS response.
// Note that resource_name is non-empty only when the resource was
// wrapped in a Resource wrapper proto.
virtual void ParseResource(upb_Arena* arena, size_t idx,
y_absl::string_view type_url,
y_absl::string_view resource_name,
y_absl::string_view serialized_resource) = 0;
// Called when a resource is wrapped in a Resource wrapper proto but
// we fail to deserialize the wrapper proto.
virtual void ResourceWrapperParsingFailed(size_t idx) = 0;
};
struct ClusterLoadReport {
XdsClusterDropStats::Snapshot dropped_requests;
std::map<RefCountedPtr<XdsLocalityName>, XdsClusterLocalityStats::Snapshot,
XdsLocalityName::Less>
locality_stats;
Duration load_report_interval;
};
using ClusterLoadReportMap = std::map<
std::pair<TString /*cluster_name*/, TString /*eds_service_name*/>,
ClusterLoadReport>;
// The metadata of the xDS resource; used by the xDS config dump.
struct ResourceMetadata {
// Resource status from the view of a xDS client, which tells the
// synchronization status between the xDS client and the xDS server.
enum ClientResourceStatus {
// Client requested this resource but hasn't received any update from
// management server. The client will not fail requests, but will queue
// them
// until update arrives or the client times out waiting for the resource.
REQUESTED = 1,
// This resource has been requested by the client but has either not been
// delivered by the server or was previously delivered by the server and
// then subsequently removed from resources provided by the server.
DOES_NOT_EXIST,
// Client received this resource and replied with ACK.
ACKED,
// Client received this resource and replied with NACK.
NACKED
};
// The client status of this resource.
ClientResourceStatus client_status = REQUESTED;
// The serialized bytes of the last successfully updated raw xDS resource.
TString serialized_proto;
// The timestamp when the resource was last successfully updated.
Timestamp update_time;
// The last successfully updated version of the resource.
TString version;
// The rejected version string of the last failed update attempt.
TString failed_version;
// Details about the last failed update attempt.
TString failed_details;
// Timestamp of the last failed update attempt.
Timestamp failed_update_time;
};
using ResourceMetadataMap =
std::map<TString /*resource_name*/, const ResourceMetadata*>;
using ResourceTypeMetadataMap =
std::map<y_absl::string_view /*type_url*/, ResourceMetadataMap>;
static_assert(static_cast<ResourceMetadata::ClientResourceStatus>(
envoy_admin_v3_REQUESTED) ==
ResourceMetadata::ClientResourceStatus::REQUESTED,
"");
static_assert(static_cast<ResourceMetadata::ClientResourceStatus>(
envoy_admin_v3_DOES_NOT_EXIST) ==
ResourceMetadata::ClientResourceStatus::DOES_NOT_EXIST,
"");
static_assert(static_cast<ResourceMetadata::ClientResourceStatus>(
envoy_admin_v3_ACKED) ==
ResourceMetadata::ClientResourceStatus::ACKED,
"");
static_assert(static_cast<ResourceMetadata::ClientResourceStatus>(
envoy_admin_v3_NACKED) ==
ResourceMetadata::ClientResourceStatus::NACKED,
"");
XdsApi(XdsClient* client, TraceFlag* tracer, const XdsBootstrap::Node* node,
upb::SymbolTable* symtab, TString user_agent_name,
TString user_agent_version);
// Creates an ADS request.
TString CreateAdsRequest(y_absl::string_view type_url,
y_absl::string_view version,
y_absl::string_view nonce,
const std::vector<TString>& resource_names,
y_absl::Status status, bool populate_node);
// Returns non-OK when failing to deserialize response message.
// Otherwise, all events are reported to the parser.
y_absl::Status ParseAdsResponse(y_absl::string_view encoded_response,
AdsResponseParserInterface* parser);
// Creates an initial LRS request.
TString CreateLrsInitialRequest();
// Creates an LRS request sending a client-side load report.
TString CreateLrsRequest(ClusterLoadReportMap cluster_load_report_map);
// Parses the LRS response and populates send_all_clusters,
// cluster_names, and load_reporting_interval.
y_absl::Status ParseLrsResponse(y_absl::string_view encoded_response,
bool* send_all_clusters,
std::set<TString>* cluster_names,
Duration* load_reporting_interval);
// Assemble the client config proto message and return the serialized result.
TString AssembleClientConfig(
const ResourceTypeMetadataMap& resource_type_metadata_map);
private:
XdsClient* client_;
TraceFlag* tracer_;
const XdsBootstrap::Node* node_; // Do not own.
upb::SymbolTable* symtab_; // Do not own.
const TString user_agent_name_;
const TString user_agent_version_;
};
} // namespace grpc_core
#endif // GRPC_SRC_CORE_EXT_XDS_XDS_API_H
|
