rustfs/crates/ecstore/src/lib.rs

// Copyright 2024 RustFS Team
//
// 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.

#![recursion_limit = "256"]

/// Scope-based hotpath measurement for `#[async_trait]` methods, where
/// `#[hotpath::measure]` would only time the boxed-future construction.
/// The guard records wall time from this statement until the enclosing
/// (desugared) async block completes, including early returns via `?`.
#[cfg(feature = "hotpath")]
#[macro_export]
macro_rules! hp_guard {
    ($label:expr) => {
        let _hotpath_scope_guard = ::hotpath::functions::build_measurement_guard_sync($label, false);
    };
}

#[cfg(not(feature = "hotpath"))]
#[macro_export]
macro_rules! hp_guard {
    ($label:expr) => {};
}

pub mod api;
mod bucket;
mod cache_value;
mod cluster;
mod config;
mod core;
mod crash_inject;
mod data_movement;
mod data_usage;
mod diagnostics;
mod disk;
mod erasure;
mod error;
mod io_support;
pub(crate) mod layout;
mod multipart_listing;
mod object_api;
mod runtime;
mod services;
mod set_disk;
mod storage_api_contracts;
mod store;

// pub mod checksum;
mod event;

use rustfs_concurrency::WorkloadAdmissionSnapshotProvider;
use std::sync::Arc;

pub type WorkloadAdmissionSnapshotProviderRef = Arc<dyn WorkloadAdmissionSnapshotProvider + Send + Sync>;

pub fn set_workload_admission_snapshot_provider(
    provider: WorkloadAdmissionSnapshotProviderRef,
) -> std::result::Result<(), WorkloadAdmissionSnapshotProviderRef> {
    runtime::sources::set_workload_admission_snapshot_provider(provider)
}

/// Request shutdown of all long-lived peer/disk background monitor tasks.
///
/// Call this during graceful shutdown, *before* the Tokio runtime is dropped, so
/// each monitor future (and the `tracing::Span` it holds) is dropped while the
/// runtime and tracing subscriber are still alive. This avoids the
/// thread-local-storage `on_close` panic that can otherwise abort the process
/// during worker-thread teardown (issue #4264). Idempotent and cheap.
pub fn shutdown_background_monitors() {
    cluster::rpc::shutdown_background_monitors();
}

/// Publish that the process is ready to serve user-object GET traffic.
///
/// Experimental metadata coalescing is allowed to run only after this point so
/// startup and internal metadata reads keep the original per-disk path.
pub fn mark_get_metadata_read_version_coalescing_service_ready() {
    runtime::global::mark_get_metadata_read_version_coalescing_service_ready();
}

#[cfg(test)]
mod rio_tests {
    #[test]
    fn uses_expected_rio_backend() {
        let expected = if cfg!(feature = "rio-v2") { "rio-v2" } else { "legacy-rio" };
        assert_eq!(crate::io_support::rio::backend_name(), expected);
    }
}

#[cfg(test)]
pub(crate) mod ecstore_validation_blackbox;

#[cfg(test)]
pub(crate) mod test_metrics;

#[cfg(test)]
pub(crate) mod test_tracing;