many_cpus 2.4.0

Efficiently schedule work and inspect the hardware environment on many-processor systems
Documentation
#![cfg_attr(coverage_nightly, coverage(off))]

use std::fmt::Debug;

use derive_more::derive::Display;

#[cfg(any(test, feature = "test-util"))]
use crate::fake::platform::FakeProcessor;
#[cfg(test)]
use crate::pal::fallback::ProcessorImpl as FallbackProcessor;
use crate::pal::{AbstractProcessor, ProcessorImpl};

#[derive(Clone, Copy, Display, Eq, Hash, PartialEq)]
pub(crate) enum ProcessorFacade {
    Target(ProcessorImpl),

    #[cfg(test)]
    Fallback(FallbackProcessor),

    /// Fake processor for the public test-util feature.
    #[cfg(any(test, feature = "test-util"))]
    Fake(FakeProcessor),
}

impl ProcessorFacade {
    // Only available on platforms with native support. The fallback platform does not need
    // direct access to the underlying ProcessorImpl type.
    #[cfg(all(any(windows, target_os = "linux"), not(miri)))]
    pub(crate) fn as_target(&self) -> &ProcessorImpl {
        match self {
            Self::Target(p) => p,
            #[cfg(test)]
            _ => panic!("attempted to dereference facade into wrong type"),
            #[cfg(all(any(test, feature = "test-util"), not(test)))]
            Self::Fake(_) => panic!("attempted to dereference facade into wrong type"),
        }
    }
}

impl AsRef<Self> for ProcessorFacade {
    fn as_ref(&self) -> &Self {
        self
    }
}

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

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

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

impl From<ProcessorImpl> for ProcessorFacade {
    fn from(p: ProcessorImpl) -> Self {
        Self::Target(p)
    }
}

#[cfg(any(test, feature = "test-util"))]
impl From<FakeProcessor> for ProcessorFacade {
    fn from(p: FakeProcessor) -> Self {
        Self::Fake(p)
    }
}

#[cfg_attr(coverage_nightly, coverage(off))] // No API contract to test.
impl Debug for ProcessorFacade {
    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),
        }
    }
}