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