Rewrite IO ops in INode. Add tests for resize.

src/sfs.rs

@@ -1,6 +1,6 @@
 use spin::Mutex;
 use bit_set::BitSet;
-use alloc::{boxed::Box, Vec, BTreeMap, rc::{Rc, Weak}};
+use alloc::{boxed::Box, Vec, BTreeMap, rc::{Rc, Weak}, String};
 use core::cell::{RefCell, RefMut};
 use dirty::Dirty;
 use super::structs::*;
@@ -14,9 +14,9 @@ use core::fmt::{Debug, Formatter, Error};
 pub trait Device {
     fn read_at(&mut self, offset: usize, buf: &mut [u8]) -> Option<usize>;
     fn write_at(&mut self, offset: usize, buf: &[u8]) -> Option<usize>;
+}
 
-    // Helper functions
+trait DeviceExt: Device {
-
     fn read_block(&mut self, id: BlockId, offset: usize, buf: &mut [u8]) -> vfs::Result<()> {
         debug_assert!(offset + buf.len() <= BLKSIZE);
         match self.read_at(id * BLKSIZE + offset, buf) {
@@ -31,9 +31,6 @@ pub trait Device {
             _ => Err(()),
         }
     }
-}
-
-trait DeviceExt: Device {
     /// Load struct `T` from given block in device
     fn load_struct<T: AsBuf>(&mut self, id: BlockId) -> T {
         let mut s: T = unsafe { uninitialized() };
@@ -79,7 +76,7 @@ impl INode {
                 ).unwrap();
                 Some(disk_block_id as BlockId)
             }
-            id => unimplemented!("double indirect blocks is not supported"),
+            _ => unimplemented!("double indirect blocks is not supported"),
         }
     }
     fn set_disk_block_id(&mut self, file_block_id: BlockId, disk_block_id: BlockId) -> vfs::Result<()> {
@@ -89,7 +86,7 @@ impl INode {
             id if id < NDIRECT => {
                 self.disk_inode.direct[id] = disk_block_id as u32;
                 Ok(())
-            },
+            }
             id if id < NDIRECT + BLK_NENTRY => {
                 let disk_block_id = disk_block_id as u32;
                 let fs = self.fs.upgrade().unwrap();
@@ -100,7 +97,7 @@ impl INode {
                 ).unwrap();
                 Ok(())
             }
-            id => unimplemented!("double indirect blocks is not supported"),
+            _ => unimplemented!("double indirect blocks is not supported"),
         }
     }
     /// Only for Dir
