1 #![allow(dead_code)] 2 use core::{cmp::min, intrinsics::unlikely}; 3 use system_error::SystemError; 4 5 use crate::{ 6 driver::base::block::{block_device::LBA_SIZE, SeekFrom}, 7 kwarn, 8 libs::vec_cursor::VecCursor, 9 }; 10 use alloc::{ 11 string::{String, ToString}, 12 sync::Arc, 13 vec::Vec, 14 }; 15 16 use super::{ 17 fs::{Cluster, FATFileSystem, MAX_FILE_SIZE}, 18 utils::decode_u8_ascii, 19 }; 20 21 #[derive(Debug, Clone, Copy, Default)] 22 pub struct FileAttributes { 23 value: u8, 24 } 25 26 /// FAT表中，关于每个簇的信息 27 #[derive(Debug, Eq, PartialEq)] 28 pub enum FATEntry { 29 /// 当前簇未使用 30 Unused, 31 /// 当前簇是坏簇 32 Bad, 33 /// 当前簇是整个FAT簇链的最后一个簇 34 EndOfChain, 35 /// 在整个链中，当前簇的下一个簇的值 36 Next(Cluster), 37 } 38 39 /// FAT目录项的枚举类型 40 #[derive(Debug, Clone)] 41 pub enum FATDirEntry { 42 File(FATFile), 43 VolId(FATFile), 44 Dir(FATDir), 45 UnInit, 46 } 47 48 /// FAT文件系统中的文件 49 #[derive(Debug, Default, Clone)] 50 pub struct FATFile { 51 /// 文件的第一个簇 52 pub first_cluster: Cluster, 53 /// 文件名 54 pub file_name: String, 55 /// 文件对应的短目录项 56 pub short_dir_entry: ShortDirEntry, 57 /// 文件目录项的起始、终止簇。格式：(簇，簇内偏移量) 58 pub loc: ((Cluster, u64), (Cluster, u64)), 59 } 60 61 impl FATFile { 62 /// @brief 获取文件大小 63 #[inline] 64 pub fn size(&self) -> u64 { 65 return self.short_dir_entry.file_size as u64; 66 } 67 68 /// @brief 设置当前文件大小（仅仅更改short_dir_entry内的值） 69 #[inline] 70 pub fn set_size(&mut self, size: u32) { 71 self.short_dir_entry.file_size = size; 72 } 73 74 /// @brief 从文件读取数据。读取的字节数与buf长度相等 75 /// 76 /// @param buf 输出缓冲区 77 /// @param offset 起始位置在文件中的偏移量 78 /// 79 /// @return Ok(usize) 成功读取到的字节数 80 /// @return Err(SystemError) 读取时出现错误，返回错误码 81 pub fn read( 82 &self, 83 fs: &Arc<FATFileSystem>, 84 buf: &mut [u8], 85 offset: u64, 86 ) -> Result<usize, SystemError> { 87 if offset >= self.size() { 88 return Ok(0); 89 } 90 91 // 文件内的簇偏移量 92 let start_cluster_number: u64 = offset / fs.bytes_per_cluster(); 93 // 计算对应在分区内的簇号 94 let mut current_cluster = if let Some(c) = 95 fs.get_cluster_by_relative(self.first_cluster, start_cluster_number as usize) 96 { 97 c 98 } else { 99 return Ok(0); 100 }; 101 102 let bytes_remain: u64 = self.size() - offset; 103 104 // 计算簇内偏移量 105 let mut in_cluster_offset: u64 = offset % fs.bytes_per_cluster(); 106 let to_read_size: usize = min(buf.len(), bytes_remain as usize); 107 108 let mut start = 0; 109 let mut read_ok = 0; 110 111 loop { 112 // 当前簇已经读取完，尝试读取下一个簇 113 if in_cluster_offset >= fs.bytes_per_cluster() { 114 if let Some(FATEntry::Next(c)) = fs.get_fat_entry(current_cluster).ok() { 115 current_cluster = c; 116 in_cluster_offset %= fs.bytes_per_cluster(); 117 } else { 118 break; 119 } 120 } 121 122 // 计算下一次读取，能够读多少字节 123 let end_len: usize = min( 124 to_read_size - read_ok, 125 min( 126 (fs.bytes_per_cluster() - in_cluster_offset) as usize, 127 buf.len() - read_ok, 128 ), 129 ); 130 131 // 从磁盘上读取数据 132 let offset = fs.cluster_bytes_offset(current_cluster) + in_cluster_offset; 133 let r = fs.partition.disk().read_at_bytes( 134 offset as usize, 135 end_len, 136 &mut buf[start..start + end_len], 137 )?; 138 139 // 更新偏移量计数信息 140 read_ok += r; 141 start += r; 142 in_cluster_offset += r as u64; 143 if read_ok == to_read_size { 144 break; 145 } 146 } 147 // todo: 更新时间信息 148 return Ok(read_ok); 149 } 150 151 /// @brief 向文件写入数据。写入的字节数与buf长度相等 152 /// 153 /// @param buf 输入缓冲区 154 /// @param offset 起始位置在文件中的偏移量 155 /// 156 /// @return Ok(usize) 成功写入的字节数 157 /// @return Err(SystemError) 写入时出现错误，返回错误码 158 pub fn write( 159 &mut self, 160 fs: &Arc<FATFileSystem>, 161 buf: &[u8], 162 offset: u64, 163 ) -> Result<usize, SystemError> { 164 self.ensure_len(fs, offset, buf.len() as u64)?; 165 166 // 要写入的第一个簇的簇号 167 let start_cluster_num = offset / fs.bytes_per_cluster(); 168 // 获取要写入的第一个簇 169 let mut current_cluster: Cluster = if let Some(c) = 170 fs.get_cluster_by_relative(self.first_cluster, start_cluster_num as usize) 171 { 172 c 173 } else { 174 return Ok(0); 175 }; 176 177 let mut in_cluster_bytes_offset: u64 = offset % fs.bytes_per_cluster(); 178 179 let mut start: usize = 0; 180 let mut write_ok: usize = 0; 181 182 // 循环写入数据 183 loop { 184 if in_cluster_bytes_offset >= fs.bytes_per_cluster() { 185 if let Some(FATEntry::Next(c)) = fs.get_fat_entry(current_cluster).ok() { 186 current_cluster = c; 187 in_cluster_bytes_offset = in_cluster_bytes_offset % fs.bytes_per_cluster(); 188 } else { 189 break; 190 } 191 } 192 193 let end_len = min( 194 (fs.bytes_per_cluster() - in_cluster_bytes_offset) as usize, 195 buf.len() - write_ok, 196 ); 197 198 // 计算本次写入位置在磁盘上的偏移量 199 let offset = fs.cluster_bytes_offset(current_cluster) + in_cluster_bytes_offset; 200 // 写入磁盘 201 let w: usize = fs.partition.disk().write_at_bytes( 202 offset as usize, 203 end_len, 204 &buf[start..start + end_len], 205 )?; 206 207 // 更新偏移量数据 208 write_ok += w; 209 start += w; 210 in_cluster_bytes_offset += w as u64; 211 212 if write_ok == buf.len() { 213 break; 214 } 215 } 216 // todo: 更新时间信息 217 return Ok(write_ok); 218 } 219 220 /// @brief 确保文件从指定偏移量开始，仍有长度为len的空间。 221 /// 如果文件大小不够，就尝试分配更多的空间给这个文件。 222 /// 223 /// @param fs 当前文件所属的文件系统 224 /// @param offset 起始位置在文件内的字节偏移量 225 /// @param len 期待的空闲空间长度 226 /// 227 /// @return Ok(()) 经过操作后，offset后面具有长度至少为len的空闲空间 228 /// @return Err(SystemError) 处理过程中出现了异常。 229 fn ensure_len( 230 &mut self, 231 fs: &Arc<FATFileSystem>, 232 offset: u64, 233 len: u64, 234 ) -> Result<(), SystemError> { 235 // 文件内本身就还有空余的空间 236 if offset + len <= self.size() { 237 return Ok(()); 238 } 239 240 // 计算文件的最后一个簇中有多少空闲空间 241 let in_cluster_offset = self.size() % fs.bytes_per_cluster(); 242 let mut bytes_remain_in_cluster = if in_cluster_offset == 0 { 243 0 244 } else { 245 fs.bytes_per_cluster() - in_cluster_offset 246 }; 247 248 // 计算还需要申请多少空间 249 let extra_bytes = min((offset + len) - self.size(), MAX_FILE_SIZE - self.size()); 250 251 // 如果文件大小为0,证明它还没有分配簇，因此分配一个簇给它 252 if self.size() == 0 { 253 // first_cluster应当为0,否则将产生空间泄露的错误 254 assert_eq!(self.first_cluster, Cluster::default()); 255 self.first_cluster = fs.allocate_cluster(None)?; 256 self.short_dir_entry.set_first_cluster(self.first_cluster); 257 bytes_remain_in_cluster = fs.bytes_per_cluster(); 258 } 259 260 // 如果还需要更多的簇 261 if bytes_remain_in_cluster < extra_bytes { 262 let clusters_to_allocate = 263 (extra_bytes - bytes_remain_in_cluster + fs.bytes_per_cluster() - 1) 264 / fs.bytes_per_cluster(); 265 let last_cluster = if let Some(c) = fs.get_last_cluster(self.first_cluster) { 266 c 267 } else { 268 kwarn!("FAT: last cluster not found, File = {self:?}"); 269 return Err(SystemError::EINVAL); 270 }; 271 // 申请簇 272 let mut current_cluster: Cluster = last_cluster; 273 for _ in 0..clusters_to_allocate { 274 current_cluster = fs.allocate_cluster(Some(current_cluster))?; 275 } 276 } 277 278 // 如果文件被扩展，则清空刚刚被扩展的部分的数据 279 if offset > self.size() { 280 // 文件内的簇偏移 281 let start_cluster: u64 = self.size() / fs.bytes_per_cluster(); 282 let start_cluster: Cluster = fs 283 .get_cluster_by_relative(self.first_cluster, start_cluster as usize) 284 .unwrap(); 285 // 计算当前文件末尾在磁盘上的字节偏移量 286 let start_offset: u64 = 287 fs.cluster_bytes_offset(start_cluster) + self.size() % fs.bytes_per_cluster(); 288 // 扩展之前，最后一个簇内还剩下多少字节的空间 289 let bytes_remain: u64 = fs.bytes_per_cluster() - (self.size() % fs.bytes_per_cluster()); 290 // 计算在扩展之后的最后一个簇内，文件的终止字节 291 let cluster_offset_start = offset / fs.bytes_per_cluster(); 292 // 扩展后，文件的最后 293 let end_cluster: Cluster = fs 294 .get_cluster_by_relative(self.first_cluster, cluster_offset_start as usize) 295 .unwrap(); 296 297 if start_cluster != end_cluster { 298 self.zero_range(fs, start_offset, start_offset + bytes_remain)?; 299 } else { 300 self.zero_range(fs, start_offset, start_offset + offset - self.size())?; 301 } 302 } 303 // 计算文件的新大小 304 let new_size = self.size() + extra_bytes; 305 self.set_size(new_size as u32); 306 // 计算短目录项所在的位置，更新短目录项 307 let short_entry_offset = fs.cluster_bytes_offset(self.loc.1 .0) + self.loc.1 .1; 308 // todo: 更新时间信息 309 // 把短目录项写入磁盘 310 self.short_dir_entry.flush(fs, short_entry_offset)?; 311 return Ok(()); 312 } 313 314 /// @brief 把磁盘上[range_start, range_end)范围的数据清零 315 /// 316 /// @param range_start 磁盘上起始位置（单位：字节） 317 /// @param range_end 磁盘上终止位置（单位：字节） 318 fn zero_range( 319 &self, 320 fs: &Arc<FATFileSystem>, 321 range_start: u64, 322 range_end: u64, 323 ) -> Result<(), SystemError> { 324 if range_end <= range_start { 325 return Ok(()); 326 } 327 328 let zeroes: Vec<u8> = vec![0u8; (range_end - range_start) as usize]; 329 fs.partition 330 .disk() 331 .write_at(range_start as usize, zeroes.len(), zeroes.as_slice())?; 332 return Ok(()); 333 } 334 335 /// @brief 截断文件的内容，并设置新的文件大小。如果new_size大于当前文件大小，则不做操作。 336 /// 337 /// @param new_size 新的文件大小，如果它大于当前文件大小，则不做操作。 338 /// 339 /// @return Ok(()) 操作成功 340 /// @return Err(SystemError) 在操作时出现错误 341 pub fn truncate(&mut self, fs: &Arc<FATFileSystem>, new_size: u64) -> Result<(), SystemError> { 342 if new_size >= self.size() { 343 return Ok(()); 344 } 345 346 let new_last_cluster = (new_size + fs.bytes_per_cluster() - 1) / fs.bytes_per_cluster(); 347 if let Some(begin_delete) = 348 fs.get_cluster_by_relative(self.first_cluster, new_last_cluster as usize) 349 { 350 fs.deallocate_cluster_chain(begin_delete)?; 351 }; 352 353 if new_size == 0 { 354 assert!(new_last_cluster == 0); 355 self.short_dir_entry.set_first_cluster(Cluster::new(0)); 356 self.first_cluster = Cluster::new(0); 357 } 358 359 self.set_size(new_size as u32); 360 // 计算短目录项在磁盘内的字节偏移量 361 let short_entry_offset = fs.cluster_bytes_offset((self.loc.1).0) + (self.loc.1).1; 362 self.short_dir_entry.flush(fs, short_entry_offset)?; 363 364 return Ok(()); 365 } 366 } 367 368 /// FAT文件系统中的文件夹 369 #[derive(Debug, Default, Clone)] 370 pub struct FATDir { 371 /// 目录的第一个簇 372 pub first_cluster: Cluster, 373 /// 该字段仅对FAT12、FAT16生效 374 pub root_offset: Option<u64>, 375 /// 文件夹名称 376 pub dir_name: String, 377 pub short_dir_entry: Option<ShortDirEntry>, 378 /// 文件的起始、终止簇。格式：(簇，簇内偏移量) 379 pub loc: Option<((Cluster, u64), (Cluster, u64))>, 380 } 381 382 impl FATDir { 383 /// @brief 获得用于遍历当前目录的迭代器 384 /// 385 /// @param fs 当前目录所在的文件系统 386 pub fn to_iter(&self, fs: Arc<FATFileSystem>) -> FATDirIter { 387 return FATDirIter { 388 current_cluster: self.first_cluster, 389 offset: self.root_offset.unwrap_or(0), 390 is_root: self.is_root(), 391 fs: fs, 392 }; 393 } 394 395 /// @brief 判断当前目录是否为根目录（仅对FAT12和FAT16生效） 396 #[inline] 397 pub fn is_root(&self) -> bool { 398 return self.root_offset.is_some(); 399 } 400 401 /// @brief 获取当前目录所占用的大小 402 pub fn size(&self, fs: &Arc<FATFileSystem>) -> u64 { 403 return fs.num_clusters_chain(self.first_cluster) * fs.bytes_per_cluster(); 404 } 405 406 /// @brief 在目录项中，寻找num_free个连续空闲目录项 407 /// 408 /// @param num_free 需要的空闲目录项数目. 409 /// @param fs 当前文件夹属于的文件系统 410 /// 411 /// @return Ok(Option<(第一个符合条件的空闲目录项所在的簇，簇内偏移量)) 412 /// @return Err(错误码) 413 pub fn find_free_entries( 414 &self, 415 num_free: u64, 416 fs: Arc<FATFileSystem>, 417 ) -> Result<Option<(Cluster, u64)>, SystemError> { 418 let mut free = 0; 419 let mut current_cluster: Cluster = self.first_cluster; 420 let mut offset = self.root_offset.unwrap_or(0); 421 // 第一个符合条件的空闲目录项 422 let mut first_free: Option<(Cluster, u64)> = None; 423 424 loop { 425 // 如果当前簇没有空间了，并且当前不是FAT12和FAT16的根目录，那么就读取下一个簇。 426 if offset >= fs.bytes_per_cluster() && !self.is_root() { 427 // 成功读取下一个簇 428 if let Some(FATEntry::Next(c)) = fs.get_fat_entry(current_cluster).ok() { 429 current_cluster = c; 430 // 计算簇内偏移量 431 offset = offset % fs.bytes_per_cluster(); 432 } else { 433 // 读取失败，当前已经是最后一个簇，退出循环 434 break; 435 } 436 } 437 // 如果当前目录是FAT12和FAT16的根目录，且已经读取完，就直接返回。 438 if self.is_root() && offset > fs.root_dir_end_bytes_offset().unwrap() { 439 return Ok(None); 440 } 441 442 let e_offset = fs.cluster_bytes_offset(current_cluster) + offset; 443 let entry: FATRawDirEntry = get_raw_dir_entry(&fs, e_offset)?; 444 445 match entry { 446 FATRawDirEntry::Free | FATRawDirEntry::FreeRest => { 447 if free == 0 { 448 first_free = Some((current_cluster, offset)); 449 } 450 451 free += 1; 452 if free == num_free { 453 // kdebug!("first_free = {first_free:?}, current_free = ({current_cluster:?}, {offset})"); 454 return Ok(first_free); 455 } 456 } 457 458 // 遇到一个不空闲的目录项，那么重新开始计算空闲目录项 459 _ => { 460 free = 0; 461 } 462 } 463 offset += FATRawDirEntry::DIR_ENTRY_LEN; 464 } 465 466 // 剩余的需要获取的目录项 467 let remain_entries = num_free - free; 468 469 // 计算需要申请多少个簇 470 let clusters_required = 471 (remain_entries * FATRawDirEntry::DIR_ENTRY_LEN + fs.bytes_per_cluster() - 1) 472 / fs.bytes_per_cluster(); 473 let mut first_cluster = Cluster::default(); 474 let mut prev_cluster = current_cluster; 475 // kdebug!( 476 // "clusters_required={clusters_required}, prev_cluster={prev_cluster:?}, free ={free}" 477 // ); 478 // 申请簇 479 for i in 0..clusters_required { 480 let c: Cluster = fs.allocate_cluster(Some(prev_cluster))?; 481 if i == 0 { 482 first_cluster = c; 483 } 484 485 prev_cluster = c; 486 } 487 488 if free > 0 { 489 // 空闲目录项跨越了簇，返回第一个空闲目录项 490 return Ok(first_free); 491 } else { 492 // 空闲目录项是在全新的簇开始的 493 return Ok(Some((first_cluster, 0))); 494 } 495 } 496 497 /// @brief 在当前目录中寻找目录项 498 /// 499 /// @param name 目录项的名字 500 /// @param expect_dir 该值为Some时有效。如果期待目标目录项是文件夹，那么值为Some(true), 否则为Some(false). 501 /// @param short_name_gen 短目录项名称生成器 502 /// @param fs 当前目录所属的文件系统 503 /// 504 /// @return Ok(FATDirEntry) 找到期待的目录项 505 /// @return Err(SystemError) 错误码 506 pub fn find_entry( 507 &self, 508 name: &str, 509 expect_dir: Option<bool>, 510 mut short_name_gen: Option<&mut ShortNameGenerator>, 511 fs: Arc<FATFileSystem>, 512 ) -> Result<FATDirEntry, SystemError> { 513 LongDirEntry::validate_long_name(name)?; 514 // 迭代当前目录下的文件/文件夹 515 for e in self.to_iter(fs) { 516 if e.eq_name(name) { 517 if expect_dir.is_some() && Some(e.is_dir()) != expect_dir { 518 if e.is_dir() { 519 // 期望得到文件，但是是文件夹 520 return Err(SystemError::EISDIR); 521 } else { 522 // 期望得到文件夹，但是是文件 523 return Err(SystemError::ENOTDIR); 524 } 525 } 526 // 找到期望的目录项 527 return Ok(e); 528 } 529 530 if let Some(ref mut sng) = short_name_gen { 531 sng.add_name(&e.short_name_raw()) 532 } 533 } 534 // 找不到文件/文件夹 535 return Err(SystemError::ENOENT); 536 } 537 538 /// @brief 在当前目录下打开文件，获取FATFile结构体 539 pub fn open_file(&self, name: &str, fs: Arc<FATFileSystem>) -> Result<FATFile, SystemError> { 540 let f: FATFile = self.find_entry(name, Some(false), None, fs)?.to_file()?; 541 return Ok(f); 542 } 543 544 /// @brief 在当前目录下打开文件夹，获取FATDir结构体 545 pub fn open_dir(&self, name: &str, fs: Arc<FATFileSystem>) -> Result<FATDir, SystemError> { 546 let d: FATDir = self.find_entry(name, Some(true), None, fs)?.to_dir()?; 547 return Ok(d); 548 } 549 550 /// @brief 在当前文件夹下创建文件。 551 /// 552 /// @param name 文件名 553 /// @param fs 当前文件夹所属的文件系统 554 pub fn create_file(&self, name: &str, fs: &Arc<FATFileSystem>) -> Result<FATFile, SystemError> { 555 let r: Result<FATDirEntryOrShortName, SystemError> = 556 self.check_existence(name, Some(false), fs.clone()); 557 // 检查错误码，如果能够表明目录项已经存在，则返回-EEXIST 558 if r.is_err() { 559 let err_val = r.unwrap_err(); 560 if err_val == (SystemError::EISDIR) || err_val == (SystemError::ENOTDIR) { 561 return Err(SystemError::EEXIST); 562 } else { 563 return Err(err_val); 564 } 565 } 566 567 match r.unwrap() { 568 FATDirEntryOrShortName::ShortName(short_name) => { 569 // 确认名称是一个可行的长文件名 570 LongDirEntry::validate_long_name(name)?; 571 // 创建目录项 572 let x: Result<FATFile, SystemError> = self 573 .create_dir_entries( 574 name.trim(), 575 &short_name, 576 None, 577 FileAttributes { 578 value: FileAttributes::ARCHIVE, 579 }, 580 fs.clone(), 581 ) 582 .map(|e| e.to_file())?; 583 return x; 584 } 585 586 FATDirEntryOrShortName::DirEntry(_) => { 587 // 已经存在这样的一个目录项了 588 return Err(SystemError::EEXIST); 589 } 590 } 591 } 592 593 pub fn create_dir(&self, name: &str, fs: &Arc<FATFileSystem>) -> Result<FATDir, SystemError> { 594 let r: Result<FATDirEntryOrShortName, SystemError> = 595 self.check_existence(name, Some(true), fs.clone()); 596 // kdebug!("check existence ok"); 597 // 检查错误码，如果能够表明目录项已经存在，则返回-EEXIST 598 if r.is_err() { 599 let err_val = r.unwrap_err(); 600 if err_val == (SystemError::EISDIR) || err_val == (SystemError::ENOTDIR) { 601 return Err(SystemError::EEXIST); 602 } else { 603 return Err(err_val); 604 } 605 } 606 607 match r.unwrap() { 608 // 文件夹不存在，创建文件夹 609 FATDirEntryOrShortName::ShortName(short_name) => { 610 LongDirEntry::validate_long_name(name)?; 611 // 目标目录项 612 let mut short_entry = ShortDirEntry::default(); 613 614 let first_cluster: Cluster = fs.allocate_cluster(None)?; 615 short_entry.set_first_cluster(first_cluster); 616 617 // === 接下来在子目录中创建'.'目录项和'..'目录项 618 let mut offset = 0; 619 // '.'目录项 620 let mut dot_entry = ShortDirEntry::default(); 621 dot_entry.name = ShortNameGenerator::new(".").generate().unwrap(); 622 dot_entry.attributes.value = FileAttributes::DIRECTORY; 623 dot_entry.set_first_cluster(first_cluster); 624 625 // todo: 设置创建、访问时间 626 dot_entry.flush(&fs, fs.cluster_bytes_offset(first_cluster) + offset)?; 627 628 // 偏移量加上一个目录项的长度 629 offset += FATRawDirEntry::DIR_ENTRY_LEN; 630 631 // '..'目录项 632 let mut dot_dot_entry = ShortDirEntry::default(); 633 dot_dot_entry.name = ShortNameGenerator::new("..").generate().unwrap(); 634 dot_dot_entry.attributes.value = FileAttributes::DIRECTORY; 635 dot_dot_entry.set_first_cluster(self.first_cluster); 636 // todo: 设置创建、访问时间 637 638 dot_dot_entry.flush(&fs, fs.cluster_bytes_offset(first_cluster) + offset)?; 639 640 // kdebug!("to create dentries"); 641 // 在当前目录下创建目标目录项 642 let res = self 643 .create_dir_entries( 644 name.trim(), 645 &short_name, 646 Some(short_entry), 647 FileAttributes { 648 value: FileAttributes::DIRECTORY, 649 }, 650 fs.clone(), 651 ) 652 .map(|e| e.to_dir())?; 653 // kdebug!("create dentries ok"); 654 return res; 655 } 656 FATDirEntryOrShortName::DirEntry(_) => { 657 // 已经存在这样的一个目录项了 658 return Err(SystemError::EEXIST); 659 } 660 } 661 } 662 /// @brief 检查目录项在当前文件夹下是否存在 663 /// 664 /// @param name 目录项的名字 665 /// @param expect_dir 该值为Some时有效。如果期待目标目录项是文件夹，那么值为Some(true), 否则为Some(false). 666 /// @param fs 当前目录所属的文件系统 667 /// 668 /// @return Ok(FATDirEntryOrShortName::DirEntry) 找到期待的目录项 669 /// @return Ok(FATDirEntryOrShortName::ShortName) 当前文件夹下不存在指定的目录项，因此返回一个可行的短文件名 670 /// @return Err(SystemError) 错误码 671 pub fn check_existence( 672 &self, 673 name: &str, 674 expect_dir: Option<bool>, 675 fs: Arc<FATFileSystem>, 676 ) -> Result<FATDirEntryOrShortName, SystemError> { 677 let mut sng = ShortNameGenerator::new(name); 678 679 loop { 680 let e: Result<FATDirEntry, SystemError> = 681 self.find_entry(name, expect_dir, Some(&mut sng), fs.clone()); 682 match e { 683 Ok(e) => { 684 // 找到，返回目录项 685 return Ok(FATDirEntryOrShortName::DirEntry(e)); 686 } 687 Err(e) => { 688 // 如果没找到，则不返回错误 689 if e == SystemError::ENOENT { 690 } else { 691 // 其他错误，则返回 692 return Err(e); 693 } 694 } 695 } 696 697 // 没找到文件，则生成短文件名 698 if let Ok(name) = sng.generate() { 699 return Ok(FATDirEntryOrShortName::ShortName(name)); 700 } 701 702 sng.next_iteration(); 703 } 704 } 705 706 /// @brief 创建一系列的目录项 707 /// 708 /// @param long_name 长文件名 709 /// @param short_name 短文件名 710 /// @param short_dentry 可选的生成好的短目录项结构体 711 /// @param attrs FAT目录项的属性 712 /// @param fs 当前文件夹所属的文件系统 713 /// 714 /// @return Ok(FATDirEntry) FAT目录项的枚举类型（目录项链条的最后一个长目录项） 715 fn create_dir_entries( 716 &self, 717 long_name: &str, 718 short_name: &[u8; 11], 719 short_dentry: Option<ShortDirEntry>, 720 attrs: FileAttributes, 721 fs: Arc<FATFileSystem>, 722 ) -> Result<FATDirEntry, SystemError> { 723 let mut short_dentry: ShortDirEntry = short_dentry.unwrap_or(ShortDirEntry::default()); 724 short_dentry.name = short_name.clone(); 725 short_dentry.attributes = attrs; 726 727 // todo: 设置创建时间、修改时间 728 729 let mut long_name_gen: LongNameEntryGenerator = 730 LongNameEntryGenerator::new(long_name, short_dentry.checksum()); 731 let num_entries = long_name_gen.num_entries() as u64; 732 733 // kdebug!("to find free entries"); 734 let free_entries: Option<(Cluster, u64)> = 735 self.find_free_entries(num_entries, fs.clone())?; 736 // 目录项开始位置 737 let start_loc: (Cluster, u64) = match free_entries { 738 Some(c) => c, 739 None => return Err(SystemError::ENOSPC), 740 }; 741 let offsets: Vec<(Cluster, u64)> = 742 FATDirEntryOffsetIter::new(fs.clone(), start_loc, num_entries, None).collect(); 743 744 // 迭代长目录项 745 for off in &offsets.as_slice()[..offsets.len() - 1] { 746 // 获取生成的下一个长目录项 747 let long_entry: LongDirEntry = long_name_gen.next().unwrap(); 748 // 获取这个长目录项在磁盘内的字节偏移量 749 let bytes_offset = fs.cluster_bytes_offset(off.0) + off.1; 750 long_entry.flush(fs.clone(), bytes_offset)?; 751 } 752 753 let start: (Cluster, u64) = offsets[0]; 754 let end: (Cluster, u64) = *offsets.last().unwrap(); 755 // 短目录项在磁盘上的字节偏移量 756 let offset = fs.cluster_bytes_offset(end.0) + end.1; 757 short_dentry.flush(&fs, offset)?; 758 759 return Ok(short_dentry.to_dir_entry_with_long_name(long_name.to_string(), (start, end))); 760 } 761 762 /// @brief 判断当前目录是否为空 763 /// 764 /// @return true 当前目录为空 765 /// @return false 当前目录不为空 766 pub fn is_empty(&self, fs: Arc<FATFileSystem>) -> bool { 767 for e in self.to_iter(fs) { 768 let s = e.short_name(); 769 if s == "." || s == ".." { 770 continue; 771 } else { 772 return false; 773 } 774 } 775 return true; 776 } 777 778 /// @brief 从当前文件夹中删除文件或者文件夹。如果目标文件夹不为空，则不能删除，返回-ENOTEMPTY. 779 /// 780 /// @param fs 当前FATDir所属的文件系统 781 /// @param name 目录项的名字 782 /// @param remove_clusters 是否删除与指定的目录项相关联的数据簇 783 /// 784 /// @return Ok() 成功时无返回值 785 /// @return Err(SystemError) 如果目标文件夹不为空，则不能删除，返回-ENOTEMPTY. 或者返回底层传上来的错误 786 pub fn remove( 787 &self, 788 fs: Arc<FATFileSystem>, 789 name: &str, 790 remove_clusters: bool, 791 ) -> Result<(), SystemError> { 792 let e: FATDirEntry = self.find_entry(name, None, None, fs.clone())?; 793 794 // 判断文件夹是否为空，如果空，则不删除，报错。 795 if e.is_dir() && !(e.to_dir().unwrap().is_empty(fs.clone())) { 796 return Err(SystemError::ENOTEMPTY); 797 } 798 799 if e.first_cluster().cluster_num >= 2 && remove_clusters { 800 // 删除与指定的目录项相关联的数据簇 801 fs.deallocate_cluster_chain(e.first_cluster())?; 802 } 803 804 if e.get_dir_range().is_some() { 805 self.remove_dir_entries(fs, e.get_dir_range().unwrap())?; 806 } 807 808 return Ok(()); 809 } 810 811 /// @brief 在当前目录中删除多个目录项 812 /// 813 /// @param fs 当前目录所属的文件系统 814 /// @param cluster_range 要删除的目录项的范围（以簇+簇内偏移量的形式表示） 815 fn remove_dir_entries( 816 &self, 817 fs: Arc<FATFileSystem>, 818 cluster_range: ((Cluster, u64), (Cluster, u64)), 819 ) -> Result<(), SystemError> { 820 // 收集所有的要移除的目录项 821 let offsets: Vec<(Cluster, u64)> = 822 FATDirEntryOffsetIter::new(fs.clone(), cluster_range.0, 15, Some(cluster_range.1)) 823 .collect(); 824 // 逐个设置这些目录项为“空闲”状态 825 for off in offsets { 826 let disk_bytes_offset = fs.cluster_bytes_offset(off.0) + off.1; 827 let mut short_entry = ShortDirEntry::default(); 828 short_entry.name[0] = 0xe5; 829 short_entry.flush(&fs, disk_bytes_offset)?; 830 } 831 return Ok(()); 832 } 833 834 /// @brief 根据名字在当前文件夹下寻找目录项 835 /// 836 /// @return Ok(FATDirEntry) 目标目录项 837 /// @return Err(SystemError) 底层传上来的错误码 838 pub fn get_dir_entry( 839 &self, 840 fs: Arc<FATFileSystem>, 841 name: &str, 842 ) -> Result<FATDirEntry, SystemError> { 843 if name == "." || name == "/" { 844 return Ok(FATDirEntry::Dir(self.clone())); 845 } 846 847 LongDirEntry::validate_long_name(name)?; 848 return self.find_entry(name, None, None, fs); 849 } 850 851 /// @brief 在当前目录内，重命名一个目录项 852 /// 853 pub fn rename( 854 &self, 855 fs: Arc<FATFileSystem>, 856 old_name: &str, 857 new_name: &str, 858 ) -> Result<FATDirEntry, SystemError> { 859 // 判断源目录项是否存在 860 let old_dentry: FATDirEntry = if let FATDirEntryOrShortName::DirEntry(dentry) = 861 self.check_existence(old_name, None, fs.clone())? 862 { 863 dentry 864 } else { 865 // 如果目标目录项不存在，则返回错误 866 return Err(SystemError::ENOENT); 867 }; 868 869 let short_name = if let FATDirEntryOrShortName::ShortName(s) = 870 self.check_existence(new_name, None, fs.clone())? 871 { 872 s 873 } else { 874 // 如果目标目录项存在，那么就返回错误 875 return Err(SystemError::EEXIST); 876 }; 877 878 let old_short_dentry: Option<ShortDirEntry> = old_dentry.short_dir_entry(); 879 if let Some(se) = old_short_dentry { 880 // 删除原来的目录项 881 self.remove(fs.clone(), old_dentry.name().as_str(), false)?; 882 883 // 创建新的目录项 884 let new_dentry: FATDirEntry = self.create_dir_entries( 885 new_name, 886 &short_name, 887 Some(se), 888 se.attributes, 889 fs.clone(), 890 )?; 891 892 return Ok(new_dentry); 893 } else { 894 // 不允许对根目录项进行重命名 895 return Err(SystemError::EPERM); 896 } 897 } 898 899 /// @brief 跨目录，重命名一个目录项 900 /// 901 pub fn rename_across( 902 &self, 903 fs: Arc<FATFileSystem>, 904 target: &FATDir, 905 old_name: &str, 906 new_name: &str, 907 ) -> Result<FATDirEntry, SystemError> { 908 // 判断源目录项是否存在 909 let old_dentry: FATDirEntry = if let FATDirEntryOrShortName::DirEntry(dentry) = 910 self.check_existence(old_name, None, fs.clone())? 911 { 912 dentry 913 } else { 914 // 如果目标目录项不存在，则返回错误 915 return Err(SystemError::ENOENT); 916 }; 917 918 let short_name = if let FATDirEntryOrShortName::ShortName(s) = 919 target.check_existence(new_name, None, fs.clone())? 920 { 921 s 922 } else { 923 // 如果目标目录项存在，那么就返回错误 924 return Err(SystemError::EEXIST); 925 }; 926 927 let old_short_dentry: Option<ShortDirEntry> = old_dentry.short_dir_entry(); 928 if let Some(se) = old_short_dentry { 929 // 删除原来的目录项 930 self.remove(fs.clone(), old_dentry.name().as_str(), false)?; 931 932 // 创建新的目录项 933 let new_dentry: FATDirEntry = target.create_dir_entries( 934 new_name, 935 &short_name, 936 Some(se), 937 se.attributes, 938 fs.clone(), 939 )?; 940 941 return Ok(new_dentry); 942 } else { 943 // 不允许对根目录项进行重命名 944 return Err(SystemError::EPERM); 945 } 946 } 947 } 948 949 impl FileAttributes { 950 pub const READ_ONLY: u8 = 1 << 0; 951 pub const HIDDEN: u8 = 1 << 1; 952 pub const SYSTEM: u8 = 1 << 2; 953 pub const VOLUME_ID: u8 = 1 << 3; 954 pub const DIRECTORY: u8 = 1 << 4; 955 pub const ARCHIVE: u8 = 1 << 5; 956 pub const LONG_NAME: u8 = FileAttributes::READ_ONLY 957 | FileAttributes::HIDDEN 958 | FileAttributes::SYSTEM 959 | FileAttributes::VOLUME_ID; 960 961 /// @brief 判断属性是否存在 962 #[inline] 963 pub fn contains(&self, attr: u8) -> bool { 964 return (self.value & attr) != 0; 965 } 966 967 pub fn new(attr: u8) -> Self { 968 return Self { value: attr }; 969 } 970 } 971 972 /// FAT32的短目录项 973 #[derive(Debug, Clone, Copy, Default)] 974 pub struct ShortDirEntry { 975 /// short name 976 name: [u8; 11], 977 /// 目录项属性 (见 FileAttributes ) 978 attributes: FileAttributes, 979 980 /// Windows NT系统的保留字段。用来表示短目录项文件名。 981 /// EXT|BASE => 8(BASE).3(EXT) 982 /// BASE:LowerCase(8),UpperCase(0) 983 /// EXT:LowerCase(16),UpperCase(0) 984 nt_res: u8, 985 986 /// 文件创建时间的毫秒级时间戳 987 crt_time_tenth: u8, 988 /// 创建时间 989 crt_time: u16, 990 /// 创建日期 991 crt_date: u16, 992 /// 最后一次访问日期 993 lst_acc_date: u16, 994 /// High word of first cluster(0 for FAT12 and FAT16) 995 fst_clus_hi: u16, 996 /// 最后写入时间 997 wrt_time: u16, 998 /// 最后写入日期 999 wrt_date: u16, 1000 /// Low word of first cluster 1001 fst_clus_lo: u16, 1002 /// 文件大小 1003 file_size: u32, 1004 } 1005 1006 /// FAT32的长目录项 1007 #[derive(Debug, Clone, Copy, Default)] 1008 pub struct LongDirEntry { 1009 /// 长目录项的序号 1010 ord: u8, 1011 /// 长文件名的第1-5个字符，每个字符占2bytes 1012 name1: [u16; 5], 1013 /// 目录项属性必须为ATTR_LONG_NAME 1014 file_attrs: FileAttributes, 1015 /// Entry Type: 如果为0，则说明这是长目录项的子项 1016 /// 非零值是保留的。 1017 dirent_type: u8, 1018 /// 短文件名的校验和 1019 checksum: u8, 1020 /// 长文件名的第6-11个字符，每个字符占2bytes 1021 name2: [u16; 6], 1022 /// 必须为0 1023 first_clus_low: u16, 1024 /// 长文件名的12-13个字符，每个字符占2bytes 1025 name3: [u16; 2], 1026 } 1027 1028 impl LongDirEntry { 1029 /// 长目录项的字符串长度（单位：word） 1030 pub const LONG_NAME_STR_LEN: usize = 13; 1031 1032 /// @brief 初始化一个新的长目录项 1033 /// 1034 /// @param ord 顺序 1035 /// @param name_part 长目录项名称的数组（长度必须为13） 1036 /// @param check_sum 短目录项的校验和 1037 /// 1038 /// @return Self 初始化好的长目录项对象 1039 fn new(ord: u8, name_part: &[u16], check_sum: u8) -> Self { 1040 let mut result = LongDirEntry::default(); 1041 result.ord = ord; 1042 result 1043 .insert_name(name_part) 1044 .expect("Name part's len should be equal to 13."); 1045 result.file_attrs.value = FileAttributes::LONG_NAME; 1046 result.dirent_type = 0; 1047 result.checksum = check_sum; 1048 // 该字段需要外层的代码手动赋值 1049 result.first_clus_low = 0; 1050 return result; 1051 } 1052 1053 /// @brief 填写长目录项的名称字段。 1054 /// 1055 /// @param name_part 要被填入当前长目录项的名字（数组长度必须为13） 1056 /// 1057 /// @return Ok(()) 1058 /// @return Err(SystemError) 错误码 1059 fn insert_name(&mut self, name_part: &[u16]) -> Result<(), SystemError> { 1060 if name_part.len() != Self::LONG_NAME_STR_LEN { 1061 return Err(SystemError::EINVAL); 1062 } 1063 self.name1.copy_from_slice(&name_part[0..5]); 1064 self.name2.copy_from_slice(&name_part[5..11]); 1065 self.name3.copy_from_slice(&name_part[11..13]); 1066 return Ok(()); 1067 } 1068 1069 /// @brief 将当前长目录项的名称字段，原样地拷贝到一个长度为13的u16数组中。 1070 /// @param dst 拷贝的目的地，一个[u16]数组，长度必须为13。 1071 pub fn copy_name_to_slice(&self, dst: &mut [u16]) -> Result<(), SystemError> { 1072 if dst.len() != Self::LONG_NAME_STR_LEN { 1073 return Err(SystemError::EINVAL); 1074 } 1075 dst[0..5].copy_from_slice(&self.name1); 1076 dst[5..11].copy_from_slice(&self.name2); 1077 dst[11..13].copy_from_slice(&self.name3); 1078 return Ok(()); 1079 } 1080 1081 /// @brief 是否为最后一个长目录项 1082 /// 1083 /// @return true 是最后一个长目录项 1084 /// @return false 不是最后一个长目录项 1085 pub fn is_last(&self) -> bool { 1086 return self.ord & 0x40 > 0; 1087 } 1088 1089 /// @brief 校验字符串是否符合长目录项的命名要求 1090 /// 1091 /// @return Ok(()) 名称合法 1092 /// @return Err(SystemError) 名称不合法，返回错误码 1093 pub fn validate_long_name(mut name: &str) -> Result<(), SystemError> { 1094 // 去除首尾多余的空格 1095 name = name.trim(); 1096 1097 // 名称不能为0 1098 if name.len() == 0 { 1099 return Err(SystemError::EINVAL); 1100 } 1101 1102 // 名称长度不能大于255 1103 if name.len() > 255 { 1104 return Err(SystemError::ENAMETOOLONG); 1105 } 1106 1107 // 检查是否符合命名要求 1108 for c in name.chars() { 1109 match c { 1110 'a'..='z' | 'A'..='Z' | '0'..='9' => {} 1111 '\u{80}'..='\u{ffff}' => {} 1112 '$' | '%' | '\'' | '-' | '_' | '@' | '~' | '`' | '!' | '(' | ')' | '{' | '}' 1113 | '^' | '#' | '&' => {} 1114 '+' | ',' | ';' | '=' | '[' | ']' | '.' | ' ' => {} 1115 _ => { 1116 return Err(SystemError::EILSEQ); 1117 } 1118 } 1119 } 1120 return Ok(()); 1121 } 1122 1123 /// @brief 把当前长目录项写入磁盘 1124 /// 1125 /// @param fs 对应的文件系统 1126 /// @param disk_bytes_offset 长目录项所在位置对应的在磁盘上的字节偏移量 1127 /// 1128 /// @return Ok(()) 1129 /// @return Err(SystemError) 错误码 1130 pub fn flush(&self, fs: Arc<FATFileSystem>, disk_bytes_offset: u64) -> Result<(), SystemError> { 1131 // 从磁盘读取数据 1132 let blk_offset = fs.get_in_block_offset(disk_bytes_offset); 1133 let lba = fs.get_lba_from_offset( 1134 fs.bytes_to_sector(fs.get_in_partition_bytes_offset(disk_bytes_offset)), 1135 ); 1136 let mut v: Vec<u8> = Vec::new(); 1137 v.resize(1 * fs.lba_per_sector() * LBA_SIZE, 0); 1138 fs.partition 1139 .disk() 1140 .read_at(lba, 1 * fs.lba_per_sector(), &mut v)?; 1141 1142 let mut cursor: VecCursor = VecCursor::new(v); 1143 // 切换游标到对应位置 1144 cursor.seek(SeekFrom::SeekSet(blk_offset as i64))?; 1145 1146 // 写入数据 1147 cursor.write_u8(self.ord)?; 1148 for b in &self.name1 { 1149 cursor.write_u16(*b)?; 1150 } 1151 1152 cursor.write_u8(self.file_attrs.value)?; 1153 cursor.write_u8(self.dirent_type)?; 1154 cursor.write_u8(self.checksum)?; 1155 1156 for b in &self.name2 { 1157 cursor.write_u16(*b)?; 1158 } 1159 1160 cursor.write_u16(self.first_clus_low)?; 1161 1162 for b in &self.name3 { 1163 cursor.write_u16(*b)?; 1164 } 1165 1166 // 把修改后的长目录项刷入磁盘 1167 fs.partition 1168 .disk() 1169 .write_at(lba, 1 * fs.lba_per_sector(), cursor.as_slice())?; 1170 fs.partition.disk().sync()?; 1171 1172 return Ok(()); 1173 } 1174 } 1175 1176 impl ShortDirEntry { 1177 const PADDING: u8 = ' ' as u8; 1178 1179 /// @brief 判断当前目录项是否为文件夹 1180 /// 1181 /// @return true 是文件夹 1182 /// @return false 不是文件夹 1183 pub fn is_dir(&self) -> bool { 1184 return (self.attributes.contains(FileAttributes::DIRECTORY)) 1185 && (!self.attributes.contains(FileAttributes::VOLUME_ID)); 1186 } 1187 1188 /// @brief 判断当前目录项是否为文件 1189 /// 1190 /// @return true 是文件 1191 /// @return false 不是文件 1192 pub fn is_file(&self) -> bool { 1193 return (!self.attributes.contains(FileAttributes::DIRECTORY)) 1194 && (!self.attributes.contains(FileAttributes::VOLUME_ID)); 1195 } 1196 1197 /// @brief 判断当前目录项是否为卷号 1198 /// 1199 /// @return true 是卷号 1200 /// @return false 不是卷号 1201 pub fn is_volume_id(&self) -> bool { 1202 return (!self.attributes.contains(FileAttributes::DIRECTORY)) 1203 && self.attributes.contains(FileAttributes::VOLUME_ID); 1204 } 1205 1206 /// @brief 将短目录项的名字转换为String 1207 fn name_to_string(&self) -> String { 1208 // 计算基础名的长度 1209 let base_len = self.name[..8] 1210 .iter() 1211 .rposition(|x| *x != ShortDirEntry::PADDING) 1212 .map(|len| len + 1) 1213 .unwrap_or(0); 1214 // 计算扩展名的长度 1215 let ext_len = self.name[8..] 1216 .iter() 1217 .rposition(|x| *x != ShortDirEntry::PADDING) 1218 .map(|len| len + 1) 1219 .unwrap_or(0); 1220 1221 // 声明存储完整名字的数组（包含“.”） 1222 let mut name = [ShortDirEntry::PADDING; 12]; 1223 // 拷贝基础名 1224 name[..base_len].copy_from_slice(&self.name[..base_len]); 1225 1226 // 拷贝扩展名，并计算总的长度 1227 let total_len = if ext_len > 0 { 1228 name[base_len] = '.' as u8; 1229 name[base_len + 1..base_len + 1 + ext_len].copy_from_slice(&self.name[8..8 + ext_len]); 1230 // 总长度为基础名长度+点号+扩展名长度 1231 base_len + 1 + ext_len 1232 } else { 1233 base_len 1234 }; 1235 1236 if name[0] == 0x05 { 1237 name[0] = 0xe5; 1238 } 1239 1240 let iter = name[..total_len].iter().map(|c| decode_u8_ascii(*c)); 1241 // 返回最终的字符串 1242 return String::from_iter(iter); 1243 } 1244 1245 /// @brief 将短目录项结构体，转换为FATDirEntry枚举类型 1246 /// 1247 /// @param loc 当前文件的起始、终止簇。格式：(簇，簇内偏移量) 1248 /// @return 生成的FATDirENtry枚举类型 1249 pub fn to_dir_entry(&self, loc: (Cluster, u64)) -> FATDirEntry { 1250 // 当前文件的第一个簇 1251 let first_cluster = 1252 Cluster::new(((self.fst_clus_hi as u64) << 16) | (self.fst_clus_lo as u64)); 1253 1254 // 当前是文件或卷号 1255 if self.is_file() || self.is_volume_id() { 1256 let mut file: FATFile = FATFile::default(); 1257 1258 file.file_name = self.name_to_string(); 1259 file.first_cluster = first_cluster; 1260 file.short_dir_entry = self.clone(); 1261 file.loc = (loc, loc); 1262 1263 // 根据当前短目录项的类型的不同，返回对应的枚举类型。 1264 if self.is_file() { 1265 return FATDirEntry::File(file); 1266 } else { 1267 return FATDirEntry::VolId(file); 1268 } 1269 } else { 1270 // 当前是文件夹 1271 let mut dir = FATDir::default(); 1272 dir.dir_name = self.name_to_string(); 1273 dir.first_cluster = first_cluster; 1274 dir.root_offset = None; 1275 dir.short_dir_entry = Some(self.clone()); 1276 dir.loc = Some((loc, loc)); 1277 1278 return FATDirEntry::Dir(dir); 1279 } 1280 } 1281 1282 /// @brief 将短目录项结构体，转换为FATDirEntry枚举类型. 并且，该短目录项具有对应的长目录项。 1283 /// 因此，需要传入从长目录项获得的完整的文件名 1284 /// 1285 /// @param name 从长目录项获取的完整文件名 1286 /// @param loc 当前文件的起始、终止簇。格式：(簇，簇内偏移量) 1287 /// @return 生成的FATDirENtry枚举类型 1288 pub fn to_dir_entry_with_long_name( 1289 &self, 1290 name: String, 1291 loc: ((Cluster, u64), (Cluster, u64)), 1292 ) -> FATDirEntry { 1293 // 当前文件的第一个簇 1294 let first_cluster = 1295 Cluster::new(((self.fst_clus_hi as u64) << 16) | (self.fst_clus_lo as u64)); 1296 1297 if self.is_file() || self.is_volume_id() { 1298 let mut file = FATFile::default(); 1299 1300 file.first_cluster = first_cluster; 1301 file.file_name = name; 1302 file.loc = loc; 1303 file.short_dir_entry = self.clone(); 1304 1305 if self.is_file() { 1306 return FATDirEntry::File(file); 1307 } else { 1308 return FATDirEntry::VolId(file); 1309 } 1310 } else { 1311 let mut dir = FATDir::default(); 1312 1313 dir.first_cluster = first_cluster; 1314 dir.dir_name = name; 1315 dir.loc = Some(loc); 1316 dir.short_dir_entry = Some(self.clone()); 1317 dir.root_offset = None; 1318 1319 return FATDirEntry::Dir(dir); 1320 } 1321 } 1322 1323 /// @brief 计算短目录项的名称的校验和 1324 fn checksum(&self) -> u8 { 1325 let mut result = 0; 1326 1327 for c in &self.name { 1328 result = (result << 7) + (result >> 1) + *c; 1329 } 1330 return result; 1331 } 1332 1333 /// @brief 把当前短目录项写入磁盘 1334 /// 1335 /// @param fs 对应的文件系统 1336 /// @param disk_bytes_offset 短目录项所在位置对应的在磁盘上的字节偏移量 1337 /// 1338 /// @return Ok(()) 1339 /// @return Err(SystemError) 错误码 1340 pub fn flush( 1341 &self, 1342 fs: &Arc<FATFileSystem>, 1343 disk_bytes_offset: u64, 1344 ) -> Result<(), SystemError> { 1345 // 从磁盘读取数据 1346 let blk_offset = fs.get_in_block_offset(disk_bytes_offset); 1347 let lba = fs.get_lba_from_offset( 1348 fs.bytes_to_sector(fs.get_in_partition_bytes_offset(disk_bytes_offset)), 1349 ); 1350 let mut v: Vec<u8> = Vec::new(); 1351 v.resize(1 * fs.lba_per_sector() * LBA_SIZE, 0); 1352 fs.partition 1353 .disk() 1354 .read_at(lba, 1 * fs.lba_per_sector(), &mut v)?; 1355 1356 let mut cursor: VecCursor = VecCursor::new(v); 1357 // 切换游标到对应位置 1358 cursor.seek(SeekFrom::SeekSet(blk_offset as i64))?; 1359 cursor.write_exact(&self.name)?; 1360 cursor.write_u8(self.attributes.value)?; 1361 cursor.write_u8(self.nt_res)?; 1362 cursor.write_u8(self.crt_time_tenth)?; 1363 cursor.write_u16(self.crt_time)?; 1364 cursor.write_u16(self.crt_date)?; 1365 cursor.write_u16(self.lst_acc_date)?; 1366 cursor.write_u16(self.fst_clus_hi)?; 1367 cursor.write_u16(self.wrt_time)?; 1368 cursor.write_u16(self.wrt_date)?; 1369 cursor.write_u16(self.fst_clus_lo)?; 1370 cursor.write_u32(self.file_size)?; 1371 1372 // 把修改后的长目录项刷入磁盘 1373 fs.partition 1374 .disk() 1375 .write_at(lba, 1 * fs.lba_per_sector(), cursor.as_slice())?; 1376 fs.partition.disk().sync()?; 1377 1378 return Ok(()); 1379 } 1380 1381 /// @brief 设置短目录项的“第一个簇”字段的值 1382 pub fn set_first_cluster(&mut self, cluster: Cluster) { 1383 self.fst_clus_lo = (cluster.cluster_num & 0x0000ffff) as u16; 1384 self.fst_clus_hi = ((cluster.cluster_num & 0xffff0000) >> 16) as u16; 1385 } 1386 } 1387 1388 /// @brief FAT文件系统标准定义的目录项 1389 #[derive(Debug, Clone)] 1390 pub enum FATRawDirEntry { 1391 /// 短目录项 1392 Short(ShortDirEntry), 1393 /// 长目录项 1394 Long(LongDirEntry), 1395 /// 当前目录项的Name[0]==0xe5, 是空闲目录项 1396 Free, 1397 /// 当前目录项的Name[0]==0xe5, 是空闲目录项，且在这之后没有被分配过的目录项了。 1398 FreeRest, 1399 } 1400 1401 impl FATRawDirEntry { 1402 /// 每个目录项的长度（单位：字节） 1403 pub const DIR_ENTRY_LEN: u64 = 32; 1404 1405 /// @brief 判断当前目录项是否为这个文件的最后一个目录项 1406 fn is_last(&self) -> bool { 1407 match self { 1408 &Self::Short(_) => { 1409 return true; 1410 } 1411 &Self::Long(l) => { 1412 return l.is_last(); 1413 } 1414 _ => { 1415 return false; 1416 } 1417 } 1418 } 1419 1420 /// @brief 判断当前目录项是否为长目录项 1421 fn is_long(&self) -> bool { 1422 if let Self::Long(_) = self { 1423 return true; 1424 } else { 1425 return false; 1426 } 1427 } 1428 1429 /// @brief 判断当前目录项是否为短目录项 1430 fn is_short(&self) -> bool { 1431 if let Self::Short(_) = self { 1432 return true; 1433 } else { 1434 return false; 1435 } 1436 } 1437 } 1438 1439 /// @brief FAT文件系统的目录项迭代器 1440 #[derive(Debug)] 1441 pub struct FATDirIter { 1442 /// 当前正在迭代的簇 1443 current_cluster: Cluster, 1444 /// 当前正在迭代的簇的簇内偏移量 1445 offset: u64, 1446 /// True for the root directories of FAT12 and FAT16 1447 is_root: bool, 1448 /// 指向当前文件系统的指针 1449 fs: Arc<FATFileSystem>, 1450 } 1451 1452 impl FATDirIter { 1453 /// @brief 迭代当前inode的目录项(获取下一个目录项) 1454 /// 1455 /// @return Ok(Cluster, u64, Option<FATDirEntry>) 1456 /// Cluster: 下一个要读取的簇号 1457 /// u64: 下一个要读取的簇内偏移量 1458 /// Option<FATDirEntry>: 读取到的目录项（如果没有读取到，就返回失败） 1459 /// @return Err(错误码) 可能出现了内部错误，或者是磁盘错误等。具体原因看错误码。 1460 fn get_dir_entry(&mut self) -> Result<(Cluster, u64, Option<FATDirEntry>), SystemError> { 1461 loop { 1462 if unlikely(self.current_cluster.cluster_num < 2) { 1463 return Ok((self.current_cluster, self.offset, None)); 1464 } 1465 1466 // 如果当前簇已经被读完，那么尝试获取下一个簇 1467 if self.offset >= self.fs.bytes_per_cluster() && !self.is_root { 1468 match self.fs.get_fat_entry(self.current_cluster)? { 1469 FATEntry::Next(c) => { 1470 // 获得下一个簇的信息 1471 self.current_cluster = c; 1472 self.offset %= self.fs.bytes_per_cluster(); 1473 } 1474 1475 _ => { 1476 // 没有下一个簇了，返回None 1477 return Ok((self.current_cluster, self.offset, None)); 1478 } 1479 } 1480 } 1481 1482 // 如果当前是FAT12/FAT16文件系统，并且当前inode是根目录项。 1483 // 如果offset大于根目录项的最大大小（已经遍历完根目录），那么就返回None 1484 if self.is_root && self.offset > self.fs.root_dir_end_bytes_offset().unwrap() { 1485 return Ok((self.current_cluster, self.offset, None)); 1486 } 1487 1488 // 获取簇在磁盘内的字节偏移量 1489 let offset: u64 = self.fs.cluster_bytes_offset(self.current_cluster) + self.offset; 1490 1491 // 从磁盘读取原始的dentry 1492 let raw_dentry: FATRawDirEntry = get_raw_dir_entry(&self.fs, offset)?; 1493 1494 // 由于迭代顺序从前往后，因此： 1495 // 如果找到1个短目录项，那么证明有一个完整的entry被找到，因此返回。 1496 // 如果找到1个长目录项，那么，就依次往下迭代查找，直到找到一个短目录项，然后返回结果。这里找到的所有的目录项，都属于同一个文件/文件夹。 1497 match raw_dentry { 1498 FATRawDirEntry::Short(s) => { 1499 // 当前找到一个短目录项，更新offset之后，直接返回 1500 self.offset += FATRawDirEntry::DIR_ENTRY_LEN; 1501 return Ok(( 1502 self.current_cluster, 1503 self.offset, 1504 Some(s.to_dir_entry(( 1505 self.current_cluster, 1506 self.offset - FATRawDirEntry::DIR_ENTRY_LEN, 1507 ))), 1508 )); 1509 } 1510 FATRawDirEntry::Long(_) => { 1511 // 当前找到一个长目录项 1512 1513 // 声明一个数组，来容纳所有的entry。（先把最后一个entry放进去） 1514 let mut long_name_entries: Vec<FATRawDirEntry> = vec![raw_dentry]; 1515 let start_offset: u64 = self.offset; 1516 let start_cluster: Cluster = self.current_cluster; 1517 1518 self.offset += FATRawDirEntry::DIR_ENTRY_LEN; 1519 1520 // 由于在FAT文件系统中，文件名最长为255字节，因此，最多有20个长目录项以及1个短目录项。 1521 // 由于上面已经塞了1个长目录项，因此接下来最多需要迭代20次 1522 // 循环查找目录项，直到遇到1个短目录项，或者是空闲目录项 1523 for _ in 0..20 { 1524 // 如果当前簇已经被读完，那么尝试获取下一个簇 1525 if self.offset >= self.fs.bytes_per_cluster() && !self.is_root { 1526 match self.fs.get_fat_entry(self.current_cluster)? { 1527 FATEntry::Next(c) => { 1528 // 获得下一个簇的信息 1529 self.current_cluster = c; 1530 self.offset %= self.fs.bytes_per_cluster(); 1531 } 1532 1533 _ => { 1534 // 没有下一个簇了，退出迭代 1535 break; 1536 } 1537 } 1538 } 1539 // 如果当前是FAT12/FAT16文件系统，并且当前inode是根目录项。 1540 // 如果offset大于根目录项的最大大小（已经遍历完根目录），那么就退出迭代 1541 if self.is_root 1542 && self.offset > self.fs.root_dir_end_bytes_offset().unwrap() 1543 { 1544 break; 1545 } 1546 1547 // 获取簇在磁盘内的字节偏移量 1548 let offset: u64 = 1549 self.fs.cluster_bytes_offset(self.current_cluster) + self.offset; 1550 // 从磁盘读取原始的dentry 1551 let raw_dentry: FATRawDirEntry = get_raw_dir_entry(&self.fs, offset)?; 1552 1553 match raw_dentry { 1554 FATRawDirEntry::Short(_) => { 1555 // 当前遇到1个短目录项，证明当前文件/文件夹的所有dentry都被读取完了，因此在将其加入数组后，退出迭代。 1556 long_name_entries.push(raw_dentry); 1557 break; 1558 } 1559 FATRawDirEntry::Long(_) => { 1560 // 当前遇到1个长目录项，将其加入数组，然后更新offset，继续迭代。 1561 long_name_entries.push(raw_dentry); 1562 self.offset += FATRawDirEntry::DIR_ENTRY_LEN; 1563 } 1564 1565 _ => { 1566 // 遇到了空闲簇，但没遇到短目录项，说明文件系统出错了，退出。 1567 break; 1568 } 1569 } 1570 } 1571 // kdebug!("collect dentries done. long_name_entries={long_name_entries:?}"); 1572 let dir_entry: Result<FATDirEntry, SystemError> = FATDirEntry::new( 1573 long_name_entries, 1574 ( 1575 (start_cluster, start_offset), 1576 (self.current_cluster, self.offset), 1577 ), 1578 ); 1579 // kdebug!("dir_entry={:?}", dir_entry); 1580 match dir_entry { 1581 Ok(d) => { 1582 // kdebug!("dir_entry ok"); 1583 self.offset += FATRawDirEntry::DIR_ENTRY_LEN; 1584 return Ok((self.current_cluster, self.offset, Some(d))); 1585 } 1586 1587 Err(_) => { 1588 // kdebug!("dir_entry err, e={}", e); 1589 self.offset += FATRawDirEntry::DIR_ENTRY_LEN; 1590 } 1591 } 1592 } 1593 FATRawDirEntry::Free => { 1594 // 当前目录项是空的 1595 self.offset += FATRawDirEntry::DIR_ENTRY_LEN; 1596 } 1597 FATRawDirEntry::FreeRest => { 1598 // 当前目录项是空的，且之后都是空的，因此直接返回 1599 return Ok((self.current_cluster, self.offset, None)); 1600 } 1601 } 1602 } 1603 } 1604 } 1605 1606 /// 为DirIter实现迭代器trait 1607 impl Iterator for FATDirIter { 1608 type Item = FATDirEntry; 1609 1610 fn next(&mut self) -> Option<Self::Item> { 1611 match self.get_dir_entry() { 1612 Ok((cluster, offset, result)) => { 1613 self.current_cluster = cluster; 1614 self.offset = offset; 1615 return result; 1616 } 1617 Err(_) => { 1618 return None; 1619 } 1620 } 1621 } 1622 } 1623 1624 impl FATDirEntry { 1625 /// @brief 构建FATDirEntry枚举类型 1626 /// 1627 /// @param long_name_entries 长目录项的数组。 1628 /// 格式：[第20个（或者是最大ord的那个）, 19, 18, ..., 1, 短目录项] 1629 /// 1630 /// @return Ok(FATDirEntry) 构建好的FATDirEntry类型的对象 1631 /// @return Err(SystemError) 错误码 1632 pub fn new( 1633 mut long_name_entries: Vec<FATRawDirEntry>, 1634 loc: ((Cluster, u64), (Cluster, u64)), 1635 ) -> Result<Self, SystemError> { 1636 if long_name_entries.is_empty() { 1637 return Err(SystemError::EINVAL); 1638 } 1639 1640 if !long_name_entries[0].is_last() || !long_name_entries.last().unwrap().is_short() { 1641 // 存在孤立的目录项，文件系统出现异常，因此返回错误，表明其只读。 1642 // TODO: 标记整个FAT文件系统为只读的 1643 return Err(SystemError::EROFS); 1644 } 1645 1646 // 取出短目录项（位于vec的末尾） 1647 let short_dentry: ShortDirEntry = match long_name_entries.pop().unwrap() { 1648 FATRawDirEntry::Short(s) => s, 1649 _ => unreachable!(), 1650 }; 1651 1652 let mut extractor = LongNameExtractor::new(); 1653 for entry in &long_name_entries { 1654 match entry { 1655 &FATRawDirEntry::Long(l) => { 1656 extractor.process(l)?; 1657 } 1658 1659 _ => { 1660 return Err(SystemError::EROFS); 1661 } 1662 } 1663 } 1664 // 检验校验和是否正确 1665 if extractor.validate_checksum(&short_dentry) { 1666 // 校验和正确，返回一个长目录项 1667 return Ok(short_dentry.to_dir_entry_with_long_name(extractor.to_string(), loc)); 1668 } else { 1669 // 校验和不相同，认为文件系统出错 1670 return Err(SystemError::EROFS); 1671 } 1672 } 1673 1674 /// @brief 获取短目录项的名字 1675 pub fn short_name(&self) -> String { 1676 match self { 1677 FATDirEntry::File(f) | FATDirEntry::VolId(f) => { 1678 return f.short_dir_entry.name_to_string(); 1679 } 1680 FATDirEntry::Dir(d) => match d.short_dir_entry { 1681 Some(s) => { 1682 return s.name_to_string(); 1683 } 1684 None => { 1685 return String::from("/"); 1686 } 1687 }, 1688 FATDirEntry::UnInit => unreachable!("FATFS: FATDirEntry uninitialized."), 1689 } 1690 } 1691 1692 /// @brief 获取短目录项结构体 1693 pub fn short_dir_entry(&self) -> Option<ShortDirEntry> { 1694 match &self { 1695 FATDirEntry::File(f) => { 1696 return Some(f.short_dir_entry); 1697 } 1698 FATDirEntry::Dir(d) => { 1699 return d.short_dir_entry; 1700 } 1701 FATDirEntry::VolId(s) => { 1702 return Some(s.short_dir_entry); 1703 } 1704 FATDirEntry::UnInit => unreachable!("FATFS: FATDirEntry uninitialized."), 1705 } 1706 } 1707 1708 /// @brief 获取目录项的第一个簇的簇号 1709 pub fn first_cluster(&self) -> Cluster { 1710 match self { 1711 FATDirEntry::File(f) => { 1712 return f.first_cluster; 1713 } 1714 FATDirEntry::Dir(d) => { 1715 return d.first_cluster; 1716 } 1717 FATDirEntry::VolId(s) => { 1718 return s.first_cluster; 1719 } 1720 FATDirEntry::UnInit => unreachable!("FATFS: FATDirEntry uninitialized."), 1721 } 1722 } 1723 1724 /// @brief 获取当前目录项所占用的簇的范围 1725 /// 1726 /// @return (起始簇，簇内偏移量), (终止簇，簇内偏移量) 1727 pub fn get_dir_range(&self) -> Option<((Cluster, u64), (Cluster, u64))> { 1728 match self { 1729 FATDirEntry::File(f) => Some(f.loc), 1730 FATDirEntry::Dir(d) => d.loc, 1731 FATDirEntry::VolId(s) => Some(s.loc), 1732 FATDirEntry::UnInit => unreachable!("FATFS: FATDirEntry uninitialized."), 1733 } 1734 } 1735 1736 /// @brief 获取原始的短目录项名（FAT标准规定的） 1737 pub fn short_name_raw(&self) -> [u8; 11] { 1738 match self { 1739 FATDirEntry::File(f) => { 1740 return f.short_dir_entry.name; 1741 } 1742 FATDirEntry::Dir(d) => match d.short_dir_entry { 1743 // 存在短目录项，直接返回 1744 Some(s) => { 1745 return s.name; 1746 } 1747 // 是根目录项 1748 None => { 1749 let mut s = [0x20u8; 11]; 1750 s[0] = '/' as u8; 1751 return s; 1752 } 1753 }, 1754 FATDirEntry::VolId(s) => { 1755 return s.short_dir_entry.name; 1756 } 1757 1758 FATDirEntry::UnInit => unreachable!("FATFS: FATDirEntry uninitialized."), 1759 } 1760 } 1761 1762 /// @brief 获取目录项的名字 1763 pub fn name(&self) -> String { 1764 match self { 1765 FATDirEntry::File(f) => { 1766 return f.file_name.clone(); 1767 } 1768 FATDirEntry::VolId(s) => { 1769 return s.file_name.clone(); 1770 } 1771 FATDirEntry::Dir(d) => { 1772 return d.dir_name.clone(); 1773 } 1774 FATDirEntry::UnInit => unreachable!("FATFS: FATDirEntry uninitialized."), 1775 } 1776 } 1777 1778 /// @brief 判断目录项是否为文件 1779 pub fn is_file(&self) -> bool { 1780 match self { 1781 &FATDirEntry::File(_) | &FATDirEntry::VolId(_) => true, 1782 _ => false, 1783 } 1784 } 1785 1786 /// @brief 判断目录项是否为文件夹 1787 pub fn is_dir(&self) -> bool { 1788 match &self { 1789 &FATDirEntry::Dir(_) => true, 1790 _ => false, 1791 } 1792 } 1793 1794 /// @brief 判断目录项是否为Volume id 1795 pub fn is_vol_id(&self) -> bool { 1796 match self { 1797 &FATDirEntry::VolId(_) => true, 1798 _ => false, 1799 } 1800 } 1801 1802 /// @brief 判断FAT目录项的名字与给定的是否相等 1803 /// 1804 /// 由于FAT32对大小写不敏感，因此将字符都转为大写，然后比较 1805 /// 1806 /// @return bool 相等 => true 1807 /// 不相等 => false 1808 pub fn eq_name(&self, name: &str) -> bool { 1809 // 由于FAT32对大小写不敏感，因此将字符都转为大写，然后比较。 1810 let binding = self.short_name(); 1811 let short_name = binding.chars().flat_map(|c| c.to_uppercase()); 1812 let binding = self.name(); 1813 let long_name = binding.chars().flat_map(|c| c.to_uppercase()); 1814 let name = name.chars().flat_map(|c| c.to_uppercase()); 1815 1816 let long_name_matches: bool = long_name.eq(name.clone()); 1817 let short_name_matches: bool = short_name.eq(name); 1818 1819 return long_name_matches || short_name_matches; 1820 } 1821 1822 /// @brief 将FATDirEntry转换为FATFile对象 1823 pub fn to_file(&self) -> Result<FATFile, SystemError> { 1824 if self.is_file() == false { 1825 return Err(SystemError::EISDIR); 1826 } 1827 1828 match &self { 1829 FATDirEntry::File(f) | FATDirEntry::VolId(f) => { 1830 return Ok(f.clone()); 1831 } 1832 _ => unreachable!(), 1833 } 1834 } 1835 1836 /// @brief 将FATDirEntry转换为FATDir对象 1837 pub fn to_dir(&self) -> Result<FATDir, SystemError> { 1838 if self.is_dir() == false { 1839 return Err(SystemError::ENOTDIR); 1840 } 1841 match &self { 1842 FATDirEntry::Dir(d) => { 1843 return Ok(d.clone()); 1844 } 1845 _ => unreachable!(), 1846 } 1847 } 1848 } 1849 1850 /// 用于生成短目录项文件名的生成器。 1851 #[derive(Debug, Default)] 1852 pub struct ShortNameGenerator { 1853 /// 短目录项的名字 1854 name: [u8; 11], 1855 /// 生成器的标志位（使用impl里面的mask来解析） 1856 flags: u8, 1857 /// 基础名的长度 1858 basename_len: u8, 1859 /// 对于文件名形如(TE021F~1.TXT)的，短前缀+校验码的短目录项，该字段表示基础名末尾数字的对应位。 1860 checksum_bitmask: u16, 1861 /// Fletcher-16 Checksum(与填写到ShortDirEntry里面的不一样) 1862 checksum: u16, 1863 /// 对于形如(TEXTFI~1.TXT)的短目录项名称，其中的数字的bitmask（第0位置位则表示这个数字是0） 1864 suffix_bitmask: u16, 1865 } 1866 1867 impl ShortNameGenerator { 1868 /// 短目录项的名称的长度 1869 const SHORT_NAME_LEN: usize = 8; 1870 1871 // ===== flags标志位的含义 ===== 1872 const IS_LOSSY: u8 = (1 << 0); 1873 const IS_EXACT_MATCH: u8 = (1 << 1); 1874 const IS_DOT: u8 = (1 << 2); 1875 const IS_DOTDOT: u8 = (1 << 3); 1876 /// 名称被完全拷贝 1877 const NAME_FITS: u8 = (1 << 4); 1878 1879 /// @brief 初始化一个短目录项名称生成器 1880 pub fn new(mut name: &str) -> Self { 1881 name = name.trim(); 1882 1883 let mut short_name: [u8; 11] = [0x20u8; 11]; 1884 if name == "." { 1885 short_name[0] = '.' as u8; 1886 } 1887 1888 if name == ".." { 1889 short_name[0] = '.' as u8; 1890 short_name[1] = '.' as u8; 1891 } 1892 1893 // @name_fits: 名称是否被完全拷贝 1894 // @basename_len: 基础名的长度 1895 // @is_lossy: 是否存在不合法的字符 1896 let (name_fits, basename_len, is_lossy) = match name.rfind('.') { 1897 Some(index) => { 1898 // 文件名里面有".", 且index为最右边的点号所在的下标（bytes index) 1899 // 拷贝基础名 1900 let (b_len, fits, b_lossy) = 1901 Self::copy_part(&mut short_name[..Self::SHORT_NAME_LEN], &name[..index]); 1902 1903 // 拷贝扩展名 1904 let (_, ext_fits, ext_lossy) = Self::copy_part( 1905 &mut short_name[Self::SHORT_NAME_LEN..Self::SHORT_NAME_LEN + 3], 1906 &name[index + 1..], 1907 ); 1908 1909 (fits && ext_fits, b_len, b_lossy || ext_lossy) 1910 } 1911 None => { 1912 // 文件名中，不存在"." 1913 let (b_len, fits, b_lossy) = 1914 Self::copy_part(&mut short_name[..Self::SHORT_NAME_LEN], &name); 1915 (fits, b_len, b_lossy) 1916 } 1917 }; 1918 1919 let mut flags: u8 = 0; 1920 // 设置flags 1921 if is_lossy { 1922 flags |= Self::IS_LOSSY; 1923 } 1924 if name == "." { 1925 flags |= Self::IS_DOT; 1926 } 1927 if name == ".." { 1928 flags |= Self::IS_DOTDOT; 1929 } 1930 1931 if name_fits { 1932 flags |= Self::NAME_FITS; 1933 } 1934 1935 return ShortNameGenerator { 1936 name: short_name, 1937 flags: flags, 1938 basename_len: basename_len, 1939 checksum: Self::fletcher_16_checksum(name), 1940 ..Default::default() 1941 }; 1942 } 1943 1944 /// @brief 拷贝字符串到一个u8数组 1945 /// 1946 /// @return (u8, bool, bool) 1947 /// return.0: 拷贝了的字符串的长度 1948 /// return.1: 是否完全拷贝完整个字符串 1949 /// return.2: 拷贝过程中，是否出现了不合法字符 1950 fn copy_part(dest: &mut [u8], src: &str) -> (u8, bool, bool) { 1951 let mut dest_len: usize = 0; 1952 let mut lossy_conv = false; 1953 1954 for c in src.chars() { 1955 // 如果src还有字符，而dest已经满了，那么表示没有完全拷贝完。 1956 if dest_len == dest.len() { 1957 return (dest_len as u8, false, lossy_conv); 1958 } 1959 1960 if c == ' ' || c == '.' { 1961 lossy_conv = true; 1962 continue; 1963 } 1964 1965 let cp: char = match c { 1966 'a'..='z' | 'A'..='Z' | '0'..='9' => c, 1967 '$' | '%' | '\'' | '-' | '_' | '@' | '~' | '`' | '!' | '(' | ')' | '{' | '}' 1968 | '^' | '#' | '&' => c, 1969 _ => '_', 1970 }; 1971 1972 // 判断是否存在不符合条件的字符 1973 lossy_conv = lossy_conv || c != cp; 1974 1975 // 拷贝字符 1976 dest[dest_len] = c.to_ascii_uppercase() as u8; 1977 dest_len += 1; 1978 } 1979 1980 // 返回结果 1981 return (dest_len as u8, true, lossy_conv); 1982 } 1983 1984 fn fletcher_16_checksum(name: &str) -> u16 { 1985 let mut sum1: u16 = 0; 1986 let mut sum2: u16 = 0; 1987 for c in name.chars() { 1988 sum1 = (sum1 + (c as u16)) % 0xff; 1989 sum2 = (sum1 + sum2) & 0xff; 1990 } 1991 return (sum2 << 8) | sum1; 1992 } 1993 1994 /// @brief 更新生成器的状态 1995 /// 当长目录项不存在的时候，需要调用这个函数来更新生成器的状态 1996 pub fn add_name(&mut self, name: &[u8; 11]) { 1997 // === 判断名称是否严格的完全匹配 1998 if name == &self.name { 1999 self.flags |= Self::IS_EXACT_MATCH; 2000 } 2001 2002 // === 检查是否存在长前缀的格式冲突。对于这样的短目录项名称：(TEXTFI~1.TXT) 2003 // 获取名称前缀 2004 let prefix_len = min(self.basename_len, 6) as usize; 2005 // 获取后缀的那个数字 2006 let num_suffix: Option<u32> = if name[prefix_len] as char == '~' { 2007 (name[prefix_len + 1] as char).to_digit(10) 2008 } else { 2009 None 2010 }; 2011 2012 // 判断扩展名是否匹配 2013 let ext_matches: bool = name[8..] == self.name[8..]; 2014 2015 if name[..prefix_len] == self.name[..prefix_len] // 基础名前缀相同 2016 && num_suffix.is_some() // 基础名具有数字后缀 2017 && ext_matches 2018 // 扩展名相匹配 2019 { 2020 let num = num_suffix.unwrap(); 2021 self.suffix_bitmask |= 1 << num; 2022 } 2023 2024 // === 检查是否存在短前缀+校验和的冲突，文件名形如：(TE021F~1.TXT) 2025 let prefix_len = min(self.basename_len, 2) as usize; 2026 let num_suffix: Option<u32> = if name[prefix_len + 4] as char == '~' { 2027 (name[prefix_len + 1] as char).to_digit(10) 2028 } else { 2029 None 2030 }; 2031 2032 if name[..prefix_len] == self.name[..prefix_len] && num_suffix.is_some() && ext_matches { 2033 // 获取短文件名中的校验码字段 2034 let checksum_result: Result< 2035 Result<u16, core::num::ParseIntError>, 2036 core::str::Utf8Error, 2037 > = core::str::from_utf8(&name[prefix_len..prefix_len + 4]) 2038 .map(|s| u16::from_str_radix(s, 16)); 2039 // 如果校验码相同 2040 if checksum_result == Ok(Ok(self.checksum)) { 2041 let num = num_suffix.unwrap(); 2042 // 置位checksum_bitmask中，基础名末尾数字的对应位 2043 self.checksum_bitmask |= 1 << num; 2044 } 2045 } 2046 } 2047 2048 pub fn generate(&self) -> Result<[u8; 11], SystemError> { 2049 if self.is_dot() || self.is_dotdot() { 2050 return Ok(self.name); 2051 } 2052 2053 // 如果当前名字不存在不合法的字符，且名称被完整拷贝，但是exact match为false，可以认为名称没有冲突，直接返回 2054 if !self.is_lossy() && self.name_fits() && !self.is_exact_match() { 2055 return Ok(self.name); 2056 } 2057 2058 // 尝试使用长前缀（6字符） 2059 for i in 1..5 { 2060 if self.suffix_bitmask & (1 << i) == 0 { 2061 return Ok(self.build_prefixed_name(i as u32, false)); 2062 } 2063 } 2064 2065 // 尝试使用短前缀+校验码 2066 for i in 1..10 { 2067 if self.checksum_bitmask & (1 << i) == 0 { 2068 return Ok(self.build_prefixed_name(i as u32, true)); 2069 } 2070 } 2071 // 由于产生太多的冲突，因此返回错误（“短文件名已经存在”） 2072 return Err(SystemError::EEXIST); 2073 } 2074 2075 pub fn next_iteration(&mut self) { 2076 // 在下一次迭代中，尝试一个不同的校验和 2077 self.checksum = (core::num::Wrapping(self.checksum) + core::num::Wrapping(1)).0; 2078 // 清空bitmask 2079 self.suffix_bitmask = 0; 2080 self.checksum_bitmask = 0; 2081 } 2082 2083 /// @brief 构造具有前缀的短目录项名称 2084 /// 2085 /// @param num 这是第几个重名的前缀名 2086 /// @param with_checksum 前缀名中是否包含校验码 2087 /// 2088 /// @return 构造好的短目录项名称数组 2089 fn build_prefixed_name(&self, num: u32, with_checksum: bool) -> [u8; 11] { 2090 let mut buf: [u8; 11] = [0x20u8; 11]; 2091 let prefix_len: usize = if with_checksum { 2092 let prefix_len: usize = min(self.basename_len as usize, 2); 2093 buf[..prefix_len].copy_from_slice(&self.name[..prefix_len]); 2094 buf[prefix_len..prefix_len + 4].copy_from_slice(&Self::u16_to_u8_array(self.checksum)); 2095 prefix_len + 4 2096 } else { 2097 let prefix_len = min(self.basename_len as usize, 6); 2098 buf[..prefix_len].copy_from_slice(&self.name[..prefix_len]); 2099 prefix_len 2100 }; 2101 2102 buf[prefix_len] = '~' as u8; 2103 buf[prefix_len + 1] = char::from_digit(num, 10).unwrap() as u8; 2104 buf[8..].copy_from_slice(&self.name[8..]); 2105 return buf; 2106 } 2107 2108 /// @brief 将一个u16数字转换为十六进制大写字符串对应的ascii数组。 2109 /// 举例：将x=12345转换为16进制字符串“3039”对应的ascii码数组：[51,48,51,57] 2110 fn u16_to_u8_array(x: u16) -> [u8; 4] { 2111 let c1 = char::from_digit((x as u32 >> 12) & 0xf, 16) 2112 .unwrap() 2113 .to_ascii_uppercase() as u8; 2114 let c2 = char::from_digit((x as u32 >> 8) & 0xf, 16) 2115 .unwrap() 2116 .to_ascii_uppercase() as u8; 2117 let c3 = char::from_digit((x as u32 >> 4) & 0xf, 16) 2118 .unwrap() 2119 .to_ascii_uppercase() as u8; 2120 let c4 = char::from_digit((x as u32 >> 0) & 0xf, 16) 2121 .unwrap() 2122 .to_ascii_uppercase() as u8; 2123 return [c1, c2, c3, c4]; 2124 } 2125 2126 #[inline] 2127 fn is_lossy(&self) -> bool { 2128 return (self.flags & Self::IS_LOSSY) > 0; 2129 } 2130 2131 #[inline] 2132 fn is_exact_match(&self) -> bool { 2133 return (self.flags & Self::IS_EXACT_MATCH) > 0; 2134 } 2135 2136 #[inline] 2137 fn is_dot(&self) -> bool { 2138 return (self.flags & Self::IS_DOT) > 0; 2139 } 2140 2141 #[inline] 2142 fn is_dotdot(&self) -> bool { 2143 return (self.flags & Self::IS_DOTDOT) > 0; 2144 } 2145 2146 #[inline] 2147 fn name_fits(&self) -> bool { 2148 return (self.flags & Self::NAME_FITS) > 0; 2149 } 2150 } 2151 2152 /// 从多个LongName中提取完整文件名字段的提取器 2153 struct LongNameExtractor { 2154 name: Vec<u16>, 2155 checksum: u8, 2156 index: u8, 2157 } 2158 2159 impl LongNameExtractor { 2160 fn new() -> Self { 2161 return LongNameExtractor { 2162 name: Vec::new(), 2163 checksum: 0, 2164 index: 0, 2165 }; 2166 } 2167 2168 /// @brief 提取长目录项的名称 2169 /// @param longname_dentry 长目录项 2170 /// 请注意，必须倒序输入长目录项对象 2171 fn process(&mut self, longname_dentry: LongDirEntry) -> Result<(), SystemError> { 2172 let is_last: bool = longname_dentry.is_last(); 2173 let index: u8 = longname_dentry.ord & 0x1f; 2174 2175 if index == 0 { 2176 self.name.clear(); 2177 return Err(SystemError::EROFS); 2178 } 2179 2180 // 如果是最后一个LongDirEntry，则初始化当前生成器 2181 if is_last { 2182 self.index = index; 2183 self.checksum = longname_dentry.checksum; 2184 self.name 2185 .resize(index as usize * LongDirEntry::LONG_NAME_STR_LEN, 0); 2186 } else if self.index == 0 2187 || index != self.index - 1 2188 || self.checksum != longname_dentry.checksum 2189 { 2190 // 如果当前index为0,或者index不连续，或者是校验和不同，那么认为文件系统损坏，清除生成器的名称字段 2191 // TODO: 对文件系统的变为只读状态状况的拦截 2192 self.name.clear(); 2193 return Err(SystemError::EROFS); 2194 } else { 2195 // 由于dentry倒序输入，因此index是每次减1的 2196 self.index -= 1; 2197 } 2198 2199 let pos: usize = ((index - 1) as usize) * LongDirEntry::LONG_NAME_STR_LEN; 2200 // 将当前目录项的值，拷贝到生成器的数组中 2201 longname_dentry 2202 .copy_name_to_slice(&mut self.name[pos..pos + LongDirEntry::LONG_NAME_STR_LEN])?; 2203 return Ok(()); 2204 } 2205 2206 /// @brief 返回名称的长度 2207 #[inline] 2208 fn len(&self) -> usize { 2209 return self.name.len(); 2210 } 2211 2212 /// @brief 返回抽取得到的名称字符串 2213 fn to_string(&self) -> String { 2214 let mut s = String::from_utf16_lossy(self.name.as_slice()); 2215 // 计算字符串的长度。如果字符串中有\0，那么就截取字符串的前面部分 2216 if let Some(len) = s.find('\u{0}') { 2217 s.truncate(len); 2218 } 2219 return s; 2220 } 2221 2222 /// @brief 判断校验码是否与指定的短目录项的校验码相同 2223 /// 2224 /// @return bool 相同 => true 2225 /// 不同 => false 2226 fn validate_checksum(&self, short_dentry: &ShortDirEntry) -> bool { 2227 return self.checksum == short_dentry.checksum(); 2228 } 2229 } 2230 2231 /// @brief 长目录项生成器 2232 #[derive(Debug)] 2233 struct LongNameEntryGenerator { 2234 name: Vec<u16>, 2235 // 短目录项的校验和 2236 checksum: u8, 2237 // 当前迭代器的索引 2238 idx: u8, 2239 /// 最后一个目录项的索引 2240 last_index: u8, 2241 } 2242 2243 impl LongNameEntryGenerator { 2244 /// @brief 初始化长目录项生成器 2245 /// 2246 /// @param name 长文件名数组 2247 /// @param checksum 短目录项的校验和 2248 pub fn new(name: &str, checksum: u8) -> Self { 2249 let mut name: Vec<u16> = name.chars().map(|c| c as u16).collect(); 2250 2251 let padding_bytes: usize = (13 - (name.len() % 13)) % 13; 2252 // 填充最后一个长目录项的文件名 2253 for i in 0..padding_bytes { 2254 if i == 0 { 2255 name.push(0); 2256 } else { 2257 name.push(0xffff); 2258 } 2259 } 2260 2261 // 先从最后一个长目录项开始生成 2262 let start_index = (name.len() / 13) as u8; 2263 return LongNameEntryGenerator { 2264 name: name, 2265 checksum: checksum, 2266 idx: start_index, 2267 last_index: start_index, 2268 }; 2269 } 2270 2271 /// @brief 返回要生成的长目录项的总数 2272 pub fn num_entries(&self) -> u8 { 2273 return self.last_index + 1; 2274 } 2275 } 2276 2277 impl Iterator for LongNameEntryGenerator { 2278 type Item = LongDirEntry; 2279 2280 fn next(&mut self) -> Option<Self::Item> { 2281 match self.idx { 2282 0 => { 2283 return None; 2284 } 2285 // 最后一个长目录项 2286 n if n == self.last_index => { 2287 // 最后一个长目录项的ord需要与0x40相或 2288 let ord: u8 = n | 0x40; 2289 let start_idx = ((n - 1) * 13) as usize; 2290 self.idx -= 1; 2291 return Some(LongDirEntry::new( 2292 ord, 2293 &self.name.as_slice()[start_idx..start_idx + 13], 2294 self.checksum, 2295 )); 2296 } 2297 n => { 2298 // 其它的长目录项 2299 let start_idx = ((n - 1) * 13) as usize; 2300 self.idx -= 1; 2301 return Some(LongDirEntry::new( 2302 n, 2303 &self.name.as_slice()[start_idx..start_idx + 13], 2304 self.checksum, 2305 )); 2306 } 2307 } 2308 } 2309 } 2310 2311 #[derive(Debug)] 2312 pub enum FATDirEntryOrShortName { 2313 DirEntry(FATDirEntry), 2314 ShortName([u8; 11]), 2315 } 2316 2317 /// @brief 对FAT目录项的迭代器(基于簇和簇内偏移量) 2318 #[derive(Debug)] 2319 struct FATDirEntryOffsetIter { 2320 /// 当前迭代的偏移量(下一次迭代要返回的值) 2321 current_offset: (Cluster, u64), 2322 /// 截止迭代的位置（end_offset所在的位置也会被迭代器返回) 2323 end_offset: Option<(Cluster, u64)>, 2324 /// 属于的文件系统 2325 fs: Arc<FATFileSystem>, 2326 /// 当前已经迭代了多少次 2327 index: u64, 2328 /// 总共要迭代多少次 2329 len: u64, 2330 /// 如果end_offset不为None，该字段表示“是否已经到达了迭代终点” 2331 fin: bool, 2332 } 2333 2334 impl FATDirEntryOffsetIter { 2335 /// @brief 初始化FAT目录项的迭代器(基于簇和簇内偏移量) 2336 /// 2337 /// @param fs 属于的文件系统 2338 /// @param start 起始偏移量 2339 /// @param len 要迭代的次数 2340 /// @param end_offset 截止迭代的位置（end_offset所在的位置也会被迭代器返回) 2341 /// 2342 /// @return 构建好的迭代器对象 2343 pub fn new( 2344 fs: Arc<FATFileSystem>, 2345 start: (Cluster, u64), 2346 len: u64, 2347 end_offset: Option<(Cluster, u64)>, 2348 ) -> Self { 2349 return FATDirEntryOffsetIter { 2350 current_offset: start, 2351 end_offset, 2352 fs, 2353 index: 0, 2354 len, 2355 fin: false, 2356 }; 2357 } 2358 } 2359 2360 impl Iterator for FATDirEntryOffsetIter { 2361 type Item = (Cluster, u64); 2362 2363 fn next(&mut self) -> Option<Self::Item> { 2364 if self.index == self.len || self.fin { 2365 return None; 2366 } 2367 2368 let r: (Cluster, u64) = self.current_offset; 2369 // 计算新的字节偏移量 2370 let mut new_offset = r.1 + FATRawDirEntry::DIR_ENTRY_LEN; 2371 let mut new_cluster: Cluster = r.0; 2372 // 越过了当前簇,则获取下一个簇 2373 if new_offset >= self.fs.bytes_per_cluster() { 2374 new_offset %= self.fs.bytes_per_cluster(); 2375 2376 match self.fs.get_fat_entry(new_cluster) { 2377 Ok(FATEntry::Next(c)) => { 2378 new_cluster = c; 2379 } 2380 // 没有下一个簇了 2381 _ => { 2382 self.fin = true; 2383 } 2384 } 2385 } 2386 2387 if let Some(off) = self.end_offset { 2388 // 判断当前簇是否是要求停止搜索的最后一个位置 2389 self.fin = off == self.current_offset; 2390 } 2391 // 更新当前迭代的偏移量 2392 self.current_offset = (new_cluster, new_offset); 2393 self.index += 1; 2394 2395 return Some(r); 2396 } 2397 } 2398 2399 /// @brief 根据磁盘内字节偏移量，读取磁盘，并生成一个FATRawDirEntry对象 2400 pub fn get_raw_dir_entry( 2401 fs: &Arc<FATFileSystem>, 2402 in_disk_bytes_offset: u64, 2403 ) -> Result<FATRawDirEntry, SystemError> { 2404 // 块内偏移量 2405 let blk_offset: u64 = fs.get_in_block_offset(in_disk_bytes_offset); 2406 let lba = fs.get_lba_from_offset( 2407 fs.bytes_to_sector(fs.get_in_partition_bytes_offset(in_disk_bytes_offset)), 2408 ); 2409 2410 // let step1 = fs.get_in_partition_bytes_offset(in_disk_bytes_offset); 2411 // let step2 = fs.bytes_to_sector(step1); 2412 // let lba = fs.get_lba_from_offset(step2); 2413 // kdebug!("step1={step1}, step2={step2}, lba={lba}"); 2414 let mut v: Vec<u8> = Vec::new(); 2415 v.resize(1 * LBA_SIZE, 0); 2416 2417 fs.partition.disk().read_at(lba, 1, &mut v)?; 2418 2419 let mut cursor: VecCursor = VecCursor::new(v); 2420 // 切换游标到对应位置 2421 cursor.seek(SeekFrom::SeekSet(blk_offset as i64))?; 2422 2423 let dir_0 = cursor.read_u8()?; 2424 2425 match dir_0 { 2426 0x00 => { 2427 return Ok(FATRawDirEntry::FreeRest); 2428 } 2429 0xe5 => { 2430 return Ok(FATRawDirEntry::Free); 2431 } 2432 _ => { 2433 cursor.seek(SeekFrom::SeekCurrent(10))?; 2434 let file_attr: FileAttributes = FileAttributes::new(cursor.read_u8()?); 2435 2436 // 指针回到目录项的开始处 2437 cursor.seek(SeekFrom::SeekSet(blk_offset as i64))?; 2438 2439 if file_attr.contains(FileAttributes::LONG_NAME) { 2440 // 当前目录项是一个长目录项 2441 let mut long_dentry = LongDirEntry::default(); 2442 2443 long_dentry.ord = cursor.read_u8()?; 2444 cursor.read_u16_into(&mut long_dentry.name1)?; 2445 long_dentry.file_attrs = FileAttributes::new(cursor.read_u8()?); 2446 long_dentry.dirent_type = cursor.read_u8()?; 2447 long_dentry.checksum = cursor.read_u8()?; 2448 2449 cursor.read_u16_into(&mut long_dentry.name2)?; 2450 long_dentry.first_clus_low = cursor.read_u16()?; 2451 cursor.read_u16_into(&mut long_dentry.name3)?; 2452 2453 return Ok(FATRawDirEntry::Long(long_dentry)); 2454 } else { 2455 // 当前目录项是一个短目录项 2456 let mut short_dentry = ShortDirEntry::default(); 2457 cursor.read_exact(&mut short_dentry.name)?; 2458 2459 short_dentry.attributes = FileAttributes::new(cursor.read_u8()?); 2460 2461 short_dentry.nt_res = cursor.read_u8()?; 2462 short_dentry.crt_time_tenth = cursor.read_u8()?; 2463 short_dentry.crt_time = cursor.read_u16()?; 2464 short_dentry.crt_date = cursor.read_u16()?; 2465 short_dentry.lst_acc_date = cursor.read_u16()?; 2466 short_dentry.fst_clus_hi = cursor.read_u16()?; 2467 short_dentry.wrt_time = cursor.read_u16()?; 2468 short_dentry.wrt_date = cursor.read_u16()?; 2469 short_dentry.fst_clus_lo = cursor.read_u16()?; 2470 short_dentry.file_size = cursor.read_u32()?; 2471 2472 return Ok(FATRawDirEntry::Short(short_dentry)); 2473 } 2474 } 2475 } 2476 } 2477