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