hyperdir 0.7.0

A container for inodes implemented as a Hyperfile
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use std::io::{Result, ErrorKind};
use std::collections::HashSet;
use aws_sdk_s3::Client;
use hyperfile::{BlockPtr, SegmentId};
use hyperfile::staging::{Staging, StagingIntercept, config::StagingConfig, s3::S3Staging};
use hyperfile::meta_loader::s3_batch::S3BlockLoader;
use hyperfile::file::flags::HyperFileFlags;
use hyperfile::file::mode::HyperFileMode;
use hyperfile::config::HyperFileConfig;
use crate::DirStaging;
use crate::file::HyperDirFile;

pub struct HyperDir<'a> {
    pub(crate) inner: HyperDirFile<'a, S3Staging, S3BlockLoader>
}

impl<'a> HyperDir<'a> {
    pub(crate) async fn do_open_or_create(client: Client, file_config: HyperFileConfig, flags: HyperFileFlags, mode: HyperFileMode, create: bool) -> Result<Self>
    {
        match Self::open(client.clone(), file_config.clone(), flags.clone()).await {
            Ok(hyper) => {
                Ok(hyper)
            },
            Err(e) => {
                if create && e.kind() == ErrorKind::NotFound {
                    return Self::create(client, file_config, flags, mode).await;
                }
                Err(e)
            }
        }
    }

    pub async fn open(client: Client, file_config: HyperFileConfig, flags: HyperFileFlags) -> Result<Self>
    {
        let dir_staging_config = S3Staging::to_dir_staging_config(&file_config.staging);
        let staging = S3Staging::from(&client, dir_staging_config, file_config.runtime.clone()).await?;
        let loader = staging.to_block_loader();
        let file = HyperDirFile::<S3Staging, S3BlockLoader>::open(staging, loader, file_config, flags).await?;
        Ok(Self {
            inner: file,
        })
    }

    pub async fn create(client: Client, file_config: HyperFileConfig, flags: HyperFileFlags, mode: HyperFileMode) -> Result<Self>
    {
        let dir_staging_config = S3Staging::to_dir_staging_config(&file_config.staging);
        let staging = S3Staging::create(&client, dir_staging_config, file_config.runtime.clone()).await?;
        let loader = staging.to_block_loader();
        let file = HyperDirFile::<S3Staging, S3BlockLoader>::new(staging, loader, file_config, flags, mode).await?;
        Ok(Self {
            inner: file,
        })
    }

    pub async fn create_with_interceptor(client: Client, file_config: HyperFileConfig, flags: HyperFileFlags, mode: HyperFileMode, interceptor: impl StagingIntercept<S3Staging> + 'static) -> Result<Self>
    {
        let dir_staging_config = S3Staging::to_dir_staging_config(&file_config.staging);
        let mut staging = S3Staging::create(&client, dir_staging_config, file_config.runtime.clone()).await?;
        staging.interceptor(interceptor);
        let loader = staging.to_block_loader();
        let file = HyperDirFile::<S3Staging, S3BlockLoader>::new(staging, loader, file_config, flags, mode).await?;
        Ok(Self {
            inner: file,
        })
    }

    pub async fn stat_fast(client: Client, file_config: HyperFileConfig) -> Result<libc::stat>
    {
        let dir_staging_config = S3Staging::to_dir_staging_config(&file_config.staging);
        let staging = S3Staging::from(&client, dir_staging_config, file_config.runtime.clone()).await?;
        HyperDirFile::<S3Staging, S3BlockLoader>::stat_fast(staging).await
    }

    pub async fn update_stat_fast(client: Client, file_config: HyperFileConfig, stat: &libc::stat) -> Result<libc::stat>
    {
        let staging = S3Staging::from(&client, file_config.staging.clone(), file_config.runtime.clone()).await?;
        HyperDirFile::<S3Staging, S3BlockLoader>::update_stat_fast(staging, stat).await
    }
}

/// expose helper fn
impl<'a> HyperDir<'a> {
    pub fn staging_config(&self) -> &StagingConfig {
        self.inner.staging_config()
    }

    pub fn with_staging_interceptor(&mut self, i: impl StagingIntercept<S3Staging> + 'static) {
        self.inner.staging_interceptor(i)
    }

    /// Every external storage location this directory references — i.e. its
    /// bmap's metadata (B+tree) node locations, which for a directory are the
    /// *only* external storage it occupies (dirents are inline payload in the
    /// leaves). The complete reachable set, for a segment reclaimer.
    ///
    /// Fail-closed: on `Err` treat reachability as unknown and reclaim nothing.
    /// See [`HyperDirFile::reachable_meta_ptrs`] for the full contract.
    pub async fn fs_reachable_meta_ptrs(&self) -> Result<Vec<BlockPtr>> {
        self.inner.reachable_meta_ptrs().await
    }

    /// The staging segments this directory still references (decoded from
    /// [`fs_reachable_meta_ptrs`](Self::fs_reachable_meta_ptrs)). Same
    /// fail-closed contract.
    pub async fn fs_reachable_segments(&self) -> Result<HashSet<SegmentId>> {
        self.inner.reachable_segments().await
    }
}