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