ferrosys 0.8.0

Pure-Rust filesystem formatter and reader: ext4, ext3, ext2, FAT32, FAT16, FAT12, exFAT, btrfs, and APFS — rootless, in userspace, byte-reproducible
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
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
//! The B-tree engine: one descent, one iteration, and the bounds that make both terminate on
//! an image that was crafted rather than formatted.
//!
//! Every tree in a btrfs is the same shape — internal nodes of `(key, child address)` pairs
//! over leaves of `(key, data)` items, sorted by the key tuple — so there is one engine and
//! every tree is read through it. What an item *means* is decided by whoever asked for it;
//! this module knows only that items have keys and that keys are ordered.
//!
//! # What bounds a walk
//!
//! An untrusted image can describe a tree that is not one, and each way of doing so has its
//! own guard:
//!
//! - **A count larger than the block holds.** Checked against the room the block has, in the
//!   units the block's own level says it holds — 25 bytes per item, 33 per child pointer.
//! - **An item whose data escapes its leaf.** Checked in two directions, because a leaf fills
//!   from both ends: the data must begin past the array describing it and end within the
//!   block. The arithmetic is 64-bit whatever the target's pointer width is, so a crafted
//!   offset and length behave the same on a 32-bit machine as on the one this is developed
//!   on.
//! - **A leaf whose data is not packed.** Every item's data abuts its neighbour's, so a leaf
//!   whose data has been moved with its offsets moved to match — every item still inside the
//!   block, every item pointing at bytes that are not its own — is refused. Nothing about a
//!   bound sees that one, and what a reader would otherwise hand back is one record's bytes
//!   under another record's key.
//! - **A child pointer that leads back up.** Every address a descent visits is remembered, and
//!   meeting one twice is a refusal rather than a loop.
//! - **A child at the wrong height.** A child must be exactly one level below its parent, so a
//!   descent has a decreasing measure independent of the visited set and terminates whatever
//!   the addresses say.
//! - **A block from another transaction.** A root item and a parent's pointer each record the
//!   transaction that wrote the block they lead to, and a block at any other is refused: one
//!   left over from an earlier transaction at an address since written again verifies in
//!   every other respect.
//! - **Keys out of order, or out of place.** A tree that is not sorted is not a tree, and a
//!   search over one silently misses items rather than failing. Every block's keys are held
//!   against each other when a descent reaches it, a node's as well as a leaf's, and against
//!   the keys its parent records: its first key is the parent's key for it, and its last is
//!   below the parent's key for the block after it. A node's keys are what a search steers
//!   by, so one that does not match the block it leads to hides files a walk of every block
//!   would still meet.
//! - **A tree larger than the caller will hold.** [`Limits::max_walk_entries`](crate::Limits::max_walk_entries) caps the items
//!   one walk visits.
//!
//! This module does I/O, through the volume it borrows.

use std::collections::BTreeSet;
use std::io::{Read, Seek};

use super::ondisk::DiskKey;
use super::volume::{ReadError, TreeBlock, TreeRoot, Volume};

/// One item, taken out of the tree that held it.
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Located {
    /// The key it was found under.
    pub key: DiskKey,
    /// Its bytes, which are as long as the item said and no longer.
    pub data: Vec<u8>,
}

/// How many blocks stand above `leaves`, level by level, in a tree of this fan-out.
///
/// The first entry is the level directly above the leaves and the last is always one — the
/// root. A tree whose leaves are one block has nothing above them, and the answer is empty:
/// that leaf *is* the root.
///
/// The arithmetic is the same whether it is being asked in advance as a bound
/// ([`geometry`](super::geometry)) or exactly of records already packed
/// ([`materialize`](super::materialize)), so it is asked in one place. `fan_out` is floored at
/// two, because a level whose blocks hold one child each never narrows and the stack would not
/// end — a floor rather than an error, since the only caller that could reach it derives the
/// fan-out from a node size the format has already accepted.
pub(super) fn levels_above(leaves: u64, fan_out: u64) -> Vec<u64> {
    let fan_out = fan_out.max(2);
    let mut levels = Vec::new();
    let mut width = leaves;
    while width > 1 {
        width = width.div_ceil(fan_out);
        levels.push(width);
    }
    levels
}

/// A handle on one tree of a volume, for searching or iterating it.
///
/// Borrowed from the [`Volume`] rather than owning anything, so a caller moves between trees
/// without reopening the filesystem — and so that every block either reads goes through the
/// one chunk map and the one checksum check.
pub struct Tree<'a, R> {
    volume: &'a mut Volume<R>,
    root: TreeRoot,
}

impl<'a, R: Read + Seek> Tree<'a, R> {
    /// A handle on the tree `root` names.
    pub(super) fn new(volume: &'a mut Volume<R>, root: TreeRoot) -> Self {
        Self { volume, root }
    }

    /// Which tree this is, and where it begins.
    #[must_use]
    pub fn root(&self) -> TreeRoot {
        self.root
    }

    /// Visit every item, in key order.
    ///
    /// The closure answers whether to keep going, so a caller looking for one thing stops
    /// where it finds it rather than reading the rest of the tree.
    ///
    /// # Errors
    ///
    /// Whatever reading a block does, and the tree-shape refusals this module's documentation
    /// lists.
    pub fn for_each_item<F>(&mut self, mut visit: F) -> Result<(), ReadError>
    where
        F: FnMut(&DiskKey, &[u8]) -> bool,
    {
        self.drive(DiskKey::MIN, &mut |_| true, &mut visit)
    }

