aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/admin-guide/cgroup-v2.rst')
-rw-r--r--Documentation/admin-guide/cgroup-v2.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index 52d093b0a250..15779d9ff681 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -694,6 +694,12 @@ Conventions
694 informational files on the root cgroup which end up showing global 694 informational files on the root cgroup which end up showing global
695 information available elsewhere shouldn't exist. 695 information available elsewhere shouldn't exist.
696 696
697- The default time unit is microseconds. If a different unit is ever
698 used, an explicit unit suffix must be present.
699
700- A parts-per quantity should use a percentage decimal with at least
701 two digit fractional part - e.g. 13.40.
702
697- If a controller implements weight based resource distribution, its 703- If a controller implements weight based resource distribution, its
698 interface file should be named "weight" and have the range [1, 704 interface file should be named "weight" and have the range [1,
699 10000] with 100 as the default. The values are chosen to allow 705 10000] with 100 as the default. The values are chosen to allow
@@ -907,6 +913,13 @@ controller implements weight and absolute bandwidth limit models for
907normal scheduling policy and absolute bandwidth allocation model for 913normal scheduling policy and absolute bandwidth allocation model for
908realtime scheduling policy. 914realtime scheduling policy.
909 915
916In all the above models, cycles distribution is defined only on a temporal
917base and it does not account for the frequency at which tasks are executed.
918The (optional) utilization clamping support allows to hint the schedutil
919cpufreq governor about the minimum desired frequency which should always be
920provided by a CPU, as well as the maximum desired frequency, which should not
921be exceeded by a CPU.
922
910WARNING: cgroup2 doesn't yet support control of realtime processes and 923WARNING: cgroup2 doesn't yet support control of realtime processes and
911the cpu controller can only be enabled when all RT processes are in 924the cpu controller can only be enabled when all RT processes are in
912the root cgroup. Be aware that system management software may already 925the root cgroup. Be aware that system management software may already
@@ -972,6 +985,33 @@ All time durations are in microseconds.
972 Shows pressure stall information for CPU. See 985 Shows pressure stall information for CPU. See
973 Documentation/accounting/psi.txt for details. 986 Documentation/accounting/psi.txt for details.
974 987
988 cpu.uclamp.min
989 A read-write single value file which exists on non-root cgroups.
990 The default is "0", i.e. no utilization boosting.
991
992 The requested minimum utilization (protection) as a percentage
993 rational number, e.g. 12.34 for 12.34%.
994
995 This interface allows reading and setting minimum utilization clamp
996 values similar to the sched_setattr(2). This minimum utilization
997 value is used to clamp the task specific minimum utilization clamp.
998
999 The requested minimum utilization (protection) is always capped by
1000 the current value for the maximum utilization (limit), i.e.
1001 `cpu.uclamp.max`.
1002
1003 cpu.uclamp.max
1004 A read-write single value file which exists on non-root cgroups.
1005 The default is "max". i.e. no utilization capping
1006
1007 The requested maximum utilization (limit) as a percentage rational
1008 number, e.g. 98.76 for 98.76%.
1009
1010 This interface allows reading and setting maximum utilization clamp
1011 values similar to the sched_setattr(2). This maximum utilization
1012 value is used to clamp the task specific maximum utilization clamp.
1013
1014
975 1015
976Memory 1016Memory
977------ 1017------