blob: 48244c42ff5214176cf4dfc071f803e2aa8cd71f [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- hugepages_treat_as_movable
34- hugetlb_shm_group
35- laptop_mode
36- legacy_va_layout
37- lowmem_reserve_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -070038- max_map_count
Andi Kleen6a460792009-09-16 11:50:15 +020039- memory_failure_early_kill
40- memory_failure_recovery
Linus Torvalds1da177e2005-04-16 15:20:36 -070041- min_free_kbytes
Christoph Lameter0ff38492006-09-25 23:31:52 -070042- min_slab_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080043- min_unmapped_ratio
44- mmap_min_addr
Daniel Cashmand07e2252016-01-14 15:19:53 -080045- mmap_rnd_bits
46- mmap_rnd_compat_bits
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -080047- nr_hugepages
48- nr_overcommit_hugepages
Peter W Morrealedb0fb182009-01-15 13:50:42 -080049- nr_trim_pages (only if CONFIG_MMU=n)
50- numa_zonelist_order
51- oom_dump_tasks
52- oom_kill_allocating_task
Jerome Marchand49f0ce52014-01-21 15:49:14 -080053- overcommit_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080054- overcommit_memory
55- overcommit_ratio
56- page-cluster
57- panic_on_oom
58- percpu_pagelist_fraction
59- stat_interval
Hugh Dickins52b6f462016-05-19 17:12:50 -070060- stat_refresh
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 -0800263hugepages_treat_as_movable
264
Naoya Horiguchi86cdb462013-09-11 14:22:13 -0700265This 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=.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800269
Naoya Horiguchi86cdb462013-09-11 14:22:13 -0700270Hugepage 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.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800284
285==============================================================
286
287hugetlb_shm_group
288
289hugetlb_shm_group contains group id that is allowed to create SysV
290shared memory segment using hugetlb page.
291
292==============================================================
293
294laptop_mode
295
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.
298
299==============================================================
300
301legacy_va_layout
302
Kulikov Vasiliy2174efb2010-06-28 13:59:28 +0200303If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800304will use the legacy (2.4) layout for all processes.
305
306==============================================================
307
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
Mel Gorman41858962009-06-16 15:32:12 -0700366watermark[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]
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800368(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]
Yaowei Bai013110a2015-09-08 15:04:10 -0700376 = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800377 / 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.
Yaowei Bai013110a2015-09-08 15:04:10 -0700387256 means 1/256. # of protection pages becomes about "0.39%" of total managed
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800388pages 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%).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393==============================================================
394
395max_map_count:
396
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
David Rientjesdef5efe2017-02-24 14:58:47 -0800399malloc, directly by mmap, mprotect, and madvise, and also when loading
400shared libraries.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
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.
405
406The default value is 65536.
407
Andi Kleen6a460792009-09-16 11:50:15 +0200408=============================================================
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446==============================================================
447
448min_free_kbytes:
449
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800450This is used to force the Linux VM to keep a minimum number
Mel Gorman41858962009-06-16 15:32:12 -0700451of 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.
Rohit Seth8ad4b1f2006-01-08 01:00:40 -0800455
Matt LaPlanted9195882008-07-25 19:45:33 -0700456Some minimal amount of memory is needed to satisfy PF_MEMALLOC
Pavel Machek24950892007-10-16 23:31:28 -0700457allocations; 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.
461
Christoph Lameter96146342006-07-03 00:24:13 -0700462=============================================================
463
Christoph Lameter0ff38492006-09-25 23:31:52 -0700464min_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
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800482min_unmapped_ratio:
KAMEZAWA Hiroyukifadd8fb2006-06-23 02:03:13 -0700483
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800484This is available only on NUMA kernels.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700485
Mel Gorman90afa5d2009-06-16 15:33:20 -0700486This 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.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700494
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800495The default is 1 percent.
David Rientjesfe071d72007-10-16 23:25:56 -0700496
Eric Parised032182007-06-28 15:55:21 -0400497==============================================================
498
499mmap_min_addr
500
501This file indicates the amount of address space which a user process will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200502be restricted from mmapping. Since kernel null dereference bugs could
Eric Parised032182007-06-28 15:55:21 -0400503accidentally 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.
509
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700510==============================================================
511
Daniel Cashmand07e2252016-01-14 15:19:53 -0800512mmap_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
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800539nr_hugepages
540
541Change the minimum size of the hugepage pool.
542
543See Documentation/vm/hugetlbpage.txt
544
545==============================================================
546
547nr_overcommit_hugepages
548
549Change the maximum size of the hugepage pool. The maximum is
550nr_hugepages + nr_overcommit_hugepages.
551
552See Documentation/vm/hugetlbpage.txt
553
554==============================================================
555
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800556nr_trim_pages
557
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.
570
571==============================================================
572
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700573numa_zonelist_order
574
575This sysctl is only for NUMA.
576'where the memory is allocated from' is controlled by zonelists.
577(This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
578 you may be able to read ZONE_DMA as ZONE_DMA32...)
579
580In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
581ZONE_NORMAL -> ZONE_DMA
582This means that a memory allocation request for GFP_KERNEL will
583get memory from ZONE_DMA only when ZONE_NORMAL is not available.
584
585In NUMA case, you can think of following 2 types of order.
586Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
587
588(A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
589(B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
590
591Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
592will be used before ZONE_NORMAL exhaustion. This increases possibility of
593out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
594
595Type(B) cannot offer the best locality but is more robust against OOM of
596the DMA zone.
597
598Type(A) is called as "Node" order. Type (B) is "Zone" order.
599
600"Node order" orders the zonelists by node, then by zone within each node.
Paul Bolle5a3016a2011-04-06 11:09:55 +0200601Specify "[Nn]ode" for node order
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700602
603"Zone Order" orders the zonelists by zone type, then by node within each
Paul Bolle5a3016a2011-04-06 11:09:55 +0200604zone. Specify "[Zz]one" for zone order.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700605
Xishi Qiu7c88a292016-04-28 16:19:11 -0700606Specify "[Dd]efault" to request automatic configuration.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700607
Xishi Qiu7c88a292016-04-28 16:19:11 -0700608On 32-bit, the Normal zone needs to be preserved for allocations accessible
609by the kernel, so "zone" order will be selected.
610
611On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
612order will be selected.
613
614Default order is recommended unless this is causing problems for your
615system/application.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800616
617==============================================================
618
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800619oom_dump_tasks
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800620
Kirill A. Shutemovdc6c9a32015-02-11 15:26:50 -0800621Enables a system-wide task dump (excluding kernel threads) to be produced
622when the kernel performs an OOM-killing and includes such information as
623pid, uid, tgid, vm size, rss, nr_ptes, nr_pmds, swapents, oom_score_adj
624score, and name. This is helpful to determine why the OOM killer was
625invoked, to identify the rogue task that caused it, and to determine why
626the OOM killer chose the task it did to kill.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800627
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800628If this is set to zero, this information is suppressed. On very
629large systems with thousands of tasks it may not be feasible to dump
630the memory state information for each one. Such systems should not
631be forced to incur a performance penalty in OOM conditions when the
632information may not be desired.
633
634If this is set to non-zero, this information is shown whenever the
635OOM killer actually kills a memory-hogging task.
636
David Rientjesad915c42010-08-09 17:18:53 -0700637The default value is 1 (enabled).
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800638
639==============================================================
640
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800641oom_kill_allocating_task
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800642
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800643This enables or disables killing the OOM-triggering task in
644out-of-memory situations.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800645
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800646If this is set to zero, the OOM killer will scan through the entire
647tasklist and select a task based on heuristics to kill. This normally
648selects a rogue memory-hogging task that frees up a large amount of
649memory when killed.
650
651If this is set to non-zero, the OOM killer simply kills the task that
652triggered the out-of-memory condition. This avoids the expensive
653tasklist scan.
654
655If panic_on_oom is selected, it takes precedence over whatever value
656is used in oom_kill_allocating_task.
657
658The default value is 0.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000659
660==============================================================
661
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800662overcommit_kbytes:
663
664When overcommit_memory is set to 2, the committed address space is not
665permitted to exceed swap plus this amount of physical RAM. See below.
666
667Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
668of them may be specified at a time. Setting one disables the other (which
669then appears as 0 when read).
670
671==============================================================
672
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800673overcommit_memory:
Paul Mundtdd8632a2009-01-08 12:04:47 +0000674
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800675This value contains a flag that enables memory overcommitment.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000676
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800677When this flag is 0, the kernel attempts to estimate the amount
678of free memory left when userspace requests more memory.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000679
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800680When this flag is 1, the kernel pretends there is always enough
681memory until it actually runs out.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000682
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800683When this flag is 2, the kernel uses a "never overcommit"
684policy that attempts to prevent any overcommit of memory.
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700685Note that user_reserve_kbytes affects this policy.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000686
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800687This feature can be very useful because there are a lot of
688programs that malloc() huge amounts of memory "just-in-case"
689and don't use much of it.
690
691The default value is 0.
692
693See Documentation/vm/overcommit-accounting and
Chun Chenc56050c2015-11-09 14:58:15 -0800694mm/mmap.c::__vm_enough_memory() for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800695
696==============================================================
697
698overcommit_ratio:
699
700When overcommit_memory is set to 2, the committed address
701space is not permitted to exceed swap plus this percentage
702of physical RAM. See above.
703
704==============================================================
705
706page-cluster
707
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700708page-cluster controls the number of pages up to which consecutive pages
709are read in from swap in a single attempt. This is the swap counterpart
710to page cache readahead.
711The mentioned consecutivity is not in terms of virtual/physical addresses,
712but consecutive on swap space - that means they were swapped out together.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800713
714It is a logarithmic value - setting it to zero means "1 page", setting
715it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700716Zero disables swap readahead completely.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800717
718The default value is three (eight pages at a time). There may be some
719small benefits in tuning this to a different value if your workload is
720swap-intensive.
721
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700722Lower values mean lower latencies for initial faults, but at the same time
723extra faults and I/O delays for following faults if they would have been part of
724that consecutive pages readahead would have brought in.
725
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800726=============================================================
727
728panic_on_oom
729
730This enables or disables panic on out-of-memory feature.
731
732If this is set to 0, the kernel will kill some rogue process,
733called oom_killer. Usually, oom_killer can kill rogue processes and
734system will survive.
735
736If this is set to 1, the kernel panics when out-of-memory happens.
737However, if a process limits using nodes by mempolicy/cpusets,
738and those nodes become memory exhaustion status, one process
739may be killed by oom-killer. No panic occurs in this case.
740Because other nodes' memory may be free. This means system total status
741may be not fatal yet.
742
743If this is set to 2, the kernel panics compulsorily even on the
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800744above-mentioned. Even oom happens under memory cgroup, the whole
745system panics.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800746
747The default value is 0.
7481 and 2 are for failover of clustering. Please select either
749according to your policy of failover.
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800750panic_on_oom=2+kdump gives you very strong tool to investigate
751why oom happens. You can get snapshot.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800752
753=============================================================
754
755percpu_pagelist_fraction
756
757This is the fraction of pages at most (high mark pcp->high) in each zone that
758are allocated for each per cpu page list. The min value for this is 8. It
759means that we don't allow more than 1/8th of pages in each zone to be
760allocated in any single per_cpu_pagelist. This entry only changes the value
761of hot per cpu pagelists. User can specify a number like 100 to allocate
7621/100th of each zone to each per cpu page list.
763
764The batch value of each per cpu pagelist is also updated as a result. It is
765set to pcp->high/4. The upper limit of batch is (PAGE_SHIFT * 8)
766
767The initial value is zero. Kernel does not use this value at boot time to set
David Rientjes7cd2b0a2014-06-23 13:22:04 -0700768the high water marks for each per cpu page list. If the user writes '0' to this
769sysctl, it will revert to this default behavior.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800770
771==============================================================
772
773stat_interval
774
775The time interval between which vm statistics are updated. The default
776is 1 second.
777
778==============================================================
779
Hugh Dickins52b6f462016-05-19 17:12:50 -0700780stat_refresh
781
782Any read or write (by root only) flushes all the per-cpu vm statistics
783into their global totals, for more accurate reports when testing
784e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
785
786As a side-effect, it also checks for negative totals (elsewhere reported
787as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
788(At time of writing, a few stats are known sometimes to be found negative,
789with no ill effects: errors and warnings on these stats are suppressed.)
790
791==============================================================
792
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800793swappiness
794
795This control is used to define how aggressive the kernel will swap
796memory pages. Higher values will increase agressiveness, lower values
Aaron Tomlin8582cb92014-01-29 14:05:38 -0800797decrease the amount of swap. A value of 0 instructs the kernel not to
798initiate swap until the amount of free and file-backed pages is less
799than the high water mark in a zone.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800800
801The default value is 60.
802
803==============================================================
804
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700805- user_reserve_kbytes
806
Masanari Iida633708a2015-01-02 12:03:19 +0900807When overcommit_memory is set to 2, "never overcommit" mode, reserve
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700808min(3% of current process size, user_reserve_kbytes) of free memory.
809This is intended to prevent a user from starting a single memory hogging
810process, such that they cannot recover (kill the hog).
811
812user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
813
814If this is reduced to zero, then the user will be allowed to allocate
815all free memory with a single process, minus admin_reserve_kbytes.
816Any subsequent attempts to execute a command will result in
817"fork: Cannot allocate memory".
818
819Changing this takes effect whenever an application requests memory.
820
821==============================================================
822
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800823vfs_cache_pressure
824------------------
825
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700826This percentage value controls the tendency of the kernel to reclaim
827the memory which is used for caching of directory and inode objects.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800828
829At the default value of vfs_cache_pressure=100 the kernel will attempt to
830reclaim dentries and inodes at a "fair" rate with respect to pagecache and
831swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
Jan Kara55c37a82009-09-21 17:01:40 -0700832to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
833never reclaim dentries and inodes due to memory pressure and this can easily
834lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800835causes the kernel to prefer to reclaim dentries and inodes.
836
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700837Increasing vfs_cache_pressure significantly beyond 100 may have negative
838performance impact. Reclaim code needs to take various locks to find freeable
839directory and inode objects. With vfs_cache_pressure=1000, it will look for
840ten times more freeable objects than there are.
841
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700842=============================================================
843
844watermark_scale_factor:
845
846This factor controls the aggressiveness of kswapd. It defines the
847amount of memory left in a node/system before kswapd is woken up and
848how much memory needs to be free before kswapd goes back to sleep.
849
850The unit is in fractions of 10,000. The default value of 10 means the
851distances between watermarks are 0.1% of the available memory in the
852node/system. The maximum value is 1000, or 10% of memory.
853
854A high rate of threads entering direct reclaim (allocstall) or kswapd
855going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
856that the number of free pages kswapd maintains for latency reasons is
857too small for the allocation bursts occurring in the system. This knob
858can then be used to tune kswapd aggressiveness accordingly.
859
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800860==============================================================
861
862zone_reclaim_mode:
863
864Zone_reclaim_mode allows someone to set more or less aggressive approaches to
865reclaim memory when a zone runs out of memory. If it is set to zero then no
866zone reclaim occurs. Allocations will be satisfied from other zones / nodes
867in the system.
868
869This is value ORed together of
870
8711 = Zone reclaim on
8722 = Zone reclaim writes dirty pages out
8734 = Zone reclaim swaps pages
874
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700875zone_reclaim_mode is disabled by default. For file servers or workloads
876that benefit from having their data cached, zone_reclaim_mode should be
877left disabled as the caching effect is likely to be more important than
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800878data locality.
879
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700880zone_reclaim may be enabled if it's known that the workload is partitioned
881such that each partition fits within a NUMA node and that accessing remote
882memory would cause a measurable performance reduction. The page allocator
883will then reclaim easily reusable pages (those page cache pages that are
884currently not used) before allocating off node pages.
885
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800886Allowing zone reclaim to write out pages stops processes that are
887writing large amounts of data from dirtying pages on other nodes. Zone
888reclaim will write out dirty pages if a zone fills up and so effectively
889throttle the process. This may decrease the performance of a single process
890since it cannot use all of system memory to buffer the outgoing writes
891anymore but it preserve the memory on other nodes so that the performance
892of other processes running on other nodes will not be affected.
893
894Allowing regular swap effectively restricts allocations to the local
895node unless explicitly overridden by memory policies or cpuset
896configurations.
897
898============ End of Document =================================