core_affinity_rs/README.md
Michael Gmelin 274f097eb0 Actually set/get cpu affinity on FreeBSD
This replaces the stubs with an actual implementation based on FreeBSD's
cpuset_*affinity functions (FreeBSD's sched_*affinity functions currently
operate on process id instead of thread id, so they couldn't be used).

I didn't test this beyond unit tests.
2022-12-15 18:05:14 +01:00

63 lines
2 KiB
Markdown

`core_affinity_rs` is a Rust crate for managing CPU affinities. It currently supports Linux, Mac OSX, and Windows.
[Documentation](https://docs.rs/core_affinity)
[![Linux Status](https://travis-ci.org/Elzair/core_affinity_rs.svg?branch=master)](https://travis-ci.org/Elzair/core_affinity_rs)
[![Build status](https://ci.appveyor.com/api/projects/status/065hefrnkxg5dllt?svg=true)](https://ci.appveyor.com/project/Elzair/core-affinity-rs)
# Example
This example shows how create a thread for each available processor and pin each thread to its corresponding processor.
```rust
extern crate core_affinity;
use std::thread;
// Retrieve the IDs of all cores on which the current
// thread is allowed to run.
// NOTE: If you want ALL the possible cores, you should
// use num_cpus.
let core_ids = core_affinity::get_core_ids().unwrap();
// Create a thread for each active CPU core.
let handles = core_ids.into_iter().map(|id| {
thread::spawn(move || {
// Pin this thread to a single CPU core.
let res = core_affinity::set_for_current(id);
if (res) {
// Do more work after this.
}
})
}).collect::<Vec<_>>();
for handle in handles.into_iter() {
handle.join().unwrap();
}
```
# Platforms
`core_affinity_rs` should work on Linux, Windows, Mac OSX, FreeBSD, and Android.
`core_affinity_rs` is continuously tested on:
* `x86_64-unknown-linux-gnu` (Linux)
* `i686-unknown-linux-gnu`
* `x86_64-unknown-linux-musl` (Linux w/ [MUSL](https://www.musl-libc.org/))
* `i686-unknown-linux-musl`
* `x86_64-apple-darwin` (Mac OSX)
* `i686-apple-darwin`
* `x86_64-pc-windows-msvc` (Windows)
* `i686-pc-windows-msvc`
* `x86_64-pc-windows-gnu`
* `i686-pc-windows-gnu`
`core_affinity_rs` is continuously cross-compiled for:
* `arm-unknown-linux-gnueabihf`
* `aarch64-unknown-linux-gnu`
* `mips-unknown-linux-gnu`
* `aarch64-unknown-linux-musl`
* `i686-linux-android`
* `x86_64-linux-android`
* `arm-linux-androideabi`
* `aarch64-linux-android`