]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - Documentation/cgroup-v2.txt
cgroup: misc cleanups
[mirror_ubuntu-bionic-kernel.git] / Documentation / cgroup-v2.txt
CommitLineData
6c292092
TH
1
2Control Group v2
3
4October, 2015 Tejun Heo <tj@kernel.org>
5
6This is the authoritative documentation on the design, interface and
7conventions of cgroup v2. It describes all userland-visible aspects
8of cgroup including core and specific controller behaviors. All
9future changes must be reflected in this document. Documentation for
9a2ddda5 10v1 is available under Documentation/cgroup-v1/.
6c292092
TH
11
12CONTENTS
13
141. Introduction
15 1-1. Terminology
16 1-2. What is cgroup?
172. Basic Operations
18 2-1. Mounting
19 2-2. Organizing Processes
20 2-3. [Un]populated Notification
21 2-4. Controlling Controllers
22 2-4-1. Enabling and Disabling
23 2-4-2. Top-down Constraint
24 2-4-3. No Internal Process Constraint
25 2-5. Delegation
26 2-5-1. Model of Delegation
27 2-5-2. Delegation Containment
28 2-6. Guidelines
29 2-6-1. Organize Once and Control
30 2-6-2. Avoid Name Collisions
313. Resource Distribution Models
32 3-1. Weights
33 3-2. Limits
34 3-3. Protections
35 3-4. Allocations
364. Interface Files
37 4-1. Format
38 4-2. Conventions
39 4-3. Core Interface Files
405. Controllers
41 5-1. CPU
42 5-1-1. CPU Interface Files
43 5-2. Memory
44 5-2-1. Memory Interface Files
45 5-2-2. Usage Guidelines
46 5-2-3. Memory Ownership
47 5-3. IO
48 5-3-1. IO Interface Files
49 5-3-2. Writeback
20c56e59
HR
50 5-4. PID
51 5-4-1. PID Interface Files
d4021f6c
SH
526. Namespace
53 6-1. Basics
54 6-2. The Root and Views
55 6-3. Migration and setns(2)
56 6-4. Interaction with Other Namespaces
6c292092
TH
57P. Information on Kernel Programming
58 P-1. Filesystem Support for Writeback
59D. Deprecated v1 Core Features
60R. Issues with v1 and Rationales for v2
61 R-1. Multiple Hierarchies
62 R-2. Thread Granularity
63 R-3. Competition Between Inner Nodes and Threads
64 R-4. Other Interface Issues
65 R-5. Controller Issues and Remedies
66 R-5-1. Memory
67
68
691. Introduction
70
711-1. Terminology
72
73"cgroup" stands for "control group" and is never capitalized. The
74singular form is used to designate the whole feature and also as a
75qualifier as in "cgroup controllers". When explicitly referring to
76multiple individual control groups, the plural form "cgroups" is used.
77
78
791-2. What is cgroup?
80
81cgroup is a mechanism to organize processes hierarchically and
82distribute system resources along the hierarchy in a controlled and
83configurable manner.
84
85cgroup is largely composed of two parts - the core and controllers.
86cgroup core is primarily responsible for hierarchically organizing
87processes. A cgroup controller is usually responsible for
88distributing a specific type of system resource along the hierarchy
89although there are utility controllers which serve purposes other than
90resource distribution.
91
92cgroups form a tree structure and every process in the system belongs
93to one and only one cgroup. All threads of a process belong to the
94same cgroup. On creation, all processes are put in the cgroup that
95the parent process belongs to at the time. A process can be migrated
96to another cgroup. Migration of a process doesn't affect already
97existing descendant processes.
98
99Following certain structural constraints, controllers may be enabled or
100disabled selectively on a cgroup. All controller behaviors are
101hierarchical - if a controller is enabled on a cgroup, it affects all
102processes which belong to the cgroups consisting the inclusive
103sub-hierarchy of the cgroup. When a controller is enabled on a nested
104cgroup, it always restricts the resource distribution further. The
105restrictions set closer to the root in the hierarchy can not be
106overridden from further away.
107
108
1092. Basic Operations
110
1112-1. Mounting
112
113Unlike v1, cgroup v2 has only single hierarchy. The cgroup v2
114hierarchy can be mounted with the following mount command.
115
116 # mount -t cgroup2 none $MOUNT_POINT
117
118cgroup2 filesystem has the magic number 0x63677270 ("cgrp"). All
119controllers which support v2 and are not bound to a v1 hierarchy are
120automatically bound to the v2 hierarchy and show up at the root.
121Controllers which are not in active use in the v2 hierarchy can be
122bound to other hierarchies. This allows mixing v2 hierarchy with the
123legacy v1 multiple hierarchies in a fully backward compatible way.
124
125A controller can be moved across hierarchies only after the controller
126is no longer referenced in its current hierarchy. Because per-cgroup
127controller states are destroyed asynchronously and controllers may
128have lingering references, a controller may not show up immediately on
129the v2 hierarchy after the final umount of the previous hierarchy.
130Similarly, a controller should be fully disabled to be moved out of
131the unified hierarchy and it may take some time for the disabled
132controller to become available for other hierarchies; furthermore, due
133to inter-controller dependencies, other controllers may need to be
134disabled too.
135
136While useful for development and manual configurations, moving
137controllers dynamically between the v2 and other hierarchies is
138strongly discouraged for production use. It is recommended to decide
139the hierarchies and controller associations before starting using the
140controllers after system boot.
141
1619b6d4
JW
142During transition to v2, system management software might still
143automount the v1 cgroup filesystem and so hijack all controllers
144during boot, before manual intervention is possible. To make testing
145and experimenting easier, the kernel parameter cgroup_no_v1= allows
146disabling controllers in v1 and make them always available in v2.
147
6c292092
TH
148
1492-2. Organizing Processes
150
151Initially, only the root cgroup exists to which all processes belong.
152A child cgroup can be created by creating a sub-directory.
153
154 # mkdir $CGROUP_NAME
155
156A given cgroup may have multiple child cgroups forming a tree
157structure. Each cgroup has a read-writable interface file
158"cgroup.procs". When read, it lists the PIDs of all processes which
159belong to the cgroup one-per-line. The PIDs are not ordered and the
160same PID may show up more than once if the process got moved to
161another cgroup and then back or the PID got recycled while reading.
162
163A process can be migrated into a cgroup by writing its PID to the
164target cgroup's "cgroup.procs" file. Only one process can be migrated
165on a single write(2) call. If a process is composed of multiple
166threads, writing the PID of any thread migrates all threads of the
167process.
168
169When a process forks a child process, the new process is born into the
170cgroup that the forking process belongs to at the time of the
171operation. After exit, a process stays associated with the cgroup
172that it belonged to at the time of exit until it's reaped; however, a
173zombie process does not appear in "cgroup.procs" and thus can't be
174moved to another cgroup.
175
176A cgroup which doesn't have any children or live processes can be
177destroyed by removing the directory. Note that a cgroup which doesn't
178have any children and is associated only with zombie processes is
179considered empty and can be removed.
180
181 # rmdir $CGROUP_NAME
182
183"/proc/$PID/cgroup" lists a process's cgroup membership. If legacy
184cgroup is in use in the system, this file may contain multiple lines,
185one for each hierarchy. The entry for cgroup v2 is always in the
186format "0::$PATH".
187
188 # cat /proc/842/cgroup
189 ...
190 0::/test-cgroup/test-cgroup-nested
191
192If the process becomes a zombie and the cgroup it was associated with
193is removed subsequently, " (deleted)" is appended to the path.
194
195 # cat /proc/842/cgroup
196 ...
197 0::/test-cgroup/test-cgroup-nested (deleted)
198
199
2002-3. [Un]populated Notification
201
202Each non-root cgroup has a "cgroup.events" file which contains
203"populated" field indicating whether the cgroup's sub-hierarchy has
204live processes in it. Its value is 0 if there is no live process in
205the cgroup and its descendants; otherwise, 1. poll and [id]notify
206events are triggered when the value changes. This can be used, for
207example, to start a clean-up operation after all processes of a given
208sub-hierarchy have exited. The populated state updates and
209notifications are recursive. Consider the following sub-hierarchy
210where the numbers in the parentheses represent the numbers of processes
211in each cgroup.
212
213 A(4) - B(0) - C(1)
214 \ D(0)
215
216A, B and C's "populated" fields would be 1 while D's 0. After the one
217process in C exits, B and C's "populated" fields would flip to "0" and
218file modified events will be generated on the "cgroup.events" files of
219both cgroups.
220
221
2222-4. Controlling Controllers
223
2242-4-1. Enabling and Disabling
225
226Each cgroup has a "cgroup.controllers" file which lists all
227controllers available for the cgroup to enable.
228
229 # cat cgroup.controllers
230 cpu io memory
231
232No controller is enabled by default. Controllers can be enabled and
233disabled by writing to the "cgroup.subtree_control" file.
234
235 # echo "+cpu +memory -io" > cgroup.subtree_control
236
237Only controllers which are listed in "cgroup.controllers" can be
238enabled. When multiple operations are specified as above, either they
239all succeed or fail. If multiple operations on the same controller
240are specified, the last one is effective.
241
242Enabling a controller in a cgroup indicates that the distribution of
243the target resource across its immediate children will be controlled.
244Consider the following sub-hierarchy. The enabled controllers are
245listed in parentheses.
246
247 A(cpu,memory) - B(memory) - C()
248 \ D()
249
250As A has "cpu" and "memory" enabled, A will control the distribution
251of CPU cycles and memory to its children, in this case, B. As B has
252"memory" enabled but not "CPU", C and D will compete freely on CPU
253cycles but their division of memory available to B will be controlled.
254
255As a controller regulates the distribution of the target resource to
256the cgroup's children, enabling it creates the controller's interface
257files in the child cgroups. In the above example, enabling "cpu" on B
258would create the "cpu." prefixed controller interface files in C and
259D. Likewise, disabling "memory" from B would remove the "memory."
260prefixed controller interface files from C and D. This means that the
261controller interface files - anything which doesn't start with
262"cgroup." are owned by the parent rather than the cgroup itself.
263
264
2652-4-2. Top-down Constraint
266
267Resources are distributed top-down and a cgroup can further distribute
268a resource only if the resource has been distributed to it from the
269parent. This means that all non-root "cgroup.subtree_control" files
270can only contain controllers which are enabled in the parent's
271"cgroup.subtree_control" file. A controller can be enabled only if
272the parent has the controller enabled and a controller can't be
273disabled if one or more children have it enabled.
274
275
2762-4-3. No Internal Process Constraint
277
278Non-root cgroups can only distribute resources to their children when
279they don't have any processes of their own. In other words, only
280cgroups which don't contain any processes can have controllers enabled
281in their "cgroup.subtree_control" files.
282
283This guarantees that, when a controller is looking at the part of the
284hierarchy which has it enabled, processes are always only on the
285leaves. This rules out situations where child cgroups compete against
286internal processes of the parent.
287
288The root cgroup is exempt from this restriction. Root contains
289processes and anonymous resource consumption which can't be associated
290with any other cgroups and requires special treatment from most
291controllers. How resource consumption in the root cgroup is governed
292is up to each controller.
293
294Note that the restriction doesn't get in the way if there is no
295enabled controller in the cgroup's "cgroup.subtree_control". This is
296important as otherwise it wouldn't be possible to create children of a
297populated cgroup. To control resource distribution of a cgroup, the
298cgroup must create children and transfer all its processes to the
299children before enabling controllers in its "cgroup.subtree_control"
300file.
301
302
3032-5. Delegation
304
3052-5-1. Model of Delegation
306
307A cgroup can be delegated to a less privileged user by granting write
308access of the directory and its "cgroup.procs" file to the user. Note
309that resource control interface files in a given directory control the
310distribution of the parent's resources and thus must not be delegated
311along with the directory.
312
313Once delegated, the user can build sub-hierarchy under the directory,
314organize processes as it sees fit and further distribute the resources
315it received from the parent. The limits and other settings of all
316resource controllers are hierarchical and regardless of what happens
317in the delegated sub-hierarchy, nothing can escape the resource
318restrictions imposed by the parent.
319
320Currently, cgroup doesn't impose any restrictions on the number of
321cgroups in or nesting depth of a delegated sub-hierarchy; however,
322this may be limited explicitly in the future.
323
324
3252-5-2. Delegation Containment
326
327A delegated sub-hierarchy is contained in the sense that processes
328can't be moved into or out of the sub-hierarchy by the delegatee. For
329a process with a non-root euid to migrate a target process into a
330cgroup by writing its PID to the "cgroup.procs" file, the following
331conditions must be met.
332
333- The writer's euid must match either uid or suid of the target process.
334
335- The writer must have write access to the "cgroup.procs" file.
336
337- The writer must have write access to the "cgroup.procs" file of the
338 common ancestor of the source and destination cgroups.
339
340The above three constraints ensure that while a delegatee may migrate
341processes around freely in the delegated sub-hierarchy it can't pull
342in from or push out to outside the sub-hierarchy.
343
344For an example, let's assume cgroups C0 and C1 have been delegated to
345user U0 who created C00, C01 under C0 and C10 under C1 as follows and
346all processes under C0 and C1 belong to U0.
347
348 ~~~~~~~~~~~~~ - C0 - C00
349 ~ cgroup ~ \ C01
350 ~ hierarchy ~
351 ~~~~~~~~~~~~~ - C1 - C10
352
353Let's also say U0 wants to write the PID of a process which is
354currently in C10 into "C00/cgroup.procs". U0 has write access to the
355file and uid match on the process; however, the common ancestor of the
356source cgroup C10 and the destination cgroup C00 is above the points
357of delegation and U0 would not have write access to its "cgroup.procs"
358files and thus the write will be denied with -EACCES.
359
360
3612-6. Guidelines
362
3632-6-1. Organize Once and Control
364
365Migrating a process across cgroups is a relatively expensive operation
366and stateful resources such as memory are not moved together with the
367process. This is an explicit design decision as there often exist
368inherent trade-offs between migration and various hot paths in terms
369of synchronization cost.
370
371As such, migrating processes across cgroups frequently as a means to
372apply different resource restrictions is discouraged. A workload
373should be assigned to a cgroup according to the system's logical and
374resource structure once on start-up. Dynamic adjustments to resource
375distribution can be made by changing controller configuration through
376the interface files.
377
378
3792-6-2. Avoid Name Collisions
380
381Interface files for a cgroup and its children cgroups occupy the same
382directory and it is possible to create children cgroups which collide
383with interface files.
384
385All cgroup core interface files are prefixed with "cgroup." and each
386controller's interface files are prefixed with the controller name and
387a dot. A controller's name is composed of lower case alphabets and
388'_'s but never begins with an '_' so it can be used as the prefix
389character for collision avoidance. Also, interface file names won't
390start or end with terms which are often used in categorizing workloads
391such as job, service, slice, unit or workload.
392
393cgroup doesn't do anything to prevent name collisions and it's the
394user's responsibility to avoid them.
395
396
3973. Resource Distribution Models
398
399cgroup controllers implement several resource distribution schemes
400depending on the resource type and expected use cases. This section
401describes major schemes in use along with their expected behaviors.
402
403
4043-1. Weights
405
406A parent's resource is distributed by adding up the weights of all
407active children and giving each the fraction matching the ratio of its
408weight against the sum. As only children which can make use of the
409resource at the moment participate in the distribution, this is
410work-conserving. Due to the dynamic nature, this model is usually
411used for stateless resources.
412
413All weights are in the range [1, 10000] with the default at 100. This
414allows symmetric multiplicative biases in both directions at fine
415enough granularity while staying in the intuitive range.
416
417As long as the weight is in range, all configuration combinations are
418valid and there is no reason to reject configuration changes or
419process migrations.
420
421"cpu.weight" proportionally distributes CPU cycles to active children
422and is an example of this type.
423
424
4253-2. Limits
426
427A child can only consume upto the configured amount of the resource.
428Limits can be over-committed - the sum of the limits of children can
429exceed the amount of resource available to the parent.
430
431Limits are in the range [0, max] and defaults to "max", which is noop.
432
433As limits can be over-committed, all configuration combinations are
434valid and there is no reason to reject configuration changes or
435process migrations.
436
437"io.max" limits the maximum BPS and/or IOPS that a cgroup can consume
438on an IO device and is an example of this type.
439
440
4413-3. Protections
442
443A cgroup is protected to be allocated upto the configured amount of
444the resource if the usages of all its ancestors are under their
445protected levels. Protections can be hard guarantees or best effort
446soft boundaries. Protections can also be over-committed in which case
447only upto the amount available to the parent is protected among
448children.
449
450Protections are in the range [0, max] and defaults to 0, which is
451noop.
452
453As protections can be over-committed, all configuration combinations
454are valid and there is no reason to reject configuration changes or
455process migrations.
456
457"memory.low" implements best-effort memory protection and is an
458example of this type.
459
460
4613-4. Allocations
462
463A cgroup is exclusively allocated a certain amount of a finite
464resource. Allocations can't be over-committed - the sum of the
465allocations of children can not exceed the amount of resource
466available to the parent.
467
468Allocations are in the range [0, max] and defaults to 0, which is no
469resource.
470
471As allocations can't be over-committed, some configuration
472combinations are invalid and should be rejected. Also, if the
473resource is mandatory for execution of processes, process migrations
474may be rejected.
475
476"cpu.rt.max" hard-allocates realtime slices and is an example of this
477type.
478
479
4804. Interface Files
481
4824-1. Format
483
484All interface files should be in one of the following formats whenever
485possible.
486
487 New-line separated values
488 (when only one value can be written at once)
489
490 VAL0\n
491 VAL1\n
492 ...
493
494 Space separated values
495 (when read-only or multiple values can be written at once)
496
497 VAL0 VAL1 ...\n
498
499 Flat keyed
500
501 KEY0 VAL0\n
502 KEY1 VAL1\n
503 ...
504
505 Nested keyed
506
507 KEY0 SUB_KEY0=VAL00 SUB_KEY1=VAL01...
508 KEY1 SUB_KEY0=VAL10 SUB_KEY1=VAL11...
509 ...
510
511For a writable file, the format for writing should generally match
512reading; however, controllers may allow omitting later fields or
513implement restricted shortcuts for most common use cases.
514
515For both flat and nested keyed files, only the values for a single key
516can be written at a time. For nested keyed files, the sub key pairs
517may be specified in any order and not all pairs have to be specified.
518
519
5204-2. Conventions
521
522- Settings for a single feature should be contained in a single file.
523
524- The root cgroup should be exempt from resource control and thus
525 shouldn't have resource control interface files. Also,
526 informational files on the root cgroup which end up showing global
527 information available elsewhere shouldn't exist.
528
529- If a controller implements weight based resource distribution, its
530 interface file should be named "weight" and have the range [1,
531 10000] with 100 as the default. The values are chosen to allow
532 enough and symmetric bias in both directions while keeping it
533 intuitive (the default is 100%).
534
535- If a controller implements an absolute resource guarantee and/or
536 limit, the interface files should be named "min" and "max"
537 respectively. If a controller implements best effort resource
538 guarantee and/or limit, the interface files should be named "low"
539 and "high" respectively.
540
541 In the above four control files, the special token "max" should be
542 used to represent upward infinity for both reading and writing.
543
544- If a setting has a configurable default value and keyed specific
545 overrides, the default entry should be keyed with "default" and
546 appear as the first entry in the file.
547
548 The default value can be updated by writing either "default $VAL" or
549 "$VAL".
550
551 When writing to update a specific override, "default" can be used as
552 the value to indicate removal of the override. Override entries
553 with "default" as the value must not appear when read.
554
555 For example, a setting which is keyed by major:minor device numbers
556 with integer values may look like the following.
557
558 # cat cgroup-example-interface-file
559 default 150
560 8:0 300
561
562 The default value can be updated by
563
564 # echo 125 > cgroup-example-interface-file
565
566 or
567
568 # echo "default 125" > cgroup-example-interface-file
569
570 An override can be set by
571
572 # echo "8:16 170" > cgroup-example-interface-file
573
574 and cleared by
575
576 # echo "8:0 default" > cgroup-example-interface-file
577 # cat cgroup-example-interface-file
578 default 125
579 8:16 170
580
581- For events which are not very high frequency, an interface file
582 "events" should be created which lists event key value pairs.
583 Whenever a notifiable event happens, file modified event should be
584 generated on the file.
585
586
5874-3. Core Interface Files
588
589All cgroup core files are prefixed with "cgroup."
590
591 cgroup.procs
592
593 A read-write new-line separated values file which exists on
594 all cgroups.
595
596 When read, it lists the PIDs of all processes which belong to
597 the cgroup one-per-line. The PIDs are not ordered and the
598 same PID may show up more than once if the process got moved
599 to another cgroup and then back or the PID got recycled while
600 reading.
601
602 A PID can be written to migrate the process associated with
603 the PID to the cgroup. The writer should match all of the
604 following conditions.
605
606 - Its euid is either root or must match either uid or suid of
607 the target process.
608
609 - It must have write access to the "cgroup.procs" file.
610
611 - It must have write access to the "cgroup.procs" file of the
612 common ancestor of the source and destination cgroups.
613
614 When delegating a sub-hierarchy, write access to this file
615 should be granted along with the containing directory.
616
617 cgroup.controllers
618
619 A read-only space separated values file which exists on all
620 cgroups.
621
622 It shows space separated list of all controllers available to
623 the cgroup. The controllers are not ordered.
624
625 cgroup.subtree_control
626
627 A read-write space separated values file which exists on all
628 cgroups. Starts out empty.
629
630 When read, it shows space separated list of the controllers
631 which are enabled to control resource distribution from the
632 cgroup to its children.
633
634 Space separated list of controllers prefixed with '+' or '-'
635 can be written to enable or disable controllers. A controller
636 name prefixed with '+' enables the controller and '-'
637 disables. If a controller appears more than once on the list,
638 the last one is effective. When multiple enable and disable
639 operations are specified, either all succeed or all fail.
640
641 cgroup.events
642
643 A read-only flat-keyed file which exists on non-root cgroups.
644 The following entries are defined. Unless specified
645 otherwise, a value change in this file generates a file
646 modified event.
647
648 populated
649
650 1 if the cgroup or its descendants contains any live
651 processes; otherwise, 0.
652
653
6545. Controllers
655
6565-1. CPU
657
658[NOTE: The interface for the cpu controller hasn't been merged yet]
659
660The "cpu" controllers regulates distribution of CPU cycles. This
661controller implements weight and absolute bandwidth limit models for
662normal scheduling policy and absolute bandwidth allocation model for
663realtime scheduling policy.
664
665
6665-1-1. CPU Interface Files
667
668All time durations are in microseconds.
669
670 cpu.stat
671
672 A read-only flat-keyed file which exists on non-root cgroups.
673
674 It reports the following six stats.
675
676 usage_usec
677 user_usec
678 system_usec
679 nr_periods
680 nr_throttled
681 throttled_usec
682
683 cpu.weight
684
685 A read-write single value file which exists on non-root
686 cgroups. The default is "100".
687
688 The weight in the range [1, 10000].
689
690 cpu.max
691
692 A read-write two value file which exists on non-root cgroups.
693 The default is "max 100000".
694
695 The maximum bandwidth limit. It's in the following format.
696
697 $MAX $PERIOD
698
699 which indicates that the group may consume upto $MAX in each
700 $PERIOD duration. "max" for $MAX indicates no limit. If only
701 one number is written, $MAX is updated.
702
703 cpu.rt.max
704
705 [NOTE: The semantics of this file is still under discussion and the
706 interface hasn't been merged yet]
707
708 A read-write two value file which exists on all cgroups.
709 The default is "0 100000".
710
711 The maximum realtime runtime allocation. Over-committing
712 configurations are disallowed and process migrations are
713 rejected if not enough bandwidth is available. It's in the
714 following format.
715
716 $MAX $PERIOD
717
718 which indicates that the group may consume upto $MAX in each
719 $PERIOD duration. If only one number is written, $MAX is
720 updated.
721
722
7235-2. Memory
724
725The "memory" controller regulates distribution of memory. Memory is
726stateful and implements both limit and protection models. Due to the
727intertwining between memory usage and reclaim pressure and the
728stateful nature of memory, the distribution model is relatively
729complex.
730
731While not completely water-tight, all major memory usages by a given
732cgroup are tracked so that the total memory consumption can be
733accounted and controlled to a reasonable extent. Currently, the
734following types of memory usages are tracked.
735
736- Userland memory - page cache and anonymous memory.
737
738- Kernel data structures such as dentries and inodes.
739
740- TCP socket buffers.
741
742The above list may expand in the future for better coverage.
743
744
7455-2-1. Memory Interface Files
746
747All memory amounts are in bytes. If a value which is not aligned to
748PAGE_SIZE is written, the value may be rounded up to the closest
749PAGE_SIZE multiple when read back.
750
751 memory.current
752
753 A read-only single value file which exists on non-root
754 cgroups.
755
756 The total amount of memory currently being used by the cgroup
757 and its descendants.
758
759 memory.low
760
761 A read-write single value file which exists on non-root
762 cgroups. The default is "0".
763
764 Best-effort memory protection. If the memory usages of a
765 cgroup and all its ancestors are below their low boundaries,
766 the cgroup's memory won't be reclaimed unless memory can be
767 reclaimed from unprotected cgroups.
768
769 Putting more memory than generally available under this
770 protection is discouraged.
771
772 memory.high
773
774 A read-write single value file which exists on non-root
775 cgroups. The default is "max".
776
777 Memory usage throttle limit. This is the main mechanism to
778 control memory usage of a cgroup. If a cgroup's usage goes
779 over the high boundary, the processes of the cgroup are
780 throttled and put under heavy reclaim pressure.
781
782 Going over the high limit never invokes the OOM killer and
783 under extreme conditions the limit may be breached.
784
785 memory.max
786
787 A read-write single value file which exists on non-root
788 cgroups. The default is "max".
789
790 Memory usage hard limit. This is the final protection
791 mechanism. If a cgroup's memory usage reaches this limit and
792 can't be reduced, the OOM killer is invoked in the cgroup.
793 Under certain circumstances, the usage may go over the limit
794 temporarily.
795
796 This is the ultimate protection mechanism. As long as the
797 high limit is used and monitored properly, this limit's
798 utility is limited to providing the final safety net.
799
800 memory.events
801
802 A read-only flat-keyed file which exists on non-root cgroups.
803 The following entries are defined. Unless specified
804 otherwise, a value change in this file generates a file
805 modified event.
806
807 low
808
809 The number of times the cgroup is reclaimed due to
810 high memory pressure even though its usage is under
811 the low boundary. This usually indicates that the low
812 boundary is over-committed.
813
814 high
815
816 The number of times processes of the cgroup are
817 throttled and routed to perform direct memory reclaim
818 because the high memory boundary was exceeded. For a
819 cgroup whose memory usage is capped by the high limit
820 rather than global memory pressure, this event's
821 occurrences are expected.
822
823 max
824
825 The number of times the cgroup's memory usage was
826 about to go over the max boundary. If direct reclaim
827 fails to bring it down, the OOM killer is invoked.
828
829 oom
830
831 The number of times the OOM killer has been invoked in
832 the cgroup. This may not exactly match the number of
833 processes killed but should generally be close.
834
587d9f72
JW
835 memory.stat
836
837 A read-only flat-keyed file which exists on non-root cgroups.
838
839 This breaks down the cgroup's memory footprint into different
840 types of memory, type-specific details, and other information
841 on the state and past events of the memory management system.
842
843 All memory amounts are in bytes.
844
845 The entries are ordered to be human readable, and new entries
846 can show up in the middle. Don't rely on items remaining in a
847 fixed position; use the keys to look up specific values!
848
849 anon
850
851 Amount of memory used in anonymous mappings such as
852 brk(), sbrk(), and mmap(MAP_ANONYMOUS)
853
854 file
855
856 Amount of memory used to cache filesystem data,
857 including tmpfs and shared memory.
858
12580e4b
VD
859 kernel_stack
860
861 Amount of memory allocated to kernel stacks.
862
27ee57c9
VD
863 slab
864
865 Amount of memory used for storing in-kernel data
866 structures.
867
4758e198
JW
868 sock
869
870 Amount of memory used in network transmission buffers
871
587d9f72
JW
872 file_mapped
873
874 Amount of cached filesystem data mapped with mmap()
875
876 file_dirty
877
878 Amount of cached filesystem data that was modified but
879 not yet written back to disk
880
881 file_writeback
882
883 Amount of cached filesystem data that was modified and
884 is currently being written back to disk
885
886 inactive_anon
887 active_anon
888 inactive_file
889 active_file
890 unevictable
891
892 Amount of memory, swap-backed and filesystem-backed,
893 on the internal memory management lists used by the
894 page reclaim algorithm
895
27ee57c9
VD
896 slab_reclaimable
897
898 Part of "slab" that might be reclaimed, such as
899 dentries and inodes.
900
901 slab_unreclaimable
902
903 Part of "slab" that cannot be reclaimed on memory
904 pressure.
905
587d9f72
JW
906 pgfault
907
908 Total number of page faults incurred
909
910 pgmajfault
911
912 Number of major page faults incurred
913
3e24b19d
VD
914 memory.swap.current
915
916 A read-only single value file which exists on non-root
917 cgroups.
918
919 The total amount of swap currently being used by the cgroup
920 and its descendants.
921
922 memory.swap.max
923
924 A read-write single value file which exists on non-root
925 cgroups. The default is "max".
926
927 Swap usage hard limit. If a cgroup's swap usage reaches this
928 limit, anonymous meomry of the cgroup will not be swapped out.
929
6c292092 930
6c83e6cb 9315-2-2. Usage Guidelines
6c292092
TH
932
933"memory.high" is the main mechanism to control memory usage.
934Over-committing on high limit (sum of high limits > available memory)
935and letting global memory pressure to distribute memory according to
936usage is a viable strategy.
937
938Because breach of the high limit doesn't trigger the OOM killer but
939throttles the offending cgroup, a management agent has ample
940opportunities to monitor and take appropriate actions such as granting
941more memory or terminating the workload.
942
943Determining whether a cgroup has enough memory is not trivial as
944memory usage doesn't indicate whether the workload can benefit from
945more memory. For example, a workload which writes data received from
946network to a file can use all available memory but can also operate as
947performant with a small amount of memory. A measure of memory
948pressure - how much the workload is being impacted due to lack of
949memory - is necessary to determine whether a workload needs more
950memory; unfortunately, memory pressure monitoring mechanism isn't
951implemented yet.
952
953
9545-2-3. Memory Ownership
955
956A memory area is charged to the cgroup which instantiated it and stays
957charged to the cgroup until the area is released. Migrating a process
958to a different cgroup doesn't move the memory usages that it
959instantiated while in the previous cgroup to the new cgroup.
960
961A memory area may be used by processes belonging to different cgroups.
962To which cgroup the area will be charged is in-deterministic; however,
963over time, the memory area is likely to end up in a cgroup which has
964enough memory allowance to avoid high reclaim pressure.
965
966If a cgroup sweeps a considerable amount of memory which is expected
967to be accessed repeatedly by other cgroups, it may make sense to use
968POSIX_FADV_DONTNEED to relinquish the ownership of memory areas
969belonging to the affected files to ensure correct memory ownership.
970
971
9725-3. IO
973
974The "io" controller regulates the distribution of IO resources. This
975controller implements both weight based and absolute bandwidth or IOPS
976limit distribution; however, weight based distribution is available
977only if cfq-iosched is in use and neither scheme is available for
978blk-mq devices.
979
980
9815-3-1. IO Interface Files
982
983 io.stat
984
985 A read-only nested-keyed file which exists on non-root
986 cgroups.
987
988 Lines are keyed by $MAJ:$MIN device numbers and not ordered.
989 The following nested keys are defined.
990
991 rbytes Bytes read
992 wbytes Bytes written
993 rios Number of read IOs
994 wios Number of write IOs
995
996 An example read output follows.
997
998 8:16 rbytes=1459200 wbytes=314773504 rios=192 wios=353
999 8:0 rbytes=90430464 wbytes=299008000 rios=8950 wios=1252
1000
1001 io.weight
1002
1003 A read-write flat-keyed file which exists on non-root cgroups.
1004 The default is "default 100".
1005
1006 The first line is the default weight applied to devices
1007 without specific override. The rest are overrides keyed by
1008 $MAJ:$MIN device numbers and not ordered. The weights are in
1009 the range [1, 10000] and specifies the relative amount IO time
1010 the cgroup can use in relation to its siblings.
1011
1012 The default weight can be updated by writing either "default
1013 $WEIGHT" or simply "$WEIGHT". Overrides can be set by writing
1014 "$MAJ:$MIN $WEIGHT" and unset by writing "$MAJ:$MIN default".
1015
1016 An example read output follows.
1017
1018 default 100
1019 8:16 200
1020 8:0 50
1021
1022 io.max
1023
1024 A read-write nested-keyed file which exists on non-root
1025 cgroups.
1026
1027 BPS and IOPS based IO limit. Lines are keyed by $MAJ:$MIN
1028 device numbers and not ordered. The following nested keys are
1029 defined.
1030
1031 rbps Max read bytes per second
1032 wbps Max write bytes per second
1033 riops Max read IO operations per second
1034 wiops Max write IO operations per second
1035
1036 When writing, any number of nested key-value pairs can be
1037 specified in any order. "max" can be specified as the value
1038 to remove a specific limit. If the same key is specified
1039 multiple times, the outcome is undefined.
1040
1041 BPS and IOPS are measured in each IO direction and IOs are
1042 delayed if limit is reached. Temporary bursts are allowed.
1043
1044 Setting read limit at 2M BPS and write at 120 IOPS for 8:16.
1045
1046 echo "8:16 rbps=2097152 wiops=120" > io.max
1047
1048 Reading returns the following.
1049
1050 8:16 rbps=2097152 wbps=max riops=max wiops=120
1051
1052 Write IOPS limit can be removed by writing the following.
1053
1054 echo "8:16 wiops=max" > io.max
1055
1056 Reading now returns the following.
1057
1058 8:16 rbps=2097152 wbps=max riops=max wiops=max
1059
1060
10615-3-2. Writeback
1062
1063Page cache is dirtied through buffered writes and shared mmaps and
1064written asynchronously to the backing filesystem by the writeback
1065mechanism. Writeback sits between the memory and IO domains and
1066regulates the proportion of dirty memory by balancing dirtying and
1067write IOs.
1068
1069The io controller, in conjunction with the memory controller,
1070implements control of page cache writeback IOs. The memory controller
1071defines the memory domain that dirty memory ratio is calculated and
1072maintained for and the io controller defines the io domain which
1073writes out dirty pages for the memory domain. Both system-wide and
1074per-cgroup dirty memory states are examined and the more restrictive
1075of the two is enforced.
1076
1077cgroup writeback requires explicit support from the underlying
1078filesystem. Currently, cgroup writeback is implemented on ext2, ext4
1079and btrfs. On other filesystems, all writeback IOs are attributed to
1080the root cgroup.
1081
1082There are inherent differences in memory and writeback management
1083which affects how cgroup ownership is tracked. Memory is tracked per
1084page while writeback per inode. For the purpose of writeback, an
1085inode is assigned to a cgroup and all IO requests to write dirty pages
1086from the inode are attributed to that cgroup.
1087
1088As cgroup ownership for memory is tracked per page, there can be pages
1089which are associated with different cgroups than the one the inode is
1090associated with. These are called foreign pages. The writeback
1091constantly keeps track of foreign pages and, if a particular foreign
1092cgroup becomes the majority over a certain period of time, switches
1093the ownership of the inode to that cgroup.
1094
1095While this model is enough for most use cases where a given inode is
1096mostly dirtied by a single cgroup even when the main writing cgroup
1097changes over time, use cases where multiple cgroups write to a single
1098inode simultaneously are not supported well. In such circumstances, a
1099significant portion of IOs are likely to be attributed incorrectly.
1100As memory controller assigns page ownership on the first use and
1101doesn't update it until the page is released, even if writeback
1102strictly follows page ownership, multiple cgroups dirtying overlapping
1103areas wouldn't work as expected. It's recommended to avoid such usage
1104patterns.
1105
1106The sysctl knobs which affect writeback behavior are applied to cgroup
1107writeback as follows.
1108
1109 vm.dirty_background_ratio
1110 vm.dirty_ratio
1111
1112 These ratios apply the same to cgroup writeback with the
1113 amount of available memory capped by limits imposed by the
1114 memory controller and system-wide clean memory.
1115
1116 vm.dirty_background_bytes
1117 vm.dirty_bytes
1118
1119 For cgroup writeback, this is calculated into ratio against
1120 total available memory and applied the same way as
1121 vm.dirty[_background]_ratio.
1122
1123
20c56e59
HR
11245-4. PID
1125
1126The process number controller is used to allow a cgroup to stop any
1127new tasks from being fork()'d or clone()'d after a specified limit is
1128reached.
1129
1130The number of tasks in a cgroup can be exhausted in ways which other
1131controllers cannot prevent, thus warranting its own controller. For
1132example, a fork bomb is likely to exhaust the number of tasks before
1133hitting memory restrictions.
1134
1135Note that PIDs used in this controller refer to TIDs, process IDs as
1136used by the kernel.
1137
1138
11395-4-1. PID Interface Files
1140
1141 pids.max
1142
1143 A read-write single value file which exists on non-root cgroups. The
1144 default is "max".
1145
1146 Hard limit of number of processes.
1147
1148 pids.current
1149
1150 A read-only single value file which exists on all cgroups.
1151
1152 The number of processes currently in the cgroup and its descendants.
1153
1154Organisational operations are not blocked by cgroup policies, so it is
1155possible to have pids.current > pids.max. This can be done by either
1156setting the limit to be smaller than pids.current, or attaching enough
1157processes to the cgroup such that pids.current is larger than
1158pids.max. However, it is not possible to violate a cgroup PID policy
1159through fork() or clone(). These will return -EAGAIN if the creation
1160of a new process would cause a cgroup policy to be violated.
1161
1162
d4021f6c
SH
11636. Namespace
1164
11656-1. Basics
1166
1167cgroup namespace provides a mechanism to virtualize the view of the
1168"/proc/$PID/cgroup" file and cgroup mounts. The CLONE_NEWCGROUP clone
1169flag can be used with clone(2) and unshare(2) to create a new cgroup
1170namespace. The process running inside the cgroup namespace will have
1171its "/proc/$PID/cgroup" output restricted to cgroupns root. The
1172cgroupns root is the cgroup of the process at the time of creation of
1173the cgroup namespace.
1174
1175Without cgroup namespace, the "/proc/$PID/cgroup" file shows the
1176complete path of the cgroup of a process. In a container setup where
1177a set of cgroups and namespaces are intended to isolate processes the
1178"/proc/$PID/cgroup" file may leak potential system level information
1179to the isolated processes. For Example:
1180
1181 # cat /proc/self/cgroup
1182 0::/batchjobs/container_id1
1183
1184The path '/batchjobs/container_id1' can be considered as system-data
1185and undesirable to expose to the isolated processes. cgroup namespace
1186can be used to restrict visibility of this path. For example, before
1187creating a cgroup namespace, one would see:
1188
1189 # ls -l /proc/self/ns/cgroup
1190 lrwxrwxrwx 1 root root 0 2014-07-15 10:37 /proc/self/ns/cgroup -> cgroup:[4026531835]
1191 # cat /proc/self/cgroup
1192 0::/batchjobs/container_id1
1193
1194After unsharing a new namespace, the view changes.
1195
1196 # ls -l /proc/self/ns/cgroup
1197 lrwxrwxrwx 1 root root 0 2014-07-15 10:35 /proc/self/ns/cgroup -> cgroup:[4026532183]
1198 # cat /proc/self/cgroup
1199 0::/
1200
1201When some thread from a multi-threaded process unshares its cgroup
1202namespace, the new cgroupns gets applied to the entire process (all
1203the threads). This is natural for the v2 hierarchy; however, for the
1204legacy hierarchies, this may be unexpected.
1205
1206A cgroup namespace is alive as long as there are processes inside or
1207mounts pinning it. When the last usage goes away, the cgroup
1208namespace is destroyed. The cgroupns root and the actual cgroups
1209remain.
1210
1211
12126-2. The Root and Views
1213
1214The 'cgroupns root' for a cgroup namespace is the cgroup in which the
1215process calling unshare(2) is running. For example, if a process in
1216/batchjobs/container_id1 cgroup calls unshare, cgroup
1217/batchjobs/container_id1 becomes the cgroupns root. For the
1218init_cgroup_ns, this is the real root ('/') cgroup.
1219
1220The cgroupns root cgroup does not change even if the namespace creator
1221process later moves to a different cgroup.
1222
1223 # ~/unshare -c # unshare cgroupns in some cgroup
1224 # cat /proc/self/cgroup
1225 0::/
1226 # mkdir sub_cgrp_1
1227 # echo 0 > sub_cgrp_1/cgroup.procs
1228 # cat /proc/self/cgroup
1229 0::/sub_cgrp_1
1230
1231Each process gets its namespace-specific view of "/proc/$PID/cgroup"
1232
1233Processes running inside the cgroup namespace will be able to see
1234cgroup paths (in /proc/self/cgroup) only inside their root cgroup.
1235From within an unshared cgroupns:
1236
1237 # sleep 100000 &
1238 [1] 7353
1239 # echo 7353 > sub_cgrp_1/cgroup.procs
1240 # cat /proc/7353/cgroup
1241 0::/sub_cgrp_1
1242
1243From the initial cgroup namespace, the real cgroup path will be
1244visible:
1245
1246 $ cat /proc/7353/cgroup
1247 0::/batchjobs/container_id1/sub_cgrp_1
1248
1249From a sibling cgroup namespace (that is, a namespace rooted at a
1250different cgroup), the cgroup path relative to its own cgroup
1251namespace root will be shown. For instance, if PID 7353's cgroup
1252namespace root is at '/batchjobs/container_id2', then it will see
1253
1254 # cat /proc/7353/cgroup
1255 0::/../container_id2/sub_cgrp_1
1256
1257Note that the relative path always starts with '/' to indicate that
1258its relative to the cgroup namespace root of the caller.
1259
1260
12616-3. Migration and setns(2)
1262
1263Processes inside a cgroup namespace can move into and out of the
1264namespace root if they have proper access to external cgroups. For
1265example, from inside a namespace with cgroupns root at
1266/batchjobs/container_id1, and assuming that the global hierarchy is
1267still accessible inside cgroupns:
1268
1269 # cat /proc/7353/cgroup
1270 0::/sub_cgrp_1
1271 # echo 7353 > batchjobs/container_id2/cgroup.procs
1272 # cat /proc/7353/cgroup
1273 0::/../container_id2
1274
1275Note that this kind of setup is not encouraged. A task inside cgroup
1276namespace should only be exposed to its own cgroupns hierarchy.
1277
1278setns(2) to another cgroup namespace is allowed when:
1279
1280(a) the process has CAP_SYS_ADMIN against its current user namespace
1281(b) the process has CAP_SYS_ADMIN against the target cgroup
1282 namespace's userns
1283
1284No implicit cgroup changes happen with attaching to another cgroup
1285namespace. It is expected that the someone moves the attaching
1286process under the target cgroup namespace root.
1287
1288
12896-4. Interaction with Other Namespaces
1290
1291Namespace specific cgroup hierarchy can be mounted by a process
1292running inside a non-init cgroup namespace.
1293
1294 # mount -t cgroup2 none $MOUNT_POINT
1295
1296This will mount the unified cgroup hierarchy with cgroupns root as the
1297filesystem root. The process needs CAP_SYS_ADMIN against its user and
1298mount namespaces.
1299
1300The virtualization of /proc/self/cgroup file combined with restricting
1301the view of cgroup hierarchy by namespace-private cgroupfs mount
1302provides a properly isolated cgroup view inside the container.
1303
1304
6c292092
TH
1305P. Information on Kernel Programming
1306
1307This section contains kernel programming information in the areas
1308where interacting with cgroup is necessary. cgroup core and
1309controllers are not covered.
1310
1311
1312P-1. Filesystem Support for Writeback
1313
1314A filesystem can support cgroup writeback by updating
1315address_space_operations->writepage[s]() to annotate bio's using the
1316following two functions.
1317
1318 wbc_init_bio(@wbc, @bio)
1319
1320 Should be called for each bio carrying writeback data and
1321 associates the bio with the inode's owner cgroup. Can be
1322 called anytime between bio allocation and submission.
1323
1324 wbc_account_io(@wbc, @page, @bytes)
1325
1326 Should be called for each data segment being written out.
1327 While this function doesn't care exactly when it's called
1328 during the writeback session, it's the easiest and most
1329 natural to call it as data segments are added to a bio.
1330
1331With writeback bio's annotated, cgroup support can be enabled per
1332super_block by setting SB_I_CGROUPWB in ->s_iflags. This allows for
1333selective disabling of cgroup writeback support which is helpful when
1334certain filesystem features, e.g. journaled data mode, are
1335incompatible.
1336
1337wbc_init_bio() binds the specified bio to its cgroup. Depending on
1338the configuration, the bio may be executed at a lower priority and if
1339the writeback session is holding shared resources, e.g. a journal
1340entry, may lead to priority inversion. There is no one easy solution
1341for the problem. Filesystems can try to work around specific problem
1342cases by skipping wbc_init_bio() or using bio_associate_blkcg()
1343directly.
1344
1345
1346D. Deprecated v1 Core Features
1347
1348- Multiple hierarchies including named ones are not supported.
1349
1350- All mount options and remounting are not supported.
1351
1352- The "tasks" file is removed and "cgroup.procs" is not sorted.
1353
1354- "cgroup.clone_children" is removed.
1355
1356- /proc/cgroups is meaningless for v2. Use "cgroup.controllers" file
1357 at the root instead.
1358
1359
1360R. Issues with v1 and Rationales for v2
1361
1362R-1. Multiple Hierarchies
1363
1364cgroup v1 allowed an arbitrary number of hierarchies and each
1365hierarchy could host any number of controllers. While this seemed to
1366provide a high level of flexibility, it wasn't useful in practice.
1367
1368For example, as there is only one instance of each controller, utility
1369type controllers such as freezer which can be useful in all
1370hierarchies could only be used in one. The issue is exacerbated by
1371the fact that controllers couldn't be moved to another hierarchy once
1372hierarchies were populated. Another issue was that all controllers
1373bound to a hierarchy were forced to have exactly the same view of the
1374hierarchy. It wasn't possible to vary the granularity depending on
1375the specific controller.
1376
1377In practice, these issues heavily limited which controllers could be
1378put on the same hierarchy and most configurations resorted to putting
1379each controller on its own hierarchy. Only closely related ones, such
1380as the cpu and cpuacct controllers, made sense to be put on the same
1381hierarchy. This often meant that userland ended up managing multiple
1382similar hierarchies repeating the same steps on each hierarchy
1383whenever a hierarchy management operation was necessary.
1384
1385Furthermore, support for multiple hierarchies came at a steep cost.
1386It greatly complicated cgroup core implementation but more importantly
1387the support for multiple hierarchies restricted how cgroup could be
1388used in general and what controllers was able to do.
1389
1390There was no limit on how many hierarchies there might be, which meant
1391that a thread's cgroup membership couldn't be described in finite
1392length. The key might contain any number of entries and was unlimited
1393in length, which made it highly awkward to manipulate and led to
1394addition of controllers which existed only to identify membership,
1395which in turn exacerbated the original problem of proliferating number
1396of hierarchies.
1397
1398Also, as a controller couldn't have any expectation regarding the
1399topologies of hierarchies other controllers might be on, each
1400controller had to assume that all other controllers were attached to
1401completely orthogonal hierarchies. This made it impossible, or at
1402least very cumbersome, for controllers to cooperate with each other.
1403
1404In most use cases, putting controllers on hierarchies which are
1405completely orthogonal to each other isn't necessary. What usually is
1406called for is the ability to have differing levels of granularity
1407depending on the specific controller. In other words, hierarchy may
1408be collapsed from leaf towards root when viewed from specific
1409controllers. For example, a given configuration might not care about
1410how memory is distributed beyond a certain level while still wanting
1411to control how CPU cycles are distributed.
1412
1413
1414R-2. Thread Granularity
1415
1416cgroup v1 allowed threads of a process to belong to different cgroups.
1417This didn't make sense for some controllers and those controllers
1418ended up implementing different ways to ignore such situations but
1419much more importantly it blurred the line between API exposed to
1420individual applications and system management interface.
1421
1422Generally, in-process knowledge is available only to the process
1423itself; thus, unlike service-level organization of processes,
1424categorizing threads of a process requires active participation from
1425the application which owns the target process.
1426
1427cgroup v1 had an ambiguously defined delegation model which got abused
1428in combination with thread granularity. cgroups were delegated to
1429individual applications so that they can create and manage their own
1430sub-hierarchies and control resource distributions along them. This
1431effectively raised cgroup to the status of a syscall-like API exposed
1432to lay programs.
1433
1434First of all, cgroup has a fundamentally inadequate interface to be
1435exposed this way. For a process to access its own knobs, it has to
1436extract the path on the target hierarchy from /proc/self/cgroup,
1437construct the path by appending the name of the knob to the path, open
1438and then read and/or write to it. This is not only extremely clunky
1439and unusual but also inherently racy. There is no conventional way to
1440define transaction across the required steps and nothing can guarantee
1441that the process would actually be operating on its own sub-hierarchy.
1442
1443cgroup controllers implemented a number of knobs which would never be
1444accepted as public APIs because they were just adding control knobs to
1445system-management pseudo filesystem. cgroup ended up with interface
1446knobs which were not properly abstracted or refined and directly
1447revealed kernel internal details. These knobs got exposed to
1448individual applications through the ill-defined delegation mechanism
1449effectively abusing cgroup as a shortcut to implementing public APIs
1450without going through the required scrutiny.
1451
1452This was painful for both userland and kernel. Userland ended up with
1453misbehaving and poorly abstracted interfaces and kernel exposing and
1454locked into constructs inadvertently.
1455
1456
1457R-3. Competition Between Inner Nodes and Threads
1458
1459cgroup v1 allowed threads to be in any cgroups which created an
1460interesting problem where threads belonging to a parent cgroup and its
1461children cgroups competed for resources. This was nasty as two
1462different types of entities competed and there was no obvious way to
1463settle it. Different controllers did different things.
1464
1465The cpu controller considered threads and cgroups as equivalents and
1466mapped nice levels to cgroup weights. This worked for some cases but
1467fell flat when children wanted to be allocated specific ratios of CPU
1468cycles and the number of internal threads fluctuated - the ratios
1469constantly changed as the number of competing entities fluctuated.
1470There also were other issues. The mapping from nice level to weight
1471wasn't obvious or universal, and there were various other knobs which
1472simply weren't available for threads.
1473
1474The io controller implicitly created a hidden leaf node for each
1475cgroup to host the threads. The hidden leaf had its own copies of all
1476the knobs with "leaf_" prefixed. While this allowed equivalent
1477control over internal threads, it was with serious drawbacks. It
1478always added an extra layer of nesting which wouldn't be necessary
1479otherwise, made the interface messy and significantly complicated the
1480implementation.
1481
1482The memory controller didn't have a way to control what happened
1483between internal tasks and child cgroups and the behavior was not
1484clearly defined. There were attempts to add ad-hoc behaviors and
1485knobs to tailor the behavior to specific workloads which would have
1486led to problems extremely difficult to resolve in the long term.
1487
1488Multiple controllers struggled with internal tasks and came up with
1489different ways to deal with it; unfortunately, all the approaches were
1490severely flawed and, furthermore, the widely different behaviors
1491made cgroup as a whole highly inconsistent.
1492
1493This clearly is a problem which needs to be addressed from cgroup core
1494in a uniform way.
1495
1496
1497R-4. Other Interface Issues
1498
1499cgroup v1 grew without oversight and developed a large number of
1500idiosyncrasies and inconsistencies. One issue on the cgroup core side
1501was how an empty cgroup was notified - a userland helper binary was
1502forked and executed for each event. The event delivery wasn't
1503recursive or delegatable. The limitations of the mechanism also led
1504to in-kernel event delivery filtering mechanism further complicating
1505the interface.
1506
1507Controller interfaces were problematic too. An extreme example is
1508controllers completely ignoring hierarchical organization and treating
1509all cgroups as if they were all located directly under the root
1510cgroup. Some controllers exposed a large amount of inconsistent
1511implementation details to userland.
1512
1513There also was no consistency across controllers. When a new cgroup
1514was created, some controllers defaulted to not imposing extra
1515restrictions while others disallowed any resource usage until
1516explicitly configured. Configuration knobs for the same type of
1517control used widely differing naming schemes and formats. Statistics
1518and information knobs were named arbitrarily and used different
1519formats and units even in the same controller.
1520
1521cgroup v2 establishes common conventions where appropriate and updates
1522controllers so that they expose minimal and consistent interfaces.
1523
1524
1525R-5. Controller Issues and Remedies
1526
1527R-5-1. Memory
1528
1529The original lower boundary, the soft limit, is defined as a limit
1530that is per default unset. As a result, the set of cgroups that
1531global reclaim prefers is opt-in, rather than opt-out. The costs for
1532optimizing these mostly negative lookups are so high that the
1533implementation, despite its enormous size, does not even provide the
1534basic desirable behavior. First off, the soft limit has no
1535hierarchical meaning. All configured groups are organized in a global
1536rbtree and treated like equal peers, regardless where they are located
1537in the hierarchy. This makes subtree delegation impossible. Second,
1538the soft limit reclaim pass is so aggressive that it not just
1539introduces high allocation latencies into the system, but also impacts
1540system performance due to overreclaim, to the point where the feature
1541becomes self-defeating.
1542
1543The memory.low boundary on the other hand is a top-down allocated
1544reserve. A cgroup enjoys reclaim protection when it and all its
1545ancestors are below their low boundaries, which makes delegation of
1546subtrees possible. Secondly, new cgroups have no reserve per default
1547and in the common case most cgroups are eligible for the preferred
1548reclaim pass. This allows the new low boundary to be efficiently
1549implemented with just a minor addition to the generic reclaim code,
1550without the need for out-of-band data structures and reclaim passes.
1551Because the generic reclaim code considers all cgroups except for the
1552ones running low in the preferred first reclaim pass, overreclaim of
1553individual groups is eliminated as well, resulting in much better
1554overall workload performance.
1555
1556The original high boundary, the hard limit, is defined as a strict
1557limit that can not budge, even if the OOM killer has to be called.
1558But this generally goes against the goal of making the most out of the
1559available memory. The memory consumption of workloads varies during
1560runtime, and that requires users to overcommit. But doing that with a
1561strict upper limit requires either a fairly accurate prediction of the
1562working set size or adding slack to the limit. Since working set size
1563estimation is hard and error prone, and getting it wrong results in
1564OOM kills, most users tend to err on the side of a looser limit and
1565end up wasting precious resources.
1566
1567The memory.high boundary on the other hand can be set much more
1568conservatively. When hit, it throttles allocations by forcing them
1569into direct reclaim to work off the excess, but it never invokes the
1570OOM killer. As a result, a high boundary that is chosen too
1571aggressively will not terminate the processes, but instead it will
1572lead to gradual performance degradation. The user can monitor this
1573and make corrections until the minimal memory footprint that still
1574gives acceptable performance is found.
1575
1576In extreme cases, with many concurrent allocations and a complete
1577breakdown of reclaim progress within the group, the high boundary can
1578be exceeded. But even then it's mostly better to satisfy the
1579allocation from the slack available in other groups or the rest of the
1580system than killing the group. Otherwise, memory.max is there to
1581limit this type of spillover and ultimately contain buggy or even
1582malicious applications.
3e24b19d 1583
b6e6edcf
JW
1584Setting the original memory.limit_in_bytes below the current usage was
1585subject to a race condition, where concurrent charges could cause the
1586limit setting to fail. memory.max on the other hand will first set the
1587limit to prevent new charges, and then reclaim and OOM kill until the
1588new limit is met - or the task writing to memory.max is killed.
1589
3e24b19d
VD
1590The combined memory+swap accounting and limiting is replaced by real
1591control over swap space.
1592
1593The main argument for a combined memory+swap facility in the original
1594cgroup design was that global or parental pressure would always be
1595able to swap all anonymous memory of a child group, regardless of the
1596child's own (possibly untrusted) configuration. However, untrusted
1597groups can sabotage swapping by other means - such as referencing its
1598anonymous memory in a tight loop - and an admin can not assume full
1599swappability when overcommitting untrusted jobs.
1600
1601For trusted jobs, on the other hand, a combined counter is not an
1602intuitive userspace interface, and it flies in the face of the idea
1603that cgroup controllers should account and limit specific physical
1604resources. Swap space is a resource like all others in the system,
1605and that's why unified hierarchy allows distributing it separately.