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