quepaxa 0.3.1

QuePaxa consensus as a sans-IO, no_std replicated log
Documentation
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
//! Leader schedule, derived only from the decided log so every replica agrees on the
//! leader of every slot without extra messages.
//!
//! The schedule in force for slot `k` is the latest one decided at a slot `≤ k − LAG`.
//! A replica only drives slots below `commit_index + max_in_flight_slots ≤ commit_index +
//! LAG`, so the schedule of any slot it touches is already fixed by its decided prefix.
//! When `ROTATE_AFTER` consecutive slots are decided with values that did not originate at
//! their leader (it is down, partitioned or slow), the leader moves to the back.
//!
//! Membership changes ride the same mechanism: an order is always the slot's members,
//! preferred leaders first, so a membership change decided in slot `s` is a new order from
//! `s + LAG` (a new epoch). The same window bound then guarantees that every proposer of a
//! slot uses the same recorders and majority.

use alloc::vec::Vec;
use bytes::BufMut;

use crate::codec::{DecodeError, Reader};

use crate::types::{NodeId, ProposalId, Slot};

/// Slots between deciding a schedule change and it taking effect.
pub(crate) const LAG: u64 = 64;
/// Consecutive slots not led by their leader before it is rotated out.
const ROTATE_AFTER: u32 = 8;
/// Upper bound on members in one order (keeps decoding allocations bounded).
pub(crate) const MAX_MEMBERS: usize = 1024;

/// Identity of a proposed membership change: `(origin, incarnation, id)`.
pub(crate) type ChangeKey = (NodeId, u64, ProposalId);

/// Encodes a membership change's new order (members, preferred leaders first).
pub(crate) fn encode_order(order: &[NodeId]) -> bytes::Bytes {
    let mut out = Vec::with_capacity(4 + 4 * order.len());
    out.put_u32_le(order.len() as u32);
    for n in order {
        out.put_u32_le(n.0);
    }
    bytes::Bytes::from(out)
}

/// Decodes an order written by [`encode_order`]: non-empty, without duplicates.
pub(crate) fn decode_order(b: &bytes::Bytes) -> Option<Vec<NodeId>> {
    let mut r = Reader::new(b);
    let len = r.u32().ok()? as usize;
    if len == 0 || len > MAX_MEMBERS {
        return None;
    }
    let mut order = Vec::with_capacity(len);
    for _ in 0..len {
        let n = NodeId(r.u32().ok()?);
        if order.contains(&n) {
            return None;
        }
        order.push(n);
    }
    r.finish().ok()?;
    Some(order)
}

#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "model", derive(Hash))]
pub(crate) struct Schedule {
    /// `(first slot it applies to, order)`, ascending; the first entry starts at slot 0.
    history: Vec<(u64, Vec<NodeId>)>,
    streak: u32,
    /// No new rotation is counted until the last one takes effect.
    quiet_until: u64,
    /// Membership epoch in force from `epoch_from` (0: the configured members).
    epoch: u64,
    epoch_from: u64,
    /// Changes already applied or ignored, so another copy decided later (hedging may
    /// include one twice) is ignored too and never reverts a newer membership.
    settled: Vec<ChangeKey>,
}

impl Schedule {
    #[cfg(test)]
    pub fn new(members: &[NodeId]) -> Self {
        let mut order = members.to_vec();
        order.sort_unstable();
        Self::with_order(order)
    }

    /// A schedule whose first leaders are `order`, first to last.
    pub fn with_order(order: Vec<NodeId>) -> Self {
        Self {
            history: alloc::vec![(0, order)],
            streak: 0,
            quiet_until: 0,
            epoch: 0,
            epoch_from: 0,
            settled: Vec::new(),
        }
    }

    fn order(&self, slot: Slot) -> &[NodeId] {
        let i = self.history.partition_point(|(from, _)| *from <= slot.0);
        &self.history[i.saturating_sub(1)].1
    }

    pub fn leader(&self, slot: Slot) -> NodeId {
        self.order(slot)[0]
    }

    /// The members of `slot`'s epoch: its recorders, preferred leaders first.
    pub fn members(&self, slot: Slot) -> &[NodeId] {
        self.order(slot)
    }

    /// Whether `node` is a member of any epoch still in the schedule (current or pending).
    pub fn knows(&self, node: NodeId) -> bool {
        self.history.iter().any(|(_, order)| order.contains(&node))
    }

    /// Everyone in any epoch still in the schedule, without duplicates.
    pub fn everyone(&self) -> Vec<NodeId> {
        let mut all: Vec<NodeId> = self.history.iter().flat_map(|(_, o)| o.iter().copied()).collect();
        all.sort_unstable();
        all.dedup();
        all
    }

