]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - Documentation/sysctl/vm.txt
drm/amd/display: Add bunch of missing license headers in DML
[mirror_ubuntu-bionic-kernel.git] / Documentation / sysctl / vm.txt
CommitLineData
db0fb184 1Documentation for /proc/sys/vm/* kernel version 2.6.29
1da177e4 2 (c) 1998, 1999, Rik van Riel <riel@nl.linux.org>
db0fb184 3 (c) 2008 Peter W. Morreale <pmorreale@novell.com>
1da177e4
LT
4
5For general info and legal blurb, please look in README.
6
7==============================================================
8
9This file contains the documentation for the sysctl files in
db0fb184 10/proc/sys/vm and is valid for Linux kernel version 2.6.29.
1da177e4
LT
11
12The files in this directory can be used to tune the operation
13of the virtual memory (VM) subsystem of the Linux kernel and
14the writeout of dirty data to disk.
15
16Default values and initialization routines for most of these
17files can be found in mm/swap.c.
18
19Currently, these files are in /proc/sys/vm:
db0fb184 20
4eeab4f5 21- admin_reserve_kbytes
db0fb184 22- block_dump
76ab0f53 23- compact_memory
5bbe3547 24- compact_unevictable_allowed
db0fb184 25- dirty_background_bytes
1da177e4 26- dirty_background_ratio
db0fb184 27- dirty_bytes
1da177e4 28- dirty_expire_centisecs
db0fb184 29- dirty_ratio
1da177e4 30- dirty_writeback_centisecs
db0fb184 31- drop_caches
5e771905 32- extfrag_threshold
db0fb184
PM
33- hugepages_treat_as_movable
34- hugetlb_shm_group
35- laptop_mode
36- legacy_va_layout
37- lowmem_reserve_ratio
1da177e4 38- max_map_count
6a46079c
AK
39- memory_failure_early_kill
40- memory_failure_recovery
1da177e4 41- min_free_kbytes
0ff38490 42- min_slab_ratio
db0fb184
PM
43- min_unmapped_ratio
44- mmap_min_addr
d07e2259
DC
45- mmap_rnd_bits
46- mmap_rnd_compat_bits
d5dbac87
NA
47- nr_hugepages
48- nr_overcommit_hugepages
db0fb184
PM
49- nr_trim_pages (only if CONFIG_MMU=n)
50- numa_zonelist_order
51- oom_dump_tasks
52- oom_kill_allocating_task
49f0ce5f 53- overcommit_kbytes
db0fb184
PM
54- overcommit_memory
55- overcommit_ratio
56- page-cluster
57- panic_on_oom
58- percpu_pagelist_fraction
59- stat_interval
52b6f46b 60- stat_refresh
db0fb184 61- swappiness
c9b1d098 62- user_reserve_kbytes
db0fb184 63- vfs_cache_pressure
e6507a00 64- watermark_scale_factor
db0fb184
PM
65- zone_reclaim_mode
66
1da177e4
LT
67==============================================================
68
4eeab4f5
AS
69admin_reserve_kbytes
70
71The amount of free memory in the system that should be reserved for users
72with the capability cap_sys_admin.
73
74admin_reserve_kbytes defaults to min(3% of free pages, 8MB)
75
76That should provide enough for the admin to log in and kill a process,
77if necessary, under the default overcommit 'guess' mode.
78
79Systems running under overcommit 'never' should increase this to account
80for the full Virtual Memory Size of programs used to recover. Otherwise,
81root may not be able to log in to recover the system.
82
83How do you calculate a minimum useful reserve?
84
85sshd or login + bash (or some other shell) + top (or ps, kill, etc.)
86
87For overcommit 'guess', we can sum resident set sizes (RSS).
88On x86_64 this is about 8MB.
89
90For overcommit 'never', we can take the max of their virtual sizes (VSZ)
91and add the sum of their RSS.
92On x86_64 this is about 128MB.
93
94Changing this takes effect whenever an application requests memory.
95
96==============================================================
97
db0fb184 98block_dump
1da177e4 99
db0fb184
PM
100block_dump enables block I/O debugging when set to a nonzero value. More
101information on block I/O debugging is in Documentation/laptops/laptop-mode.txt.
1da177e4
LT
102
103==============================================================
104
76ab0f53
MG
105compact_memory
106
107Available only when CONFIG_COMPACTION is set. When 1 is written to the file,
108all zones are compacted such that free memory is available in contiguous
109blocks where possible. This can be important for example in the allocation of
110huge pages although processes will also directly compact memory as required.
111
112==============================================================
113
5bbe3547
EM
114compact_unevictable_allowed
115
116Available only when CONFIG_COMPACTION is set. When set to 1, compaction is
117allowed to examine the unevictable lru (mlocked pages) for pages to compact.
118This should be used on systems where stalls for minor page faults are an
119acceptable trade for large contiguous free memory. Set to 0 to prevent
120compaction from moving pages that are unevictable. Default value is 1.
121
122==============================================================
123
db0fb184 124dirty_background_bytes
1da177e4 125
6601fac8
AB
126Contains the amount of dirty memory at which the background kernel
127flusher threads will start writeback.
1da177e4 128
abffc020
AR
129Note: dirty_background_bytes is the counterpart of dirty_background_ratio. Only
130one of them may be specified at a time. When one sysctl is written it is
131immediately taken into account to evaluate the dirty memory limits and the
132other appears as 0 when read.
1da177e4 133
db0fb184 134==============================================================
1da177e4 135
db0fb184 136dirty_background_ratio
1da177e4 137
715ea41e
ZL
138Contains, as a percentage of total available memory that contains free pages
139and reclaimable pages, the number of pages at which the background kernel
140flusher threads will start writing out dirty data.
141
d83e2a4e 142The total available memory is not equal to total system memory.
1da177e4 143
db0fb184 144==============================================================
1da177e4 145
db0fb184
PM
146dirty_bytes
147
148Contains the amount of dirty memory at which a process generating disk writes
149will itself start writeback.
150
abffc020
AR
151Note: dirty_bytes is the counterpart of dirty_ratio. Only one of them may be
152specified at a time. When one sysctl is written it is immediately taken into
153account to evaluate the dirty memory limits and the other appears as 0 when
154read.
1da177e4 155
9e4a5bda
AR
156Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
157value lower than this limit will be ignored and the old configuration will be
158retained.
159
1da177e4
LT
160==============================================================
161
db0fb184 162dirty_expire_centisecs
1da177e4 163
db0fb184 164This tunable is used to define when dirty data is old enough to be eligible
6601fac8
AB
165for writeout by the kernel flusher threads. It is expressed in 100'ths
166of a second. Data which has been dirty in-memory for longer than this
167interval will be written out next time a flusher thread wakes up.
db0fb184
PM
168
169==============================================================
170
171dirty_ratio
172
715ea41e
ZL
173Contains, as a percentage of total available memory that contains free pages
174and reclaimable pages, the number of pages at which a process which is
175generating disk writes will itself start writing out dirty data.
176
d83e2a4e 177The total available memory is not equal to total system memory.
1da177e4
LT
178
179==============================================================
180
db0fb184 181dirty_writeback_centisecs
1da177e4 182
6601fac8 183The kernel flusher threads will periodically wake up and write `old' data
db0fb184
PM
184out to disk. This tunable expresses the interval between those wakeups, in
185100'ths of a second.
1da177e4 186
db0fb184 187Setting this to zero disables periodic writeback altogether.
1da177e4
LT
188
189==============================================================
190
db0fb184 191drop_caches
1da177e4 192
5509a5d2
DH
193Writing to this will cause the kernel to drop clean caches, as well as
194reclaimable slab objects like dentries and inodes. Once dropped, their
195memory becomes free.
1da177e4 196
db0fb184
PM
197To free pagecache:
198 echo 1 > /proc/sys/vm/drop_caches
5509a5d2 199To free reclaimable slab objects (includes dentries and inodes):
db0fb184 200 echo 2 > /proc/sys/vm/drop_caches
5509a5d2 201To free slab objects and pagecache:
db0fb184 202 echo 3 > /proc/sys/vm/drop_caches
1da177e4 203
5509a5d2
DH
204This is a non-destructive operation and will not free any dirty objects.
205To increase the number of objects freed by this operation, the user may run
206`sync' prior to writing to /proc/sys/vm/drop_caches. This will minimize the
207number of dirty objects on the system and create more candidates to be
208dropped.
209
210This file is not a means to control the growth of the various kernel caches
211(inodes, dentries, pagecache, etc...) These objects are automatically
212reclaimed by the kernel when memory is needed elsewhere on the system.
213
214Use of this file can cause performance problems. Since it discards cached
215objects, it may cost a significant amount of I/O and CPU to recreate the
216dropped objects, especially if they were under heavy use. Because of this,
217use outside of a testing or debugging environment is not recommended.
218
219You may see informational messages in your kernel log when this file is
220used:
221
222 cat (1234): drop_caches: 3
223
224These are informational only. They do not mean that anything is wrong
225with your system. To disable them, echo 4 (bit 3) into drop_caches.
1da177e4
LT
226
227==============================================================
228
5e771905
MG
229extfrag_threshold
230
231This parameter affects whether the kernel will compact memory or direct
a10726bb
RV
232reclaim to satisfy a high-order allocation. The extfrag/extfrag_index file in
233debugfs shows what the fragmentation index for each order is in each zone in
234the system. Values tending towards 0 imply allocations would fail due to lack
235of memory, values towards 1000 imply failures are due to fragmentation and -1
236implies that the allocation will succeed as long as watermarks are met.
5e771905
MG
237
238The kernel will not compact memory in a zone if the
239fragmentation index is <= extfrag_threshold. The default value is 500.
240
241==============================================================
242
d09b6468
MH
243highmem_is_dirtyable
244
245Available only for systems with CONFIG_HIGHMEM enabled (32b systems).
246
247This parameter controls whether the high memory is considered for dirty
248writers throttling. This is not the case by default which means that
249only the amount of memory directly visible/usable by the kernel can
250be dirtied. As a result, on systems with a large amount of memory and
251lowmem basically depleted writers might be throttled too early and
252streaming writes can get very slow.
253
254Changing the value to non zero would allow more memory to be dirtied
255and thus allow writers to write more data which can be flushed to the
256storage more effectively. Note this also comes with a risk of pre-mature
257OOM killer because some writers (e.g. direct block device writes) can
258only use the low memory and they can fill it up with dirty data without
259any throttling.
260
261==============================================================
262
db0fb184 263hugepages_treat_as_movable
1da177e4 264
86cdb465
NH
265This parameter controls whether we can allocate hugepages from ZONE_MOVABLE
266or not. If set to non-zero, hugepages can be allocated from ZONE_MOVABLE.
267ZONE_MOVABLE is created when kernel boot parameter kernelcore= is specified,
268so this parameter has no effect if used without kernelcore=.
269
270Hugepage migration is now available in some situations which depend on the
271architecture and/or the hugepage size. If a hugepage supports migration,
272allocation from ZONE_MOVABLE is always enabled for the hugepage regardless
273of the value of this parameter.
274IOW, this parameter affects only non-migratable hugepages.
275
276Assuming that hugepages are not migratable in your system, one usecase of
277this parameter is that users can make hugepage pool more extensible by
278enabling the allocation from ZONE_MOVABLE. This is because on ZONE_MOVABLE
279page reclaim/migration/compaction work more and you can get contiguous
280memory more likely. Note that using ZONE_MOVABLE for non-migratable
281hugepages can do harm to other features like memory hotremove (because
282memory hotremove expects that memory blocks on ZONE_MOVABLE are always
283removable,) so it's a trade-off responsible for the users.
24950898 284
8ad4b1fb
RS
285==============================================================
286
db0fb184 287hugetlb_shm_group
8ad4b1fb 288
db0fb184
PM
289hugetlb_shm_group contains group id that is allowed to create SysV
290shared memory segment using hugetlb page.
8ad4b1fb 291
db0fb184 292==============================================================
8ad4b1fb 293
db0fb184 294laptop_mode
1743660b 295
db0fb184
PM
296laptop_mode is a knob that controls "laptop mode". All the things that are
297controlled by this knob are discussed in Documentation/laptops/laptop-mode.txt.
1743660b 298
db0fb184 299==============================================================
1743660b 300
db0fb184 301legacy_va_layout
1b2ffb78 302
2174efb6 303If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
db0fb184 304will use the legacy (2.4) layout for all processes.
1b2ffb78 305
db0fb184 306==============================================================
1b2ffb78 307
db0fb184
PM
308lowmem_reserve_ratio
309
310For some specialised workloads on highmem machines it is dangerous for
311the kernel to allow process memory to be allocated from the "lowmem"
312zone. This is because that memory could then be pinned via the mlock()
313system call, or by unavailability of swapspace.
314
315And on large highmem machines this lack of reclaimable lowmem memory
316can be fatal.
317
318So the Linux page allocator has a mechanism which prevents allocations
319which _could_ use highmem from using too much lowmem. This means that
320a certain amount of lowmem is defended from the possibility of being
321captured into pinned user memory.
322
323(The same argument applies to the old 16 megabyte ISA DMA region. This
324mechanism will also defend that region from allocations which could use
325highmem or lowmem).
326
327The `lowmem_reserve_ratio' tunable determines how aggressive the kernel is
328in defending these lower zones.
329
330If you have a machine which uses highmem or ISA DMA and your
331applications are using mlock(), or if you are running with no swap then
332you probably should change the lowmem_reserve_ratio setting.
333
334The lowmem_reserve_ratio is an array. You can see them by reading this file.
335-
336% cat /proc/sys/vm/lowmem_reserve_ratio
337256 256 32
338-
339Note: # of this elements is one fewer than number of zones. Because the highest
340 zone's value is not necessary for following calculation.
341
342But, these values are not used directly. The kernel calculates # of protection
343pages for each zones from them. These are shown as array of protection pages
344in /proc/zoneinfo like followings. (This is an example of x86-64 box).
345Each zone has an array of protection pages like this.
346
347-
348Node 0, zone DMA
349 pages free 1355
350 min 3
351 low 3
352 high 4
353 :
354 :
355 numa_other 0
356 protection: (0, 2004, 2004, 2004)
357 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
358 pagesets
359 cpu: 0 pcp: 0
360 :
361-
362These protections are added to score to judge whether this zone should be used
363for page allocation or should be reclaimed.
364
365In this example, if normal pages (index=2) are required to this DMA zone and
41858966
MG
366watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
367not be used because pages_free(1355) is smaller than watermark + protection[2]
db0fb184
PM
368(4 + 2004 = 2008). If this protection value is 0, this zone would be used for
369normal page requirement. If requirement is DMA zone(index=0), protection[0]
370(=0) is used.
371
372zone[i]'s protection[j] is calculated by following expression.
373
374(i < j):
375 zone[i]->protection[j]
013110a7 376 = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
db0fb184
PM
377 / lowmem_reserve_ratio[i];
378(i = j):
379 (should not be protected. = 0;
380(i > j):
381 (not necessary, but looks 0)
382
383The default values of lowmem_reserve_ratio[i] are
384 256 (if zone[i] means DMA or DMA32 zone)
385 32 (others).
386As above expression, they are reciprocal number of ratio.
013110a7 387256 means 1/256. # of protection pages becomes about "0.39%" of total managed
db0fb184
PM
388pages of higher zones on the node.
389
390If you would like to protect more pages, smaller values are effective.
391The minimum value is 1 (1/1 -> 100%).
1b2ffb78 392
db0fb184 393==============================================================
1b2ffb78 394
db0fb184 395max_map_count:
1743660b 396
db0fb184
PM
397This file contains the maximum number of memory map areas a process
398may have. Memory map areas are used as a side-effect of calling
def5efe0
DR
399malloc, directly by mmap, mprotect, and madvise, and also when loading
400shared libraries.
1743660b 401
db0fb184
PM
402While most applications need less than a thousand maps, certain
403programs, particularly malloc debuggers, may consume lots of them,
404e.g., up to one or two maps per allocation.
fadd8fbd 405
db0fb184 406The default value is 65536.
9614634f 407
6a46079c
AK
408=============================================================
409
410memory_failure_early_kill:
411
412Control how to kill processes when uncorrected memory error (typically
413a 2bit error in a memory module) is detected in the background by hardware
414that cannot be handled by the kernel. In some cases (like the page
415still having a valid copy on disk) the kernel will handle the failure
416transparently without affecting any applications. But if there is
417no other uptodate copy of the data it will kill to prevent any data
418corruptions from propagating.
419
4201: Kill all processes that have the corrupted and not reloadable page mapped
421as soon as the corruption is detected. Note this is not supported
422for a few types of pages, like kernel internally allocated data or
423the swap cache, but works for the majority of user pages.
424
4250: Only unmap the corrupted page from all processes and only kill a process
426who tries to access it.
427
428The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
429handle this if they want to.
430
431This is only active on architectures/platforms with advanced machine
432check handling and depends on the hardware capabilities.
433
434Applications can override this setting individually with the PR_MCE_KILL prctl
435
436==============================================================
437
438memory_failure_recovery
439
440Enable memory failure recovery (when supported by the platform)
441
4421: Attempt recovery.
443
4440: Always panic on a memory failure.
445
db0fb184 446==============================================================
9614634f 447
db0fb184 448min_free_kbytes:
9614634f 449
db0fb184 450This is used to force the Linux VM to keep a minimum number
41858966
MG
451of kilobytes free. The VM uses this number to compute a
452watermark[WMARK_MIN] value for each lowmem zone in the system.
453Each lowmem zone gets a number of reserved free pages based
454proportionally on its size.
db0fb184
PM
455
456Some minimal amount of memory is needed to satisfy PF_MEMALLOC
457allocations; if you set this to lower than 1024KB, your system will
458become subtly broken, and prone to deadlock under high loads.
459
460Setting this too high will OOM your machine instantly.
9614634f
CL
461
462=============================================================
463
0ff38490
CL
464min_slab_ratio:
465
466This is available only on NUMA kernels.
467
468A percentage of the total pages in each zone. On Zone reclaim
469(fallback from the local zone occurs) slabs will be reclaimed if more
470than this percentage of pages in a zone are reclaimable slab pages.
471This insures that the slab growth stays under control even in NUMA
472systems that rarely perform global reclaim.
473
474The default is 5 percent.
475
476Note that slab reclaim is triggered in a per zone / node fashion.
477The process of reclaiming slab memory is currently not node specific
478and may not be fast.
479
480=============================================================
481
db0fb184 482min_unmapped_ratio:
fadd8fbd 483
db0fb184 484This is available only on NUMA kernels.
fadd8fbd 485
90afa5de
MG
486This is a percentage of the total pages in each zone. Zone reclaim will
487only occur if more than this percentage of pages are in a state that
488zone_reclaim_mode allows to be reclaimed.
489
490If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
491against all file-backed unmapped pages including swapcache pages and tmpfs
492files. Otherwise, only unmapped pages backed by normal files but not tmpfs
493files and similar are considered.
2b744c01 494
db0fb184 495The default is 1 percent.
fadd8fbd 496
db0fb184 497==============================================================
2b744c01 498
db0fb184 499mmap_min_addr
ed032189 500
db0fb184 501This file indicates the amount of address space which a user process will
af901ca1 502be restricted from mmapping. Since kernel null dereference bugs could
db0fb184
PM
503accidentally operate based on the information in the first couple of pages
504of memory userspace processes should not be allowed to write to them. By
505default this value is set to 0 and no protections will be enforced by the
506security module. Setting this value to something like 64k will allow the
507vast majority of applications to work correctly and provide defense in depth
508against future potential kernel bugs.
fe071d7e 509
db0fb184 510==============================================================
fef1bdd6 511
d07e2259
DC
512mmap_rnd_bits:
513
514This value can be used to select the number of bits to use to
515determine the random offset to the base address of vma regions
516resulting from mmap allocations on architectures which support
517tuning address space randomization. This value will be bounded
518by the architecture's minimum and maximum supported values.
519
520This value can be changed after boot using the
521/proc/sys/vm/mmap_rnd_bits tunable
522
523==============================================================
524
525mmap_rnd_compat_bits:
526
527This value can be used to select the number of bits to use to
528determine the random offset to the base address of vma regions
529resulting from mmap allocations for applications run in
530compatibility mode on architectures which support tuning address
531space randomization. This value will be bounded by the
532architecture's minimum and maximum supported values.
533
534This value can be changed after boot using the
535/proc/sys/vm/mmap_rnd_compat_bits tunable
536
537==============================================================
538
db0fb184 539nr_hugepages
fef1bdd6 540
db0fb184 541Change the minimum size of the hugepage pool.
fef1bdd6 542
db0fb184 543See Documentation/vm/hugetlbpage.txt
fef1bdd6 544
db0fb184 545==============================================================
fef1bdd6 546
db0fb184 547nr_overcommit_hugepages
fef1bdd6 548
db0fb184
PM
549Change the maximum size of the hugepage pool. The maximum is
550nr_hugepages + nr_overcommit_hugepages.
fe071d7e 551
db0fb184 552See Documentation/vm/hugetlbpage.txt
fe071d7e 553
db0fb184 554==============================================================
fe071d7e 555
db0fb184 556nr_trim_pages
ed032189 557
db0fb184
PM
558This is available only on NOMMU kernels.
559
560This value adjusts the excess page trimming behaviour of power-of-2 aligned
561NOMMU mmap allocations.
562
563A value of 0 disables trimming of allocations entirely, while a value of 1
564trims excess pages aggressively. Any value >= 1 acts as the watermark where
565trimming of allocations is initiated.
566
567The default value is 1.
568
569See Documentation/nommu-mmap.txt for more information.
ed032189 570
f0c0b2b8
KH
571==============================================================
572
573numa_zonelist_order
574
c9bff3ee
MH
575This sysctl is only for NUMA and it is deprecated. Anything but
576Node order will fail!
577
f0c0b2b8
KH
578'where the memory is allocated from' is controlled by zonelists.
579(This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
580 you may be able to read ZONE_DMA as ZONE_DMA32...)
581
582In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
583ZONE_NORMAL -> ZONE_DMA
584This means that a memory allocation request for GFP_KERNEL will
585get memory from ZONE_DMA only when ZONE_NORMAL is not available.
586
587In NUMA case, you can think of following 2 types of order.
588Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
589
590(A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
591(B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
592
593Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
594will be used before ZONE_NORMAL exhaustion. This increases possibility of
595out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
596
597Type(B) cannot offer the best locality but is more robust against OOM of
598the DMA zone.
599
600Type(A) is called as "Node" order. Type (B) is "Zone" order.
601
602"Node order" orders the zonelists by node, then by zone within each node.
5a3016a6 603Specify "[Nn]ode" for node order
f0c0b2b8
KH
604
605"Zone Order" orders the zonelists by zone type, then by node within each
5a3016a6 606zone. Specify "[Zz]one" for zone order.
f0c0b2b8 607
7c88a292
XQ
608Specify "[Dd]efault" to request automatic configuration.
609
610On 32-bit, the Normal zone needs to be preserved for allocations accessible
611by the kernel, so "zone" order will be selected.
612
613On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
614order will be selected.
615
616Default order is recommended unless this is causing problems for your
617system/application.
d5dbac87
NA
618
619==============================================================
620
db0fb184 621oom_dump_tasks
d5dbac87 622
dc6c9a35
KS
623Enables a system-wide task dump (excluding kernel threads) to be produced
624when the kernel performs an OOM-killing and includes such information as
625pid, uid, tgid, vm size, rss, nr_ptes, nr_pmds, swapents, oom_score_adj
626score, and name. This is helpful to determine why the OOM killer was
627invoked, to identify the rogue task that caused it, and to determine why
628the OOM killer chose the task it did to kill.
d5dbac87 629
db0fb184
PM
630If this is set to zero, this information is suppressed. On very
631large systems with thousands of tasks it may not be feasible to dump
632the memory state information for each one. Such systems should not
633be forced to incur a performance penalty in OOM conditions when the
634information may not be desired.
635
636If this is set to non-zero, this information is shown whenever the
637OOM killer actually kills a memory-hogging task.
638
ad915c43 639The default value is 1 (enabled).
d5dbac87
NA
640
641==============================================================
642
db0fb184 643oom_kill_allocating_task
d5dbac87 644
db0fb184
PM
645This enables or disables killing the OOM-triggering task in
646out-of-memory situations.
d5dbac87 647
db0fb184
PM
648If this is set to zero, the OOM killer will scan through the entire
649tasklist and select a task based on heuristics to kill. This normally
650selects a rogue memory-hogging task that frees up a large amount of
651memory when killed.
652
653If this is set to non-zero, the OOM killer simply kills the task that
654triggered the out-of-memory condition. This avoids the expensive
655tasklist scan.
656
657If panic_on_oom is selected, it takes precedence over whatever value
658is used in oom_kill_allocating_task.
659
660The default value is 0.
dd8632a1
PM
661
662==============================================================
663
49f0ce5f
JM
664overcommit_kbytes:
665
666When overcommit_memory is set to 2, the committed address space is not
667permitted to exceed swap plus this amount of physical RAM. See below.
668
669Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
670of them may be specified at a time. Setting one disables the other (which
671then appears as 0 when read).
672
673==============================================================
674
db0fb184 675overcommit_memory:
dd8632a1 676
db0fb184 677This value contains a flag that enables memory overcommitment.
dd8632a1 678
db0fb184
PM
679When this flag is 0, the kernel attempts to estimate the amount
680of free memory left when userspace requests more memory.
dd8632a1 681
db0fb184
PM
682When this flag is 1, the kernel pretends there is always enough
683memory until it actually runs out.
dd8632a1 684
db0fb184
PM
685When this flag is 2, the kernel uses a "never overcommit"
686policy that attempts to prevent any overcommit of memory.
c9b1d098 687Note that user_reserve_kbytes affects this policy.
dd8632a1 688
db0fb184
PM
689This feature can be very useful because there are a lot of
690programs that malloc() huge amounts of memory "just-in-case"
691and don't use much of it.
692
693The default value is 0.
694
695See Documentation/vm/overcommit-accounting and
c56050c7 696mm/mmap.c::__vm_enough_memory() for more information.
db0fb184
PM
697
698==============================================================
699
700overcommit_ratio:
701
702When overcommit_memory is set to 2, the committed address
703space is not permitted to exceed swap plus this percentage
704of physical RAM. See above.
705
706==============================================================
707
708page-cluster
709
df858fa8
CE
710page-cluster controls the number of pages up to which consecutive pages
711are read in from swap in a single attempt. This is the swap counterpart
712to page cache readahead.
713The mentioned consecutivity is not in terms of virtual/physical addresses,
714but consecutive on swap space - that means they were swapped out together.
db0fb184
PM
715
716It is a logarithmic value - setting it to zero means "1 page", setting
717it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
df858fa8 718Zero disables swap readahead completely.
db0fb184
PM
719
720The default value is three (eight pages at a time). There may be some
721small benefits in tuning this to a different value if your workload is
722swap-intensive.
723
df858fa8
CE
724Lower values mean lower latencies for initial faults, but at the same time
725extra faults and I/O delays for following faults if they would have been part of
726that consecutive pages readahead would have brought in.
727
db0fb184
PM
728=============================================================
729
730panic_on_oom
731
732This enables or disables panic on out-of-memory feature.
733
734If this is set to 0, the kernel will kill some rogue process,
735called oom_killer. Usually, oom_killer can kill rogue processes and
736system will survive.
737
738If this is set to 1, the kernel panics when out-of-memory happens.
739However, if a process limits using nodes by mempolicy/cpusets,
740and those nodes become memory exhaustion status, one process
741may be killed by oom-killer. No panic occurs in this case.
742Because other nodes' memory may be free. This means system total status
743may be not fatal yet.
744
745If this is set to 2, the kernel panics compulsorily even on the
daaf1e68
KH
746above-mentioned. Even oom happens under memory cgroup, the whole
747system panics.
db0fb184
PM
748
749The default value is 0.
7501 and 2 are for failover of clustering. Please select either
751according to your policy of failover.
daaf1e68
KH
752panic_on_oom=2+kdump gives you very strong tool to investigate
753why oom happens. You can get snapshot.
db0fb184
PM
754
755=============================================================
756
757percpu_pagelist_fraction
758
759This is the fraction of pages at most (high mark pcp->high) in each zone that
760are allocated for each per cpu page list. The min value for this is 8. It
761means that we don't allow more than 1/8th of pages in each zone to be
762allocated in any single per_cpu_pagelist. This entry only changes the value
763of hot per cpu pagelists. User can specify a number like 100 to allocate
7641/100th of each zone to each per cpu page list.
765
766The batch value of each per cpu pagelist is also updated as a result. It is
767set to pcp->high/4. The upper limit of batch is (PAGE_SHIFT * 8)
768
769The initial value is zero. Kernel does not use this value at boot time to set
7cd2b0a3
DR
770the high water marks for each per cpu page list. If the user writes '0' to this
771sysctl, it will revert to this default behavior.
db0fb184
PM
772
773==============================================================
774
775stat_interval
776
777The time interval between which vm statistics are updated. The default
778is 1 second.
779
780==============================================================
781
52b6f46b
HD
782stat_refresh
783
784Any read or write (by root only) flushes all the per-cpu vm statistics
785into their global totals, for more accurate reports when testing
786e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
787
788As a side-effect, it also checks for negative totals (elsewhere reported
789as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
790(At time of writing, a few stats are known sometimes to be found negative,
791with no ill effects: errors and warnings on these stats are suppressed.)
792
793==============================================================
794
db0fb184
PM
795swappiness
796
797This control is used to define how aggressive the kernel will swap
798memory pages. Higher values will increase agressiveness, lower values
8582cb96
AT
799decrease the amount of swap. A value of 0 instructs the kernel not to
800initiate swap until the amount of free and file-backed pages is less
801than the high water mark in a zone.
db0fb184
PM
802
803The default value is 60.
804
805==============================================================
806
c9b1d098
AS
807- user_reserve_kbytes
808
633708a4 809When overcommit_memory is set to 2, "never overcommit" mode, reserve
c9b1d098
AS
810min(3% of current process size, user_reserve_kbytes) of free memory.
811This is intended to prevent a user from starting a single memory hogging
812process, such that they cannot recover (kill the hog).
813
814user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
815
816If this is reduced to zero, then the user will be allowed to allocate
817all free memory with a single process, minus admin_reserve_kbytes.
818Any subsequent attempts to execute a command will result in
819"fork: Cannot allocate memory".
820
821Changing this takes effect whenever an application requests memory.
822
823==============================================================
824
db0fb184
PM
825vfs_cache_pressure
826------------------
827
4a0da71b
DV
828This percentage value controls the tendency of the kernel to reclaim
829the memory which is used for caching of directory and inode objects.
db0fb184
PM
830
831At the default value of vfs_cache_pressure=100 the kernel will attempt to
832reclaim dentries and inodes at a "fair" rate with respect to pagecache and
833swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
55c37a84
JK
834to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
835never reclaim dentries and inodes due to memory pressure and this can easily
836lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
db0fb184
PM
837causes the kernel to prefer to reclaim dentries and inodes.
838
4a0da71b
DV
839Increasing vfs_cache_pressure significantly beyond 100 may have negative
840performance impact. Reclaim code needs to take various locks to find freeable
841directory and inode objects. With vfs_cache_pressure=1000, it will look for
842ten times more freeable objects than there are.
843
795ae7a0
JW
844=============================================================
845
846watermark_scale_factor:
847
848This factor controls the aggressiveness of kswapd. It defines the
849amount of memory left in a node/system before kswapd is woken up and
850how much memory needs to be free before kswapd goes back to sleep.
851
852The unit is in fractions of 10,000. The default value of 10 means the
853distances between watermarks are 0.1% of the available memory in the
854node/system. The maximum value is 1000, or 10% of memory.
855
856A high rate of threads entering direct reclaim (allocstall) or kswapd
857going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
858that the number of free pages kswapd maintains for latency reasons is
859too small for the allocation bursts occurring in the system. This knob
860can then be used to tune kswapd aggressiveness accordingly.
861
db0fb184
PM
862==============================================================
863
864zone_reclaim_mode:
865
866Zone_reclaim_mode allows someone to set more or less aggressive approaches to
867reclaim memory when a zone runs out of memory. If it is set to zero then no
868zone reclaim occurs. Allocations will be satisfied from other zones / nodes
869in the system.
870
871This is value ORed together of
872
8731 = Zone reclaim on
8742 = Zone reclaim writes dirty pages out
8754 = Zone reclaim swaps pages
876
4f9b16a6
MG
877zone_reclaim_mode is disabled by default. For file servers or workloads
878that benefit from having their data cached, zone_reclaim_mode should be
879left disabled as the caching effect is likely to be more important than
db0fb184
PM
880data locality.
881
4f9b16a6
MG
882zone_reclaim may be enabled if it's known that the workload is partitioned
883such that each partition fits within a NUMA node and that accessing remote
884memory would cause a measurable performance reduction. The page allocator
885will then reclaim easily reusable pages (those page cache pages that are
886currently not used) before allocating off node pages.
887
db0fb184
PM
888Allowing zone reclaim to write out pages stops processes that are
889writing large amounts of data from dirtying pages on other nodes. Zone
890reclaim will write out dirty pages if a zone fills up and so effectively
891throttle the process. This may decrease the performance of a single process
892since it cannot use all of system memory to buffer the outgoing writes
893anymore but it preserve the memory on other nodes so that the performance
894of other processes running on other nodes will not be affected.
895
896Allowing regular swap effectively restricts allocations to the local
897node unless explicitly overridden by memory policies or cpuset
898configurations.
899
900============ End of Document =================================