patina 21.1.0

//! Globals used in the Patina SDK performance code.
//!
//! ## License
//!
//! Copyright (c) Microsoft Corporation.
//!
//! SPDX-License-Identifier: Apache-2.0
//!
use crate::{
    boot_services::{StandardBootServices, tpl::Tpl},
    component::service::{Service, perf_timer::ArchTimerFunctionality},
    performance::table::FBPT,
    tpl_mutex::TplMutex,
};
use core::{
    cell::OnceCell,
    sync::atomic::{AtomicBool, AtomicU32, Ordering},
};

static LOAD_IMAGE_COUNT: AtomicU32 = AtomicU32::new(0);
static PERF_MEASUREMENT_MASK: AtomicU32 = AtomicU32::new(0);

/// Static state for the performance component.
struct StaticState {
    /// Boot Services instance
    boot_services: OnceCell<StandardBootServices>,
    /// The FBPT protected by a TPL mutex.
    fbpt: OnceCell<TplMutex<FBPT>>,
    /// Flag to indicate if the static state is in the process of being initialized.
    initializing: AtomicBool,
    /// Timer service for performance measurements.
    timer: Service<dyn ArchTimerFunctionality>,
}

impl StaticState {
    /// Creates a new uninitialized static state.
    const fn uninit() -> Self {
        Self {
            boot_services: OnceCell::new(),
            fbpt: OnceCell::new(),
            initializing: AtomicBool::new(false),
            timer: Service::new_uninit(),
        }
    }

    /// Initializes the static state.
    ///
    /// ## Errors
    ///
    /// Returns `Already initialized` if the static state has already been initialized.
    /// Returns `Currently initializing somewhere else` if another thread is currently initializing the static state.
    fn init(&self, bs: StandardBootServices, timer: Service<dyn ArchTimerFunctionality>) -> Result<(), &'static str> {
        if self.initializing.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_ok() {
            self.boot_services.set(bs).map_err(|_| "Already initialized")?;
            self.fbpt
                .set(TplMutex::new(
                    self.boot_services.get().expect("Boot Services Just Set").clone(),
                    Tpl::NOTIFY,
                    FBPT::new(),
                ))
                .map_err(|_| "Failed to set FBPT")?;
            self.timer.replace(&timer);
            self.initializing.store(false, Ordering::Release);
            return Ok(());
        }

        Err("Currently initializing somewhere else")
    }

    /// Gets the inner static state if it has been initialized.
    ///
    /// Returns `None` if the state is not yet initialized.
    /// Returns `None` if the state is currently being initialized.
    /// Returns `Some` with references to the `StandardBootServices` and `TplMutex<FBPT>` if initialized.
    fn inner(&self) -> Option<(&StandardBootServices, &TplMutex<FBPT>, &Service<dyn ArchTimerFunctionality>)> {
        if !self.initializing.load(Ordering::Acquire)
            && let Some(bs) = self.boot_services.get()
            && let Some(fbpt) = self.fbpt.get()
        {
            return Some((bs, fbpt, &self.timer));
        }
        None
    }
}

/// SAFETY: Initializing the `OnceCell`s via the atomic `initialize` flag satisfies the `Send` requirement for
/// synchronization on the `set` calls inside `init`. Both the `StandardBootServices` and `TplMutex` types are `Send`
/// as well, so the only other usage of the `OnceCell`s `get` method is safe.
unsafe impl Send for StaticState {}

/// SAFETY: Initializing the `OnceCell`s via the atomic `initialize` flag satisfies the `Sync` requirement for
/// synchronization on the `set` calls inside `init`. Both the `StandardBootServices` and `TplMutex` types are `Sync`
/// as well, so the only other usage of the `OnceCell`s `get` method is safe.
unsafe impl Sync for StaticState {}

static STATIC_STATE: StaticState = StaticState::uninit();

/// Set performance component static state.
pub fn set_perf_measurement_mask(mask: u32) {
    PERF_MEASUREMENT_MASK.store(mask, Ordering::Relaxed);
}

/// Get performance component static state.
pub fn get_perf_measurement_mask() -> u32 {
    PERF_MEASUREMENT_MASK.load(Ordering::Relaxed)
}

/// Get the current load image count.
pub fn get_load_image_count() -> u32 {
    LOAD_IMAGE_COUNT.load(Ordering::Relaxed)
}

/// Increment the load image count.
pub fn increment_load_image_count() {
    LOAD_IMAGE_COUNT.fetch_add(1, Ordering::Relaxed);
}

/// Set load image count to a specific value.
pub fn set_load_image_count(count: u32) {
    LOAD_IMAGE_COUNT.store(count, Ordering::Relaxed);
}

/// Set performance component static state.
#[coverage(off)]
pub fn set_static_state(
    boot_services: StandardBootServices,
    timer: Service<dyn ArchTimerFunctionality>,
) -> Result<(), &'static str> {
    STATIC_STATE.init(boot_services, timer)
}

/// Get performance component static state.
#[coverage(off)]
pub fn get_static_state()
-> Option<(&'static StandardBootServices, &'static TplMutex<FBPT>, &'static Service<dyn ArchTimerFunctionality>)> {
    STATIC_STATE.inner()
}

#[cfg(test)]
#[coverage(off)]
mod tests {
    use crate as patina;
    use crate::component::service::IntoService;

    use super::*;

    #[derive(IntoService)]
    #[service(dyn ArchTimerFunctionality)]
    struct MockTimer {}

    impl ArchTimerFunctionality for MockTimer {
        fn perf_frequency(&self) -> u64 {
            100
        }
        fn cpu_count(&self) -> u64 {
            200
        }
    }

    #[test]
    fn test_get_static_state() {
        let static_state: StaticState = StaticState::uninit();
        assert!(static_state.inner().is_none());
        assert!(static_state.init(StandardBootServices::new_uninit(), Service::mock(Box::new(MockTimer {}))).is_ok());
        assert!(static_state.inner().is_some());
        assert!(static_state.init(StandardBootServices::new_uninit(), Service::mock(Box::new(MockTimer {}))).is_err());
    }
}