-
-
Notifications
You must be signed in to change notification settings - Fork 382
/
test_tree_failpoints.rs
1365 lines (1292 loc) · 31.7 KB
/
test_tree_failpoints.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
#![cfg(feature = "failpoints")]
mod common;
use std::collections::{BTreeMap, HashSet};
use std::sync::Mutex;
use quickcheck::{Arbitrary, Gen, QuickCheck, StdGen};
use rand::{seq::SliceRandom, Rng};
use sled::*;
#[derive(Debug, Clone)]
enum Op {
Set,
Del(u8),
Id,
Restart,
Flush,
FailPoint(&'static str),
}
use self::Op::*;
impl Arbitrary for Op {
fn arbitrary<G: Gen>(g: &mut G) -> Op {
let fail_points = vec![
"zero garbage segment",
"zero garbage segment post",
"buffer write",
"buffer write post",
"write_config bytes",
"write_config crc",
"write_config post",
"segment initial free zero",
"snap write",
"snap write len",
"snap write crc",
"snap write post",
"snap write mv",
"snap write mv post",
"snap write rm old",
"blob blob write",
"write_blob write crc",
"write_blob write kind_byte",
"write_blob write buf",
];
if g.gen_bool(1. / 30.) {
return FailPoint(fail_points.choose(g).unwrap());
}
if g.gen_bool(1. / 10.) {
return Restart;
}
let choice = g.gen_range(0, 4);
match choice {
0 => Set,
1 => Del(g.gen::<u8>()),
2 => Id,
3 => Flush,
_ => panic!("impossible choice"),
}
}
fn shrink(&self) -> Box<dyn Iterator<Item = Op>> {
match *self {
Op::Del(ref lid) if *lid > 0 => {
Box::new(vec![Op::Del(*lid / 2), Op::Del(*lid - 1)].into_iter())
}
_ => Box::new(vec![].into_iter()),
}
}
}
fn v(b: &[u8]) -> u16 {
if b[0] % 4 != 0 {
assert_eq!(b.len(), 2);
}
(u16::from(b[0]) << 8) + u16::from(b[1])
}
fn tear_down_failpoints() {
sled::fail::reset();
}
#[derive(Debug)]
struct ReferenceEntry {
values: Vec<Option<u16>>,
crash_epoch: u32,
}
fn prop_tree_crashes_nicely(ops: Vec<Op>, flusher: bool) -> bool {
// forces quickcheck to run one thread at a time
static M: Lazy<Mutex<()>, fn() -> Mutex<()>> = Lazy::new(|| Mutex::new(()));
let _lock = M.lock().expect("our test lock should not be poisoned");
// clear all failpoints that may be left over from the last run
tear_down_failpoints();
let res = std::panic::catch_unwind(|| {
run_tree_crashes_nicely(ops.clone(), flusher)
});
tear_down_failpoints();
match res {
Err(e) => {
println!(
"failed with {:?} on ops {:?} flusher {}",
e, ops, flusher
);
false
}
Ok(res) => {
if !res {
println!("failed with ops {:?} flusher: {}", ops, flusher);
}
res
}
}
}
fn run_tree_crashes_nicely(ops: Vec<Op>, flusher: bool) -> bool {
common::setup_logger();
let segment_size = 256;
let config = Config::new()
.temporary(true)
.flush_every_ms(if flusher { Some(1) } else { None })
.cache_capacity(256)
.idgen_persist_interval(1)
.segment_size(segment_size);
let mut tree = config.open().expect("tree should start");
let mut reference = BTreeMap::new();
let mut fail_points = HashSet::new();
let mut max_id: isize = -1;
let mut crash_counter = 0;
macro_rules! restart {
() => {
drop(tree);
let tree_res = config.global_error().and_then(|_| config.open());
if let Err(ref e) = tree_res {
if e == &Error::FailPoint {
return true;
}
println!("could not start database: {}", e);
return false;
}
tree = tree_res.expect("tree should restart");
let mut ref_iter = reference.iter().map(|(ref rk, ref rv)| (**rk, *rv));
for res in tree.iter() {
let t = match res {
Ok((ref tk, _)) => v(tk),
Err(Error::FailPoint) => return true,
Err(other) => panic!("failed to iterate over items in tree after restart: {:?}", other),
};
// make sure the tree value is in there
while let Some((ref_key, ref_expected)) = ref_iter.next() {
if ref_expected.values.iter().all(Option::is_none) {
// this key should not be present in the tree, skip it and move on to the
// next entry in the reference
continue;
} else if ref_expected.values.iter().all(Option::is_some) {
// this key must be present in the tree, check if the keys from both
// iterators match
if t != ref_key {
println!(
"expected to iterate over {:?} but got {:?} instead",
ref_key,
t
);
return false;
}
break;
} else {
// according to the reference, this key could either be present or absent,
// depending on whether recent writes were successful. check whether the
// keys from the two iterators match, if they do, the key happens to be
// present, which is okay, if they don't, and the tree iterator is further
// ahead than the reference iterator, the key happens to be absent, so we
// skip the entry in the reference. if the reference iterator ever gets
// further than the tree iterator, that means the tree has a key that it
// should not.
if t == ref_key {
// tree and reference agree, we can move on to the next tree item
break;
} else if ref_key > t {
// we have a bug, the reference iterator should always be <= tree
// (this means that the key t was in the tree, but it wasn't in
// the reference, so the reference iterator has advanced on past t)
println!(
"tree verification failed: expected {:?} got {:?}",
ref_key,
t
);
return false;
} else {
// we are iterating through the reference until we have an item that
// must be present or an uncertain item that matches the tree's real
// item anyway
continue;
}
}
}
}
// finish the rest of the reference iterator, and confirm the tree isn't missing
// any keys it needs to have at the end
while let Some((ref_key, ref_expected)) = ref_iter.next() {
if ref_expected.values.iter().all(Option::is_some) {
// this key had to be present, but we got to the end of the tree without
// seeing it
println!("tree verification failed: expected {:?} got end", ref_key);
println!("expected: {:?}", ref_expected);
println!("tree: {:?}", tree);
return false;
}
}
println!("finished verification");
}
}
macro_rules! fp_crash {
($e:expr) => {
match $e {
Ok(thing) => thing,
Err(Error::FailPoint) => {
tear_down_failpoints();
crash_counter += 1;
restart!();
continue;
}
other => {
println!("got non-failpoint err: {:?}", other);
return false;
}
}
};
}
let mut set_counter = 0u16;
println!("ops: {:?}", ops);
for op in ops.into_iter() {
match op {
Set => {
let hi = (set_counter >> 8) as u8;
let lo = set_counter as u8;
let val = if hi % 4 == 0 {
let mut val = vec![hi, lo];
val.extend(vec![
lo;
hi as usize * segment_size / 4
* set_counter as usize
]);
val
} else {
vec![hi, lo]
};
// update the reference to show that this key could be present.
// the next Flush operation will update the
// reference again, and require this key to be present
// (unless there's a crash before then).
let reference_entry = reference
.entry(set_counter)
.or_insert_with(|| ReferenceEntry {
values: vec![None],
crash_epoch: crash_counter,
});
reference_entry.values.push(Some(set_counter));
reference_entry.crash_epoch = crash_counter;
fp_crash!(tree.insert(&[hi, lo], val));
set_counter += 1;
}
Del(k) => {
// if this key was already set, update the reference to show
// that this key could either be present or
// absent. the next Flush operation will update the reference
// again, and require this key to be absent (unless there's a
// crash before then).
reference.entry(u16::from(k)).and_modify(|v| {
v.values.push(None);
v.crash_epoch = crash_counter;
});
fp_crash!(tree.remove(&*vec![0, k]));
}
Id => {
let id = fp_crash!(tree.generate_id());
assert!(
id as isize > max_id,
"generated id of {} is not larger \
than previous max id of {}",
id,
max_id,
);
max_id = id as isize;
}
Flush => {
fp_crash!(tree.flush());
// once a flush has been successfully completed, recent Set/Del
// operations should be durable. go through the
// reference, and if a Set/Del operation was done since
// the last crash, keep the value for that key corresponding to
// the most recent operation, and toss the rest.
for (_key, reference_entry) in reference.iter_mut() {
if reference_entry.values.len() > 1 {
if reference_entry.crash_epoch == crash_counter {
let last = *reference_entry.values.last().unwrap();
reference_entry.values.clear();
reference_entry.values.push(last);
}
}
}
}
Restart => {
restart!();
}
FailPoint(fp) => {
fail_points.insert(fp);
sled::fail::set(&*fp);
}
}
}
true
}
#[test]
#[cfg(not(target_os = "fuchsia"))]
fn quickcheck_tree_with_failpoints() {
// use fewer tests for travis OSX builds that stall out all the time
let n_tests = 50;
let generator_sz = 100;
QuickCheck::new()
.gen(StdGen::new(rand::thread_rng(), generator_sz))
.tests(n_tests)
.max_tests(10000)
.quickcheck(prop_tree_crashes_nicely as fn(Vec<Op>, bool) -> bool);
}
#[test]
fn failpoints_bug_01() {
// postmortem 1: model did not account for proper reasons to fail to start
assert!(prop_tree_crashes_nicely(
vec![FailPoint("snap write"), Restart],
false,
));
}
#[test]
fn failpoints_bug_2() {
// postmortem 1: the system was assuming the happy path across failpoints
assert!(prop_tree_crashes_nicely(
vec![FailPoint("buffer write post"), Set, Set, Restart],
false,
))
}
#[test]
fn failpoints_bug_3() {
// postmortem 1: this was a regression that happened because we
// chose to eat errors about advancing snapshots, which trigger
// log flushes. We should not trigger flushes from snapshots,
// but first we need to make sure we are better about detecting
// tears, by not also using 0 as a failed flush signifier.
assert!(prop_tree_crashes_nicely(
vec![Set, Set, Set, Set, Set, Set, Set, Set, Restart,],
false,
))
}
#[test]
fn failpoints_bug_4() {
// postmortem 1: the test model was not properly accounting for
// writes that may-or-may-not be present due to an error.
assert!(prop_tree_crashes_nicely(
vec![Set, FailPoint("snap write"), Del(0), Set, Restart],
false,
))
}
#[test]
fn failpoints_bug_5() {
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![
Set,
FailPoint("snap write mv post"),
Set,
FailPoint("snap write"),
Set,
Set,
Set,
Restart,
FailPoint("zero segment"),
Set,
Set,
Set,
Restart,
],
false,
))
}
#[test]
fn failpoints_bug_6() {
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![
Set,
Del(0),
Set,
Set,
Set,
Restart,
FailPoint("zero segment post"),
Set,
Set,
Set,
Restart,
],
false,
))
}
#[test]
fn failpoints_bug_7() {
// postmortem 1: We were crashing because a Segment was
// in the SegmentAccountant's to_clean Vec, but it had
// no present pages. This can legitimately happen when
// a Segment only contains failed log flushes.
assert!(prop_tree_crashes_nicely(
vec![
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Del(17),
Del(29),
Del(246),
Del(248),
Set,
],
false,
))
}
#[test]
fn failpoints_bug_8() {
// postmortem 1: we were assuming that deletes would fail if buffer writes
// are disabled, but that's not true, because deletes might not cause any
// writes if the value was not present.
assert!(prop_tree_crashes_nicely(
vec![
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Del(0),
FailPoint("buffer write post"),
Del(179),
],
false,
))
}
#[test]
fn failpoints_bug_9() {
// postmortem 1: recovery was not properly accounting for
// ordering issues around allocation and freeing of pages.
assert!(prop_tree_crashes_nicely(
vec![
Set,
Restart,
Del(110),
Del(0),
Set,
Restart,
Set,
Del(255),
Set,
Set,
Set,
Set,
Set,
Del(38),
Set,
Set,
Del(253),
Set,
Restart,
Set,
Del(19),
Set,
Del(118),
Set,
Set,
Set,
Set,
Set,
Del(151),
Set,
Set,
Del(201),
Set,
Restart,
Set,
Set,
Del(17),
Set,
Set,
Set,
Del(230),
Set,
Restart,
],
true,
))
}
#[test]
fn failpoints_bug_10() {
// expected to iterate over 50 but got 49 instead
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![
Del(175),
Del(19),
Restart,
Del(155),
Del(111),
Set,
Del(4),
Set,
Set,
Set,
Set,
Restart,
Del(94),
Set,
Del(83),
Del(181),
Del(218),
Set,
Set,
Del(60),
Del(248),
Set,
Set,
Set,
Del(167),
Del(180),
Del(180),
Set,
Restart,
Del(14),
Set,
Set,
Del(156),
Del(29),
Del(190),
Set,
Set,
Del(245),
Set,
Del(231),
Del(95),
Set,
Restart,
Set,
Del(189),
Set,
Restart,
Set,
Del(249),
Set,
Set,
Del(110),
Del(75),
Set,
Restart,
Del(156),
Del(140),
Del(101),
Del(45),
Del(115),
Del(162),
Set,
Set,
Del(192),
Del(31),
Del(224),
Set,
Del(84),
Del(6),
Set,
Del(191),
Set,
Set,
Set,
Del(86),
Del(143),
Del(168),
Del(175),
Set,
Restart,
Set,
Set,
Set,
Set,
Set,
Restart,
Del(14),
Set,
Set,
Set,
Set,
Set,
Set,
Del(60),
Set,
Del(115),
Restart,
Set,
Del(203),
Del(12),
Del(134),
Del(118),
Del(26),
Del(161),
Set,
Del(6),
Del(23),
Set,
Del(122),
Del(251),
Set,
Restart,
Set,
Set,
Del(252),
Del(88),
Set,
Del(140),
Del(164),
Del(203),
Del(165),
Set,
Set,
Restart,
Del(0),
Set,
Del(146),
Del(83),
Restart,
Del(0),
Set,
Del(55),
Set,
Set,
Del(89),
Set,
Set,
Del(105),
Restart,
Set,
Restart,
Del(145),
Set,
Del(17),
Del(123),
Set,
Del(203),
Set,
Set,
Set,
Set,
Del(192),
Del(58),
Restart,
Set,
Restart,
Set,
Restart,
Set,
Del(142),
Set,
Del(220),
Del(185),
Set,
Del(86),
Set,
Set,
Del(123),
Set,
Restart,
Del(56),
Del(191),
Set,
Set,
Set,
Set,
Set,
Del(123),
Set,
Set,
Set,
Restart,
Del(20),
Del(47),
Del(207),
Del(45),
Set,
Set,
Set,
Del(83),
Set,
Del(92),
Del(117),
Set,
Set,
Restart,
Del(241),
Set,
Del(49),
Set,
],
false,
))
}
#[test]
fn failpoints_bug_11() {
// dupe lsn detected
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Restart,
Del(21),
Set,
Set,
FailPoint("buffer write post"),
Set,
Set,
Restart,
],
false,
))
}
#[test]
fn failpoints_bug_12() {
// postmortem 1: we were not sorting the recovery state, which
// led to divergent state across recoveries. TODO wut
assert!(prop_tree_crashes_nicely(
vec![
Set,
Del(0),
Set,
Set,
Set,
Set,
Set,
Set,
Restart,
Set,
Set,
Set,
Restart,
],
false,
))
}
#[test]
fn failpoints_bug_13() {
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Del(0),
Set,
Set,
Set,
Del(2),
Set,
Set,
Set,
Set,
Del(1),
Del(3),
Del(18),
Set,
Set,
Set,
Restart,
Set,
Set,
Set,
Set,
FailPoint("snap write"),
Del(4),
],
false,
))
}
#[test]
fn failpoints_bug_14() {
// postmortem 1: improper bounds on splits caused a loop to happen
assert!(prop_tree_crashes_nicely(
vec![
FailPoint("blob blob write"),
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
Set,
],
false,
))
}
#[test]
fn failpoints_bug_15() {
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![FailPoint("buffer write"), Id, Restart, Id],
false,
))
}
#[test]
fn failpoints_bug_16() {
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![FailPoint("zero garbage segment"), Id, Id],
false,
))
}
#[test]
fn failpoints_bug_17() {
// postmortem 1: during recovery we were not properly
// filtering replaced pages in segments by the source
// segment still
assert!(prop_tree_crashes_nicely(
vec![
Del(0),
Set,
Set,
Set,
Del(3),
Id,
Id,
Set,
Id,
Id,
Del(3),
Id,
Id,
Del(3),
Restart,
Id,
FailPoint("blob blob write"),
Id,
Restart,
Id,
Set,
Id,
Del(3),
Set
],
false,
))
}
#[test]
fn failpoints_bug_18() {
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![Id, Id, Set, Id, Id, Id, Set, Del(0), Restart, Del(0), Id, Set],
false,
))
}
#[test]
fn failpoints_bug_19() {
// postmortem 1:
assert!(prop_tree_crashes_nicely(
vec![
Set,
Set,
Set,
Set,
Del(4),
Id,
Del(4),
Id,
Id,
Set,
Set,
Set,
Set,
Set,
Id,
Set,
Set,
Del(11),
Del(13),