1004e86ffSlogin pub mod core; 26d81180bSLoGin pub mod fcntl; 3004e86ffSlogin pub mod file; 4004e86ffSlogin pub mod mount; 59b0abe6dSLoGin pub mod open; 6cde5492fSlogin pub mod syscall; 7004e86ffSlogin mod utils; 8004e86ffSlogin 96b4e7a29SLoGin use ::core::{any::Any, fmt::Debug, sync::atomic::AtomicUsize}; 10004e86ffSlogin use alloc::{string::String, sync::Arc, vec::Vec}; 11*dfe53cf0SGnoCiYeH use intertrait::CastFromSync; 1291e9d4abSLoGin use system_error::SystemError; 13004e86ffSlogin 142dbef785SGnoCiYeH use crate::{ 15c566df45SLoGin driver::base::{ 16c566df45SLoGin block::block_device::BlockDevice, char::CharDevice, device::device_number::DeviceNumber, 17c566df45SLoGin }, 182dbef785SGnoCiYeH ipc::pipe::LockedPipeInode, 19*dfe53cf0SGnoCiYeH libs::{ 20*dfe53cf0SGnoCiYeH casting::DowncastArc, 21*dfe53cf0SGnoCiYeH spinlock::{SpinLock, SpinLockGuard}, 22*dfe53cf0SGnoCiYeH }, 232dbef785SGnoCiYeH time::TimeSpec, 242dbef785SGnoCiYeH }; 25004e86ffSlogin 266b4e7a29SLoGin use self::{core::generate_inode_id, file::FileMode, syscall::ModeType}; 27004e86ffSlogin pub use self::{core::ROOT_INODE, file::FilePrivateData, mount::MountFS}; 28004e86ffSlogin 29004e86ffSlogin /// vfs容许的最大的路径名称长度 30ab5c8ca4Slogin pub const MAX_PATHLEN: usize = 1024; 31004e86ffSlogin 326b4e7a29SLoGin // 定义inode号 336b4e7a29SLoGin int_like!(InodeId, AtomicInodeId, usize, AtomicUsize); 34004e86ffSlogin 35004e86ffSlogin /// 文件的类型 36004e86ffSlogin #[derive(Debug, Clone, Copy, PartialEq, Eq)] 37004e86ffSlogin pub enum FileType { 38004e86ffSlogin /// 文件 39004e86ffSlogin File, 40004e86ffSlogin /// 文件夹 41004e86ffSlogin Dir, 42004e86ffSlogin /// 块设备 43004e86ffSlogin BlockDevice, 44004e86ffSlogin /// 字符设备 45004e86ffSlogin CharDevice, 4602343d0bSLoGin /// 帧缓冲设备 4702343d0bSLoGin FramebufferDevice, 4840314b30SXiaoye Zheng /// kvm设备 4940314b30SXiaoye Zheng KvmDevice, 50004e86ffSlogin /// 管道文件 51004e86ffSlogin Pipe, 52004e86ffSlogin /// 符号链接 53004e86ffSlogin SymLink, 54cde5492fSlogin /// 套接字 55cde5492fSlogin Socket, 56004e86ffSlogin } 57004e86ffSlogin 58bf4a4899SLoGin #[allow(dead_code)] 592dbef785SGnoCiYeH #[derive(Debug, Clone)] 602dbef785SGnoCiYeH pub enum SpecialNodeData { 612dbef785SGnoCiYeH /// 管道文件 622dbef785SGnoCiYeH Pipe(Arc<LockedPipeInode>), 632dbef785SGnoCiYeH /// 字符设备 642dbef785SGnoCiYeH CharDevice(Arc<dyn CharDevice>), 652dbef785SGnoCiYeH /// 块设备 662dbef785SGnoCiYeH BlockDevice(Arc<dyn BlockDevice>), 672dbef785SGnoCiYeH } 682dbef785SGnoCiYeH 69004e86ffSlogin /* these are defined by POSIX and also present in glibc's dirent.h */ 70004e86ffSlogin /// 完整含义请见 http://www.gnu.org/software/libc/manual/html_node/Directory-Entries.html 71bf4a4899SLoGin #[allow(dead_code)] 72004e86ffSlogin pub const DT_UNKNOWN: u16 = 0; 73004e86ffSlogin /// 命名管道,或者FIFO 74004e86ffSlogin pub const DT_FIFO: u16 = 1; 75004e86ffSlogin // 字符设备 76004e86ffSlogin pub const DT_CHR: u16 = 2; 77004e86ffSlogin // 目录 78004e86ffSlogin pub const DT_DIR: u16 = 4; 79004e86ffSlogin // 块设备 80004e86ffSlogin pub const DT_BLK: u16 = 6; 81004e86ffSlogin // 常规文件 82004e86ffSlogin pub const DT_REG: u16 = 8; 83004e86ffSlogin // 符号链接 84004e86ffSlogin pub const DT_LNK: u16 = 10; 85004e86ffSlogin // 是一个socket 86004e86ffSlogin pub const DT_SOCK: u16 = 12; 87004e86ffSlogin // 这个是抄Linux的,还不知道含义 88bf4a4899SLoGin #[allow(dead_code)] 89004e86ffSlogin pub const DT_WHT: u16 = 14; 90bf4a4899SLoGin #[allow(dead_code)] 91004e86ffSlogin pub const DT_MAX: u16 = 16; 92004e86ffSlogin 93a03c4f9dSLoGin /// vfs容许的最大的符号链接跳转次数 94a03c4f9dSLoGin pub const VFS_MAX_FOLLOW_SYMLINK_TIMES: usize = 8; 95a03c4f9dSLoGin 96004e86ffSlogin impl FileType { 97004e86ffSlogin pub fn get_file_type_num(&self) -> u16 { 98004e86ffSlogin return match self { 99004e86ffSlogin FileType::File => DT_REG, 100004e86ffSlogin FileType::Dir => DT_DIR, 101004e86ffSlogin FileType::BlockDevice => DT_BLK, 102004e86ffSlogin FileType::CharDevice => DT_CHR, 10340314b30SXiaoye Zheng FileType::KvmDevice => DT_CHR, 104004e86ffSlogin FileType::Pipe => DT_FIFO, 105004e86ffSlogin FileType::SymLink => DT_LNK, 106cde5492fSlogin FileType::Socket => DT_SOCK, 10702343d0bSLoGin FileType::FramebufferDevice => DT_CHR, 108004e86ffSlogin }; 109004e86ffSlogin } 110004e86ffSlogin } 111004e86ffSlogin 112cde5492fSlogin bitflags! { 113004e86ffSlogin /// @brief inode的状态(由poll方法返回) 114cde5492fSlogin pub struct PollStatus: u8 { 115cde5492fSlogin const WRITE = 1u8 << 0; 116cde5492fSlogin const READ = 1u8 << 1; 117cde5492fSlogin const ERROR = 1u8 << 2; 118004e86ffSlogin } 119004e86ffSlogin } 120004e86ffSlogin 121*dfe53cf0SGnoCiYeH pub trait IndexNode: Any + Sync + Send + Debug + CastFromSync { 122004e86ffSlogin /// @brief 打开文件 123004e86ffSlogin /// 124004e86ffSlogin /// @return 成功:Ok() 125004e86ffSlogin /// 失败:Err(错误码) 126*dfe53cf0SGnoCiYeH fn open( 127*dfe53cf0SGnoCiYeH &self, 128*dfe53cf0SGnoCiYeH _data: SpinLockGuard<FilePrivateData>, 129*dfe53cf0SGnoCiYeH _mode: &FileMode, 130*dfe53cf0SGnoCiYeH ) -> Result<(), SystemError> { 131004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 13279a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 133004e86ffSlogin } 134004e86ffSlogin 135004e86ffSlogin /// @brief 关闭文件 136004e86ffSlogin /// 137004e86ffSlogin /// @return 成功:Ok() 138004e86ffSlogin /// 失败:Err(错误码) 139*dfe53cf0SGnoCiYeH fn close(&self, _data: SpinLockGuard<FilePrivateData>) -> Result<(), SystemError> { 140004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 14179a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 142004e86ffSlogin } 143004e86ffSlogin 144004e86ffSlogin /// @brief 在inode的指定偏移量开始,读取指定大小的数据 145004e86ffSlogin /// 146004e86ffSlogin /// @param offset 起始位置在Inode中的偏移量 147004e86ffSlogin /// @param len 要读取的字节数 148004e86ffSlogin /// @param buf 缓冲区. 请注意,必须满足@buf.len()>=@len 149004e86ffSlogin /// @param _data 各文件系统系统所需私有信息 150004e86ffSlogin /// 151004e86ffSlogin /// @return 成功:Ok(读取的字节数) 152004e86ffSlogin /// 失败:Err(Posix错误码) 153004e86ffSlogin fn read_at( 154004e86ffSlogin &self, 155004e86ffSlogin offset: usize, 156004e86ffSlogin len: usize, 157004e86ffSlogin buf: &mut [u8], 158*dfe53cf0SGnoCiYeH _data: SpinLockGuard<FilePrivateData>, 159676b8ef6SMork ) -> Result<usize, SystemError>; 160004e86ffSlogin 161004e86ffSlogin /// @brief 在inode的指定偏移量开始,写入指定大小的数据(从buf的第0byte开始写入) 162004e86ffSlogin /// 163004e86ffSlogin /// @param offset 起始位置在Inode中的偏移量 164004e86ffSlogin /// @param len 要写入的字节数 165004e86ffSlogin /// @param buf 缓冲区. 请注意,必须满足@buf.len()>=@len 166004e86ffSlogin /// @param _data 各文件系统系统所需私有信息 167004e86ffSlogin /// 168004e86ffSlogin /// @return 成功:Ok(写入的字节数) 169004e86ffSlogin /// 失败:Err(Posix错误码) 170004e86ffSlogin fn write_at( 171004e86ffSlogin &self, 172004e86ffSlogin offset: usize, 173004e86ffSlogin len: usize, 174004e86ffSlogin buf: &[u8], 175*dfe53cf0SGnoCiYeH _data: SpinLockGuard<FilePrivateData>, 176676b8ef6SMork ) -> Result<usize, SystemError>; 177004e86ffSlogin 178004e86ffSlogin /// @brief 获取当前inode的状态。 179004e86ffSlogin /// 180004e86ffSlogin /// @return PollStatus结构体 1815e948c56SGnoCiYeH fn poll(&self, _private_data: &FilePrivateData) -> Result<usize, SystemError> { 18240609970SGnoCiYeH // 若文件系统没有实现此方法,则返回“不支持” 18340609970SGnoCiYeH return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 18440609970SGnoCiYeH } 185004e86ffSlogin 186004e86ffSlogin /// @brief 获取inode的元数据 187004e86ffSlogin /// 188004e86ffSlogin /// @return 成功:Ok(inode的元数据) 189004e86ffSlogin /// 失败:Err(错误码) 190676b8ef6SMork fn metadata(&self) -> Result<Metadata, SystemError> { 191004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 19279a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 193004e86ffSlogin } 194004e86ffSlogin 195004e86ffSlogin /// @brief 设置inode的元数据 196004e86ffSlogin /// 197004e86ffSlogin /// @return 成功:Ok() 198004e86ffSlogin /// 失败:Err(错误码) 199676b8ef6SMork fn set_metadata(&self, _metadata: &Metadata) -> Result<(), SystemError> { 200004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 20179a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 202004e86ffSlogin } 203004e86ffSlogin 204004e86ffSlogin /// @brief 重新设置文件的大小 205004e86ffSlogin /// 2066d81180bSLoGin /// 如果文件大小增加,则文件内容不变,但是文件的空洞部分会被填充为0 2076d81180bSLoGin /// 如果文件大小减小,则文件内容会被截断 2086d81180bSLoGin /// 209004e86ffSlogin /// @return 成功:Ok() 210004e86ffSlogin /// 失败:Err(错误码) 211676b8ef6SMork fn resize(&self, _len: usize) -> Result<(), SystemError> { 212004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 21379a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 214004e86ffSlogin } 215004e86ffSlogin 216004e86ffSlogin /// @brief 在当前目录下创建一个新的inode 217004e86ffSlogin /// 218004e86ffSlogin /// @param name 目录项的名字 219004e86ffSlogin /// @param file_type 文件类型 220004e86ffSlogin /// @param mode 权限 221004e86ffSlogin /// 222004e86ffSlogin /// @return 创建成功:返回Ok(新的inode的Arc指针) 223004e86ffSlogin /// @return 创建失败:返回Err(错误码) 224004e86ffSlogin fn create( 225004e86ffSlogin &self, 226004e86ffSlogin name: &str, 227004e86ffSlogin file_type: FileType, 2286b4e7a29SLoGin mode: ModeType, 229676b8ef6SMork ) -> Result<Arc<dyn IndexNode>, SystemError> { 23079a452ceShoumkh // 若文件系统没有实现此方法,则默认调用其create_with_data方法。如果仍未实现,则会得到一个Err(-EOPNOTSUPP_OR_ENOTSUP)的返回值 231004e86ffSlogin return self.create_with_data(name, file_type, mode, 0); 232004e86ffSlogin } 233004e86ffSlogin 234004e86ffSlogin /// @brief 在当前目录下创建一个新的inode,并传入一个简单的data字段,方便进行初始化。 235004e86ffSlogin /// 236004e86ffSlogin /// @param name 目录项的名字 237004e86ffSlogin /// @param file_type 文件类型 238004e86ffSlogin /// @param mode 权限 239004e86ffSlogin /// @param data 用于初始化该inode的数据。(为0则表示忽略此字段)对于不同的文件系统来说,代表的含义可能不同。 240004e86ffSlogin /// 241004e86ffSlogin /// @return 创建成功:返回Ok(新的inode的Arc指针) 242004e86ffSlogin /// @return 创建失败:返回Err(错误码) 243004e86ffSlogin fn create_with_data( 244004e86ffSlogin &self, 245004e86ffSlogin _name: &str, 246004e86ffSlogin _file_type: FileType, 2476b4e7a29SLoGin _mode: ModeType, 248004e86ffSlogin _data: usize, 249676b8ef6SMork ) -> Result<Arc<dyn IndexNode>, SystemError> { 250004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 25179a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 252004e86ffSlogin } 253004e86ffSlogin 254004e86ffSlogin /// @brief 在当前目录下,创建一个名为Name的硬链接,指向另一个IndexNode 255004e86ffSlogin /// 256004e86ffSlogin /// @param name 硬链接的名称 257004e86ffSlogin /// @param other 要被指向的IndexNode的Arc指针 258004e86ffSlogin /// 259004e86ffSlogin /// @return 成功:Ok() 260004e86ffSlogin /// 失败:Err(错误码) 261676b8ef6SMork fn link(&self, _name: &str, _other: &Arc<dyn IndexNode>) -> Result<(), SystemError> { 262004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 26379a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 264004e86ffSlogin } 265004e86ffSlogin 266004e86ffSlogin /// @brief 在当前目录下,删除一个名为Name的硬链接 267004e86ffSlogin /// 268004e86ffSlogin /// @param name 硬链接的名称 269004e86ffSlogin /// 270004e86ffSlogin /// @return 成功:Ok() 271004e86ffSlogin /// 失败:Err(错误码) 272676b8ef6SMork fn unlink(&self, _name: &str) -> Result<(), SystemError> { 273004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 27479a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 275004e86ffSlogin } 276004e86ffSlogin 277004e86ffSlogin /// @brief 删除文件夹 278004e86ffSlogin /// 279004e86ffSlogin /// @param name 文件夹名称 280004e86ffSlogin /// 281004e86ffSlogin /// @return 成功 Ok(()) 282004e86ffSlogin /// @return 失败 Err(错误码) 283676b8ef6SMork fn rmdir(&self, _name: &str) -> Result<(), SystemError> { 28479a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 285004e86ffSlogin } 286004e86ffSlogin 287004e86ffSlogin /// @brief 将指定名称的子目录项的文件内容,移动到target这个目录下。如果_old_name所指向的inode与_target的相同,那么则直接执行重命名的操作。 288004e86ffSlogin /// 289004e86ffSlogin /// @param old_name 旧的名字 290004e86ffSlogin /// 291004e86ffSlogin /// @param target 移动到指定的inode 292004e86ffSlogin /// 293004e86ffSlogin /// @param new_name 新的文件名 294004e86ffSlogin /// 295004e86ffSlogin /// @return 成功: Ok() 296004e86ffSlogin /// 失败: Err(错误码) 2979e481b3bSTTaq fn move_to( 298004e86ffSlogin &self, 299004e86ffSlogin _old_name: &str, 300004e86ffSlogin _target: &Arc<dyn IndexNode>, 301004e86ffSlogin _new_name: &str, 302676b8ef6SMork ) -> Result<(), SystemError> { 303004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 30479a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 305004e86ffSlogin } 306004e86ffSlogin 3079e481b3bSTTaq /// # 修改文件名 3089e481b3bSTTaq /// 3099e481b3bSTTaq /// 3109e481b3bSTTaq /// ## 参数 3119e481b3bSTTaq /// 3129e481b3bSTTaq /// - _old_name: 源文件路径 3139e481b3bSTTaq /// - _new_name: 目标文件路径 3149e481b3bSTTaq /// 3159e481b3bSTTaq /// ## 返回值 3169e481b3bSTTaq /// - Ok(返回值类型): 返回值的说明 3179e481b3bSTTaq /// - Err(错误值类型): 错误的说明 3189e481b3bSTTaq /// 3199e481b3bSTTaq fn rename(&self, _old_name: &str, _new_name: &str) -> Result<(), SystemError> { 3209e481b3bSTTaq // 若文件系统没有实现此方法,则返回“不支持” 3219e481b3bSTTaq return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 3229e481b3bSTTaq } 3239e481b3bSTTaq 324004e86ffSlogin /// @brief 寻找一个名为Name的inode 325004e86ffSlogin /// 326004e86ffSlogin /// @param name 要寻找的inode的名称 327004e86ffSlogin /// 328004e86ffSlogin /// @return 成功:Ok() 329004e86ffSlogin /// 失败:Err(错误码) 330676b8ef6SMork fn find(&self, _name: &str) -> Result<Arc<dyn IndexNode>, SystemError> { 331004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 33279a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 333004e86ffSlogin } 334004e86ffSlogin 335004e86ffSlogin /// @brief 根据inode号,获取子目录项的名字 336004e86ffSlogin /// 337004e86ffSlogin /// @param ino inode号 338004e86ffSlogin /// 339004e86ffSlogin /// @return 成功:Ok() 340004e86ffSlogin /// 失败:Err(错误码) 341676b8ef6SMork fn get_entry_name(&self, _ino: InodeId) -> Result<String, SystemError> { 342004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 34379a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 344004e86ffSlogin } 345004e86ffSlogin 346004e86ffSlogin /// @brief 根据inode号,获取子目录项的名字和元数据 347004e86ffSlogin /// 348004e86ffSlogin /// @param ino inode号 349004e86ffSlogin /// 350004e86ffSlogin /// @return 成功:Ok(String, Metadata) 351004e86ffSlogin /// 失败:Err(错误码) 352676b8ef6SMork fn get_entry_name_and_metadata(&self, ino: InodeId) -> Result<(String, Metadata), SystemError> { 353004e86ffSlogin // 如果有条件,请在文件系统中使用高效的方式实现本接口,而不是依赖这个低效率的默认实现。 354004e86ffSlogin let name = self.get_entry_name(ino)?; 355004e86ffSlogin let entry = self.find(&name)?; 356004e86ffSlogin return Ok((name, entry.metadata()?)); 357004e86ffSlogin } 358004e86ffSlogin 359004e86ffSlogin /// @brief io control接口 360004e86ffSlogin /// 361004e86ffSlogin /// @param cmd 命令 362004e86ffSlogin /// @param data 数据 363004e86ffSlogin /// 364004e86ffSlogin /// @return 成功:Ok() 365004e86ffSlogin /// 失败:Err(错误码) 36652da9a59SGnoCiYeH fn ioctl( 36752da9a59SGnoCiYeH &self, 36852da9a59SGnoCiYeH _cmd: u32, 36952da9a59SGnoCiYeH _data: usize, 37052da9a59SGnoCiYeH _private_data: &FilePrivateData, 37152da9a59SGnoCiYeH ) -> Result<usize, SystemError> { 372004e86ffSlogin // 若文件系统没有实现此方法,则返回“不支持” 37379a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 374004e86ffSlogin } 375004e86ffSlogin 376004e86ffSlogin /// @brief 获取inode所在的文件系统的指针 377004e86ffSlogin fn fs(&self) -> Arc<dyn FileSystem>; 378004e86ffSlogin 379004e86ffSlogin /// @brief 本函数用于实现动态转换。 380004e86ffSlogin /// 具体的文件系统在实现本函数时,最简单的方式就是:直接返回self 381004e86ffSlogin fn as_any_ref(&self) -> &dyn Any; 382004e86ffSlogin 383004e86ffSlogin /// @brief 列出当前inode下的所有目录项的名字 384676b8ef6SMork fn list(&self) -> Result<Vec<String>, SystemError>; 385004e86ffSlogin 386004e86ffSlogin /// @brief 在当前Inode下,挂载一个新的文件系统 387004e86ffSlogin /// 请注意!该函数只能被MountFS实现,其他文件系统不应实现这个函数 388676b8ef6SMork fn mount(&self, _fs: Arc<dyn FileSystem>) -> Result<Arc<MountFS>, SystemError> { 38979a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 390004e86ffSlogin } 391004e86ffSlogin 392004e86ffSlogin /// @brief 截断当前inode到指定的长度。如果当前文件长度小于len,则不操作。 393004e86ffSlogin /// 394004e86ffSlogin /// @param len 要被截断到的目标长度 395676b8ef6SMork fn truncate(&self, _len: usize) -> Result<(), SystemError> { 39679a452ceShoumkh return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 397004e86ffSlogin } 39820e3152eSlogin 39920e3152eSlogin /// @brief 将当前inode的内容同步到具体设备上 40020e3152eSlogin fn sync(&self) -> Result<(), SystemError> { 40120e3152eSlogin return Ok(()); 40220e3152eSlogin } 4032dbef785SGnoCiYeH 4042dbef785SGnoCiYeH /// ## 创建一个特殊文件节点 4052dbef785SGnoCiYeH /// - _filename: 文件名 4062dbef785SGnoCiYeH /// - _mode: 权限信息 4072dbef785SGnoCiYeH fn mknod( 4082dbef785SGnoCiYeH &self, 4092dbef785SGnoCiYeH _filename: &str, 4102dbef785SGnoCiYeH _mode: ModeType, 4112dbef785SGnoCiYeH _dev_t: DeviceNumber, 4122dbef785SGnoCiYeH ) -> Result<Arc<dyn IndexNode>, SystemError> { 4132dbef785SGnoCiYeH return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 4142dbef785SGnoCiYeH } 4152dbef785SGnoCiYeH 4162dbef785SGnoCiYeH /// ## 返回特殊文件的inode 4172dbef785SGnoCiYeH fn special_node(&self) -> Option<SpecialNodeData> { 4182dbef785SGnoCiYeH None 4192dbef785SGnoCiYeH } 420004e86ffSlogin } 421004e86ffSlogin 422cde5492fSlogin impl DowncastArc for dyn IndexNode { 423cde5492fSlogin fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any> { 424cde5492fSlogin self 425cde5492fSlogin } 426cde5492fSlogin } 427cde5492fSlogin 428004e86ffSlogin impl dyn IndexNode { 429004e86ffSlogin /// @brief 将当前Inode转换为一个具体的结构体(类型由T指定) 430004e86ffSlogin /// 如果类型正确,则返回Some,否则返回None 431004e86ffSlogin pub fn downcast_ref<T: IndexNode>(&self) -> Option<&T> { 432004e86ffSlogin return self.as_any_ref().downcast_ref::<T>(); 433004e86ffSlogin } 434004e86ffSlogin 435004e86ffSlogin /// @brief 查找文件(不考虑符号链接) 436004e86ffSlogin /// 437004e86ffSlogin /// @param path 文件路径 438004e86ffSlogin /// 439004e86ffSlogin /// @return Ok(Arc<dyn IndexNode>) 要寻找的目录项的inode 440676b8ef6SMork /// @return Err(SystemError) 错误码 441676b8ef6SMork pub fn lookup(&self, path: &str) -> Result<Arc<dyn IndexNode>, SystemError> { 442004e86ffSlogin return self.lookup_follow_symlink(path, 0); 443004e86ffSlogin } 444004e86ffSlogin 445004e86ffSlogin /// @brief 查找文件(考虑符号链接) 446004e86ffSlogin /// 447004e86ffSlogin /// @param path 文件路径 448004e86ffSlogin /// @param max_follow_times 最大经过的符号链接的大小 449004e86ffSlogin /// 450004e86ffSlogin /// @return Ok(Arc<dyn IndexNode>) 要寻找的目录项的inode 451676b8ef6SMork /// @return Err(SystemError) 错误码 452004e86ffSlogin pub fn lookup_follow_symlink( 453004e86ffSlogin &self, 454004e86ffSlogin path: &str, 455004e86ffSlogin max_follow_times: usize, 456676b8ef6SMork ) -> Result<Arc<dyn IndexNode>, SystemError> { 457004e86ffSlogin if self.metadata()?.file_type != FileType::Dir { 458676b8ef6SMork return Err(SystemError::ENOTDIR); 459004e86ffSlogin } 460004e86ffSlogin 461004e86ffSlogin // 处理绝对路径 462004e86ffSlogin // result: 上一个被找到的inode 463004e86ffSlogin // rest_path: 还没有查找的路径 464004e86ffSlogin let (mut result, mut rest_path) = if let Some(rest) = path.strip_prefix('/') { 465004e86ffSlogin (ROOT_INODE().clone(), String::from(rest)) 466004e86ffSlogin } else { 467004e86ffSlogin // 是相对路径 468004e86ffSlogin (self.find(".")?, String::from(path)) 469004e86ffSlogin }; 470004e86ffSlogin 471004e86ffSlogin // 逐级查找文件 472004e86ffSlogin while !rest_path.is_empty() { 473004e86ffSlogin // 当前这一级不是文件夹 474004e86ffSlogin if result.metadata()?.file_type != FileType::Dir { 475676b8ef6SMork return Err(SystemError::ENOTDIR); 476004e86ffSlogin } 477004e86ffSlogin 478004e86ffSlogin let name; 479004e86ffSlogin 480004e86ffSlogin // 寻找“/” 481004e86ffSlogin match rest_path.find('/') { 482004e86ffSlogin Some(pos) => { 483004e86ffSlogin // 找到了,设置下一个要查找的名字 484004e86ffSlogin name = String::from(&rest_path[0..pos]); 485004e86ffSlogin // 剩余的路径字符串 486004e86ffSlogin rest_path = String::from(&rest_path[pos + 1..]); 487004e86ffSlogin } 488004e86ffSlogin None => { 489004e86ffSlogin name = rest_path; 490004e86ffSlogin rest_path = String::new(); 491004e86ffSlogin } 492004e86ffSlogin } 493004e86ffSlogin 494004e86ffSlogin // 遇到连续多个"/"的情况 495004e86ffSlogin if name.is_empty() { 496004e86ffSlogin continue; 497004e86ffSlogin } 498004e86ffSlogin 499004e86ffSlogin let inode = result.find(&name)?; 500004e86ffSlogin 501004e86ffSlogin // 处理符号链接的问题 502004e86ffSlogin if inode.metadata()?.file_type == FileType::SymLink && max_follow_times > 0 { 503004e86ffSlogin let mut content = [0u8; 256]; 504004e86ffSlogin // 读取符号链接 505*dfe53cf0SGnoCiYeH let len = inode.read_at( 506*dfe53cf0SGnoCiYeH 0, 507*dfe53cf0SGnoCiYeH 256, 508*dfe53cf0SGnoCiYeH &mut content, 509*dfe53cf0SGnoCiYeH SpinLock::new(FilePrivateData::Unused).lock(), 510*dfe53cf0SGnoCiYeH )?; 511004e86ffSlogin 512004e86ffSlogin // 将读到的数据转换为utf8字符串(先转为str,再转为String) 513004e86ffSlogin let link_path = String::from( 514676b8ef6SMork ::core::str::from_utf8(&content[..len]).map_err(|_| SystemError::ENOTDIR)?, 515004e86ffSlogin ); 516004e86ffSlogin 517004e86ffSlogin let new_path = link_path + "/" + &rest_path; 518004e86ffSlogin // 继续查找符号链接 519004e86ffSlogin return result.lookup_follow_symlink(&new_path, max_follow_times - 1); 520004e86ffSlogin } else { 521004e86ffSlogin result = inode; 522004e86ffSlogin } 523004e86ffSlogin } 524004e86ffSlogin 525004e86ffSlogin return Ok(result); 526004e86ffSlogin } 527004e86ffSlogin } 528004e86ffSlogin 529004e86ffSlogin /// IndexNode的元数据 530004e86ffSlogin /// 531004e86ffSlogin /// 对应Posix2008中的sys/stat.h中的定义 https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_stat.h.html 532004e86ffSlogin #[derive(Debug, PartialEq, Eq, Clone)] 533004e86ffSlogin pub struct Metadata { 534004e86ffSlogin /// 当前inode所在的文件系统的设备号 535004e86ffSlogin pub dev_id: usize, 536004e86ffSlogin 537004e86ffSlogin /// inode号 538004e86ffSlogin pub inode_id: InodeId, 539004e86ffSlogin 540004e86ffSlogin /// Inode的大小 541004e86ffSlogin /// 文件:文件大小(单位:字节) 542004e86ffSlogin /// 目录:目录项中的文件、文件夹数量 543004e86ffSlogin pub size: i64, 544004e86ffSlogin 545004e86ffSlogin /// Inode所在的文件系统中,每个块的大小 546004e86ffSlogin pub blk_size: usize, 547004e86ffSlogin 548004e86ffSlogin /// Inode所占的块的数目 549004e86ffSlogin pub blocks: usize, 550004e86ffSlogin 551004e86ffSlogin /// inode最后一次被访问的时间 552004e86ffSlogin pub atime: TimeSpec, 553004e86ffSlogin 554004e86ffSlogin /// inode最后一次修改的时间 555004e86ffSlogin pub mtime: TimeSpec, 556004e86ffSlogin 557004e86ffSlogin /// inode的创建时间 558004e86ffSlogin pub ctime: TimeSpec, 559004e86ffSlogin 560004e86ffSlogin /// 文件类型 561004e86ffSlogin pub file_type: FileType, 562004e86ffSlogin 563004e86ffSlogin /// 权限 5646b4e7a29SLoGin pub mode: ModeType, 565004e86ffSlogin 566004e86ffSlogin /// 硬链接的数量 567004e86ffSlogin pub nlinks: usize, 568004e86ffSlogin 569004e86ffSlogin /// User ID 570004e86ffSlogin pub uid: usize, 571004e86ffSlogin 572004e86ffSlogin /// Group ID 573004e86ffSlogin pub gid: usize, 574004e86ffSlogin 575004e86ffSlogin /// 文件指向的设备的id(对于设备文件系统来说) 57602343d0bSLoGin pub raw_dev: DeviceNumber, 577004e86ffSlogin } 578004e86ffSlogin 579cde5492fSlogin impl Default for Metadata { 580cde5492fSlogin fn default() -> Self { 581cde5492fSlogin return Self { 582cde5492fSlogin dev_id: 0, 5836b4e7a29SLoGin inode_id: InodeId::new(0), 584cde5492fSlogin size: 0, 585cde5492fSlogin blk_size: 0, 586cde5492fSlogin blocks: 0, 587cde5492fSlogin atime: TimeSpec::default(), 588cde5492fSlogin mtime: TimeSpec::default(), 589cde5492fSlogin ctime: TimeSpec::default(), 590cde5492fSlogin file_type: FileType::File, 5916b4e7a29SLoGin mode: ModeType::empty(), 592cde5492fSlogin nlinks: 1, 593cde5492fSlogin uid: 0, 594cde5492fSlogin gid: 0, 59502343d0bSLoGin raw_dev: DeviceNumber::default(), 596cde5492fSlogin }; 597cde5492fSlogin } 598cde5492fSlogin } 599cde5492fSlogin 600597ecc08STTaq #[derive(Debug, Clone)] 601597ecc08STTaq pub struct SuperBlock { 602597ecc08STTaq // type of filesystem 603597ecc08STTaq pub magic: Magic, 604597ecc08STTaq // optimal transfer block size 605597ecc08STTaq pub bsize: u64, 606597ecc08STTaq // total data blocks in filesystem 607597ecc08STTaq pub blocks: u64, 608597ecc08STTaq // free block in system 609597ecc08STTaq pub bfree: u64, 610597ecc08STTaq // 可供非特权用户使用的空闲块 611597ecc08STTaq pub bavail: u64, 612597ecc08STTaq // total inodes in filesystem 613597ecc08STTaq pub files: u64, 614597ecc08STTaq // free inodes in filesystem 615597ecc08STTaq pub ffree: u64, 616597ecc08STTaq // filesysytem id 617597ecc08STTaq pub fsid: u64, 618597ecc08STTaq // Max length of filename 619597ecc08STTaq pub namelen: u64, 620597ecc08STTaq // fragment size 621597ecc08STTaq pub frsize: u64, 622597ecc08STTaq // mount flags of filesystem 623597ecc08STTaq pub flags: u64, 624597ecc08STTaq } 625597ecc08STTaq 626597ecc08STTaq impl SuperBlock { 627597ecc08STTaq pub fn new(magic: Magic, bsize: u64, namelen: u64) -> Self { 628597ecc08STTaq Self { 629597ecc08STTaq magic, 630597ecc08STTaq bsize, 631597ecc08STTaq blocks: 0, 632597ecc08STTaq bfree: 0, 633597ecc08STTaq bavail: 0, 634597ecc08STTaq files: 0, 635597ecc08STTaq ffree: 0, 636597ecc08STTaq fsid: 0, 637597ecc08STTaq namelen, 638597ecc08STTaq frsize: 0, 639597ecc08STTaq flags: 0, 640597ecc08STTaq } 641597ecc08STTaq } 642597ecc08STTaq } 643597ecc08STTaq bitflags! { 644597ecc08STTaq pub struct Magic: u64 { 645597ecc08STTaq const DEVFS_MAGIC = 0x1373; 646597ecc08STTaq const FAT_MAGIC = 0xf2f52011; 647597ecc08STTaq const KER_MAGIC = 0x3153464b; 648597ecc08STTaq const PROC_MAGIC = 0x9fa0; 649597ecc08STTaq const RAMFS_MAGIC = 0x858458f6; 650597ecc08STTaq const MOUNT_MAGIC = 61267; 651597ecc08STTaq } 652597ecc08STTaq } 653597ecc08STTaq 654004e86ffSlogin /// @brief 所有文件系统都应该实现的trait 655004e86ffSlogin pub trait FileSystem: Any + Sync + Send + Debug { 656004e86ffSlogin /// @brief 获取当前文件系统的root inode的指针 657004e86ffSlogin fn root_inode(&self) -> Arc<dyn IndexNode>; 658004e86ffSlogin 659004e86ffSlogin /// @brief 获取当前文件系统的信息 660004e86ffSlogin fn info(&self) -> FsInfo; 661004e86ffSlogin 662004e86ffSlogin /// @brief 本函数用于实现动态转换。 663004e86ffSlogin /// 具体的文件系统在实现本函数时,最简单的方式就是:直接返回self 664004e86ffSlogin fn as_any_ref(&self) -> &dyn Any; 6651d37ca6dSDonkey Kane 6661d37ca6dSDonkey Kane fn name(&self) -> &str; 667597ecc08STTaq 668597ecc08STTaq fn super_block(&self) -> SuperBlock; 669004e86ffSlogin } 670004e86ffSlogin 67106d5e247SLoGin impl DowncastArc for dyn FileSystem { 67206d5e247SLoGin fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any> { 67306d5e247SLoGin self 67406d5e247SLoGin } 67506d5e247SLoGin } 67606d5e247SLoGin 677004e86ffSlogin #[derive(Debug)] 678004e86ffSlogin pub struct FsInfo { 679004e86ffSlogin /// 文件系统所在的块设备的id 680004e86ffSlogin pub blk_dev_id: usize, 681004e86ffSlogin /// 文件名的最大长度 682004e86ffSlogin pub max_name_len: usize, 683004e86ffSlogin } 684004e86ffSlogin 685004e86ffSlogin /// @brief 686004e86ffSlogin #[repr(C)] 687004e86ffSlogin #[derive(Debug)] 688004e86ffSlogin pub struct Dirent { 689004e86ffSlogin d_ino: u64, // 文件序列号 690004e86ffSlogin d_off: i64, // dir偏移量 691004e86ffSlogin d_reclen: u16, // 目录下的记录数 692004e86ffSlogin d_type: u8, // entry的类型 693004e86ffSlogin d_name: u8, // 文件entry的名字(是一个零长数组), 本字段仅用于占位 694004e86ffSlogin } 69520e3152eSlogin 69620e3152eSlogin impl Metadata { 6976b4e7a29SLoGin pub fn new(file_type: FileType, mode: ModeType) -> Self { 69820e3152eSlogin Metadata { 69920e3152eSlogin dev_id: 0, 70020e3152eSlogin inode_id: generate_inode_id(), 70120e3152eSlogin size: 0, 70220e3152eSlogin blk_size: 0, 70320e3152eSlogin blocks: 0, 70420e3152eSlogin atime: TimeSpec::default(), 70520e3152eSlogin mtime: TimeSpec::default(), 70620e3152eSlogin ctime: TimeSpec::default(), 70720e3152eSlogin file_type, 70820e3152eSlogin mode, 70920e3152eSlogin nlinks: 1, 71020e3152eSlogin uid: 0, 71120e3152eSlogin gid: 0, 71202343d0bSLoGin raw_dev: DeviceNumber::default(), 71320e3152eSlogin } 71420e3152eSlogin } 71520e3152eSlogin } 7161d37ca6dSDonkey Kane pub struct FileSystemMaker { 7171d37ca6dSDonkey Kane function: &'static FileSystemNewFunction, 7181d37ca6dSDonkey Kane name: &'static str, 7191d37ca6dSDonkey Kane } 7201d37ca6dSDonkey Kane 7211d37ca6dSDonkey Kane impl FileSystemMaker { 7221d37ca6dSDonkey Kane pub const fn new( 7231d37ca6dSDonkey Kane name: &'static str, 7241d37ca6dSDonkey Kane function: &'static FileSystemNewFunction, 7251d37ca6dSDonkey Kane ) -> FileSystemMaker { 7261d37ca6dSDonkey Kane FileSystemMaker { function, name } 7271d37ca6dSDonkey Kane } 7281d37ca6dSDonkey Kane 7291d37ca6dSDonkey Kane pub fn call(&self) -> Result<Arc<dyn FileSystem>, SystemError> { 7301d37ca6dSDonkey Kane (self.function)() 7311d37ca6dSDonkey Kane } 7321d37ca6dSDonkey Kane } 7331d37ca6dSDonkey Kane 7341d37ca6dSDonkey Kane pub type FileSystemNewFunction = fn() -> Result<Arc<dyn FileSystem>, SystemError>; 7351d37ca6dSDonkey Kane 7361d37ca6dSDonkey Kane #[macro_export] 7371d37ca6dSDonkey Kane macro_rules! define_filesystem_maker_slice { 7381d37ca6dSDonkey Kane ($name:ident) => { 7391d37ca6dSDonkey Kane #[::linkme::distributed_slice] 7401d37ca6dSDonkey Kane pub static $name: [FileSystemMaker] = [..]; 7411d37ca6dSDonkey Kane }; 7421d37ca6dSDonkey Kane () => { 7431d37ca6dSDonkey Kane compile_error!("define_filesystem_maker_slice! requires at least one argument: slice_name"); 7441d37ca6dSDonkey Kane }; 7451d37ca6dSDonkey Kane } 7461d37ca6dSDonkey Kane 7471d37ca6dSDonkey Kane /// 调用指定数组中的所有初始化器 7481d37ca6dSDonkey Kane #[macro_export] 7491d37ca6dSDonkey Kane macro_rules! producefs { 7501d37ca6dSDonkey Kane ($initializer_slice:ident,$filesystem:ident) => { 7511d37ca6dSDonkey Kane match $initializer_slice.iter().find(|&m| m.name == $filesystem) { 7521d37ca6dSDonkey Kane Some(maker) => maker.call(), 7531d37ca6dSDonkey Kane None => { 7541d37ca6dSDonkey Kane kerror!("mismatch filesystem type : {}", $filesystem); 7551d37ca6dSDonkey Kane Err(SystemError::EINVAL) 7561d37ca6dSDonkey Kane } 7571d37ca6dSDonkey Kane } 7581d37ca6dSDonkey Kane }; 7591d37ca6dSDonkey Kane } 7601d37ca6dSDonkey Kane 7611d37ca6dSDonkey Kane define_filesystem_maker_slice!(FSMAKER); 762