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