    /// Visit every item at or after `from`, in key order.
    ///
    /// The descent goes straight to the first item at or after the key rather than walking the
    /// tree from its start, which is what makes "the entries of this directory" one descent
    /// instead of a scan.
    ///
    /// # Errors
    ///
    /// As [`for_each_item`](Self::for_each_item).
    pub fn for_each_item_from<F>(&mut self, from: DiskKey, mut visit: F) -> Result<(), ReadError>
    where
        F: FnMut(&DiskKey, &[u8]) -> bool,
    {
        self.drive(from, &mut |_| true, &mut visit)
    }

    /// Visit every block of the tree, in the order a depth-first descent meets them.
    ///
    /// Every block is fetched through the chunk map and its checksum verified before the
    /// closure sees it, so a walk that completes is a statement that every block of the tree
    /// verified. The items are bounds-checked on the way past whether or not the closure looks
    /// at them, which is what makes this a verification pass rather than a header read.
    ///
    /// # Errors
    ///
    /// As [`for_each_item`](Self::for_each_item).
    pub fn for_each_block<F>(&mut self, mut visit: F) -> Result<(), ReadError>
    where
        F: FnMut(&TreeBlock) -> bool,
    {
        self.drive(DiskKey::MIN, &mut visit, &mut |_, _| true)
    }

    /// The first item at or after `key`, or [`None`] where the tree holds none.
    ///
    /// # Errors
    ///
    /// As [`for_each_item`](Self::for_each_item).
    pub fn find_first(&mut self, key: DiskKey) -> Result<Option<Located>, ReadError> {
        let mut found = None;
        self.for_each_item_from(key, |key, data| {
            found = Some(Located {
                key: *key,
                data: data.to_vec(),
            });
            false
        })?;
        Ok(found)
    }

    /// The item stored under exactly `key`, or [`None`] where there is none.
    ///
    /// # Errors
    ///
    /// As [`for_each_item`](Self::for_each_item).
    pub fn find_exact(&mut self, key: DiskKey) -> Result<Option<Located>, ReadError> {
        Ok(self.find_first(key)?.filter(|found| found.key == key))
    }

    /// The last item at or before `key`, or [`None`] where every item in the tree is above it.
    ///
    /// The search a *range* needs, where [`find_first`](Self::find_first) is the one a *point*
    /// needs. A record keyed by where a run begins covers everything up to the next one, so the
    /// record covering a position is the last one at or before it — and asking for the first at
    /// or after would find the record covering the *next* position and skip the one wanted.
    /// That is how a file's extents are keyed, and reading from an offset in the middle of one
    /// is the case that makes the difference visible.
    ///
    /// One descent, so it costs the height of the tree rather than a scan.
    ///
    /// # Errors
    ///
    /// As [`for_each_item`](Self::for_each_item).
    pub fn find_at_or_before(&mut self, key: DiskKey) -> Result<Option<Located>, ReadError> {
        let mut visited = BTreeSet::new();
        visited.insert(self.root.bytenr);
        let mut block = self.read_root()?;
        let mut below = None;
        loop {
            if block.header().is_leaf() {
                let at = partition(&block, &key, true)?;
                let Some(index) = at.checked_sub(1) else {
                    return Ok(None);
                };
                let found = Located {
                    key: block.item(index)?.key,
                    data: block.item_data(index)?.to_vec(),
                };
                if index + 1 == block.count()? && below.is_some() {
                    self.confirm_last(&found.key, &key)?;
                }
                return Ok(Some(found));
            }
            let index = start_index(&block, &key)?;
            (block, below) = self.child_of(&block, below, index, &mut visited)?;
        }
    }

    /// Hold an answer that is the last item of its leaf, where the tree goes on past that leaf,
    /// to the item after it.
    ///
    /// A descent steers by the keys a node records for its children and checks only the
    /// children it enters. A key for the block after the one entered that sits above that
    /// block's own first item steers a search for a key between the two into the block before,
    /// and the answer is that block's last item — a real item, verified, and not the last at
    /// or before the key. Stepping on to the next item enters the block after through every
    /// guard a descent applies, which is what holds its first key to the key its parent
    /// records for it. Only an answer that is the last item of its leaf can have been steered
    /// that way, so only that answer pays for the step.
    fn confirm_last(&mut self, answer: &DiskKey, key: &DiskKey) -> Result<(), ReadError> {
        let mut next = None;
        self.for_each_item_from(*answer, |item, _| {
            if item == answer {
                return true;
            }
            next = Some(*item);
            false
        })?;
        if next.is_some_and(|next| next <= *key) {
            return Err(ReadError::BadTreeBlock {
                logical: self.root.bytenr,
                fault: "a search for a key passed over an item at or before it",
            });
        }
        Ok(())
    }

