/
region.go
996 lines (880 loc) · 28 KB
/
region.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
// Copyright 2016 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 core
import (
"bytes"
"encoding/hex"
"fmt"
"math/rand"
"reflect"
"strings"
"time"
"unsafe"
"github.com/gogo/protobuf/proto"
"github.com/pingcap/kvproto/pkg/metapb"
"github.com/pingcap/kvproto/pkg/pdpb"
)
// RegionInfo records detail region info.
// Read-Only once created.
type RegionInfo struct {
meta *metapb.Region
learners []*metapb.Peer
voters []*metapb.Peer
leader *metapb.Peer
downPeers []*pdpb.PeerStats
pendingPeers []*metapb.Peer
writtenBytes uint64
readBytes uint64
approximateSize int64
approximateKeys int64
}
// NewRegionInfo creates RegionInfo with region's meta and leader peer.
func NewRegionInfo(region *metapb.Region, leader *metapb.Peer, opts ...RegionCreateOption) *RegionInfo {
regionInfo := &RegionInfo{
meta: region,
leader: leader,
}
for _, opt := range opts {
opt(regionInfo)
}
classifyVoterAndLearner(regionInfo)
return regionInfo
}
// classifyVoterAndLearner sorts out voter and learner from peers into different slice.
func classifyVoterAndLearner(region *RegionInfo) {
learners := make([]*metapb.Peer, 0, 1)
voters := make([]*metapb.Peer, 0, len(region.meta.Peers))
for _, p := range region.meta.Peers {
if p.IsLearner {
learners = append(learners, p)
} else {
voters = append(voters, p)
}
}
region.learners = learners
region.voters = voters
}
// EmptyRegionApproximateSize is the region approximate size of an empty region
// (heartbeat size <= 1MB).
const EmptyRegionApproximateSize = 1
// RegionFromHeartbeat constructs a Region from region heartbeat.
func RegionFromHeartbeat(heartbeat *pdpb.RegionHeartbeatRequest) *RegionInfo {
// Convert unit to MB.
// If region is empty or less than 1MB, use 1MB instead.
regionSize := heartbeat.GetApproximateSize() / (1 << 20)
if regionSize < EmptyRegionApproximateSize {
regionSize = EmptyRegionApproximateSize
}
region := &RegionInfo{
meta: heartbeat.GetRegion(),
leader: heartbeat.GetLeader(),
downPeers: heartbeat.GetDownPeers(),
pendingPeers: heartbeat.GetPendingPeers(),
writtenBytes: heartbeat.GetBytesWritten(),
readBytes: heartbeat.GetBytesRead(),
approximateSize: int64(regionSize),
approximateKeys: int64(heartbeat.GetApproximateKeys()),
}
classifyVoterAndLearner(region)
return region
}
// Clone returns a copy of current regionInfo.
func (r *RegionInfo) Clone(opts ...RegionCreateOption) *RegionInfo {
downPeers := make([]*pdpb.PeerStats, 0, len(r.downPeers))
for _, peer := range r.downPeers {
downPeers = append(downPeers, proto.Clone(peer).(*pdpb.PeerStats))
}
pendingPeers := make([]*metapb.Peer, 0, len(r.pendingPeers))
for _, peer := range r.pendingPeers {
pendingPeers = append(pendingPeers, proto.Clone(peer).(*metapb.Peer))
}
region := &RegionInfo{
meta: proto.Clone(r.meta).(*metapb.Region),
leader: proto.Clone(r.leader).(*metapb.Peer),
downPeers: downPeers,
pendingPeers: pendingPeers,
writtenBytes: r.writtenBytes,
readBytes: r.readBytes,
approximateSize: r.approximateSize,
approximateKeys: r.approximateKeys,
}
for _, opt := range opts {
opt(region)
}
classifyVoterAndLearner(region)
return region
}
// GetLearners returns the learners.
func (r *RegionInfo) GetLearners() []*metapb.Peer {
return r.learners
}
// GetVoters returns the voters.
func (r *RegionInfo) GetVoters() []*metapb.Peer {
return r.voters
}
// GetPeer returns the peer with specified peer id.
func (r *RegionInfo) GetPeer(peerID uint64) *metapb.Peer {
for _, peer := range r.meta.GetPeers() {
if peer.GetId() == peerID {
return peer
}
}
return nil
}
// GetDownPeer returns the down peer with specified peer id.
func (r *RegionInfo) GetDownPeer(peerID uint64) *metapb.Peer {
for _, down := range r.downPeers {
if down.GetPeer().GetId() == peerID {
return down.GetPeer()
}
}
return nil
}
// GetDownVoter returns the down voter with specified peer id.
func (r *RegionInfo) GetDownVoter(peerID uint64) *metapb.Peer {
for _, down := range r.downPeers {
if down.GetPeer().GetId() == peerID && !down.GetPeer().IsLearner {
return down.GetPeer()
}
}
return nil
}
// GetDownLearner returns the down learner with soecified peer id.
func (r *RegionInfo) GetDownLearner(peerID uint64) *metapb.Peer {
for _, down := range r.downPeers {
if down.GetPeer().GetId() == peerID && down.GetPeer().IsLearner {
return down.GetPeer()
}
}
return nil
}
// GetPendingPeer returns the pending peer with specified peer id.
func (r *RegionInfo) GetPendingPeer(peerID uint64) *metapb.Peer {
for _, peer := range r.pendingPeers {
if peer.GetId() == peerID {
return peer
}
}
return nil
}
// GetPendingVoter returns the pending voter with specified peer id.
func (r *RegionInfo) GetPendingVoter(peerID uint64) *metapb.Peer {
for _, peer := range r.pendingPeers {
if peer.GetId() == peerID && !peer.IsLearner {
return peer
}
}
return nil
}
// GetPendingLearner returns the pending learner peer with specified peer id.
func (r *RegionInfo) GetPendingLearner(peerID uint64) *metapb.Peer {
for _, peer := range r.pendingPeers {
if peer.GetId() == peerID && peer.IsLearner {
return peer
}
}
return nil
}
// GetStorePeer returns the peer in specified store.
func (r *RegionInfo) GetStorePeer(storeID uint64) *metapb.Peer {
for _, peer := range r.meta.GetPeers() {
if peer.GetStoreId() == storeID {
return peer
}
}
return nil
}
// GetStoreVoter returns the voter in specified store.
func (r *RegionInfo) GetStoreVoter(storeID uint64) *metapb.Peer {
for _, peer := range r.voters {
if peer.GetStoreId() == storeID {
return peer
}
}
return nil
}
// GetStoreLearner returns the learner peer in specified store.
func (r *RegionInfo) GetStoreLearner(storeID uint64) *metapb.Peer {
for _, peer := range r.learners {
if peer.GetStoreId() == storeID {
return peer
}
}
return nil
}
// GetStoreIds returns a map indicate the region distributed.
func (r *RegionInfo) GetStoreIds() map[uint64]struct{} {
peers := r.meta.GetPeers()
stores := make(map[uint64]struct{}, len(peers))
for _, peer := range peers {
stores[peer.GetStoreId()] = struct{}{}
}
return stores
}
// GetFollowers returns a map indicate the follow peers distributed.
func (r *RegionInfo) GetFollowers() map[uint64]*metapb.Peer {
peers := r.GetVoters()
followers := make(map[uint64]*metapb.Peer, len(peers))
for _, peer := range peers {
if r.leader == nil || r.leader.GetId() != peer.GetId() {
followers[peer.GetStoreId()] = peer
}
}
return followers
}
// GetFollower randomly returns a follow peer.
func (r *RegionInfo) GetFollower() *metapb.Peer {
for _, peer := range r.GetVoters() {
if r.leader == nil || r.leader.GetId() != peer.GetId() {
return peer
}
}
return nil
}
// GetDiffFollowers returns the followers which is not located in the same
// store as any other followers of the another specified region.
func (r *RegionInfo) GetDiffFollowers(other *RegionInfo) []*metapb.Peer {
res := make([]*metapb.Peer, 0, len(r.meta.Peers))
for _, p := range r.GetFollowers() {
diff := true
for _, o := range other.GetFollowers() {
if p.GetStoreId() == o.GetStoreId() {
diff = false
break
}
}
if diff {
res = append(res, p)
}
}
return res
}
// GetID returns the ID of the region.
func (r *RegionInfo) GetID() uint64 {
return r.meta.GetId()
}
// GetMeta returns the meta information of the region.
func (r *RegionInfo) GetMeta() *metapb.Region {
return r.meta
}
// GetApproximateSize returns the approximate size of the region.
func (r *RegionInfo) GetApproximateSize() int64 {
return r.approximateSize
}
// GetApproximateKeys returns the approximate keys of the region.
func (r *RegionInfo) GetApproximateKeys() int64 {
return r.approximateKeys
}
// GetDownPeers returns the down peers of the region.
func (r *RegionInfo) GetDownPeers() []*pdpb.PeerStats {
return r.downPeers
}
// GetPendingPeers returns the pending peers of the region.
func (r *RegionInfo) GetPendingPeers() []*metapb.Peer {
return r.pendingPeers
}
// GetBytesRead returns the read bytes of the region.
func (r *RegionInfo) GetBytesRead() uint64 {
return r.readBytes
}
// GetBytesWritten returns the written bytes of the region.
func (r *RegionInfo) GetBytesWritten() uint64 {
return r.writtenBytes
}
// GetLeader returns the leader of the region.
func (r *RegionInfo) GetLeader() *metapb.Peer {
return r.leader
}
// GetStartKey returns the start key of the region.
func (r *RegionInfo) GetStartKey() []byte {
return r.meta.StartKey
}
// GetEndKey returns the end key of the region.
func (r *RegionInfo) GetEndKey() []byte {
return r.meta.EndKey
}
// GetPeers returns the peers of the region.
func (r *RegionInfo) GetPeers() []*metapb.Peer {
return r.meta.GetPeers()
}
// GetRegionEpoch returns the region epoch of the region.
func (r *RegionInfo) GetRegionEpoch() *metapb.RegionEpoch {
return r.meta.RegionEpoch
}
// RegionStat records each hot region's statistics
type RegionStat struct {
RegionID uint64 `json:"region_id"`
FlowBytes uint64 `json:"flow_bytes"`
// HotDegree records the hot region update times
HotDegree int `json:"hot_degree"`
// LastUpdateTime used to calculate average write
LastUpdateTime time.Time `json:"last_update_time"`
StoreID uint64 `json:"-"`
// AntiCount used to eliminate some noise when remove region in cache
AntiCount int
// Version used to check the region split times
Version uint64
// Stats is a rolling statistics, recording some recently added records.
Stats *RollingStats
}
// NewRegionStat returns a RegionStat.
func NewRegionStat(region *RegionInfo, flowBytes uint64, antiCount int) *RegionStat {
return &RegionStat{
RegionID: region.GetID(),
FlowBytes: flowBytes,
LastUpdateTime: time.Now(),
StoreID: region.leader.GetStoreId(),
Version: region.meta.GetRegionEpoch().GetVersion(),
AntiCount: antiCount,
}
}
// RegionsStat is a list of a group region state type
type RegionsStat []RegionStat
func (m RegionsStat) Len() int { return len(m) }
func (m RegionsStat) Swap(i, j int) { m[i], m[j] = m[j], m[i] }
func (m RegionsStat) Less(i, j int) bool { return m[i].FlowBytes < m[j].FlowBytes }
// HotRegionsStat records all hot regions statistics
type HotRegionsStat struct {
TotalFlowBytes uint64 `json:"total_flow_bytes"`
RegionsCount int `json:"regions_count"`
RegionsStat RegionsStat `json:"statistics"`
}
// regionMap wraps a map[uint64]*core.RegionInfo and supports randomly pick a region.
type regionMap struct {
m map[uint64]*regionEntry
ids []uint64
totalSize int64
totalKeys int64
}
type regionEntry struct {
*RegionInfo
pos int
}
func newRegionMap() *regionMap {
return ®ionMap{
m: make(map[uint64]*regionEntry),
totalSize: 0,
}
}
func (rm *regionMap) Len() int {
if rm == nil {
return 0
}
return len(rm.m)
}
func (rm *regionMap) Get(id uint64) *RegionInfo {
if rm == nil {
return nil
}
if entry, ok := rm.m[id]; ok {
return entry.RegionInfo
}
return nil
}
func (rm *regionMap) Put(region *RegionInfo) {
if old, ok := rm.m[region.GetID()]; ok {
rm.totalSize += region.approximateSize - old.approximateSize
rm.totalKeys += region.approximateKeys - old.approximateKeys
old.RegionInfo = region
return
}
rm.m[region.GetID()] = ®ionEntry{
RegionInfo: region,
pos: len(rm.ids),
}
rm.ids = append(rm.ids, region.GetID())
rm.totalSize += region.approximateSize
rm.totalKeys += region.approximateKeys
}
func (rm *regionMap) RandomRegion() *RegionInfo {
if rm.Len() == 0 {
return nil
}
return rm.Get(rm.ids[rand.Intn(rm.Len())])
}
func (rm *regionMap) Delete(id uint64) {
if rm == nil {
return
}
if old, ok := rm.m[id]; ok {
len := rm.Len()
last := rm.m[rm.ids[len-1]]
last.pos = old.pos
rm.ids[last.pos] = last.GetID()
delete(rm.m, id)
rm.ids = rm.ids[:len-1]
rm.totalSize -= old.approximateSize
rm.totalKeys -= old.approximateKeys
}
}
func (rm *regionMap) TotalSize() int64 {
if rm.Len() == 0 {
return 0
}
return rm.totalSize
}
// RegionsInfo for export
type RegionsInfo struct {
tree *regionTree
regions *regionMap // regionID -> regionInfo
leaders map[uint64]*regionMap // storeID -> regionID -> regionInfo
followers map[uint64]*regionMap // storeID -> regionID -> regionInfo
learners map[uint64]*regionMap // storeID -> regionID -> regionInfo
pendingPeers map[uint64]*regionMap // storeID -> regionID -> regionInfo
}
// NewRegionsInfo creates RegionsInfo with tree, regions, leaders and followers
func NewRegionsInfo() *RegionsInfo {
return &RegionsInfo{
tree: newRegionTree(),
regions: newRegionMap(),
leaders: make(map[uint64]*regionMap),
followers: make(map[uint64]*regionMap),
learners: make(map[uint64]*regionMap),
pendingPeers: make(map[uint64]*regionMap),
}
}
// GetRegion returns the RegionInfo with regionID
func (r *RegionsInfo) GetRegion(regionID uint64) *RegionInfo {
region := r.regions.Get(regionID)
if region == nil {
return nil
}
return region
}
// SetRegion sets the RegionInfo with regionID
func (r *RegionsInfo) SetRegion(region *RegionInfo) []*metapb.Region {
if origin := r.regions.Get(region.GetID()); origin != nil {
r.RemoveRegion(origin)
}
return r.AddRegion(region)
}
// Length returns the RegionsInfo length
func (r *RegionsInfo) Length() int {
return r.regions.Len()
}
// TreeLength returns the RegionsInfo tree length(now only used in test)
func (r *RegionsInfo) TreeLength() int {
return r.tree.length()
}
// GetOverlaps returns the regions which are overlapped with the specified region range.
func (r *RegionsInfo) GetOverlaps(region *RegionInfo) []*metapb.Region {
return r.tree.getOverlaps(region.meta)
}
// AddRegion adds RegionInfo to regionTree and regionMap, also update leaders and followers by region peers
func (r *RegionsInfo) AddRegion(region *RegionInfo) []*metapb.Region {
// Add to tree and regions.
overlaps := r.tree.update(region.meta)
for _, item := range overlaps {
r.RemoveRegion(r.GetRegion(item.Id))
}
r.regions.Put(region)
// Add to leaders and followers.
for _, peer := range region.GetVoters() {
storeID := peer.GetStoreId()
if peer.GetId() == region.leader.GetId() {
// Add leader peer to leaders.
store, ok := r.leaders[storeID]
if !ok {
store = newRegionMap()
r.leaders[storeID] = store
}
store.Put(region)
} else {
// Add follower peer to followers.
store, ok := r.followers[storeID]
if !ok {
store = newRegionMap()
r.followers[storeID] = store
}
store.Put(region)
}
}
// Add to learners.
for _, peer := range region.GetLearners() {
storeID := peer.GetStoreId()
store, ok := r.learners[storeID]
if !ok {
store = newRegionMap()
r.learners[storeID] = store
}
store.Put(region)
}
for _, peer := range region.pendingPeers {
storeID := peer.GetStoreId()
store, ok := r.pendingPeers[storeID]
if !ok {
store = newRegionMap()
r.pendingPeers[storeID] = store
}
store.Put(region)
}
return overlaps
}
// RemoveRegion removes RegionInfo from regionTree and regionMap
func (r *RegionsInfo) RemoveRegion(region *RegionInfo) {
// Remove from tree and regions.
r.tree.remove(region.meta)
r.regions.Delete(region.GetID())
// Remove from leaders and followers.
for _, peer := range region.meta.GetPeers() {
storeID := peer.GetStoreId()
r.leaders[storeID].Delete(region.GetID())
r.followers[storeID].Delete(region.GetID())
r.learners[storeID].Delete(region.GetID())
r.pendingPeers[storeID].Delete(region.GetID())
}
}
// SearchRegion searches RegionInfo from regionTree
func (r *RegionsInfo) SearchRegion(regionKey []byte) *RegionInfo {
metaRegion := r.tree.search(regionKey)
if metaRegion == nil {
return nil
}
return r.GetRegion(metaRegion.GetId())
}
// SearchPrevRegion searches previous RegionInfo from regionTree
func (r *RegionsInfo) SearchPrevRegion(regionKey []byte) *RegionInfo {
metaRegion := r.tree.searchPrev(regionKey)
if metaRegion == nil {
return nil
}
return r.GetRegion(metaRegion.GetId())
}
// GetRegions gets all RegionInfo from regionMap
func (r *RegionsInfo) GetRegions() []*RegionInfo {
regions := make([]*RegionInfo, 0, r.regions.Len())
for _, region := range r.regions.m {
regions = append(regions, region.RegionInfo)
}
return regions
}
// GetStoreRegions gets all RegionInfo with a given storeID
func (r *RegionsInfo) GetStoreRegions(storeID uint64) []*RegionInfo {
regions := make([]*RegionInfo, 0, r.GetStoreLeaderCount(storeID)+r.GetStoreFollowerCount(storeID))
if leaders, ok := r.leaders[storeID]; ok {
for _, region := range leaders.m {
regions = append(regions, region.RegionInfo)
}
}
if followers, ok := r.followers[storeID]; ok {
for _, region := range followers.m {
regions = append(regions, region.RegionInfo)
}
}
return regions
}
// GetStoreLeaderRegionSize get total size of store's leader regions
func (r *RegionsInfo) GetStoreLeaderRegionSize(storeID uint64) int64 {
return r.leaders[storeID].TotalSize()
}
// GetStoreFollowerRegionSize get total size of store's follower regions
func (r *RegionsInfo) GetStoreFollowerRegionSize(storeID uint64) int64 {
return r.followers[storeID].TotalSize()
}
// GetStoreLearnerRegionSize get total size of store's learner regions
func (r *RegionsInfo) GetStoreLearnerRegionSize(storeID uint64) int64 {
return r.learners[storeID].TotalSize()
}
// GetStoreRegionSize get total size of store's regions
func (r *RegionsInfo) GetStoreRegionSize(storeID uint64) int64 {
return r.GetStoreLeaderRegionSize(storeID) + r.GetStoreFollowerRegionSize(storeID) + r.GetStoreLearnerRegionSize(storeID)
}
// GetMetaRegions gets a set of metapb.Region from regionMap
func (r *RegionsInfo) GetMetaRegions() []*metapb.Region {
regions := make([]*metapb.Region, 0, r.regions.Len())
for _, region := range r.regions.m {
regions = append(regions, proto.Clone(region.meta).(*metapb.Region))
}
return regions
}
// GetRegionCount gets the total count of RegionInfo of regionMap
func (r *RegionsInfo) GetRegionCount() int {
return r.regions.Len()
}
// GetStoreRegionCount gets the total count of a store's leader and follower RegionInfo by storeID
func (r *RegionsInfo) GetStoreRegionCount(storeID uint64) int {
return r.GetStoreLeaderCount(storeID) + r.GetStoreFollowerCount(storeID) + r.GetStoreLearnerCount(storeID)
}
// GetStorePendingPeerCount gets the total count of a store's region that includes pending peer
func (r *RegionsInfo) GetStorePendingPeerCount(storeID uint64) int {
return r.pendingPeers[storeID].Len()
}
// GetStoreLeaderCount get the total count of a store's leader RegionInfo
func (r *RegionsInfo) GetStoreLeaderCount(storeID uint64) int {
return r.leaders[storeID].Len()
}
// GetStoreFollowerCount get the total count of a store's follower RegionInfo
func (r *RegionsInfo) GetStoreFollowerCount(storeID uint64) int {
return r.followers[storeID].Len()
}
// GetStoreLearnerCount get the total count of a store's learner RegionInfo
func (r *RegionsInfo) GetStoreLearnerCount(storeID uint64) int {
return r.learners[storeID].Len()
}
// RandRegion get a region by random
func (r *RegionsInfo) RandRegion(opts ...RegionOption) *RegionInfo {
return randRegion(r.regions, opts...)
}
// RandLeaderRegion get a store's leader region by random
func (r *RegionsInfo) RandLeaderRegion(storeID uint64, opts ...RegionOption) *RegionInfo {
return randRegion(r.leaders[storeID], opts...)
}
// RandFollowerRegion get a store's follower region by random
func (r *RegionsInfo) RandFollowerRegion(storeID uint64, opts ...RegionOption) *RegionInfo {
return randRegion(r.followers[storeID], opts...)
}
// GetLeader return leader RegionInfo by storeID and regionID(now only used in test)
func (r *RegionsInfo) GetLeader(storeID uint64, regionID uint64) *RegionInfo {
return r.leaders[storeID].Get(regionID)
}
// GetFollower return follower RegionInfo by storeID and regionID(now only used in test)
func (r *RegionsInfo) GetFollower(storeID uint64, regionID uint64) *RegionInfo {
return r.followers[storeID].Get(regionID)
}
// ScanRange scans region with start key, until number greater than limit.
func (r *RegionsInfo) ScanRange(startKey []byte, limit int) []*RegionInfo {
res := make([]*RegionInfo, 0, limit)
r.tree.scanRange(startKey, func(metaRegion *metapb.Region) bool {
res = append(res, r.GetRegion(metaRegion.GetId()))
return len(res) < limit
})
return res
}
// GetAdjacentRegions returns region's info that is adjacent with specific region
func (r *RegionsInfo) GetAdjacentRegions(region *RegionInfo) (*RegionInfo, *RegionInfo) {
metaPrev, metaNext := r.tree.getAdjacentRegions(region.meta)
var prev, next *RegionInfo
// check key to avoid key range hole
if metaPrev != nil && bytes.Equal(metaPrev.region.EndKey, region.meta.StartKey) {
prev = r.GetRegion(metaPrev.region.GetId())
}
if metaNext != nil && bytes.Equal(region.meta.EndKey, metaNext.region.StartKey) {
next = r.GetRegion(metaNext.region.GetId())
}
return prev, next
}
// GetAverageRegionSize returns the average region approximate size.
func (r *RegionsInfo) GetAverageRegionSize() int64 {
if r.regions.Len() == 0 {
return 0
}
return r.regions.TotalSize() / int64(r.regions.Len())
}
// RegionStats records a list of regions' statistics and distribution status.
type RegionStats struct {
Count int `json:"count"`
EmptyCount int `json:"empty_count"`
StorageSize int64 `json:"storage_size"`
StorageKeys int64 `json:"storage_keys"`
StoreLeaderCount map[uint64]int `json:"store_leader_count"`
StorePeerCount map[uint64]int `json:"store_peer_count"`
StoreLeaderSize map[uint64]int64 `json:"store_leader_size"`
StoreLeaderKeys map[uint64]int64 `json:"store_leader_keys"`
StorePeerSize map[uint64]int64 `json:"store_peer_size"`
StorePeerKeys map[uint64]int64 `json:"store_peer_keys"`
}
func newRegionStats() *RegionStats {
return &RegionStats{
StoreLeaderCount: make(map[uint64]int),
StorePeerCount: make(map[uint64]int),
StoreLeaderSize: make(map[uint64]int64),
StoreLeaderKeys: make(map[uint64]int64),
StorePeerSize: make(map[uint64]int64),
StorePeerKeys: make(map[uint64]int64),
}
}
// Observe adds a region's statistics into RegionStats.
func (s *RegionStats) Observe(r *RegionInfo) {
s.Count++
if r.approximateSize <= EmptyRegionApproximateSize {
s.EmptyCount++
}
s.StorageSize += r.approximateSize
s.StorageKeys += r.approximateKeys
if r.leader != nil {
s.StoreLeaderCount[r.leader.GetStoreId()]++
s.StoreLeaderSize[r.leader.GetStoreId()] += r.approximateSize
s.StoreLeaderKeys[r.leader.GetStoreId()] += r.approximateKeys
}
for _, p := range r.meta.Peers {
s.StorePeerCount[p.GetStoreId()]++
s.StorePeerSize[p.GetStoreId()] += r.approximateSize
s.StorePeerKeys[p.GetStoreId()] += r.approximateKeys
}
}
// GetRegionStats scans regions that inside range [startKey, endKey) and sums up
// their statistics.
func (r *RegionsInfo) GetRegionStats(startKey, endKey []byte) *RegionStats {
stats := newRegionStats()
r.tree.scanRange(startKey, func(meta *metapb.Region) bool {
if len(endKey) > 0 && (len(meta.EndKey) == 0 || bytes.Compare(meta.EndKey, endKey) >= 0) {
return false
}
if region := r.GetRegion(meta.GetId()); region != nil {
stats.Observe(region)
}
return true
})
return stats
}
const randomRegionMaxRetry = 10
func randRegion(regions *regionMap, opts ...RegionOption) *RegionInfo {
for i := 0; i < randomRegionMaxRetry; i++ {
region := regions.RandomRegion()
if region == nil {
return nil
}
isSelect := true
for _, opt := range opts {
if !opt(region) {
isSelect = false
break
}
}
if isSelect {
return region
}
}
return nil
}
// DiffRegionPeersInfo return the difference of peers info between two RegionInfo
func DiffRegionPeersInfo(origin *RegionInfo, other *RegionInfo) string {
var ret []string
for _, a := range origin.meta.Peers {
both := false
for _, b := range other.meta.Peers {
if reflect.DeepEqual(a, b) {
both = true
break
}
}
if !both {
ret = append(ret, fmt.Sprintf("Remove peer:{%v}", a))
}
}
for _, b := range other.meta.Peers {
both := false
for _, a := range origin.meta.Peers {
if reflect.DeepEqual(a, b) {
both = true
break
}
}
if !both {
ret = append(ret, fmt.Sprintf("Add peer:{%v}", b))
}
}
return strings.Join(ret, ",")
}
// DiffRegionKeyInfo return the difference of key info between two RegionInfo
func DiffRegionKeyInfo(origin *RegionInfo, other *RegionInfo) string {
var ret []string
if !bytes.Equal(origin.meta.StartKey, other.meta.StartKey) {
ret = append(ret, fmt.Sprintf("StartKey Changed:%s -> %s", HexRegionKey(origin.meta.StartKey), HexRegionKey(other.meta.StartKey)))
} else {
ret = append(ret, fmt.Sprintf("StartKey:%s", HexRegionKey(origin.meta.StartKey)))
}
if !bytes.Equal(origin.meta.EndKey, other.meta.EndKey) {
ret = append(ret, fmt.Sprintf("EndKey Changed:%s -> %s", HexRegionKey(origin.meta.EndKey), HexRegionKey(other.meta.EndKey)))
} else {
ret = append(ret, fmt.Sprintf("EndKey:%s", HexRegionKey(origin.meta.EndKey)))
}
return strings.Join(ret, ", ")
}
// String converts slice of bytes to string without copy.
func String(b []byte) (s string) {
if len(b) == 0 {
return ""
}
pbytes := (*reflect.SliceHeader)(unsafe.Pointer(&b))
pstring := (*reflect.StringHeader)(unsafe.Pointer(&s))
pstring.Data = pbytes.Data
pstring.Len = pbytes.Len
return
}
// ToUpperASCIIInplace bytes.ToUpper but zero-cost
func ToUpperASCIIInplace(s []byte) []byte {
hasLower := false
for i := 0; i < len(s); i++ {
c := s[i]
hasLower = hasLower || ('a' <= c && c <= 'z')
}
if !hasLower {
return s
}
var c byte
for i := 0; i < len(s); i++ {
c = s[i]
if 'a' <= c && c <= 'z' {
c -= 'a' - 'A'
}
s[i] = c
}
return s
}
// EncodeToString overrides hex.EncodeToString implementation. Difference: returns []byte, not string
func EncodeToString(src []byte) []byte {
dst := make([]byte, hex.EncodedLen(len(src)))
hex.Encode(dst, src)
return dst
}
// HexRegionKey converts region key to hex format. Used for formating region in
// logs.
func HexRegionKey(key []byte) []byte {
return ToUpperASCIIInplace(EncodeToString(key))
}
// HexRegionKeyStr converts region key to hex format. Used for formating region in
// logs.
func HexRegionKeyStr(key []byte) string {
return String(HexRegionKey(key))
}
// RegionToHexMeta converts a region meta's keys to hex format. Used for formating
// region in logs.
func RegionToHexMeta(meta *metapb.Region) HexRegionMeta {
if meta == nil {
return HexRegionMeta{}
}
meta = proto.Clone(meta).(*metapb.Region)
meta.StartKey = HexRegionKey(meta.StartKey)
meta.EndKey = HexRegionKey(meta.EndKey)
return HexRegionMeta{meta}
}
// HexRegionMeta is a region meta in the hex format. Used for formating region in logs.
type HexRegionMeta struct {
*metapb.Region
}
func (h HexRegionMeta) String() string {
return strings.TrimSpace(proto.CompactTextString(h.Region))
}
// RegionsToHexMeta converts regions' meta keys to hex format. Used for formating
// region in logs.
func RegionsToHexMeta(regions []*metapb.Region) HexRegionsMeta {
hexRegionMetas := make([]*metapb.Region, len(regions))
for i, region := range regions {
meta := proto.Clone(region).(*metapb.Region)
meta.StartKey = HexRegionKey(meta.StartKey)
meta.EndKey = HexRegionKey(meta.EndKey)
hexRegionMetas[i] = meta
}
return HexRegionsMeta(hexRegionMetas)
}
// HexRegionsMeta is a slice of regions' meta in the hex format. Used for formating
// region in logs.
type HexRegionsMeta []*metapb.Region
func (h HexRegionsMeta) String() string {
var b strings.Builder
for _, r := range h {
b.WriteString(proto.CompactTextString(r))
}
return strings.TrimSpace(b.String())
}