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