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