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