@@ -109,7 +106,7 @@ impl INode {
             .map(|i| {
                 use vfs::INode;
                 let mut entry: DiskEntry = unsafe { uninitialized() };
-                self.read_at(i as usize * BLKSIZE, entry.as_buf_mut()).unwrap();
+                self._read_at(i as usize * BLKSIZE, entry.as_buf_mut()).unwrap();
                 entry
             })
             .find(|entry| entry.name.as_ref() == name)
@@ -119,27 +116,104 @@ impl INode {
     fn init_dir(&mut self, parent: INodeId) -> vfs::Result<()> {
         use vfs::INode;
         // Insert entries: '.' '..'
-        self.resize(BLKSIZE * 2).unwrap();
+        self._resize(BLKSIZE * 2).unwrap();
-        self.write_at(BLKSIZE * 1, DiskEntry {
+        self._write_at(BLKSIZE * 1, DiskEntry {
             id: parent as u32,
             name: Str256::from(".."),
         }.as_buf()).unwrap();
         let id = self.id as u32;
-        self.write_at(BLKSIZE * 0, DiskEntry {
+        self._write_at(BLKSIZE * 0, DiskEntry {
             id,
             name: Str256::from("."),
         }.as_buf()).unwrap();
         Ok(())
     }
-    fn clean_at(&mut self, begin: usize, end: usize) -> vfs::Result<()> {
+    /// Resize content size, no matter what type it is.
+    fn _resize(&mut self, len: usize) -> vfs::Result<()> {
+        assert!(len <= MAX_FILE_SIZE, "file size exceed limit");
+        let blocks = ((len + BLKSIZE - 1) / BLKSIZE) as u32;
+        use core::cmp::{Ord, Ordering};
+        match blocks.cmp(&self.disk_inode.blocks) {
+            Ordering::Equal => {}  // Do nothing
+            Ordering::Greater => {
+                let fs = self.fs.upgrade().unwrap();
+                let old_blocks = self.disk_inode.blocks;
+                self.disk_inode.blocks = blocks;
+                // allocate indirect block if need
+                if old_blocks < NDIRECT as u32 && blocks >= NDIRECT as u32 {
+                    self.disk_inode.indirect = fs.alloc_block().unwrap() as u32;
+                }
+                // allocate extra blocks
+                for i in old_blocks..blocks {
+                    let disk_block_id = fs.alloc_block().expect("no more space");
+                    self.set_disk_block_id(i as usize, disk_block_id).unwrap();
+                }
+                // clean up
+                let old_size = self.disk_inode.size as usize;
+                self.disk_inode.size = len as u32;
+                self._clean_at(old_size, len).unwrap();
+            }
+            Ordering::Less => {
+                let fs = self.fs.upgrade().unwrap();
+                // free extra blocks
+                for i in blocks..self.disk_inode.blocks {
+                    let disk_block_id = self.get_disk_block_id(i as usize).unwrap();
+                    fs.free_block(disk_block_id);
+                }
+                // free indirect block if need
+                if blocks < NDIRECT as u32 && self.disk_inode.blocks >= NDIRECT as u32 {
+                    fs.free_block(self.disk_inode.indirect as usize);
+                    self.disk_inode.indirect = 0;
+                }
+                self.disk_inode.blocks = blocks;
+            }
+        }
+        self.disk_inode.size = len as u32;
+        Ok(())
+    }
+    /// Read/Write content, no matter what type it is
+    fn _io_at<F>(&self, begin: usize, end: usize, mut f: F) -> vfs::Result<usize>
+        where F: FnMut(RefMut<Box<Device>>, &BlockRange, usize)
+    {
         let fs = self.fs.upgrade().unwrap();
 
-        let iter = BlockIter { begin, end };
+        let size = match self.disk_inode.type_ {
-        for BlockRange { block, begin, end } in iter {
+            FileType::Dir => self.disk_inode.blocks as usize * BLKSIZE,
-            static ZEROS: [u8; BLKSIZE] = [0; BLKSIZE];
+            FileType::File => self.disk_inode.size as usize,
-            let disk_block_id = self.get_disk_block_id(block).unwrap();
+            _ => unimplemented!(),
-            fs.device.borrow_mut().write_block(disk_block_id, begin, &ZEROS[begin..end]).unwrap();
+        };
+        let iter = BlockIter {
+            begin: size.min(begin),
+            end: size.min(end),
+        };
+
+        // For each block
+        let mut buf_offset = 0usize;
+        for mut range in iter {
+            range.block = self.get_disk_block_id(range.block).unwrap();
+            f(fs.device.borrow_mut(), &range, buf_offset);
+            buf_offset += range.len();
         }
+        Ok(buf_offset)
+    }
+    /// Read content, no matter what type it is
+    fn _read_at(&self, offset: usize, buf: &mut [u8]) -> vfs::Result<usize> {
+        self._io_at(offset, offset + buf.len(), |mut device, range, offset| {
+            device.read_block(range.block, range.begin, &mut buf[offset..offset + range.len()]).unwrap()
+        })
+    }
+    /// Write content, no matter what type it is
+    fn _write_at(&self, offset: usize, buf: &[u8]) -> vfs::Result<usize> {
+        self._io_at(offset, offset + buf.len(), |mut device, range, offset| {
+            device.write_block(range.block, range.begin, &buf[offset..offset + range.len()]).unwrap()
+        })
+    }
+    /// Clean content, no matter what type it is
+    fn _clean_at(&self, begin: usize, end: usize) -> vfs::Result<()> {
+        static ZEROS: [u8; BLKSIZE] = [0; BLKSIZE];
+        self._io_at(begin, end, |mut device, range, _| {
+            device.write_block(range.block, range.begin, &ZEROS[..range.len()]).unwrap()
+        }).unwrap();
         Ok(())
     }
 }
@@ -153,40 +227,12 @@ impl vfs::INode for INode {
         self.sync()
     }
     fn read_at(&self, offset: usize, buf: &mut [u8]) -> vfs::Result<usize> {
-        let fs = self.fs.upgrade().unwrap();
+        assert_eq!(self.disk_inode.type_, FileType::File, "read_at is only available on file");
-
+        self._read_at(offset, buf)
-        let iter = BlockIter {
-            begin: offset,
-            end: offset + buf.len(),
-        };
-
-        // Read for each block
-        let mut buf_offset = 0usize;
-        for BlockRange { block, begin, end } in iter {
-            let disk_block_id = self.get_disk_block_id(block).unwrap();
-            let len = end - begin;
-            fs.device.borrow_mut().read_block(disk_block_id, begin, &mut buf[buf_offset..buf_offset + len]).unwrap();
-            buf_offset += len;
-        }
-        Ok(buf_offset)
     }
     fn write_at(&self, offset: usize, buf: &[u8]) -> vfs::Result<usize> {
-        let fs = self.fs.upgrade().unwrap();
+        assert_eq!(self.disk_inode.type_, FileType::File, "write_at is only available on file");
-
+        self._write_at(offset, buf)
-        let iter = BlockIter {
-            begin: offset,
-            end: offset + buf.len(),
-        };
-
-        // Write for each block
-        let mut buf_offset = 0usize;
-        for BlockRange { block, begin, end } in iter {
-            let disk_block_id = self.get_disk_block_id(block).unwrap();
-            let len = end - begin;
-            fs.device.borrow_mut().write_block(disk_block_id, begin, &buf[buf_offset..buf_offset + len]).unwrap();
-            buf_offset += len;
-        }
-        Ok(buf_offset)
     }
     fn info(&self) -> vfs::Result<vfs::FileInfo> {
         Ok(vfs::FileInfo {
@@ -204,53 +250,13 @@ impl vfs::INode for INode {
         Ok(())
     }
     fn resize(&mut self, len: usize) -> vfs::Result<()> {
-        if len > MAX_FILE_SIZE {
+        assert_eq!(self.disk_inode.type_, FileType::File, "resize is only available on file");
-            return Err(());
+        self._resize(len)
-        }
-        let blocks = ((len + BLKSIZE - 1) / BLKSIZE) as u32;
-        use core::cmp::{Ord, Ordering};
-        match blocks.cmp(&self.disk_inode.blocks) {
-            Ordering::Equal => {},  // Do nothing
-            Ordering::Greater => {
-                let fs = self.fs.upgrade().unwrap();
-                let old_blocks = self.disk_inode.blocks;
-                self.disk_inode.blocks = blocks;
-                // allocate indirect block if need
-                if old_blocks < NDIRECT as u32 && blocks >= NDIRECT as u32 {
-                    self.disk_inode.indirect = fs.alloc_block().unwrap() as u32;
-                }
-                // allocate extra blocks
-                for i in old_blocks .. blocks {
-                    let disk_block_id = fs.alloc_block().expect("no more space");
-                    self.set_disk_block_id(i as usize, disk_block_id).unwrap();
-                }
-                // clean up
-                let old_size = self.disk_inode.size as usize;
-                self.clean_at(old_size, len).unwrap();
-            },
-            Ordering::Less => {
-                let fs = self.fs.upgrade().unwrap();
-                // free extra blocks
-                for i in blocks .. self.disk_inode.blocks {
-                    let disk_block_id = self.get_disk_block_id(i as usize).unwrap();
-                    fs.free_block(disk_block_id);
-                }
-                // free indirect block if need
-                if blocks < NDIRECT as u32 && self.disk_inode.blocks >= NDIRECT as u32 {
-                    fs.free_block(self.disk_inode.indirect as usize);
-                    self.disk_inode.indirect = 0;
-                }
-                self.disk_inode.blocks = blocks;
-            },
-        }
-        self.disk_inode.size = len as u32;
-        Ok(())
     }
     fn create(&mut self, name: &'static str, type_: vfs::FileType) -> vfs::Result<Ptr<vfs::INode>> {
         let fs = self.fs.upgrade().unwrap();
         let info = self.info().unwrap();
         assert_eq!(info.type_, vfs::FileType::Dir);
-        assert_eq!(info.size % BLKSIZE, 0);
 
         // Ensure the name is not exist
         assert!(self.get_file_inode_id(name).is_none(), "file name exist");
@@ -266,8 +272,8 @@ impl vfs::INode for INode {
             id: inode.borrow().id as u32,
             name: Str256::from(name),
         };
-        self.resize(info.size + BLKSIZE).unwrap();
+        self._resize(info.size + BLKSIZE).unwrap();
-        self.write_at(info.size, entry.as_buf()).unwrap();
+        self._write_at(info.size, entry.as_buf()).unwrap();
 
         Ok(inode)
     }
@@ -275,7 +281,6 @@ impl vfs::INode for INode {
         let fs = self.fs.upgrade().unwrap();
         let info = self.info().unwrap();
         assert_eq!(info.type_, vfs::FileType::Dir);
-        assert_eq!(info.size % BLKSIZE, 0);
 
         let (name, rest_path) = match path.find('/') {
             None => (path, ""),
@@ -294,6 +299,17 @@ impl vfs::INode for INode {
             _ => unimplemented!(),
         }
     }
+    fn list(&self) -> vfs::Result<Vec<String>> {
+        assert_eq!(self.disk_inode.type_, FileType::Dir);
+
+        Ok((0..self.disk_inode.blocks)
+            .map(|i| {
+                use vfs::INode;
+                let mut entry: DiskEntry = unsafe { uninitialized() };
+                self._read_at(i as usize * BLKSIZE, entry.as_buf_mut()).unwrap();
+                String::from(entry.name.as_ref())
+            }).collect())
+    }
 }
 
 impl Drop for INode {
@@ -310,13 +326,19 @@ struct BlockIter {
     end: usize,
 }
 
-#[derive(Debug)]
+#[derive(Debug, Eq, PartialEq)]
 struct BlockRange {
     block: BlockId,
     begin: usize,
     end: usize,
 }
 
+impl BlockRange {
+    fn len(&self) -> usize {
+        self.end - self.begin
+    }
+}
+
 impl Iterator for BlockIter {
     type Item = BlockRange;
 
@@ -562,4 +584,13 @@ impl From<FileType> for vfs::FileType {
 #[cfg(test)]
 mod test {
     use super::*;
+
+    #[test]
+    fn block_iter() {
+        let mut iter = BlockIter { begin: 0x123, end: 0x2018 };
+        assert_eq!(iter.next(), Some(BlockRange { block: 0, begin: 0x123, end: 0x1000 }));
+        assert_eq!(iter.next(), Some(BlockRange { block: 1, begin: 0, end: 0x1000 }));
+        assert_eq!(iter.next(), Some(BlockRange { block: 2, begin: 0, end: 0x18 }));
+        assert_eq!(iter.next(), None);
+    }
 }

src/structs.rs

@@ -24,6 +24,7 @@ pub struct SuperBlock {
 #[derive(Debug)]
 pub struct DiskINode {
     /// size of the file (in bytes)
+    /// undefined in dir (256 * #entries ?)
     pub size: u32,
     /// one of SYS_TYPE_* above
     pub type_: FileType,

src/tests.rs

@@ -5,6 +5,8 @@ use super::sfs::*;
 use super::vfs::*;
 use super::vfs::INode;
 use std::rc::Rc;
+use std::mem::uninitialized;
+use super::structs::{DiskEntry, AsBuf};
 
 impl Device for File {
     fn read_at(&mut self, offset: usize, buf: &mut [u8]) -> Option<usize> {
@@ -45,7 +47,7 @@ fn open_sample_file() {
 
 #[test]
 fn create_new_sfs() {
-    _create_new_sfs();
+    let sfs = _create_new_sfs();
 }
 
 #[test]
@@ -54,13 +56,8 @@ fn print_root() {
     let root = sfs.root_inode();
     println!("{:?}", root.borrow());
 
-    use super::structs::{DiskEntry, AsBuf};
+    let files = root.borrow().list().unwrap();
-    use std::mem::uninitialized;
+    println!("{:?}", files);
-    let mut entry: DiskEntry = unsafe{uninitialized()};
-    for i in 0 .. 23 {
-        root.borrow_mut().read_at(i * 4096, entry.as_buf_mut()).unwrap();
-        println!("{:?}", entry);
-    }
 }
 
 #[test]
@@ -79,7 +76,48 @@ fn create_file() {
 }
 
 #[test]
-fn lookup() {
+fn resize() {
+    let sfs = _create_new_sfs();
+    let root = sfs.root_inode();
+    let file1 = root.borrow_mut().create("file1", FileType::File).unwrap();
+    assert_eq!(file1.borrow().info().unwrap().size, 0, "empty file size != 0");
+
+    const SIZE1: usize = 0x1234;
+    const SIZE2: usize = 0x1250;
+    file1.borrow_mut().resize(SIZE1).unwrap();
+    assert_eq!(file1.borrow().info().unwrap().size, SIZE1, "wrong size after resize");
+    let mut data1: [u8; SIZE2] = unsafe{uninitialized()};
+    impl AsBuf for [u8; SIZE2] {}
+    let len = file1.borrow().read_at(0, data1.as_buf_mut()).unwrap();
+    assert_eq!(len, SIZE1, "wrong size returned by read_at()");
+    assert_eq!(&data1[..SIZE1], &[0u8; SIZE1][..], "expanded data should be 0");
+
+    sfs.sync().unwrap();
+}
+
+// FIXME: `should_panic` tests will panic again on exit, due to `Dirty` drop
+
+//#[test]
+//#[should_panic]
+//fn resize_on_dir_should_panic() {
+//    let sfs = _create_new_sfs();
+//    let root = sfs.root_inode();
+//    root.borrow_mut().resize(4096).unwrap();
+//    sfs.sync().unwrap();
+//}
+//
+//#[test]
+//#[should_panic]
+//fn resize_too_large_should_panic() {
+//    let sfs = _create_new_sfs();
+//    let root = sfs.root_inode();
+//    let file1 = root.borrow_mut().create("file1", FileType::File).unwrap();
+//    file1.borrow_mut().resize(1 << 28).unwrap();
+//    sfs.sync().unwrap();
+//}
+
+#[test]
+fn create_then_lookup() {
     let sfs = _create_new_sfs();
     let root = sfs.root_inode();
 

src/vfs.rs

@@ -1,4 +1,4 @@
-use alloc::rc::{Rc, Weak};
+use alloc::{Vec, String, rc::{Rc, Weak}};
 use core::cell::RefCell;
 use core::mem::size_of;
 use core;
@@ -18,6 +18,7 @@ pub trait INode: Debug {
     fn resize(&mut self, len: usize) -> Result<()>;
     fn create(&mut self, name: &'static str, type_: FileType) -> Result<Rc<RefCell<INode>>>;
     fn lookup(&self, path: &'static str) -> Result<Rc<RefCell<INode>>>;
+    fn list(&self) -> Result<Vec<String>>;
 //    fn io_ctrl(&mut self, op: u32, data: &[u8]) -> Result<()>;
 }