Skip to main content

CpuTopology

Struct CpuTopology 

Source
pub struct CpuTopology { /* private fields */ }
Expand description

The SMT layout of the logical CPUs this process may run on: for each allowed CPU, in ascending id order, the set of CPUs sharing its physical core.

An empty sibling list means “sysfs did not answer for this CPU”. Such a CPU is treated as a physical core of its own and is never merged with another unknown one — guessing that two unreadable CPUs are siblings would silently halve the pool on any host that simply has no topology/ directory (a container with a masked /sys, some hypervisors, anything non-Linux), and that regression arrives with no error attached to it.

Implementations§

Source§

impl CpuTopology

Source

pub fn from_sibling_lists<I>(entries: I) -> Self
where I: IntoIterator<Item = (usize, Vec<usize>)>,

Build a topology from explicit sibling lists — the injection point that makes every rule in this module testable on a host with no SMT, no root, and no particular CPU count.

Entries are sorted by CPU id and deduplicated, because the rules pick the first allowed CPU of each physical core as that core’s representative and that choice must not depend on the order the caller happened to enumerate in.

Source

pub fn read_from(root: &Path, allowed: &[usize]) -> Self

Read {root}/cpu{n}/topology/thread_siblings_list for each CPU in allowed. A CPU whose file is missing or unreadable gets an empty sibling list (see the type docs: it becomes its own core), so a host without sysfs topology degrades to one worker per allowed CPU instead of erroring out mid-boot.

Source

pub fn detect() -> Self

This host’s topology: SYSFS_CPU_ROOT restricted to process_affinity_cpus.

Source

pub fn allowed_cpus(&self) -> Vec<usize>

The allowed logical CPUs, ascending.

Source

pub fn len(&self) -> usize

Number of allowed logical CPUs, SMT siblings included.

Source

pub fn is_empty(&self) -> bool

Whether no CPU at all is described.

Trait Implementations§

Source§

impl Clone for CpuTopology

Source§

fn clone(&self) -> CpuTopology

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CpuTopology

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CpuTopology

Source§

fn default() -> CpuTopology

Returns the “default value” for a type. Read more
Source§

impl Eq for CpuTopology

Source§

impl PartialEq for CpuTopology

Source§

fn eq(&self, other: &CpuTopology) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CpuTopology

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.