memory.txt 30 KB

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