numaperf-core 0.1.0

Core types and error handling for the numaperf NUMA runtime
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

# numaperf-core

[![Crates.io](https://img.shields.io/crates/v/numaperf-core.svg)](https://crates.io/crates/numaperf-core)
[![Documentation](https://img.shields.io/badge/docs-skelfresearch.com-blue)](https://docs.skelfresearch.com/numaperf/api/core-types/)

**Core types and error handling for the numaperf NUMA runtime.**

## Overview

numaperf-core provides the foundational types used throughout the numaperf workspace: type-safe identifiers for NUMA nodes and CPUs, efficient bitset implementations for CPU and node masks, and a unified error type.

## Usage

```toml
[dependencies]
numaperf-core = "0.1"
```

Most users should use the `numaperf` facade crate instead.

## Example

```rust
use numaperf_core::{NodeId, CpuSet, NodeMask};

// Type-safe node identifier
let node = NodeId::new(0);

// CPU set with bitmap operations
let mut cpus = CpuSet::new();
cpus.add(0);
cpus.add(1);
assert!(cpus.contains(0));

// Node mask for memory policies
let mask = NodeMask::single(node);
```

## Types

- **`NodeId`** - Type-safe NUMA node identifier
- **`CpuSet`** - Efficient CPU set with bitmap operations
- **`NodeMask`** - NUMA node set for memory policies
- **`NumaError`** - Unified error type for all numaperf operations
- **`HardMode`** - Soft vs strict enforcement mode
- **`Capabilities`** - System capability detection

## Part of numaperf

This crate is part of the [numaperf](https://github.com/Skelf-Research/numaperf) workspace.

- [Documentation](https://docs.skelfresearch.com/numaperf)
- [GitHub](https://github.com/Skelf-Research/numaperf)

## License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.