-
Notifications
You must be signed in to change notification settings - Fork 392
/
raw_node.rs
830 lines (733 loc) · 27.6 KB
/
raw_node.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
// Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0.
// Copyright 2015 The etcd Authors
//
// 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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! The raw node of the raft module.
//!
//! This module contains the value types for the node and it's connection to other
//! nodes but not the raft consensus itself. Generally, you'll interact with the
//! RawNode first and use it to access the inner workings of the consensus protocol.
use std::{collections::VecDeque, mem};
use protobuf::Message as PbMessage;
use raft_proto::ConfChangeI;
use slog::Logger;
use crate::eraftpb::{ConfState, Entry, EntryType, HardState, Message, MessageType, Snapshot};
use crate::errors::{Error, Result};
use crate::read_only::ReadState;
use crate::{config::Config, StateRole};
use crate::{storage::GetEntriesFor, GetEntriesContext, Raft, SoftState, Status, Storage};
use slog::info;
/// Represents a Peer node in the cluster.
#[derive(Debug, Default)]
pub struct Peer {
/// The ID of the peer.
pub id: u64,
/// If there is context associated with the peer (like connection information), it can be
/// serialized and stored here.
pub context: Option<Vec<u8>>,
}
/// The status of the snapshot.
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum SnapshotStatus {
/// Represents that the snapshot is finished being created.
Finish,
/// Indicates that the snapshot failed to build or is not ready.
Failure,
}
/// Checks if certain message type should be used internally.
pub fn is_local_msg(t: MessageType) -> bool {
matches!(
t,
MessageType::MsgHup
| MessageType::MsgBeat
| MessageType::MsgUnreachable
| MessageType::MsgSnapStatus
| MessageType::MsgCheckQuorum
)
}
fn is_response_msg(t: MessageType) -> bool {
matches!(
t,
MessageType::MsgAppendResponse
| MessageType::MsgRequestVoteResponse
| MessageType::MsgHeartbeatResponse
| MessageType::MsgUnreachable
| MessageType::MsgRequestPreVoteResponse
)
}
/// For a given snapshot, determine if it's empty or not.
#[deprecated(since = "0.6.0", note = "Please use `Snapshot::is_empty` instead")]
pub fn is_empty_snap(s: &Snapshot) -> bool {
s.is_empty()
}
/// Ready encapsulates the entries and messages that are ready to read,
/// be saved to stable storage, committed or sent to other peers.
#[derive(Default, Debug, PartialEq)]
pub struct Ready {
number: u64,
ss: Option<SoftState>,
hs: Option<HardState>,
read_states: Vec<ReadState>,
entries: Vec<Entry>,
snapshot: Snapshot,
is_persisted_msg: bool,
light: LightReady,
must_sync: bool,
}
impl Ready {
/// The number of current Ready.
/// It is used for identifying the different Ready and ReadyRecord.
#[inline]
pub fn number(&self) -> u64 {
self.number
}
/// The current volatile state of a Node.
/// SoftState will be None if there is no update.
/// It is not required to consume or store SoftState.
#[inline]
pub fn ss(&self) -> Option<&SoftState> {
self.ss.as_ref()
}
/// The current state of a Node to be saved to stable storage.
/// HardState will be None state if there is no update.
#[inline]
pub fn hs(&self) -> Option<&HardState> {
self.hs.as_ref()
}
/// ReadStates specifies the state for read only query.
#[inline]
pub fn read_states(&self) -> &Vec<ReadState> {
&self.read_states
}
/// Take the ReadStates.
#[inline]
pub fn take_read_states(&mut self) -> Vec<ReadState> {
mem::take(&mut self.read_states)
}
/// Entries specifies entries to be saved to stable storage.
#[inline]
pub fn entries(&self) -> &Vec<Entry> {
&self.entries
}
/// Take the Entries.
#[inline]
pub fn take_entries(&mut self) -> Vec<Entry> {
mem::take(&mut self.entries)
}
/// Snapshot specifies the snapshot to be saved to stable storage.
#[inline]
pub fn snapshot(&self) -> &Snapshot {
&self.snapshot
}
/// CommittedEntries specifies entries to be committed to a
/// store/state-machine. These have previously been committed to stable
/// store.
#[inline]
pub fn committed_entries(&self) -> &Vec<Entry> {
self.light.committed_entries()
}
/// Take the CommitEntries.
#[inline]
pub fn take_committed_entries(&mut self) -> Vec<Entry> {
self.light.take_committed_entries()
}
/// Messages specifies outbound messages to be sent.
/// If it contains a MsgSnap message, the application MUST report back to raft
/// when the snapshot has been received or has failed by calling ReportSnapshot.
#[inline]
pub fn messages(&self) -> &[Message] {
if !self.is_persisted_msg {
self.light.messages()
} else {
&[]
}
}
/// Take the Messages.
#[inline]
pub fn take_messages(&mut self) -> Vec<Message> {
if !self.is_persisted_msg {
self.light.take_messages()
} else {
Vec::new()
}
}
/// Persisted Messages specifies outbound messages to be sent AFTER the HardState,
/// Entries and Snapshot are persisted to stable storage.
#[inline]
pub fn persisted_messages(&self) -> &[Message] {
if self.is_persisted_msg {
self.light.messages()
} else {
&[]
}
}
/// Take the Persisted Messages.
#[inline]
pub fn take_persisted_messages(&mut self) -> Vec<Message> {
if self.is_persisted_msg {
self.light.take_messages()
} else {
Vec::new()
}
}
/// MustSync is false if and only if
/// 1. no HardState or only its commit is different from before
/// 2. no Entries and Snapshot
/// If it's false, an asynchronous write of HardState is permissible before calling
/// [`RawNode::on_persist_ready`] or [`RawNode::advance`] or its families.
#[inline]
pub fn must_sync(&self) -> bool {
self.must_sync
}
}
/// ReadyRecord encapsulates some needed data from the corresponding Ready.
#[derive(Default, Debug, PartialEq)]
struct ReadyRecord {
number: u64,
// (index, term) of the last entry from the entries in Ready
last_entry: Option<(u64, u64)>,
// (index, term) of the snapshot in Ready
snapshot: Option<(u64, u64)>,
}
/// LightReady encapsulates the commit index, committed entries and
/// messages that are ready to be applied or be sent to other peers.
#[derive(Default, Debug, PartialEq)]
pub struct LightReady {
commit_index: Option<u64>,
committed_entries: Vec<Entry>,
messages: Vec<Message>,
}
impl LightReady {
/// The current commit index.
/// It will be None state if there is no update.
/// It is not required to save it to stable storage.
#[inline]
pub fn commit_index(&self) -> Option<u64> {
self.commit_index
}
/// CommittedEntries specifies entries to be committed to a
/// store/state-machine. These have previously been committed to stable
/// store.
#[inline]
pub fn committed_entries(&self) -> &Vec<Entry> {
&self.committed_entries
}
/// Take the CommittedEntries.
#[inline]
pub fn take_committed_entries(&mut self) -> Vec<Entry> {
mem::take(&mut self.committed_entries)
}
/// Messages specifies outbound messages to be sent.
#[inline]
pub fn messages(&self) -> &[Message] {
&self.messages
}
/// Take the Messages.
#[inline]
pub fn take_messages(&mut self) -> Vec<Message> {
mem::take(&mut self.messages)
}
}
/// RawNode is a thread-unsafe Node.
/// The methods of this struct correspond to the methods of Node and are described
/// more fully there.
pub struct RawNode<T: Storage> {
/// The internal raft state.
pub raft: Raft<T>,
prev_ss: SoftState,
prev_hs: HardState,
// Current max number of Record and ReadyRecord.
max_number: u64,
records: VecDeque<ReadyRecord>,
// Index which the given committed entries should start from.
commit_since_index: u64,
}
impl<T: Storage> RawNode<T> {
#[allow(clippy::new_ret_no_self)]
/// Create a new RawNode given some [`Config`].
pub fn new(config: &Config, store: T, logger: &Logger) -> Result<Self> {
assert_ne!(config.id, 0, "config.id must not be zero");
let r = Raft::new(config, store, logger)?;
let mut rn = RawNode {
raft: r,
prev_hs: Default::default(),
prev_ss: Default::default(),
max_number: 0,
records: VecDeque::new(),
commit_since_index: config.applied,
};
rn.prev_hs = rn.raft.hard_state();
rn.prev_ss = rn.raft.soft_state();
info!(
rn.raft.logger,
"RawNode created with id {id}.",
id = rn.raft.id
);
Ok(rn)
}
/// Create a new RawNode given some [`Config`] and the default logger.
///
/// The default logger is an `slog` to `log` adapter.
#[cfg(feature = "default-logger")]
#[allow(clippy::new_ret_no_self)]
pub fn with_default_logger(c: &Config, store: T) -> Result<Self> {
Self::new(c, store, &crate::default_logger())
}
/// Sets priority of node.
#[inline]
pub fn set_priority(&mut self, priority: i64) {
self.raft.set_priority(priority);
}
/// Tick advances the internal logical clock by a single tick.
///
/// Returns true to indicate that there will probably be some readiness which
/// needs to be handled.
pub fn tick(&mut self) -> bool {
self.raft.tick()
}
/// Campaign causes this RawNode to transition to candidate state.
pub fn campaign(&mut self) -> Result<()> {
let mut m = Message::default();
m.set_msg_type(MessageType::MsgHup);
self.raft.step(m)
}
/// Propose proposes data to be appended to the raft log.
pub fn propose(&mut self, context: Vec<u8>, data: Vec<u8>) -> Result<()> {
let mut m = Message::default();
m.set_msg_type(MessageType::MsgPropose);
m.from = self.raft.id;
let mut e = Entry::default();
e.data = data.into();
e.context = context.into();
m.set_entries(vec![e].into());
self.raft.step(m)
}
/// Broadcast heartbeats to all the followers.
///
/// If it's not leader, nothing will happen.
pub fn ping(&mut self) {
self.raft.ping()
}
/// ProposeConfChange proposes a config change.
///
/// If the node enters joint state with `auto_leave` set to true, it's
/// caller's responsibility to propose an empty conf change again to force
/// leaving joint state.
pub fn propose_conf_change(&mut self, context: Vec<u8>, cc: impl ConfChangeI) -> Result<()> {
let (data, ty) = if let Some(cc) = cc.as_v1() {
(cc.write_to_bytes()?, EntryType::EntryConfChange)
} else {
(cc.as_v2().write_to_bytes()?, EntryType::EntryConfChangeV2)
};
let mut m = Message::default();
m.set_msg_type(MessageType::MsgPropose);
let mut e = Entry::default();
e.set_entry_type(ty);
e.data = data.into();
e.context = context.into();
m.set_entries(vec![e].into());
self.raft.step(m)
}
/// Applies a config change to the local node. The app must call this when it
/// applies a configuration change, except when it decides to reject the
/// configuration change, in which case no call must take place.
pub fn apply_conf_change(&mut self, cc: &impl ConfChangeI) -> Result<ConfState> {
self.raft.apply_conf_change(&cc.as_v2())
}
/// Step advances the state machine using the given message.
pub fn step(&mut self, m: Message) -> Result<()> {
// Ignore unexpected local messages receiving over network
if is_local_msg(m.get_msg_type()) {
return Err(Error::StepLocalMsg);
}
if self.raft.prs().get(m.from).is_some() || !is_response_msg(m.get_msg_type()) {
return self.raft.step(m);
}
Err(Error::StepPeerNotFound)
}
/// A callback when entries are fetched asynchronously.
/// The context should provide the context passed from Storage.entries().
/// See more in the comment of Storage.entries().
///
/// # Panics
///
/// Panics if passed with the context of context.can_async() == false
pub fn on_entries_fetched(&mut self, context: GetEntriesContext) {
match context.0 {
GetEntriesFor::SendAppend {
to,
term,
aggressively,
} => {
if self.raft.term != term || self.raft.state != StateRole::Leader {
// term or leadership has changed
return;
}
if self.raft.prs().get(to).is_none() {
// the peer has been removed, do nothing
return;
}
if aggressively {
self.raft.send_append_aggressively(to)
} else {
self.raft.send_append(to)
}
}
GetEntriesFor::Empty(can_async) if can_async => {}
_ => panic!("shouldn't call callback on non-async context"),
}
}
/// Generates a LightReady that has the committed entries and messages but no commit index.
fn gen_light_ready(&mut self) -> LightReady {
let mut rd = LightReady::default();
let max_size = Some(self.raft.max_committed_size_per_ready);
let raft = &mut self.raft;
rd.committed_entries = raft
.raft_log
.next_entries_since(self.commit_since_index, max_size)
.unwrap_or_default();
// Update raft uncommitted entries size
raft.reduce_uncommitted_size(&rd.committed_entries);
if let Some(e) = rd.committed_entries.last() {
assert!(self.commit_since_index < e.get_index());
self.commit_since_index = e.get_index();
}
if !raft.msgs.is_empty() {
rd.messages = mem::take(&mut raft.msgs);
}
rd
}
/// Returns the outstanding work that the application needs to handle.
///
/// This includes appending and applying entries or a snapshot, updating the HardState,
/// and sending messages. The returned `Ready` *MUST* be handled and subsequently
/// passed back via `advance` or its families. Before that, *DO NOT* call any function like
/// `step`, `propose`, `campaign` to change internal state.
///
/// [`Self::has_ready`] should be called first to check if it's necessary to handle the ready.
pub fn ready(&mut self) -> Ready {
let raft = &mut self.raft;
self.max_number += 1;
let mut rd = Ready {
number: self.max_number,
..Default::default()
};
let mut rd_record = ReadyRecord {
number: self.max_number,
..Default::default()
};
if self.prev_ss.raft_state != StateRole::Leader && raft.state == StateRole::Leader {
// The vote msg which makes this peer become leader has been sent after persisting.
// So the remaining records must be generated during being candidate which can not
// have last_entry and snapshot(if so, it should become follower).
for record in self.records.drain(..) {
assert_eq!(record.last_entry, None);
assert_eq!(record.snapshot, None);
}
}
let ss = raft.soft_state();
if ss != self.prev_ss {
rd.ss = Some(ss);
}
let hs = raft.hard_state();
if hs != self.prev_hs {
if hs.vote != self.prev_hs.vote || hs.term != self.prev_hs.term {
rd.must_sync = true;
}
rd.hs = Some(hs);
}
if !raft.read_states.is_empty() {
rd.read_states = mem::take(&mut raft.read_states);
}
if let Some(snapshot) = &raft.raft_log.unstable_snapshot() {
rd.snapshot = snapshot.clone();
assert!(self.commit_since_index <= rd.snapshot.get_metadata().index);
self.commit_since_index = rd.snapshot.get_metadata().index;
// If there is a snapshot, the latter entries can not be persisted
// so there is no committed entries.
assert!(
!raft
.raft_log
.has_next_entries_since(self.commit_since_index),
"has snapshot but also has committed entries since {}",
self.commit_since_index
);
rd_record.snapshot = Some((
rd.snapshot.get_metadata().index,
rd.snapshot.get_metadata().term,
));
rd.must_sync = true;
}
rd.entries = raft.raft_log.unstable_entries().to_vec();
if let Some(e) = rd.entries.last() {
// If the last entry exists, the entries must not empty, vice versa.
rd.must_sync = true;
rd_record.last_entry = Some((e.get_index(), e.get_term()));
}
// Leader can send messages immediately to make replication concurrently.
// For more details, check raft thesis 10.2.1.
rd.is_persisted_msg = raft.state != StateRole::Leader;
rd.light = self.gen_light_ready();
self.records.push_back(rd_record);
rd
}
/// HasReady called when RawNode user need to check if any Ready pending.
pub fn has_ready(&self) -> bool {
let raft = &self.raft;
if !raft.msgs.is_empty() {
return true;
}
if raft.soft_state() != self.prev_ss {
return true;
}
if raft.hard_state() != self.prev_hs {
return true;
}
if !raft.read_states.is_empty() {
return true;
}
if !raft.raft_log.unstable_entries().is_empty() {
return true;
}
if self.snap().map_or(false, |s| !s.is_empty()) {
return true;
}
if raft
.raft_log
.has_next_entries_since(self.commit_since_index)
{
return true;
}
false
}
fn commit_ready(&mut self, rd: Ready) {
if let Some(ss) = rd.ss {
self.prev_ss = ss;
}
if let Some(hs) = rd.hs {
self.prev_hs = hs;
}
let rd_record = self.records.back().unwrap();
assert!(rd_record.number == rd.number);
let raft = &mut self.raft;
if let Some((index, _)) = rd_record.snapshot {
raft.raft_log.stable_snap(index);
}
if let Some((index, term)) = rd_record.last_entry {
raft.raft_log.stable_entries(index, term);
}
}
fn commit_apply(&mut self, applied: u64) {
self.raft.commit_apply(applied);
}
/// Notifies that the ready of this number has been persisted.
///
/// Since Ready must be persisted in order, calling this function implicitly means
/// all readies with numbers smaller than this one have been persisted.
///
/// [`Self::has_ready`] and [`Self::ready`] should be called later to handle further
/// updates that become valid after ready being persisted.
pub fn on_persist_ready(&mut self, number: u64) {
let (mut index, mut term) = (0, 0);
let mut snap_index = 0;
while let Some(record) = self.records.front() {
if record.number > number {
break;
}
let record = self.records.pop_front().unwrap();
if let Some((i, _)) = record.snapshot {
snap_index = i;
index = 0;
term = 0;
}
if let Some((i, t)) = record.last_entry {
index = i;
term = t;
}
}
if snap_index != 0 {
self.raft.on_persist_snap(snap_index);
}
if index != 0 {
self.raft.on_persist_entries(index, term);
}
}
/// Advances the ready after fully processing it.
///
/// Fully processing a ready requires to persist snapshot, entries and hard states, apply all
/// committed entries, send all messages.
///
/// Returns the LightReady that contains commit index, committed entries and messages. [`LightReady`]
/// contains updates that are only valid after persisting last ready. It should also be fully processed.
/// Then [`Self::advance_apply`] or [`Self::advance_apply_to`] should be used later to update applying
/// progress.
pub fn advance(&mut self, rd: Ready) -> LightReady {
let applied = self.commit_since_index;
let light_rd = self.advance_append(rd);
self.advance_apply_to(applied);
light_rd
}
/// Advances the ready without applying committed entries. [`Self::advance_apply`] or
/// [`Self::advance_apply_to`] should be used later to update applying progress.
///
/// Returns the LightReady that contains commit index, committed entries and messages.
///
/// Since Ready must be persisted in order, calling this function implicitly means
/// all ready collected before have been persisted.
#[inline]
pub fn advance_append(&mut self, rd: Ready) -> LightReady {
self.commit_ready(rd);
self.on_persist_ready(self.max_number);
let mut light_rd = self.gen_light_ready();
if self.raft.state != StateRole::Leader && !light_rd.messages().is_empty() {
fatal!(self.raft.logger, "not leader but has new msg after advance");
}
// Set commit index if it's updated
let hard_state = self.raft.hard_state();
if hard_state.commit > self.prev_hs.commit {
light_rd.commit_index = Some(hard_state.commit);
self.prev_hs.commit = hard_state.commit;
} else {
assert!(hard_state.commit == self.prev_hs.commit);
light_rd.commit_index = None;
}
assert_eq!(hard_state, self.prev_hs, "hard state != prev_hs");
light_rd
}
/// Same as [`Self::advance_append`] except that it allows to only store the updates in cache.
/// [`Self::on_persist_ready`] should be used later to update the persisting progress.
///
/// Raft works on an assumption persisted updates should not be lost, which usually requires expensive
/// operations like `fsync`. `advance_append_async` allows you to control the rate of such operations and
/// get a reasonable batch size. However, it's still required that the updates can be read by raft from the
/// `Storage` trait before calling `advance_append_async`.
#[inline]
pub fn advance_append_async(&mut self, rd: Ready) {
self.commit_ready(rd);
}
/// Advance apply to the index of the last committed entries given before.
#[inline]
pub fn advance_apply(&mut self) {
self.commit_apply(self.commit_since_index);
}
/// Advance apply to the passed index.
#[inline]
pub fn advance_apply_to(&mut self, applied: u64) {
self.commit_apply(applied);
}
/// Grabs the snapshot from the raft if available.
#[inline]
pub fn snap(&self) -> Option<&Snapshot> {
self.raft.snap()
}
/// Status returns the current status of the given group.
#[inline]
pub fn status(&self) -> Status {
Status::new(&self.raft)
}
/// ReportUnreachable reports the given node is not reachable for the last send.
pub fn report_unreachable(&mut self, id: u64) {
let mut m = Message::default();
m.set_msg_type(MessageType::MsgUnreachable);
m.from = id;
// we don't care if it is ok actually
let _ = self.raft.step(m);
}
/// ReportSnapshot reports the status of the sent snapshot.
pub fn report_snapshot(&mut self, id: u64, status: SnapshotStatus) {
let rej = status == SnapshotStatus::Failure;
let mut m = Message::default();
m.set_msg_type(MessageType::MsgSnapStatus);
m.from = id;
m.reject = rej;
// we don't care if it is ok actually
let _ = self.raft.step(m);
}
/// Request a snapshot from a leader.
/// The snapshot's index must be greater or equal to the request_index (last_index) or
/// the leader's term must be greater than the request term (last_index's term).
pub fn request_snapshot(&mut self) -> Result<()> {
self.raft.request_snapshot()
}
/// TransferLeader tries to transfer leadership to the given transferee.
pub fn transfer_leader(&mut self, transferee: u64) {
let mut m = Message::default();
m.set_msg_type(MessageType::MsgTransferLeader);
m.from = transferee;
let _ = self.raft.step(m);
}
/// ReadIndex requests a read state. The read state will be set in ready.
/// Read State has a read index. Once the application advances further than the read
/// index, any linearizable read requests issued before the read request can be
/// processed safely. The read state will have the same rctx attached.
pub fn read_index(&mut self, rctx: Vec<u8>) {
let mut m = Message::default();
m.set_msg_type(MessageType::MsgReadIndex);
let mut e = Entry::default();
e.data = rctx.into();
m.set_entries(vec![e].into());
let _ = self.raft.step(m);
}
/// Returns the store as an immutable reference.
#[inline]
pub fn store(&self) -> &T {
self.raft.store()
}
/// Returns the store as a mutable reference.
#[inline]
pub fn mut_store(&mut self) -> &mut T {
self.raft.mut_store()
}
/// Set whether skip broadcast empty commit messages at runtime.
#[inline]
pub fn skip_bcast_commit(&mut self, skip: bool) {
self.raft.skip_bcast_commit(skip)
}
/// Set whether to batch append msg at runtime.
#[inline]
pub fn set_batch_append(&mut self, batch_append: bool) {
self.raft.set_batch_append(batch_append)
}
}
#[cfg(test)]
mod test {
use crate::eraftpb::MessageType;
use super::is_local_msg;
#[test]
fn test_is_local_msg() {
let tests = vec![
(MessageType::MsgHup, true),
(MessageType::MsgBeat, true),
(MessageType::MsgUnreachable, true),
(MessageType::MsgSnapStatus, true),
(MessageType::MsgCheckQuorum, true),
(MessageType::MsgPropose, false),
(MessageType::MsgAppend, false),
(MessageType::MsgAppendResponse, false),
(MessageType::MsgRequestVote, false),
(MessageType::MsgRequestVoteResponse, false),
(MessageType::MsgSnapshot, false),
(MessageType::MsgHeartbeat, false),
(MessageType::MsgHeartbeatResponse, false),
(MessageType::MsgTransferLeader, false),
(MessageType::MsgTimeoutNow, false),
(MessageType::MsgReadIndex, false),
(MessageType::MsgReadIndexResp, false),
(MessageType::MsgRequestPreVote, false),
(MessageType::MsgRequestPreVoteResponse, false),
];
for (msg_type, result) in tests {
assert_eq!(is_local_msg(msg_type), result);
}
}
}