Merge tag 'linux-kselftest-kunit-fixes-5.11-rc3' of git://git.kernel.org/pub/scm...
[linux/fpc-iii.git] / Documentation / admin-guide / cgroup-v2.rst
blob63521cd36ce53633f73e5607142a438566b933ab
1 ================
2 Control Group v2
3 ================
5 :Date: October, 2015
6 :Author: Tejun Heo <tj@kernel.org>
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 :ref:`Documentation/admin-guide/cgroup-v1/index.rst <cgroup-v1>`.
14 .. CONTENTS
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. Cpuset
60        5.5-1. Cpuset Interface Files
61      5-6. Device
62      5-7. RDMA
63        5-7-1. RDMA Interface Files
64      5-8. HugeTLB
65        5.8-1. HugeTLB Interface Files
66      5-8. Misc
67        5-8-1. perf_event
68      5-N. Non-normative information
69        5-N-1. CPU controller root cgroup process behaviour
70        5-N-2. IO controller root cgroup process behaviour
71    6. Namespace
72      6-1. Basics
73      6-2. The Root and Views
74      6-3. Migration and setns(2)
75      6-4. Interaction with Other Namespaces
76    P. Information on Kernel Programming
77      P-1. Filesystem Support for Writeback
78    D. Deprecated v1 Core Features
79    R. Issues with v1 and Rationales for v2
80      R-1. Multiple Hierarchies
81      R-2. Thread Granularity
82      R-3. Competition Between Inner Nodes and Threads
83      R-4. Other Interface Issues
84      R-5. Controller Issues and Remedies
85        R-5-1. Memory
88 Introduction
89 ============
91 Terminology
92 -----------
94 "cgroup" stands for "control group" and is never capitalized.  The
95 singular form is used to designate the whole feature and also as a
96 qualifier as in "cgroup controllers".  When explicitly referring to
97 multiple individual control groups, the plural form "cgroups" is used.
100 What is cgroup?
101 ---------------
103 cgroup is a mechanism to organize processes hierarchically and
104 distribute system resources along the hierarchy in a controlled and
105 configurable manner.
107 cgroup is largely composed of two parts - the core and controllers.
108 cgroup core is primarily responsible for hierarchically organizing
109 processes.  A cgroup controller is usually responsible for
110 distributing a specific type of system resource along the hierarchy
111 although there are utility controllers which serve purposes other than
112 resource distribution.
114 cgroups form a tree structure and every process in the system belongs
115 to one and only one cgroup.  All threads of a process belong to the
116 same cgroup.  On creation, all processes are put in the cgroup that
117 the parent process belongs to at the time.  A process can be migrated
118 to another cgroup.  Migration of a process doesn't affect already
119 existing descendant processes.
121 Following certain structural constraints, controllers may be enabled or
122 disabled selectively on a cgroup.  All controller behaviors are
123 hierarchical - if a controller is enabled on a cgroup, it affects all
124 processes which belong to the cgroups consisting the inclusive
125 sub-hierarchy of the cgroup.  When a controller is enabled on a nested
126 cgroup, it always restricts the resource distribution further.  The
127 restrictions set closer to the root in the hierarchy can not be
128 overridden from further away.
131 Basic Operations
132 ================
134 Mounting
135 --------
137 Unlike v1, cgroup v2 has only single hierarchy.  The cgroup v2
138 hierarchy can be mounted with the following mount command::
140   # mount -t cgroup2 none $MOUNT_POINT
142 cgroup2 filesystem has the magic number 0x63677270 ("cgrp").  All
143 controllers which support v2 and are not bound to a v1 hierarchy are
144 automatically bound to the v2 hierarchy and show up at the root.
145 Controllers which are not in active use in the v2 hierarchy can be
146 bound to other hierarchies.  This allows mixing v2 hierarchy with the
147 legacy v1 multiple hierarchies in a fully backward compatible way.
149 A controller can be moved across hierarchies only after the controller
150 is no longer referenced in its current hierarchy.  Because per-cgroup
151 controller states are destroyed asynchronously and controllers may
152 have lingering references, a controller may not show up immediately on
153 the v2 hierarchy after the final umount of the previous hierarchy.
154 Similarly, a controller should be fully disabled to be moved out of
155 the unified hierarchy and it may take some time for the disabled
156 controller to become available for other hierarchies; furthermore, due
157 to inter-controller dependencies, other controllers may need to be
158 disabled too.
160 While useful for development and manual configurations, moving
161 controllers dynamically between the v2 and other hierarchies is
162 strongly discouraged for production use.  It is recommended to decide
163 the hierarchies and controller associations before starting using the
164 controllers after system boot.
166 During transition to v2, system management software might still
167 automount the v1 cgroup filesystem and so hijack all controllers
168 during boot, before manual intervention is possible. To make testing
169 and experimenting easier, the kernel parameter cgroup_no_v1= allows
170 disabling controllers in v1 and make them always available in v2.
172 cgroup v2 currently supports the following mount options.
174   nsdelegate
176         Consider cgroup namespaces as delegation boundaries.  This
177         option is system wide and can only be set on mount or modified
178         through remount from the init namespace.  The mount option is
179         ignored on non-init namespace mounts.  Please refer to the
180         Delegation section for details.
182   memory_localevents
184         Only populate memory.events with data for the current cgroup,
185         and not any subtrees. This is legacy behaviour, the default
186         behaviour without this option is to include subtree counts.
187         This option is system wide and can only be set on mount or
188         modified through remount from the init namespace. The mount
189         option is ignored on non-init namespace mounts.
191   memory_recursiveprot
193         Recursively apply memory.min and memory.low protection to
194         entire subtrees, without requiring explicit downward
195         propagation into leaf cgroups.  This allows protecting entire
196         subtrees from one another, while retaining free competition
197         within those subtrees.  This should have been the default
198         behavior but is a mount-option to avoid regressing setups
199         relying on the original semantics (e.g. specifying bogusly
200         high 'bypass' protection values at higher tree levels).
203 Organizing Processes and Threads
204 --------------------------------
206 Processes
207 ~~~~~~~~~
209 Initially, only the root cgroup exists to which all processes belong.
210 A child cgroup can be created by creating a sub-directory::
212   # mkdir $CGROUP_NAME
214 A given cgroup may have multiple child cgroups forming a tree
215 structure.  Each cgroup has a read-writable interface file
216 "cgroup.procs".  When read, it lists the PIDs of all processes which
217 belong to the cgroup one-per-line.  The PIDs are not ordered and the
218 same PID may show up more than once if the process got moved to
219 another cgroup and then back or the PID got recycled while reading.
221 A process can be migrated into a cgroup by writing its PID to the
222 target cgroup's "cgroup.procs" file.  Only one process can be migrated
223 on a single write(2) call.  If a process is composed of multiple
224 threads, writing the PID of any thread migrates all threads of the
225 process.
227 When a process forks a child process, the new process is born into the
228 cgroup that the forking process belongs to at the time of the
229 operation.  After exit, a process stays associated with the cgroup
230 that it belonged to at the time of exit until it's reaped; however, a
231 zombie process does not appear in "cgroup.procs" and thus can't be
232 moved to another cgroup.
234 A cgroup which doesn't have any children or live processes can be
235 destroyed by removing the directory.  Note that a cgroup which doesn't
236 have any children and is associated only with zombie processes is
237 considered empty and can be removed::
239   # rmdir $CGROUP_NAME
241 "/proc/$PID/cgroup" lists a process's cgroup membership.  If legacy
242 cgroup is in use in the system, this file may contain multiple lines,
243 one for each hierarchy.  The entry for cgroup v2 is always in the
244 format "0::$PATH"::
246   # cat /proc/842/cgroup
247   ...
248   0::/test-cgroup/test-cgroup-nested
250 If the process becomes a zombie and the cgroup it was associated with
251 is removed subsequently, " (deleted)" is appended to the path::
253   # cat /proc/842/cgroup
254   ...
255   0::/test-cgroup/test-cgroup-nested (deleted)
258 Threads
259 ~~~~~~~
261 cgroup v2 supports thread granularity for a subset of controllers to
262 support use cases requiring hierarchical resource distribution across
263 the threads of a group of processes.  By default, all threads of a
264 process belong to the same cgroup, which also serves as the resource
265 domain to host resource consumptions which are not specific to a
266 process or thread.  The thread mode allows threads to be spread across
267 a subtree while still maintaining the common resource domain for them.
269 Controllers which support thread mode are called threaded controllers.
270 The ones which don't are called domain controllers.
272 Marking a cgroup threaded makes it join the resource domain of its
273 parent as a threaded cgroup.  The parent may be another threaded
274 cgroup whose resource domain is further up in the hierarchy.  The root
275 of a threaded subtree, that is, the nearest ancestor which is not
276 threaded, is called threaded domain or thread root interchangeably and
277 serves as the resource domain for the entire subtree.
279 Inside a threaded subtree, threads of a process can be put in
280 different cgroups and are not subject to the no internal process
281 constraint - threaded controllers can be enabled on non-leaf cgroups
282 whether they have threads in them or not.
284 As the threaded domain cgroup hosts all the domain resource
285 consumptions of the subtree, it is considered to have internal
286 resource consumptions whether there are processes in it or not and
287 can't have populated child cgroups which aren't threaded.  Because the
288 root cgroup is not subject to no internal process constraint, it can
289 serve both as a threaded domain and a parent to domain cgroups.
291 The current operation mode or type of the cgroup is shown in the
292 "cgroup.type" file which indicates whether the cgroup is a normal
293 domain, a domain which is serving as the domain of a threaded subtree,
294 or a threaded cgroup.
296 On creation, a cgroup is always a domain cgroup and can be made
297 threaded by writing "threaded" to the "cgroup.type" file.  The
298 operation is single direction::
300   # echo threaded > cgroup.type
302 Once threaded, the cgroup can't be made a domain again.  To enable the
303 thread mode, the following conditions must be met.
305 - As the cgroup will join the parent's resource domain.  The parent
306   must either be a valid (threaded) domain or a threaded cgroup.
308 - When the parent is an unthreaded domain, it must not have any domain
309   controllers enabled or populated domain children.  The root is
310   exempt from this requirement.
312 Topology-wise, a cgroup can be in an invalid state.  Please consider
313 the following topology::
315   A (threaded domain) - B (threaded) - C (domain, just created)
317 C is created as a domain but isn't connected to a parent which can
318 host child domains.  C can't be used until it is turned into a
319 threaded cgroup.  "cgroup.type" file will report "domain (invalid)" in
320 these cases.  Operations which fail due to invalid topology use
321 EOPNOTSUPP as the errno.
323 A domain cgroup is turned into a threaded domain when one of its child
324 cgroup becomes threaded or threaded controllers are enabled in the
325 "cgroup.subtree_control" file while there are processes in the cgroup.
326 A threaded domain reverts to a normal domain when the conditions
327 clear.
329 When read, "cgroup.threads" contains the list of the thread IDs of all
330 threads in the cgroup.  Except that the operations are per-thread
331 instead of per-process, "cgroup.threads" has the same format and
332 behaves the same way as "cgroup.procs".  While "cgroup.threads" can be
333 written to in any cgroup, as it can only move threads inside the same
334 threaded domain, its operations are confined inside each threaded
335 subtree.
337 The threaded domain cgroup serves as the resource domain for the whole
338 subtree, and, while the threads can be scattered across the subtree,
339 all the processes are considered to be in the threaded domain cgroup.
340 "cgroup.procs" in a threaded domain cgroup contains the PIDs of all
341 processes in the subtree and is not readable in the subtree proper.
342 However, "cgroup.procs" can be written to from anywhere in the subtree
343 to migrate all threads of the matching process to the cgroup.
345 Only threaded controllers can be enabled in a threaded subtree.  When
346 a threaded controller is enabled inside a threaded subtree, it only
347 accounts for and controls resource consumptions associated with the
348 threads in the cgroup and its descendants.  All consumptions which
349 aren't tied to a specific thread belong to the threaded domain cgroup.
351 Because a threaded subtree is exempt from no internal process
352 constraint, a threaded controller must be able to handle competition
353 between threads in a non-leaf cgroup and its child cgroups.  Each
354 threaded controller defines how such competitions are handled.
357 [Un]populated Notification
358 --------------------------
360 Each non-root cgroup has a "cgroup.events" file which contains
361 "populated" field indicating whether the cgroup's sub-hierarchy has
362 live processes in it.  Its value is 0 if there is no live process in
363 the cgroup and its descendants; otherwise, 1.  poll and [id]notify
364 events are triggered when the value changes.  This can be used, for
365 example, to start a clean-up operation after all processes of a given
366 sub-hierarchy have exited.  The populated state updates and
367 notifications are recursive.  Consider the following sub-hierarchy
368 where the numbers in the parentheses represent the numbers of processes
369 in each cgroup::
371   A(4) - B(0) - C(1)
372               \ D(0)
374 A, B and C's "populated" fields would be 1 while D's 0.  After the one
375 process in C exits, B and C's "populated" fields would flip to "0" and
376 file modified events will be generated on the "cgroup.events" files of
377 both cgroups.
380 Controlling Controllers
381 -----------------------
383 Enabling and Disabling
384 ~~~~~~~~~~~~~~~~~~~~~~
386 Each cgroup has a "cgroup.controllers" file which lists all
387 controllers available for the cgroup to enable::
389   # cat cgroup.controllers
390   cpu io memory
392 No controller is enabled by default.  Controllers can be enabled and
393 disabled by writing to the "cgroup.subtree_control" file::
395   # echo "+cpu +memory -io" > cgroup.subtree_control
397 Only controllers which are listed in "cgroup.controllers" can be
398 enabled.  When multiple operations are specified as above, either they
399 all succeed or fail.  If multiple operations on the same controller
400 are specified, the last one is effective.
402 Enabling a controller in a cgroup indicates that the distribution of
403 the target resource across its immediate children will be controlled.
404 Consider the following sub-hierarchy.  The enabled controllers are
405 listed in parentheses::
407   A(cpu,memory) - B(memory) - C()
408                             \ D()
410 As A has "cpu" and "memory" enabled, A will control the distribution
411 of CPU cycles and memory to its children, in this case, B.  As B has
412 "memory" enabled but not "CPU", C and D will compete freely on CPU
413 cycles but their division of memory available to B will be controlled.
415 As a controller regulates the distribution of the target resource to
416 the cgroup's children, enabling it creates the controller's interface
417 files in the child cgroups.  In the above example, enabling "cpu" on B
418 would create the "cpu." prefixed controller interface files in C and
419 D.  Likewise, disabling "memory" from B would remove the "memory."
420 prefixed controller interface files from C and D.  This means that the
421 controller interface files - anything which doesn't start with
422 "cgroup." are owned by the parent rather than the cgroup itself.
425 Top-down Constraint
426 ~~~~~~~~~~~~~~~~~~~
428 Resources are distributed top-down and a cgroup can further distribute
429 a resource only if the resource has been distributed to it from the
430 parent.  This means that all non-root "cgroup.subtree_control" files
431 can only contain controllers which are enabled in the parent's
432 "cgroup.subtree_control" file.  A controller can be enabled only if
433 the parent has the controller enabled and a controller can't be
434 disabled if one or more children have it enabled.
437 No Internal Process Constraint
438 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
440 Non-root cgroups can distribute domain resources to their children
441 only when they don't have any processes of their own.  In other words,
442 only domain cgroups which don't contain any processes can have domain
443 controllers enabled in their "cgroup.subtree_control" files.
445 This guarantees that, when a domain controller is looking at the part
446 of the hierarchy which has it enabled, processes are always only on
447 the leaves.  This rules out situations where child cgroups compete
448 against internal processes of the parent.
450 The root cgroup is exempt from this restriction.  Root contains
451 processes and anonymous resource consumption which can't be associated
452 with any other cgroups and requires special treatment from most
453 controllers.  How resource consumption in the root cgroup is governed
454 is up to each controller (for more information on this topic please
455 refer to the Non-normative information section in the Controllers
456 chapter).
458 Note that the restriction doesn't get in the way if there is no
459 enabled controller in the cgroup's "cgroup.subtree_control".  This is
460 important as otherwise it wouldn't be possible to create children of a
461 populated cgroup.  To control resource distribution of a cgroup, the
462 cgroup must create children and transfer all its processes to the
463 children before enabling controllers in its "cgroup.subtree_control"
464 file.
467 Delegation
468 ----------
470 Model of Delegation
471 ~~~~~~~~~~~~~~~~~~~
473 A cgroup can be delegated in two ways.  First, to a less privileged
474 user by granting write access of the directory and its "cgroup.procs",
475 "cgroup.threads" and "cgroup.subtree_control" files to the user.
476 Second, if the "nsdelegate" mount option is set, automatically to a
477 cgroup namespace on namespace creation.
479 Because the resource control interface files in a given directory
480 control the distribution of the parent's resources, the delegatee
481 shouldn't be allowed to write to them.  For the first method, this is
482 achieved by not granting access to these files.  For the second, the
483 kernel rejects writes to all files other than "cgroup.procs" and
484 "cgroup.subtree_control" on a namespace root from inside the
485 namespace.
487 The end results are equivalent for both delegation types.  Once
488 delegated, the user can build sub-hierarchy under the directory,
489 organize processes inside it as it sees fit and further distribute the
490 resources it received from the parent.  The limits and other settings
491 of all resource controllers are hierarchical and regardless of what
492 happens in the delegated sub-hierarchy, nothing can escape the
493 resource restrictions imposed by the parent.
495 Currently, cgroup doesn't impose any restrictions on the number of
496 cgroups in or nesting depth of a delegated sub-hierarchy; however,
497 this may be limited explicitly in the future.
500 Delegation Containment
501 ~~~~~~~~~~~~~~~~~~~~~~
503 A delegated sub-hierarchy is contained in the sense that processes
504 can't be moved into or out of the sub-hierarchy by the delegatee.
506 For delegations to a less privileged user, this is achieved by
507 requiring the following conditions for a process with a non-root euid
508 to migrate a target process into a cgroup by writing its PID to the
509 "cgroup.procs" file.
511 - The writer must have write access to the "cgroup.procs" file.
513 - The writer must have write access to the "cgroup.procs" file of the
514   common ancestor of the source and destination cgroups.
516 The above two constraints ensure that while a delegatee may migrate
517 processes around freely in the delegated sub-hierarchy it can't pull
518 in from or push out to outside the sub-hierarchy.
520 For an example, let's assume cgroups C0 and C1 have been delegated to
521 user U0 who created C00, C01 under C0 and C10 under C1 as follows and
522 all processes under C0 and C1 belong to U0::
524   ~~~~~~~~~~~~~ - C0 - C00
525   ~ cgroup    ~      \ C01
526   ~ hierarchy ~
527   ~~~~~~~~~~~~~ - C1 - C10
529 Let's also say U0 wants to write the PID of a process which is
530 currently in C10 into "C00/cgroup.procs".  U0 has write access to the
531 file; however, the common ancestor of the source cgroup C10 and the
532 destination cgroup C00 is above the points of delegation and U0 would
533 not have write access to its "cgroup.procs" files and thus the write
534 will be denied with -EACCES.
536 For delegations to namespaces, containment is achieved by requiring
537 that both the source and destination cgroups are reachable from the
538 namespace of the process which is attempting the migration.  If either
539 is not reachable, the migration is rejected with -ENOENT.
542 Guidelines
543 ----------
545 Organize Once and Control
546 ~~~~~~~~~~~~~~~~~~~~~~~~~
548 Migrating a process across cgroups is a relatively expensive operation
549 and stateful resources such as memory are not moved together with the
550 process.  This is an explicit design decision as there often exist
551 inherent trade-offs between migration and various hot paths in terms
552 of synchronization cost.
554 As such, migrating processes across cgroups frequently as a means to
555 apply different resource restrictions is discouraged.  A workload
556 should be assigned to a cgroup according to the system's logical and
557 resource structure once on start-up.  Dynamic adjustments to resource
558 distribution can be made by changing controller configuration through
559 the interface files.
562 Avoid Name Collisions
563 ~~~~~~~~~~~~~~~~~~~~~
565 Interface files for a cgroup and its children cgroups occupy the same
566 directory and it is possible to create children cgroups which collide
567 with interface files.
569 All cgroup core interface files are prefixed with "cgroup." and each
570 controller's interface files are prefixed with the controller name and
571 a dot.  A controller's name is composed of lower case alphabets and
572 '_'s but never begins with an '_' so it can be used as the prefix
573 character for collision avoidance.  Also, interface file names won't
574 start or end with terms which are often used in categorizing workloads
575 such as job, service, slice, unit or workload.
577 cgroup doesn't do anything to prevent name collisions and it's the
578 user's responsibility to avoid them.
581 Resource Distribution Models
582 ============================
584 cgroup controllers implement several resource distribution schemes
585 depending on the resource type and expected use cases.  This section
586 describes major schemes in use along with their expected behaviors.
589 Weights
590 -------
592 A parent's resource is distributed by adding up the weights of all
593 active children and giving each the fraction matching the ratio of its
594 weight against the sum.  As only children which can make use of the
595 resource at the moment participate in the distribution, this is
596 work-conserving.  Due to the dynamic nature, this model is usually
597 used for stateless resources.
599 All weights are in the range [1, 10000] with the default at 100.  This
600 allows symmetric multiplicative biases in both directions at fine
601 enough granularity while staying in the intuitive range.
603 As long as the weight is in range, all configuration combinations are
604 valid and there is no reason to reject configuration changes or
605 process migrations.
607 "cpu.weight" proportionally distributes CPU cycles to active children
608 and is an example of this type.
611 Limits
612 ------
614 A child can only consume upto the configured amount of the resource.
615 Limits can be over-committed - the sum of the limits of children can
616 exceed the amount of resource available to the parent.
618 Limits are in the range [0, max] and defaults to "max", which is noop.
620 As limits can be over-committed, all configuration combinations are
621 valid and there is no reason to reject configuration changes or
622 process migrations.
624 "io.max" limits the maximum BPS and/or IOPS that a cgroup can consume
625 on an IO device and is an example of this type.
628 Protections
629 -----------
631 A cgroup is protected upto the configured amount of the resource
632 as long as the usages of all its ancestors are under their
633 protected levels.  Protections can be hard guarantees or best effort
634 soft boundaries.  Protections can also be over-committed in which case
635 only upto the amount available to the parent is protected among
636 children.
638 Protections are in the range [0, max] and defaults to 0, which is
639 noop.
641 As protections can be over-committed, all configuration combinations
642 are valid and there is no reason to reject configuration changes or
643 process migrations.
645 "memory.low" implements best-effort memory protection and is an
646 example of this type.
649 Allocations
650 -----------
652 A cgroup is exclusively allocated a certain amount of a finite
653 resource.  Allocations can't be over-committed - the sum of the
654 allocations of children can not exceed the amount of resource
655 available to the parent.
657 Allocations are in the range [0, max] and defaults to 0, which is no
658 resource.
660 As allocations can't be over-committed, some configuration
661 combinations are invalid and should be rejected.  Also, if the
662 resource is mandatory for execution of processes, process migrations
663 may be rejected.
665 "cpu.rt.max" hard-allocates realtime slices and is an example of this
666 type.
669 Interface Files
670 ===============
672 Format
673 ------
675 All interface files should be in one of the following formats whenever
676 possible::
678   New-line separated values
679   (when only one value can be written at once)
681         VAL0\n
682         VAL1\n
683         ...
685   Space separated values
686   (when read-only or multiple values can be written at once)
688         VAL0 VAL1 ...\n
690   Flat keyed
692         KEY0 VAL0\n
693         KEY1 VAL1\n
694         ...
696   Nested keyed
698         KEY0 SUB_KEY0=VAL00 SUB_KEY1=VAL01...
699         KEY1 SUB_KEY0=VAL10 SUB_KEY1=VAL11...
700         ...
702 For a writable file, the format for writing should generally match
703 reading; however, controllers may allow omitting later fields or
704 implement restricted shortcuts for most common use cases.
706 For both flat and nested keyed files, only the values for a single key
707 can be written at a time.  For nested keyed files, the sub key pairs
708 may be specified in any order and not all pairs have to be specified.
711 Conventions
712 -----------
714 - Settings for a single feature should be contained in a single file.
716 - The root cgroup should be exempt from resource control and thus
717   shouldn't have resource control interface files.
719 - The default time unit is microseconds.  If a different unit is ever
720   used, an explicit unit suffix must be present.
722 - A parts-per quantity should use a percentage decimal with at least
723   two digit fractional part - e.g. 13.40.
725 - If a controller implements weight based resource distribution, its
726   interface file should be named "weight" and have the range [1,
727   10000] with 100 as the default.  The values are chosen to allow
728   enough and symmetric bias in both directions while keeping it
729   intuitive (the default is 100%).
731 - If a controller implements an absolute resource guarantee and/or
732   limit, the interface files should be named "min" and "max"
733   respectively.  If a controller implements best effort resource
734   guarantee and/or limit, the interface files should be named "low"
735   and "high" respectively.
737   In the above four control files, the special token "max" should be
738   used to represent upward infinity for both reading and writing.
740 - If a setting has a configurable default value and keyed specific
741   overrides, the default entry should be keyed with "default" and
742   appear as the first entry in the file.
744   The default value can be updated by writing either "default $VAL" or
745   "$VAL".
747   When writing to update a specific override, "default" can be used as
748   the value to indicate removal of the override.  Override entries
749   with "default" as the value must not appear when read.
751   For example, a setting which is keyed by major:minor device numbers
752   with integer values may look like the following::
754     # cat cgroup-example-interface-file
755     default 150
756     8:0 300
758   The default value can be updated by::
760     # echo 125 > cgroup-example-interface-file
762   or::
764     # echo "default 125" > cgroup-example-interface-file
766   An override can be set by::
768     # echo "8:16 170" > cgroup-example-interface-file
770   and cleared by::
772     # echo "8:0 default" > cgroup-example-interface-file
773     # cat cgroup-example-interface-file
774     default 125
775     8:16 170
777 - For events which are not very high frequency, an interface file
778   "events" should be created which lists event key value pairs.
779   Whenever a notifiable event happens, file modified event should be
780   generated on the file.
783 Core Interface Files
784 --------------------
786 All cgroup core files are prefixed with "cgroup."
788   cgroup.type
790         A read-write single value file which exists on non-root
791         cgroups.
793         When read, it indicates the current type of the cgroup, which
794         can be one of the following values.
796         - "domain" : A normal valid domain cgroup.
798         - "domain threaded" : A threaded domain cgroup which is
799           serving as the root of a threaded subtree.
801         - "domain invalid" : A cgroup which is in an invalid state.
802           It can't be populated or have controllers enabled.  It may
803           be allowed to become a threaded cgroup.
805         - "threaded" : A threaded cgroup which is a member of a
806           threaded subtree.
808         A cgroup can be turned into a threaded cgroup by writing
809         "threaded" to this file.
811   cgroup.procs
812         A read-write new-line separated values file which exists on
813         all cgroups.
815         When read, it lists the PIDs of all processes which belong to
816         the cgroup one-per-line.  The PIDs are not ordered and the
817         same PID may show up more than once if the process got moved
818         to another cgroup and then back or the PID got recycled while
819         reading.
821         A PID can be written to migrate the process associated with
822         the PID to the cgroup.  The writer should match all of the
823         following conditions.
825         - It must have write access to the "cgroup.procs" file.
827         - It must have write access to the "cgroup.procs" file of the
828           common ancestor of the source and destination cgroups.
830         When delegating a sub-hierarchy, write access to this file
831         should be granted along with the containing directory.
833         In a threaded cgroup, reading this file fails with EOPNOTSUPP
834         as all the processes belong to the thread root.  Writing is
835         supported and moves every thread of the process to the cgroup.
837   cgroup.threads
838         A read-write new-line separated values file which exists on
839         all cgroups.
841         When read, it lists the TIDs of all threads which belong to
842         the cgroup one-per-line.  The TIDs are not ordered and the
843         same TID may show up more than once if the thread got moved to
844         another cgroup and then back or the TID got recycled while
845         reading.
847         A TID can be written to migrate the thread associated with the
848         TID to the cgroup.  The writer should match all of the
849         following conditions.
851         - It must have write access to the "cgroup.threads" file.
853         - The cgroup that the thread is currently in must be in the
854           same resource domain as the destination cgroup.
856         - It must have write access to the "cgroup.procs" file of the
857           common ancestor of the source and destination cgroups.
859         When delegating a sub-hierarchy, write access to this file
860         should be granted along with the containing directory.
862   cgroup.controllers
863         A read-only space separated values file which exists on all
864         cgroups.
866         It shows space separated list of all controllers available to
867         the cgroup.  The controllers are not ordered.
869   cgroup.subtree_control
870         A read-write space separated values file which exists on all
871         cgroups.  Starts out empty.
873         When read, it shows space separated list of the controllers
874         which are enabled to control resource distribution from the
875         cgroup to its children.
877         Space separated list of controllers prefixed with '+' or '-'
878         can be written to enable or disable controllers.  A controller
879         name prefixed with '+' enables the controller and '-'
880         disables.  If a controller appears more than once on the list,
881         the last one is effective.  When multiple enable and disable
882         operations are specified, either all succeed or all fail.
884   cgroup.events
885         A read-only flat-keyed file which exists on non-root cgroups.
886         The following entries are defined.  Unless specified
887         otherwise, a value change in this file generates a file
888         modified event.
890           populated
891                 1 if the cgroup or its descendants contains any live
892                 processes; otherwise, 0.
893           frozen
894                 1 if the cgroup is frozen; otherwise, 0.
896   cgroup.max.descendants
897         A read-write single value files.  The default is "max".
899         Maximum allowed number of descent cgroups.
900         If the actual number of descendants is equal or larger,
901         an attempt to create a new cgroup in the hierarchy will fail.
903   cgroup.max.depth
904         A read-write single value files.  The default is "max".
906         Maximum allowed descent depth below the current cgroup.
907         If the actual descent depth is equal or larger,
908         an attempt to create a new child cgroup will fail.
910   cgroup.stat
911         A read-only flat-keyed file with the following entries:
913           nr_descendants
914                 Total number of visible descendant cgroups.
916           nr_dying_descendants
917                 Total number of dying descendant cgroups. A cgroup becomes
918                 dying after being deleted by a user. The cgroup will remain
919                 in dying state for some time undefined time (which can depend
920                 on system load) before being completely destroyed.
922                 A process can't enter a dying cgroup under any circumstances,
923                 a dying cgroup can't revive.
925                 A dying cgroup can consume system resources not exceeding
926                 limits, which were active at the moment of cgroup deletion.
928   cgroup.freeze
929         A read-write single value file which exists on non-root cgroups.
930         Allowed values are "0" and "1". The default is "0".
932         Writing "1" to the file causes freezing of the cgroup and all
933         descendant cgroups. This means that all belonging processes will
934         be stopped and will not run until the cgroup will be explicitly
935         unfrozen. Freezing of the cgroup may take some time; when this action
936         is completed, the "frozen" value in the cgroup.events control file
937         will be updated to "1" and the corresponding notification will be
938         issued.
940         A cgroup can be frozen either by its own settings, or by settings
941         of any ancestor cgroups. If any of ancestor cgroups is frozen, the
942         cgroup will remain frozen.
944         Processes in the frozen cgroup can be killed by a fatal signal.
945         They also can enter and leave a frozen cgroup: either by an explicit
946         move by a user, or if freezing of the cgroup races with fork().
947         If a process is moved to a frozen cgroup, it stops. If a process is
948         moved out of a frozen cgroup, it becomes running.
950         Frozen status of a cgroup doesn't affect any cgroup tree operations:
951         it's possible to delete a frozen (and empty) cgroup, as well as
952         create new sub-cgroups.
954 Controllers
955 ===========
960 The "cpu" controllers regulates distribution of CPU cycles.  This
961 controller implements weight and absolute bandwidth limit models for
962 normal scheduling policy and absolute bandwidth allocation model for
963 realtime scheduling policy.
965 In all the above models, cycles distribution is defined only on a temporal
966 base and it does not account for the frequency at which tasks are executed.
967 The (optional) utilization clamping support allows to hint the schedutil
968 cpufreq governor about the minimum desired frequency which should always be
969 provided by a CPU, as well as the maximum desired frequency, which should not
970 be exceeded by a CPU.
972 WARNING: cgroup2 doesn't yet support control of realtime processes and
973 the cpu controller can only be enabled when all RT processes are in
974 the root cgroup.  Be aware that system management software may already
975 have placed RT processes into nonroot cgroups during the system boot
976 process, and these processes may need to be moved to the root cgroup
977 before the cpu controller can be enabled.
980 CPU Interface Files
981 ~~~~~~~~~~~~~~~~~~~
983 All time durations are in microseconds.
985   cpu.stat
986         A read-only flat-keyed file.
987         This file exists whether the controller is enabled or not.
989         It always reports the following three stats:
991         - usage_usec
992         - user_usec
993         - system_usec
995         and the following three when the controller is enabled:
997         - nr_periods
998         - nr_throttled
999         - throttled_usec
1001   cpu.weight
1002         A read-write single value file which exists on non-root
1003         cgroups.  The default is "100".
1005         The weight in the range [1, 10000].
1007   cpu.weight.nice
1008         A read-write single value file which exists on non-root
1009         cgroups.  The default is "0".
1011         The nice value is in the range [-20, 19].
1013         This interface file is an alternative interface for
1014         "cpu.weight" and allows reading and setting weight using the
1015         same values used by nice(2).  Because the range is smaller and
1016         granularity is coarser for the nice values, the read value is
1017         the closest approximation of the current weight.
1019   cpu.max
1020         A read-write two value file which exists on non-root cgroups.
1021         The default is "max 100000".
1023         The maximum bandwidth limit.  It's in the following format::
1025           $MAX $PERIOD
1027         which indicates that the group may consume upto $MAX in each
1028         $PERIOD duration.  "max" for $MAX indicates no limit.  If only
1029         one number is written, $MAX is updated.
1031   cpu.pressure
1032         A read-only nested-key file which exists on non-root cgroups.
1034         Shows pressure stall information for CPU. See
1035         :ref:`Documentation/accounting/psi.rst <psi>` for details.
1037   cpu.uclamp.min
1038         A read-write single value file which exists on non-root cgroups.
1039         The default is "0", i.e. no utilization boosting.
1041         The requested minimum utilization (protection) as a percentage
1042         rational number, e.g. 12.34 for 12.34%.
1044         This interface allows reading and setting minimum utilization clamp
1045         values similar to the sched_setattr(2). This minimum utilization
1046         value is used to clamp the task specific minimum utilization clamp.
1048         The requested minimum utilization (protection) is always capped by
1049         the current value for the maximum utilization (limit), i.e.
1050         `cpu.uclamp.max`.
1052   cpu.uclamp.max
1053         A read-write single value file which exists on non-root cgroups.
1054         The default is "max". i.e. no utilization capping
1056         The requested maximum utilization (limit) as a percentage rational
1057         number, e.g. 98.76 for 98.76%.
1059         This interface allows reading and setting maximum utilization clamp
1060         values similar to the sched_setattr(2). This maximum utilization
1061         value is used to clamp the task specific maximum utilization clamp.
1065 Memory
1066 ------
1068 The "memory" controller regulates distribution of memory.  Memory is
1069 stateful and implements both limit and protection models.  Due to the
1070 intertwining between memory usage and reclaim pressure and the
1071 stateful nature of memory, the distribution model is relatively
1072 complex.
1074 While not completely water-tight, all major memory usages by a given
1075 cgroup are tracked so that the total memory consumption can be
1076 accounted and controlled to a reasonable extent.  Currently, the
1077 following types of memory usages are tracked.
1079 - Userland memory - page cache and anonymous memory.
1081 - Kernel data structures such as dentries and inodes.
1083 - TCP socket buffers.
1085 The above list may expand in the future for better coverage.
1088 Memory Interface Files
1089 ~~~~~~~~~~~~~~~~~~~~~~
1091 All memory amounts are in bytes.  If a value which is not aligned to
1092 PAGE_SIZE is written, the value may be rounded up to the closest
1093 PAGE_SIZE multiple when read back.
1095   memory.current
1096         A read-only single value file which exists on non-root
1097         cgroups.
1099         The total amount of memory currently being used by the cgroup
1100         and its descendants.
1102   memory.min
1103         A read-write single value file which exists on non-root
1104         cgroups.  The default is "0".
1106         Hard memory protection.  If the memory usage of a cgroup
1107         is within its effective min boundary, the cgroup's memory
1108         won't be reclaimed under any conditions. If there is no
1109         unprotected reclaimable memory available, OOM killer
1110         is invoked. Above the effective min boundary (or
1111         effective low boundary if it is higher), pages are reclaimed
1112         proportionally to the overage, reducing reclaim pressure for
1113         smaller overages.
1115         Effective min boundary is limited by memory.min values of
1116         all ancestor cgroups. If there is memory.min overcommitment
1117         (child cgroup or cgroups are requiring more protected memory
1118         than parent will allow), then each child cgroup will get
1119         the part of parent's protection proportional to its
1120         actual memory usage below memory.min.
1122         Putting more memory than generally available under this
1123         protection is discouraged and may lead to constant OOMs.
1125         If a memory cgroup is not populated with processes,
1126         its memory.min is ignored.
1128   memory.low
1129         A read-write single value file which exists on non-root
1130         cgroups.  The default is "0".
1132         Best-effort memory protection.  If the memory usage of a
1133         cgroup is within its effective low boundary, the cgroup's
1134         memory won't be reclaimed unless there is no reclaimable
1135         memory available in unprotected cgroups.
1136         Above the effective low boundary (or 
1137         effective min boundary if it is higher), pages are reclaimed
1138         proportionally to the overage, reducing reclaim pressure for
1139         smaller overages.
1141         Effective low boundary is limited by memory.low values of
1142         all ancestor cgroups. If there is memory.low overcommitment
1143         (child cgroup or cgroups are requiring more protected memory
1144         than parent will allow), then each child cgroup will get
1145         the part of parent's protection proportional to its
1146         actual memory usage below memory.low.
1148         Putting more memory than generally available under this
1149         protection is discouraged.
1151   memory.high
1152         A read-write single value file which exists on non-root
1153         cgroups.  The default is "max".
1155         Memory usage throttle limit.  This is the main mechanism to
1156         control memory usage of a cgroup.  If a cgroup's usage goes
1157         over the high boundary, the processes of the cgroup are
1158         throttled and put under heavy reclaim pressure.
1160         Going over the high limit never invokes the OOM killer and
1161         under extreme conditions the limit may be breached.
1163   memory.max
1164         A read-write single value file which exists on non-root
1165         cgroups.  The default is "max".
1167         Memory usage hard limit.  This is the final protection
1168         mechanism.  If a cgroup's memory usage reaches this limit and
1169         can't be reduced, the OOM killer is invoked in the cgroup.
1170         Under certain circumstances, the usage may go over the limit
1171         temporarily.
1173         In default configuration regular 0-order allocations always
1174         succeed unless OOM killer chooses current task as a victim.
1176         Some kinds of allocations don't invoke the OOM killer.
1177         Caller could retry them differently, return into userspace
1178         as -ENOMEM or silently ignore in cases like disk readahead.
1180         This is the ultimate protection mechanism.  As long as the
1181         high limit is used and monitored properly, this limit's
1182         utility is limited to providing the final safety net.
1184   memory.oom.group
1185         A read-write single value file which exists on non-root
1186         cgroups.  The default value is "0".
1188         Determines whether the cgroup should be treated as
1189         an indivisible workload by the OOM killer. If set,
1190         all tasks belonging to the cgroup or to its descendants
1191         (if the memory cgroup is not a leaf cgroup) are killed
1192         together or not at all. This can be used to avoid
1193         partial kills to guarantee workload integrity.
1195         Tasks with the OOM protection (oom_score_adj set to -1000)
1196         are treated as an exception and are never killed.
1198         If the OOM killer is invoked in a cgroup, it's not going
1199         to kill any tasks outside of this cgroup, regardless
1200         memory.oom.group values of ancestor cgroups.
1202   memory.events
1203         A read-only flat-keyed file which exists on non-root cgroups.
1204         The following entries are defined.  Unless specified
1205         otherwise, a value change in this file generates a file
1206         modified event.
1208         Note that all fields in this file are hierarchical and the
1209         file modified event can be generated due to an event down the
1210         hierarchy. For for the local events at the cgroup level see
1211         memory.events.local.
1213           low
1214                 The number of times the cgroup is reclaimed due to
1215                 high memory pressure even though its usage is under
1216                 the low boundary.  This usually indicates that the low
1217                 boundary is over-committed.
1219           high
1220                 The number of times processes of the cgroup are
1221                 throttled and routed to perform direct memory reclaim
1222                 because the high memory boundary was exceeded.  For a
1223                 cgroup whose memory usage is capped by the high limit
1224                 rather than global memory pressure, this event's
1225                 occurrences are expected.
1227           max
1228                 The number of times the cgroup's memory usage was
1229                 about to go over the max boundary.  If direct reclaim
1230                 fails to bring it down, the cgroup goes to OOM state.
1232           oom
1233                 The number of time the cgroup's memory usage was
1234                 reached the limit and allocation was about to fail.
1236                 This event is not raised if the OOM killer is not
1237                 considered as an option, e.g. for failed high-order
1238                 allocations or if caller asked to not retry attempts.
1240           oom_kill
1241                 The number of processes belonging to this cgroup
1242                 killed by any kind of OOM killer.
1244   memory.events.local
1245         Similar to memory.events but the fields in the file are local
1246         to the cgroup i.e. not hierarchical. The file modified event
1247         generated on this file reflects only the local events.
1249   memory.stat
1250         A read-only flat-keyed file which exists on non-root cgroups.
1252         This breaks down the cgroup's memory footprint into different
1253         types of memory, type-specific details, and other information
1254         on the state and past events of the memory management system.
1256         All memory amounts are in bytes.
1258         The entries are ordered to be human readable, and new entries
1259         can show up in the middle. Don't rely on items remaining in a
1260         fixed position; use the keys to look up specific values!
1262         If the entry has no per-node counter(or not show in the
1263         mempry.numa_stat). We use 'npn'(non-per-node) as the tag
1264         to indicate that it will not show in the mempry.numa_stat.
1266           anon
1267                 Amount of memory used in anonymous mappings such as
1268                 brk(), sbrk(), and mmap(MAP_ANONYMOUS)
1270           file
1271                 Amount of memory used to cache filesystem data,
1272                 including tmpfs and shared memory.
1274           kernel_stack
1275                 Amount of memory allocated to kernel stacks.
1277           pagetables
1278                 Amount of memory allocated for page tables.
1280           percpu(npn)
1281                 Amount of memory used for storing per-cpu kernel
1282                 data structures.
1284           sock(npn)
1285                 Amount of memory used in network transmission buffers
1287           shmem
1288                 Amount of cached filesystem data that is swap-backed,
1289                 such as tmpfs, shm segments, shared anonymous mmap()s
1291           file_mapped
1292                 Amount of cached filesystem data mapped with mmap()
1294           file_dirty
1295                 Amount of cached filesystem data that was modified but
1296                 not yet written back to disk
1298           file_writeback
1299                 Amount of cached filesystem data that was modified and
1300                 is currently being written back to disk
1302           anon_thp
1303                 Amount of memory used in anonymous mappings backed by
1304                 transparent hugepages
1306           file_thp
1307                 Amount of cached filesystem data backed by transparent
1308                 hugepages
1310           shmem_thp
1311                 Amount of shm, tmpfs, shared anonymous mmap()s backed by
1312                 transparent hugepages
1314           inactive_anon, active_anon, inactive_file, active_file, unevictable
1315                 Amount of memory, swap-backed and filesystem-backed,
1316                 on the internal memory management lists used by the
1317                 page reclaim algorithm.
1319                 As these represent internal list state (eg. shmem pages are on anon
1320                 memory management lists), inactive_foo + active_foo may not be equal to
1321                 the value for the foo counter, since the foo counter is type-based, not
1322                 list-based.
1324           slab_reclaimable
1325                 Part of "slab" that might be reclaimed, such as
1326                 dentries and inodes.
1328           slab_unreclaimable
1329                 Part of "slab" that cannot be reclaimed on memory
1330                 pressure.
1332           slab(npn)
1333                 Amount of memory used for storing in-kernel data
1334                 structures.
1336           workingset_refault_anon
1337                 Number of refaults of previously evicted anonymous pages.
1339           workingset_refault_file
1340                 Number of refaults of previously evicted file pages.
1342           workingset_activate_anon
1343                 Number of refaulted anonymous pages that were immediately
1344                 activated.
1346           workingset_activate_file
1347                 Number of refaulted file pages that were immediately activated.
1349           workingset_restore_anon
1350                 Number of restored anonymous pages which have been detected as
1351                 an active workingset before they got reclaimed.
1353           workingset_restore_file
1354                 Number of restored file pages which have been detected as an
1355                 active workingset before they got reclaimed.
1357           workingset_nodereclaim
1358                 Number of times a shadow node has been reclaimed
1360           pgfault(npn)
1361                 Total number of page faults incurred
1363           pgmajfault(npn)
1364                 Number of major page faults incurred
1366           pgrefill(npn)
1367                 Amount of scanned pages (in an active LRU list)
1369           pgscan(npn)
1370                 Amount of scanned pages (in an inactive LRU list)
1372           pgsteal(npn)
1373                 Amount of reclaimed pages
1375           pgactivate(npn)
1376                 Amount of pages moved to the active LRU list
1378           pgdeactivate(npn)
1379                 Amount of pages moved to the inactive LRU list
1381           pglazyfree(npn)
1382                 Amount of pages postponed to be freed under memory pressure
1384           pglazyfreed(npn)
1385                 Amount of reclaimed lazyfree pages
1387           thp_fault_alloc(npn)
1388                 Number of transparent hugepages which were allocated to satisfy
1389                 a page fault. This counter is not present when CONFIG_TRANSPARENT_HUGEPAGE
1390                 is not set.
1392           thp_collapse_alloc(npn)
1393                 Number of transparent hugepages which were allocated to allow
1394                 collapsing an existing range of pages. This counter is not
1395                 present when CONFIG_TRANSPARENT_HUGEPAGE is not set.
1397   memory.numa_stat
1398         A read-only nested-keyed file which exists on non-root cgroups.
1400         This breaks down the cgroup's memory footprint into different
1401         types of memory, type-specific details, and other information
1402         per node on the state of the memory management system.
1404         This is useful for providing visibility into the NUMA locality
1405         information within an memcg since the pages are allowed to be
1406         allocated from any physical node. One of the use case is evaluating
1407         application performance by combining this information with the
1408         application's CPU allocation.
1410         All memory amounts are in bytes.
1412         The output format of memory.numa_stat is::
1414           type N0=<bytes in node 0> N1=<bytes in node 1> ...
1416         The entries are ordered to be human readable, and new entries
1417         can show up in the middle. Don't rely on items remaining in a
1418         fixed position; use the keys to look up specific values!
1420         The entries can refer to the memory.stat.
1422   memory.swap.current
1423         A read-only single value file which exists on non-root
1424         cgroups.
1426         The total amount of swap currently being used by the cgroup
1427         and its descendants.
1429   memory.swap.high
1430         A read-write single value file which exists on non-root
1431         cgroups.  The default is "max".
1433         Swap usage throttle limit.  If a cgroup's swap usage exceeds
1434         this limit, all its further allocations will be throttled to
1435         allow userspace to implement custom out-of-memory procedures.
1437         This limit marks a point of no return for the cgroup. It is NOT
1438         designed to manage the amount of swapping a workload does
1439         during regular operation. Compare to memory.swap.max, which
1440         prohibits swapping past a set amount, but lets the cgroup
1441         continue unimpeded as long as other memory can be reclaimed.
1443         Healthy workloads are not expected to reach this limit.
1445   memory.swap.max
1446         A read-write single value file which exists on non-root
1447         cgroups.  The default is "max".
1449         Swap usage hard limit.  If a cgroup's swap usage reaches this
1450         limit, anonymous memory of the cgroup will not be swapped out.
1452   memory.swap.events
1453         A read-only flat-keyed file which exists on non-root cgroups.
1454         The following entries are defined.  Unless specified
1455         otherwise, a value change in this file generates a file
1456         modified event.
1458           high
1459                 The number of times the cgroup's swap usage was over
1460                 the high threshold.
1462           max
1463                 The number of times the cgroup's swap usage was about
1464                 to go over the max boundary and swap allocation
1465                 failed.
1467           fail
1468                 The number of times swap allocation failed either
1469                 because of running out of swap system-wide or max
1470                 limit.
1472         When reduced under the current usage, the existing swap
1473         entries are reclaimed gradually and the swap usage may stay
1474         higher than the limit for an extended period of time.  This
1475         reduces the impact on the workload and memory management.
1477   memory.pressure
1478         A read-only nested-key file which exists on non-root cgroups.
1480         Shows pressure stall information for memory. See
1481         :ref:`Documentation/accounting/psi.rst <psi>` for details.
1484 Usage Guidelines
1485 ~~~~~~~~~~~~~~~~
1487 "memory.high" is the main mechanism to control memory usage.
1488 Over-committing on high limit (sum of high limits > available memory)
1489 and letting global memory pressure to distribute memory according to
1490 usage is a viable strategy.
1492 Because breach of the high limit doesn't trigger the OOM killer but
1493 throttles the offending cgroup, a management agent has ample
1494 opportunities to monitor and take appropriate actions such as granting
1495 more memory or terminating the workload.
1497 Determining whether a cgroup has enough memory is not trivial as
1498 memory usage doesn't indicate whether the workload can benefit from
1499 more memory.  For example, a workload which writes data received from
1500 network to a file can use all available memory but can also operate as
1501 performant with a small amount of memory.  A measure of memory
1502 pressure - how much the workload is being impacted due to lack of
1503 memory - is necessary to determine whether a workload needs more
1504 memory; unfortunately, memory pressure monitoring mechanism isn't
1505 implemented yet.
1508 Memory Ownership
1509 ~~~~~~~~~~~~~~~~
1511 A memory area is charged to the cgroup which instantiated it and stays
1512 charged to the cgroup until the area is released.  Migrating a process
1513 to a different cgroup doesn't move the memory usages that it
1514 instantiated while in the previous cgroup to the new cgroup.
1516 A memory area may be used by processes belonging to different cgroups.
1517 To which cgroup the area will be charged is in-deterministic; however,
1518 over time, the memory area is likely to end up in a cgroup which has
1519 enough memory allowance to avoid high reclaim pressure.
1521 If a cgroup sweeps a considerable amount of memory which is expected
1522 to be accessed repeatedly by other cgroups, it may make sense to use
1523 POSIX_FADV_DONTNEED to relinquish the ownership of memory areas
1524 belonging to the affected files to ensure correct memory ownership.
1530 The "io" controller regulates the distribution of IO resources.  This
1531 controller implements both weight based and absolute bandwidth or IOPS
1532 limit distribution; however, weight based distribution is available
1533 only if cfq-iosched is in use and neither scheme is available for
1534 blk-mq devices.
1537 IO Interface Files
1538 ~~~~~~~~~~~~~~~~~~
1540   io.stat
1541         A read-only nested-keyed file.
1543         Lines are keyed by $MAJ:$MIN device numbers and not ordered.
1544         The following nested keys are defined.
1546           ======        =====================
1547           rbytes        Bytes read
1548           wbytes        Bytes written
1549           rios          Number of read IOs
1550           wios          Number of write IOs
1551           dbytes        Bytes discarded
1552           dios          Number of discard IOs
1553           ======        =====================
1555         An example read output follows::
1557           8:16 rbytes=1459200 wbytes=314773504 rios=192 wios=353 dbytes=0 dios=0
1558           8:0 rbytes=90430464 wbytes=299008000 rios=8950 wios=1252 dbytes=50331648 dios=3021
1560   io.cost.qos
1561         A read-write nested-keyed file with exists only on the root
1562         cgroup.
1564         This file configures the Quality of Service of the IO cost
1565         model based controller (CONFIG_BLK_CGROUP_IOCOST) which
1566         currently implements "io.weight" proportional control.  Lines
1567         are keyed by $MAJ:$MIN device numbers and not ordered.  The
1568         line for a given device is populated on the first write for
1569         the device on "io.cost.qos" or "io.cost.model".  The following
1570         nested keys are defined.
1572           ======        =====================================
1573           enable        Weight-based control enable
1574           ctrl          "auto" or "user"
1575           rpct          Read latency percentile    [0, 100]
1576           rlat          Read latency threshold
1577           wpct          Write latency percentile   [0, 100]
1578           wlat          Write latency threshold
1579           min           Minimum scaling percentage [1, 10000]
1580           max           Maximum scaling percentage [1, 10000]
1581           ======        =====================================
1583         The controller is disabled by default and can be enabled by
1584         setting "enable" to 1.  "rpct" and "wpct" parameters default
1585         to zero and the controller uses internal device saturation
1586         state to adjust the overall IO rate between "min" and "max".
1588         When a better control quality is needed, latency QoS
1589         parameters can be configured.  For example::
1591           8:16 enable=1 ctrl=auto rpct=95.00 rlat=75000 wpct=95.00 wlat=150000 min=50.00 max=150.0
1593         shows that on sdb, the controller is enabled, will consider
1594         the device saturated if the 95th percentile of read completion
1595         latencies is above 75ms or write 150ms, and adjust the overall
1596         IO issue rate between 50% and 150% accordingly.
1598         The lower the saturation point, the better the latency QoS at
1599         the cost of aggregate bandwidth.  The narrower the allowed
1600         adjustment range between "min" and "max", the more conformant
1601         to the cost model the IO behavior.  Note that the IO issue
1602         base rate may be far off from 100% and setting "min" and "max"
1603         blindly can lead to a significant loss of device capacity or
1604         control quality.  "min" and "max" are useful for regulating
1605         devices which show wide temporary behavior changes - e.g. a
1606         ssd which accepts writes at the line speed for a while and
1607         then completely stalls for multiple seconds.
1609         When "ctrl" is "auto", the parameters are controlled by the
1610         kernel and may change automatically.  Setting "ctrl" to "user"
1611         or setting any of the percentile and latency parameters puts
1612         it into "user" mode and disables the automatic changes.  The
1613         automatic mode can be restored by setting "ctrl" to "auto".
1615   io.cost.model
1616         A read-write nested-keyed file with exists only on the root
1617         cgroup.
1619         This file configures the cost model of the IO cost model based
1620         controller (CONFIG_BLK_CGROUP_IOCOST) which currently
1621         implements "io.weight" proportional control.  Lines are keyed
1622         by $MAJ:$MIN device numbers and not ordered.  The line for a
1623         given device is populated on the first write for the device on
1624         "io.cost.qos" or "io.cost.model".  The following nested keys
1625         are defined.
1627           =====         ================================
1628           ctrl          "auto" or "user"
1629           model         The cost model in use - "linear"
1630           =====         ================================
1632         When "ctrl" is "auto", the kernel may change all parameters
1633         dynamically.  When "ctrl" is set to "user" or any other
1634         parameters are written to, "ctrl" become "user" and the
1635         automatic changes are disabled.
1637         When "model" is "linear", the following model parameters are
1638         defined.
1640           ============= ========================================
1641           [r|w]bps      The maximum sequential IO throughput
1642           [r|w]seqiops  The maximum 4k sequential IOs per second
1643           [r|w]randiops The maximum 4k random IOs per second
1644           ============= ========================================
1646         From the above, the builtin linear model determines the base
1647         costs of a sequential and random IO and the cost coefficient
1648         for the IO size.  While simple, this model can cover most
1649         common device classes acceptably.
1651         The IO cost model isn't expected to be accurate in absolute
1652         sense and is scaled to the device behavior dynamically.
1654         If needed, tools/cgroup/iocost_coef_gen.py can be used to
1655         generate device-specific coefficients.
1657   io.weight
1658         A read-write flat-keyed file which exists on non-root cgroups.
1659         The default is "default 100".
1661         The first line is the default weight applied to devices
1662         without specific override.  The rest are overrides keyed by
1663         $MAJ:$MIN device numbers and not ordered.  The weights are in
1664         the range [1, 10000] and specifies the relative amount IO time
1665         the cgroup can use in relation to its siblings.
1667         The default weight can be updated by writing either "default
1668         $WEIGHT" or simply "$WEIGHT".  Overrides can be set by writing
1669         "$MAJ:$MIN $WEIGHT" and unset by writing "$MAJ:$MIN default".
1671         An example read output follows::
1673           default 100
1674           8:16 200
1675           8:0 50
1677   io.max
1678         A read-write nested-keyed file which exists on non-root
1679         cgroups.
1681         BPS and IOPS based IO limit.  Lines are keyed by $MAJ:$MIN
1682         device numbers and not ordered.  The following nested keys are
1683         defined.
1685           =====         ==================================
1686           rbps          Max read bytes per second
1687           wbps          Max write bytes per second
1688           riops         Max read IO operations per second
1689           wiops         Max write IO operations per second
1690           =====         ==================================
1692         When writing, any number of nested key-value pairs can be
1693         specified in any order.  "max" can be specified as the value
1694         to remove a specific limit.  If the same key is specified
1695         multiple times, the outcome is undefined.
1697         BPS and IOPS are measured in each IO direction and IOs are
1698         delayed if limit is reached.  Temporary bursts are allowed.
1700         Setting read limit at 2M BPS and write at 120 IOPS for 8:16::
1702           echo "8:16 rbps=2097152 wiops=120" > io.max
1704         Reading returns the following::
1706           8:16 rbps=2097152 wbps=max riops=max wiops=120
1708         Write IOPS limit can be removed by writing the following::
1710           echo "8:16 wiops=max" > io.max
1712         Reading now returns the following::
1714           8:16 rbps=2097152 wbps=max riops=max wiops=max
1716   io.pressure
1717         A read-only nested-key file which exists on non-root cgroups.
1719         Shows pressure stall information for IO. See
1720         :ref:`Documentation/accounting/psi.rst <psi>` for details.
1723 Writeback
1724 ~~~~~~~~~
1726 Page cache is dirtied through buffered writes and shared mmaps and
1727 written asynchronously to the backing filesystem by the writeback
1728 mechanism.  Writeback sits between the memory and IO domains and
1729 regulates the proportion of dirty memory by balancing dirtying and
1730 write IOs.
1732 The io controller, in conjunction with the memory controller,
1733 implements control of page cache writeback IOs.  The memory controller
1734 defines the memory domain that dirty memory ratio is calculated and
1735 maintained for and the io controller defines the io domain which
1736 writes out dirty pages for the memory domain.  Both system-wide and
1737 per-cgroup dirty memory states are examined and the more restrictive
1738 of the two is enforced.
1740 cgroup writeback requires explicit support from the underlying
1741 filesystem.  Currently, cgroup writeback is implemented on ext2, ext4,
1742 btrfs, f2fs, and xfs.  On other filesystems, all writeback IOs are 
1743 attributed to the root cgroup.
1745 There are inherent differences in memory and writeback management
1746 which affects how cgroup ownership is tracked.  Memory is tracked per
1747 page while writeback per inode.  For the purpose of writeback, an
1748 inode is assigned to a cgroup and all IO requests to write dirty pages
1749 from the inode are attributed to that cgroup.
1751 As cgroup ownership for memory is tracked per page, there can be pages
1752 which are associated with different cgroups than the one the inode is
1753 associated with.  These are called foreign pages.  The writeback
1754 constantly keeps track of foreign pages and, if a particular foreign
1755 cgroup becomes the majority over a certain period of time, switches
1756 the ownership of the inode to that cgroup.
1758 While this model is enough for most use cases where a given inode is
1759 mostly dirtied by a single cgroup even when the main writing cgroup
1760 changes over time, use cases where multiple cgroups write to a single
1761 inode simultaneously are not supported well.  In such circumstances, a
1762 significant portion of IOs are likely to be attributed incorrectly.
1763 As memory controller assigns page ownership on the first use and
1764 doesn't update it until the page is released, even if writeback
1765 strictly follows page ownership, multiple cgroups dirtying overlapping
1766 areas wouldn't work as expected.  It's recommended to avoid such usage
1767 patterns.
1769 The sysctl knobs which affect writeback behavior are applied to cgroup
1770 writeback as follows.
1772   vm.dirty_background_ratio, vm.dirty_ratio
1773         These ratios apply the same to cgroup writeback with the
1774         amount of available memory capped by limits imposed by the
1775         memory controller and system-wide clean memory.
1777   vm.dirty_background_bytes, vm.dirty_bytes
1778         For cgroup writeback, this is calculated into ratio against
1779         total available memory and applied the same way as
1780         vm.dirty[_background]_ratio.
1783 IO Latency
1784 ~~~~~~~~~~
1786 This is a cgroup v2 controller for IO workload protection.  You provide a group
1787 with a latency target, and if the average latency exceeds that target the
1788 controller will throttle any peers that have a lower latency target than the
1789 protected workload.
1791 The limits are only applied at the peer level in the hierarchy.  This means that
1792 in the diagram below, only groups A, B, and C will influence each other, and
1793 groups D and F will influence each other.  Group G will influence nobody::
1795                         [root]
1796                 /          |            \
1797                 A          B            C
1798                /  \        |
1799               D    F       G
1802 So the ideal way to configure this is to set io.latency in groups A, B, and C.
1803 Generally you do not want to set a value lower than the latency your device
1804 supports.  Experiment to find the value that works best for your workload.
1805 Start at higher than the expected latency for your device and watch the
1806 avg_lat value in io.stat for your workload group to get an idea of the
1807 latency you see during normal operation.  Use the avg_lat value as a basis for
1808 your real setting, setting at 10-15% higher than the value in io.stat.
1810 How IO Latency Throttling Works
1811 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1813 io.latency is work conserving; so as long as everybody is meeting their latency
1814 target the controller doesn't do anything.  Once a group starts missing its
1815 target it begins throttling any peer group that has a higher target than itself.
1816 This throttling takes 2 forms:
1818 - Queue depth throttling.  This is the number of outstanding IO's a group is
1819   allowed to have.  We will clamp down relatively quickly, starting at no limit
1820   and going all the way down to 1 IO at a time.
1822 - Artificial delay induction.  There are certain types of IO that cannot be
1823   throttled without possibly adversely affecting higher priority groups.  This
1824   includes swapping and metadata IO.  These types of IO are allowed to occur
1825   normally, however they are "charged" to the originating group.  If the
1826   originating group is being throttled you will see the use_delay and delay
1827   fields in io.stat increase.  The delay value is how many microseconds that are
1828   being added to any process that runs in this group.  Because this number can
1829   grow quite large if there is a lot of swapping or metadata IO occurring we
1830   limit the individual delay events to 1 second at a time.
1832 Once the victimized group starts meeting its latency target again it will start
1833 unthrottling any peer groups that were throttled previously.  If the victimized
1834 group simply stops doing IO the global counter will unthrottle appropriately.
1836 IO Latency Interface Files
1837 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1839   io.latency
1840         This takes a similar format as the other controllers.
1842                 "MAJOR:MINOR target=<target time in microseconds"
1844   io.stat
1845         If the controller is enabled you will see extra stats in io.stat in
1846         addition to the normal ones.
1848           depth
1849                 This is the current queue depth for the group.
1851           avg_lat
1852                 This is an exponential moving average with a decay rate of 1/exp
1853                 bound by the sampling interval.  The decay rate interval can be
1854                 calculated by multiplying the win value in io.stat by the
1855                 corresponding number of samples based on the win value.
1857           win
1858                 The sampling window size in milliseconds.  This is the minimum
1859                 duration of time between evaluation events.  Windows only elapse
1860                 with IO activity.  Idle periods extend the most recent window.
1865 The process number controller is used to allow a cgroup to stop any
1866 new tasks from being fork()'d or clone()'d after a specified limit is
1867 reached.
1869 The number of tasks in a cgroup can be exhausted in ways which other
1870 controllers cannot prevent, thus warranting its own controller.  For
1871 example, a fork bomb is likely to exhaust the number of tasks before
1872 hitting memory restrictions.
1874 Note that PIDs used in this controller refer to TIDs, process IDs as
1875 used by the kernel.
1878 PID Interface Files
1879 ~~~~~~~~~~~~~~~~~~~
1881   pids.max
1882         A read-write single value file which exists on non-root
1883         cgroups.  The default is "max".
1885         Hard limit of number of processes.
1887   pids.current
1888         A read-only single value file which exists on all cgroups.
1890         The number of processes currently in the cgroup and its
1891         descendants.
1893 Organisational operations are not blocked by cgroup policies, so it is
1894 possible to have pids.current > pids.max.  This can be done by either
1895 setting the limit to be smaller than pids.current, or attaching enough
1896 processes to the cgroup such that pids.current is larger than
1897 pids.max.  However, it is not possible to violate a cgroup PID policy
1898 through fork() or clone(). These will return -EAGAIN if the creation
1899 of a new process would cause a cgroup policy to be violated.
1902 Cpuset
1903 ------
1905 The "cpuset" controller provides a mechanism for constraining
1906 the CPU and memory node placement of tasks to only the resources
1907 specified in the cpuset interface files in a task's current cgroup.
1908 This is especially valuable on large NUMA systems where placing jobs
1909 on properly sized subsets of the systems with careful processor and
1910 memory placement to reduce cross-node memory access and contention
1911 can improve overall system performance.
1913 The "cpuset" controller is hierarchical.  That means the controller
1914 cannot use CPUs or memory nodes not allowed in its parent.
1917 Cpuset Interface Files
1918 ~~~~~~~~~~~~~~~~~~~~~~
1920   cpuset.cpus
1921         A read-write multiple values file which exists on non-root
1922         cpuset-enabled cgroups.
1924         It lists the requested CPUs to be used by tasks within this
1925         cgroup.  The actual list of CPUs to be granted, however, is
1926         subjected to constraints imposed by its parent and can differ
1927         from the requested CPUs.
1929         The CPU numbers are comma-separated numbers or ranges.
1930         For example::
1932           # cat cpuset.cpus
1933           0-4,6,8-10
1935         An empty value indicates that the cgroup is using the same
1936         setting as the nearest cgroup ancestor with a non-empty
1937         "cpuset.cpus" or all the available CPUs if none is found.
1939         The value of "cpuset.cpus" stays constant until the next update
1940         and won't be affected by any CPU hotplug events.
1942   cpuset.cpus.effective
1943         A read-only multiple values file which exists on all
1944         cpuset-enabled cgroups.
1946         It lists the onlined CPUs that are actually granted to this
1947         cgroup by its parent.  These CPUs are allowed to be used by
1948         tasks within the current cgroup.
1950         If "cpuset.cpus" is empty, the "cpuset.cpus.effective" file shows
1951         all the CPUs from the parent cgroup that can be available to
1952         be used by this cgroup.  Otherwise, it should be a subset of
1953         "cpuset.cpus" unless none of the CPUs listed in "cpuset.cpus"
1954         can be granted.  In this case, it will be treated just like an
1955         empty "cpuset.cpus".
1957         Its value will be affected by CPU hotplug events.
1959   cpuset.mems
1960         A read-write multiple values file which exists on non-root
1961         cpuset-enabled cgroups.
1963         It lists the requested memory nodes to be used by tasks within
1964         this cgroup.  The actual list of memory nodes granted, however,
1965         is subjected to constraints imposed by its parent and can differ
1966         from the requested memory nodes.
1968         The memory node numbers are comma-separated numbers or ranges.
1969         For example::
1971           # cat cpuset.mems
1972           0-1,3
1974         An empty value indicates that the cgroup is using the same
1975         setting as the nearest cgroup ancestor with a non-empty
1976         "cpuset.mems" or all the available memory nodes if none
1977         is found.
1979         The value of "cpuset.mems" stays constant until the next update
1980         and won't be affected by any memory nodes hotplug events.
1982   cpuset.mems.effective
1983         A read-only multiple values file which exists on all
1984         cpuset-enabled cgroups.
1986         It lists the onlined memory nodes that are actually granted to
1987         this cgroup by its parent. These memory nodes are allowed to
1988         be used by tasks within the current cgroup.
1990         If "cpuset.mems" is empty, it shows all the memory nodes from the
1991         parent cgroup that will be available to be used by this cgroup.
1992         Otherwise, it should be a subset of "cpuset.mems" unless none of
1993         the memory nodes listed in "cpuset.mems" can be granted.  In this
1994         case, it will be treated just like an empty "cpuset.mems".
1996         Its value will be affected by memory nodes hotplug events.
1998   cpuset.cpus.partition
1999         A read-write single value file which exists on non-root
2000         cpuset-enabled cgroups.  This flag is owned by the parent cgroup
2001         and is not delegatable.
2003         It accepts only the following input values when written to.
2005         "root"   - a partition root
2006         "member" - a non-root member of a partition
2008         When set to be a partition root, the current cgroup is the
2009         root of a new partition or scheduling domain that comprises
2010         itself and all its descendants except those that are separate
2011         partition roots themselves and their descendants.  The root
2012         cgroup is always a partition root.
2014         There are constraints on where a partition root can be set.
2015         It can only be set in a cgroup if all the following conditions
2016         are true.
2018         1) The "cpuset.cpus" is not empty and the list of CPUs are
2019            exclusive, i.e. they are not shared by any of its siblings.
2020         2) The parent cgroup is a partition root.
2021         3) The "cpuset.cpus" is also a proper subset of the parent's
2022            "cpuset.cpus.effective".
2023         4) There is no child cgroups with cpuset enabled.  This is for
2024            eliminating corner cases that have to be handled if such a
2025            condition is allowed.
2027         Setting it to partition root will take the CPUs away from the
2028         effective CPUs of the parent cgroup.  Once it is set, this
2029         file cannot be reverted back to "member" if there are any child
2030         cgroups with cpuset enabled.
2032         A parent partition cannot distribute all its CPUs to its
2033         child partitions.  There must be at least one cpu left in the
2034         parent partition.
2036         Once becoming a partition root, changes to "cpuset.cpus" is
2037         generally allowed as long as the first condition above is true,
2038         the change will not take away all the CPUs from the parent
2039         partition and the new "cpuset.cpus" value is a superset of its
2040         children's "cpuset.cpus" values.
2042         Sometimes, external factors like changes to ancestors'
2043         "cpuset.cpus" or cpu hotplug can cause the state of the partition
2044         root to change.  On read, the "cpuset.sched.partition" file
2045         can show the following values.
2047         "member"       Non-root member of a partition
2048         "root"         Partition root
2049         "root invalid" Invalid partition root
2051         It is a partition root if the first 2 partition root conditions
2052         above are true and at least one CPU from "cpuset.cpus" is
2053         granted by the parent cgroup.
2055         A partition root can become invalid if none of CPUs requested
2056         in "cpuset.cpus" can be granted by the parent cgroup or the
2057         parent cgroup is no longer a partition root itself.  In this
2058         case, it is not a real partition even though the restriction
2059         of the first partition root condition above will still apply.
2060         The cpu affinity of all the tasks in the cgroup will then be
2061         associated with CPUs in the nearest ancestor partition.
2063         An invalid partition root can be transitioned back to a
2064         real partition root if at least one of the requested CPUs
2065         can now be granted by its parent.  In this case, the cpu
2066         affinity of all the tasks in the formerly invalid partition
2067         will be associated to the CPUs of the newly formed partition.
2068         Changing the partition state of an invalid partition root to
2069         "member" is always allowed even if child cpusets are present.
2072 Device controller
2073 -----------------
2075 Device controller manages access to device files. It includes both
2076 creation of new device files (using mknod), and access to the
2077 existing device files.
2079 Cgroup v2 device controller has no interface files and is implemented
2080 on top of cgroup BPF. To control access to device files, a user may
2081 create bpf programs of the BPF_CGROUP_DEVICE type and attach them
2082 to cgroups. On an attempt to access a device file, corresponding
2083 BPF programs will be executed, and depending on the return value
2084 the attempt will succeed or fail with -EPERM.
2086 A BPF_CGROUP_DEVICE program takes a pointer to the bpf_cgroup_dev_ctx
2087 structure, which describes the device access attempt: access type
2088 (mknod/read/write) and device (type, major and minor numbers).
2089 If the program returns 0, the attempt fails with -EPERM, otherwise
2090 it succeeds.
2092 An example of BPF_CGROUP_DEVICE program may be found in the kernel
2093 source tree in the tools/testing/selftests/bpf/dev_cgroup.c file.
2096 RDMA
2097 ----
2099 The "rdma" controller regulates the distribution and accounting of
2100 RDMA resources.
2102 RDMA Interface Files
2103 ~~~~~~~~~~~~~~~~~~~~
2105   rdma.max
2106         A readwrite nested-keyed file that exists for all the cgroups
2107         except root that describes current configured resource limit
2108         for a RDMA/IB device.
2110         Lines are keyed by device name and are not ordered.
2111         Each line contains space separated resource name and its configured
2112         limit that can be distributed.
2114         The following nested keys are defined.
2116           ==========    =============================
2117           hca_handle    Maximum number of HCA Handles
2118           hca_object    Maximum number of HCA Objects
2119           ==========    =============================
2121         An example for mlx4 and ocrdma device follows::
2123           mlx4_0 hca_handle=2 hca_object=2000
2124           ocrdma1 hca_handle=3 hca_object=max
2126   rdma.current
2127         A read-only file that describes current resource usage.
2128         It exists for all the cgroup except root.
2130         An example for mlx4 and ocrdma device follows::
2132           mlx4_0 hca_handle=1 hca_object=20
2133           ocrdma1 hca_handle=1 hca_object=23
2135 HugeTLB
2136 -------
2138 The HugeTLB controller allows to limit the HugeTLB usage per control group and
2139 enforces the controller limit during page fault.
2141 HugeTLB Interface Files
2142 ~~~~~~~~~~~~~~~~~~~~~~~
2144   hugetlb.<hugepagesize>.current
2145         Show current usage for "hugepagesize" hugetlb.  It exists for all
2146         the cgroup except root.
2148   hugetlb.<hugepagesize>.max
2149         Set/show the hard limit of "hugepagesize" hugetlb usage.
2150         The default value is "max".  It exists for all the cgroup except root.
2152   hugetlb.<hugepagesize>.events
2153         A read-only flat-keyed file which exists on non-root cgroups.
2155           max
2156                 The number of allocation failure due to HugeTLB limit
2158   hugetlb.<hugepagesize>.events.local
2159         Similar to hugetlb.<hugepagesize>.events but the fields in the file
2160         are local to the cgroup i.e. not hierarchical. The file modified event
2161         generated on this file reflects only the local events.
2163 Misc
2164 ----
2166 perf_event
2167 ~~~~~~~~~~
2169 perf_event controller, if not mounted on a legacy hierarchy, is
2170 automatically enabled on the v2 hierarchy so that perf events can
2171 always be filtered by cgroup v2 path.  The controller can still be
2172 moved to a legacy hierarchy after v2 hierarchy is populated.
2175 Non-normative information
2176 -------------------------
2178 This section contains information that isn't considered to be a part of
2179 the stable kernel API and so is subject to change.
2182 CPU controller root cgroup process behaviour
2183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2185 When distributing CPU cycles in the root cgroup each thread in this
2186 cgroup is treated as if it was hosted in a separate child cgroup of the
2187 root cgroup. This child cgroup weight is dependent on its thread nice
2188 level.
2190 For details of this mapping see sched_prio_to_weight array in
2191 kernel/sched/core.c file (values from this array should be scaled
2192 appropriately so the neutral - nice 0 - value is 100 instead of 1024).
2195 IO controller root cgroup process behaviour
2196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2198 Root cgroup processes are hosted in an implicit leaf child node.
2199 When distributing IO resources this implicit child node is taken into
2200 account as if it was a normal child cgroup of the root cgroup with a
2201 weight value of 200.
2204 Namespace
2205 =========
2207 Basics
2208 ------
2210 cgroup namespace provides a mechanism to virtualize the view of the
2211 "/proc/$PID/cgroup" file and cgroup mounts.  The CLONE_NEWCGROUP clone
2212 flag can be used with clone(2) and unshare(2) to create a new cgroup
2213 namespace.  The process running inside the cgroup namespace will have
2214 its "/proc/$PID/cgroup" output restricted to cgroupns root.  The
2215 cgroupns root is the cgroup of the process at the time of creation of
2216 the cgroup namespace.
2218 Without cgroup namespace, the "/proc/$PID/cgroup" file shows the
2219 complete path of the cgroup of a process.  In a container setup where
2220 a set of cgroups and namespaces are intended to isolate processes the
2221 "/proc/$PID/cgroup" file may leak potential system level information
2222 to the isolated processes.  For Example::
2224   # cat /proc/self/cgroup
2225   0::/batchjobs/container_id1
2227 The path '/batchjobs/container_id1' can be considered as system-data
2228 and undesirable to expose to the isolated processes.  cgroup namespace
2229 can be used to restrict visibility of this path.  For example, before
2230 creating a cgroup namespace, one would see::
2232   # ls -l /proc/self/ns/cgroup
2233   lrwxrwxrwx 1 root root 0 2014-07-15 10:37 /proc/self/ns/cgroup -> cgroup:[4026531835]
2234   # cat /proc/self/cgroup
2235   0::/batchjobs/container_id1
2237 After unsharing a new namespace, the view changes::
2239   # ls -l /proc/self/ns/cgroup
2240   lrwxrwxrwx 1 root root 0 2014-07-15 10:35 /proc/self/ns/cgroup -> cgroup:[4026532183]
2241   # cat /proc/self/cgroup
2242   0::/
2244 When some thread from a multi-threaded process unshares its cgroup
2245 namespace, the new cgroupns gets applied to the entire process (all
2246 the threads).  This is natural for the v2 hierarchy; however, for the
2247 legacy hierarchies, this may be unexpected.
2249 A cgroup namespace is alive as long as there are processes inside or
2250 mounts pinning it.  When the last usage goes away, the cgroup
2251 namespace is destroyed.  The cgroupns root and the actual cgroups
2252 remain.
2255 The Root and Views
2256 ------------------
2258 The 'cgroupns root' for a cgroup namespace is the cgroup in which the
2259 process calling unshare(2) is running.  For example, if a process in
2260 /batchjobs/container_id1 cgroup calls unshare, cgroup
2261 /batchjobs/container_id1 becomes the cgroupns root.  For the
2262 init_cgroup_ns, this is the real root ('/') cgroup.
2264 The cgroupns root cgroup does not change even if the namespace creator
2265 process later moves to a different cgroup::
2267   # ~/unshare -c # unshare cgroupns in some cgroup
2268   # cat /proc/self/cgroup
2269   0::/
2270   # mkdir sub_cgrp_1
2271   # echo 0 > sub_cgrp_1/cgroup.procs
2272   # cat /proc/self/cgroup
2273   0::/sub_cgrp_1
2275 Each process gets its namespace-specific view of "/proc/$PID/cgroup"
2277 Processes running inside the cgroup namespace will be able to see
2278 cgroup paths (in /proc/self/cgroup) only inside their root cgroup.
2279 From within an unshared cgroupns::
2281   # sleep 100000 &
2282   [1] 7353
2283   # echo 7353 > sub_cgrp_1/cgroup.procs
2284   # cat /proc/7353/cgroup
2285   0::/sub_cgrp_1
2287 From the initial cgroup namespace, the real cgroup path will be
2288 visible::
2290   $ cat /proc/7353/cgroup
2291   0::/batchjobs/container_id1/sub_cgrp_1
2293 From a sibling cgroup namespace (that is, a namespace rooted at a
2294 different cgroup), the cgroup path relative to its own cgroup
2295 namespace root will be shown.  For instance, if PID 7353's cgroup
2296 namespace root is at '/batchjobs/container_id2', then it will see::
2298   # cat /proc/7353/cgroup
2299   0::/../container_id2/sub_cgrp_1
2301 Note that the relative path always starts with '/' to indicate that
2302 its relative to the cgroup namespace root of the caller.
2305 Migration and setns(2)
2306 ----------------------
2308 Processes inside a cgroup namespace can move into and out of the
2309 namespace root if they have proper access to external cgroups.  For
2310 example, from inside a namespace with cgroupns root at
2311 /batchjobs/container_id1, and assuming that the global hierarchy is
2312 still accessible inside cgroupns::
2314   # cat /proc/7353/cgroup
2315   0::/sub_cgrp_1
2316   # echo 7353 > batchjobs/container_id2/cgroup.procs
2317   # cat /proc/7353/cgroup
2318   0::/../container_id2
2320 Note that this kind of setup is not encouraged.  A task inside cgroup
2321 namespace should only be exposed to its own cgroupns hierarchy.
2323 setns(2) to another cgroup namespace is allowed when:
2325 (a) the process has CAP_SYS_ADMIN against its current user namespace
2326 (b) the process has CAP_SYS_ADMIN against the target cgroup
2327     namespace's userns
2329 No implicit cgroup changes happen with attaching to another cgroup
2330 namespace.  It is expected that the someone moves the attaching
2331 process under the target cgroup namespace root.
2334 Interaction with Other Namespaces
2335 ---------------------------------
2337 Namespace specific cgroup hierarchy can be mounted by a process
2338 running inside a non-init cgroup namespace::
2340   # mount -t cgroup2 none $MOUNT_POINT
2342 This will mount the unified cgroup hierarchy with cgroupns root as the
2343 filesystem root.  The process needs CAP_SYS_ADMIN against its user and
2344 mount namespaces.
2346 The virtualization of /proc/self/cgroup file combined with restricting
2347 the view of cgroup hierarchy by namespace-private cgroupfs mount
2348 provides a properly isolated cgroup view inside the container.
2351 Information on Kernel Programming
2352 =================================
2354 This section contains kernel programming information in the areas
2355 where interacting with cgroup is necessary.  cgroup core and
2356 controllers are not covered.
2359 Filesystem Support for Writeback
2360 --------------------------------
2362 A filesystem can support cgroup writeback by updating
2363 address_space_operations->writepage[s]() to annotate bio's using the
2364 following two functions.
2366   wbc_init_bio(@wbc, @bio)
2367         Should be called for each bio carrying writeback data and
2368         associates the bio with the inode's owner cgroup and the
2369         corresponding request queue.  This must be called after
2370         a queue (device) has been associated with the bio and
2371         before submission.
2373   wbc_account_cgroup_owner(@wbc, @page, @bytes)
2374         Should be called for each data segment being written out.
2375         While this function doesn't care exactly when it's called
2376         during the writeback session, it's the easiest and most
2377         natural to call it as data segments are added to a bio.
2379 With writeback bio's annotated, cgroup support can be enabled per
2380 super_block by setting SB_I_CGROUPWB in ->s_iflags.  This allows for
2381 selective disabling of cgroup writeback support which is helpful when
2382 certain filesystem features, e.g. journaled data mode, are
2383 incompatible.
2385 wbc_init_bio() binds the specified bio to its cgroup.  Depending on
2386 the configuration, the bio may be executed at a lower priority and if
2387 the writeback session is holding shared resources, e.g. a journal
2388 entry, may lead to priority inversion.  There is no one easy solution
2389 for the problem.  Filesystems can try to work around specific problem
2390 cases by skipping wbc_init_bio() and using bio_associate_blkg()
2391 directly.
2394 Deprecated v1 Core Features
2395 ===========================
2397 - Multiple hierarchies including named ones are not supported.
2399 - All v1 mount options are not supported.
2401 - The "tasks" file is removed and "cgroup.procs" is not sorted.
2403 - "cgroup.clone_children" is removed.
2405 - /proc/cgroups is meaningless for v2.  Use "cgroup.controllers" file
2406   at the root instead.
2409 Issues with v1 and Rationales for v2
2410 ====================================
2412 Multiple Hierarchies
2413 --------------------
2415 cgroup v1 allowed an arbitrary number of hierarchies and each
2416 hierarchy could host any number of controllers.  While this seemed to
2417 provide a high level of flexibility, it wasn't useful in practice.
2419 For example, as there is only one instance of each controller, utility
2420 type controllers such as freezer which can be useful in all
2421 hierarchies could only be used in one.  The issue is exacerbated by
2422 the fact that controllers couldn't be moved to another hierarchy once
2423 hierarchies were populated.  Another issue was that all controllers
2424 bound to a hierarchy were forced to have exactly the same view of the
2425 hierarchy.  It wasn't possible to vary the granularity depending on
2426 the specific controller.
2428 In practice, these issues heavily limited which controllers could be
2429 put on the same hierarchy and most configurations resorted to putting
2430 each controller on its own hierarchy.  Only closely related ones, such
2431 as the cpu and cpuacct controllers, made sense to be put on the same
2432 hierarchy.  This often meant that userland ended up managing multiple
2433 similar hierarchies repeating the same steps on each hierarchy
2434 whenever a hierarchy management operation was necessary.
2436 Furthermore, support for multiple hierarchies came at a steep cost.
2437 It greatly complicated cgroup core implementation but more importantly
2438 the support for multiple hierarchies restricted how cgroup could be
2439 used in general and what controllers was able to do.
2441 There was no limit on how many hierarchies there might be, which meant
2442 that a thread's cgroup membership couldn't be described in finite
2443 length.  The key might contain any number of entries and was unlimited
2444 in length, which made it highly awkward to manipulate and led to
2445 addition of controllers which existed only to identify membership,
2446 which in turn exacerbated the original problem of proliferating number
2447 of hierarchies.
2449 Also, as a controller couldn't have any expectation regarding the
2450 topologies of hierarchies other controllers might be on, each
2451 controller had to assume that all other controllers were attached to
2452 completely orthogonal hierarchies.  This made it impossible, or at
2453 least very cumbersome, for controllers to cooperate with each other.
2455 In most use cases, putting controllers on hierarchies which are
2456 completely orthogonal to each other isn't necessary.  What usually is
2457 called for is the ability to have differing levels of granularity
2458 depending on the specific controller.  In other words, hierarchy may
2459 be collapsed from leaf towards root when viewed from specific
2460 controllers.  For example, a given configuration might not care about
2461 how memory is distributed beyond a certain level while still wanting
2462 to control how CPU cycles are distributed.
2465 Thread Granularity
2466 ------------------
2468 cgroup v1 allowed threads of a process to belong to different cgroups.
2469 This didn't make sense for some controllers and those controllers
2470 ended up implementing different ways to ignore such situations but
2471 much more importantly it blurred the line between API exposed to
2472 individual applications and system management interface.
2474 Generally, in-process knowledge is available only to the process
2475 itself; thus, unlike service-level organization of processes,
2476 categorizing threads of a process requires active participation from
2477 the application which owns the target process.
2479 cgroup v1 had an ambiguously defined delegation model which got abused
2480 in combination with thread granularity.  cgroups were delegated to
2481 individual applications so that they can create and manage their own
2482 sub-hierarchies and control resource distributions along them.  This
2483 effectively raised cgroup to the status of a syscall-like API exposed
2484 to lay programs.
2486 First of all, cgroup has a fundamentally inadequate interface to be
2487 exposed this way.  For a process to access its own knobs, it has to
2488 extract the path on the target hierarchy from /proc/self/cgroup,
2489 construct the path by appending the name of the knob to the path, open
2490 and then read and/or write to it.  This is not only extremely clunky
2491 and unusual but also inherently racy.  There is no conventional way to
2492 define transaction across the required steps and nothing can guarantee
2493 that the process would actually be operating on its own sub-hierarchy.
2495 cgroup controllers implemented a number of knobs which would never be
2496 accepted as public APIs because they were just adding control knobs to
2497 system-management pseudo filesystem.  cgroup ended up with interface
2498 knobs which were not properly abstracted or refined and directly
2499 revealed kernel internal details.  These knobs got exposed to
2500 individual applications through the ill-defined delegation mechanism
2501 effectively abusing cgroup as a shortcut to implementing public APIs
2502 without going through the required scrutiny.
2504 This was painful for both userland and kernel.  Userland ended up with
2505 misbehaving and poorly abstracted interfaces and kernel exposing and
2506 locked into constructs inadvertently.
2509 Competition Between Inner Nodes and Threads
2510 -------------------------------------------
2512 cgroup v1 allowed threads to be in any cgroups which created an
2513 interesting problem where threads belonging to a parent cgroup and its
2514 children cgroups competed for resources.  This was nasty as two
2515 different types of entities competed and there was no obvious way to
2516 settle it.  Different controllers did different things.
2518 The cpu controller considered threads and cgroups as equivalents and
2519 mapped nice levels to cgroup weights.  This worked for some cases but
2520 fell flat when children wanted to be allocated specific ratios of CPU
2521 cycles and the number of internal threads fluctuated - the ratios
2522 constantly changed as the number of competing entities fluctuated.
2523 There also were other issues.  The mapping from nice level to weight
2524 wasn't obvious or universal, and there were various other knobs which
2525 simply weren't available for threads.
2527 The io controller implicitly created a hidden leaf node for each
2528 cgroup to host the threads.  The hidden leaf had its own copies of all
2529 the knobs with ``leaf_`` prefixed.  While this allowed equivalent
2530 control over internal threads, it was with serious drawbacks.  It
2531 always added an extra layer of nesting which wouldn't be necessary
2532 otherwise, made the interface messy and significantly complicated the
2533 implementation.
2535 The memory controller didn't have a way to control what happened
2536 between internal tasks and child cgroups and the behavior was not
2537 clearly defined.  There were attempts to add ad-hoc behaviors and
2538 knobs to tailor the behavior to specific workloads which would have
2539 led to problems extremely difficult to resolve in the long term.
2541 Multiple controllers struggled with internal tasks and came up with
2542 different ways to deal with it; unfortunately, all the approaches were
2543 severely flawed and, furthermore, the widely different behaviors
2544 made cgroup as a whole highly inconsistent.
2546 This clearly is a problem which needs to be addressed from cgroup core
2547 in a uniform way.
2550 Other Interface Issues
2551 ----------------------
2553 cgroup v1 grew without oversight and developed a large number of
2554 idiosyncrasies and inconsistencies.  One issue on the cgroup core side
2555 was how an empty cgroup was notified - a userland helper binary was
2556 forked and executed for each event.  The event delivery wasn't
2557 recursive or delegatable.  The limitations of the mechanism also led
2558 to in-kernel event delivery filtering mechanism further complicating
2559 the interface.
2561 Controller interfaces were problematic too.  An extreme example is
2562 controllers completely ignoring hierarchical organization and treating
2563 all cgroups as if they were all located directly under the root
2564 cgroup.  Some controllers exposed a large amount of inconsistent
2565 implementation details to userland.
2567 There also was no consistency across controllers.  When a new cgroup
2568 was created, some controllers defaulted to not imposing extra
2569 restrictions while others disallowed any resource usage until
2570 explicitly configured.  Configuration knobs for the same type of
2571 control used widely differing naming schemes and formats.  Statistics
2572 and information knobs were named arbitrarily and used different
2573 formats and units even in the same controller.
2575 cgroup v2 establishes common conventions where appropriate and updates
2576 controllers so that they expose minimal and consistent interfaces.
2579 Controller Issues and Remedies
2580 ------------------------------
2582 Memory
2583 ~~~~~~
2585 The original lower boundary, the soft limit, is defined as a limit
2586 that is per default unset.  As a result, the set of cgroups that
2587 global reclaim prefers is opt-in, rather than opt-out.  The costs for
2588 optimizing these mostly negative lookups are so high that the
2589 implementation, despite its enormous size, does not even provide the
2590 basic desirable behavior.  First off, the soft limit has no
2591 hierarchical meaning.  All configured groups are organized in a global
2592 rbtree and treated like equal peers, regardless where they are located
2593 in the hierarchy.  This makes subtree delegation impossible.  Second,
2594 the soft limit reclaim pass is so aggressive that it not just
2595 introduces high allocation latencies into the system, but also impacts
2596 system performance due to overreclaim, to the point where the feature
2597 becomes self-defeating.
2599 The memory.low boundary on the other hand is a top-down allocated
2600 reserve.  A cgroup enjoys reclaim protection when it's within its
2601 effective low, which makes delegation of subtrees possible. It also
2602 enjoys having reclaim pressure proportional to its overage when
2603 above its effective low.
2605 The original high boundary, the hard limit, is defined as a strict
2606 limit that can not budge, even if the OOM killer has to be called.
2607 But this generally goes against the goal of making the most out of the
2608 available memory.  The memory consumption of workloads varies during
2609 runtime, and that requires users to overcommit.  But doing that with a
2610 strict upper limit requires either a fairly accurate prediction of the
2611 working set size or adding slack to the limit.  Since working set size
2612 estimation is hard and error prone, and getting it wrong results in
2613 OOM kills, most users tend to err on the side of a looser limit and
2614 end up wasting precious resources.
2616 The memory.high boundary on the other hand can be set much more
2617 conservatively.  When hit, it throttles allocations by forcing them
2618 into direct reclaim to work off the excess, but it never invokes the
2619 OOM killer.  As a result, a high boundary that is chosen too
2620 aggressively will not terminate the processes, but instead it will
2621 lead to gradual performance degradation.  The user can monitor this
2622 and make corrections until the minimal memory footprint that still
2623 gives acceptable performance is found.
2625 In extreme cases, with many concurrent allocations and a complete
2626 breakdown of reclaim progress within the group, the high boundary can
2627 be exceeded.  But even then it's mostly better to satisfy the
2628 allocation from the slack available in other groups or the rest of the
2629 system than killing the group.  Otherwise, memory.max is there to
2630 limit this type of spillover and ultimately contain buggy or even
2631 malicious applications.
2633 Setting the original memory.limit_in_bytes below the current usage was
2634 subject to a race condition, where concurrent charges could cause the
2635 limit setting to fail. memory.max on the other hand will first set the
2636 limit to prevent new charges, and then reclaim and OOM kill until the
2637 new limit is met - or the task writing to memory.max is killed.
2639 The combined memory+swap accounting and limiting is replaced by real
2640 control over swap space.
2642 The main argument for a combined memory+swap facility in the original
2643 cgroup design was that global or parental pressure would always be
2644 able to swap all anonymous memory of a child group, regardless of the
2645 child's own (possibly untrusted) configuration.  However, untrusted
2646 groups can sabotage swapping by other means - such as referencing its
2647 anonymous memory in a tight loop - and an admin can not assume full
2648 swappability when overcommitting untrusted jobs.
2650 For trusted jobs, on the other hand, a combined counter is not an
2651 intuitive userspace interface, and it flies in the face of the idea
2652 that cgroup controllers should account and limit specific physical
2653 resources.  Swap space is a resource like all others in the system,
2654 and that's why unified hierarchy allows distributing it separately.