ext2 0.1.1

Read and write on Ext2 partitions without mount
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
mod body;
mod disk;
mod header;
mod syscall;
mod tools;

use super::IoResult;

use disk::Disk;
use header::{BlockGroupDescriptor, SuperBlock};

pub use body::{DirectoryEntry, DirectoryEntryType, Entry, Inode, TypePerm};
pub use tools::div_rounded_up;

use tools::{align_next, err_if_zero, u32_align_next, Block};

use bit_field::{BitArray, BitField};
use nix::errno::Errno;

use std::cell::RefCell;
use std::fmt;
use std::io::{Read, Seek, Write};
use std::mem::size_of;
#[cfg(unstable)]
use std::mem::MaybeUninit;

/// Global structure of ext2Filesystem, such as disk partition.
pub struct Ext2Filesystem<T: Read + Write + Seek> {
    superblock: SuperBlock,
    superblock_addr: u64,
    disk: RefCell<Disk<T>>,
    nbr_block_grp: u32,
    block_size: u32,
    block_mask: u32,
    block_shift: u32,
    cache: Cache<u64, Block>,
}

impl<T: Read + Write + Seek> fmt::Debug for Ext2Filesystem<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Test")
            .field("superblock", &self.superblock)
            .field("superblock_addr", &self.superblock_addr)
            .field("nbr_block_grp", &self.nbr_block_grp)
            .field("block_size", &self.block_size)
            .field("block_mask", &self.block_mask)
            .field("block_shift", &self.block_shift)
            .field("cache", &self.cache)
            // Not include disk in debug output.
            .finish()
    }
}

/// Used to help confirm the presence of Ext2 on a volume
const EXT2_SIGNATURE_MAGIC: u16 = 0xef53;

/// Magic iterator over the entire fileSytem
struct EntryIter<'a, T: Read + Write + Seek> {
    filesystem: &'a Ext2Filesystem<T>,
    inode: (Inode, u64),
    curr_offset: u32,
}

impl<'a, T: Read + Write + Seek> Iterator for EntryIter<'a, T> {
    type Item = (DirectoryEntry, u32);
    fn next(&mut self) -> Option<Self::Item> {
        if let Some(d) = self
            .filesystem
            .find_entry((&mut self.inode.0, self.inode.1), self.curr_offset as u64)
        {
            let curr_offset = self.curr_offset;
            self.curr_offset += d.get_size() as u32;
            if d.get_inode() == 0 {
                self.next()
            } else {
                Some((d, curr_offset))
            }
        } else {
            None
        }
    }
}

type OffsetDirEntry = u32;
type InodeAddr = u64;
type InodeNbr = u32;

impl<T: Read + Write + Seek> Ext2Filesystem<T> {
    /// Invocation of a new FileSystem instance: take a FD and his reader as parameter
    pub fn new(disk: T) -> IoResult<Self> {
        let superblock_addr = 1024;
        let mut disk = Disk(disk);
        let superblock: SuperBlock = disk.read_struct(superblock_addr)?;

        let signature = superblock.get_ext2_signature();
        if signature != EXT2_SIGNATURE_MAGIC {
            return Err(Errno::EINVAL);
        }

        // consistency check
        let nbr_block_grp = superblock.get_nbr_block_grp();
        assert_eq!(nbr_block_grp, superblock.get_inode_block_grp());

        let block_size = 1024 << superblock.get_log2_block_size();
        // Check block_size constraints
        assert!(block_size != 0 && (block_size & (block_size - 1)) == 0);
        let block_mask = block_size - 1;
        let block_shift = u32::trailing_zeros(block_size);

        Ok(Self {
            block_size,
            block_mask,
            block_shift,
            superblock,
            superblock_addr,
            nbr_block_grp,
            disk: RefCell::new(disk),
            cache: Cache::new(block_size as usize / size_of::<Block>()),
        })
    }

    fn find_entry_in_inode(
        &self,
        inode_nbr: u32,
        filename: &str,
    ) -> IoResult<(DirectoryEntry, OffsetDirEntry)> {
        Ok(self
            .iter_entries(inode_nbr)?
            .find(|(x, _)| unsafe { x.get_filename() } == filename)
            .ok_or(Errno::ENOENT)?)
    }

    /// truncate inode to the size `new_size` deleting all data blocks above
    fn truncate_inode(
        &mut self,
        (inode, inode_addr): (&mut Inode, InodeAddr),
        new_size: u64,
    ) -> IoResult<()> {
        let size = inode.get_size();
        assert!(new_size <= size);
        if size == 0 {
            return Ok(());
        }
        let new_size_block = self.to_block_addr(new_size);
        // let curr_size = self.to_block_addr(align_next(size, self.block_size as u64));
        // size - 1 to get the previous block addr
        let curr_size = self.to_block_addr(size - 1);
        for block_off in (new_size_block.0..=curr_size.0).rev() {
            self.inode_free_block((inode, inode_addr), Block(block_off))
                .unwrap();
        }
        inode.update_size(new_size, self.block_size);
        self.disk.borrow_mut().write_struct(inode_addr, inode)?;
        Ok(())
    }

