route/vendor/google.golang.org/grpc/clientconn.go

1249 lines
36 KiB
Go
Raw Normal View History

2017-01-26 15:51:44 +00:00
/*
*
2017-09-30 16:47:47 +00:00
* Copyright 2014 gRPC authors.
2017-01-26 15:51:44 +00:00
*
2017-09-30 16:47:47 +00:00
* 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
2017-01-26 15:51:44 +00:00
*
2017-09-30 16:47:47 +00:00
* http://www.apache.org/licenses/LICENSE-2.0
2017-01-26 15:51:44 +00:00
*
2017-09-30 16:47:47 +00:00
* 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.
2017-01-26 15:51:44 +00:00
*
*/
package grpc
import (
"errors"
2017-09-30 16:47:47 +00:00
"math"
2017-01-26 15:51:44 +00:00
"net"
"strings"
"sync"
"time"
"golang.org/x/net/context"
"golang.org/x/net/trace"
2017-09-30 16:47:47 +00:00
"google.golang.org/grpc/connectivity"
2017-01-26 15:51:44 +00:00
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/grpclog"
2017-09-30 16:47:47 +00:00
"google.golang.org/grpc/keepalive"
2017-01-26 15:51:44 +00:00
"google.golang.org/grpc/stats"
"google.golang.org/grpc/transport"
)
var (
// ErrClientConnClosing indicates that the operation is illegal because
// the ClientConn is closing.
ErrClientConnClosing = errors.New("grpc: the client connection is closing")
// ErrClientConnTimeout indicates that the ClientConn cannot establish the
// underlying connections within the specified timeout.
2017-09-30 16:47:47 +00:00
// DEPRECATED: Please use context.DeadlineExceeded instead.
2017-01-26 15:51:44 +00:00
ErrClientConnTimeout = errors.New("grpc: timed out when dialing")
// errNoTransportSecurity indicates that there is no transport security
// being set for ClientConn. Users should either set one or explicitly
// call WithInsecure DialOption to disable security.
errNoTransportSecurity = errors.New("grpc: no transport security set (use grpc.WithInsecure() explicitly or set credentials)")
// errTransportCredentialsMissing indicates that users want to transmit security
// information (e.g., oauth2 token) which requires secure connection on an insecure
// connection.
errTransportCredentialsMissing = errors.New("grpc: the credentials require transport level security (use grpc.WithTransportCredentials() to set)")
// errCredentialsConflict indicates that grpc.WithTransportCredentials()
// and grpc.WithInsecure() are both called for a connection.
errCredentialsConflict = errors.New("grpc: transport credentials are set for an insecure connection (grpc.WithTransportCredentials() and grpc.WithInsecure() are both called)")
// errNetworkIO indicates that the connection is down due to some network I/O error.
errNetworkIO = errors.New("grpc: failed with network I/O error")
// errConnDrain indicates that the connection starts to be drained and does not accept any new RPCs.
errConnDrain = errors.New("grpc: the connection is drained")
// errConnClosing indicates that the connection is closing.
errConnClosing = errors.New("grpc: the connection is closing")
// errConnUnavailable indicates that the connection is unavailable.
errConnUnavailable = errors.New("grpc: the connection is unavailable")
2017-09-30 16:47:47 +00:00
// errBalancerClosed indicates that the balancer is closed.
errBalancerClosed = errors.New("grpc: balancer is closed")
2017-01-26 15:51:44 +00:00
// minimum time to give a connection to complete
minConnectTimeout = 20 * time.Second
)
// dialOptions configure a Dial call. dialOptions are set by the DialOption
// values passed to Dial.
type dialOptions struct {
2017-09-30 16:47:47 +00:00
unaryInt UnaryClientInterceptor
streamInt StreamClientInterceptor
codec Codec
cp Compressor
dc Decompressor
bs backoffStrategy
2017-10-06 15:29:20 +00:00
balancer Balancer
2017-09-30 16:47:47 +00:00
block bool
insecure bool
timeout time.Duration
scChan <-chan ServiceConfig
copts transport.ConnectOptions
callOptions []CallOption
2017-01-26 15:51:44 +00:00
}
2017-09-30 16:47:47 +00:00
const (
defaultClientMaxReceiveMessageSize = 1024 * 1024 * 4
defaultClientMaxSendMessageSize = math.MaxInt32
)
2017-01-26 15:51:44 +00:00
// DialOption configures how we set up the connection.
type DialOption func(*dialOptions)
2017-09-30 16:47:47 +00:00
// WithInitialWindowSize returns a DialOption which sets the value for initial window size on a stream.
// The lower bound for window size is 64K and any value smaller than that will be ignored.
func WithInitialWindowSize(s int32) DialOption {
return func(o *dialOptions) {
o.copts.InitialWindowSize = s
}
}
// WithInitialConnWindowSize returns a DialOption which sets the value for initial window size on a connection.
// The lower bound for window size is 64K and any value smaller than that will be ignored.
func WithInitialConnWindowSize(s int32) DialOption {
return func(o *dialOptions) {
o.copts.InitialConnWindowSize = s
}
}
// WithMaxMsgSize returns a DialOption which sets the maximum message size the client can receive. Deprecated: use WithDefaultCallOptions(MaxCallRecvMsgSize(s)) instead.
func WithMaxMsgSize(s int) DialOption {
return WithDefaultCallOptions(MaxCallRecvMsgSize(s))
}
// WithDefaultCallOptions returns a DialOption which sets the default CallOptions for calls over the connection.
func WithDefaultCallOptions(cos ...CallOption) DialOption {
return func(o *dialOptions) {
o.callOptions = append(o.callOptions, cos...)
}
}
2017-01-26 15:51:44 +00:00
// WithCodec returns a DialOption which sets a codec for message marshaling and unmarshaling.
func WithCodec(c Codec) DialOption {
return func(o *dialOptions) {
o.codec = c
}
}
// WithCompressor returns a DialOption which sets a CompressorGenerator for generating message
// compressor.
func WithCompressor(cp Compressor) DialOption {
return func(o *dialOptions) {
o.cp = cp
}
}
// WithDecompressor returns a DialOption which sets a DecompressorGenerator for generating
// message decompressor.
func WithDecompressor(dc Decompressor) DialOption {
return func(o *dialOptions) {
o.dc = dc
}
}
2017-10-06 15:29:20 +00:00
// WithBalancer returns a DialOption which sets a load balancer.
2017-01-26 15:51:44 +00:00
func WithBalancer(b Balancer) DialOption {
return func(o *dialOptions) {
2017-10-06 15:29:20 +00:00
o.balancer = b
2017-01-26 15:51:44 +00:00
}
}
// WithServiceConfig returns a DialOption which has a channel to read the service configuration.
func WithServiceConfig(c <-chan ServiceConfig) DialOption {
return func(o *dialOptions) {
o.scChan = c
}
}
// WithBackoffMaxDelay configures the dialer to use the provided maximum delay
// when backing off after failed connection attempts.
func WithBackoffMaxDelay(md time.Duration) DialOption {
return WithBackoffConfig(BackoffConfig{MaxDelay: md})
}
// WithBackoffConfig configures the dialer to use the provided backoff
// parameters after connection failures.
//
// Use WithBackoffMaxDelay until more parameters on BackoffConfig are opened up
// for use.
func WithBackoffConfig(b BackoffConfig) DialOption {
// Set defaults to ensure that provided BackoffConfig is valid and
// unexported fields get default values.
setDefaults(&b)
return withBackoff(b)
}
// withBackoff sets the backoff strategy used for retries after a
// failed connection attempt.
//
// This can be exported if arbitrary backoff strategies are allowed by gRPC.
func withBackoff(bs backoffStrategy) DialOption {
return func(o *dialOptions) {
o.bs = bs
}
}
// WithBlock returns a DialOption which makes caller of Dial blocks until the underlying
// connection is up. Without this, Dial returns immediately and connecting the server
// happens in background.
func WithBlock() DialOption {
return func(o *dialOptions) {
o.block = true
}
}
// WithInsecure returns a DialOption which disables transport security for this ClientConn.
// Note that transport security is required unless WithInsecure is set.
func WithInsecure() DialOption {
return func(o *dialOptions) {
o.insecure = true
}
}
// WithTransportCredentials returns a DialOption which configures a
// connection level security credentials (e.g., TLS/SSL).
func WithTransportCredentials(creds credentials.TransportCredentials) DialOption {
return func(o *dialOptions) {
o.copts.TransportCredentials = creds
}
}
// WithPerRPCCredentials returns a DialOption which sets
2017-09-30 16:47:47 +00:00
// credentials and places auth state on each outbound RPC.
2017-01-26 15:51:44 +00:00
func WithPerRPCCredentials(creds credentials.PerRPCCredentials) DialOption {
return func(o *dialOptions) {
o.copts.PerRPCCredentials = append(o.copts.PerRPCCredentials, creds)
}
}
// WithTimeout returns a DialOption that configures a timeout for dialing a ClientConn
// initially. This is valid if and only if WithBlock() is present.
2017-09-30 16:47:47 +00:00
// Deprecated: use DialContext and context.WithTimeout instead.
2017-01-26 15:51:44 +00:00
func WithTimeout(d time.Duration) DialOption {
return func(o *dialOptions) {
o.timeout = d
}
}
// WithDialer returns a DialOption that specifies a function to use for dialing network addresses.
// If FailOnNonTempDialError() is set to true, and an error is returned by f, gRPC checks the error's
// Temporary() method to decide if it should try to reconnect to the network address.
func WithDialer(f func(string, time.Duration) (net.Conn, error)) DialOption {
return func(o *dialOptions) {
o.copts.Dialer = func(ctx context.Context, addr string) (net.Conn, error) {
if deadline, ok := ctx.Deadline(); ok {
return f(addr, deadline.Sub(time.Now()))
}
return f(addr, 0)
}
}
}
// WithStatsHandler returns a DialOption that specifies the stats handler
// for all the RPCs and underlying network connections in this ClientConn.
func WithStatsHandler(h stats.Handler) DialOption {
return func(o *dialOptions) {
o.copts.StatsHandler = h
}
}
2017-09-30 16:47:47 +00:00
// FailOnNonTempDialError returns a DialOption that specifies if gRPC fails on non-temporary dial errors.
2017-01-26 15:51:44 +00:00
// If f is true, and dialer returns a non-temporary error, gRPC will fail the connection to the network
// address and won't try to reconnect.
// The default value of FailOnNonTempDialError is false.
// This is an EXPERIMENTAL API.
func FailOnNonTempDialError(f bool) DialOption {
return func(o *dialOptions) {
o.copts.FailOnNonTempDialError = f
}
}
// WithUserAgent returns a DialOption that specifies a user agent string for all the RPCs.
func WithUserAgent(s string) DialOption {
return func(o *dialOptions) {
o.copts.UserAgent = s
}
}
2017-10-06 15:29:20 +00:00
// WithKeepaliveParams returns a DialOption that specifies keepalive paramaters for the client transport.
2017-09-30 16:47:47 +00:00
func WithKeepaliveParams(kp keepalive.ClientParameters) DialOption {
return func(o *dialOptions) {
o.copts.KeepaliveParams = kp
}
}
2017-01-26 15:51:44 +00:00
// WithUnaryInterceptor returns a DialOption that specifies the interceptor for unary RPCs.
func WithUnaryInterceptor(f UnaryClientInterceptor) DialOption {
return func(o *dialOptions) {
o.unaryInt = f
}
}
// WithStreamInterceptor returns a DialOption that specifies the interceptor for streaming RPCs.
func WithStreamInterceptor(f StreamClientInterceptor) DialOption {
return func(o *dialOptions) {
o.streamInt = f
}
}
2017-09-30 16:47:47 +00:00
// WithAuthority returns a DialOption that specifies the value to be used as
// the :authority pseudo-header. This value only works with WithInsecure and
// has no effect if TransportCredentials are present.
func WithAuthority(a string) DialOption {
return func(o *dialOptions) {
o.copts.Authority = a
}
}
2017-01-26 15:51:44 +00:00
// Dial creates a client connection to the given target.
func Dial(target string, opts ...DialOption) (*ClientConn, error) {
return DialContext(context.Background(), target, opts...)
}
// DialContext creates a client connection to the given target. ctx can be used to
2017-09-30 16:47:47 +00:00
// cancel or expire the pending connection. Once this function returns, the
2017-01-26 15:51:44 +00:00
// cancellation and expiration of ctx will be noop. Users should call ClientConn.Close
// to terminate all the pending operations after this function returns.
func DialContext(ctx context.Context, target string, opts ...DialOption) (conn *ClientConn, err error) {
cc := &ClientConn{
target: target,
2017-09-30 16:47:47 +00:00
csMgr: &connectivityStateManager{},
2017-10-06 15:29:20 +00:00
conns: make(map[Address]*addrConn),
2017-01-26 15:51:44 +00:00
}
2017-09-30 16:47:47 +00:00
cc.csEvltr = &connectivityStateEvaluator{csMgr: cc.csMgr}
2017-01-26 15:51:44 +00:00
cc.ctx, cc.cancel = context.WithCancel(context.Background())
2017-09-30 16:47:47 +00:00
2017-01-26 15:51:44 +00:00
for _, opt := range opts {
opt(&cc.dopts)
}
2017-09-30 16:47:47 +00:00
cc.mkp = cc.dopts.copts.KeepaliveParams
if cc.dopts.copts.Dialer == nil {
cc.dopts.copts.Dialer = newProxyDialer(
func(ctx context.Context, addr string) (net.Conn, error) {
return dialContext(ctx, "tcp", addr)
},
)
}
if cc.dopts.copts.UserAgent != "" {
cc.dopts.copts.UserAgent += " " + grpcUA
} else {
cc.dopts.copts.UserAgent = grpcUA
}
2017-01-26 15:51:44 +00:00
if cc.dopts.timeout > 0 {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, cc.dopts.timeout)
defer cancel()
}
defer func() {
select {
case <-ctx.Done():
conn, err = nil, ctx.Err()
default:
}
if err != nil {
cc.Close()
}
}()
2017-09-30 16:47:47 +00:00
scSet := false
2017-01-26 15:51:44 +00:00
if cc.dopts.scChan != nil {
2017-09-30 16:47:47 +00:00
// Try to get an initial service config.
2017-01-26 15:51:44 +00:00
select {
case sc, ok := <-cc.dopts.scChan:
if ok {
cc.sc = sc
2017-09-30 16:47:47 +00:00
scSet = true
2017-01-26 15:51:44 +00:00
}
2017-09-30 16:47:47 +00:00
default:
2017-01-26 15:51:44 +00:00
}
}
// Set defaults.
if cc.dopts.codec == nil {
cc.dopts.codec = protoCodec{}
}
if cc.dopts.bs == nil {
cc.dopts.bs = DefaultBackoffConfig
}
creds := cc.dopts.copts.TransportCredentials
if creds != nil && creds.Info().ServerName != "" {
cc.authority = creds.Info().ServerName
2017-09-30 16:47:47 +00:00
} else if cc.dopts.insecure && cc.dopts.copts.Authority != "" {
cc.authority = cc.dopts.copts.Authority
2017-01-26 15:51:44 +00:00
} else {
2017-09-30 16:47:47 +00:00
cc.authority = target
}
2017-10-06 15:29:20 +00:00
waitC := make(chan error, 1)
go func() {
defer close(waitC)
if cc.dopts.balancer == nil && cc.sc.LB != nil {
cc.dopts.balancer = cc.sc.LB
2017-09-30 16:47:47 +00:00
}
2017-10-06 15:29:20 +00:00
if cc.dopts.balancer != nil {
var credsClone credentials.TransportCredentials
if creds != nil {
credsClone = creds.Clone()
}
config := BalancerConfig{
DialCreds: credsClone,
Dialer: cc.dopts.copts.Dialer,
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
if err := cc.dopts.balancer.Start(target, config); err != nil {
2017-01-26 15:51:44 +00:00
waitC <- err
return
}
2017-10-06 15:29:20 +00:00
ch := cc.dopts.balancer.Notify()
if ch != nil {
if cc.dopts.block {
doneChan := make(chan struct{})
go cc.lbWatcher(doneChan)
<-doneChan
} else {
go cc.lbWatcher(nil)
}
return
2017-09-30 16:47:47 +00:00
}
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
// No balancer, or no resolver within the balancer. Connect directly.
if err := cc.resetAddrConn([]Address{{Addr: target}}, cc.dopts.block, nil); err != nil {
waitC <- err
return
}
}()
select {
case <-ctx.Done():
return nil, ctx.Err()
case err := <-waitC:
if err != nil {
return nil, err
}
2017-09-30 16:47:47 +00:00
}
if cc.dopts.scChan != nil && !scSet {
// Blocking wait for the initial service config.
select {
case sc, ok := <-cc.dopts.scChan:
if ok {
cc.sc = sc
}
case <-ctx.Done():
return nil, ctx.Err()
2017-01-26 15:51:44 +00:00
}
}
2017-09-30 16:47:47 +00:00
if cc.dopts.scChan != nil {
go cc.scWatcher()
}
2017-01-26 15:51:44 +00:00
return cc, nil
}
2017-09-30 16:47:47 +00:00
// connectivityStateEvaluator gets updated by addrConns when their
// states transition, based on which it evaluates the state of
// ClientConn.
// Note: This code will eventually sit in the balancer in the new design.
type connectivityStateEvaluator struct {
csMgr *connectivityStateManager
mu sync.Mutex
numReady uint64 // Number of addrConns in ready state.
numConnecting uint64 // Number of addrConns in connecting state.
numTransientFailure uint64 // Number of addrConns in transientFailure.
}
2017-01-26 15:51:44 +00:00
2017-09-30 16:47:47 +00:00
// recordTransition records state change happening in every addrConn and based on
// that it evaluates what state the ClientConn is in.
// It can only transition between connectivity.Ready, connectivity.Connecting and connectivity.TransientFailure. Other states,
2017-10-06 15:29:20 +00:00
// Idle and connectivity.Shutdown are transitioned into by ClientConn; in the begining of the connection
2017-09-30 16:47:47 +00:00
// before any addrConn is created ClientConn is in idle state. In the end when ClientConn
// closes it is in connectivity.Shutdown state.
// TODO Note that in later releases, a ClientConn with no activity will be put into an Idle state.
func (cse *connectivityStateEvaluator) recordTransition(oldState, newState connectivity.State) {
cse.mu.Lock()
defer cse.mu.Unlock()
// Update counters.
for idx, state := range []connectivity.State{oldState, newState} {
updateVal := 2*uint64(idx) - 1 // -1 for oldState and +1 for new.
switch state {
case connectivity.Ready:
cse.numReady += updateVal
case connectivity.Connecting:
cse.numConnecting += updateVal
case connectivity.TransientFailure:
cse.numTransientFailure += updateVal
}
}
2017-01-26 15:51:44 +00:00
2017-09-30 16:47:47 +00:00
// Evaluate.
if cse.numReady > 0 {
cse.csMgr.updateState(connectivity.Ready)
return
}
if cse.numConnecting > 0 {
cse.csMgr.updateState(connectivity.Connecting)
return
2017-01-26 15:51:44 +00:00
}
2017-09-30 16:47:47 +00:00
cse.csMgr.updateState(connectivity.TransientFailure)
}
// connectivityStateManager keeps the connectivity.State of ClientConn.
// This struct will eventually be exported so the balancers can access it.
type connectivityStateManager struct {
mu sync.Mutex
state connectivity.State
notifyChan chan struct{}
}
// updateState updates the connectivity.State of ClientConn.
// If there's a change it notifies goroutines waiting on state change to
// happen.
func (csm *connectivityStateManager) updateState(state connectivity.State) {
csm.mu.Lock()
defer csm.mu.Unlock()
if csm.state == connectivity.Shutdown {
return
}
if csm.state == state {
return
}
csm.state = state
if csm.notifyChan != nil {
// There are other goroutines waiting on this channel.
close(csm.notifyChan)
csm.notifyChan = nil
}
}
func (csm *connectivityStateManager) getState() connectivity.State {
csm.mu.Lock()
defer csm.mu.Unlock()
return csm.state
}
func (csm *connectivityStateManager) getNotifyChan() <-chan struct{} {
csm.mu.Lock()
defer csm.mu.Unlock()
if csm.notifyChan == nil {
csm.notifyChan = make(chan struct{})
}
return csm.notifyChan
2017-01-26 15:51:44 +00:00
}
// ClientConn represents a client connection to an RPC server.
type ClientConn struct {
ctx context.Context
cancel context.CancelFunc
target string
authority string
dopts dialOptions
2017-09-30 16:47:47 +00:00
csMgr *connectivityStateManager
csEvltr *connectivityStateEvaluator // This will eventually be part of balancer.
2017-01-26 15:51:44 +00:00
mu sync.RWMutex
sc ServiceConfig
2017-10-06 15:29:20 +00:00
conns map[Address]*addrConn
2017-09-30 16:47:47 +00:00
// Keepalive parameter can be updated if a GoAway is received.
mkp keepalive.ClientParameters
2017-01-26 15:51:44 +00:00
}
2017-09-30 16:47:47 +00:00
// WaitForStateChange waits until the connectivity.State of ClientConn changes from sourceState or
// ctx expires. A true value is returned in former case and false in latter.
// This is an EXPERIMENTAL API.
func (cc *ClientConn) WaitForStateChange(ctx context.Context, sourceState connectivity.State) bool {
ch := cc.csMgr.getNotifyChan()
if cc.csMgr.getState() != sourceState {
return true
}
select {
case <-ctx.Done():
return false
case <-ch:
return true
2017-01-26 15:51:44 +00:00
}
}
2017-09-30 16:47:47 +00:00
// GetState returns the connectivity.State of ClientConn.
// This is an EXPERIMENTAL API.
func (cc *ClientConn) GetState() connectivity.State {
return cc.csMgr.getState()
}
2017-10-06 15:29:20 +00:00
// lbWatcher watches the Notify channel of the balancer in cc and manages
// connections accordingly. If doneChan is not nil, it is closed after the
// first successfull connection is made.
func (cc *ClientConn) lbWatcher(doneChan chan struct{}) {
defer func() {
// In case channel from cc.dopts.balancer.Notify() gets closed before a
// successful connection gets established, don't forget to notify the
// caller.
if doneChan != nil {
close(doneChan)
}
}()
_, isPickFirst := cc.dopts.balancer.(*pickFirst)
for addrs := range cc.dopts.balancer.Notify() {
if isPickFirst {
if len(addrs) == 0 {
// No address can be connected, should teardown current addrconn if exists
cc.mu.Lock()
if len(cc.conns) != 0 {
cc.pickFirstAddrConnTearDown()
}
cc.mu.Unlock()
} else {
cc.resetAddrConn(addrs, true, nil)
if doneChan != nil {
close(doneChan)
doneChan = nil
}
}
} else {
// Not pickFirst, create a new addrConn for each address.
var (
add []Address // Addresses need to setup connections.
del []*addrConn // Connections need to tear down.
)
cc.mu.Lock()
for _, a := range addrs {
if _, ok := cc.conns[a]; !ok {
add = append(add, a)
}
}
for k, c := range cc.conns {
var keep bool
for _, a := range addrs {
if k == a {
keep = true
break
}
}
if !keep {
del = append(del, c)
delete(cc.conns, k)
}
}
cc.mu.Unlock()
for _, a := range add {
var err error
if doneChan != nil {
err = cc.resetAddrConn([]Address{a}, true, nil)
if err == nil {
close(doneChan)
doneChan = nil
}
} else {
err = cc.resetAddrConn([]Address{a}, false, nil)
}
if err != nil {
grpclog.Warningf("Error creating connection to %v. Err: %v", a, err)
}
}
for _, c := range del {
c.tearDown(errConnDrain)
}
}
}
}
2017-01-26 15:51:44 +00:00
func (cc *ClientConn) scWatcher() {
for {
select {
case sc, ok := <-cc.dopts.scChan:
if !ok {
return
}
cc.mu.Lock()
// TODO: load balance policy runtime change is ignored.
// We may revist this decision in the future.
cc.sc = sc
cc.mu.Unlock()
case <-cc.ctx.Done():
return
}
}
}
2017-10-06 15:29:20 +00:00
// pickFirstUpdateAddresses checks whether current address in the updating list, Update the list if true.
// It is only used when the balancer is pick first.
func (cc *ClientConn) pickFirstUpdateAddresses(addrs []Address) bool {
if len(cc.conns) == 0 {
// No addrconn. Should go resetting addrconn.
return false
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
var currentAc *addrConn
for _, currentAc = range cc.conns {
break
2017-09-30 16:47:47 +00:00
}
2017-10-06 15:29:20 +00:00
var addrInNewSlice bool
for _, addr := range addrs {
if strings.Compare(addr.Addr, currentAc.curAddr.Addr) == 0 {
addrInNewSlice = true
break
}
}
if addrInNewSlice {
cc.conns = make(map[Address]*addrConn)
for _, addr := range addrs {
cc.conns[addr] = currentAc
}
currentAc.addrs = addrs
return true
}
return false
2017-09-30 16:47:47 +00:00
}
2017-10-06 15:29:20 +00:00
// pickFirstAddrConnTearDown() should be called after lock.
func (cc *ClientConn) pickFirstAddrConnTearDown() {
if len(cc.conns) == 0 {
2017-09-30 16:47:47 +00:00
return
}
2017-10-06 15:29:20 +00:00
var currentAc *addrConn
for _, currentAc = range cc.conns {
break
}
for k := range cc.conns {
delete(cc.conns, k)
}
currentAc.tearDown(errConnDrain)
2017-09-30 16:47:47 +00:00
}
2017-10-06 15:29:20 +00:00
// resetAddrConn creates an addrConn for addr and adds it to cc.conns.
// If there is an old addrConn for addr, it will be torn down, using tearDownErr as the reason.
// If tearDownErr is nil, errConnDrain will be used instead.
//
// We should never need to replace an addrConn with a new one. This function is only used
// as newAddrConn to create new addrConn.
// TODO rename this function and clean up the code.
func (cc *ClientConn) resetAddrConn(addrs []Address, block bool, tearDownErr error) error {
// if current transport in addrs, just change lists to update order and new addresses
// not work for roundrobin
cc.mu.Lock()
if _, isPickFirst := cc.dopts.balancer.(*pickFirst); isPickFirst {
// If Current address in use in the updating list, just update the list.
// Otherwise, teardown current addrconn and create a new one.
if cc.pickFirstUpdateAddresses(addrs) {
cc.mu.Unlock()
return nil
}
cc.pickFirstAddrConnTearDown()
2017-09-30 16:47:47 +00:00
}
2017-10-06 15:29:20 +00:00
cc.mu.Unlock()
2017-09-30 16:47:47 +00:00
2017-10-06 15:29:20 +00:00
ac := &addrConn{
cc: cc,
addrs: addrs,
dopts: cc.dopts,
}
ac.ctx, ac.cancel = context.WithCancel(cc.ctx)
ac.csEvltr = cc.csEvltr
2017-01-26 15:51:44 +00:00
if EnableTracing {
2017-09-30 16:47:47 +00:00
ac.events = trace.NewEventLog("grpc.ClientConn", ac.addrs[0].Addr)
2017-01-26 15:51:44 +00:00
}
if !ac.dopts.insecure {
if ac.dopts.copts.TransportCredentials == nil {
return errNoTransportSecurity
}
} else {
if ac.dopts.copts.TransportCredentials != nil {
return errCredentialsConflict
}
for _, cd := range ac.dopts.copts.PerRPCCredentials {
if cd.RequireTransportSecurity() {
return errTransportCredentialsMissing
}
}
}
2017-10-06 15:29:20 +00:00
// Track ac in cc. This needs to be done before any getTransport(...) is called.
cc.mu.Lock()
if cc.conns == nil {
cc.mu.Unlock()
return ErrClientConnClosing
}
stale := cc.conns[ac.addrs[0]]
for _, a := range ac.addrs {
cc.conns[a] = ac
}
cc.mu.Unlock()
if stale != nil {
// There is an addrConn alive on ac.addr already. This could be due to
// a buggy Balancer that reports duplicated Addresses.
if tearDownErr == nil {
// tearDownErr is nil if resetAddrConn is called by
// 1) Dial
// 2) lbWatcher
// In both cases, the stale ac should drain, not close.
stale.tearDown(errConnDrain)
} else {
stale.tearDown(tearDownErr)
}
}
2017-09-30 16:47:47 +00:00
if block {
2017-01-26 15:51:44 +00:00
if err := ac.resetTransport(false); err != nil {
if err != errConnClosing {
2017-10-06 15:29:20 +00:00
// Tear down ac and delete it from cc.conns.
cc.mu.Lock()
delete(cc.conns, ac.addrs[0])
cc.mu.Unlock()
2017-01-26 15:51:44 +00:00
ac.tearDown(err)
}
if e, ok := err.(transport.ConnectionError); ok && !e.Temporary() {
return e.Origin()
}
return err
}
// Start to monitor the error status of transport.
go ac.transportMonitor()
} else {
// Start a goroutine connecting to the server asynchronously.
go func() {
if err := ac.resetTransport(false); err != nil {
2017-09-30 16:47:47 +00:00
grpclog.Warningf("Failed to dial %s: %v; please retry.", ac.addrs[0].Addr, err)
2017-01-26 15:51:44 +00:00
if err != errConnClosing {
// Keep this ac in cc.conns, to get the reason it's torn down.
ac.tearDown(err)
}
return
}
ac.transportMonitor()
}()
}
return nil
}
2017-09-30 16:47:47 +00:00
// GetMethodConfig gets the method config of the input method.
// If there's an exact match for input method (i.e. /service/method), we return
// the corresponding MethodConfig.
// If there isn't an exact match for the input method, we look for the default config
// under the service (i.e /service/). If there is a default MethodConfig for
// the serivce, we return it.
// Otherwise, we return an empty MethodConfig.
func (cc *ClientConn) GetMethodConfig(method string) MethodConfig {
// TODO: Avoid the locking here.
2017-01-26 15:51:44 +00:00
cc.mu.RLock()
defer cc.mu.RUnlock()
2017-09-30 16:47:47 +00:00
m, ok := cc.sc.Methods[method]
if !ok {
i := strings.LastIndex(method, "/")
m, _ = cc.sc.Methods[method[:i+1]]
}
return m
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
func (cc *ClientConn) getTransport(ctx context.Context, opts BalancerGetOptions) (transport.ClientTransport, func(), error) {
2017-01-26 15:51:44 +00:00
var (
ac *addrConn
2017-10-06 15:29:20 +00:00
ok bool
put func()
2017-01-26 15:51:44 +00:00
)
2017-10-06 15:29:20 +00:00
if cc.dopts.balancer == nil {
2017-01-26 15:51:44 +00:00
// If balancer is nil, there should be only one addrConn available.
cc.mu.RLock()
if cc.conns == nil {
cc.mu.RUnlock()
return nil, nil, toRPCErr(ErrClientConnClosing)
}
2017-10-06 15:29:20 +00:00
for _, ac = range cc.conns {
2017-01-26 15:51:44 +00:00
// Break after the first iteration to get the first addrConn.
2017-10-06 15:29:20 +00:00
ok = true
2017-01-26 15:51:44 +00:00
break
}
cc.mu.RUnlock()
} else {
var (
2017-10-06 15:29:20 +00:00
addr Address
err error
2017-01-26 15:51:44 +00:00
)
2017-10-06 15:29:20 +00:00
addr, put, err = cc.dopts.balancer.Get(ctx, opts)
2017-01-26 15:51:44 +00:00
if err != nil {
return nil, nil, toRPCErr(err)
}
2017-10-06 15:29:20 +00:00
cc.mu.RLock()
if cc.conns == nil {
cc.mu.RUnlock()
return nil, nil, toRPCErr(ErrClientConnClosing)
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
ac, ok = cc.conns[addr]
cc.mu.RUnlock()
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
if !ok {
if put != nil {
updateRPCInfoInContext(ctx, rpcInfo{bytesSent: false, bytesReceived: false})
put()
}
2017-01-26 15:51:44 +00:00
return nil, nil, errConnClosing
}
2017-10-06 15:29:20 +00:00
t, err := ac.wait(ctx, cc.dopts.balancer != nil, !opts.BlockingWait)
2017-01-26 15:51:44 +00:00
if err != nil {
if put != nil {
2017-09-30 16:47:47 +00:00
updateRPCInfoInContext(ctx, rpcInfo{bytesSent: false, bytesReceived: false})
2017-10-06 15:29:20 +00:00
put()
2017-01-26 15:51:44 +00:00
}
return nil, nil, err
}
return t, put, nil
}
// Close tears down the ClientConn and all underlying connections.
func (cc *ClientConn) Close() error {
cc.cancel()
cc.mu.Lock()
if cc.conns == nil {
cc.mu.Unlock()
return ErrClientConnClosing
}
conns := cc.conns
cc.conns = nil
2017-09-30 16:47:47 +00:00
cc.csMgr.updateState(connectivity.Shutdown)
2017-01-26 15:51:44 +00:00
cc.mu.Unlock()
2017-10-06 15:29:20 +00:00
if cc.dopts.balancer != nil {
cc.dopts.balancer.Close()
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
for _, ac := range conns {
2017-01-26 15:51:44 +00:00
ac.tearDown(ErrClientConnClosing)
}
return nil
}
// addrConn is a network connection to a given address.
type addrConn struct {
ctx context.Context
cancel context.CancelFunc
2017-09-30 16:47:47 +00:00
cc *ClientConn
2017-10-06 15:29:20 +00:00
curAddr Address
addrs []Address
2017-09-30 16:47:47 +00:00
dopts dialOptions
events trace.EventLog
csEvltr *connectivityStateEvaluator
2017-01-26 15:51:44 +00:00
2017-09-30 16:47:47 +00:00
mu sync.Mutex
state connectivity.State
2017-10-06 15:29:20 +00:00
down func(error) // the handler called when a connection is down.
2017-01-26 15:51:44 +00:00
// ready is closed and becomes nil when a new transport is up or failed
// due to timeout.
ready chan struct{}
transport transport.ClientTransport
// The reason this addrConn is torn down.
tearDownErr error
}
2017-09-30 16:47:47 +00:00
// adjustParams updates parameters used to create transports upon
// receiving a GoAway.
func (ac *addrConn) adjustParams(r transport.GoAwayReason) {
switch r {
case transport.TooManyPings:
v := 2 * ac.dopts.copts.KeepaliveParams.Time
ac.cc.mu.Lock()
if v > ac.cc.mkp.Time {
ac.cc.mkp.Time = v
}
ac.cc.mu.Unlock()
}
}
2017-01-26 15:51:44 +00:00
// printf records an event in ac's event log, unless ac has been closed.
// REQUIRES ac.mu is held.
func (ac *addrConn) printf(format string, a ...interface{}) {
if ac.events != nil {
ac.events.Printf(format, a...)
}
}
// errorf records an error in ac's event log, unless ac has been closed.
// REQUIRES ac.mu is held.
func (ac *addrConn) errorf(format string, a ...interface{}) {
if ac.events != nil {
ac.events.Errorf(format, a...)
}
}
2017-09-30 16:47:47 +00:00
// resetTransport recreates a transport to the address for ac.
// For the old transport:
// - if drain is true, it will be gracefully closed.
// - otherwise, it will be closed.
func (ac *addrConn) resetTransport(drain bool) error {
2017-01-26 15:51:44 +00:00
ac.mu.Lock()
2017-09-30 16:47:47 +00:00
if ac.state == connectivity.Shutdown {
ac.mu.Unlock()
return errConnClosing
2017-01-26 15:51:44 +00:00
}
2017-10-06 15:29:20 +00:00
ac.printf("connecting")
if ac.down != nil {
ac.down(downErrorf(false, true, "%v", errNetworkIO))
ac.down = nil
}
2017-09-30 16:47:47 +00:00
oldState := ac.state
ac.state = connectivity.Connecting
ac.csEvltr.recordTransition(oldState, ac.state)
t := ac.transport
ac.transport = nil
ac.mu.Unlock()
if t != nil && !drain {
t.Close()
}
ac.cc.mu.RLock()
ac.dopts.copts.KeepaliveParams = ac.cc.mkp
ac.cc.mu.RUnlock()
2017-01-26 15:51:44 +00:00
for retries := 0; ; retries++ {
2017-10-06 15:29:20 +00:00
ac.mu.Lock()
2017-09-30 16:47:47 +00:00
sleepTime := ac.dopts.bs.backoff(retries)
timeout := minConnectTimeout
if timeout < time.Duration(int(sleepTime)/len(ac.addrs)) {
timeout = time.Duration(int(sleepTime) / len(ac.addrs))
}
connectTime := time.Now()
// copy ac.addrs in case of race
2017-10-06 15:29:20 +00:00
addrsIter := make([]Address, len(ac.addrs))
2017-09-30 16:47:47 +00:00
copy(addrsIter, ac.addrs)
2017-01-26 15:51:44 +00:00
ac.mu.Unlock()
2017-09-30 16:47:47 +00:00
for _, addr := range addrsIter {
ac.mu.Lock()
if ac.state == connectivity.Shutdown {
// ac.tearDown(...) has been invoked.
ac.mu.Unlock()
return errConnClosing
}
ac.mu.Unlock()
ctx, cancel := context.WithTimeout(ac.ctx, timeout)
sinfo := transport.TargetInfo{
Addr: addr.Addr,
Metadata: addr.Metadata,
}
newTransport, err := transport.NewClientTransport(ctx, sinfo, ac.dopts.copts)
// Don't call cancel in success path due to a race in Go 1.6:
// https://github.com/golang/go/issues/15078.
if err != nil {
cancel()
2017-01-26 15:51:44 +00:00
2017-09-30 16:47:47 +00:00
if e, ok := err.(transport.ConnectionError); ok && !e.Temporary() {
return err
}
grpclog.Warningf("grpc: addrConn.resetTransport failed to create client transport: %v; Reconnecting to %v", err, addr)
ac.mu.Lock()
if ac.state == connectivity.Shutdown {
// ac.tearDown(...) has been invoked.
ac.mu.Unlock()
return errConnClosing
}
2017-10-06 15:29:20 +00:00
ac.errorf("transient failure: %v", err)
oldState = ac.state
ac.state = connectivity.TransientFailure
ac.csEvltr.recordTransition(oldState, ac.state)
if ac.ready != nil {
close(ac.ready)
ac.ready = nil
}
2017-09-30 16:47:47 +00:00
ac.mu.Unlock()
continue
2017-01-26 15:51:44 +00:00
}
ac.mu.Lock()
2017-09-30 16:47:47 +00:00
ac.printf("ready")
if ac.state == connectivity.Shutdown {
2017-01-26 15:51:44 +00:00
// ac.tearDown(...) has been invoked.
ac.mu.Unlock()
2017-09-30 16:47:47 +00:00
newTransport.Close()
2017-01-26 15:51:44 +00:00
return errConnClosing
}
2017-09-30 16:47:47 +00:00
oldState = ac.state
ac.state = connectivity.Ready
ac.csEvltr.recordTransition(oldState, ac.state)
ac.transport = newTransport
2017-01-26 15:51:44 +00:00
if ac.ready != nil {
close(ac.ready)
ac.ready = nil
}
2017-10-06 15:29:20 +00:00
if ac.cc.dopts.balancer != nil {
ac.down = ac.cc.dopts.balancer.Up(addr)
}
ac.curAddr = addr
2017-01-26 15:51:44 +00:00
ac.mu.Unlock()
2017-09-30 16:47:47 +00:00
return nil
2017-01-26 15:51:44 +00:00
}
2017-09-30 16:47:47 +00:00
timer := time.NewTimer(sleepTime - time.Since(connectTime))
select {
case <-timer.C:
case <-ac.ctx.Done():
timer.Stop()
return ac.ctx.Err()
}
timer.Stop()
2017-01-26 15:51:44 +00:00
}
}
// Run in a goroutine to track the error in transport and create the
// new transport if an error happens. It returns when the channel is closing.
func (ac *addrConn) transportMonitor() {
for {
ac.mu.Lock()
t := ac.transport
ac.mu.Unlock()
select {
// This is needed to detect the teardown when
// the addrConn is idle (i.e., no RPC in flight).
case <-ac.ctx.Done():
select {
case <-t.Error():
t.Close()
default:
}
return
case <-t.GoAway():
2017-09-30 16:47:47 +00:00
ac.adjustParams(t.GetGoAwayReason())
// If GoAway happens without any network I/O error, the underlying transport
// will be gracefully closed, and a new transport will be created.
// (The transport will be closed when all the pending RPCs finished or failed.)
// If GoAway and some network I/O error happen concurrently, the underlying transport
// will be closed, and a new transport will be created.
var drain bool
2017-01-26 15:51:44 +00:00
select {
case <-t.Error():
default:
2017-09-30 16:47:47 +00:00
drain = true
}
if err := ac.resetTransport(drain); err != nil {
grpclog.Infof("get error from resetTransport %v, transportMonitor returning", err)
if err != errConnClosing {
// Keep this ac in cc.conns, to get the reason it's torn down.
ac.tearDown(err)
}
return
2017-01-26 15:51:44 +00:00
}
case <-t.Error():
select {
case <-ac.ctx.Done():
t.Close()
return
case <-t.GoAway():
2017-09-30 16:47:47 +00:00
ac.adjustParams(t.GetGoAwayReason())
2017-10-06 15:29:20 +00:00
if err := ac.resetTransport(false); err != nil {
grpclog.Infof("get error from resetTransport %v, transportMonitor returning", err)
if err != errConnClosing {
// Keep this ac in cc.conns, to get the reason it's torn down.
ac.tearDown(err)
}
return
}
2017-01-26 15:51:44 +00:00
default:
}
2017-10-06 15:29:20 +00:00
ac.mu.Lock()
if ac.state == connectivity.Shutdown {
// ac has been shutdown.
ac.mu.Unlock()
return
}
oldState := ac.state
ac.state = connectivity.TransientFailure
ac.csEvltr.recordTransition(oldState, ac.state)
ac.mu.Unlock()
2017-09-30 16:47:47 +00:00
if err := ac.resetTransport(false); err != nil {
grpclog.Infof("get error from resetTransport %v, transportMonitor returning", err)
2017-01-26 15:51:44 +00:00
ac.mu.Lock()
ac.printf("transport exiting: %v", err)
ac.mu.Unlock()
2017-09-30 16:47:47 +00:00
grpclog.Warningf("grpc: addrConn.transportMonitor exits due to: %v", err)
2017-01-26 15:51:44 +00:00
if err != errConnClosing {
// Keep this ac in cc.conns, to get the reason it's torn down.
ac.tearDown(err)
}
return
}
}
}
}
// wait blocks until i) the new transport is up or ii) ctx is done or iii) ac is closed or
2017-09-30 16:47:47 +00:00
// iv) transport is in connectivity.TransientFailure and there is a balancer/failfast is true.
2017-01-26 15:51:44 +00:00
func (ac *addrConn) wait(ctx context.Context, hasBalancer, failfast bool) (transport.ClientTransport, error) {
for {
ac.mu.Lock()
switch {
2017-09-30 16:47:47 +00:00
case ac.state == connectivity.Shutdown:
2017-01-26 15:51:44 +00:00
if failfast || !hasBalancer {
// RPC is failfast or balancer is nil. This RPC should fail with ac.tearDownErr.
err := ac.tearDownErr
ac.mu.Unlock()
return nil, err
}
ac.mu.Unlock()
return nil, errConnClosing
2017-09-30 16:47:47 +00:00
case ac.state == connectivity.Ready:
2017-01-26 15:51:44 +00:00
ct := ac.transport
ac.mu.Unlock()
return ct, nil
2017-09-30 16:47:47 +00:00
case ac.state == connectivity.TransientFailure:
2017-01-26 15:51:44 +00:00
if failfast || hasBalancer {
ac.mu.Unlock()
return nil, errConnUnavailable
}
}
ready := ac.ready
if ready == nil {
ready = make(chan struct{})
ac.ready = ready
}
ac.mu.Unlock()
select {
case <-ctx.Done():
return nil, toRPCErr(ctx.Err())
// Wait until the new transport is ready or failed.
case <-ready:
}
}
}
// tearDown starts to tear down the addrConn.
// TODO(zhaoq): Make this synchronous to avoid unbounded memory consumption in
// some edge cases (e.g., the caller opens and closes many addrConn's in a
// tight loop.
// tearDown doesn't remove ac from ac.cc.conns.
func (ac *addrConn) tearDown(err error) {
ac.cancel()
ac.mu.Lock()
2017-10-06 15:29:20 +00:00
ac.curAddr = Address{}
2017-01-26 15:51:44 +00:00
defer ac.mu.Unlock()
2017-10-06 15:29:20 +00:00
if ac.down != nil {
ac.down(downErrorf(false, false, "%v", err))
ac.down = nil
}
2017-01-26 15:51:44 +00:00
if err == errConnDrain && ac.transport != nil {
// GracefulClose(...) may be executed multiple times when
// i) receiving multiple GoAway frames from the server; or
// ii) there are concurrent name resolver/Balancer triggered
// address removal and GoAway.
ac.transport.GracefulClose()
}
2017-09-30 16:47:47 +00:00
if ac.state == connectivity.Shutdown {
2017-01-26 15:51:44 +00:00
return
}
2017-09-30 16:47:47 +00:00
oldState := ac.state
ac.state = connectivity.Shutdown
2017-01-26 15:51:44 +00:00
ac.tearDownErr = err
2017-09-30 16:47:47 +00:00
ac.csEvltr.recordTransition(oldState, ac.state)
2017-01-26 15:51:44 +00:00
if ac.events != nil {
ac.events.Finish()
ac.events = nil
}
if ac.ready != nil {
close(ac.ready)
ac.ready = nil
}
if ac.transport != nil && err != errConnDrain {
ac.transport.Close()
}
return
}