goosefs-sdk 0.1.8

Goosefs Rust gRPC Client - Direct gRPC client for Goosefs Master/Worker
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

// Copyright (C) 2026 Tencent. All rights reserved.
//
// Licensed 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.

//! io_uring page-store backend.
//!
//! This module provides [`UringPageStore`] — an io_uring-backed implementation
//! of [`crate::cache::store::PageStore`] that eliminates the `spawn_blocking`
//! overhead of `LocalPageStore` (tokio::fs) on the cache-hit hot path.
//!
//! # Platform support
//!
//! io_uring is Linux-only (kernel ≥ 5.1). On other platforms the module
//! exposes only [`is_uring_available`] (which returns `false`), and
//! `LocalCacheManager` transparently falls back to `LocalPageStore`.
//!
//! # Disk layout
//!
//! Identical to `LocalPageStore`:
//! `<dir>/<page_size>/<bucket>/<file_id>/<page_index>`
//!
//! so both backends can read each other's files (cross-backend compatibility).
//!
//! See `docs/CLIENT_PAGE_CACHE_DESIGN.md`.

#[cfg(target_os = "linux")]
mod driver;
#[cfg(target_os = "linux")]
mod future;
#[cfg(target_os = "linux")]
mod requests;
#[cfg(target_os = "linux")]
mod store;
mod sys;

#[cfg(target_os = "linux")]
pub use store::UringPageStore;
pub use sys::is_uring_available;

/// Initialise the io_uring thread pool configuration from `CacheManagerOptions`.
///
/// On non-Linux platforms this is a no-op (the io_uring backend is unavailable).
#[cfg(target_os = "linux")]
pub fn init_uring_config(queue_depth: usize, thread_count: usize) {
    driver::init_uring_config(queue_depth, thread_count);
}

#[cfg(not(target_os = "linux"))]
#[allow(unused_variables)]
pub fn init_uring_config(queue_depth: usize, thread_count: usize) {}

use crate::error::Error;

/// Number of hash buckets — must match `LocalPageStore` for cross-backend
/// compatibility.
#[cfg_attr(not(target_os = "linux"), allow(dead_code))]
const NUM_BUCKETS: u64 = 1000;

/// xxHash3 64-bit hash of `file_id` for bucket selection.
///
/// **Must stay byte-for-byte identical to `LocalPageStore::hash_file_id`** —
/// the on-disk bucket directory is determined by this hash, so a mismatch
/// would orphan the entire cache when switching backends.
#[cfg_attr(not(target_os = "linux"), allow(dead_code))]
fn hash_file_id(file_id: &str) -> u64 {
    xxhash_rust::xxh3::xxh3_64(file_id.as_bytes())
}

#[cfg_attr(not(target_os = "linux"), allow(dead_code))]
fn io_error(message: impl Into<String>, e: std::io::Error) -> Error {
    Error::Internal {
        message: message.into(),
        source: Some(Box::new(e)),
    }
}