/
peer.rs
3961 lines (3690 loc) · 155 KB
/
peer.rs
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 2018 TiKV Project Authors. Licensed under Apache-2.0.
use std::borrow::Cow;
use std::collections::Bound::{Excluded, Included, Unbounded};
use std::collections::VecDeque;
use std::time::Instant;
use std::{cmp, u64};
use batch_system::{BasicMailbox, Fsm};
use engine_traits::CF_RAFT;
use engine_traits::{Engines, KvEngine, RaftEngine, WriteBatchExt};
use error_code::ErrorCodeExt;
use kvproto::errorpb;
use kvproto::import_sstpb::SstMeta;
use kvproto::metapb::{self, Region, RegionEpoch};
use kvproto::pdpb::CheckPolicy;
use kvproto::raft_cmdpb::{
AdminCmdType, AdminRequest, CmdType, RaftCmdRequest, RaftCmdResponse, Request, StatusCmdType,
StatusResponse,
};
use kvproto::raft_serverpb::{
ExtraMessageType, MergeState, PeerState, RaftMessage, RaftSnapshotData, RaftTruncatedState,
RegionLocalState,
};
use kvproto::replication_modepb::{DrAutoSyncState, ReplicationMode};
use pd_client::PdClient;
use protobuf::Message;
use raft::eraftpb::{ConfChangeType, MessageType};
use raft::{self, SnapshotStatus, INVALID_INDEX, NO_LIMIT};
use raft::{Ready, StateRole};
use tikv_util::collections::HashMap;
use tikv_util::mpsc::{self, LooseBoundedSender, Receiver};
use tikv_util::time::duration_to_sec;
use tikv_util::worker::{Scheduler, Stopped};
use tikv_util::{escape, is_zero_duration, Either};
use crate::coprocessor::RegionChangeEvent;
use crate::store::cmd_resp::{bind_term, new_error};
use crate::store::fsm::store::{PollContext, StoreMeta};
use crate::store::fsm::{
apply, ApplyMetrics, ApplyTask, ApplyTaskRes, CatchUpLogs, ChangeCmd, ChangePeer, ExecResult,
};
use crate::store::local_metrics::RaftProposeMetrics;
use crate::store::metrics::*;
use crate::store::msg::Callback;
use crate::store::peer::{ConsistencyState, Peer, StaleState};
use crate::store::peer_storage::{ApplySnapResult, InvokeContext};
use crate::store::transport::Transport;
use crate::store::util::{is_learner, KeysInfoFormatter};
use crate::store::worker::{
CleanupSSTTask, CleanupTask, ConsistencyCheckTask, RaftlogGcTask, ReadDelegate, RegionTask,
SplitCheckTask,
};
use crate::store::PdTask;
use crate::store::{
util, AbstractPeer, CasualMessage, Config, MergeResultKind, PeerMsg, PeerTicks, RaftCommand,
SignificantMsg, SnapKey, StoreMsg,
};
use crate::{Error, Result};
use keys::{self, enc_end_key, enc_start_key};
const REGION_SPLIT_SKIP_MAX_COUNT: usize = 3;
pub struct DestroyPeerJob {
pub initialized: bool,
pub region_id: u64,
pub peer: metapb::Peer,
}
/// Represents state of the group.
#[derive(Clone, Copy, PartialEq, Debug)]
pub enum GroupState {
/// The group is working generally, leader keeps
/// replicating data to followers.
Ordered,
/// The group is out of order. Leadership may not be hold.
Chaos,
/// The group is about to be out of order. It leave some
/// safe space to avoid stepping chaos too often.
PreChaos,
/// The group is hibernated.
Idle,
}
pub struct PeerFsm<EK, ER>
where
EK: KvEngine,
ER: RaftEngine,
{
pub peer: Peer<EK, ER>,
/// A registry for all scheduled ticks. This can avoid scheduling ticks twice accidentally.
tick_registry: PeerTicks,
/// Ticks for speed up campaign in chaos state.
///
/// Followers will keep ticking in Idle mode to measure how many ticks have been skipped.
/// Once it becomes chaos, those skipped ticks will be ticked so that it can campaign
/// quickly instead of waiting an election timeout.
///
/// This will be reset to 0 once it receives any messages from leader.
missing_ticks: usize,
group_state: GroupState,
stopped: bool,
has_ready: bool,
early_apply: bool,
mailbox: Option<BasicMailbox<PeerFsm<EK, ER>>>,
pub receiver: Receiver<PeerMsg<EK>>,
/// when snapshot is generating or sending, skip split check at most REGION_SPLIT_SKIT_MAX_COUNT times.
skip_split_count: usize,
/// Sometimes applied raft logs won't be compacted in time, because less compact means less
/// sync-log in apply threads. Stale logs will be deleted if the skip time reaches this
/// `skip_gc_raft_log_ticks`.
skip_gc_raft_log_ticks: usize,
// Batch raft command which has the same header into an entry
batch_req_builder: BatchRaftCmdRequestBuilder<EK>,
}
pub struct BatchRaftCmdRequestBuilder<E>
where
E: KvEngine,
{
raft_entry_max_size: f64,
batch_req_size: u32,
request: Option<RaftCmdRequest>,
callbacks: Vec<(Callback<E::Snapshot>, usize)>,
}
impl<EK, ER> Drop for PeerFsm<EK, ER>
where
EK: KvEngine,
ER: RaftEngine,
{
fn drop(&mut self) {
self.peer.stop();
while let Ok(msg) = self.receiver.try_recv() {
let callback = match msg {
PeerMsg::RaftCommand(cmd) => cmd.callback,
PeerMsg::CasualMessage(CasualMessage::SplitRegion { callback, .. }) => callback,
_ => continue,
};
let mut err = errorpb::Error::default();
err.set_message("region is not found".to_owned());
err.mut_region_not_found().set_region_id(self.region_id());
let mut resp = RaftCmdResponse::default();
resp.mut_header().set_error(err);
callback.invoke_with_response(resp);
}
}
}
pub type SenderFsmPair<EK, ER> = (LooseBoundedSender<PeerMsg<EK>>, Box<PeerFsm<EK, ER>>);
impl<EK, ER> PeerFsm<EK, ER>
where
EK: KvEngine,
ER: RaftEngine,
{
// If we create the peer actively, like bootstrap/split/merge region, we should
// use this function to create the peer. The region must contain the peer info
// for this store.
pub fn create(
store_id: u64,
cfg: &Config,
sched: Scheduler<RegionTask<EK::Snapshot>>,
engines: Engines<EK, ER>,
region: &metapb::Region,
) -> Result<SenderFsmPair<EK, ER>> {
let meta_peer = match util::find_peer(region, store_id) {
None => {
return Err(box_err!(
"find no peer for store {} in region {:?}",
store_id,
region
));
}
Some(peer) => peer.clone(),
};
info!(
"create peer";
"region_id" => region.get_id(),
"peer_id" => meta_peer.get_id(),
);
let (tx, rx) = mpsc::loose_bounded(cfg.notify_capacity);
Ok((
tx,
Box::new(PeerFsm {
early_apply: cfg.early_apply,
peer: Peer::new(store_id, cfg, sched, engines, region, meta_peer)?,
tick_registry: PeerTicks::empty(),
missing_ticks: 0,
group_state: GroupState::Ordered,
stopped: false,
has_ready: false,
mailbox: None,
receiver: rx,
skip_split_count: 0,
skip_gc_raft_log_ticks: 0,
batch_req_builder: BatchRaftCmdRequestBuilder::new(
cfg.raft_entry_max_size.0 as f64,
),
}),
))
}
// The peer can be created from another node with raft membership changes, and we only
// know the region_id and peer_id when creating this replicated peer, the region info
// will be retrieved later after applying snapshot.
pub fn replicate(
store_id: u64,
cfg: &Config,
sched: Scheduler<RegionTask<EK::Snapshot>>,
engines: Engines<EK, ER>,
region_id: u64,
peer: metapb::Peer,
) -> Result<SenderFsmPair<EK, ER>> {
// We will remove tombstone key when apply snapshot
info!(
"replicate peer";
"region_id" => region_id,
"peer_id" => peer.get_id(),
);
let mut region = metapb::Region::default();
region.set_id(region_id);
let (tx, rx) = mpsc::loose_bounded(cfg.notify_capacity);
Ok((
tx,
Box::new(PeerFsm {
early_apply: cfg.early_apply,
peer: Peer::new(store_id, cfg, sched, engines, ®ion, peer)?,
tick_registry: PeerTicks::empty(),
missing_ticks: 0,
group_state: GroupState::Ordered,
stopped: false,
has_ready: false,
mailbox: None,
receiver: rx,
skip_split_count: 0,
skip_gc_raft_log_ticks: 0,
batch_req_builder: BatchRaftCmdRequestBuilder::new(
cfg.raft_entry_max_size.0 as f64,
),
}),
))
}
#[inline]
pub fn region_id(&self) -> u64 {
self.peer.region().get_id()
}
#[inline]
pub fn get_peer(&self) -> &Peer<EK, ER> {
&self.peer
}
#[inline]
pub fn peer_id(&self) -> u64 {
self.peer.peer_id()
}
#[inline]
pub fn stop(&mut self) {
self.stopped = true;
}
pub fn set_pending_merge_state(&mut self, state: MergeState) {
self.peer.pending_merge_state = Some(state);
}
pub fn schedule_applying_snapshot(&mut self) {
self.peer.mut_store().schedule_applying_snapshot();
}
}
impl<E> BatchRaftCmdRequestBuilder<E>
where
E: KvEngine,
{
fn new(raft_entry_max_size: f64) -> BatchRaftCmdRequestBuilder<E> {
BatchRaftCmdRequestBuilder {
raft_entry_max_size,
request: None,
batch_req_size: 0,
callbacks: vec![],
}
}
fn can_batch(&self, req: &RaftCmdRequest, req_size: u32) -> bool {
// No batch request whose size exceed 20% of raft_entry_max_size,
// so total size of request in batch_raft_request would not exceed
// (40% + 20%) of raft_entry_max_size
if req.get_requests().is_empty() || f64::from(req_size) > self.raft_entry_max_size * 0.2 {
return false;
}
for r in req.get_requests() {
match r.get_cmd_type() {
CmdType::Delete | CmdType::Put => (),
_ => {
return false;
}
}
}
if let Some(batch_req) = self.request.as_ref() {
if batch_req.get_header() != req.get_header() {
return false;
}
}
true
}
fn add(&mut self, cmd: RaftCommand<E::Snapshot>, req_size: u32) {
let req_num = cmd.request.get_requests().len();
let RaftCommand {
mut request,
callback,
..
} = cmd;
if let Some(batch_req) = self.request.as_mut() {
let requests: Vec<_> = request.take_requests().into();
for q in requests {
batch_req.mut_requests().push(q);
}
} else {
self.request = Some(request);
};
self.callbacks.push((callback, req_num));
self.batch_req_size += req_size;
}
fn should_finish(&self) -> bool {
if let Some(batch_req) = self.request.as_ref() {
// Limit the size of batch request so that it will not exceed raft_entry_max_size after
// adding header.
if f64::from(self.batch_req_size) > self.raft_entry_max_size * 0.4 {
return true;
}
if batch_req.get_requests().len() > <E as WriteBatchExt>::WRITE_BATCH_MAX_KEYS {
return true;
}
}
false
}
fn build(&mut self, metric: &mut RaftProposeMetrics) -> Option<RaftCommand<E::Snapshot>> {
if let Some(req) = self.request.take() {
self.batch_req_size = 0;
if self.callbacks.len() == 1 {
let (cb, _) = self.callbacks.pop().unwrap();
return Some(RaftCommand::new(req, cb));
}
metric.batch += self.callbacks.len() - 1;
let cbs = std::mem::replace(&mut self.callbacks, vec![]);
let cb = Callback::Write(Box::new(move |resp| {
let mut last_index = 0;
let has_error = resp.response.get_header().has_error();
for (cb, req_num) in cbs {
let next_index = last_index + req_num;
let mut cmd_resp = RaftCmdResponse::default();
cmd_resp.set_header(resp.response.get_header().clone());
if !has_error {
cmd_resp.set_responses(
resp.response.get_responses()[last_index..next_index].into(),
);
}
cb.invoke_with_response(cmd_resp);
last_index = next_index;
}
}));
return Some(RaftCommand::new(req, cb));
}
None
}
}
impl<EK, ER> Fsm for PeerFsm<EK, ER>
where
EK: KvEngine,
ER: RaftEngine,
{
type Message = PeerMsg<EK>;
#[inline]
fn is_stopped(&self) -> bool {
self.stopped
}
/// Set a mailbox to Fsm, which should be used to send message to itself.
#[inline]
fn set_mailbox(&mut self, mailbox: Cow<'_, BasicMailbox<Self>>)
where
Self: Sized,
{
self.mailbox = Some(mailbox.into_owned());
}
/// Take the mailbox from Fsm. Implementation should ensure there will be
/// no reference to mailbox after calling this method.
#[inline]
fn take_mailbox(&mut self) -> Option<BasicMailbox<Self>>
where
Self: Sized,
{
self.mailbox.take()
}
}
pub struct PeerFsmDelegate<'a, EK, ER, T: 'static, C: 'static>
where
EK: KvEngine,
ER: RaftEngine,
{
fsm: &'a mut PeerFsm<EK, ER>,
ctx: &'a mut PollContext<EK, ER, T, C>,
}
impl<'a, EK, ER, T: Transport, C: PdClient> PeerFsmDelegate<'a, EK, ER, T, C>
where
EK: KvEngine,
ER: RaftEngine,
{
pub fn new(
fsm: &'a mut PeerFsm<EK, ER>,
ctx: &'a mut PollContext<EK, ER, T, C>,
) -> PeerFsmDelegate<'a, EK, ER, T, C> {
PeerFsmDelegate { fsm, ctx }
}
pub fn handle_msgs(&mut self, msgs: &mut Vec<PeerMsg<EK>>) {
for m in msgs.drain(..) {
match m {
PeerMsg::RaftMessage(msg) => {
if let Err(e) = self.on_raft_message(msg) {
error!(%e;
"handle raft message err";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
);
}
}
PeerMsg::RaftCommand(cmd) => {
self.ctx
.raft_metrics
.propose
.request_wait_time
.observe(duration_to_sec(cmd.send_time.elapsed()) as f64);
let req_size = cmd.request.compute_size();
if self.fsm.batch_req_builder.can_batch(&cmd.request, req_size) {
self.fsm.batch_req_builder.add(cmd, req_size);
if self.fsm.batch_req_builder.should_finish() {
self.propose_batch_raft_command();
}
} else {
self.propose_batch_raft_command();
self.propose_raft_command(cmd.request, cmd.callback)
}
}
PeerMsg::Tick(tick) => self.on_tick(tick),
PeerMsg::ApplyRes { res } => {
self.on_apply_res(res);
}
PeerMsg::SignificantMsg(msg) => self.on_significant_msg(msg),
PeerMsg::CasualMessage(msg) => self.on_casual_msg(msg),
PeerMsg::Start => self.start(),
PeerMsg::HeartbeatPd => {
if self.fsm.peer.is_leader() {
self.register_pd_heartbeat_tick()
}
}
PeerMsg::Noop => {}
PeerMsg::UpdateReplicationMode => self.on_update_replication_mode(),
}
}
// Propose batch request which may be still waiting for more raft-command
self.propose_batch_raft_command();
}
fn propose_batch_raft_command(&mut self) {
if let Some(cmd) = self
.fsm
.batch_req_builder
.build(&mut self.ctx.raft_metrics.propose)
{
self.propose_raft_command(cmd.request, cmd.callback)
}
}
fn on_update_replication_mode(&mut self) {
self.fsm
.peer
.switch_replication_mode(&self.ctx.global_replication_state);
if self.fsm.peer.is_leader() {
self.reset_raft_tick(GroupState::Ordered);
self.register_pd_heartbeat_tick();
}
}
fn on_casual_msg(&mut self, msg: CasualMessage<EK>) {
match msg {
CasualMessage::SplitRegion {
region_epoch,
split_keys,
callback,
} => {
info!(
"on split";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"split_keys" => %KeysInfoFormatter(split_keys.iter()),
);
self.on_prepare_split_region(region_epoch, split_keys, callback);
}
CasualMessage::ComputeHashResult {
index,
context,
hash,
} => {
self.on_hash_computed(index, context, hash);
}
CasualMessage::RegionApproximateSize { size } => {
self.on_approximate_region_size(size);
}
CasualMessage::RegionApproximateKeys { keys } => {
self.on_approximate_region_keys(keys);
}
CasualMessage::CompactionDeclinedBytes { bytes } => {
self.on_compaction_declined_bytes(bytes);
}
CasualMessage::HalfSplitRegion {
region_epoch,
policy,
} => {
self.on_schedule_half_split_region(®ion_epoch, policy);
}
CasualMessage::GcSnap { snaps } => {
self.on_gc_snap(snaps);
}
CasualMessage::ClearRegionSize => {
self.on_clear_region_size();
}
CasualMessage::RegionOverlapped => {
debug!("start ticking for overlapped"; "region_id" => self.region_id(), "peer_id" => self.fsm.peer_id());
// Maybe do some safe check first?
self.fsm.group_state = GroupState::Chaos;
self.register_raft_base_tick();
if is_learner(&self.fsm.peer.peer) {
// FIXME: should use `bcast_check_stale_peer_message` instead.
// Sending a new enum type msg to a old tikv may cause panic during rolling update
// we should change the protobuf behavior and check if properly handled in all place
self.fsm.peer.bcast_wake_up_message(&mut self.ctx);
}
}
CasualMessage::SnapshotGenerated => {
// Resume snapshot handling again to avoid waiting another heartbeat.
self.fsm.peer.ping();
self.fsm.has_ready = true;
}
CasualMessage::ForceCompactRaftLogs => {
self.on_raft_gc_log_tick(true);
}
CasualMessage::AccessPeer(cb) => cb(&mut self.fsm.peer as &mut dyn AbstractPeer),
}
}
fn on_tick(&mut self, tick: PeerTicks) {
if self.fsm.stopped {
return;
}
trace!(
"tick";
"tick" => ?tick,
"peer_id" => self.fsm.peer_id(),
"region_id" => self.region_id(),
);
self.fsm.tick_registry.remove(tick);
match tick {
PeerTicks::RAFT => self.on_raft_base_tick(),
PeerTicks::RAFT_LOG_GC => self.on_raft_gc_log_tick(false),
PeerTicks::PD_HEARTBEAT => self.on_pd_heartbeat_tick(),
PeerTicks::SPLIT_REGION_CHECK => self.on_split_region_check_tick(),
PeerTicks::CHECK_MERGE => self.on_check_merge(),
PeerTicks::CHECK_PEER_STALE_STATE => self.on_check_peer_stale_state_tick(),
_ => unreachable!(),
}
}
fn start(&mut self) {
self.register_raft_base_tick();
self.register_raft_gc_log_tick();
self.register_pd_heartbeat_tick();
self.register_split_region_check_tick();
self.register_check_peer_stale_state_tick();
self.on_check_merge();
// Apply committed entries more quickly.
if self.fsm.peer.raft_group.store().committed_index()
> self.fsm.peer.raft_group.store().applied_index()
{
self.fsm.has_ready = true;
}
}
fn on_gc_snap(&mut self, snaps: Vec<(SnapKey, bool)>) {
let s = self.fsm.peer.get_store();
let compacted_idx = s.truncated_index();
let compacted_term = s.truncated_term();
let is_applying_snap = s.is_applying_snapshot();
for (key, is_sending) in snaps {
if is_sending {
let s = match self.ctx.snap_mgr.get_snapshot_for_sending(&key) {
Ok(s) => s,
Err(e) => {
error!(%e;
"failed to load snapshot";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"snapshot" => ?key,
);
continue;
}
};
if key.term < compacted_term || key.idx < compacted_idx {
info!(
"deleting compacted snap file";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"snap_file" => %key,
);
self.ctx.snap_mgr.delete_snapshot(&key, s.as_ref(), false);
} else if let Ok(meta) = s.meta() {
let modified = match meta.modified() {
Ok(m) => m,
Err(e) => {
error!(
"failed to load snapshot";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"snapshot" => ?key,
"err" => %e,
);
continue;
}
};
if let Ok(elapsed) = modified.elapsed() {
if elapsed > self.ctx.cfg.snap_gc_timeout.0 {
info!(
"deleting expired snap file";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"snap_file" => %key,
);
self.ctx.snap_mgr.delete_snapshot(&key, s.as_ref(), false);
}
}
}
} else if key.term <= compacted_term
&& (key.idx < compacted_idx || key.idx == compacted_idx && !is_applying_snap)
{
info!(
"deleting applied snap file";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"snap_file" => %key,
);
let a = match self.ctx.snap_mgr.get_snapshot_for_applying(&key) {
Ok(a) => a,
Err(e) => {
error!(%e;
"failed to load snapshot";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"snap_file" => %key,
);
continue;
}
};
self.ctx.snap_mgr.delete_snapshot(&key, a.as_ref(), false);
}
}
}
fn on_clear_region_size(&mut self) {
self.fsm.peer.approximate_size = None;
self.fsm.peer.approximate_keys = None;
self.register_split_region_check_tick();
}
fn on_capture_change(
&mut self,
cmd: ChangeCmd,
region_epoch: RegionEpoch,
cb: Callback<EK::Snapshot>,
) {
fail_point!("raft_on_capture_change");
let region_id = self.region_id();
let msg =
new_read_index_request(region_id, region_epoch.clone(), self.fsm.peer.peer.clone());
let apply_router = self.ctx.apply_router.clone();
self.propose_raft_command(
msg,
Callback::Read(Box::new(move |resp| {
// Return the error
if resp.response.get_header().has_error() {
cb.invoke_read(resp);
return;
}
apply_router.schedule_task(
region_id,
ApplyTask::Change {
cmd,
region_epoch,
cb,
},
)
})),
);
}
fn on_significant_msg(&mut self, msg: SignificantMsg<EK::Snapshot>) {
match msg {
SignificantMsg::SnapshotStatus {
to_peer_id, status, ..
} => {
// Report snapshot status to the corresponding peer.
self.report_snapshot_status(to_peer_id, status);
}
SignificantMsg::Unreachable { to_peer_id, .. } => {
if self.fsm.peer.is_leader() {
self.fsm.peer.raft_group.report_unreachable(to_peer_id);
} else if to_peer_id == self.fsm.peer.leader_id() {
self.fsm.group_state = GroupState::Chaos;
self.register_raft_base_tick();
}
}
SignificantMsg::StoreUnreachable { store_id } => {
if let Some(peer_id) = util::find_peer(self.region(), store_id).map(|p| p.get_id())
{
if self.fsm.peer.is_leader() {
self.fsm.peer.raft_group.report_unreachable(peer_id);
} else if peer_id == self.fsm.peer.leader_id() {
self.fsm.group_state = GroupState::Chaos;
self.register_raft_base_tick();
}
}
}
SignificantMsg::MergeResult {
target_region_id,
target,
result,
} => {
self.on_merge_result(target_region_id, target, result);
}
SignificantMsg::CatchUpLogs(catch_up_logs) => {
self.on_catch_up_logs_for_merge(catch_up_logs);
}
SignificantMsg::StoreResolved { store_id, group_id } => {
let state = self.ctx.global_replication_state.lock().unwrap();
if state.status().get_mode() != ReplicationMode::DrAutoSync {
return;
}
if state.status().get_dr_auto_sync().get_state() == DrAutoSyncState::Async {
return;
}
drop(state);
self.fsm
.peer
.raft_group
.raft
.assign_commit_groups(&[(store_id, group_id)]);
}
SignificantMsg::CaptureChange {
cmd,
region_epoch,
callback,
} => self.on_capture_change(cmd, region_epoch, callback),
SignificantMsg::LeaderCallback(cb) => {
self.on_leader_callback(cb);
}
}
}
fn report_snapshot_status(&mut self, to_peer_id: u64, status: SnapshotStatus) {
let to_peer = match self.fsm.peer.get_peer_from_cache(to_peer_id) {
Some(peer) => peer,
None => {
// If to_peer is gone, ignore this snapshot status
warn!(
"peer not found, ignore snapshot status";
"region_id" => self.region_id(),
"peer_id" => self.fsm.peer_id(),
"to_peer_id" => to_peer_id,
"status" => ?status,
);
return;
}
};
info!(
"report snapshot status";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"to" => ?to_peer,
"status" => ?status,
);
self.fsm.peer.raft_group.report_snapshot(to_peer_id, status)
}
fn on_leader_callback(&mut self, cb: Callback<EK::Snapshot>) {
let msg = new_read_index_request(
self.region_id(),
self.region().get_region_epoch().clone(),
self.fsm.peer.peer.clone(),
);
self.propose_raft_command(msg, cb);
}
fn on_role_changed(&mut self, ready: &Ready) {
// Update leader lease when the Raft state changes.
if let Some(ss) = ready.ss() {
if StateRole::Leader == ss.raft_state {
self.fsm.missing_ticks = 0;
self.register_split_region_check_tick();
self.fsm.peer.heartbeat_pd(&self.ctx);
self.register_pd_heartbeat_tick();
}
}
}
pub fn collect_ready(&mut self) {
let has_ready = self.fsm.has_ready;
self.fsm.has_ready = false;
if !has_ready || self.fsm.stopped {
return;
}
self.ctx.pending_count += 1;
self.ctx.has_ready = true;
let res = self.fsm.peer.handle_raft_ready_append(self.ctx);
if let Some(r) = res {
self.on_role_changed(&r.0);
if !r.0.entries().is_empty() {
self.register_raft_gc_log_tick();
self.register_split_region_check_tick();
}
self.ctx.ready_res.push(r);
}
}
#[inline]
pub fn handle_raft_ready_apply(&mut self, ready: &mut Ready, invoke_ctx: &InvokeContext) {
self.fsm.early_apply = ready
.committed_entries
.as_ref()
.and_then(|e| e.last())
.map_or(false, |e| {
self.fsm.peer.can_early_apply(e.get_term(), e.get_index())
});
if !self.fsm.early_apply {
return;
}
self.fsm
.peer
.handle_raft_ready_apply(self.ctx, ready, invoke_ctx);
}
pub fn post_raft_ready_append(&mut self, mut ready: Ready, invoke_ctx: InvokeContext) {
let is_merging = self.fsm.peer.pending_merge_state.is_some();
if !self.fsm.early_apply {
self.fsm
.peer
.handle_raft_ready_apply(self.ctx, &mut ready, &invoke_ctx);
}
let res = self
.fsm
.peer
.post_raft_ready_append(self.ctx, &mut ready, invoke_ctx);
self.fsm.peer.handle_raft_ready_advance(ready);
let mut has_snapshot = false;
if let Some(apply_res) = res {
self.on_ready_apply_snapshot(apply_res);
has_snapshot = true;
self.register_raft_base_tick();
}
if self.fsm.peer.leader_unreachable {
self.fsm.group_state = GroupState::Chaos;
self.register_raft_base_tick();
self.fsm.peer.leader_unreachable = false;
}
if is_merging && has_snapshot {
// After applying a snapshot, merge is rollbacked implicitly.
self.on_ready_rollback_merge(0, None);
}
}
#[inline]
fn region_id(&self) -> u64 {
self.fsm.peer.region().get_id()
}
#[inline]
fn region(&self) -> &Region {
self.fsm.peer.region()
}
#[inline]
fn store_id(&self) -> u64 {
self.fsm.peer.peer.get_store_id()
}
#[inline]
fn schedule_tick(&mut self, tick: PeerTicks) {
if self.fsm.tick_registry.contains(tick) {
return;
}
let idx = tick.bits() as usize;
if is_zero_duration(&self.ctx.tick_batch[idx].wait_duration) {
return;
}
trace!(
"schedule tick";
"tick" => ?tick,
"timeout" => ?self.ctx.tick_batch[idx].wait_duration,
"region_id" => self.region_id(),
"peer_id" => self.fsm.peer_id(),
);
self.fsm.tick_registry.insert(tick);
let region_id = self.region_id();
let mb = match self.ctx.router.mailbox(region_id) {
Some(mb) => mb,
None => {
self.fsm.tick_registry.remove(tick);
error!(
"failed to get mailbox";
"region_id" => self.fsm.region_id(),
"peer_id" => self.fsm.peer_id(),
"tick" => ?tick,
);
return;
}
};
let peer_id = self.fsm.peer.peer_id();
let cb = Box::new(move || {
// This can happen only when the peer is about to be destroyed
// or the node is shutting down. So it's OK to not to clean up
// registry.
if let Err(e) = mb.force_send(PeerMsg::Tick(tick)) {
debug!(
"failed to schedule peer tick";
"region_id" => region_id,
"peer_id" => peer_id,
"tick" => ?tick,
"err" => %e,
);
}
});
self.ctx.tick_batch[idx].ticks.push(cb);
}
fn register_raft_base_tick(&mut self) {
// If we register raft base tick failed, the whole raft can't run correctly,
// TODO: shutdown the store?
self.schedule_tick(PeerTicks::RAFT)
}
fn on_raft_base_tick(&mut self) {
if self.fsm.peer.pending_remove {
self.fsm.peer.mut_store().flush_cache_metrics();
return;
}
// When having pending snapshot, if election timeout is met, it can't pass
// the pending conf change check because first index has been updated to
// a value that is larger than last index.
if self.fsm.peer.is_applying_snapshot() || self.fsm.peer.has_pending_snapshot() {
// need to check if snapshot is applied.
self.fsm.has_ready = true;
self.fsm.missing_ticks = 0;
self.register_raft_base_tick();
return;
}
self.fsm.peer.retry_pending_reads(&self.ctx.cfg);
let mut res = None;
if self.ctx.cfg.hibernate_regions {
if self.fsm.group_state == GroupState::Idle {
// missing_ticks should be less than election timeout ticks otherwise
// follower may tick more than an election timeout in chaos state.
// Before stopping tick, `missing_tick` should be `raft_election_timeout_ticks` - 2
// - `raft_heartbeat_ticks` (default 10 - 2 - 2 = 6)
// and the follwer's `election_elapsed` in raft-rs is 1.
// After the group state becomes Chaos, the next tick will call `raft_group.tick`
// `missing_tick` + 1 times(default 7).
// Then the follower's `election_elapsed` will be 1 + `missing_tick` + 1
// (default 1 + 6 + 1 = 8) which is less than the min election timeout.
// The reason is that we don't want let all followers become (pre)candidate if one
// follower may receive a request, then becomes (pre)candidate and sends (pre)vote msg
// to others. As long as the leader can wake up and broadcast hearbeats in one `raft_heartbeat_ticks`