memory.txt 29.0 KB
Newer Older
1 2
Memory Resource Controller

3 4 5
NOTE: The Memory Resource Controller has generically been referred to as the
      memory controller in this document. Do not confuse memory controller
      used here with the memory controller that is used in hardware.
B
Balbir Singh 已提交
6

K
KAMEZAWA Hiroyuki 已提交
7 8 9 10 11 12
(For editors)
In this document:
      When we mention a cgroup (cgroupfs's directory) with memory controller,
      we call it "memory cgroup". When you see git-log and source code, you'll
      see patch's title and function names tend to use "memcg".
      In this document, we avoid using it.
B
Balbir Singh 已提交
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Benefits and Purpose of the memory controller

The memory controller isolates the memory behaviour of a group of tasks
from the rest of the system. The article on LWN [12] mentions some probable
uses of the memory controller. The memory controller can be used to

a. Isolate an application or a group of applications
   Memory hungry applications can be isolated and limited to a smaller
   amount of memory.
b. Create a cgroup with limited amount of memory, this can be used
   as a good alternative to booting with mem=XXXX.
c. Virtualization solutions can control the amount of memory they want
   to assign to a virtual machine instance.
d. A CD/DVD burner could control the amount of memory used by the
   rest of the system to ensure that burning does not fail due to lack
   of available memory.
e. There are several other use cases, find one or use the controller just
   for fun (to learn and hack on the VM subsystem).

K
KAMEZAWA Hiroyuki 已提交
33 34 35 36
Current Status: linux-2.6.34-mmotm(development version of 2010/April)

Features:
 - accounting anonymous pages, file caches, swap caches usage and limiting them.
37
 - pages are linked to per-memcg LRU exclusively, and there is no global LRU.
K
KAMEZAWA Hiroyuki 已提交
38 39 40 41 42 43 44 45
 - optionally, memory+swap usage can be accounted and limited.
 - hierarchical accounting
 - soft limit
 - moving(recharging) account at moving a task is selectable.
 - usage threshold notifier
 - oom-killer disable knob and oom-notifier
 - Root cgroup has no limit controls.

46 47
 Kernel memory support is work in progress, and the current version provides
 basically functionality. (See Section 2.7)
K
KAMEZAWA Hiroyuki 已提交
48 49 50 51 52 53

Brief summary of control files.

 tasks				 # attach a task(thread) and show list of threads
 cgroup.procs			 # show list of processes
 cgroup.event_control		 # an interface for event_fd()
54 55 56 57
 memory.usage_in_bytes		 # show current res_counter usage for memory
				 (See 5.5 for details)
 memory.memsw.usage_in_bytes	 # show current res_counter usage for memory+Swap
				 (See 5.5 for details)
K
KAMEZAWA Hiroyuki 已提交
58 59 60 61 62
 memory.limit_in_bytes		 # set/show limit of memory usage
 memory.memsw.limit_in_bytes	 # set/show limit of memory+Swap usage
 memory.failcnt			 # show the number of memory usage hits limits
 memory.memsw.failcnt		 # show the number of memory+Swap hits limits
 memory.max_usage_in_bytes	 # show max memory usage recorded
63
 memory.memsw.max_usage_in_bytes # show max memory+Swap usage recorded
K
KAMEZAWA Hiroyuki 已提交
64 65 66 67 68 69 70 71
 memory.soft_limit_in_bytes	 # set/show soft limit of memory usage
 memory.stat			 # show various statistics
 memory.use_hierarchy		 # set/show hierarchical account enabled
 memory.force_empty		 # trigger forced move charge to parent
 memory.swappiness		 # set/show swappiness parameter of vmscan
				 (See sysctl's vm.swappiness)
 memory.move_charge_at_immigrate # set/show controls of moving charges
 memory.oom_control		 # set/show oom controls.
72
 memory.numa_stat		 # show the number of memory usage per numa node
K
KAMEZAWA Hiroyuki 已提交
73

74
 memory.kmem.tcp.limit_in_bytes  # set/show hard limit for tcp buf memory
75
 memory.kmem.tcp.usage_in_bytes  # show current tcp buf memory allocation
76

B
Balbir Singh 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
1. History

The memory controller has a long history. A request for comments for the memory
controller was posted by Balbir Singh [1]. At the time the RFC was posted
there were several implementations for memory control. The goal of the
RFC was to build consensus and agreement for the minimal features required
for memory control. The first RSS controller was posted by Balbir Singh[2]
in Feb 2007. Pavel Emelianov [3][4][5] has since posted three versions of the
RSS controller. At OLS, at the resource management BoF, everyone suggested
that we handle both page cache and RSS together. Another request was raised
to allow user space handling of OOM. The current memory controller is
at version 6; it combines both mapped (RSS) and unmapped Page
Cache Control [11].

2. Memory Control

Memory is a unique resource in the sense that it is present in a limited
amount. If a task requires a lot of CPU processing, the task can spread
its processing over a period of hours, days, months or years, but with
memory, the same physical memory needs to be reused to accomplish the task.

The memory controller implementation has been divided into phases. These
are:

1. Memory controller
2. mlock(2) controller
3. Kernel user memory accounting and slab control
4. user mappings length controller

The memory controller is the first controller developed.

2.1. Design

The core of the design is a counter called the res_counter. The res_counter
tracks the current memory usage and limit of the group of processes associated
with the controller. Each cgroup has a memory controller specific data
structure (mem_cgroup) associated with it.

2.2. Accounting

		+--------------------+
		|  mem_cgroup     |
		|  (res_counter)     |
		+--------------------+
		 /            ^      \
		/             |       \
           +---------------+  |        +---------------+
           | mm_struct     |  |....    | mm_struct     |
           |               |  |        |               |
           +---------------+  |        +---------------+
                              |
                              + --------------+
                                              |
           +---------------+           +------+--------+
           | page          +---------->  page_cgroup|
           |               |           |               |
           +---------------+           +---------------+

             (Figure 1: Hierarchy of Accounting)


Figure 1 shows the important aspects of the controller

1. Accounting happens per cgroup
2. Each mm_struct knows about which cgroup it belongs to
3. Each page has a pointer to the page_cgroup, which in turn knows the
   cgroup it belongs to

The accounting is done as follows: mem_cgroup_charge() is invoked to setup
the necessary data structures and check if the cgroup that is being charged
is over its limit. If it is then reclaim is invoked on the cgroup.
More details can be found in the reclaim section of this document.
If everything goes well, a page meta-data-structure called page_cgroup is
K
KAMEZAWA Hiroyuki 已提交
150 151
updated. page_cgroup has its own LRU on cgroup.
(*) page_cgroup structure is allocated at boot/memory-hotplug time.
B
Balbir Singh 已提交
152 153 154

2.2.1 Accounting details

155
All mapped anon pages (RSS) and cache pages (Page Cache) are accounted.
156
Some pages which are never reclaimable and will not be on the LRU
K
KAMEZAWA Hiroyuki 已提交
157
are not accounted. We just account pages under usual VM management.
158 159 160 161 162 163 164

RSS pages are accounted at page_fault unless they've already been accounted
for earlier. A file page will be accounted for as Page Cache when it's
inserted into inode (radix-tree). While it's mapped into the page tables of
processes, duplicate accounting is carefully avoided.

A RSS page is unaccounted when it's fully unmapped. A PageCache page is
K
KAMEZAWA Hiroyuki 已提交
165 166 167 168 169 170 171 172
unaccounted when it's removed from radix-tree. Even if RSS pages are fully
unmapped (by kswapd), they may exist as SwapCache in the system until they
are really freed. Such SwapCaches also also accounted.
A swapped-in page is not accounted until it's mapped.

Note: The kernel does swapin-readahead and read multiple swaps at once.
This means swapped-in pages may contain pages for other tasks than a task
causing page fault. So, we avoid accounting at swap-in I/O.
173 174 175

At page migration, accounting information is kept.

K
KAMEZAWA Hiroyuki 已提交
176 177
Note: we just account pages-on-LRU because our purpose is to control amount
of used pages; not-on-LRU pages tend to be out-of-control from VM view.
B
Balbir Singh 已提交
178 179 180 181 182 183 184 185 186

2.3 Shared Page Accounting

Shared pages are accounted on the basis of the first touch approach. The
cgroup that first touches a page is accounted for the page. The principle
behind this approach is that a cgroup that aggressively uses a shared
page will eventually get charged for it (once it is uncharged from
the cgroup that brought it in -- this will happen on memory pressure).

187 188 189
But see section 8.2: when moving a task to another cgroup, its pages may
be recharged to the new cgroup, if move_charge_at_immigrate has been chosen.

A
Andrew Morton 已提交
190
Exception: If CONFIG_CGROUP_CGROUP_MEMCG_SWAP is not used.
191
When you do swapoff and make swapped-out pages of shmem(tmpfs) to
K
KAMEZAWA Hiroyuki 已提交
192 193 194
be backed into memory in force, charges for pages are accounted against the
caller of swapoff rather than the users of shmem.

A
Andrew Morton 已提交
195
2.4 Swap Extension (CONFIG_MEMCG_SWAP)
K
KAMEZAWA Hiroyuki 已提交
196

197 198 199 200 201 202 203
Swap Extension allows you to record charge for swap. A swapped-in page is
charged back to original page allocator if possible.

When swap is accounted, following files are added.
 - memory.memsw.usage_in_bytes.
 - memory.memsw.limit_in_bytes.

K
KAMEZAWA Hiroyuki 已提交
204 205 206 207 208 209 210 211
memsw means memory+swap. Usage of memory+swap is limited by
memsw.limit_in_bytes.

Example: Assume a system with 4G of swap. A task which allocates 6G of memory
(by mistake) under 2G memory limitation will use all swap.
In this case, setting memsw.limit_in_bytes=3G will prevent bad use of swap.
By using memsw limit, you can avoid system OOM which can be caused by swap
shortage.
212

K
KAMEZAWA Hiroyuki 已提交
213
* why 'memory+swap' rather than swap.
214 215
The global LRU(kswapd) can swap out arbitrary pages. Swap-out means
to move account from memory to swap...there is no change in usage of
K
KAMEZAWA Hiroyuki 已提交
216 217
memory+swap. In other words, when we want to limit the usage of swap without
affecting global LRU, memory+swap limit is better than just limiting swap from
218 219 220
OS point of view.

* What happens when a cgroup hits memory.memsw.limit_in_bytes
221
When a cgroup hits memory.memsw.limit_in_bytes, it's useless to do swap-out
222 223 224 225
in this cgroup. Then, swap-out will not be done by cgroup routine and file
caches are dropped. But as mentioned above, global LRU can do swapout memory
from it for sanity of the system's memory management state. You can't forbid
it by cgroup.
226 227

2.5 Reclaim
B
Balbir Singh 已提交
228

K
KAMEZAWA Hiroyuki 已提交
229 230
Each cgroup maintains a per cgroup LRU which has the same structure as
global VM. When a cgroup goes over its limit, we first try
B
Balbir Singh 已提交
231 232 233
to reclaim memory from the cgroup so as to make space for the new
pages that the cgroup has touched. If the reclaim is unsuccessful,
an OOM routine is invoked to select and kill the bulkiest task in the
K
KAMEZAWA Hiroyuki 已提交
234
cgroup. (See 10. OOM Control below.)
B
Balbir Singh 已提交
235 236 237 238 239

The reclaim algorithm has not been modified for cgroups, except that
pages that are selected for reclaiming come from the per cgroup LRU
list.

240 241 242
NOTE: Reclaim does not work for the root cgroup, since we cannot set any
limits on the root cgroup.

243 244
Note2: When panic_on_oom is set to "2", the whole system will panic.

K
KAMEZAWA Hiroyuki 已提交
245 246 247
When oom event notifier is registered, event will be delivered.
(See oom_control section)

K
KAMEZAWA Hiroyuki 已提交
248
2.6 Locking
B
Balbir Singh 已提交
249

K
KAMEZAWA Hiroyuki 已提交
250 251
   lock_page_cgroup()/unlock_page_cgroup() should not be called under
   mapping->tree_lock.
B
Balbir Singh 已提交
252

K
KAMEZAWA Hiroyuki 已提交
253 254 255 256 257 258 259 260
   Other lock order is following:
   PG_locked.
   mm->page_table_lock
       zone->lru_lock
	  lock_page_cgroup.
  In many cases, just lock_page_cgroup() is called.
  per-zone-per-cgroup LRU (cgroup's private LRU) is just guarded by
  zone->lru_lock, it has no lock of its own.
B
Balbir Singh 已提交
261

A
Andrew Morton 已提交
262
2.7 Kernel Memory Extension (CONFIG_MEMCG_KMEM)
263 264 265 266 267 268 269 270 271 272 273 274 275 276

With the Kernel memory extension, the Memory Controller is able to limit
the amount of kernel memory used by the system. Kernel memory is fundamentally
different than user memory, since it can't be swapped out, which makes it
possible to DoS the system by consuming too much of this precious resource.

Kernel memory limits are not imposed for the root cgroup. Usage for the root
cgroup may or may not be accounted.

Currently no soft limit is implemented for kernel memory. It is future work
to trigger slab reclaim when those limits are reached.

2.7.1 Current Kernel Memory resources accounted

G
Glauber Costa 已提交
277 278 279
* sockets memory pressure: some sockets protocols have memory pressure
thresholds. The Memory Controller allows them to be controlled individually
per cgroup, instead of globally.
280

G
Glauber Costa 已提交
281 282
* tcp memory pressure: sockets memory pressure for the tcp protocol.

B
Balbir Singh 已提交
283 284 285 286 287 288
3. User Interface

0. Configuration

a. Enable CONFIG_CGROUPS
b. Enable CONFIG_RESOURCE_COUNTERS
A
Andrew Morton 已提交
289 290
c. Enable CONFIG_MEMCG
d. Enable CONFIG_MEMCG_SWAP (to use swap extension)
B
Balbir Singh 已提交
291

292 293 294 295
1. Prepare the cgroups (see cgroups.txt, Why are cgroups needed?)
# mount -t tmpfs none /sys/fs/cgroup
# mkdir /sys/fs/cgroup/memory
# mount -t cgroup none /sys/fs/cgroup/memory -o memory
B
Balbir Singh 已提交
296 297

2. Make the new group and move bash into it
298 299
# mkdir /sys/fs/cgroup/memory/0
# echo $$ > /sys/fs/cgroup/memory/0/tasks
B
Balbir Singh 已提交
300

K
KAMEZAWA Hiroyuki 已提交
301
Since now we're in the 0 cgroup, we can alter the memory limit:
302
# echo 4M > /sys/fs/cgroup/memory/0/memory.limit_in_bytes
303 304

NOTE: We can use a suffix (k, K, m, M, g or G) to indicate values in kilo,
K
KAMEZAWA Hiroyuki 已提交
305 306
mega or gigabytes. (Here, Kilo, Mega, Giga are Kibibytes, Mebibytes, Gibibytes.)

307
NOTE: We can write "-1" to reset the *.limit_in_bytes(unlimited).
308
NOTE: We cannot set limits on the root cgroup any more.
309

310
# cat /sys/fs/cgroup/memory/0/memory.limit_in_bytes
311
4194304
312

B
Balbir Singh 已提交
313
We can check the usage:
314
# cat /sys/fs/cgroup/memory/0/memory.usage_in_bytes
315
1216512
316 317

A successful write to this file does not guarantee a successful set of
K
KAMEZAWA Hiroyuki 已提交
318
this limit to the value written into the file. This can be due to a
319
number of factors, such as rounding up to page boundaries or the total
K
KAMEZAWA Hiroyuki 已提交
320
availability of memory on the system. The user is required to re-read
321 322
this file after a write to guarantee the value committed by the kernel.

323
# echo 1 > memory.limit_in_bytes
324
# cat memory.limit_in_bytes
325
4096
B
Balbir Singh 已提交
326 327 328 329

The memory.failcnt field gives the number of times that the cgroup limit was
exceeded.

330 331 332
The memory.stat file gives accounting information. Now, the number of
caches, RSS and Active pages/Inactive pages are shown.

B
Balbir Singh 已提交
333 334
4. Testing

K
KAMEZAWA Hiroyuki 已提交
335 336 337 338 339 340 341 342 343 344 345 346
For testing features and implementation, see memcg_test.txt.

Performance test is also important. To see pure memory controller's overhead,
testing on tmpfs will give you good numbers of small overheads.
Example: do kernel make on tmpfs.

Page-fault scalability is also important. At measuring parallel
page fault test, multi-process test may be better than multi-thread
test because it has noise of shared objects/status.

But the above two are testing extreme situations.
Trying usual test under memory controller is always helpful.
B
Balbir Singh 已提交
347 348 349 350

4.1 Troubleshooting

Sometimes a user might find that the application under a cgroup is
K
KAMEZAWA Hiroyuki 已提交
351
terminated by OOM killer. There are several causes for this:
B
Balbir Singh 已提交
352 353 354 355 356 357 358

1. The cgroup limit is too low (just too low to do anything useful)
2. The user is using anonymous memory and swap is turned off or too low

A sync followed by echo 1 > /proc/sys/vm/drop_caches will help get rid of
some of the pages cached in the cgroup (page cache pages).

K
KAMEZAWA Hiroyuki 已提交
359 360 361
To know what happens, disable OOM_Kill by 10. OOM Control(see below) and
seeing what happens will be helpful.

B
Balbir Singh 已提交
362 363
4.2 Task migration

364
When a task migrates from one cgroup to another, its charge is not
365
carried forward by default. The pages allocated from the original cgroup still
B
Balbir Singh 已提交
366 367 368
remain charged to it, the charge is dropped when the page is freed or
reclaimed.

K
KAMEZAWA Hiroyuki 已提交
369 370
You can move charges of a task along with task migration.
See 8. "Move charges at task migration"
371

B
Balbir Singh 已提交
372 373 374 375
4.3 Removing a cgroup

A cgroup can be removed by rmdir, but as discussed in sections 4.1 and 4.2, a
cgroup might have some charge associated with it, even though all
K
KAMEZAWA Hiroyuki 已提交
376 377 378
tasks have migrated away from it. (because we charge against pages, not
against tasks.)

379 380 381
We move the stats to root (if use_hierarchy==0) or parent (if
use_hierarchy==1), and no change on the charge except uncharging
from the child.
B
Balbir Singh 已提交
382

383 384 385 386
Charges recorded in swap information is not updated at removal of cgroup.
Recorded information is discarded and a cgroup which uses swap (swapcache)
will be charged as a new owner of it.

387
About use_hierarchy, see Section 6.
388

389 390 391 392 393 394 395 396 397
5. Misc. interfaces.

5.1 force_empty
  memory.force_empty interface is provided to make cgroup's memory usage empty.
  You can use this interface only when the cgroup has no tasks.
  When writing anything to this

  # echo 0 > memory.force_empty

K
KAMEZAWA Hiroyuki 已提交
398 399
  Almost all pages tracked by this memory cgroup will be unmapped and freed.
  Some pages cannot be freed because they are locked or in-use. Such pages are
400 401
  moved to parent(if use_hierarchy==1) or root (if use_hierarchy==0) and this
  cgroup will be empty.
402 403 404 405 406

  Typical use case of this interface is that calling this before rmdir().
  Because rmdir() moves all pages to parent, some out-of-use page caches can be
  moved to the parent. If you want to avoid that, force_empty will be useful.

407 408
  About use_hierarchy, see Section 6.

K
KOSAKI Motohiro 已提交
409
5.2 stat file
B
Bharata B Rao 已提交
410

411
memory.stat file includes following statistics
B
Bharata B Rao 已提交
412

K
KAMEZAWA Hiroyuki 已提交
413
# per-memory cgroup local status
B
Bharata B Rao 已提交
414 415
cache		- # of bytes of page cache memory.
rss		- # of bytes of anonymous and swap cache memory.
K
KAMEZAWA Hiroyuki 已提交
416
mapped_file	- # of bytes of mapped file (includes tmpfs/shmem)
417 418 419 420 421
pgpgin		- # of charging events to the memory cgroup. The charging
		event happens each time a page is accounted as either mapped
		anon page(RSS) or cache page(Page Cache) to the cgroup.
pgpgout		- # of uncharging events to the memory cgroup. The uncharging
		event happens each time a page is unaccounted from the cgroup.
K
KAMEZAWA Hiroyuki 已提交
422
swap		- # of bytes of swap usage
B
Bharata B Rao 已提交
423
inactive_anon	- # of bytes of anonymous memory and swap cache memory on
K
KAMEZAWA Hiroyuki 已提交
424 425 426 427 428
		LRU list.
active_anon	- # of bytes of anonymous and swap cache memory on active
		inactive LRU list.
inactive_file	- # of bytes of file-backed memory on inactive LRU list.
active_file	- # of bytes of file-backed memory on active LRU list.
B
Bharata B Rao 已提交
429 430
unevictable	- # of bytes of memory that cannot be reclaimed (mlocked etc).

K
KAMEZAWA Hiroyuki 已提交
431 432 433 434 435 436 437
# status considering hierarchy (see memory.use_hierarchy settings)

hierarchical_memory_limit - # of bytes of memory limit with regard to hierarchy
			under which the memory cgroup is
hierarchical_memsw_limit - # of bytes of memory+swap limit with regard to
			hierarchy under which memory cgroup is.

438 439 440 441
total_<counter>		- # hierarchical version of <counter>, which in
			addition to the cgroup's own value includes the
			sum of all hierarchical children's values of
			<counter>, i.e. total_cache
K
KAMEZAWA Hiroyuki 已提交
442 443

# The following additional stats are dependent on CONFIG_DEBUG_VM.
B
Bharata B Rao 已提交
444 445 446 447 448 449 450

recent_rotated_anon	- VM internal parameter. (see mm/vmscan.c)
recent_rotated_file	- VM internal parameter. (see mm/vmscan.c)
recent_scanned_anon	- VM internal parameter. (see mm/vmscan.c)
recent_scanned_file	- VM internal parameter. (see mm/vmscan.c)

Memo:
K
KAMEZAWA Hiroyuki 已提交
451 452
	recent_rotated means recent frequency of LRU rotation.
	recent_scanned means recent # of scans to LRU.
K
KOSAKI Motohiro 已提交
453 454
	showing for better debug please see the code for meanings.

B
Bharata B Rao 已提交
455 456 457
Note:
	Only anonymous and swap cache memory is listed as part of 'rss' stat.
	This should not be confused with the true 'resident set size' or the
K
KAMEZAWA Hiroyuki 已提交
458 459 460 461 462
	amount of physical memory used by the cgroup.
	'rss + file_mapped" will give you resident set size of cgroup.
	(Note: file and shmem may be shared among other cgroups. In that case,
	 file_mapped is accounted only when the memory cgroup is owner of page
	 cache.)
K
KOSAKI Motohiro 已提交
463

K
KOSAKI Motohiro 已提交
464 465
5.3 swappiness

K
KAMEZAWA Hiroyuki 已提交
466
Similar to /proc/sys/vm/swappiness, but affecting a hierarchy of groups only.
K
KOSAKI Motohiro 已提交
467

K
KAMEZAWA Hiroyuki 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 481
Following cgroups' swappiness can't be changed.
- root cgroup (uses /proc/sys/vm/swappiness).
- a cgroup which uses hierarchy and it has other cgroup(s) below it.
- a cgroup which uses hierarchy and not the root of hierarchy.

5.4 failcnt

A memory cgroup provides memory.failcnt and memory.memsw.failcnt files.
This failcnt(== failure count) shows the number of times that a usage counter
hit its limit. When a memory cgroup hits a limit, failcnt increases and
memory under it will be reclaimed.

You can reset failcnt by writing 0 to failcnt file.
# echo 0 > .../memory.failcnt
K
KOSAKI Motohiro 已提交
482

483 484 485 486 487 488 489 490 491
5.5 usage_in_bytes

For efficiency, as other kernel components, memory cgroup uses some optimization
to avoid unnecessary cacheline false sharing. usage_in_bytes is affected by the
method and doesn't show 'exact' value of memory(and swap) usage, it's an fuzz
value for efficient access. (Of course, when necessary, it's synchronized.)
If you want to know more exact memory usage, you should use RSS+CACHE(+SWAP)
value in memory.stat(see 5.2).

492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
5.6 numa_stat

This is similar to numa_maps but operates on a per-memcg basis.  This is
useful for providing visibility into the numa locality information within
an memcg since the pages are allowed to be allocated from any physical
node.  One of the usecases is evaluating application performance by
combining this information with the application's cpu allocation.

We export "total", "file", "anon" and "unevictable" pages per-node for
each memcg.  The ouput format of memory.numa_stat is:

total=<total pages> N0=<node 0 pages> N1=<node 1 pages> ...
file=<total file pages> N0=<node 0 pages> N1=<node 1 pages> ...
anon=<total anon pages> N0=<node 0 pages> N1=<node 1 pages> ...
unevictable=<total anon pages> N0=<node 0 pages> N1=<node 1 pages> ...

And we have total = file + anon + unevictable.

510
6. Hierarchy support
511

512 513 514 515 516
The memory controller supports a deep hierarchy and hierarchical accounting.
The hierarchy is created by creating the appropriate cgroups in the
cgroup filesystem. Consider for example, the following cgroup filesystem
hierarchy

517
	       root
518
	     /  |   \
519 520 521 522 523
            /	|    \
	   a	b     c
		      | \
		      |  \
		      d   e
524 525 526

In the diagram above, with hierarchical accounting enabled, all memory
usage of e, is accounted to its ancestors up until the root (i.e, c and root),
K
KAMEZAWA Hiroyuki 已提交
527
that has memory.use_hierarchy enabled. If one of the ancestors goes over its
528 529 530 531 532
limit, the reclaim algorithm reclaims from the tasks in the ancestor and the
children of the ancestor.

6.1 Enabling hierarchical accounting and reclaim

K
KAMEZAWA Hiroyuki 已提交
533
A memory cgroup by default disables the hierarchy feature. Support
534 535 536 537 538 539 540 541
can be enabled by writing 1 to memory.use_hierarchy file of the root cgroup

# echo 1 > memory.use_hierarchy

The feature can be disabled by

# echo 0 > memory.use_hierarchy

542 543 544
NOTE1: Enabling/disabling will fail if either the cgroup already has other
       cgroups created below it, or if the parent cgroup has use_hierarchy
       enabled.
545

546
NOTE2: When panic_on_oom is set to "2", the whole system will panic in
K
KAMEZAWA Hiroyuki 已提交
547
       case of an OOM event in any cgroup.
548

549 550 551 552 553 554 555 556
7. Soft limits

Soft limits allow for greater sharing of memory. The idea behind soft limits
is to allow control groups to use as much of the memory as needed, provided

a. There is no memory contention
b. They do not exceed their hard limit

K
KAMEZAWA Hiroyuki 已提交
557
When the system detects memory contention or low memory, control groups
558 559 560 561 562 563 564 565 566 567 568 569 570
are pushed back to their soft limits. If the soft limit of each control
group is very high, they are pushed back as much as possible to make
sure that one control group does not starve the others of memory.

Please note that soft limits is a best effort feature, it comes with
no guarantees, but it does its best to make sure that when memory is
heavily contended for, memory is allocated based on the soft limit
hints/setup. Currently soft limit based reclaim is setup such that
it gets invoked from balance_pgdat (kswapd).

7.1 Interface

Soft limits can be setup by using the following commands (in this example we
K
KAMEZAWA Hiroyuki 已提交
571
assume a soft limit of 256 MiB)
572 573 574 575 576 577 578 579 580 581 582 583

# echo 256M > memory.soft_limit_in_bytes

If we want to change this to 1G, we can at any time use

# echo 1G > memory.soft_limit_in_bytes

NOTE1: Soft limits take effect over a long period of time, since they involve
       reclaiming memory for balancing between memory cgroups
NOTE2: It is recommended to set the soft limit always below the hard limit,
       otherwise the hard limit will take precedence.

584 585 586 587
8. Move charges at task migration

Users can move charges associated with a task along with task migration, that
is, uncharge task's pages from the old cgroup and charge them to the new cgroup.
588 589
This feature is not supported in !CONFIG_MMU environments because of lack of
page tables.
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606

8.1 Interface

This feature is disabled by default. It can be enabled(and disabled again) by
writing to memory.move_charge_at_immigrate of the destination cgroup.

If you want to enable it:

# echo (some positive value) > memory.move_charge_at_immigrate

Note: Each bits of move_charge_at_immigrate has its own meaning about what type
      of charges should be moved. See 8.2 for details.
Note: Charges are moved only when you move mm->owner, IOW, a leader of a thread
      group.
Note: If we cannot find enough space for the task in the destination cgroup, we
      try to make space by reclaiming memory. Task migration may fail if we
      cannot make enough space.
K
KAMEZAWA Hiroyuki 已提交
607
Note: It can take several seconds if you move charges much.
608 609 610 611 612 613 614 615

And if you want disable it again:

# echo 0 > memory.move_charge_at_immigrate

8.2 Type of charges which can be move

Each bits of move_charge_at_immigrate has its own meaning about what type of
616 617 618
charges should be moved. But in any cases, it must be noted that an account of
a page or a swap can be moved only when it is charged to the task's current(old)
memory cgroup.
619 620 621 622

  bit | what type of charges would be moved ?
 -----+------------------------------------------------------------------------
   0  | A charge of an anonymous page(or swap of it) used by the target task.
623
      | You must enable Swap Extension(see 2.4) to enable move of swap charges.
624 625
 -----+------------------------------------------------------------------------
   1  | A charge of file pages(normal file, tmpfs file(e.g. ipc shared memory)
K
KAMEZAWA Hiroyuki 已提交
626
      | and swaps of tmpfs file) mmapped by the target task. Unlike the case of
627 628 629 630 631 632
      | anonymous pages, file pages(and swaps) in the range mmapped by the task
      | will be moved even if the task hasn't done page fault, i.e. they might
      | not be the task's "RSS", but other task's "RSS" that maps the same file.
      | And mapcount of the page is ignored(the page can be moved even if
      | page_mapcount(page) > 1). You must enable Swap Extension(see 2.4) to
      | enable move of swap charges.
633 634 635 636 637 638

8.3 TODO

- All of moving charge operations are done under cgroup_mutex. It's not good
  behavior to hold the mutex too long, so we may need some trick.

639 640
9. Memory thresholds

K
KAMEZAWA Hiroyuki 已提交
641
Memory cgroup implements memory thresholds using cgroups notification
642 643 644 645
API (see cgroups.txt). It allows to register multiple memory and memsw
thresholds and gets notifications when it crosses.

To register a threshold application need:
K
KAMEZAWA Hiroyuki 已提交
646 647 648 649
- create an eventfd using eventfd(2);
- open memory.usage_in_bytes or memory.memsw.usage_in_bytes;
- write string like "<event_fd> <fd of memory.usage_in_bytes> <threshold>" to
  cgroup.event_control.
650 651 652 653 654 655

Application will be notified through eventfd when memory usage crosses
threshold in any direction.

It's applicable for root and non-root cgroup.

K
KAMEZAWA Hiroyuki 已提交
656 657
10. OOM Control

658 659
memory.oom_control file is for OOM notification and other controls.

K
KAMEZAWA Hiroyuki 已提交
660 661 662
Memory cgroup implements OOM notifier using cgroup notification
API (See cgroups.txt). It allows to register multiple OOM notification
delivery and gets notification when OOM happens.
K
KAMEZAWA Hiroyuki 已提交
663 664 665 666

To register a notifier, application need:
 - create an eventfd using eventfd(2)
 - open memory.oom_control file
K
KAMEZAWA Hiroyuki 已提交
667 668
 - write string like "<event_fd> <fd of memory.oom_control>" to
   cgroup.event_control
K
KAMEZAWA Hiroyuki 已提交
669

K
KAMEZAWA Hiroyuki 已提交
670
Application will be notified through eventfd when OOM happens.
K
KAMEZAWA Hiroyuki 已提交
671 672
OOM notification doesn't work for root cgroup.

K
KAMEZAWA Hiroyuki 已提交
673 674
You can disable OOM-killer by writing "1" to memory.oom_control file, as:

675 676
	#echo 1 > memory.oom_control

K
KAMEZAWA Hiroyuki 已提交
677 678 679
This operation is only allowed to the top cgroup of sub-hierarchy.
If OOM-killer is disabled, tasks under cgroup will hang/sleep
in memory cgroup's OOM-waitqueue when they request accountable memory.
680

K
KAMEZAWA Hiroyuki 已提交
681
For running them, you have to relax the memory cgroup's OOM status by
682 683 684 685 686 687 688 689 690 691
	* enlarge limit or reduce usage.
To reduce usage,
	* kill some tasks.
	* move some tasks to other group with account migration.
	* remove some files (on tmpfs?)

Then, stopped tasks will work again.

At reading, current status of OOM is shown.
	oom_kill_disable 0 or 1 (if 1, oom-killer is disabled)
K
KAMEZAWA Hiroyuki 已提交
692
	under_oom	 0 or 1 (if 1, the memory cgroup is under OOM, tasks may
693
				 be stopped.)
K
KAMEZAWA Hiroyuki 已提交
694 695

11. TODO
B
Balbir Singh 已提交
696 697

1. Add support for accounting huge pages (as a separate controller)
698 699
2. Make per-cgroup scanner reclaim not-shared pages first
3. Teach controller to account for shared-pages
700
4. Start reclamation in the background when the limit is
B
Balbir Singh 已提交
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
   not yet hit but the usage is getting closer

Summary

Overall, the memory controller has been a stable controller and has been
commented and discussed quite extensively in the community.

References

1. Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/
2. Singh, Balbir. Memory Controller (RSS Control),
   http://lwn.net/Articles/222762/
3. Emelianov, Pavel. Resource controllers based on process cgroups
   http://lkml.org/lkml/2007/3/6/198
4. Emelianov, Pavel. RSS controller based on process cgroups (v2)
716
   http://lkml.org/lkml/2007/4/9/78
B
Balbir Singh 已提交
717 718 719 720 721
5. Emelianov, Pavel. RSS controller based on process cgroups (v3)
   http://lkml.org/lkml/2007/5/30/244
6. Menage, Paul. Control Groups v10, http://lwn.net/Articles/236032/
7. Vaidyanathan, Srinivasan, Control Groups: Pagecache accounting and control
   subsystem (v3), http://lwn.net/Articles/235534/
722
8. Singh, Balbir. RSS controller v2 test results (lmbench),
B
Balbir Singh 已提交
723
   http://lkml.org/lkml/2007/5/17/232
724
9. Singh, Balbir. RSS controller v2 AIM9 results
B
Balbir Singh 已提交
725
   http://lkml.org/lkml/2007/5/18/1
726
10. Singh, Balbir. Memory controller v6 test results,
B
Balbir Singh 已提交
727
    http://lkml.org/lkml/2007/8/19/36
728 729
11. Singh, Balbir. Memory controller introduction (v6),
    http://lkml.org/lkml/2007/8/17/69
B
Balbir Singh 已提交
730 731
12. Corbet, Jonathan, Controlling memory use in cgroups,
    http://lwn.net/Articles/243795/