    /// delete inode `inode_nbr`
    fn free_inode(
        &mut self,
        (inode, inode_addr): (&mut Inode, InodeAddr),
        inode_nbr: u32,
    ) -> IoResult<()> {
        assert!(inode_nbr >= 1);
        /* Delete Data Blocks */
        // don't truncate inode if it is a fast symbolic link
        if !(inode.type_and_perm.is_symlink()
            && inode.get_size() <= Inode::FAST_SYMLINK_SIZE_MAX as u64)
        {
            self.truncate_inode((inode, inode_addr), 0).unwrap();
        }
        /* Unset Inode bitmap */
        let block_grp = (inode_nbr - 1) / self.superblock.inodes_per_block_grp;
        let index = (inode_nbr as u64 - 1) % self.superblock.inodes_per_block_grp as u64;
        let (mut block_dtr, block_dtr_addr) = self.get_block_grp_descriptor(block_grp)?;
        let bitmap_addr = self.to_addr(block_dtr.inode_usage_bitmap);

        let mut disk = self.disk.borrow_mut();
        let mut bitmap: u8 = disk.read_struct(bitmap_addr + index / 8)?;
        assert!(bitmap.get_bit((index % 8) as usize));
        bitmap.set_bit((index % 8) as usize, false);
        disk.write_struct(bitmap_addr + index / 8, &bitmap)?;

        // debug_assert!(self.get_inode(inode_nbr).is_err());
        // TODO: check that with fsck
        block_dtr.nbr_free_inodes += 1;
        self.superblock.nbr_free_inodes += 1;
        block_dtr.nbr_free_inodes;
        disk.write_struct(self.superblock_addr, &self.superblock)?;
        disk.write_struct(block_dtr_addr, &block_dtr)?;
        Ok(())
    }

    /// decrement link count of the inode and delete it if it becomes 0
    /// panic if the inode refers to a directory
    fn unlink_inode(&mut self, inode_nbr: u32, free_inode_data: bool) -> IoResult<()> {
        let (mut inode, inode_addr) = self.get_inode(inode_nbr)?;
        if inode.is_a_directory() {
            #[cfg(unstable)]
            return Err(Errno::EISDIR);
            #[cfg(not(unstable))]
            return Err(Errno::EPERM);
        }
        if inode.nbr_hard_links <= 1 && free_inode_data {
            return self.free_inode((&mut inode, inode_addr), inode_nbr);
        }
        inode.nbr_hard_links -= 1;
        self.disk.borrow_mut().write_struct(inode_addr, &inode)?;
        Ok(())
    }

    /// delete the entry at entry_off of the parent_inode nbr
    fn delete_entry(&mut self, parent_inode_nbr: u32, entry_off: u32) -> IoResult<()> {
        let (mut inode, inode_addr) = self.get_inode(parent_inode_nbr)?;
        let curr_offset = entry_off;
        let entry = self
            .find_entry((&mut inode, inode_addr), curr_offset as u64)
            .unwrap();

        let (mut previous, previous_offset) = self
            .iter_entries(parent_inode_nbr)
            .unwrap()
            .take_while(|(_, off)| *off < entry_off)
            .last()
            .unwrap();
        /* if it is the last entry */
        if self
            .find_entry(
                (&mut inode, inode_addr),
                curr_offset as u64 + entry.get_size() as u64,
            )
            .is_none()
        {
            self.set_as_last_entry((&mut inode, inode_addr), (&mut previous, previous_offset))
        }
        /* Else, we set previous next to current next.
        this creates a Hole which will be filled in push_entry */
        else {
            let next_entry_off = curr_offset as u64 + entry.get_size() as u64;
            let previous_entry_addr = self
                .inode_data_may_alloc((&mut inode, inode_addr), previous_offset as u64)
                .unwrap();
            previous.set_size((next_entry_off - previous_offset as u64) as u16);
            previous.write_on_disk(previous_entry_addr, &mut self.disk.borrow_mut())?;
            Ok(())
        }
    }

    /// convert a block to an address
    fn to_addr(&self, block_number: Block) -> u64 {
        self.block_size as u64 * block_number.0 as u64
    }

    /// convert an address to a number of block
    fn to_block_addr(&self, size: u64) -> Block {
        Block((size / self.block_size as u64) as u32)
    }

    /// convert an address to a number of block
    fn to_block(&self, size: u64) -> Block {
        Block(
            (size / self.block_size as u64 + ((size % self.block_size as u64 != 0) as u64)) as u32,
        )
    }

