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