themis-topology 0.11.1

Typed placement law for NUMA, HBM, memory-tier, and worker locality contracts
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

//! Typed placement law for Atlas memory and runtime crates.
//!
//! Themis owns placement vocabulary, not allocation or execution. Mnemosyne
//! consumes these types to choose memory locality. Moirai consumes these types
//! to choose worker and task locality.

#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(nightly_tls_active, feature(thread_local))]
#![deny(unsafe_op_in_unsafe_fn)]
#![deny(missing_docs)]

#[cfg(feature = "std")]
extern crate std;

mod law;
mod query;
mod topology;

#[cfg(feature = "melinoe")]
mod branded;

#[cfg(feature = "melinoe")]
pub use branded::{
    sync_region_placement_scope, thread_local_placement_scope, ConstNumaNodePlacement,
    ConstNumaPinnedCell, ConstNumaPinnedCellRef, ConstNumaPinnedSlice, ConstNumaPinnedSliceRef,
    ConstPinnedCell, ConstPinnedSlice, ConstThreadLocalNumaPlacement, NumaNodePlacement,
    NumaPinnedCell, NumaPinnedCellRef, NumaPinnedSlice, NumaPinnedSliceRef, PinnedCell,
    PinnedSlice, SyncRegionPlacement, ThreadLocalNumaPlacement, ThreadLocalPlacement,
};
pub use law::{
    LocalityDomainId, MemoryTier, NumaBucketIndex, NumaNodeId, PlacementHint, TopologyEpoch,
    WorkerId,
};
pub use query::{
    current_numa_node, current_processor, refresh_current_numa_node, try_current_numa_node,
};
#[cfg(feature = "std")]
pub use topology::{bind_current_thread, BindError};
pub use topology::{
    CacheLevel, CoreId, CpuEfficiencyView, CpuSmtView, CpuTopology, EfficiencyClass,
    GpuDeviceProperties, GpuTopology, NumaNode, TpuDeviceProperties, TpuTopology,
};
#[cfg(windows)]
pub use topology::{ProcessorAffinityGroups, ProcessorGroupAffinity};

// Test-only re-exports for integration tests (they are `pub` at definition
// site but live inside a private `mod topology`, so crate-root re-export
// is required for integration-test access). Gated on `feature = "testing"`
// (not just `cfg(test)`) because integration tests in `tests/` consume the
// lib as a regular dependency; `cfg(test)` only activates when the lib itself
// is the test target, not when it is depended on.
#[cfg(any(test, feature = "testing"))]
pub use topology::{
    build_adjacent_nodes, build_default_distance_row, build_node_to_index, build_processor_to_node,
};