    /// The latest epoch and the slot it starts at (possibly still in the future).
    pub fn epoch(&self) -> (u64, u64) {
        (self.epoch, self.epoch_from)
    }

    /// Applies membership change `key`, decided in `slot`: from `slot + LAG` on, `order`
    /// (the new members, preferred leaders first) leads. Returns the new epoch and its first
    /// slot, or `None` if ignored because another change has not taken effect yet or this
    /// one was already applied or ignored. Feed it in slot order, after `observe` for the
    /// same slot.
    pub fn reconfigure(&mut self, slot: Slot, key: ChangeKey, order: Vec<NodeId>) -> Option<(u64, u64)> {
        if self.settled.contains(&key) {
            return None;
        }
        self.settled.push(key);
        if slot.0 < self.epoch_from {
            return None;
        }
        let from = slot.0 + LAG;
        // A rotation counted in this very slot is superseded.
        if self.history.last().is_some_and(|(f, _)| *f == from) {
            self.history.pop();
        }
        self.history.push((from, order));
        self.epoch += 1;
        self.epoch_from = from;
        self.streak = 0;
        self.quiet_until = from;
        self.prune(slot);
        Some((self.epoch, from))
    }

    /// Older schedules can no longer apply to any slot a replica will drive.
    fn prune(&mut self, slot: Slot) {
        let keep_from = self.history.partition_point(|(f, _)| *f <= slot.0).saturating_sub(1);
        self.history.drain(..keep_from);
    }

    /// 0 for the leader, then the hedging order; a non-member ranks last.
    pub fn position(&self, node: NodeId, slot: Slot) -> u64 {
        let order = self.order(slot);
        order.iter().position(|&n| n == node).unwrap_or(order.len()) as u64
    }

    pub fn encode(&self, out: &mut Vec<u8>) {
        out.put_u64_le(self.epoch);
        out.put_u64_le(self.epoch_from);
        out.put_u32_le(self.settled.len() as u32);
        for (origin, incarnation, id) in &self.settled {
            out.put_u32_le(origin.0);
            out.put_u64_le(*incarnation);
            out.put_u64_le(id.0);
        }
        out.put_u32_le(self.streak);
        out.put_u64_le(self.quiet_until);
        out.put_u32_le(self.history.len() as u32);
        for (from, order) in &self.history {
            out.put_u64_le(*from);
            out.put_u32_le(order.len() as u32);
            for n in order {
                out.put_u32_le(n.0);
            }
        }
    }

    /// Restores a schedule. Before epochs (`with_epochs` false) every order is a permutation
    /// of the configured `members`.
    pub fn decode(r: &mut Reader<'_>, members: &[NodeId], with_epochs: bool) -> Result<Self, DecodeError> {
        let (mut epoch, mut epoch_from, mut settled) = (0, 0, Vec::new());
        if with_epochs {
            epoch = r.u64()?;
            epoch_from = r.u64()?;
            let n = r.u32()? as usize;
            for _ in 0..n {
                settled.push((NodeId(r.u32()?), r.u64()?, ProposalId(r.u64()?)));
            }
            if (settled.len() as u64) < epoch {
                return Err(DecodeError::BadTag);
            }
        }
        let streak = r.u32()?;
        if streak >= ROTATE_AFTER {
            return Err(DecodeError::BadTag);
        }
        let quiet_until = r.u64()?;
        let n = r.u32()? as usize;
        let mut history = Vec::new();
        for _ in 0..n {
            let from = r.u64()?;
            // Until the first change, every order is a permutation of the configured members.
            let configured = epoch == 0;
            let len = r.u32()? as usize;
            if len == 0 || len > MAX_MEMBERS || (configured && len != members.len()) {
                return Err(DecodeError::BadTag);
            }
            let mut order = Vec::with_capacity(len);
            for _ in 0..len {
                let node = NodeId(r.u32()?);
                if (configured && !members.contains(&node)) || order.contains(&node) {
                    return Err(DecodeError::BadTag);
                }
                order.push(node);
            }
            history.push((from, order));
        }
        if history.is_empty() || !history.is_sorted_by_key(|(f, _)| *f) {
            return Err(DecodeError::BadTag);
        }
        Ok(Self { history, streak, quiet_until, epoch, epoch_from, settled })
    }