    /// get inode nbr inode and return the Inode and it's address
    fn get_inode(&self, inode: u32) -> IoResult<(Inode, InodeAddr)> {
        assert!(inode >= 1);
        let block_grp = (inode - 1) / self.superblock.inodes_per_block_grp;
        let index = (inode as u64 - 1) % self.superblock.inodes_per_block_grp as u64;
        let inode_offset = index as u64 * self.superblock.get_size_inode() as u64;

        let (block_dtr, _) = self.get_block_grp_descriptor(block_grp)?;
        let bitmap_addr = self.to_addr(block_dtr.inode_usage_bitmap);
        let bitmap: u8 = self
            .disk
            .borrow_mut()
            .read_struct(bitmap_addr + index / 8)?;
        if !bitmap.get_bit((index % 8) as usize) {
            return Err(Errno::ENOENT);
        }

        let inode_addr = self.to_addr(block_dtr.inode_table) + inode_offset;

        Ok((self.disk.borrow_mut().read_struct(inode_addr)?, inode_addr))
    }

    //TODO: better handle disk error
    /// try to allocate a new inode on block group n and return the inode number
    fn alloc_inode_on_grp(&mut self, n: u32) -> Option<InodeNbr> {
        let (mut block_dtr, block_dtr_addr) = self.get_block_grp_descriptor(n).ok()?;
        if block_dtr.nbr_free_inodes == 0 {
            return None;
        }
        let mut disk = self.disk.borrow_mut();

        // TODO: dynamic alloc ?
        let bitmap_addr = self.to_addr(block_dtr.inode_usage_bitmap);
        let mut bitmap: [u8; 1024] = disk.read_struct(bitmap_addr).ok()?;
        for i in 0..self.superblock.inodes_per_block_grp {
            if !bitmap.get_bit(i as usize) {
                bitmap.set_bit(i as usize, true);
                disk.write_struct(bitmap_addr + i as u64 / 8, &bitmap[(i / 8) as usize])
                    .ok()?;
                block_dtr.nbr_free_inodes -= 1;
                self.superblock.nbr_free_inodes -= 1;
                block_dtr.nbr_free_inodes;
                disk.write_struct(self.superblock_addr, &self.superblock)
                    .ok()?;
                disk.write_struct(block_dtr_addr, &block_dtr).ok()?;
                // TODO: Check the + 1
                return Some(self.superblock.inodes_per_block_grp * n + i + 1);
            }
        }
        None
    }

    /// try to allocate a new inode anywhere on the filesystem and return the inode number
    fn alloc_inode(&mut self) -> Option<InodeNbr> {
        for n in 0..self.nbr_block_grp {
            if let Some(n) = self.alloc_inode_on_grp(n) {
                return Some(n);
            }
        }
        None
    }

    /// the the entry at offset entry_offset the last entry of the directory
    fn set_as_last_entry(
        &mut self,
        (inode, inode_addr): (&mut Inode, InodeAddr),
        (entry, entry_offset): (&mut DirectoryEntry, OffsetDirEntry),
    ) -> IoResult<()> {
        let entry_addr = self.inode_data_alloc((inode, inode_addr), entry_offset as u64)?;

        // =(the offset to the next block)
        entry.set_size((u32_align_next(entry_offset + 1, self.block_size) - entry_offset) as u16);
        entry.write_on_disk(entry_addr, &mut self.disk.borrow_mut())?;
        /* Update inode size */
        let new_size = entry_offset as u64 + entry.get_size() as u64;
        if new_size < inode.get_size() {
            self.truncate_inode((inode, inode_addr), new_size)?;
        } else {
            inode.update_size(new_size, self.block_size);
            self.disk.borrow_mut().write_struct(inode_addr, inode)?;
        }
        Ok(())
    }

    /// push a directory entry on the Directory inode: `parent_inode_nbr`
    fn push_entry(
        &mut self,
        parent_inode_nbr: u32,
        new_entry: &mut DirectoryEntry,
    ) -> IoResult<()> {
        let (mut inode, inode_addr) = self.get_inode(parent_inode_nbr)?;
        // Get the last entry of the Directory
        match self.iter_entries(parent_inode_nbr)?.last() {
            Some((mut entry, offset)) => {
                let offset = offset as u64;

                let entry_addr = self.inode_data_xxx(&mut inode, offset).unwrap();
                // debug_assert_eq!(self.disk.read_struct::<DirectoryEntry>(entry_addr), entry)?;
                let entry_size = entry.size() as u64;

                let new_offset = {
                    let new_offset = align_next(offset + entry_size, 4);
                    // if we do not cross a Block
                    if self.to_block(new_offset) == self.to_block(new_offset + new_entry.size() as u64)
                    // and the block is already allocated
                        && self.inode_data_may_alloc((&mut inode, inode_addr), new_offset).is_ok()
                    //self.to_block( as u32) == self.to_block(offset)
                    {
                        new_offset
                    } else {
                        align_next(offset + entry_size, self.block_size as u64)
                    }
                };
                /* Update previous entry size */
                entry.set_size((new_offset - offset) as u16);
                entry.write_on_disk(entry_addr, &mut self.disk.borrow_mut())?;

                self.set_as_last_entry((&mut inode, inode_addr), (new_entry, new_offset as u32))
            }
            None => self.set_as_last_entry((&mut inode, inode_addr), (new_entry, 0 as u32)),
        }
    }

