FANNG1 commented on code in PR #5835: URL: https://github.com/apache/gravitino/pull/5835#discussion_r1883200647
########## clients/filesystem-fuse/src/filesystem.rs: ########## @@ -0,0 +1,236 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +use async_trait::async_trait; +use bytes::Bytes; +use fuse3::{Errno, FileType, Timestamp}; + +pub(crate) type Result<T> = std::result::Result<T, Errno>; + +/// RawFileSystem interface for the file system implementation. it use by FuseApiHandle, +/// it ues the file id to operate the file system apis +/// the `file_id` and `parent_file_id` it is the unique identifier for the file system, +/// it is used to identify the file or directory +/// the `handle_id` it is the file handle, it is used to identify the opened file, +/// it is used to read or write the file content +/// the `file id` and `handle_id` need to mapping the `ino`/`inode` and `fh` in the fuse3 +#[async_trait] +pub(crate) trait RawFileSystem: Send + Sync { + /// Init the file system + async fn init(&self); + + /// Get the file path by file id + async fn get_file_path(&self, file_id: u64) -> String; + + /// Validate the file id and file handle, if the file id or file handle is invalid, return error + async fn valid_file_id(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Get the file stat by file id + async fn stat(&self, file_id: u64) -> Result<FileStat>; + + /// Get the file stat by parent file id and file name + async fn lookup(&self, parent_file_id: u64, name: &str) -> Result<FileStat>; + + /// Read the directory by file id + async fn read_dir(&self, dir_file_id: u64) -> Result<Vec<FileStat>>; + + /// Open the file by file id and flags + async fn open_file(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Open the directory by file id and flags + async fn open_dir(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Create the file by parent file id and file name and flags + async fn create_file(&self, parent_file_id: u64, name: &str, flags: u32) -> Result<FileHandle>; + + /// Create the directory by parent file id and file name + async fn create_dir(&self, parent_file_id: u64, name: &str) -> Result<FileHandle>; + + /// Set the file attribute by file id and file stat + async fn set_attr(&self, file_id: u64, file_stat: &FileStat) -> Result<()>; + + /// Remove the file by parent file id and file name + async fn remove_file(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Remove the directory by parent file id and file name + async fn remove_dir(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Close the file by file id and file handle + async fn close_file(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Read the file content by file id, file handle, offset and size + async fn read(&self, file_id: u64, fh: u64, offset: u64, size: u32) -> Result<Bytes>; + + /// Write the file content by file id, file handle, offset and data + async fn write(&self, file_id: u64, fh: u64, offset: u64, data: &[u8]) -> Result<u32>; +} + +/// PathFileSystem is the interface for the file system implementation, it use to interact with other file system +/// it is used file path to operate the file system +#[async_trait] +pub(crate) trait PathFileSystem: Send + Sync { + /// Init the file system + async fn init(&self); + + /// Get the file stat by file path + async fn stat(&self, name: &str) -> Result<FileStat>; + + /// Get the file stat by parent file path and file name + async fn lookup(&self, parent: &str, name: &str) -> Result<FileStat>; + + /// Read the directory by file path + async fn read_dir(&self, name: &str) -> Result<Vec<FileStat>>; + + /// Open the file by file path and flags + async fn open_file(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>; + + /// Open the directory by file path and flags + async fn open_dir(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>; + + /// Create the file by parent file path and file name and flags + async fn create_file( + &self, + parent: &str, + name: &str, + flags: OpenFileFlags, + ) -> Result<OpenedFile>; + + /// Create the directory by parent file path and file name + async fn create_dir(&self, parent: &str, name: &str) -> Result<OpenedFile>; Review Comment: should return open file here? ########## clients/filesystem-fuse/src/filesystem.rs: ########## @@ -0,0 +1,236 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +use async_trait::async_trait; +use bytes::Bytes; +use fuse3::{Errno, FileType, Timestamp}; + +pub(crate) type Result<T> = std::result::Result<T, Errno>; + +/// RawFileSystem interface for the file system implementation. it use by FuseApiHandle, +/// it ues the file id to operate the file system apis +/// the `file_id` and `parent_file_id` it is the unique identifier for the file system, +/// it is used to identify the file or directory +/// the `handle_id` it is the file handle, it is used to identify the opened file, +/// it is used to read or write the file content +/// the `file id` and `handle_id` need to mapping the `ino`/`inode` and `fh` in the fuse3 +#[async_trait] +pub(crate) trait RawFileSystem: Send + Sync { + /// Init the file system + async fn init(&self); + + /// Get the file path by file id + async fn get_file_path(&self, file_id: u64) -> String; + + /// Validate the file id and file handle, if the file id or file handle is invalid, return error + async fn valid_file_id(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Get the file stat by file id + async fn stat(&self, file_id: u64) -> Result<FileStat>; + + /// Get the file stat by parent file id and file name + async fn lookup(&self, parent_file_id: u64, name: &str) -> Result<FileStat>; + + /// Read the directory by file id + async fn read_dir(&self, dir_file_id: u64) -> Result<Vec<FileStat>>; + + /// Open the file by file id and flags + async fn open_file(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Open the directory by file id and flags + async fn open_dir(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Create the file by parent file id and file name and flags + async fn create_file(&self, parent_file_id: u64, name: &str, flags: u32) -> Result<FileHandle>; + + /// Create the directory by parent file id and file name + async fn create_dir(&self, parent_file_id: u64, name: &str) -> Result<FileHandle>; + + /// Set the file attribute by file id and file stat + async fn set_attr(&self, file_id: u64, file_stat: &FileStat) -> Result<()>; + + /// Remove the file by parent file id and file name + async fn remove_file(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Remove the directory by parent file id and file name + async fn remove_dir(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Close the file by file id and file handle + async fn close_file(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Read the file content by file id, file handle, offset and size + async fn read(&self, file_id: u64, fh: u64, offset: u64, size: u32) -> Result<Bytes>; + + /// Write the file content by file id, file handle, offset and data + async fn write(&self, file_id: u64, fh: u64, offset: u64, data: &[u8]) -> Result<u32>; +} + +/// PathFileSystem is the interface for the file system implementation, it use to interact with other file system +/// it is used file path to operate the file system +#[async_trait] +pub(crate) trait PathFileSystem: Send + Sync { + /// Init the file system + async fn init(&self); + + /// Get the file stat by file path + async fn stat(&self, name: &str) -> Result<FileStat>; + + /// Get the file stat by parent file path and file name + async fn lookup(&self, parent: &str, name: &str) -> Result<FileStat>; + + /// Read the directory by file path + async fn read_dir(&self, name: &str) -> Result<Vec<FileStat>>; + + /// Open the file by file path and flags + async fn open_file(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>; + + /// Open the directory by file path and flags + async fn open_dir(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>; + + /// Create the file by parent file path and file name and flags + async fn create_file( + &self, + parent: &str, + name: &str, + flags: OpenFileFlags, + ) -> Result<OpenedFile>; + + /// Create the directory by parent file path and file name + async fn create_dir(&self, parent: &str, name: &str) -> Result<OpenedFile>; + + /// Set the file attribute by file path and file stat + async fn set_attr(&self, name: &str, file_stat: &FileStat, flush: bool) -> Result<()>; + + /// Remove the file by parent file path and file name + async fn remove_file(&self, parent: &str, name: &str) -> Result<()>; + + /// Remove the directory by parent file path and file name + async fn remove_dir(&self, parent: &str, name: &str) -> Result<()>; +} + +pub(crate) struct FileSystemContext { + // system user id + pub(crate) uid: u32, + + // system group id + pub(crate) gid: u32, + + // default file permission + pub(crate) default_file_perm: u16, + + // default idr permission + pub(crate) default_dir_perm: u16, + + // io block size + pub(crate) block_size: u32, +} + +// FileSystemContext is the file system context for the file system implementation. +impl FileSystemContext { + pub(crate) fn new(uid: u32, gid: u32) -> Self { + FileSystemContext { + uid, + gid, + default_file_perm: 0o644, + default_dir_perm: 0o755, + block_size: 4 * 1024, + } + } +} + +// FileStat is the file stat for the file system. +#[derive(Clone, Debug)] +pub struct FileStat { + // file id for the file system. + pub(crate) file_id: u64, + + // parent file id + pub(crate) parent_file_id: u64, + + // file name + pub(crate) name: String, + + // file path of the fuse file system root + pub(crate) path: String, + + // file size + pub(crate) size: u64, + + // file type like regular file or directory and so on + pub(crate) kind: FileType, + + // file permission + pub(crate) perm: u16, + + // file access time + pub(crate) atime: Timestamp, + + // file modify time + pub(crate) mtime: Timestamp, + + // file create time + pub(crate) ctime: Timestamp, + + // file link count + pub(crate) nlink: u32, Review Comment: do we need `nlink`? ########## clients/filesystem-fuse/src/fuse_api_handle.rs: ########## @@ -0,0 +1,448 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use crate::filesystem::{FileStat, FileSystemContext, RawFileSystem}; +use fuse3::path::prelude::{ReplyData, ReplyOpen, ReplyStatFs, ReplyWrite}; +use fuse3::path::Request; +use fuse3::raw::prelude::{ + FileAttr, ReplyAttr, ReplyCreated, ReplyDirectory, ReplyDirectoryPlus, ReplyEntry, ReplyInit, +}; +use fuse3::raw::reply::{DirectoryEntry, DirectoryEntryPlus}; +use fuse3::raw::Filesystem; +use fuse3::FileType::{Directory, RegularFile}; +use fuse3::{Errno, FileType, Inode, SetAttr, Timestamp}; +use futures_util::stream; +use futures_util::stream::BoxStream; +use futures_util::StreamExt; +use std::ffi::{OsStr, OsString}; +use std::num::NonZeroU32; +use std::time::{Duration, SystemTime}; + +pub(crate) struct FuseApiHandle<T: RawFileSystem> { + local_fs: T, + default_ttl: Duration, + fs_context: FileSystemContext, +} + +impl<T: RawFileSystem> FuseApiHandle<T> { + const DEFAULT_TTL: Duration = Duration::from_secs(1); + const DEFAULT_MAX_WRITE: u32 = 16 * 1024; + + pub fn new(fs: T, context: FileSystemContext) -> Self { + Self { + local_fs: fs, + default_ttl: Self::DEFAULT_TTL, + fs_context: context, + } + } + + pub async fn get_file_path(&self, file_id: u64) -> String { + self.local_fs.get_file_path(file_id).await + } + + async fn get_modified_file_stat( + &self, + file_id: u64, + size: Option<u64>, + atime: Option<Timestamp>, + mtime: Option<Timestamp>, + ) -> Result<FileStat, Errno> { + let mut file_stat = self.local_fs.stat(file_id).await?; + + if let Some(size) = size { + file_stat.size = size; + }; + + if let Some(atime) = atime { + file_stat.atime = atime; + }; + + if let Some(mtime) = mtime { + file_stat.mtime = mtime; + }; + + Ok(file_stat) + } +} + +impl<T: RawFileSystem> Filesystem for FuseApiHandle<T> { + async fn init(&self, _req: Request) -> fuse3::Result<ReplyInit> { + self.local_fs.init().await; + Ok(ReplyInit { + max_write: NonZeroU32::new(Self::DEFAULT_MAX_WRITE).unwrap(), + }) + } + + async fn destroy(&self, _req: Request) { + //TODO need to call the destroy method of the local_fs + } + + async fn lookup( + &self, + _req: Request, + parent: Inode, + name: &OsStr, + ) -> fuse3::Result<ReplyEntry> { + let name = name.to_string_lossy(); + let file_stat = self.local_fs.lookup(parent, &name).await?; + Ok(ReplyEntry { + ttl: self.default_ttl, + attr: fstat_to_file_attr(&file_stat, &self.fs_context), + generation: 0, + }) + } + + async fn getattr( + &self, + _req: Request, + inode: Inode, + fh: Option<u64>, + _flags: u32, + ) -> fuse3::Result<ReplyAttr> { + // check the opened file inode is the same as the inode + if let Some(fh) = fh { + self.local_fs.valid_file_id(inode, fh).await?; + } + + let file_stat = self.local_fs.stat(inode).await?; + Ok(ReplyAttr { + ttl: self.default_ttl, + attr: fstat_to_file_attr(&file_stat, &self.fs_context), + }) + } + + async fn setattr( + &self, + _req: Request, + inode: Inode, + _fh: Option<u64>, + set_attr: SetAttr, + ) -> fuse3::Result<ReplyAttr> { + let new_file_stat = self + .get_modified_file_stat(inode, set_attr.size, set_attr.atime, set_attr.mtime) + .await?; + let attr = fstat_to_file_attr(&new_file_stat, &self.fs_context); + self.local_fs.set_attr(inode, &new_file_stat).await?; + Ok(ReplyAttr { + ttl: self.default_ttl, + attr: attr, + }) + } + + async fn mkdir( + &self, + _req: Request, + parent: Inode, + name: &OsStr, + _mode: u32, + _umask: u32, + ) -> fuse3::Result<ReplyEntry> { + let name = name.to_string_lossy(); + let handle_id = self.local_fs.create_dir(parent, &name).await?; + Ok(ReplyEntry { + ttl: self.default_ttl, + attr: dummy_file_attr( + handle_id.file_id, + Directory, + Timestamp::from(SystemTime::now()), + &self.fs_context, + ), + generation: 0, + }) + } + + async fn unlink(&self, _req: Request, parent: Inode, name: &OsStr) -> fuse3::Result<()> { + let name = name.to_string_lossy(); + self.local_fs.remove_file(parent, &name).await?; + Ok(()) + } + + async fn rmdir(&self, _req: Request, parent: Inode, name: &OsStr) -> fuse3::Result<()> { + let name = name.to_string_lossy(); + self.local_fs.remove_dir(parent, &name).await?; + Ok(()) + } + + async fn open(&self, _req: Request, inode: Inode, flags: u32) -> fuse3::Result<ReplyOpen> { + let file_handle = self.local_fs.open_file(inode, flags).await?; + Ok(ReplyOpen { + fh: file_handle.handle_id, + flags: flags, + }) + } + + async fn read( + &self, + _req: Request, + inode: Inode, + fh: u64, + offset: u64, + size: u32, + ) -> fuse3::Result<ReplyData> { + let data = self.local_fs.read(inode, fh, offset, size).await?; + Ok(ReplyData { data: data }) + } + + async fn write( + &self, + _req: Request, + inode: Inode, + fh: u64, + offset: u64, + data: &[u8], + _write_flags: u32, + _flags: u32, + ) -> fuse3::Result<ReplyWrite> { + let written = self.local_fs.write(inode, fh, offset, data).await?; + Ok(ReplyWrite { written: written }) + } + + async fn statfs(&self, _req: Request, _inode: Inode) -> fuse3::Result<ReplyStatFs> { + //TODO: Implement statfs for the filesystem + Ok(ReplyStatFs { + blocks: 1000000, + bfree: 1000000, + bavail: 1000000, + files: 1000000, + ffree: 1000000, + bsize: 4096, + namelen: 255, + frsize: 4096, + }) + } + + async fn release( + &self, + _eq: Request, + inode: Inode, + fh: u64, + _flags: u32, + _lock_owner: u64, + _flush: bool, + ) -> fuse3::Result<()> { + self.local_fs.close_file(inode, fh).await + } + + async fn opendir(&self, _req: Request, inode: Inode, flags: u32) -> fuse3::Result<ReplyOpen> { + let file_handle = self.local_fs.open_dir(inode, flags).await?; + Ok(ReplyOpen { + fh: file_handle.handle_id, + flags: flags, + }) + } + + type DirEntryStream<'a> + = BoxStream<'a, fuse3::Result<DirectoryEntry>> + where + T: 'a; + + #[allow(clippy::needless_lifetimes)] + async fn readdir<'a>( + &'a self, + _req: Request, + parent: Inode, + _fh: u64, + offset: i64, + ) -> fuse3::Result<ReplyDirectory<Self::DirEntryStream<'a>>> { + let current = self.local_fs.stat(parent).await?; + let files = self.local_fs.read_dir(parent).await?; + let entries_stream = + stream::iter(files.into_iter().enumerate().map(|(index, file_stat)| { + Ok(DirectoryEntry { + inode: file_stat.file_id, + name: file_stat.name.clone().into(), + kind: file_stat.kind, + offset: (index + 3) as i64, + }) + })); + + let relative_paths = stream::iter([ + Ok(DirectoryEntry { + inode: current.file_id, + name: ".".into(), + kind: Directory, + offset: 1, + }), + Ok(DirectoryEntry { + inode: current.parent_file_id, + name: "..".into(), + kind: Directory, + offset: 2, + }), + ]); + + let combined_stream = relative_paths.chain(entries_stream); + Ok(ReplyDirectory { + entries: combined_stream.skip(offset as usize).boxed(), Review Comment: ok ########## clients/filesystem-fuse/src/filesystem.rs: ########## @@ -0,0 +1,236 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +use async_trait::async_trait; +use bytes::Bytes; +use fuse3::{Errno, FileType, Timestamp}; + +pub(crate) type Result<T> = std::result::Result<T, Errno>; + +/// RawFileSystem interface for the file system implementation. it use by FuseApiHandle, +/// it ues the file id to operate the file system apis +/// the `file_id` and `parent_file_id` it is the unique identifier for the file system, +/// it is used to identify the file or directory +/// the `handle_id` it is the file handle, it is used to identify the opened file, +/// it is used to read or write the file content +/// the `file id` and `handle_id` need to mapping the `ino`/`inode` and `fh` in the fuse3 +#[async_trait] +pub(crate) trait RawFileSystem: Send + Sync { + /// Init the file system + async fn init(&self); + + /// Get the file path by file id + async fn get_file_path(&self, file_id: u64) -> String; + + /// Validate the file id and file handle, if the file id or file handle is invalid, return error + async fn valid_file_id(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Get the file stat by file id + async fn stat(&self, file_id: u64) -> Result<FileStat>; + + /// Get the file stat by parent file id and file name + async fn lookup(&self, parent_file_id: u64, name: &str) -> Result<FileStat>; + + /// Read the directory by file id + async fn read_dir(&self, dir_file_id: u64) -> Result<Vec<FileStat>>; + + /// Open the file by file id and flags + async fn open_file(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Open the directory by file id and flags + async fn open_dir(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Create the file by parent file id and file name and flags + async fn create_file(&self, parent_file_id: u64, name: &str, flags: u32) -> Result<FileHandle>; + + /// Create the directory by parent file id and file name + async fn create_dir(&self, parent_file_id: u64, name: &str) -> Result<FileHandle>; + + /// Set the file attribute by file id and file stat + async fn set_attr(&self, file_id: u64, file_stat: &FileStat) -> Result<()>; + + /// Remove the file by parent file id and file name + async fn remove_file(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Remove the directory by parent file id and file name + async fn remove_dir(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Close the file by file id and file handle + async fn close_file(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Read the file content by file id, file handle, offset and size + async fn read(&self, file_id: u64, fh: u64, offset: u64, size: u32) -> Result<Bytes>; + + /// Write the file content by file id, file handle, offset and data + async fn write(&self, file_id: u64, fh: u64, offset: u64, data: &[u8]) -> Result<u32>; Review Comment: please add this to the document ########## clients/filesystem-fuse/src/fuse_api_handle.rs: ########## @@ -0,0 +1,507 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use crate::filesystem::{FileStat, FileSystemContext, RawFileSystem}; +use fuse3::path::prelude::{ReplyData, ReplyOpen, ReplyStatFs, ReplyWrite}; +use fuse3::path::Request; +use fuse3::raw::prelude::{ + FileAttr, ReplyAttr, ReplyCreated, ReplyDirectory, ReplyDirectoryPlus, ReplyEntry, ReplyInit, +}; +use fuse3::raw::reply::{DirectoryEntry, DirectoryEntryPlus}; +use fuse3::raw::Filesystem; +use fuse3::FileType::{Directory, RegularFile}; +use fuse3::{Errno, FileType, Inode, SetAttr, Timestamp}; +use futures_util::stream; +use futures_util::stream::BoxStream; +use futures_util::StreamExt; +use std::ffi::{OsStr, OsString}; +use std::num::NonZeroU32; +use std::time::{Duration, SystemTime}; + +pub(crate) struct FuseApiHandle<T: RawFileSystem> { + fs: T, + default_ttl: Duration, + fs_context: FileSystemContext, +} + +impl<T: RawFileSystem> FuseApiHandle<T> { + const DEFAULT_ATTR_TTL: Duration = Duration::from_secs(1); + const DEFAULT_MAX_WRITE_SIZE: u32 = 16 * 1024; + + pub fn new(fs: T, context: FileSystemContext) -> Self { + Self { + fs: fs, + default_ttl: Self::DEFAULT_ATTR_TTL, + fs_context: context, + } + } + + pub async fn get_file_path(&self, file_id: u64) -> String { + self.fs.get_file_path(file_id).await + } + + async fn get_modified_file_stat( + &self, + file_id: u64, + size: Option<u64>, + atime: Option<Timestamp>, + mtime: Option<Timestamp>, + ) -> Result<FileStat, Errno> { + let mut file_stat = self.fs.stat(file_id).await?; + + if let Some(size) = size { + file_stat.size = size; + }; + + if let Some(atime) = atime { + file_stat.atime = atime; + }; + + if let Some(mtime) = mtime { + file_stat.mtime = mtime; + }; + + Ok(file_stat) + } +} + +impl<T: RawFileSystem> Filesystem for FuseApiHandle<T> { + async fn init(&self, _req: Request) -> fuse3::Result<ReplyInit> { + self.fs.init().await; + Ok(ReplyInit { + max_write: NonZeroU32::new(Self::DEFAULT_MAX_WRITE_SIZE).unwrap(), + }) + } + + async fn destroy(&self, _req: Request) { + //TODO need to call the destroy method of the local_fs + } + + async fn lookup( + &self, + _req: Request, + parent: Inode, + name: &OsStr, + ) -> fuse3::Result<ReplyEntry> { + let name = name.to_string_lossy(); + let file_stat = self.fs.lookup(parent, &name).await?; + Ok(ReplyEntry { + ttl: self.default_ttl, + attr: fstat_to_file_attr(&file_stat, &self.fs_context), + generation: 0, + }) + } + + async fn getattr( + &self, + _req: Request, + inode: Inode, + fh: Option<u64>, + _flags: u32, + ) -> fuse3::Result<ReplyAttr> { + // check the opened file file_id is the same as the inode + if let Some(fh) = fh { + self.fs.valid_file_id(inode, fh).await?; + } + + let file_stat = self.fs.stat(inode).await?; + Ok(ReplyAttr { + ttl: self.default_ttl, + attr: fstat_to_file_attr(&file_stat, &self.fs_context), + }) + } + + async fn setattr( + &self, + _req: Request, + inode: Inode, + fh: Option<u64>, + set_attr: SetAttr, + ) -> fuse3::Result<ReplyAttr> { + // check the opened file file_id is the same as the inode Review Comment: please add the comment to the interface of `valid_file_id `, no need to add the comment for the invoked places. change the comment to `Verify the equality between the file_id of the opened file and the inode.`？ ########## clients/filesystem-fuse/src/filesystem.rs: ########## @@ -0,0 +1,236 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +use async_trait::async_trait; +use bytes::Bytes; +use fuse3::{Errno, FileType, Timestamp}; + +pub(crate) type Result<T> = std::result::Result<T, Errno>; + +/// RawFileSystem interface for the file system implementation. it use by FuseApiHandle, +/// it ues the file id to operate the file system apis +/// the `file_id` and `parent_file_id` it is the unique identifier for the file system, +/// it is used to identify the file or directory +/// the `handle_id` it is the file handle, it is used to identify the opened file, +/// it is used to read or write the file content +/// the `file id` and `handle_id` need to mapping the `ino`/`inode` and `fh` in the fuse3 +#[async_trait] +pub(crate) trait RawFileSystem: Send + Sync { + /// Init the file system + async fn init(&self); + + /// Get the file path by file id + async fn get_file_path(&self, file_id: u64) -> String; + + /// Validate the file id and file handle, if the file id or file handle is invalid, return error + async fn valid_file_id(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Get the file stat by file id + async fn stat(&self, file_id: u64) -> Result<FileStat>; + + /// Get the file stat by parent file id and file name + async fn lookup(&self, parent_file_id: u64, name: &str) -> Result<FileStat>; + + /// Read the directory by file id + async fn read_dir(&self, dir_file_id: u64) -> Result<Vec<FileStat>>; + + /// Open the file by file id and flags + async fn open_file(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Open the directory by file id and flags + async fn open_dir(&self, file_id: u64, flags: u32) -> Result<FileHandle>; + + /// Create the file by parent file id and file name and flags + async fn create_file(&self, parent_file_id: u64, name: &str, flags: u32) -> Result<FileHandle>; + + /// Create the directory by parent file id and file name + async fn create_dir(&self, parent_file_id: u64, name: &str) -> Result<FileHandle>; + + /// Set the file attribute by file id and file stat + async fn set_attr(&self, file_id: u64, file_stat: &FileStat) -> Result<()>; + + /// Remove the file by parent file id and file name + async fn remove_file(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Remove the directory by parent file id and file name + async fn remove_dir(&self, parent_file_id: u64, name: &str) -> Result<()>; + + /// Close the file by file id and file handle + async fn close_file(&self, file_id: u64, fh: u64) -> Result<()>; + + /// Read the file content by file id, file handle, offset and size + async fn read(&self, file_id: u64, fh: u64, offset: u64, size: u32) -> Result<Bytes>; + + /// Write the file content by file id, file handle, offset and data + async fn write(&self, file_id: u64, fh: u64, offset: u64, data: &[u8]) -> Result<u32>; +} + +/// PathFileSystem is the interface for the file system implementation, it use to interact with other file system +/// it is used file path to operate the file system +#[async_trait] +pub(crate) trait PathFileSystem: Send + Sync { + /// Init the file system + async fn init(&self); + + /// Get the file stat by file path + async fn stat(&self, name: &str) -> Result<FileStat>; + + /// Get the file stat by parent file path and file name + async fn lookup(&self, parent: &str, name: &str) -> Result<FileStat>; + + /// Read the directory by file path + async fn read_dir(&self, name: &str) -> Result<Vec<FileStat>>; + + /// Open the file by file path and flags + async fn open_file(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>; + + /// Open the directory by file path and flags + async fn open_dir(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>; + + /// Create the file by parent file path and file name and flags + async fn create_file( + &self, + parent: &str, + name: &str, + flags: OpenFileFlags, + ) -> Result<OpenedFile>; + + /// Create the directory by parent file path and file name + async fn create_dir(&self, parent: &str, name: &str) -> Result<OpenedFile>; + + /// Set the file attribute by file path and file stat + async fn set_attr(&self, name: &str, file_stat: &FileStat, flush: bool) -> Result<()>; + + /// Remove the file by parent file path and file name + async fn remove_file(&self, parent: &str, name: &str) -> Result<()>; + + /// Remove the directory by parent file path and file name + async fn remove_dir(&self, parent: &str, name: &str) -> Result<()>; +} + +pub(crate) struct FileSystemContext { + // system user id + pub(crate) uid: u32, + + // system group id + pub(crate) gid: u32, + + // default file permission + pub(crate) default_file_perm: u16, + + // default idr permission + pub(crate) default_dir_perm: u16, + + // io block size + pub(crate) block_size: u32, +} + +// FileSystemContext is the file system context for the file system implementation. +impl FileSystemContext { + pub(crate) fn new(uid: u32, gid: u32) -> Self { + FileSystemContext { + uid, + gid, + default_file_perm: 0o644, + default_dir_perm: 0o755, + block_size: 4 * 1024, + } + } +} + +// FileStat is the file stat for the file system. Review Comment: There are too many file systems, please specify which file system. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