    /// Feeds each decided slot exactly once, in slot order, with its value's origin.
    pub fn observe(&mut self, slot: Slot, origin: NodeId) {
        if slot.0 < self.quiet_until {
            return;
        }
        if origin == self.leader(slot) {
            self.streak = 0;
            return;
        }
        self.streak += 1;
        if self.streak >= ROTATE_AFTER {
            let mut order = self.order(slot).to_vec();
            order.rotate_left(1);
            let from = slot.0 + LAG;
            self.history.push((from, order));
            self.streak = 0;
            self.quiet_until = from;
            self.prune(slot);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn ids(v: &[u32]) -> Vec<NodeId> {
        v.iter().copied().map(NodeId).collect()
    }

    #[test]
    fn initial_leader_is_the_smallest_member() {
        let s = Schedule::new(&ids(&[3, 1, 2]));
        assert_eq!((s.leader(Slot(0)), s.position(NodeId(3), Slot(0))), (NodeId(1), 2));
    }

    #[test]
    fn eight_missed_slots_rotate_the_leader_after_the_lag() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        for slot in 0..8 {
            s.observe(Slot(slot), NodeId(1));
        }
        assert_eq!(s.leader(Slot(7 + LAG - 1)), NodeId(0));
        assert_eq!(s.leader(Slot(7 + LAG)), NodeId(1));
        assert_eq!(s.position(NodeId(0), Slot(7 + LAG)), 2);
    }

    #[test]
    fn a_slot_led_by_its_leader_resets_the_streak() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        for slot in 0..7 {
            s.observe(Slot(slot), NodeId(2));
        }
        s.observe(Slot(7), NodeId(0));
        for slot in 8..15 {
            s.observe(Slot(slot), NodeId(2));
        }
        assert_eq!(s.leader(Slot(200)), NodeId(0));
    }