    /// find the directory entry a offset file.curr_offset
    fn find_entry(&self, inode: (&mut Inode, u64), offset: u64) -> Option<DirectoryEntry> {
        if offset >= inode.0.get_size() {
            return None;
        }
        let base_addr = self.inode_data_xxx(inode.0, offset).ok()? as u64;
        let dir_header: DirectoryEntry = self.disk.borrow_mut().read_struct(base_addr).ok()?;
        Some(dir_header)
    }

    /// iter of the entries of inodes if inode is a directory
    fn iter_entries<'a>(&'a self, inode: InodeNbr) -> IoResult<EntryIter<'a, T>> {
        let (inode, inode_addr) = self.get_inode(inode)?;
        if !inode.is_a_directory() {
            #[cfg(unstable)]
            return Err(Errno::ENOTDIR);
            #[cfg(not(unstable))]
            return Err(Errno::EPERM);
        }
        Ok(EntryIter {
            filesystem: self,
            inode: (inode, inode_addr),
            curr_offset: 0,
        })
    }

    /// read the block group descriptor address from the block group number starting at 0
    fn block_grp_descriptor_addr(&self, n: u32) -> u64 {
        // The table is located in the block immediately following the
        // Superblock. So if the block size (determined from a field
        // in the superblock) is 1024 bytes per block, the Block Group
        // Descriptor Table will begin at block 2. For any other block
        // size, it will begin at block 1. Remember that blocks are
        // numbered starting at 0, and that block numbers don't
        // usually correspond to physical block addresses.
        assert!(n <= self.nbr_block_grp);
        let offset = if self.block_size == 1024 { 2 } else { 1 };

        self.to_addr(Block(offset)) + n as u64 * size_of::<BlockGroupDescriptor>() as u64
    }

    /// read the block group descriptor from the block group number starting at 0
    fn get_block_grp_descriptor(&self, n: u32) -> IoResult<(BlockGroupDescriptor, u64)> {
        let block_grp_addr = self.block_grp_descriptor_addr(n);
        let block_grp: BlockGroupDescriptor = self.disk.borrow_mut().read_struct(block_grp_addr)?;
        Ok((block_grp, block_grp_addr))
    }

    /// try to allocate a new block on block grp number `n`
    fn alloc_block_on_grp(&mut self, n: u32) -> Option<Block> {
        let (mut block_dtr, block_dtr_addr) = self.get_block_grp_descriptor(n).ok()?;
        if block_dtr.nbr_free_blocks == 0 {
            return None;
        }
        // TODO: dynamic alloc ?
        let bitmap_addr = self.to_addr(block_dtr.block_usage_bitmap);
        let mut bitmap: [u8; 1024] = self.disk.borrow_mut().read_struct(bitmap_addr).ok()?;
        for i in 0..self.superblock.get_block_per_block_grp().0 {
            if !bitmap.get_bit(i as usize) {
                bitmap.set_bit(i as usize, true);
                self.disk
                    .borrow_mut()
                    .write_struct(bitmap_addr + i as u64 / 8, &bitmap[(i / 8) as usize])
                    .ok()?;

                block_dtr.nbr_free_blocks -= 1;
                self.disk
                    .borrow_mut()
                    .write_struct(block_dtr_addr, &block_dtr)
                    .ok()?;
                self.superblock.nbr_free_blocks -= 1;
                self.disk
                    .borrow_mut()
                    .write_struct(self.superblock_addr, &self.superblock)
                    .ok()?;
                // TODO: Check the + 1
                return Some(self.superblock.get_block_per_block_grp() * n + Block(i + 1));
            }
        }
        None
    }

    /// try to allocate a new block anywhere on the filesystem
    fn alloc_block(&mut self) -> Option<Block> {
        for n in 0..self.nbr_block_grp {
            if let Some(addr) = self.alloc_block_on_grp(n) {
                // TODO: dynamic alloc ?
                let _res = self
                    .disk
                    .borrow_mut()
                    .write_buffer(self.to_addr(addr), &[0; 1024]);
                return Some(addr);
            }
        }
        None
    }

    /// try to free the block block_nbr
    fn free_block(&mut self, block_nbr: Block) -> IoResult<()> {
        let block_grp = (block_nbr.0 - 1) / self.superblock.get_block_per_block_grp().0;
        let index = (block_nbr.0 as u64 - 1) % self.superblock.get_block_per_block_grp().0 as u64;

        let (mut block_dtr, block_dtr_addr) = self.get_block_grp_descriptor(block_grp)?;
        let bitmap_addr = self.to_addr(block_dtr.block_usage_bitmap);

        let mut disk = self.disk.borrow_mut();
        let mut bitmap: u8 = disk.read_struct(bitmap_addr + index / 8)?;
        assert!(bitmap.get_bit((index % 8) as usize));
        bitmap.set_bit((index % 8) as usize, false);

        disk.write_struct(bitmap_addr + index / 8, &bitmap)?;
        block_dtr.nbr_free_blocks += 1;
        disk.write_struct(block_dtr_addr, &block_dtr)?;
        self.superblock.nbr_free_blocks += 1;
        disk.write_struct(self.superblock_addr, &self.superblock)?;
        Ok(())
    }

    /// get the data of inode at offset `offset`, and allocate the data block if necessary
    fn inode_data_alloc(&mut self, inode: (&mut Inode, u64), offset: u64) -> IoResult<u64> {
        self.inode_data_may_alloc(inode, offset)
    }

    /// alloc a pointer (used by the function inode_data_alloc)
    fn alloc_pointer(&mut self, pointer_addr: u64) -> IoResult<Block> {
        err_if_zero({
            let pointer = self.disk.borrow_mut().read_struct(pointer_addr)?;
            if pointer == Block(0) {
                let new_block = self.alloc_block().ok_or(Errno::ENOSPC)?;
                self.disk
                    .borrow_mut()
                    .write_struct(pointer_addr, &new_block)?;
                new_block
            } else {
                pointer
            }
        })
    }

    fn pointer(&self, pointer_addr: u64) -> IoResult<Block> {
        err_if_zero({
            let pointer = self.disk.borrow_mut().read_struct(pointer_addr)?;
            pointer
        })
    }

    /// free a pointer (used by the function inode_data_alloc)
    fn free_pointer(&mut self, pointer_addr: u64) -> IoResult<()> {
        let pointer = self.disk.borrow_mut().read_struct(pointer_addr)?;
        if pointer == Block(0) {
            panic!("free pointer null");
        } else {
            self.disk
                .borrow_mut()
                .write_struct(pointer_addr, &Block(0))?;
            self.free_block(pointer)
        }
    }

    /// Get the file location at offset 'offset'
    fn inode_free_block(
        &mut self,
        (inode, inode_addr): (&mut Inode, InodeAddr),
        block_off: Block,
    ) -> IoResult<()> {
        let blocknumber_per_block = (self.block_size as usize / size_of::<Block>()) as u32;
        let block_off = block_off.0 as u64;

        // SIMPLE ADDRESSING
        let mut offset_start = 0;
        let mut offset_end = 12;
        if block_off >= offset_start && block_off < offset_end {
            let pointer = err_if_zero(inode.direct_block_pointers[block_off as usize])?;
            self.free_block(pointer)?;
            inode.direct_block_pointers[block_off as usize] = Block(0);
            self.disk.borrow_mut().write_struct(inode_addr, inode)?;
            return Ok(());
        }

        // SINGLY INDIRECT ADDRESSING
        // 12 * blocksize .. 12 * blocksize + (blocksize / 4) * blocksize
        offset_start = offset_end;
        offset_end += blocknumber_per_block as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off = (block_off - offset_start) as u64;
            let pointer = err_if_zero(inode.singly_indirect_block_pointers)?;

            self.free_pointer(self.to_addr(pointer) + off * size_of::<Block>() as u64)?;

            if block_off == offset_start {
                let pointer = err_if_zero(inode.singly_indirect_block_pointers)?;
                self.free_block(pointer)?;
                inode.singly_indirect_block_pointers = Block(0);
                self.disk.borrow_mut().write_struct(inode_addr, inode)?;
            }
            return Ok(());
        }

        // DOUBLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end += (blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let doubly_indirect = err_if_zero(inode.doubly_indirect_block_pointers)?;

            let off_doubly = (block_off - offset_start) / blocknumber_per_block as u64;
            let addr_pointer_to_pointer =
                self.to_addr(doubly_indirect) + off_doubly * size_of::<Block>() as u64;

            let pointer_to_pointer: Block = err_if_zero(
                self.disk
                    .borrow_mut()
                    .read_struct(addr_pointer_to_pointer)?,
            )?;
            let off = (block_off - offset_start) % blocknumber_per_block as u64;

            self.free_pointer(self.to_addr(pointer_to_pointer) + off * size_of::<Block>() as u64)?;

            if off == 0 {
                self.free_pointer(addr_pointer_to_pointer)?;
            }

            if block_off == offset_start {
                let pointer = err_if_zero(inode.doubly_indirect_block_pointers)?;
                self.free_block(pointer)?;
                inode.doubly_indirect_block_pointers = Block(0);
                self.disk.borrow_mut().write_struct(inode_addr, inode)?;
            }
            return Ok(());
        }

        // TRIPLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end +=
            (blocknumber_per_block * blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off_triply =
                (block_off - offset_start) / (blocknumber_per_block * blocknumber_per_block) as u64;

            let tripply_indirect = err_if_zero(inode.triply_indirect_block_pointers)?;

            let addr_pointer_to_pointer_to_pointer =
                self.to_addr(tripply_indirect) + off_triply * size_of::<Block>() as u64;
            let pointer_to_pointer_to_pointer: Block = err_if_zero(
                self.disk
                    .borrow_mut()
                    .read_struct(addr_pointer_to_pointer_to_pointer)?,
            )?;

            let off_doubly = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                / blocknumber_per_block as u64) as u64;

            let addr_pointer_to_pointer = self.to_addr(pointer_to_pointer_to_pointer)
                + off_doubly * size_of::<Block>() as u64;

            let pointer_to_pointer: Block = err_if_zero(
                self.disk
                    .borrow_mut()
                    .read_struct(addr_pointer_to_pointer)?,
            )?;

            let off = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                % blocknumber_per_block as u64) as u64;

            self.free_pointer(self.to_addr(pointer_to_pointer) + off * size_of::<Block>() as u64)?;

            if off == 0 {
                self.free_pointer(addr_pointer_to_pointer)?;
            }

            if off_doubly == 0 {
                self.free_pointer(addr_pointer_to_pointer_to_pointer)?;
            }

            if block_off == offset_start {
                let pointer = err_if_zero(inode.triply_indirect_block_pointers)?;
                self.free_block(pointer)?;
                inode.triply_indirect_block_pointers = Block(0);
                self.disk.borrow_mut().write_struct(inode_addr, inode)?;
            }
            return Ok(());
        }
        Err(Errno::EFBIG)
    }

    /// Get the file location at offset 'offset'
    fn inode_data_may_alloc(
        &mut self,
        (inode, inode_addr): (&mut Inode, InodeAddr),
        offset: u64,
    ) -> IoResult<u64> {
        let block_off = offset / self.block_size as u64;
        let blocknumber_per_block = self.block_size as usize / size_of::<Block>();

        // SIMPLE ADDRESSING
        let mut offset_start = 0;
        let mut offset_end = 12;
        if block_off >= offset_start && block_off < offset_end {
            if inode.direct_block_pointers[block_off as usize] == Block(0) {
                inode.direct_block_pointers[block_off as usize] =
                    self.alloc_block().ok_or(Errno::ENOSPC)?;
                self.disk.borrow_mut().write_struct(inode_addr, inode)?;
            }
            return Ok(self.to_addr(err_if_zero(
                inode.direct_block_pointers[block_off as usize],
            )?) + offset % self.block_size as u64);
        }

        // SINGLY INDIRECT ADDRESSING
        // 12 * blocksize .. 12 * blocksize + (blocksize / 4) * blocksize
        offset_start = offset_end;
        offset_end += blocknumber_per_block as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off = block_off - offset_start;

            let singly_indirect = err_if_zero({
                if inode.singly_indirect_block_pointers == Block(0) {
                    inode.singly_indirect_block_pointers =
                        self.alloc_block().ok_or(Errno::ENOSPC)?;
                    self.disk.borrow_mut().write_struct(inode_addr, inode)?;
                }
                inode.singly_indirect_block_pointers
            })?;

            let pointer: Block = self
                .alloc_pointer(self.to_addr(singly_indirect) + off * size_of::<Block>() as u64)?;

            return Ok(self.to_addr(pointer) + offset % self.block_size as u64);
        }

        // DOUBLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end += (blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off = (block_off - offset_start) / blocknumber_per_block as u64;
            let doubly_indirect = err_if_zero({
                if inode.doubly_indirect_block_pointers == Block(0) {
                    inode.doubly_indirect_block_pointers =
                        self.alloc_block().ok_or(Errno::ENOSPC)?;
                    self.disk.borrow_mut().write_struct(inode_addr, inode)?;
                }
                inode.doubly_indirect_block_pointers
            })?;
            let pointer_to_pointer: Block = self
                .alloc_pointer(self.to_addr(doubly_indirect) + off * size_of::<Block>() as u64)?;
            let off = (block_off - offset_start) % blocknumber_per_block as u64;
            let pointer: Block = self.alloc_pointer(
                self.to_addr(pointer_to_pointer) + off * size_of::<Block>() as u64,
            )?;
            return Ok(self.to_addr(pointer) + offset % self.block_size as u64);
        }

        // TRIPLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end +=
            (blocknumber_per_block * blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off =
                (block_off - offset_start) / (blocknumber_per_block * blocknumber_per_block) as u64;

            let tripply_indirect = err_if_zero({
                if inode.triply_indirect_block_pointers == Block(0) {
                    inode.triply_indirect_block_pointers =
                        self.alloc_block().ok_or(Errno::ENOSPC)?;
                    self.disk.borrow_mut().write_struct(inode_addr, inode)?;
                }
                inode.triply_indirect_block_pointers
            })?;
            let pointer_to_pointer_to_pointer: Block = self
                .alloc_pointer(self.to_addr(tripply_indirect) + off * size_of::<Block>() as u64)?;

            let off = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                / blocknumber_per_block as u64) as u64;
            let pointer_to_pointer: Block = self.alloc_pointer(
                self.to_addr(pointer_to_pointer_to_pointer) + off * size_of::<Block>() as u64,
            )?;

            let off = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                % blocknumber_per_block as u64) as u64;
            let pointer: Block = self.alloc_pointer(
                self.to_addr(pointer_to_pointer) + off * size_of::<Block>() as u64,
            )?;

            return Ok(self.to_addr(pointer) + offset % self.block_size as u64);
        }
        Err(Errno::EFBIG)
    }

    /// Get the file location at offset 'offset'
    /// Return which block store the file data at offset T
    /// Simple Read without CACHE
    fn inode_data_xxx(&self, inode: &mut Inode, offset: u64) -> IoResult<u64> {
        let block_off = offset / self.block_size as u64;
        let blocknumber_per_block = self.block_size as usize / size_of::<Block>();

        // SIMPLE ADDRESSING
        let mut offset_start = 0;
        let mut offset_end = 12;
        if block_off >= offset_start && block_off < offset_end {
            return Ok(self.to_addr(err_if_zero(
                inode.direct_block_pointers[block_off as usize],
            )?) + offset % self.block_size as u64);
        }

        // SINGLY INDIRECT ADDRESSING
        // 12 * blocksize .. 12 * blocksize + (blocksize / 4) * blocksize
        offset_start = offset_end;
        offset_end += blocknumber_per_block as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off = block_off - offset_start;

            let singly_indirect = err_if_zero(inode.singly_indirect_block_pointers)?;

            let pointer: Block =
                self.pointer(self.to_addr(singly_indirect) + off * size_of::<Block>() as u64)?;

            return Ok(self.to_addr(pointer) + offset % self.block_size as u64);
        }

        // DOUBLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end += (blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off = (block_off - offset_start) / blocknumber_per_block as u64;
            let doubly_indirect = err_if_zero(inode.doubly_indirect_block_pointers)?;
            let pointer_to_pointer: Block =
                self.pointer(self.to_addr(doubly_indirect) + off * size_of::<Block>() as u64)?;
            let off = (block_off - offset_start) % blocknumber_per_block as u64;
            let pointer: Block =
                self.pointer(self.to_addr(pointer_to_pointer) + off * size_of::<Block>() as u64)?;
            return Ok(self.to_addr(pointer) + offset % self.block_size as u64);
        }

        // TRIPLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end +=
            (blocknumber_per_block * blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off =
                (block_off - offset_start) / (blocknumber_per_block * blocknumber_per_block) as u64;

            let tripply_indirect = err_if_zero(inode.triply_indirect_block_pointers)?;
            let pointer_to_pointer_to_pointer: Block =
                self.pointer(self.to_addr(tripply_indirect) + off * size_of::<Block>() as u64)?;

            let off = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                / blocknumber_per_block as u64) as u64;
            let pointer_to_pointer: Block = self.pointer(
                self.to_addr(pointer_to_pointer_to_pointer) + off * size_of::<Block>() as u64,
            )?;

            let off = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                % blocknumber_per_block as u64) as u64;
            let pointer: Block =
                self.pointer(self.to_addr(pointer_to_pointer) + off * size_of::<Block>() as u64)?;

            return Ok(self.to_addr(pointer) + offset % self.block_size as u64);
        }
        Err(Errno::EFBIG)
    }

    /// Get the file location at offset 'offset'
    /// Return which block store the file data at offset T
    /// Simple Read
    fn inode_data(&mut self, inode: &Inode, offset: u64) -> IoResult<u64> {
        let block_off = offset >> self.block_shift as u64;
        let blocknumber_per_block = self.block_size as usize / size_of::<Block>();
        let blocknumber_per_block_mask = blocknumber_per_block - 1;
        let blocknumber_per_block_shift = usize::trailing_zeros(blocknumber_per_block);

        // SIMPLE ADDRESSING
        let mut offset_start = 0;
        let mut offset_end = 12;
        if block_off >= offset_start && block_off < offset_end {
            return Ok(self.to_addr(err_if_zero(
                inode.direct_block_pointers[block_off as usize],
            )?) + (offset & self.block_mask as u64));
        }

        // SINGLY INDIRECT ADDRESSING
        // 12 * blocksize .. 12 * blocksize + (blocksize / 4) * blocksize
        offset_start = offset_end;
        offset_end += blocknumber_per_block as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off = block_off - offset_start;
            let singly_indirect = err_if_zero(inode.singly_indirect_block_pointers)?;

            let addr = self.to_addr(singly_indirect);
            let pointer = self.get_pointer(addr, off, Level::L1)?;
            return Ok(self.to_addr(pointer) + (offset & self.block_mask as u64));
        }

        // DOUBLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end += (blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off = (block_off - offset_start) >> blocknumber_per_block_shift as u64;
            let doubly_indirect = err_if_zero(inode.doubly_indirect_block_pointers)?;

            let addr = self.to_addr(doubly_indirect);
            let pointer_to_pointer = self.get_pointer(addr, off, Level::L1)?;

            let off = (block_off - offset_start) & blocknumber_per_block_mask as u64;

            let addr = self.to_addr(pointer_to_pointer);
            let pointer = self.get_pointer(addr, off, Level::L2)?;

            return Ok(self.to_addr(pointer) + (offset & self.block_mask as u64));
        }

        // TRIPLY INDIRECT ADDRESSING
        offset_start = offset_end;
        offset_end +=
            (blocknumber_per_block * blocknumber_per_block * blocknumber_per_block) as u64;
        if block_off >= offset_start && block_off < offset_end {
            let off =
                (block_off - offset_start) / (blocknumber_per_block * blocknumber_per_block) as u64;
            let tripply_indirect = err_if_zero(inode.triply_indirect_block_pointers)?;

            let addr = self.to_addr(tripply_indirect);
            let pointer_to_pointer_to_pointer = self.get_pointer(addr, off, Level::L1)?;

            let off = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                >> blocknumber_per_block_shift as u64) as u64;

            let addr = self.to_addr(pointer_to_pointer_to_pointer);
            let pointer_to_pointer = self.get_pointer(addr, off, Level::L2)?;

            let off = (((block_off - offset_start)
                % (blocknumber_per_block * blocknumber_per_block) as u64)
                & blocknumber_per_block_mask as u64) as u64;

            let addr = self.to_addr(pointer_to_pointer);
            let pointer = self.get_pointer(addr, off, Level::L3)?;

            return Ok(self.to_addr(pointer) + (offset & self.block_mask as u64));
        }
        Err(Errno::EFBIG)
    }

    /// Get a inode pointer
    #[inline(always)]
    fn get_pointer(&mut self, addr: u64, off: u64, level: Level) -> IoResult<Block> {
        Ok(*match self.cache.get(addr, off as usize, level) {
            Some(p) => p,
            None => {
                let v = self.cache.update_layer(addr, level);
                unsafe {
                    self.disk.borrow_mut().read_buffer(
                        addr,
                        std::slice::from_raw_parts_mut(
                            v.as_mut_ptr() as *mut u8,
                            self.block_size as usize,
                        ),
                    )?
                };
                self.cache
                    .get(addr, off as usize, level)
                    .expect("Must be founded !")
            }
        })
    }
}