    /// The child at `index` of `parent`, with every guard a descent applies to one, and the
    /// bound the child's own children sit below.
    ///
    /// Five of them, and each catches something the others cannot: an address already visited
    /// is a tree that is not one, a block from another transaction than the pointer records is
    /// not the committed one, a child that is not exactly one level below its parent is a
    /// descent with no decreasing measure, a leaf whose items are not packed hands back one
    /// record's bytes under another record's key, and keys out of order or out of the place
    /// the parent's keys give them steer a search past what the tree holds. Every descent in
    /// this module goes through here so that none of the five can be forgotten in one of them.
    ///
    /// `below` is the bound `parent` itself sits under — the key its own parent records for
    /// the block after it, or none at the right edge of the tree.
    fn child_of(
        &mut self,
        parent: &TreeBlock,
        below: Option<DiskKey>,
        index: usize,
        visited: &mut BTreeSet<u64>,
    ) -> Result<(TreeBlock, Option<DiskKey>), ReadError> {
        let level = parent.header().level;
        let pointer = parent.key_ptr(index)?;
        let child_at = pointer.blockptr;
        if !visited.insert(child_at) {
            return Err(ReadError::TreeCycle { logical: child_at });
        }
        // The child's upper bound is the parent's key for the block after it, or, for the
        // last child, the parent's own.
        let child_below = if index + 1 < parent.count()? {
            Some(parent.key_ptr(index + 1)?.key)
        } else {
            below
        };
        let child = self.volume.read_tree_block(child_at, pointer.generation)?;
        // A child exactly one level below its parent is what makes a descent terminate
        // whatever the addresses say, and it is a separate guard from the visited set rather
        // than a cheaper version of it: a crafted tree can point at a fresh block at every step
        // and still never reach a leaf.
        if u16::from(child.header().level) + 1 != u16::from(level) {
            return Err(ReadError::BadTreeLevel {
                logical: child_at,
                level: child.header().level,
                parent: level,
            });
        }
        child.check_leaf_packing()?;
        child.check_keys(Some(pointer.key), child_below)?;
        Ok((child, child_below))
    }

    /// How many items the tree holds, having read and verified every block on the way.
    ///
    /// # Errors
    ///
    /// As [`for_each_item`](Self::for_each_item).
    pub fn count_items(&mut self) -> Result<u64, ReadError> {
        let mut items = 0u64;
        self.for_each_item(|_, _| {
            items += 1;
            true
        })?;
        Ok(items)
    }

    /// The tree's top block, checked against what the root item said it would be, and checked
    /// as every block below it is.
    ///
    /// The level and the transaction are each recorded in two places — the root item and the
    /// block's own header — and holding them against each other is what catches a root item
    /// pointing at a block that is not the one it describes.
    fn read_root(&mut self) -> Result<TreeBlock, ReadError> {
        let block = self
            .volume
            .read_tree_block(self.root.bytenr, self.root.generation)?;
        if block.header().level != self.root.level {
            return Err(ReadError::BadTreeLevel {
                logical: self.root.bytenr,
                level: block.header().level,
                parent: self.root.level,
            });
        }
        block.check_leaf_packing()?;
        block.check_keys(None, None)?;
        Ok(block)
    }

    /// The one descent, which every public form above is a wrapper over.
    ///
    /// A depth-first walk with an explicit stack: each frame is a block and how far through it
    /// the walk has got. A block enters the stack at the entry `from` selects, so a walk from
    /// a key descends straight to it and a walk from [`DiskKey::MIN`] starts every block at
    /// zero.
    fn drive(
        &mut self,
        from: DiskKey,
        on_block: &mut dyn FnMut(&TreeBlock) -> bool,
        on_item: &mut dyn FnMut(&DiskKey, &[u8]) -> bool,
    ) -> Result<(), ReadError> {
        let limit = self.volume.walk_limit();
        let mut visited = BTreeSet::new();
        visited.insert(self.root.bytenr);

        let root = self.read_root()?;
        if !on_block(&root) {
            return Ok(());
        }
        let start = start_index(&root, &from)?;
        // Each frame is a block, how far through it the walk has got, and the bound its keys
        // sit below. Every key a walk passes was held against its neighbours and against that
        // bound when its block was read, so the order the items come out in is the tree's.
        let mut stack = vec![(root, start, None)];
        let mut visits = 0usize;

        while let Some(top) = stack.len().checked_sub(1) {
            let count = stack[top].0.count()?;
            let index = stack[top].1;
            if index >= count {
                stack.pop();
                continue;
            }
            stack[top].1 += 1;

            if stack[top].0.header().is_leaf() {
                let key = stack[top].0.item(index)?.key;
                let data = stack[top].0.item_data(index)?;
                if !on_item(&key, data) {
                    return Ok(());
                }
                // Counted once taken: the item that ends a range — the first record past a
                // directory, to a listing of it — is read to find the end and is not one the
                // range holds, so a range of exactly the cap is inside it.
                visits += 1;
                if visits > limit {
                    return Err(ReadError::TooManyEntries {
                        objectid: self.root.objectid,
                        limit,
                    });
                }
                continue;
            }

            let (child, below) = {
                let (parent, _, below) = &stack[top];
                self.child_of(parent, *below, index, &mut visited)?
            };
            if !on_block(&child) {
                return Ok(());
            }
            let start = start_index(&child, &from)?;
            stack.push((child, start, below));
        }
        Ok(())
    }
}

