scorpiofs 0.2.3

use std::{
    collections::HashMap,
    io::Error,
    path::{Path, PathBuf},
    sync::Arc,
};

use inode_alloc::InodeAlloc;
use libfuse_fs::{
    overlayfs::{config, OverlayFs},
    passthrough::{new_passthroughfs_layer, PassthroughArgs},
};
use rfuse3::raw::{Filesystem, Request};
use tokio::sync::Mutex;

use crate::{
    dicfuse::{Dicfuse, DicfuseManager},
    manager::ScorpioManager,
    util::config as sconfig,
};

mod async_io;
mod inode_alloc;

/// A struct representing the MegaFuse system, which handles the creation
/// and management of overlay filesystems (OverlayFs). This includes
/// mounting and unmounting operations, as well as inode allocation and
/// other filesystem-related functionalities.
///
/// The `MegaFuse` struct contains the following:
/// - `dic`: A reference-counted pointer to the Dicfuse system for dictionary-based operations.
/// - `overlayfs`: A Mutex-wrapped `HashMap` storing the overlay filesystems for each inode.
/// - `inodes_alloc`: A struct responsible for allocating inodes.
#[allow(unused)]
#[derive(Clone)]
pub struct MegaFuse {
    pub dic: Arc<Dicfuse>,
    overlayfs: Arc<Mutex<HashMap<u64, Arc<OverlayFs>>>>, // Inode -> overlayyfs
    inodes_alloc: InodeAlloc,
}

#[allow(unused)]
impl MegaFuse {
    /// Creates a new instance of `MegaFuse` asynchronously.
    ///
    /// This function initializes the `dic`, `overlayfs`, and `inodes_alloc` fields
    /// of the `MegaFuse` struct. It is used for creating a base `MegaFuse` object
    /// before performing additional setup or mounting operations.
    ///
    /// # Returns
    /// A new `MegaFuse` instance.
    pub async fn new() -> Self {
        Self {
            // Use the global Dicfuse singleton to avoid sled DB lock conflicts and duplicate imports
            // when Scorpio daemon also hosts Antares (which relies on DicfuseManager).
            dic: DicfuseManager::global().await,
            overlayfs: Arc::new(Mutex::new(HashMap::new())),
            inodes_alloc: InodeAlloc::new(),
        }
    }
    /// Creates a new instance of `MegaFuse` from a given manager asynchronously.
    ///
    /// This function creates a new `MegaFuse` instance and then performs mount operations
    /// for directories based on the provided `ScorpioManager`. It mounts the user's work
    /// directories by using information from the manager and sets up the necessary overlay filesystems.
    ///
    /// # Parameters
    /// - `manager`: A reference to a `ScorpioManager` instance that holds the store path and works to mount.
    ///
    /// # Returns
    /// A new `MegaFuse` instance with mounted overlay filesystems based on the manager's configuration.
    pub async fn new_from_manager(manager: &ScorpioManager) -> MegaFuse {
        let megafuse = MegaFuse::new().await;
        let store_path = sconfig::store_path();

        // mount user works.
        for dir in &manager.works {
            let _lower = PathBuf::from(store_path).join(&dir.hash);
            megafuse
                .overlay_mount(dir.node, &_lower, false, None)
                .await
                .unwrap();
        }

        megafuse
    }

    /// Mounts an overlay filesystem at a specified path asynchronously.
    ///
    /// This function sets up a layered overlay filesystem at the given `store_path`, with
    /// specified lower and upper directories for the filesystem layers. It ensures the proper
    /// creation of directories and clears the contents of the upper layer if necessary.
    ///
    /// # Parameters
    /// - `inode`: The inode to associate with the overlay filesystem.
    /// - `store_path`: The path where the overlay filesystem should be mounted.
    /// - `need_cl`: Used for creating the CL layer.
    /// - `cl_link`: Optional CL link identifier. When provided with `need_cl=true`, determines the subdirectory name for the CL layer.
    ///
    /// # Returns
    /// A result indicating whether the mounting operation was successful.
    pub async fn overlay_mount<P: AsRef<Path>>(
        &self,
        inode: u64,
        store_path: P,
        need_cl: bool, // if need cl, then create cl layer.
        cl_link: Option<&str>,
    ) -> std::io::Result<()> {
        // Set up the directory structure
        let lower = store_path.as_ref().join("lower");
        let upper = store_path.as_ref().join("upper");
        let mut lowerdir = vec![lower];

        // If a CL layer is needed, create a directory bound to cl_link.
        if need_cl {
            if let Some(link) = cl_link {
                let cl_path = store_path.as_ref().join("cl").join(link);
                std::fs::create_dir_all(&cl_path)?;
                lowerdir.insert(0, cl_path);
            }
        }
        let upperdir = upper;

        let config = config::Config {
            mountpoint: PathBuf::new(),
            do_import: true,
            ..Default::default()
        };

        // Create lower layers
        let mut lower_layers = Vec::new();
        for lower in &lowerdir {
            let lower_path = Path::new(lower);
            if lower_path.exists() {
                let layer = new_passthroughfs_layer(PassthroughArgs {
                    root_dir: lower.clone(),
                    mapping: None::<String>,
                })
                .await?;
                lower_layers.push(Arc::new(layer));
                // Rest of the code...
            } else {
                std::fs::create_dir_all(lower_path)?;
                let layer = new_passthroughfs_layer(PassthroughArgs {
                    root_dir: lower.clone(),
                    mapping: None::<String>,
                })
                .await?;
                lower_layers.push(Arc::new(layer));
            }
        }

        // Check if the upper directory exists
        let upper_path = Path::new(&upperdir);
        if !upper_path.exists() {
            // Create the upper directory if it doesn't exist
            std::fs::create_dir_all(&upperdir)?;
        } else {
            // Clear the contents of the upper directory`
            let entries = std::fs::read_dir(&upperdir)?;
            for entry in entries {
                let entry = entry?;
                if entry.file_type()?.is_dir() {
                    std::fs::remove_dir_all(entry.path())?;
                } else {
                    std::fs::remove_file(entry.path())?;
                }
            }
        }

        // Create upper layer
        let upper_layer = Arc::new(
            new_passthroughfs_layer(PassthroughArgs {
                root_dir: upperdir.clone(),
                mapping: None::<String>,
            })
            .await?,
        );
        let overlayfs = OverlayFs::new(Some(upper_layer), lower_layers, config, inode)?;
        self.overlayfs
            .lock()
            .await
            .insert(inode, Arc::new(overlayfs));
        self.after_mount_new().await;
        Ok(())
    }

