corescout-substrate 1.1.0

Linux hardware discovery and passive observation. The only crate that touches hardware.
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

//! Fallback backend for platforms CoreScout does not support yet.
//!
//! It exists so the crate builds and its platform-neutral logic (CPU set
//! parsing, statistics, ranking, output formatting) stays unit-testable on any
//! developer machine, including the Windows and macOS boxes where the Linux
//! backend cannot even be compiled.

use std::process::{Child, Command};

use crate::platform::{Platform, SwitchCounters};
use crate::topology::{LogicalId, Topology};
use corescout_core::cpuset::CpuSet;
use corescout_core::error::{Error, Result};

/// A [`Platform`] whose every operation reports "unsupported".
pub struct StubPlatform;

impl StubPlatform {
    pub fn new() -> Self {
        StubPlatform
    }
}

impl Default for StubPlatform {
    fn default() -> Self {
        Self::new()
    }
}

fn unsupported<T>(what: &str) -> Result<T> {
    Err(Error::unsupported(format!(
        "{what} (CoreScout currently implements Linux only; \
         see platform/mod.rs for the Windows porting notes)"
    )))
}

impl Platform for StubPlatform {
    fn name(&self) -> &'static str {
        "unsupported"
    }

    fn discover_topology(&self) -> Result<Topology> {
        unsupported("topology discovery")
    }

    fn pin_current_thread(&self, _cpu: LogicalId) -> Result<()> {
        unsupported("thread pinning")
    }

    fn set_current_thread_affinity(&self, _cpus: &CpuSet) -> Result<()> {
        unsupported("thread affinity")
    }

    fn current_thread_affinity(&self) -> Result<CpuSet> {
        unsupported("thread affinity")
    }

    fn process_affinity(&self) -> Result<CpuSet> {
        unsupported("process affinity")
    }

    fn thread_switch_counters(&self) -> Option<SwitchCounters> {
        None
    }

    fn spawn_with_affinity(&self, _command: &mut Command, _cpus: &CpuSet) -> Result<Child> {
        unsupported("affinity-constrained process launch")
    }
}