blob: cb0368459da31409996c8e01fa8add867ec0c5d8 [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
60- swappiness
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -070061- user_reserve_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080062- vfs_cache_pressure
63- zone_reclaim_mode
64
Linus Torvalds1da177e2005-04-16 15:20:36 -070065==============================================================
66
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070067admin_reserve_kbytes
68
69The amount of free memory in the system that should be reserved for users
70with the capability cap_sys_admin.
71
72admin_reserve_kbytes defaults to min(3% of free pages, 8MB)
73
74That should provide enough for the admin to log in and kill a process,
75if necessary, under the default overcommit 'guess' mode.
76
77Systems running under overcommit 'never' should increase this to account
78for the full Virtual Memory Size of programs used to recover. Otherwise,
79root may not be able to log in to recover the system.
80
81How do you calculate a minimum useful reserve?
82
83sshd or login + bash (or some other shell) + top (or ps, kill, etc.)
84
85For overcommit 'guess', we can sum resident set sizes (RSS).
86On x86_64 this is about 8MB.
87
88For overcommit 'never', we can take the max of their virtual sizes (VSZ)
89and add the sum of their RSS.
90On x86_64 this is about 128MB.
91
92Changing this takes effect whenever an application requests memory.
93
94==============================================================
95
Peter W Morrealedb0fb182009-01-15 13:50:42 -080096block_dump
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Peter W Morrealedb0fb182009-01-15 13:50:42 -080098block_dump enables block I/O debugging when set to a nonzero value. More
99information on block I/O debugging is in Documentation/laptops/laptop-mode.txt.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101==============================================================
102
Mel Gorman76ab0f52010-05-24 14:32:28 -0700103compact_memory
104
105Available only when CONFIG_COMPACTION is set. When 1 is written to the file,
106all zones are compacted such that free memory is available in contiguous
107blocks where possible. This can be important for example in the allocation of
108huge pages although processes will also directly compact memory as required.
109
110==============================================================
111
Eric B Munson5bbe3542015-04-15 16:13:20 -0700112compact_unevictable_allowed
113
114Available only when CONFIG_COMPACTION is set. When set to 1, compaction is
115allowed to examine the unevictable lru (mlocked pages) for pages to compact.
116This should be used on systems where stalls for minor page faults are an
117acceptable trade for large contiguous free memory. Set to 0 to prevent
118compaction from moving pages that are unevictable. Default value is 1.
119
120==============================================================
121
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800122dirty_background_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300124Contains the amount of dirty memory at which the background kernel
125flusher threads will start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Andrea Righiabffc022010-10-27 15:33:31 -0700127Note: dirty_background_bytes is the counterpart of dirty_background_ratio. Only
128one of them may be specified at a time. When one sysctl is written it is
129immediately taken into account to evaluate the dirty memory limits and the
130other appears as 0 when read.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132==============================================================
133
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800134dirty_background_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Zheng Liu715ea412013-11-12 15:08:30 -0800136Contains, as a percentage of total available memory that contains free pages
137and reclaimable pages, the number of pages at which the background kernel
138flusher threads will start writing out dirty data.
139
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000140The total available memory is not equal to total system memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142==============================================================
143
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800144dirty_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800146Contains the amount of dirty memory at which a process generating disk writes
147will itself start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Andrea Righiabffc022010-10-27 15:33:31 -0700149Note: dirty_bytes is the counterpart of dirty_ratio. Only one of them may be
150specified at a time. When one sysctl is written it is immediately taken into
151account to evaluate the dirty memory limits and the other appears as 0 when
152read.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800153
Andrea Righi9e4a5bd2009-04-30 15:08:57 -0700154Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
155value lower than this limit will be ignored and the old configuration will be
156retained.
157
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800158==============================================================
159
160dirty_expire_centisecs
161
162This tunable is used to define when dirty data is old enough to be eligible
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300163for writeout by the kernel flusher threads. It is expressed in 100'ths
164of a second. Data which has been dirty in-memory for longer than this
165interval will be written out next time a flusher thread wakes up.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800166
167==============================================================
168
169dirty_ratio
170
Zheng Liu715ea412013-11-12 15:08:30 -0800171Contains, as a percentage of total available memory that contains free pages
172and reclaimable pages, the number of pages at which a process which is
173generating disk writes will itself start writing out dirty data.
174
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000175The total available memory is not equal to total system memory.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800176
177==============================================================
178
179dirty_writeback_centisecs
180
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300181The kernel flusher threads will periodically wake up and write `old' data
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800182out to disk. This tunable expresses the interval between those wakeups, in
183100'ths of a second.
184
185Setting this to zero disables periodic writeback altogether.
186
187==============================================================
188
189drop_caches
190
Dave Hansen5509a5d2014-04-03 14:48:19 -0700191Writing to this will cause the kernel to drop clean caches, as well as
192reclaimable slab objects like dentries and inodes. Once dropped, their
193memory becomes free.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800194
195To free pagecache:
196 echo 1 > /proc/sys/vm/drop_caches
Dave Hansen5509a5d2014-04-03 14:48:19 -0700197To free reclaimable slab objects (includes dentries and inodes):
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800198 echo 2 > /proc/sys/vm/drop_caches
Dave Hansen5509a5d2014-04-03 14:48:19 -0700199To free slab objects and pagecache:
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800200 echo 3 > /proc/sys/vm/drop_caches
201
Dave Hansen5509a5d2014-04-03 14:48:19 -0700202This is a non-destructive operation and will not free any dirty objects.
203To increase the number of objects freed by this operation, the user may run
204`sync' prior to writing to /proc/sys/vm/drop_caches. This will minimize the
205number of dirty objects on the system and create more candidates to be
206dropped.
207
208This file is not a means to control the growth of the various kernel caches
209(inodes, dentries, pagecache, etc...) These objects are automatically
210reclaimed by the kernel when memory is needed elsewhere on the system.
211
212Use of this file can cause performance problems. Since it discards cached
213objects, it may cost a significant amount of I/O and CPU to recreate the
214dropped objects, especially if they were under heavy use. Because of this,
215use outside of a testing or debugging environment is not recommended.
216
217You may see informational messages in your kernel log when this file is
218used:
219
220 cat (1234): drop_caches: 3
221
222These are informational only. They do not mean that anything is wrong
223with your system. To disable them, echo 4 (bit 3) into drop_caches.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800224
225==============================================================
226
Mel Gorman5e771902010-05-24 14:32:31 -0700227extfrag_threshold
228
229This parameter affects whether the kernel will compact memory or direct
Rabin Vincenta10726b2015-07-14 07:35:11 +0200230reclaim to satisfy a high-order allocation. The extfrag/extfrag_index file in
231debugfs shows what the fragmentation index for each order is in each zone in
232the system. Values tending towards 0 imply allocations would fail due to lack
233of memory, values towards 1000 imply failures are due to fragmentation and -1
234implies that the allocation will succeed as long as watermarks are met.
Mel Gorman5e771902010-05-24 14:32:31 -0700235
236The kernel will not compact memory in a zone if the
237fragmentation index is <= extfrag_threshold. The default value is 500.
238
239==============================================================
240
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800241hugepages_treat_as_movable
242
Naoya Horiguchi86cdb462013-09-11 14:22:13 -0700243This parameter controls whether we can allocate hugepages from ZONE_MOVABLE
244or not. If set to non-zero, hugepages can be allocated from ZONE_MOVABLE.
245ZONE_MOVABLE is created when kernel boot parameter kernelcore= is specified,
246so this parameter has no effect if used without kernelcore=.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800247
Naoya Horiguchi86cdb462013-09-11 14:22:13 -0700248Hugepage migration is now available in some situations which depend on the
249architecture and/or the hugepage size. If a hugepage supports migration,
250allocation from ZONE_MOVABLE is always enabled for the hugepage regardless
251of the value of this parameter.
252IOW, this parameter affects only non-migratable hugepages.
253
254Assuming that hugepages are not migratable in your system, one usecase of
255this parameter is that users can make hugepage pool more extensible by
256enabling the allocation from ZONE_MOVABLE. This is because on ZONE_MOVABLE
257page reclaim/migration/compaction work more and you can get contiguous
258memory more likely. Note that using ZONE_MOVABLE for non-migratable
259hugepages can do harm to other features like memory hotremove (because
260memory hotremove expects that memory blocks on ZONE_MOVABLE are always
261removable,) so it's a trade-off responsible for the users.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800262
263==============================================================
264
265hugetlb_shm_group
266
267hugetlb_shm_group contains group id that is allowed to create SysV
268shared memory segment using hugetlb page.
269
270==============================================================
271
272laptop_mode
273
274laptop_mode is a knob that controls "laptop mode". All the things that are
275controlled by this knob are discussed in Documentation/laptops/laptop-mode.txt.
276
277==============================================================
278
279legacy_va_layout
280
Kulikov Vasiliy2174efb2010-06-28 13:59:28 +0200281If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800282will use the legacy (2.4) layout for all processes.
283
284==============================================================
285
286lowmem_reserve_ratio
287
288For some specialised workloads on highmem machines it is dangerous for
289the kernel to allow process memory to be allocated from the "lowmem"
290zone. This is because that memory could then be pinned via the mlock()
291system call, or by unavailability of swapspace.
292
293And on large highmem machines this lack of reclaimable lowmem memory
294can be fatal.
295
296So the Linux page allocator has a mechanism which prevents allocations
297which _could_ use highmem from using too much lowmem. This means that
298a certain amount of lowmem is defended from the possibility of being
299captured into pinned user memory.
300
301(The same argument applies to the old 16 megabyte ISA DMA region. This
302mechanism will also defend that region from allocations which could use
303highmem or lowmem).
304
305The `lowmem_reserve_ratio' tunable determines how aggressive the kernel is
306in defending these lower zones.
307
308If you have a machine which uses highmem or ISA DMA and your
309applications are using mlock(), or if you are running with no swap then
310you probably should change the lowmem_reserve_ratio setting.
311
312The lowmem_reserve_ratio is an array. You can see them by reading this file.
313-
314% cat /proc/sys/vm/lowmem_reserve_ratio
315256 256 32
316-
317Note: # of this elements is one fewer than number of zones. Because the highest
318 zone's value is not necessary for following calculation.
319
320But, these values are not used directly. The kernel calculates # of protection
321pages for each zones from them. These are shown as array of protection pages
322in /proc/zoneinfo like followings. (This is an example of x86-64 box).
323Each zone has an array of protection pages like this.
324
325-
326Node 0, zone DMA
327 pages free 1355
328 min 3
329 low 3
330 high 4
331 :
332 :
333 numa_other 0
334 protection: (0, 2004, 2004, 2004)
335 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
336 pagesets
337 cpu: 0 pcp: 0
338 :
339-
340These protections are added to score to judge whether this zone should be used
341for page allocation or should be reclaimed.
342
343In this example, if normal pages (index=2) are required to this DMA zone and
Mel Gorman41858962009-06-16 15:32:12 -0700344watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
345not be used because pages_free(1355) is smaller than watermark + protection[2]
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800346(4 + 2004 = 2008). If this protection value is 0, this zone would be used for
347normal page requirement. If requirement is DMA zone(index=0), protection[0]
348(=0) is used.
349
350zone[i]'s protection[j] is calculated by following expression.
351
352(i < j):
353 zone[i]->protection[j]
Yaowei Bai013110a2015-09-08 15:04:10 -0700354 = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800355 / lowmem_reserve_ratio[i];
356(i = j):
357 (should not be protected. = 0;
358(i > j):
359 (not necessary, but looks 0)
360
361The default values of lowmem_reserve_ratio[i] are
362 256 (if zone[i] means DMA or DMA32 zone)
363 32 (others).
364As above expression, they are reciprocal number of ratio.
Yaowei Bai013110a2015-09-08 15:04:10 -0700365256 means 1/256. # of protection pages becomes about "0.39%" of total managed
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800366pages of higher zones on the node.
367
368If you would like to protect more pages, smaller values are effective.
369The minimum value is 1 (1/1 -> 100%).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371==============================================================
372
373max_map_count:
374
375This file contains the maximum number of memory map areas a process
376may have. Memory map areas are used as a side-effect of calling
377malloc, directly by mmap and mprotect, and also when loading shared
378libraries.
379
380While most applications need less than a thousand maps, certain
381programs, particularly malloc debuggers, may consume lots of them,
382e.g., up to one or two maps per allocation.
383
384The default value is 65536.
385
Andi Kleen6a460792009-09-16 11:50:15 +0200386=============================================================
387
388memory_failure_early_kill:
389
390Control how to kill processes when uncorrected memory error (typically
391a 2bit error in a memory module) is detected in the background by hardware
392that cannot be handled by the kernel. In some cases (like the page
393still having a valid copy on disk) the kernel will handle the failure
394transparently without affecting any applications. But if there is
395no other uptodate copy of the data it will kill to prevent any data
396corruptions from propagating.
397
3981: Kill all processes that have the corrupted and not reloadable page mapped
399as soon as the corruption is detected. Note this is not supported
400for a few types of pages, like kernel internally allocated data or
401the swap cache, but works for the majority of user pages.
402
4030: Only unmap the corrupted page from all processes and only kill a process
404who tries to access it.
405
406The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
407handle this if they want to.
408
409This is only active on architectures/platforms with advanced machine
410check handling and depends on the hardware capabilities.
411
412Applications can override this setting individually with the PR_MCE_KILL prctl
413
414==============================================================
415
416memory_failure_recovery
417
418Enable memory failure recovery (when supported by the platform)
419
4201: Attempt recovery.
421
4220: Always panic on a memory failure.
423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424==============================================================
425
426min_free_kbytes:
427
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800428This is used to force the Linux VM to keep a minimum number
Mel Gorman41858962009-06-16 15:32:12 -0700429of kilobytes free. The VM uses this number to compute a
430watermark[WMARK_MIN] value for each lowmem zone in the system.
431Each lowmem zone gets a number of reserved free pages based
432proportionally on its size.
Rohit Seth8ad4b1f2006-01-08 01:00:40 -0800433
Matt LaPlanted9195882008-07-25 19:45:33 -0700434Some minimal amount of memory is needed to satisfy PF_MEMALLOC
Pavel Machek24950892007-10-16 23:31:28 -0700435allocations; if you set this to lower than 1024KB, your system will
436become subtly broken, and prone to deadlock under high loads.
437
438Setting this too high will OOM your machine instantly.
439
Christoph Lameter96146342006-07-03 00:24:13 -0700440=============================================================
441
Christoph Lameter0ff38492006-09-25 23:31:52 -0700442min_slab_ratio:
443
444This is available only on NUMA kernels.
445
446A percentage of the total pages in each zone. On Zone reclaim
447(fallback from the local zone occurs) slabs will be reclaimed if more
448than this percentage of pages in a zone are reclaimable slab pages.
449This insures that the slab growth stays under control even in NUMA
450systems that rarely perform global reclaim.
451
452The default is 5 percent.
453
454Note that slab reclaim is triggered in a per zone / node fashion.
455The process of reclaiming slab memory is currently not node specific
456and may not be fast.
457
458=============================================================
459
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800460min_unmapped_ratio:
KAMEZAWA Hiroyukifadd8fb2006-06-23 02:03:13 -0700461
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800462This is available only on NUMA kernels.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700463
Mel Gorman90afa5d2009-06-16 15:33:20 -0700464This is a percentage of the total pages in each zone. Zone reclaim will
465only occur if more than this percentage of pages are in a state that
466zone_reclaim_mode allows to be reclaimed.
467
468If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
469against all file-backed unmapped pages including swapcache pages and tmpfs
470files. Otherwise, only unmapped pages backed by normal files but not tmpfs
471files and similar are considered.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700472
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800473The default is 1 percent.
David Rientjesfe071d72007-10-16 23:25:56 -0700474
Eric Parised032182007-06-28 15:55:21 -0400475==============================================================
476
477mmap_min_addr
478
479This file indicates the amount of address space which a user process will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200480be restricted from mmapping. Since kernel null dereference bugs could
Eric Parised032182007-06-28 15:55:21 -0400481accidentally operate based on the information in the first couple of pages
482of memory userspace processes should not be allowed to write to them. By
483default this value is set to 0 and no protections will be enforced by the
484security module. Setting this value to something like 64k will allow the
485vast majority of applications to work correctly and provide defense in depth
486against future potential kernel bugs.
487
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700488==============================================================
489
Daniel Cashmand07e2252016-01-14 15:19:53 -0800490mmap_rnd_bits:
491
492This value can be used to select the number of bits to use to
493determine the random offset to the base address of vma regions
494resulting from mmap allocations on architectures which support
495tuning address space randomization. This value will be bounded
496by the architecture's minimum and maximum supported values.
497
498This value can be changed after boot using the
499/proc/sys/vm/mmap_rnd_bits tunable
500
501==============================================================
502
503mmap_rnd_compat_bits:
504
505This value can be used to select the number of bits to use to
506determine the random offset to the base address of vma regions
507resulting from mmap allocations for applications run in
508compatibility mode on architectures which support tuning address
509space randomization. This value will be bounded by the
510architecture's minimum and maximum supported values.
511
512This value can be changed after boot using the
513/proc/sys/vm/mmap_rnd_compat_bits tunable
514
515==============================================================
516
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800517nr_hugepages
518
519Change the minimum size of the hugepage pool.
520
521See Documentation/vm/hugetlbpage.txt
522
523==============================================================
524
525nr_overcommit_hugepages
526
527Change the maximum size of the hugepage pool. The maximum is
528nr_hugepages + nr_overcommit_hugepages.
529
530See Documentation/vm/hugetlbpage.txt
531
532==============================================================
533
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800534nr_trim_pages
535
536This is available only on NOMMU kernels.
537
538This value adjusts the excess page trimming behaviour of power-of-2 aligned
539NOMMU mmap allocations.
540
541A value of 0 disables trimming of allocations entirely, while a value of 1
542trims excess pages aggressively. Any value >= 1 acts as the watermark where
543trimming of allocations is initiated.
544
545The default value is 1.
546
547See Documentation/nommu-mmap.txt for more information.
548
549==============================================================
550
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700551numa_zonelist_order
552
553This sysctl is only for NUMA.
554'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
584Specify "[Dd]efault" to request automatic configuration. Autoconfiguration
585will select "node" order in following case.
586(1) if the DMA zone does not exist or
587(2) if the DMA zone comprises greater than 50% of the available memory or
Wanpeng Lif8f191f2013-07-08 16:00:16 -0700588(3) if any node's DMA zone comprises greater than 70% of its local memory and
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700589 the amount of local memory is big enough.
590
591Otherwise, "zone" order will be selected. Default order is recommended unless
592this is causing problems for your system/application.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800593
594==============================================================
595
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800596oom_dump_tasks
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800597
Kirill A. Shutemovdc6c9a32015-02-11 15:26:50 -0800598Enables a system-wide task dump (excluding kernel threads) to be produced
599when the kernel performs an OOM-killing and includes such information as
600pid, uid, tgid, vm size, rss, nr_ptes, nr_pmds, swapents, oom_score_adj
601score, and name. This is helpful to determine why the OOM killer was
602invoked, to identify the rogue task that caused it, and to determine why
603the OOM killer chose the task it did to kill.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800604
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800605If this is set to zero, this information is suppressed. On very
606large systems with thousands of tasks it may not be feasible to dump
607the memory state information for each one. Such systems should not
608be forced to incur a performance penalty in OOM conditions when the
609information may not be desired.
610
611If this is set to non-zero, this information is shown whenever the
612OOM killer actually kills a memory-hogging task.
613
David Rientjesad915c42010-08-09 17:18:53 -0700614The default value is 1 (enabled).
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800615
616==============================================================
617
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800618oom_kill_allocating_task
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800619
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800620This enables or disables killing the OOM-triggering task in
621out-of-memory situations.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800622
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800623If this is set to zero, the OOM killer will scan through the entire
624tasklist and select a task based on heuristics to kill. This normally
625selects a rogue memory-hogging task that frees up a large amount of
626memory when killed.
627
628If this is set to non-zero, the OOM killer simply kills the task that
629triggered the out-of-memory condition. This avoids the expensive
630tasklist scan.
631
632If panic_on_oom is selected, it takes precedence over whatever value
633is used in oom_kill_allocating_task.
634
635The default value is 0.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000636
637==============================================================
638
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800639overcommit_kbytes:
640
641When overcommit_memory is set to 2, the committed address space is not
642permitted to exceed swap plus this amount of physical RAM. See below.
643
644Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
645of them may be specified at a time. Setting one disables the other (which
646then appears as 0 when read).
647
648==============================================================
649
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800650overcommit_memory:
Paul Mundtdd8632a2009-01-08 12:04:47 +0000651
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800652This value contains a flag that enables memory overcommitment.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000653
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800654When this flag is 0, the kernel attempts to estimate the amount
655of free memory left when userspace requests more memory.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000656
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800657When this flag is 1, the kernel pretends there is always enough
658memory until it actually runs out.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000659
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800660When this flag is 2, the kernel uses a "never overcommit"
661policy that attempts to prevent any overcommit of memory.
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700662Note that user_reserve_kbytes affects this policy.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000663
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800664This feature can be very useful because there are a lot of
665programs that malloc() huge amounts of memory "just-in-case"
666and don't use much of it.
667
668The default value is 0.
669
670See Documentation/vm/overcommit-accounting and
Chun Chenc56050c2015-11-09 14:58:15 -0800671mm/mmap.c::__vm_enough_memory() for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800672
673==============================================================
674
675overcommit_ratio:
676
677When overcommit_memory is set to 2, the committed address
678space is not permitted to exceed swap plus this percentage
679of physical RAM. See above.
680
681==============================================================
682
683page-cluster
684
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700685page-cluster controls the number of pages up to which consecutive pages
686are read in from swap in a single attempt. This is the swap counterpart
687to page cache readahead.
688The mentioned consecutivity is not in terms of virtual/physical addresses,
689but consecutive on swap space - that means they were swapped out together.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800690
691It is a logarithmic value - setting it to zero means "1 page", setting
692it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700693Zero disables swap readahead completely.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800694
695The default value is three (eight pages at a time). There may be some
696small benefits in tuning this to a different value if your workload is
697swap-intensive.
698
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700699Lower values mean lower latencies for initial faults, but at the same time
700extra faults and I/O delays for following faults if they would have been part of
701that consecutive pages readahead would have brought in.
702
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800703=============================================================
704
705panic_on_oom
706
707This enables or disables panic on out-of-memory feature.
708
709If this is set to 0, the kernel will kill some rogue process,
710called oom_killer. Usually, oom_killer can kill rogue processes and
711system will survive.
712
713If this is set to 1, the kernel panics when out-of-memory happens.
714However, if a process limits using nodes by mempolicy/cpusets,
715and those nodes become memory exhaustion status, one process
716may be killed by oom-killer. No panic occurs in this case.
717Because other nodes' memory may be free. This means system total status
718may be not fatal yet.
719
720If this is set to 2, the kernel panics compulsorily even on the
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800721above-mentioned. Even oom happens under memory cgroup, the whole
722system panics.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800723
724The default value is 0.
7251 and 2 are for failover of clustering. Please select either
726according to your policy of failover.
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800727panic_on_oom=2+kdump gives you very strong tool to investigate
728why oom happens. You can get snapshot.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800729
730=============================================================
731
732percpu_pagelist_fraction
733
734This is the fraction of pages at most (high mark pcp->high) in each zone that
735are allocated for each per cpu page list. The min value for this is 8. It
736means that we don't allow more than 1/8th of pages in each zone to be
737allocated in any single per_cpu_pagelist. This entry only changes the value
738of hot per cpu pagelists. User can specify a number like 100 to allocate
7391/100th of each zone to each per cpu page list.
740
741The batch value of each per cpu pagelist is also updated as a result. It is
742set to pcp->high/4. The upper limit of batch is (PAGE_SHIFT * 8)
743
744The initial value is zero. Kernel does not use this value at boot time to set
David Rientjes7cd2b0a2014-06-23 13:22:04 -0700745the high water marks for each per cpu page list. If the user writes '0' to this
746sysctl, it will revert to this default behavior.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800747
748==============================================================
749
750stat_interval
751
752The time interval between which vm statistics are updated. The default
753is 1 second.
754
755==============================================================
756
757swappiness
758
759This control is used to define how aggressive the kernel will swap
760memory pages. Higher values will increase agressiveness, lower values
Aaron Tomlin8582cb92014-01-29 14:05:38 -0800761decrease the amount of swap. A value of 0 instructs the kernel not to
762initiate swap until the amount of free and file-backed pages is less
763than the high water mark in a zone.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800764
765The default value is 60.
766
767==============================================================
768
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700769- user_reserve_kbytes
770
Masanari Iida633708a2015-01-02 12:03:19 +0900771When overcommit_memory is set to 2, "never overcommit" mode, reserve
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700772min(3% of current process size, user_reserve_kbytes) of free memory.
773This is intended to prevent a user from starting a single memory hogging
774process, such that they cannot recover (kill the hog).
775
776user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
777
778If this is reduced to zero, then the user will be allowed to allocate
779all free memory with a single process, minus admin_reserve_kbytes.
780Any subsequent attempts to execute a command will result in
781"fork: Cannot allocate memory".
782
783Changing this takes effect whenever an application requests memory.
784
785==============================================================
786
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800787vfs_cache_pressure
788------------------
789
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700790This percentage value controls the tendency of the kernel to reclaim
791the memory which is used for caching of directory and inode objects.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800792
793At the default value of vfs_cache_pressure=100 the kernel will attempt to
794reclaim dentries and inodes at a "fair" rate with respect to pagecache and
795swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
Jan Kara55c37a82009-09-21 17:01:40 -0700796to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
797never reclaim dentries and inodes due to memory pressure and this can easily
798lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800799causes the kernel to prefer to reclaim dentries and inodes.
800
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700801Increasing vfs_cache_pressure significantly beyond 100 may have negative
802performance impact. Reclaim code needs to take various locks to find freeable
803directory and inode objects. With vfs_cache_pressure=1000, it will look for
804ten times more freeable objects than there are.
805
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700806=============================================================
807
808watermark_scale_factor:
809
810This factor controls the aggressiveness of kswapd. It defines the
811amount of memory left in a node/system before kswapd is woken up and
812how much memory needs to be free before kswapd goes back to sleep.
813
814The unit is in fractions of 10,000. The default value of 10 means the
815distances between watermarks are 0.1% of the available memory in the
816node/system. The maximum value is 1000, or 10% of memory.
817
818A high rate of threads entering direct reclaim (allocstall) or kswapd
819going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
820that the number of free pages kswapd maintains for latency reasons is
821too small for the allocation bursts occurring in the system. This knob
822can then be used to tune kswapd aggressiveness accordingly.
823
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800824==============================================================
825
826zone_reclaim_mode:
827
828Zone_reclaim_mode allows someone to set more or less aggressive approaches to
829reclaim memory when a zone runs out of memory. If it is set to zero then no
830zone reclaim occurs. Allocations will be satisfied from other zones / nodes
831in the system.
832
833This is value ORed together of
834
8351 = Zone reclaim on
8362 = Zone reclaim writes dirty pages out
8374 = Zone reclaim swaps pages
838
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700839zone_reclaim_mode is disabled by default. For file servers or workloads
840that benefit from having their data cached, zone_reclaim_mode should be
841left disabled as the caching effect is likely to be more important than
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800842data locality.
843
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700844zone_reclaim may be enabled if it's known that the workload is partitioned
845such that each partition fits within a NUMA node and that accessing remote
846memory would cause a measurable performance reduction. The page allocator
847will then reclaim easily reusable pages (those page cache pages that are
848currently not used) before allocating off node pages.
849
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800850Allowing zone reclaim to write out pages stops processes that are
851writing large amounts of data from dirtying pages on other nodes. Zone
852reclaim will write out dirty pages if a zone fills up and so effectively
853throttle the process. This may decrease the performance of a single process
854since it cannot use all of system memory to buffer the outgoing writes
855anymore but it preserve the memory on other nodes so that the performance
856of other processes running on other nodes will not be affected.
857
858Allowing regular swap effectively restricts allocations to the local
859node unless explicitly overridden by memory policies or cpuset
860configurations.
861
862============ End of Document =================================