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