1004e86ffSlogin use core::mem::MaybeUninit; 2004e86ffSlogin 31496ba7bSLoGin use alloc::{string::String, sync::Arc, vec::Vec}; 4004e86ffSlogin 5004e86ffSlogin use crate::{ 6b087521eSChiichen driver::{ 7b087521eSChiichen base::{block::SeekFrom, device::DevicePrivateData}, 8b087521eSChiichen tty::TtyFilePrivateData, 9b087521eSChiichen }, 10b087521eSChiichen filesystem::procfs::ProcfsFilePrivateData, 11876cb89eSGnoCiYeH ipc::pipe::PipeFsPrivateData, 12b087521eSChiichen kerror, 131496ba7bSLoGin libs::spinlock::SpinLock, 141496ba7bSLoGin process::ProcessManager, 15b087521eSChiichen syscall::SystemError, 16004e86ffSlogin }; 17004e86ffSlogin 182dbef785SGnoCiYeH use super::{Dirent, FileType, IndexNode, InodeId, Metadata, SpecialNodeData}; 19004e86ffSlogin 20004e86ffSlogin /// 文件私有信息的枚举类型 21004e86ffSlogin #[derive(Debug, Clone)] 22004e86ffSlogin pub enum FilePrivateData { 23876cb89eSGnoCiYeH /// 管道文件私有信息 24876cb89eSGnoCiYeH Pipefs(PipeFsPrivateData), 250d48c3c9Slogin /// procfs文件私有信息 26004e86ffSlogin Procfs(ProcfsFilePrivateData), 27b087521eSChiichen /// 设备文件的私有信息 28b087521eSChiichen DevFS(DevicePrivateData), 29b087521eSChiichen /// tty设备文件的私有信息 300d48c3c9Slogin Tty(TtyFilePrivateData), 310d48c3c9Slogin /// 不需要文件私有信息 32004e86ffSlogin Unused, 33004e86ffSlogin } 34004e86ffSlogin 35004e86ffSlogin impl Default for FilePrivateData { 36004e86ffSlogin fn default() -> Self { 37004e86ffSlogin return Self::Unused; 38004e86ffSlogin } 39004e86ffSlogin } 40004e86ffSlogin 41004e86ffSlogin bitflags! { 42004e86ffSlogin /// @brief 文件打开模式 43004e86ffSlogin /// 其中,低2bit组合而成的数字的值,用于表示访问权限。其他的bit,才支持通过按位或的方式来表示参数 44004e86ffSlogin /// 45004e86ffSlogin /// 与Linux 5.19.10的uapi/asm-generic/fcntl.h相同 46004e86ffSlogin /// https://opengrok.ringotek.cn/xref/linux-5.19.10/tools/include/uapi/asm-generic/fcntl.h#19 47004e86ffSlogin pub struct FileMode: u32{ 48004e86ffSlogin /* File access modes for `open' and `fcntl'. */ 49004e86ffSlogin /// Open Read-only 5084407d36Slogin const O_RDONLY = 0o0; 51004e86ffSlogin /// Open Write-only 5284407d36Slogin const O_WRONLY = 0o1; 53004e86ffSlogin /// Open read/write 5484407d36Slogin const O_RDWR = 0o2; 55004e86ffSlogin /// Mask for file access modes 5684407d36Slogin const O_ACCMODE = 0o00000003; 57004e86ffSlogin 58004e86ffSlogin /* Bits OR'd into the second argument to open. */ 59004e86ffSlogin /// Create file if it does not exist 6084407d36Slogin const O_CREAT = 0o00000100; 61004e86ffSlogin /// Fail if file already exists 6284407d36Slogin const O_EXCL = 0o00000200; 63004e86ffSlogin /// Do not assign controlling terminal 6484407d36Slogin const O_NOCTTY = 0o00000400; 65004e86ffSlogin /// 文件存在且是普通文件,并以O_RDWR或O_WRONLY打开,则它会被清空 6684407d36Slogin const O_TRUNC = 0o00001000; 67004e86ffSlogin /// 文件指针会被移动到文件末尾 6884407d36Slogin const O_APPEND = 0o00002000; 69004e86ffSlogin /// 非阻塞式IO模式 7084407d36Slogin const O_NONBLOCK = 0o00004000; 7120e3152eSlogin /// 每次write都等待物理I/O完成,但是如果写操作不影响读取刚写入的数据,则不等待文件属性更新 7284407d36Slogin const O_DSYNC = 0o00010000; 73004e86ffSlogin /// fcntl, for BSD compatibility 7484407d36Slogin const FASYNC = 0o00020000; 75004e86ffSlogin /* direct disk access hint */ 7684407d36Slogin const O_DIRECT = 0o00040000; 7784407d36Slogin const O_LARGEFILE = 0o00100000; 78004e86ffSlogin /// 打开的必须是一个目录 7984407d36Slogin const O_DIRECTORY = 0o00200000; 80004e86ffSlogin /// Do not follow symbolic links 8184407d36Slogin const O_NOFOLLOW = 0o00400000; 8284407d36Slogin const O_NOATIME = 0o01000000; 83004e86ffSlogin /// set close_on_exec 8484407d36Slogin const O_CLOEXEC = 0o02000000; 8520e3152eSlogin /// 每次write都等到物理I/O完成,包括write引起的文件属性的更新 8620e3152eSlogin const O_SYNC = 0o04000000; 87004e86ffSlogin } 88004e86ffSlogin } 89004e86ffSlogin 9020e3152eSlogin impl FileMode { 9120e3152eSlogin /// @brief 获取文件的访问模式的值 9220e3152eSlogin #[inline] 9320e3152eSlogin pub fn accmode(&self) -> u32 { 9420e3152eSlogin return self.bits() & FileMode::O_ACCMODE.bits(); 9520e3152eSlogin } 9620e3152eSlogin } 97004e86ffSlogin /// @brief 抽象文件结构体 9864aea4b3SGou Ngai #[derive(Debug)] 99004e86ffSlogin pub struct File { 100004e86ffSlogin inode: Arc<dyn IndexNode>, 101004e86ffSlogin /// 对于文件,表示字节偏移量;对于文件夹,表示当前操作的子目录项偏移量 102004e86ffSlogin offset: usize, 103004e86ffSlogin /// 文件的打开模式 104004e86ffSlogin mode: FileMode, 105004e86ffSlogin /// 文件类型 106004e86ffSlogin file_type: FileType, 107004e86ffSlogin /// readdir时候用的,暂存的本次循环中,所有子目录项的名字的数组 108004e86ffSlogin readdir_subdirs_name: Vec<String>, 109004e86ffSlogin pub private_data: FilePrivateData, 110004e86ffSlogin } 111004e86ffSlogin 112004e86ffSlogin impl File { 113004e86ffSlogin /// @brief 创建一个新的文件对象 114004e86ffSlogin /// 115004e86ffSlogin /// @param inode 文件对象对应的inode 116004e86ffSlogin /// @param mode 文件的打开模式 117676b8ef6SMork pub fn new(inode: Arc<dyn IndexNode>, mode: FileMode) -> Result<Self, SystemError> { 1182dbef785SGnoCiYeH let mut inode = inode; 1192dbef785SGnoCiYeH let file_type = inode.metadata()?.file_type; 1202dbef785SGnoCiYeH match file_type { 1212dbef785SGnoCiYeH FileType::Pipe => { 1222dbef785SGnoCiYeH if let Some(SpecialNodeData::Pipe(pipe_inode)) = inode.special_node() { 1232dbef785SGnoCiYeH inode = pipe_inode; 1242dbef785SGnoCiYeH } 1252dbef785SGnoCiYeH } 1262dbef785SGnoCiYeH _ => {} 1272dbef785SGnoCiYeH } 1282dbef785SGnoCiYeH 129004e86ffSlogin let mut f = File { 130004e86ffSlogin inode, 131004e86ffSlogin offset: 0, 132004e86ffSlogin mode, 133004e86ffSlogin file_type, 134004e86ffSlogin readdir_subdirs_name: Vec::new(), 135004e86ffSlogin private_data: FilePrivateData::default(), 136004e86ffSlogin }; 137004e86ffSlogin // kdebug!("inode:{:?}",f.inode); 1380d48c3c9Slogin f.inode.open(&mut f.private_data, &mode)?; 13940314b30SXiaoye Zheng 140004e86ffSlogin return Ok(f); 141004e86ffSlogin } 142004e86ffSlogin 143004e86ffSlogin /// @brief 从文件中读取指定的字节数到buffer中 144004e86ffSlogin /// 145004e86ffSlogin /// @param len 要读取的字节数 146004e86ffSlogin /// @param buf 目标buffer 147004e86ffSlogin /// 148004e86ffSlogin /// @return Ok(usize) 成功读取的字节数 149676b8ef6SMork /// @return Err(SystemError) 错误码 150676b8ef6SMork pub fn read(&mut self, len: usize, buf: &mut [u8]) -> Result<usize, SystemError> { 151004e86ffSlogin // 先检查本文件在权限等规则下,是否可读取。 152004e86ffSlogin self.readable()?; 153004e86ffSlogin 154004e86ffSlogin if buf.len() < len { 155676b8ef6SMork return Err(SystemError::ENOBUFS); 156004e86ffSlogin } 1576d81180bSLoGin 1586d81180bSLoGin // 如果文件指针已经超过了文件大小,则返回0 1596d81180bSLoGin if self.offset > self.inode.metadata()?.size as usize { 1606d81180bSLoGin return Ok(0); 1616d81180bSLoGin } 162004e86ffSlogin let len = self 163004e86ffSlogin .inode 164004e86ffSlogin .read_at(self.offset, len, buf, &mut self.private_data)?; 165004e86ffSlogin self.offset += len; 166004e86ffSlogin return Ok(len); 167004e86ffSlogin } 168004e86ffSlogin 169004e86ffSlogin /// @brief 从buffer向文件写入指定的字节数的数据 170004e86ffSlogin /// 171004e86ffSlogin /// @param len 要写入的字节数 172004e86ffSlogin /// @param buf 源数据buffer 173004e86ffSlogin /// 174004e86ffSlogin /// @return Ok(usize) 成功写入的字节数 175676b8ef6SMork /// @return Err(SystemError) 错误码 176676b8ef6SMork pub fn write(&mut self, len: usize, buf: &[u8]) -> Result<usize, SystemError> { 177004e86ffSlogin // 先检查本文件在权限等规则下,是否可写入。 178004e86ffSlogin self.writeable()?; 179004e86ffSlogin if buf.len() < len { 180676b8ef6SMork return Err(SystemError::ENOBUFS); 181004e86ffSlogin } 1826d81180bSLoGin 1836d81180bSLoGin // 如果文件指针已经超过了文件大小,则需要扩展文件大小 1846d81180bSLoGin let file_size = self.inode.metadata()?.size as usize; 1856d81180bSLoGin if self.offset > file_size { 1866d81180bSLoGin self.inode.resize(self.offset)?; 1876d81180bSLoGin } 188004e86ffSlogin let len = self 189004e86ffSlogin .inode 19020e3152eSlogin .write_at(self.offset, len, buf, &mut self.private_data)?; 191004e86ffSlogin self.offset += len; 192004e86ffSlogin return Ok(len); 193004e86ffSlogin } 194004e86ffSlogin 195004e86ffSlogin /// @brief 获取文件的元数据 196676b8ef6SMork pub fn metadata(&self) -> Result<Metadata, SystemError> { 197004e86ffSlogin return self.inode.metadata(); 198004e86ffSlogin } 199004e86ffSlogin 200004e86ffSlogin /// @brief 根据inode号获取子目录项的名字 2016b4e7a29SLoGin pub fn get_entry_name(&self, ino: InodeId) -> Result<String, SystemError> { 202004e86ffSlogin return self.inode.get_entry_name(ino); 203004e86ffSlogin } 204004e86ffSlogin 205004e86ffSlogin /// @brief 调整文件操作指针的位置 206004e86ffSlogin /// 207004e86ffSlogin /// @param origin 调整的起始位置 208676b8ef6SMork pub fn lseek(&mut self, origin: SeekFrom) -> Result<usize, SystemError> { 20940fe15e0SLoGin let file_type = self.inode.metadata()?.file_type; 210bfafc102Slogin match file_type { 211bfafc102Slogin FileType::Pipe | FileType::CharDevice => { 212676b8ef6SMork return Err(SystemError::ESPIPE); 213004e86ffSlogin } 214bfafc102Slogin _ => {} 215bfafc102Slogin } 216bfafc102Slogin 217004e86ffSlogin let pos: i64; 218004e86ffSlogin match origin { 219004e86ffSlogin SeekFrom::SeekSet(offset) => { 220004e86ffSlogin pos = offset; 221004e86ffSlogin } 222004e86ffSlogin SeekFrom::SeekCurrent(offset) => { 223004e86ffSlogin pos = self.offset as i64 + offset; 224004e86ffSlogin } 225004e86ffSlogin SeekFrom::SeekEnd(offset) => { 226004e86ffSlogin let metadata = self.metadata()?; 227004e86ffSlogin pos = metadata.size + offset; 228004e86ffSlogin } 229004e86ffSlogin SeekFrom::Invalid => { 230676b8ef6SMork return Err(SystemError::EINVAL); 231004e86ffSlogin } 232004e86ffSlogin } 2336d81180bSLoGin // 根据linux man page, lseek允许超出文件末尾,并且不改变文件大小 2346d81180bSLoGin // 当pos超出文件末尾时,read返回0。直到开始写入数据时,才会改变文件大小 2356d81180bSLoGin if pos < 0 { 236676b8ef6SMork return Err(SystemError::EOVERFLOW); 237004e86ffSlogin } 238004e86ffSlogin self.offset = pos as usize; 239004e86ffSlogin return Ok(self.offset); 240004e86ffSlogin } 241004e86ffSlogin 242004e86ffSlogin /// @brief 判断当前文件是否可读 243004e86ffSlogin #[inline] 244676b8ef6SMork pub fn readable(&self) -> Result<(), SystemError> { 245004e86ffSlogin // 暂时认为只要不是write only, 就可读 246004e86ffSlogin if self.mode == FileMode::O_WRONLY { 247676b8ef6SMork return Err(SystemError::EPERM); 248004e86ffSlogin } 249004e86ffSlogin 250004e86ffSlogin return Ok(()); 251004e86ffSlogin } 252004e86ffSlogin 253004e86ffSlogin /// @brief 判断当前文件是否可写 254004e86ffSlogin #[inline] 255676b8ef6SMork pub fn writeable(&self) -> Result<(), SystemError> { 256004e86ffSlogin // 暂时认为只要不是read only, 就可写 257004e86ffSlogin if self.mode == FileMode::O_RDONLY { 258676b8ef6SMork return Err(SystemError::EPERM); 259004e86ffSlogin } 260004e86ffSlogin 261004e86ffSlogin return Ok(()); 262004e86ffSlogin } 263004e86ffSlogin 264004e86ffSlogin /// @biref 充填dirent结构体 265004e86ffSlogin /// @return 返回dirent结构体的大小 266676b8ef6SMork pub fn readdir(&mut self, dirent: &mut Dirent) -> Result<u64, SystemError> { 267004e86ffSlogin let inode: &Arc<dyn IndexNode> = &self.inode; 268004e86ffSlogin 269004e86ffSlogin // 如果偏移量为0 270004e86ffSlogin if self.offset == 0 { 2711effcfe5SGnoCiYeH // 通过list更新readdir_subdirs_name 272004e86ffSlogin self.readdir_subdirs_name = inode.list()?; 273004e86ffSlogin self.readdir_subdirs_name.sort(); 274004e86ffSlogin } 275004e86ffSlogin // kdebug!("sub_entries={sub_entries:?}"); 2761effcfe5SGnoCiYeH 2771effcfe5SGnoCiYeH // 已经读到末尾 2781effcfe5SGnoCiYeH if self.offset == self.readdir_subdirs_name.len() { 279004e86ffSlogin self.offset = 0; 280004e86ffSlogin return Ok(0); 281004e86ffSlogin } 2821effcfe5SGnoCiYeH let name = &self.readdir_subdirs_name[self.offset]; 283004e86ffSlogin let sub_inode: Arc<dyn IndexNode> = match inode.find(&name) { 284004e86ffSlogin Ok(i) => i, 285004e86ffSlogin Err(e) => { 28606d5e247SLoGin kerror!( 28706d5e247SLoGin "Readdir error: Failed to find sub inode:{name:?}, file={self:?}, error={e:?}" 28806d5e247SLoGin ); 289004e86ffSlogin return Err(e); 290004e86ffSlogin } 291004e86ffSlogin }; 292004e86ffSlogin 293004e86ffSlogin let name_bytes: &[u8] = name.as_bytes(); 294004e86ffSlogin 295004e86ffSlogin // 根据posix的规定,dirent中的d_name是一个不定长的数组,因此需要unsafe来拷贝数据 296004e86ffSlogin unsafe { 297004e86ffSlogin let ptr = &mut dirent.d_name as *mut u8; 2981effcfe5SGnoCiYeH 299004e86ffSlogin let buf: &mut [u8] = 3001effcfe5SGnoCiYeH ::core::slice::from_raw_parts_mut::<'static, u8>(ptr, name_bytes.len() + 1); 3011effcfe5SGnoCiYeH buf[0..name_bytes.len()].copy_from_slice(name_bytes); 3021effcfe5SGnoCiYeH buf[name_bytes.len()] = 0; 303004e86ffSlogin } 304004e86ffSlogin 3051effcfe5SGnoCiYeH self.offset += 1; 3061effcfe5SGnoCiYeH dirent.d_ino = sub_inode.metadata().unwrap().inode_id.into() as u64; 3071effcfe5SGnoCiYeH dirent.d_type = sub_inode.metadata().unwrap().file_type.get_file_type_num() as u8; 3081effcfe5SGnoCiYeH 309004e86ffSlogin // 计算dirent结构体的大小 310bb0e4d41SGnoCiYeH let size = (name_bytes.len() + ::core::mem::size_of::<Dirent>() 311bb0e4d41SGnoCiYeH - ::core::mem::size_of_val(&dirent.d_name)) as u64; 312bb0e4d41SGnoCiYeH 313bb0e4d41SGnoCiYeH dirent.d_reclen = size as u16; 314bb0e4d41SGnoCiYeH dirent.d_off += dirent.d_reclen as i64; 315bb0e4d41SGnoCiYeH 316bb0e4d41SGnoCiYeH return Ok(size); 317004e86ffSlogin } 31864aea4b3SGou Ngai 319004e86ffSlogin pub fn inode(&self) -> Arc<dyn IndexNode> { 320004e86ffSlogin return self.inode.clone(); 321004e86ffSlogin } 32264aea4b3SGou Ngai 32364aea4b3SGou Ngai /// @brief 尝试克隆一个文件 32464aea4b3SGou Ngai /// 3251496ba7bSLoGin /// @return Option<File> 克隆后的文件结构体。如果克隆失败,返回None 3261496ba7bSLoGin pub fn try_clone(&self) -> Option<File> { 3271496ba7bSLoGin let mut res = Self { 32864aea4b3SGou Ngai inode: self.inode.clone(), 32964aea4b3SGou Ngai offset: self.offset.clone(), 33064aea4b3SGou Ngai mode: self.mode.clone(), 33164aea4b3SGou Ngai file_type: self.file_type.clone(), 33264aea4b3SGou Ngai readdir_subdirs_name: self.readdir_subdirs_name.clone(), 33364aea4b3SGou Ngai private_data: self.private_data.clone(), 3341496ba7bSLoGin }; 33564aea4b3SGou Ngai // 调用inode的open方法,让inode知道有新的文件打开了这个inode 33664aea4b3SGou Ngai if self.inode.open(&mut res.private_data, &res.mode).is_err() { 33764aea4b3SGou Ngai return None; 33864aea4b3SGou Ngai } 33964aea4b3SGou Ngai 34064aea4b3SGou Ngai return Some(res); 34164aea4b3SGou Ngai } 342cde5492fSlogin 343cde5492fSlogin /// @brief 获取文件的类型 344cde5492fSlogin #[inline] 345cde5492fSlogin pub fn file_type(&self) -> FileType { 346cde5492fSlogin return self.file_type; 347cde5492fSlogin } 3486d81180bSLoGin 3496d81180bSLoGin /// @brief 获取文件的打开模式 3506d81180bSLoGin #[inline] 3516d81180bSLoGin pub fn mode(&self) -> FileMode { 3526d81180bSLoGin return self.mode; 3536d81180bSLoGin } 3546d81180bSLoGin 3556d81180bSLoGin /// 获取文件是否在execve时关闭 3566d81180bSLoGin #[inline] 3576d81180bSLoGin pub fn close_on_exec(&self) -> bool { 3586d81180bSLoGin return self.mode.contains(FileMode::O_CLOEXEC); 3596d81180bSLoGin } 3606d81180bSLoGin 3616d81180bSLoGin /// 设置文件是否在execve时关闭 3626d81180bSLoGin #[inline] 3636d81180bSLoGin pub fn set_close_on_exec(&mut self, close_on_exec: bool) { 3646d81180bSLoGin if close_on_exec { 3656d81180bSLoGin self.mode.insert(FileMode::O_CLOEXEC); 3666d81180bSLoGin } else { 3676d81180bSLoGin self.mode.remove(FileMode::O_CLOEXEC); 3686d81180bSLoGin } 3696d81180bSLoGin } 3706d81180bSLoGin 3716d81180bSLoGin pub fn set_mode(&mut self, mode: FileMode) -> Result<(), SystemError> { 3726d81180bSLoGin // todo: 是否需要调用inode的open方法,以更新private data(假如它与mode有关的话)? 3736d81180bSLoGin // 也许需要加个更好的设计,让inode知晓文件的打开模式发生了变化,让它自己决定是否需要更新private data 3746d81180bSLoGin 3756d81180bSLoGin // 直接修改文件的打开模式 3766d81180bSLoGin self.mode = mode; 3776d81180bSLoGin return Ok(()); 3786d81180bSLoGin } 3796d81180bSLoGin 3806d81180bSLoGin /// @brief 重新设置文件的大小 3816d81180bSLoGin /// 3826d81180bSLoGin /// 如果文件大小增加,则文件内容不变,但是文件的空洞部分会被填充为0 3836d81180bSLoGin /// 如果文件大小减小,则文件内容会被截断 3846d81180bSLoGin /// 3856d81180bSLoGin /// @return 成功:Ok() 3866d81180bSLoGin /// 失败:Err(错误码) 3871496ba7bSLoGin pub fn ftruncate(&self, len: usize) -> Result<(), SystemError> { 3886d81180bSLoGin // 如果文件不可写,返回错误 3896d81180bSLoGin self.writeable()?; 3906d81180bSLoGin 3916d81180bSLoGin // 调用inode的truncate方法 3926d81180bSLoGin self.inode.resize(len)?; 3936d81180bSLoGin return Ok(()); 3946d81180bSLoGin } 395004e86ffSlogin } 396004e86ffSlogin 397004e86ffSlogin impl Drop for File { 398004e86ffSlogin fn drop(&mut self) { 399676b8ef6SMork let r: Result<(), SystemError> = self.inode.close(&mut self.private_data); 400004e86ffSlogin // 打印错误信息 401004e86ffSlogin if r.is_err() { 402004e86ffSlogin kerror!( 4031496ba7bSLoGin "pid: {:?} failed to close file: {:?}, errno={:?}", 4041496ba7bSLoGin ProcessManager::current_pcb().pid(), 405004e86ffSlogin self, 406004e86ffSlogin r.unwrap_err() 407004e86ffSlogin ); 408004e86ffSlogin } 409004e86ffSlogin } 410004e86ffSlogin } 411004e86ffSlogin 412004e86ffSlogin /// @brief pcb里面的文件描述符数组 41364aea4b3SGou Ngai #[derive(Debug)] 414004e86ffSlogin pub struct FileDescriptorVec { 415004e86ffSlogin /// 当前进程打开的文件描述符 4161496ba7bSLoGin fds: [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD], 417004e86ffSlogin } 418004e86ffSlogin 419004e86ffSlogin impl FileDescriptorVec { 420*0d9b7d92SLoGin pub const PROCESS_MAX_FD: usize = 1024; 421004e86ffSlogin 4221496ba7bSLoGin pub fn new() -> FileDescriptorVec { 423004e86ffSlogin // 先声明一个未初始化的数组 4241496ba7bSLoGin let mut data: [MaybeUninit<Option<Arc<SpinLock<File>>>>; 4251496ba7bSLoGin FileDescriptorVec::PROCESS_MAX_FD] = unsafe { MaybeUninit::uninit().assume_init() }; 426004e86ffSlogin 427004e86ffSlogin // 逐个把每个元素初始化为None 428004e86ffSlogin for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 429004e86ffSlogin data[i] = MaybeUninit::new(None); 430004e86ffSlogin } 431004e86ffSlogin // 由于一切都初始化完毕,因此将未初始化的类型强制转换为已经初始化的类型 4321496ba7bSLoGin let data: [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD] = unsafe { 4331496ba7bSLoGin core::mem::transmute::< 4341496ba7bSLoGin _, 4351496ba7bSLoGin [Option<Arc<SpinLock<File>>>; FileDescriptorVec::PROCESS_MAX_FD], 4361496ba7bSLoGin >(data) 437004e86ffSlogin }; 438004e86ffSlogin 439004e86ffSlogin // 初始化文件描述符数组结构体 4401496ba7bSLoGin return FileDescriptorVec { fds: data }; 441004e86ffSlogin } 442004e86ffSlogin 44364aea4b3SGou Ngai /// @brief 克隆一个文件描述符数组 44464aea4b3SGou Ngai /// 4451496ba7bSLoGin /// @return FileDescriptorVec 克隆后的文件描述符数组 4461496ba7bSLoGin pub fn clone(&self) -> FileDescriptorVec { 4471496ba7bSLoGin let mut res = FileDescriptorVec::new(); 44864aea4b3SGou Ngai for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 44964aea4b3SGou Ngai if let Some(file) = &self.fds[i] { 4501496ba7bSLoGin if let Some(file) = file.lock().try_clone() { 4511496ba7bSLoGin res.fds[i] = Some(Arc::new(SpinLock::new(file))); 4521496ba7bSLoGin } 45364aea4b3SGou Ngai } 45464aea4b3SGou Ngai } 45564aea4b3SGou Ngai return res; 45664aea4b3SGou Ngai } 45764aea4b3SGou Ngai 458004e86ffSlogin /// @brief 判断文件描述符序号是否合法 459004e86ffSlogin /// 460004e86ffSlogin /// @return true 合法 461004e86ffSlogin /// 462004e86ffSlogin /// @return false 不合法 463004e86ffSlogin #[inline] 464004e86ffSlogin pub fn validate_fd(fd: i32) -> bool { 465004e86ffSlogin if fd < 0 || fd as usize > FileDescriptorVec::PROCESS_MAX_FD { 466004e86ffSlogin return false; 467004e86ffSlogin } else { 468004e86ffSlogin return true; 469004e86ffSlogin } 470004e86ffSlogin } 4711496ba7bSLoGin 4721496ba7bSLoGin /// 申请文件描述符,并把文件对象存入其中。 4731496ba7bSLoGin /// 4741496ba7bSLoGin /// ## 参数 4751496ba7bSLoGin /// 4761496ba7bSLoGin /// - `file` 要存放的文件对象 4771496ba7bSLoGin /// - `fd` 如果为Some(i32),表示指定要申请这个文件描述符,如果这个文件描述符已经被使用,那么返回EBADF 4781496ba7bSLoGin /// 4791496ba7bSLoGin /// ## 返回值 4801496ba7bSLoGin /// 4811496ba7bSLoGin /// - `Ok(i32)` 申请成功,返回申请到的文件描述符 4821496ba7bSLoGin /// - `Err(SystemError)` 申请失败,返回错误码,并且,file对象将被drop掉 4831496ba7bSLoGin pub fn alloc_fd(&mut self, file: File, fd: Option<i32>) -> Result<i32, SystemError> { 4841496ba7bSLoGin if fd.is_some() { 4851496ba7bSLoGin // 指定了要申请的文件描述符编号 4861496ba7bSLoGin let new_fd = fd.unwrap(); 4871496ba7bSLoGin let x = &mut self.fds[new_fd as usize]; 4881496ba7bSLoGin if x.is_none() { 4891496ba7bSLoGin *x = Some(Arc::new(SpinLock::new(file))); 4901496ba7bSLoGin return Ok(new_fd); 4911496ba7bSLoGin } else { 4921496ba7bSLoGin return Err(SystemError::EBADF); 4931496ba7bSLoGin } 4941496ba7bSLoGin } else { 4951496ba7bSLoGin // 没有指定要申请的文件描述符编号 4961496ba7bSLoGin for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 4971496ba7bSLoGin if self.fds[i].is_none() { 4981496ba7bSLoGin self.fds[i] = Some(Arc::new(SpinLock::new(file))); 4991496ba7bSLoGin return Ok(i as i32); 5001496ba7bSLoGin } 5011496ba7bSLoGin } 5021496ba7bSLoGin return Err(SystemError::EMFILE); 5031496ba7bSLoGin } 5041496ba7bSLoGin } 5051496ba7bSLoGin 5061496ba7bSLoGin /// 根据文件描述符序号,获取文件结构体的Arc指针 5071496ba7bSLoGin /// 5081496ba7bSLoGin /// ## 参数 5091496ba7bSLoGin /// 5101496ba7bSLoGin /// - `fd` 文件描述符序号 5111496ba7bSLoGin pub fn get_file_by_fd(&self, fd: i32) -> Option<Arc<SpinLock<File>>> { 5121496ba7bSLoGin if !FileDescriptorVec::validate_fd(fd) { 5131496ba7bSLoGin return None; 5141496ba7bSLoGin } 5151496ba7bSLoGin return self.fds[fd as usize].clone(); 5161496ba7bSLoGin } 5171496ba7bSLoGin 5181496ba7bSLoGin /// 释放文件描述符,同时关闭文件。 5191496ba7bSLoGin /// 5201496ba7bSLoGin /// ## 参数 5211496ba7bSLoGin /// 5221496ba7bSLoGin /// - `fd` 文件描述符序号 5231496ba7bSLoGin pub fn drop_fd(&mut self, fd: i32) -> Result<(), SystemError> { 5241496ba7bSLoGin // 判断文件描述符的数字是否超过限制 5251496ba7bSLoGin if !FileDescriptorVec::validate_fd(fd) { 5261496ba7bSLoGin return Err(SystemError::EBADF); 5271496ba7bSLoGin } 5281496ba7bSLoGin 52971474bc6SLoGin self.get_file_by_fd(fd).ok_or(SystemError::EBADF)?; 5301496ba7bSLoGin 5311496ba7bSLoGin // 把文件描述符数组对应位置设置为空 5321496ba7bSLoGin let file = self.fds[fd as usize].take().unwrap(); 53334e6d6c8Syuyi2439 5341496ba7bSLoGin assert!(Arc::strong_count(&file) == 1); 5351496ba7bSLoGin return Ok(()); 5361496ba7bSLoGin } 537876cb89eSGnoCiYeH 538876cb89eSGnoCiYeH pub fn iter(&self) -> FileDescriptorIterator { 539876cb89eSGnoCiYeH return FileDescriptorIterator::new(self); 540876cb89eSGnoCiYeH } 541876cb89eSGnoCiYeH 542876cb89eSGnoCiYeH pub fn close_on_exec(&mut self) { 543876cb89eSGnoCiYeH for i in 0..FileDescriptorVec::PROCESS_MAX_FD { 544876cb89eSGnoCiYeH if let Some(file) = &self.fds[i] { 545876cb89eSGnoCiYeH let to_drop = file.lock().close_on_exec(); 546876cb89eSGnoCiYeH if to_drop { 547876cb89eSGnoCiYeH let r = self.drop_fd(i as i32); 548876cb89eSGnoCiYeH if let Err(r) = r { 549876cb89eSGnoCiYeH kerror!( 550876cb89eSGnoCiYeH "Failed to close file: pid = {:?}, fd = {}, error = {:?}", 551876cb89eSGnoCiYeH ProcessManager::current_pcb().pid(), 552876cb89eSGnoCiYeH i, 553876cb89eSGnoCiYeH r 554876cb89eSGnoCiYeH ); 555876cb89eSGnoCiYeH } 556876cb89eSGnoCiYeH } 557876cb89eSGnoCiYeH } 558876cb89eSGnoCiYeH } 559876cb89eSGnoCiYeH } 560876cb89eSGnoCiYeH } 561876cb89eSGnoCiYeH 562876cb89eSGnoCiYeH #[derive(Debug)] 563876cb89eSGnoCiYeH pub struct FileDescriptorIterator<'a> { 564876cb89eSGnoCiYeH fds: &'a FileDescriptorVec, 565876cb89eSGnoCiYeH index: usize, 566876cb89eSGnoCiYeH } 567876cb89eSGnoCiYeH 568876cb89eSGnoCiYeH impl<'a> FileDescriptorIterator<'a> { 569876cb89eSGnoCiYeH pub fn new(fds: &'a FileDescriptorVec) -> Self { 570876cb89eSGnoCiYeH return Self { fds, index: 0 }; 571876cb89eSGnoCiYeH } 572876cb89eSGnoCiYeH } 573876cb89eSGnoCiYeH 574876cb89eSGnoCiYeH impl<'a> Iterator for FileDescriptorIterator<'a> { 575876cb89eSGnoCiYeH type Item = (i32, Arc<SpinLock<File>>); 576876cb89eSGnoCiYeH 577876cb89eSGnoCiYeH fn next(&mut self) -> Option<Self::Item> { 578876cb89eSGnoCiYeH while self.index < FileDescriptorVec::PROCESS_MAX_FD { 579876cb89eSGnoCiYeH let fd = self.index as i32; 580876cb89eSGnoCiYeH self.index += 1; 581876cb89eSGnoCiYeH if let Some(file) = self.fds.get_file_by_fd(fd) { 582876cb89eSGnoCiYeH return Some((fd, file)); 583876cb89eSGnoCiYeH } 584876cb89eSGnoCiYeH } 585876cb89eSGnoCiYeH return None; 586876cb89eSGnoCiYeH } 587004e86ffSlogin } 588