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