-
Notifications
You must be signed in to change notification settings - Fork 269
/
grpc_client.go
435 lines (369 loc) · 11.6 KB
/
grpc_client.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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
// Copyright 2021 PingCAP, Inc.
//
// 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,
// See the License for the specific language governing permissions and
// limitations under the License.
package p2p
import (
"context"
"sync"
"time"
"github.com/pingcap/errors"
"github.com/pingcap/failpoint"
"github.com/pingcap/log"
"github.com/pingcap/tiflow/pkg/container/queue"
cerrors "github.com/pingcap/tiflow/pkg/errors"
"github.com/pingcap/tiflow/pkg/p2p/internal"
"github.com/pingcap/tiflow/pkg/security"
"github.com/pingcap/tiflow/proto/p2p"
"github.com/prometheus/client_golang/prometheus"
"go.uber.org/atomic"
"go.uber.org/zap"
"golang.org/x/sync/errgroup"
"golang.org/x/time/rate"
gRPCPeer "google.golang.org/grpc/peer"
)
// grpcMessageClient is a client used to send peer messages.
// `Run` must be running before sending any message.
type grpcMessageClient struct {
sendCh *internal.SendChan
topicMu sync.RWMutex
topics map[string]*topicEntry
senderID NodeID
closeCh chan struct{}
isClosed atomic.Bool
// config is read only
config *MessageClientConfig
// newSender is used to create a new sender.
// It can be replaced to unit test MessageClient.
newSenderFn func(MessageClientStream) clientBatchSender[MessageEntry]
connector clientConnector
}
type topicEntry struct {
sentMessageMu sync.Mutex
sentMessages queue.ChunkQueue[*p2p.MessageEntry]
nextSeq atomic.Int64
ack atomic.Int64
lastSent atomic.Int64
}
// NewGrpcMessageClient creates a new MessageClient
// senderID is an identifier for the local node.
func NewGrpcMessageClient(senderID NodeID, config *MessageClientConfig) *grpcMessageClient {
return &grpcMessageClient{
sendCh: internal.NewSendChan(int64(config.SendChannelSize)),
topics: make(map[string]*topicEntry),
senderID: senderID,
closeCh: make(chan struct{}),
config: config,
newSenderFn: func(stream MessageClientStream) clientBatchSender[MessageEntry] {
return newClientBatchSender(stream, config.MaxBatchBytes, config.MaxBatchCount)
},
connector: newClientConnector(),
}
}
// Run launches background goroutines for MessageClient to work.
func (c *grpcMessageClient) Run(
ctx context.Context, network, addr string,
receiverID NodeID,
credential *security.Credential,
) (ret error) {
defer func() {
c.isClosed.Store(true)
close(c.closeCh)
}()
metricsClientCount := clientCount.With(prometheus.Labels{
"to": addr,
})
metricsClientCount.Inc()
defer metricsClientCount.Dec()
rl := rate.NewLimiter(rate.Limit(c.config.RetryRateLimitPerSecond), 1)
epoch := int64(0)
for {
select {
case <-ctx.Done():
return errors.Trace(ctx.Err())
default:
}
if err := rl.Wait(ctx); err != nil {
return errors.Trace(err)
}
gRPCClient, release, err := c.connector.Connect(clientConnectOptions{
network: network,
addr: addr,
credential: credential,
timeout: c.config.DialTimeout,
maxRecvMsgSize: c.config.MaxRecvMsgSize,
})
if err != nil {
log.Warn("peer-message client: failed to connect to server",
zap.Error(err))
continue
}
epoch++
streamMeta := &p2p.StreamMeta{
SenderId: c.senderID,
ReceiverId: receiverID,
Epoch: epoch,
ClientVersion: c.config.ClientVersion,
SenderAdvertisedAddr: c.config.AdvertisedAddr,
}
err = c.launchStream(ctx, gRPCClient, streamMeta)
if cerrors.ErrPeerMessageClientPermanentFail.Equal(err) {
release()
return errors.Trace(err)
}
log.Warn("peer message client detected error, restarting", zap.Error(err))
release()
continue
}
}
func (c *grpcMessageClient) launchStream(ctx context.Context, gRPCClient p2p.CDCPeerToPeerClient, meta *p2p.StreamMeta) error {
failpoint.Inject("InjectClientPermanentFailure", func() {
failpoint.Return(cerrors.ErrPeerMessageClientPermanentFail.GenWithStackByArgs())
})
cancelCtx, cancelStream := context.WithCancel(ctx)
defer cancelStream()
clientStream, err := gRPCClient.SendMessage(cancelCtx)
if err != nil {
return errors.Trace(err)
}
err = clientStream.Send(&p2p.MessagePacket{Meta: meta})
if err != nil {
return errors.Trace(err)
}
return errors.Trace(c.run(ctx, clientStream, cancelStream))
}
func (c *grpcMessageClient) run(ctx context.Context, stream MessageClientStream, cancel func()) error {
errg, ctx := errgroup.WithContext(ctx)
errg.Go(func() error {
defer cancel()
return c.runTx(ctx, stream)
})
errg.Go(func() error {
defer cancel()
return c.runRx(ctx, stream)
})
return errors.Trace(errg.Wait())
}
func (c *grpcMessageClient) runTx(ctx context.Context, stream MessageClientStream) error {
if err := c.retrySending(ctx, stream); err != nil {
return errors.Trace(err)
}
peerAddr := unknownPeerLabel
peer, ok := gRPCPeer.FromContext(stream.Context())
if ok {
peerAddr = peer.Addr.String()
}
metricsClientMessageCount := clientMessageCount.With(prometheus.Labels{
"to": peerAddr,
})
ticker := time.NewTicker(c.config.BatchSendInterval)
defer ticker.Stop()
batchSender := c.newSenderFn(stream)
for {
msg, ok, err := c.sendCh.Receive(ctx, ticker.C)
if err != nil {
return errors.Trace(err)
}
if !ok {
// `ticker` has fired and we have not received any message.
// We try to flush whatever message we already have.
// The implementation of batchSender guarantees that
// an empty flush does not send any message.
if err := batchSender.Flush(); err != nil {
return errors.Trace(err)
}
continue
}
c.topicMu.RLock()
tpk, ok := c.topics[msg.Topic]
c.topicMu.RUnlock()
if !ok {
// This line should never be reachable unless there is a bug in this file.
log.Panic("topic not found. Report a bug", zap.String("topic", msg.Topic))
}
// We want to assert that `msg.Sequence` is continuous within a topic.
if old := tpk.lastSent.Swap(msg.Sequence); old != initAck && msg.Sequence != old+1 {
log.Panic("unexpected seq of message",
zap.String("topic", msg.Topic),
zap.Int64("seq", msg.Sequence))
}
tpk.sentMessageMu.Lock()
tpk.sentMessages.Push(msg)
tpk.sentMessageMu.Unlock()
metricsClientMessageCount.Inc()
log.Debug("Sending Message",
zap.String("topic", msg.Topic),
zap.Int64("seq", msg.Sequence))
if err := batchSender.Append(msg); err != nil {
return errors.Trace(err)
}
}
}
// retrySending retries sending messages when the gRPC stream is re-established.
func (c *grpcMessageClient) retrySending(ctx context.Context, stream MessageClientStream) error {
topicsCloned := make(map[string]*topicEntry)
c.topicMu.RLock()
for k, v := range c.topics {
topicsCloned[k] = v
}
c.topicMu.RUnlock()
batcher := c.newSenderFn(stream)
for topic, tpk := range topicsCloned {
select {
case <-ctx.Done():
return errors.Trace(ctx.Err())
default:
}
tpk.sentMessageMu.Lock()
if queueHead, ok := tpk.sentMessages.Head(); ok {
retryFromSeq := queueHead.Sequence
log.Info("peer-to-peer client retrying",
zap.String("topic", topic),
zap.Int64("fromSeq", retryFromSeq))
}
for it := tpk.sentMessages.Begin(); it.Valid(); it.Next() {
msg := it.Value()
log.Debug("retry sending msg",
zap.String("topic", msg.Topic),
zap.Int64("seq", msg.Sequence))
err := batcher.Append(&p2p.MessageEntry{
Topic: msg.Topic,
Content: msg.Content,
Sequence: msg.Sequence,
})
if err != nil {
tpk.sentMessageMu.Unlock()
return errors.Trace(err)
}
}
if err := batcher.Flush(); err != nil {
tpk.sentMessageMu.Unlock()
return errors.Trace(err)
}
tpk.sentMessageMu.Unlock()
}
return nil
}
func (c *grpcMessageClient) runRx(ctx context.Context, stream MessageClientStream) error {
peerAddr := unknownPeerLabel
peer, ok := gRPCPeer.FromContext(stream.Context())
if ok {
peerAddr = peer.Addr.String()
}
metricsClientAckCount := clientAckCount.With(prometheus.Labels{
"from": peerAddr,
})
for {
select {
case <-ctx.Done():
return errors.Trace(ctx.Err())
default:
}
resp, err := stream.Recv()
if err != nil {
return errors.Trace(err)
}
switch resp.GetExitReason() {
case p2p.ExitReason_OK:
break
case p2p.ExitReason_CAPTURE_ID_MISMATCH:
return cerrors.ErrPeerMessageClientPermanentFail.GenWithStackByArgs(resp.GetErrorMessage())
default:
return cerrors.ErrPeerMessageServerClosed.GenWithStackByArgs(resp.GetErrorMessage())
}
metricsClientAckCount.Inc()
for _, ack := range resp.GetAck() {
c.topicMu.RLock()
tpk, ok := c.topics[ack.GetTopic()]
c.topicMu.RUnlock()
if !ok {
log.Warn("Received ACK for unknown topic", zap.String("topic", ack.GetTopic()))
continue
}
tpk.ack.Store(ack.GetLastSeq())
tpk.sentMessageMu.Lock()
tpk.sentMessages.RangeAndPop(func(msg *p2p.MessageEntry) bool {
return msg.Sequence <= ack.GetLastSeq()
})
tpk.sentMessageMu.Unlock()
}
}
}
// SendMessage sends a message. It will block if the client is not ready to
// accept the message for now. Once the function returns without an error,
// the client will try its best to send the message, until `Run` is canceled.
func (c *grpcMessageClient) SendMessage(ctx context.Context, topic Topic, value interface{}) (seq Seq, ret error) {
return c.sendMessage(ctx, topic, value, false)
}
// TrySendMessage tries to send a message. It will return ErrPeerMessageSendTryAgain
// if the client is not ready to accept the message.
func (c *grpcMessageClient) TrySendMessage(ctx context.Context, topic Topic, value interface{}) (seq Seq, ret error) {
// FIXME (zixiong): This is a temporary way for testing client congestion.
// This failpoint will be removed once we abstract the MessageClient as an interface.
failpoint.Inject("ClientInjectSendMessageTryAgain", func() {
failpoint.Return(0, cerrors.ErrPeerMessageSendTryAgain.GenWithStackByArgs())
})
// FIXME (zixiong): This is a temporary way for testing whether the caller can handler this error.
failpoint.Inject("ClientInjectClosed", func() {
failpoint.Return(0, cerrors.ErrPeerMessageClientClosed.GenWithStackByArgs())
})
return c.sendMessage(ctx, topic, value, true)
}
func (c *grpcMessageClient) sendMessage(ctx context.Context, topic Topic, value interface{}, nonblocking bool) (seq Seq, ret error) {
if c.isClosed.Load() {
return 0, cerrors.ErrPeerMessageClientClosed.GenWithStackByArgs()
}
c.topicMu.RLock()
tpk, ok := c.topics[topic]
c.topicMu.RUnlock()
if !ok {
tpk = &topicEntry{
sentMessages: *queue.NewChunkQueue[*p2p.MessageEntry](),
}
tpk.nextSeq.Store(0)
c.topicMu.Lock()
if newTpk, ok := c.topics[topic]; !ok {
c.topics[topic] = tpk
} else {
tpk = newTpk
}
c.topicMu.Unlock()
}
data, err := marshalMessage(value)
if err != nil {
return 0, cerrors.WrapError(cerrors.ErrPeerMessageEncodeError, err)
}
if nonblocking {
ok, seq := c.sendCh.SendAsync(topic, data, tpk.nextSeq.Inc)
if !ok {
return 0, cerrors.ErrPeerMessageSendTryAgain.GenWithStackByArgs()
}
return seq, nil
}
// blocking
seq, err = c.sendCh.SendSync(ctx, topic, data, c.closeCh, tpk.nextSeq.Inc)
if err != nil {
return 0, errors.Trace(err)
}
return seq, nil
}
// CurrentAck returns (s, true) if all messages with sequence less than or
// equal to s have been processed by the receiver. It returns (0, false) if
// no message for `topic` has been sent.
func (c *grpcMessageClient) CurrentAck(topic Topic) (Seq, bool) {
c.topicMu.RLock()
defer c.topicMu.RUnlock()
tpk, ok := c.topics[topic]
if !ok {
return 0, false
}
return tpk.ack.Load(), true
}