many_cpus_impl 2.4.14

Implementation crate for many_cpus - do not reference directly
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
58
59
60
61
62
63

use std::fmt::Debug;

use windows::Win32::System::JobObjects::JOBOBJECT_CPU_RATE_CONTROL_INFORMATION;
use windows::Win32::System::Kernel::PROCESSOR_NUMBER;
use windows::Win32::System::SystemInformation::{
    GROUP_AFFINITY, LOGICAL_PROCESSOR_RELATIONSHIP, SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX,
};
use windows::core::Result;

/// Bindings for FFI calls into external libraries (either provided by operating system or not).
///
/// All PAL FFI calls must go through this trait, enabling them to be mocked.
#[cfg_attr(test, mockall::automock)]
pub(crate) trait Bindings: Debug + Send + Sync + 'static {
    fn get_active_processor_count(&self, group_number: u16) -> u32;
    fn get_maximum_processor_count(&self, group_number: u16) -> u32;

    fn get_maximum_processor_group_count(&self) -> u16;

    fn get_current_processor_number_ex(&self) -> PROCESSOR_NUMBER;

    fn get_numa_highest_node_number(&self) -> u32;

    fn get_current_process_default_cpu_set_masks(&self) -> Vec<GROUP_AFFINITY>;
    fn get_current_thread_cpu_set_masks(&self) -> Vec<GROUP_AFFINITY>;
    fn set_current_thread_cpu_set_masks(&self, masks: &[GROUP_AFFINITY]);

    unsafe fn get_logical_processor_information_ex(
        &self,
        relationship_type: LOGICAL_PROCESSOR_RELATIONSHIP,
        buffer: Option<*mut SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX>,
        returned_length: *mut u32,
    ) -> Result<()>;

    // JobObjectGroupInformationEx; may return empty list if not affinitized.
    fn get_current_job_cpu_set_masks(&self) -> Vec<GROUP_AFFINITY>;

    fn get_current_job_cpu_rate_control(&self) -> Option<JOBOBJECT_CPU_RATE_CONTROL_INFORMATION>;

    /// Returns the nominal maximum clock frequency in MHz of each logical processor, indexed by
    /// processor ID.
    ///
    /// The returned `Vec` always has length exactly `max_processor_count`, with entry `i` holding
    /// the value for processor ID `i` (covering every processor ID in `0..max_processor_count`).
    /// Processors for which the platform reports no value (for example offline processors) hold 0.
    ///
    /// This is a passive read that covers every processor across all processor groups without
    /// changing the affinity or any other runtime state of the calling thread.
    fn get_processor_max_mhz(&self, max_processor_count: usize) -> Vec<u32>;

    /// Returns the model string of each logical processor, indexed by processor ID.
    ///
    /// The returned `Vec` always has length exactly `max_processor_count`, with entry `i` holding
    /// the value for processor ID `i` (covering every processor ID in `0..max_processor_count`).
    /// Processors for which the platform reports no model (for example offline processors) hold
    /// `None`.
    ///
    /// This is a passive read that covers every processor across all processor groups without
    /// changing the affinity or any other runtime state of the calling thread.
    fn get_processor_name_strings(&self, max_processor_count: usize) -> Vec<Option<String>>;

    fn get_current_thread_legacy_group_affinity(&self) -> GROUP_AFFINITY;
}