-
Notifications
You must be signed in to change notification settings - Fork 85
/
server_transport_tcp.go
341 lines (313 loc) · 9.21 KB
/
server_transport_tcp.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
//
//
// Tencent is pleased to support the open source community by making tRPC available.
//
// Copyright (C) 2023 THL A29 Limited, a Tencent company.
// All rights reserved.
//
// If you have downloaded a copy of the tRPC source code from Tencent,
// please note that tRPC source code is licensed under the Apache 2.0 License,
// A copy of the Apache 2.0 License is included in this file.
//
//
package transport
import (
"context"
"io"
"math"
"net"
"strings"
"sync"
"time"
"github.com/panjf2000/ants/v2"
"trpc.group/trpc-go/trpc-go/codec"
"trpc.group/trpc-go/trpc-go/errs"
"trpc.group/trpc-go/trpc-go/internal/addrutil"
"trpc.group/trpc-go/trpc-go/internal/report"
"trpc.group/trpc-go/trpc-go/internal/writev"
"trpc.group/trpc-go/trpc-go/log"
"trpc.group/trpc-go/trpc-go/rpcz"
"trpc.group/trpc-go/trpc-go/transport/internal/frame"
)
const defaultBufferSize = 128 * 1024
type handleParam struct {
req []byte
c *tcpconn
start time.Time
}
func (p *handleParam) reset() {
p.req = nil
p.c = nil
p.start = time.Time{}
}
var handleParamPool = &sync.Pool{
New: func() interface{} { return new(handleParam) },
}
func createRoutinePool(size int) *ants.PoolWithFunc {
if size <= 0 {
size = math.MaxInt32
}
pool, err := ants.NewPoolWithFunc(size, func(args interface{}) {
param, ok := args.(*handleParam)
if !ok {
log.Tracef("routine pool args type error, shouldn't happen!")
return
}
report.TCPServerAsyncGoroutineScheduleDelay.Set(float64(time.Since(param.start).Microseconds()))
if param.c == nil {
log.Tracef("routine pool tcpconn is nil, shouldn't happen!")
return
}
param.c.handleSync(param.req)
param.reset()
handleParamPool.Put(param)
})
if err != nil {
log.Tracef("routine pool create error:%v", err)
return nil
}
return pool
}
func (s *serverTransport) serveTCP(ctx context.Context, ln net.Listener, opts *ListenServeOptions) error {
// Create a goroutine pool if ServerAsync enabled.
var pool *ants.PoolWithFunc
if opts.ServerAsync {
pool = createRoutinePool(opts.Routines)
}
for tempDelay := time.Duration(0); ; {
rwc, err := ln.Accept()
if err != nil {
if ne, ok := err.(net.Error); ok && ne.Temporary() {
tempDelay = doTempDelay(tempDelay)
continue
}
select {
case <-ctx.Done(): // If this error is triggered by the user, such as during a restart,
return err // it is possible to directly return the error, causing the current listener to exit.
default:
// Restricted access to the internal/poll.ErrNetClosing type necessitates comparing a string literal.
const accept, closeError = "accept", "use of closed network connection"
const msg = "the server transport, listening on %s, encountered an error: %+v; this error was handled" +
" gracefully by the framework to prevent abnormal termination, serving as a reference for" +
" investigating acceptance errors that can't be filtered by the Temporary interface"
if e, ok := err.(*net.OpError); ok && e.Op == accept && strings.Contains(e.Err.Error(), closeError) {
log.Infof("listener with address %s is closed", ln.Addr())
return err
}
log.Errorf(msg, ln.Addr(), err)
continue
}
}
tempDelay = 0
if tcpConn, ok := rwc.(*net.TCPConn); ok {
if err := tcpConn.SetKeepAlive(true); err != nil {
log.Tracef("tcp conn set keepalive error:%v", err)
}
if s.opts.KeepAlivePeriod > 0 {
if err := tcpConn.SetKeepAlivePeriod(s.opts.KeepAlivePeriod); err != nil {
log.Tracef("tcp conn set keepalive period error:%v", err)
}
}
}
tc := &tcpconn{
conn: s.newConn(ctx, opts),
rwc: rwc,
fr: opts.FramerBuilder.New(codec.NewReader(rwc)),
remoteAddr: rwc.RemoteAddr(),
localAddr: rwc.LocalAddr(),
serverAsync: opts.ServerAsync,
writev: opts.Writev,
st: s,
pool: pool,
}
// Start goroutine sending with writev.
if tc.writev {
tc.buffer = writev.NewBuffer()
tc.closeNotify = make(chan struct{}, 1)
tc.buffer.Start(tc.rwc, tc.closeNotify)
}
// To avoid over writing packages, checks whether should we copy packages by Framer and
// some other configurations.
tc.copyFrame = frame.ShouldCopy(opts.CopyFrame, tc.serverAsync, codec.IsSafeFramer(tc.fr))
key := addrutil.AddrToKey(tc.localAddr, tc.remoteAddr)
s.m.Lock()
s.addrToConn[key] = tc
s.m.Unlock()
go tc.serve()
}
}
func doTempDelay(tempDelay time.Duration) time.Duration {
if tempDelay == 0 {
tempDelay = 5 * time.Millisecond
} else {
tempDelay *= 2
}
if max := 1 * time.Second; tempDelay > max {
tempDelay = max
}
time.Sleep(tempDelay)
return tempDelay
}
// tcpconn is the connection which is established when server accept a client connecting request.
type tcpconn struct {
*conn
rwc net.Conn
fr codec.Framer
localAddr net.Addr
remoteAddr net.Addr
serverAsync bool
writev bool
copyFrame bool
closeOnce sync.Once
st *serverTransport
pool *ants.PoolWithFunc
buffer *writev.Buffer
closeNotify chan struct{}
}
// close closes socket and cleans up.
func (c *tcpconn) close() {
c.closeOnce.Do(func() {
// Send error msg to handler.
ctx, msg := codec.WithNewMessage(context.Background())
msg.WithLocalAddr(c.localAddr)
msg.WithRemoteAddr(c.remoteAddr)
e := &errs.Error{
Type: errs.ErrorTypeFramework,
Code: errs.RetServerSystemErr,
Desc: "trpc",
Msg: "Server connection closed",
}
msg.WithServerRspErr(e)
// The connection closing message is handed over to handler.
if err := c.conn.handleClose(ctx); err != nil {
log.Trace("transport: notify connection close failed", err)
}
// Notify to stop writev sending goroutine.
if c.writev {
close(c.closeNotify)
}
// Remove cache in server stream transport.
key := addrutil.AddrToKey(c.localAddr, c.remoteAddr)
c.st.m.Lock()
delete(c.st.addrToConn, key)
c.st.m.Unlock()
// Finally, close the socket connection.
c.rwc.Close()
})
}
// write encapsulates tcp conn write.
func (c *tcpconn) write(p []byte) (int, error) {
if c.writev {
return c.buffer.Write(p)
}
return c.rwc.Write(p)
}
func (c *tcpconn) serve() {
defer c.close()
for {
// Check if upstream has closed.
select {
case <-c.ctx.Done():
return
default:
}
if c.idleTimeout > 0 {
now := time.Now()
// SetReadDeadline has poor performance, so, update timeout every 5 seconds.
if now.Sub(c.lastVisited) > 5*time.Second {
c.lastVisited = now
err := c.rwc.SetReadDeadline(now.Add(c.idleTimeout))
if err != nil {
log.Trace("transport: tcpconn SetReadDeadline fail ", err)
return
}
}
}
req, err := c.fr.ReadFrame()
if err != nil {
if err == io.EOF {
report.TCPServerTransportReadEOF.Incr() // client has closed the connections.
return
}
// Server closes the connection if client sends no package in last idle timeout.
if e, ok := err.(net.Error); ok && e.Timeout() {
report.TCPServerTransportIdleTimeout.Incr()
return
}
report.TCPServerTransportReadFail.Incr()
log.Trace("transport: tcpconn serve ReadFrame fail ", err)
return
}
report.TCPServerTransportReceiveSize.Set(float64(len(req)))
// if framer is not concurrent safe, copy the data to avoid over writing.
if c.copyFrame {
reqCopy := make([]byte, len(req))
copy(reqCopy, req)
req = reqCopy
}
c.handle(req)
}
}
func (c *tcpconn) handle(req []byte) {
if !c.serverAsync || c.pool == nil {
c.handleSync(req)
return
}
// Using sync.pool to dispatch package processing goroutine parameters can reduce a memory
// allocation and slightly promote performance.
args := handleParamPool.Get().(*handleParam)
args.req = req
args.c = c
args.start = time.Now()
if err := c.pool.Invoke(args); err != nil {
report.TCPServerTransportJobQueueFullFail.Incr()
log.Trace("transport: tcpconn serve routine pool put job queue fail ", err)
c.handleSyncWithErr(req, errs.ErrServerRoutinePoolBusy)
}
}
func (c *tcpconn) handleSync(req []byte) {
c.handleSyncWithErr(req, nil)
}
func (c *tcpconn) handleSyncWithErr(req []byte, e error) {
ctx, msg := codec.WithNewMessage(context.Background())
defer codec.PutBackMessage(msg)
msg.WithServerRspErr(e)
// Record local addr and remote addr to context.
msg.WithLocalAddr(c.localAddr)
msg.WithRemoteAddr(c.remoteAddr)
span, ender, ctx := rpcz.NewSpanContext(ctx, "server")
span.SetAttribute(rpcz.TRPCAttributeRequestSize, len(req))
rsp, err := c.conn.handle(ctx, req)
defer func() {
span.SetAttribute(rpcz.TRPCAttributeRPCName, msg.ServerRPCName())
if err == nil {
span.SetAttribute(rpcz.TRPCAttributeError, msg.ServerRspErr())
} else {
span.SetAttribute(rpcz.TRPCAttributeError, err)
}
ender.End()
}()
if err != nil {
if err != errs.ErrServerNoResponse {
report.TCPServerTransportHandleFail.Incr()
log.Trace("transport: tcpconn serve handle fail ", err)
c.close()
return
}
// On stream RPC, server does not need to write rsp, just returns.
return
}
report.TCPServerTransportSendSize.Set(float64(len(rsp)))
span.SetAttribute(rpcz.TRPCAttributeResponseSize, len(rsp))
{
// common RPC write rsp.
_, ender := span.NewChild("SendMessage")
_, err = c.write(rsp)
ender.End()
}
if err != nil {
report.TCPServerTransportWriteFail.Incr()
log.Trace("transport: tcpconn write fail ", err)
c.close()
}
}