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