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