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