psi: cgroup support
[muen/linux.git] / Documentation / admin-guide / cgroup-v2.rst
1 ================
2 Control Group v2
3 ================
4
5 :Date: October, 2015
6 :Author: Tejun Heo <tj@kernel.org>
7
8 This is the authoritative documentation on the design, interface and
9 conventions of cgroup v2.  It describes all userland-visible aspects
10 of cgroup including core and specific controller behaviors.  All
11 future changes must be reflected in this document.  Documentation for
12 v1 is available under Documentation/cgroup-v1/.
13
14 .. CONTENTS
15
16    1. Introduction
17      1-1. Terminology
18      1-2. What is cgroup?
19    2. Basic Operations
20      2-1. Mounting
21      2-2. Organizing Processes and Threads
22        2-2-1. Processes
23        2-2-2. Threads
24      2-3. [Un]populated Notification
25      2-4. Controlling Controllers
26        2-4-1. Enabling and Disabling
27        2-4-2. Top-down Constraint
28        2-4-3. No Internal Process Constraint
29      2-5. Delegation
30        2-5-1. Model of Delegation
31        2-5-2. Delegation Containment
32      2-6. Guidelines
33        2-6-1. Organize Once and Control
34        2-6-2. Avoid Name Collisions
35    3. Resource Distribution Models
36      3-1. Weights
37      3-2. Limits
38      3-3. Protections
39      3-4. Allocations
40    4. Interface Files
41      4-1. Format
42      4-2. Conventions
43      4-3. Core Interface Files
44    5. Controllers
45      5-1. CPU
46        5-1-1. CPU Interface Files
47      5-2. Memory
48        5-2-1. Memory Interface Files
49        5-2-2. Usage Guidelines
50        5-2-3. Memory Ownership
51      5-3. IO
52        5-3-1. IO Interface Files
53        5-3-2. Writeback
54        5-3-3. IO Latency
55          5-3-3-1. How IO Latency Throttling Works
56          5-3-3-2. IO Latency Interface Files
57      5-4. PID
58        5-4-1. PID Interface Files
59      5-5. Device
60      5-6. RDMA
61        5-6-1. RDMA Interface Files
62      5-7. Misc
63        5-7-1. perf_event
64      5-N. Non-normative information
65        5-N-1. CPU controller root cgroup process behaviour
66        5-N-2. IO controller root cgroup process behaviour
67    6. Namespace
68      6-1. Basics
69      6-2. The Root and Views
70      6-3. Migration and setns(2)
71      6-4. Interaction with Other Namespaces
72    P. Information on Kernel Programming
73      P-1. Filesystem Support for Writeback
74    D. Deprecated v1 Core Features
75    R. Issues with v1 and Rationales for v2
76      R-1. Multiple Hierarchies
77      R-2. Thread Granularity
78      R-3. Competition Between Inner Nodes and Threads
79      R-4. Other Interface Issues
80      R-5. Controller Issues and Remedies
81        R-5-1. Memory
82
83
84 Introduction
85 ============
86
87 Terminology
88 -----------
89
90 "cgroup" stands for "control group" and is never capitalized.  The
91 singular form is used to designate the whole feature and also as a
92 qualifier as in "cgroup controllers".  When explicitly referring to
93 multiple individual control groups, the plural form "cgroups" is used.
94
95
96 What is cgroup?
97 ---------------
98
99 cgroup is a mechanism to organize processes hierarchically and
100 distribute system resources along the hierarchy in a controlled and
101 configurable manner.
102
103 cgroup is largely composed of two parts - the core and controllers.
104 cgroup core is primarily responsible for hierarchically organizing
105 processes.  A cgroup controller is usually responsible for
106 distributing a specific type of system resource along the hierarchy
107 although there are utility controllers which serve purposes other than
108 resource distribution.
109
110 cgroups form a tree structure and every process in the system belongs
111 to one and only one cgroup.  All threads of a process belong to the
112 same cgroup.  On creation, all processes are put in the cgroup that
113 the parent process belongs to at the time.  A process can be migrated
114 to another cgroup.  Migration of a process doesn't affect already
115 existing descendant processes.
116
117 Following certain structural constraints, controllers may be enabled or
118 disabled selectively on a cgroup.  All controller behaviors are
119 hierarchical - if a controller is enabled on a cgroup, it affects all
120 processes which belong to the cgroups consisting the inclusive
121 sub-hierarchy of the cgroup.  When a controller is enabled on a nested
122 cgroup, it always restricts the resource distribution further.  The
123 restrictions set closer to the root in the hierarchy can not be
124 overridden from further away.
125
126
127 Basic Operations
128 ================
129
130 Mounting
131 --------
132
133 Unlike v1, cgroup v2 has only single hierarchy.  The cgroup v2
134 hierarchy can be mounted with the following mount command::
135
136   # mount -t cgroup2 none $MOUNT_POINT
137
138 cgroup2 filesystem has the magic number 0x63677270 ("cgrp").  All
139 controllers which support v2 and are not bound to a v1 hierarchy are
140 automatically bound to the v2 hierarchy and show up at the root.
141 Controllers which are not in active use in the v2 hierarchy can be
142 bound to other hierarchies.  This allows mixing v2 hierarchy with the
143 legacy v1 multiple hierarchies in a fully backward compatible way.
144
145 A controller can be moved across hierarchies only after the controller
146 is no longer referenced in its current hierarchy.  Because per-cgroup
147 controller states are destroyed asynchronously and controllers may
148 have lingering references, a controller may not show up immediately on
149 the v2 hierarchy after the final umount of the previous hierarchy.
150 Similarly, a controller should be fully disabled to be moved out of
151 the unified hierarchy and it may take some time for the disabled
152 controller to become available for other hierarchies; furthermore, due
153 to inter-controller dependencies, other controllers may need to be
154 disabled too.
155
156 While useful for development and manual configurations, moving
157 controllers dynamically between the v2 and other hierarchies is
158 strongly discouraged for production use.  It is recommended to decide
159 the hierarchies and controller associations before starting using the
160 controllers after system boot.
161
162 During transition to v2, system management software might still
163 automount the v1 cgroup filesystem and so hijack all controllers
164 during boot, before manual intervention is possible. To make testing
165 and experimenting easier, the kernel parameter cgroup_no_v1= allows
166 disabling controllers in v1 and make them always available in v2.
167
168 cgroup v2 currently supports the following mount options.
169
170   nsdelegate
171
172         Consider cgroup namespaces as delegation boundaries.  This
173         option is system wide and can only be set on mount or modified
174         through remount from the init namespace.  The mount option is
175         ignored on non-init namespace mounts.  Please refer to the
176         Delegation section for details.
177
178
179 Organizing Processes and Threads
180 --------------------------------
181
182 Processes
183 ~~~~~~~~~
184
185 Initially, only the root cgroup exists to which all processes belong.
186 A child cgroup can be created by creating a sub-directory::
187
188   # mkdir $CGROUP_NAME
189
190 A given cgroup may have multiple child cgroups forming a tree
191 structure.  Each cgroup has a read-writable interface file
192 "cgroup.procs".  When read, it lists the PIDs of all processes which
193 belong to the cgroup one-per-line.  The PIDs are not ordered and the
194 same PID may show up more than once if the process got moved to
195 another cgroup and then back or the PID got recycled while reading.
196
197 A process can be migrated into a cgroup by writing its PID to the
198 target cgroup's "cgroup.procs" file.  Only one process can be migrated
199 on a single write(2) call.  If a process is composed of multiple
200 threads, writing the PID of any thread migrates all threads of the
201 process.
202
203 When a process forks a child process, the new process is born into the
204 cgroup that the forking process belongs to at the time of the
205 operation.  After exit, a process stays associated with the cgroup
206 that it belonged to at the time of exit until it's reaped; however, a
207 zombie process does not appear in "cgroup.procs" and thus can't be
208 moved to another cgroup.
209
210 A cgroup which doesn't have any children or live processes can be
211 destroyed by removing the directory.  Note that a cgroup which doesn't
212 have any children and is associated only with zombie processes is
213 considered empty and can be removed::
214
215   # rmdir $CGROUP_NAME
216
217 "/proc/$PID/cgroup" lists a process's cgroup membership.  If legacy
218 cgroup is in use in the system, this file may contain multiple lines,
219 one for each hierarchy.  The entry for cgroup v2 is always in the
220 format "0::$PATH"::
221
222   # cat /proc/842/cgroup
223   ...
224   0::/test-cgroup/test-cgroup-nested
225
226 If the process becomes a zombie and the cgroup it was associated with
227 is removed subsequently, " (deleted)" is appended to the path::
228
229   # cat /proc/842/cgroup
230   ...
231   0::/test-cgroup/test-cgroup-nested (deleted)
232
233
234 Threads
235 ~~~~~~~
236
237 cgroup v2 supports thread granularity for a subset of controllers to
238 support use cases requiring hierarchical resource distribution across
239 the threads of a group of processes.  By default, all threads of a
240 process belong to the same cgroup, which also serves as the resource
241 domain to host resource consumptions which are not specific to a
242 process or thread.  The thread mode allows threads to be spread across
243 a subtree while still maintaining the common resource domain for them.
244
245 Controllers which support thread mode are called threaded controllers.
246 The ones which don't are called domain controllers.
247
248 Marking a cgroup threaded makes it join the resource domain of its
249 parent as a threaded cgroup.  The parent may be another threaded
250 cgroup whose resource domain is further up in the hierarchy.  The root
251 of a threaded subtree, that is, the nearest ancestor which is not
252 threaded, is called threaded domain or thread root interchangeably and
253 serves as the resource domain for the entire subtree.
254
255 Inside a threaded subtree, threads of a process can be put in
256 different cgroups and are not subject to the no internal process
257 constraint - threaded controllers can be enabled on non-leaf cgroups
258 whether they have threads in them or not.
259
260 As the threaded domain cgroup hosts all the domain resource
261 consumptions of the subtree, it is considered to have internal
262 resource consumptions whether there are processes in it or not and
263 can't have populated child cgroups which aren't threaded.  Because the
264 root cgroup is not subject to no internal process constraint, it can
265 serve both as a threaded domain and a parent to domain cgroups.
266
267 The current operation mode or type of the cgroup is shown in the
268 "cgroup.type" file which indicates whether the cgroup is a normal
269 domain, a domain which is serving as the domain of a threaded subtree,
270 or a threaded cgroup.
271
272 On creation, a cgroup is always a domain cgroup and can be made
273 threaded by writing "threaded" to the "cgroup.type" file.  The
274 operation is single direction::
275
276   # echo threaded > cgroup.type
277
278 Once threaded, the cgroup can't be made a domain again.  To enable the
279 thread mode, the following conditions must be met.
280
281 - As the cgroup will join the parent's resource domain.  The parent
282   must either be a valid (threaded) domain or a threaded cgroup.
283
284 - When the parent is an unthreaded domain, it must not have any domain
285   controllers enabled or populated domain children.  The root is
286   exempt from this requirement.
287
288 Topology-wise, a cgroup can be in an invalid state.  Please consider
289 the following topology::
290
291   A (threaded domain) - B (threaded) - C (domain, just created)
292
293 C is created as a domain but isn't connected to a parent which can
294 host child domains.  C can't be used until it is turned into a
295 threaded cgroup.  "cgroup.type" file will report "domain (invalid)" in
296 these cases.  Operations which fail due to invalid topology use
297 EOPNOTSUPP as the errno.
298
299 A domain cgroup is turned into a threaded domain when one of its child
300 cgroup becomes threaded or threaded controllers are enabled in the
301 "cgroup.subtree_control" file while there are processes in the cgroup.
302 A threaded domain reverts to a normal domain when the conditions
303 clear.
304
305 When read, "cgroup.threads" contains the list of the thread IDs of all
306 threads in the cgroup.  Except that the operations are per-thread
307 instead of per-process, "cgroup.threads" has the same format and
308 behaves the same way as "cgroup.procs".  While "cgroup.threads" can be
309 written to in any cgroup, as it can only move threads inside the same
310 threaded domain, its operations are confined inside each threaded
311 subtree.
312
313 The threaded domain cgroup serves as the resource domain for the whole
314 subtree, and, while the threads can be scattered across the subtree,
315 all the processes are considered to be in the threaded domain cgroup.
316 "cgroup.procs" in a threaded domain cgroup contains the PIDs of all
317 processes in the subtree and is not readable in the subtree proper.
318 However, "cgroup.procs" can be written to from anywhere in the subtree
319 to migrate all threads of the matching process to the cgroup.
320
321 Only threaded controllers can be enabled in a threaded subtree.  When
322 a threaded controller is enabled inside a threaded subtree, it only
323 accounts for and controls resource consumptions associated with the
324 threads in the cgroup and its descendants.  All consumptions which
325 aren't tied to a specific thread belong to the threaded domain cgroup.
326
327 Because a threaded subtree is exempt from no internal process
328 constraint, a threaded controller must be able to handle competition
329 between threads in a non-leaf cgroup and its child cgroups.  Each
330 threaded controller defines how such competitions are handled.
331
332
333 [Un]populated Notification
334 --------------------------
335
336 Each non-root cgroup has a "cgroup.events" file which contains
337 "populated" field indicating whether the cgroup's sub-hierarchy has
338 live processes in it.  Its value is 0 if there is no live process in
339 the cgroup and its descendants; otherwise, 1.  poll and [id]notify
340 events are triggered when the value changes.  This can be used, for
341 example, to start a clean-up operation after all processes of a given
342 sub-hierarchy have exited.  The populated state updates and
343 notifications are recursive.  Consider the following sub-hierarchy
344 where the numbers in the parentheses represent the numbers of processes
345 in each cgroup::
346
347   A(4) - B(0) - C(1)
348               \ D(0)
349
350 A, B and C's "populated" fields would be 1 while D's 0.  After the one
351 process in C exits, B and C's "populated" fields would flip to "0" and
352 file modified events will be generated on the "cgroup.events" files of
353 both cgroups.
354
355
356 Controlling Controllers
357 -----------------------
358
359 Enabling and Disabling
360 ~~~~~~~~~~~~~~~~~~~~~~
361
362 Each cgroup has a "cgroup.controllers" file which lists all
363 controllers available for the cgroup to enable::
364
365   # cat cgroup.controllers
366   cpu io memory
367
368 No controller is enabled by default.  Controllers can be enabled and
369 disabled by writing to the "cgroup.subtree_control" file::
370
371   # echo "+cpu +memory -io" > cgroup.subtree_control
372
373 Only controllers which are listed in "cgroup.controllers" can be
374 enabled.  When multiple operations are specified as above, either they
375 all succeed or fail.  If multiple operations on the same controller
376 are specified, the last one is effective.
377
378 Enabling a controller in a cgroup indicates that the distribution of
379 the target resource across its immediate children will be controlled.
380 Consider the following sub-hierarchy.  The enabled controllers are
381 listed in parentheses::
382
383   A(cpu,memory) - B(memory) - C()
384                             \ D()
385
386 As A has "cpu" and "memory" enabled, A will control the distribution
387 of CPU cycles and memory to its children, in this case, B.  As B has
388 "memory" enabled but not "CPU", C and D will compete freely on CPU
389 cycles but their division of memory available to B will be controlled.
390
391 As a controller regulates the distribution of the target resource to
392 the cgroup's children, enabling it creates the controller's interface
393 files in the child cgroups.  In the above example, enabling "cpu" on B
394 would create the "cpu." prefixed controller interface files in C and
395 D.  Likewise, disabling "memory" from B would remove the "memory."
396 prefixed controller interface files from C and D.  This means that the
397 controller interface files - anything which doesn't start with
398 "cgroup." are owned by the parent rather than the cgroup itself.
399
400
401 Top-down Constraint
402 ~~~~~~~~~~~~~~~~~~~
403
404 Resources are distributed top-down and a cgroup can further distribute
405 a resource only if the resource has been distributed to it from the
406 parent.  This means that all non-root "cgroup.subtree_control" files
407 can only contain controllers which are enabled in the parent's
408 "cgroup.subtree_control" file.  A controller can be enabled only if
409 the parent has the controller enabled and a controller can't be
410 disabled if one or more children have it enabled.
411
412
413 No Internal Process Constraint
414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
415
416 Non-root cgroups can distribute domain resources to their children
417 only when they don't have any processes of their own.  In other words,
418 only domain cgroups which don't contain any processes can have domain
419 controllers enabled in their "cgroup.subtree_control" files.
420
421 This guarantees that, when a domain controller is looking at the part
422 of the hierarchy which has it enabled, processes are always only on
423 the leaves.  This rules out situations where child cgroups compete
424 against internal processes of the parent.
425
426 The root cgroup is exempt from this restriction.  Root contains
427 processes and anonymous resource consumption which can't be associated
428 with any other cgroups and requires special treatment from most
429 controllers.  How resource consumption in the root cgroup is governed
430 is up to each controller (for more information on this topic please
431 refer to the Non-normative information section in the Controllers
432 chapter).
433
434 Note that the restriction doesn't get in the way if there is no
435 enabled controller in the cgroup's "cgroup.subtree_control".  This is
436 important as otherwise it wouldn't be possible to create children of a
437 populated cgroup.  To control resource distribution of a cgroup, the
438 cgroup must create children and transfer all its processes to the
439 children before enabling controllers in its "cgroup.subtree_control"
440 file.
441
442
443 Delegation
444 ----------
445
446 Model of Delegation
447 ~~~~~~~~~~~~~~~~~~~
448
449 A cgroup can be delegated in two ways.  First, to a less privileged
450 user by granting write access of the directory and its "cgroup.procs",
451 "cgroup.threads" and "cgroup.subtree_control" files to the user.
452 Second, if the "nsdelegate" mount option is set, automatically to a
453 cgroup namespace on namespace creation.
454
455 Because the resource control interface files in a given directory
456 control the distribution of the parent's resources, the delegatee
457 shouldn't be allowed to write to them.  For the first method, this is
458 achieved by not granting access to these files.  For the second, the
459 kernel rejects writes to all files other than "cgroup.procs" and
460 "cgroup.subtree_control" on a namespace root from inside the
461 namespace.
462
463 The end results are equivalent for both delegation types.  Once
464 delegated, the user can build sub-hierarchy under the directory,
465 organize processes inside it as it sees fit and further distribute the
466 resources it received from the parent.  The limits and other settings
467 of all resource controllers are hierarchical and regardless of what
468 happens in the delegated sub-hierarchy, nothing can escape the
469 resource restrictions imposed by the parent.
470
471 Currently, cgroup doesn't impose any restrictions on the number of
472 cgroups in or nesting depth of a delegated sub-hierarchy; however,
473 this may be limited explicitly in the future.
474
475
476 Delegation Containment
477 ~~~~~~~~~~~~~~~~~~~~~~
478
479 A delegated sub-hierarchy is contained in the sense that processes
480 can't be moved into or out of the sub-hierarchy by the delegatee.
481
482 For delegations to a less privileged user, this is achieved by
483 requiring the following conditions for a process with a non-root euid
484 to migrate a target process into a cgroup by writing its PID to the
485 "cgroup.procs" file.
486
487 - The writer must have write access to the "cgroup.procs" file.
488
489 - The writer must have write access to the "cgroup.procs" file of the
490   common ancestor of the source and destination cgroups.
491
492 The above two constraints ensure that while a delegatee may migrate
493 processes around freely in the delegated sub-hierarchy it can't pull
494 in from or push out to outside the sub-hierarchy.
495
496 For an example, let's assume cgroups C0 and C1 have been delegated to
497 user U0 who created C00, C01 under C0 and C10 under C1 as follows and
498 all processes under C0 and C1 belong to U0::
499
500   ~~~~~~~~~~~~~ - C0 - C00
501   ~ cgroup    ~      \ C01
502   ~ hierarchy ~
503   ~~~~~~~~~~~~~ - C1 - C10
504
505 Let's also say U0 wants to write the PID of a process which is
506 currently in C10 into "C00/cgroup.procs".  U0 has write access to the
507 file; however, the common ancestor of the source cgroup C10 and the
508 destination cgroup C00 is above the points of delegation and U0 would
509 not have write access to its "cgroup.procs" files and thus the write
510 will be denied with -EACCES.
511
512 For delegations to namespaces, containment is achieved by requiring
513 that both the source and destination cgroups are reachable from the
514 namespace of the process which is attempting the migration.  If either
515 is not reachable, the migration is rejected with -ENOENT.
516
517
518 Guidelines
519 ----------
520
521 Organize Once and Control
522 ~~~~~~~~~~~~~~~~~~~~~~~~~
523
524 Migrating a process across cgroups is a relatively expensive operation
525 and stateful resources such as memory are not moved together with the
526 process.  This is an explicit design decision as there often exist
527 inherent trade-offs between migration and various hot paths in terms
528 of synchronization cost.
529
530 As such, migrating processes across cgroups frequently as a means to
531 apply different resource restrictions is discouraged.  A workload
532 should be assigned to a cgroup according to the system's logical and
533 resource structure once on start-up.  Dynamic adjustments to resource
534 distribution can be made by changing controller configuration through
535 the interface files.
536
537
538 Avoid Name Collisions
539 ~~~~~~~~~~~~~~~~~~~~~
540
541 Interface files for a cgroup and its children cgroups occupy the same
542 directory and it is possible to create children cgroups which collide
543 with interface files.
544
545 All cgroup core interface files are prefixed with "cgroup." and each
546 controller's interface files are prefixed with the controller name and
547 a dot.  A controller's name is composed of lower case alphabets and
548 '_'s but never begins with an '_' so it can be used as the prefix
549 character for collision avoidance.  Also, interface file names won't
550 start or end with terms which are often used in categorizing workloads
551 such as job, service, slice, unit or workload.
552
553 cgroup doesn't do anything to prevent name collisions and it's the
554 user's responsibility to avoid them.
555
556
557 Resource Distribution Models
558 ============================
559
560 cgroup controllers implement several resource distribution schemes
561 depending on the resource type and expected use cases.  This section
562 describes major schemes in use along with their expected behaviors.
563
564
565 Weights
566 -------
567
568 A parent's resource is distributed by adding up the weights of all
569 active children and giving each the fraction matching the ratio of its
570 weight against the sum.  As only children which can make use of the
571 resource at the moment participate in the distribution, this is
572 work-conserving.  Due to the dynamic nature, this model is usually
573 used for stateless resources.
574
575 All weights are in the range [1, 10000] with the default at 100.  This
576 allows symmetric multiplicative biases in both directions at fine
577 enough granularity while staying in the intuitive range.
578
579 As long as the weight is in range, all configuration combinations are
580 valid and there is no reason to reject configuration changes or
581 process migrations.
582
583 "cpu.weight" proportionally distributes CPU cycles to active children
584 and is an example of this type.
585
586
587 Limits
588 ------
589
590 A child can only consume upto the configured amount of the resource.
591 Limits can be over-committed - the sum of the limits of children can
592 exceed the amount of resource available to the parent.
593
594 Limits are in the range [0, max] and defaults to "max", which is noop.
595
596 As limits can be over-committed, all configuration combinations are
597 valid and there is no reason to reject configuration changes or
598 process migrations.
599
600 "io.max" limits the maximum BPS and/or IOPS that a cgroup can consume
601 on an IO device and is an example of this type.
602
603
604 Protections
605 -----------
606
607 A cgroup is protected to be allocated upto the configured amount of
608 the resource if the usages of all its ancestors are under their
609 protected levels.  Protections can be hard guarantees or best effort
610 soft boundaries.  Protections can also be over-committed in which case
611 only upto the amount available to the parent is protected among
612 children.
613
614 Protections are in the range [0, max] and defaults to 0, which is
615 noop.
616
617 As protections can be over-committed, all configuration combinations
618 are valid and there is no reason to reject configuration changes or
619 process migrations.
620
621 "memory.low" implements best-effort memory protection and is an
622 example of this type.
623
624
625 Allocations
626 -----------
627
628 A cgroup is exclusively allocated a certain amount of a finite
629 resource.  Allocations can't be over-committed - the sum of the
630 allocations of children can not exceed the amount of resource
631 available to the parent.
632
633 Allocations are in the range [0, max] and defaults to 0, which is no
634 resource.
635
636 As allocations can't be over-committed, some configuration
637 combinations are invalid and should be rejected.  Also, if the
638 resource is mandatory for execution of processes, process migrations
639 may be rejected.
640
641 "cpu.rt.max" hard-allocates realtime slices and is an example of this
642 type.
643
644
645 Interface Files
646 ===============
647
648 Format
649 ------
650
651 All interface files should be in one of the following formats whenever
652 possible::
653
654   New-line separated values
655   (when only one value can be written at once)
656
657         VAL0\n
658         VAL1\n
659         ...
660
661   Space separated values
662   (when read-only or multiple values can be written at once)
663
664         VAL0 VAL1 ...\n
665
666   Flat keyed
667
668         KEY0 VAL0\n
669         KEY1 VAL1\n
670         ...
671
672   Nested keyed
673
674         KEY0 SUB_KEY0=VAL00 SUB_KEY1=VAL01...
675         KEY1 SUB_KEY0=VAL10 SUB_KEY1=VAL11...
676         ...
677
678 For a writable file, the format for writing should generally match
679 reading; however, controllers may allow omitting later fields or
680 implement restricted shortcuts for most common use cases.
681
682 For both flat and nested keyed files, only the values for a single key
683 can be written at a time.  For nested keyed files, the sub key pairs
684 may be specified in any order and not all pairs have to be specified.
685
686
687 Conventions
688 -----------
689
690 - Settings for a single feature should be contained in a single file.
691
692 - The root cgroup should be exempt from resource control and thus
693   shouldn't have resource control interface files.  Also,
694   informational files on the root cgroup which end up showing global
695   information available elsewhere shouldn't exist.
696
697 - If a controller implements weight based resource distribution, its
698   interface file should be named "weight" and have the range [1,
699   10000] with 100 as the default.  The values are chosen to allow
700   enough and symmetric bias in both directions while keeping it
701   intuitive (the default is 100%).
702
703 - If a controller implements an absolute resource guarantee and/or
704   limit, the interface files should be named "min" and "max"
705   respectively.  If a controller implements best effort resource
706   guarantee and/or limit, the interface files should be named "low"
707   and "high" respectively.
708
709   In the above four control files, the special token "max" should be
710   used to represent upward infinity for both reading and writing.
711
712 - If a setting has a configurable default value and keyed specific
713   overrides, the default entry should be keyed with "default" and
714   appear as the first entry in the file.
715
716   The default value can be updated by writing either "default $VAL" or
717   "$VAL".
718
719   When writing to update a specific override, "default" can be used as
720   the value to indicate removal of the override.  Override entries
721   with "default" as the value must not appear when read.
722
723   For example, a setting which is keyed by major:minor device numbers
724   with integer values may look like the following::
725
726     # cat cgroup-example-interface-file
727     default 150
728     8:0 300
729
730   The default value can be updated by::
731
732     # echo 125 > cgroup-example-interface-file
733
734   or::
735
736     # echo "default 125" > cgroup-example-interface-file
737
738   An override can be set by::
739
740     # echo "8:16 170" > cgroup-example-interface-file
741
742   and cleared by::
743
744     # echo "8:0 default" > cgroup-example-interface-file
745     # cat cgroup-example-interface-file
746     default 125
747     8:16 170
748
749 - For events which are not very high frequency, an interface file
750   "events" should be created which lists event key value pairs.
751   Whenever a notifiable event happens, file modified event should be
752   generated on the file.
753
754
755 Core Interface Files
756 --------------------
757
758 All cgroup core files are prefixed with "cgroup."
759
760   cgroup.type
761
762         A read-write single value file which exists on non-root
763         cgroups.
764
765         When read, it indicates the current type of the cgroup, which
766         can be one of the following values.
767
768         - "domain" : A normal valid domain cgroup.
769
770         - "domain threaded" : A threaded domain cgroup which is
771           serving as the root of a threaded subtree.
772
773         - "domain invalid" : A cgroup which is in an invalid state.
774           It can't be populated or have controllers enabled.  It may
775           be allowed to become a threaded cgroup.
776
777         - "threaded" : A threaded cgroup which is a member of a
778           threaded subtree.
779
780         A cgroup can be turned into a threaded cgroup by writing
781         "threaded" to this file.
782
783   cgroup.procs
784         A read-write new-line separated values file which exists on
785         all cgroups.
786
787         When read, it lists the PIDs of all processes which belong to
788         the cgroup one-per-line.  The PIDs are not ordered and the
789         same PID may show up more than once if the process got moved
790         to another cgroup and then back or the PID got recycled while
791         reading.
792
793         A PID can be written to migrate the process associated with
794         the PID to the cgroup.  The writer should match all of the
795         following conditions.
796
797         - It must have write access to the "cgroup.procs" file.
798
799         - It must have write access to the "cgroup.procs" file of the
800           common ancestor of the source and destination cgroups.
801
802         When delegating a sub-hierarchy, write access to this file
803         should be granted along with the containing directory.
804
805         In a threaded cgroup, reading this file fails with EOPNOTSUPP
806         as all the processes belong to the thread root.  Writing is
807         supported and moves every thread of the process to the cgroup.
808
809   cgroup.threads
810         A read-write new-line separated values file which exists on
811         all cgroups.
812
813         When read, it lists the TIDs of all threads which belong to
814         the cgroup one-per-line.  The TIDs are not ordered and the
815         same TID may show up more than once if the thread got moved to
816         another cgroup and then back or the TID got recycled while
817         reading.
818
819         A TID can be written to migrate the thread associated with the
820         TID to the cgroup.  The writer should match all of the
821         following conditions.
822
823         - It must have write access to the "cgroup.threads" file.
824
825         - The cgroup that the thread is currently in must be in the
826           same resource domain as the destination cgroup.
827
828         - It must have write access to the "cgroup.procs" file of the
829           common ancestor of the source and destination cgroups.
830
831         When delegating a sub-hierarchy, write access to this file
832         should be granted along with the containing directory.
833
834   cgroup.controllers
835         A read-only space separated values file which exists on all
836         cgroups.
837
838         It shows space separated list of all controllers available to
839         the cgroup.  The controllers are not ordered.
840
841   cgroup.subtree_control
842         A read-write space separated values file which exists on all
843         cgroups.  Starts out empty.
844
845         When read, it shows space separated list of the controllers
846         which are enabled to control resource distribution from the
847         cgroup to its children.
848
849         Space separated list of controllers prefixed with '+' or '-'
850         can be written to enable or disable controllers.  A controller
851         name prefixed with '+' enables the controller and '-'
852         disables.  If a controller appears more than once on the list,
853         the last one is effective.  When multiple enable and disable
854         operations are specified, either all succeed or all fail.
855
856   cgroup.events
857         A read-only flat-keyed file which exists on non-root cgroups.
858         The following entries are defined.  Unless specified
859         otherwise, a value change in this file generates a file
860         modified event.
861
862           populated
863                 1 if the cgroup or its descendants contains any live
864                 processes; otherwise, 0.
865
866   cgroup.max.descendants
867         A read-write single value files.  The default is "max".
868
869         Maximum allowed number of descent cgroups.
870         If the actual number of descendants is equal or larger,
871         an attempt to create a new cgroup in the hierarchy will fail.
872
873   cgroup.max.depth
874         A read-write single value files.  The default is "max".
875
876         Maximum allowed descent depth below the current cgroup.
877         If the actual descent depth is equal or larger,
878         an attempt to create a new child cgroup will fail.
879
880   cgroup.stat
881         A read-only flat-keyed file with the following entries:
882
883           nr_descendants
884                 Total number of visible descendant cgroups.
885
886           nr_dying_descendants
887                 Total number of dying descendant cgroups. A cgroup becomes
888                 dying after being deleted by a user. The cgroup will remain
889                 in dying state for some time undefined time (which can depend
890                 on system load) before being completely destroyed.
891
892                 A process can't enter a dying cgroup under any circumstances,
893                 a dying cgroup can't revive.
894
895                 A dying cgroup can consume system resources not exceeding
896                 limits, which were active at the moment of cgroup deletion.
897
898
899 Controllers
900 ===========
901
902 CPU
903 ---
904
905 The "cpu" controllers regulates distribution of CPU cycles.  This
906 controller implements weight and absolute bandwidth limit models for
907 normal scheduling policy and absolute bandwidth allocation model for
908 realtime scheduling policy.
909
910 WARNING: cgroup2 doesn't yet support control of realtime processes and
911 the cpu controller can only be enabled when all RT processes are in
912 the root cgroup.  Be aware that system management software may already
913 have placed RT processes into nonroot cgroups during the system boot
914 process, and these processes may need to be moved to the root cgroup
915 before the cpu controller can be enabled.
916
917
918 CPU Interface Files
919 ~~~~~~~~~~~~~~~~~~~
920
921 All time durations are in microseconds.
922
923   cpu.stat
924         A read-only flat-keyed file which exists on non-root cgroups.
925         This file exists whether the controller is enabled or not.
926
927         It always reports the following three stats:
928
929         - usage_usec
930         - user_usec
931         - system_usec
932
933         and the following three when the controller is enabled:
934
935         - nr_periods
936         - nr_throttled
937         - throttled_usec
938
939   cpu.weight
940         A read-write single value file which exists on non-root
941         cgroups.  The default is "100".
942
943         The weight in the range [1, 10000].
944
945   cpu.weight.nice
946         A read-write single value file which exists on non-root
947         cgroups.  The default is "0".
948
949         The nice value is in the range [-20, 19].
950
951         This interface file is an alternative interface for
952         "cpu.weight" and allows reading and setting weight using the
953         same values used by nice(2).  Because the range is smaller and
954         granularity is coarser for the nice values, the read value is
955         the closest approximation of the current weight.
956
957   cpu.max
958         A read-write two value file which exists on non-root cgroups.
959         The default is "max 100000".
960
961         The maximum bandwidth limit.  It's in the following format::
962
963           $MAX $PERIOD
964
965         which indicates that the group may consume upto $MAX in each
966         $PERIOD duration.  "max" for $MAX indicates no limit.  If only
967         one number is written, $MAX is updated.
968
969   cpu.pressure
970         A read-only nested-key file which exists on non-root cgroups.
971
972         Shows pressure stall information for CPU. See
973         Documentation/accounting/psi.txt for details.
974
975
976 Memory
977 ------
978
979 The "memory" controller regulates distribution of memory.  Memory is
980 stateful and implements both limit and protection models.  Due to the
981 intertwining between memory usage and reclaim pressure and the
982 stateful nature of memory, the distribution model is relatively
983 complex.
984
985 While not completely water-tight, all major memory usages by a given
986 cgroup are tracked so that the total memory consumption can be
987 accounted and controlled to a reasonable extent.  Currently, the
988 following types of memory usages are tracked.
989
990 - Userland memory - page cache and anonymous memory.
991
992 - Kernel data structures such as dentries and inodes.
993
994 - TCP socket buffers.
995
996 The above list may expand in the future for better coverage.
997
998
999 Memory Interface Files
1000 ~~~~~~~~~~~~~~~~~~~~~~
1001
1002 All memory amounts are in bytes.  If a value which is not aligned to
1003 PAGE_SIZE is written, the value may be rounded up to the closest
1004 PAGE_SIZE multiple when read back.
1005
1006   memory.current
1007         A read-only single value file which exists on non-root
1008         cgroups.
1009
1010         The total amount of memory currently being used by the cgroup
1011         and its descendants.
1012
1013   memory.min
1014         A read-write single value file which exists on non-root
1015         cgroups.  The default is "0".
1016
1017         Hard memory protection.  If the memory usage of a cgroup
1018         is within its effective min boundary, the cgroup's memory
1019         won't be reclaimed under any conditions. If there is no
1020         unprotected reclaimable memory available, OOM killer
1021         is invoked.
1022
1023        Effective min boundary is limited by memory.min values of
1024         all ancestor cgroups. If there is memory.min overcommitment
1025         (child cgroup or cgroups are requiring more protected memory
1026         than parent will allow), then each child cgroup will get
1027         the part of parent's protection proportional to its
1028         actual memory usage below memory.min.
1029
1030         Putting more memory than generally available under this
1031         protection is discouraged and may lead to constant OOMs.
1032
1033         If a memory cgroup is not populated with processes,
1034         its memory.min is ignored.
1035
1036   memory.low
1037         A read-write single value file which exists on non-root
1038         cgroups.  The default is "0".
1039
1040         Best-effort memory protection.  If the memory usage of a
1041         cgroup is within its effective low boundary, the cgroup's
1042         memory won't be reclaimed unless memory can be reclaimed
1043         from unprotected cgroups.
1044
1045         Effective low boundary is limited by memory.low values of
1046         all ancestor cgroups. If there is memory.low overcommitment
1047         (child cgroup or cgroups are requiring more protected memory
1048         than parent will allow), then each child cgroup will get
1049         the part of parent's protection proportional to its
1050         actual memory usage below memory.low.
1051
1052         Putting more memory than generally available under this
1053         protection is discouraged.
1054
1055   memory.high
1056         A read-write single value file which exists on non-root
1057         cgroups.  The default is "max".
1058
1059         Memory usage throttle limit.  This is the main mechanism to
1060         control memory usage of a cgroup.  If a cgroup's usage goes
1061         over the high boundary, the processes of the cgroup are
1062         throttled and put under heavy reclaim pressure.
1063
1064         Going over the high limit never invokes the OOM killer and
1065         under extreme conditions the limit may be breached.
1066
1067   memory.max
1068         A read-write single value file which exists on non-root
1069         cgroups.  The default is "max".
1070
1071         Memory usage hard limit.  This is the final protection
1072         mechanism.  If a cgroup's memory usage reaches this limit and
1073         can't be reduced, the OOM killer is invoked in the cgroup.
1074         Under certain circumstances, the usage may go over the limit
1075         temporarily.
1076
1077         This is the ultimate protection mechanism.  As long as the
1078         high limit is used and monitored properly, this limit's
1079         utility is limited to providing the final safety net.
1080
1081   memory.oom.group
1082         A read-write single value file which exists on non-root
1083         cgroups.  The default value is "0".
1084
1085         Determines whether the cgroup should be treated as
1086         an indivisible workload by the OOM killer. If set,
1087         all tasks belonging to the cgroup or to its descendants
1088         (if the memory cgroup is not a leaf cgroup) are killed
1089         together or not at all. This can be used to avoid
1090         partial kills to guarantee workload integrity.
1091
1092         Tasks with the OOM protection (oom_score_adj set to -1000)
1093         are treated as an exception and are never killed.
1094
1095         If the OOM killer is invoked in a cgroup, it's not going
1096         to kill any tasks outside of this cgroup, regardless
1097         memory.oom.group values of ancestor cgroups.
1098
1099   memory.events
1100         A read-only flat-keyed file which exists on non-root cgroups.
1101         The following entries are defined.  Unless specified
1102         otherwise, a value change in this file generates a file
1103         modified event.
1104
1105           low
1106                 The number of times the cgroup is reclaimed due to
1107                 high memory pressure even though its usage is under
1108                 the low boundary.  This usually indicates that the low
1109                 boundary is over-committed.
1110
1111           high
1112                 The number of times processes of the cgroup are
1113                 throttled and routed to perform direct memory reclaim
1114                 because the high memory boundary was exceeded.  For a
1115                 cgroup whose memory usage is capped by the high limit
1116                 rather than global memory pressure, this event's
1117                 occurrences are expected.
1118
1119           max
1120                 The number of times the cgroup's memory usage was
1121                 about to go over the max boundary.  If direct reclaim
1122                 fails to bring it down, the cgroup goes to OOM state.
1123
1124           oom
1125                 The number of time the cgroup's memory usage was
1126                 reached the limit and allocation was about to fail.
1127
1128                 Depending on context result could be invocation of OOM
1129                 killer and retrying allocation or failing allocation.
1130
1131                 Failed allocation in its turn could be returned into
1132                 userspace as -ENOMEM or silently ignored in cases like
1133                 disk readahead.  For now OOM in memory cgroup kills
1134                 tasks iff shortage has happened inside page fault.
1135
1136           oom_kill
1137                 The number of processes belonging to this cgroup
1138                 killed by any kind of OOM killer.
1139
1140   memory.stat
1141         A read-only flat-keyed file which exists on non-root cgroups.
1142
1143         This breaks down the cgroup's memory footprint into different
1144         types of memory, type-specific details, and other information
1145         on the state and past events of the memory management system.
1146
1147         All memory amounts are in bytes.
1148
1149         The entries are ordered to be human readable, and new entries
1150         can show up in the middle. Don't rely on items remaining in a
1151         fixed position; use the keys to look up specific values!
1152
1153           anon
1154                 Amount of memory used in anonymous mappings such as
1155                 brk(), sbrk(), and mmap(MAP_ANONYMOUS)
1156
1157           file
1158                 Amount of memory used to cache filesystem data,
1159                 including tmpfs and shared memory.
1160
1161           kernel_stack
1162                 Amount of memory allocated to kernel stacks.
1163
1164           slab
1165                 Amount of memory used for storing in-kernel data
1166                 structures.
1167
1168           sock
1169                 Amount of memory used in network transmission buffers
1170
1171           shmem
1172                 Amount of cached filesystem data that is swap-backed,
1173                 such as tmpfs, shm segments, shared anonymous mmap()s
1174
1175           file_mapped
1176                 Amount of cached filesystem data mapped with mmap()
1177
1178           file_dirty
1179                 Amount of cached filesystem data that was modified but
1180                 not yet written back to disk
1181
1182           file_writeback
1183                 Amount of cached filesystem data that was modified and
1184                 is currently being written back to disk
1185
1186           inactive_anon, active_anon, inactive_file, active_file, unevictable
1187                 Amount of memory, swap-backed and filesystem-backed,
1188                 on the internal memory management lists used by the
1189                 page reclaim algorithm
1190
1191           slab_reclaimable
1192                 Part of "slab" that might be reclaimed, such as
1193                 dentries and inodes.
1194
1195           slab_unreclaimable
1196                 Part of "slab" that cannot be reclaimed on memory
1197                 pressure.
1198
1199           pgfault
1200                 Total number of page faults incurred
1201
1202           pgmajfault
1203                 Number of major page faults incurred
1204
1205           workingset_refault
1206
1207                 Number of refaults of previously evicted pages
1208
1209           workingset_activate
1210
1211                 Number of refaulted pages that were immediately activated
1212
1213           workingset_nodereclaim
1214
1215                 Number of times a shadow node has been reclaimed
1216
1217           pgrefill
1218
1219                 Amount of scanned pages (in an active LRU list)
1220
1221           pgscan
1222
1223                 Amount of scanned pages (in an inactive LRU list)
1224
1225           pgsteal
1226
1227                 Amount of reclaimed pages
1228
1229           pgactivate
1230
1231                 Amount of pages moved to the active LRU list
1232
1233           pgdeactivate
1234
1235                 Amount of pages moved to the inactive LRU lis
1236
1237           pglazyfree
1238
1239                 Amount of pages postponed to be freed under memory pressure
1240
1241           pglazyfreed
1242
1243                 Amount of reclaimed lazyfree pages
1244
1245   memory.swap.current
1246         A read-only single value file which exists on non-root
1247         cgroups.
1248
1249         The total amount of swap currently being used by the cgroup
1250         and its descendants.
1251
1252   memory.swap.max
1253         A read-write single value file which exists on non-root
1254         cgroups.  The default is "max".
1255
1256         Swap usage hard limit.  If a cgroup's swap usage reaches this
1257         limit, anonymous memory of the cgroup will not be swapped out.
1258
1259   memory.swap.events
1260         A read-only flat-keyed file which exists on non-root cgroups.
1261         The following entries are defined.  Unless specified
1262         otherwise, a value change in this file generates a file
1263         modified event.
1264
1265           max
1266                 The number of times the cgroup's swap usage was about
1267                 to go over the max boundary and swap allocation
1268                 failed.
1269
1270           fail
1271                 The number of times swap allocation failed either
1272                 because of running out of swap system-wide or max
1273                 limit.
1274
1275         When reduced under the current usage, the existing swap
1276         entries are reclaimed gradually and the swap usage may stay
1277         higher than the limit for an extended period of time.  This
1278         reduces the impact on the workload and memory management.
1279
1280   memory.pressure
1281         A read-only nested-key file which exists on non-root cgroups.
1282
1283         Shows pressure stall information for memory. See
1284         Documentation/accounting/psi.txt for details.
1285
1286
1287 Usage Guidelines
1288 ~~~~~~~~~~~~~~~~
1289
1290 "memory.high" is the main mechanism to control memory usage.
1291 Over-committing on high limit (sum of high limits > available memory)
1292 and letting global memory pressure to distribute memory according to
1293 usage is a viable strategy.
1294
1295 Because breach of the high limit doesn't trigger the OOM killer but
1296 throttles the offending cgroup, a management agent has ample
1297 opportunities to monitor and take appropriate actions such as granting
1298 more memory or terminating the workload.
1299
1300 Determining whether a cgroup has enough memory is not trivial as
1301 memory usage doesn't indicate whether the workload can benefit from
1302 more memory.  For example, a workload which writes data received from
1303 network to a file can use all available memory but can also operate as
1304 performant with a small amount of memory.  A measure of memory
1305 pressure - how much the workload is being impacted due to lack of
1306 memory - is necessary to determine whether a workload needs more
1307 memory; unfortunately, memory pressure monitoring mechanism isn't
1308 implemented yet.
1309
1310
1311 Memory Ownership
1312 ~~~~~~~~~~~~~~~~
1313
1314 A memory area is charged to the cgroup which instantiated it and stays
1315 charged to the cgroup until the area is released.  Migrating a process
1316 to a different cgroup doesn't move the memory usages that it
1317 instantiated while in the previous cgroup to the new cgroup.
1318
1319 A memory area may be used by processes belonging to different cgroups.
1320 To which cgroup the area will be charged is in-deterministic; however,
1321 over time, the memory area is likely to end up in a cgroup which has
1322 enough memory allowance to avoid high reclaim pressure.
1323
1324 If a cgroup sweeps a considerable amount of memory which is expected
1325 to be accessed repeatedly by other cgroups, it may make sense to use
1326 POSIX_FADV_DONTNEED to relinquish the ownership of memory areas
1327 belonging to the affected files to ensure correct memory ownership.
1328
1329
1330 IO
1331 --
1332
1333 The "io" controller regulates the distribution of IO resources.  This
1334 controller implements both weight based and absolute bandwidth or IOPS
1335 limit distribution; however, weight based distribution is available
1336 only if cfq-iosched is in use and neither scheme is available for
1337 blk-mq devices.
1338
1339
1340 IO Interface Files
1341 ~~~~~~~~~~~~~~~~~~
1342
1343   io.stat
1344         A read-only nested-keyed file which exists on non-root
1345         cgroups.
1346
1347         Lines are keyed by $MAJ:$MIN device numbers and not ordered.
1348         The following nested keys are defined.
1349
1350           ======        =====================
1351           rbytes        Bytes read
1352           wbytes        Bytes written
1353           rios          Number of read IOs
1354           wios          Number of write IOs
1355           dbytes        Bytes discarded
1356           dios          Number of discard IOs
1357           ======        =====================
1358
1359         An example read output follows:
1360
1361           8:16 rbytes=1459200 wbytes=314773504 rios=192 wios=353 dbytes=0 dios=0
1362           8:0 rbytes=90430464 wbytes=299008000 rios=8950 wios=1252 dbytes=50331648 dios=3021
1363
1364   io.weight
1365         A read-write flat-keyed file which exists on non-root cgroups.
1366         The default is "default 100".
1367
1368         The first line is the default weight applied to devices
1369         without specific override.  The rest are overrides keyed by
1370         $MAJ:$MIN device numbers and not ordered.  The weights are in
1371         the range [1, 10000] and specifies the relative amount IO time
1372         the cgroup can use in relation to its siblings.
1373
1374         The default weight can be updated by writing either "default
1375         $WEIGHT" or simply "$WEIGHT".  Overrides can be set by writing
1376         "$MAJ:$MIN $WEIGHT" and unset by writing "$MAJ:$MIN default".
1377
1378         An example read output follows::
1379
1380           default 100
1381           8:16 200
1382           8:0 50
1383
1384   io.max
1385         A read-write nested-keyed file which exists on non-root
1386         cgroups.
1387
1388         BPS and IOPS based IO limit.  Lines are keyed by $MAJ:$MIN
1389         device numbers and not ordered.  The following nested keys are
1390         defined.
1391
1392           =====         ==================================
1393           rbps          Max read bytes per second
1394           wbps          Max write bytes per second
1395           riops         Max read IO operations per second
1396           wiops         Max write IO operations per second
1397           =====         ==================================
1398
1399         When writing, any number of nested key-value pairs can be
1400         specified in any order.  "max" can be specified as the value
1401         to remove a specific limit.  If the same key is specified
1402         multiple times, the outcome is undefined.
1403
1404         BPS and IOPS are measured in each IO direction and IOs are
1405         delayed if limit is reached.  Temporary bursts are allowed.
1406
1407         Setting read limit at 2M BPS and write at 120 IOPS for 8:16::
1408
1409           echo "8:16 rbps=2097152 wiops=120" > io.max
1410
1411         Reading returns the following::
1412
1413           8:16 rbps=2097152 wbps=max riops=max wiops=120
1414
1415         Write IOPS limit can be removed by writing the following::
1416
1417           echo "8:16 wiops=max" > io.max
1418
1419         Reading now returns the following::
1420
1421           8:16 rbps=2097152 wbps=max riops=max wiops=max
1422
1423   io.pressure
1424         A read-only nested-key file which exists on non-root cgroups.
1425
1426         Shows pressure stall information for IO. See
1427         Documentation/accounting/psi.txt for details.
1428
1429
1430 Writeback
1431 ~~~~~~~~~
1432
1433 Page cache is dirtied through buffered writes and shared mmaps and
1434 written asynchronously to the backing filesystem by the writeback
1435 mechanism.  Writeback sits between the memory and IO domains and
1436 regulates the proportion of dirty memory by balancing dirtying and
1437 write IOs.
1438
1439 The io controller, in conjunction with the memory controller,
1440 implements control of page cache writeback IOs.  The memory controller
1441 defines the memory domain that dirty memory ratio is calculated and
1442 maintained for and the io controller defines the io domain which
1443 writes out dirty pages for the memory domain.  Both system-wide and
1444 per-cgroup dirty memory states are examined and the more restrictive
1445 of the two is enforced.
1446
1447 cgroup writeback requires explicit support from the underlying
1448 filesystem.  Currently, cgroup writeback is implemented on ext2, ext4
1449 and btrfs.  On other filesystems, all writeback IOs are attributed to
1450 the root cgroup.
1451
1452 There are inherent differences in memory and writeback management
1453 which affects how cgroup ownership is tracked.  Memory is tracked per
1454 page while writeback per inode.  For the purpose of writeback, an
1455 inode is assigned to a cgroup and all IO requests to write dirty pages
1456 from the inode are attributed to that cgroup.
1457
1458 As cgroup ownership for memory is tracked per page, there can be pages
1459 which are associated with different cgroups than the one the inode is
1460 associated with.  These are called foreign pages.  The writeback
1461 constantly keeps track of foreign pages and, if a particular foreign
1462 cgroup becomes the majority over a certain period of time, switches
1463 the ownership of the inode to that cgroup.
1464
1465 While this model is enough for most use cases where a given inode is
1466 mostly dirtied by a single cgroup even when the main writing cgroup
1467 changes over time, use cases where multiple cgroups write to a single
1468 inode simultaneously are not supported well.  In such circumstances, a
1469 significant portion of IOs are likely to be attributed incorrectly.
1470 As memory controller assigns page ownership on the first use and
1471 doesn't update it until the page is released, even if writeback
1472 strictly follows page ownership, multiple cgroups dirtying overlapping
1473 areas wouldn't work as expected.  It's recommended to avoid such usage
1474 patterns.
1475
1476 The sysctl knobs which affect writeback behavior are applied to cgroup
1477 writeback as follows.
1478
1479   vm.dirty_background_ratio, vm.dirty_ratio
1480         These ratios apply the same to cgroup writeback with the
1481         amount of available memory capped by limits imposed by the
1482         memory controller and system-wide clean memory.
1483
1484   vm.dirty_background_bytes, vm.dirty_bytes
1485         For cgroup writeback, this is calculated into ratio against
1486         total available memory and applied the same way as
1487         vm.dirty[_background]_ratio.
1488
1489
1490 IO Latency
1491 ~~~~~~~~~~
1492
1493 This is a cgroup v2 controller for IO workload protection.  You provide a group
1494 with a latency target, and if the average latency exceeds that target the
1495 controller will throttle any peers that have a lower latency target than the
1496 protected workload.
1497
1498 The limits are only applied at the peer level in the hierarchy.  This means that
1499 in the diagram below, only groups A, B, and C will influence each other, and
1500 groups D and F will influence each other.  Group G will influence nobody.
1501
1502                         [root]
1503                 /          |            \
1504                 A          B            C
1505                /  \        |
1506               D    F       G
1507
1508
1509 So the ideal way to configure this is to set io.latency in groups A, B, and C.
1510 Generally you do not want to set a value lower than the latency your device
1511 supports.  Experiment to find the value that works best for your workload.
1512 Start at higher than the expected latency for your device and watch the
1513 avg_lat value in io.stat for your workload group to get an idea of the
1514 latency you see during normal operation.  Use the avg_lat value as a basis for
1515 your real setting, setting at 10-15% higher than the value in io.stat.
1516
1517 How IO Latency Throttling Works
1518 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1519
1520 io.latency is work conserving; so as long as everybody is meeting their latency
1521 target the controller doesn't do anything.  Once a group starts missing its
1522 target it begins throttling any peer group that has a higher target than itself.
1523 This throttling takes 2 forms:
1524
1525 - Queue depth throttling.  This is the number of outstanding IO's a group is
1526   allowed to have.  We will clamp down relatively quickly, starting at no limit
1527   and going all the way down to 1 IO at a time.
1528
1529 - Artificial delay induction.  There are certain types of IO that cannot be
1530   throttled without possibly adversely affecting higher priority groups.  This
1531   includes swapping and metadata IO.  These types of IO are allowed to occur
1532   normally, however they are "charged" to the originating group.  If the
1533   originating group is being throttled you will see the use_delay and delay
1534   fields in io.stat increase.  The delay value is how many microseconds that are
1535   being added to any process that runs in this group.  Because this number can
1536   grow quite large if there is a lot of swapping or metadata IO occurring we
1537   limit the individual delay events to 1 second at a time.
1538
1539 Once the victimized group starts meeting its latency target again it will start
1540 unthrottling any peer groups that were throttled previously.  If the victimized
1541 group simply stops doing IO the global counter will unthrottle appropriately.
1542
1543 IO Latency Interface Files
1544 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1545
1546   io.latency
1547         This takes a similar format as the other controllers.
1548
1549                 "MAJOR:MINOR target=<target time in microseconds"
1550
1551   io.stat
1552         If the controller is enabled you will see extra stats in io.stat in
1553         addition to the normal ones.
1554
1555           depth
1556                 This is the current queue depth for the group.
1557
1558           avg_lat
1559                 This is an exponential moving average with a decay rate of 1/exp
1560                 bound by the sampling interval.  The decay rate interval can be
1561                 calculated by multiplying the win value in io.stat by the
1562                 corresponding number of samples based on the win value.
1563
1564           win
1565                 The sampling window size in milliseconds.  This is the minimum
1566                 duration of time between evaluation events.  Windows only elapse
1567                 with IO activity.  Idle periods extend the most recent window.
1568
1569 PID
1570 ---
1571
1572 The process number controller is used to allow a cgroup to stop any
1573 new tasks from being fork()'d or clone()'d after a specified limit is
1574 reached.
1575
1576 The number of tasks in a cgroup can be exhausted in ways which other
1577 controllers cannot prevent, thus warranting its own controller.  For
1578 example, a fork bomb is likely to exhaust the number of tasks before
1579 hitting memory restrictions.
1580
1581 Note that PIDs used in this controller refer to TIDs, process IDs as
1582 used by the kernel.
1583
1584
1585 PID Interface Files
1586 ~~~~~~~~~~~~~~~~~~~
1587
1588   pids.max
1589         A read-write single value file which exists on non-root
1590         cgroups.  The default is "max".
1591
1592         Hard limit of number of processes.
1593
1594   pids.current
1595         A read-only single value file which exists on all cgroups.
1596
1597         The number of processes currently in the cgroup and its
1598         descendants.
1599
1600 Organisational operations are not blocked by cgroup policies, so it is
1601 possible to have pids.current > pids.max.  This can be done by either
1602 setting the limit to be smaller than pids.current, or attaching enough
1603 processes to the cgroup such that pids.current is larger than
1604 pids.max.  However, it is not possible to violate a cgroup PID policy
1605 through fork() or clone(). These will return -EAGAIN if the creation
1606 of a new process would cause a cgroup policy to be violated.
1607
1608
1609 Device controller
1610 -----------------
1611
1612 Device controller manages access to device files. It includes both
1613 creation of new device files (using mknod), and access to the
1614 existing device files.
1615
1616 Cgroup v2 device controller has no interface files and is implemented
1617 on top of cgroup BPF. To control access to device files, a user may
1618 create bpf programs of the BPF_CGROUP_DEVICE type and attach them
1619 to cgroups. On an attempt to access a device file, corresponding
1620 BPF programs will be executed, and depending on the return value
1621 the attempt will succeed or fail with -EPERM.
1622
1623 A BPF_CGROUP_DEVICE program takes a pointer to the bpf_cgroup_dev_ctx
1624 structure, which describes the device access attempt: access type
1625 (mknod/read/write) and device (type, major and minor numbers).
1626 If the program returns 0, the attempt fails with -EPERM, otherwise
1627 it succeeds.
1628
1629 An example of BPF_CGROUP_DEVICE program may be found in the kernel
1630 source tree in the tools/testing/selftests/bpf/dev_cgroup.c file.
1631
1632
1633 RDMA
1634 ----
1635
1636 The "rdma" controller regulates the distribution and accounting of
1637 of RDMA resources.
1638
1639 RDMA Interface Files
1640 ~~~~~~~~~~~~~~~~~~~~
1641
1642   rdma.max
1643         A readwrite nested-keyed file that exists for all the cgroups
1644         except root that describes current configured resource limit
1645         for a RDMA/IB device.
1646
1647         Lines are keyed by device name and are not ordered.
1648         Each line contains space separated resource name and its configured
1649         limit that can be distributed.
1650
1651         The following nested keys are defined.
1652
1653           ==========    =============================
1654           hca_handle    Maximum number of HCA Handles
1655           hca_object    Maximum number of HCA Objects
1656           ==========    =============================
1657
1658         An example for mlx4 and ocrdma device follows::
1659
1660           mlx4_0 hca_handle=2 hca_object=2000
1661           ocrdma1 hca_handle=3 hca_object=max
1662
1663   rdma.current
1664         A read-only file that describes current resource usage.
1665         It exists for all the cgroup except root.
1666
1667         An example for mlx4 and ocrdma device follows::
1668
1669           mlx4_0 hca_handle=1 hca_object=20
1670           ocrdma1 hca_handle=1 hca_object=23
1671
1672
1673 Misc
1674 ----
1675
1676 perf_event
1677 ~~~~~~~~~~
1678
1679 perf_event controller, if not mounted on a legacy hierarchy, is
1680 automatically enabled on the v2 hierarchy so that perf events can
1681 always be filtered by cgroup v2 path.  The controller can still be
1682 moved to a legacy hierarchy after v2 hierarchy is populated.
1683
1684
1685 Non-normative information
1686 -------------------------
1687
1688 This section contains information that isn't considered to be a part of
1689 the stable kernel API and so is subject to change.
1690
1691
1692 CPU controller root cgroup process behaviour
1693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1694
1695 When distributing CPU cycles in the root cgroup each thread in this
1696 cgroup is treated as if it was hosted in a separate child cgroup of the
1697 root cgroup. This child cgroup weight is dependent on its thread nice
1698 level.
1699
1700 For details of this mapping see sched_prio_to_weight array in
1701 kernel/sched/core.c file (values from this array should be scaled
1702 appropriately so the neutral - nice 0 - value is 100 instead of 1024).
1703
1704
1705 IO controller root cgroup process behaviour
1706 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1707
1708 Root cgroup processes are hosted in an implicit leaf child node.
1709 When distributing IO resources this implicit child node is taken into
1710 account as if it was a normal child cgroup of the root cgroup with a
1711 weight value of 200.
1712
1713
1714 Namespace
1715 =========
1716
1717 Basics
1718 ------
1719
1720 cgroup namespace provides a mechanism to virtualize the view of the
1721 "/proc/$PID/cgroup" file and cgroup mounts.  The CLONE_NEWCGROUP clone
1722 flag can be used with clone(2) and unshare(2) to create a new cgroup
1723 namespace.  The process running inside the cgroup namespace will have
1724 its "/proc/$PID/cgroup" output restricted to cgroupns root.  The
1725 cgroupns root is the cgroup of the process at the time of creation of
1726 the cgroup namespace.
1727
1728 Without cgroup namespace, the "/proc/$PID/cgroup" file shows the
1729 complete path of the cgroup of a process.  In a container setup where
1730 a set of cgroups and namespaces are intended to isolate processes the
1731 "/proc/$PID/cgroup" file may leak potential system level information
1732 to the isolated processes.  For Example::
1733
1734   # cat /proc/self/cgroup
1735   0::/batchjobs/container_id1
1736
1737 The path '/batchjobs/container_id1' can be considered as system-data
1738 and undesirable to expose to the isolated processes.  cgroup namespace
1739 can be used to restrict visibility of this path.  For example, before
1740 creating a cgroup namespace, one would see::
1741
1742   # ls -l /proc/self/ns/cgroup
1743   lrwxrwxrwx 1 root root 0 2014-07-15 10:37 /proc/self/ns/cgroup -> cgroup:[4026531835]
1744   # cat /proc/self/cgroup
1745   0::/batchjobs/container_id1
1746
1747 After unsharing a new namespace, the view changes::
1748
1749   # ls -l /proc/self/ns/cgroup
1750   lrwxrwxrwx 1 root root 0 2014-07-15 10:35 /proc/self/ns/cgroup -> cgroup:[4026532183]
1751   # cat /proc/self/cgroup
1752   0::/
1753
1754 When some thread from a multi-threaded process unshares its cgroup
1755 namespace, the new cgroupns gets applied to the entire process (all
1756 the threads).  This is natural for the v2 hierarchy; however, for the
1757 legacy hierarchies, this may be unexpected.
1758
1759 A cgroup namespace is alive as long as there are processes inside or
1760 mounts pinning it.  When the last usage goes away, the cgroup
1761 namespace is destroyed.  The cgroupns root and the actual cgroups
1762 remain.
1763
1764
1765 The Root and Views
1766 ------------------
1767
1768 The 'cgroupns root' for a cgroup namespace is the cgroup in which the
1769 process calling unshare(2) is running.  For example, if a process in
1770 /batchjobs/container_id1 cgroup calls unshare, cgroup
1771 /batchjobs/container_id1 becomes the cgroupns root.  For the
1772 init_cgroup_ns, this is the real root ('/') cgroup.
1773
1774 The cgroupns root cgroup does not change even if the namespace creator
1775 process later moves to a different cgroup::
1776
1777   # ~/unshare -c # unshare cgroupns in some cgroup
1778   # cat /proc/self/cgroup
1779   0::/
1780   # mkdir sub_cgrp_1
1781   # echo 0 > sub_cgrp_1/cgroup.procs
1782   # cat /proc/self/cgroup
1783   0::/sub_cgrp_1
1784
1785 Each process gets its namespace-specific view of "/proc/$PID/cgroup"
1786
1787 Processes running inside the cgroup namespace will be able to see
1788 cgroup paths (in /proc/self/cgroup) only inside their root cgroup.
1789 From within an unshared cgroupns::
1790
1791   # sleep 100000 &
1792   [1] 7353
1793   # echo 7353 > sub_cgrp_1/cgroup.procs
1794   # cat /proc/7353/cgroup
1795   0::/sub_cgrp_1
1796
1797 From the initial cgroup namespace, the real cgroup path will be
1798 visible::
1799
1800   $ cat /proc/7353/cgroup
1801   0::/batchjobs/container_id1/sub_cgrp_1
1802
1803 From a sibling cgroup namespace (that is, a namespace rooted at a
1804 different cgroup), the cgroup path relative to its own cgroup
1805 namespace root will be shown.  For instance, if PID 7353's cgroup
1806 namespace root is at '/batchjobs/container_id2', then it will see::
1807
1808   # cat /proc/7353/cgroup
1809   0::/../container_id2/sub_cgrp_1
1810
1811 Note that the relative path always starts with '/' to indicate that
1812 its relative to the cgroup namespace root of the caller.
1813
1814
1815 Migration and setns(2)
1816 ----------------------
1817
1818 Processes inside a cgroup namespace can move into and out of the
1819 namespace root if they have proper access to external cgroups.  For
1820 example, from inside a namespace with cgroupns root at
1821 /batchjobs/container_id1, and assuming that the global hierarchy is
1822 still accessible inside cgroupns::
1823
1824   # cat /proc/7353/cgroup
1825   0::/sub_cgrp_1
1826   # echo 7353 > batchjobs/container_id2/cgroup.procs
1827   # cat /proc/7353/cgroup
1828   0::/../container_id2
1829
1830 Note that this kind of setup is not encouraged.  A task inside cgroup
1831 namespace should only be exposed to its own cgroupns hierarchy.
1832
1833 setns(2) to another cgroup namespace is allowed when:
1834
1835 (a) the process has CAP_SYS_ADMIN against its current user namespace
1836 (b) the process has CAP_SYS_ADMIN against the target cgroup
1837     namespace's userns
1838
1839 No implicit cgroup changes happen with attaching to another cgroup
1840 namespace.  It is expected that the someone moves the attaching
1841 process under the target cgroup namespace root.
1842
1843
1844 Interaction with Other Namespaces
1845 ---------------------------------
1846
1847 Namespace specific cgroup hierarchy can be mounted by a process
1848 running inside a non-init cgroup namespace::
1849
1850   # mount -t cgroup2 none $MOUNT_POINT
1851
1852 This will mount the unified cgroup hierarchy with cgroupns root as the
1853 filesystem root.  The process needs CAP_SYS_ADMIN against its user and
1854 mount namespaces.
1855
1856 The virtualization of /proc/self/cgroup file combined with restricting
1857 the view of cgroup hierarchy by namespace-private cgroupfs mount
1858 provides a properly isolated cgroup view inside the container.
1859
1860
1861 Information on Kernel Programming
1862 =================================
1863
1864 This section contains kernel programming information in the areas
1865 where interacting with cgroup is necessary.  cgroup core and
1866 controllers are not covered.
1867
1868
1869 Filesystem Support for Writeback
1870 --------------------------------
1871
1872 A filesystem can support cgroup writeback by updating
1873 address_space_operations->writepage[s]() to annotate bio's using the
1874 following two functions.
1875
1876   wbc_init_bio(@wbc, @bio)
1877         Should be called for each bio carrying writeback data and
1878         associates the bio with the inode's owner cgroup and the
1879         corresponding request queue.  This must be called after
1880         a queue (device) has been associated with the bio and
1881         before submission.
1882
1883   wbc_account_io(@wbc, @page, @bytes)
1884         Should be called for each data segment being written out.
1885         While this function doesn't care exactly when it's called
1886         during the writeback session, it's the easiest and most
1887         natural to call it as data segments are added to a bio.
1888
1889 With writeback bio's annotated, cgroup support can be enabled per
1890 super_block by setting SB_I_CGROUPWB in ->s_iflags.  This allows for
1891 selective disabling of cgroup writeback support which is helpful when
1892 certain filesystem features, e.g. journaled data mode, are
1893 incompatible.
1894
1895 wbc_init_bio() binds the specified bio to its cgroup.  Depending on
1896 the configuration, the bio may be executed at a lower priority and if
1897 the writeback session is holding shared resources, e.g. a journal
1898 entry, may lead to priority inversion.  There is no one easy solution
1899 for the problem.  Filesystems can try to work around specific problem
1900 cases by skipping wbc_init_bio() or using bio_associate_create_blkg()
1901 directly.
1902
1903
1904 Deprecated v1 Core Features
1905 ===========================
1906
1907 - Multiple hierarchies including named ones are not supported.
1908
1909 - All v1 mount options are not supported.
1910
1911 - The "tasks" file is removed and "cgroup.procs" is not sorted.
1912
1913 - "cgroup.clone_children" is removed.
1914
1915 - /proc/cgroups is meaningless for v2.  Use "cgroup.controllers" file
1916   at the root instead.
1917
1918
1919 Issues with v1 and Rationales for v2
1920 ====================================
1921
1922 Multiple Hierarchies
1923 --------------------
1924
1925 cgroup v1 allowed an arbitrary number of hierarchies and each
1926 hierarchy could host any number of controllers.  While this seemed to
1927 provide a high level of flexibility, it wasn't useful in practice.
1928
1929 For example, as there is only one instance of each controller, utility
1930 type controllers such as freezer which can be useful in all
1931 hierarchies could only be used in one.  The issue is exacerbated by
1932 the fact that controllers couldn't be moved to another hierarchy once
1933 hierarchies were populated.  Another issue was that all controllers
1934 bound to a hierarchy were forced to have exactly the same view of the
1935 hierarchy.  It wasn't possible to vary the granularity depending on
1936 the specific controller.
1937
1938 In practice, these issues heavily limited which controllers could be
1939 put on the same hierarchy and most configurations resorted to putting
1940 each controller on its own hierarchy.  Only closely related ones, such
1941 as the cpu and cpuacct controllers, made sense to be put on the same
1942 hierarchy.  This often meant that userland ended up managing multiple
1943 similar hierarchies repeating the same steps on each hierarchy
1944 whenever a hierarchy management operation was necessary.
1945
1946 Furthermore, support for multiple hierarchies came at a steep cost.
1947 It greatly complicated cgroup core implementation but more importantly
1948 the support for multiple hierarchies restricted how cgroup could be
1949 used in general and what controllers was able to do.
1950
1951 There was no limit on how many hierarchies there might be, which meant
1952 that a thread's cgroup membership couldn't be described in finite
1953 length.  The key might contain any number of entries and was unlimited
1954 in length, which made it highly awkward to manipulate and led to
1955 addition of controllers which existed only to identify membership,
1956 which in turn exacerbated the original problem of proliferating number
1957 of hierarchies.
1958
1959 Also, as a controller couldn't have any expectation regarding the
1960 topologies of hierarchies other controllers might be on, each
1961 controller had to assume that all other controllers were attached to
1962 completely orthogonal hierarchies.  This made it impossible, or at
1963 least very cumbersome, for controllers to cooperate with each other.
1964
1965 In most use cases, putting controllers on hierarchies which are
1966 completely orthogonal to each other isn't necessary.  What usually is
1967 called for is the ability to have differing levels of granularity
1968 depending on the specific controller.  In other words, hierarchy may
1969 be collapsed from leaf towards root when viewed from specific
1970 controllers.  For example, a given configuration might not care about
1971 how memory is distributed beyond a certain level while still wanting
1972 to control how CPU cycles are distributed.
1973
1974
1975 Thread Granularity
1976 ------------------
1977
1978 cgroup v1 allowed threads of a process to belong to different cgroups.
1979 This didn't make sense for some controllers and those controllers
1980 ended up implementing different ways to ignore such situations but
1981 much more importantly it blurred the line between API exposed to
1982 individual applications and system management interface.
1983
1984 Generally, in-process knowledge is available only to the process
1985 itself; thus, unlike service-level organization of processes,
1986 categorizing threads of a process requires active participation from
1987 the application which owns the target process.
1988
1989 cgroup v1 had an ambiguously defined delegation model which got abused
1990 in combination with thread granularity.  cgroups were delegated to
1991 individual applications so that they can create and manage their own
1992 sub-hierarchies and control resource distributions along them.  This
1993 effectively raised cgroup to the status of a syscall-like API exposed
1994 to lay programs.
1995
1996 First of all, cgroup has a fundamentally inadequate interface to be
1997 exposed this way.  For a process to access its own knobs, it has to
1998 extract the path on the target hierarchy from /proc/self/cgroup,
1999 construct the path by appending the name of the knob to the path, open
2000 and then read and/or write to it.  This is not only extremely clunky
2001 and unusual but also inherently racy.  There is no conventional way to
2002 define transaction across the required steps and nothing can guarantee
2003 that the process would actually be operating on its own sub-hierarchy.
2004
2005 cgroup controllers implemented a number of knobs which would never be
2006 accepted as public APIs because they were just adding control knobs to
2007 system-management pseudo filesystem.  cgroup ended up with interface
2008 knobs which were not properly abstracted or refined and directly
2009 revealed kernel internal details.  These knobs got exposed to
2010 individual applications through the ill-defined delegation mechanism
2011 effectively abusing cgroup as a shortcut to implementing public APIs
2012 without going through the required scrutiny.
2013
2014 This was painful for both userland and kernel.  Userland ended up with
2015 misbehaving and poorly abstracted interfaces and kernel exposing and
2016 locked into constructs inadvertently.
2017
2018
2019 Competition Between Inner Nodes and Threads
2020 -------------------------------------------
2021
2022 cgroup v1 allowed threads to be in any cgroups which created an
2023 interesting problem where threads belonging to a parent cgroup and its
2024 children cgroups competed for resources.  This was nasty as two
2025 different types of entities competed and there was no obvious way to
2026 settle it.  Different controllers did different things.
2027
2028 The cpu controller considered threads and cgroups as equivalents and
2029 mapped nice levels to cgroup weights.  This worked for some cases but
2030 fell flat when children wanted to be allocated specific ratios of CPU
2031 cycles and the number of internal threads fluctuated - the ratios
2032 constantly changed as the number of competing entities fluctuated.
2033 There also were other issues.  The mapping from nice level to weight
2034 wasn't obvious or universal, and there were various other knobs which
2035 simply weren't available for threads.
2036
2037 The io controller implicitly created a hidden leaf node for each
2038 cgroup to host the threads.  The hidden leaf had its own copies of all
2039 the knobs with ``leaf_`` prefixed.  While this allowed equivalent
2040 control over internal threads, it was with serious drawbacks.  It
2041 always added an extra layer of nesting which wouldn't be necessary
2042 otherwise, made the interface messy and significantly complicated the
2043 implementation.
2044
2045 The memory controller didn't have a way to control what happened
2046 between internal tasks and child cgroups and the behavior was not
2047 clearly defined.  There were attempts to add ad-hoc behaviors and
2048 knobs to tailor the behavior to specific workloads which would have
2049 led to problems extremely difficult to resolve in the long term.
2050
2051 Multiple controllers struggled with internal tasks and came up with
2052 different ways to deal with it; unfortunately, all the approaches were
2053 severely flawed and, furthermore, the widely different behaviors
2054 made cgroup as a whole highly inconsistent.
2055
2056 This clearly is a problem which needs to be addressed from cgroup core
2057 in a uniform way.
2058
2059
2060 Other Interface Issues
2061 ----------------------
2062
2063 cgroup v1 grew without oversight and developed a large number of
2064 idiosyncrasies and inconsistencies.  One issue on the cgroup core side
2065 was how an empty cgroup was notified - a userland helper binary was
2066 forked and executed for each event.  The event delivery wasn't
2067 recursive or delegatable.  The limitations of the mechanism also led
2068 to in-kernel event delivery filtering mechanism further complicating
2069 the interface.
2070
2071 Controller interfaces were problematic too.  An extreme example is
2072 controllers completely ignoring hierarchical organization and treating
2073 all cgroups as if they were all located directly under the root
2074 cgroup.  Some controllers exposed a large amount of inconsistent
2075 implementation details to userland.
2076
2077 There also was no consistency across controllers.  When a new cgroup
2078 was created, some controllers defaulted to not imposing extra
2079 restrictions while others disallowed any resource usage until
2080 explicitly configured.  Configuration knobs for the same type of
2081 control used widely differing naming schemes and formats.  Statistics
2082 and information knobs were named arbitrarily and used different
2083 formats and units even in the same controller.
2084
2085 cgroup v2 establishes common conventions where appropriate and updates
2086 controllers so that they expose minimal and consistent interfaces.
2087
2088
2089 Controller Issues and Remedies
2090 ------------------------------
2091
2092 Memory
2093 ~~~~~~
2094
2095 The original lower boundary, the soft limit, is defined as a limit
2096 that is per default unset.  As a result, the set of cgroups that
2097 global reclaim prefers is opt-in, rather than opt-out.  The costs for
2098 optimizing these mostly negative lookups are so high that the
2099 implementation, despite its enormous size, does not even provide the
2100 basic desirable behavior.  First off, the soft limit has no
2101 hierarchical meaning.  All configured groups are organized in a global
2102 rbtree and treated like equal peers, regardless where they are located
2103 in the hierarchy.  This makes subtree delegation impossible.  Second,
2104 the soft limit reclaim pass is so aggressive that it not just
2105 introduces high allocation latencies into the system, but also impacts
2106 system performance due to overreclaim, to the point where the feature
2107 becomes self-defeating.
2108
2109 The memory.low boundary on the other hand is a top-down allocated
2110 reserve.  A cgroup enjoys reclaim protection when it's within its low,
2111 which makes delegation of subtrees possible.
2112
2113 The original high boundary, the hard limit, is defined as a strict
2114 limit that can not budge, even if the OOM killer has to be called.
2115 But this generally goes against the goal of making the most out of the
2116 available memory.  The memory consumption of workloads varies during
2117 runtime, and that requires users to overcommit.  But doing that with a
2118 strict upper limit requires either a fairly accurate prediction of the
2119 working set size or adding slack to the limit.  Since working set size
2120 estimation is hard and error prone, and getting it wrong results in
2121 OOM kills, most users tend to err on the side of a looser limit and
2122 end up wasting precious resources.
2123
2124 The memory.high boundary on the other hand can be set much more
2125 conservatively.  When hit, it throttles allocations by forcing them
2126 into direct reclaim to work off the excess, but it never invokes the
2127 OOM killer.  As a result, a high boundary that is chosen too
2128 aggressively will not terminate the processes, but instead it will
2129 lead to gradual performance degradation.  The user can monitor this
2130 and make corrections until the minimal memory footprint that still
2131 gives acceptable performance is found.
2132
2133 In extreme cases, with many concurrent allocations and a complete
2134 breakdown of reclaim progress within the group, the high boundary can
2135 be exceeded.  But even then it's mostly better to satisfy the
2136 allocation from the slack available in other groups or the rest of the
2137 system than killing the group.  Otherwise, memory.max is there to
2138 limit this type of spillover and ultimately contain buggy or even
2139 malicious applications.
2140
2141 Setting the original memory.limit_in_bytes below the current usage was
2142 subject to a race condition, where concurrent charges could cause the
2143 limit setting to fail. memory.max on the other hand will first set the
2144 limit to prevent new charges, and then reclaim and OOM kill until the
2145 new limit is met - or the task writing to memory.max is killed.
2146
2147 The combined memory+swap accounting and limiting is replaced by real
2148 control over swap space.
2149
2150 The main argument for a combined memory+swap facility in the original
2151 cgroup design was that global or parental pressure would always be
2152 able to swap all anonymous memory of a child group, regardless of the
2153 child's own (possibly untrusted) configuration.  However, untrusted
2154 groups can sabotage swapping by other means - such as referencing its
2155 anonymous memory in a tight loop - and an admin can not assume full
2156 swappability when overcommitting untrusted jobs.
2157
2158 For trusted jobs, on the other hand, a combined counter is not an
2159 intuitive userspace interface, and it flies in the face of the idea
2160 that cgroup controllers should account and limit specific physical
2161 resources.  Swap space is a resource like all others in the system,
2162 and that's why unified hierarchy allows distributing it separately.