forked from pingcap/tidb-engine-ext
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpeer.rs
7740 lines (7251 loc) · 306 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.
// #[PerformanceCriticalPath]
use std::{
borrow::Cow,
cell::Cell,
cmp,
collections::{
Bound::{Excluded, Unbounded},
VecDeque,
},
iter::Iterator,
mem,
sync::{atomic::Ordering, Arc, Mutex},
time::{Duration, Instant},
u64,
};
use batch_system::{BasicMailbox, Fsm, FsmType};
use collections::{HashMap, HashSet};
use engine_traits::{
Engines, KvEngine, RaftEngine, RaftLogBatch, SstMetaInfo, WriteBatchExt, CF_LOCK, CF_RAFT,
};
use error_code::ErrorCodeExt;
use fail::fail_point;
use futures::channel::mpsc::UnboundedSender;
use itertools::Itertools;
use keys::{self, enc_end_key, enc_start_key};
use kvproto::{
brpb::CheckAdminResponse,
errorpb,
import_sstpb::SwitchMode,
kvrpcpb::DiskFullOpt,
metapb::{self, Region, RegionEpoch},
pdpb::{self, CheckPolicy},
raft_cmdpb::{
AdminCmdType, AdminRequest, CmdType, PutRequest, RaftCmdRequest, RaftCmdResponse, Request,
StatusCmdType, StatusResponse,
},
raft_serverpb::{
ExtraMessage, ExtraMessageType, MergeState, PeerState, RaftMessage, RaftSnapshotData,
RaftTruncatedState, RefreshBuckets, RegionLocalState,
},
replication_modepb::{DrAutoSyncState, ReplicationMode},
};
use parking_lot::RwLockWriteGuard;
use pd_client::BucketMeta;
use protobuf::Message;
use raft::{
self,
eraftpb::{self, ConfChangeType, MessageType},
GetEntriesContext, Progress, ReadState, SnapshotStatus, StateRole, INVALID_INDEX, NO_LIMIT,
};
use smallvec::SmallVec;
use strum::{EnumCount, VariantNames};
use tikv_alloc::trace::TraceEvent;
use tikv_util::{
box_err, debug, defer, error, escape, info, info_or_debug, is_zero_duration,
mpsc::{self, LooseBoundedSender, Receiver},
slow_log,
store::{find_peer, find_peer_by_id, is_learner, region_on_same_stores},
sys::disk::DiskUsage,
time::{monotonic_raw_now, Instant as TiInstant, SlowTimer},
trace, warn,
worker::{ScheduleError, Scheduler},
Either,
};
use tracker::GLOBAL_TRACKERS;
use txn_types::WriteBatchFlags;
use self::memtrace::*;
use super::life::forward_destroy_to_source_peer;
#[cfg(any(test, feature = "testexport"))]
use crate::store::PeerInternalStat;
use crate::{
coprocessor::{RegionChangeEvent, RegionChangeReason},
store::{
cmd_resp::{bind_term, new_error},
demote_failed_voters_request,
entry_storage::MAX_WARMED_UP_CACHE_KEEP_TIME,
fsm::{
apply,
store::{PollContext, StoreMeta},
ApplyMetrics, ApplyTask, ApplyTaskRes, CatchUpLogs, ChangeObserver, ChangePeer,
ExecResult, SwitchWitness,
},
hibernate_state::{GroupState, HibernateState},
local_metrics::{RaftMetrics, TimeTracker},
memory::*,
metrics::*,
msg::{Callback, CampaignType, ExtCallback, InspectedRaftMessage},
peer::{
ConsistencyState, Peer, PersistSnapshotResult, StaleState,
TRANSFER_LEADER_COMMAND_REPLY_CTX,
},
region_meta::RegionMeta,
snapshot_backup::{AbortReason, SnapshotBrState, SnapshotBrWaitApplyRequest},
transport::Transport,
unsafe_recovery::{
exit_joint_request, ForceLeaderState, UnsafeRecoveryExecutePlanSyncer,
UnsafeRecoveryFillOutReportSyncer, UnsafeRecoveryForceLeaderSyncer,
UnsafeRecoveryState, UnsafeRecoveryWaitApplySyncer,
},
util::{self, compare_region_epoch, KeysInfoFormatter, LeaseState},
worker::{
Bucket, BucketRange, CleanupTask, ConsistencyCheckTask, GcSnapshotTask, RaftlogGcTask,
ReadDelegate, ReadProgress, RegionTask, SplitCheckTask,
},
CasualMessage, Config, LocksStatus, MergeResultKind, PdTask, PeerMsg, PeerTick,
ProposalContext, RaftCmdExtraOpts, RaftCommand, RaftlogFetchResult, ReadCallback,
ReadIndexContext, ReadTask, SignificantMsg, SnapKey, StoreMsg, WriteCallback,
RAFT_INIT_LOG_INDEX,
},
Error, Result,
};
#[derive(Clone, Copy, Debug)]
pub struct DelayDestroy {
merged_by_target: bool,
reason: DelayReason,
}
#[derive(Clone, Copy, Debug, PartialEq)]
enum DelayReason {
UnPersistedReady,
UnFlushLogGc,
Shutdown,
}
/// Limits the maximum number of regions returned by error.
///
/// Another choice is using coprocessor batch limit, but 10 should be a good fit
/// in most case.
const MAX_REGIONS_IN_ERROR: usize = 10;
const REGION_SPLIT_SKIP_MAX_COUNT: usize = 3;
/// Limits the request size that can be batched in a single RaftCmdRequest.
// todo: this fugure maybe changed to a more suitable value.
#[allow(clippy::identity_op)]
const MAX_BATCH_SIZE_LIMIT: u64 = 1 * 1024 * 1024;
const UNSAFE_RECOVERY_STATE_TIMEOUT: Duration = Duration::from_secs(60);
pub const MAX_PROPOSAL_SIZE_RATIO: f64 = 0.4;
pub struct DestroyPeerJob {
pub initialized: bool,
pub region_id: u64,
pub peer: metapb::Peer,
}
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: [bool; PeerTick::VARIANT_COUNT],
/// 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,
hibernate_state: HibernateState,
stopped: bool,
has_ready: 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,
reactivate_memory_lock_ticks: usize,
/// Batch raft command which has the same header into an entry
batch_req_builder: BatchRaftCmdRequestBuilder<EK>,
trace: PeerMemoryTrace,
/// Destroy is delayed because of some unpersisted readies in Peer.
/// Should call `destroy_peer` again after persisting all readies.
delayed_destroy: Option<DelayDestroy>,
/// Before actually destroying a peer, ensure all log gc tasks are finished,
/// so we can start destroying without seeking.
logs_gc_flushed: bool,
}
pub struct BatchRaftCmdRequestBuilder<E>
where
E: KvEngine,
{
batch_req_size: u64,
has_proposed_cb: bool,
propose_checked: Option<bool>,
request: Option<RaftCmdRequest>,
callbacks: Vec<Callback<E::Snapshot>>,
// Ref: https://github.com/tikv/tikv/issues/16818.
// Check for duplicate key entries batching proposed commands.
// TODO: remove this field when the cause of issue 16818 is located.
lock_cf_keys: HashSet<Vec<u8>>,
}
impl<EK, ER> Drop for PeerFsm<EK, ER>
where
EK: KvEngine,
ER: RaftEngine,
{
fn drop(&mut self) {
self.peer.stop();
let mut raft_messages_size = 0;
while let Ok(msg) = self.receiver.try_recv() {
let callback = match msg {
PeerMsg::RaftCommand(cmd) => cmd.callback,
PeerMsg::CasualMessage(box CasualMessage::SplitRegion { callback, .. }) => callback,
PeerMsg::RaftMessage(im, _) => {
raft_messages_size += im.heap_size;
continue;
}
_ => 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);
}
(match self.hibernate_state.group_state() {
GroupState::Idle | GroupState::PreChaos => &HIBERNATED_PEER_STATE_GAUGE.hibernated,
_ => &HIBERNATED_PEER_STATE_GAUGE.awaken,
})
.dec();
MEMTRACE_RAFT_MESSAGES.trace(TraceEvent::Sub(raft_messages_size));
MEMTRACE_RAFT_ENTRIES.trace(TraceEvent::Sub(self.peer.memtrace_raft_entries));
let mut event = TraceEvent::default();
if let Some(e) = self.trace.reset(PeerMemoryTrace::default()) {
event = event + e;
}
MEMTRACE_PEERS.trace(event);
}
}
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,
region_scheduler: Scheduler<RegionTask>,
raftlog_fetch_scheduler: Scheduler<ReadTask<EK>>,
engines: Engines<EK, ER>,
region: &metapb::Region,
wait_data: bool,
) -> Result<SenderFsmPair<EK, ER>> {
let meta_peer = match 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(),
);
HIBERNATED_PEER_STATE_GAUGE.awaken.inc();
let (tx, rx) = mpsc::loose_bounded(cfg.notify_capacity);
Ok((
tx,
Box::new(PeerFsm {
peer: Peer::new(
store_id,
cfg,
region_scheduler,
raftlog_fetch_scheduler,
engines,
region,
meta_peer,
wait_data,
None,
)?,
tick_registry: [false; PeerTick::VARIANT_COUNT],
missing_ticks: 0,
hibernate_state: HibernateState::ordered(),
stopped: false,
has_ready: false,
mailbox: None,
receiver: rx,
skip_split_count: 0,
skip_gc_raft_log_ticks: 0,
reactivate_memory_lock_ticks: 0,
batch_req_builder: BatchRaftCmdRequestBuilder::new(),
trace: PeerMemoryTrace::default(),
delayed_destroy: None,
logs_gc_flushed: false,
}),
))
}
// 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,
region_scheduler: Scheduler<RegionTask>,
raftlog_fetch_scheduler: Scheduler<ReadTask<EK>>,
engines: Engines<EK, ER>,
region_id: u64,
peer: metapb::Peer,
create_by_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(),
"store_id" => store_id,
"create_by_peer_id" => create_by_peer.get_id(),
"create_by_peer_store_id" => create_by_peer.get_store_id(),
);
let mut region = metapb::Region::default();
region.set_id(region_id);
HIBERNATED_PEER_STATE_GAUGE.awaken.inc();
let (tx, rx) = mpsc::loose_bounded(cfg.notify_capacity);
Ok((
tx,
Box::new(PeerFsm {
peer: Peer::new(
store_id,
cfg,
region_scheduler,
raftlog_fetch_scheduler,
engines,
®ion,
peer,
false,
Some(create_by_peer),
)?,
tick_registry: [false; PeerTick::VARIANT_COUNT],
missing_ticks: 0,
hibernate_state: HibernateState::ordered(),
stopped: false,
has_ready: false,
mailbox: None,
receiver: rx,
skip_split_count: 0,
skip_gc_raft_log_ticks: 0,
reactivate_memory_lock_ticks: 0,
batch_req_builder: BatchRaftCmdRequestBuilder::new(),
trace: PeerMemoryTrace::default(),
delayed_destroy: None,
logs_gc_flushed: false,
}),
))
}
#[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();
}
pub fn reset_hibernate_state(&mut self, state: GroupState) {
self.hibernate_state.reset(state);
if state == GroupState::Idle {
self.peer.raft_group.raft.maybe_free_inflight_buffers();
}
}
pub fn maybe_hibernate(&mut self) -> bool {
self.hibernate_state
.maybe_hibernate(self.peer.peer_id(), self.peer.region())
}
pub fn update_memory_trace(&mut self, event: &mut TraceEvent) {
let task = PeerMemoryTrace {
read_only: self.raft_read_size(),
progress: self.raft_progress_size(),
proposals: self.peer.proposal_size(),
rest: self.peer.rest_size(),
};
if let Some(e) = self.trace.reset(task) {
*event = *event + e;
}
}
}
impl<E> BatchRaftCmdRequestBuilder<E>
where
E: KvEngine,
{
fn new() -> BatchRaftCmdRequestBuilder<E> {
BatchRaftCmdRequestBuilder {
batch_req_size: 0,
has_proposed_cb: false,
propose_checked: None,
request: None,
callbacks: vec![],
lock_cf_keys: HashSet::default(),
}
}
fn can_batch(&self, cfg: &Config, 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
// Also, to prevent the write batch size from becoming too large when
// raft_entry_max_size is set too high (all requests in a RaftCmdRequest will be
// written in one RocksDB write batch), we use MAX_APPLY_BATCH_SIZE to
// limit the number of requests batched within a single RaftCmdRequest.
if req.get_requests().is_empty()
|| req_size as u64 > (cfg.raft_entry_max_size.0 as f64 * 0.2) as u64
|| (self.batch_req_size + req_size as u64) > MAX_BATCH_SIZE_LIMIT
{
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 RaftCommand {
mut request,
mut callback,
..
} = cmd;
// Ref: https://github.com/tikv/tikv/issues/16818.
// Check for duplicate key entries batching proposed commands.
// TODO: remove this check when the cause of issue 16818 is located.
for req in request.get_requests() {
if req.has_put() && req.get_put().get_cf() == CF_LOCK {
let key = req.get_put().get_key();
if !self.lock_cf_keys.insert(key.to_vec()) {
panic!(
"found duplicate key in Lock CF PUT request between batched requests. \
key: {:?}, existing batch request: {:?}, new request to add: {:?}",
key, self.request, request
);
}
}
}
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);
};
if callback.has_proposed_cb() {
self.has_proposed_cb = true;
if self.propose_checked.unwrap_or(false) {
callback.invoke_proposed();
}
}
self.callbacks.push(callback);
self.batch_req_size += req_size as u64;
}
fn should_finish(&self, cfg: &Config) -> 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 self.batch_req_size
> (cfg.raft_entry_max_size.0 as f64 * MAX_PROPOSAL_SIZE_RATIO) as u64
{
return true;
}
if batch_req.get_requests().len() > <E as WriteBatchExt>::WRITE_BATCH_MAX_KEYS {
return true;
}
}
false
}
fn build(
&mut self,
metric: &mut RaftMetrics,
) -> Option<(RaftCmdRequest, Callback<E::Snapshot>)> {
if let Some(req) = self.request.take() {
self.batch_req_size = 0;
self.has_proposed_cb = false;
self.propose_checked = None;
self.lock_cf_keys = HashSet::default();
if self.callbacks.len() == 1 {
let cb = self.callbacks.pop().unwrap();
return Some((req, cb));
}
metric.propose.batch.inc_by(self.callbacks.len() as u64 - 1);
let mut cbs = std::mem::take(&mut self.callbacks);
let proposed_cbs: Vec<ExtCallback> = cbs
.iter_mut()
.filter_map(|cb| cb.take_proposed_cb())
.collect();
let proposed_cb: Option<ExtCallback> = if proposed_cbs.is_empty() {
None
} else {
Some(Box::new(move || {
for proposed_cb in proposed_cbs {
proposed_cb();
}
}))
};
let committed_cbs: Vec<_> = cbs
.iter_mut()
.filter_map(|cb| cb.take_committed_cb())
.collect();
let committed_cb: Option<ExtCallback> = if committed_cbs.is_empty() {
None
} else {
Some(Box::new(move || {
for committed_cb in committed_cbs {
committed_cb();
}
}))
};
let trackers: SmallVec<[TimeTracker; 4]> = cbs
.iter_mut()
.flat_map(|cb| cb.write_trackers())
.cloned()
.collect();
let cb = Callback::Write {
cb: Box::new(move |resp| {
for cb in cbs {
let mut cmd_resp = RaftCmdResponse::default();
cmd_resp.set_header(resp.response.get_header().clone());
cb.invoke_with_response(cmd_resp);
}
}),
proposed_cb,
committed_cb,
trackers,
};
return Some((req, cb));
}
None
}
}
impl<EK, ER> Fsm for PeerFsm<EK, ER>
where
EK: KvEngine,
ER: RaftEngine,
{
type Message = PeerMsg<EK>;
const FSM_TYPE: FsmType = FsmType::store;
#[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>
where
EK: KvEngine,
ER: RaftEngine,
{
fsm: &'a mut PeerFsm<EK, ER>,
ctx: &'a mut PollContext<EK, ER, T>,
}
impl<'a, EK, ER, T: Transport> PeerFsmDelegate<'a, EK, ER, T>
where
EK: KvEngine,
ER: RaftEngine,
{
pub fn new(
fsm: &'a mut PeerFsm<EK, ER>,
ctx: &'a mut PollContext<EK, ER, T>,
) -> PeerFsmDelegate<'a, EK, ER, T> {
PeerFsmDelegate { fsm, ctx }
}
pub fn handle_msgs(&mut self, msgs: &mut Vec<PeerMsg<EK>>) {
let timer = SlowTimer::from_millis(100);
let count = msgs.len();
#[allow(const_evaluatable_unchecked)]
let mut distribution = [0; PeerMsg::<EK>::COUNT];
// As the detail of one msg is not very useful when handling multiple messages,
// only format the msg detail in slow log when there is only one message.
let detail = if msgs.len() == 1 {
msgs.first().map(|m| format!("{:?}", m))
} else {
None
};
for m in msgs.drain(..) {
// skip handling remain messages if fsm is destroyed. This can aviod handling
// arbitary messages(e.g. CasualMessage::ForceCompactRaftLogs) that may need
// to read raft logs which maybe lead to panic.
// We do not skip RaftCommand because raft commond callback should always be
// handled or it will cause panic.
if self.fsm.stopped && !matches!(&m, PeerMsg::RaftCommand(_)) {
continue;
}
distribution[m.discriminant()] += 1;
match m {
PeerMsg::RaftMessage(msg, sent_time) => {
if let Some(sent_time) = sent_time {
let wait_time = sent_time.saturating_elapsed().as_secs_f64();
self.ctx.raft_metrics.process_wait_time.observe(wait_time);
}
if !self.ctx.coprocessor_host.on_raft_message(&msg.msg) {
continue;
}
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) => {
let propose_time = cmd.send_time.saturating_elapsed();
self.ctx
.raft_metrics
.propose_wait_time
.observe(propose_time.as_secs_f64());
cmd.callback.read_tracker().map(|tracker| {
GLOBAL_TRACKERS.with_tracker(tracker, |t| {
t.metrics.read_index_propose_wait_nanos =
propose_time.as_nanos() as u64;
})
});
if let Some(Err(e)) = cmd.extra_opts.deadline.map(|deadline| deadline.check()) {
cmd.callback.invoke_with_response(new_error(e.into()));
continue;
}
// Ref: https://github.com/tikv/tikv/issues/16818.
// Check for duplicate key entries within the to be proposed raft cmd.
// TODO: remove this check when the cause of issue 16818 is located.
let mut keys_set = std::collections::HashSet::new();
for req in cmd.request.get_requests() {
if req.has_put() && req.get_put().get_cf() == CF_LOCK {
let key = req.get_put().get_key();
if !keys_set.insert(key.to_vec()) {
panic!(
"found duplicate key in Lock CF PUT request, key: {:?}, cmd: {:?}",
key, cmd
);
}
}
}
let req_size = cmd.request.compute_size();
if self.ctx.cfg.cmd_batch
&& self.fsm.batch_req_builder.can_batch(&self.ctx.cfg, &cmd.request, req_size)
// Avoid to merge requests with different `DiskFullOpt`s into one,
// so that normal writes can be rejected when proposing if the
// store's disk is full.
&& ((self.ctx.self_disk_usage == DiskUsage::Normal
&& !self.fsm.peer.disk_full_peers.majority())
|| cmd.extra_opts.disk_full_opt == DiskFullOpt::NotAllowedOnFull)
{
self.fsm.batch_req_builder.add(*cmd, req_size);
if self.fsm.batch_req_builder.should_finish(&self.ctx.cfg) {
self.propose_pending_batch_raft_command();
}
} else {
self.propose_raft_command(
cmd.request,
cmd.callback,
cmd.extra_opts.disk_full_opt,
);
}
}
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::Persisted {
peer_id,
ready_number,
} => self.on_persisted_msg(peer_id, ready_number),
PeerMsg::UpdateReplicationMode => self.on_update_replication_mode(),
PeerMsg::Destroy(peer_id) => {
if self.fsm.peer.peer_id() == peer_id {
self.maybe_destroy();
}
}
}
}
self.on_loop_finished();
slow_log!(
T timer,
"{} handle {} peer messages {:?}, detail: {:?}",
self.fsm.peer.tag,
count,
PeerMsg::<EK>::VARIANTS.iter().zip(distribution).filter(|(_, c)| *c > 0).format(", "),
detail,
);
self.ctx.raft_metrics.peer_msg_len.observe(count as f64);
self.ctx
.raft_metrics
.event_time
.peer_msg
.observe(timer.saturating_elapsed().as_secs_f64());
}
#[inline]
fn on_loop_finished(&mut self) {
let ready_concurrency = self.ctx.cfg.cmd_batch_concurrent_ready_max_count;
// Allow to propose pending commands iff all ongoing commands are persisted or
// committed. this is trying to batch proposes as many as possible to
// minimize the cpu overhead.
let should_propose = self.ctx.sync_write_worker.is_some()
|| ready_concurrency == 0
|| self.fsm.peer.unpersisted_ready_len() < ready_concurrency
// Allow to propose if all ongoing proposals are committed to avoiding io jitter block
// new commands.
|| !self.fsm.peer.has_uncommitted_log();
let force_delay_fp = || {
fail_point!(
"force_delay_propose_batch_raft_command",
self.ctx.sync_write_worker.is_none(),
|_| true
);
false
};
// Propose batch request which may be still waiting for more raft-command
if should_propose && !force_delay_fp() {
self.propose_pending_batch_raft_command();
} else {
if self.fsm.batch_req_builder.has_proposed_cb
&& self.fsm.batch_req_builder.propose_checked.is_none()
&& let Some(cmd) = self.fsm.batch_req_builder.request.take()
{
// We are delaying these requests to next loop. Try to fulfill their
// proposed callback early.
self.fsm.batch_req_builder.propose_checked = Some(false);
if let Ok(None) = self.pre_propose_raft_command(&cmd) {
if self.fsm.peer.will_likely_propose(&cmd) {
self.fsm.batch_req_builder.propose_checked = Some(true);
for cb in &mut self.fsm.batch_req_builder.callbacks {
cb.invoke_proposed();
}
}
}
self.fsm.batch_req_builder.request = Some(cmd);
}
if self.fsm.batch_req_builder.request.is_some() {
self.ctx.raft_metrics.ready.propose_delay.inc();
}
}
}
/// Flushes all pending raft commands for immediate execution.
#[inline]
fn propose_pending_batch_raft_command(&mut self) {
if self.fsm.batch_req_builder.request.is_none() {
return;
}
let (request, callback) = self
.fsm
.batch_req_builder
.build(&mut self.ctx.raft_metrics)
.unwrap();
self.propose_raft_command_internal(request, callback, DiskFullOpt::NotAllowedOnFull);
}
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_unsafe_recovery_pre_demote_failed_voters(
&mut self,
syncer: UnsafeRecoveryExecutePlanSyncer,
failed_voters: Vec<metapb::Peer>,
) {
if let Some(state) = &self.fsm.peer.unsafe_recovery_state
&& !state.is_abort()
{
warn!(
"Unsafe recovery, demote failed voters has already been initiated";
"region_id" => self.region().get_id(),
"peer_id" => self.fsm.peer.peer.get_id(),
"state" => ?state,
);
syncer.abort();
return;
}
if !self.fsm.peer.is_in_force_leader() {
error!(
"Unsafe recovery, demoting failed voters failed, since this peer is not forced leader";
"region_id" => self.region().get_id(),
"peer_id" => self.fsm.peer.peer.get_id(),
);
return;
}
if self.fsm.peer.in_joint_state() {
info!(
"Unsafe recovery, already in joint state, exit first";
"region_id" => self.region().get_id(),
"peer_id" => self.fsm.peer.peer.get_id(),
);
let failed = Arc::new(Mutex::new(false));
let failed_clone = failed.clone();
let callback = Callback::<EK::Snapshot>::write(Box::new(move |resp| {
if resp.response.get_header().has_error() {
*failed_clone.lock().unwrap() = true;
error!(
"Unsafe recovery, fail to exit residual joint state";
"err" => ?resp.response.get_header().get_error(),
);
}
}));
self.propose_raft_command_internal(
exit_joint_request(self.region(), &self.fsm.peer.peer),
callback,
DiskFullOpt::AllowedOnAlmostFull,
);
if !*failed.lock().unwrap() {
self.fsm.peer.unsafe_recovery_state =
Some(UnsafeRecoveryState::DemoteFailedVoters {
syncer,
failed_voters,
target_index: self.fsm.peer.raft_group.raft.raft_log.last_index(),
demote_after_exit: true,
});
} else {
self.fsm.peer.unsafe_recovery_state = Some(UnsafeRecoveryState::Failed);
}
} else {
self.unsafe_recovery_demote_failed_voters(syncer, failed_voters);
}
}
fn unsafe_recovery_demote_failed_voters(
&mut self,
syncer: UnsafeRecoveryExecutePlanSyncer,
failed_voters: Vec<metapb::Peer>,
) {
if let Some(req) =
demote_failed_voters_request(self.region(), &self.fsm.peer.peer, failed_voters)
{
info!(
"Unsafe recovery, demoting failed voters";
"region_id" => self.region().get_id(),
"peer_id" => self.fsm.peer.peer.get_id(),
"req" => ?req);
let failed = Arc::new(Mutex::new(false));
let failed_clone = failed.clone();
let callback = Callback::<EK::Snapshot>::write(Box::new(move |resp| {
if resp.response.get_header().has_error() {
*failed_clone.lock().unwrap() = true;
error!(
"Unsafe recovery, fail to finish demotion";
"err" => ?resp.response.get_header().get_error(),
);
}
}));
self.propose_raft_command_internal(req, callback, DiskFullOpt::AllowedOnAlmostFull);
if !*failed.lock().unwrap() {
self.fsm.peer.unsafe_recovery_state =
Some(UnsafeRecoveryState::DemoteFailedVoters {
syncer,
failed_voters: vec![], // No longer needed since here.
target_index: self.fsm.peer.raft_group.raft.raft_log.last_index(),
demote_after_exit: false,
});
} else {
self.fsm.peer.unsafe_recovery_state = Some(UnsafeRecoveryState::Failed);
}
} else {
warn!(
"Unsafe recovery, no need to demote failed voters";
"region_id" => self.region().get_id(),
"peer_id" => self.fsm.peer_id(),
"region" => ?self.region(),
);
}
}
fn on_unsafe_recovery_destroy(&mut self, syncer: UnsafeRecoveryExecutePlanSyncer) {
if let Some(state) = &self.fsm.peer.unsafe_recovery_state
&& !state.is_abort()
{
warn!(
"Unsafe recovery, can't destroy, another plan is executing in progress";
"region_id" => self.region_id(),
"peer_id" => self.fsm.peer_id(),
"state" => ?state,
);
syncer.abort();
return;
}
self.fsm.peer.unsafe_recovery_state = Some(UnsafeRecoveryState::Destroy(syncer));
self.handle_destroy_peer(DestroyPeerJob {
initialized: self.fsm.peer.is_initialized(),
region_id: self.region_id(),
peer: self.fsm.peer.peer.clone(),
});
}