Skip to main content

Capabilities

Struct Capabilities 

Source
pub struct Capabilities {
    pub strict_memory_binding: bool,
    pub strict_cpu_affinity: bool,
    pub memory_locking: bool,
    pub numa_balancing_disabled: bool,
    pub numa_node_count: usize,
}
Expand description

Detected system capabilities for NUMA operations.

This struct provides information about what NUMA features are available on the current system, including kernel capabilities, system settings, and hardware topology.

§Example

use numaperf_core::Capabilities;

let caps = Capabilities::detect();
println!("System capabilities: {}", caps.summary());

if caps.supports_hard_mode() {
    println!("Hard mode is fully supported");
} else {
    println!("Missing capabilities:");
    for cap in caps.missing_for_hard_mode() {
        println!("  - {}", cap);
    }
}

Fields§

§strict_memory_binding: bool

Has CAP_SYS_ADMIN (for strict memory binding with MPOL_BIND).

§strict_cpu_affinity: bool

Has CAP_SYS_NICE (for strict CPU affinity with realtime scheduling).

§memory_locking: bool

Has CAP_IPC_LOCK (for memory locking with mlock).

§numa_balancing_disabled: bool

Kernel NUMA balancing is disabled (kernel.numa_balancing=0).

§numa_node_count: usize

Number of NUMA nodes detected on the system.

Implementations§

Source§

impl Capabilities

Source

pub fn detect() -> Self

Detect current system capabilities.

This reads from /proc and /sys filesystems to determine what NUMA features are available.

Source

pub fn supports_hard_mode(&self) -> bool

Check if all hard mode requirements are met.

Hard mode requires:

  • CAP_SYS_ADMIN for strict memory binding
  • CAP_SYS_NICE for strict CPU affinity
  • NUMA balancing disabled to prevent kernel migration
Source

pub fn missing_for_hard_mode(&self) -> Vec<&'static str>

Get a list of missing capabilities required for hard mode.

Returns an empty list if supports_hard_mode() returns true.

Source

pub fn is_numa_system(&self) -> bool

Check if this is a NUMA system (more than one node).

Source

pub fn summary(&self) -> String

Generate a human-readable summary of detected capabilities.

Trait Implementations§

Source§

impl Clone for Capabilities

Source§

fn clone(&self) -> Capabilities

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Capabilities

Source§

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

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

impl Display for Capabilities

Source§

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

Formats the value using the given formatter. Read more

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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.