use bit_vec::BitVec; use alloc::{boxed::Box, vec::Vec, collections::BTreeMap, rc::{Rc, Weak}, string::String}; use core::cell::{RefCell, RefMut}; use core::mem::{uninitialized, size_of}; use core::slice; use core::fmt::{Debug, Formatter, Error}; use dirty::Dirty; use structs::*; use vfs::{self, Device}; use util::*; 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) { Some(len) if len == buf.len() => Ok(()), _ => Err(()), } } fn write_block(&mut self, id: BlockId, offset: usize, buf: &[u8]) -> vfs::Result<()> { debug_assert!(offset + buf.len() <= BLKSIZE); match self.write_at(id * BLKSIZE + offset, buf) { Some(len) if len == buf.len() => Ok(()), _ => Err(()), } } /// Load struct `T` from given block in device fn load_struct(&mut self, id: BlockId) -> T { let mut s: T = unsafe { uninitialized() }; self.read_block(id, 0, s.as_buf_mut()).unwrap(); s } } impl DeviceExt for Device {} type Ptr = Rc>; /// inode for sfs pub struct INode { /// on-disk inode disk_inode: Dirty, /// inode number id: INodeId, /// Weak reference to SFS, used by almost all operations fs: Weak, // Point to inode in ucore VFS, used by c_interface // ucore_inode: *const (), } impl Debug for INode { fn fmt(&self, f: &mut Formatter) -> Result<(), Error> { write!(f, "INode {{ id: {}, disk: {:?} }}", self.id, self.disk_inode) } } impl INode { /// Map file block id to disk block id fn get_disk_block_id(&self, file_block_id: BlockId) -> Option { match file_block_id { id if id >= self.disk_inode.blocks as BlockId => None, id if id < NDIRECT => Some(self.disk_inode.direct[id] as BlockId), id if id < NDIRECT + BLK_NENTRY => { let mut disk_block_id: u32 = 0; let fs = self.fs.upgrade().unwrap(); fs.device.borrow_mut().read_block( self.disk_inode.indirect as usize, ENTRY_SIZE * (id - NDIRECT), disk_block_id.as_buf_mut(), ).unwrap(); Some(disk_block_id as BlockId) } _ => unimplemented!("double indirect blocks is not supported"), } } fn set_disk_block_id(&mut self, file_block_id: BlockId, disk_block_id: BlockId) -> vfs::Result<()> { match file_block_id { id if id >= self.disk_inode.blocks as BlockId => Err(()), 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(); fs.device.borrow_mut().write_block( self.disk_inode.indirect as usize, ENTRY_SIZE * (id - NDIRECT), disk_block_id.as_buf(), ).unwrap(); Ok(()) } _ => unimplemented!("double indirect blocks is not supported"), } } /// Only for Dir fn get_file_inode_id(&self, name: &str) -> Option { (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(); entry }) .find(|entry| entry.name.as_ref() == name) .map(|entry| entry.id as INodeId) } /// Init dir content. Insert 2 init entries. fn init_dir(&mut self, parent: INodeId) -> vfs::Result<()> { use vfs::INode; // Insert entries: '.' '..' self._resize(BLKSIZE * 2).unwrap(); 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 { id, name: Str256::from("."), }.as_buf()).unwrap(); Ok(()) } /// 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(&self, begin: usize, end: usize, mut f: F) -> vfs::Result where F: FnMut(RefMut>, &BlockRange, usize) { let fs = self.fs.upgrade().unwrap(); let size = match self.disk_inode.type_ { FileType::Dir => self.disk_inode.blocks as usize * BLKSIZE, FileType::File => self.disk_inode.size as usize, _ => unimplemented!(), }; let iter = BlockIter { begin: size.min(begin), end: size.min(end), block_size_log2: BLKSIZE_LOG2, }; // 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 { 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 { 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(()) } } impl vfs::INode for INode { fn open(&mut self, flags: u32) -> vfs::Result<()> { // Do nothing Ok(()) } fn close(&mut self) -> vfs::Result<()> { self.sync() } fn read_at(&self, offset: usize, buf: &mut [u8]) -> vfs::Result { assert_eq!(self.disk_inode.type_, FileType::File, "read_at is only available on file"); self._read_at(offset, buf) } fn write_at(&self, offset: usize, buf: &[u8]) -> vfs::Result { assert_eq!(self.disk_inode.type_, FileType::File, "write_at is only available on file"); self._write_at(offset, buf) } fn info(&self) -> vfs::Result { Ok(vfs::FileInfo { size: self.disk_inode.size as usize, mode: 0, type_: vfs::FileType::from(self.disk_inode.type_.clone()), blocks: self.disk_inode.blocks as usize, }) } fn sync(&mut self) -> vfs::Result<()> { if self.disk_inode.dirty() { let fs = self.fs.upgrade().unwrap(); fs.device.borrow_mut().write_block(self.id, 0, self.disk_inode.as_buf()).unwrap(); self.disk_inode.sync(); } Ok(()) } fn resize(&mut self, len: usize) -> vfs::Result<()> { assert_eq!(self.disk_inode.type_, FileType::File, "resize is only available on file"); self._resize(len) } fn create(&mut self, name: &str, type_: vfs::FileType) -> vfs::Result> { let fs = self.fs.upgrade().unwrap(); let info = self.info().unwrap(); assert_eq!(info.type_, vfs::FileType::Dir); // Ensure the name is not exist assert!(self.get_file_inode_id(name).is_none(), "file name exist"); // Create new INode let inode = match type_ { vfs::FileType::File => fs.new_inode_file().unwrap(), vfs::FileType::Dir => fs.new_inode_dir(self.id).unwrap(), }; // Write new entry let entry = DiskEntry { id: inode.borrow().id as u32, name: Str256::from(name), }; self._resize(info.size + BLKSIZE).unwrap(); self._write_at(info.size, entry.as_buf()).unwrap(); Ok(inode) } fn lookup(&self, path: &str) -> vfs::Result> { let fs = self.fs.upgrade().unwrap(); let info = self.info().unwrap(); assert_eq!(info.type_, vfs::FileType::Dir); let (name, rest_path) = match path.find('/') { None => (path, ""), Some(pos) => (&path[0..pos], &path[pos + 1..]), }; let inode_id = self.get_file_inode_id(name); if inode_id.is_none() { return Err(()); } let inode = fs.get_inode(inode_id.unwrap()); let type_ = inode.borrow().disk_inode.type_; match type_ { FileType::File => if rest_path == "" { Ok(inode) } else { Err(()) }, FileType::Dir => if rest_path == "" { Ok(inode) } else { inode.borrow().lookup(rest_path) }, _ => unimplemented!(), } } fn list(&self) -> vfs::Result> { 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()) } fn fs(&self) -> Weak { self.fs.clone() } } impl Drop for INode { /// Auto sync when drop fn drop(&mut self) { use vfs::INode; self.sync().expect("failed to sync"); } } /// filesystem for sfs /// /// ## 内部可变性 /// 为了方便协调外部及INode对SFS的访问,并为日后并行化做准备, /// 将SFS设置为内部可变,即对外接口全部是&self,struct的全部field用RefCell包起来 /// 这样其内部各field均可独立访问 pub struct SimpleFileSystem { /// on-disk superblock super_block: RefCell>, /// blocks in use are mared 0 free_map: RefCell>, /// inode list inodes: RefCell>>, /// device device: RefCell>, /// Pointer to self, used by INodes self_ptr: Weak, } impl SimpleFileSystem { /// Load SFS from device pub fn open(mut device: Box) -> Option> { let super_block = device.load_struct::(BLKN_SUPER); if super_block.check() == false { return None; } let free_map = device.load_struct::<[u8; BLKSIZE]>(BLKN_FREEMAP); Some(SimpleFileSystem { super_block: RefCell::new(Dirty::new(super_block)), free_map: RefCell::new(Dirty::new(BitVec::from_bytes(&free_map))), inodes: RefCell::new(BTreeMap::>::new()), device: RefCell::new(device), self_ptr: Weak::default(), }.wrap()) } /// Create a new SFS on blank disk pub fn create(mut device: Box, space: usize) -> Rc { let blocks = (space / BLKSIZE).min(BLKBITS); assert!(blocks >= 16, "space too small"); let super_block = SuperBlock { magic: MAGIC, blocks: blocks as u32, unused_blocks: blocks as u32 - 3, info: Str32::from("simple file system"), }; let free_map = { let mut bitset = BitVec::from_elem(BLKBITS, false); for i in 3..blocks { bitset.set(i, true); } bitset }; let sfs = SimpleFileSystem { super_block: RefCell::new(Dirty::new_dirty(super_block)), free_map: RefCell::new(Dirty::new_dirty(free_map)), inodes: RefCell::new(BTreeMap::>::new()), device: RefCell::new(device), self_ptr: Weak::default(), }.wrap(); // Init root INode { use vfs::INode; let root = sfs._new_inode(BLKN_ROOT, Dirty::new_dirty(DiskINode::new_dir())); root.borrow_mut().init_dir(BLKN_ROOT).unwrap(); root.borrow_mut().sync().unwrap(); } sfs } /// Wrap pure SimpleFileSystem with Rc /// Used in constructors fn wrap(self) -> Rc { // Create a Rc, make a Weak from it, then put it into the struct. // It's a little tricky. let fs = Rc::new(self); let weak = Rc::downgrade(&fs); let ptr = Rc::into_raw(fs) as *mut Self; unsafe{ (*ptr).self_ptr = weak; } unsafe{ Rc::from_raw(ptr) } } /// Allocate a block, return block id fn alloc_block(&self) -> Option { let id = self.free_map.borrow_mut().alloc(); if id.is_some() { self.super_block.borrow_mut().unused_blocks -= 1; // will panic if underflow } id } /// Free a block fn free_block(&self, block_id: usize) { let mut free_map = self.free_map.borrow_mut(); assert!(!free_map[block_id]); free_map.set(block_id, true); self.super_block.borrow_mut().unused_blocks += 1; } /// Create a new INode struct, then insert it to self.inodes /// Private used for load or create INode fn _new_inode(&self, id: INodeId, disk_inode: Dirty) -> Ptr { let inode = Rc::new(RefCell::new(INode { disk_inode, id, fs: self.self_ptr.clone(), })); self.inodes.borrow_mut().insert(id, inode.clone()); inode } /// Get inode by id. Load if not in memory. /// ** Must ensure it's a valid INode ** fn get_inode(&self, id: INodeId) -> Ptr { assert!(!self.free_map.borrow()[id]); // Load if not in memory. if !self.inodes.borrow().contains_key(&id) { let disk_inode = Dirty::new(self.device.borrow_mut().load_struct::(id)); self._new_inode(id, disk_inode) } else { self.inodes.borrow_mut().get(&id).unwrap().clone() } } /// Create a new INode file fn new_inode_file(&self) -> vfs::Result> { let id = self.alloc_block().unwrap(); let disk_inode = Dirty::new_dirty(DiskINode::new_file()); Ok(self._new_inode(id, disk_inode)) } /// Create a new INode dir fn new_inode_dir(&self, parent: INodeId) -> vfs::Result> { let id = self.alloc_block().unwrap(); let disk_inode = Dirty::new_dirty(DiskINode::new_dir()); let inode = self._new_inode(id, disk_inode); inode.borrow_mut().init_dir(parent).unwrap(); Ok(inode) } } impl vfs::FileSystem for SimpleFileSystem { /// Write back super block if dirty fn sync(&self) -> vfs::Result<()> { { let mut super_block = self.super_block.borrow_mut(); if super_block.dirty() { self.device.borrow_mut().write_at(BLKSIZE * BLKN_SUPER, super_block.as_buf()).unwrap(); super_block.sync(); } } { let mut free_map = self.free_map.borrow_mut(); if free_map.dirty() { self.device.borrow_mut().write_at(BLKSIZE * BLKN_FREEMAP, free_map.as_buf()).unwrap(); free_map.sync(); } } for inode in self.inodes.borrow().values() { use vfs::INode; inode.borrow_mut().sync().unwrap(); } Ok(()) } fn root_inode(&self) -> Ptr { self.get_inode(BLKN_ROOT) } fn info(&self) -> &'static vfs::FsInfo { static INFO: vfs::FsInfo = vfs::FsInfo { max_file_size: MAX_FILE_SIZE, }; &INFO } } impl Drop for SimpleFileSystem { /// Auto sync when drop fn drop(&mut self) { use vfs::FileSystem; self.sync().expect("failed to sync"); } } trait BitsetAlloc { fn alloc(&mut self) -> Option; } impl BitsetAlloc for BitVec { fn alloc(&mut self) -> Option { // TODO: more efficient let id = (0..self.len()).find(|&i| self[i]); if let Some(id) = id { self.set(id, false); } id } } impl AsBuf for BitVec { fn as_buf(&self) -> &[u8] { let slice = self.storage(); unsafe { slice::from_raw_parts(slice as *const _ as *const u8, slice.len() * 4) } } fn as_buf_mut(&mut self) -> &mut [u8] { let slice = self.storage(); unsafe { slice::from_raw_parts_mut(slice as *const _ as *mut u8, slice.len() * 4) } } } impl AsBuf for [u8; BLKSIZE] {} impl From for vfs::FileType { fn from(t: FileType) -> Self { match t { FileType::File => vfs::FileType::File, FileType::Dir => vfs::FileType::Dir, _ => panic!("unknown file type"), } } }