-
Notifications
You must be signed in to change notification settings - Fork 5.8k
/
client.go
1282 lines (1158 loc) · 40.9 KB
/
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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2020 PingCAP, Inc. Licensed under Apache-2.0.
package backup
import (
"bytes"
"context"
"encoding/base64"
"encoding/json"
"reflect"
"sort"
"strings"
"time"
"github.com/google/btree"
"github.com/opentracing/opentracing-go"
"github.com/pingcap/errors"
backuppb "github.com/pingcap/kvproto/pkg/brpb"
"github.com/pingcap/kvproto/pkg/kvrpcpb"
"github.com/pingcap/kvproto/pkg/metapb"
"github.com/pingcap/log"
"github.com/pingcap/tidb/br/pkg/checkpoint"
"github.com/pingcap/tidb/br/pkg/conn"
connutil "github.com/pingcap/tidb/br/pkg/conn/util"
berrors "github.com/pingcap/tidb/br/pkg/errors"
"github.com/pingcap/tidb/br/pkg/glue"
"github.com/pingcap/tidb/br/pkg/logutil"
"github.com/pingcap/tidb/br/pkg/metautil"
"github.com/pingcap/tidb/br/pkg/rtree"
"github.com/pingcap/tidb/br/pkg/storage"
"github.com/pingcap/tidb/br/pkg/summary"
"github.com/pingcap/tidb/br/pkg/utils"
"github.com/pingcap/tidb/br/pkg/version"
"github.com/pingcap/tidb/pkg/ddl"
"github.com/pingcap/tidb/pkg/distsql"
"github.com/pingcap/tidb/pkg/kv"
"github.com/pingcap/tidb/pkg/meta"
"github.com/pingcap/tidb/pkg/meta/model"
"github.com/pingcap/tidb/pkg/util"
filter "github.com/pingcap/tidb/pkg/util/table-filter"
"github.com/tikv/client-go/v2/oracle"
"github.com/tikv/client-go/v2/txnkv/txnlock"
pd "github.com/tikv/pd/client"
"go.uber.org/zap"
)
const (
// MaxResolveLocksbackupOffSleep is the maximum sleep time for resolving locks.
// 10 minutes for every round.
MaxResolveLocksbackupOffSleepMs = 600000
)
// ClientMgr manages connections needed by backup.
type ClientMgr interface {
GetBackupClient(ctx context.Context, storeID uint64) (backuppb.BackupClient, error)
ResetBackupClient(ctx context.Context, storeID uint64) (backuppb.BackupClient, error)
GetPDClient() pd.Client
GetLockResolver() *txnlock.LockResolver
Close()
}
// Checksum is the checksum of some backup files calculated by CollectChecksums.
type Checksum struct {
Crc64Xor uint64
TotalKvs uint64
TotalBytes uint64
}
// ProgressUnit represents the unit of progress.
type ProgressUnit string
type MainBackupLoop struct {
BackupSender
// backup requests for all stores.
// the subRanges may changed every round.
BackupReq backuppb.BackupRequest
// the number of backup clients to send backup requests per store.
Concurrency uint
// record the whole backup progress in infinite loop.
GlobalProgressTree *rtree.ProgressRangeTree
ReplicaReadLabel map[string]string
StateNotifier chan BackupRetryPolicy
ProgressCallBack func()
GetBackupClientCallBack func(ctx context.Context, storeID uint64, reset bool) (backuppb.BackupClient, error)
}
type MainBackupSender struct{}
func (s *MainBackupSender) SendAsync(
ctx context.Context,
round uint64,
storeID uint64,
request backuppb.BackupRequest,
concurrency uint,
cli backuppb.BackupClient,
respCh chan *ResponseAndStore,
StateNotifier chan BackupRetryPolicy,
) {
go func() {
defer func() {
logutil.CL(ctx).Info("store backup goroutine exits", zap.Uint64("store", storeID))
close(respCh)
}()
err := startBackup(ctx, storeID, request, cli, concurrency, respCh)
if err != nil {
// only 2 kinds of errors will occur here.
// 1. grpc connection error(already retry inside)
// 2. context cancelled outside.
if errors.Cause(err) == context.Canceled {
logutil.CL(ctx).Info("store backup cancelled",
zap.Uint64("round", round),
zap.Uint64("storeID", storeID))
} else {
// otherwise retry backup this store
logutil.CL(ctx).Error("store backup failed",
zap.Uint64("round", round),
zap.Uint64("storeID", storeID), zap.Error(err))
select {
case <-ctx.Done():
case StateNotifier <- BackupRetryPolicy{One: storeID}:
}
}
}
}()
}
// CollectStoreBackupsAsync is the receiver function of all stores backup results.
func (l *MainBackupLoop) CollectStoreBackupsAsync(
ctx context.Context,
round uint64,
storeBackupChs map[uint64]chan *ResponseAndStore,
globalCh chan *ResponseAndStore,
) {
go func() {
defer func() {
logutil.CL(ctx).Info("collect backups goroutine exits", zap.Uint64("round", round))
close(globalCh)
}()
cases := make([]reflect.SelectCase, 0)
for _, ch := range storeBackupChs {
cases = append(cases, reflect.SelectCase{Dir: reflect.SelectRecv, Chan: reflect.ValueOf(ch)})
}
remainingProducers := len(cases)
logutil.CL(ctx).Info("start wait store backups", zap.Int("remainingProducers", remainingProducers))
for remainingProducers > 0 {
chosen, value, ok := reflect.Select(cases)
if !ok {
// The chosen channel has been closed, so zero out the channel to disable the case
cases[chosen].Chan = reflect.ValueOf(nil)
remainingProducers -= 1
continue
}
select {
case <-ctx.Done():
return
case globalCh <- value.Interface().(*ResponseAndStore):
}
}
}()
}
// infinite loop to backup ranges on all tikv stores
// if one client grpc disconnected. resend backup request to this store.
// if new tikv store joined. send backup request to new store.
// if one tikv store rebooted. consider leader changes, resend backup request to all stores.
// if one tikv store disconnected. consider leader changes, resend backup request to all stores.a
func (bc *Client) RunLoop(ctx context.Context, loop *MainBackupLoop) error {
// a flag to indicate the backup round
// one backup round try to backup all ranges on all tikv stores.
// ideally, backup should be finished in one round
// unless the cluster state changed or some kv errors occurred.
round := uint64(0)
// reset grpc connection every round except key_locked error.
reset := true
mainLoop:
for {
round += 1
// sleep 200ms. in case of tikv cluster abnormal state trigger too many backup rounds.
time.Sleep(200 * time.Millisecond)
logutil.CL(ctx).Info("This round of backup starts...", zap.Uint64("round", round))
// initialize the error context every round
errContext := utils.NewErrorContext("MainBackupLoop", 10)
// a channel to collect all store backup results
globalBackupResultCh := make(chan *ResponseAndStore)
// channel slices to receive backup region result from different tikv stores
storeBackupResultChMap := make(map[uint64]chan *ResponseAndStore)
// mainCtx used to control mainLoop
// every round need a new context to control the main backup process
mainCtx, mainCancel := context.WithCancel(ctx)
// handleCtx used to control handleLoop
// every round has another infinite loop to handle all tikv backup responses
// until backup finished, store state changed or error occurred.
handleCtx, handleCancel := context.WithCancel(ctx)
// Compute the left ranges that not backuped yet
start := time.Now()
var inCompleteRanges []rtree.Range
var allTxnLocks []*txnlock.Lock
select {
case <-ctx.Done():
// ctx cancal outside
handleCancel()
mainCancel()
return ctx.Err()
default:
iter := loop.GlobalProgressTree.Iter()
inCompleteRanges = iter.GetIncompleteRanges()
if len(inCompleteRanges) == 0 {
// all range backuped
logutil.CL(ctx).Info("This round finished all backup ranges", zap.Uint64("round", round))
handleCancel()
mainCancel()
return nil
}
}
logutil.CL(mainCtx).Info("backup ranges", zap.Uint64("round", round),
zap.Int("incomplete-ranges", len(inCompleteRanges)), zap.Duration("cost", time.Since(start)))
loop.BackupReq.SubRanges = getBackupRanges(inCompleteRanges)
allStores, err := bc.getBackupStores(mainCtx, loop.ReplicaReadLabel)
if err != nil {
// because we have connectted to pd before.
// so this error must be retryable, just make infinite retry here
logutil.CL(mainCtx).Error("failed to get backup stores", zap.Uint64("round", round), zap.Error(err))
mainCancel()
reset = true
continue mainLoop
}
for _, store := range allStores {
if err = utils.CheckStoreLiveness(store); err != nil {
// skip this store in this round.
logutil.CL(mainCtx).Warn("store not alive, skip backup it in this round", zap.Uint64("round", round), zap.Error(err))
continue
}
storeID := store.GetId()
// reset backup client every round, to get a clean grpc connection.
cli, err := loop.GetBackupClientCallBack(mainCtx, storeID, reset)
if err != nil {
// because the we get store info from pd.
// there is no customer setting here, so make infinite retry.
logutil.CL(ctx).Error("failed to reset backup client", zap.Uint64("round", round), zap.Uint64("storeID", storeID), zap.Error(err))
mainCancel()
reset = true
continue mainLoop
}
ch := make(chan *ResponseAndStore)
storeBackupResultChMap[storeID] = ch
loop.SendAsync(mainCtx, round, storeID, loop.BackupReq, loop.Concurrency, cli, ch, loop.StateNotifier)
}
// infinite loop to collect region backup response to global channel
loop.CollectStoreBackupsAsync(handleCtx, round, storeBackupResultChMap, globalBackupResultCh)
handleLoop:
for {
select {
case <-ctx.Done():
handleCancel()
mainCancel()
return ctx.Err()
case storeBackupInfo := <-loop.StateNotifier:
if storeBackupInfo.All {
logutil.CL(mainCtx).Info("cluster state changed. restart store backups", zap.Uint64("round", round))
// stop current connections
handleCancel()
mainCancel()
// start next round backups
reset = true
continue mainLoop
}
if storeBackupInfo.One != 0 {
storeID := storeBackupInfo.One
logutil.CL(mainCtx).Info("receive notifaction and retry backup on this store",
zap.Uint64("storeID", storeID), zap.Uint64("round", round))
store, err := bc.mgr.GetPDClient().GetStore(mainCtx, storeID)
if err != nil {
// cannot get store, maybe store has scaled-in.
logutil.CL(mainCtx).Info("cannot get store from pd", zap.Uint64("round", round), zap.Error(err))
// try next round
handleCancel()
mainCancel()
reset = true
continue mainLoop
}
if err = utils.CheckStoreLiveness(store); err != nil {
// skip this store in this round.
logutil.CL(mainCtx).Warn("store not alive, skip backup it in this round", zap.Uint64("round", round), zap.Error(err))
reset = true
continue mainLoop
}
// reset backup client. store address could change but store id remained.
cli, err := loop.GetBackupClientCallBack(mainCtx, storeID, reset)
if err != nil {
logutil.CL(mainCtx).Error("failed to reset backup client", zap.Uint64("round", round), zap.Uint64("storeID", storeID), zap.Error(err))
handleCancel()
mainCancel()
// receive new store info but failed to get backup client.
// start next round backups to get all tikv stores and reset all client connections.
reset = true
continue mainLoop
}
// cancel the former collect goroutine
handleCancel()
ch := make(chan *ResponseAndStore)
storeBackupResultChMap[storeID] = ch
// start backup for this store
loop.SendAsync(mainCtx, round, storeID, loop.BackupReq, loop.Concurrency, cli, ch, loop.StateNotifier)
// re-create context for new handler loop
handleCtx, handleCancel = context.WithCancel(mainCtx)
// handleCancel makes the former collect goroutine exits
// so we need to re-create a new channel and restart a new collect goroutine.
globalBackupResultCh = make(chan *ResponseAndStore)
// collect all store backup producer channel result to one channel
loop.CollectStoreBackupsAsync(handleCtx, round, storeBackupResultChMap, globalBackupResultCh)
}
case respAndStore, ok := <-globalBackupResultCh:
if !ok {
// resolve all txn lock before next round starts
if len(allTxnLocks) > 0 {
bo := utils.AdaptTiKVBackoffer(handleCtx, MaxResolveLocksbackupOffSleepMs, berrors.ErrUnknown)
_, err = bc.mgr.GetLockResolver().ResolveLocks(bo.Inner(), 0, allTxnLocks)
if err != nil {
logutil.CL(handleCtx).Warn("failed to resolve locks, ignore and wait for next round to resolve",
zap.Uint64("round", round), zap.Error(err))
}
reset = false
}
// this round backup finished. break and check incomplete ranges in mainLoop.
break handleLoop
}
lock, err := bc.OnBackupResponse(handleCtx, respAndStore, errContext, loop.GlobalProgressTree)
if err != nil {
// if error occurred here, stop the backup process
// because only 3 kinds of errors will be returned here:
// 1. permission denied on tikv store.
// 2. parse backup response error.(shouldn't happen in any case)
// 3. checkpoint update failed. TODO: should we retry here?
handleCancel()
mainCancel()
return err
}
if lock != nil {
allTxnLocks = append(allTxnLocks, lock)
}
loop.ProgressCallBack()
}
}
}
}
// Client is a client instructs TiKV how to do a backup.
type Client struct {
mgr ClientMgr
clusterID uint64
storage storage.ExternalStorage
backend *backuppb.StorageBackend
apiVersion kvrpcpb.APIVersion
cipher *backuppb.CipherInfo
checkpointMeta *checkpoint.CheckpointMetadataForBackup
checkpointRunner *checkpoint.CheckpointRunner[checkpoint.BackupKeyType, checkpoint.BackupValueType]
gcTTL int64
}
// NewBackupClient returns a new backup client.
func NewBackupClient(ctx context.Context, mgr ClientMgr) *Client {
log.Info("new backup client")
pdClient := mgr.GetPDClient()
clusterID := pdClient.GetClusterID(ctx)
return &Client{
clusterID: clusterID,
mgr: mgr,
cipher: nil,
checkpointMeta: nil,
checkpointRunner: nil,
}
}
// SetCipher for checkpoint to encrypt sst file's metadata
func (bc *Client) SetCipher(cipher *backuppb.CipherInfo) {
bc.cipher = cipher
}
// GetCurrentTS gets a new timestamp from PD.
func (bc *Client) GetCurrentTS(ctx context.Context) (uint64, error) {
p, l, err := bc.mgr.GetPDClient().GetTS(ctx)
if err != nil {
return 0, errors.Trace(err)
}
restoreTS := oracle.ComposeTS(p, l)
return restoreTS, nil
}
// GetTS returns the latest timestamp.
func (bc *Client) GetTS(ctx context.Context, duration time.Duration, ts uint64) (uint64, error) {
var (
backupTS uint64
err error
)
if bc.checkpointMeta != nil {
log.Info("reuse checkpoint BackupTS", zap.Uint64("backup-ts", bc.checkpointMeta.BackupTS))
return bc.checkpointMeta.BackupTS, nil
}
if ts > 0 {
backupTS = ts
} else {
p, l, err := bc.mgr.GetPDClient().GetTS(ctx)
if err != nil {
return 0, errors.Trace(err)
}
backupTS = oracle.ComposeTS(p, l)
switch {
case duration < 0:
return 0, errors.Annotate(berrors.ErrInvalidArgument, "negative timeago is not allowed")
case duration > 0:
log.Info("backup time ago", zap.Duration("timeago", duration))
backupTime := oracle.GetTimeFromTS(backupTS)
backupAgo := backupTime.Add(-duration)
if backupTS < oracle.ComposeTS(oracle.GetPhysical(backupAgo), l) {
return 0, errors.Annotate(berrors.ErrInvalidArgument, "backup ts overflow please choose a smaller timeago")
}
backupTS = oracle.ComposeTS(oracle.GetPhysical(backupAgo), l)
}
}
// check backup time do not exceed GCSafePoint
err = utils.CheckGCSafePoint(ctx, bc.mgr.GetPDClient(), backupTS)
if err != nil {
return 0, errors.Trace(err)
}
log.Info("backup encode timestamp", zap.Uint64("BackupTS", backupTS))
return backupTS, nil
}
// SetLockFile set write lock file.
func (bc *Client) SetLockFile(ctx context.Context) error {
return bc.storage.WriteFile(ctx, metautil.LockFile,
[]byte("DO NOT DELETE\n"+
"This file exists to remind other backup jobs won't use this path"))
}
// GetSafePointID get the gc-safe-point's service-id from either checkpoint or immediate generation
func (bc *Client) GetSafePointID() string {
if bc.checkpointMeta != nil {
log.Info("reuse the checkpoint gc-safepoint service id", zap.String("service-id", bc.checkpointMeta.GCServiceId))
return bc.checkpointMeta.GCServiceId
}
return utils.MakeSafePointID()
}
// SetGCTTL set gcTTL for client.
func (bc *Client) SetGCTTL(ttl int64) {
if ttl <= 0 {
ttl = utils.DefaultBRGCSafePointTTL
}
bc.gcTTL = ttl
}
// GetGCTTL get gcTTL for this backup.
func (bc *Client) GetGCTTL() int64 {
return bc.gcTTL
}
// GetStorageBackend gets storage backupend field in client.
func (bc *Client) GetStorageBackend() *backuppb.StorageBackend {
return bc.backend
}
// GetStorage gets storage for this backup.
func (bc *Client) GetStorage() storage.ExternalStorage {
return bc.storage
}
// SetStorageAndCheckNotInUse sets ExternalStorage for client and check storage not in used by others.
func (bc *Client) SetStorageAndCheckNotInUse(
ctx context.Context,
backend *backuppb.StorageBackend,
opts *storage.ExternalStorageOptions,
) error {
err := bc.SetStorage(ctx, backend, opts)
if err != nil {
return errors.Trace(err)
}
// backupmeta already exists
exist, err := bc.storage.FileExists(ctx, metautil.MetaFile)
if err != nil {
return errors.Annotatef(err, "error occurred when checking %s file", metautil.MetaFile)
}
if exist {
return errors.Annotatef(berrors.ErrInvalidArgument, "backup meta file exists in %v, "+
"there may be some backup files in the path already, "+
"please specify a correct backup directory!", bc.storage.URI()+"/"+metautil.MetaFile)
}
// use checkpoint mode if checkpoint meta exists
exist, err = bc.storage.FileExists(ctx, checkpoint.CheckpointMetaPathForBackup)
if err != nil {
return errors.Annotatef(err, "error occurred when checking %s file", checkpoint.CheckpointMetaPathForBackup)
}
// if there is no checkpoint meta, then checkpoint mode is not used
// or it is the first execution
if exist {
// load the config's hash to keep the config unchanged.
log.Info("load the checkpoint meta, so the existence of lockfile is allowed.")
bc.checkpointMeta, err = checkpoint.LoadCheckpointMetadata(ctx, bc.storage)
if err != nil {
return errors.Annotatef(err, "error occurred when loading %s file", checkpoint.CheckpointMetaPathForBackup)
}
} else {
err = CheckBackupStorageIsLocked(ctx, bc.storage)
if err != nil {
return err
}
}
return nil
}
// CheckCheckpoint check whether the configs are the same
func (bc *Client) CheckCheckpoint(hash []byte) error {
if bc.checkpointMeta != nil && !bytes.Equal(bc.checkpointMeta.ConfigHash, hash) {
return errors.Annotatef(berrors.ErrInvalidArgument, "failed to backup to %v, "+
"because the checkpoint mode is used, "+
"but the hashs of the configs are not the same. Please check the config",
bc.storage.URI(),
)
}
// first execution or not using checkpoint mode yet
// or using the same config can pass the check
return nil
}
func (bc *Client) GetCheckpointRunner() *checkpoint.CheckpointRunner[checkpoint.BackupKeyType, checkpoint.BackupValueType] {
return bc.checkpointRunner
}
// StartCheckpointMeta will
// 1. saves the initial status into the external storage;
// 2. load the checkpoint data from external storage
// 3. start checkpoint runner
func (bc *Client) StartCheckpointRunner(
ctx context.Context,
cfgHash []byte,
backupTS uint64,
ranges []rtree.Range,
safePointID string,
progressCallBack func(),
) (err error) {
if bc.checkpointMeta == nil {
bc.checkpointMeta = &checkpoint.CheckpointMetadataForBackup{
GCServiceId: safePointID,
ConfigHash: cfgHash,
BackupTS: backupTS,
Ranges: ranges,
}
// sync the checkpoint meta to the external storage at first
if err := checkpoint.SaveCheckpointMetadata(ctx, bc.storage, bc.checkpointMeta); err != nil {
return errors.Trace(err)
}
} else {
// otherwise, the checkpoint meta is loaded from the external storage,
// no need to save it again
// besides, there are exist checkpoint data need to be loaded before start checkpoint runner
bc.checkpointMeta.CheckpointDataMap, err = bc.loadCheckpointRanges(ctx, progressCallBack)
if err != nil {
return errors.Trace(err)
}
}
bc.checkpointRunner, err = checkpoint.StartCheckpointRunnerForBackup(ctx, bc.storage, bc.cipher, bc.mgr.GetPDClient())
return errors.Trace(err)
}
func (bc *Client) WaitForFinishCheckpoint(ctx context.Context, flush bool) {
if bc.checkpointRunner != nil {
bc.checkpointRunner.WaitForFinish(ctx, flush)
}
}
// getProgressRange loads the checkpoint(finished) sub-ranges of the current range, and calculate its incompleted sub-ranges.
func (bc *Client) getProgressRange(r rtree.Range) *rtree.ProgressRange {
// use groupKey to distinguish different ranges
groupKey := base64.URLEncoding.EncodeToString(r.StartKey)
if bc.checkpointMeta != nil && len(bc.checkpointMeta.CheckpointDataMap) > 0 {
rangeTree, exists := bc.checkpointMeta.CheckpointDataMap[groupKey]
if exists {
incomplete := rangeTree.GetIncompleteRange(r.StartKey, r.EndKey)
delete(bc.checkpointMeta.CheckpointDataMap, groupKey)
return &rtree.ProgressRange{
Res: rangeTree,
Incomplete: incomplete,
Origin: r,
GroupKey: groupKey,
}
}
}
// the origin range are not recorded in checkpoint
// return the default progress range
return &rtree.ProgressRange{
Res: rtree.NewRangeTree(),
Incomplete: []rtree.Range{
r,
},
Origin: r,
GroupKey: groupKey,
}
}
// LoadCheckpointRange loads the checkpoint(finished) sub-ranges of the current range, and calculate its incompleted sub-ranges.
func (bc *Client) loadCheckpointRanges(ctx context.Context, progressCallBack func()) (map[string]rtree.RangeTree, error) {
rangeDataMap := make(map[string]rtree.RangeTree)
pastDureTime, err := checkpoint.WalkCheckpointFileForBackup(ctx, bc.storage, bc.cipher, func(groupKey string, rg checkpoint.BackupValueType) {
rangeTree, exists := rangeDataMap[groupKey]
if !exists {
rangeTree = rtree.NewRangeTree()
rangeDataMap[groupKey] = rangeTree
}
rangeTree.Put(rg.StartKey, rg.EndKey, rg.Files)
progressCallBack()
})
// we should adjust start-time of the summary to `pastDureTime` earlier
log.Info("past cost time", zap.Duration("cost", pastDureTime))
summary.AdjustStartTimeToEarlierTime(pastDureTime)
return rangeDataMap, errors.Trace(err)
}
// SetStorage sets ExternalStorage for client.
func (bc *Client) SetStorage(
ctx context.Context,
backend *backuppb.StorageBackend,
opts *storage.ExternalStorageOptions,
) error {
var err error
bc.backend = backend
bc.storage, err = storage.New(ctx, backend, opts)
return errors.Trace(err)
}
// GetClusterID returns the cluster ID of the tidb cluster to backup.
func (bc *Client) GetClusterID() uint64 {
return bc.clusterID
}
// GetApiVersion sets api version of the TiKV storage
func (bc *Client) GetApiVersion() kvrpcpb.APIVersion {
return bc.apiVersion
}
// SetApiVersion sets api version of the TiKV storage
func (bc *Client) SetApiVersion(v kvrpcpb.APIVersion) {
bc.apiVersion = v
}
// Client.BuildBackupRangeAndSchema calls BuildBackupRangeAndSchema,
// if the checkpoint mode is used, return the ranges from checkpoint meta
func (bc *Client) BuildBackupRangeAndSchema(
storage kv.Storage,
tableFilter filter.Filter,
backupTS uint64,
isFullBackup bool,
) ([]rtree.Range, *Schemas, []*backuppb.PlacementPolicy, error) {
if bc.checkpointMeta == nil {
return BuildBackupRangeAndInitSchema(storage, tableFilter, backupTS, isFullBackup, true)
}
_, schemas, policies, err := BuildBackupRangeAndInitSchema(storage, tableFilter, backupTS, isFullBackup, false)
schemas.SetCheckpointChecksum(bc.checkpointMeta.CheckpointChecksum)
return bc.checkpointMeta.Ranges, schemas, policies, errors.Trace(err)
}
// CheckBackupStorageIsLocked checks whether backups is locked.
// which means we found other backup progress already write
// some data files into the same backup directory or cloud prefix.
func CheckBackupStorageIsLocked(ctx context.Context, s storage.ExternalStorage) error {
exist, err := s.FileExists(ctx, metautil.LockFile)
if err != nil {
return errors.Annotatef(err, "error occurred when checking %s file", metautil.LockFile)
}
if exist {
err = s.WalkDir(ctx, &storage.WalkOption{}, func(path string, size int64) error {
// should return error to break the walkDir when found lock file and other .sst files.
if strings.HasSuffix(path, ".sst") {
return errors.Annotatef(berrors.ErrInvalidArgument, "backup lock file and sst file exist in %v, "+
"there are some backup files in the path already, but hasn't checkpoint metadata, "+
"please specify a correct backup directory!", s.URI()+"/"+metautil.LockFile)
}
return nil
})
return err
}
return nil
}
// BuildBackupRangeAndSchema gets KV range and schema of tables.
// KV ranges are separated by Table IDs.
// Also, KV ranges are separated by Index IDs in the same table.
func BuildBackupRangeAndInitSchema(
storage kv.Storage,
tableFilter filter.Filter,
backupTS uint64,
isFullBackup bool,
buildRange bool,
) ([]rtree.Range, *Schemas, []*backuppb.PlacementPolicy, error) {
snapshot := storage.GetSnapshot(kv.NewVersion(backupTS))
m := meta.NewSnapshotMeta(snapshot)
var policies []*backuppb.PlacementPolicy
if isFullBackup {
// according to https://github.com/pingcap/tidb/issues/32290
// only full backup will record policies in backupMeta.
policyList, err := m.ListPolicies()
if err != nil {
return nil, nil, nil, errors.Trace(err)
}
policies = make([]*backuppb.PlacementPolicy, 0, len(policies))
for _, policyInfo := range policyList {
p, err := json.Marshal(policyInfo)
if err != nil {
return nil, nil, nil, errors.Trace(err)
}
policies = append(policies, &backuppb.PlacementPolicy{Info: p})
}
}
ranges := make([]rtree.Range, 0)
schemasNum := 0
dbs, err := m.ListDatabases()
if err != nil {
return nil, nil, nil, errors.Trace(err)
}
for _, dbInfo := range dbs {
// skip system databases
if !tableFilter.MatchSchema(dbInfo.Name.O) || util.IsMemDB(dbInfo.Name.L) || utils.IsTemplateSysDB(dbInfo.Name) {
continue
}
hasTable := false
err = m.IterTables(dbInfo.ID, func(tableInfo *model.TableInfo) error {
if tableInfo.Version > version.CURRENT_BACKUP_SUPPORT_TABLE_INFO_VERSION {
// normally this shouldn't happen in a production env.
// because we had a unit test to avoid table info version update silencly.
// and had version check before run backup.
return errors.Errorf("backup doesn't not support table %s with version %d, maybe try a new version of br",
tableInfo.Name.String(),
tableInfo.Version,
)
}
if !tableFilter.MatchTable(dbInfo.Name.O, tableInfo.Name.O) {
// Skip tables other than the given table.
return nil
}
schemasNum += 1
hasTable = true
if buildRange {
tableRanges, err := distsql.BuildTableRanges(tableInfo)
if err != nil {
return errors.Trace(err)
}
for _, r := range tableRanges {
// Add keyspace prefix to BackupRequest
startKey, endKey := storage.GetCodec().EncodeRange(r.StartKey, r.EndKey)
ranges = append(ranges, rtree.Range{
StartKey: startKey,
EndKey: endKey,
})
}
}
return nil
})
if err != nil {
return nil, nil, nil, errors.Trace(err)
}
if !hasTable {
log.Info("backup empty database", zap.Stringer("db", dbInfo.Name))
schemasNum += 1
}
}
if schemasNum == 0 {
log.Info("nothing to backup")
return nil, nil, nil, nil
}
return ranges, NewBackupSchemas(func(storage kv.Storage, fn func(*model.DBInfo, *model.TableInfo)) error {
return BuildBackupSchemas(storage, tableFilter, backupTS, isFullBackup, fn)
}, schemasNum), policies, nil
}
func BuildBackupSchemas(
storage kv.Storage,
tableFilter filter.Filter,
backupTS uint64,
isFullBackup bool,
fn func(dbInfo *model.DBInfo, tableInfo *model.TableInfo),
) error {
snapshot := storage.GetSnapshot(kv.NewVersion(backupTS))
m := meta.NewSnapshotMeta(snapshot)
dbs, err := m.ListDatabases()
if err != nil {
return errors.Trace(err)
}
for _, dbInfo := range dbs {
// skip system databases
if !tableFilter.MatchSchema(dbInfo.Name.O) || util.IsMemDB(dbInfo.Name.L) || utils.IsTemplateSysDB(dbInfo.Name) {
continue
}
if !isFullBackup {
// according to https://github.com/pingcap/tidb/issues/32290.
// ignore placement policy when not in full backup
dbInfo.PlacementPolicyRef = nil
}
hasTable := false
err = m.IterTables(dbInfo.ID, func(tableInfo *model.TableInfo) error {
if !tableFilter.MatchTable(dbInfo.Name.O, tableInfo.Name.O) {
// Skip tables other than the given table.
return nil
}
logger := log.L().With(
zap.String("db", dbInfo.Name.O),
zap.String("table", tableInfo.Name.O),
)
autoIDAccess := m.GetAutoIDAccessors(dbInfo.ID, tableInfo.ID)
var globalAutoID int64
switch {
case tableInfo.IsSequence():
globalAutoID, err = autoIDAccess.SequenceValue().Get()
case tableInfo.IsView() || !utils.NeedAutoID(tableInfo):
// no auto ID for views or table without either rowID nor auto_increment ID.
default:
if tableInfo.SepAutoInc() {
globalAutoID, err = autoIDAccess.IncrementID(tableInfo.Version).Get()
// For a nonclustered table with auto_increment column, both auto_increment_id and _tidb_rowid are required.
// See also https://github.com/pingcap/tidb/issues/46093
if rowID, err1 := autoIDAccess.RowID().Get(); err1 == nil {
tableInfo.AutoIncIDExtra = rowID + 1
} else {
// It is possible that the rowid meta key does not exist (i.e. table have auto_increment_id but no _rowid),
// so err1 != nil might be expected.
if globalAutoID == 0 {
// When both auto_increment_id and _rowid are missing, it must be something wrong.
return errors.Trace(err1)
}
// Print a warning in other scenes, should it be a INFO log?
log.Warn("get rowid error", zap.Error(err1))
}
} else {
globalAutoID, err = autoIDAccess.RowID().Get()
}
}
if err != nil {
return errors.Trace(err)
}
tableInfo.AutoIncID = globalAutoID + 1
if !isFullBackup {
// according to https://github.com/pingcap/tidb/issues/32290.
// ignore placement policy when not in full backup
tableInfo.ClearPlacement()
}
// Treat cached table as normal table.
tableInfo.TableCacheStatusType = model.TableCacheStatusDisable
if tableInfo.ContainsAutoRandomBits() {
// this table has auto_random id, we need backup and rebase in restoration
var globalAutoRandID int64
globalAutoRandID, err = autoIDAccess.RandomID().Get()
if err != nil {
return errors.Trace(err)
}
tableInfo.AutoRandID = globalAutoRandID + 1
logger.Debug("change table AutoRandID",
zap.Int64("AutoRandID", globalAutoRandID))
}
logger.Debug("change table AutoIncID",
zap.Int64("AutoIncID", globalAutoID))
// remove all non-public indices
n := 0
for _, index := range tableInfo.Indices {
if index.State == model.StatePublic {
tableInfo.Indices[n] = index
n++
}
}
tableInfo.Indices = tableInfo.Indices[:n]
fn(dbInfo, tableInfo)
hasTable = true
return nil
})
if err != nil {
return errors.Trace(err)
}
if !hasTable {
fn(dbInfo, nil)
}
}
return nil
}
// BuildFullSchema builds a full backup schemas for databases and tables.
func BuildFullSchema(storage kv.Storage, backupTS uint64, fn func(dbInfo *model.DBInfo, tableInfo *model.TableInfo)) error {
snapshot := storage.GetSnapshot(kv.NewVersion(backupTS))
m := meta.NewSnapshotMeta(snapshot)
dbs, err := m.ListDatabases()
if err != nil {
return errors.Trace(err)
}
for _, db := range dbs {
hasTable := false
err = m.IterTables(db.ID, func(table *model.TableInfo) error {
// add table
fn(db, table)
hasTable = true
return nil
})
if err != nil {
return errors.Trace(err)
}
// backup this empty db if this schema is empty.
if !hasTable {
fn(db, nil)
}
}
return nil
}
func skipUnsupportedDDLJob(job *model.Job) bool {
switch job.Type {
// TiDB V5.3.0 supports TableAttributes and TablePartitionAttributes.
// Backup guarantees data integrity but region placement, which is out of scope of backup
case model.ActionCreatePlacementPolicy,
model.ActionAlterPlacementPolicy,
model.ActionDropPlacementPolicy,
model.ActionAlterTablePartitionPlacement,
model.ActionModifySchemaDefaultPlacement,
model.ActionAlterTablePlacement,
model.ActionAlterTableAttributes,
model.ActionAlterTablePartitionAttributes:
return true
default:
return false
}
}
// WriteBackupDDLJobs sends the ddl jobs are done in (lastBackupTS, backupTS] to metaWriter.
func WriteBackupDDLJobs(metaWriter *metautil.MetaWriter, g glue.Glue, store kv.Storage, lastBackupTS, backupTS uint64, needDomain bool) error {
snapshot := store.GetSnapshot(kv.NewVersion(backupTS))
snapMeta := meta.NewSnapshotMeta(snapshot)
lastSnapshot := store.GetSnapshot(kv.NewVersion(lastBackupTS))
lastSnapMeta := meta.NewSnapshotMeta(lastSnapshot)
lastSchemaVersion, err := lastSnapMeta.GetSchemaVersionWithNonEmptyDiff()
if err != nil {
return errors.Trace(err)
}
backupSchemaVersion, err := snapMeta.GetSchemaVersionWithNonEmptyDiff()
if err != nil {
return errors.Trace(err)