use core::cell::RefCell; use core::cmp; use io::prelude::*; use io::{Error, ErrorKind, SeekFrom}; use io; use byteorder::LittleEndian; use byteorder_ext::{ReadBytesExt, WriteBytesExt}; use file::File; use dir::{DirRawStream, Dir}; use dir_entry::DIR_ENTRY_SIZE; use table::{ClusterIterator, alloc_cluster, read_fat_flags, count_free_clusters}; #[cfg(all(not(feature = "std"), feature = "alloc"))] use alloc::{String, string::ToString}; #[cfg(all(not(feature = "std"), not(feature = "alloc")))] use core::str; // FAT implementation based on: // http://wiki.osdev.org/FAT // https://www.win.tue.nl/~aeb/linux/fs/fat/fat-1.html #[derive(Debug, Copy, Clone, PartialEq)] pub enum FatType { Fat12, Fat16, Fat32, } impl FatType { fn from_clusters(total_clusters: u32) -> FatType { if total_clusters < 4085 { FatType::Fat12 } else if total_clusters < 65525 { FatType::Fat16 } else { FatType::Fat32 } } } pub struct FsStatusFlags { pub dirty: bool, pub io_error: bool, } pub trait ReadSeek: Read + Seek {} impl ReadSeek for T where T: Read + Seek {} pub trait ReadWriteSeek: Read + Write + Seek {} impl ReadWriteSeek for T where T: Read + Write + Seek {} pub(crate) fn strip_non_ascii(slice: &mut [u8]) { for c in slice { if *c < 0x20 || *c >= 0x80 { *c = '_' as u8; } } } #[allow(dead_code)] #[derive(Default, Debug, Clone)] struct BiosParameterBlock { bytes_per_sector: u16, sectors_per_cluster: u8, reserved_sectors: u16, fats: u8, root_entries: u16, total_sectors_16: u16, media: u8, sectors_per_fat_16: u16, sectors_per_track: u16, heads: u16, hidden_sectors: u32, total_sectors_32: u32, // Extended BIOS Parameter Block sectors_per_fat_32: u32, extended_flags: u16, fs_version: u16, root_dir_first_cluster: u32, fs_info_sector: u16, backup_boot_sector: u16, reserved_0: [u8; 12], drive_num: u8, reserved_1: u8, ext_sig: u8, volume_id: u32, volume_label: [u8; 11], fs_type_label: [u8; 8], } impl BiosParameterBlock { fn deserialize(rdr: &mut Read) -> io::Result { let mut bpb: BiosParameterBlock = Default::default(); bpb.bytes_per_sector = rdr.read_u16::()?; bpb.sectors_per_cluster = rdr.read_u8()?; bpb.reserved_sectors = rdr.read_u16::()?; bpb.fats = rdr.read_u8()?; bpb.root_entries = rdr.read_u16::()? ; bpb.total_sectors_16 = rdr.read_u16::()?; bpb.media = rdr.read_u8()?; bpb.sectors_per_fat_16 = rdr.read_u16::()?; bpb.sectors_per_track = rdr.read_u16::()?; bpb.heads = rdr.read_u16::()?; bpb.hidden_sectors = rdr.read_u32::()?; bpb.total_sectors_32 = rdr.read_u32::()?; // sanity checks if bpb.bytes_per_sector < 512 { return Err(Error::new(ErrorKind::Other, "invalid bytes_per_sector value in BPB")); } if bpb.sectors_per_cluster < 1 { return Err(Error::new(ErrorKind::Other, "invalid sectors_per_cluster value in BPB")); } if bpb.reserved_sectors < 1 { return Err(Error::new(ErrorKind::Other, "invalid reserved_sectors value in BPB")); } if bpb.fats == 0 { return Err(Error::new(ErrorKind::Other, "invalid fats value in BPB")); } if bpb.sectors_per_fat_16 == 0 { bpb.sectors_per_fat_32 = rdr.read_u32::()?; bpb.extended_flags = rdr.read_u16::()?; bpb.fs_version = rdr.read_u16::()?; bpb.root_dir_first_cluster = rdr.read_u32::()?; bpb.fs_info_sector = rdr.read_u16::()?; bpb.backup_boot_sector = rdr.read_u16::()?; rdr.read_exact(&mut bpb.reserved_0)?; bpb.drive_num = rdr.read_u8()?; bpb.reserved_1 = rdr.read_u8()?; bpb.ext_sig = rdr.read_u8()?; // 0x29 bpb.volume_id = rdr.read_u32::()?; rdr.read_exact(&mut bpb.volume_label)?; rdr.read_exact(&mut bpb.fs_type_label)?; } else { bpb.drive_num = rdr.read_u8()?; bpb.reserved_1 = rdr.read_u8()?; bpb.ext_sig = rdr.read_u8()?; // 0x29 bpb.volume_id = rdr.read_u32::()?; rdr.read_exact(&mut bpb.volume_label)?; rdr.read_exact(&mut bpb.fs_type_label)?; } // Strip non-ascii characters from volume label strip_non_ascii(&mut bpb.volume_label); if bpb.ext_sig != 0x29 { // fields after ext_sig are not used - clean them bpb.volume_id = 0; bpb.volume_label = [0; 11]; bpb.fs_type_label = [0; 8]; } Ok(bpb) } fn mirroring_enabled(&self) -> bool { self.extended_flags & 0x80 == 0 } fn active_fat(&self) -> u16 { self.extended_flags & 0x0F } fn status_flags(&self) -> FsStatusFlags { FsStatusFlags { dirty: self.reserved_1 & 1 != 0, io_error: self.reserved_1 & 2 != 0, } } } #[allow(dead_code)] struct BootRecord { bootjmp: [u8; 3], oem_name: [u8; 8], bpb: BiosParameterBlock, boot_code: [u8; 448], boot_sig: [u8; 2], } impl BootRecord { fn deserialize(rdr: &mut Read) -> io::Result { let mut boot: BootRecord = Default::default(); rdr.read_exact(&mut boot.bootjmp)?; rdr.read_exact(&mut boot.oem_name)?; boot.bpb = BiosParameterBlock::deserialize(rdr)?; if boot.bpb.sectors_per_fat_16 == 0 { rdr.read_exact(&mut boot.boot_code[0..420])?; } else { rdr.read_exact(&mut boot.boot_code[0..448])?; } rdr.read_exact(&mut boot.boot_sig)?; Ok(boot) } } impl Default for BootRecord { fn default() -> BootRecord { BootRecord { bootjmp: Default::default(), oem_name: Default::default(), bpb: Default::default(), boot_code: [0; 448], boot_sig: Default::default(), } } } #[derive(Default, Debug, Clone)] struct FsInfoSector { #[allow(dead_code)] free_cluster_count: Option, next_free_cluster: Option, } impl FsInfoSector { const LEAD_SIG: u32 = 0x41615252; const STRUC_SIG: u32 = 0x61417272; const TRAIL_SIG: u32 = 0xAA550000; fn deserialize(rdr: &mut Read) -> io::Result { let lead_sig = rdr.read_u32::()?; if lead_sig != Self::LEAD_SIG { return Err(Error::new(ErrorKind::Other, "invalid lead_sig in FsInfo sector")); } let mut reserved = [0u8; 480]; rdr.read_exact(&mut reserved)?; let struc_sig = rdr.read_u32::()?; if struc_sig != Self::STRUC_SIG { return Err(Error::new(ErrorKind::Other, "invalid struc_sig in FsInfo sector")); } let free_cluster_count = match rdr.read_u32::()? { 0xFFFFFFFF => None, n => Some(n), }; let next_free_cluster = match rdr.read_u32::()? { 0xFFFFFFFF => None, n => Some(n), }; let mut reserved2 = [0u8; 12]; rdr.read_exact(&mut reserved2)?; let trail_sig = rdr.read_u32::()?; if trail_sig != Self::TRAIL_SIG { return Err(Error::new(ErrorKind::Other, "invalid trail_sig in FsInfo sector")); } Ok(FsInfoSector { free_cluster_count, next_free_cluster }) } // TODO: save modified FsInfo secton on unmount #[allow(dead_code)] fn serialize(&self, wrt: &mut Write) -> io::Result<()> { wrt.write_u32::(Self::LEAD_SIG)?; let reserved = [0u8; 480]; wrt.write(&reserved)?; wrt.write_u32::(Self::STRUC_SIG)?; wrt.write_u32::(self.free_cluster_count.unwrap_or(0xFFFFFFFF))?; wrt.write_u32::(self.next_free_cluster.unwrap_or(0xFFFFFFFF))?; let reserved2 = [0u8; 12]; wrt.write(&reserved2)?; wrt.write_u32::(Self::TRAIL_SIG)?; Ok(()) } fn add_free_clusters(&mut self, free_clusters: i32) { if let Some(n) = self.free_cluster_count { self.free_cluster_count = Some((n as i32 + free_clusters) as u32); } } } /// FAT filesystem options. #[derive(Debug, Clone, Copy)] pub struct FsOptions { pub(crate) update_accessed_date: bool, } impl FsOptions { pub fn new() -> Self { FsOptions { update_accessed_date: false, } } /// If enabled library updates accessed date field in directory entry when reading pub fn update_accessed_date(mut self, enabled: bool) -> Self { self.update_accessed_date = enabled; self } } /// FAT filesystem statistics #[derive(Debug, Clone, Copy)] pub struct FileSystemStats { /// Cluster size in bytes pub cluster_size: u32, /// Number of total clusters in filesystem usable for file allocation pub total_clusters: u32, /// Number of free clusters pub free_clusters: u32, } pub(crate) type FileSystemRef<'a, 'b> = &'a FileSystem<'b>; /// FAT filesystem main struct. pub struct FileSystem<'a> { pub(crate) disk: RefCell<&'a mut ReadWriteSeek>, pub(crate) options: FsOptions, fat_type: FatType, bpb: BiosParameterBlock, first_data_sector: u32, root_dir_sectors: u32, total_clusters: u32, fs_info: RefCell, } impl <'a> FileSystem<'a> { /// Creates new filesystem object instance. /// /// Supplied disk parameter cannot be seeked. If there is a need to read a fragment of disk image (e.g. partition) /// library user should provide a custom implementation of ReadWriteSeek trait. /// /// Note: creating multiple filesystem objects with one underlying device/disk image can /// cause filesystem corruption. pub fn new(disk: &'a mut T, options: FsOptions) -> io::Result> { // Make sure given image is not seeked debug_assert!(disk.seek(SeekFrom::Current(0))? == 0); // Read boot sector let bpb = { let boot = BootRecord::deserialize(disk)?; if boot.boot_sig != [0x55, 0xAA] { return Err(Error::new(ErrorKind::Other, "invalid signature")); } boot.bpb }; let total_sectors = if bpb.total_sectors_16 == 0 { bpb.total_sectors_32 } else { bpb.total_sectors_16 as u32 }; let sectors_per_fat = if bpb.sectors_per_fat_16 == 0 { bpb.sectors_per_fat_32 } else { bpb.sectors_per_fat_16 as u32 }; let root_dir_bytes = bpb.root_entries as u32 * DIR_ENTRY_SIZE as u32; let root_dir_sectors = (root_dir_bytes + (bpb.bytes_per_sector as u32 - 1)) / bpb.bytes_per_sector as u32; let first_data_sector = bpb.reserved_sectors as u32 + (bpb.fats as u32 * sectors_per_fat) + root_dir_sectors; let fat_sectors = bpb.fats as u32 * sectors_per_fat; let data_sectors = total_sectors - (bpb.reserved_sectors as u32 + fat_sectors + root_dir_sectors as u32); let total_clusters = data_sectors / bpb.sectors_per_cluster as u32; let fat_type = FatType::from_clusters(total_clusters); let fs_info = if fat_type == FatType::Fat32 { disk.seek(SeekFrom::Start(bpb.fs_info_sector as u64 * 512))?; FsInfoSector::deserialize(disk)? } else { FsInfoSector::default() }; Ok(FileSystem { disk: RefCell::new(disk), options, fat_type, bpb: bpb, first_data_sector, root_dir_sectors, total_clusters, fs_info: RefCell::new(fs_info), }) } /// Returns type of used File Allocation Table (FAT). pub fn fat_type(&self) -> FatType { self.fat_type } /// Returns volume identifier read from BPB in Boot Sector. pub fn volume_id(&self) -> u32 { self.bpb.volume_id } /// Returns volume label from BPB in Boot Sector. /// /// Note: File with VOLUME_ID attribute in root directory is ignored by this library. /// Only label from BPB is used. #[cfg(feature = "alloc")] pub fn volume_label(&self) -> String { String::from_utf8_lossy(&self.bpb.volume_label).trim_right().to_string() } #[cfg(not(feature = "alloc"))] pub fn volume_label(&self) -> &str { str::from_utf8(&self.bpb.volume_label).unwrap_or("").trim_right() } /// Returns root directory object allowing futher penetration of filesystem structure. pub fn root_dir<'b>(&'b self) -> Dir<'b, 'a> { let root_rdr = { match self.fat_type { FatType::Fat12 | FatType::Fat16 => DirRawStream::Root(DiskSlice::from_sectors( self.first_data_sector - self.root_dir_sectors, self.root_dir_sectors, 1, self)), _ => DirRawStream::File(File::new(Some(self.bpb.root_dir_first_cluster), None, self)), } }; Dir::new(root_rdr, self) } pub(crate) fn offset_from_sector(&self, sector: u32) -> u64 { (sector as u64) * self.bpb.bytes_per_sector as u64 } pub(crate) fn sector_from_cluster(&self, cluster: u32) -> u32 { ((cluster - 2) * self.bpb.sectors_per_cluster as u32) + self.first_data_sector } pub(crate) fn cluster_size(&self) -> u32 { self.bpb.sectors_per_cluster as u32 * self.bpb.bytes_per_sector as u32 } pub(crate) fn offset_from_cluster(&self, cluser: u32) -> u64 { self.offset_from_sector(self.sector_from_cluster(cluser)) } fn fat_slice<'b>(&'b self) -> DiskSlice<'b, 'a> { let sectors_per_fat = if self.bpb.sectors_per_fat_16 == 0 { self.bpb.sectors_per_fat_32 } else { self.bpb.sectors_per_fat_16 as u32 }; let mirroring_enabled = self.bpb.mirroring_enabled(); let (fat_first_sector, mirrors) = if mirroring_enabled { (self.bpb.reserved_sectors as u32, self.bpb.fats) } else { let active_fat = self.bpb.active_fat() as u32; let fat_first_sector = (self.bpb.reserved_sectors as u32) + active_fat * sectors_per_fat; (fat_first_sector, 1) }; DiskSlice::from_sectors(fat_first_sector, sectors_per_fat, mirrors, self) } pub(crate) fn cluster_iter<'b>(&'b self, cluster: u32) -> ClusterIterator<'b, 'a> { let disk_slice = self.fat_slice(); ClusterIterator::new(disk_slice, self.fat_type, cluster) } pub(crate) fn truncate_cluster_chain(&self, cluster: u32) -> io::Result<()> { let mut iter = self.cluster_iter(cluster); let num_free = iter.truncate()?; let mut fs_info = self.fs_info.borrow_mut(); fs_info.add_free_clusters(num_free as i32); Ok(()) } pub(crate) fn free_cluster_chain(&self, cluster: u32) -> io::Result<()> { let mut iter = self.cluster_iter(cluster); let num_free = iter.free()?; let mut fs_info = self.fs_info.borrow_mut(); fs_info.add_free_clusters(num_free as i32); Ok(()) } pub(crate) fn alloc_cluster(&self, prev_cluster: Option) -> io::Result { let hint = self.fs_info.borrow().next_free_cluster; let mut fat = self.fat_slice(); let cluster = alloc_cluster(&mut fat, self.fat_type, prev_cluster, hint, self.total_clusters)?; let mut fs_info = self.fs_info.borrow_mut(); fs_info.next_free_cluster = Some(cluster + 1); fs_info.add_free_clusters(-1); Ok(cluster) } /// Returns status flags for this volume. pub fn read_status_flags(&self) -> io::Result { let bpb_status = self.bpb.status_flags(); let fat_status = read_fat_flags(&mut self.fat_slice(), self.fat_type)?; Ok(FsStatusFlags { dirty: bpb_status.dirty || fat_status.dirty, io_error: bpb_status.io_error || fat_status.io_error, }) } /// Returns filesystem statistics like number of total and free clusters. /// /// For FAT32 volumes number of free clusters from FSInfo sector is returned (may be incorrect). /// For other filesystems number is computed on each call (scans entire FAT so it takes more time). pub fn stats(&self) -> io::Result { let free_clusters = match self.fs_info.borrow().free_cluster_count { Some(n) => n, _ => { let mut fat = self.fat_slice(); count_free_clusters(&mut fat, self.fat_type, self.total_clusters)? } }; Ok(FileSystemStats { cluster_size: self.cluster_size(), total_clusters: self.total_clusters, free_clusters, }) } } #[derive(Clone)] pub(crate) struct DiskSlice<'a, 'b: 'a> { begin: u64, size: u64, offset: u64, mirrors: u8, fs: &'a FileSystem<'b>, } impl <'a, 'b> DiskSlice<'a, 'b> { pub(crate) fn new(begin: u64, size: u64, mirrors: u8, fs: FileSystemRef<'a, 'b>) -> Self { DiskSlice { begin, size, mirrors, fs, offset: 0 } } pub(crate) fn from_sectors(first_sector: u32, sector_count: u32, mirrors: u8, fs: FileSystemRef<'a, 'b>) -> Self { let bytes_per_sector = fs.bpb.bytes_per_sector as u64; Self::new(first_sector as u64 * bytes_per_sector, sector_count as u64 * bytes_per_sector, mirrors, fs) } pub(crate) fn abs_pos(&self) -> u64 { self.begin + self.offset } } impl <'a, 'b> Read for DiskSlice<'a, 'b> { fn read(&mut self, buf: &mut [u8]) -> io::Result { let offset = self.begin + self.offset; let read_size = cmp::min((self.size - self.offset) as usize, buf.len()); let mut disk = self.fs.disk.borrow_mut(); disk.seek(SeekFrom::Start(offset))?; let size = disk.read(&mut buf[..read_size])?; self.offset += size as u64; Ok(size) } } impl <'a, 'b> Write for DiskSlice<'a, 'b> { fn write(&mut self, buf: &[u8]) -> io::Result { let offset = self.begin + self.offset; let write_size = cmp::min((self.size - self.offset) as usize, buf.len()); for i in 0..self.mirrors { let mut disk = self.fs.disk.borrow_mut(); disk.seek(SeekFrom::Start(offset + i as u64 * self.size))?; disk.write_all(&buf[..write_size])?; } self.offset += write_size as u64; Ok(write_size) } fn flush(&mut self) -> io::Result<()> { let mut disk = self.fs.disk.borrow_mut(); disk.flush() } } impl <'a, 'b> Seek for DiskSlice<'a, 'b> { fn seek(&mut self, pos: SeekFrom) -> io::Result { let new_offset = match pos { SeekFrom::Current(x) => self.offset as i64 + x, SeekFrom::Start(x) => x as i64, SeekFrom::End(x) => self.size as i64 + x, }; if new_offset < 0 || new_offset as u64 > self.size { Err(io::Error::new(ErrorKind::InvalidInput, "invalid seek")) } else { self.offset = new_offset as u64; Ok(self.offset) } } }