diff options
| author | The8472 <git@infinite-source.de> | 2021-11-19 22:52:09 +0100 |
|---|---|---|
| committer | The8472 <git@infinite-source.de> | 2021-11-19 22:52:09 +0100 |
| commit | 39b98e8c1a86a2788c05930779b343dd4c334971 (patch) | |
| tree | 4401b93bf3b394234de2fed9ffd91e1cd1422ab5 /library/std | |
| parent | 18fa4342fc215fe9e714307db694eaa8f5dc4a0d (diff) | |
| download | rust-39b98e8c1a86a2788c05930779b343dd4c334971.tar.gz rust-39b98e8c1a86a2788c05930779b343dd4c334971.zip | |
Expand available_parallelism docs in anticipation of cgroup quotas
The "fixed" in "fixed steady state limits" means to exclude load-dependent resource prioritization that would calculate to 100% of capacity on an idle system and less capacity on a loaded system. Additionally I also exclude "system load" since it would be silly to try to identify other, perhaps higher priority, processes hogging some CPU cores that aren't explicitly excluded by masks/quotas/whatever.
Diffstat (limited to 'library/std')
| -rw-r--r-- | library/std/src/thread/mod.rs | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/library/std/src/thread/mod.rs b/library/std/src/thread/mod.rs index 39b53b51bfa..343d3ef8dc5 100644 --- a/library/std/src/thread/mod.rs +++ b/library/std/src/thread/mod.rs @@ -1460,9 +1460,12 @@ fn _assert_sync_and_send() { /// The purpose of this API is to provide an easy and portable way to query /// the default amount of parallelism the program should use. Among other things it /// does not expose information on NUMA regions, does not account for -/// differences in (co)processor capabilities, and will not modify the program's -/// global state in order to more accurately query the amount of available -/// parallelism. +/// differences in (co)processor capabilities or current system load, +/// and will not modify the program's global state in order to more accurately +/// query the amount of available parallelism. +/// +/// Where both fixed steady-state and burst limits are available the steady-state +/// capacity will be used to ensure more predictable latencies. /// /// Resource limits can be changed during the runtime of a program, therefore the value is /// not cached and instead recomputed every time this function is called. It should not be |