    /// Removes the CL (Change List) layer data from disk for a given store path and CL link.
    ///
    /// This function deletes the CL layer directory located at `store_path/cl/cl_link`.
    /// It's used to clean up CL data after it's no longer needed (e.g., when CL is closed).
    ///
    /// # Parameters
    /// - `store_path`: The base path where the CL directory is located.
    /// - `cl_link`: The specific CL link identifier to remove.
    ///
    /// # Returns
    /// A result indicating whether the removal operation was successful.
    pub async fn remove_cl_layer_by_cl_link<P: AsRef<Path>>(
        &self,
        store_path: P,
        cl_link: &str,
    ) -> std::io::Result<()> {
        let cl_path = store_path.as_ref().join("cl").join(cl_link);
        if cl_path.exists() {
            std::fs::remove_dir_all(&cl_path)?;
        }
        Ok(())
    }

    /// Unmounts the overlay filesystem associated with a given inode asynchronously.
    ///
    /// This function removes the overlay filesystem mapped to the specified inode from
    /// the `overlayfs` map and cleans up the associated resources.
    ///
    /// # Parameters
    /// - `inode`: The inode whose overlay filesystem is to be unmounted.
    ///
    /// # Returns
    /// A result indicating whether the unmounting operation was successful.
    pub async fn overlay_umount_byinode(&self, inode: u64) -> std::io::Result<()> {
        if !self.is_mount(inode).await {
            return Err(Error::new(
                std::io::ErrorKind::NotFound,
                "Overlay filesystem not mounted",
            ));
        }
        self.overlayfs.lock().await.remove(&inode);
        Ok(())
    }

    /// Unmounts the overlay filesystem associated with a given path asynchronously.
    ///
    /// This function retrieves the inode from the dictionary using the provided `path`
    /// and then calls `overlay_umount_byinode` to unmount the overlay filesystem.
    ///
    /// # Parameters
    /// - `path`: The path whose associated overlay filesystem is to be unmounted.
    ///
    /// # Returns
    /// A result indicating whether the unmounting operation was successful.
    pub async fn overlay_umount_bypath(&self, path: &str) -> std::io::Result<()> {
        let item = self.dic.store.get_by_path(path).await?;
        let inode = item.get_inode();
        self.overlay_umount_byinode(inode).await
    }

    /// Retrieves the inode associated with a given path asynchronously.
    ///
    /// This function queries the dictionary (`dic`) to obtain the inode associated
    /// with the specified `path`.
    ///
    /// # Parameters
    /// - `path`: The path whose inode is to be retrieved.
    ///
    /// # Returns
    /// A result containing the inode associated with the given path.
    pub async fn get_inode(&self, path: &str) -> std::io::Result<u64> {
        let item = self.dic.store.get_by_path(path).await?;
        Ok(item.get_inode())
    }

    /// Checks if an overlay filesystem is mounted for a given inode.
    ///
    /// This function checks if the `overlayfs` map contains the specified inode,
    /// indicating whether the overlay filesystem is currently mounted.
    ///
    /// # Parameters
    /// - `inode`: The inode to check for an associated mounted overlay filesystem.
    ///
    /// # Returns
    /// `true` if the overlay filesystem is mounted for the given inode, `false` otherwise.
    pub async fn is_mount(&self, inode: u64) -> bool {
        self.overlayfs.lock().await.get(&inode).is_some()
    }

    /// Allocates inode batches for every overlay filesystem asynchronously.
    ///
    /// This function clears the current inode allocation and then allocates new
    /// inode batches for all the overlay filesystems in the `overlayfs` map.
    ///
    /// # Returns
    /// None
    pub async fn after_mount_new(&self) {
        // clear inode alloc
        self.inodes_alloc.clear().await;
        // lock  overlayfs map
        let map_lock = &self.overlayfs.lock().await;

        for (inode, ovl_fs) in map_lock.iter() {
            // alloc new  inode batch.
            let inode_batch = self.inodes_alloc.alloc_inode(*inode).await;
            // extend inode alloc
            ovl_fs.extend_inode_alloc(inode_batch).await;
            // init overlay filesystem
            let _ = ovl_fs.init(Request::default()).await;
        }
    }
}