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
use std::error::Error;
use std::ops::Deref;
use tokio::time::Instant;
use crate::engine::LogIdList;
use crate::entry::RaftEntry;
use crate::equal;
use crate::error::ForwardToLeader;
use crate::less_equal;
use crate::log_id::RaftLogId;
use crate::node::Node;
use crate::utime::UTime;
use crate::validate::Validate;
use crate::LogId;
use crate::LogIdOptionExt;
use crate::NodeId;
use crate::ServerState;
use crate::SnapshotMeta;
use crate::Vote;
mod log_state_reader;
mod membership_state;
mod vote_state_reader;
#[cfg(test)]
mod tests {
mod forward_to_leader_test;
mod log_state_reader_test;
mod validate_test;
}
pub(crate) use log_state_reader::LogStateReader;
pub use membership_state::MembershipState;
pub(crate) use vote_state_reader::VoteStateReader;
#[derive(Clone, Debug)]
#[derive(Default)]
#[derive(PartialEq, Eq)]
pub struct RaftState<NID, N>
where
NID: NodeId,
N: Node,
{
pub(crate) vote: UTime<Vote<NID>>,
pub committed: Option<LogId<NID>>,
pub(crate) purged_next: u64,
pub log_ids: LogIdList<NID>,
pub membership_state: MembershipState<NID, N>,
pub snapshot_meta: SnapshotMeta<NID, N>,
pub server_state: ServerState,
pub(crate) purge_upto: Option<LogId<NID>>,
}
impl<NID, N> LogStateReader<NID> for RaftState<NID, N>
where
NID: NodeId,
N: Node,
{
fn get_log_id(&self, index: u64) -> Option<LogId<NID>> {
self.log_ids.get(index)
}
fn last_log_id(&self) -> Option<&LogId<NID>> {
self.log_ids.last()
}
fn committed(&self) -> Option<&LogId<NID>> {
self.committed.as_ref()
}
fn snapshot_last_log_id(&self) -> Option<&LogId<NID>> {
self.snapshot_meta.last_log_id.as_ref()
}
fn purge_upto(&self) -> Option<&LogId<NID>> {
self.purge_upto.as_ref()
}
fn last_purged_log_id(&self) -> Option<&LogId<NID>> {
if self.purged_next == 0 {
return None;
}
self.log_ids.first()
}
}
impl<NID, N> VoteStateReader<NID> for RaftState<NID, N>
where
NID: NodeId,
N: Node,
{
fn vote_ref(&self) -> &Vote<NID> {
self.vote.deref()
}
}
impl<NID, N> Validate for RaftState<NID, N>
where
NID: NodeId,
N: Node,
{
fn validate(&self) -> Result<(), Box<dyn Error>> {
if self.purged_next == 0 {
less_equal!(self.log_ids.first().index(), Some(0));
} else {
equal!(self.purged_next, self.log_ids.first().next_index());
}
less_equal!(self.last_purged_log_id(), self.purge_upto());
if self.snapshot_last_log_id().is_none() {
less_equal!(self.purge_upto(), self.committed());
} else {
less_equal!(self.purge_upto(), self.snapshot_last_log_id());
}
less_equal!(self.snapshot_last_log_id(), self.committed());
less_equal!(self.committed(), self.last_log_id());
self.membership_state.validate()?;
Ok(())
}
}
impl<NID, N> RaftState<NID, N>
where
NID: NodeId,
N: Node,
{
pub fn vote_ref(&self) -> &Vote<NID> {
self.vote.deref()
}
pub fn vote_last_modified(&self) -> Option<Instant> {
self.vote.utime()
}
pub(crate) fn extend_log_ids_from_same_leader<'a, LID: RaftLogId<NID> + 'a>(&mut self, new_log_ids: &[LID]) {
self.log_ids.extend_from_same_leader(new_log_ids)
}
pub(crate) fn extend_log_ids<'a, LID: RaftLogId<NID> + 'a>(&mut self, new_log_id: &[LID]) {
self.log_ids.extend(new_log_id)
}
#[tracing::instrument(level = "debug", skip_all)]
pub(crate) fn update_committed(&mut self, committed: &Option<LogId<NID>>) -> Option<Option<LogId<NID>>> {
if committed.as_ref() > self.committed() {
let prev = self.committed().copied();
self.committed = *committed;
self.membership_state.commit(committed);
Some(prev)
} else {
None
}
}
pub(crate) fn first_conflicting_index<Ent>(&self, entries: &[Ent]) -> usize
where Ent: RaftLogId<NID> {
let l = entries.len();
for (i, ent) in entries.iter().enumerate() {
let log_id = ent.get_log_id();
if !self.has_log_id(log_id) {
tracing::debug!(
at = display(i),
entry_log_id = display(log_id),
"found nonexistent log id"
);
return i;
}
}
tracing::debug!("not found nonexistent");
l
}
#[tracing::instrument(level = "debug", skip_all)]
pub(crate) fn purge_log(&mut self, upto: &LogId<NID>) {
self.purged_next = upto.index + 1;
self.log_ids.purge(upto);
}
#[tracing::instrument(level = "debug", skip_all)]
pub(crate) fn calc_server_state(&self, id: &NID) -> ServerState {
tracing::debug!(
is_member = display(self.is_voter(id)),
is_leader = display(self.is_leader(id)),
is_leading = display(self.is_leading(id)),
"states"
);
if self.is_voter(id) {
if self.is_leader(id) {
ServerState::Leader
} else if self.is_leading(id) {
ServerState::Candidate
} else {
ServerState::Follower
}
} else {
ServerState::Learner
}
}
pub(crate) fn is_voter(&self, id: &NID) -> bool {
self.membership_state.is_voter(id)
}
pub(crate) fn is_leading(&self, id: &NID) -> bool {
self.vote.leader_id().voted_for().as_ref() == Some(id)
}
pub(crate) fn is_leader(&self, id: &NID) -> bool {
self.vote.leader_id().voted_for().as_ref() == Some(id) && self.vote.is_committed()
}
pub(crate) fn assign_log_ids<'a, Ent: RaftEntry<NID, N> + 'a>(
&mut self,
entries: impl Iterator<Item = &'a mut Ent>,
) {
let mut log_id = LogId::new(
self.vote_ref().committed_leader_id().unwrap(),
self.last_log_id().next_index(),
);
for entry in entries {
entry.set_log_id(&log_id);
tracing::debug!("assign log id: {}", log_id);
log_id.index += 1;
}
}
pub(crate) fn forward_to_leader(&self) -> ForwardToLeader<NID, N> {
let vote = self.vote_ref();
if vote.is_committed() {
let id = vote.leader_id().voted_for().unwrap();
let node = self.membership_state.effective().get_node(&id);
if let Some(n) = node {
return ForwardToLeader::new(id, n.clone());
} else {
tracing::debug!("id={} is not in membership, when getting leader id", id);
}
};
ForwardToLeader::empty()
}
}