const NB_LAYERS: usize = 3;

/// Multi layer cache
#[derive(Debug)]
struct Cache<K, T> {
    #[cfg(unstable)]
    entries: [CacheEntry<K, T>; NB_LAYERS],
    #[cfg(not(unstable))]
    entries: Vec<CacheEntry<K, T>>,
}

impl<K: Eq + PartialEq + Copy, T: Clone + Default> Cache<K, T> {
    /// Create a new multi layer cache
    fn new(nb_elems: usize) -> Self {
        #[cfg(unstable)]
        {
            let mut entries: [MaybeUninit<CacheEntry<K, T>>; NB_LAYERS] =
                MaybeUninit::uninit_array();
            for entry in entries.iter_mut() {
                entry.write(CacheEntry::new(nb_elems));
            }
            Self {
                entries: unsafe { MaybeUninit::array_assume_init(entries) },
            }
        }
        #[cfg(not(unstable))]
        {
            Self {
                entries: vec![CacheEntry::new(nb_elems); NB_LAYERS],
            }
        }
    }

    /// Invalidate all the layers()
    fn invalidate(&mut self) {
        for entry in self.entries.iter_mut() {
            entry.invalidate();
        }
    }

    /// Try to get a layer borrowed data
    fn get(&self, idx: K, offset: usize, level: Level) -> Option<&T> {
        self.entries[get_index(level)].get(idx).map(|v| &v[offset])
    }

