patina_debugger/

lib.rs

//! Patina Debugger
//!
//! This crate provides a debugger implementation that will install itself in the
//! exception handlers and communicate with debugger software using the GDB Remote
//! protocol. The debugger is intended to be used in the boot phase cores.
//!
//! This crate is under construction and may be missing functionality, documentation,
//! and testing.
//!
//! ## Getting Started
//!
//! For more details on using the debugger on a device, see the [readme](./Readme.md).
//!
//! ## Examples and Usage
//!
//! The debugger consists of the static access routines and the underlying debugger
//! struct. The top level platform code should initialize the static `PatinaDebugger`
//! struct with the appropriate serial transport and default configuration. The
//! platform has the option of setting static configuration, or enabling the
//! debugger in runtime code based on platform policy. During entry, the platform
//! should use the `set_debugger` routine to set the global instance of the debugger.
//!
//! Core code should use the static routines to interact with the debugger. If the
//! debugger is either not set or not enabled, the static routines will be no-ops.
//!
//! ```rust
//! extern crate patina;
//! # extern crate patina_internal_cpu;
//! # use patina_internal_cpu::interrupts::{Interrupts, InterruptManager};
//! # use patina::component::service::perf_timer::ArchTimerFunctionality;
//!
//! static DEBUGGER: patina_debugger::PatinaDebugger<patina::serial::uart::UartNull> =
//!     patina_debugger::PatinaDebugger::new(patina::serial::uart::UartNull{})
//!         .with_timeout(30); // Set initial break timeout to 30 seconds.
//!
//! fn entry() {
//!
//!     // Configure the debugger. This is used for dynamic configuration of the debugger.
//!     DEBUGGER.enable(true);
//!
//!     // Set the global debugger instance. This can only be done once.
//!     patina_debugger::set_debugger(&DEBUGGER);
//!
//!     // Setup a custom monitor command for this platform.
//!     patina_debugger::add_monitor_command("my_command", "Description of my_command", |args, writer| {
//!         // Parse the arguments from _args, which is a SplitWhitespace iterator.
//!         let _ = write!(writer, "Executed my_command with args: {:?}", args);
//!     });
//!
//!     // Call the core entry. The core can then initialize and access the debugger
//!     // through the static routines.
//!     start();
//! }
//!
//! fn start() {
//!     // Initialize the debugger. This will cause a debug break because of the
//!     // initial break configuration set above.
//!     patina_debugger::initialize(&mut Interrupts::default(), Some(&ExampleTimer));
//!
//!     // Notify the debugger of a module load.
//!     patina_debugger::notify_module_load("module.efi", 0x420000, 0x10000);
//!
//!     // Poll the debugger for any pending interrupts.
//!     patina_debugger::poll_debugger();
//!
//!     // Break into the debugger if the debugger is enabled and initialized.
//!     patina_debugger::breakpoint();
//!
//!     // Cause a debug break unconditionally. This will crash the system
//!     // if the debugger is not enabled or initialized. This should be used with extreme caution.
//!     patina_debugger::breakpoint_unchecked();
//! }
//!
//! # struct ExampleTimer;
//! # impl ArchTimerFunctionality for ExampleTimer {
//! #     fn cpu_count(&self) -> u64 {
//! #         0
//! #     }
//! #
//! #     fn perf_frequency(&self) -> u64 {
//! #         1
//! #     }
//! # }
//!
//! ```
//!
//! The debugger can be further configured by using various functions on the
//! initialization of the debugger struct. See the definition for [debugger::PatinaDebugger]
//! for more details. Notably, if the device is using the same transport for
//! logging and debugger, it is advisable to use `.without_log_init()`.
//!
//! ## Features
//!
//! `alloc` - Uses allocated buffers rather than static buffers for all memory. This provides additional functionality
//! but prevents debugging prior to allocations being available. This is intended for use by the core crate, and not
//! for platform use.
//!
//! ## License
//!
//! Copyright (C) Microsoft Corporation.
//!
//! SPDX-License-Identifier: Apache-2.0
//!
#![cfg_attr(not(test), no_std)]
#![feature(coverage_attribute)]

