1 pub mod core; 2 pub mod fcntl; 3 pub mod file; 4 pub mod mount; 5 pub mod open; 6 pub mod syscall; 7 mod utils; 8 9 use ::core::{any::Any, fmt::Debug, sync::atomic::AtomicUsize}; 10 11 use alloc::{string::String, sync::Arc, vec::Vec}; 12 use system_error::SystemError; 13 14 use crate::{ 15 driver::base::{ 16 block::block_device::BlockDevice, char::CharDevice, device::device_number::DeviceNumber, 17 }, 18 ipc::pipe::LockedPipeInode, 19 libs::casting::DowncastArc, 20 time::TimeSpec, 21 }; 22 23 use self::{core::generate_inode_id, file::FileMode, syscall::ModeType}; 24 pub use self::{core::ROOT_INODE, file::FilePrivateData, mount::MountFS}; 25 26 /// vfs容许的最大的路径名称长度 27 pub const MAX_PATHLEN: usize = 1024; 28 29 // 定义inode号 30 int_like!(InodeId, AtomicInodeId, usize, AtomicUsize); 31 32 /// 文件的类型 33 #[derive(Debug, Clone, Copy, PartialEq, Eq)] 34 pub enum FileType { 35 /// 文件 36 File, 37 /// 文件夹 38 Dir, 39 /// 块设备 40 BlockDevice, 41 /// 字符设备 42 CharDevice, 43 /// 帧缓冲设备 44 FramebufferDevice, 45 /// kvm设备 46 KvmDevice, 47 /// 管道文件 48 Pipe, 49 /// 符号链接 50 SymLink, 51 /// 套接字 52 Socket, 53 } 54 55 #[allow(dead_code)] 56 #[derive(Debug, Clone)] 57 pub enum SpecialNodeData { 58 /// 管道文件 59 Pipe(Arc<LockedPipeInode>), 60 /// 字符设备 61 CharDevice(Arc<dyn CharDevice>), 62 /// 块设备 63 BlockDevice(Arc<dyn BlockDevice>), 64 } 65 66 /* these are defined by POSIX and also present in glibc's dirent.h */ 67 /// 完整含义请见 http://www.gnu.org/software/libc/manual/html_node/Directory-Entries.html 68 #[allow(dead_code)] 69 pub const DT_UNKNOWN: u16 = 0; 70 /// 命名管道，或者FIFO 71 pub const DT_FIFO: u16 = 1; 72 // 字符设备 73 pub const DT_CHR: u16 = 2; 74 // 目录 75 pub const DT_DIR: u16 = 4; 76 // 块设备 77 pub const DT_BLK: u16 = 6; 78 // 常规文件 79 pub const DT_REG: u16 = 8; 80 // 符号链接 81 pub const DT_LNK: u16 = 10; 82 // 是一个socket 83 pub const DT_SOCK: u16 = 12; 84 // 这个是抄Linux的，还不知道含义 85 #[allow(dead_code)] 86 pub const DT_WHT: u16 = 14; 87 #[allow(dead_code)] 88 pub const DT_MAX: u16 = 16; 89 90 /// vfs容许的最大的符号链接跳转次数 91 pub const VFS_MAX_FOLLOW_SYMLINK_TIMES: usize = 8; 92 93 impl FileType { 94 pub fn get_file_type_num(&self) -> u16 { 95 return match self { 96 FileType::File => DT_REG, 97 FileType::Dir => DT_DIR, 98 FileType::BlockDevice => DT_BLK, 99 FileType::CharDevice => DT_CHR, 100 FileType::KvmDevice => DT_CHR, 101 FileType::Pipe => DT_FIFO, 102 FileType::SymLink => DT_LNK, 103 FileType::Socket => DT_SOCK, 104 FileType::FramebufferDevice => DT_CHR, 105 }; 106 } 107 } 108 109 bitflags! { 110 /// @brief inode的状态（由poll方法返回） 111 pub struct PollStatus: u8 { 112 const WRITE = 1u8 << 0; 113 const READ = 1u8 << 1; 114 const ERROR = 1u8 << 2; 115 } 116 } 117 118 pub trait IndexNode: Any + Sync + Send + Debug { 119 /// @brief 打开文件 120 /// 121 /// @return 成功：Ok() 122 /// 失败：Err(错误码) 123 fn open(&self, _data: &mut FilePrivateData, _mode: &FileMode) -> Result<(), SystemError> { 124 // 若文件系统没有实现此方法，则返回“不支持” 125 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 126 } 127 128 /// @brief 关闭文件 129 /// 130 /// @return 成功：Ok() 131 /// 失败：Err(错误码) 132 fn close(&self, _data: &mut FilePrivateData) -> Result<(), SystemError> { 133 // 若文件系统没有实现此方法，则返回“不支持” 134 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 135 } 136 137 /// @brief 在inode的指定偏移量开始，读取指定大小的数据 138 /// 139 /// @param offset 起始位置在Inode中的偏移量 140 /// @param len 要读取的字节数 141 /// @param buf 缓冲区. 请注意，必须满足@buf.len()>=@len 142 /// @param _data 各文件系统系统所需私有信息 143 /// 144 /// @return 成功：Ok(读取的字节数) 145 /// 失败：Err(Posix错误码) 146 fn read_at( 147 &self, 148 offset: usize, 149 len: usize, 150 buf: &mut [u8], 151 _data: &mut FilePrivateData, 152 ) -> Result<usize, SystemError>; 153 154 /// @brief 在inode的指定偏移量开始，写入指定大小的数据（从buf的第0byte开始写入） 155 /// 156 /// @param offset 起始位置在Inode中的偏移量 157 /// @param len 要写入的字节数 158 /// @param buf 缓冲区. 请注意，必须满足@buf.len()>=@len 159 /// @param _data 各文件系统系统所需私有信息 160 /// 161 /// @return 成功：Ok(写入的字节数) 162 /// 失败：Err(Posix错误码) 163 fn write_at( 164 &self, 165 offset: usize, 166 len: usize, 167 buf: &[u8], 168 _data: &mut FilePrivateData, 169 ) -> Result<usize, SystemError>; 170 171 /// @brief 获取当前inode的状态。 172 /// 173 /// @return PollStatus结构体 174 fn poll(&self, _private_data: &FilePrivateData) -> Result<usize, SystemError> { 175 // 若文件系统没有实现此方法，则返回“不支持” 176 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 177 } 178 179 /// @brief 获取inode的元数据 180 /// 181 /// @return 成功：Ok(inode的元数据) 182 /// 失败：Err(错误码) 183 fn metadata(&self) -> Result<Metadata, SystemError> { 184 // 若文件系统没有实现此方法，则返回“不支持” 185 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 186 } 187 188 /// @brief 设置inode的元数据 189 /// 190 /// @return 成功：Ok() 191 /// 失败：Err(错误码) 192 fn set_metadata(&self, _metadata: &Metadata) -> Result<(), SystemError> { 193 // 若文件系统没有实现此方法，则返回“不支持” 194 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 195 } 196 197 /// @brief 重新设置文件的大小 198 /// 199 /// 如果文件大小增加，则文件内容不变，但是文件的空洞部分会被填充为0 200 /// 如果文件大小减小，则文件内容会被截断 201 /// 202 /// @return 成功：Ok() 203 /// 失败：Err(错误码) 204 fn resize(&self, _len: usize) -> Result<(), SystemError> { 205 // 若文件系统没有实现此方法，则返回“不支持” 206 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 207 } 208 209 /// @brief 在当前目录下创建一个新的inode 210 /// 211 /// @param name 目录项的名字 212 /// @param file_type 文件类型 213 /// @param mode 权限 214 /// 215 /// @return 创建成功：返回Ok(新的inode的Arc指针) 216 /// @return 创建失败：返回Err(错误码) 217 fn create( 218 &self, 219 name: &str, 220 file_type: FileType, 221 mode: ModeType, 222 ) -> Result<Arc<dyn IndexNode>, SystemError> { 223 // 若文件系统没有实现此方法，则默认调用其create_with_data方法。如果仍未实现，则会得到一个Err(-EOPNOTSUPP_OR_ENOTSUP)的返回值 224 return self.create_with_data(name, file_type, mode, 0); 225 } 226 227 /// @brief 在当前目录下创建一个新的inode，并传入一个简单的data字段，方便进行初始化。 228 /// 229 /// @param name 目录项的名字 230 /// @param file_type 文件类型 231 /// @param mode 权限 232 /// @param data 用于初始化该inode的数据。（为0则表示忽略此字段）对于不同的文件系统来说，代表的含义可能不同。 233 /// 234 /// @return 创建成功：返回Ok(新的inode的Arc指针) 235 /// @return 创建失败：返回Err(错误码) 236 fn create_with_data( 237 &self, 238 _name: &str, 239 _file_type: FileType, 240 _mode: ModeType, 241 _data: usize, 242 ) -> Result<Arc<dyn IndexNode>, SystemError> { 243 // 若文件系统没有实现此方法，则返回“不支持” 244 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 245 } 246 247 /// @brief 在当前目录下，创建一个名为Name的硬链接，指向另一个IndexNode 248 /// 249 /// @param name 硬链接的名称 250 /// @param other 要被指向的IndexNode的Arc指针 251 /// 252 /// @return 成功：Ok() 253 /// 失败：Err(错误码) 254 fn link(&self, _name: &str, _other: &Arc<dyn IndexNode>) -> Result<(), SystemError> { 255 // 若文件系统没有实现此方法，则返回“不支持” 256 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 257 } 258 259 /// @brief 在当前目录下，删除一个名为Name的硬链接 260 /// 261 /// @param name 硬链接的名称 262 /// 263 /// @return 成功：Ok() 264 /// 失败：Err(错误码) 265 fn unlink(&self, _name: &str) -> Result<(), SystemError> { 266 // 若文件系统没有实现此方法，则返回“不支持” 267 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 268 } 269 270 /// @brief 删除文件夹 271 /// 272 /// @param name 文件夹名称 273 /// 274 /// @return 成功 Ok(()) 275 /// @return 失败 Err(错误码) 276 fn rmdir(&self, _name: &str) -> Result<(), SystemError> { 277 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 278 } 279 280 /// @brief 将指定名称的子目录项的文件内容，移动到target这个目录下。如果_old_name所指向的inode与_target的相同，那么则直接执行重命名的操作。 281 /// 282 /// @param old_name 旧的名字 283 /// 284 /// @param target 移动到指定的inode 285 /// 286 /// @param new_name 新的文件名 287 /// 288 /// @return 成功: Ok() 289 /// 失败: Err(错误码) 290 fn move_to( 291 &self, 292 _old_name: &str, 293 _target: &Arc<dyn IndexNode>, 294 _new_name: &str, 295 ) -> Result<(), SystemError> { 296 // 若文件系统没有实现此方法，则返回“不支持” 297 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 298 } 299 300 /// # 修改文件名 301 /// 302 /// 303 /// ## 参数 304 /// 305 /// - _old_name: 源文件路径 306 /// - _new_name: 目标文件路径 307 /// 308 /// ## 返回值 309 /// - Ok(返回值类型): 返回值的说明 310 /// - Err(错误值类型): 错误的说明 311 /// 312 fn rename(&self, _old_name: &str, _new_name: &str) -> Result<(), SystemError> { 313 // 若文件系统没有实现此方法，则返回“不支持” 314 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 315 } 316 317 /// @brief 寻找一个名为Name的inode 318 /// 319 /// @param name 要寻找的inode的名称 320 /// 321 /// @return 成功：Ok() 322 /// 失败：Err(错误码) 323 fn find(&self, _name: &str) -> Result<Arc<dyn IndexNode>, SystemError> { 324 // 若文件系统没有实现此方法，则返回“不支持” 325 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 326 } 327 328 /// @brief 根据inode号，获取子目录项的名字 329 /// 330 /// @param ino inode号 331 /// 332 /// @return 成功：Ok() 333 /// 失败：Err(错误码) 334 fn get_entry_name(&self, _ino: InodeId) -> Result<String, SystemError> { 335 // 若文件系统没有实现此方法，则返回“不支持” 336 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 337 } 338 339 /// @brief 根据inode号，获取子目录项的名字和元数据 340 /// 341 /// @param ino inode号 342 /// 343 /// @return 成功：Ok(String, Metadata) 344 /// 失败：Err(错误码) 345 fn get_entry_name_and_metadata(&self, ino: InodeId) -> Result<(String, Metadata), SystemError> { 346 // 如果有条件，请在文件系统中使用高效的方式实现本接口，而不是依赖这个低效率的默认实现。 347 let name = self.get_entry_name(ino)?; 348 let entry = self.find(&name)?; 349 return Ok((name, entry.metadata()?)); 350 } 351 352 /// @brief io control接口 353 /// 354 /// @param cmd 命令 355 /// @param data 数据 356 /// 357 /// @return 成功：Ok() 358 /// 失败：Err(错误码) 359 fn ioctl( 360 &self, 361 _cmd: u32, 362 _data: usize, 363 _private_data: &FilePrivateData, 364 ) -> Result<usize, SystemError> { 365 // 若文件系统没有实现此方法，则返回“不支持” 366 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 367 } 368 369 /// @brief 获取inode所在的文件系统的指针 370 fn fs(&self) -> Arc<dyn FileSystem>; 371 372 /// @brief 本函数用于实现动态转换。 373 /// 具体的文件系统在实现本函数时，最简单的方式就是：直接返回self 374 fn as_any_ref(&self) -> &dyn Any; 375 376 /// @brief 列出当前inode下的所有目录项的名字 377 fn list(&self) -> Result<Vec<String>, SystemError>; 378 379 /// @brief 在当前Inode下，挂载一个新的文件系统 380 /// 请注意！该函数只能被MountFS实现，其他文件系统不应实现这个函数 381 fn mount(&self, _fs: Arc<dyn FileSystem>) -> Result<Arc<MountFS>, SystemError> { 382 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 383 } 384 385 /// @brief 截断当前inode到指定的长度。如果当前文件长度小于len,则不操作。 386 /// 387 /// @param len 要被截断到的目标长度 388 fn truncate(&self, _len: usize) -> Result<(), SystemError> { 389 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 390 } 391 392 /// @brief 将当前inode的内容同步到具体设备上 393 fn sync(&self) -> Result<(), SystemError> { 394 return Ok(()); 395 } 396 397 /// ## 创建一个特殊文件节点 398 /// - _filename: 文件名 399 /// - _mode: 权限信息 400 fn mknod( 401 &self, 402 _filename: &str, 403 _mode: ModeType, 404 _dev_t: DeviceNumber, 405 ) -> Result<Arc<dyn IndexNode>, SystemError> { 406 return Err(SystemError::EOPNOTSUPP_OR_ENOTSUP); 407 } 408 409 /// ## 返回特殊文件的inode 410 fn special_node(&self) -> Option<SpecialNodeData> { 411 None 412 } 413 } 414 415 impl DowncastArc for dyn IndexNode { 416 fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any> { 417 self 418 } 419 } 420 421 impl dyn IndexNode { 422 /// @brief 将当前Inode转换为一个具体的结构体（类型由T指定） 423 /// 如果类型正确，则返回Some,否则返回None 424 pub fn downcast_ref<T: IndexNode>(&self) -> Option<&T> { 425 return self.as_any_ref().downcast_ref::<T>(); 426 } 427 428 /// @brief 查找文件（不考虑符号链接） 429 /// 430 /// @param path 文件路径 431 /// 432 /// @return Ok(Arc<dyn IndexNode>) 要寻找的目录项的inode 433 /// @return Err(SystemError) 错误码 434 pub fn lookup(&self, path: &str) -> Result<Arc<dyn IndexNode>, SystemError> { 435 return self.lookup_follow_symlink(path, 0); 436 } 437 438 /// @brief 查找文件（考虑符号链接） 439 /// 440 /// @param path 文件路径 441 /// @param max_follow_times 最大经过的符号链接的大小 442 /// 443 /// @return Ok(Arc<dyn IndexNode>) 要寻找的目录项的inode 444 /// @return Err(SystemError) 错误码 445 pub fn lookup_follow_symlink( 446 &self, 447 path: &str, 448 max_follow_times: usize, 449 ) -> Result<Arc<dyn IndexNode>, SystemError> { 450 if self.metadata()?.file_type != FileType::Dir { 451 return Err(SystemError::ENOTDIR); 452 } 453 454 // 处理绝对路径 455 // result: 上一个被找到的inode 456 // rest_path: 还没有查找的路径 457 let (mut result, mut rest_path) = if let Some(rest) = path.strip_prefix('/') { 458 (ROOT_INODE().clone(), String::from(rest)) 459 } else { 460 // 是相对路径 461 (self.find(".")?, String::from(path)) 462 }; 463 464 // 逐级查找文件 465 while !rest_path.is_empty() { 466 // 当前这一级不是文件夹 467 if result.metadata()?.file_type != FileType::Dir { 468 return Err(SystemError::ENOTDIR); 469 } 470 471 let name; 472 473 // 寻找“/” 474 match rest_path.find('/') { 475 Some(pos) => { 476 // 找到了，设置下一个要查找的名字 477 name = String::from(&rest_path[0..pos]); 478 // 剩余的路径字符串 479 rest_path = String::from(&rest_path[pos + 1..]); 480 } 481 None => { 482 name = rest_path; 483 rest_path = String::new(); 484 } 485 } 486 487 // 遇到连续多个"/"的情况 488 if name.is_empty() { 489 continue; 490 } 491 492 let inode = result.find(&name)?; 493 494 // 处理符号链接的问题 495 if inode.metadata()?.file_type == FileType::SymLink && max_follow_times > 0 { 496 let mut content = [0u8; 256]; 497 // 读取符号链接 498 let len = inode.read_at(0, 256, &mut content, &mut FilePrivateData::Unused)?; 499 500 // 将读到的数据转换为utf8字符串（先转为str，再转为String） 501 let link_path = String::from( 502 ::core::str::from_utf8(&content[..len]).map_err(|_| SystemError::ENOTDIR)?, 503 ); 504 505 let new_path = link_path + "/" + &rest_path; 506 // 继续查找符号链接 507 return result.lookup_follow_symlink(&new_path, max_follow_times - 1); 508 } else { 509 result = inode; 510 } 511 } 512 513 return Ok(result); 514 } 515 } 516 517 /// IndexNode的元数据 518 /// 519 /// 对应Posix2008中的sys/stat.h中的定义 https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_stat.h.html 520 #[derive(Debug, PartialEq, Eq, Clone)] 521 pub struct Metadata { 522 /// 当前inode所在的文件系统的设备号 523 pub dev_id: usize, 524 525 /// inode号 526 pub inode_id: InodeId, 527 528 /// Inode的大小 529 /// 文件：文件大小（单位：字节） 530 /// 目录：目录项中的文件、文件夹数量 531 pub size: i64, 532 533 /// Inode所在的文件系统中，每个块的大小 534 pub blk_size: usize, 535 536 /// Inode所占的块的数目 537 pub blocks: usize, 538 539 /// inode最后一次被访问的时间 540 pub atime: TimeSpec, 541 542 /// inode最后一次修改的时间 543 pub mtime: TimeSpec, 544 545 /// inode的创建时间 546 pub ctime: TimeSpec, 547 548 /// 文件类型 549 pub file_type: FileType, 550 551 /// 权限 552 pub mode: ModeType, 553 554 /// 硬链接的数量 555 pub nlinks: usize, 556 557 /// User ID 558 pub uid: usize, 559 560 /// Group ID 561 pub gid: usize, 562 563 /// 文件指向的设备的id（对于设备文件系统来说） 564 pub raw_dev: DeviceNumber, 565 } 566 567 impl Default for Metadata { 568 fn default() -> Self { 569 return Self { 570 dev_id: 0, 571 inode_id: InodeId::new(0), 572 size: 0, 573 blk_size: 0, 574 blocks: 0, 575 atime: TimeSpec::default(), 576 mtime: TimeSpec::default(), 577 ctime: TimeSpec::default(), 578 file_type: FileType::File, 579 mode: ModeType::empty(), 580 nlinks: 1, 581 uid: 0, 582 gid: 0, 583 raw_dev: DeviceNumber::default(), 584 }; 585 } 586 } 587 588 /// @brief 所有文件系统都应该实现的trait 589 pub trait FileSystem: Any + Sync + Send + Debug { 590 /// @brief 获取当前文件系统的root inode的指针 591 fn root_inode(&self) -> Arc<dyn IndexNode>; 592 593 /// @brief 获取当前文件系统的信息 594 fn info(&self) -> FsInfo; 595 596 /// @brief 本函数用于实现动态转换。 597 /// 具体的文件系统在实现本函数时，最简单的方式就是：直接返回self 598 fn as_any_ref(&self) -> &dyn Any; 599 } 600 601 impl DowncastArc for dyn FileSystem { 602 fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any> { 603 self 604 } 605 } 606 607 #[derive(Debug)] 608 pub struct FsInfo { 609 /// 文件系统所在的块设备的id 610 pub blk_dev_id: usize, 611 /// 文件名的最大长度 612 pub max_name_len: usize, 613 } 614 615 /// @brief 616 #[repr(C)] 617 #[derive(Debug)] 618 pub struct Dirent { 619 d_ino: u64, // 文件序列号 620 d_off: i64, // dir偏移量 621 d_reclen: u16, // 目录下的记录数 622 d_type: u8, // entry的类型 623 d_name: u8, // 文件entry的名字(是一个零长数组)， 本字段仅用于占位 624 } 625 626 impl Metadata { 627 pub fn new(file_type: FileType, mode: ModeType) -> Self { 628 Metadata { 629 dev_id: 0, 630 inode_id: generate_inode_id(), 631 size: 0, 632 blk_size: 0, 633 blocks: 0, 634 atime: TimeSpec::default(), 635 mtime: TimeSpec::default(), 636 ctime: TimeSpec::default(), 637 file_type, 638 mode, 639 nlinks: 1, 640 uid: 0, 641 gid: 0, 642 raw_dev: DeviceNumber::default(), 643 } 644 } 645 } 646