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