#[coverage(off)] // The debugger needs integration test infrastructure. Disabling coverage until this is completed.
mod arch;
#[coverage(off)] // The debugger needs integration test infrastructure. Disabling coverage until this is completed.
mod dbg_target;
#[coverage(off)] // The debugger needs integration test infrastructure. Disabling coverage until this is completed.
mod debugger;
mod memory;
mod system;
mod transport;

#[cfg(any(feature = "alloc", test))]
extern crate alloc;

pub use debugger::PatinaDebugger;

#[cfg(not(test))]
use arch::{DebuggerArch, SystemArch};
use patina::{component::service::perf_timer::ArchTimerFunctionality, serial::SerialIO};
use patina_internal_cpu::interrupts::{ExceptionContext, InterruptManager};

/// Global instance of the debugger.
///
/// This is only expected to be set once, and will be accessed through the static
/// routines after that point. Because the debugger is expected to install itself
/// in exception handlers and will have access to other static state for things
/// like breakpoints, it is not safe to remove or replace it. For this reason,
/// this uses the Once lock to provide these properties.
///
static DEBUGGER: spin::Once<&dyn Debugger> = spin::Once::new();

/// Type for monitor command functions. This will be invoked by the debugger when
/// the associated monitor command is invoked.
///
/// The first argument contains the whitespace separated arguments from the command.
/// For example, if the command is `my_command arg1 arg2`, then `arg1` and `arg2` will
/// be the first and second elements of the iterator respectively.
///
/// The second argument is a writer that should be used to write the output of the
/// command. This can be done by directly invoking the [core::fmt::Write] trait methods
/// or using the `write!` macro. `format!` should be avoided as it will allocate memory
/// which shouldn't be done in debugger when possible.
pub type MonitorCommandFn = dyn Fn(&mut core::str::SplitWhitespace<'_>, &mut dyn core::fmt::Write) + Send + Sync;

/// Trait for debugger interaction. This is required to allow for a global to the
/// platform specific debugger implementation. For safety, these routines should
/// only be invoked on the global instance of the debugger.
trait Debugger: Sync {
    #[cfg(test)]
    fn test_initialize(&'static self, initialized: bool);

    /// Initializes the debugger. Intended for core use only.
    fn initialize(
        &'static self,
        interrupt_manager: &mut dyn InterruptManager,
        timer: Option<&'static dyn ArchTimerFunctionality>,
    );

    /// Checks if the debugger is enabled.
    fn enabled(&'static self) -> bool;

    /// Checks if the debugger is initialized.
    fn initialized(&'static self) -> bool;

    /// Notifies the debugger of a module load.
    fn notify_module_load(&'static self, module_name: &str, _address: usize, _length: usize);

    /// Polls the debugger for any pending interrupts.
    fn poll_debugger(&'static self);

    #[cfg(feature = "alloc")]
    fn add_monitor_command(
        &'static self,
        command: &'static str,
        description: &'static str,
        callback: alloc::boxed::Box<MonitorCommandFn>,
    );
}

#[derive(Debug)]
#[allow(dead_code)]
enum DebugError {
    /// The debugger lock could not be acquired. Usually indicating the debugger faulted.
    Reentry,
    /// The debugger configuration is locked. This indicates a failure during debugger configuration.
    ConfigLocked,
    /// The debugger was invoked without being fully initialized.
    NotInitialized,
    /// Failure from the GDB stub initialization.
    GdbStubInit,
    /// Failure from the GDB stub.
    GdbStubError(gdbstub::stub::GdbStubError<(), patina::error::EfiError>),
    /// Failure to reboot the system.
    RebootFailure,
    /// Failure in the transport layer.
    TransportFailure,
}

/// Policy for how the debugger will handle logging on the system.
pub enum DebuggerLoggingPolicy {
    /// The debugger will suspend logging while broken in, but will not change the
    /// logging state outside of the debugger. This may cause instability if the
    /// debugger and logging share a transport.
    SuspendLogging,
    /// The debugger will disable all logging after a connection is made. This is
    /// the safest option if the debugger and logging share a transport.
    DisableLogging,
    /// The debugger will not suspend logging while broken in and will allow log
    /// messages from the debugger itself. This should only be used if the debugger
    /// and logging transports are separate.
    FullLogging,
}

/// Sets the global instance of the debugger.
pub fn set_debugger<T: SerialIO>(debugger: &'static PatinaDebugger<T>) {
    DEBUGGER.call_once(|| debugger);
}

/// Initializes the debugger. This will install the debugger into the exception
/// handlers using the provided interrupt manager. This routine may invoke a debug
/// break depending on configuration.
#[coverage(off)] // Initializing the debugger requires integration testing infrastructure. Disabling coverage until this is completed.
pub fn initialize(interrupt_manager: &mut dyn InterruptManager, timer: Option<&'static dyn ArchTimerFunctionality>) {
    if let Some(debugger) = DEBUGGER.get() {
        debugger.initialize(interrupt_manager, timer);
    }
}

/// Invokes a debug break instruction if the debugger is enabled and initialized. This will cause
/// the debugger to break in. If the debugger is not enabled and initialized, this routine will have no effect.
pub fn breakpoint() {
    if enabled() {
        if initialized() {
            breakpoint_unchecked();
        } else {
            log::error!("Debugger breakpoint invoked before debugger initialized, not breaking in!");
        }
    }
}

/// Invokes a debug break instruction unconditionally. If this routine is invoked when
/// the debugger is not enabled and initialized, it will cause an unhandled exception.
///
/// ## Important
///
/// This should only be used in debug scenarios or when it is impossible to continue
/// execution in the current state and an CPU exception must be raised.
#[inline(always)]
pub fn breakpoint_unchecked() {
    #[cfg(not(test))]
    SystemArch::breakpoint();
    #[cfg(test)]
    panic!("breakpoint_unchecked");
}

/// Notifies the debugger of a module load at the provided address and length.
/// This should be invoked before the module has begun execution.
pub fn notify_module_load(module_name: &str, address: usize, length: usize) {
    if let Some(debugger) = DEBUGGER.get() {
        debugger.notify_module_load(module_name, address, length);
    }
}

/// Polls the debugger for any pending interrupts. The routine may cause a debug
/// break.
pub fn poll_debugger() {
    if let Some(debugger) = DEBUGGER.get() {
        debugger.poll_debugger();
    }
}

/// Checks if the debugger is enabled.
pub fn enabled() -> bool {
    match DEBUGGER.get() {
        Some(debugger) => debugger.enabled(),
        None => false,
    }
}

/// Checks if the debugger is initialized.
pub fn initialized() -> bool {
    match DEBUGGER.get() {
        Some(debugger) => debugger.initialized(),
        None => false,
    }
}

/// Adds a monitor command to the debugger. This may be called before initialization,
/// but should not be called before memory allocations are available. See [MonitorCommandFn]
/// for more details on the callback function expectations.
///
/// ## Example
///
/// ```rust
/// patina_debugger::add_monitor_command("my_command", "Description of my_command", |args, writer| {
///     // Parse the arguments from _args, which is a SplitWhitespace iterator.
///     let _ = write!(writer, "Executed my_command with args: {:?}", args);
/// });
/// ```
///
#[cfg(feature = "alloc")]
pub fn add_monitor_command<F>(cmd: &'static str, description: &'static str, function: F)
where
    F: Fn(&mut core::str::SplitWhitespace<'_>, &mut dyn core::fmt::Write) + Send + Sync + 'static,
{
    if let Some(debugger) = DEBUGGER.get() {
        debugger.add_monitor_command(cmd, description, alloc::boxed::Box::new(function));
    }
}

/// Adds a monitor command to the debugger. This may be called before initialization,
/// but should not be called before memory allocations are available. See [MonitorCommandFn]
/// for more details on the callback function expectations.
///
/// ## Example
///
/// ```rust
/// patina_debugger::add_monitor_command("my_command", "Description of my_command", |args, writer| {
///     // Parse the arguments from _args, which is a SplitWhitespace iterator.
///     let _ = write!(writer, "Executed my_command with args: {:?}", args);
/// });
/// ```
///
#[cfg(not(feature = "alloc"))]
pub fn add_monitor_command<F>(cmd: &'static str, _description: &'static str, _function: F)
where
    F: Fn(&mut core::str::SplitWhitespace<'_>, &mut dyn core::fmt::Write) + Send + Sync + 'static,
{
    if let Some(_) = DEBUGGER.get() {
        log::warn!("Dynamic monitor commands require the 'alloc' feature. Will not add command: {cmd}");
    }
}

/// Exception information for the debugger.
#[allow(dead_code)]
struct ExceptionInfo {
    /// The type of exception that occurred.
    pub exception_type: ExceptionType,
    /// The instruction pointer address.
    pub instruction_pointer: u64,
    /// The system context at the time of the exception.
    pub context: ExceptionContext,
}

/// Exception type information.
#[derive(PartialEq, Eq)]
#[allow(dead_code)]
enum ExceptionType {
    /// A break due to a completed instruction step.
    Step,
    /// A break due to a breakpoint instruction.
    Breakpoint,
    /// A break due to an invalid memory access. The accessed address is provided.
    AccessViolation(usize),
    /// A general protection fault. Exception data is provided.
    GeneralProtectionFault(u64),
    /// A break due to an exception type not handled by the debugger. The exception type is provided.
    Other(u64),
}

impl core::fmt::Display for ExceptionType {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            ExceptionType::Step => write!(f, "Debug Step"),
            ExceptionType::Breakpoint => write!(f, "Breakpoint"),
            ExceptionType::AccessViolation(addr) => write!(f, "Access Violation at {addr:#X}"),
            ExceptionType::GeneralProtectionFault(data) => {
                write!(f, "General Protection Fault. Exception data: {data:#X}")
            }
            ExceptionType::Other(exception_type) => write!(f, "Unknown. Architecture code: {exception_type:#X}"),
        }
    }
}

#[coverage(off)]
#[cfg(test)]
mod tests {
    use super::*;
    use serial_test::serial;

    static DUMMY_DEBUGGER: PatinaDebugger<patina::serial::uart::UartNull> =
        PatinaDebugger::new(patina::serial::uart::UartNull {});

    fn reset() {
        // Reset the global debugger for testing.
        DUMMY_DEBUGGER.enable(false);
        DUMMY_DEBUGGER.test_initialize(false);
        if !DEBUGGER.is_completed() {
            set_debugger(&DUMMY_DEBUGGER);
        }
    }

    #[test]
    #[serial(global_debugger)]
    fn test_debug_break_not_enabled() {
        reset();
        // Ensure that invoking a debug break when the debugger is not enabled does not cause issues.
        breakpoint();
    }

    #[test]
    #[serial(global_debugger)]
    fn test_debug_break_not_initialized() {
        reset();
        DUMMY_DEBUGGER.enable(true);
        // Ensure that invoking a debug break when the debugger is not initialized does not cause issues.
        breakpoint();
    }

    #[test]
    #[should_panic(expected = "breakpoint_unchecked")]
    #[serial(global_debugger)]
    fn test_debug_break_enabled_and_initialized() {
        reset();
        // Enable the debugger.
        DUMMY_DEBUGGER.enable(true);
        DUMMY_DEBUGGER.test_initialize(true);
        // Ensure that invoking a debug break when the debugger is enabled and initialized causes a panic.
        breakpoint();
    }
}