redoxfs 0.9.0

The Redox Filesystem
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
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
use alloc::{
    boxed::Box,
    collections::{BTreeMap, VecDeque},
    vec::Vec,
};
use core::{
    cmp::min,
    mem,
    ops::{Deref, DerefMut},
};
use syscall::error::{
    Error, Result, EEXIST, EINVAL, EIO, EISDIR, ENOENT, ENOSPC, ENOTDIR, ENOTEMPTY, ERANGE,
};

use crate::{
    htree::{self, HTreeHash, HTreeNode, HTreePtr},
    AllocEntry, AllocList, Allocator, BlockAddr, BlockData, BlockLevel, BlockMeta, BlockPtr,
    BlockTrait, DirEntry, DirList, Disk, FileSystem, Header, Node, NodeFlags, NodeLevel,
    NodeLevelData, RecordRaw, ReleaseList, TreeData, TreePtr, ALLOC_GC_THRESHOLD,
    ALLOC_LIST_ENTRIES, DIR_ENTRY_MAX_LENGTH, HEADER_RING,
};

pub(crate) fn level_data(node: &TreeData<Node>) -> Result<&NodeLevelData> {
    node.data().level_data().ok_or_else(|| {
        #[cfg(feature = "log")]
        log::error!("LEVEL_DATA: NODE HAS INLINE DATA");
        Error::new(EIO)
    })
}

pub(crate) fn level_data_mut(node: &mut TreeData<Node>) -> Result<&mut NodeLevelData> {
    node.data_mut().level_data_mut().ok_or_else(|| {
        #[cfg(feature = "log")]
        log::error!("LEVEL_DATA_MUT: NODE HAS INLINE DATA");
        Error::new(EIO)
    })
}

pub trait AllocCtx {
    fn allocate(&mut self, _addr: BlockAddr) {}
    fn deallocate(&mut self, _addr: BlockAddr) {}
}

pub struct FsCtx;
impl AllocCtx for FsCtx {}

impl AllocCtx for TreeData<Node> {
    fn allocate(&mut self, addr: BlockAddr) {
        let blocks = self.data().blocks();
        self.data_mut().set_blocks(
            blocks
                .checked_add(addr.level().blocks::<u64>())
                .expect("node block count overflow"),
        );
    }

    fn deallocate(&mut self, addr: BlockAddr) {
        let blocks = self.data().blocks();
        self.data_mut().set_blocks(
            blocks
                .checked_sub(addr.level().blocks::<u64>())
                .expect("node block count underflow"),
        );
    }
}

pub struct Transaction<'a, D: Disk> {
    fs: &'a mut FileSystem<D>,
    //TODO: make private
    pub header: Header,
    //TODO: make private
    pub header_changed: bool,
    pub(crate) allocator: Allocator,
    allocator_log: VecDeque<AllocEntry>,
    deallocate: Vec<BlockAddr>,
    pub(crate) write_cache: BTreeMap<BlockAddr, Box<[u8]>>,
}

impl<'a, D: Disk> Transaction<'a, D> {
    pub(crate) fn new(fs: &'a mut FileSystem<D>) -> Self {
        let header = fs.header;
        let allocator = fs.allocator.clone();
        Self {
            fs,
            header,
            header_changed: false,
            allocator,
            allocator_log: VecDeque::new(),
            deallocate: Vec::new(),
            write_cache: BTreeMap::new(),
        }
    }

    pub fn commit(mut self, squash: bool) -> Result<()> {
        self.sync(squash)?;
        self.fs.header = self.header;
        self.fs.allocator = self.allocator;
        Ok(())
    }

    //
    // MARK: block operations
    //

    /// Allocate a new block of size defined by `meta`, returning its address.
    /// - returns `Err(ENOSPC)` if a block of this size could not be alloated.
    /// - unsafe because order must be done carefully and changes must be flushed to disk
    pub(crate) unsafe fn allocate(
        &mut self,
        ctx: &mut dyn AllocCtx,
        meta: BlockMeta,
    ) -> Result<BlockAddr> {
        match self.allocator.allocate(meta) {
            Some(addr) => {
                self.allocator_log.push_back(AllocEntry::allocate(addr));
                ctx.allocate(addr);
                Ok(addr)
            }
            None => Err(Error::new(ENOSPC)),
        }
    }

    /// Deallocate the given block.
    /// - unsafe because order must be done carefully and changes must be flushed to disk
    pub(crate) unsafe fn deallocate(&mut self, ctx: &mut dyn AllocCtx, addr: BlockAddr) {
        //TODO: should we use some sort of not-null abstraction?
        assert!(!addr.is_null());

        // Remove from write_cache if it is there, since it no longer needs to be written
        //TODO: for larger blocks do we need to check for sub-blocks in here?
        self.write_cache.remove(&addr);

        // Search and remove the last matching entry in allocator_log
        let mut found = false;
        for i in (0..self.allocator_log.len()).rev() {
            let entry = self.allocator_log[i];
            if entry.index() == addr.index() && entry.count() == -addr.level().blocks::<i64>() {
                found = true;
                self.allocator_log.remove(i);
                break;
            }
        }

        if found {
            // Deallocate immediately since it is an allocation that was not needed
            self.allocator.deallocate(addr);
        } else {
            // Deallocate later when syncing filesystem, to avoid re-use
            self.deallocate.push(addr);
        }
        ctx.deallocate(addr);
    }

    unsafe fn deallocate_block<T: BlockTrait>(
        &mut self,
        ctx: &mut dyn AllocCtx,
        ptr: BlockPtr<T>,
    ) -> bool {
        if !ptr.is_null() {
            self.deallocate(ctx, ptr.addr());
            true
        } else {
            false
        }
    }

    /// Drain `self.allocator_log` and `self.deallocate`,
    /// updating the [`AllocList`] with the resulting state.
    ///
    /// This method does not write anything to disk,
    /// all writes are cached.
    ///
    /// To keep the allocator log from growing excessively, it will
    /// periodically be fully rebuilt using the state of `self.allocator`.
    /// This rebuild can be forced by setting `force_squash` to `true`.
    fn sync_allocator(&mut self, force_squash: bool) -> Result<bool> {
        let mut prev_ptr = BlockPtr::default();
        let should_gc = self.header.generation() % ALLOC_GC_THRESHOLD == 0
            && self.header.generation() >= ALLOC_GC_THRESHOLD
            && self.allocator.free() > 0;
        if force_squash || should_gc {
            // Clear and rebuild alloc log
            self.allocator_log.clear();
            let levels = self.allocator.levels();
            for level in (0..levels.len()).rev() {
                let count = (1 << level) as i64;
                'indexs: for &index in levels[level].iter() {
                    for entry in self.allocator_log.iter_mut() {
                        if index + count as u64 == entry.index() {
                            // New entry is at start of existing entry
                            *entry = AllocEntry::new(index, count + entry.count());
                            continue 'indexs;
                        } else if entry.index() + entry.count() as u64 == index {
                            // New entry is at end of existing entry
                            *entry = AllocEntry::new(entry.index(), entry.count() + count);
                            continue 'indexs;
                        }
                    }

                    self.allocator_log.push_back(AllocEntry::new(index, count));
                }
            }

            // Prepare to deallocate old alloc blocks
            let mut alloc_ptr = self.header.alloc;
            while !alloc_ptr.is_null() {
                let alloc = self.read_block(alloc_ptr)?;
                self.deallocate.push(alloc.addr());
                alloc_ptr = alloc.data().prev;
            }
        } else {
            // Return if there are no log changes
            if self.allocator_log.is_empty() && self.deallocate.is_empty() {
                return Ok(false);
            }

            // Push old alloc block to front of allocator log
            //TODO: just skip this if it is already full?
            let alloc = self.read_block(self.header.alloc)?;
            for i in (0..alloc.data().entries.len()).rev() {
                let entry = alloc.data().entries[i];
                if !entry.is_null() {
                    self.allocator_log.push_front(entry);
                }
            }

            // Prepare to deallocate old alloc block
            self.deallocate.push(alloc.addr());

            // Link to previous alloc block
            prev_ptr = alloc.data().prev;
        }

        // Allocate required blocks, including CoW of current alloc tail
        let mut new_blocks = Vec::new();
        while new_blocks.len() * ALLOC_LIST_ENTRIES
            <= self.allocator_log.len() + self.deallocate.len()
        {
            new_blocks.push(unsafe { self.allocate(&mut FsCtx, BlockMeta::default())? });
        }

        // De-allocate old blocks (after allocation to prevent re-use)
        //TODO: optimize allocator log in memory
        while let Some(addr) = self.deallocate.pop() {
            self.allocator.deallocate(addr);
            self.allocator_log.push_back(AllocEntry::deallocate(addr));
        }

        for new_block in new_blocks {
            let mut alloc = BlockData::<AllocList>::empty(new_block).unwrap();
            alloc.data_mut().prev = prev_ptr;
            for entry in alloc.data_mut().entries.iter_mut() {
                if let Some(log_entry) = self.allocator_log.pop_front() {
                    *entry = log_entry;
                } else {
                    break;
                }
            }
            prev_ptr = unsafe { self.write_block(alloc)? };
        }

        self.header.alloc = prev_ptr;
        self.header_changed = true;

