blob: ff234d229cbbc581ec53a41dcc7725565d0747d4 [file] [log] [blame]
Peter W Morrealedb0fb182009-01-15 13:50:42 -08001Documentation for /proc/sys/vm/* kernel version 2.6.29
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 (c) 1998, 1999, Rik van Riel <riel@nl.linux.org>
Peter W Morrealedb0fb182009-01-15 13:50:42 -08003 (c) 2008 Peter W. Morreale <pmorreale@novell.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
5For general info and legal blurb, please look in README.
6
7==============================================================
8
9This file contains the documentation for the sysctl files in
Peter W Morrealedb0fb182009-01-15 13:50:42 -080010/proc/sys/vm and is valid for Linux kernel version 2.6.29.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
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:
Peter W Morrealedb0fb182009-01-15 13:50:42 -080020
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070021- admin_reserve_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080022- block_dump
Mel Gorman76ab0f52010-05-24 14:32:28 -070023- compact_memory
Eric B Munson5bbe3542015-04-15 16:13:20 -070024- compact_unevictable_allowed
Peter W Morrealedb0fb182009-01-15 13:50:42 -080025- dirty_background_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -070026- dirty_background_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080027- dirty_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -070028- dirty_expire_centisecs
Peter W Morrealedb0fb182009-01-15 13:50:42 -080029- dirty_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -070030- dirty_writeback_centisecs
Peter W Morrealedb0fb182009-01-15 13:50:42 -080031- drop_caches
Mel Gorman5e771902010-05-24 14:32:31 -070032- extfrag_threshold
Peter W Morrealedb0fb182009-01-15 13:50:42 -080033- hugetlb_shm_group
34- laptop_mode
35- legacy_va_layout
36- lowmem_reserve_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -070037- max_map_count
Andi Kleen6a460792009-09-16 11:50:15 +020038- memory_failure_early_kill
39- memory_failure_recovery
Linus Torvalds1da177e2005-04-16 15:20:36 -070040- min_free_kbytes
Christoph Lameter0ff38492006-09-25 23:31:52 -070041- min_slab_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080042- min_unmapped_ratio
43- mmap_min_addr
Daniel Cashmand07e2252016-01-14 15:19:53 -080044- mmap_rnd_bits
45- mmap_rnd_compat_bits
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -080046- nr_hugepages
47- nr_overcommit_hugepages
Peter W Morrealedb0fb182009-01-15 13:50:42 -080048- nr_trim_pages (only if CONFIG_MMU=n)
49- numa_zonelist_order
50- oom_dump_tasks
51- oom_kill_allocating_task
Jerome Marchand49f0ce52014-01-21 15:49:14 -080052- overcommit_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080053- overcommit_memory
54- overcommit_ratio
55- page-cluster
56- panic_on_oom
57- percpu_pagelist_fraction
58- stat_interval
Hugh Dickins52b6f462016-05-19 17:12:50 -070059- stat_refresh
Kemi Wang45180852017-11-15 17:38:22 -080060- numa_stat
Peter W Morrealedb0fb182009-01-15 13:50:42 -080061- swappiness
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -070062- user_reserve_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080063- vfs_cache_pressure
Jerome Marchande6507a02016-07-12 12:05:59 +020064- watermark_scale_factor
Peter W Morrealedb0fb182009-01-15 13:50:42 -080065- zone_reclaim_mode
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067==============================================================
68
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070069admin_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
Peter W Morrealedb0fb182009-01-15 13:50:42 -080098block_dump
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800100block_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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103==============================================================
104
Mel Gorman76ab0f52010-05-24 14:32:28 -0700105compact_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
Eric B Munson5bbe3542015-04-15 16:13:20 -0700114compact_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
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800124dirty_background_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300126Contains the amount of dirty memory at which the background kernel
127flusher threads will start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Andrea Righiabffc022010-10-27 15:33:31 -0700129Note: 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134==============================================================
135
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800136dirty_background_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Zheng Liu715ea412013-11-12 15:08:30 -0800138Contains, 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
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000142The total available memory is not equal to total system memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144==============================================================
145
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800146dirty_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800148Contains the amount of dirty memory at which a process generating disk writes
149will itself start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Andrea Righiabffc022010-10-27 15:33:31 -0700151Note: 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.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800155
Andrea Righi9e4a5bd2009-04-30 15:08:57 -0700156Note: 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
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800160==============================================================
161
162dirty_expire_centisecs
163
164This tunable is used to define when dirty data is old enough to be eligible
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300165for 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.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800168
169==============================================================
170
171dirty_ratio
172
Zheng Liu715ea412013-11-12 15:08:30 -0800173Contains, 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
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000177The total available memory is not equal to total system memory.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800178
179==============================================================
180
181dirty_writeback_centisecs
182
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300183The kernel flusher threads will periodically wake up and write `old' data
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800184out to disk. This tunable expresses the interval between those wakeups, in
185100'ths of a second.
186
187Setting this to zero disables periodic writeback altogether.
188
189==============================================================
190
191drop_caches
192
Dave Hansen5509a5d2014-04-03 14:48:19 -0700193Writing 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.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800196
197To free pagecache:
198 echo 1 > /proc/sys/vm/drop_caches
Dave Hansen5509a5d2014-04-03 14:48:19 -0700199To free reclaimable slab objects (includes dentries and inodes):
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800200 echo 2 > /proc/sys/vm/drop_caches
Dave Hansen5509a5d2014-04-03 14:48:19 -0700201To free slab objects and pagecache:
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800202 echo 3 > /proc/sys/vm/drop_caches
203
Dave Hansen5509a5d2014-04-03 14:48:19 -0700204This 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.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800226
227==============================================================
228
Mel Gorman5e771902010-05-24 14:32:31 -0700229extfrag_threshold
230
231This parameter affects whether the kernel will compact memory or direct
Rabin Vincenta10726b2015-07-14 07:35:11 +0200232reclaim 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.
Mel Gorman5e771902010-05-24 14:32:31 -0700237
238The kernel will not compact memory in a zone if the
239fragmentation index is <= extfrag_threshold. The default value is 500.
240
241==============================================================
242
Michal Hockod09b6462017-07-10 15:49:38 -0700243highmem_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
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800263hugetlb_shm_group
264
265hugetlb_shm_group contains group id that is allowed to create SysV
266shared memory segment using hugetlb page.
267
268==============================================================
269
270laptop_mode
271
272laptop_mode is a knob that controls "laptop mode". All the things that are
273controlled by this knob are discussed in Documentation/laptops/laptop-mode.txt.
274
275==============================================================
276
277legacy_va_layout
278
Kulikov Vasiliy2174efb2010-06-28 13:59:28 +0200279If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800280will use the legacy (2.4) layout for all processes.
281
282==============================================================
283
284lowmem_reserve_ratio
285
286For some specialised workloads on highmem machines it is dangerous for
287the kernel to allow process memory to be allocated from the "lowmem"
288zone. This is because that memory could then be pinned via the mlock()
289system call, or by unavailability of swapspace.
290
291And on large highmem machines this lack of reclaimable lowmem memory
292can be fatal.
293
294So the Linux page allocator has a mechanism which prevents allocations
295which _could_ use highmem from using too much lowmem. This means that
296a certain amount of lowmem is defended from the possibility of being
297captured into pinned user memory.
298
299(The same argument applies to the old 16 megabyte ISA DMA region. This
300mechanism will also defend that region from allocations which could use
301highmem or lowmem).
302
303The `lowmem_reserve_ratio' tunable determines how aggressive the kernel is
304in defending these lower zones.
305
306If you have a machine which uses highmem or ISA DMA and your
307applications are using mlock(), or if you are running with no swap then
308you probably should change the lowmem_reserve_ratio setting.
309
310The lowmem_reserve_ratio is an array. You can see them by reading this file.
311-
312% cat /proc/sys/vm/lowmem_reserve_ratio
313256 256 32
314-
315Note: # of this elements is one fewer than number of zones. Because the highest
316 zone's value is not necessary for following calculation.
317
318But, these values are not used directly. The kernel calculates # of protection
319pages for each zones from them. These are shown as array of protection pages
320in /proc/zoneinfo like followings. (This is an example of x86-64 box).
321Each zone has an array of protection pages like this.
322
323-
324Node 0, zone DMA
325 pages free 1355
326 min 3
327 low 3
328 high 4
329 :
330 :
331 numa_other 0
332 protection: (0, 2004, 2004, 2004)
333 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
334 pagesets
335 cpu: 0 pcp: 0
336 :
337-
338These protections are added to score to judge whether this zone should be used
339for page allocation or should be reclaimed.
340
341In this example, if normal pages (index=2) are required to this DMA zone and
Mel Gorman41858962009-06-16 15:32:12 -0700342watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
343not be used because pages_free(1355) is smaller than watermark + protection[2]
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800344(4 + 2004 = 2008). If this protection value is 0, this zone would be used for
345normal page requirement. If requirement is DMA zone(index=0), protection[0]
346(=0) is used.
347
348zone[i]'s protection[j] is calculated by following expression.
349
350(i < j):
351 zone[i]->protection[j]
Yaowei Bai013110a2015-09-08 15:04:10 -0700352 = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800353 / lowmem_reserve_ratio[i];
354(i = j):
355 (should not be protected. = 0;
356(i > j):
357 (not necessary, but looks 0)
358
359The default values of lowmem_reserve_ratio[i] are
360 256 (if zone[i] means DMA or DMA32 zone)
361 32 (others).
362As above expression, they are reciprocal number of ratio.
Yaowei Bai013110a2015-09-08 15:04:10 -0700363256 means 1/256. # of protection pages becomes about "0.39%" of total managed
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800364pages of higher zones on the node.
365
366If you would like to protect more pages, smaller values are effective.
367The minimum value is 1 (1/1 -> 100%).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
369==============================================================
370
371max_map_count:
372
373This file contains the maximum number of memory map areas a process
374may have. Memory map areas are used as a side-effect of calling
David Rientjesdef5efe2017-02-24 14:58:47 -0800375malloc, directly by mmap, mprotect, and madvise, and also when loading
376shared libraries.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378While most applications need less than a thousand maps, certain
379programs, particularly malloc debuggers, may consume lots of them,
380e.g., up to one or two maps per allocation.
381
382The default value is 65536.
383
Andi Kleen6a460792009-09-16 11:50:15 +0200384=============================================================
385
386memory_failure_early_kill:
387
388Control how to kill processes when uncorrected memory error (typically
389a 2bit error in a memory module) is detected in the background by hardware
390that cannot be handled by the kernel. In some cases (like the page
391still having a valid copy on disk) the kernel will handle the failure
392transparently without affecting any applications. But if there is
393no other uptodate copy of the data it will kill to prevent any data
394corruptions from propagating.
395
3961: Kill all processes that have the corrupted and not reloadable page mapped
397as soon as the corruption is detected. Note this is not supported
398for a few types of pages, like kernel internally allocated data or
399the swap cache, but works for the majority of user pages.
400
4010: Only unmap the corrupted page from all processes and only kill a process
402who tries to access it.
403
404The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
405handle this if they want to.
406
407This is only active on architectures/platforms with advanced machine
408check handling and depends on the hardware capabilities.
409
410Applications can override this setting individually with the PR_MCE_KILL prctl
411
412==============================================================
413
414memory_failure_recovery
415
416Enable memory failure recovery (when supported by the platform)
417
4181: Attempt recovery.
419
4200: Always panic on a memory failure.
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422==============================================================
423
424min_free_kbytes:
425
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800426This is used to force the Linux VM to keep a minimum number
Mel Gorman41858962009-06-16 15:32:12 -0700427of kilobytes free. The VM uses this number to compute a
428watermark[WMARK_MIN] value for each lowmem zone in the system.
429Each lowmem zone gets a number of reserved free pages based
430proportionally on its size.
Rohit Seth8ad4b1f2006-01-08 01:00:40 -0800431
Matt LaPlanted9195882008-07-25 19:45:33 -0700432Some minimal amount of memory is needed to satisfy PF_MEMALLOC
Pavel Machek24950892007-10-16 23:31:28 -0700433allocations; if you set this to lower than 1024KB, your system will
434become subtly broken, and prone to deadlock under high loads.
435
436Setting this too high will OOM your machine instantly.
437
Christoph Lameter96146342006-07-03 00:24:13 -0700438=============================================================
439
Christoph Lameter0ff38492006-09-25 23:31:52 -0700440min_slab_ratio:
441
442This is available only on NUMA kernels.
443
444A percentage of the total pages in each zone. On Zone reclaim
445(fallback from the local zone occurs) slabs will be reclaimed if more
446than this percentage of pages in a zone are reclaimable slab pages.
447This insures that the slab growth stays under control even in NUMA
448systems that rarely perform global reclaim.
449
450The default is 5 percent.
451
452Note that slab reclaim is triggered in a per zone / node fashion.
453The process of reclaiming slab memory is currently not node specific
454and may not be fast.
455
456=============================================================
457
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800458min_unmapped_ratio:
KAMEZAWA Hiroyukifadd8fb2006-06-23 02:03:13 -0700459
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800460This is available only on NUMA kernels.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700461
Mel Gorman90afa5d2009-06-16 15:33:20 -0700462This is a percentage of the total pages in each zone. Zone reclaim will
463only occur if more than this percentage of pages are in a state that
464zone_reclaim_mode allows to be reclaimed.
465
466If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
467against all file-backed unmapped pages including swapcache pages and tmpfs
468files. Otherwise, only unmapped pages backed by normal files but not tmpfs
469files and similar are considered.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700470
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800471The default is 1 percent.
David Rientjesfe071d72007-10-16 23:25:56 -0700472
Eric Parised032182007-06-28 15:55:21 -0400473==============================================================
474
475mmap_min_addr
476
477This file indicates the amount of address space which a user process will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200478be restricted from mmapping. Since kernel null dereference bugs could
Eric Parised032182007-06-28 15:55:21 -0400479accidentally operate based on the information in the first couple of pages
480of memory userspace processes should not be allowed to write to them. By
481default this value is set to 0 and no protections will be enforced by the
482security module. Setting this value to something like 64k will allow the
483vast majority of applications to work correctly and provide defense in depth
484against future potential kernel bugs.
485
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700486==============================================================
487
Daniel Cashmand07e2252016-01-14 15:19:53 -0800488mmap_rnd_bits:
489
490This value can be used to select the number of bits to use to
491determine the random offset to the base address of vma regions
492resulting from mmap allocations on architectures which support
493tuning address space randomization. This value will be bounded
494by the architecture's minimum and maximum supported values.
495
496This value can be changed after boot using the
497/proc/sys/vm/mmap_rnd_bits tunable
498
499==============================================================
500
501mmap_rnd_compat_bits:
502
503This value can be used to select the number of bits to use to
504determine the random offset to the base address of vma regions
505resulting from mmap allocations for applications run in
506compatibility mode on architectures which support tuning address
507space randomization. This value will be bounded by the
508architecture's minimum and maximum supported values.
509
510This value can be changed after boot using the
511/proc/sys/vm/mmap_rnd_compat_bits tunable
512
513==============================================================
514
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800515nr_hugepages
516
517Change the minimum size of the hugepage pool.
518
519See Documentation/vm/hugetlbpage.txt
520
521==============================================================
522
523nr_overcommit_hugepages
524
525Change the maximum size of the hugepage pool. The maximum is
526nr_hugepages + nr_overcommit_hugepages.
527
528See Documentation/vm/hugetlbpage.txt
529
530==============================================================
531
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800532nr_trim_pages
533
534This is available only on NOMMU kernels.
535
536This value adjusts the excess page trimming behaviour of power-of-2 aligned
537NOMMU mmap allocations.
538
539A value of 0 disables trimming of allocations entirely, while a value of 1
540trims excess pages aggressively. Any value >= 1 acts as the watermark where
541trimming of allocations is initiated.
542
543The default value is 1.
544
545See Documentation/nommu-mmap.txt for more information.
546
547==============================================================
548
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700549numa_zonelist_order
550
Michal Hockoc9bff3e2017-09-06 16:20:13 -0700551This sysctl is only for NUMA and it is deprecated. Anything but
552Node order will fail!
553
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700554'where the memory is allocated from' is controlled by zonelists.
555(This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
556 you may be able to read ZONE_DMA as ZONE_DMA32...)
557
558In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
559ZONE_NORMAL -> ZONE_DMA
560This means that a memory allocation request for GFP_KERNEL will
561get memory from ZONE_DMA only when ZONE_NORMAL is not available.
562
563In NUMA case, you can think of following 2 types of order.
564Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
565
566(A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
567(B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
568
569Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
570will be used before ZONE_NORMAL exhaustion. This increases possibility of
571out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
572
573Type(B) cannot offer the best locality but is more robust against OOM of
574the DMA zone.
575
576Type(A) is called as "Node" order. Type (B) is "Zone" order.
577
578"Node order" orders the zonelists by node, then by zone within each node.
Paul Bolle5a3016a2011-04-06 11:09:55 +0200579Specify "[Nn]ode" for node order
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700580
581"Zone Order" orders the zonelists by zone type, then by node within each
Paul Bolle5a3016a2011-04-06 11:09:55 +0200582zone. Specify "[Zz]one" for zone order.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700583
Xishi Qiu7c88a292016-04-28 16:19:11 -0700584Specify "[Dd]efault" to request automatic configuration.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700585
Xishi Qiu7c88a292016-04-28 16:19:11 -0700586On 32-bit, the Normal zone needs to be preserved for allocations accessible
587by the kernel, so "zone" order will be selected.
588
589On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
590order will be selected.
591
592Default order is recommended unless this is causing problems for your
593system/application.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800594
595==============================================================
596
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800597oom_dump_tasks
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800598
Kirill A. Shutemovdc6c9a32015-02-11 15:26:50 -0800599Enables a system-wide task dump (excluding kernel threads) to be produced
600when the kernel performs an OOM-killing and includes such information as
Kirill A. Shutemovaf5b0f62017-11-15 17:35:40 -0800601pid, uid, tgid, vm size, rss, pgtables_bytes, swapents, oom_score_adj
602score, and name. This is helpful to determine why the OOM killer was
603invoked, to identify the rogue task that caused it, and to determine why
604the OOM killer chose the task it did to kill.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800605
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800606If this is set to zero, this information is suppressed. On very
607large systems with thousands of tasks it may not be feasible to dump
608the memory state information for each one. Such systems should not
609be forced to incur a performance penalty in OOM conditions when the
610information may not be desired.
611
612If this is set to non-zero, this information is shown whenever the
613OOM killer actually kills a memory-hogging task.
614
David Rientjesad915c42010-08-09 17:18:53 -0700615The default value is 1 (enabled).
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800616
617==============================================================
618
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800619oom_kill_allocating_task
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800620
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800621This enables or disables killing the OOM-triggering task in
622out-of-memory situations.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800623
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800624If this is set to zero, the OOM killer will scan through the entire
625tasklist and select a task based on heuristics to kill. This normally
626selects a rogue memory-hogging task that frees up a large amount of
627memory when killed.
628
629If this is set to non-zero, the OOM killer simply kills the task that
630triggered the out-of-memory condition. This avoids the expensive
631tasklist scan.
632
633If panic_on_oom is selected, it takes precedence over whatever value
634is used in oom_kill_allocating_task.
635
636The default value is 0.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000637
638==============================================================
639
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800640overcommit_kbytes:
641
642When overcommit_memory is set to 2, the committed address space is not
643permitted to exceed swap plus this amount of physical RAM. See below.
644
645Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
646of them may be specified at a time. Setting one disables the other (which
647then appears as 0 when read).
648
649==============================================================
650
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800651overcommit_memory:
Paul Mundtdd8632a2009-01-08 12:04:47 +0000652
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800653This value contains a flag that enables memory overcommitment.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000654
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800655When this flag is 0, the kernel attempts to estimate the amount
656of free memory left when userspace requests more memory.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000657
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800658When this flag is 1, the kernel pretends there is always enough
659memory until it actually runs out.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000660
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800661When this flag is 2, the kernel uses a "never overcommit"
662policy that attempts to prevent any overcommit of memory.
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700663Note that user_reserve_kbytes affects this policy.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000664
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800665This feature can be very useful because there are a lot of
666programs that malloc() huge amounts of memory "just-in-case"
667and don't use much of it.
668
669The default value is 0.
670
671See Documentation/vm/overcommit-accounting and
Chun Chenc56050c2015-11-09 14:58:15 -0800672mm/mmap.c::__vm_enough_memory() for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800673
674==============================================================
675
676overcommit_ratio:
677
678When overcommit_memory is set to 2, the committed address
679space is not permitted to exceed swap plus this percentage
680of physical RAM. See above.
681
682==============================================================
683
684page-cluster
685
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700686page-cluster controls the number of pages up to which consecutive pages
687are read in from swap in a single attempt. This is the swap counterpart
688to page cache readahead.
689The mentioned consecutivity is not in terms of virtual/physical addresses,
690but consecutive on swap space - that means they were swapped out together.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800691
692It is a logarithmic value - setting it to zero means "1 page", setting
693it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700694Zero disables swap readahead completely.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800695
696The default value is three (eight pages at a time). There may be some
697small benefits in tuning this to a different value if your workload is
698swap-intensive.
699
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700700Lower values mean lower latencies for initial faults, but at the same time
701extra faults and I/O delays for following faults if they would have been part of
702that consecutive pages readahead would have brought in.
703
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800704=============================================================
705
706panic_on_oom
707
708This enables or disables panic on out-of-memory feature.
709
710If this is set to 0, the kernel will kill some rogue process,
711called oom_killer. Usually, oom_killer can kill rogue processes and
712system will survive.
713
714If this is set to 1, the kernel panics when out-of-memory happens.
715However, if a process limits using nodes by mempolicy/cpusets,
716and those nodes become memory exhaustion status, one process
717may be killed by oom-killer. No panic occurs in this case.
718Because other nodes' memory may be free. This means system total status
719may be not fatal yet.
720
721If this is set to 2, the kernel panics compulsorily even on the
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800722above-mentioned. Even oom happens under memory cgroup, the whole
723system panics.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800724
725The default value is 0.
7261 and 2 are for failover of clustering. Please select either
727according to your policy of failover.
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800728panic_on_oom=2+kdump gives you very strong tool to investigate
729why oom happens. You can get snapshot.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800730
731=============================================================
732
733percpu_pagelist_fraction
734
735This is the fraction of pages at most (high mark pcp->high) in each zone that
736are allocated for each per cpu page list. The min value for this is 8. It
737means that we don't allow more than 1/8th of pages in each zone to be
738allocated in any single per_cpu_pagelist. This entry only changes the value
739of hot per cpu pagelists. User can specify a number like 100 to allocate
7401/100th of each zone to each per cpu page list.
741
742The batch value of each per cpu pagelist is also updated as a result. It is
743set to pcp->high/4. The upper limit of batch is (PAGE_SHIFT * 8)
744
745The initial value is zero. Kernel does not use this value at boot time to set
David Rientjes7cd2b0a2014-06-23 13:22:04 -0700746the high water marks for each per cpu page list. If the user writes '0' to this
747sysctl, it will revert to this default behavior.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800748
749==============================================================
750
751stat_interval
752
753The time interval between which vm statistics are updated. The default
754is 1 second.
755
756==============================================================
757
Hugh Dickins52b6f462016-05-19 17:12:50 -0700758stat_refresh
759
760Any read or write (by root only) flushes all the per-cpu vm statistics
761into their global totals, for more accurate reports when testing
762e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
763
764As a side-effect, it also checks for negative totals (elsewhere reported
765as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
766(At time of writing, a few stats are known sometimes to be found negative,
767with no ill effects: errors and warnings on these stats are suppressed.)
768
769==============================================================
770
Kemi Wang45180852017-11-15 17:38:22 -0800771numa_stat
772
773This interface allows runtime configuration of numa statistics.
774
775When page allocation performance becomes a bottleneck and you can tolerate
776some possible tool breakage and decreased numa counter precision, you can
777do:
778 echo 0 > /proc/sys/vm/numa_stat
779
780When page allocation performance is not a bottleneck and you want all
781tooling to work, you can do:
782 echo 1 > /proc/sys/vm/numa_stat
783
784==============================================================
785
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800786swappiness
787
788This control is used to define how aggressive the kernel will swap
Kangmin Park27432322017-11-17 15:30:23 -0800789memory pages. Higher values will increase aggressiveness, lower values
Aaron Tomlin8582cb92014-01-29 14:05:38 -0800790decrease the amount of swap. A value of 0 instructs the kernel not to
791initiate swap until the amount of free and file-backed pages is less
792than the high water mark in a zone.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800793
794The default value is 60.
795
796==============================================================
797
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700798- user_reserve_kbytes
799
Masanari Iida633708a2015-01-02 12:03:19 +0900800When overcommit_memory is set to 2, "never overcommit" mode, reserve
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700801min(3% of current process size, user_reserve_kbytes) of free memory.
802This is intended to prevent a user from starting a single memory hogging
803process, such that they cannot recover (kill the hog).
804
805user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
806
807If this is reduced to zero, then the user will be allowed to allocate
808all free memory with a single process, minus admin_reserve_kbytes.
809Any subsequent attempts to execute a command will result in
810"fork: Cannot allocate memory".
811
812Changing this takes effect whenever an application requests memory.
813
814==============================================================
815
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800816vfs_cache_pressure
817------------------
818
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700819This percentage value controls the tendency of the kernel to reclaim
820the memory which is used for caching of directory and inode objects.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800821
822At the default value of vfs_cache_pressure=100 the kernel will attempt to
823reclaim dentries and inodes at a "fair" rate with respect to pagecache and
824swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
Jan Kara55c37a82009-09-21 17:01:40 -0700825to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
826never reclaim dentries and inodes due to memory pressure and this can easily
827lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800828causes the kernel to prefer to reclaim dentries and inodes.
829
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700830Increasing vfs_cache_pressure significantly beyond 100 may have negative
831performance impact. Reclaim code needs to take various locks to find freeable
832directory and inode objects. With vfs_cache_pressure=1000, it will look for
833ten times more freeable objects than there are.
834
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700835=============================================================
836
837watermark_scale_factor:
838
839This factor controls the aggressiveness of kswapd. It defines the
840amount of memory left in a node/system before kswapd is woken up and
841how much memory needs to be free before kswapd goes back to sleep.
842
843The unit is in fractions of 10,000. The default value of 10 means the
844distances between watermarks are 0.1% of the available memory in the
845node/system. The maximum value is 1000, or 10% of memory.
846
847A high rate of threads entering direct reclaim (allocstall) or kswapd
848going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
849that the number of free pages kswapd maintains for latency reasons is
850too small for the allocation bursts occurring in the system. This knob
851can then be used to tune kswapd aggressiveness accordingly.
852
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800853==============================================================
854
855zone_reclaim_mode:
856
857Zone_reclaim_mode allows someone to set more or less aggressive approaches to
858reclaim memory when a zone runs out of memory. If it is set to zero then no
859zone reclaim occurs. Allocations will be satisfied from other zones / nodes
860in the system.
861
862This is value ORed together of
863
8641 = Zone reclaim on
8652 = Zone reclaim writes dirty pages out
8664 = Zone reclaim swaps pages
867
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700868zone_reclaim_mode is disabled by default. For file servers or workloads
869that benefit from having their data cached, zone_reclaim_mode should be
870left disabled as the caching effect is likely to be more important than
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800871data locality.
872
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700873zone_reclaim may be enabled if it's known that the workload is partitioned
874such that each partition fits within a NUMA node and that accessing remote
875memory would cause a measurable performance reduction. The page allocator
876will then reclaim easily reusable pages (those page cache pages that are
877currently not used) before allocating off node pages.
878
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800879Allowing zone reclaim to write out pages stops processes that are
880writing large amounts of data from dirtying pages on other nodes. Zone
881reclaim will write out dirty pages if a zone fills up and so effectively
882throttle the process. This may decrease the performance of a single process
883since it cannot use all of system memory to buffer the outgoing writes
884anymore but it preserve the memory on other nodes so that the performance
885of other processes running on other nodes will not be affected.
886
887Allowing regular swap effectively restricts allocations to the local
888node unless explicitly overridden by memory policies or cpuset
889configurations.
890
891============ End of Document =================================