/// Where in `block` a walk from `from` begins.
///
/// For a **leaf** it is the first item at or after the key, so items below it are skipped. For
/// a **node** it is the last child whose key is at or below it, since that child's subtree is
/// where the key would be — and a node whose every key is above `from` starts at its first
/// child.
///
/// Computed for every block rather than only for the leftmost path, which is the same answer
/// and one fewer piece of state: a block entirely above `from` has no key at or below it, so
/// the binary search lands on zero on its own.
///
/// The search is bounded whatever the block holds, so a block whose keys are not sorted
/// answers with a wrong index and never with one outside the block. That a block is sorted is
/// checked when a descent reaches it, before any search over it.
fn start_index(block: &TreeBlock, from: &DiskKey) -> Result<usize, ReadError> {
    if *from == DiskKey::MIN {
        return Ok(0);
    }
    // A leaf counts the entries strictly below the key, since that is the first one to visit.
    // A node counts those at or below it and steps back one, to the child whose subtree is
    // where the key would be — and a node whose every key is above `from` steps back from
    // zero, which is its first child.
    let leaf = block.header().is_leaf();
    let at = partition(block, from, !leaf)?;
    Ok(if leaf { at } else { at.saturating_sub(1) })
}

/// How many of `block`'s entries sort below `from`, counting one equal to it where `inclusive`.
///
/// The one binary search over a block, in the two readings a descent needs of it. It is bounded
/// whatever the block holds, so a block whose keys are not sorted answers with a wrong index
/// and never with one outside the block. That a block is sorted is checked when a descent
/// reaches it, before any search over it.
fn partition(block: &TreeBlock, from: &DiskKey, inclusive: bool) -> Result<usize, ReadError> {
    let leaf = block.header().is_leaf();
    let (mut lo, mut hi) = (0usize, block.count()?);
    while lo < hi {
        let mid = lo + (hi - lo) / 2;
        let key = if leaf {
            block.item(mid)?.key
        } else {
            block.key_ptr(mid)?.key
        };
        let below = if inclusive { key <= *from } else { key < *from };
        if below { lo = mid + 1 } else { hi = mid }
    }
    Ok(lo)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::btrfs::forge::{
        CHUNK_LENGTH, CHUNK_LOGICAL, FIRST_FREE_AT, Forge, NODE_SIZE, ROOT_TREE_AT, leaf, node,
        seal,
    };
    use crate::btrfs::ondisk::{Header, Item, ItemType, objectid};
    use crate::{Limits, OpenOptions};

    /// A key in the root tree's own namespace, so a forged tree sorts the way a real one does.
    fn key(n: u64) -> DiskKey {
        DiskKey::new(n, ItemType::ROOT_ITEM, 0)
    }

    /// A leaf of `n` items, each carrying its own number as a byte.
    fn items(range: std::ops::Range<u64>) -> Vec<(DiskKey, Vec<u8>)> {
        range.map(|n| (key(n), vec![n as u8; 8])).collect()
    }

    /// Every key a walk of `forge`'s root tree visits.
    fn walk(forge: &Forge) -> Result<Vec<DiskKey>, ReadError> {
        let mut volume = Volume::open(forge.source())?;
        let root = volume.root_tree();
        let mut keys = Vec::new();
        volume.tree(root).for_each_item(|k, _| {
            keys.push(*k);
            true
        })?;
        Ok(keys)
    }

    #[test]
    fn a_walk_visits_every_item_of_a_tree_in_key_order() {
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..40));
        assert_eq!(
            walk(&forge).expect("a well-formed tree"),
            items(1..40).iter().map(|(k, _)| *k).collect::<Vec<_>>()
        );
    }

    #[test]
    fn a_walk_descends_through_a_node_and_reaches_every_leaf_below_it() {
        // Two leaves under one node, which is the smallest tree that exercises a descent at
        // all — a one-leaf tree never reads a child pointer.
        let mut forge = Forge::new();
        let (left, right) = (FIRST_FREE_AT, FIRST_FREE_AT + NODE_SIZE as u64);
        forge
            .block(left, &leaf(left, objectid::ROOT_TREE, &items(1..10)))
            .block(right, &leaf(right, objectid::ROOT_TREE, &items(10..20)))
            .root_node(1, &[(key(1), left), (key(10), right)]);
        assert_eq!(walk(&forge).expect("a well-formed tree").len(), 19);
    }

    #[test]
    fn a_seek_lands_where_a_walk_of_the_whole_tree_would_have_reached() {
        // The property the descent's start index exists for, over a tree deep enough that the
        // choice of child matters. Every key present is probed, and so is one below and one
        // above each — the three places an off-by-one in the binary search would show.
        let mut forge = Forge::new();
        let (left, right) = (FIRST_FREE_AT, FIRST_FREE_AT + NODE_SIZE as u64);
        forge
            .block(left, &leaf(left, objectid::ROOT_TREE, &items(10..20)))
            .block(right, &leaf(right, objectid::ROOT_TREE, &items(20..30)))
            .root_node(1, &[(key(10), left), (key(20), right)]);

        let mut volume = Volume::open(forge.source()).expect("a well-formed filesystem");
        let root = volume.root_tree();
        let all: Vec<DiskKey> = (10..30).map(key).collect();
        for probe in (5..35).map(key) {
            let expected: Vec<DiskKey> = all.iter().copied().filter(|k| *k >= probe).collect();
            let mut got = Vec::new();
            volume
                .tree(root)
                .for_each_item_from(probe, |k, _| {
                    got.push(*k);
                    true
                })
                .expect("a well-formed tree");
            assert_eq!(got, expected, "seeking to {probe:?}");
            assert_eq!(
                volume
                    .tree(root)
                    .find_first(probe)
                    .expect("search")
                    .map(|f| f.key),
                expected.first().copied()
            );
        }
        // And the exact form answers only where the key is genuinely there.
        assert!(
            volume
                .tree(root)
                .find_exact(key(15))
                .expect("search")
                .is_some()
        );
        assert!(
            volume
                .tree(root)
                .find_exact(key(35))
                .expect("search")
                .is_none()
        );
    }

    #[test]
    fn a_block_reached_twice_is_a_tree_that_is_not_one() {
        // Two child pointers naming one leaf. Not a cycle in the strict sense and the same
        // defect: a walk would visit its items twice, and the key-order check would then fire
        // for a reason that says nothing about what is wrong.
        let mut forge = Forge::new();
        let leaf_at = FIRST_FREE_AT;
        forge
            .block(leaf_at, &leaf(leaf_at, objectid::ROOT_TREE, &items(1..10)))
            .root_node(1, &[(key(1), leaf_at), (key(10), leaf_at)]);
        assert!(matches!(
            walk(&forge),
            Err(ReadError::TreeCycle { logical }) if logical == leaf_at
        ));

        // And a node naming itself, which the same guard catches before the block is read at
        // all — the root's own address is in the visited set from the start.
        let mut forge = Forge::new();
        forge.root_node(1, &[(key(1), ROOT_TREE_AT)]);
        assert!(matches!(
            walk(&forge),
            Err(ReadError::TreeCycle { logical }) if logical == ROOT_TREE_AT
        ));
    }

    #[test]
    fn a_child_that_is_not_one_level_below_its_parent_is_refused() {
        // The guard that makes a descent terminate whatever the addresses say: a crafted tree
        // can name a fresh block at every step, so the visited set alone is not a bound.
        for child_level in [0u8, 2, 3] {
            if child_level == 1 {
                continue;
            }
            let mut forge = Forge::new();
            let child = FIRST_FREE_AT;
            let block = if child_level == 0 {
                leaf(child, objectid::ROOT_TREE, &items(1..4))
            } else {
                node(
                    child,
                    objectid::ROOT_TREE,
                    child_level,
                    &[(key(1), FIRST_FREE_AT + NODE_SIZE as u64)],
                )
            };
            forge.block(child, &block).root_node(2, &[(key(1), child)]);
            match walk(&forge) {
                Err(ReadError::BadTreeLevel { level, parent, .. }) => {
                    assert_eq!((level, parent), (child_level, 2));
                }
                other => panic!("a level-{child_level} child under a level-2 node: {other:?}"),
            }
        }
    }

    #[test]
    fn a_root_block_that_is_not_the_height_its_root_item_claimed_is_refused() {
        // The level is recorded twice — in the root item and in the block's own header — and
        // holding them against each other is what catches a root item pointing at a block
        // that is not the one it describes.
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..4));
        forge.amend_superblock(0, |sb| sb.root_level = 1);
        assert!(matches!(
            walk(&forge),
            Err(ReadError::BadTreeLevel {
                level: 0,
                parent: 1,
                ..
            })
        ));
    }

    #[test]
    fn a_header_that_does_not_describe_the_block_it_sits_in_is_refused() {
        // Three claims a header makes about its own block, each checked against something
        // outside the header. None is a fault a checksum can catch: every one of these fields
        // is inside what the checksum covers, so a block written correctly somewhere else, or
        // for another filesystem, verifies perfectly.
        //
        // They are one gate because the damage differs and nothing else does — the crafted
        // block, the walk, and the shape of the refusal are the same three lines in each.
        /// What a row damages about a header, and the word its refusal must carry.
        type Fault = (&'static str, Box<dyn Fn(&mut Header)>);

        let faults: [Fault; 3] = [
            (
                "room",
                Box::new(|header: &mut Header| {
                    header.nritems = (NODE_SIZE / Item::SIZE + 1) as u32;
                }),
            ),
            (
                "logical address",
                Box::new(|header: &mut Header| header.bytenr = CHUNK_LOGICAL),
            ),
            (
                "another filesystem",
                Box::new(|header: &mut Header| header.fsid = [0x99; 16]),
            ),
        ];
        for (expected, damage) in faults {
            let mut forge = Forge::new();
            forge.root_leaf(&items(1..4));
            forge.amend(ROOT_TREE_AT, |block| {
                let mut header = Header::read_from(block).expect("a header");
                damage(&mut header);
                header.write_to(block);
            });
            match walk(&forge) {
                Err(ReadError::BadTreeBlock { fault, .. }) => {
                    assert!(fault.contains(expected), "{fault}");
                }
                other => panic!("a header claiming the wrong {expected}: {other:?}"),
            }
        }
    }

    #[test]
    fn an_item_whose_data_escapes_its_leaf_is_refused_in_both_directions() {
        // Asked of the block directly rather than through a walk, and deliberately: a walk
        // checks the leaf's packing before it reads an item, and packing already implies an
        // item cannot end past the block. What it does not imply is that the data stays out
        // of the array describing it — and a caller holding a block from `read_block` has had
        // neither check made for it, which is the path these two guards are on.
        /// What a row damages about an item, and the word its refusal must carry.
        type Escape = (&'static str, Box<dyn Fn(&mut Item)>);

        let cases: [Escape; 3] = [
            ("array", Box::new(|item: &mut Item| item.offset = 0)),
            (
                "block",
                Box::new(|item: &mut Item| item.size = NODE_SIZE as u32),
            ),
            (
                "block",
                Box::new(|item: &mut Item| {
                    item.offset = u32::MAX;
                    item.size = u32::MAX;
                }),
            ),
        ];
        for (expected, damage) in cases {
            let mut forge = Forge::new();
            forge.root_leaf(&items(1..4));
            forge.amend(ROOT_TREE_AT, |block| {
                let mut item = Item::read_from(&block[Header::SIZE..]).expect("an item");
                damage(&mut item);
                item.write_to(&mut block[Header::SIZE..]);
            });
            let mut volume = Volume::open(forge.source()).expect("a well-formed filesystem");
            let block = volume.read_block(ROOT_TREE_AT).expect("the block verifies");
            match block.item_data(0) {
                Err(ReadError::BadItem {
                    fault, index: 0, ..
                }) => {
                    assert!(fault.contains(expected), "{fault}");
                }
                other => panic!("an item escaping its leaf toward the {expected}: {other:?}"),
            }
        }
    }

    #[test]
    fn a_leaf_whose_data_has_been_moved_with_its_offsets_is_refused() {
        // Every item stays inside the block and every item points at bytes that are not its
        // own, so no bound notices — what does is the format's own packing rule, that one
        // item's data ends where the next one's begins. The baseline's corruptor has a switch
        // for exactly this shape, and it is what found the check missing.
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..6));
        forge.amend(ROOT_TREE_AT, |block| {
            let at = Header::SIZE + 2 * Item::SIZE;
            let mut third = Item::read_from(&block[at..]).expect("an item");
            third.offset -= 16;
            third.write_to(&mut block[at..]);
        });
        assert!(matches!(
            walk(&forge),
            Err(ReadError::BadItem { fault, index: 2, .. })
                if fault.contains("does not end where the item before it begins")
        ));

        // And the first item is bounded by the end of the block rather than by a neighbour,
        // which is the case a rule written only about neighbours would miss.
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..6));
        forge.amend(ROOT_TREE_AT, |block| {
            let mut first = Item::read_from(&block[Header::SIZE..]).expect("an item");
            first.size -= 1;
            first.write_to(&mut block[Header::SIZE..]);
        });
        assert!(matches!(
            walk(&forge),
            Err(ReadError::BadItem { index: 0, .. })
        ));
    }

    #[test]
    fn a_block_from_another_transaction_than_its_pointer_records_is_refused() {
        use crate::btrfs::forge::GENERATION;
        use crate::btrfs::ondisk::KeyPtr;

        // The root block of a tree records another transaction than the root item does. Its
        // checksum, its address and its filesystem all verify, which is exactly what a block
        // left at an address since written again looks like.
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..6));
        forge.amend(ROOT_TREE_AT, |block| {
            let mut header = Header::read_from(block).expect("a header");
            header.generation = 9999;
            header.write_to(block);
        });
        assert!(matches!(
            walk(&forge),
            Err(ReadError::WrongGeneration { logical, generation: 9999, expected })
                if logical == ROOT_TREE_AT && expected == GENERATION
        ));

        // A parent's pointer records another transaction than the child carries. The walk and
        // both forms of lookup reach the child through that pointer, and each refuses it.
        let mut forge = Forge::new();
        let (left, right) = (FIRST_FREE_AT, FIRST_FREE_AT + NODE_SIZE as u64);
        forge
            .block(left, &leaf(left, objectid::ROOT_TREE, &items(1..10)))
            .block(right, &leaf(right, objectid::ROOT_TREE, &items(10..20)))
            .root_node(1, &[(key(1), left), (key(10), right)]);
        forge.amend(ROOT_TREE_AT, |block| {
            let at = Header::SIZE + KeyPtr::SIZE;
            let mut pointer = KeyPtr::read_from(&block[at..]).expect("a pointer");
            pointer.generation = 9999;
            pointer.write_to(&mut block[at..]);
        });
        let stale = |r: Result<_, ReadError>| {
            matches!(
                r,
                Err(ReadError::WrongGeneration { logical, generation, expected: 9999 })
                    if logical == right && generation == GENERATION
            )
        };
        assert!(stale(walk(&forge).map(|_| ())));
        let mut volume = Volume::open(forge.source()).expect("the filesystem opens");
        let root = volume.root_tree();
        assert!(stale(volume.tree(root).find_first(key(15)).map(|_| ())));
        assert!(stale(
            volume.tree(root).find_at_or_before(key(15)).map(|_| ())
        ));
        // The left child's pointer is sound, and what sits under it still reads.
        assert!(
            volume
                .tree(root)
                .find_exact(key(5))
                .expect("search")
                .is_some()
        );
    }

    #[test]
    fn a_node_key_that_does_not_match_the_block_it_leads_to_is_refused_on_every_path() {
        // A node's keys are what a search steers by, and a checksum covers a wrong one as
        // faithfully as a right one. A walk of every block in order meets every item whatever
        // the node's keys say, so a check made only where a walk passes each item certifies a
        // tree whose lookups miss what it holds. Each shape here is refused by the walk and by
        // both forms of lookup alike.
        let (left, right) = (FIRST_FREE_AT, FIRST_FREE_AT + NODE_SIZE as u64);
        // Each shape, and a key whose lookup reaches the block at fault.
        type Shape = (&'static str, std::ops::Range<u64>, [DiskKey; 2], DiskKey);
        let shapes: [Shape; 4] = [
            (
                "the node's keys are out of order",
                1..10,
                [key(10), DiskKey::MIN],
                key(15),
            ),
            (
                "the key for the right child is below its first key",
                1..10,
                [key(1), key(9)],
                key(15),
            ),
            (
                "the key for the right child is above its first key",
                1..10,
                [key(1), key(11)],
                key(15),
            ),
            (
                "the left child reaches the key the node records for the right one",
                1..12,
                [key(1), key(10)],
                key(5),
            ),
        ];
        for (what, left_items, [first, second], reaches) in shapes {
            let held: Vec<u64> = left_items.clone().chain(10..20).collect();
            let mut forge = Forge::new();
            forge
                .block(left, &leaf(left, objectid::ROOT_TREE, &items(left_items)))
                .block(right, &leaf(right, objectid::ROOT_TREE, &items(10..20)))
                .root_node(1, &[(first, left), (second, right)]);
            let refused =
                |r: Result<(), ReadError>| matches!(r, Err(ReadError::BadTreeBlock { .. }));
            assert!(refused(walk(&forge).map(|_| ())), "{what}: the walk");
            let mut volume = Volume::open(forge.source()).expect("the filesystem opens");
            let root = volume.root_tree();
            for probe in [5, 10, 15] {
                // A lookup that steers clear of the faulty child is a lookup the fault does
                // not affect, and answers what the tree holds; one that reaches it must refuse
                // it, never answer from it. An answer is held to the items the blocks hold, so
                // a lookup the wrong key steers past an item answers wrongly and fails here.
                let truths = [
                    (
                        "find_first",
                        held.iter().copied().filter(|n| *n >= probe).min(),
                    ),
                    (
                        "find_at_or_before",
                        held.iter().copied().filter(|n| *n <= probe).max(),
                    ),
                ];
                for (form, truth) in truths {
                    let answer = if form == "find_first" {
                        volume.tree(root).find_first(key(probe))
                    } else {
                        volume.tree(root).find_at_or_before(key(probe))
                    };
                    match answer {
                        Ok(found) => assert_eq!(
                            found.map(|located| located.key),
                            truth.map(key),
                            "{what}: {form} {probe} answered other than the tree holds"
                        ),
                        Err(e) => assert!(
                            refused(Err(e)),
                            "{what}: {form} {probe} failed some other way"
                        ),
                    }
                }
            }
            assert!(
                refused(volume.tree(root).find_first(reaches).map(|_| ())),
                "{what}: a lookup that reaches the block at fault"
            );
        }

        // The control: the same tree with the node's keys each the first key of the block it
        // leads to, read whole and searched, agrees with itself.
        let mut forge = Forge::new();
        forge
            .block(left, &leaf(left, objectid::ROOT_TREE, &items(1..10)))
            .block(right, &leaf(right, objectid::ROOT_TREE, &items(10..20)))
            .root_node(1, &[(key(1), left), (key(10), right)]);
        assert_eq!(walk(&forge).expect("a well-formed tree").len(), 19);
    }

    #[test]
    fn a_tree_whose_keys_are_not_in_order_is_refused_rather_than_searched_wrongly() {
        // A binary search over unsorted keys silently misses items instead of failing, so a
        // block whose keys are not sorted is refused when a descent reaches it, before any
        // search over it.
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..6));
        forge.amend(ROOT_TREE_AT, |block| {
            let mut second = Item::read_from(&block[Header::SIZE + Item::SIZE..]).expect("an item");
            second.key = key(0);
            second.write_to(&mut block[Header::SIZE + Item::SIZE..]);
        });
        assert!(matches!(
            walk(&forge),
            Err(ReadError::BadTreeBlock { fault, .. }) if fault.contains("above the one before")
        ));

        // Two items under one key is the same defect at its boundary: a tree's keys are
        // unique, and a search that found one of them would never see the other.
        let mut forge = Forge::new();
        forge.root_leaf(&[(key(1), vec![1; 8]), (key(1), vec![2; 8])]);
        assert!(matches!(walk(&forge), Err(ReadError::BadTreeBlock { .. })));
    }

    #[test]
    fn a_block_whose_checksum_no_longer_covers_it_is_refused_wherever_it_sits() {
        for at in [ROOT_TREE_AT, CHUNK_LOGICAL] {
            let mut forge = Forge::new();
            forge.root_leaf(&items(1..4));
            forge.break_checksum(at);
            let opened = Volume::open(forge.source()).and_then(|mut v| {
                let root = v.root_tree();
                v.tree(root).count_items()
            });
            assert!(
                matches!(
                    &opened,
                    Err(ReadError::BadChecksum {
                        object: "tree block",
                        ..
                    })
                ),
                "a damaged block at {at}: {opened:?}"
            );
        }
    }

    #[test]
    fn a_block_at_an_address_no_chunk_maps_is_refused_rather_than_read_from_nowhere() {
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..4));
        // Past the end of the one chunk, which is the address space this filesystem has.
        forge.amend_superblock(0, |sb| sb.root = CHUNK_LOGICAL + CHUNK_LENGTH);
        assert!(matches!(
            walk(&forge),
            Err(ReadError::UnmappedLogical { .. })
        ));
    }

    #[test]
    fn a_walk_stops_at_the_cap_the_caller_set_rather_than_gathering_past_it() {
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..40));
        let options = OpenOptions::new().limits(Limits::new().max_walk_entries(10));
        let mut volume =
            Volume::open_with(forge.source(), options).expect("a well-formed filesystem");
        let root = volume.root_tree();
        assert!(matches!(
            volume.tree(root).count_items(),
            Err(ReadError::TooManyEntries { limit: 10, .. })
        ));
        // Exactly at the cap is inside it: a bound that refused the last entry it allowed
        // would be off by one in the direction that refuses healthy filesystems.
        let options = OpenOptions::new().limits(Limits::new().max_walk_entries(39));
        let mut volume =
            Volume::open_with(forge.source(), options).expect("a well-formed filesystem");
        let root = volume.root_tree();
        assert_eq!(volume.tree(root).count_items().expect("within the cap"), 39);
        // The item that ends a range is not one the range takes: a visit that takes exactly
        // the cap's worth and declines the next — a directory listing meeting the first record
        // past the directory — is inside the cap, and one that takes the next is past it.
        let options = OpenOptions::new().limits(Limits::new().max_walk_entries(10));
        let mut volume =
            Volume::open_with(forge.source(), options).expect("a well-formed filesystem");
        let root = volume.root_tree();
        let mut taken = 0;
        volume
            .tree(root)
            .for_each_item(|_, _| {
                if taken == 10 {
                    return false;
                }
                taken += 1;
                true
            })
            .expect("ten taken, and the eleventh declined");
        assert_eq!(taken, 10);
        let mut taken = 0;
        assert!(matches!(
            volume.tree(root).for_each_item(|_, _| {
                taken += 1;
                taken <= 11
            }),
            Err(ReadError::TooManyEntries { limit: 10, .. })
        ));
    }

    #[test]
    fn a_visit_that_says_to_stop_stops_where_it_said() {
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..40));
        let mut volume = Volume::open(forge.source()).expect("a well-formed filesystem");
        let root = volume.root_tree();
        let mut seen = 0;
        volume
            .tree(root)
            .for_each_item(|_, _| {
                seen += 1;
                seen < 3
            })
            .expect("a well-formed tree");
        assert_eq!(seen, 3);
    }

    #[test]
    fn every_block_of_a_tree_is_offered_to_a_block_walk_including_its_nodes() {
        let mut forge = Forge::new();
        let (left, right) = (FIRST_FREE_AT, FIRST_FREE_AT + NODE_SIZE as u64);
        forge
            .block(left, &leaf(left, objectid::ROOT_TREE, &items(1..10)))
            .block(right, &leaf(right, objectid::ROOT_TREE, &items(10..20)))
            .root_node(1, &[(key(1), left), (key(10), right)]);
        let mut volume = Volume::open(forge.source()).expect("a well-formed filesystem");
        let root = volume.root_tree();
        let mut blocks = Vec::new();
        volume
            .tree(root)
            .for_each_block(|block| {
                blocks.push((block.header().bytenr, block.header().level));
                true
            })
            .expect("a well-formed tree");
        assert_eq!(blocks, vec![(ROOT_TREE_AT, 1), (left, 0), (right, 0)]);
    }

    #[test]
    fn a_forged_filesystem_is_one_the_reader_accepts_before_it_is_damaged() {
        // What makes every gate above a negative control rather than a test of a broken
        // fixture: the same filesystem, undamaged, opens and reads.
        let mut forge = Forge::new();
        forge.root_leaf(&items(1..40));
        let mut volume = Volume::open(forge.source()).expect("a well-formed filesystem");
        assert_eq!(volume.superblock().nodesize as usize, NODE_SIZE);
        assert_eq!(volume.chunk_map().len(), 1);
        let root = volume.root_tree();
        assert_eq!(
            volume.tree(root).count_items().expect("a well-formed tree"),
            39
        );
        // And the seal the forge applies is the format's own recipe, not a second spelling of
        // it: a block resealed by hand verifies exactly as one the forge wrote does.
        let mut block = leaf(FIRST_FREE_AT, objectid::ROOT_TREE, &items(1..4));
        block[Header::SIZE] ^= 0xff;
        seal(&mut block);
        forge.block(FIRST_FREE_AT, &block);
        let mut volume = Volume::open(forge.source()).expect("a well-formed filesystem");
        assert!(volume.read_block(FIRST_FREE_AT).is_ok());
    }
}