blob: 206c9b071cf22ff2ff2d80f40fe5a887363fd412 [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
Rik van Rieldbe0f612011-09-01 15:26:50 -040033- extra_free_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080034- hugepages_treat_as_movable
35- hugetlb_shm_group
36- laptop_mode
37- legacy_va_layout
38- lowmem_reserve_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -070039- max_map_count
Andi Kleen6a460792009-09-16 11:50:15 +020040- memory_failure_early_kill
41- memory_failure_recovery
Linus Torvalds1da177e2005-04-16 15:20:36 -070042- min_free_kbytes
Christoph Lameter0ff38492006-09-25 23:31:52 -070043- min_slab_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080044- min_unmapped_ratio
45- mmap_min_addr
Daniel Cashmand07e2252016-01-14 15:19:53 -080046- mmap_rnd_bits
47- mmap_rnd_compat_bits
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -080048- nr_hugepages
49- nr_overcommit_hugepages
Peter W Morrealedb0fb182009-01-15 13:50:42 -080050- nr_trim_pages (only if CONFIG_MMU=n)
51- numa_zonelist_order
52- oom_dump_tasks
53- oom_kill_allocating_task
Jerome Marchand49f0ce52014-01-21 15:49:14 -080054- overcommit_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080055- overcommit_memory
56- overcommit_ratio
57- page-cluster
58- panic_on_oom
59- percpu_pagelist_fraction
60- stat_interval
Hugh Dickins52b6f462016-05-19 17:12:50 -070061- stat_refresh
Peter W Morrealedb0fb182009-01-15 13:50:42 -080062- swappiness
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -070063- user_reserve_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080064- vfs_cache_pressure
Jerome Marchande6507a02016-07-12 12:05:59 +020065- watermark_scale_factor
Peter W Morrealedb0fb182009-01-15 13:50:42 -080066- zone_reclaim_mode
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068==============================================================
69
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070070admin_reserve_kbytes
71
72The amount of free memory in the system that should be reserved for users
73with the capability cap_sys_admin.
74
75admin_reserve_kbytes defaults to min(3% of free pages, 8MB)
76
77That should provide enough for the admin to log in and kill a process,
78if necessary, under the default overcommit 'guess' mode.
79
80Systems running under overcommit 'never' should increase this to account
81for the full Virtual Memory Size of programs used to recover. Otherwise,
82root may not be able to log in to recover the system.
83
84How do you calculate a minimum useful reserve?
85
86sshd or login + bash (or some other shell) + top (or ps, kill, etc.)
87
88For overcommit 'guess', we can sum resident set sizes (RSS).
89On x86_64 this is about 8MB.
90
91For overcommit 'never', we can take the max of their virtual sizes (VSZ)
92and add the sum of their RSS.
93On x86_64 this is about 128MB.
94
95Changing this takes effect whenever an application requests memory.
96
97==============================================================
98
Peter W Morrealedb0fb182009-01-15 13:50:42 -080099block_dump
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800101block_dump enables block I/O debugging when set to a nonzero value. More
102information on block I/O debugging is in Documentation/laptops/laptop-mode.txt.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104==============================================================
105
Mel Gorman76ab0f52010-05-24 14:32:28 -0700106compact_memory
107
108Available only when CONFIG_COMPACTION is set. When 1 is written to the file,
109all zones are compacted such that free memory is available in contiguous
110blocks where possible. This can be important for example in the allocation of
111huge pages although processes will also directly compact memory as required.
112
113==============================================================
114
Eric B Munson5bbe3542015-04-15 16:13:20 -0700115compact_unevictable_allowed
116
117Available only when CONFIG_COMPACTION is set. When set to 1, compaction is
118allowed to examine the unevictable lru (mlocked pages) for pages to compact.
119This should be used on systems where stalls for minor page faults are an
120acceptable trade for large contiguous free memory. Set to 0 to prevent
121compaction from moving pages that are unevictable. Default value is 1.
122
123==============================================================
124
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800125dirty_background_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300127Contains the amount of dirty memory at which the background kernel
128flusher threads will start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Andrea Righiabffc022010-10-27 15:33:31 -0700130Note: dirty_background_bytes is the counterpart of dirty_background_ratio. Only
131one of them may be specified at a time. When one sysctl is written it is
132immediately taken into account to evaluate the dirty memory limits and the
133other appears as 0 when read.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135==============================================================
136
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800137dirty_background_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Zheng Liu715ea412013-11-12 15:08:30 -0800139Contains, as a percentage of total available memory that contains free pages
140and reclaimable pages, the number of pages at which the background kernel
141flusher threads will start writing out dirty data.
142
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000143The total available memory is not equal to total system memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145==============================================================
146
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800147dirty_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800149Contains the amount of dirty memory at which a process generating disk writes
150will itself start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Andrea Righiabffc022010-10-27 15:33:31 -0700152Note: dirty_bytes is the counterpart of dirty_ratio. Only one of them may be
153specified at a time. When one sysctl is written it is immediately taken into
154account to evaluate the dirty memory limits and the other appears as 0 when
155read.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800156
Andrea Righi9e4a5bd2009-04-30 15:08:57 -0700157Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
158value lower than this limit will be ignored and the old configuration will be
159retained.
160
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800161==============================================================
162
163dirty_expire_centisecs
164
165This tunable is used to define when dirty data is old enough to be eligible
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300166for writeout by the kernel flusher threads. It is expressed in 100'ths
167of a second. Data which has been dirty in-memory for longer than this
168interval will be written out next time a flusher thread wakes up.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800169
170==============================================================
171
172dirty_ratio
173
Zheng Liu715ea412013-11-12 15:08:30 -0800174Contains, as a percentage of total available memory that contains free pages
175and reclaimable pages, the number of pages at which a process which is
176generating disk writes will itself start writing out dirty data.
177
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000178The total available memory is not equal to total system memory.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800179
180==============================================================
181
182dirty_writeback_centisecs
183
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300184The kernel flusher threads will periodically wake up and write `old' data
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800185out to disk. This tunable expresses the interval between those wakeups, in
186100'ths of a second.
187
188Setting this to zero disables periodic writeback altogether.
189
190==============================================================
191
192drop_caches
193
Dave Hansen5509a5d2014-04-03 14:48:19 -0700194Writing to this will cause the kernel to drop clean caches, as well as
195reclaimable slab objects like dentries and inodes. Once dropped, their
196memory becomes free.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800197
198To free pagecache:
199 echo 1 > /proc/sys/vm/drop_caches
Dave Hansen5509a5d2014-04-03 14:48:19 -0700200To free reclaimable slab objects (includes dentries and inodes):
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800201 echo 2 > /proc/sys/vm/drop_caches
Dave Hansen5509a5d2014-04-03 14:48:19 -0700202To free slab objects and pagecache:
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800203 echo 3 > /proc/sys/vm/drop_caches
204
Dave Hansen5509a5d2014-04-03 14:48:19 -0700205This is a non-destructive operation and will not free any dirty objects.
206To increase the number of objects freed by this operation, the user may run
207`sync' prior to writing to /proc/sys/vm/drop_caches. This will minimize the
208number of dirty objects on the system and create more candidates to be
209dropped.
210
211This file is not a means to control the growth of the various kernel caches
212(inodes, dentries, pagecache, etc...) These objects are automatically
213reclaimed by the kernel when memory is needed elsewhere on the system.
214
215Use of this file can cause performance problems. Since it discards cached
216objects, it may cost a significant amount of I/O and CPU to recreate the
217dropped objects, especially if they were under heavy use. Because of this,
218use outside of a testing or debugging environment is not recommended.
219
220You may see informational messages in your kernel log when this file is
221used:
222
223 cat (1234): drop_caches: 3
224
225These are informational only. They do not mean that anything is wrong
226with your system. To disable them, echo 4 (bit 3) into drop_caches.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800227
228==============================================================
229
Mel Gorman5e771902010-05-24 14:32:31 -0700230extfrag_threshold
231
232This parameter affects whether the kernel will compact memory or direct
Rabin Vincenta10726b2015-07-14 07:35:11 +0200233reclaim to satisfy a high-order allocation. The extfrag/extfrag_index file in
234debugfs shows what the fragmentation index for each order is in each zone in
235the system. Values tending towards 0 imply allocations would fail due to lack
236of memory, values towards 1000 imply failures are due to fragmentation and -1
237implies that the allocation will succeed as long as watermarks are met.
Mel Gorman5e771902010-05-24 14:32:31 -0700238
239The kernel will not compact memory in a zone if the
240fragmentation index is <= extfrag_threshold. The default value is 500.
241
242==============================================================
243
Rik van Rieldbe0f612011-09-01 15:26:50 -0400244extra_free_kbytes
245
246This parameter tells the VM to keep extra free memory between the threshold
247where background reclaim (kswapd) kicks in, and the threshold where direct
248reclaim (by allocating processes) kicks in.
249
250This is useful for workloads that require low latency memory allocations
251and have a bounded burstiness in memory allocations, for example a
252realtime application that receives and transmits network traffic
253(causing in-kernel memory allocations) with a maximum total message burst
254size of 200MB may need 200MB of extra free memory to avoid direct reclaim
255related latencies.
256
257==============================================================
258
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800259hugepages_treat_as_movable
260
Naoya Horiguchi86cdb462013-09-11 14:22:13 -0700261This parameter controls whether we can allocate hugepages from ZONE_MOVABLE
262or not. If set to non-zero, hugepages can be allocated from ZONE_MOVABLE.
263ZONE_MOVABLE is created when kernel boot parameter kernelcore= is specified,
264so this parameter has no effect if used without kernelcore=.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800265
Naoya Horiguchi86cdb462013-09-11 14:22:13 -0700266Hugepage migration is now available in some situations which depend on the
267architecture and/or the hugepage size. If a hugepage supports migration,
268allocation from ZONE_MOVABLE is always enabled for the hugepage regardless
269of the value of this parameter.
270IOW, this parameter affects only non-migratable hugepages.
271
272Assuming that hugepages are not migratable in your system, one usecase of
273this parameter is that users can make hugepage pool more extensible by
274enabling the allocation from ZONE_MOVABLE. This is because on ZONE_MOVABLE
275page reclaim/migration/compaction work more and you can get contiguous
276memory more likely. Note that using ZONE_MOVABLE for non-migratable
277hugepages can do harm to other features like memory hotremove (because
278memory hotremove expects that memory blocks on ZONE_MOVABLE are always
279removable,) so it's a trade-off responsible for the users.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800280
281==============================================================
282
283hugetlb_shm_group
284
285hugetlb_shm_group contains group id that is allowed to create SysV
286shared memory segment using hugetlb page.
287
288==============================================================
289
290laptop_mode
291
292laptop_mode is a knob that controls "laptop mode". All the things that are
293controlled by this knob are discussed in Documentation/laptops/laptop-mode.txt.
294
295==============================================================
296
297legacy_va_layout
298
Kulikov Vasiliy2174efb2010-06-28 13:59:28 +0200299If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800300will use the legacy (2.4) layout for all processes.
301
302==============================================================
303
304lowmem_reserve_ratio
305
306For some specialised workloads on highmem machines it is dangerous for
307the kernel to allow process memory to be allocated from the "lowmem"
308zone. This is because that memory could then be pinned via the mlock()
309system call, or by unavailability of swapspace.
310
311And on large highmem machines this lack of reclaimable lowmem memory
312can be fatal.
313
314So the Linux page allocator has a mechanism which prevents allocations
315which _could_ use highmem from using too much lowmem. This means that
316a certain amount of lowmem is defended from the possibility of being
317captured into pinned user memory.
318
319(The same argument applies to the old 16 megabyte ISA DMA region. This
320mechanism will also defend that region from allocations which could use
321highmem or lowmem).
322
323The `lowmem_reserve_ratio' tunable determines how aggressive the kernel is
324in defending these lower zones.
325
326If you have a machine which uses highmem or ISA DMA and your
327applications are using mlock(), or if you are running with no swap then
328you probably should change the lowmem_reserve_ratio setting.
329
330The lowmem_reserve_ratio is an array. You can see them by reading this file.
331-
332% cat /proc/sys/vm/lowmem_reserve_ratio
333256 256 32
334-
335Note: # of this elements is one fewer than number of zones. Because the highest
336 zone's value is not necessary for following calculation.
337
338But, these values are not used directly. The kernel calculates # of protection
339pages for each zones from them. These are shown as array of protection pages
340in /proc/zoneinfo like followings. (This is an example of x86-64 box).
341Each zone has an array of protection pages like this.
342
343-
344Node 0, zone DMA
345 pages free 1355
346 min 3
347 low 3
348 high 4
349 :
350 :
351 numa_other 0
352 protection: (0, 2004, 2004, 2004)
353 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
354 pagesets
355 cpu: 0 pcp: 0
356 :
357-
358These protections are added to score to judge whether this zone should be used
359for page allocation or should be reclaimed.
360
361In this example, if normal pages (index=2) are required to this DMA zone and
Mel Gorman41858962009-06-16 15:32:12 -0700362watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
363not be used because pages_free(1355) is smaller than watermark + protection[2]
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800364(4 + 2004 = 2008). If this protection value is 0, this zone would be used for
365normal page requirement. If requirement is DMA zone(index=0), protection[0]
366(=0) is used.
367
368zone[i]'s protection[j] is calculated by following expression.
369
370(i < j):
371 zone[i]->protection[j]
Yaowei Bai013110a2015-09-08 15:04:10 -0700372 = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800373 / lowmem_reserve_ratio[i];
374(i = j):
375 (should not be protected. = 0;
376(i > j):
377 (not necessary, but looks 0)
378
379The default values of lowmem_reserve_ratio[i] are
380 256 (if zone[i] means DMA or DMA32 zone)
381 32 (others).
382As above expression, they are reciprocal number of ratio.
Yaowei Bai013110a2015-09-08 15:04:10 -0700383256 means 1/256. # of protection pages becomes about "0.39%" of total managed
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800384pages of higher zones on the node.
385
386If you would like to protect more pages, smaller values are effective.
387The minimum value is 1 (1/1 -> 100%).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389==============================================================
390
391max_map_count:
392
393This file contains the maximum number of memory map areas a process
394may have. Memory map areas are used as a side-effect of calling
395malloc, directly by mmap and mprotect, and also when loading shared
396libraries.
397
398While most applications need less than a thousand maps, certain
399programs, particularly malloc debuggers, may consume lots of them,
400e.g., up to one or two maps per allocation.
401
402The default value is 65536.
403
Andi Kleen6a460792009-09-16 11:50:15 +0200404=============================================================
405
406memory_failure_early_kill:
407
408Control how to kill processes when uncorrected memory error (typically
409a 2bit error in a memory module) is detected in the background by hardware
410that cannot be handled by the kernel. In some cases (like the page
411still having a valid copy on disk) the kernel will handle the failure
412transparently without affecting any applications. But if there is
413no other uptodate copy of the data it will kill to prevent any data
414corruptions from propagating.
415
4161: Kill all processes that have the corrupted and not reloadable page mapped
417as soon as the corruption is detected. Note this is not supported
418for a few types of pages, like kernel internally allocated data or
419the swap cache, but works for the majority of user pages.
420
4210: Only unmap the corrupted page from all processes and only kill a process
422who tries to access it.
423
424The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
425handle this if they want to.
426
427This is only active on architectures/platforms with advanced machine
428check handling and depends on the hardware capabilities.
429
430Applications can override this setting individually with the PR_MCE_KILL prctl
431
432==============================================================
433
434memory_failure_recovery
435
436Enable memory failure recovery (when supported by the platform)
437
4381: Attempt recovery.
439
4400: Always panic on a memory failure.
441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442==============================================================
443
444min_free_kbytes:
445
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800446This is used to force the Linux VM to keep a minimum number
Mel Gorman41858962009-06-16 15:32:12 -0700447of kilobytes free. The VM uses this number to compute a
448watermark[WMARK_MIN] value for each lowmem zone in the system.
449Each lowmem zone gets a number of reserved free pages based
450proportionally on its size.
Rohit Seth8ad4b1f2006-01-08 01:00:40 -0800451
Matt LaPlanted9195882008-07-25 19:45:33 -0700452Some minimal amount of memory is needed to satisfy PF_MEMALLOC
Pavel Machek24950892007-10-16 23:31:28 -0700453allocations; if you set this to lower than 1024KB, your system will
454become subtly broken, and prone to deadlock under high loads.
455
456Setting this too high will OOM your machine instantly.
457
Christoph Lameter96146342006-07-03 00:24:13 -0700458=============================================================
459
Christoph Lameter0ff38492006-09-25 23:31:52 -0700460min_slab_ratio:
461
462This is available only on NUMA kernels.
463
464A percentage of the total pages in each zone. On Zone reclaim
465(fallback from the local zone occurs) slabs will be reclaimed if more
466than this percentage of pages in a zone are reclaimable slab pages.
467This insures that the slab growth stays under control even in NUMA
468systems that rarely perform global reclaim.
469
470The default is 5 percent.
471
472Note that slab reclaim is triggered in a per zone / node fashion.
473The process of reclaiming slab memory is currently not node specific
474and may not be fast.
475
476=============================================================
477
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800478min_unmapped_ratio:
KAMEZAWA Hiroyukifadd8fb2006-06-23 02:03:13 -0700479
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800480This is available only on NUMA kernels.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700481
Mel Gorman90afa5d2009-06-16 15:33:20 -0700482This is a percentage of the total pages in each zone. Zone reclaim will
483only occur if more than this percentage of pages are in a state that
484zone_reclaim_mode allows to be reclaimed.
485
486If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
487against all file-backed unmapped pages including swapcache pages and tmpfs
488files. Otherwise, only unmapped pages backed by normal files but not tmpfs
489files and similar are considered.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700490
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800491The default is 1 percent.
David Rientjesfe071d72007-10-16 23:25:56 -0700492
Eric Parised032182007-06-28 15:55:21 -0400493==============================================================
494
495mmap_min_addr
496
497This file indicates the amount of address space which a user process will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200498be restricted from mmapping. Since kernel null dereference bugs could
Eric Parised032182007-06-28 15:55:21 -0400499accidentally operate based on the information in the first couple of pages
500of memory userspace processes should not be allowed to write to them. By
501default this value is set to 0 and no protections will be enforced by the
502security module. Setting this value to something like 64k will allow the
503vast majority of applications to work correctly and provide defense in depth
504against future potential kernel bugs.
505
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700506==============================================================
507
Daniel Cashmand07e2252016-01-14 15:19:53 -0800508mmap_rnd_bits:
509
510This value can be used to select the number of bits to use to
511determine the random offset to the base address of vma regions
512resulting from mmap allocations on architectures which support
513tuning address space randomization. This value will be bounded
514by the architecture's minimum and maximum supported values.
515
516This value can be changed after boot using the
517/proc/sys/vm/mmap_rnd_bits tunable
518
519==============================================================
520
521mmap_rnd_compat_bits:
522
523This value can be used to select the number of bits to use to
524determine the random offset to the base address of vma regions
525resulting from mmap allocations for applications run in
526compatibility mode on architectures which support tuning address
527space randomization. This value will be bounded by the
528architecture's minimum and maximum supported values.
529
530This value can be changed after boot using the
531/proc/sys/vm/mmap_rnd_compat_bits tunable
532
533==============================================================
534
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800535nr_hugepages
536
537Change the minimum size of the hugepage pool.
538
539See Documentation/vm/hugetlbpage.txt
540
541==============================================================
542
543nr_overcommit_hugepages
544
545Change the maximum size of the hugepage pool. The maximum is
546nr_hugepages + nr_overcommit_hugepages.
547
548See Documentation/vm/hugetlbpage.txt
549
550==============================================================
551
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800552nr_trim_pages
553
554This is available only on NOMMU kernels.
555
556This value adjusts the excess page trimming behaviour of power-of-2 aligned
557NOMMU mmap allocations.
558
559A value of 0 disables trimming of allocations entirely, while a value of 1
560trims excess pages aggressively. Any value >= 1 acts as the watermark where
561trimming of allocations is initiated.
562
563The default value is 1.
564
565See Documentation/nommu-mmap.txt for more information.
566
567==============================================================
568
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700569numa_zonelist_order
570
571This sysctl is only for NUMA.
572'where the memory is allocated from' is controlled by zonelists.
573(This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
574 you may be able to read ZONE_DMA as ZONE_DMA32...)
575
576In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
577ZONE_NORMAL -> ZONE_DMA
578This means that a memory allocation request for GFP_KERNEL will
579get memory from ZONE_DMA only when ZONE_NORMAL is not available.
580
581In NUMA case, you can think of following 2 types of order.
582Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
583
584(A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
585(B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
586
587Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
588will be used before ZONE_NORMAL exhaustion. This increases possibility of
589out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
590
591Type(B) cannot offer the best locality but is more robust against OOM of
592the DMA zone.
593
594Type(A) is called as "Node" order. Type (B) is "Zone" order.
595
596"Node order" orders the zonelists by node, then by zone within each node.
Paul Bolle5a3016a2011-04-06 11:09:55 +0200597Specify "[Nn]ode" for node order
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700598
599"Zone Order" orders the zonelists by zone type, then by node within each
Paul Bolle5a3016a2011-04-06 11:09:55 +0200600zone. Specify "[Zz]one" for zone order.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700601
Xishi Qiu7c88a292016-04-28 16:19:11 -0700602Specify "[Dd]efault" to request automatic configuration.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700603
Xishi Qiu7c88a292016-04-28 16:19:11 -0700604On 32-bit, the Normal zone needs to be preserved for allocations accessible
605by the kernel, so "zone" order will be selected.
606
607On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
608order will be selected.
609
610Default order is recommended unless this is causing problems for your
611system/application.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800612
613==============================================================
614
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800615oom_dump_tasks
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800616
Kirill A. Shutemovdc6c9a32015-02-11 15:26:50 -0800617Enables a system-wide task dump (excluding kernel threads) to be produced
618when the kernel performs an OOM-killing and includes such information as
619pid, uid, tgid, vm size, rss, nr_ptes, nr_pmds, swapents, oom_score_adj
620score, and name. This is helpful to determine why the OOM killer was
621invoked, to identify the rogue task that caused it, and to determine why
622the OOM killer chose the task it did to kill.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800623
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800624If this is set to zero, this information is suppressed. On very
625large systems with thousands of tasks it may not be feasible to dump
626the memory state information for each one. Such systems should not
627be forced to incur a performance penalty in OOM conditions when the
628information may not be desired.
629
630If this is set to non-zero, this information is shown whenever the
631OOM killer actually kills a memory-hogging task.
632
David Rientjesad915c42010-08-09 17:18:53 -0700633The default value is 1 (enabled).
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800634
635==============================================================
636
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800637oom_kill_allocating_task
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800638
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800639This enables or disables killing the OOM-triggering task in
640out-of-memory situations.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800641
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800642If this is set to zero, the OOM killer will scan through the entire
643tasklist and select a task based on heuristics to kill. This normally
644selects a rogue memory-hogging task that frees up a large amount of
645memory when killed.
646
647If this is set to non-zero, the OOM killer simply kills the task that
648triggered the out-of-memory condition. This avoids the expensive
649tasklist scan.
650
651If panic_on_oom is selected, it takes precedence over whatever value
652is used in oom_kill_allocating_task.
653
654The default value is 0.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000655
656==============================================================
657
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800658overcommit_kbytes:
659
660When overcommit_memory is set to 2, the committed address space is not
661permitted to exceed swap plus this amount of physical RAM. See below.
662
663Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
664of them may be specified at a time. Setting one disables the other (which
665then appears as 0 when read).
666
667==============================================================
668
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800669overcommit_memory:
Paul Mundtdd8632a2009-01-08 12:04:47 +0000670
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800671This value contains a flag that enables memory overcommitment.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000672
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800673When this flag is 0, the kernel attempts to estimate the amount
674of free memory left when userspace requests more memory.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000675
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800676When this flag is 1, the kernel pretends there is always enough
677memory until it actually runs out.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000678
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800679When this flag is 2, the kernel uses a "never overcommit"
680policy that attempts to prevent any overcommit of memory.
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700681Note that user_reserve_kbytes affects this policy.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000682
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800683This feature can be very useful because there are a lot of
684programs that malloc() huge amounts of memory "just-in-case"
685and don't use much of it.
686
687The default value is 0.
688
689See Documentation/vm/overcommit-accounting and
Chun Chenc56050c2015-11-09 14:58:15 -0800690mm/mmap.c::__vm_enough_memory() for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800691
692==============================================================
693
694overcommit_ratio:
695
696When overcommit_memory is set to 2, the committed address
697space is not permitted to exceed swap plus this percentage
698of physical RAM. See above.
699
700==============================================================
701
702page-cluster
703
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700704page-cluster controls the number of pages up to which consecutive pages
705are read in from swap in a single attempt. This is the swap counterpart
706to page cache readahead.
707The mentioned consecutivity is not in terms of virtual/physical addresses,
708but consecutive on swap space - that means they were swapped out together.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800709
710It is a logarithmic value - setting it to zero means "1 page", setting
711it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700712Zero disables swap readahead completely.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800713
714The default value is three (eight pages at a time). There may be some
715small benefits in tuning this to a different value if your workload is
716swap-intensive.
717
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700718Lower values mean lower latencies for initial faults, but at the same time
719extra faults and I/O delays for following faults if they would have been part of
720that consecutive pages readahead would have brought in.
721
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800722=============================================================
723
724panic_on_oom
725
726This enables or disables panic on out-of-memory feature.
727
728If this is set to 0, the kernel will kill some rogue process,
729called oom_killer. Usually, oom_killer can kill rogue processes and
730system will survive.
731
732If this is set to 1, the kernel panics when out-of-memory happens.
733However, if a process limits using nodes by mempolicy/cpusets,
734and those nodes become memory exhaustion status, one process
735may be killed by oom-killer. No panic occurs in this case.
736Because other nodes' memory may be free. This means system total status
737may be not fatal yet.
738
739If this is set to 2, the kernel panics compulsorily even on the
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800740above-mentioned. Even oom happens under memory cgroup, the whole
741system panics.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800742
743The default value is 0.
7441 and 2 are for failover of clustering. Please select either
745according to your policy of failover.
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800746panic_on_oom=2+kdump gives you very strong tool to investigate
747why oom happens. You can get snapshot.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800748
749=============================================================
750
751percpu_pagelist_fraction
752
753This is the fraction of pages at most (high mark pcp->high) in each zone that
754are allocated for each per cpu page list. The min value for this is 8. It
755means that we don't allow more than 1/8th of pages in each zone to be
756allocated in any single per_cpu_pagelist. This entry only changes the value
757of hot per cpu pagelists. User can specify a number like 100 to allocate
7581/100th of each zone to each per cpu page list.
759
760The batch value of each per cpu pagelist is also updated as a result. It is
761set to pcp->high/4. The upper limit of batch is (PAGE_SHIFT * 8)
762
763The initial value is zero. Kernel does not use this value at boot time to set
David Rientjes7cd2b0a2014-06-23 13:22:04 -0700764the high water marks for each per cpu page list. If the user writes '0' to this
765sysctl, it will revert to this default behavior.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800766
767==============================================================
768
769stat_interval
770
771The time interval between which vm statistics are updated. The default
772is 1 second.
773
774==============================================================
775
Hugh Dickins52b6f462016-05-19 17:12:50 -0700776stat_refresh
777
778Any read or write (by root only) flushes all the per-cpu vm statistics
779into their global totals, for more accurate reports when testing
780e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
781
782As a side-effect, it also checks for negative totals (elsewhere reported
783as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
784(At time of writing, a few stats are known sometimes to be found negative,
785with no ill effects: errors and warnings on these stats are suppressed.)
786
787==============================================================
788
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800789swappiness
790
791This control is used to define how aggressive the kernel will swap
792memory pages. Higher values will increase agressiveness, lower values
Aaron Tomlin8582cb92014-01-29 14:05:38 -0800793decrease the amount of swap. A value of 0 instructs the kernel not to
794initiate swap until the amount of free and file-backed pages is less
795than the high water mark in a zone.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800796
797The default value is 60.
798
799==============================================================
800
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700801- user_reserve_kbytes
802
Masanari Iida633708a2015-01-02 12:03:19 +0900803When overcommit_memory is set to 2, "never overcommit" mode, reserve
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700804min(3% of current process size, user_reserve_kbytes) of free memory.
805This is intended to prevent a user from starting a single memory hogging
806process, such that they cannot recover (kill the hog).
807
808user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
809
810If this is reduced to zero, then the user will be allowed to allocate
811all free memory with a single process, minus admin_reserve_kbytes.
812Any subsequent attempts to execute a command will result in
813"fork: Cannot allocate memory".
814
815Changing this takes effect whenever an application requests memory.
816
817==============================================================
818
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800819vfs_cache_pressure
820------------------
821
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700822This percentage value controls the tendency of the kernel to reclaim
823the memory which is used for caching of directory and inode objects.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800824
825At the default value of vfs_cache_pressure=100 the kernel will attempt to
826reclaim dentries and inodes at a "fair" rate with respect to pagecache and
827swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
Jan Kara55c37a82009-09-21 17:01:40 -0700828to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
829never reclaim dentries and inodes due to memory pressure and this can easily
830lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800831causes the kernel to prefer to reclaim dentries and inodes.
832
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700833Increasing vfs_cache_pressure significantly beyond 100 may have negative
834performance impact. Reclaim code needs to take various locks to find freeable
835directory and inode objects. With vfs_cache_pressure=1000, it will look for
836ten times more freeable objects than there are.
837
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700838=============================================================
839
840watermark_scale_factor:
841
842This factor controls the aggressiveness of kswapd. It defines the
843amount of memory left in a node/system before kswapd is woken up and
844how much memory needs to be free before kswapd goes back to sleep.
845
846The unit is in fractions of 10,000. The default value of 10 means the
847distances between watermarks are 0.1% of the available memory in the
848node/system. The maximum value is 1000, or 10% of memory.
849
850A high rate of threads entering direct reclaim (allocstall) or kswapd
851going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
852that the number of free pages kswapd maintains for latency reasons is
853too small for the allocation bursts occurring in the system. This knob
854can then be used to tune kswapd aggressiveness accordingly.
855
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800856==============================================================
857
858zone_reclaim_mode:
859
860Zone_reclaim_mode allows someone to set more or less aggressive approaches to
861reclaim memory when a zone runs out of memory. If it is set to zero then no
862zone reclaim occurs. Allocations will be satisfied from other zones / nodes
863in the system.
864
865This is value ORed together of
866
8671 = Zone reclaim on
8682 = Zone reclaim writes dirty pages out
8694 = Zone reclaim swaps pages
870
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700871zone_reclaim_mode is disabled by default. For file servers or workloads
872that benefit from having their data cached, zone_reclaim_mode should be
873left disabled as the caching effect is likely to be more important than
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800874data locality.
875
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700876zone_reclaim may be enabled if it's known that the workload is partitioned
877such that each partition fits within a NUMA node and that accessing remote
878memory would cause a measurable performance reduction. The page allocator
879will then reclaim easily reusable pages (those page cache pages that are
880currently not used) before allocating off node pages.
881
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800882Allowing zone reclaim to write out pages stops processes that are
883writing large amounts of data from dirtying pages on other nodes. Zone
884reclaim will write out dirty pages if a zone fills up and so effectively
885throttle the process. This may decrease the performance of a single process
886since it cannot use all of system memory to buffer the outgoing writes
887anymore but it preserve the memory on other nodes so that the performance
888of other processes running on other nodes will not be affected.
889
890Allowing regular swap effectively restricts allocations to the local
891node unless explicitly overridden by memory policies or cpuset
892configurations.
893
894============ End of Document =================================