rustfs/rustfs/src/startup_runtime_hooks.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.

use crate::license::license_status;
use crate::startup_runtime_sources;
use rustls::crypto::aws_lc_rs::default_provider;
use std::future::Future;
use std::io::Result;
use tracing::{debug, info};

const LOG_COMPONENT_EMBEDDED: &str = "embedded";
const LOG_COMPONENT_MAIN: &str = "main";
const LOG_SUBSYSTEM_EMBEDDED: &str = "embedded";
const LOG_SUBSYSTEM_LICENSE: &str = "license";
const LOG_SUBSYSTEM_STARTUP: &str = "startup";
const EVENT_CRYPTO_PROVIDER_STATE: &str = "crypto_provider_state";
const EVENT_DIAL9_RUNTIME_STATUS: &str = "dial9_runtime_status";
const EVENT_RUNTIME_LICENSE_STATUS: &str = "runtime_license_status";

pub(crate) fn log_startup_runtime_diagnostics() {
    log_dial9_runtime_status();
    log_runtime_license_status();
    debug!("{}", crate::server::LOGO);
}

fn log_dial9_runtime_status() {
    if rustfs_obs::dial9::is_enabled() {
        info!(
            target: "rustfs::main",
            event = EVENT_DIAL9_RUNTIME_STATUS,
            component = LOG_COMPONENT_MAIN,
            subsystem = LOG_SUBSYSTEM_STARTUP,
            enabled = true,
            "Dial9 Tokio runtime telemetry is enabled"
        );
    } else {
        debug!(
            target: "rustfs::main",
            event = EVENT_DIAL9_RUNTIME_STATUS,
            component = LOG_COMPONENT_MAIN,
            subsystem = LOG_SUBSYSTEM_STARTUP,
            enabled = false,
            "Dial9 Tokio runtime telemetry is disabled"
        );
    }
}

fn log_runtime_license_status() {
    info!(
        target: "rustfs::main",
        event = EVENT_RUNTIME_LICENSE_STATUS,
        component = LOG_COMPONENT_MAIN,
        subsystem = LOG_SUBSYSTEM_LICENSE,
        license_status = %license_status(),
        "Initialized runtime license state"
    );
}

pub(crate) async fn init_profiling_runtime() {
    init_profiling_runtime_with(crate::profiling::init_from_env).await;
}

async fn init_profiling_runtime_with<InitFn, InitFuture>(init: InitFn)
where
    InitFn: FnOnce() -> InitFuture,
    InitFuture: Future<Output = ()>,
{
    init().await;
}

pub(crate) fn shutdown_profiling_runtime() {
    shutdown_profiling_runtime_with(crate::profiling::shutdown_profiling);
}

fn shutdown_profiling_runtime_with<ShutdownFn>(shutdown: ShutdownFn)
where
    ShutdownFn: FnOnce(),
{
    shutdown();
}

pub(crate) fn install_default_crypto_provider() {
    if default_provider().install_default().is_err() {
        debug!(
            target: "rustfs::main",
            event = EVENT_CRYPTO_PROVIDER_STATE,
            component = LOG_COMPONENT_MAIN,
            subsystem = LOG_SUBSYSTEM_STARTUP,
            provider = "aws_lc_rs",
            state = "already_installed",
            "Rustls crypto provider state checked"
        );
    }
}

pub(crate) async fn init_embedded_runtime_hooks(obs_endpoint: String) -> Result<()> {
    // Observability is a process-global tracing subscriber and can only be
    // installed once. A second embedded server in the same process reuses the
    // first server's subscriber — try to publish anyway (first server wins),
    // and treat both an init failure and a set failure as "already set" so a
    // second startup does not abort (backlog#1052 S5).
    match startup_runtime_sources::init_observability_guard(obs_endpoint).await {
        Ok(guard) => {
            if let Err(err) = startup_runtime_sources::set_observability_guard(guard) {
                debug!(
                    component = LOG_COMPONENT_EMBEDDED,
                    subsystem = LOG_SUBSYSTEM_EMBEDDED,
                    event = "observability_guard_reused",
                    error = %err,
                    "process already has an observability guard installed; second server reuses it"
                );
            }
        }
        Err(err) => {
            debug!(
                component = LOG_COMPONENT_EMBEDDED,
                subsystem = LOG_SUBSYSTEM_EMBEDDED,
                event = "observability_init_skipped",
                error = %err,
                "observability already initialized; second server reuses the process subscriber"
            );
        }
    }

    install_embedded_default_crypto_provider();
    rustfs_trusted_proxies::init();

    Ok(())
}

fn install_embedded_default_crypto_provider() {
    if let Err(err) = default_provider().install_default() {
        debug!(
            component = LOG_COMPONENT_EMBEDDED,
            subsystem = LOG_SUBSYSTEM_EMBEDDED,
            event = EVENT_CRYPTO_PROVIDER_STATE,
            state = "already_installed",
            error = ?err,
            "Embedded crypto provider state changed"
        );
    }
}

#[cfg(test)]
mod tests {
    use super::{init_profiling_runtime_with, shutdown_profiling_runtime_with};
    use std::sync::{
        Arc,
        atomic::{AtomicBool, Ordering},
    };

    #[tokio::test]
    async fn init_profiling_runtime_invokes_registered_hook() {
        let called = Arc::new(AtomicBool::new(false));
        let hook_called = called.clone();

        init_profiling_runtime_with(move || async move {
            hook_called.store(true, Ordering::SeqCst);
        })
        .await;

        assert!(called.load(Ordering::SeqCst));
    }

    #[test]
    fn shutdown_profiling_runtime_invokes_registered_hook() {
        let called = AtomicBool::new(false);

        shutdown_profiling_runtime_with(|| {
            called.store(true, Ordering::SeqCst);
        });

        assert!(called.load(Ordering::SeqCst));
    }
}