scx_utils 1.1.0

Utilities for sched_ext schedulers
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

// Copyright (c) Meta Platforms, Inc. and affiliates.
//
// This software may be used and distributed according to the terms of the
// GNU General Public License version 2.

//! # Utility collection for sched_ext schedulers
//!
//! [sched_ext](https://github.com/sched-ext/scx) is a Linux kernel feature
//! which enables implementing kernel thread schedulers in BPF and dynamically
//! loading them.
//!
//! This crate is a collection of utilities for sched_ext scheduler
//! implementations which use Rust for userspace component. This enables
//! implementing hot paths in BPF while offloading colder and more complex
//! operations to userspace Rust code which can be significantly more convenient
//! and powerful.
//!
//! The utilities can be put into two broad categories.
//!
//! ## Build Utilities
//!
//! BPF being its own CPU architecture and independent runtime environment,
//! build environment and steps are already rather complex. The need to
//! interface between two different languages - C and Rust - adds further
//! complexities. This crate contains `struct BpfBuilder` which is to be
//! used from `build.rs` and automates most of the process.
//!
//! ## Utilities for Rust Userspace Component
//!
//! Utility modules which can be useful for userspace component of sched_ext
//! schedulers.

pub use log::info;
pub use log::warn;
pub use paste::paste;

/// Gated exports of `scx_cargo::BpfBuilder` to avoid breaking existing users with this API change.
/// Please switch build time support to the `scx_cargo` crate.
#[cfg(feature = "deprecated-build-support")]
pub use scx_cargo::{BpfBuilder, ClangInfo};

mod bindings;

mod user_exit_info;
pub use user_exit_info::ScxConsts;
pub use user_exit_info::ScxExitKind;
pub use user_exit_info::UeiDumpPtr;
pub use user_exit_info::UserExitInfo;
pub use user_exit_info::SCX_ECODE_ACT_RESTART;
pub use user_exit_info::SCX_ECODE_RSN_HOTPLUG;
pub use user_exit_info::UEI_DUMP_PTR_MUTEX;

pub mod build_id;
pub mod compat;
pub use compat::ksym_exists;
pub use compat::ROOT_PREFIX;

mod libbpf_logger;
pub use libbpf_logger::init_libbpf_logging;
pub mod libbpf_clap_opts;

pub mod ravg;

mod topology;
#[cfg(any(test, feature = "testutils"))]
pub use topology::testutils;
pub use topology::Core;
pub use topology::CoreType;
pub use topology::Cpu;
pub use topology::Llc;
pub use topology::Node;
pub use topology::Topology;
pub use topology::NR_CPUS_POSSIBLE;
pub use topology::NR_CPU_IDS;

mod energy_model;
pub use energy_model::EnergyModel;
pub use energy_model::PerfDomain;
pub use energy_model::PerfState;

mod cpumask;
pub use cpumask::read_cpulist;
#[cfg(any(test, feature = "testutils"))]
pub use cpumask::set_cpumask_test_width;
pub use cpumask::Cpumask;

mod gpu;
#[cfg(feature = "gpu-topology")]
pub use gpu::GpuIndex;

mod infeasible;
pub use infeasible::LoadAggregator;
pub use infeasible::LoadLedger;

pub mod mangoapp;

pub mod misc;
pub use misc::monitor_stats;
pub use misc::normalize_load_metric;
pub use misc::try_set_rlimit_infinity;

mod netdev;
pub use netdev::read_netdevs;
pub use netdev::NetDev;

pub mod pm;

pub mod enums;
pub use enums::scx_enums;

pub mod cli;
pub use cli::TopologyArgs;

#[cfg(feature = "autopower")]
pub mod autopower;

pub mod perf;