Add Thread-safe version of the ext2 implementation

The `Synced<T>` struct is a wrapper over the `Ext2` struct. It
guarantees thread safety through an `Arc` and a spinlock
(`spin::Mutex`).

The `fs::sync` mod provides Thread-safe versions of structs found in `fs`.

Cargo.toml

@@ -6,6 +6,7 @@ authors = ["Szymon Walter <walter.szymon.98@gmail.com>"]
 [dependencies]
 bitflags = "1.0"
 rlibc = { version = "1.0", optional = true }
+spin = "0.4"
 
 [features]
 default = ["no_std"]

src/fs/mod.rs

@@ -1,5 +1,4 @@
 use core::mem;
-use core::slice;
 use core::fmt::{self, Debug};
 use core::nonzero::NonZero;
 
@@ -12,7 +11,9 @@ use sys::superblock::Superblock;
 use sys::block_group::BlockGroupDescriptor;
 use sys::inode::Inode as RawInode;
 
-struct Struct<T, S: SectorSize> {
+pub mod sync;
+
+pub(crate) struct Struct<T, S: SectorSize> {
     pub inner: T,
     pub offset: Address<S>,
 }
@@ -26,9 +27,10 @@ impl<T, S: SectorSize> From<(T, Address<S>)> for Struct<T, S> {
 
 /// Safe wrapper for raw sys structs
 pub struct Ext2<S: SectorSize, V: Volume<u8, S>> {
-    volume: V,
+    // TODO: should this have some different vis?
-    superblock: Struct<Superblock, S>,
+    pub(crate) volume: V,
-    block_groups: Struct<Vec<BlockGroupDescriptor>, S>,
+    pub(crate) superblock: Struct<Superblock, S>,
+    pub(crate) block_groups: Struct<Vec<BlockGroupDescriptor>, S>,
 }
 
 impl<S: SectorSize, V: Volume<u8, S>> Ext2<S, V> {
@@ -162,9 +164,9 @@ impl<S: SectorSize, V: Volume<u8, S>> Ext2<S, V> {
         (self.superblock().rev_major, self.superblock().rev_minor)
     }
 
-    pub fn inode_size<'vol>(&'vol self) -> usize {
+    pub fn inode_size(&self) -> usize {
         if self.version().0 == 0 {
-            mem::size_of::<Inode<'vol, S, V>>()
+            mem::size_of::<RawInode>()
         } else {
             // note: inodes bigger than 128 are not supported
             self.superblock().inode_size as usize
@@ -494,7 +496,7 @@ pub struct Directory<
 impl<'vol, 'inode, S: SectorSize, V: 'vol + Volume<u8, S>> Iterator
     for Directory<'vol, 'inode, S, V>
 {
-    type Item = Result<DirectoryEntry<'vol>, Error>;
+    type Item = Result<DirectoryEntry, Error>;
 
     fn next(&mut self) -> Option<Self::Item> {
         if self.buffer.is_none() || self.offset >= self.block_size {
@@ -520,8 +522,7 @@ impl<'vol, 'inode, S: SectorSize, V: 'vol + Volume<u8, S>> Iterator
         let len = buffer[6];
         let ty = buffer[7];
 
-        let ptr = unsafe { buffer.as_ptr().add(8) };
+        let name = buffer[8..8 + len as usize].to_vec();
-        let name = unsafe { slice::from_raw_parts(ptr, len as usize) };
 
         self.offset += size as usize;
 
@@ -533,8 +534,9 @@ impl<'vol, 'inode, S: SectorSize, V: 'vol + Volume<u8, S>> Iterator
     }
 }
 
-pub struct DirectoryEntry<'a> {
+#[derive(Clone)]
-    pub name: &'a [u8],
+pub struct DirectoryEntry {
+    pub name: Vec<u8>,
     pub inode: usize,
     pub ty: u8,
 }
@@ -695,7 +697,7 @@ mod tests {
                 for entry in dir {
                     assert!(entry.is_ok());
                     let entry = entry.unwrap();
-                    let entry_name = str::from_utf8(entry.name).unwrap_or("?");
+                    let entry_name = str::from_utf8(&entry.name).unwrap_or("?");
                     println!("{}/{} => {}", name, entry_name, entry.inode,);
                     if entry_name != "." && entry_name != ".." {
                         walk(

src/fs/sync.rs

@@ -0,0 +1,634 @@
+use core::fmt::{self, Debug};
+use core::nonzero::NonZero;
+
+use alloc::Vec;
+use alloc::arc::Arc;
+
+use spin::{Mutex, MutexGuard};
+
+use error::Error;
+use sector::{Address, SectorSize};
+use volume::Volume;
+use sys::inode::Inode as RawInode;
+
+use super::Ext2;
+
+pub struct Synced<T> {
+    inner: Arc<Mutex<T>>,
+}
+
+impl<T> Synced<T> {
+    pub fn with_inner(inner: T) -> Synced<T> {
+        Synced {
+            inner: Arc::new(Mutex::new(inner)),
+        }
+    }
+
+    pub fn inner<'a>(&'a self) -> MutexGuard<'a, T> {
+        self.inner.lock()
+    }
+}
+
+impl<T> Clone for Synced<T> {
+    fn clone(&self) -> Self {
+        Synced {
+            inner: self.inner.clone(),
+        }
+    }
+}
+
+impl<S: SectorSize, V: Volume<u8, S>> Synced<Ext2<S, V>> {
+    pub fn new(volume: V) -> Result<Synced<Ext2<S, V>>, Error> {
+        Ext2::new(volume).map(|inner| Synced::with_inner(inner))
+    }
+
+    #[allow(dead_code)]
+    fn update_global(&mut self) -> Result<(), Error> {
+        self.inner().update_global()
+    }
+
+    pub fn read_inode(
+        &self,
+        buf: &mut [u8],
+        inode: &Inode<S, V>,
+    ) -> Result<usize, Error> {
+        let total_size = inode.size();
+        let block_size = self.block_size();
+        let mut offset = 0;
+
+        for block in inode.blocks() {
+            match block {
+                Ok((data, _)) => {
+                    let data_size = block_size
+                        .min(total_size - offset)
+                        .min(buf.len() - offset);
+                    let end = offset + data_size;
+                    buf[offset..end].copy_from_slice(&data[..data_size]);
+                    offset += data_size;
+                }
+                Err(err) => return Err(err.into()),
+            }
+        }
+
+        Ok(offset)
+    }
+
+    pub fn write_inode(
+        &self,
+        _inode: &(Inode<S, V>, Address<S>),
+        _buf: &[u8],
+    ) -> Result<usize, Error> {
+        unimplemented!()
+    }
+
+    pub fn root_inode(&self) -> (Inode<S, V>, Address<S>) {
+        self.inode_nth(2).unwrap()
+    }
+
+    pub fn inode_nth(&self, index: usize) -> Option<(Inode<S, V>, Address<S>)> {
+        self.inodes_nth(index).next()
+    }
+
+    pub fn inodes(&self) -> Inodes<S, V> {
+        self.inodes_nth(1)
+    }
+
+    pub fn inodes_nth(&self, index: usize) -> Inodes<S, V> {
+        assert!(index > 0, "inodes are 1-indexed");
+        let inner = self.inner();
+        Inodes {
+            fs: self.clone(),
+            log_block_size: inner.log_block_size(),
+            inode_size: inner.inode_size(),
+            inodes_per_group: inner.inodes_count(),
+            inodes_count: inner.total_inodes_count(),
+            index,
+        }
+    }
+
+    pub fn version(&self) -> (u32, u16) {
+        self.inner().version()
+    }
+
+    pub fn inode_size(&self) -> usize {
+        self.inner().inode_size()
+    }
+
+    pub fn inodes_count(&self) -> usize {
+        self.inner().inodes_count()
+    }
+
+    pub fn total_inodes_count(&self) -> usize {
+        self.inner().total_inodes_count()
+    }
+
+    pub fn block_group_count(&self) -> Result<usize, Error> {
+        self.inner().block_group_count()
+    }
+
+    pub fn total_block_count(&self) -> usize {
+        self.inner().total_block_count()
+    }
+
+    pub fn free_block_count(&self) -> usize {
+        self.inner().free_block_count()
+    }
+
+    pub fn block_size(&self) -> usize {
+        self.inner().block_size()
+    }
+
+    pub fn log_block_size(&self) -> u32 {
+        self.inner().log_block_size()
+    }
+
+    pub fn sector_size(&self) -> usize {
+        S::SIZE
+    }
+
+    pub fn log_sector_size(&self) -> u32 {
+        S::LOG_SIZE
+    }
+}
+
+impl<S: SectorSize, V: Volume<u8, S>> Debug for Synced<Ext2<S, V>> {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "Synced<Ext2<{}>>", S::SIZE)
+    }
+}
+
+#[derive(Debug, Clone)]
+pub struct Inodes<S: SectorSize, V: Volume<u8, S>> {
+    fs: Synced<Ext2<S, V>>,
+    log_block_size: u32,
+    inode_size: usize,
+    inodes_per_group: usize,
+    inodes_count: usize,
+    index: usize,
+}
+
+impl<S: SectorSize, V: Volume<u8, S>> Iterator for Inodes<S, V> {
+    type Item = (Inode<S, V>, Address<S>);
+
+    fn next(&mut self) -> Option<Self::Item> {
+        if self.index < self.inodes_count {
+            let block_group = (self.index - 1) / self.inodes_per_group;
+            let index = (self.index - 1) % self.inodes_per_group;
+            self.index += 1;
+
+            let fs = self.fs.inner();
+
+            let inodes_block =
+                fs.block_groups.inner[block_group].inode_table_block;
+
+            let offset = Address::with_block_size(
+                inodes_block,
+                (index * self.inode_size) as i32,
+                self.log_block_size,
+            );
+            let raw = unsafe {
+                RawInode::find_inode(&fs.volume, offset, self.inode_size).ok()
+            };
+            raw.map(|(raw, offset)| (Inode::new(self.fs.clone(), raw), offset))
+        } else {
+            None
+        }
+    }
+}
+
+#[derive(Debug)]
+pub struct Inode<S: SectorSize, V: Volume<u8, S>> {
+    fs: Synced<Ext2<S, V>>,
+    inner: RawInode,
+}
+
+impl<S: SectorSize, V: Volume<u8, S>> Clone for Inode<S, V> {
+    fn clone(&self) -> Self {
+        Inode {
+            fs: self.fs.clone(),
+            inner: self.inner,
+        }
+    }
+}
+
+impl<S: SectorSize, V: Volume<u8, S>> Inode<S, V> {
+    pub fn new(fs: Synced<Ext2<S, V>>, inner: RawInode) -> Inode<S, V> {
+        Inode { fs, inner }
+    }
+
+    pub fn blocks(&self) -> InodeBlocks<S, V> {
+        InodeBlocks {
+            inode: self.clone(),
+            index: 0,
+        }
+    }
+
+    pub fn directory(&self) -> Option<Directory<S, V>> {
+        use sys::inode::TypePerm;
+        if unsafe { self.inner.type_perm.contains(TypePerm::DIRECTORY) } {
+            Some(Directory {
+                blocks: self.blocks(),
+                offset: 0,
+                buffer: None,
+                block_size: self.fs.block_size(),
+            })
+        } else {
+            None
+        }
+    }
+
+    pub fn block(&self, index: usize) -> Option<NonZero<u32>> {
+        self.try_block(index).ok().and_then(|block| block)
+    }
+
+    pub fn try_block(
+        &self,
+        mut index: usize,
+    ) -> Result<Option<NonZero<u32>>, Error> {
+        // number of blocks in direct table: 12
+        // number of blocks in indirect table: block_size/4
+        //   why?
+        //     - a block is n bytes long
+        //     - a block address occupies 32 bits, or 4 bytes
+        //     - thus, n/4
+        // number of blocks in doubly table: (block_size/4)^2
+        //   why?
+        //     - every entry in the doubly table points to another block
+        //     - that's n/4 blocks, where n is the block size
+        //     - every block contains n/4 block pointers
+        //     - that's n/4 blocks with n/4 pointers each = (n/4)^2
+        // number of blocks in triply table: (block_size/4)^3
+
+        fn block_index<S: SectorSize, V: Volume<u8, S>>(
+            volume: &V,
+            block: u32,
+            index: usize,
+            log_block_size: u32,
+        ) -> Result<Option<NonZero<u32>>, Error> {
+            let offset = (index * 4) as i32;
+            let end = offset + 4;
+            let addr = Address::with_block_size(block, offset, log_block_size);
+            let end = Address::with_block_size(block, end, log_block_size);
+            let block = volume.slice(addr..end);
+            match block {
+                Ok(block) => unsafe {
+                    Ok(NonZero::new(block.dynamic_cast::<u32>().0))
+                },
+                Err(err) => Err(err.into()),
+            }
+        }
+
+        let bs4 = self.fs.block_size() / 4;
+        let log_block_size = self.fs.log_block_size();
+
+        if index < 12 {
+            return Ok(NonZero::new(self.inner.direct_pointer[index]));
+        }
+
+        index -= 12;
+
+        if index < bs4 {
+            let block = self.inner.indirect_pointer;
+            return block_index(
+                &self.fs.inner().volume,
+                block,
+                index,
+                log_block_size,
+            );
+        }
+
+        index -= bs4;
+
+        if index < bs4 * bs4 {
+            let indirect_index = index >> (log_block_size + 2);
+            let block = match block_index(
+                &self.fs.inner().volume,
+                self.inner.doubly_indirect,
+                indirect_index,
+                log_block_size,
+            ) {
+                Ok(Some(block)) => block.get(),
+                Ok(None) => return Ok(None),
+                Err(err) => return Err(err),
+            };
+            return block_index(
+                &self.fs.inner().volume,
+                block,
+                index & (bs4 - 1),
+                log_block_size,
+            );
+        }
+
+        index -= bs4 * bs4;
+
+        if index < bs4 * bs4 * bs4 {
+            let doubly_index = index >> (2 * log_block_size + 4);
+            let indirect = match block_index(
+                &self.fs.inner().volume,
+                self.inner.triply_indirect,
+                doubly_index,
+                log_block_size,
+            ) {
+                Ok(Some(block)) => block.get(),
+                Ok(None) => return Ok(None),
+                Err(err) => return Err(err),
+            };
+            let indirect_index = (index >> (log_block_size + 2)) & (bs4 - 1);
+            let block = match block_index(
+                &self.fs.inner().volume,
+                indirect as u32,
+                indirect_index,
+                log_block_size,
+            ) {
+                Ok(Some(block)) => block.get(),
+                Ok(None) => return Ok(None),
+                Err(err) => return Err(err),
+            };
+            return block_index(
+                &self.fs.inner().volume,
+                block,
+                index & (bs4 - 1),
+                log_block_size,
+            );
+        }
+
+        Ok(None)
+    }
+
+    pub fn in_use(&self) -> bool {
+        self.inner.hard_links > 0
+    }
+
+    pub fn uid(&self) -> u16 {
+        self.inner.uid
+    }
+
+    pub fn sectors(&self) -> usize {
+        self.inner.sectors_count as usize
+    }
+
+    pub fn size32(&self) -> u32 {
+        self.inner.size_low
+    }
+
+    pub fn size64(&self) -> u64 {
+        self.inner.size_low as u64 | (self.inner.size_high as u64) << 32
+    }
+
+    #[cfg(target_pointer_width = "64")]
+    #[inline]
+    pub fn size(&self) -> usize {
+        self.size64() as usize
+    }
+
+    #[cfg(target_pointer_width = "32")]
+    #[inline]
+    pub fn size(&self) -> usize {
+        self.size32() as usize
+    }
+}
+
+#[derive(Debug, Clone)]
+pub struct InodeBlocks<S: SectorSize, V: Volume<u8, S>> {
+    inode: Inode<S, V>,
+    index: usize,
+}
+
+impl<S: SectorSize, V: Volume<u8, S>> Iterator for InodeBlocks<S, V> {
+    type Item = Result<(Vec<u8>, Address<S>), Error>;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        let block = self.inode.try_block(self.index);
+        let block = match block {
+            Ok(Some(ok)) => ok,
+            Ok(None) => return None,
+            Err(err) => return Some(Err(err)),
+        };
+
+        self.index += 1;
+
+        let block = block.get();
+        let log_block_size = self.inode.fs.log_block_size();
+        let offset = Address::with_block_size(block, 0, log_block_size);
+        let end = Address::with_block_size(block + 1, 0, log_block_size);
+
+        let fs = self.inode.fs.inner();
+        let slice = fs.volume
+            .slice(offset..end)
+            .map(|slice| (slice.to_vec(), offset))
+            .map_err(|err| err.into());
+        Some(slice)
+    }
+}
+
+#[derive(Debug, Clone)]
+pub struct Directory<S: SectorSize, V: Volume<u8, S>> {
+    blocks: InodeBlocks<S, V>,
+    offset: usize,
+    buffer: Option<Vec<u8>>,
+    block_size: usize,
+}
+
+impl<S: SectorSize, V: Volume<u8, S>> Iterator for Directory<S, V> {
+    type Item = Result<DirectoryEntry, Error>;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        if self.buffer.is_none() || self.offset >= self.block_size {
+            self.buffer = match self.blocks.next() {
+                None => return None,
+                Some(Ok((block, _))) => Some(block),
+                Some(Err(err)) => return Some(Err(err)),
+            };
+
+            self.offset = 0;
+        }
+
+        let buffer = &self.buffer.as_ref().unwrap()[self.offset..];
+
+        let inode = buffer[0] as u32 | (buffer[1] as u32) << 8
+            | (buffer[2] as u32) << 16
+            | (buffer[3] as u32) << 24;
+        if inode == 0 {
+            return None;
+        }
+
+        let size = buffer[4] as u16 | (buffer[5] as u16) << 8;
+        let len = buffer[6];
+        let ty = buffer[7];
+
+        let name = buffer[8..8 + len as usize].to_vec();
+
+        self.offset += size as usize;
+
+        Some(Ok(DirectoryEntry {
+            name: name,
+            inode: inode as usize,
+            ty: ty,
+        }))
+    }
+}
+
+#[derive(Clone)]
+pub struct DirectoryEntry {
+    pub name: Vec<u8>,
+    pub inode: usize,
+    pub ty: u8,
+}
+
+#[cfg(test)]
+mod tests {
+    use std::fs::File;
+    use std::cell::RefCell;
+
+    use sector::{SectorSize, Size512};
+    use volume::Volume;
+
+    use super::{Ext2, Inode, Synced};
+
+    #[test]
+    fn file() {
+        let file = RefCell::new(File::open("ext2.img").unwrap());
+        let fs = Synced::<Ext2<Size512, _>>::new(file);
+
+        assert!(
+            fs.is_ok(),
+            "Err({:?})",
+            fs.err().unwrap_or_else(|| unreachable!()),
+        );
+
+        let fs = fs.unwrap();
+
+        let vers = fs.version();
+        println!("version: {}.{}", vers.0, vers.1);
+        assert_eq!(128, fs.inode_size());
+    }
+
+    #[test]
+    fn inodes() {
+        let file = RefCell::new(File::open("ext2.img").unwrap());
+        let fs = Synced::<Ext2<Size512, _>>::new(file);
+
+        assert!(
+            fs.is_ok(),
+            "Err({:?})",
+            fs.err().unwrap_or_else(|| unreachable!()),
+        );
+
+        let fs = fs.unwrap();
+
+        let inodes = fs.inodes().filter(|inode| inode.0.in_use());
+        for inode in inodes {
+            println!("{:?}", inode);
+        }
+    }
+
+    #[test]
+    fn inode_blocks() {
+        use std::str;
+        let file = RefCell::new(File::open("ext2.img").unwrap());
+        let fs = Synced::<Ext2<Size512, _>>::new(file).unwrap();
+
+        let inodes = fs.inodes().filter(|inode| {
+            inode.0.in_use() && inode.0.uid() == 1000 && inode.0.size() < 1024
+        });
+        for inode in inodes {
+            println!("{:?}", inode.0);
+            let size = inode.0.size();
+            for block in inode.0.blocks() {
+                let (data, _) = block.unwrap();
+                assert_eq!(data.len(), fs.block_size());
+                println!("{:?}", &data[..size]);
+                let _ = str::from_utf8(&data[..size])
+                    .map(|string| println!("{}", string));
+            }
+        }
+    }
+
+    #[test]
+    fn read_inode() {
+        let file = RefCell::new(File::open("ext2.img").unwrap());
+        let fs = Synced::<Ext2<Size512, _>>::new(file).unwrap();
+
+        let inodes = fs.inodes().filter(|inode| {
+            inode.0.in_use() && inode.0.uid() == 1000 && inode.0.size() < 1024
+        });
+        for (inode, _) in inodes {
+            let mut buf = Vec::with_capacity(inode.size());
+            unsafe {
+                buf.set_len(inode.size());
+            }
+            let size = fs.read_inode(&mut buf[..], &inode);
+            assert!(size.is_ok());
+            let size = size.unwrap();
+            assert_eq!(size, inode.size());
+            unsafe {
+                buf.set_len(size);
+            }
+        }
+    }
+
+    #[test]
+    fn read_big() {
+        let file = RefCell::new(File::open("ext2.img").unwrap());
+        let fs = Synced::<Ext2<Size512, _>>::new(file).unwrap();
+
+        let inodes = fs.inodes().filter(|inode| {
+            inode.0.in_use() && inode.0.uid() == 1000
+                && inode.0.size() == 537600
+        });
+        for (inode, _) in inodes {
+            let mut buf = Vec::with_capacity(inode.size());
+            unsafe {
+                buf.set_len(inode.size());
+            }
+            let size = fs.read_inode(&mut buf[..], &inode);
+            assert!(size.is_ok());
+            let size = size.unwrap();
+            assert_eq!(size, inode.size());
+            unsafe {
+                buf.set_len(size);
+            }
+
+            for (i, &x) in buf.iter().enumerate() {
+                if i & 1 == 0 {
+                    assert_eq!(x, b'u', "{}", i);
+                } else {
+                    assert_eq!(x, b'\n', "{}", i);
+                }
+            }
+        }
+    }
+
+    #[test]
+    fn walkdir() {
+        use std::str;
+
+        fn walk<'vol, S: SectorSize, V: Volume<u8, S>>(
+            fs: &'vol Synced<Ext2<S, V>>,
+            inode: Inode<S, V>,
+            name: String,
+        ) {
+            inode.directory().map(|dir| {
+                for entry in dir {
+                    assert!(entry.is_ok());
+                    let entry = entry.unwrap();
+                    let entry_name = str::from_utf8(&entry.name).unwrap_or("?");
+                    println!("{}/{} => {}", name, entry_name, entry.inode,);
+                    if entry_name != "." && entry_name != ".." {
+                        walk(
+                            fs,
+                            fs.inode_nth(entry.inode).unwrap().0,
+                            format!("{}/{}", name, entry_name),
+                        );
+                    }
+                }
+            });
+        }
+
+        let file = RefCell::new(File::open("ext2.img").unwrap());
+        let fs = Synced::<Ext2<Size512, _>>::new(file).unwrap();
+
+        let (root, _) = fs.root_inode();
+        walk(&fs, root, String::new());
+    }
+}

src/lib.rs

@@ -12,6 +12,7 @@
 extern crate alloc;
 #[macro_use]
 extern crate bitflags;
+extern crate spin;
 
 #[cfg(any(test, not(feature = "no_std")))]
 extern crate core;

src/volume/mod.rs

@@ -31,6 +31,7 @@ pub trait Volume<T: Clone, S: SectorSize> {
     ) -> Result<VolumeSlice<'a, T, S>, Self::Error>;
 }
 
+#[derive(Debug, Clone, PartialEq, Hash)]
 pub struct VolumeSlice<'a, T: 'a + Clone, S: SectorSize> {
     inner: Cow<'a, [T]>,
     index: Address<S>,