/* * * Copyright 2019 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. * */ // Package v2 provides xDS v2 transport protocol specific functionality. package v2 import ( "context" "fmt" "github.com/golang/protobuf/proto" "google.golang.org/grpc" "google.golang.org/grpc/codes" "google.golang.org/grpc/internal/grpclog" "google.golang.org/grpc/internal/pretty" controllerversion "google.golang.org/grpc/xds/internal/xdsclient/controller/version" "google.golang.org/grpc/xds/internal/xdsclient/xdsresource" xdsresourceversion "google.golang.org/grpc/xds/internal/xdsclient/xdsresource/version" "google.golang.org/protobuf/types/known/anypb" v2xdspb "github.com/envoyproxy/go-control-plane/envoy/api/v2" v2corepb "github.com/envoyproxy/go-control-plane/envoy/api/v2/core" v2adsgrpc "github.com/envoyproxy/go-control-plane/envoy/service/discovery/v2" statuspb "google.golang.org/genproto/googleapis/rpc/status" ) func init() { controllerversion.RegisterAPIClientBuilder(xdsresourceversion.TransportV2, newClient) } var ( resourceTypeToURL = map[xdsresource.ResourceType]string{ xdsresource.ListenerResource: xdsresourceversion.V2ListenerURL, xdsresource.RouteConfigResource: xdsresourceversion.V2RouteConfigURL, xdsresource.ClusterResource: xdsresourceversion.V2ClusterURL, xdsresource.EndpointsResource: xdsresourceversion.V2EndpointsURL, } ) func newClient(opts controllerversion.BuildOptions) (controllerversion.VersionedClient, error) { nodeProto, ok := opts.NodeProto.(*v2corepb.Node) if !ok { return nil, fmt.Errorf("xds: unsupported Node proto type: %T, want %T", opts.NodeProto, (*v2corepb.Node)(nil)) } v2c := &client{nodeProto: nodeProto, logger: opts.Logger} return v2c, nil } type adsStream v2adsgrpc.AggregatedDiscoveryService_StreamAggregatedResourcesClient // client performs the actual xDS RPCs using the xDS v2 API. It creates a // single ADS stream on which the different types of xDS requests and responses // are multiplexed. type client struct { nodeProto *v2corepb.Node logger *grpclog.PrefixLogger } func (v2c *client) NewStream(ctx context.Context, cc *grpc.ClientConn) (grpc.ClientStream, error) { return v2adsgrpc.NewAggregatedDiscoveryServiceClient(cc).StreamAggregatedResources(ctx, grpc.WaitForReady(true)) } // SendRequest sends out a DiscoveryRequest for the given resourceNames, of type // rType, on the provided stream. // // version is the ack version to be sent with the request // - If this is the new request (not an ack/nack), version will be empty. // - If this is an ack, version will be the version from the response. // - If this is a nack, version will be the previous acked version (from // versionMap). If there was no ack before, it will be empty. func (v2c *client) SendRequest(s grpc.ClientStream, resourceNames []string, rType xdsresource.ResourceType, version, nonce, errMsg string) error { stream, ok := s.(adsStream) if !ok { return fmt.Errorf("xds: Attempt to send request on unsupported stream type: %T", s) } req := &v2xdspb.DiscoveryRequest{ Node: v2c.nodeProto, TypeUrl: resourceTypeToURL[rType], ResourceNames: resourceNames, VersionInfo: version, ResponseNonce: nonce, } if errMsg != "" { req.ErrorDetail = &statuspb.Status{ Code: int32(codes.InvalidArgument), Message: errMsg, } } if err := stream.Send(req); err != nil { return fmt.Errorf("xds: stream.Send(%+v) failed: %v", req, err) } v2c.logger.Debugf("ADS request sent: %v", pretty.ToJSON(req)) return nil } // RecvResponse blocks on the receipt of one response message on the provided // stream. func (v2c *client) RecvResponse(s grpc.ClientStream) (proto.Message, error) { stream, ok := s.(adsStream) if !ok { return nil, fmt.Errorf("xds: Attempt to receive response on unsupported stream type: %T", s) } resp, err := stream.Recv() if err != nil { return nil, fmt.Errorf("xds: stream.Recv() failed: %v", err) } v2c.logger.Infof("ADS response received, type: %v", resp.GetTypeUrl()) v2c.logger.Debugf("ADS response received: %v", pretty.ToJSON(resp)) return resp, nil } func (v2c *client) ParseResponse(r proto.Message) (xdsresource.ResourceType, []*anypb.Any, string, string, error) { rType := xdsresource.UnknownResource resp, ok := r.(*v2xdspb.DiscoveryResponse) if !ok { return rType, nil, "", "", fmt.Errorf("xds: unsupported message type: %T", resp) } // Note that the xDS transport protocol is versioned independently of // the resource types, and it is supported to transfer older versions // of resource types using new versions of the transport protocol, or // vice-versa. Hence we need to handle v3 type_urls as well here. var err error url := resp.GetTypeUrl() switch { case xdsresource.IsListenerResource(url): rType = xdsresource.ListenerResource case xdsresource.IsRouteConfigResource(url): rType = xdsresource.RouteConfigResource case xdsresource.IsClusterResource(url): rType = xdsresource.ClusterResource case xdsresource.IsEndpointsResource(url): rType = xdsresource.EndpointsResource default: return rType, nil, "", "", controllerversion.ErrResourceTypeUnsupported{ ErrStr: fmt.Sprintf("Resource type %v unknown in response from server", resp.GetTypeUrl()), } } return rType, resp.GetResources(), resp.GetVersionInfo(), resp.GetNonce(), err }