Merge branch 'for-3.5-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/tj...
[firefly-linux-kernel-4.4.55.git] / Documentation / cgroups / memory.txt
1 Memory Resource Controller
2
3 NOTE: The Memory Resource Controller has generically been referred to as the
4       memory controller in this document. Do not confuse memory controller
5       used here with the memory controller that is used in hardware.
6
7 (For editors)
8 In this document:
9       When we mention a cgroup (cgroupfs's directory) with memory controller,
10       we call it "memory cgroup". When you see git-log and source code, you'll
11       see patch's title and function names tend to use "memcg".
12       In this document, we avoid using it.
13
14 Benefits and Purpose of the memory controller
15
16 The memory controller isolates the memory behaviour of a group of tasks
17 from the rest of the system. The article on LWN [12] mentions some probable
18 uses of the memory controller. The memory controller can be used to
19
20 a. Isolate an application or a group of applications
21    Memory hungry applications can be isolated and limited to a smaller
22    amount of memory.
23 b. Create a cgroup with limited amount of memory, this can be used
24    as a good alternative to booting with mem=XXXX.
25 c. Virtualization solutions can control the amount of memory they want
26    to assign to a virtual machine instance.
27 d. A CD/DVD burner could control the amount of memory used by the
28    rest of the system to ensure that burning does not fail due to lack
29    of available memory.
30 e. There are several other use cases, find one or use the controller just
31    for fun (to learn and hack on the VM subsystem).
32
33 Current Status: linux-2.6.34-mmotm(development version of 2010/April)
34
35 Features:
36  - accounting anonymous pages, file caches, swap caches usage and limiting them.
37  - pages are linked to per-memcg LRU exclusively, and there is no global LRU.
38  - optionally, memory+swap usage can be accounted and limited.
39  - hierarchical accounting
40  - soft limit
41  - moving(recharging) account at moving a task is selectable.
42  - usage threshold notifier
43  - oom-killer disable knob and oom-notifier
44  - Root cgroup has no limit controls.
45
46  Kernel memory support is work in progress, and the current version provides
47  basically functionality. (See Section 2.7)
48
49 Brief summary of control files.
50
51  tasks                           # attach a task(thread) and show list of threads
52  cgroup.procs                    # show list of processes
53  cgroup.event_control            # an interface for event_fd()
54  memory.usage_in_bytes           # show current res_counter usage for memory
55                                  (See 5.5 for details)
56  memory.memsw.usage_in_bytes     # show current res_counter usage for memory+Swap
57                                  (See 5.5 for details)
58  memory.limit_in_bytes           # set/show limit of memory usage
59  memory.memsw.limit_in_bytes     # set/show limit of memory+Swap usage
60  memory.failcnt                  # show the number of memory usage hits limits
61  memory.memsw.failcnt            # show the number of memory+Swap hits limits
62  memory.max_usage_in_bytes       # show max memory usage recorded
63  memory.memsw.max_usage_in_bytes # show max memory+Swap usage recorded
64  memory.soft_limit_in_bytes      # set/show soft limit of memory usage
65  memory.stat                     # show various statistics
66  memory.use_hierarchy            # set/show hierarchical account enabled
67  memory.force_empty              # trigger forced move charge to parent
68  memory.swappiness               # set/show swappiness parameter of vmscan
69                                  (See sysctl's vm.swappiness)
70  memory.move_charge_at_immigrate # set/show controls of moving charges
71  memory.oom_control              # set/show oom controls.
72  memory.numa_stat                # show the number of memory usage per numa node
73
74  memory.kmem.tcp.limit_in_bytes  # set/show hard limit for tcp buf memory
75  memory.kmem.tcp.usage_in_bytes  # show current tcp buf memory allocation
76
77 1. History
78
79 The memory controller has a long history. A request for comments for the memory
80 controller was posted by Balbir Singh [1]. At the time the RFC was posted
81 there were several implementations for memory control. The goal of the
82 RFC was to build consensus and agreement for the minimal features required
83 for memory control. The first RSS controller was posted by Balbir Singh[2]
84 in Feb 2007. Pavel Emelianov [3][4][5] has since posted three versions of the
85 RSS controller. At OLS, at the resource management BoF, everyone suggested
86 that we handle both page cache and RSS together. Another request was raised
87 to allow user space handling of OOM. The current memory controller is
88 at version 6; it combines both mapped (RSS) and unmapped Page
89 Cache Control [11].
90
91 2. Memory Control
92
93 Memory is a unique resource in the sense that it is present in a limited
94 amount. If a task requires a lot of CPU processing, the task can spread
95 its processing over a period of hours, days, months or years, but with
96 memory, the same physical memory needs to be reused to accomplish the task.
97
98 The memory controller implementation has been divided into phases. These
99 are:
100
101 1. Memory controller
102 2. mlock(2) controller
103 3. Kernel user memory accounting and slab control
104 4. user mappings length controller
105
106 The memory controller is the first controller developed.
107
108 2.1. Design
109
110 The core of the design is a counter called the res_counter. The res_counter
111 tracks the current memory usage and limit of the group of processes associated
112 with the controller. Each cgroup has a memory controller specific data
113 structure (mem_cgroup) associated with it.
114
115 2.2. Accounting
116
117                 +--------------------+
118                 |  mem_cgroup     |
119                 |  (res_counter)     |
120                 +--------------------+
121                  /            ^      \
122                 /             |       \
123            +---------------+  |        +---------------+
124            | mm_struct     |  |....    | mm_struct     |
125            |               |  |        |               |
126            +---------------+  |        +---------------+
127                               |
128                               + --------------+
129                                               |
130            +---------------+           +------+--------+
131            | page          +---------->  page_cgroup|
132            |               |           |               |
133            +---------------+           +---------------+
134
135              (Figure 1: Hierarchy of Accounting)
136
137
138 Figure 1 shows the important aspects of the controller
139
140 1. Accounting happens per cgroup
141 2. Each mm_struct knows about which cgroup it belongs to
142 3. Each page has a pointer to the page_cgroup, which in turn knows the
143    cgroup it belongs to
144
145 The accounting is done as follows: mem_cgroup_charge() is invoked to setup
146 the necessary data structures and check if the cgroup that is being charged
147 is over its limit. If it is then reclaim is invoked on the cgroup.
148 More details can be found in the reclaim section of this document.
149 If everything goes well, a page meta-data-structure called page_cgroup is
150 updated. page_cgroup has its own LRU on cgroup.
151 (*) page_cgroup structure is allocated at boot/memory-hotplug time.
152
153 2.2.1 Accounting details
154
155 All mapped anon pages (RSS) and cache pages (Page Cache) are accounted.
156 Some pages which are never reclaimable and will not be on the LRU
157 are not accounted. We just account pages under usual VM management.
158
159 RSS pages are accounted at page_fault unless they've already been accounted
160 for earlier. A file page will be accounted for as Page Cache when it's
161 inserted into inode (radix-tree). While it's mapped into the page tables of
162 processes, duplicate accounting is carefully avoided.
163
164 A RSS page is unaccounted when it's fully unmapped. A PageCache page is
165 unaccounted when it's removed from radix-tree. Even if RSS pages are fully
166 unmapped (by kswapd), they may exist as SwapCache in the system until they
167 are really freed. Such SwapCaches also also accounted.
168 A swapped-in page is not accounted until it's mapped.
169
170 Note: The kernel does swapin-readahead and read multiple swaps at once.
171 This means swapped-in pages may contain pages for other tasks than a task
172 causing page fault. So, we avoid accounting at swap-in I/O.
173
174 At page migration, accounting information is kept.
175
176 Note: we just account pages-on-LRU because our purpose is to control amount
177 of used pages; not-on-LRU pages tend to be out-of-control from VM view.
178
179 2.3 Shared Page Accounting
180
181 Shared pages are accounted on the basis of the first touch approach. The
182 cgroup that first touches a page is accounted for the page. The principle
183 behind this approach is that a cgroup that aggressively uses a shared
184 page will eventually get charged for it (once it is uncharged from
185 the cgroup that brought it in -- this will happen on memory pressure).
186
187 But see section 8.2: when moving a task to another cgroup, its pages may
188 be recharged to the new cgroup, if move_charge_at_immigrate has been chosen.
189
190 Exception: If CONFIG_CGROUP_CGROUP_MEM_RES_CTLR_SWAP is not used.
191 When you do swapoff and make swapped-out pages of shmem(tmpfs) to
192 be backed into memory in force, charges for pages are accounted against the
193 caller of swapoff rather than the users of shmem.
194
195 2.4 Swap Extension (CONFIG_CGROUP_MEM_RES_CTLR_SWAP)
196
197 Swap Extension allows you to record charge for swap. A swapped-in page is
198 charged back to original page allocator if possible.
199
200 When swap is accounted, following files are added.
201  - memory.memsw.usage_in_bytes.
202  - memory.memsw.limit_in_bytes.
203
204 memsw means memory+swap. Usage of memory+swap is limited by
205 memsw.limit_in_bytes.
206
207 Example: Assume a system with 4G of swap. A task which allocates 6G of memory
208 (by mistake) under 2G memory limitation will use all swap.
209 In this case, setting memsw.limit_in_bytes=3G will prevent bad use of swap.
210 By using memsw limit, you can avoid system OOM which can be caused by swap
211 shortage.
212
213 * why 'memory+swap' rather than swap.
214 The global LRU(kswapd) can swap out arbitrary pages. Swap-out means
215 to move account from memory to swap...there is no change in usage of
216 memory+swap. In other words, when we want to limit the usage of swap without
217 affecting global LRU, memory+swap limit is better than just limiting swap from
218 OS point of view.
219
220 * What happens when a cgroup hits memory.memsw.limit_in_bytes
221 When a cgroup hits memory.memsw.limit_in_bytes, it's useless to do swap-out
222 in this cgroup. Then, swap-out will not be done by cgroup routine and file
223 caches are dropped. But as mentioned above, global LRU can do swapout memory
224 from it for sanity of the system's memory management state. You can't forbid
225 it by cgroup.
226
227 2.5 Reclaim
228
229 Each cgroup maintains a per cgroup LRU which has the same structure as
230 global VM. When a cgroup goes over its limit, we first try
231 to reclaim memory from the cgroup so as to make space for the new
232 pages that the cgroup has touched. If the reclaim is unsuccessful,
233 an OOM routine is invoked to select and kill the bulkiest task in the
234 cgroup. (See 10. OOM Control below.)
235
236 The reclaim algorithm has not been modified for cgroups, except that
237 pages that are selected for reclaiming come from the per cgroup LRU
238 list.
239
240 NOTE: Reclaim does not work for the root cgroup, since we cannot set any
241 limits on the root cgroup.
242
243 Note2: When panic_on_oom is set to "2", the whole system will panic.
244
245 When oom event notifier is registered, event will be delivered.
246 (See oom_control section)
247
248 2.6 Locking
249
250    lock_page_cgroup()/unlock_page_cgroup() should not be called under
251    mapping->tree_lock.
252
253    Other lock order is following:
254    PG_locked.
255    mm->page_table_lock
256        zone->lru_lock
257           lock_page_cgroup.
258   In many cases, just lock_page_cgroup() is called.
259   per-zone-per-cgroup LRU (cgroup's private LRU) is just guarded by
260   zone->lru_lock, it has no lock of its own.
261
262 2.7 Kernel Memory Extension (CONFIG_CGROUP_MEM_RES_CTLR_KMEM)
263
264 With the Kernel memory extension, the Memory Controller is able to limit
265 the amount of kernel memory used by the system. Kernel memory is fundamentally
266 different than user memory, since it can't be swapped out, which makes it
267 possible to DoS the system by consuming too much of this precious resource.
268
269 Kernel memory limits are not imposed for the root cgroup. Usage for the root
270 cgroup may or may not be accounted.
271
272 Currently no soft limit is implemented for kernel memory. It is future work
273 to trigger slab reclaim when those limits are reached.
274
275 2.7.1 Current Kernel Memory resources accounted
276
277 * sockets memory pressure: some sockets protocols have memory pressure
278 thresholds. The Memory Controller allows them to be controlled individually
279 per cgroup, instead of globally.
280
281 * tcp memory pressure: sockets memory pressure for the tcp protocol.
282
283 3. User Interface
284
285 0. Configuration
286
287 a. Enable CONFIG_CGROUPS
288 b. Enable CONFIG_RESOURCE_COUNTERS
289 c. Enable CONFIG_CGROUP_MEM_RES_CTLR
290 d. Enable CONFIG_CGROUP_MEM_RES_CTLR_SWAP (to use swap extension)
291
292 1. Prepare the cgroups (see cgroups.txt, Why are cgroups needed?)
293 # mount -t tmpfs none /sys/fs/cgroup
294 # mkdir /sys/fs/cgroup/memory
295 # mount -t cgroup none /sys/fs/cgroup/memory -o memory
296
297 2. Make the new group and move bash into it
298 # mkdir /sys/fs/cgroup/memory/0
299 # echo $$ > /sys/fs/cgroup/memory/0/tasks
300
301 Since now we're in the 0 cgroup, we can alter the memory limit:
302 # echo 4M > /sys/fs/cgroup/memory/0/memory.limit_in_bytes
303
304 NOTE: We can use a suffix (k, K, m, M, g or G) to indicate values in kilo,
305 mega or gigabytes. (Here, Kilo, Mega, Giga are Kibibytes, Mebibytes, Gibibytes.)
306
307 NOTE: We can write "-1" to reset the *.limit_in_bytes(unlimited).
308 NOTE: We cannot set limits on the root cgroup any more.
309
310 # cat /sys/fs/cgroup/memory/0/memory.limit_in_bytes
311 4194304
312
313 We can check the usage:
314 # cat /sys/fs/cgroup/memory/0/memory.usage_in_bytes
315 1216512
316
317 A successful write to this file does not guarantee a successful set of
318 this limit to the value written into the file. This can be due to a
319 number of factors, such as rounding up to page boundaries or the total
320 availability of memory on the system. The user is required to re-read
321 this file after a write to guarantee the value committed by the kernel.
322
323 # echo 1 > memory.limit_in_bytes
324 # cat memory.limit_in_bytes
325 4096
326
327 The memory.failcnt field gives the number of times that the cgroup limit was
328 exceeded.
329
330 The memory.stat file gives accounting information. Now, the number of
331 caches, RSS and Active pages/Inactive pages are shown.
332
333 4. Testing
334
335 For testing features and implementation, see memcg_test.txt.
336
337 Performance test is also important. To see pure memory controller's overhead,
338 testing on tmpfs will give you good numbers of small overheads.
339 Example: do kernel make on tmpfs.
340
341 Page-fault scalability is also important. At measuring parallel
342 page fault test, multi-process test may be better than multi-thread
343 test because it has noise of shared objects/status.
344
345 But the above two are testing extreme situations.
346 Trying usual test under memory controller is always helpful.
347
348 4.1 Troubleshooting
349
350 Sometimes a user might find that the application under a cgroup is
351 terminated by OOM killer. There are several causes for this:
352
353 1. The cgroup limit is too low (just too low to do anything useful)
354 2. The user is using anonymous memory and swap is turned off or too low
355
356 A sync followed by echo 1 > /proc/sys/vm/drop_caches will help get rid of
357 some of the pages cached in the cgroup (page cache pages).
358
359 To know what happens, disable OOM_Kill by 10. OOM Control(see below) and
360 seeing what happens will be helpful.
361
362 4.2 Task migration
363
364 When a task migrates from one cgroup to another, its charge is not
365 carried forward by default. The pages allocated from the original cgroup still
366 remain charged to it, the charge is dropped when the page is freed or
367 reclaimed.
368
369 You can move charges of a task along with task migration.
370 See 8. "Move charges at task migration"
371
372 4.3 Removing a cgroup
373
374 A cgroup can be removed by rmdir, but as discussed in sections 4.1 and 4.2, a
375 cgroup might have some charge associated with it, even though all
376 tasks have migrated away from it. (because we charge against pages, not
377 against tasks.)
378
379 We move the stats to root (if use_hierarchy==0) or parent (if
380 use_hierarchy==1), and no change on the charge except uncharging
381 from the child.
382
383 Charges recorded in swap information is not updated at removal of cgroup.
384 Recorded information is discarded and a cgroup which uses swap (swapcache)
385 will be charged as a new owner of it.
386
387 About use_hierarchy, see Section 6.
388
389 5. Misc. interfaces.
390
391 5.1 force_empty
392   memory.force_empty interface is provided to make cgroup's memory usage empty.
393   You can use this interface only when the cgroup has no tasks.
394   When writing anything to this
395
396   # echo 0 > memory.force_empty
397
398   Almost all pages tracked by this memory cgroup will be unmapped and freed.
399   Some pages cannot be freed because they are locked or in-use. Such pages are
400   moved to parent(if use_hierarchy==1) or root (if use_hierarchy==0) and this
401   cgroup will be empty.
402
403   Typical use case of this interface is that calling this before rmdir().
404   Because rmdir() moves all pages to parent, some out-of-use page caches can be
405   moved to the parent. If you want to avoid that, force_empty will be useful.
406
407   About use_hierarchy, see Section 6.
408
409 5.2 stat file
410
411 memory.stat file includes following statistics
412
413 # per-memory cgroup local status
414 cache           - # of bytes of page cache memory.
415 rss             - # of bytes of anonymous and swap cache memory.
416 mapped_file     - # of bytes of mapped file (includes tmpfs/shmem)
417 pgpgin          - # of charging events to the memory cgroup. The charging
418                 event happens each time a page is accounted as either mapped
419                 anon page(RSS) or cache page(Page Cache) to the cgroup.
420 pgpgout         - # of uncharging events to the memory cgroup. The uncharging
421                 event happens each time a page is unaccounted from the cgroup.
422 swap            - # of bytes of swap usage
423 inactive_anon   - # of bytes of anonymous memory and swap cache memory on
424                 LRU list.
425 active_anon     - # of bytes of anonymous and swap cache memory on active
426                 inactive LRU list.
427 inactive_file   - # of bytes of file-backed memory on inactive LRU list.
428 active_file     - # of bytes of file-backed memory on active LRU list.
429 unevictable     - # of bytes of memory that cannot be reclaimed (mlocked etc).
430
431 # status considering hierarchy (see memory.use_hierarchy settings)
432
433 hierarchical_memory_limit - # of bytes of memory limit with regard to hierarchy
434                         under which the memory cgroup is
435 hierarchical_memsw_limit - # of bytes of memory+swap limit with regard to
436                         hierarchy under which memory cgroup is.
437
438 total_<counter>         - # hierarchical version of <counter>, which in
439                         addition to the cgroup's own value includes the
440                         sum of all hierarchical children's values of
441                         <counter>, i.e. total_cache
442
443 # The following additional stats are dependent on CONFIG_DEBUG_VM.
444
445 recent_rotated_anon     - VM internal parameter. (see mm/vmscan.c)
446 recent_rotated_file     - VM internal parameter. (see mm/vmscan.c)
447 recent_scanned_anon     - VM internal parameter. (see mm/vmscan.c)
448 recent_scanned_file     - VM internal parameter. (see mm/vmscan.c)
449
450 Memo:
451         recent_rotated means recent frequency of LRU rotation.
452         recent_scanned means recent # of scans to LRU.
453         showing for better debug please see the code for meanings.
454
455 Note:
456         Only anonymous and swap cache memory is listed as part of 'rss' stat.
457         This should not be confused with the true 'resident set size' or the
458         amount of physical memory used by the cgroup.
459         'rss + file_mapped" will give you resident set size of cgroup.
460         (Note: file and shmem may be shared among other cgroups. In that case,
461          file_mapped is accounted only when the memory cgroup is owner of page
462          cache.)
463
464 5.3 swappiness
465
466 Similar to /proc/sys/vm/swappiness, but affecting a hierarchy of groups only.
467
468 Following cgroups' swappiness can't be changed.
469 - root cgroup (uses /proc/sys/vm/swappiness).
470 - a cgroup which uses hierarchy and it has other cgroup(s) below it.
471 - a cgroup which uses hierarchy and not the root of hierarchy.
472
473 5.4 failcnt
474
475 A memory cgroup provides memory.failcnt and memory.memsw.failcnt files.
476 This failcnt(== failure count) shows the number of times that a usage counter
477 hit its limit. When a memory cgroup hits a limit, failcnt increases and
478 memory under it will be reclaimed.
479
480 You can reset failcnt by writing 0 to failcnt file.
481 # echo 0 > .../memory.failcnt
482
483 5.5 usage_in_bytes
484
485 For efficiency, as other kernel components, memory cgroup uses some optimization
486 to avoid unnecessary cacheline false sharing. usage_in_bytes is affected by the
487 method and doesn't show 'exact' value of memory(and swap) usage, it's an fuzz
488 value for efficient access. (Of course, when necessary, it's synchronized.)
489 If you want to know more exact memory usage, you should use RSS+CACHE(+SWAP)
490 value in memory.stat(see 5.2).
491
492 5.6 numa_stat
493
494 This is similar to numa_maps but operates on a per-memcg basis.  This is
495 useful for providing visibility into the numa locality information within
496 an memcg since the pages are allowed to be allocated from any physical
497 node.  One of the usecases is evaluating application performance by
498 combining this information with the application's cpu allocation.
499
500 We export "total", "file", "anon" and "unevictable" pages per-node for
501 each memcg.  The ouput format of memory.numa_stat is:
502
503 total=<total pages> N0=<node 0 pages> N1=<node 1 pages> ...
504 file=<total file pages> N0=<node 0 pages> N1=<node 1 pages> ...
505 anon=<total anon pages> N0=<node 0 pages> N1=<node 1 pages> ...
506 unevictable=<total anon pages> N0=<node 0 pages> N1=<node 1 pages> ...
507
508 And we have total = file + anon + unevictable.
509
510 6. Hierarchy support
511
512 The memory controller supports a deep hierarchy and hierarchical accounting.
513 The hierarchy is created by creating the appropriate cgroups in the
514 cgroup filesystem. Consider for example, the following cgroup filesystem
515 hierarchy
516
517                root
518              /  |   \
519             /   |    \
520            a    b     c
521                       | \
522                       |  \
523                       d   e
524
525 In the diagram above, with hierarchical accounting enabled, all memory
526 usage of e, is accounted to its ancestors up until the root (i.e, c and root),
527 that has memory.use_hierarchy enabled. If one of the ancestors goes over its
528 limit, the reclaim algorithm reclaims from the tasks in the ancestor and the
529 children of the ancestor.
530
531 6.1 Enabling hierarchical accounting and reclaim
532
533 A memory cgroup by default disables the hierarchy feature. Support
534 can be enabled by writing 1 to memory.use_hierarchy file of the root cgroup
535
536 # echo 1 > memory.use_hierarchy
537
538 The feature can be disabled by
539
540 # echo 0 > memory.use_hierarchy
541
542 NOTE1: Enabling/disabling will fail if either the cgroup already has other
543        cgroups created below it, or if the parent cgroup has use_hierarchy
544        enabled.
545
546 NOTE2: When panic_on_oom is set to "2", the whole system will panic in
547        case of an OOM event in any cgroup.
548
549 7. Soft limits
550
551 Soft limits allow for greater sharing of memory. The idea behind soft limits
552 is to allow control groups to use as much of the memory as needed, provided
553
554 a. There is no memory contention
555 b. They do not exceed their hard limit
556
557 When the system detects memory contention or low memory, control groups
558 are pushed back to their soft limits. If the soft limit of each control
559 group is very high, they are pushed back as much as possible to make
560 sure that one control group does not starve the others of memory.
561
562 Please note that soft limits is a best effort feature, it comes with
563 no guarantees, but it does its best to make sure that when memory is
564 heavily contended for, memory is allocated based on the soft limit
565 hints/setup. Currently soft limit based reclaim is setup such that
566 it gets invoked from balance_pgdat (kswapd).
567
568 7.1 Interface
569
570 Soft limits can be setup by using the following commands (in this example we
571 assume a soft limit of 256 MiB)
572
573 # echo 256M > memory.soft_limit_in_bytes
574
575 If we want to change this to 1G, we can at any time use
576
577 # echo 1G > memory.soft_limit_in_bytes
578
579 NOTE1: Soft limits take effect over a long period of time, since they involve
580        reclaiming memory for balancing between memory cgroups
581 NOTE2: It is recommended to set the soft limit always below the hard limit,
582        otherwise the hard limit will take precedence.
583
584 8. Move charges at task migration
585
586 Users can move charges associated with a task along with task migration, that
587 is, uncharge task's pages from the old cgroup and charge them to the new cgroup.
588 This feature is not supported in !CONFIG_MMU environments because of lack of
589 page tables.
590
591 8.1 Interface
592
593 This feature is disabled by default. It can be enabled(and disabled again) by
594 writing to memory.move_charge_at_immigrate of the destination cgroup.
595
596 If you want to enable it:
597
598 # echo (some positive value) > memory.move_charge_at_immigrate
599
600 Note: Each bits of move_charge_at_immigrate has its own meaning about what type
601       of charges should be moved. See 8.2 for details.
602 Note: Charges are moved only when you move mm->owner, IOW, a leader of a thread
603       group.
604 Note: If we cannot find enough space for the task in the destination cgroup, we
605       try to make space by reclaiming memory. Task migration may fail if we
606       cannot make enough space.
607 Note: It can take several seconds if you move charges much.
608
609 And if you want disable it again:
610
611 # echo 0 > memory.move_charge_at_immigrate
612
613 8.2 Type of charges which can be move
614
615 Each bits of move_charge_at_immigrate has its own meaning about what type of
616 charges should be moved. But in any cases, it must be noted that an account of
617 a page or a swap can be moved only when it is charged to the task's current(old)
618 memory cgroup.
619
620   bit | what type of charges would be moved ?
621  -----+------------------------------------------------------------------------
622    0  | A charge of an anonymous page(or swap of it) used by the target task.
623       | You must enable Swap Extension(see 2.4) to enable move of swap charges.
624  -----+------------------------------------------------------------------------
625    1  | A charge of file pages(normal file, tmpfs file(e.g. ipc shared memory)
626       | and swaps of tmpfs file) mmapped by the target task. Unlike the case of
627       | anonymous pages, file pages(and swaps) in the range mmapped by the task
628       | will be moved even if the task hasn't done page fault, i.e. they might
629       | not be the task's "RSS", but other task's "RSS" that maps the same file.
630       | And mapcount of the page is ignored(the page can be moved even if
631       | page_mapcount(page) > 1). You must enable Swap Extension(see 2.4) to
632       | enable move of swap charges.
633
634 8.3 TODO
635
636 - All of moving charge operations are done under cgroup_mutex. It's not good
637   behavior to hold the mutex too long, so we may need some trick.
638
639 9. Memory thresholds
640
641 Memory cgroup implements memory thresholds using cgroups notification
642 API (see cgroups.txt). It allows to register multiple memory and memsw
643 thresholds and gets notifications when it crosses.
644
645 To register a threshold application need:
646 - create an eventfd using eventfd(2);
647 - open memory.usage_in_bytes or memory.memsw.usage_in_bytes;
648 - write string like "<event_fd> <fd of memory.usage_in_bytes> <threshold>" to
649   cgroup.event_control.
650
651 Application will be notified through eventfd when memory usage crosses
652 threshold in any direction.
653
654 It's applicable for root and non-root cgroup.
655
656 10. OOM Control
657
658 memory.oom_control file is for OOM notification and other controls.
659
660 Memory cgroup implements OOM notifier using cgroup notification
661 API (See cgroups.txt). It allows to register multiple OOM notification
662 delivery and gets notification when OOM happens.
663
664 To register a notifier, application need:
665  - create an eventfd using eventfd(2)
666  - open memory.oom_control file
667  - write string like "<event_fd> <fd of memory.oom_control>" to
668    cgroup.event_control
669
670 Application will be notified through eventfd when OOM happens.
671 OOM notification doesn't work for root cgroup.
672
673 You can disable OOM-killer by writing "1" to memory.oom_control file, as:
674
675         #echo 1 > memory.oom_control
676
677 This operation is only allowed to the top cgroup of sub-hierarchy.
678 If OOM-killer is disabled, tasks under cgroup will hang/sleep
679 in memory cgroup's OOM-waitqueue when they request accountable memory.
680
681 For running them, you have to relax the memory cgroup's OOM status by
682         * enlarge limit or reduce usage.
683 To reduce usage,
684         * kill some tasks.
685         * move some tasks to other group with account migration.
686         * remove some files (on tmpfs?)
687
688 Then, stopped tasks will work again.
689
690 At reading, current status of OOM is shown.
691         oom_kill_disable 0 or 1 (if 1, oom-killer is disabled)
692         under_oom        0 or 1 (if 1, the memory cgroup is under OOM, tasks may
693                                  be stopped.)
694
695 11. TODO
696
697 1. Add support for accounting huge pages (as a separate controller)
698 2. Make per-cgroup scanner reclaim not-shared pages first
699 3. Teach controller to account for shared-pages
700 4. Start reclamation in the background when the limit is
701    not yet hit but the usage is getting closer
702
703 Summary
704
705 Overall, the memory controller has been a stable controller and has been
706 commented and discussed quite extensively in the community.
707
708 References
709
710 1. Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/
711 2. Singh, Balbir. Memory Controller (RSS Control),
712    http://lwn.net/Articles/222762/
713 3. Emelianov, Pavel. Resource controllers based on process cgroups
714    http://lkml.org/lkml/2007/3/6/198
715 4. Emelianov, Pavel. RSS controller based on process cgroups (v2)
716    http://lkml.org/lkml/2007/4/9/78
717 5. Emelianov, Pavel. RSS controller based on process cgroups (v3)
718    http://lkml.org/lkml/2007/5/30/244
719 6. Menage, Paul. Control Groups v10, http://lwn.net/Articles/236032/
720 7. Vaidyanathan, Srinivasan, Control Groups: Pagecache accounting and control
721    subsystem (v3), http://lwn.net/Articles/235534/
722 8. Singh, Balbir. RSS controller v2 test results (lmbench),
723    http://lkml.org/lkml/2007/5/17/232
724 9. Singh, Balbir. RSS controller v2 AIM9 results
725    http://lkml.org/lkml/2007/5/18/1
726 10. Singh, Balbir. Memory controller v6 test results,
727     http://lkml.org/lkml/2007/8/19/36
728 11. Singh, Balbir. Memory controller introduction (v6),
729     http://lkml.org/lkml/2007/8/17/69
730 12. Corbet, Jonathan, Controlling memory use in cgroups,
731     http://lwn.net/Articles/243795/