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