    #[test]
    fn misses_before_a_rotation_takes_effect_do_not_rotate_again() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        for slot in 0..(8 + LAG) {
            s.observe(Slot(slot), NodeId(2));
        }
        assert_eq!(s.leader(Slot(8 + LAG)), NodeId(1));
    }

    #[test]
    fn decode_rejects_an_empty_or_unsorted_history() {
        let members = ids(&[0, 1, 2]);
        let encoded = |froms: &[u64]| {
            let mut out = Vec::new();
            out.put_u32_le(0);
            out.put_u64_le(0);
            out.put_u32_le(froms.len() as u32);
            for from in froms {
                out.put_u64_le(*from);
                out.put_u32_le(3);
                [0, 1, 2].into_iter().for_each(|n| out.put_u32_le(n));
            }
            bytes::Bytes::from(out)
        };
        let decode = |b: &bytes::Bytes| {
            Schedule::decode(&mut Reader::new(b), &members, false).map(|s| s.history.len())
        };
        assert_eq!(decode(&encoded(&[0, 9])), Ok(2));
        assert!(decode(&encoded(&[])).is_err());
        assert!(decode(&encoded(&[9, 0])).is_err());
    }

    fn key(id: u64) -> ChangeKey {
        (NodeId(0), 1, ProposalId(id))
    }

    #[test]
    fn a_membership_change_takes_effect_a_window_later() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        assert_eq!(s.reconfigure(Slot(10), key(1), ids(&[3, 1, 2])), Some((1, 10 + LAG)));
        assert_eq!(s.members(Slot(10 + LAG - 1)), ids(&[0, 1, 2]));
        assert_eq!((s.members(Slot(10 + LAG)), s.leader(Slot(10 + LAG))), (&ids(&[3, 1, 2])[..], NodeId(3)));
        assert!(s.knows(NodeId(3)) && s.knows(NodeId(0)));
        assert_eq!(s.everyone(), ids(&[0, 1, 2, 3]));
    }

    #[test]
    fn one_change_at_a_time_and_never_twice() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        s.reconfigure(Slot(10), key(1), ids(&[1, 2, 3])).unwrap();
        assert_eq!(s.reconfigure(Slot(11), key(2), ids(&[0, 1])), None, "the first is still pending");
        assert_eq!(s.reconfigure(Slot(10 + LAG), key(1), ids(&[1, 2, 3])), None, "a late duplicate");
        assert_eq!(
            s.reconfigure(Slot(10 + LAG), key(2), ids(&[0, 1])),
            None,
            "a late copy of an ignored one"
        );
        assert_eq!(s.reconfigure(Slot(10 + LAG), key(3), ids(&[0, 1])), Some((2, 10 + 2 * LAG)));
        assert_eq!(s.epoch(), (2, 10 + 2 * LAG));
    }

    #[test]
    fn a_change_supersedes_a_rotation_counted_in_the_same_slot() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        for slot in 0..8 {
            s.observe(Slot(slot), NodeId(1));
        }
        s.reconfigure(Slot(7), key(1), ids(&[2, 0])).unwrap();
        assert_eq!(s.members(Slot(7 + LAG)), ids(&[2, 0]));
        // Rotations resume in the new epoch, counted from its own leader.
        for slot in (7 + LAG)..(7 + LAG + 8) {
            s.observe(Slot(slot), NodeId(0));
        }
        assert_eq!(s.leader(Slot(7 + 2 * LAG + 7)), NodeId(0));
    }

    #[test]
    fn epochs_round_trip() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        s.reconfigure(Slot(3), key(9), ids(&[4, 5, 6, 7])).unwrap();
        let mut out = Vec::new();
        s.encode(&mut out);
        let b = bytes::Bytes::from(out);
        assert_eq!(Schedule::decode(&mut Reader::new(&b), &ids(&[0, 1, 2]), true), Ok(s));
    }

    #[test]
    fn orders_decode_only_when_well_formed() {
        assert_eq!(decode_order(&encode_order(&ids(&[2, 0]))), Some(ids(&[2, 0])));
        assert_eq!(decode_order(&encode_order(&[])), None);
        assert_eq!(decode_order(&encode_order(&ids(&[1, 1]))), None);
        assert_eq!(decode_order(&bytes::Bytes::from_static(&[1, 0, 0, 0])), None);
    }

    #[test]
    fn orders_are_bounded_in_size() {
        let at_most = (0..MAX_MEMBERS as u32).map(NodeId).collect::<Vec<_>>();
        assert!(decode_order(&encode_order(&at_most)).is_some());
        let too_many = (0..=MAX_MEMBERS as u32).map(NodeId).collect::<Vec<_>>();
        assert_eq!(decode_order(&encode_order(&too_many)), None);
    }

    #[test]
    fn old_schedules_are_pruned() {
        let mut s = Schedule::new(&ids(&[0, 1, 2]));
        for slot in 0..10_000 {
            s.observe(Slot(slot), NodeId(9));
        }
        assert!(s.history.len() <= 2, "{} orders kept", s.history.len());
    }

    /// One schedule encoding with a single order: before epochs (`None`) or in `epoch`.
    fn encoded(epoch: Option<u64>, order: &[u32]) -> bytes::Bytes {
        let mut out = Vec::new();
        if let Some(e) = epoch {
            out.put_u64_le(e);
            out.put_u64_le(0);
            out.put_u32_le(e as u32);
            for k in 0..e {
                out.put_u32_le(0);
                out.put_u64_le(1);
                out.put_u64_le(k);
            }
        }
        out.put_u32_le(0);
        out.put_u64_le(0);
        out.put_u32_le(1);
        out.put_u64_le(0);
        out.put_u32_le(order.len() as u32);
        order.iter().for_each(|n| out.put_u32_le(*n));
        bytes::Bytes::from(out)
    }

    #[test]
    fn decoding_checks_every_order() {
        let members = ids(&[0, 1, 2]);
        let decode = |epoch: Option<u64>, order: &[u32]| {
            Schedule::decode(&mut Reader::new(&encoded(epoch, order)), &members, epoch.is_some()).is_ok()
        };
        // Before any change, orders are permutations of the configured members.
        for epoch in [None, Some(0)] {
            assert!(decode(epoch, &[2, 0, 1]));
            assert!(!decode(epoch, &[0, 1]) && !decode(epoch, &[0, 1, 7]) && !decode(epoch, &[0, 1, 1]));
        }
        // After one, any non-empty order of distinct replicas, up to the bound.
        assert!(decode(Some(1), &[7, 8]) && decode(Some(1), &[5]));
        assert!(!decode(Some(1), &[]) && !decode(Some(1), &[7, 7]));
        let max: Vec<u32> = (0..MAX_MEMBERS as u32).collect();
        let over: Vec<u32> = (0..=MAX_MEMBERS as u32).collect();
        assert!(decode(Some(1), &max) && !decode(Some(1), &over));
        // An epoch needs at least as many settled changes.
        let mut short = encoded(Some(2), &[5]).to_vec();
        short[16..20].copy_from_slice(&1u32.to_le_bytes());
        short.drain(20..40);
        let short = bytes::Bytes::from(short);
        assert!(Schedule::decode(&mut Reader::new(&short), &members, true).is_err());
    }

    proptest::proptest! {
        // Replicas that observe the same decided prefix agree on every slot's leader.
        #[test]
        fn same_log_same_leaders(origins in proptest::collection::vec(0u32..3, 0..400)) {
            let (mut a, mut b) = (Schedule::new(&ids(&[0, 1, 2])), Schedule::new(&ids(&[2, 1, 0])));
            for (slot, o) in origins.iter().enumerate() {
                a.observe(Slot(slot as u64), NodeId(*o));
                b.observe(Slot(slot as u64), NodeId(*o));
            }
            for k in 0..(origins.len() as u64 + LAG) {
                proptest::prop_assert_eq!(a.leader(Slot(k)), b.leader(Slot(k)));
            }
        }
    }
}