many_cpus 2.4.0

Efficiently schedule work and inspect the hardware environment on many-processor systems
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

#![cfg_attr(coverage_nightly, coverage(off))]

use std::fmt::Debug;
#[cfg(any(test, feature = "test-util"))]
use std::sync::Arc;

#[cfg(any(test, feature = "test-util"))]
use crate::fake::FakePlatform;
#[cfg(test)]
use crate::pal::fallback::BuildTargetPlatform as FallbackPlatform;
use crate::pal::{BUILD_TARGET_PLATFORM, BuildTargetPlatform, Platform, ProcessorFacade};

#[derive(Clone)]
pub(crate) enum PlatformFacade {
    Target(&'static BuildTargetPlatform),

    #[cfg(test)]
    Fallback(&'static FallbackPlatform),

    /// Fake hardware for the public test-util feature.
    #[cfg(any(test, feature = "test-util"))]
    Fake(Arc<FakePlatform>),
}

impl PlatformFacade {
    pub(crate) fn target() -> Self {
        Self::Target(&BUILD_TARGET_PLATFORM)
    }

    #[cfg(any(test, feature = "test-util"))]
    pub(crate) fn from_fake(fake: FakePlatform) -> Self {
        Self::Fake(Arc::new(fake))
    }

    /// Returns a reference to the inner `FakePlatform`, panicking if not a fake.
    #[cfg(test)]
    pub(crate) fn as_fake(&self) -> &FakePlatform {
        match self {
            Self::Fake(inner) => inner,
            _ => panic!("expected PlatformFacade::Fake"),
        }
    }
}

impl Platform for PlatformFacade {
    fn get_all_processors(&self) -> nonempty::NonEmpty<ProcessorFacade> {
        match self {
            Self::Target(p) => p.get_all_processors(),
            #[cfg(test)]
            Self::Fallback(p) => p.get_all_processors(),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.get_all_processors(),
        }
    }

    fn pin_current_thread_to<P>(&self, processors: &nonempty::NonEmpty<P>)
    where
        P: AsRef<ProcessorFacade>,
    {
        match self {
            Self::Target(p) => p.pin_current_thread_to(processors),
            #[cfg(test)]
            Self::Fallback(p) => p.pin_current_thread_to(processors),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.pin_current_thread_to(processors),
        }
    }

    fn current_processor_id(&self) -> crate::ProcessorId {
        match self {
            Self::Target(p) => p.current_processor_id(),
            #[cfg(test)]
            Self::Fallback(p) => p.current_processor_id(),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.current_processor_id(),
        }
    }

    fn max_processor_id(&self) -> crate::ProcessorId {
        match self {
            Self::Target(p) => p.max_processor_id(),
            #[cfg(test)]
            Self::Fallback(p) => p.max_processor_id(),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.max_processor_id(),
        }
    }

    fn max_memory_region_id(&self) -> crate::MemoryRegionId {
        match self {
            Self::Target(p) => p.max_memory_region_id(),
            #[cfg(test)]
            Self::Fallback(p) => p.max_memory_region_id(),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.max_memory_region_id(),
        }
    }

    fn current_thread_processors(&self) -> nonempty::NonEmpty<crate::ProcessorId> {
        match self {
            Self::Target(p) => p.current_thread_processors(),
            #[cfg(test)]
            Self::Fallback(p) => p.current_thread_processors(),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.current_thread_processors(),
        }
    }

    fn max_processor_time(&self) -> f64 {
        match self {
            Self::Target(p) => p.max_processor_time(),
            #[cfg(test)]
            Self::Fallback(p) => p.max_processor_time(),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.max_processor_time(),
        }
    }

    fn active_processor_count(&self) -> usize {
        match self {
            Self::Target(p) => p.active_processor_count(),
            #[cfg(test)]
            Self::Fallback(p) => p.active_processor_count(),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(p) => p.active_processor_count(),
        }
    }
}

impl From<&'static BuildTargetPlatform> for PlatformFacade {
    fn from(p: &'static BuildTargetPlatform) -> Self {
        Self::Target(p)
    }
}

#[cfg_attr(coverage_nightly, coverage(off))] // No API contract to test.
impl Debug for PlatformFacade {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Target(inner) => inner.fmt(f),
            #[cfg(test)]
            Self::Fallback(inner) => inner.fmt(f),
            #[cfg(any(test, feature = "test-util"))]
            Self::Fake(inner) => inner.fmt(f),
        }
    }
}