reovim-kernel 0.14.4

//! Custom panic handler infrastructure.
//!
//! Linux equivalent: `kernel/panic.c`
//!
//! Provides custom panic handling for graceful shutdown and crash recovery.

use std::{
    panic::{self, PanicHookInfo},
    path::PathBuf,
    sync::{
        OnceLock,
        atomic::{AtomicBool, Ordering},
    },
};

static PANIC_HANDLER_INSTALLED: AtomicBool = AtomicBool::new(false);

/// Recovery callback type.
///
/// Called during panic to allow saving state before the process terminates.
pub type RecoveryCallback = Box<dyn Fn(&PanicHookInfo<'_>) + Send + Sync>;

/// Global recovery callback.
static RECOVERY_CALLBACK: OnceLock<RecoveryCallback> = OnceLock::new();

/// Debug context collected during panic.
///
/// Contains server logs and client dump file paths for crash reports.
#[derive(Debug, Default)]
pub struct DebugContext {
    /// Server debug ring buffer dump (Phase #478).
    pub server_logs: Option<String>,
    /// Paths to client debug dump files.
    pub client_dump_paths: Vec<PathBuf>,
}

/// Debug context callback type.
///
/// Called during panic to collect debug information for the crash report.
pub type DebugContextCallback = Box<dyn Fn() -> DebugContext + Send + Sync>;

/// Global debug context callback.
static DEBUG_CONTEXT_CALLBACK: OnceLock<DebugContextCallback> = OnceLock::new();

/// Set the debug context callback.
///
/// Called during panic to collect server logs and client dump paths.
/// Can only be set once.
///
/// # Example
///
/// ```ignore
/// set_debug_context_callback(Box::new(|| {
///     let server_logs = try_debug_ring().and_then(|r| r.try_dump());
///     DebugContext {
///         server_logs,
///         client_dump_paths: Vec::new(),
///     }
/// }));
/// ```
pub fn set_debug_context_callback(callback: DebugContextCallback) {
    let _ = DEBUG_CONTEXT_CALLBACK.set(callback);
}

/// Install the custom panic handler.
///
/// Linux equivalent: `panic_notifier_list`
///
/// This wraps the default panic handler to:
/// 1. Generate a crash report
/// 2. Call the recovery callback (if set) to save state
/// 3. Log the crash report
/// 4. Write crash report to file
/// 5. Call the original panic handler
///
/// # Example
///
/// ```ignore
/// use reovim_kernel::panic::{install_panic_handler, set_recovery_callback};
///
/// // Set up recovery to save unsaved buffers
/// set_recovery_callback(Box::new(|info| {
///     // Save unsaved buffers...
/// }));
///
/// // Install the handler
/// install_panic_handler();
/// ```
///
/// # Notes
///
/// - Can only be called once; subsequent calls are no-ops
/// - Must be called early in application startup
pub fn install_panic_handler() {
    if PANIC_HANDLER_INSTALLED.swap(true, Ordering::SeqCst) {
        return; // Already installed
    }

    let default_hook = panic::take_hook();

    panic::set_hook(Box::new(
        #[cfg_attr(coverage_nightly, coverage(off))]
        move |info| {
            // 1. Generate crash report
            let mut report = super::report::generate_crash_report(info);

            // 2. Collect debug context (server logs, client dumps)
            if let Some(callback) = DEBUG_CONTEXT_CALLBACK.get() {
                let ctx = callback();
                report.server_logs = ctx.server_logs;
                report.client_dump_paths = ctx.client_dump_paths;
            }

            // 3. Attempt recovery (save buffers)
            if let Some(callback) = RECOVERY_CALLBACK.get() {
                callback(info);
            }

            // 4. Log crash report
            crate::pr_err!("PANIC: {}", report.summary());

            // 5. Write crash report to file
            if let Err(e) = report.write_to_file() {
                eprintln!("Failed to write crash report: {e}");
            }

            // 6. Call original handler
            default_hook(info);
        },
    ));
}

/// Set the recovery callback.
///
/// Called during panic to allow saving state. Can only be set once.
///
/// # Example
///
/// ```ignore
/// set_recovery_callback(Box::new(|_info| {
///     // Save all unsaved buffers to recovery directory
///     for buffer in buffers.iter() {
///         if buffer.is_modified() {
///             save_buffer_for_recovery(buffer);
///         }
///     }
/// }));
/// ```
pub fn set_recovery_callback(callback: RecoveryCallback) {
    let _ = RECOVERY_CALLBACK.set(callback);
}

/// Check if the panic handler has been installed.
#[must_use]
pub fn is_handler_installed() -> bool {
    PANIC_HANDLER_INSTALLED.load(Ordering::SeqCst)
}