2019-11-07 19:05:39 +00:00
|
|
|
/*
|
|
|
|
*
|
|
|
|
* Copyright 2014 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 grpc
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"errors"
|
|
|
|
"fmt"
|
|
|
|
"io"
|
|
|
|
"math"
|
|
|
|
"net"
|
|
|
|
"net/http"
|
|
|
|
"reflect"
|
|
|
|
"runtime"
|
|
|
|
"strings"
|
|
|
|
"sync"
|
|
|
|
"sync/atomic"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"golang.org/x/net/trace"
|
|
|
|
|
|
|
|
"google.golang.org/grpc/codes"
|
|
|
|
"google.golang.org/grpc/credentials"
|
|
|
|
"google.golang.org/grpc/encoding"
|
|
|
|
"google.golang.org/grpc/encoding/proto"
|
|
|
|
"google.golang.org/grpc/grpclog"
|
2021-02-01 17:32:29 +00:00
|
|
|
"google.golang.org/grpc/internal"
|
2019-11-07 19:05:39 +00:00
|
|
|
"google.golang.org/grpc/internal/binarylog"
|
|
|
|
"google.golang.org/grpc/internal/channelz"
|
2020-06-25 20:42:41 +00:00
|
|
|
"google.golang.org/grpc/internal/grpcrand"
|
2019-11-07 19:05:39 +00:00
|
|
|
"google.golang.org/grpc/internal/grpcsync"
|
|
|
|
"google.golang.org/grpc/internal/transport"
|
|
|
|
"google.golang.org/grpc/keepalive"
|
|
|
|
"google.golang.org/grpc/metadata"
|
|
|
|
"google.golang.org/grpc/peer"
|
|
|
|
"google.golang.org/grpc/stats"
|
|
|
|
"google.golang.org/grpc/status"
|
|
|
|
"google.golang.org/grpc/tap"
|
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
|
|
|
defaultServerMaxReceiveMessageSize = 1024 * 1024 * 4
|
|
|
|
defaultServerMaxSendMessageSize = math.MaxInt32
|
2021-05-20 15:38:21 +00:00
|
|
|
|
|
|
|
// Server transports are tracked in a map which is keyed on listener
|
|
|
|
// address. For regular gRPC traffic, connections are accepted in Serve()
|
|
|
|
// through a call to Accept(), and we use the actual listener address as key
|
|
|
|
// when we add it to the map. But for connections received through
|
|
|
|
// ServeHTTP(), we do not have a listener and hence use this dummy value.
|
|
|
|
listenerAddressForServeHTTP = "listenerAddressForServeHTTP"
|
2019-11-07 19:05:39 +00:00
|
|
|
)
|
|
|
|
|
2021-02-01 17:32:29 +00:00
|
|
|
func init() {
|
|
|
|
internal.GetServerCredentials = func(srv *Server) credentials.TransportCredentials {
|
|
|
|
return srv.opts.creds
|
|
|
|
}
|
2021-05-20 15:38:21 +00:00
|
|
|
internal.DrainServerTransports = func(srv *Server, addr string) {
|
|
|
|
srv.drainServerTransports(addr)
|
|
|
|
}
|
2022-07-13 13:43:46 +00:00
|
|
|
internal.AddExtraServerOptions = func(opt ...ServerOption) {
|
|
|
|
extraServerOptions = opt
|
|
|
|
}
|
|
|
|
internal.ClearExtraServerOptions = func() {
|
|
|
|
extraServerOptions = nil
|
|
|
|
}
|
2021-02-01 17:32:29 +00:00
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
var statusOK = status.New(codes.OK, "")
|
2020-08-05 08:15:42 +00:00
|
|
|
var logger = grpclog.Component("core")
|
2019-11-07 19:05:39 +00:00
|
|
|
|
|
|
|
type methodHandler func(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor UnaryServerInterceptor) (interface{}, error)
|
|
|
|
|
|
|
|
// MethodDesc represents an RPC service's method specification.
|
|
|
|
type MethodDesc struct {
|
|
|
|
MethodName string
|
|
|
|
Handler methodHandler
|
|
|
|
}
|
|
|
|
|
|
|
|
// ServiceDesc represents an RPC service's specification.
|
|
|
|
type ServiceDesc struct {
|
|
|
|
ServiceName string
|
|
|
|
// The pointer to the service interface. Used to check whether the user
|
|
|
|
// provided implementation satisfies the interface requirements.
|
|
|
|
HandlerType interface{}
|
|
|
|
Methods []MethodDesc
|
|
|
|
Streams []StreamDesc
|
|
|
|
Metadata interface{}
|
|
|
|
}
|
|
|
|
|
2020-09-10 06:49:55 +00:00
|
|
|
// serviceInfo wraps information about a service. It is very similar to
|
|
|
|
// ServiceDesc and is constructed from it for internal purposes.
|
|
|
|
type serviceInfo struct {
|
|
|
|
// Contains the implementation for the methods in this service.
|
|
|
|
serviceImpl interface{}
|
|
|
|
methods map[string]*MethodDesc
|
|
|
|
streams map[string]*StreamDesc
|
|
|
|
mdata interface{}
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
|
2020-06-25 20:42:41 +00:00
|
|
|
type serverWorkerData struct {
|
|
|
|
st transport.ServerTransport
|
|
|
|
wg *sync.WaitGroup
|
|
|
|
stream *transport.Stream
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
// Server is a gRPC server to serve RPC requests.
|
|
|
|
type Server struct {
|
|
|
|
opts serverOptions
|
|
|
|
|
2021-05-20 15:38:21 +00:00
|
|
|
mu sync.Mutex // guards following
|
|
|
|
lis map[net.Listener]bool
|
|
|
|
// conns contains all active server transports. It is a map keyed on a
|
|
|
|
// listener address with the value being the set of active transports
|
|
|
|
// belonging to that listener.
|
|
|
|
conns map[string]map[transport.ServerTransport]bool
|
2020-09-10 06:49:55 +00:00
|
|
|
serve bool
|
|
|
|
drain bool
|
|
|
|
cv *sync.Cond // signaled when connections close for GracefulStop
|
|
|
|
services map[string]*serviceInfo // service name -> service info
|
|
|
|
events trace.EventLog
|
2019-11-07 19:05:39 +00:00
|
|
|
|
|
|
|
quit *grpcsync.Event
|
|
|
|
done *grpcsync.Event
|
|
|
|
channelzRemoveOnce sync.Once
|
|
|
|
serveWG sync.WaitGroup // counts active Serve goroutines for GracefulStop
|
|
|
|
|
2022-04-26 12:24:23 +00:00
|
|
|
channelzID *channelz.Identifier
|
2019-11-07 19:05:39 +00:00
|
|
|
czData *channelzData
|
2020-06-25 20:42:41 +00:00
|
|
|
|
|
|
|
serverWorkerChannels []chan *serverWorkerData
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type serverOptions struct {
|
|
|
|
creds credentials.TransportCredentials
|
|
|
|
codec baseCodec
|
|
|
|
cp Compressor
|
|
|
|
dc Decompressor
|
|
|
|
unaryInt UnaryServerInterceptor
|
|
|
|
streamInt StreamServerInterceptor
|
2020-03-12 16:11:27 +00:00
|
|
|
chainUnaryInts []UnaryServerInterceptor
|
|
|
|
chainStreamInts []StreamServerInterceptor
|
2019-11-07 19:05:39 +00:00
|
|
|
inTapHandle tap.ServerInHandle
|
2022-07-13 13:43:46 +00:00
|
|
|
statsHandlers []stats.Handler
|
2019-11-07 19:05:39 +00:00
|
|
|
maxConcurrentStreams uint32
|
|
|
|
maxReceiveMessageSize int
|
|
|
|
maxSendMessageSize int
|
|
|
|
unknownStreamDesc *StreamDesc
|
|
|
|
keepaliveParams keepalive.ServerParameters
|
|
|
|
keepalivePolicy keepalive.EnforcementPolicy
|
|
|
|
initialWindowSize int32
|
|
|
|
initialConnWindowSize int32
|
|
|
|
writeBufferSize int
|
|
|
|
readBufferSize int
|
|
|
|
connectionTimeout time.Duration
|
|
|
|
maxHeaderListSize *uint32
|
|
|
|
headerTableSize *uint32
|
2020-06-25 20:42:41 +00:00
|
|
|
numServerWorkers uint32
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
var defaultServerOptions = serverOptions{
|
|
|
|
maxReceiveMessageSize: defaultServerMaxReceiveMessageSize,
|
|
|
|
maxSendMessageSize: defaultServerMaxSendMessageSize,
|
|
|
|
connectionTimeout: 120 * time.Second,
|
|
|
|
writeBufferSize: defaultWriteBufSize,
|
|
|
|
readBufferSize: defaultReadBufSize,
|
|
|
|
}
|
2022-07-13 13:43:46 +00:00
|
|
|
var extraServerOptions []ServerOption
|
2019-11-07 19:05:39 +00:00
|
|
|
|
|
|
|
// A ServerOption sets options such as credentials, codec and keepalive parameters, etc.
|
|
|
|
type ServerOption interface {
|
|
|
|
apply(*serverOptions)
|
|
|
|
}
|
|
|
|
|
|
|
|
// EmptyServerOption does not alter the server configuration. It can be embedded
|
|
|
|
// in another structure to build custom server options.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This type is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
type EmptyServerOption struct{}
|
|
|
|
|
|
|
|
func (EmptyServerOption) apply(*serverOptions) {}
|
|
|
|
|
|
|
|
// funcServerOption wraps a function that modifies serverOptions into an
|
|
|
|
// implementation of the ServerOption interface.
|
|
|
|
type funcServerOption struct {
|
|
|
|
f func(*serverOptions)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (fdo *funcServerOption) apply(do *serverOptions) {
|
|
|
|
fdo.f(do)
|
|
|
|
}
|
|
|
|
|
|
|
|
func newFuncServerOption(f func(*serverOptions)) *funcServerOption {
|
|
|
|
return &funcServerOption{
|
|
|
|
f: f,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// WriteBufferSize determines how much data can be batched before doing a write on the wire.
|
|
|
|
// The corresponding memory allocation for this buffer will be twice the size to keep syscalls low.
|
|
|
|
// The default value for this buffer is 32KB.
|
|
|
|
// Zero will disable the write buffer such that each write will be on underlying connection.
|
|
|
|
// Note: A Send call may not directly translate to a write.
|
|
|
|
func WriteBufferSize(s int) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.writeBufferSize = s
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// ReadBufferSize lets you set the size of read buffer, this determines how much data can be read at most
|
|
|
|
// for one read syscall.
|
|
|
|
// The default value for this buffer is 32KB.
|
|
|
|
// Zero will disable read buffer for a connection so data framer can access the underlying
|
|
|
|
// conn directly.
|
|
|
|
func ReadBufferSize(s int) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.readBufferSize = s
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// InitialWindowSize returns a ServerOption that sets window size for stream.
|
|
|
|
// The lower bound for window size is 64K and any value smaller than that will be ignored.
|
|
|
|
func InitialWindowSize(s int32) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.initialWindowSize = s
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// InitialConnWindowSize returns a ServerOption that sets window size for a connection.
|
|
|
|
// The lower bound for window size is 64K and any value smaller than that will be ignored.
|
|
|
|
func InitialConnWindowSize(s int32) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.initialConnWindowSize = s
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// KeepaliveParams returns a ServerOption that sets keepalive and max-age parameters for the server.
|
|
|
|
func KeepaliveParams(kp keepalive.ServerParameters) ServerOption {
|
|
|
|
if kp.Time > 0 && kp.Time < time.Second {
|
2020-08-05 08:15:42 +00:00
|
|
|
logger.Warning("Adjusting keepalive ping interval to minimum period of 1s")
|
2019-11-07 19:05:39 +00:00
|
|
|
kp.Time = time.Second
|
|
|
|
}
|
|
|
|
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.keepaliveParams = kp
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// KeepaliveEnforcementPolicy returns a ServerOption that sets keepalive enforcement policy for the server.
|
|
|
|
func KeepaliveEnforcementPolicy(kep keepalive.EnforcementPolicy) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.keepalivePolicy = kep
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// CustomCodec returns a ServerOption that sets a codec for message marshaling and unmarshaling.
|
|
|
|
//
|
|
|
|
// This will override any lookups by content-subtype for Codecs registered with RegisterCodec.
|
2020-08-05 08:15:42 +00:00
|
|
|
//
|
|
|
|
// Deprecated: register codecs using encoding.RegisterCodec. The server will
|
|
|
|
// automatically use registered codecs based on the incoming requests' headers.
|
|
|
|
// See also
|
|
|
|
// https://github.com/grpc/grpc-go/blob/master/Documentation/encoding.md#using-a-codec.
|
|
|
|
// Will be supported throughout 1.x.
|
2019-11-07 19:05:39 +00:00
|
|
|
func CustomCodec(codec Codec) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.codec = codec
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2021-05-20 15:38:21 +00:00
|
|
|
// ForceServerCodec returns a ServerOption that sets a codec for message
|
|
|
|
// marshaling and unmarshaling.
|
|
|
|
//
|
|
|
|
// This will override any lookups by content-subtype for Codecs registered
|
|
|
|
// with RegisterCodec.
|
|
|
|
//
|
|
|
|
// See Content-Type on
|
|
|
|
// https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests for
|
|
|
|
// more details. Also see the documentation on RegisterCodec and
|
|
|
|
// CallContentSubtype for more details on the interaction between encoding.Codec
|
|
|
|
// and content-subtype.
|
|
|
|
//
|
|
|
|
// This function is provided for advanced users; prefer to register codecs
|
|
|
|
// using encoding.RegisterCodec.
|
|
|
|
// The server will automatically use registered codecs based on the incoming
|
|
|
|
// requests' headers. See also
|
|
|
|
// https://github.com/grpc/grpc-go/blob/master/Documentation/encoding.md#using-a-codec.
|
|
|
|
// Will be supported throughout 1.x.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2021-05-20 15:38:21 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
|
|
|
func ForceServerCodec(codec encoding.Codec) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.codec = codec
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
// RPCCompressor returns a ServerOption that sets a compressor for outbound
|
|
|
|
// messages. For backward compatibility, all outbound messages will be sent
|
|
|
|
// using this compressor, regardless of incoming message compression. By
|
|
|
|
// default, server messages will be sent using the same compressor with which
|
|
|
|
// request messages were sent.
|
|
|
|
//
|
2020-08-05 08:15:42 +00:00
|
|
|
// Deprecated: use encoding.RegisterCompressor instead. Will be supported
|
|
|
|
// throughout 1.x.
|
2019-11-07 19:05:39 +00:00
|
|
|
func RPCCompressor(cp Compressor) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.cp = cp
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// RPCDecompressor returns a ServerOption that sets a decompressor for inbound
|
|
|
|
// messages. It has higher priority than decompressors registered via
|
|
|
|
// encoding.RegisterCompressor.
|
|
|
|
//
|
2020-08-05 08:15:42 +00:00
|
|
|
// Deprecated: use encoding.RegisterCompressor instead. Will be supported
|
|
|
|
// throughout 1.x.
|
2019-11-07 19:05:39 +00:00
|
|
|
func RPCDecompressor(dc Decompressor) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.dc = dc
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// MaxMsgSize returns a ServerOption to set the max message size in bytes the server can receive.
|
|
|
|
// If this is not set, gRPC uses the default limit.
|
|
|
|
//
|
2020-08-05 08:15:42 +00:00
|
|
|
// Deprecated: use MaxRecvMsgSize instead. Will be supported throughout 1.x.
|
2019-11-07 19:05:39 +00:00
|
|
|
func MaxMsgSize(m int) ServerOption {
|
|
|
|
return MaxRecvMsgSize(m)
|
|
|
|
}
|
|
|
|
|
|
|
|
// MaxRecvMsgSize returns a ServerOption to set the max message size in bytes the server can receive.
|
|
|
|
// If this is not set, gRPC uses the default 4MB.
|
|
|
|
func MaxRecvMsgSize(m int) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.maxReceiveMessageSize = m
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// MaxSendMsgSize returns a ServerOption to set the max message size in bytes the server can send.
|
|
|
|
// If this is not set, gRPC uses the default `math.MaxInt32`.
|
|
|
|
func MaxSendMsgSize(m int) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.maxSendMessageSize = m
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// MaxConcurrentStreams returns a ServerOption that will apply a limit on the number
|
|
|
|
// of concurrent streams to each ServerTransport.
|
|
|
|
func MaxConcurrentStreams(n uint32) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.maxConcurrentStreams = n
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// Creds returns a ServerOption that sets credentials for server connections.
|
|
|
|
func Creds(c credentials.TransportCredentials) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.creds = c
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// UnaryInterceptor returns a ServerOption that sets the UnaryServerInterceptor for the
|
|
|
|
// server. Only one unary interceptor can be installed. The construction of multiple
|
|
|
|
// interceptors (e.g., chaining) can be implemented at the caller.
|
|
|
|
func UnaryInterceptor(i UnaryServerInterceptor) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
if o.unaryInt != nil {
|
|
|
|
panic("The unary server interceptor was already set and may not be reset.")
|
|
|
|
}
|
|
|
|
o.unaryInt = i
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-03-12 16:11:27 +00:00
|
|
|
// ChainUnaryInterceptor returns a ServerOption that specifies the chained interceptor
|
|
|
|
// for unary RPCs. The first interceptor will be the outer most,
|
|
|
|
// while the last interceptor will be the inner most wrapper around the real call.
|
|
|
|
// All unary interceptors added by this method will be chained.
|
|
|
|
func ChainUnaryInterceptor(interceptors ...UnaryServerInterceptor) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.chainUnaryInts = append(o.chainUnaryInts, interceptors...)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
// StreamInterceptor returns a ServerOption that sets the StreamServerInterceptor for the
|
|
|
|
// server. Only one stream interceptor can be installed.
|
|
|
|
func StreamInterceptor(i StreamServerInterceptor) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
if o.streamInt != nil {
|
|
|
|
panic("The stream server interceptor was already set and may not be reset.")
|
|
|
|
}
|
|
|
|
o.streamInt = i
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-03-12 16:11:27 +00:00
|
|
|
// ChainStreamInterceptor returns a ServerOption that specifies the chained interceptor
|
2020-06-25 20:42:41 +00:00
|
|
|
// for streaming RPCs. The first interceptor will be the outer most,
|
2020-03-12 16:11:27 +00:00
|
|
|
// while the last interceptor will be the inner most wrapper around the real call.
|
|
|
|
// All stream interceptors added by this method will be chained.
|
|
|
|
func ChainStreamInterceptor(interceptors ...StreamServerInterceptor) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.chainStreamInts = append(o.chainStreamInts, interceptors...)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
// InTapHandle returns a ServerOption that sets the tap handle for all the server
|
|
|
|
// transport to be created. Only one can be installed.
|
2021-05-20 15:38:21 +00:00
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2021-05-20 15:38:21 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
func InTapHandle(h tap.ServerInHandle) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
if o.inTapHandle != nil {
|
|
|
|
panic("The tap handle was already set and may not be reset.")
|
|
|
|
}
|
|
|
|
o.inTapHandle = h
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// StatsHandler returns a ServerOption that sets the stats handler for the server.
|
|
|
|
func StatsHandler(h stats.Handler) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
2022-08-30 06:45:26 +00:00
|
|
|
if h == nil {
|
|
|
|
logger.Error("ignoring nil parameter in grpc.StatsHandler ServerOption")
|
|
|
|
// Do not allow a nil stats handler, which would otherwise cause
|
|
|
|
// panics.
|
|
|
|
return
|
|
|
|
}
|
2022-07-13 13:43:46 +00:00
|
|
|
o.statsHandlers = append(o.statsHandlers, h)
|
2019-11-07 19:05:39 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// UnknownServiceHandler returns a ServerOption that allows for adding a custom
|
|
|
|
// unknown service handler. The provided method is a bidi-streaming RPC service
|
|
|
|
// handler that will be invoked instead of returning the "unimplemented" gRPC
|
|
|
|
// error whenever a request is received for an unregistered service or method.
|
2019-12-26 17:42:48 +00:00
|
|
|
// The handling function and stream interceptor (if set) have full access to
|
|
|
|
// the ServerStream, including its Context.
|
2019-11-07 19:05:39 +00:00
|
|
|
func UnknownServiceHandler(streamHandler StreamHandler) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.unknownStreamDesc = &StreamDesc{
|
|
|
|
StreamName: "unknown_service_handler",
|
|
|
|
Handler: streamHandler,
|
|
|
|
// We need to assume that the users of the streamHandler will want to use both.
|
|
|
|
ClientStreams: true,
|
|
|
|
ServerStreams: true,
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// ConnectionTimeout returns a ServerOption that sets the timeout for
|
|
|
|
// connection establishment (up to and including HTTP/2 handshaking) for all
|
|
|
|
// new connections. If this is not set, the default is 120 seconds. A zero or
|
|
|
|
// negative value will result in an immediate timeout.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
func ConnectionTimeout(d time.Duration) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.connectionTimeout = d
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// MaxHeaderListSize returns a ServerOption that sets the max (uncompressed) size
|
|
|
|
// of header list that the server is prepared to accept.
|
|
|
|
func MaxHeaderListSize(s uint32) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.maxHeaderListSize = &s
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// HeaderTableSize returns a ServerOption that sets the size of dynamic
|
|
|
|
// header table for stream.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
func HeaderTableSize(s uint32) ServerOption {
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.headerTableSize = &s
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-06-25 20:42:41 +00:00
|
|
|
// NumStreamWorkers returns a ServerOption that sets the number of worker
|
|
|
|
// goroutines that should be used to process incoming streams. Setting this to
|
|
|
|
// zero (default) will disable workers and spawn a new goroutine for each
|
|
|
|
// stream.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2020-06-25 20:42:41 +00:00
|
|
|
func NumStreamWorkers(numServerWorkers uint32) ServerOption {
|
|
|
|
// TODO: If/when this API gets stabilized (i.e. stream workers become the
|
|
|
|
// only way streams are processed), change the behavior of the zero value to
|
|
|
|
// a sane default. Preliminary experiments suggest that a value equal to the
|
|
|
|
// number of CPUs available is most performant; requires thorough testing.
|
|
|
|
return newFuncServerOption(func(o *serverOptions) {
|
|
|
|
o.numServerWorkers = numServerWorkers
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// serverWorkerResetThreshold defines how often the stack must be reset. Every
|
|
|
|
// N requests, by spawning a new goroutine in its place, a worker can reset its
|
|
|
|
// stack so that large stacks don't live in memory forever. 2^16 should allow
|
|
|
|
// each goroutine stack to live for at least a few seconds in a typical
|
|
|
|
// workload (assuming a QPS of a few thousand requests/sec).
|
|
|
|
const serverWorkerResetThreshold = 1 << 16
|
|
|
|
|
|
|
|
// serverWorkers blocks on a *transport.Stream channel forever and waits for
|
|
|
|
// data to be fed by serveStreams. This allows different requests to be
|
|
|
|
// processed by the same goroutine, removing the need for expensive stack
|
|
|
|
// re-allocations (see the runtime.morestack problem [1]).
|
|
|
|
//
|
|
|
|
// [1] https://github.com/golang/go/issues/18138
|
|
|
|
func (s *Server) serverWorker(ch chan *serverWorkerData) {
|
|
|
|
// To make sure all server workers don't reset at the same time, choose a
|
|
|
|
// random number of iterations before resetting.
|
|
|
|
threshold := serverWorkerResetThreshold + grpcrand.Intn(serverWorkerResetThreshold)
|
|
|
|
for completed := 0; completed < threshold; completed++ {
|
|
|
|
data, ok := <-ch
|
|
|
|
if !ok {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
s.handleStream(data.st, data.stream, s.traceInfo(data.st, data.stream))
|
|
|
|
data.wg.Done()
|
|
|
|
}
|
|
|
|
go s.serverWorker(ch)
|
|
|
|
}
|
|
|
|
|
|
|
|
// initServerWorkers creates worker goroutines and channels to process incoming
|
|
|
|
// connections to reduce the time spent overall on runtime.morestack.
|
|
|
|
func (s *Server) initServerWorkers() {
|
|
|
|
s.serverWorkerChannels = make([]chan *serverWorkerData, s.opts.numServerWorkers)
|
|
|
|
for i := uint32(0); i < s.opts.numServerWorkers; i++ {
|
|
|
|
s.serverWorkerChannels[i] = make(chan *serverWorkerData)
|
|
|
|
go s.serverWorker(s.serverWorkerChannels[i])
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) stopServerWorkers() {
|
|
|
|
for i := uint32(0); i < s.opts.numServerWorkers; i++ {
|
|
|
|
close(s.serverWorkerChannels[i])
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
// NewServer creates a gRPC server which has no service registered and has not
|
|
|
|
// started to accept requests yet.
|
|
|
|
func NewServer(opt ...ServerOption) *Server {
|
|
|
|
opts := defaultServerOptions
|
2022-07-13 13:43:46 +00:00
|
|
|
for _, o := range extraServerOptions {
|
|
|
|
o.apply(&opts)
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
for _, o := range opt {
|
|
|
|
o.apply(&opts)
|
|
|
|
}
|
|
|
|
s := &Server{
|
2020-09-10 06:49:55 +00:00
|
|
|
lis: make(map[net.Listener]bool),
|
|
|
|
opts: opts,
|
2021-05-20 15:38:21 +00:00
|
|
|
conns: make(map[string]map[transport.ServerTransport]bool),
|
2020-09-10 06:49:55 +00:00
|
|
|
services: make(map[string]*serviceInfo),
|
|
|
|
quit: grpcsync.NewEvent(),
|
|
|
|
done: grpcsync.NewEvent(),
|
|
|
|
czData: new(channelzData),
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2020-03-12 16:11:27 +00:00
|
|
|
chainUnaryServerInterceptors(s)
|
|
|
|
chainStreamServerInterceptors(s)
|
2019-11-07 19:05:39 +00:00
|
|
|
s.cv = sync.NewCond(&s.mu)
|
|
|
|
if EnableTracing {
|
|
|
|
_, file, line, _ := runtime.Caller(1)
|
|
|
|
s.events = trace.NewEventLog("grpc.Server", fmt.Sprintf("%s:%d", file, line))
|
|
|
|
}
|
|
|
|
|
2020-06-25 20:42:41 +00:00
|
|
|
if s.opts.numServerWorkers > 0 {
|
|
|
|
s.initServerWorkers()
|
|
|
|
}
|
|
|
|
|
2022-04-26 12:24:23 +00:00
|
|
|
s.channelzID = channelz.RegisterServer(&channelzServer{s}, "")
|
|
|
|
channelz.Info(logger, s.channelzID, "Server created")
|
2019-11-07 19:05:39 +00:00
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// printf records an event in s's event log, unless s has been stopped.
|
|
|
|
// REQUIRES s.mu is held.
|
|
|
|
func (s *Server) printf(format string, a ...interface{}) {
|
|
|
|
if s.events != nil {
|
|
|
|
s.events.Printf(format, a...)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// errorf records an error in s's event log, unless s has been stopped.
|
|
|
|
// REQUIRES s.mu is held.
|
|
|
|
func (s *Server) errorf(format string, a ...interface{}) {
|
|
|
|
if s.events != nil {
|
|
|
|
s.events.Errorf(format, a...)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-10 06:49:55 +00:00
|
|
|
// ServiceRegistrar wraps a single method that supports service registration. It
|
|
|
|
// enables users to pass concrete types other than grpc.Server to the service
|
|
|
|
// registration methods exported by the IDL generated code.
|
|
|
|
type ServiceRegistrar interface {
|
|
|
|
// RegisterService registers a service and its implementation to the
|
|
|
|
// concrete type implementing this interface. It may not be called
|
|
|
|
// once the server has started serving.
|
|
|
|
// desc describes the service and its methods and handlers. impl is the
|
|
|
|
// service implementation which is passed to the method handlers.
|
|
|
|
RegisterService(desc *ServiceDesc, impl interface{})
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
// RegisterService registers a service and its implementation to the gRPC
|
|
|
|
// server. It is called from the IDL generated code. This must be called before
|
2020-09-10 06:49:55 +00:00
|
|
|
// invoking Serve. If ss is non-nil (for legacy code), its type is checked to
|
|
|
|
// ensure it implements sd.HandlerType.
|
2019-11-07 19:05:39 +00:00
|
|
|
func (s *Server) RegisterService(sd *ServiceDesc, ss interface{}) {
|
2020-09-10 06:49:55 +00:00
|
|
|
if ss != nil {
|
|
|
|
ht := reflect.TypeOf(sd.HandlerType).Elem()
|
|
|
|
st := reflect.TypeOf(ss)
|
|
|
|
if !st.Implements(ht) {
|
|
|
|
logger.Fatalf("grpc: Server.RegisterService found the handler of type %v that does not satisfy %v", st, ht)
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
s.register(sd, ss)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) register(sd *ServiceDesc, ss interface{}) {
|
|
|
|
s.mu.Lock()
|
|
|
|
defer s.mu.Unlock()
|
|
|
|
s.printf("RegisterService(%q)", sd.ServiceName)
|
|
|
|
if s.serve {
|
2020-08-05 08:15:42 +00:00
|
|
|
logger.Fatalf("grpc: Server.RegisterService after Server.Serve for %q", sd.ServiceName)
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2020-09-10 06:49:55 +00:00
|
|
|
if _, ok := s.services[sd.ServiceName]; ok {
|
2020-08-05 08:15:42 +00:00
|
|
|
logger.Fatalf("grpc: Server.RegisterService found duplicate service registration for %q", sd.ServiceName)
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2020-09-10 06:49:55 +00:00
|
|
|
info := &serviceInfo{
|
|
|
|
serviceImpl: ss,
|
|
|
|
methods: make(map[string]*MethodDesc),
|
|
|
|
streams: make(map[string]*StreamDesc),
|
|
|
|
mdata: sd.Metadata,
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
for i := range sd.Methods {
|
|
|
|
d := &sd.Methods[i]
|
2020-09-10 06:49:55 +00:00
|
|
|
info.methods[d.MethodName] = d
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
for i := range sd.Streams {
|
|
|
|
d := &sd.Streams[i]
|
2020-09-10 06:49:55 +00:00
|
|
|
info.streams[d.StreamName] = d
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2020-09-10 06:49:55 +00:00
|
|
|
s.services[sd.ServiceName] = info
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// MethodInfo contains the information of an RPC including its method name and type.
|
|
|
|
type MethodInfo struct {
|
|
|
|
// Name is the method name only, without the service name or package name.
|
|
|
|
Name string
|
|
|
|
// IsClientStream indicates whether the RPC is a client streaming RPC.
|
|
|
|
IsClientStream bool
|
|
|
|
// IsServerStream indicates whether the RPC is a server streaming RPC.
|
|
|
|
IsServerStream bool
|
|
|
|
}
|
|
|
|
|
|
|
|
// ServiceInfo contains unary RPC method info, streaming RPC method info and metadata for a service.
|
|
|
|
type ServiceInfo struct {
|
|
|
|
Methods []MethodInfo
|
|
|
|
// Metadata is the metadata specified in ServiceDesc when registering service.
|
|
|
|
Metadata interface{}
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetServiceInfo returns a map from service names to ServiceInfo.
|
|
|
|
// Service names include the package names, in the form of <package>.<service>.
|
|
|
|
func (s *Server) GetServiceInfo() map[string]ServiceInfo {
|
|
|
|
ret := make(map[string]ServiceInfo)
|
2020-09-10 06:49:55 +00:00
|
|
|
for n, srv := range s.services {
|
|
|
|
methods := make([]MethodInfo, 0, len(srv.methods)+len(srv.streams))
|
|
|
|
for m := range srv.methods {
|
2019-11-07 19:05:39 +00:00
|
|
|
methods = append(methods, MethodInfo{
|
|
|
|
Name: m,
|
|
|
|
IsClientStream: false,
|
|
|
|
IsServerStream: false,
|
|
|
|
})
|
|
|
|
}
|
2020-09-10 06:49:55 +00:00
|
|
|
for m, d := range srv.streams {
|
2019-11-07 19:05:39 +00:00
|
|
|
methods = append(methods, MethodInfo{
|
|
|
|
Name: m,
|
|
|
|
IsClientStream: d.ClientStreams,
|
|
|
|
IsServerStream: d.ServerStreams,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
ret[n] = ServiceInfo{
|
|
|
|
Methods: methods,
|
|
|
|
Metadata: srv.mdata,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return ret
|
|
|
|
}
|
|
|
|
|
|
|
|
// ErrServerStopped indicates that the operation is now illegal because of
|
|
|
|
// the server being stopped.
|
|
|
|
var ErrServerStopped = errors.New("grpc: the server has been stopped")
|
|
|
|
|
|
|
|
type listenSocket struct {
|
|
|
|
net.Listener
|
2022-04-26 12:24:23 +00:00
|
|
|
channelzID *channelz.Identifier
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (l *listenSocket) ChannelzMetric() *channelz.SocketInternalMetric {
|
|
|
|
return &channelz.SocketInternalMetric{
|
|
|
|
SocketOptions: channelz.GetSocketOption(l.Listener),
|
|
|
|
LocalAddr: l.Listener.Addr(),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *listenSocket) Close() error {
|
|
|
|
err := l.Listener.Close()
|
2022-04-26 12:24:23 +00:00
|
|
|
channelz.RemoveEntry(l.channelzID)
|
|
|
|
channelz.Info(logger, l.channelzID, "ListenSocket deleted")
|
2019-11-07 19:05:39 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Serve accepts incoming connections on the listener lis, creating a new
|
|
|
|
// ServerTransport and service goroutine for each. The service goroutines
|
|
|
|
// read gRPC requests and then call the registered handlers to reply to them.
|
|
|
|
// Serve returns when lis.Accept fails with fatal errors. lis will be closed when
|
|
|
|
// this method returns.
|
|
|
|
// Serve will return a non-nil error unless Stop or GracefulStop is called.
|
|
|
|
func (s *Server) Serve(lis net.Listener) error {
|
|
|
|
s.mu.Lock()
|
|
|
|
s.printf("serving")
|
|
|
|
s.serve = true
|
|
|
|
if s.lis == nil {
|
|
|
|
// Serve called after Stop or GracefulStop.
|
|
|
|
s.mu.Unlock()
|
|
|
|
lis.Close()
|
|
|
|
return ErrServerStopped
|
|
|
|
}
|
|
|
|
|
|
|
|
s.serveWG.Add(1)
|
|
|
|
defer func() {
|
|
|
|
s.serveWG.Done()
|
|
|
|
if s.quit.HasFired() {
|
|
|
|
// Stop or GracefulStop called; block until done and return nil.
|
|
|
|
<-s.done.Done()
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
|
|
|
|
ls := &listenSocket{Listener: lis}
|
|
|
|
s.lis[ls] = true
|
|
|
|
|
|
|
|
defer func() {
|
|
|
|
s.mu.Lock()
|
|
|
|
if s.lis != nil && s.lis[ls] {
|
|
|
|
ls.Close()
|
|
|
|
delete(s.lis, ls)
|
|
|
|
}
|
|
|
|
s.mu.Unlock()
|
|
|
|
}()
|
|
|
|
|
2022-04-26 12:24:23 +00:00
|
|
|
var err error
|
|
|
|
ls.channelzID, err = channelz.RegisterListenSocket(ls, s.channelzID, lis.Addr().String())
|
|
|
|
if err != nil {
|
|
|
|
s.mu.Unlock()
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
s.mu.Unlock()
|
|
|
|
channelz.Info(logger, ls.channelzID, "ListenSocket created")
|
2019-11-07 19:05:39 +00:00
|
|
|
|
2022-04-26 12:24:23 +00:00
|
|
|
var tempDelay time.Duration // how long to sleep on accept failure
|
2019-11-07 19:05:39 +00:00
|
|
|
for {
|
|
|
|
rawConn, err := lis.Accept()
|
|
|
|
if err != nil {
|
|
|
|
if ne, ok := err.(interface {
|
|
|
|
Temporary() bool
|
|
|
|
}); ok && ne.Temporary() {
|
|
|
|
if tempDelay == 0 {
|
|
|
|
tempDelay = 5 * time.Millisecond
|
|
|
|
} else {
|
|
|
|
tempDelay *= 2
|
|
|
|
}
|
|
|
|
if max := 1 * time.Second; tempDelay > max {
|
|
|
|
tempDelay = max
|
|
|
|
}
|
|
|
|
s.mu.Lock()
|
|
|
|
s.printf("Accept error: %v; retrying in %v", err, tempDelay)
|
|
|
|
s.mu.Unlock()
|
|
|
|
timer := time.NewTimer(tempDelay)
|
|
|
|
select {
|
|
|
|
case <-timer.C:
|
|
|
|
case <-s.quit.Done():
|
|
|
|
timer.Stop()
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
s.mu.Lock()
|
|
|
|
s.printf("done serving; Accept = %v", err)
|
|
|
|
s.mu.Unlock()
|
|
|
|
|
|
|
|
if s.quit.HasFired() {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
tempDelay = 0
|
|
|
|
// Start a new goroutine to deal with rawConn so we don't stall this Accept
|
|
|
|
// loop goroutine.
|
|
|
|
//
|
|
|
|
// Make sure we account for the goroutine so GracefulStop doesn't nil out
|
|
|
|
// s.conns before this conn can be added.
|
|
|
|
s.serveWG.Add(1)
|
|
|
|
go func() {
|
2021-05-20 15:38:21 +00:00
|
|
|
s.handleRawConn(lis.Addr().String(), rawConn)
|
2019-11-07 19:05:39 +00:00
|
|
|
s.serveWG.Done()
|
|
|
|
}()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// handleRawConn forks a goroutine to handle a just-accepted connection that
|
|
|
|
// has not had any I/O performed on it yet.
|
2021-05-20 15:38:21 +00:00
|
|
|
func (s *Server) handleRawConn(lisAddr string, rawConn net.Conn) {
|
2019-11-07 19:05:39 +00:00
|
|
|
if s.quit.HasFired() {
|
|
|
|
rawConn.Close()
|
|
|
|
return
|
|
|
|
}
|
|
|
|
rawConn.SetDeadline(time.Now().Add(s.opts.connectionTimeout))
|
|
|
|
|
|
|
|
// Finish handshaking (HTTP2)
|
2021-09-27 15:01:40 +00:00
|
|
|
st := s.newHTTP2Transport(rawConn)
|
|
|
|
rawConn.SetDeadline(time.Time{})
|
2019-11-07 19:05:39 +00:00
|
|
|
if st == nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2021-05-20 15:38:21 +00:00
|
|
|
if !s.addConn(lisAddr, st) {
|
2019-11-07 19:05:39 +00:00
|
|
|
return
|
|
|
|
}
|
|
|
|
go func() {
|
|
|
|
s.serveStreams(st)
|
2021-05-20 15:38:21 +00:00
|
|
|
s.removeConn(lisAddr, st)
|
2019-11-07 19:05:39 +00:00
|
|
|
}()
|
|
|
|
}
|
|
|
|
|
2021-05-20 15:38:21 +00:00
|
|
|
func (s *Server) drainServerTransports(addr string) {
|
|
|
|
s.mu.Lock()
|
|
|
|
conns := s.conns[addr]
|
|
|
|
for st := range conns {
|
|
|
|
st.Drain()
|
|
|
|
}
|
|
|
|
s.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
// newHTTP2Transport sets up a http/2 transport (using the
|
|
|
|
// gRPC http2 server transport in transport/http2_server.go).
|
2021-09-27 15:01:40 +00:00
|
|
|
func (s *Server) newHTTP2Transport(c net.Conn) transport.ServerTransport {
|
2019-11-07 19:05:39 +00:00
|
|
|
config := &transport.ServerConfig{
|
|
|
|
MaxStreams: s.opts.maxConcurrentStreams,
|
2021-09-27 15:01:40 +00:00
|
|
|
ConnectionTimeout: s.opts.connectionTimeout,
|
|
|
|
Credentials: s.opts.creds,
|
2019-11-07 19:05:39 +00:00
|
|
|
InTapHandle: s.opts.inTapHandle,
|
2022-07-13 13:43:46 +00:00
|
|
|
StatsHandlers: s.opts.statsHandlers,
|
2019-11-07 19:05:39 +00:00
|
|
|
KeepaliveParams: s.opts.keepaliveParams,
|
|
|
|
KeepalivePolicy: s.opts.keepalivePolicy,
|
|
|
|
InitialWindowSize: s.opts.initialWindowSize,
|
|
|
|
InitialConnWindowSize: s.opts.initialConnWindowSize,
|
|
|
|
WriteBufferSize: s.opts.writeBufferSize,
|
|
|
|
ReadBufferSize: s.opts.readBufferSize,
|
|
|
|
ChannelzParentID: s.channelzID,
|
|
|
|
MaxHeaderListSize: s.opts.maxHeaderListSize,
|
|
|
|
HeaderTableSize: s.opts.headerTableSize,
|
|
|
|
}
|
2021-07-07 13:10:33 +00:00
|
|
|
st, err := transport.NewServerTransport(c, config)
|
2019-11-07 19:05:39 +00:00
|
|
|
if err != nil {
|
|
|
|
s.mu.Lock()
|
|
|
|
s.errorf("NewServerTransport(%q) failed: %v", c.RemoteAddr(), err)
|
|
|
|
s.mu.Unlock()
|
2021-09-27 15:01:40 +00:00
|
|
|
// ErrConnDispatched means that the connection was dispatched away from
|
|
|
|
// gRPC; those connections should be left open.
|
|
|
|
if err != credentials.ErrConnDispatched {
|
2021-11-08 10:41:15 +00:00
|
|
|
// Don't log on ErrConnDispatched and io.EOF to prevent log spam.
|
2021-09-27 15:01:40 +00:00
|
|
|
if err != io.EOF {
|
2022-08-30 06:45:26 +00:00
|
|
|
channelz.Info(logger, s.channelzID, "grpc: Server.Serve failed to create ServerTransport: ", err)
|
2021-09-27 15:01:40 +00:00
|
|
|
}
|
2021-11-08 10:41:15 +00:00
|
|
|
c.Close()
|
2021-09-27 15:01:40 +00:00
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return st
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) serveStreams(st transport.ServerTransport) {
|
|
|
|
defer st.Close()
|
|
|
|
var wg sync.WaitGroup
|
2020-06-25 20:42:41 +00:00
|
|
|
|
|
|
|
var roundRobinCounter uint32
|
2019-11-07 19:05:39 +00:00
|
|
|
st.HandleStreams(func(stream *transport.Stream) {
|
|
|
|
wg.Add(1)
|
2020-06-25 20:42:41 +00:00
|
|
|
if s.opts.numServerWorkers > 0 {
|
|
|
|
data := &serverWorkerData{st: st, wg: &wg, stream: stream}
|
|
|
|
select {
|
|
|
|
case s.serverWorkerChannels[atomic.AddUint32(&roundRobinCounter, 1)%s.opts.numServerWorkers] <- data:
|
|
|
|
default:
|
|
|
|
// If all stream workers are busy, fallback to the default code path.
|
|
|
|
go func() {
|
|
|
|
s.handleStream(st, stream, s.traceInfo(st, stream))
|
|
|
|
wg.Done()
|
|
|
|
}()
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
go func() {
|
|
|
|
defer wg.Done()
|
|
|
|
s.handleStream(st, stream, s.traceInfo(st, stream))
|
|
|
|
}()
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
}, func(ctx context.Context, method string) context.Context {
|
|
|
|
if !EnableTracing {
|
|
|
|
return ctx
|
|
|
|
}
|
|
|
|
tr := trace.New("grpc.Recv."+methodFamily(method), method)
|
|
|
|
return trace.NewContext(ctx, tr)
|
|
|
|
})
|
|
|
|
wg.Wait()
|
|
|
|
}
|
|
|
|
|
|
|
|
var _ http.Handler = (*Server)(nil)
|
|
|
|
|
|
|
|
// ServeHTTP implements the Go standard library's http.Handler
|
|
|
|
// interface by responding to the gRPC request r, by looking up
|
|
|
|
// the requested gRPC method in the gRPC server s.
|
|
|
|
//
|
|
|
|
// The provided HTTP request must have arrived on an HTTP/2
|
|
|
|
// connection. When using the Go standard library's server,
|
|
|
|
// practically this means that the Request must also have arrived
|
|
|
|
// over TLS.
|
|
|
|
//
|
|
|
|
// To share one port (such as 443 for https) between gRPC and an
|
|
|
|
// existing http.Handler, use a root http.Handler such as:
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// if r.ProtoMajor == 2 && strings.HasPrefix(
|
|
|
|
// r.Header.Get("Content-Type"), "application/grpc") {
|
|
|
|
// grpcServer.ServeHTTP(w, r)
|
|
|
|
// } else {
|
|
|
|
// yourMux.ServeHTTP(w, r)
|
|
|
|
// }
|
2019-11-07 19:05:39 +00:00
|
|
|
//
|
|
|
|
// Note that ServeHTTP uses Go's HTTP/2 server implementation which is totally
|
|
|
|
// separate from grpc-go's HTTP/2 server. Performance and features may vary
|
|
|
|
// between the two paths. ServeHTTP does not support some gRPC features
|
2020-10-16 12:04:44 +00:00
|
|
|
// available through grpc-go's HTTP/2 server.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
2022-07-13 13:43:46 +00:00
|
|
|
st, err := transport.NewServerHandlerTransport(w, r, s.opts.statsHandlers)
|
2019-11-07 19:05:39 +00:00
|
|
|
if err != nil {
|
|
|
|
http.Error(w, err.Error(), http.StatusInternalServerError)
|
|
|
|
return
|
|
|
|
}
|
2021-05-20 15:38:21 +00:00
|
|
|
if !s.addConn(listenerAddressForServeHTTP, st) {
|
2019-11-07 19:05:39 +00:00
|
|
|
return
|
|
|
|
}
|
2021-05-20 15:38:21 +00:00
|
|
|
defer s.removeConn(listenerAddressForServeHTTP, st)
|
2019-11-07 19:05:39 +00:00
|
|
|
s.serveStreams(st)
|
|
|
|
}
|
|
|
|
|
|
|
|
// traceInfo returns a traceInfo and associates it with stream, if tracing is enabled.
|
|
|
|
// If tracing is not enabled, it returns nil.
|
|
|
|
func (s *Server) traceInfo(st transport.ServerTransport, stream *transport.Stream) (trInfo *traceInfo) {
|
|
|
|
if !EnableTracing {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
tr, ok := trace.FromContext(stream.Context())
|
|
|
|
if !ok {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
trInfo = &traceInfo{
|
|
|
|
tr: tr,
|
|
|
|
firstLine: firstLine{
|
|
|
|
client: false,
|
|
|
|
remoteAddr: st.RemoteAddr(),
|
|
|
|
},
|
|
|
|
}
|
|
|
|
if dl, ok := stream.Context().Deadline(); ok {
|
|
|
|
trInfo.firstLine.deadline = time.Until(dl)
|
|
|
|
}
|
|
|
|
return trInfo
|
|
|
|
}
|
|
|
|
|
2021-05-20 15:38:21 +00:00
|
|
|
func (s *Server) addConn(addr string, st transport.ServerTransport) bool {
|
2019-11-07 19:05:39 +00:00
|
|
|
s.mu.Lock()
|
|
|
|
defer s.mu.Unlock()
|
|
|
|
if s.conns == nil {
|
|
|
|
st.Close()
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
if s.drain {
|
|
|
|
// Transport added after we drained our existing conns: drain it
|
|
|
|
// immediately.
|
|
|
|
st.Drain()
|
|
|
|
}
|
2021-05-20 15:38:21 +00:00
|
|
|
|
|
|
|
if s.conns[addr] == nil {
|
|
|
|
// Create a map entry if this is the first connection on this listener.
|
|
|
|
s.conns[addr] = make(map[transport.ServerTransport]bool)
|
|
|
|
}
|
|
|
|
s.conns[addr][st] = true
|
2019-11-07 19:05:39 +00:00
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
2021-05-20 15:38:21 +00:00
|
|
|
func (s *Server) removeConn(addr string, st transport.ServerTransport) {
|
2019-11-07 19:05:39 +00:00
|
|
|
s.mu.Lock()
|
|
|
|
defer s.mu.Unlock()
|
2021-05-20 15:38:21 +00:00
|
|
|
|
|
|
|
conns := s.conns[addr]
|
|
|
|
if conns != nil {
|
|
|
|
delete(conns, st)
|
|
|
|
if len(conns) == 0 {
|
|
|
|
// If the last connection for this address is being removed, also
|
|
|
|
// remove the map entry corresponding to the address. This is used
|
|
|
|
// in GracefulStop() when waiting for all connections to be closed.
|
|
|
|
delete(s.conns, addr)
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
s.cv.Broadcast()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) channelzMetric() *channelz.ServerInternalMetric {
|
|
|
|
return &channelz.ServerInternalMetric{
|
|
|
|
CallsStarted: atomic.LoadInt64(&s.czData.callsStarted),
|
|
|
|
CallsSucceeded: atomic.LoadInt64(&s.czData.callsSucceeded),
|
|
|
|
CallsFailed: atomic.LoadInt64(&s.czData.callsFailed),
|
|
|
|
LastCallStartedTimestamp: time.Unix(0, atomic.LoadInt64(&s.czData.lastCallStartedTime)),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) incrCallsStarted() {
|
|
|
|
atomic.AddInt64(&s.czData.callsStarted, 1)
|
|
|
|
atomic.StoreInt64(&s.czData.lastCallStartedTime, time.Now().UnixNano())
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) incrCallsSucceeded() {
|
|
|
|
atomic.AddInt64(&s.czData.callsSucceeded, 1)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) incrCallsFailed() {
|
|
|
|
atomic.AddInt64(&s.czData.callsFailed, 1)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) sendResponse(t transport.ServerTransport, stream *transport.Stream, msg interface{}, cp Compressor, opts *transport.Options, comp encoding.Compressor) error {
|
|
|
|
data, err := encode(s.getCodec(stream.ContentSubtype()), msg)
|
|
|
|
if err != nil {
|
2020-08-05 08:15:42 +00:00
|
|
|
channelz.Error(logger, s.channelzID, "grpc: server failed to encode response: ", err)
|
2019-11-07 19:05:39 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
compData, err := compress(data, cp, comp)
|
|
|
|
if err != nil {
|
2020-08-05 08:15:42 +00:00
|
|
|
channelz.Error(logger, s.channelzID, "grpc: server failed to compress response: ", err)
|
2019-11-07 19:05:39 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
hdr, payload := msgHeader(data, compData)
|
|
|
|
// TODO(dfawley): should we be checking len(data) instead?
|
|
|
|
if len(payload) > s.opts.maxSendMessageSize {
|
|
|
|
return status.Errorf(codes.ResourceExhausted, "grpc: trying to send message larger than max (%d vs. %d)", len(payload), s.opts.maxSendMessageSize)
|
|
|
|
}
|
|
|
|
err = t.Write(stream, hdr, payload, opts)
|
2022-07-13 13:43:46 +00:00
|
|
|
if err == nil {
|
|
|
|
for _, sh := range s.opts.statsHandlers {
|
|
|
|
sh.HandleRPC(stream.Context(), outPayload(false, msg, data, payload, time.Now()))
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2020-03-12 16:11:27 +00:00
|
|
|
// chainUnaryServerInterceptors chains all unary server interceptors into one.
|
|
|
|
func chainUnaryServerInterceptors(s *Server) {
|
|
|
|
// Prepend opts.unaryInt to the chaining interceptors if it exists, since unaryInt will
|
|
|
|
// be executed before any other chained interceptors.
|
|
|
|
interceptors := s.opts.chainUnaryInts
|
|
|
|
if s.opts.unaryInt != nil {
|
|
|
|
interceptors = append([]UnaryServerInterceptor{s.opts.unaryInt}, s.opts.chainUnaryInts...)
|
|
|
|
}
|
|
|
|
|
|
|
|
var chainedInt UnaryServerInterceptor
|
|
|
|
if len(interceptors) == 0 {
|
|
|
|
chainedInt = nil
|
|
|
|
} else if len(interceptors) == 1 {
|
|
|
|
chainedInt = interceptors[0]
|
|
|
|
} else {
|
2021-08-13 10:03:03 +00:00
|
|
|
chainedInt = chainUnaryInterceptors(interceptors)
|
2020-03-12 16:11:27 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
s.opts.unaryInt = chainedInt
|
|
|
|
}
|
|
|
|
|
2021-08-13 10:03:03 +00:00
|
|
|
func chainUnaryInterceptors(interceptors []UnaryServerInterceptor) UnaryServerInterceptor {
|
|
|
|
return func(ctx context.Context, req interface{}, info *UnaryServerInfo, handler UnaryHandler) (interface{}, error) {
|
2021-11-08 10:41:15 +00:00
|
|
|
// the struct ensures the variables are allocated together, rather than separately, since we
|
|
|
|
// know they should be garbage collected together. This saves 1 allocation and decreases
|
|
|
|
// time/call by about 10% on the microbenchmark.
|
|
|
|
var state struct {
|
|
|
|
i int
|
|
|
|
next UnaryHandler
|
|
|
|
}
|
|
|
|
state.next = func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
|
|
if state.i == len(interceptors)-1 {
|
|
|
|
return interceptors[state.i](ctx, req, info, handler)
|
2021-08-13 10:03:03 +00:00
|
|
|
}
|
2021-11-08 10:41:15 +00:00
|
|
|
state.i++
|
|
|
|
return interceptors[state.i-1](ctx, req, info, state.next)
|
2021-08-13 10:03:03 +00:00
|
|
|
}
|
2021-11-08 10:41:15 +00:00
|
|
|
return state.next(ctx, req)
|
2020-03-12 16:11:27 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-10 06:49:55 +00:00
|
|
|
func (s *Server) processUnaryRPC(t transport.ServerTransport, stream *transport.Stream, info *serviceInfo, md *MethodDesc, trInfo *traceInfo) (err error) {
|
2022-07-13 13:43:46 +00:00
|
|
|
shs := s.opts.statsHandlers
|
|
|
|
if len(shs) != 0 || trInfo != nil || channelz.IsOn() {
|
2019-12-26 17:42:48 +00:00
|
|
|
if channelz.IsOn() {
|
|
|
|
s.incrCallsStarted()
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2019-12-26 17:42:48 +00:00
|
|
|
var statsBegin *stats.Begin
|
2022-07-13 13:43:46 +00:00
|
|
|
for _, sh := range shs {
|
2019-12-26 17:42:48 +00:00
|
|
|
beginTime := time.Now()
|
|
|
|
statsBegin = &stats.Begin{
|
2021-08-13 10:03:03 +00:00
|
|
|
BeginTime: beginTime,
|
|
|
|
IsClientStream: false,
|
|
|
|
IsServerStream: false,
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2019-12-26 17:42:48 +00:00
|
|
|
sh.HandleRPC(stream.Context(), statsBegin)
|
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(&trInfo.firstLine, false)
|
|
|
|
}
|
|
|
|
// The deferred error handling for tracing, stats handler and channelz are
|
|
|
|
// combined into one function to reduce stack usage -- a defer takes ~56-64
|
|
|
|
// bytes on the stack, so overflowing the stack will require a stack
|
|
|
|
// re-allocation, which is expensive.
|
|
|
|
//
|
|
|
|
// To maintain behavior similar to separate deferred statements, statements
|
|
|
|
// should be executed in the reverse order. That is, tracing first, stats
|
|
|
|
// handler second, and channelz last. Note that panics *within* defers will
|
|
|
|
// lead to different behavior, but that's an acceptable compromise; that
|
|
|
|
// would be undefined behavior territory anyway.
|
2019-11-07 19:05:39 +00:00
|
|
|
defer func() {
|
2019-12-26 17:42:48 +00:00
|
|
|
if trInfo != nil {
|
|
|
|
if err != nil && err != io.EOF {
|
|
|
|
trInfo.tr.LazyLog(&fmtStringer{"%v", []interface{}{err}}, true)
|
|
|
|
trInfo.tr.SetError()
|
|
|
|
}
|
|
|
|
trInfo.tr.Finish()
|
|
|
|
}
|
|
|
|
|
2022-07-13 13:43:46 +00:00
|
|
|
for _, sh := range shs {
|
2019-12-26 17:42:48 +00:00
|
|
|
end := &stats.End{
|
|
|
|
BeginTime: statsBegin.BeginTime,
|
|
|
|
EndTime: time.Now(),
|
|
|
|
}
|
|
|
|
if err != nil && err != io.EOF {
|
|
|
|
end.Error = toRPCErr(err)
|
|
|
|
}
|
|
|
|
sh.HandleRPC(stream.Context(), end)
|
|
|
|
}
|
|
|
|
|
|
|
|
if channelz.IsOn() {
|
|
|
|
if err != nil && err != io.EOF {
|
|
|
|
s.incrCallsFailed()
|
|
|
|
} else {
|
|
|
|
s.incrCallsSucceeded()
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
}()
|
|
|
|
}
|
|
|
|
|
|
|
|
binlog := binarylog.GetMethodLogger(stream.Method())
|
|
|
|
if binlog != nil {
|
|
|
|
ctx := stream.Context()
|
|
|
|
md, _ := metadata.FromIncomingContext(ctx)
|
|
|
|
logEntry := &binarylog.ClientHeader{
|
|
|
|
Header: md,
|
|
|
|
MethodName: stream.Method(),
|
|
|
|
PeerAddr: nil,
|
|
|
|
}
|
|
|
|
if deadline, ok := ctx.Deadline(); ok {
|
|
|
|
logEntry.Timeout = time.Until(deadline)
|
|
|
|
if logEntry.Timeout < 0 {
|
|
|
|
logEntry.Timeout = 0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if a := md[":authority"]; len(a) > 0 {
|
|
|
|
logEntry.Authority = a[0]
|
|
|
|
}
|
|
|
|
if peer, ok := peer.FromContext(ctx); ok {
|
|
|
|
logEntry.PeerAddr = peer.Addr
|
|
|
|
}
|
|
|
|
binlog.Log(logEntry)
|
|
|
|
}
|
|
|
|
|
|
|
|
// comp and cp are used for compression. decomp and dc are used for
|
|
|
|
// decompression. If comp and decomp are both set, they are the same;
|
|
|
|
// however they are kept separate to ensure that at most one of the
|
|
|
|
// compressor/decompressor variable pairs are set for use later.
|
|
|
|
var comp, decomp encoding.Compressor
|
|
|
|
var cp Compressor
|
|
|
|
var dc Decompressor
|
|
|
|
|
|
|
|
// If dc is set and matches the stream's compression, use it. Otherwise, try
|
|
|
|
// to find a matching registered compressor for decomp.
|
|
|
|
if rc := stream.RecvCompress(); s.opts.dc != nil && s.opts.dc.Type() == rc {
|
|
|
|
dc = s.opts.dc
|
|
|
|
} else if rc != "" && rc != encoding.Identity {
|
|
|
|
decomp = encoding.GetCompressor(rc)
|
|
|
|
if decomp == nil {
|
|
|
|
st := status.Newf(codes.Unimplemented, "grpc: Decompressor is not installed for grpc-encoding %q", rc)
|
|
|
|
t.WriteStatus(stream, st)
|
|
|
|
return st.Err()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// If cp is set, use it. Otherwise, attempt to compress the response using
|
|
|
|
// the incoming message compression method.
|
|
|
|
//
|
|
|
|
// NOTE: this needs to be ahead of all handling, https://github.com/grpc/grpc-go/issues/686.
|
|
|
|
if s.opts.cp != nil {
|
|
|
|
cp = s.opts.cp
|
|
|
|
stream.SetSendCompress(cp.Type())
|
|
|
|
} else if rc := stream.RecvCompress(); rc != "" && rc != encoding.Identity {
|
|
|
|
// Legacy compressor not specified; attempt to respond with same encoding.
|
|
|
|
comp = encoding.GetCompressor(rc)
|
|
|
|
if comp != nil {
|
|
|
|
stream.SetSendCompress(rc)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
var payInfo *payloadInfo
|
2022-07-13 13:43:46 +00:00
|
|
|
if len(shs) != 0 || binlog != nil {
|
2019-11-07 19:05:39 +00:00
|
|
|
payInfo = &payloadInfo{}
|
|
|
|
}
|
|
|
|
d, err := recvAndDecompress(&parser{r: stream}, stream, dc, s.opts.maxReceiveMessageSize, payInfo, decomp)
|
|
|
|
if err != nil {
|
2020-09-10 06:49:55 +00:00
|
|
|
if e := t.WriteStatus(stream, status.Convert(err)); e != nil {
|
|
|
|
channelz.Warningf(logger, s.channelzID, "grpc: Server.processUnaryRPC failed to write status %v", e)
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if channelz.IsOn() {
|
|
|
|
t.IncrMsgRecv()
|
|
|
|
}
|
|
|
|
df := func(v interface{}) error {
|
|
|
|
if err := s.getCodec(stream.ContentSubtype()).Unmarshal(d, v); err != nil {
|
|
|
|
return status.Errorf(codes.Internal, "grpc: error unmarshalling request: %v", err)
|
|
|
|
}
|
2022-07-13 13:43:46 +00:00
|
|
|
for _, sh := range shs {
|
2019-11-07 19:05:39 +00:00
|
|
|
sh.HandleRPC(stream.Context(), &stats.InPayload{
|
|
|
|
RecvTime: time.Now(),
|
|
|
|
Payload: v,
|
2020-10-16 12:04:44 +00:00
|
|
|
WireLength: payInfo.wireLength + headerLen,
|
2019-11-07 19:05:39 +00:00
|
|
|
Data: d,
|
|
|
|
Length: len(d),
|
|
|
|
})
|
|
|
|
}
|
|
|
|
if binlog != nil {
|
|
|
|
binlog.Log(&binarylog.ClientMessage{
|
|
|
|
Message: d,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(&payload{sent: false, msg: v}, true)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
ctx := NewContextWithServerTransportStream(stream.Context(), stream)
|
2020-09-10 06:49:55 +00:00
|
|
|
reply, appErr := md.Handler(info.serviceImpl, ctx, df, s.opts.unaryInt)
|
2019-11-07 19:05:39 +00:00
|
|
|
if appErr != nil {
|
|
|
|
appStatus, ok := status.FromError(appErr)
|
|
|
|
if !ok {
|
2022-03-16 11:55:03 +00:00
|
|
|
// Convert non-status application error to a status error with code
|
|
|
|
// Unknown, but handle context errors specifically.
|
|
|
|
appStatus = status.FromContextError(appErr)
|
|
|
|
appErr = appStatus.Err()
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(stringer(appStatus.Message()), true)
|
|
|
|
trInfo.tr.SetError()
|
|
|
|
}
|
|
|
|
if e := t.WriteStatus(stream, appStatus); e != nil {
|
2020-08-05 08:15:42 +00:00
|
|
|
channelz.Warningf(logger, s.channelzID, "grpc: Server.processUnaryRPC failed to write status: %v", e)
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
if binlog != nil {
|
|
|
|
if h, _ := stream.Header(); h.Len() > 0 {
|
|
|
|
// Only log serverHeader if there was header. Otherwise it can
|
|
|
|
// be trailer only.
|
|
|
|
binlog.Log(&binarylog.ServerHeader{
|
|
|
|
Header: h,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
binlog.Log(&binarylog.ServerTrailer{
|
|
|
|
Trailer: stream.Trailer(),
|
|
|
|
Err: appErr,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return appErr
|
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(stringer("OK"), false)
|
|
|
|
}
|
|
|
|
opts := &transport.Options{Last: true}
|
|
|
|
|
|
|
|
if err := s.sendResponse(t, stream, reply, cp, opts, comp); err != nil {
|
|
|
|
if err == io.EOF {
|
|
|
|
// The entire stream is done (for unary RPC only).
|
|
|
|
return err
|
|
|
|
}
|
2020-03-12 16:11:27 +00:00
|
|
|
if sts, ok := status.FromError(err); ok {
|
|
|
|
if e := t.WriteStatus(stream, sts); e != nil {
|
2020-08-05 08:15:42 +00:00
|
|
|
channelz.Warningf(logger, s.channelzID, "grpc: Server.processUnaryRPC failed to write status: %v", e)
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
switch st := err.(type) {
|
|
|
|
case transport.ConnectionError:
|
|
|
|
// Nothing to do here.
|
|
|
|
default:
|
|
|
|
panic(fmt.Sprintf("grpc: Unexpected error (%T) from sendResponse: %v", st, st))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if binlog != nil {
|
|
|
|
h, _ := stream.Header()
|
|
|
|
binlog.Log(&binarylog.ServerHeader{
|
|
|
|
Header: h,
|
|
|
|
})
|
|
|
|
binlog.Log(&binarylog.ServerTrailer{
|
|
|
|
Trailer: stream.Trailer(),
|
|
|
|
Err: appErr,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if binlog != nil {
|
|
|
|
h, _ := stream.Header()
|
|
|
|
binlog.Log(&binarylog.ServerHeader{
|
|
|
|
Header: h,
|
|
|
|
})
|
|
|
|
binlog.Log(&binarylog.ServerMessage{
|
|
|
|
Message: reply,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
if channelz.IsOn() {
|
|
|
|
t.IncrMsgSent()
|
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(&payload{sent: true, msg: reply}, true)
|
|
|
|
}
|
|
|
|
// TODO: Should we be logging if writing status failed here, like above?
|
|
|
|
// Should the logging be in WriteStatus? Should we ignore the WriteStatus
|
|
|
|
// error or allow the stats handler to see it?
|
|
|
|
err = t.WriteStatus(stream, statusOK)
|
|
|
|
if binlog != nil {
|
|
|
|
binlog.Log(&binarylog.ServerTrailer{
|
|
|
|
Trailer: stream.Trailer(),
|
|
|
|
Err: appErr,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2020-03-12 16:11:27 +00:00
|
|
|
// chainStreamServerInterceptors chains all stream server interceptors into one.
|
|
|
|
func chainStreamServerInterceptors(s *Server) {
|
|
|
|
// Prepend opts.streamInt to the chaining interceptors if it exists, since streamInt will
|
|
|
|
// be executed before any other chained interceptors.
|
|
|
|
interceptors := s.opts.chainStreamInts
|
|
|
|
if s.opts.streamInt != nil {
|
|
|
|
interceptors = append([]StreamServerInterceptor{s.opts.streamInt}, s.opts.chainStreamInts...)
|
|
|
|
}
|
|
|
|
|
|
|
|
var chainedInt StreamServerInterceptor
|
|
|
|
if len(interceptors) == 0 {
|
|
|
|
chainedInt = nil
|
|
|
|
} else if len(interceptors) == 1 {
|
|
|
|
chainedInt = interceptors[0]
|
|
|
|
} else {
|
2021-08-13 10:03:03 +00:00
|
|
|
chainedInt = chainStreamInterceptors(interceptors)
|
2020-03-12 16:11:27 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
s.opts.streamInt = chainedInt
|
|
|
|
}
|
|
|
|
|
2021-08-13 10:03:03 +00:00
|
|
|
func chainStreamInterceptors(interceptors []StreamServerInterceptor) StreamServerInterceptor {
|
|
|
|
return func(srv interface{}, ss ServerStream, info *StreamServerInfo, handler StreamHandler) error {
|
2021-11-08 10:41:15 +00:00
|
|
|
// the struct ensures the variables are allocated together, rather than separately, since we
|
|
|
|
// know they should be garbage collected together. This saves 1 allocation and decreases
|
|
|
|
// time/call by about 10% on the microbenchmark.
|
|
|
|
var state struct {
|
|
|
|
i int
|
|
|
|
next StreamHandler
|
|
|
|
}
|
|
|
|
state.next = func(srv interface{}, ss ServerStream) error {
|
|
|
|
if state.i == len(interceptors)-1 {
|
|
|
|
return interceptors[state.i](srv, ss, info, handler)
|
2021-08-13 10:03:03 +00:00
|
|
|
}
|
2021-11-08 10:41:15 +00:00
|
|
|
state.i++
|
|
|
|
return interceptors[state.i-1](srv, ss, info, state.next)
|
2021-08-13 10:03:03 +00:00
|
|
|
}
|
2021-11-08 10:41:15 +00:00
|
|
|
return state.next(srv, ss)
|
2020-03-12 16:11:27 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-10 06:49:55 +00:00
|
|
|
func (s *Server) processStreamingRPC(t transport.ServerTransport, stream *transport.Stream, info *serviceInfo, sd *StreamDesc, trInfo *traceInfo) (err error) {
|
2019-11-07 19:05:39 +00:00
|
|
|
if channelz.IsOn() {
|
|
|
|
s.incrCallsStarted()
|
|
|
|
}
|
2022-07-13 13:43:46 +00:00
|
|
|
shs := s.opts.statsHandlers
|
2019-12-26 17:42:48 +00:00
|
|
|
var statsBegin *stats.Begin
|
2022-07-13 13:43:46 +00:00
|
|
|
if len(shs) != 0 {
|
2019-11-07 19:05:39 +00:00
|
|
|
beginTime := time.Now()
|
2019-12-26 17:42:48 +00:00
|
|
|
statsBegin = &stats.Begin{
|
2021-08-13 10:03:03 +00:00
|
|
|
BeginTime: beginTime,
|
|
|
|
IsClientStream: sd.ClientStreams,
|
|
|
|
IsServerStream: sd.ServerStreams,
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2022-07-13 13:43:46 +00:00
|
|
|
for _, sh := range shs {
|
|
|
|
sh.HandleRPC(stream.Context(), statsBegin)
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
ctx := NewContextWithServerTransportStream(stream.Context(), stream)
|
|
|
|
ss := &serverStream{
|
|
|
|
ctx: ctx,
|
|
|
|
t: t,
|
|
|
|
s: stream,
|
|
|
|
p: &parser{r: stream},
|
|
|
|
codec: s.getCodec(stream.ContentSubtype()),
|
|
|
|
maxReceiveMessageSize: s.opts.maxReceiveMessageSize,
|
|
|
|
maxSendMessageSize: s.opts.maxSendMessageSize,
|
|
|
|
trInfo: trInfo,
|
2022-07-13 13:43:46 +00:00
|
|
|
statsHandler: shs,
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
|
2022-07-13 13:43:46 +00:00
|
|
|
if len(shs) != 0 || trInfo != nil || channelz.IsOn() {
|
2019-12-26 17:42:48 +00:00
|
|
|
// See comment in processUnaryRPC on defers.
|
|
|
|
defer func() {
|
|
|
|
if trInfo != nil {
|
|
|
|
ss.mu.Lock()
|
|
|
|
if err != nil && err != io.EOF {
|
|
|
|
ss.trInfo.tr.LazyLog(&fmtStringer{"%v", []interface{}{err}}, true)
|
|
|
|
ss.trInfo.tr.SetError()
|
|
|
|
}
|
|
|
|
ss.trInfo.tr.Finish()
|
|
|
|
ss.trInfo.tr = nil
|
|
|
|
ss.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
2022-07-13 13:43:46 +00:00
|
|
|
if len(shs) != 0 {
|
2019-12-26 17:42:48 +00:00
|
|
|
end := &stats.End{
|
|
|
|
BeginTime: statsBegin.BeginTime,
|
|
|
|
EndTime: time.Now(),
|
|
|
|
}
|
|
|
|
if err != nil && err != io.EOF {
|
|
|
|
end.Error = toRPCErr(err)
|
|
|
|
}
|
2022-07-13 13:43:46 +00:00
|
|
|
for _, sh := range shs {
|
|
|
|
sh.HandleRPC(stream.Context(), end)
|
|
|
|
}
|
2019-12-26 17:42:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if channelz.IsOn() {
|
|
|
|
if err != nil && err != io.EOF {
|
|
|
|
s.incrCallsFailed()
|
|
|
|
} else {
|
|
|
|
s.incrCallsSucceeded()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
}
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
ss.binlog = binarylog.GetMethodLogger(stream.Method())
|
|
|
|
if ss.binlog != nil {
|
|
|
|
md, _ := metadata.FromIncomingContext(ctx)
|
|
|
|
logEntry := &binarylog.ClientHeader{
|
|
|
|
Header: md,
|
|
|
|
MethodName: stream.Method(),
|
|
|
|
PeerAddr: nil,
|
|
|
|
}
|
|
|
|
if deadline, ok := ctx.Deadline(); ok {
|
|
|
|
logEntry.Timeout = time.Until(deadline)
|
|
|
|
if logEntry.Timeout < 0 {
|
|
|
|
logEntry.Timeout = 0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if a := md[":authority"]; len(a) > 0 {
|
|
|
|
logEntry.Authority = a[0]
|
|
|
|
}
|
|
|
|
if peer, ok := peer.FromContext(ss.Context()); ok {
|
|
|
|
logEntry.PeerAddr = peer.Addr
|
|
|
|
}
|
|
|
|
ss.binlog.Log(logEntry)
|
|
|
|
}
|
|
|
|
|
|
|
|
// If dc is set and matches the stream's compression, use it. Otherwise, try
|
|
|
|
// to find a matching registered compressor for decomp.
|
|
|
|
if rc := stream.RecvCompress(); s.opts.dc != nil && s.opts.dc.Type() == rc {
|
|
|
|
ss.dc = s.opts.dc
|
|
|
|
} else if rc != "" && rc != encoding.Identity {
|
|
|
|
ss.decomp = encoding.GetCompressor(rc)
|
|
|
|
if ss.decomp == nil {
|
|
|
|
st := status.Newf(codes.Unimplemented, "grpc: Decompressor is not installed for grpc-encoding %q", rc)
|
|
|
|
t.WriteStatus(ss.s, st)
|
|
|
|
return st.Err()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// If cp is set, use it. Otherwise, attempt to compress the response using
|
|
|
|
// the incoming message compression method.
|
|
|
|
//
|
|
|
|
// NOTE: this needs to be ahead of all handling, https://github.com/grpc/grpc-go/issues/686.
|
|
|
|
if s.opts.cp != nil {
|
|
|
|
ss.cp = s.opts.cp
|
|
|
|
stream.SetSendCompress(s.opts.cp.Type())
|
|
|
|
} else if rc := stream.RecvCompress(); rc != "" && rc != encoding.Identity {
|
|
|
|
// Legacy compressor not specified; attempt to respond with same encoding.
|
|
|
|
ss.comp = encoding.GetCompressor(rc)
|
|
|
|
if ss.comp != nil {
|
|
|
|
stream.SetSendCompress(rc)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-07-07 13:10:33 +00:00
|
|
|
ss.ctx = newContextWithRPCInfo(ss.ctx, false, ss.codec, ss.cp, ss.comp)
|
|
|
|
|
2019-11-07 19:05:39 +00:00
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(&trInfo.firstLine, false)
|
|
|
|
}
|
|
|
|
var appErr error
|
|
|
|
var server interface{}
|
2020-09-10 06:49:55 +00:00
|
|
|
if info != nil {
|
|
|
|
server = info.serviceImpl
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
if s.opts.streamInt == nil {
|
|
|
|
appErr = sd.Handler(server, ss)
|
|
|
|
} else {
|
|
|
|
info := &StreamServerInfo{
|
|
|
|
FullMethod: stream.Method(),
|
|
|
|
IsClientStream: sd.ClientStreams,
|
|
|
|
IsServerStream: sd.ServerStreams,
|
|
|
|
}
|
|
|
|
appErr = s.opts.streamInt(server, ss, info, sd.Handler)
|
|
|
|
}
|
|
|
|
if appErr != nil {
|
|
|
|
appStatus, ok := status.FromError(appErr)
|
|
|
|
if !ok {
|
2022-03-16 11:55:03 +00:00
|
|
|
// Convert non-status application error to a status error with code
|
|
|
|
// Unknown, but handle context errors specifically.
|
|
|
|
appStatus = status.FromContextError(appErr)
|
2019-11-07 19:05:39 +00:00
|
|
|
appErr = appStatus.Err()
|
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
ss.mu.Lock()
|
|
|
|
ss.trInfo.tr.LazyLog(stringer(appStatus.Message()), true)
|
|
|
|
ss.trInfo.tr.SetError()
|
|
|
|
ss.mu.Unlock()
|
|
|
|
}
|
|
|
|
t.WriteStatus(ss.s, appStatus)
|
|
|
|
if ss.binlog != nil {
|
|
|
|
ss.binlog.Log(&binarylog.ServerTrailer{
|
|
|
|
Trailer: ss.s.Trailer(),
|
|
|
|
Err: appErr,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
// TODO: Should we log an error from WriteStatus here and below?
|
|
|
|
return appErr
|
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
ss.mu.Lock()
|
|
|
|
ss.trInfo.tr.LazyLog(stringer("OK"), false)
|
|
|
|
ss.mu.Unlock()
|
|
|
|
}
|
|
|
|
err = t.WriteStatus(ss.s, statusOK)
|
|
|
|
if ss.binlog != nil {
|
|
|
|
ss.binlog.Log(&binarylog.ServerTrailer{
|
|
|
|
Trailer: ss.s.Trailer(),
|
|
|
|
Err: appErr,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *Server) handleStream(t transport.ServerTransport, stream *transport.Stream, trInfo *traceInfo) {
|
|
|
|
sm := stream.Method()
|
|
|
|
if sm != "" && sm[0] == '/' {
|
|
|
|
sm = sm[1:]
|
|
|
|
}
|
|
|
|
pos := strings.LastIndex(sm, "/")
|
|
|
|
if pos == -1 {
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(&fmtStringer{"Malformed method name %q", []interface{}{sm}}, true)
|
|
|
|
trInfo.tr.SetError()
|
|
|
|
}
|
|
|
|
errDesc := fmt.Sprintf("malformed method name: %q", stream.Method())
|
2021-07-07 13:10:33 +00:00
|
|
|
if err := t.WriteStatus(stream, status.New(codes.Unimplemented, errDesc)); err != nil {
|
2019-11-07 19:05:39 +00:00
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(&fmtStringer{"%v", []interface{}{err}}, true)
|
|
|
|
trInfo.tr.SetError()
|
|
|
|
}
|
2020-08-05 08:15:42 +00:00
|
|
|
channelz.Warningf(logger, s.channelzID, "grpc: Server.handleStream failed to write status: %v", err)
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.Finish()
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
service := sm[:pos]
|
|
|
|
method := sm[pos+1:]
|
|
|
|
|
2020-09-10 06:49:55 +00:00
|
|
|
srv, knownService := s.services[service]
|
2019-11-07 19:05:39 +00:00
|
|
|
if knownService {
|
2020-09-10 06:49:55 +00:00
|
|
|
if md, ok := srv.methods[method]; ok {
|
2019-11-07 19:05:39 +00:00
|
|
|
s.processUnaryRPC(t, stream, srv, md, trInfo)
|
|
|
|
return
|
|
|
|
}
|
2020-09-10 06:49:55 +00:00
|
|
|
if sd, ok := srv.streams[method]; ok {
|
2019-11-07 19:05:39 +00:00
|
|
|
s.processStreamingRPC(t, stream, srv, sd, trInfo)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// Unknown service, or known server unknown method.
|
|
|
|
if unknownDesc := s.opts.unknownStreamDesc; unknownDesc != nil {
|
|
|
|
s.processStreamingRPC(t, stream, nil, unknownDesc, trInfo)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
var errDesc string
|
|
|
|
if !knownService {
|
|
|
|
errDesc = fmt.Sprintf("unknown service %v", service)
|
|
|
|
} else {
|
|
|
|
errDesc = fmt.Sprintf("unknown method %v for service %v", method, service)
|
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyPrintf("%s", errDesc)
|
|
|
|
trInfo.tr.SetError()
|
|
|
|
}
|
|
|
|
if err := t.WriteStatus(stream, status.New(codes.Unimplemented, errDesc)); err != nil {
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.LazyLog(&fmtStringer{"%v", []interface{}{err}}, true)
|
|
|
|
trInfo.tr.SetError()
|
|
|
|
}
|
2020-08-05 08:15:42 +00:00
|
|
|
channelz.Warningf(logger, s.channelzID, "grpc: Server.handleStream failed to write status: %v", err)
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
if trInfo != nil {
|
|
|
|
trInfo.tr.Finish()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// The key to save ServerTransportStream in the context.
|
|
|
|
type streamKey struct{}
|
|
|
|
|
|
|
|
// NewContextWithServerTransportStream creates a new context from ctx and
|
|
|
|
// attaches stream to it.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
func NewContextWithServerTransportStream(ctx context.Context, stream ServerTransportStream) context.Context {
|
|
|
|
return context.WithValue(ctx, streamKey{}, stream)
|
|
|
|
}
|
|
|
|
|
|
|
|
// ServerTransportStream is a minimal interface that a transport stream must
|
|
|
|
// implement. This can be used to mock an actual transport stream for tests of
|
|
|
|
// handler code that use, for example, grpc.SetHeader (which requires some
|
|
|
|
// stream to be in context).
|
|
|
|
//
|
|
|
|
// See also NewContextWithServerTransportStream.
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This type is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
type ServerTransportStream interface {
|
|
|
|
Method() string
|
|
|
|
SetHeader(md metadata.MD) error
|
|
|
|
SendHeader(md metadata.MD) error
|
|
|
|
SetTrailer(md metadata.MD) error
|
|
|
|
}
|
|
|
|
|
|
|
|
// ServerTransportStreamFromContext returns the ServerTransportStream saved in
|
|
|
|
// ctx. Returns nil if the given context has no stream associated with it
|
|
|
|
// (which implies it is not an RPC invocation context).
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// # Experimental
|
2020-10-16 12:04:44 +00:00
|
|
|
//
|
|
|
|
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
|
|
|
|
// later release.
|
2019-11-07 19:05:39 +00:00
|
|
|
func ServerTransportStreamFromContext(ctx context.Context) ServerTransportStream {
|
|
|
|
s, _ := ctx.Value(streamKey{}).(ServerTransportStream)
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// Stop stops the gRPC server. It immediately closes all open
|
|
|
|
// connections and listeners.
|
|
|
|
// It cancels all active RPCs on the server side and the corresponding
|
|
|
|
// pending RPCs on the client side will get notified by connection
|
|
|
|
// errors.
|
|
|
|
func (s *Server) Stop() {
|
|
|
|
s.quit.Fire()
|
|
|
|
|
|
|
|
defer func() {
|
|
|
|
s.serveWG.Wait()
|
|
|
|
s.done.Fire()
|
|
|
|
}()
|
|
|
|
|
2022-04-26 12:24:23 +00:00
|
|
|
s.channelzRemoveOnce.Do(func() { channelz.RemoveEntry(s.channelzID) })
|
2019-11-07 19:05:39 +00:00
|
|
|
|
|
|
|
s.mu.Lock()
|
|
|
|
listeners := s.lis
|
|
|
|
s.lis = nil
|
2021-05-20 15:38:21 +00:00
|
|
|
conns := s.conns
|
2019-11-07 19:05:39 +00:00
|
|
|
s.conns = nil
|
|
|
|
// interrupt GracefulStop if Stop and GracefulStop are called concurrently.
|
|
|
|
s.cv.Broadcast()
|
|
|
|
s.mu.Unlock()
|
|
|
|
|
|
|
|
for lis := range listeners {
|
|
|
|
lis.Close()
|
|
|
|
}
|
2021-05-20 15:38:21 +00:00
|
|
|
for _, cs := range conns {
|
|
|
|
for st := range cs {
|
|
|
|
st.Close()
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
2020-06-25 20:42:41 +00:00
|
|
|
if s.opts.numServerWorkers > 0 {
|
|
|
|
s.stopServerWorkers()
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
|
|
|
|
s.mu.Lock()
|
|
|
|
if s.events != nil {
|
|
|
|
s.events.Finish()
|
|
|
|
s.events = nil
|
|
|
|
}
|
|
|
|
s.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
|
|
|
// GracefulStop stops the gRPC server gracefully. It stops the server from
|
|
|
|
// accepting new connections and RPCs and blocks until all the pending RPCs are
|
|
|
|
// finished.
|
|
|
|
func (s *Server) GracefulStop() {
|
|
|
|
s.quit.Fire()
|
|
|
|
defer s.done.Fire()
|
|
|
|
|
2022-04-26 12:24:23 +00:00
|
|
|
s.channelzRemoveOnce.Do(func() { channelz.RemoveEntry(s.channelzID) })
|
2019-11-07 19:05:39 +00:00
|
|
|
s.mu.Lock()
|
|
|
|
if s.conns == nil {
|
|
|
|
s.mu.Unlock()
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
for lis := range s.lis {
|
|
|
|
lis.Close()
|
|
|
|
}
|
|
|
|
s.lis = nil
|
|
|
|
if !s.drain {
|
2021-05-20 15:38:21 +00:00
|
|
|
for _, conns := range s.conns {
|
|
|
|
for st := range conns {
|
|
|
|
st.Drain()
|
|
|
|
}
|
2019-11-07 19:05:39 +00:00
|
|
|
}
|
|
|
|
s.drain = true
|
|
|
|
}
|
|
|
|
|
|
|
|
// Wait for serving threads to be ready to exit. Only then can we be sure no
|
|
|
|
// new conns will be created.
|
|
|
|
s.mu.Unlock()
|
|
|
|
s.serveWG.Wait()
|
|
|
|
s.mu.Lock()
|
|
|
|
|
|
|
|
for len(s.conns) != 0 {
|
|
|
|
s.cv.Wait()
|
|
|
|
}
|
|
|
|
s.conns = nil
|
|
|
|
if s.events != nil {
|
|
|
|
s.events.Finish()
|
|
|
|
s.events = nil
|
|
|
|
}
|
|
|
|
s.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
|
|
|
// contentSubtype must be lowercase
|
|
|
|
// cannot return nil
|
|
|
|
func (s *Server) getCodec(contentSubtype string) baseCodec {
|
|
|
|
if s.opts.codec != nil {
|
|
|
|
return s.opts.codec
|
|
|
|
}
|
|
|
|
if contentSubtype == "" {
|
|
|
|
return encoding.GetCodec(proto.Name)
|
|
|
|
}
|
|
|
|
codec := encoding.GetCodec(contentSubtype)
|
|
|
|
if codec == nil {
|
|
|
|
return encoding.GetCodec(proto.Name)
|
|
|
|
}
|
|
|
|
return codec
|
|
|
|
}
|
|
|
|
|
2022-06-06 10:25:03 +00:00
|
|
|
// SetHeader sets the header metadata to be sent from the server to the client.
|
|
|
|
// The context provided must be the context passed to the server's handler.
|
|
|
|
//
|
|
|
|
// Streaming RPCs should prefer the SetHeader method of the ServerStream.
|
|
|
|
//
|
|
|
|
// When called multiple times, all the provided metadata will be merged. All
|
|
|
|
// the metadata will be sent out when one of the following happens:
|
|
|
|
//
|
2022-08-30 06:45:26 +00:00
|
|
|
// - grpc.SendHeader is called, or for streaming handlers, stream.SendHeader.
|
|
|
|
// - The first response message is sent. For unary handlers, this occurs when
|
|
|
|
// the handler returns; for streaming handlers, this can happen when stream's
|
|
|
|
// SendMsg method is called.
|
|
|
|
// - An RPC status is sent out (error or success). This occurs when the handler
|
|
|
|
// returns.
|
2022-06-06 10:25:03 +00:00
|
|
|
//
|
|
|
|
// SetHeader will fail if called after any of the events above.
|
|
|
|
//
|
|
|
|
// The error returned is compatible with the status package. However, the
|
|
|
|
// status code will often not match the RPC status as seen by the client
|
|
|
|
// application, and therefore, should not be relied upon for this purpose.
|
2019-11-07 19:05:39 +00:00
|
|
|
func SetHeader(ctx context.Context, md metadata.MD) error {
|
|
|
|
if md.Len() == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
stream := ServerTransportStreamFromContext(ctx)
|
|
|
|
if stream == nil {
|
|
|
|
return status.Errorf(codes.Internal, "grpc: failed to fetch the stream from the context %v", ctx)
|
|
|
|
}
|
|
|
|
return stream.SetHeader(md)
|
|
|
|
}
|
|
|
|
|
2022-06-06 10:25:03 +00:00
|
|
|
// SendHeader sends header metadata. It may be called at most once, and may not
|
|
|
|
// be called after any event that causes headers to be sent (see SetHeader for
|
|
|
|
// a complete list). The provided md and headers set by SetHeader() will be
|
|
|
|
// sent.
|
|
|
|
//
|
|
|
|
// The error returned is compatible with the status package. However, the
|
|
|
|
// status code will often not match the RPC status as seen by the client
|
|
|
|
// application, and therefore, should not be relied upon for this purpose.
|
2019-11-07 19:05:39 +00:00
|
|
|
func SendHeader(ctx context.Context, md metadata.MD) error {
|
|
|
|
stream := ServerTransportStreamFromContext(ctx)
|
|
|
|
if stream == nil {
|
|
|
|
return status.Errorf(codes.Internal, "grpc: failed to fetch the stream from the context %v", ctx)
|
|
|
|
}
|
|
|
|
if err := stream.SendHeader(md); err != nil {
|
|
|
|
return toRPCErr(err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetTrailer sets the trailer metadata that will be sent when an RPC returns.
|
|
|
|
// When called more than once, all the provided metadata will be merged.
|
2022-06-06 10:25:03 +00:00
|
|
|
//
|
|
|
|
// The error returned is compatible with the status package. However, the
|
|
|
|
// status code will often not match the RPC status as seen by the client
|
|
|
|
// application, and therefore, should not be relied upon for this purpose.
|
2019-11-07 19:05:39 +00:00
|
|
|
func SetTrailer(ctx context.Context, md metadata.MD) error {
|
|
|
|
if md.Len() == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
stream := ServerTransportStreamFromContext(ctx)
|
|
|
|
if stream == nil {
|
|
|
|
return status.Errorf(codes.Internal, "grpc: failed to fetch the stream from the context %v", ctx)
|
|
|
|
}
|
|
|
|
return stream.SetTrailer(md)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Method returns the method string for the server context. The returned
|
|
|
|
// string is in the format of "/service/method".
|
|
|
|
func Method(ctx context.Context) (string, bool) {
|
|
|
|
s := ServerTransportStreamFromContext(ctx)
|
|
|
|
if s == nil {
|
|
|
|
return "", false
|
|
|
|
}
|
|
|
|
return s.Method(), true
|
|
|
|
}
|
|
|
|
|
|
|
|
type channelzServer struct {
|
|
|
|
s *Server
|
|
|
|
}
|
|
|
|
|
|
|
|
func (c *channelzServer) ChannelzMetric() *channelz.ServerInternalMetric {
|
|
|
|
return c.s.channelzMetric()
|
|
|
|
}
|