patina_performance 19.0.5

Performance measurement infrastructure.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

//! Patina Performance Component Configuration
//!
//! ## Performance Configuration Usage
//!
//! The configuration can be set statically with `.with_config()` or produced dynamically during boot.
//!
//! ## Static Configuration Example
//!
//! ```rust,ignore
//! // ...
//!
//! Core::default()
//! // ...
//!
//! .with_config(patina_performance::config::PerfConfig {
//!     enable_component: true,
//!     enabled_measurements: {
//!        patina::performance::Measurement::DriverBindingStart         // Adds driver binding start measurements.
//!        | patina::performance::Measurement::DriverBindingStop        // Adds driver binding stop measurements.
//!        | patina::performance::Measurement::DriverBindingSupport     // Adds driver binding support measurements.
//!        | patina::performance::Measurement::LoadImage                // Adds load image measurements.
//!        | patina::performance::Measurement::StartImage               // Adds start image measurements.
//!     }
//! })
//! .with_component(patina_performance::component::Performance)
//! .start()
//! .unwrap();
//!
//! // ...
//! ```
//!
//! ## License
//!
//! Copyright (C) Microsoft Corporation.
//!
//! SPDX-License-Identifier: Apache-2.0
//!

/// Default: component disabled unless explicitly enabled by platform/HOB.
pub const DEFAULT_ENABLE_COMPONENT: bool = false;
/// Default: no measurements enabled (mask = 0) until configured.
pub const DEFAULT_ENABLED_MEASUREMENTS: u32 = 0;

/// The configuration for the Patina Performance component.
#[derive(Debug, Clone, Copy)]
pub struct PerfConfig {
    /// Indicates whether the Patina Performance component is enabled.
    pub enable_component: bool,
    /// Bitmask of enabled measurements (see [`patina::performance::Measurement`]).
    pub enabled_measurements: u32,
}

impl Default for PerfConfig {
    fn default() -> Self {
        Self { enable_component: DEFAULT_ENABLE_COMPONENT, enabled_measurements: DEFAULT_ENABLED_MEASUREMENTS }
    }
}