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}; 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 file_type: FileType = inode.metadata()?.file_type; 119 let mut f = File { 120 inode, 121 offset: 0, 122 mode, 123 file_type, 124 readdir_subdirs_name: Vec::new(), 125 private_data: FilePrivateData::default(), 126 }; 127 // kdebug!("inode:{:?}",f.inode); 128 f.inode.open(&mut f.private_data, &mode)?; 129 return Ok(f); 130 } 131 132 /// @brief 从文件中读取指定的字节数到buffer中 133 /// 134 /// @param len 要读取的字节数 135 /// @param buf 目标buffer 136 /// 137 /// @return Ok(usize) 成功读取的字节数 138 /// @return Err(SystemError) 错误码 139 pub fn read(&mut self, len: usize, buf: &mut [u8]) -> Result<usize, SystemError> { 140 // 先检查本文件在权限等规则下,是否可读取。 141 self.readable()?; 142 143 if buf.len() < len { 144 return Err(SystemError::ENOBUFS); 145 } 146 147 // 如果文件指针已经超过了文件大小,则返回0 148 if self.offset > self.inode.metadata()?.size as usize { 149 return Ok(0); 150 } 151 152 let len = self 153 .inode 154 .read_at(self.offset, len, buf, &mut self.private_data)?; 155 self.offset += len; 156 return Ok(len); 157 } 158 159 /// @brief 从buffer向文件写入指定的字节数的数据 160 /// 161 /// @param len 要写入的字节数 162 /// @param buf 源数据buffer 163 /// 164 /// @return Ok(usize) 成功写入的字节数 165 /// @return Err(SystemError) 错误码 166 pub fn write(&mut self, len: usize, buf: &[u8]) -> Result<usize, SystemError> { 167 // 先检查本文件在权限等规则下,是否可写入。 168 self.writeable()?; 169 if buf.len() < len { 170 return Err(SystemError::ENOBUFS); 171 } 172 173 // 如果文件指针已经超过了文件大小,则需要扩展文件大小 174 let file_size = self.inode.metadata()?.size as usize; 175 if self.offset > file_size { 176 self.inode.resize(self.offset)?; 177 } 178 let len = self 179 .inode 180 .write_at(self.offset, len, buf, &mut self.private_data)?; 181 self.offset += len; 182 return Ok(len); 183 } 184 185 /// @brief 获取文件的元数据 186 pub fn metadata(&self) -> Result<Metadata, SystemError> { 187 return self.inode.metadata(); 188 } 189 190 /// @brief 根据inode号获取子目录项的名字 191 pub fn get_entry_name(&self, ino: InodeId) -> Result<String, SystemError> { 192 return self.inode.get_entry_name(ino); 193 } 194 195 /// @brief 调整文件操作指针的位置 196 /// 197 /// @param origin 调整的起始位置 198 pub fn lseek(&mut self, origin: SeekFrom) -> Result<usize, SystemError> { 199 let file_type = self.inode.metadata()?.file_type; 200 match file_type { 201 FileType::Pipe | FileType::CharDevice => { 202 return Err(SystemError::ESPIPE); 203 } 204 _ => {} 205 } 206 207 let pos: i64; 208 match origin { 209 SeekFrom::SeekSet(offset) => { 210 pos = offset; 211 } 212 SeekFrom::SeekCurrent(offset) => { 213 pos = self.offset as i64 + offset; 214 } 215 SeekFrom::SeekEnd(offset) => { 216 let metadata = self.metadata()?; 217 pos = metadata.size + offset; 218 } 219 SeekFrom::Invalid => { 220 return Err(SystemError::EINVAL); 221 } 222 } 223 // 根据linux man page, lseek允许超出文件末尾,并且不改变文件大小 224 // 当pos超出文件末尾时,read返回0。直到开始写入数据时,才会改变文件大小 225 if pos < 0 { 226 return Err(SystemError::EOVERFLOW); 227 } 228 self.offset = pos as usize; 229 return Ok(self.offset); 230 } 231 232 /// @brief 判断当前文件是否可读 233 #[inline] 234 pub fn readable(&self) -> Result<(), SystemError> { 235 // 暂时认为只要不是write only, 就可读 236 if self.mode == FileMode::O_WRONLY { 237 return Err(SystemError::EPERM); 238 } 239 240 return Ok(()); 241 } 242 243 /// @brief 判断当前文件是否可写 244 #[inline] 245 pub fn writeable(&self) -> Result<(), SystemError> { 246 // 暂时认为只要不是read only, 就可写 247 if self.mode == FileMode::O_RDONLY { 248 return Err(SystemError::EPERM); 249 } 250 251 return Ok(()); 252 } 253 254 /// @biref 充填dirent结构体 255 /// @return 返回dirent结构体的大小 256 pub fn readdir(&mut self, dirent: &mut Dirent) -> Result<u64, SystemError> { 257 let inode: &Arc<dyn IndexNode> = &self.inode; 258 259 // 如果偏移量为0 260 if self.offset == 0 { 261 self.readdir_subdirs_name = inode.list()?; 262 self.readdir_subdirs_name.sort(); 263 } 264 // kdebug!("sub_entries={sub_entries:?}"); 265 if self.readdir_subdirs_name.is_empty() { 266 self.offset = 0; 267 return Ok(0); 268 } 269 let name: String = self.readdir_subdirs_name.remove(0); 270 let sub_inode: Arc<dyn IndexNode> = match inode.find(&name) { 271 Ok(i) => i, 272 Err(e) => { 273 kerror!("Readdir error: Failed to find sub inode, file={self:?}"); 274 return Err(e); 275 } 276 }; 277 278 let name_bytes: &[u8] = name.as_bytes(); 279 280 self.offset += 1; 281 dirent.d_ino = sub_inode.metadata().unwrap().inode_id.into() as u64; 282 dirent.d_type = sub_inode.metadata().unwrap().file_type.get_file_type_num() as u8; 283 // 根据posix的规定,dirent中的d_name是一个不定长的数组,因此需要unsafe来拷贝数据 284 unsafe { 285 let ptr = &mut dirent.d_name as *mut u8; 286 let buf: &mut [u8] = 287 ::core::slice::from_raw_parts_mut::<'static, u8>(ptr, name_bytes.len()); 288 buf.copy_from_slice(name_bytes); 289 } 290 291 // 计算dirent结构体的大小 292 let size = (name_bytes.len() + ::core::mem::size_of::<Dirent>() 293 - ::core::mem::size_of_val(&dirent.d_name)) as u64; 294 295 dirent.d_reclen = size as u16; 296 dirent.d_off += dirent.d_reclen as i64; 297 298 return Ok(size); 299 } 300 301 pub fn inode(&self) -> Arc<dyn IndexNode> { 302 return self.inode.clone(); 303 } 304 305 /// @brief 尝试克隆一个文件 306 /// 307 /// @return Option<File> 克隆后的文件结构体。如果克隆失败,返回None 308 pub fn try_clone(&self) -> Option<File> { 309 let mut res = Self { 310 inode: self.inode.clone(), 311 offset: self.offset.clone(), 312 mode: self.mode.clone(), 313 file_type: self.file_type.clone(), 314 readdir_subdirs_name: self.readdir_subdirs_name.clone(), 315 private_data: self.private_data.clone(), 316 }; 317 // 调用inode的open方法,让inode知道有新的文件打开了这个inode 318 if self.inode.open(&mut res.private_data, &res.mode).is_err() { 319 return None; 320 } 321 322 return Some(res); 323 } 324 325 /// @brief 获取文件的类型 326 #[inline] 327 pub fn file_type(&self) -> FileType { 328 return self.file_type; 329 } 330 331 /// @brief 获取文件的打开模式 332 #[inline] 333 pub fn mode(&self) -> FileMode { 334 return self.mode; 335 } 336 337 /// 获取文件是否在execve时关闭 338 #[inline] 339 pub fn close_on_exec(&self) -> bool { 340 return self.mode.contains(FileMode::O_CLOEXEC); 341 } 342 343 /// 设置文件是否在execve时关闭 344 #[inline] 345 pub fn set_close_on_exec(&mut self, close_on_exec: bool) { 346 if close_on_exec { 347 self.mode.insert(FileMode::O_CLOEXEC); 348 } else { 349 self.mode.remove(FileMode::O_CLOEXEC); 350 } 351 } 352 353 pub fn set_mode(&mut self, mode: FileMode) -> Result<(), SystemError> { 354 // todo: 是否需要调用inode的open方法,以更新private data(假如它与mode有关的话)? 355 // 也许需要加个更好的设计,让inode知晓文件的打开模式发生了变化,让它自己决定是否需要更新private data 356 357 // 直接修改文件的打开模式 358 self.mode = mode; 359 return Ok(()); 360 } 361 362 /// @brief 重新设置文件的大小 363 /// 364 /// 如果文件大小增加,则文件内容不变,但是文件的空洞部分会被填充为0 365 /// 如果文件大小减小,则文件内容会被截断 366 /// 367 /// @return 成功:Ok() 368 /// 失败:Err(错误码) 369 pub fn ftruncate(&self, len: usize) -> Result<(), SystemError> { 370 // 如果文件不可写,返回错误 371 self.writeable()?; 372 373 // 调用inode的truncate方法 374 self.inode.resize(len)?; 375 return Ok(()); 376 } 377 } 378 379 impl Drop for File { 380 fn drop(&mut self) { 381 let r: Result<(), SystemError> = self.inode.close(&mut self.private_data); 382 // 打印错误信息 383 if r.is_err() { 384 kerror!( 385 "pid: {:?} failed to close file: {:?}, errno={:?}", 386 ProcessManager::current_pcb().pid(), 387 self, 388 r.unwrap_err() 389 ); 390 } 391 } 392 } 393 394 /// @brief pcb里面的文件描述符数组 395 #[derive(Debug)] 396 pub struct FileDescriptorVec { 397 /// 当前进程打开的文件描述符 398 fds: [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD], 399 } 400 401 impl FileDescriptorVec { 402 pub const PROCESS_MAX_FD: usize = 32; 403 404 pub fn new() -> FileDescriptorVec { 405 // 先声明一个未初始化的数组 406 let mut data: [MaybeUninit<Option<Arc<SpinLock<File>>>>; 407 FileDescriptorVec::PROCESS_MAX_FD] = unsafe { MaybeUninit::uninit().assume_init() }; 408 409 // 逐个把每个元素初始化为None 410 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 411 data[i] = MaybeUninit::new(None); 412 } 413 // 由于一切都初始化完毕,因此将未初始化的类型强制转换为已经初始化的类型 414 let data: [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD] = unsafe { 415 core::mem::transmute::< 416 _, 417 [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD], 418 >(data) 419 }; 420 421 // 初始化文件描述符数组结构体 422 return FileDescriptorVec { fds: data }; 423 } 424 425 /// @brief 克隆一个文件描述符数组 426 /// 427 /// @return FileDescriptorVec 克隆后的文件描述符数组 428 pub fn clone(&self) -> FileDescriptorVec { 429 let mut res = FileDescriptorVec::new(); 430 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 431 if let Some(file) = &self.fds[i] { 432 if let Some(file) = file.lock().try_clone() { 433 res.fds[i] = Some(Arc::new(SpinLock::new(file))); 434 } 435 } 436 } 437 return res; 438 } 439 440 /// @brief 判断文件描述符序号是否合法 441 /// 442 /// @return true 合法 443 /// 444 /// @return false 不合法 445 #[inline] 446 pub fn validate_fd(fd: i32) -> bool { 447 if fd < 0 || fd as usize > FileDescriptorVec::PROCESS_MAX_FD { 448 return false; 449 } else { 450 return true; 451 } 452 } 453 454 /// 申请文件描述符,并把文件对象存入其中。 455 /// 456 /// ## 参数 457 /// 458 /// - `file` 要存放的文件对象 459 /// - `fd` 如果为Some(i32),表示指定要申请这个文件描述符,如果这个文件描述符已经被使用,那么返回EBADF 460 /// 461 /// ## 返回值 462 /// 463 /// - `Ok(i32)` 申请成功,返回申请到的文件描述符 464 /// - `Err(SystemError)` 申请失败,返回错误码,并且,file对象将被drop掉 465 pub fn alloc_fd(&mut self, file: File, fd: Option<i32>) -> Result<i32, SystemError> { 466 if fd.is_some() { 467 // 指定了要申请的文件描述符编号 468 let new_fd = fd.unwrap(); 469 let x = &mut self.fds[new_fd as usize]; 470 if x.is_none() { 471 *x = Some(Arc::new(SpinLock::new(file))); 472 return Ok(new_fd); 473 } else { 474 return Err(SystemError::EBADF); 475 } 476 } else { 477 // 没有指定要申请的文件描述符编号 478 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 479 if self.fds[i].is_none() { 480 self.fds[i] = Some(Arc::new(SpinLock::new(file))); 481 return Ok(i as i32); 482 } 483 } 484 return Err(SystemError::EMFILE); 485 } 486 } 487 488 /// 根据文件描述符序号,获取文件结构体的Arc指针 489 /// 490 /// ## 参数 491 /// 492 /// - `fd` 文件描述符序号 493 pub fn get_file_by_fd(&self, fd: i32) -> Option<Arc<SpinLock<File>>> { 494 if !FileDescriptorVec::validate_fd(fd) { 495 return None; 496 } 497 return self.fds[fd as usize].clone(); 498 } 499 500 /// 释放文件描述符,同时关闭文件。 501 /// 502 /// ## 参数 503 /// 504 /// - `fd` 文件描述符序号 505 pub fn drop_fd(&mut self, fd: i32) -> Result<(), SystemError> { 506 // 判断文件描述符的数字是否超过限制 507 if !FileDescriptorVec::validate_fd(fd) { 508 return Err(SystemError::EBADF); 509 } 510 511 self.get_file_by_fd(fd).ok_or(SystemError::EBADF)?; 512 513 // 把文件描述符数组对应位置设置为空 514 let file = self.fds[fd as usize].take().unwrap(); 515 516 assert!(Arc::strong_count(&file) == 1); 517 return Ok(()); 518 } 519 520 pub fn iter(&self) -> FileDescriptorIterator { 521 return FileDescriptorIterator::new(self); 522 } 523 524 pub fn close_on_exec(&mut self) { 525 for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 526 if let Some(file) = &self.fds[i] { 527 let to_drop = file.lock().close_on_exec(); 528 if to_drop { 529 let r = self.drop_fd(i as i32); 530 if let Err(r) = r { 531 kerror!( 532 "Failed to close file: pid = {:?}, fd = {}, error = {:?}", 533 ProcessManager::current_pcb().pid(), 534 i, 535 r 536 ); 537 } 538 } 539 } 540 } 541 } 542 } 543 544 #[derive(Debug)] 545 pub struct FileDescriptorIterator<'a> { 546 fds: &'a FileDescriptorVec, 547 index: usize, 548 } 549 550 impl<'a> FileDescriptorIterator<'a> { 551 pub fn new(fds: &'a FileDescriptorVec) -> Self { 552 return Self { fds, index: 0 }; 553 } 554 } 555 556 impl<'a> Iterator for FileDescriptorIterator<'a> { 557 type Item = (i32, Arc<SpinLock<File>>); 558 559 fn next(&mut self) -> Option<Self::Item> { 560 while self.index < FileDescriptorVec::PROCESS_MAX_FD { 561 let fd = self.index as i32; 562 self.index += 1; 563 if let Some(file) = self.fds.get_file_by_fd(fd) { 564 return Some((fd, file)); 565 } 566 } 567 return None; 568 } 569 } 570