Merge tag 'riscv/for-v5.3-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/riscv...
[sfrench/cifs-2.6.git] / Documentation / admin-guide / sysctl / vm.rst
1 ===============================
2 Documentation for /proc/sys/vm/
3 ===============================
4
5 kernel version 2.6.29
6
7 Copyright (c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
8
9 Copyright (c) 2008         Peter W. Morreale <pmorreale@novell.com>
10
11 For general info and legal blurb, please look in index.rst.
12
13 ------------------------------------------------------------------------------
14
15 This file contains the documentation for the sysctl files in
16 /proc/sys/vm and is valid for Linux kernel version 2.6.29.
17
18 The files in this directory can be used to tune the operation
19 of the virtual memory (VM) subsystem of the Linux kernel and
20 the writeout of dirty data to disk.
21
22 Default values and initialization routines for most of these
23 files can be found in mm/swap.c.
24
25 Currently, these files are in /proc/sys/vm:
26
27 - admin_reserve_kbytes
28 - block_dump
29 - compact_memory
30 - compact_unevictable_allowed
31 - dirty_background_bytes
32 - dirty_background_ratio
33 - dirty_bytes
34 - dirty_expire_centisecs
35 - dirty_ratio
36 - dirtytime_expire_seconds
37 - dirty_writeback_centisecs
38 - drop_caches
39 - extfrag_threshold
40 - hugetlb_shm_group
41 - laptop_mode
42 - legacy_va_layout
43 - lowmem_reserve_ratio
44 - max_map_count
45 - memory_failure_early_kill
46 - memory_failure_recovery
47 - min_free_kbytes
48 - min_slab_ratio
49 - min_unmapped_ratio
50 - mmap_min_addr
51 - mmap_rnd_bits
52 - mmap_rnd_compat_bits
53 - nr_hugepages
54 - nr_hugepages_mempolicy
55 - nr_overcommit_hugepages
56 - nr_trim_pages         (only if CONFIG_MMU=n)
57 - numa_zonelist_order
58 - oom_dump_tasks
59 - oom_kill_allocating_task
60 - overcommit_kbytes
61 - overcommit_memory
62 - overcommit_ratio
63 - page-cluster
64 - panic_on_oom
65 - percpu_pagelist_fraction
66 - stat_interval
67 - stat_refresh
68 - numa_stat
69 - swappiness
70 - unprivileged_userfaultfd
71 - user_reserve_kbytes
72 - vfs_cache_pressure
73 - watermark_boost_factor
74 - watermark_scale_factor
75 - zone_reclaim_mode
76
77
78 admin_reserve_kbytes
79 ====================
80
81 The amount of free memory in the system that should be reserved for users
82 with the capability cap_sys_admin.
83
84 admin_reserve_kbytes defaults to min(3% of free pages, 8MB)
85
86 That should provide enough for the admin to log in and kill a process,
87 if necessary, under the default overcommit 'guess' mode.
88
89 Systems running under overcommit 'never' should increase this to account
90 for the full Virtual Memory Size of programs used to recover. Otherwise,
91 root may not be able to log in to recover the system.
92
93 How do you calculate a minimum useful reserve?
94
95 sshd or login + bash (or some other shell) + top (or ps, kill, etc.)
96
97 For overcommit 'guess', we can sum resident set sizes (RSS).
98 On x86_64 this is about 8MB.
99
100 For overcommit 'never', we can take the max of their virtual sizes (VSZ)
101 and add the sum of their RSS.
102 On x86_64 this is about 128MB.
103
104 Changing this takes effect whenever an application requests memory.
105
106
107 block_dump
108 ==========
109
110 block_dump enables block I/O debugging when set to a nonzero value. More
111 information on block I/O debugging is in Documentation/admin-guide/laptops/laptop-mode.rst.
112
113
114 compact_memory
115 ==============
116
117 Available only when CONFIG_COMPACTION is set. When 1 is written to the file,
118 all zones are compacted such that free memory is available in contiguous
119 blocks where possible. This can be important for example in the allocation of
120 huge pages although processes will also directly compact memory as required.
121
122
123 compact_unevictable_allowed
124 ===========================
125
126 Available only when CONFIG_COMPACTION is set. When set to 1, compaction is
127 allowed to examine the unevictable lru (mlocked pages) for pages to compact.
128 This should be used on systems where stalls for minor page faults are an
129 acceptable trade for large contiguous free memory.  Set to 0 to prevent
130 compaction from moving pages that are unevictable.  Default value is 1.
131
132
133 dirty_background_bytes
134 ======================
135
136 Contains the amount of dirty memory at which the background kernel
137 flusher threads will start writeback.
138
139 Note:
140   dirty_background_bytes is the counterpart of dirty_background_ratio. Only
141   one of them may be specified at a time. When one sysctl is written it is
142   immediately taken into account to evaluate the dirty memory limits and the
143   other appears as 0 when read.
144
145
146 dirty_background_ratio
147 ======================
148
149 Contains, as a percentage of total available memory that contains free pages
150 and reclaimable pages, the number of pages at which the background kernel
151 flusher threads will start writing out dirty data.
152
153 The total available memory is not equal to total system memory.
154
155
156 dirty_bytes
157 ===========
158
159 Contains the amount of dirty memory at which a process generating disk writes
160 will itself start writeback.
161
162 Note: dirty_bytes is the counterpart of dirty_ratio. Only one of them may be
163 specified at a time. When one sysctl is written it is immediately taken into
164 account to evaluate the dirty memory limits and the other appears as 0 when
165 read.
166
167 Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
168 value lower than this limit will be ignored and the old configuration will be
169 retained.
170
171
172 dirty_expire_centisecs
173 ======================
174
175 This tunable is used to define when dirty data is old enough to be eligible
176 for writeout by the kernel flusher threads.  It is expressed in 100'ths
177 of a second.  Data which has been dirty in-memory for longer than this
178 interval will be written out next time a flusher thread wakes up.
179
180
181 dirty_ratio
182 ===========
183
184 Contains, as a percentage of total available memory that contains free pages
185 and reclaimable pages, the number of pages at which a process which is
186 generating disk writes will itself start writing out dirty data.
187
188 The total available memory is not equal to total system memory.
189
190
191 dirtytime_expire_seconds
192 ========================
193
194 When a lazytime inode is constantly having its pages dirtied, the inode with
195 an updated timestamp will never get chance to be written out.  And, if the
196 only thing that has happened on the file system is a dirtytime inode caused
197 by an atime update, a worker will be scheduled to make sure that inode
198 eventually gets pushed out to disk.  This tunable is used to define when dirty
199 inode is old enough to be eligible for writeback by the kernel flusher threads.
200 And, it is also used as the interval to wakeup dirtytime_writeback thread.
201
202
203 dirty_writeback_centisecs
204 =========================
205
206 The kernel flusher threads will periodically wake up and write `old` data
207 out to disk.  This tunable expresses the interval between those wakeups, in
208 100'ths of a second.
209
210 Setting this to zero disables periodic writeback altogether.
211
212
213 drop_caches
214 ===========
215
216 Writing to this will cause the kernel to drop clean caches, as well as
217 reclaimable slab objects like dentries and inodes.  Once dropped, their
218 memory becomes free.
219
220 To free pagecache::
221
222         echo 1 > /proc/sys/vm/drop_caches
223
224 To free reclaimable slab objects (includes dentries and inodes)::
225
226         echo 2 > /proc/sys/vm/drop_caches
227
228 To free slab objects and pagecache::
229
230         echo 3 > /proc/sys/vm/drop_caches
231
232 This is a non-destructive operation and will not free any dirty objects.
233 To increase the number of objects freed by this operation, the user may run
234 `sync` prior to writing to /proc/sys/vm/drop_caches.  This will minimize the
235 number of dirty objects on the system and create more candidates to be
236 dropped.
237
238 This file is not a means to control the growth of the various kernel caches
239 (inodes, dentries, pagecache, etc...)  These objects are automatically
240 reclaimed by the kernel when memory is needed elsewhere on the system.
241
242 Use of this file can cause performance problems.  Since it discards cached
243 objects, it may cost a significant amount of I/O and CPU to recreate the
244 dropped objects, especially if they were under heavy use.  Because of this,
245 use outside of a testing or debugging environment is not recommended.
246
247 You may see informational messages in your kernel log when this file is
248 used::
249
250         cat (1234): drop_caches: 3
251
252 These are informational only.  They do not mean that anything is wrong
253 with your system.  To disable them, echo 4 (bit 2) into drop_caches.
254
255
256 extfrag_threshold
257 =================
258
259 This parameter affects whether the kernel will compact memory or direct
260 reclaim to satisfy a high-order allocation. The extfrag/extfrag_index file in
261 debugfs shows what the fragmentation index for each order is in each zone in
262 the system. Values tending towards 0 imply allocations would fail due to lack
263 of memory, values towards 1000 imply failures are due to fragmentation and -1
264 implies that the allocation will succeed as long as watermarks are met.
265
266 The kernel will not compact memory in a zone if the
267 fragmentation index is <= extfrag_threshold. The default value is 500.
268
269
270 highmem_is_dirtyable
271 ====================
272
273 Available only for systems with CONFIG_HIGHMEM enabled (32b systems).
274
275 This parameter controls whether the high memory is considered for dirty
276 writers throttling.  This is not the case by default which means that
277 only the amount of memory directly visible/usable by the kernel can
278 be dirtied. As a result, on systems with a large amount of memory and
279 lowmem basically depleted writers might be throttled too early and
280 streaming writes can get very slow.
281
282 Changing the value to non zero would allow more memory to be dirtied
283 and thus allow writers to write more data which can be flushed to the
284 storage more effectively. Note this also comes with a risk of pre-mature
285 OOM killer because some writers (e.g. direct block device writes) can
286 only use the low memory and they can fill it up with dirty data without
287 any throttling.
288
289
290 hugetlb_shm_group
291 =================
292
293 hugetlb_shm_group contains group id that is allowed to create SysV
294 shared memory segment using hugetlb page.
295
296
297 laptop_mode
298 ===========
299
300 laptop_mode is a knob that controls "laptop mode". All the things that are
301 controlled by this knob are discussed in Documentation/admin-guide/laptops/laptop-mode.rst.
302
303
304 legacy_va_layout
305 ================
306
307 If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
308 will use the legacy (2.4) layout for all processes.
309
310
311 lowmem_reserve_ratio
312 ====================
313
314 For some specialised workloads on highmem machines it is dangerous for
315 the kernel to allow process memory to be allocated from the "lowmem"
316 zone.  This is because that memory could then be pinned via the mlock()
317 system call, or by unavailability of swapspace.
318
319 And on large highmem machines this lack of reclaimable lowmem memory
320 can be fatal.
321
322 So the Linux page allocator has a mechanism which prevents allocations
323 which *could* use highmem from using too much lowmem.  This means that
324 a certain amount of lowmem is defended from the possibility of being
325 captured into pinned user memory.
326
327 (The same argument applies to the old 16 megabyte ISA DMA region.  This
328 mechanism will also defend that region from allocations which could use
329 highmem or lowmem).
330
331 The `lowmem_reserve_ratio` tunable determines how aggressive the kernel is
332 in defending these lower zones.
333
334 If you have a machine which uses highmem or ISA DMA and your
335 applications are using mlock(), or if you are running with no swap then
336 you probably should change the lowmem_reserve_ratio setting.
337
338 The lowmem_reserve_ratio is an array. You can see them by reading this file::
339
340         % cat /proc/sys/vm/lowmem_reserve_ratio
341         256     256     32
342
343 But, these values are not used directly. The kernel calculates # of protection
344 pages for each zones from them. These are shown as array of protection pages
345 in /proc/zoneinfo like followings. (This is an example of x86-64 box).
346 Each zone has an array of protection pages like this::
347
348   Node 0, zone      DMA
349     pages free     1355
350           min      3
351           low      3
352           high     4
353         :
354         :
355       numa_other   0
356           protection: (0, 2004, 2004, 2004)
357         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
358     pagesets
359       cpu: 0 pcp: 0
360           :
361
362 These protections are added to score to judge whether this zone should be used
363 for page allocation or should be reclaimed.
364
365 In this example, if normal pages (index=2) are required to this DMA zone and
366 watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
367 not be used because pages_free(1355) is smaller than watermark + protection[2]
368 (4 + 2004 = 2008). If this protection value is 0, this zone would be used for
369 normal page requirement. If requirement is DMA zone(index=0), protection[0]
370 (=0) is used.
371
372 zone[i]'s protection[j] is calculated by following expression::
373
374   (i < j):
375     zone[i]->protection[j]
376     = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
377       / lowmem_reserve_ratio[i];
378   (i = j):
379      (should not be protected. = 0;
380   (i > j):
381      (not necessary, but looks 0)
382
383 The default values of lowmem_reserve_ratio[i] are
384
385     === ====================================
386     256 (if zone[i] means DMA or DMA32 zone)
387     32  (others)
388     === ====================================
389
390 As above expression, they are reciprocal number of ratio.
391 256 means 1/256. # of protection pages becomes about "0.39%" of total managed
392 pages of higher zones on the node.
393
394 If you would like to protect more pages, smaller values are effective.
395 The minimum value is 1 (1/1 -> 100%). The value less than 1 completely
396 disables protection of the pages.
397
398
399 max_map_count:
400 ==============
401
402 This file contains the maximum number of memory map areas a process
403 may have. Memory map areas are used as a side-effect of calling
404 malloc, directly by mmap, mprotect, and madvise, and also when loading
405 shared libraries.
406
407 While most applications need less than a thousand maps, certain
408 programs, particularly malloc debuggers, may consume lots of them,
409 e.g., up to one or two maps per allocation.
410
411 The default value is 65536.
412
413
414 memory_failure_early_kill:
415 ==========================
416
417 Control how to kill processes when uncorrected memory error (typically
418 a 2bit error in a memory module) is detected in the background by hardware
419 that cannot be handled by the kernel. In some cases (like the page
420 still having a valid copy on disk) the kernel will handle the failure
421 transparently without affecting any applications. But if there is
422 no other uptodate copy of the data it will kill to prevent any data
423 corruptions from propagating.
424
425 1: Kill all processes that have the corrupted and not reloadable page mapped
426 as soon as the corruption is detected.  Note this is not supported
427 for a few types of pages, like kernel internally allocated data or
428 the swap cache, but works for the majority of user pages.
429
430 0: Only unmap the corrupted page from all processes and only kill a process
431 who tries to access it.
432
433 The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
434 handle this if they want to.
435
436 This is only active on architectures/platforms with advanced machine
437 check handling and depends on the hardware capabilities.
438
439 Applications can override this setting individually with the PR_MCE_KILL prctl
440
441
442 memory_failure_recovery
443 =======================
444
445 Enable memory failure recovery (when supported by the platform)
446
447 1: Attempt recovery.
448
449 0: Always panic on a memory failure.
450
451
452 min_free_kbytes
453 ===============
454
455 This is used to force the Linux VM to keep a minimum number
456 of kilobytes free.  The VM uses this number to compute a
457 watermark[WMARK_MIN] value for each lowmem zone in the system.
458 Each lowmem zone gets a number of reserved free pages based
459 proportionally on its size.
460
461 Some minimal amount of memory is needed to satisfy PF_MEMALLOC
462 allocations; if you set this to lower than 1024KB, your system will
463 become subtly broken, and prone to deadlock under high loads.
464
465 Setting this too high will OOM your machine instantly.
466
467
468 min_slab_ratio
469 ==============
470
471 This is available only on NUMA kernels.
472
473 A percentage of the total pages in each zone.  On Zone reclaim
474 (fallback from the local zone occurs) slabs will be reclaimed if more
475 than this percentage of pages in a zone are reclaimable slab pages.
476 This insures that the slab growth stays under control even in NUMA
477 systems that rarely perform global reclaim.
478
479 The default is 5 percent.
480
481 Note that slab reclaim is triggered in a per zone / node fashion.
482 The process of reclaiming slab memory is currently not node specific
483 and may not be fast.
484
485
486 min_unmapped_ratio
487 ==================
488
489 This is available only on NUMA kernels.
490
491 This is a percentage of the total pages in each zone. Zone reclaim will
492 only occur if more than this percentage of pages are in a state that
493 zone_reclaim_mode allows to be reclaimed.
494
495 If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
496 against all file-backed unmapped pages including swapcache pages and tmpfs
497 files. Otherwise, only unmapped pages backed by normal files but not tmpfs
498 files and similar are considered.
499
500 The default is 1 percent.
501
502
503 mmap_min_addr
504 =============
505
506 This file indicates the amount of address space  which a user process will
507 be restricted from mmapping.  Since kernel null dereference bugs could
508 accidentally operate based on the information in the first couple of pages
509 of memory userspace processes should not be allowed to write to them.  By
510 default this value is set to 0 and no protections will be enforced by the
511 security module.  Setting this value to something like 64k will allow the
512 vast majority of applications to work correctly and provide defense in depth
513 against future potential kernel bugs.
514
515
516 mmap_rnd_bits
517 =============
518
519 This value can be used to select the number of bits to use to
520 determine the random offset to the base address of vma regions
521 resulting from mmap allocations on architectures which support
522 tuning address space randomization.  This value will be bounded
523 by the architecture's minimum and maximum supported values.
524
525 This value can be changed after boot using the
526 /proc/sys/vm/mmap_rnd_bits tunable
527
528
529 mmap_rnd_compat_bits
530 ====================
531
532 This value can be used to select the number of bits to use to
533 determine the random offset to the base address of vma regions
534 resulting from mmap allocations for applications run in
535 compatibility mode on architectures which support tuning address
536 space randomization.  This value will be bounded by the
537 architecture's minimum and maximum supported values.
538
539 This value can be changed after boot using the
540 /proc/sys/vm/mmap_rnd_compat_bits tunable
541
542
543 nr_hugepages
544 ============
545
546 Change the minimum size of the hugepage pool.
547
548 See Documentation/admin-guide/mm/hugetlbpage.rst
549
550
551 nr_hugepages_mempolicy
552 ======================
553
554 Change the size of the hugepage pool at run-time on a specific
555 set of NUMA nodes.
556
557 See Documentation/admin-guide/mm/hugetlbpage.rst
558
559
560 nr_overcommit_hugepages
561 =======================
562
563 Change the maximum size of the hugepage pool. The maximum is
564 nr_hugepages + nr_overcommit_hugepages.
565
566 See Documentation/admin-guide/mm/hugetlbpage.rst
567
568
569 nr_trim_pages
570 =============
571
572 This is available only on NOMMU kernels.
573
574 This value adjusts the excess page trimming behaviour of power-of-2 aligned
575 NOMMU mmap allocations.
576
577 A value of 0 disables trimming of allocations entirely, while a value of 1
578 trims excess pages aggressively. Any value >= 1 acts as the watermark where
579 trimming of allocations is initiated.
580
581 The default value is 1.
582
583 See Documentation/nommu-mmap.txt for more information.
584
585
586 numa_zonelist_order
587 ===================
588
589 This sysctl is only for NUMA and it is deprecated. Anything but
590 Node order will fail!
591
592 'where the memory is allocated from' is controlled by zonelists.
593
594 (This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
595 you may be able to read ZONE_DMA as ZONE_DMA32...)
596
597 In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
598 ZONE_NORMAL -> ZONE_DMA
599 This means that a memory allocation request for GFP_KERNEL will
600 get memory from ZONE_DMA only when ZONE_NORMAL is not available.
601
602 In NUMA case, you can think of following 2 types of order.
603 Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL::
604
605   (A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
606   (B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
607
608 Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
609 will be used before ZONE_NORMAL exhaustion. This increases possibility of
610 out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
611
612 Type(B) cannot offer the best locality but is more robust against OOM of
613 the DMA zone.
614
615 Type(A) is called as "Node" order. Type (B) is "Zone" order.
616
617 "Node order" orders the zonelists by node, then by zone within each node.
618 Specify "[Nn]ode" for node order
619
620 "Zone Order" orders the zonelists by zone type, then by node within each
621 zone.  Specify "[Zz]one" for zone order.
622
623 Specify "[Dd]efault" to request automatic configuration.
624
625 On 32-bit, the Normal zone needs to be preserved for allocations accessible
626 by the kernel, so "zone" order will be selected.
627
628 On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
629 order will be selected.
630
631 Default order is recommended unless this is causing problems for your
632 system/application.
633
634
635 oom_dump_tasks
636 ==============
637
638 Enables a system-wide task dump (excluding kernel threads) to be produced
639 when the kernel performs an OOM-killing and includes such information as
640 pid, uid, tgid, vm size, rss, pgtables_bytes, swapents, oom_score_adj
641 score, and name.  This is helpful to determine why the OOM killer was
642 invoked, to identify the rogue task that caused it, and to determine why
643 the OOM killer chose the task it did to kill.
644
645 If this is set to zero, this information is suppressed.  On very
646 large systems with thousands of tasks it may not be feasible to dump
647 the memory state information for each one.  Such systems should not
648 be forced to incur a performance penalty in OOM conditions when the
649 information may not be desired.
650
651 If this is set to non-zero, this information is shown whenever the
652 OOM killer actually kills a memory-hogging task.
653
654 The default value is 1 (enabled).
655
656
657 oom_kill_allocating_task
658 ========================
659
660 This enables or disables killing the OOM-triggering task in
661 out-of-memory situations.
662
663 If this is set to zero, the OOM killer will scan through the entire
664 tasklist and select a task based on heuristics to kill.  This normally
665 selects a rogue memory-hogging task that frees up a large amount of
666 memory when killed.
667
668 If this is set to non-zero, the OOM killer simply kills the task that
669 triggered the out-of-memory condition.  This avoids the expensive
670 tasklist scan.
671
672 If panic_on_oom is selected, it takes precedence over whatever value
673 is used in oom_kill_allocating_task.
674
675 The default value is 0.
676
677
678 overcommit_kbytes
679 =================
680
681 When overcommit_memory is set to 2, the committed address space is not
682 permitted to exceed swap plus this amount of physical RAM. See below.
683
684 Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
685 of them may be specified at a time. Setting one disables the other (which
686 then appears as 0 when read).
687
688
689 overcommit_memory
690 =================
691
692 This value contains a flag that enables memory overcommitment.
693
694 When this flag is 0, the kernel attempts to estimate the amount
695 of free memory left when userspace requests more memory.
696
697 When this flag is 1, the kernel pretends there is always enough
698 memory until it actually runs out.
699
700 When this flag is 2, the kernel uses a "never overcommit"
701 policy that attempts to prevent any overcommit of memory.
702 Note that user_reserve_kbytes affects this policy.
703
704 This feature can be very useful because there are a lot of
705 programs that malloc() huge amounts of memory "just-in-case"
706 and don't use much of it.
707
708 The default value is 0.
709
710 See Documentation/vm/overcommit-accounting.rst and
711 mm/util.c::__vm_enough_memory() for more information.
712
713
714 overcommit_ratio
715 ================
716
717 When overcommit_memory is set to 2, the committed address
718 space is not permitted to exceed swap plus this percentage
719 of physical RAM.  See above.
720
721
722 page-cluster
723 ============
724
725 page-cluster controls the number of pages up to which consecutive pages
726 are read in from swap in a single attempt. This is the swap counterpart
727 to page cache readahead.
728 The mentioned consecutivity is not in terms of virtual/physical addresses,
729 but consecutive on swap space - that means they were swapped out together.
730
731 It is a logarithmic value - setting it to zero means "1 page", setting
732 it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
733 Zero disables swap readahead completely.
734
735 The default value is three (eight pages at a time).  There may be some
736 small benefits in tuning this to a different value if your workload is
737 swap-intensive.
738
739 Lower values mean lower latencies for initial faults, but at the same time
740 extra faults and I/O delays for following faults if they would have been part of
741 that consecutive pages readahead would have brought in.
742
743
744 panic_on_oom
745 ============
746
747 This enables or disables panic on out-of-memory feature.
748
749 If this is set to 0, the kernel will kill some rogue process,
750 called oom_killer.  Usually, oom_killer can kill rogue processes and
751 system will survive.
752
753 If this is set to 1, the kernel panics when out-of-memory happens.
754 However, if a process limits using nodes by mempolicy/cpusets,
755 and those nodes become memory exhaustion status, one process
756 may be killed by oom-killer. No panic occurs in this case.
757 Because other nodes' memory may be free. This means system total status
758 may be not fatal yet.
759
760 If this is set to 2, the kernel panics compulsorily even on the
761 above-mentioned. Even oom happens under memory cgroup, the whole
762 system panics.
763
764 The default value is 0.
765
766 1 and 2 are for failover of clustering. Please select either
767 according to your policy of failover.
768
769 panic_on_oom=2+kdump gives you very strong tool to investigate
770 why oom happens. You can get snapshot.
771
772
773 percpu_pagelist_fraction
774 ========================
775
776 This is the fraction of pages at most (high mark pcp->high) in each zone that
777 are allocated for each per cpu page list.  The min value for this is 8.  It
778 means that we don't allow more than 1/8th of pages in each zone to be
779 allocated in any single per_cpu_pagelist.  This entry only changes the value
780 of hot per cpu pagelists.  User can specify a number like 100 to allocate
781 1/100th of each zone to each per cpu page list.
782
783 The batch value of each per cpu pagelist is also updated as a result.  It is
784 set to pcp->high/4.  The upper limit of batch is (PAGE_SHIFT * 8)
785
786 The initial value is zero.  Kernel does not use this value at boot time to set
787 the high water marks for each per cpu page list.  If the user writes '0' to this
788 sysctl, it will revert to this default behavior.
789
790
791 stat_interval
792 =============
793
794 The time interval between which vm statistics are updated.  The default
795 is 1 second.
796
797
798 stat_refresh
799 ============
800
801 Any read or write (by root only) flushes all the per-cpu vm statistics
802 into their global totals, for more accurate reports when testing
803 e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
804
805 As a side-effect, it also checks for negative totals (elsewhere reported
806 as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
807 (At time of writing, a few stats are known sometimes to be found negative,
808 with no ill effects: errors and warnings on these stats are suppressed.)
809
810
811 numa_stat
812 =========
813
814 This interface allows runtime configuration of numa statistics.
815
816 When page allocation performance becomes a bottleneck and you can tolerate
817 some possible tool breakage and decreased numa counter precision, you can
818 do::
819
820         echo 0 > /proc/sys/vm/numa_stat
821
822 When page allocation performance is not a bottleneck and you want all
823 tooling to work, you can do::
824
825         echo 1 > /proc/sys/vm/numa_stat
826
827
828 swappiness
829 ==========
830
831 This control is used to define how aggressive the kernel will swap
832 memory pages.  Higher values will increase aggressiveness, lower values
833 decrease the amount of swap.  A value of 0 instructs the kernel not to
834 initiate swap until the amount of free and file-backed pages is less
835 than the high water mark in a zone.
836
837 The default value is 60.
838
839
840 unprivileged_userfaultfd
841 ========================
842
843 This flag controls whether unprivileged users can use the userfaultfd
844 system calls.  Set this to 1 to allow unprivileged users to use the
845 userfaultfd system calls, or set this to 0 to restrict userfaultfd to only
846 privileged users (with SYS_CAP_PTRACE capability).
847
848 The default value is 1.
849
850
851 user_reserve_kbytes
852 ===================
853
854 When overcommit_memory is set to 2, "never overcommit" mode, reserve
855 min(3% of current process size, user_reserve_kbytes) of free memory.
856 This is intended to prevent a user from starting a single memory hogging
857 process, such that they cannot recover (kill the hog).
858
859 user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
860
861 If this is reduced to zero, then the user will be allowed to allocate
862 all free memory with a single process, minus admin_reserve_kbytes.
863 Any subsequent attempts to execute a command will result in
864 "fork: Cannot allocate memory".
865
866 Changing this takes effect whenever an application requests memory.
867
868
869 vfs_cache_pressure
870 ==================
871
872 This percentage value controls the tendency of the kernel to reclaim
873 the memory which is used for caching of directory and inode objects.
874
875 At the default value of vfs_cache_pressure=100 the kernel will attempt to
876 reclaim dentries and inodes at a "fair" rate with respect to pagecache and
877 swapcache reclaim.  Decreasing vfs_cache_pressure causes the kernel to prefer
878 to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
879 never reclaim dentries and inodes due to memory pressure and this can easily
880 lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
881 causes the kernel to prefer to reclaim dentries and inodes.
882
883 Increasing vfs_cache_pressure significantly beyond 100 may have negative
884 performance impact. Reclaim code needs to take various locks to find freeable
885 directory and inode objects. With vfs_cache_pressure=1000, it will look for
886 ten times more freeable objects than there are.
887
888
889 watermark_boost_factor
890 ======================
891
892 This factor controls the level of reclaim when memory is being fragmented.
893 It defines the percentage of the high watermark of a zone that will be
894 reclaimed if pages of different mobility are being mixed within pageblocks.
895 The intent is that compaction has less work to do in the future and to
896 increase the success rate of future high-order allocations such as SLUB
897 allocations, THP and hugetlbfs pages.
898
899 To make it sensible with respect to the watermark_scale_factor
900 parameter, the unit is in fractions of 10,000. The default value of
901 15,000 on !DISCONTIGMEM configurations means that up to 150% of the high
902 watermark will be reclaimed in the event of a pageblock being mixed due
903 to fragmentation. The level of reclaim is determined by the number of
904 fragmentation events that occurred in the recent past. If this value is
905 smaller than a pageblock then a pageblocks worth of pages will be reclaimed
906 (e.g.  2MB on 64-bit x86). A boost factor of 0 will disable the feature.
907
908
909 watermark_scale_factor
910 ======================
911
912 This factor controls the aggressiveness of kswapd. It defines the
913 amount of memory left in a node/system before kswapd is woken up and
914 how much memory needs to be free before kswapd goes back to sleep.
915
916 The unit is in fractions of 10,000. The default value of 10 means the
917 distances between watermarks are 0.1% of the available memory in the
918 node/system. The maximum value is 1000, or 10% of memory.
919
920 A high rate of threads entering direct reclaim (allocstall) or kswapd
921 going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
922 that the number of free pages kswapd maintains for latency reasons is
923 too small for the allocation bursts occurring in the system. This knob
924 can then be used to tune kswapd aggressiveness accordingly.
925
926
927 zone_reclaim_mode
928 =================
929
930 Zone_reclaim_mode allows someone to set more or less aggressive approaches to
931 reclaim memory when a zone runs out of memory. If it is set to zero then no
932 zone reclaim occurs. Allocations will be satisfied from other zones / nodes
933 in the system.
934
935 This is value OR'ed together of
936
937 =       ===================================
938 1       Zone reclaim on
939 2       Zone reclaim writes dirty pages out
940 4       Zone reclaim swaps pages
941 =       ===================================
942
943 zone_reclaim_mode is disabled by default.  For file servers or workloads
944 that benefit from having their data cached, zone_reclaim_mode should be
945 left disabled as the caching effect is likely to be more important than
946 data locality.
947
948 zone_reclaim may be enabled if it's known that the workload is partitioned
949 such that each partition fits within a NUMA node and that accessing remote
950 memory would cause a measurable performance reduction.  The page allocator
951 will then reclaim easily reusable pages (those page cache pages that are
952 currently not used) before allocating off node pages.
953
954 Allowing zone reclaim to write out pages stops processes that are
955 writing large amounts of data from dirtying pages on other nodes. Zone
956 reclaim will write out dirty pages if a zone fills up and so effectively
957 throttle the process. This may decrease the performance of a single process
958 since it cannot use all of system memory to buffer the outgoing writes
959 anymore but it preserve the memory on other nodes so that the performance
960 of other processes running on other nodes will not be affected.
961
962 Allowing regular swap effectively restricts allocations to the local
963 node unless explicitly overridden by memory policies or cpuset
964 configurations.