    /// Update a layer and get a mutable reference to his content
    fn update_layer(&mut self, idx: K, level: Level) -> &mut Vec<T> {
        self.entries[get_index(level)].update_layer(idx)
    }
}

fn get_index(level: Level) -> usize {
    use Level::*;
    match level {
        L1 => NB_LAYERS - 3,
        L2 => NB_LAYERS - 2,
        L3 => NB_LAYERS - 1,
    }
}

#[derive(Debug, Copy, Clone)]
enum Level {
    L1,
    L2,
    L3,
}

#[derive(Debug, Clone)]
struct CacheEntry<K, T> {
    idx: Option<K>,
    data: Vec<T>,
}

impl<K: Eq + PartialEq + Copy, T: Clone + Default> CacheEntry<K, T> {
    fn new(nb_elems: usize) -> Self {
        Self {
            idx: None,
            data: vec![Default::default(); nb_elems],
        }
    }

    fn invalidate(&mut self) {
        self.idx = None;
    }

    fn get(&self, idx: K) -> Option<&Vec<T>> {
        if let Some(stored_idx) = self.idx {
            if stored_idx == idx {
                return Some(&self.data);
            }
        }
        None
    }

    fn update_layer(&mut self, idx: K) -> &mut Vec<T> {
        self.idx = Some(idx);
        &mut self.data
    }
}