mm: prevent divide error for small values of vm_dirty_bytes
[linux-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 - block_dump
22 - dirty_background_bytes
23 - dirty_background_ratio
24 - dirty_bytes
25 - dirty_expire_centisecs
26 - dirty_ratio
27 - dirty_writeback_centisecs
28 - drop_caches
29 - hugepages_treat_as_movable
30 - hugetlb_shm_group
31 - laptop_mode
32 - legacy_va_layout
33 - lowmem_reserve_ratio
34 - max_map_count
35 - min_free_kbytes
36 - min_slab_ratio
37 - min_unmapped_ratio
38 - mmap_min_addr
39 - nr_hugepages
40 - nr_overcommit_hugepages
41 - nr_pdflush_threads
42 - nr_pdflush_threads_min
43 - nr_pdflush_threads_max
44 - nr_trim_pages         (only if CONFIG_MMU=n)
45 - numa_zonelist_order
46 - oom_dump_tasks
47 - oom_kill_allocating_task
48 - overcommit_memory
49 - overcommit_ratio
50 - page-cluster
51 - panic_on_oom
52 - percpu_pagelist_fraction
53 - stat_interval
54 - swappiness
55 - vfs_cache_pressure
56 - zone_reclaim_mode
57
58
59 ==============================================================
60
61 block_dump
62
63 block_dump enables block I/O debugging when set to a nonzero value. More
64 information on block I/O debugging is in Documentation/laptops/laptop-mode.txt.
65
66 ==============================================================
67
68 dirty_background_bytes
69
70 Contains the amount of dirty memory at which the pdflush background writeback
71 daemon will start writeback.
72
73 If dirty_background_bytes is written, dirty_background_ratio becomes a function
74 of its value (dirty_background_bytes / the amount of dirtyable system memory).
75
76 ==============================================================
77
78 dirty_background_ratio
79
80 Contains, as a percentage of total system memory, the number of pages at which
81 the pdflush background writeback daemon will start writing out dirty data.
82
83 ==============================================================
84
85 dirty_bytes
86
87 Contains the amount of dirty memory at which a process generating disk writes
88 will itself start writeback.
89
90 If dirty_bytes is written, dirty_ratio becomes a function of its value
91 (dirty_bytes / the amount of dirtyable system memory).
92
93 Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
94 value lower than this limit will be ignored and the old configuration will be
95 retained.
96
97 ==============================================================
98
99 dirty_expire_centisecs
100
101 This tunable is used to define when dirty data is old enough to be eligible
102 for writeout by the pdflush daemons.  It is expressed in 100'ths of a second.
103 Data which has been dirty in-memory for longer than this interval will be
104 written out next time a pdflush daemon wakes up.
105
106 ==============================================================
107
108 dirty_ratio
109
110 Contains, as a percentage of total system memory, the number of pages at which
111 a process which is generating disk writes will itself start writing out dirty
112 data.
113
114 ==============================================================
115
116 dirty_writeback_centisecs
117
118 The pdflush writeback daemons will periodically wake up and write `old' data
119 out to disk.  This tunable expresses the interval between those wakeups, in
120 100'ths of a second.
121
122 Setting this to zero disables periodic writeback altogether.
123
124 ==============================================================
125
126 drop_caches
127
128 Writing to this will cause the kernel to drop clean caches, dentries and
129 inodes from memory, causing that memory to become free.
130
131 To free pagecache:
132         echo 1 > /proc/sys/vm/drop_caches
133 To free dentries and inodes:
134         echo 2 > /proc/sys/vm/drop_caches
135 To free pagecache, dentries and inodes:
136         echo 3 > /proc/sys/vm/drop_caches
137
138 As this is a non-destructive operation and dirty objects are not freeable, the
139 user should run `sync' first.
140
141 ==============================================================
142
143 hugepages_treat_as_movable
144
145 This parameter is only useful when kernelcore= is specified at boot time to
146 create ZONE_MOVABLE for pages that may be reclaimed or migrated. Huge pages
147 are not movable so are not normally allocated from ZONE_MOVABLE. A non-zero
148 value written to hugepages_treat_as_movable allows huge pages to be allocated
149 from ZONE_MOVABLE.
150
151 Once enabled, the ZONE_MOVABLE is treated as an area of memory the huge
152 pages pool can easily grow or shrink within. Assuming that applications are
153 not running that mlock() a lot of memory, it is likely the huge pages pool
154 can grow to the size of ZONE_MOVABLE by repeatedly entering the desired value
155 into nr_hugepages and triggering page reclaim.
156
157 ==============================================================
158
159 hugetlb_shm_group
160
161 hugetlb_shm_group contains group id that is allowed to create SysV
162 shared memory segment using hugetlb page.
163
164 ==============================================================
165
166 laptop_mode
167
168 laptop_mode is a knob that controls "laptop mode". All the things that are
169 controlled by this knob are discussed in Documentation/laptops/laptop-mode.txt.
170
171 ==============================================================
172
173 legacy_va_layout
174
175 If non-zero, this sysctl disables the new 32-bit mmap mmap layout - the kernel
176 will use the legacy (2.4) layout for all processes.
177
178 ==============================================================
179
180 lowmem_reserve_ratio
181
182 For some specialised workloads on highmem machines it is dangerous for
183 the kernel to allow process memory to be allocated from the "lowmem"
184 zone.  This is because that memory could then be pinned via the mlock()
185 system call, or by unavailability of swapspace.
186
187 And on large highmem machines this lack of reclaimable lowmem memory
188 can be fatal.
189
190 So the Linux page allocator has a mechanism which prevents allocations
191 which _could_ use highmem from using too much lowmem.  This means that
192 a certain amount of lowmem is defended from the possibility of being
193 captured into pinned user memory.
194
195 (The same argument applies to the old 16 megabyte ISA DMA region.  This
196 mechanism will also defend that region from allocations which could use
197 highmem or lowmem).
198
199 The `lowmem_reserve_ratio' tunable determines how aggressive the kernel is
200 in defending these lower zones.
201
202 If you have a machine which uses highmem or ISA DMA and your
203 applications are using mlock(), or if you are running with no swap then
204 you probably should change the lowmem_reserve_ratio setting.
205
206 The lowmem_reserve_ratio is an array. You can see them by reading this file.
207 -
208 % cat /proc/sys/vm/lowmem_reserve_ratio
209 256     256     32
210 -
211 Note: # of this elements is one fewer than number of zones. Because the highest
212       zone's value is not necessary for following calculation.
213
214 But, these values are not used directly. The kernel calculates # of protection
215 pages for each zones from them. These are shown as array of protection pages
216 in /proc/zoneinfo like followings. (This is an example of x86-64 box).
217 Each zone has an array of protection pages like this.
218
219 -
220 Node 0, zone      DMA
221   pages free     1355
222         min      3
223         low      3
224         high     4
225         :
226         :
227     numa_other   0
228         protection: (0, 2004, 2004, 2004)
229         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
230   pagesets
231     cpu: 0 pcp: 0
232         :
233 -
234 These protections are added to score to judge whether this zone should be used
235 for page allocation or should be reclaimed.
236
237 In this example, if normal pages (index=2) are required to this DMA zone and
238 pages_high is used for watermark, the kernel judges this zone should not be
239 used because pages_free(1355) is smaller than watermark + protection[2]
240 (4 + 2004 = 2008). If this protection value is 0, this zone would be used for
241 normal page requirement. If requirement is DMA zone(index=0), protection[0]
242 (=0) is used.
243
244 zone[i]'s protection[j] is calculated by following expression.
245
246 (i < j):
247   zone[i]->protection[j]
248   = (total sums of present_pages from zone[i+1] to zone[j] on the node)
249     / lowmem_reserve_ratio[i];
250 (i = j):
251    (should not be protected. = 0;
252 (i > j):
253    (not necessary, but looks 0)
254
255 The default values of lowmem_reserve_ratio[i] are
256     256 (if zone[i] means DMA or DMA32 zone)
257     32  (others).
258 As above expression, they are reciprocal number of ratio.
259 256 means 1/256. # of protection pages becomes about "0.39%" of total present
260 pages of higher zones on the node.
261
262 If you would like to protect more pages, smaller values are effective.
263 The minimum value is 1 (1/1 -> 100%).
264
265 ==============================================================
266
267 max_map_count:
268
269 This file contains the maximum number of memory map areas a process
270 may have. Memory map areas are used as a side-effect of calling
271 malloc, directly by mmap and mprotect, and also when loading shared
272 libraries.
273
274 While most applications need less than a thousand maps, certain
275 programs, particularly malloc debuggers, may consume lots of them,
276 e.g., up to one or two maps per allocation.
277
278 The default value is 65536.
279
280 ==============================================================
281
282 min_free_kbytes:
283
284 This is used to force the Linux VM to keep a minimum number
285 of kilobytes free.  The VM uses this number to compute a pages_min
286 value for each lowmem zone in the system.  Each lowmem zone gets
287 a number of reserved free pages based proportionally on its size.
288
289 Some minimal amount of memory is needed to satisfy PF_MEMALLOC
290 allocations; if you set this to lower than 1024KB, your system will
291 become subtly broken, and prone to deadlock under high loads.
292
293 Setting this too high will OOM your machine instantly.
294
295 =============================================================
296
297 min_slab_ratio:
298
299 This is available only on NUMA kernels.
300
301 A percentage of the total pages in each zone.  On Zone reclaim
302 (fallback from the local zone occurs) slabs will be reclaimed if more
303 than this percentage of pages in a zone are reclaimable slab pages.
304 This insures that the slab growth stays under control even in NUMA
305 systems that rarely perform global reclaim.
306
307 The default is 5 percent.
308
309 Note that slab reclaim is triggered in a per zone / node fashion.
310 The process of reclaiming slab memory is currently not node specific
311 and may not be fast.
312
313 =============================================================
314
315 min_unmapped_ratio:
316
317 This is available only on NUMA kernels.
318
319 A percentage of the total pages in each zone.  Zone reclaim will only
320 occur if more than this percentage of pages are file backed and unmapped.
321 This is to insure that a minimal amount of local pages is still available for
322 file I/O even if the node is overallocated.
323
324 The default is 1 percent.
325
326 ==============================================================
327
328 mmap_min_addr
329
330 This file indicates the amount of address space  which a user process will
331 be restricted from mmaping.  Since kernel null dereference bugs could
332 accidentally operate based on the information in the first couple of pages
333 of memory userspace processes should not be allowed to write to them.  By
334 default this value is set to 0 and no protections will be enforced by the
335 security module.  Setting this value to something like 64k will allow the
336 vast majority of applications to work correctly and provide defense in depth
337 against future potential kernel bugs.
338
339 ==============================================================
340
341 nr_hugepages
342
343 Change the minimum size of the hugepage pool.
344
345 See Documentation/vm/hugetlbpage.txt
346
347 ==============================================================
348
349 nr_overcommit_hugepages
350
351 Change the maximum size of the hugepage pool. The maximum is
352 nr_hugepages + nr_overcommit_hugepages.
353
354 See Documentation/vm/hugetlbpage.txt
355
356 ==============================================================
357
358 nr_pdflush_threads
359
360 The current number of pdflush threads.  This value is read-only.
361 The value changes according to the number of dirty pages in the system.
362
363 When neccessary, additional pdflush threads are created, one per second, up to
364 nr_pdflush_threads_max.
365
366 ==============================================================
367
368 nr_trim_pages
369
370 This is available only on NOMMU kernels.
371
372 This value adjusts the excess page trimming behaviour of power-of-2 aligned
373 NOMMU mmap allocations.
374
375 A value of 0 disables trimming of allocations entirely, while a value of 1
376 trims excess pages aggressively. Any value >= 1 acts as the watermark where
377 trimming of allocations is initiated.
378
379 The default value is 1.
380
381 See Documentation/nommu-mmap.txt for more information.
382
383 ==============================================================
384
385 numa_zonelist_order
386
387 This sysctl is only for NUMA.
388 'where the memory is allocated from' is controlled by zonelists.
389 (This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
390  you may be able to read ZONE_DMA as ZONE_DMA32...)
391
392 In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
393 ZONE_NORMAL -> ZONE_DMA
394 This means that a memory allocation request for GFP_KERNEL will
395 get memory from ZONE_DMA only when ZONE_NORMAL is not available.
396
397 In NUMA case, you can think of following 2 types of order.
398 Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
399
400 (A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
401 (B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
402
403 Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
404 will be used before ZONE_NORMAL exhaustion. This increases possibility of
405 out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
406
407 Type(B) cannot offer the best locality but is more robust against OOM of
408 the DMA zone.
409
410 Type(A) is called as "Node" order. Type (B) is "Zone" order.
411
412 "Node order" orders the zonelists by node, then by zone within each node.
413 Specify "[Nn]ode" for zone order
414
415 "Zone Order" orders the zonelists by zone type, then by node within each
416 zone.  Specify "[Zz]one"for zode order.
417
418 Specify "[Dd]efault" to request automatic configuration.  Autoconfiguration
419 will select "node" order in following case.
420 (1) if the DMA zone does not exist or
421 (2) if the DMA zone comprises greater than 50% of the available memory or
422 (3) if any node's DMA zone comprises greater than 60% of its local memory and
423     the amount of local memory is big enough.
424
425 Otherwise, "zone" order will be selected. Default order is recommended unless
426 this is causing problems for your system/application.
427
428 ==============================================================
429
430 oom_dump_tasks
431
432 Enables a system-wide task dump (excluding kernel threads) to be
433 produced when the kernel performs an OOM-killing and includes such
434 information as pid, uid, tgid, vm size, rss, cpu, oom_adj score, and
435 name.  This is helpful to determine why the OOM killer was invoked
436 and to identify the rogue task that caused it.
437
438 If this is set to zero, this information is suppressed.  On very
439 large systems with thousands of tasks it may not be feasible to dump
440 the memory state information for each one.  Such systems should not
441 be forced to incur a performance penalty in OOM conditions when the
442 information may not be desired.
443
444 If this is set to non-zero, this information is shown whenever the
445 OOM killer actually kills a memory-hogging task.
446
447 The default value is 0.
448
449 ==============================================================
450
451 oom_kill_allocating_task
452
453 This enables or disables killing the OOM-triggering task in
454 out-of-memory situations.
455
456 If this is set to zero, the OOM killer will scan through the entire
457 tasklist and select a task based on heuristics to kill.  This normally
458 selects a rogue memory-hogging task that frees up a large amount of
459 memory when killed.
460
461 If this is set to non-zero, the OOM killer simply kills the task that
462 triggered the out-of-memory condition.  This avoids the expensive
463 tasklist scan.
464
465 If panic_on_oom is selected, it takes precedence over whatever value
466 is used in oom_kill_allocating_task.
467
468 The default value is 0.
469
470 ==============================================================
471
472 nr_pdflush_threads_min
473
474 This value controls the minimum number of pdflush threads.
475
476 At boot time, the kernel will create and maintain 'nr_pdflush_threads_min'
477 threads for the kernel's lifetime.
478
479 The default value is 2.  The minimum value you can specify is 1, and
480 the maximum value is the current setting of 'nr_pdflush_threads_max'.
481
482 See 'nr_pdflush_threads_max' below for more information.
483
484 ==============================================================
485
486 nr_pdflush_threads_max
487
488 This value controls the maximum number of pdflush threads that can be
489 created.  The pdflush algorithm will create a new pdflush thread (up to
490 this maximum) if no pdflush threads have been available for >= 1 second.
491
492 The default value is 8.  The minimum value you can specify is the
493 current value of 'nr_pdflush_threads_min' and the
494 maximum is 1000.
495
496 ==============================================================
497
498 overcommit_memory:
499
500 This value contains a flag that enables memory overcommitment.
501
502 When this flag is 0, the kernel attempts to estimate the amount
503 of free memory left when userspace requests more memory.
504
505 When this flag is 1, the kernel pretends there is always enough
506 memory until it actually runs out.
507
508 When this flag is 2, the kernel uses a "never overcommit"
509 policy that attempts to prevent any overcommit of memory.
510
511 This feature can be very useful because there are a lot of
512 programs that malloc() huge amounts of memory "just-in-case"
513 and don't use much of it.
514
515 The default value is 0.
516
517 See Documentation/vm/overcommit-accounting and
518 security/commoncap.c::cap_vm_enough_memory() for more information.
519
520 ==============================================================
521
522 overcommit_ratio:
523
524 When overcommit_memory is set to 2, the committed address
525 space is not permitted to exceed swap plus this percentage
526 of physical RAM.  See above.
527
528 ==============================================================
529
530 page-cluster
531
532 page-cluster controls the number of pages which are written to swap in
533 a single attempt.  The swap I/O size.
534
535 It is a logarithmic value - setting it to zero means "1 page", setting
536 it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
537
538 The default value is three (eight pages at a time).  There may be some
539 small benefits in tuning this to a different value if your workload is
540 swap-intensive.
541
542 =============================================================
543
544 panic_on_oom
545
546 This enables or disables panic on out-of-memory feature.
547
548 If this is set to 0, the kernel will kill some rogue process,
549 called oom_killer.  Usually, oom_killer can kill rogue processes and
550 system will survive.
551
552 If this is set to 1, the kernel panics when out-of-memory happens.
553 However, if a process limits using nodes by mempolicy/cpusets,
554 and those nodes become memory exhaustion status, one process
555 may be killed by oom-killer. No panic occurs in this case.
556 Because other nodes' memory may be free. This means system total status
557 may be not fatal yet.
558
559 If this is set to 2, the kernel panics compulsorily even on the
560 above-mentioned.
561
562 The default value is 0.
563 1 and 2 are for failover of clustering. Please select either
564 according to your policy of failover.
565
566 =============================================================
567
568 percpu_pagelist_fraction
569
570 This is the fraction of pages at most (high mark pcp->high) in each zone that
571 are allocated for each per cpu page list.  The min value for this is 8.  It
572 means that we don't allow more than 1/8th of pages in each zone to be
573 allocated in any single per_cpu_pagelist.  This entry only changes the value
574 of hot per cpu pagelists.  User can specify a number like 100 to allocate
575 1/100th of each zone to each per cpu page list.
576
577 The batch value of each per cpu pagelist is also updated as a result.  It is
578 set to pcp->high/4.  The upper limit of batch is (PAGE_SHIFT * 8)
579
580 The initial value is zero.  Kernel does not use this value at boot time to set
581 the high water marks for each per cpu page list.
582
583 ==============================================================
584
585 stat_interval
586
587 The time interval between which vm statistics are updated.  The default
588 is 1 second.
589
590 ==============================================================
591
592 swappiness
593
594 This control is used to define how aggressive the kernel will swap
595 memory pages.  Higher values will increase agressiveness, lower values
596 descrease the amount of swap.
597
598 The default value is 60.
599
600 ==============================================================
601
602 vfs_cache_pressure
603 ------------------
604
605 Controls the tendency of the kernel to reclaim the memory which is used for
606 caching of directory and inode objects.
607
608 At the default value of vfs_cache_pressure=100 the kernel will attempt to
609 reclaim dentries and inodes at a "fair" rate with respect to pagecache and
610 swapcache reclaim.  Decreasing vfs_cache_pressure causes the kernel to prefer
611 to retain dentry and inode caches.  Increasing vfs_cache_pressure beyond 100
612 causes the kernel to prefer to reclaim dentries and inodes.
613
614 ==============================================================
615
616 zone_reclaim_mode:
617
618 Zone_reclaim_mode allows someone to set more or less aggressive approaches to
619 reclaim memory when a zone runs out of memory. If it is set to zero then no
620 zone reclaim occurs. Allocations will be satisfied from other zones / nodes
621 in the system.
622
623 This is value ORed together of
624
625 1       = Zone reclaim on
626 2       = Zone reclaim writes dirty pages out
627 4       = Zone reclaim swaps pages
628
629 zone_reclaim_mode is set during bootup to 1 if it is determined that pages
630 from remote zones will cause a measurable performance reduction. The
631 page allocator will then reclaim easily reusable pages (those page
632 cache pages that are currently not used) before allocating off node pages.
633
634 It may be beneficial to switch off zone reclaim if the system is
635 used for a file server and all of memory should be used for caching files
636 from disk. In that case the caching effect is more important than
637 data locality.
638
639 Allowing zone reclaim to write out pages stops processes that are
640 writing large amounts of data from dirtying pages on other nodes. Zone
641 reclaim will write out dirty pages if a zone fills up and so effectively
642 throttle the process. This may decrease the performance of a single process
643 since it cannot use all of system memory to buffer the outgoing writes
644 anymore but it preserve the memory on other nodes so that the performance
645 of other processes running on other nodes will not be affected.
646
647 Allowing regular swap effectively restricts allocations to the local
648 node unless explicitly overridden by memory policies or cpuset
649 configurations.
650
651 ============ End of Document =================================