memory.txt 29 KB

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