Skip to content

Commit 7b91eb6

Browse files
joshdonhtejun
authored andcommitted
cgroup: Fix documentation for cpu.idle
Two problems: - cpu.idle cgroups show up with 0 weight, correct the documentation to indicate this. - cpu.idle has no entry describing it. Signed-off-by: Josh Don <[email protected]> Signed-off-by: Tejun Heo <[email protected]>
1 parent 877c737 commit 7b91eb6

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

Documentation/admin-guide/cgroup-v2.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1093,7 +1093,11 @@ All time durations are in microseconds.
10931093
A read-write single value file which exists on non-root
10941094
cgroups. The default is "100".
10951095

1096-
The weight in the range [1, 10000].
1096+
For non idle groups (cpu.idle = 0), the weight is in the
1097+
range [1, 10000].
1098+
1099+
If the cgroup has been configured to be SCHED_IDLE (cpu.idle = 1),
1100+
then the weight will show as a 0.
10971101

10981102
cpu.weight.nice
10991103
A read-write single value file which exists on non-root
@@ -1157,6 +1161,16 @@ All time durations are in microseconds.
11571161
values similar to the sched_setattr(2). This maximum utilization
11581162
value is used to clamp the task specific maximum utilization clamp.
11591163

1164+
cpu.idle
1165+
A read-write single value file which exists on non-root cgroups.
1166+
The default is 0.
1167+
1168+
This is the cgroup analog of the per-task SCHED_IDLE sched policy.
1169+
Setting this value to a 1 will make the scheduling policy of the
1170+
cgroup SCHED_IDLE. The threads inside the cgroup will retain their
1171+
own relative priorities, but the cgroup itself will be treated as
1172+
very low priority relative to its peers.
1173+
11601174

11611175

11621176
Memory

0 commit comments

Comments
 (0)