diqiu50 commented on code in PR #5835: URL: https://github.com/apache/gravitino/pull/5835#discussion_r1881940837
########## 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: Some time, you want to write n bytes. actually the m bytes can be written. so we need return the number of written bytes. -- 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]
