1 use core::mem::MaybeUninit; 2 3 use alloc::{string::String, sync::Arc, vec::Vec}; 4 5 use crate::{ 6 driver::{ 7 base::{block::SeekFrom, device::DevicePrivateData}, 8 tty::TtyFilePrivateData, 9 }, 10 filesystem::procfs::ProcfsFilePrivateData, 11 ipc::pipe::PipeFsPrivateData, 12 kerror, 13 libs::spinlock::SpinLock, 14 process::ProcessManager, 15 syscall::SystemError, 16 }; 17 18 use super::{Dirent, FileType, IndexNode, InodeId, Metadata, SpecialNodeData}; 19 20 /// 文件私有信息的枚举类型 21 #[derive(Debug, Clone)] 22 pub enum FilePrivateData { 23 /// 管道文件私有信息 24 Pipefs(PipeFsPrivateData), 25 /// procfs文件私有信息 26 Procfs(ProcfsFilePrivateData), 27 /// 设备文件的私有信息 28 DevFS(DevicePrivateData), 29 /// tty设备文件的私有信息 30 Tty(TtyFilePrivateData), 31 /// 不需要文件私有信息 32 Unused, 33 } 34 35 impl Default for FilePrivateData { 36 fn default() -> Self { 37 return Self::Unused; 38 } 39 } 40 41 bitflags! { 42 /// @brief 文件打开模式 43 /// 其中,低2bit组合而成的数字的值,用于表示访问权限。其他的bit,才支持通过按位或的方式来表示参数 44 /// 45 /// 与Linux 5.19.10的uapi/asm-generic/fcntl.h相同 46 /// https://opengrok.ringotek.cn/xref/linux-5.19.10/tools/include/uapi/asm-generic/fcntl.h#19 47 pub struct FileMode: u32{ 48 /* File access modes for `open' and `fcntl'. */ 49 /// Open Read-only 50 const O_RDONLY = 0o0; 51 /// Open Write-only 52 const O_WRONLY = 0o1; 53 /// Open read/write 54 const O_RDWR = 0o2; 55 /// Mask for file access modes 56 const O_ACCMODE = 0o00000003; 57 58 /* Bits OR'd into the second argument to open. */ 59 /// Create file if it does not exist 60 const O_CREAT = 0o00000100; 61 /// Fail if file already exists 62 const O_EXCL = 0o00000200; 63 /// Do not assign controlling terminal 64 const O_NOCTTY = 0o00000400; 65 /// 文件存在且是普通文件,并以O_RDWR或O_WRONLY打开,则它会被清空 66 const O_TRUNC = 0o00001000; 67 /// 文件指针会被移动到文件末尾 68 const O_APPEND = 0o00002000; 69 /// 非阻塞式IO模式 70 const O_NONBLOCK = 0o00004000; 71 /// 每次write都等待物理I/O完成,但是如果写操作不影响读取刚写入的数据,则不等待文件属性更新 72 const O_DSYNC = 0o00010000; 73 /// fcntl, for BSD compatibility 74 const FASYNC = 0o00020000; 75 /* direct disk access hint */ 76 const O_DIRECT = 0o00040000; 77 const O_LARGEFILE = 0o00100000; 78 /// 打开的必须是一个目录 79 const O_DIRECTORY = 0o00200000; 80 /// Do not follow symbolic links 81 const O_NOFOLLOW = 0o00400000; 82 const O_NOATIME = 0o01000000; 83 /// set close_on_exec 84 const O_CLOEXEC = 0o02000000; 85 /// 每次write都等到物理I/O完成,包括write引起的文件属性的更新 86 const O_SYNC = 0o04000000; 87 } 88 } 89 90 impl FileMode { 91 /// @brief 获取文件的访问模式的值 92 #[inline] 93 pub fn accmode(&self) -> u32 { 94 return self.bits() & FileMode::O_ACCMODE.bits(); 95 } 96 } 97 /// @brief 抽象文件结构体 98 #[derive(Debug)] 99 pub struct File { 100 inode: Arc<dyn IndexNode>, 101 /// 对于文件,表示字节偏移量;对于文件夹,表示当前操作的子目录项偏移量 102 offset: usize, 103 /// 文件的打开模式 104 mode: FileMode, 105 /// 文件类型 106 file_type: FileType, 107 /// readdir时候用的,暂存的本次循环中,所有子目录项的名字的数组 108 readdir_subdirs_name: Vec<String>, 109 pub private_data: FilePrivateData, 110 } 111 112 impl File { 113 /// @brief 创建一个新的文件对象 114 /// 115 /// @param inode 文件对象对应的inode 116 /// @param mode 文件的打开模式 117 pub fn new(inode: Arc<dyn IndexNode>, mode: FileMode) -> Result<Self, SystemError> { 118 let mut inode = inode; 119 let file_type = inode.metadata()?.file_type; 120 match file_type { 121 FileType::Pipe => { 122 if let Some(SpecialNodeData::Pipe(pipe_inode)) = inode.special_node() { 123 inode = pipe_inode; 124 } 125 } 126 _ => {} 127 } 128 129 let mut f = File { 130 inode, 131 offset: 0, 132 mode, 133 file_type, 134 readdir_subdirs_name: Vec::new(), 135 private_data: FilePrivateData::default(), 136 }; 137 // kdebug!("inode:{:?}",f.inode); 138 f.inode.open(&mut f.private_data, &mode)?; 139 140 return Ok(f); 141 } 142 143 /// @brief 从文件中读取指定的字节数到buffer中 144 /// 145 /// @param len 要读取的字节数 146 /// @param buf 目标buffer 147 /// 148 /// @return Ok(usize) 成功读取的字节数 149 /// @return Err(SystemError) 错误码 150 pub fn read(&mut self, len: usize, buf: &mut [u8]) -> Result<usize, SystemError> { 151 // 先检查本文件在权限等规则下,是否可读取。 152 self.readable()?; 153 154 if buf.len() < len { 155 return Err(SystemError::ENOBUFS); 156 } 157 158 // 如果文件指针已经超过了文件大小,则返回0 159 if self.offset > self.inode.metadata()?.size as usize { 160 return Ok(0); 161 } 162 let len = self 163 .inode 164 .read_at(self.offset, len, buf, &mut self.private_data)?; 165 self.offset += len; 166 return Ok(len); 167 } 168 169 /// @brief 从buffer向文件写入指定的字节数的数据 170 /// 171 /// @param len 要写入的字节数 172 /// @param buf 源数据buffer 173 /// 174 /// @return Ok(usize) 成功写入的字节数 175 /// @return Err(SystemError) 错误码 176 pub fn write(&mut self, len: usize, buf: &[u8]) -> Result<usize, SystemError> { 177 // 先检查本文件在权限等规则下,是否可写入。 178 self.writeable()?; 179 if buf.len() < len { 180 return Err(SystemError::ENOBUFS); 181 } 182 183 // 如果文件指针已经超过了文件大小,则需要扩展文件大小 184 let file_size = self.inode.metadata()?.size as usize; 185 if self.offset > file_size { 186 self.inode.resize(self.offset)?; 187 } 188 let len = self 189 .inode 190 .write_at(self.offset, len, buf, &mut self.private_data)?; 191 self.offset += len; 192 return Ok(len); 193 } 194 195 /// @brief 获取文件的元数据 196 pub fn metadata(&self) -> Result<Metadata, SystemError> { 197 return self.inode.metadata(); 198 } 199 200 /// @brief 根据inode号获取子目录项的名字 201 pub fn get_entry_name(&self, ino: InodeId) -> Result<String, SystemError> { 202 return self.inode.get_entry_name(ino); 203 } 204 205 /// @brief 调整文件操作指针的位置 206 /// 207 /// @param origin 调整的起始位置 208 pub fn lseek(&mut self, origin: SeekFrom) -> Result<usize, SystemError> { 209 let file_type = self.inode.metadata()?.file_type; 210 match file_type { 211 FileType::Pipe | FileType::CharDevice => { 212 return Err(SystemError::ESPIPE); 213 } 214 _ => {} 215 } 216 217 let pos: i64; 218 match origin { 219 SeekFrom::SeekSet(offset) => { 220 pos = offset; 221 } 222 SeekFrom::SeekCurrent(offset) => { 223 pos = self.offset as i64 + offset; 224 } 225 SeekFrom::SeekEnd(offset) => { 226 let metadata = self.metadata()?; 227 pos = metadata.size + offset; 228 } 229 SeekFrom::Invalid => { 230 return Err(SystemError::EINVAL); 231 } 232 } 233 // 根据linux man page, lseek允许超出文件末尾,并且不改变文件大小 234 // 当pos超出文件末尾时,read返回0。直到开始写入数据时,才会改变文件大小 235 if pos < 0 { 236 return Err(SystemError::EOVERFLOW); 237 } 238 self.offset = pos as usize; 239 return Ok(self.offset); 240 } 241 242 /// @brief 判断当前文件是否可读 243 #[inline] 244 pub fn readable(&self) -> Result<(), SystemError> { 245 // 暂时认为只要不是write only, 就可读 246 if self.mode == FileMode::O_WRONLY { 247 return Err(SystemError::EPERM); 248 } 249 250 return Ok(()); 251 } 252 253 /// @brief 判断当前文件是否可写 254 #[inline] 255 pub fn writeable(&self) -> Result<(), SystemError> { 256 // 暂时认为只要不是read only, 就可写 257 if self.mode == FileMode::O_RDONLY { 258 return Err(SystemError::EPERM); 259 } 260 261 return Ok(()); 262 } 263 264 /// @biref 充填dirent结构体 265 /// @return 返回dirent结构体的大小 266 pub fn readdir(&mut self, dirent: &mut Dirent) -> Result<u64, SystemError> { 267 let inode: &Arc<dyn IndexNode> = &self.inode; 268 269 // 如果偏移量为0 270 if self.offset == 0 { 271 // 通过list更新readdir_subdirs_name 272 self.readdir_subdirs_name = inode.list()?; 273 self.readdir_subdirs_name.sort(); 274 } 275 // kdebug!("sub_entries={sub_entries:?}"); 276 277 // 已经读到末尾 278 if self.offset == self.readdir_subdirs_name.len() { 279 self.offset = 0; 280 return Ok(0); 281 } 282 let name = &self.readdir_subdirs_name[self.offset]; 283 let sub_inode: Arc<dyn IndexNode> = match inode.find(&name) { 284 Ok(i) => i, 285 Err(e) => { 286 kerror!( 287 "Readdir error: Failed to find sub inode:{name:?}, file={self:?}, error={e:?}" 288 ); 289 return Err(e); 290 } 291 }; 292 293 let name_bytes: &[u8] = name.as_bytes(); 294 295 // 根据posix的规定,dirent中的d_name是一个不定长的数组,因此需要unsafe来拷贝数据 296 unsafe { 297 let ptr = &mut dirent.d_name as *mut u8; 298 299 let buf: &mut [u8] = 300 ::core::slice::from_raw_parts_mut::<'static, u8>(ptr, name_bytes.len() + 1); 301 buf[0..name_bytes.len()].copy_from_slice(name_bytes); 302 buf[name_bytes.len()] = 0; 303 } 304 305 self.offset += 1; 306 dirent.d_ino = sub_inode.metadata().unwrap().inode_id.into() as u64; 307 dirent.d_type = sub_inode.metadata().unwrap().file_type.get_file_type_num() as u8; 308 309 // 计算dirent结构体的大小 310 let size = (name_bytes.len() + ::core::mem::size_of::<Dirent>() 311 - ::core::mem::size_of_val(&dirent.d_name)) as u64; 312 313 dirent.d_reclen = size as u16; 314 dirent.d_off += dirent.d_reclen as i64; 315 316 return Ok(size); 317 } 318 319 pub fn inode(&self) -> Arc<dyn IndexNode> { 320 return self.inode.clone(); 321 } 322 323 /// @brief 尝试克隆一个文件 324 /// 325 /// @return Option<File> 克隆后的文件结构体。如果克隆失败,返回None 326 pub fn try_clone(&self) -> Option<File> { 327 let mut res = Self { 328 inode: self.inode.clone(), 329 offset: self.offset.clone(), 330 mode: self.mode.clone(), 331 file_type: self.file_type.clone(), 332 readdir_subdirs_name: self.readdir_subdirs_name.clone(), 333 private_data: self.private_data.clone(), 334 }; 335 // 调用inode的open方法,让inode知道有新的文件打开了这个inode 336 if self.inode.open(&mut res.private_data, &res.mode).is_err() { 337 return None; 338 } 339 340 return Some(res); 341 } 342 343 /// @brief 获取文件的类型 344 #[inline] 345 pub fn file_type(&self) -> FileType { 346 return self.file_type; 347 } 348 349 /// @brief 获取文件的打开模式 350 #[inline] 351 pub fn mode(&self) -> FileMode { 352 return self.mode; 353 } 354 355 /// 获取文件是否在execve时关闭 356 #[inline] 357 pub fn close_on_exec(&self) -> bool { 358 return self.mode.contains(FileMode::O_CLOEXEC); 359 } 360 361 /// 设置文件是否在execve时关闭 362 #[inline] 363 pub fn set_close_on_exec(&mut self, close_on_exec: bool) { 364 if close_on_exec { 365 self.mode.insert(FileMode::O_CLOEXEC); 366 } else { 367 self.mode.remove(FileMode::O_CLOEXEC); 368 } 369 } 370 371 pub fn set_mode(&mut self, mode: FileMode) -> Result<(), SystemError> { 372 // todo: 是否需要调用inode的open方法,以更新private data(假如它与mode有关的话)? 373 // 也许需要加个更好的设计,让inode知晓文件的打开模式发生了变化,让它自己决定是否需要更新private data 374 375 // 直接修改文件的打开模式 376 self.mode = mode; 377 return Ok(()); 378 } 379 380 /// @brief 重新设置文件的大小 381 /// 382 /// 如果文件大小增加,则文件内容不变,但是文件的空洞部分会被填充为0 383 /// 如果文件大小减小,则文件内容会被截断 384 /// 385 /// @return 成功:Ok() 386 /// 失败:Err(错误码) 387 pub fn ftruncate(&self, len: usize) -> Result<(), SystemError> { 388 // 如果文件不可写,返回错误 389 self.writeable()?; 390 391 // 调用inode的truncate方法 392 self.inode.resize(len)?; 393 return Ok(()); 394 } 395 } 396 397 impl Drop for File { 398 fn drop(&mut self) { 399 let r: Result<(), SystemError> = self.inode.close(&mut self.private_data); 400 // 打印错误信息 401 if r.is_err() { 402 kerror!( 403 "pid: {:?} failed to close file: {:?}, errno={:?}", 404 ProcessManager::current_pcb().pid(), 405 self, 406 r.unwrap_err() 407 ); 408 } 409 } 410 } 411 412 /// @brief pcb里面的文件描述符数组 413 #[derive(Debug)] 414 pub struct FileDescriptorVec { 415 /// 当前进程打开的文件描述符 416 fds: [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD], 417 } 418 419 impl FileDescriptorVec { 420 pub const PROCESS_MAX_FD: usize = 1024; 421 422 pub fn new() -> FileDescriptorVec { 423 // 先声明一个未初始化的数组 424 let mut data: [MaybeUninit<Option<Arc<SpinLock<File>>>>; 425 FileDescriptorVec::PROCESS_MAX_FD] = unsafe { MaybeUninit::uninit().assume_init() }; 426 427 // 逐个把每个元素初始化为None 428 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 429 data[i] = MaybeUninit::new(None); 430 } 431 // 由于一切都初始化完毕,因此将未初始化的类型强制转换为已经初始化的类型 432 let data: [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD] = unsafe { 433 core::mem::transmute::< 434 _, 435 [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD], 436 >(data) 437 }; 438 439 // 初始化文件描述符数组结构体 440 return FileDescriptorVec { fds: data }; 441 } 442 443 /// @brief 克隆一个文件描述符数组 444 /// 445 /// @return FileDescriptorVec 克隆后的文件描述符数组 446 pub fn clone(&self) -> FileDescriptorVec { 447 let mut res = FileDescriptorVec::new(); 448 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 449 if let Some(file) = &self.fds[i] { 450 if let Some(file) = file.lock().try_clone() { 451 res.fds[i] = Some(Arc::new(SpinLock::new(file))); 452 } 453 } 454 } 455 return res; 456 } 457 458 /// @brief 判断文件描述符序号是否合法 459 /// 460 /// @return true 合法 461 /// 462 /// @return false 不合法 463 #[inline] 464 pub fn validate_fd(fd: i32) -> bool { 465 if fd < 0 || fd as usize > FileDescriptorVec::PROCESS_MAX_FD { 466 return false; 467 } else { 468 return true; 469 } 470 } 471 472 /// 申请文件描述符,并把文件对象存入其中。 473 /// 474 /// ## 参数 475 /// 476 /// - `file` 要存放的文件对象 477 /// - `fd` 如果为Some(i32),表示指定要申请这个文件描述符,如果这个文件描述符已经被使用,那么返回EBADF 478 /// 479 /// ## 返回值 480 /// 481 /// - `Ok(i32)` 申请成功,返回申请到的文件描述符 482 /// - `Err(SystemError)` 申请失败,返回错误码,并且,file对象将被drop掉 483 pub fn alloc_fd(&mut self, file: File, fd: Option<i32>) -> Result<i32, SystemError> { 484 if fd.is_some() { 485 // 指定了要申请的文件描述符编号 486 let new_fd = fd.unwrap(); 487 let x = &mut self.fds[new_fd as usize]; 488 if x.is_none() { 489 *x = Some(Arc::new(SpinLock::new(file))); 490 return Ok(new_fd); 491 } else { 492 return Err(SystemError::EBADF); 493 } 494 } else { 495 // 没有指定要申请的文件描述符编号 496 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 497 if self.fds[i].is_none() { 498 self.fds[i] = Some(Arc::new(SpinLock::new(file))); 499 return Ok(i as i32); 500 } 501 } 502 return Err(SystemError::EMFILE); 503 } 504 } 505 506 /// 根据文件描述符序号,获取文件结构体的Arc指针 507 /// 508 /// ## 参数 509 /// 510 /// - `fd` 文件描述符序号 511 pub fn get_file_by_fd(&self, fd: i32) -> Option<Arc<SpinLock<File>>> { 512 if !FileDescriptorVec::validate_fd(fd) { 513 return None; 514 } 515 return self.fds[fd as usize].clone(); 516 } 517 518 /// 释放文件描述符,同时关闭文件。 519 /// 520 /// ## 参数 521 /// 522 /// - `fd` 文件描述符序号 523 pub fn drop_fd(&mut self, fd: i32) -> Result<(), SystemError> { 524 // 判断文件描述符的数字是否超过限制 525 if !FileDescriptorVec::validate_fd(fd) { 526 return Err(SystemError::EBADF); 527 } 528 529 self.get_file_by_fd(fd).ok_or(SystemError::EBADF)?; 530 531 // 把文件描述符数组对应位置设置为空 532 let file = self.fds[fd as usize].take().unwrap(); 533 534 assert!(Arc::strong_count(&file) == 1); 535 return Ok(()); 536 } 537 538 pub fn iter(&self) -> FileDescriptorIterator { 539 return FileDescriptorIterator::new(self); 540 } 541 542 pub fn close_on_exec(&mut self) { 543 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 544 if let Some(file) = &self.fds[i] { 545 let to_drop = file.lock().close_on_exec(); 546 if to_drop { 547 let r = self.drop_fd(i as i32); 548 if let Err(r) = r { 549 kerror!( 550 "Failed to close file: pid = {:?}, fd = {}, error = {:?}", 551 ProcessManager::current_pcb().pid(), 552 i, 553 r 554 ); 555 } 556 } 557 } 558 } 559 } 560 } 561 562 #[derive(Debug)] 563 pub struct FileDescriptorIterator<'a> { 564 fds: &'a FileDescriptorVec, 565 index: usize, 566 } 567 568 impl<'a> FileDescriptorIterator<'a> { 569 pub fn new(fds: &'a FileDescriptorVec) -> Self { 570 return Self { fds, index: 0 }; 571 } 572 } 573 574 impl<'a> Iterator for FileDescriptorIterator<'a> { 575 type Item = (i32, Arc<SpinLock<File>>); 576 577 fn next(&mut self) -> Option<Self::Item> { 578 while self.index < FileDescriptorVec::PROCESS_MAX_FD { 579 let fd = self.index as i32; 580 self.index += 1; 581 if let Some(file) = self.fds.get_file_by_fd(fd) { 582 return Some((fd, file)); 583 } 584 } 585 return None; 586 } 587 } 588