        Ok(true)
    }

    /// Write all changes cached in this [`Transaction`] to disk.
    pub fn sync(&mut self, force_squash: bool) -> Result<bool> {
        // Make sure alloc is synced
        self.sync_allocator(force_squash)?;

        // Write all items in write cache
        for (addr, raw) in self.write_cache.iter_mut() {
            // sync_alloc must have changed alloc block pointer
            // if we have any blocks to write
            assert!(self.header_changed);

            self.fs.encrypt(raw, *addr);
            let count = unsafe { self.fs.disk.write_at(self.fs.block + addr.index(), raw)? };
            if count != raw.len() {
                // Read wrong number of bytes
                #[cfg(feature = "log")]
                log::error!("SYNC WRITE_CACHE: WRONG NUMBER OF BYTES");
                return Err(Error::new(EIO));
            }
        }
        self.write_cache.clear();

        // Do nothing if there are no changes to write.
        //
        // This only happens if `self.write_cache` was empty,
        // and the fs header wasn't changed by another operation.
        if !self.header_changed {
            return Ok(false);
        }

        // Update header to next generation
        let gen = self.header.update(self.fs.cipher_opt.as_ref());
        let gen_block = gen % HEADER_RING;

        // Write header
        let count = unsafe {
            self.fs
                .disk
                .write_at(self.fs.block + gen_block, &self.header)?
        };
        if count != mem::size_of_val(&self.header) {
            // Read wrong number of bytes
            #[cfg(feature = "log")]
            log::error!("SYNC: WRONG NUMBER OF BYTES");
            return Err(Error::new(EIO));
        }

        self.header_changed = false;
        Ok(true)
    }

    pub fn read_block<T: BlockTrait + DerefMut<Target = [u8]>>(
        &mut self,
        ptr: BlockPtr<T>,
    ) -> Result<BlockData<T>> {
        if ptr.is_null() {
            // Pointer is invalid (should this return None?)
            #[cfg(feature = "log")]
            log::error!("READ_BLOCK: POINTER IS NULL");
            return Err(Error::new(ENOENT));
        }

        let mut data = match T::empty(ptr.addr().level()) {
            Some(some) => some,
            None => {
                #[cfg(feature = "log")]
                log::error!("READ_BLOCK: INVALID BLOCK LEVEL FOR TYPE");
                return Err(Error::new(ENOENT));
            }
        };
        if let Some(raw) = self.write_cache.get(&ptr.addr()) {
            data.copy_from_slice(raw);
        } else {
            let count = unsafe {
                self.fs
                    .disk
                    .read_at(self.fs.block + ptr.addr().index(), &mut data)?
            };
            if count != data.len() {
                // Read wrong number of bytes
                #[cfg(feature = "log")]
                log::error!("READ_BLOCK: WRONG NUMBER OF BYTES");
                return Err(Error::new(EIO));
            }
            self.fs.decrypt(&mut data, ptr.addr());
        }

        let block = BlockData::new(ptr.addr(), data);
        let block_ptr = block.create_ptr();
        if block_ptr.hash() != ptr.hash() {
            // Incorrect hash
            #[cfg(feature = "log")]
            log::error!(
                "READ_BLOCK: INCORRECT HASH 0x{:X} != 0x{:X} for block 0x{:X}",
                block_ptr.hash(),
                ptr.hash(),
                ptr.addr().index()
            );
            return Err(Error::new(EIO));
        }
        Ok(block)
    }

    /// Read block data or, if pointer is null, return default block data
    ///
    /// # Safety
    /// Unsafe because it creates strange BlockData types that must be swapped before use
    unsafe fn read_block_or_empty<T: BlockTrait + DerefMut<Target = [u8]>>(
        &mut self,
        ptr: BlockPtr<T>,
    ) -> Result<BlockData<T>> {
        if ptr.is_null() {
            let addr = ptr.addr();
            match T::empty(addr.level()) {
                Some(empty) => Ok(BlockData::new(addr, empty)),
                None => {
                    #[cfg(feature = "log")]
                    log::error!("READ_BLOCK_OR_EMPTY: INVALID BLOCK LEVEL FOR TYPE");
                    Err(Error::new(ENOENT))
                }
            }
        } else {
            self.read_block(ptr)
        }
    }

    unsafe fn read_record<T: BlockTrait + DerefMut<Target = [u8]>>(
        &mut self,
        mut ptr: BlockPtr<T>,
        level: BlockLevel,
    ) -> Result<BlockData<T>> {
        // Set null pointers to correct size (reduces number of copies below)
        if ptr.is_null() {
            ptr = BlockPtr::<T>::null(BlockMeta::new(level));
        }

        // Read record from disk, or construct empty one for null pointers
        let mut record = unsafe { self.read_block_or_empty(ptr)? };

        // Attempt to decompress if address metadata indicates compression
        if let Some(decomp_level) = record.addr().decomp_level() {
            // First 2 bytes store compressed data length
            // This means only compressed record sizes up to 64 KiB are supported
            let mut decomp = match T::empty(decomp_level) {
                Some(empty) => empty,
                None => {
                    #[cfg(feature = "log")]
                    log::error!("READ_RECORD: INVALID DECOMPRESSED BLOCK LEVEL FOR TYPE");
                    return Err(Error::new(ENOENT));
                }
            };
            let comp_len = record.data()[0] as usize | ((record.data()[1] as usize) << 8);
            let total_len = comp_len + 2;
            if let Err(err) = lz4_flex::decompress_into(&record.data()[2..total_len], &mut decomp) {
                #[cfg(feature = "log")]
                log::error!("READ_RECORD: FAILED TO DECOMPRESS: {:?}", err);
                return Err(Error::new(EIO));
            }
            record = BlockData::new(BlockAddr::null(BlockMeta::new(decomp_level)), decomp);
        }

        // Return record if it is larger than or equal to requested level
        if record.addr().level() >= level {
            return Ok(record);
        }

        // If a larger level was requested,
        // create a fake record with the requested level
        // and fill it with the data in the original record.
        let (_old_addr, old_raw) = unsafe { record.into_parts() };
        let mut raw = match T::empty(level) {
            Some(empty) => empty,
            None => {
                #[cfg(feature = "log")]
                log::error!("READ_RECORD: INVALID BLOCK LEVEL FOR TYPE");
                return Err(Error::new(ENOENT));
            }
        };
        let len = min(raw.len(), old_raw.len());
        raw[..len].copy_from_slice(&old_raw[..len]);

        Ok(BlockData::new(BlockAddr::null(BlockMeta::new(level)), raw))
    }

    /// Write block data to a new address, returning new address
    pub fn sync_block<T: BlockTrait + Deref<Target = [u8]>>(
        &mut self,
        ctx: &mut dyn AllocCtx,
        mut block: BlockData<T>,
    ) -> Result<BlockPtr<T>> {
        // Swap block to new address
        let meta = block.addr().meta();
        let old_addr = block.swap_addr(unsafe { self.allocate(ctx, meta)? });
        // Deallocate old address (will only take effect after sync_allocator, which helps to
        // prevent re-use before a new header is written
        if !old_addr.is_null() {
            unsafe {
                self.deallocate(ctx, old_addr);
            }
        }
        // Write new block
        unsafe { self.write_block(block) }
    }

    /// Write block data, returning a calculated block pointer
    ///
    /// # Safety
    /// Unsafe to encourage CoW semantics
    pub(crate) unsafe fn write_block<T: BlockTrait + Deref<Target = [u8]>>(
        &mut self,
        block: BlockData<T>,
    ) -> Result<BlockPtr<T>> {
        if block.addr().is_null() {
            // Pointer is invalid
            #[cfg(feature = "log")]
            log::error!("WRITE_BLOCK: POINTER IS NULL");
            return Err(Error::new(ENOENT));
        }

        //TODO: do not convert to boxed slice if it already is one
        self.write_cache.insert(
            block.addr(),
            block.data().deref().to_vec().into_boxed_slice(),
        );

        Ok(block.create_ptr())
    }

    //
    // MARK: tree operations
    //

    /// Walk the tree and return the contents and address
    /// of the data block that `ptr` points too.
    fn read_tree_and_addr<T: BlockTrait + DerefMut<Target = [u8]>>(
        &mut self,
        ptr: TreePtr<T>,
    ) -> Result<(TreeData<T>, BlockAddr)> {
        if ptr.is_null() {
            // ID is invalid (should this return None?)
            #[cfg(feature = "log")]
            log::error!("READ_TREE: ID IS NULL");
            return Err(Error::new(ENOENT));
        }

        let (i3, i2, i1, i0) = ptr.indexes();
        let l3 = self.read_block(self.header.tree)?;
        let l2 = self.read_block(l3.data().ptrs[i3])?;
        let l1 = self.read_block(l2.data().ptrs[i2])?;
        let l0 = self.read_block(l1.data().ptrs[i1])?;
        let raw = self.read_block(l0.data().ptrs[i0])?;

        //TODO: transmute instead of copy?
        let mut data = match T::empty(BlockLevel::default()) {
            Some(some) => some,
            None => {
                #[cfg(feature = "log")]
                log::error!("READ_TREE: INVALID BLOCK LEVEL FOR TYPE");
                return Err(Error::new(ENOENT));
            }
        };
        data.copy_from_slice(raw.data());

        Ok((TreeData::new(ptr.id(), data), raw.addr()))
    }

    /// Walk the tree and return the contents of the data block that `ptr` points too.
    pub fn read_tree<T: BlockTrait + DerefMut<Target = [u8]>>(
        &mut self,
        ptr: TreePtr<T>,
    ) -> Result<TreeData<T>> {
        Ok(self.read_tree_and_addr(ptr)?.0)
    }

    /// Insert `block_ptr` into the first free slot in the tree,
    /// returning a pointer to that slot.
    pub fn insert_tree<T: Deref<Target = [u8]>>(
        &mut self,
        block_ptr: BlockPtr<T>,
    ) -> Result<TreePtr<T>> {
        // Remember that if there is a free block at any level it will always sync when it
        // allocates at the lowest level, so we can save a write by not writing each level as it
        // is allocated.
        unsafe {
            let mut l3 = self.read_block(self.header.tree)?;
            for i3 in 0..l3.data().ptrs.len() {
                if l3.data().branch_is_full(i3) {
                    continue;
                }
                let mut l2 = self.read_block_or_empty(l3.data().ptrs[i3])?;
                for i2 in 0..l2.data().ptrs.len() {
                    if l2.data().branch_is_full(i2) {
                        continue;
                    }
                    let mut l1 = self.read_block_or_empty(l2.data().ptrs[i2])?;
                    for i1 in 0..l1.data().ptrs.len() {
                        if l1.data().branch_is_full(i1) {
                            continue;
                        }
                        let mut l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;
                        for i0 in 0..l0.data().ptrs.len() {
                            if l0.data().branch_is_full(i0) {
                                continue;
                            }

                            let pn = l0.data().ptrs[i0];
                            assert!(pn.is_null());

                            let tree_ptr = TreePtr::from_indexes((i3, i2, i1, i0));

                            // Skip if this is a reserved node (null)
                            if tree_ptr.is_null() {
                                l0.data_mut().set_branch_full(i0, true);
                                continue;
                            }

                            // Write updates to newly allocated blocks
                            l0.data_mut().set_branch_full(i0, true);
                            l0.data_mut().ptrs[i0] = block_ptr.cast();
                            l1.data_mut()
                                .set_branch_full(i1, l0.data().tree_list_is_full());
                            l1.data_mut().ptrs[i1] = self.sync_block(&mut FsCtx, l0)?;
                            l2.data_mut()
                                .set_branch_full(i2, l1.data().tree_list_is_full());
                            l2.data_mut().ptrs[i2] = self.sync_block(&mut FsCtx, l1)?;
                            l3.data_mut()
                                .set_branch_full(i3, l2.data().tree_list_is_full());
                            l3.data_mut().ptrs[i3] = self.sync_block(&mut FsCtx, l2)?;
                            self.header.tree = self.sync_block(&mut FsCtx, l3)?;
                            self.header_changed = true;

                            return Ok(tree_ptr);
                        }
                    }
                }
            }
        }

        Err(Error::new(ENOSPC))
    }

    /// Clear the previously claimed slot in the tree for the given `ptr`. Note that this
    /// should only be called after the corresponding node block has already been deallocated.
    fn remove_tree<T: BlockTrait + DerefMut<Target = [u8]>>(
        &mut self,
        ptr: TreePtr<T>,
    ) -> Result<()> {
        if ptr.is_null() {
            // ID is invalid (should this return None?)
            #[cfg(feature = "log")]
            log::error!("READ_TREE: ID IS NULL");
            return Err(Error::new(ENOENT));
        }

        let (i3, i2, i1, i0) = ptr.indexes();
        let mut l3 = self.read_block(self.header.tree)?;
        let mut l2 = self.read_block(l3.data().ptrs[i3])?;
        let mut l1 = self.read_block(l2.data().ptrs[i2])?;
        let mut l0 = self.read_block(l1.data().ptrs[i1])?;

        // Clear the value in the tree, but do not deallocate the node block, as that should already
        // have been done at the node level. The inner tree nodes can be deallocated if they are empty.
        l0.data_mut().set_branch_full(i0, false);
        l0.data_mut().ptrs[i0] = BlockPtr::default();
        let l0_ptr = if l0.data().tree_list_is_empty() {
            unsafe { self.deallocate(&mut FsCtx, l0.addr()) };
            BlockPtr::default()
        } else {
            self.sync_block(&mut FsCtx, l0)?
        };

        l1.data_mut().set_branch_full(i1, false);
        l1.data_mut().ptrs[i1] = l0_ptr;
        let l1_ptr = if l1.data().tree_list_is_empty() {
            unsafe { self.deallocate(&mut FsCtx, l1.addr()) };
            BlockPtr::default()
        } else {
            self.sync_block(&mut FsCtx, l1)?
        };

        l2.data_mut().set_branch_full(i2, false);
        l2.data_mut().ptrs[i2] = l1_ptr;
        let l2_ptr = if l2.data().tree_list_is_empty() {
            unsafe { self.deallocate(&mut FsCtx, l2.addr()) };
            BlockPtr::default()
        } else {
            self.sync_block(&mut FsCtx, l2)?
        };

        l3.data_mut().set_branch_full(i3, false);
        l3.data_mut().ptrs[i3] = l2_ptr;
        let l3_ptr = if l3.data().tree_list_is_empty() {
            unsafe { self.deallocate(&mut FsCtx, l3.addr()) };
            BlockPtr::default()
        } else {
            self.sync_block(&mut FsCtx, l3)?
        };

        self.header.tree = l3_ptr;
        self.header_changed = true;
        Ok(())
    }

    pub fn sync_trees<T: Deref<Target = [u8]>>(&mut self, nodes: &[TreeData<T>]) -> Result<()> {
        for node in nodes.iter().rev() {
            let ptr = node.ptr();
            if ptr.is_null() {
                // ID is invalid
                #[cfg(feature = "log")]
                log::error!("SYNC_TREE: ID IS NULL");
                return Err(Error::new(ENOENT));
            }
        }

        for node in nodes.iter().rev() {
            let (i3, i2, i1, i0) = node.ptr().indexes();
            let mut l3 = self.read_block(self.header.tree)?;
            let mut l2 = self.read_block(l3.data().ptrs[i3])?;
            let mut l1 = self.read_block(l2.data().ptrs[i2])?;
            let mut l0 = self.read_block(l1.data().ptrs[i1])?;
            let mut raw = self.read_block(l0.data().ptrs[i0])?;

            // Return if data is equal
            if raw.data().deref() == node.data().deref() {
                continue;
            }

            //TODO: transmute instead of copy?
            raw.data_mut().copy_from_slice(node.data());

            // Write updates to newly allocated blocks
            l0.data_mut().ptrs[i0] = self.sync_block(&mut FsCtx, raw)?;
            l1.data_mut().ptrs[i1] = self.sync_block(&mut FsCtx, l0)?;
            l2.data_mut().ptrs[i2] = self.sync_block(&mut FsCtx, l1)?;
            l3.data_mut().ptrs[i3] = self.sync_block(&mut FsCtx, l2)?;
            self.header.tree = self.sync_block(&mut FsCtx, l3)?;
            self.header_changed = true;
        }

        Ok(())
    }

    pub fn sync_tree<T: Deref<Target = [u8]>>(&mut self, node: TreeData<T>) -> Result<()> {
        self.sync_trees(&[node])
    }

    //
    // MARK: node operations
    //

    /// Write all children of `parent_ptr` to `children`.
    /// `parent_ptr` must point to a directory node.
    pub fn child_nodes(
        &mut self,
        parent_ptr: TreePtr<Node>,
        children: &mut Vec<DirEntry>,
    ) -> Result<()> {
        let parent = self.read_tree(parent_ptr)?;
        if level_data(&parent)?.level0[0].is_marker() {
            let htree_levels = level_data(&parent)?.level0[0].addr().level().0;
            let htree_root = if htree_levels == 0 {
                // Create a fake root to satisfy the recursive child_nodes_inner function signature
                let mut fake_htree_node =
                    BlockData::<HTreeNode<RecordRaw>>::empty(BlockAddr::default()).unwrap();
                let dir_ptr = level_data(&parent)?.level0[1];
                let htree_ptr = HTreePtr::new(HTreeHash::MAX, dir_ptr);
                fake_htree_node.data_mut().ptrs[0] = htree_ptr;
                fake_htree_node
            } else {
                let htree_record_ptr = level_data(&parent)?.level0[1];
                let htree_ptr: BlockPtr<HTreeNode<RecordRaw>> = unsafe { htree_record_ptr.cast() };
                self.read_block(htree_ptr)?
            };
            self.child_nodes_inner(htree_root.data(), children, htree_levels.max(1))?;
        }
        Ok(())
    }

    fn child_nodes_inner(
        &mut self,
        htree_node: &HTreeNode<RecordRaw>,
        children: &mut Vec<DirEntry>,
        htree_levels: usize,
    ) -> Result<()> {
        assert!(htree_levels > 0);
        if htree_levels == 1 {
            for entry in htree_node.ptrs.iter().filter(|entry| !entry.is_null()) {
                let dir_ptr: BlockPtr<DirList> = unsafe { entry.ptr.cast() };
                let dir = self.read_block(dir_ptr)?;
                for entry in dir.data().entries() {
                    children.push(entry);
                }
            }
        } else {
            for entry in htree_node.ptrs.iter().filter(|entry| !entry.is_null()) {
                let htree_ptr: BlockPtr<HTreeNode<RecordRaw>> = unsafe { entry.ptr.cast() };
                let htree_node = self.read_block(htree_ptr)?;
                self.child_nodes_inner(htree_node.data(), children, htree_levels - 1)?;
            }
        }

        Ok(())
    }

    /// Find a node that is a child of the `parent_ptr` and is named `name`.
    /// Returns ENOENT if this node is not found.
    pub fn find_node(&mut self, parent_ptr: TreePtr<Node>, name: &str) -> Result<TreeData<Node>> {
        let parent = self.read_tree(parent_ptr)?;
        if !level_data(&parent)?.level0[0].is_marker() {
            return Err(Error::new(ENOENT));
        }

        let htree_levels = level_data(&parent)?.level0[0].addr().level().0;

        let root_htree_node = if htree_levels == 0 {
            // Create a fake root to satisfy the recursive inner_find_node function signature
            let mut fake_htree_node =
                BlockData::<HTreeNode<RecordRaw>>::empty(BlockAddr::default()).unwrap();
            let dir_ptr = level_data(&parent)?.level0[1];
            let htree_ptr = HTreePtr::new(HTreeHash::MAX, dir_ptr);
            fake_htree_node.data_mut().ptrs[0] = htree_ptr;
            fake_htree_node
        } else {
            let root_htree_ptr: BlockPtr<HTreeNode<RecordRaw>> =
                unsafe { level_data(&parent)?.level0[1].cast() };
            self.read_block(root_htree_ptr)?
        };

        let result = self.find_node_inner(
            root_htree_node.data(),
            name,
            HTreeHash::from_name(name),
            htree_levels.max(1),
        )?;
        result
            .map(|(tree_node, _address)| tree_node)
            .ok_or(Error::new(ENOENT))
    }

    fn find_node_inner(
        &mut self,
        parent_htree_node: &HTreeNode<RecordRaw>,
        name: &str,
        name_hash: HTreeHash,
        htree_levels: usize,
    ) -> Result<Option<(TreeData<Node>, BlockAddr)>> {
        assert!(htree_levels > 0);
        if htree_levels == 1 {
            // If we are at the leaf level, search for the name
            for (_, htree_ptr) in parent_htree_node.find_ptrs_for_read(name_hash) {
                let dir_ptr: BlockPtr<DirList> = unsafe { htree_ptr.ptr.cast() };
                let dir = self.read_block(dir_ptr)?;

                if let Some(entry) = dir.data().find_entry(name) {
                    let node_ptr = entry.node_ptr();
                    return Ok(Some(self.read_tree_and_addr(node_ptr)?));
                }
            }
            #[cfg(feature = "log")]
            log::trace!("FIND_NODE: Node not found in leaf level 1");
            return Ok(None);
        }

        // Otherwise, search the next level of the H-tree
        for (_, entry) in parent_htree_node.find_ptrs_for_read(name_hash) {
            let htree_ptr: BlockPtr<HTreeNode<RecordRaw>> = unsafe { entry.ptr.cast() };
            let htree_node = self.read_block(htree_ptr)?;
            let result =
                self.find_node_inner(htree_node.data(), name, name_hash, htree_levels - 1)?;
            if let Some(node) = result {
                return Ok(Some(node));
            }
        }

        #[cfg(feature = "log")]
        log::trace!(
            "FIND_NODE: Node not found in higher level: {}",
            htree_levels
        );
        Ok(None)
    }

    /// Create a new node in the tree with the given parameters.
    pub fn create_node(
        &mut self,
        parent_ptr: TreePtr<Node>,
        name: &str,
        mode: u16,
        ctime: u64,
        ctime_nsec: u32,
    ) -> Result<TreeData<Node>> {
        self.check_name(&parent_ptr, name)?;

        unsafe {
            let parent = self.read_tree(parent_ptr)?;
            let node_block_data = BlockData::new(
                self.allocate(&mut FsCtx, BlockMeta::default())?,
                Node::new(
                    mode,
                    parent.data().uid(),
                    parent.data().gid(),
                    ctime,
                    ctime_nsec,
                ),
            );
            let node_block_ptr = self.write_block(node_block_data)?;
            let node_ptr = self.insert_tree(node_block_ptr)?;

            self.link_node(parent_ptr, name, node_ptr)?;

            //TODO: do not re-read node
            self.read_tree(node_ptr)
        }
    }

    pub fn link_node(
        &mut self,
        parent_ptr: TreePtr<Node>,
        name: &str,
        node_ptr: TreePtr<Node>,
    ) -> Result<()> {
        let mut parent = self.read_tree(parent_ptr)?;
        let mut node = self.read_tree(node_ptr)?;

        // Increment node reference counter
        let links = node.data().links();
        node.data_mut().set_links(links + 1);

        let dir_entry = DirEntry::new(node_ptr, name);
        let dir_entry_htree_hash = HTreeHash::from_name(name);
        let record_byte_size = parent.data().record_level().bytes();

        // If this is a brand new directory, create the first DirList block
        if !level_data(&parent)?.level0[0].is_marker() {
            let marker: BlockPtr<RecordRaw> = BlockPtr::marker(0);
            assert!(marker.is_marker());

            level_data_mut(&mut parent)?.level0[0] = BlockPtr::marker(0);
            assert!(level_data(&parent)?.level0[0].is_marker());

            // Create the first DirList block
            let dir = BlockData::<DirList>::empty(BlockAddr::default()).unwrap();
            let dir_ptr = self.sync_block(&mut parent, dir)?;

            // Add the DirList directly to the parent directory
            level_data_mut(&mut parent)?.level0[1] = unsafe { dir_ptr.cast() };
            let size = parent.data().size() + record_byte_size;
            parent.data_mut().set_size(size);
        }

        let mut htree_levels = level_data(&parent)?.level0[0].addr().level().0;

        let mut htree_root = if htree_levels == 0 {
            // If we have no H-tree root, create a fake one to satisfy the recurisve inner_link_node function
            let mut fake_htree_node =
                BlockData::<HTreeNode<RecordRaw>>::empty(BlockAddr::default()).unwrap();
            let dir_ptr = level_data(&parent)?.level0[1];
            let htree_ptr = HTreePtr::new(HTreeHash::MAX, dir_ptr);
            fake_htree_node.data_mut().ptrs[0] = htree_ptr;
            fake_htree_node
        } else {
            // Otherwise get the real H-tree root
            let htree_root_ptr: BlockPtr<HTreeNode<RecordRaw>> =
                unsafe { level_data(&parent)?.level0[1].cast() };
            self.read_block(htree_root_ptr)?
        };

        let new_sibling = self.link_node_inner(
            &mut parent,
            htree_root.data_mut(),
            dir_entry,
            dir_entry_htree_hash,
            htree_levels.max(1),
        )?;

        // If we used a fake root, and we grew beyond a single DirList block, we need to create a real root
        if htree_levels == 0 && !htree_root.data().ptrs[1].is_null() {
            htree_levels = 1;
            level_data_mut(&mut parent)?.level0[0] = BlockPtr::marker(1);
            let size = parent.data().size() + record_byte_size;
            parent.data_mut().set_size(size);
        }

        // If the H-tree root was split, create a new root to hold the old root as a sibling along with the new sibling
        if let Some((sibling_htree_hash, unallocated_sibling)) = new_sibling {
            assert!(htree_levels > 0);

            // Prep the new sibling H-tree block to be added to the new root
            let mut sibling =
                BlockData::<HTreeNode<RecordRaw>>::empty(BlockAddr::default()).unwrap();
            let _ = mem::replace(sibling.data_mut(), unallocated_sibling);
            let sibling_block_ptr = self.sync_block(&mut parent, sibling)?;
            let sibling_htree_ptr = HTreePtr::new(sibling_htree_hash, sibling_block_ptr);
            let sibling_record_ptr: HTreePtr<RecordRaw> = unsafe { sibling_htree_ptr.cast() };

            // Prep the existing H-tree root to become a sibling
            let root_htree_hash = htree_root
                .data()
                .find_max_htree_hash()
                .ok_or(Error::new(EIO))?;
            let root_block_ptr = self.sync_block(&mut parent, htree_root)?;
            let root_htree_ptr = HTreePtr::new(root_htree_hash, root_block_ptr);
            let root_record_ptr: HTreePtr<RecordRaw> = unsafe { root_htree_ptr.cast() };

            // Create the new root H-tree block
            let mut new_root =
                BlockData::<HTreeNode<RecordRaw>>::empty(BlockAddr::default()).unwrap();
            new_root.data_mut().ptrs[0] = sibling_record_ptr;
            let unexpected_sibling = htree::add_inner_node(new_root.data_mut(), root_record_ptr)?;
            assert!(unexpected_sibling.is_none());
            let new_root_ptr = self.sync_block(&mut parent, new_root)?;

            // Add the parent node pointer, increase the level, and increase one block size per allocated block
            level_data_mut(&mut parent)?.level0[0] = BlockPtr::marker(htree_levels as u8 + 1);
            level_data_mut(&mut parent)?.level0[1] = unsafe { new_root_ptr.cast() };
            let size = parent.data().size() + 2 * record_byte_size;
            parent.data_mut().set_size(size);
        } else if htree_levels > 0 {
            // Update the parent node with the new root pointer
            let root_block_ptr = self.sync_block(&mut parent, htree_root)?;
            level_data_mut(&mut parent)?.level0[1] = unsafe { root_block_ptr.cast() };
        } else {
            // Update the parent with the DirList block, ignoring the fake htree_root
            level_data_mut(&mut parent)?.level0[1] = htree_root.data().ptrs[0].ptr;
        }
        self.sync_trees(&[parent, node])?;
        Ok(())
    }

    fn link_node_inner(
        &mut self,
        parent_dir_node: &mut TreeData<Node>,
        parent_htree_node: &mut HTreeNode<RecordRaw>,
        dir_entry: DirEntry,
        dir_entry_htree_hash: HTreeHash,
        htree_levels: usize,
    ) -> Result<Option<(HTreeHash, HTreeNode<RecordRaw>)>> {
        let record_byte_size = parent_dir_node.data().record_level().bytes();

        // Find the entry to update
        let mut htree_ptr = parent_htree_node.ptrs[0];
        let mut htree_ptr_idx = 0;
        for (idx, entry) in parent_htree_node.ptrs.iter().enumerate() {
            if entry.is_null() {
                break;
            }
            htree_ptr = *entry;
            htree_ptr_idx = idx;
            if htree_ptr.htree_hash >= dir_entry_htree_hash {
                break;
            }
        }

        // The recursion terminates by processing the last inner node
        assert!(htree_levels > 0);
        if htree_levels == 1 {
            // Add the entry to the DirList block
            let dir_ptr: BlockPtr<DirList> = unsafe { htree_ptr.ptr.cast() };
            let mut dir = self.read_block(dir_ptr)?;
            let unallocated_sibling =
                htree::add_dir_entry(dir.data_mut(), &mut htree_ptr.htree_hash, dir_entry)?;
            let dir_record_ptr = unsafe { self.sync_block(parent_dir_node, dir)?.cast() };
            parent_htree_node.ptrs[htree_ptr_idx] =
                HTreePtr::new(htree_ptr.htree_hash, dir_record_ptr);

            if let Some((new_hash, new_unallocated_dir)) = unallocated_sibling {
                // The DirList block was split, so we need to add it to the h-tree
                let mut dir = BlockData::<DirList>::empty(BlockAddr::default()).unwrap();
                let _ = mem::replace(dir.data_mut(), new_unallocated_dir);
                let dir_ptr = self.sync_block(parent_dir_node, dir)?;
                let dir_htree_ptr = HTreePtr::new(new_hash, dir_ptr);
                let dir_record_ptr: HTreePtr<RecordRaw> = unsafe { dir_htree_ptr.cast() };
                let size = parent_dir_node.data().size() + record_byte_size;
                parent_dir_node.data_mut().set_size(size);

                // We mutate the parent, but let the caller write the parent to disk
                return htree::add_inner_node(parent_htree_node, dir_record_ptr);
            }
            return Ok(None);
        }

        // Recursively insert the entry into the next H-tree level
        let htree_block_ptr: BlockPtr<HTreeNode<RecordRaw>> = unsafe { htree_ptr.ptr.cast() };
        let mut htree_block = self.read_block(htree_block_ptr)?;
        let unallocated_sibling = self.link_node_inner(
            parent_dir_node,
            htree_block.data_mut(),
            dir_entry,
            dir_entry_htree_hash,
            htree_levels - 1,
        )?;

        // Write the muteated H-tree block back to disk and update the parent node's pointer
        let htree_hash = htree_block.data().find_max_htree_hash().unwrap();
        let htree_block_ptr = self.sync_block(parent_dir_node, htree_block)?;
        let htree_record_ptr: BlockPtr<RecordRaw> = unsafe { htree_block_ptr.cast() };
        parent_htree_node.ptrs[htree_ptr_idx] = HTreePtr::new(htree_hash, htree_record_ptr);

        // If the inner insert function returns a new H-tree sibling block, write it and add it to the parent H-tree node
        if let Some((new_hash, new_unallocated_sibling)) = unallocated_sibling {
            let mut sibling =
                BlockData::<HTreeNode<RecordRaw>>::empty(BlockAddr::default()).unwrap();
            let _ = mem::replace(sibling.data_mut(), new_unallocated_sibling);
            let sibling_ptr = self.sync_block(parent_dir_node, sibling)?;
            let sibling_htree_ptr = HTreePtr::new(new_hash, sibling_ptr);
            let sibling_record_ptr: HTreePtr<RecordRaw> = unsafe { sibling_htree_ptr.cast() };
            let size = parent_dir_node.data().size() + record_byte_size;
            parent_dir_node.data_mut().set_size(size);

            // We mutate the parent, but let the caller write the parent to disk
            return htree::add_inner_node(parent_htree_node, sibling_record_ptr);
        }

        Ok(None)
    }

    pub fn remove_node(
        &mut self,
        parent_ptr: TreePtr<Node>,
        name: &str,
        mode: u16,
    ) -> Result<Option<u32>> {
        #[cfg(feature = "log")]
        log::debug!(
            "REMOVE_NODE: name: {}, mode: {:x}, parent_ptr: {:?}",
            name,
            mode,
            parent_ptr.indexes()
        );

        let mut parent = self.read_tree(parent_ptr)?;
        if !level_data(&parent)?.level0[0].is_marker() {
            #[cfg(feature = "log")]
            log::error!("REMOVE_NODE: Parent has no htree marker set (not a directory or empty)");
            return Err(Error::new(ENOENT));
        }

        let htree_levels = level_data(&parent)?.level0[0].addr().level().0;
        let name_hash = HTreeHash::from_name(name);

        let mut htree_root = if htree_levels == 0 {
            // If we have no H-tree root, create a fake one to satisfy the recurisve inner_link_node function
            let mut fake_htree_node =
                BlockData::<HTreeNode<RecordRaw>>::empty(BlockAddr::default()).unwrap();
            let dir_ptr = level_data(&parent)?.level0[1];
            let htree_ptr = HTreePtr::new(HTreeHash::MAX, dir_ptr);
            fake_htree_node.data_mut().ptrs[0] = htree_ptr;
            fake_htree_node
        } else {
            // Otherwise get the real H-tree root
            let htree_root_record_ptr = level_data(&parent)?.level0[1];
            let htree_root_ptr: BlockPtr<HTreeNode<RecordRaw>> =
                unsafe { htree_root_record_ptr.cast() };
            self.read_block(htree_root_ptr)?
        };

        // Read node and test type against requested type
        // TODO: Do this check as part of the removal tree processing, and get rid of this extra find
        let (mut node, _node_addr) = self
            .find_node_inner(htree_root.data(), name, name_hash, htree_levels.max(1))?
            .ok_or(Error::new(ENOENT))?;

        if mode & Node::MODE_TYPE == Node::MODE_DIR {
            if !node.data().is_dir() {
                // Found a file instead of a directory
                return Err(Error::new(ENOTDIR));
            } else if node.data().size() > 0 && node.data().links() == 1 {
                // Tried to remove directory that still has entries
                return Err(Error::new(ENOTEMPTY));
            }
            // The directory will be removed.
        } else {
            if node.data().is_dir() {
                // Found a directory instead of file
                return Err(Error::new(EISDIR));
            }
            // The non-directory entry will be removed.
        }

        let links = node.data().links();
        let node_id = node.id();
        let remove_node = if links > 1 {
            node.data_mut().set_links(links - 1);
            false
        } else {
            node.data_mut().set_links(0);
            true
        };

        // Recursively remove the node from the H-tree, removing empty H-tree nodes
        self.remove_node_inner(
            &mut parent,
            htree_root.data_mut(),
            name,
            name_hash,
            htree_levels.max(1),
        )?;

        htree_root
            .data_mut()
            .ptrs
            .sort_by(|a, b| a.htree_hash.cmp(&b.htree_hash));
        if htree_root.data().ptrs[0].is_null() {
            // Dealocate the htree_root only if it was a real root node in the H-tree
            if htree_levels > 0 {
                unsafe {
                    self.deallocate(&mut parent, htree_root.addr());
                }
                let record_byte_size = parent.data().record_level().bytes();
                let size = parent.data().size() - record_byte_size;
                parent.data_mut().set_size(size);
            }
            level_data_mut(&mut parent)?.level0[0] = BlockPtr::default();
            level_data_mut(&mut parent)?.level0[1] = BlockPtr::default();
        } else if htree_levels > 0 {
            // Update the real htree_root and update the ptr in the parent
            let htree_root_block_ptr = self.sync_block(&mut parent, htree_root)?;
            level_data_mut(&mut parent)?.level0[1] = unsafe { htree_root_block_ptr.cast() };
        } else {
            // The htree_root is fake, so update the parent with the ptr to the one and only directory list
            let dir_list_block_ptr = htree_root.data().ptrs[0].ptr;
            level_data_mut(&mut parent)?.level0[1] = unsafe { dir_list_block_ptr.cast() };
        }

        if remove_node {
            self.sync_tree(parent)?;
            self.release_node(node.ptr())?;
            Ok(Some(node_id))
        } else {
            // Sync both parent and node at the same time
            self.sync_trees(&[parent, node])?;
            Ok(None)
        }
    }

    /// Notify of node open, for tracking node usage
    pub fn on_open_node(&mut self, node_ptr: TreePtr<Node>) -> Result<()> {
        let entry = self.fs.node_usages.entry(node_ptr.id()).or_insert(0);
        *entry = entry.checked_add(1).ok_or_else(|| {
            #[cfg(feature = "log")]
            log::error!("node {} usage overflow", node_ptr.id());
            Error::new(EINVAL)
        })?;
        Ok(())
    }

    /// Notify of node close, for tracking node usage. Delete node if it is in
    /// the release list.
    ///
    /// Returns `Ok(true)` if the node was deleted
    pub fn on_close_node(&mut self, node_ptr: TreePtr<Node>) -> Result<()> {
        // Subtract from usages and return if not zero
        match self.fs.node_usages.get_mut(&node_ptr.id()) {
            Some(entry) => {
                *entry = entry.checked_sub(1).ok_or_else(|| {
                    #[cfg(feature = "log")]
                    log::error!("node {} usage underflow", node_ptr.id());
                    Error::new(EINVAL)
                })?;
                if *entry > 0 {
                    // Node still in use
                    return Ok(());
                }
            }
            None => {
                #[cfg(feature = "log")]
                log::error!(
                    "tried to close node {} that is not already open",
                    node_ptr.id()
                );
                return Ok(());
            }
        }

        // Remove node usages entry
        self.fs.node_usages.remove(&node_ptr.id());

        // Check for node in release list and delete it
        self.release_unused_nodes()
    }

    /// Check for unused nodes in release list and delete them
    pub fn release_unused_nodes(&mut self) -> Result<()> {
        // Read current release lists (going forward through list)
        let mut releases = VecDeque::<BlockData<ReleaseList>>::new();
        {
            let mut release_ptr = self.header.release;
            while !release_ptr.is_null() {
                let release = self.read_block(release_ptr)?;
                release_ptr = release.data().prev;
                releases.push_front(release);
            }
        }

        // Find unused nodes and remove them (going backwards through list)
        let mut update_prev = None;
        let mut release_nodes = Vec::new();
        while let Some(mut release) = releases.pop_back() {
            if let Some(prev_ptr) = update_prev.take() {
                release.data_mut().prev = prev_ptr;
            }

            let mut changed = false;
            let mut empty = true;
            for entry in release.data_mut().entries.iter_mut() {
                if !entry.is_null() {
                    let usages = self.fs.node_usages.get(&entry.id()).copied().unwrap_or(0);
                    if usages == 0 {
                        release_nodes.push(*entry);
                        *entry = TreePtr::default();
                        changed = true;
                    } else {
                        empty = false;
                    }
                }
            }

            if empty {
                // Deallocate this release list block
                unsafe {
                    self.deallocate(&mut FsCtx, release.addr());
                }
                // Skip this block in the list
                update_prev = Some(release.data().prev);
            } else if changed {
                // Update this block
                update_prev = Some(self.sync_block(&mut FsCtx, release)?);
            } else {
                update_prev = None;
            }
        }
        if let Some(prev_ptr) = update_prev.take() {
            self.header.release = prev_ptr;
            self.header_changed = true;
        }

        for node_ptr in release_nodes {
            self.release_node(node_ptr)?;
        }

        Ok(())
    }

    /// Removes node if usages are zero, adds it to release list if usages are
    /// greater than zero.
    pub fn release_node(&mut self, node_ptr: TreePtr<Node>) -> Result<()> {
        let usages = self
            .fs
            .node_usages
            .get(&node_ptr.id())
            .copied()
            .unwrap_or(0);
        if usages > 0 {
            let mut release = unsafe { self.read_block_or_empty(self.header.release)? };

            // Try to insert into current release block
            let mut inserted = false;
            for entry in release.data_mut().entries.iter_mut() {
                if entry.is_null() {
                    *entry = node_ptr;
                    inserted = true;
                    break;
                }
            }

            // If not inserted, try to add another release block
            if !inserted {
                release = BlockData::empty(BlockAddr::null(BlockMeta::default())).unwrap();
                release.data_mut().prev = self.header.release;
                release.data_mut().entries[0] = node_ptr;
            }

            // Update header
            self.header.release = self.sync_block(&mut FsCtx, release)?;
            self.header_changed = true;
        } else {
            let (mut node, node_addr) = self.read_tree_and_addr(node_ptr)?;
            self.truncate_node_inner(&mut node, 0)?;
            self.remove_tree(node.ptr())?;
            unsafe {
                self.deallocate(&mut FsCtx, node_addr);
            }
        }
        Ok(())
    }

    fn remove_node_inner(
        &mut self,
        parent_dir_node: &mut TreeData<Node>,
        parent_htree_node: &mut HTreeNode<RecordRaw>,
        dir_entry_name: &str,
        dir_entry_htree_hash: HTreeHash,
        htree_levels: usize,
    ) -> Result<()> {
        let record_byte_size = parent_dir_node.data().record_level().bytes();

        // Process every node that could hold the entry
        assert!(htree_levels > 0);
        let relevant_entry_indexes: Vec<usize> = parent_htree_node
            .find_ptrs_for_read(dir_entry_htree_hash)
            .map(|x| x.0)
            .collect();

        for entry_idx in relevant_entry_indexes {
            let entry_ptr = parent_htree_node.ptrs[entry_idx];
            if htree_levels == 1 {
                let dir_ptr: BlockPtr<DirList> = unsafe { entry_ptr.ptr.cast() };
                let mut dir_list = self.read_block(dir_ptr)?;

                // If we don't find the entry to remove, continue to the next relevant node
                if !dir_list.data_mut().remove_entry(dir_entry_name) {
                    continue;
                }

                // Determine if the htree_hash needs to be updated
                let new_htree_hash = if dir_entry_htree_hash == HTreeHash::from_name(dir_entry_name)
                {
                    HTreeHash::find_max(dir_list.data())
                } else {
                    Some(dir_entry_htree_hash)
                };

                if let Some(new_tree_hash) = new_htree_hash {
                    // The entry_ptr needs to be updated in the parent_htree_node
                    let dir_block_ptr = self.sync_block(parent_dir_node, dir_list)?;
                    let dir_record_ptr: BlockPtr<RecordRaw> = unsafe { dir_block_ptr.cast() };
                    parent_htree_node.ptrs[entry_idx] =
                        HTreePtr::new(new_tree_hash, dir_record_ptr);
                } else {
                    // The entry needs to be removed from the parent_htree_noce
                    parent_htree_node.ptrs[entry_idx] = HTreePtr::default();
                    unsafe { self.deallocate(parent_dir_node, dir_list.addr()) };
                    let size = parent_dir_node.data().size() - record_byte_size;
                    parent_dir_node.data_mut().set_size(size);
                }
                return Ok(());
            } else {
                let htree_ptr: BlockPtr<HTreeNode<RecordRaw>> = unsafe { entry_ptr.ptr.cast() };
                let mut htree_node = self.read_block(htree_ptr)?;

                let result = self.remove_node_inner(
                    parent_dir_node,
                    htree_node.data_mut(),
                    dir_entry_name,
                    dir_entry_htree_hash,
                    htree_levels - 1,
                );

                // If the removal attempt resulted in ENOENT, iterate to look at the next relevant node
                if result.is_err() && result.err().unwrap().errno == ENOENT {
                    continue;
                }

                // In case it is some other err
                result?;

                // Sort entries, moving them to the start of the ptrs array in H-tree hash order
                htree_node
                    .data_mut()
                    .ptrs
                    .sort_by(|a, b| a.htree_hash.cmp(&b.htree_hash));

                if let Some(new_htree_hash) = htree_node.data().find_max_htree_hash() {
                    // The entry_ptr needs to be updated in the parent_htree_node
                    let htree_block_ptr = self.sync_block(parent_dir_node, htree_node)?;
                    let htree_record_ptr: BlockPtr<RecordRaw> = unsafe { htree_block_ptr.cast() };
                    parent_htree_node.ptrs[entry_idx] =
                        HTreePtr::new(new_htree_hash, htree_record_ptr);
                } else {
                    // The htree_node is now empty, so remove it
                    parent_htree_node.ptrs[entry_idx] = HTreePtr::default();
                    unsafe { self.deallocate(parent_dir_node, htree_node.addr()) };
                    let size = parent_dir_node.data().size() - record_byte_size;
                    parent_dir_node.data_mut().set_size(size);
                }
                return Ok(());
            }
        }
        Err(Error::new(ENOENT))
    }

    pub fn rename_node(
        &mut self,
        orig_parent_ptr: TreePtr<Node>,
        orig_name: &str,
        new_parent_ptr: TreePtr<Node>,
        new_name: &str,
    ) -> Result<()> {
        let orig = self.find_node(orig_parent_ptr, orig_name)?;

        // TODO: only allow ENOENT as an error?
        if let Ok(new) = self.find_node(new_parent_ptr, new_name) {
            // Move to same name, return
            if new.id() == orig.id() {
                return Ok(());
            }

            // Remove new name
            // (we renamed to a node that already exists, overwrite it.)
            self.remove_node(
                new_parent_ptr,
                new_name,
                new.data().mode() & Node::MODE_TYPE,
            )?;
        }

        // Link original file to new name
        self.check_name(&new_parent_ptr, new_name)?;
        self.link_node(new_parent_ptr, new_name, orig.ptr())?;

        // Remove original file
        self.remove_node(
            orig_parent_ptr,
            orig_name,
            orig.data().mode() & Node::MODE_TYPE,
        )?;

        Ok(())
    }

    pub fn rename_node_no_replace(
        &mut self,
        orig_parent_ptr: TreePtr<Node>,
        orig_name: &str,
        new_parent_ptr: TreePtr<Node>,
        new_name: &str,
    ) -> Result<()> {
        let orig = self.find_node(orig_parent_ptr, orig_name)?;

        // The target shouldn't exist.
        if self.find_node(new_parent_ptr, new_name).is_ok() {
            return Err(Error::new(EEXIST));
        }

        // The rest is the same as rename_node.
        // Link original file to new name
        self.check_name(&new_parent_ptr, new_name)?;
        self.link_node(new_parent_ptr, new_name, orig.ptr())?;

        // Remove original file
        self.remove_node(
            orig_parent_ptr,
            orig_name,
            orig.data().mode() & Node::MODE_TYPE,
        )?;

        Ok(())
    }

    fn check_name(&mut self, parent_ptr: &TreePtr<Node>, name: &str) -> Result<()> {
        if name.contains(':') {
            return Err(Error::new(EINVAL));
        }

        if name.len() > DIR_ENTRY_MAX_LENGTH {
            return Err(Error::new(EINVAL));
        }

        // TODO: Can this be removed if link_node satisfies this check itself?
        if self.find_node(*parent_ptr, name).is_ok() {
            return Err(Error::new(EEXIST));
        }

        Ok(())
    }

    /// Get a pointer to a the record of `node` with the given offset.
    /// (i.e, to the `n`th record of `node`.)
    fn node_record_ptr(
        &mut self,
        node: &TreeData<Node>,
        record_offset: u64,
    ) -> Result<BlockPtr<RecordRaw>> {
        unsafe {
            match NodeLevel::new(record_offset).ok_or(Error::new(ERANGE))? {
                NodeLevel::L0(i0) => Ok(level_data(node)?.level0[i0]),
                NodeLevel::L1(i1, i0) => {
                    let l0 = self.read_block_or_empty(level_data(node)?.level1[i1])?;
                    Ok(l0.data().ptrs[i0])
                }
                NodeLevel::L2(i2, i1, i0) => {
                    let l1 = self.read_block_or_empty(level_data(node)?.level2[i2])?;
                    let l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;
                    Ok(l0.data().ptrs[i0])
                }
                NodeLevel::L3(i3, i2, i1, i0) => {
                    let l2 = self.read_block_or_empty(level_data(node)?.level3[i3])?;
                    let l1 = self.read_block_or_empty(l2.data().ptrs[i2])?;
                    let l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;
                    Ok(l0.data().ptrs[i0])
                }
                NodeLevel::L4(i4, i3, i2, i1, i0) => {
                    let l3 = self.read_block_or_empty(level_data(node)?.level4[i4])?;
                    let l2 = self.read_block_or_empty(l3.data().ptrs[i3])?;
                    let l1 = self.read_block_or_empty(l2.data().ptrs[i2])?;
                    let l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;
                    Ok(l0.data().ptrs[i0])
                }
            }
        }
    }

    fn remove_node_record_ptr(
        &mut self,
        node: &mut TreeData<Node>,
        record_offset: u64,
    ) -> Result<()> {
        unsafe {
            match NodeLevel::new(record_offset).ok_or(Error::new(ERANGE))? {
                NodeLevel::L0(i0) => {
                    let ptr = level_data_mut(node)?.level0[i0].clear();
                    self.deallocate_block(node, ptr);
                }
                NodeLevel::L1(i1, i0) => {
                    let mut l0 = self.read_block_or_empty(level_data(node)?.level1[i1])?;
                    self.deallocate_block(node, l0.data_mut().ptrs[i0].clear());
                    if l0.data().is_empty() {
                        let ptr = level_data_mut(node)?.level1[i1].clear();
                        self.deallocate_block(node, ptr);
                    } else {
                        level_data_mut(node)?.level1[i1] = self.sync_block(node, l0)?;
                    }
                }
                NodeLevel::L2(i2, i1, i0) => {
                    let mut l1 = self.read_block_or_empty(level_data(node)?.level2[i2])?;
                    let mut l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;
                    self.deallocate_block(node, l0.data_mut().ptrs[i0].clear());
                    if l0.data().is_empty() {
                        self.deallocate_block(node, l1.data_mut().ptrs[i1].clear());
                    } else {
                        l1.data_mut().ptrs[i1] = self.sync_block(node, l0)?;
                    }
                    if l1.data().is_empty() {
                        let ptr = level_data_mut(node)?.level2[i2].clear();
                        self.deallocate_block(node, ptr);
                    } else {
                        level_data_mut(node)?.level2[i2] = self.sync_block(node, l1)?;
                    }
                }
                NodeLevel::L3(i3, i2, i1, i0) => {
                    let mut l2 = self.read_block_or_empty(level_data(node)?.level3[i3])?;
                    let mut l1 = self.read_block_or_empty(l2.data().ptrs[i2])?;
                    let mut l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;
                    self.deallocate_block(node, l0.data_mut().ptrs[i0].clear());
                    if l0.data().is_empty() {
                        self.deallocate_block(node, l1.data_mut().ptrs[i1].clear());
                    } else {
                        l1.data_mut().ptrs[i1] = self.sync_block(node, l0)?;
                    }
                    if l1.data().is_empty() {
                        self.deallocate_block(node, l2.data_mut().ptrs[i2].clear());
                    } else {
                        l2.data_mut().ptrs[i2] = self.sync_block(node, l1)?;
                    }
                    if l2.data().is_empty() {
                        let ptr = level_data_mut(node)?.level3[i3].clear();
                        self.deallocate_block(node, ptr);
                    } else {
                        level_data_mut(node)?.level3[i3] = self.sync_block(node, l2)?;
                    }
                }
                NodeLevel::L4(i4, i3, i2, i1, i0) => {
                    let mut l3 = self.read_block_or_empty(level_data(node)?.level4[i4])?;
                    let mut l2 = self.read_block_or_empty(l3.data().ptrs[i3])?;
                    let mut l1 = self.read_block_or_empty(l2.data().ptrs[i2])?;
                    let mut l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;
                    self.deallocate_block(node, l0.data_mut().ptrs[i0].clear());
                    if l0.data().is_empty() {
                        self.deallocate_block(node, l1.data_mut().ptrs[i1].clear());
                    } else {
                        l1.data_mut().ptrs[i1] = self.sync_block(node, l0)?;
                    }
                    if l1.data().is_empty() {
                        self.deallocate_block(node, l2.data_mut().ptrs[i2].clear());
                    } else {
                        l2.data_mut().ptrs[i2] = self.sync_block(node, l1)?;
                    }
                    if l2.data().is_empty() {
                        self.deallocate_block(node, l3.data_mut().ptrs[i3].clear());
                    } else {
                        l3.data_mut().ptrs[i3] = self.sync_block(node, l2)?;
                    }
                    if l3.data().is_empty() {
                        let ptr = level_data_mut(node)?.level4[i4].clear();
                        self.deallocate_block(node, ptr);
                    } else {
                        level_data_mut(node)?.level4[i4] = self.sync_block(node, l3)?;
                    }
                }
            }

            Ok(())
        }
    }

    /// Set the record at `ptr` as the data at `record_offset` of `node`.
    fn sync_node_record_ptr(
        &mut self,
        node: &mut TreeData<Node>,
        record_offset: u64,
        ptr: BlockPtr<RecordRaw>,
    ) -> Result<()> {
        unsafe {
            match NodeLevel::new(record_offset).ok_or(Error::new(ERANGE))? {
                NodeLevel::L0(i0) => {
                    level_data_mut(node)?.level0[i0] = ptr;
                }
                NodeLevel::L1(i1, i0) => {
                    let mut l0 = self.read_block_or_empty(level_data(node)?.level1[i1])?;

                    l0.data_mut().ptrs[i0] = ptr;
                    level_data_mut(node)?.level1[i1] = self.sync_block(node, l0)?;
                }
                NodeLevel::L2(i2, i1, i0) => {
                    let mut l1 = self.read_block_or_empty(level_data(node)?.level2[i2])?;
                    let mut l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;

                    l0.data_mut().ptrs[i0] = ptr;
                    l1.data_mut().ptrs[i1] = self.sync_block(node, l0)?;
                    level_data_mut(node)?.level2[i2] = self.sync_block(node, l1)?;
                }
                NodeLevel::L3(i3, i2, i1, i0) => {
                    let mut l2 = self.read_block_or_empty(level_data(node)?.level3[i3])?;
                    let mut l1 = self.read_block_or_empty(l2.data().ptrs[i2])?;
                    let mut l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;

                    l0.data_mut().ptrs[i0] = ptr;
                    l1.data_mut().ptrs[i1] = self.sync_block(node, l0)?;
                    l2.data_mut().ptrs[i2] = self.sync_block(node, l1)?;
                    level_data_mut(node)?.level3[i3] = self.sync_block(node, l2)?;
                }
                NodeLevel::L4(i4, i3, i2, i1, i0) => {
                    let mut l3 = self.read_block_or_empty(level_data(node)?.level4[i4])?;
                    let mut l2 = self.read_block_or_empty(l3.data().ptrs[i3])?;
                    let mut l1 = self.read_block_or_empty(l2.data().ptrs[i2])?;
                    let mut l0 = self.read_block_or_empty(l1.data().ptrs[i1])?;

                    l0.data_mut().ptrs[i0] = ptr;
                    l1.data_mut().ptrs[i1] = self.sync_block(node, l0)?;
                    l2.data_mut().ptrs[i2] = self.sync_block(node, l1)?;
                    l3.data_mut().ptrs[i3] = self.sync_block(node, l2)?;
                    level_data_mut(node)?.level4[i4] = self.sync_block(node, l3)?;
                }
            }
        }

        Ok(())
    }

    pub fn read_node_inner(
        &mut self,
        node: &TreeData<Node>,
        mut offset: u64,
        buf: &mut [u8],
    ) -> Result<usize> {
        let node_size = node.data().size();

        // Try reading from inline data
        if let Some(inline_data) = node.data().inline_data() {
            if offset >= node_size {
                return Ok(0);
            }

            // Read as much as possible from inline data
            let mut i = 0;
            if offset < inline_data.len() as u64 {
                let len = min(
                    buf.len() as u64,
                    min(node_size - offset, inline_data.len() as u64 - offset),
                );
                buf[i..len as usize]
                    .copy_from_slice(&inline_data[offset as usize..(offset + len) as usize]);
                i += len as usize;
                offset += len;
            }

            // Handle sparse data (outside of inline data)
            while i < buf.len() && offset < node_size {
                buf[i] = 0;
                i += 1;
                offset += 1;
            }

            return Ok(i);
        }

        let record_level = node.data().record_level();

        let mut bytes_read = 0;
        while bytes_read < buf.len() && offset < node_size {
            // How many bytes we've read into the next record
            let j = (offset % record_level.bytes()) as usize;

            // Number of bytes to read in this iteration
            let len = min(
                buf.len() - bytes_read, // number of bytes we have left in `buf`
                min(
                    record_level.bytes() - j as u64, // number of bytes we haven't read in this record
                    node_size - offset,              // number of bytes left in this node
                ) as usize,
            );

            let record_idx = offset / record_level.bytes();
            let record_ptr = self.node_record_ptr(node, record_idx)?;

            // The level of the record to read.
            // This is at most `record_level` due to the way `len` is computed.
            let level = BlockLevel::for_bytes((j + len) as u64);

            let record = unsafe { self.read_record(record_ptr, level)? };
            buf[bytes_read..bytes_read + len].copy_from_slice(&record.data()[j..j + len]);

            bytes_read += len;
            offset += len as u64;
        }
        Ok(bytes_read)
    }

    pub fn read_node(
        &mut self,
        node_ptr: TreePtr<Node>,
        offset: u64,
        buf: &mut [u8],
        atime: u64,
        atime_nsec: u32,
    ) -> Result<usize> {
        let mut node = self.read_tree(node_ptr)?;
        let mut node_changed = false;

        let i = self.read_node_inner(&node, offset, buf)?;
        if i > 0 {
            let node_atime = node.data().atime();
            if atime > node_atime.0 || (atime == node_atime.0 && atime_nsec > node_atime.1) {
                let is_old = atime - node_atime.0 > 3600; // Last read was more than a day ago
                if is_old {
                    node.data_mut().set_atime(atime, atime_nsec);
                    node_changed = true;
                }
            }
        }

        if node_changed {
            self.sync_tree(node)?;
        }

        Ok(i)
    }

    pub fn truncate_node_inner(&mut self, node: &mut TreeData<Node>, size: u64) -> Result<bool> {
        let old_size = node.data().size();
        let record_level = node.data().record_level();

        // Size already matches, return
        if old_size == size {
            return Ok(false);
        }

        if old_size < size {
            // If we're "truncating" to a larger size,
            // write zeroes until the size matches
            let zeroes = RecordRaw::empty(record_level).unwrap();

            let mut offset = old_size;
            while offset < size {
                let start = offset % record_level.bytes();
                if start == 0 {
                    // We don't have to write completely zero records as read will interpret
                    // null record pointers as zero records
                    offset = size;
                    break;
                }
                let end = if offset / record_level.bytes() == size / record_level.bytes() {
                    size % record_level.bytes()
                } else {
                    record_level.bytes()
                };
                self.write_node_inner(node, &mut offset, &zeroes[start as usize..end as usize])?;
            }
            assert_eq!(offset, size);
        } else if !node.data().has_inline_data() {
            // Deallocate records
            for record in
                (size.div_ceil(record_level.bytes())..old_size / record_level.bytes()).rev()
            {
                self.remove_node_record_ptr(node, record)?;
            }
        }

        // Update size
        node.data_mut().set_size(size);

        Ok(true)
    }

    /// Truncate the given node to the given size.
    ///
    /// If `size` is larger than the node's current size,
    /// expand the node with zeroes.
    pub fn truncate_node(
        &mut self,
        node_ptr: TreePtr<Node>,
        size: u64,
        mtime: u64,
        mtime_nsec: u32,
    ) -> Result<()> {
        let mut node = self.read_tree(node_ptr)?;
        if self.truncate_node_inner(&mut node, size)? {
            let node_mtime = node.data().mtime();
            if mtime > node_mtime.0 || (mtime == node_mtime.0 && mtime_nsec > node_mtime.1) {
                node.data_mut().set_mtime(mtime, mtime_nsec);
            }

            self.sync_tree(node)?;
        }

        Ok(())
    }

    fn write_node_inner_records(
        &mut self,
        node: &mut TreeData<Node>,
        offset: &mut u64,
        buf: &[u8],
    ) -> Result<bool> {
        let mut node_changed = false;

        let record_level = node.data().record_level();
        let node_size = node.data().size();
        let node_records = node_size.div_ceil(record_level.bytes());

        let mut i = 0;
        while i < buf.len() {
            let j = (*offset % record_level.bytes()) as usize;
            let len = min(buf.len() - i, record_level.bytes() as usize - j);
            let level = BlockLevel::for_bytes((j + len) as u64);

            let mut record_ptr = if node_records > (*offset / record_level.bytes()) {
                self.node_record_ptr(node, *offset / record_level.bytes())?
            } else {
                BlockPtr::null(BlockMeta::new(level))
            };
            let mut record = unsafe { self.read_record(record_ptr, level)? };

            // If record has changed
            if buf[i..i + len] != record.data()[j..j + len] {
                // Update record in memory
                record.data_mut()[j..j + len].copy_from_slice(&buf[i..i + len]);

                // Handle record compression, if record is larger than one block
                let decomp_level = record.addr().level();
                if decomp_level.0 > 0 {
                    assert_eq!(decomp_level.bytes(), record.data().len() as u64);
                    match lz4_flex::compress_into(record.data(), &mut self.fs.compress_cache) {
                        Ok(comp_len) => {
                            let total_len = comp_len + 2;
                            // Maximum compressed record size is 64 KiB
                            if total_len <= 64 * 1024 {
                                let comp_level = BlockLevel::for_bytes(total_len as u64);
                                // Replace record with compressed record, if it saves space
                                if comp_level < decomp_level {
                                    if let Some(mut comp) = RecordRaw::empty(comp_level) {
                                        // First two bytes store compressed data length
                                        comp[0] = comp_len as u8;
                                        comp[1] = (comp_len >> 8) as u8;
                                        comp[2..total_len]
                                            .copy_from_slice(&self.fs.compress_cache[..comp_len]);
                                        record = BlockData::new(
                                            BlockAddr::null(BlockMeta::new_compressed(
                                                comp_level,
                                                decomp_level,
                                            )),
                                            comp,
                                        );
                                    }
                                }
                            }
                        }
                        Err(_err) => {
                            // Failures to compress can be ignored, with the original record data used
                        }
                    }
                }

                // CoW record using its current level
                let new_addr = unsafe { self.allocate(node, record.addr().meta())? };
                let mut old_addr = record.swap_addr(new_addr);

                // If the record was resized we need to dealloc the original ptr
                if old_addr.is_null() {
                    old_addr = record_ptr.addr();
                }

                // Write record to disk
                //TODO: deallocate new_addr on failure?
                record_ptr = unsafe { self.write_block(record)? };

                // Update record pointer
                self.sync_node_record_ptr(node, *offset / record_level.bytes(), record_ptr)?;
                node_changed = true;

                // Deallocate old record
                if !old_addr.is_null() {
                    unsafe {
                        self.deallocate(node, old_addr);
                    }
                }
            }

            i += len;
            *offset += len as u64;
        }

        if node.data().size() < *offset {
            node.data_mut().set_size(*offset);
            node_changed = true;
        }

        Ok(node_changed)
    }

    pub fn write_node_inner(
        &mut self,
        node: &mut TreeData<Node>,
        offset: &mut u64,
        buf: &[u8],
    ) -> Result<bool> {
        let mut node_changed = false;

        // Try writing to inline data
        let node_size = node.data().size();
        let convert_inline = if let Some(inline_data) = node.data_mut().inline_data_mut() {
            let end = *offset + (buf.len() as u64);
            if end < inline_data.len() as u64 {
                inline_data[*offset as usize..end as usize].copy_from_slice(buf);
                *offset += buf.len() as u64;
                if node.data().size() < *offset {
                    node.data_mut().set_size(*offset);
                }
                return Ok(true);
            } else {
                Some(inline_data[..min(node_size as usize, inline_data.len())].to_vec())
            }
        } else {
            None
        };

        if let Some(inline_data) = convert_inline {
            // If inline data cannot fit, convert to records
            let mut flags = node.data().flags();
            flags.remove(NodeFlags::INLINE_DATA);
            node.data_mut().set_flags(flags);
            node.data_mut().level_data = NodeLevelData::default();
            self.write_node_inner_records(node, &mut 0, &inline_data)?;
            node_changed = true;
        }

        if self.write_node_inner_records(node, offset, buf)? {
            node_changed = true;
        }

        Ok(node_changed)
    }

    /// Write the bytes at `buf` to `node` starting at `offset`.
    pub fn write_node(
        &mut self,
        node_ptr: TreePtr<Node>,
        mut offset: u64,
        buf: &[u8],
        mtime: u64,
        mtime_nsec: u32,
    ) -> Result<usize> {
        let mut node = self.read_tree(node_ptr)?;

        if self.write_node_inner(&mut node, &mut offset, buf)? {
            let node_mtime = node.data().mtime();
            if mtime > node_mtime.0 || (mtime == node_mtime.0 && mtime_nsec > node_mtime.1) {
                node.data_mut().set_mtime(mtime, mtime_nsec);
            }

            self.sync_tree(node)?;
        }

        Ok(buf.len())
    }
}