revert-mm-fix-blkdev-size-calculation-in-generic_write_checks
[linux-2.6/linux-trees-mm.git] / Documentation / sysctl / vm.txt
blob66dfe7022d4b31acf545a3f60da892fb4f493e74
1 Documentation for /proc/sys/vm/*        kernel version 2.2.10
2         (c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
4 For general info and legal blurb, please look in README.
6 ==============================================================
8 This file contains the documentation for the sysctl files in
9 /proc/sys/vm and is valid for Linux kernel version 2.2.
11 The files in this directory can be used to tune the operation
12 of the virtual memory (VM) subsystem of the Linux kernel and
13 the writeout of dirty data to disk.
15 Default values and initialization routines for most of these
16 files can be found in mm/swap.c.
18 Currently, these files are in /proc/sys/vm:
19 - overcommit_memory
20 - page-cluster
21 - dirty_ratio
22 - dirty_background_ratio
23 - dirty_expire_centisecs
24 - dirty_writeback_centisecs
25 - max_map_count
26 - min_free_kbytes
27 - laptop_mode
28 - block_dump
29 - drop-caches
30 - zone_reclaim_mode
31 - min_unmapped_ratio
32 - min_slab_ratio
33 - panic_on_oom
34 - oom_dump_tasks
35 - oom_kill_allocating_task
36 - mmap_min_address
37 - numa_zonelist_order
39 ==============================================================
41 dirty_ratio, dirty_background_ratio, dirty_expire_centisecs,
42 dirty_writeback_centisecs, vfs_cache_pressure, laptop_mode,
43 block_dump, swap_token_timeout, drop-caches,
44 hugepages_treat_as_movable:
46 See Documentation/filesystems/proc.txt
48 ==============================================================
50 overcommit_memory:
52 This value contains a flag that enables memory overcommitment.
54 When this flag is 0, the kernel attempts to estimate the amount
55 of free memory left when userspace requests more memory.
57 When this flag is 1, the kernel pretends there is always enough
58 memory until it actually runs out.
60 When this flag is 2, the kernel uses a "never overcommit"
61 policy that attempts to prevent any overcommit of memory.  
63 This feature can be very useful because there are a lot of
64 programs that malloc() huge amounts of memory "just-in-case"
65 and don't use much of it.
67 The default value is 0.
69 See Documentation/vm/overcommit-accounting and
70 security/commoncap.c::cap_vm_enough_memory() for more information.
72 ==============================================================
74 overcommit_ratio:
76 When overcommit_memory is set to 2, the committed address
77 space is not permitted to exceed swap plus this percentage
78 of physical RAM.  See above.
80 ==============================================================
82 page-cluster:
84 The Linux VM subsystem avoids excessive disk seeks by reading
85 multiple pages on a page fault. The number of pages it reads
86 is dependent on the amount of memory in your machine.
88 The number of pages the kernel reads in at once is equal to
89 2 ^ page-cluster. Values above 2 ^ 5 don't make much sense
90 for swap because we only cluster swap data in 32-page groups.
92 ==============================================================
94 max_map_count:
96 This file contains the maximum number of memory map areas a process
97 may have. Memory map areas are used as a side-effect of calling
98 malloc, directly by mmap and mprotect, and also when loading shared
99 libraries.
101 While most applications need less than a thousand maps, certain
102 programs, particularly malloc debuggers, may consume lots of them,
103 e.g., up to one or two maps per allocation.
105 The default value is 65536.
107 ==============================================================
109 min_free_kbytes:
111 This is used to force the Linux VM to keep a minimum number 
112 of kilobytes free.  The VM uses this number to compute a pages_min
113 value for each lowmem zone in the system.  Each lowmem zone gets 
114 a number of reserved free pages based proportionally on its size.
116 Some minimal ammount of memory is needed to satisfy PF_MEMALLOC
117 allocations; if you set this to lower than 1024KB, your system will
118 become subtly broken, and prone to deadlock under high loads.
120 Setting this too high will OOM your machine instantly.
122 ==============================================================
124 percpu_pagelist_fraction
126 This is the fraction of pages at most (high mark pcp->high) in each zone that
127 are allocated for each per cpu page list.  The min value for this is 8.  It
128 means that we don't allow more than 1/8th of pages in each zone to be
129 allocated in any single per_cpu_pagelist.  This entry only changes the value
130 of hot per cpu pagelists.  User can specify a number like 100 to allocate
131 1/100th of each zone to each per cpu page list.
133 The batch value of each per cpu pagelist is also updated as a result.  It is
134 set to pcp->high/4.  The upper limit of batch is (PAGE_SHIFT * 8)
136 The initial value is zero.  Kernel does not use this value at boot time to set
137 the high water marks for each per cpu page list.
139 ===============================================================
141 zone_reclaim_mode:
143 Zone_reclaim_mode allows someone to set more or less aggressive approaches to
144 reclaim memory when a zone runs out of memory. If it is set to zero then no
145 zone reclaim occurs. Allocations will be satisfied from other zones / nodes
146 in the system.
148 This is value ORed together of
150 1       = Zone reclaim on
151 2       = Zone reclaim writes dirty pages out
152 4       = Zone reclaim swaps pages
154 zone_reclaim_mode is set during bootup to 1 if it is determined that pages
155 from remote zones will cause a measurable performance reduction. The
156 page allocator will then reclaim easily reusable pages (those page
157 cache pages that are currently not used) before allocating off node pages.
159 It may be beneficial to switch off zone reclaim if the system is
160 used for a file server and all of memory should be used for caching files
161 from disk. In that case the caching effect is more important than
162 data locality.
164 Allowing zone reclaim to write out pages stops processes that are
165 writing large amounts of data from dirtying pages on other nodes. Zone
166 reclaim will write out dirty pages if a zone fills up and so effectively
167 throttle the process. This may decrease the performance of a single process
168 since it cannot use all of system memory to buffer the outgoing writes
169 anymore but it preserve the memory on other nodes so that the performance
170 of other processes running on other nodes will not be affected.
172 Allowing regular swap effectively restricts allocations to the local
173 node unless explicitly overridden by memory policies or cpuset
174 configurations.
176 =============================================================
178 min_unmapped_ratio:
180 This is available only on NUMA kernels.
182 A percentage of the total pages in each zone.  Zone reclaim will only
183 occur if more than this percentage of pages are file backed and unmapped.
184 This is to insure that a minimal amount of local pages is still available for
185 file I/O even if the node is overallocated.
187 The default is 1 percent.
189 =============================================================
191 min_slab_ratio:
193 This is available only on NUMA kernels.
195 A percentage of the total pages in each zone.  On Zone reclaim
196 (fallback from the local zone occurs) slabs will be reclaimed if more
197 than this percentage of pages in a zone are reclaimable slab pages.
198 This insures that the slab growth stays under control even in NUMA
199 systems that rarely perform global reclaim.
201 The default is 5 percent.
203 Note that slab reclaim is triggered in a per zone / node fashion.
204 The process of reclaiming slab memory is currently not node specific
205 and may not be fast.
207 =============================================================
209 panic_on_oom
211 This enables or disables panic on out-of-memory feature.
213 If this is set to 0, the kernel will kill some rogue process,
214 called oom_killer.  Usually, oom_killer can kill rogue processes and
215 system will survive.
217 If this is set to 1, the kernel panics when out-of-memory happens.
218 However, if a process limits using nodes by mempolicy/cpusets,
219 and those nodes become memory exhaustion status, one process
220 may be killed by oom-killer. No panic occurs in this case.
221 Because other nodes' memory may be free. This means system total status
222 may be not fatal yet.
224 If this is set to 2, the kernel panics compulsorily even on the
225 above-mentioned.
227 The default value is 0.
228 1 and 2 are for failover of clustering. Please select either
229 according to your policy of failover.
231 =============================================================
233 oom_dump_tasks
235 Enables a system-wide task dump (excluding kernel threads) to be
236 produced when the kernel performs an OOM-killing and includes such
237 information as pid, uid, tgid, vm size, rss, cpu, oom_adj score, and
238 name.  This is helpful to determine why the OOM killer was invoked
239 and to identify the rogue task that caused it.
241 If this is set to zero, this information is suppressed.  On very
242 large systems with thousands of tasks it may not be feasible to dump
243 the memory state information for each one.  Such systems should not
244 be forced to incur a performance penalty in OOM conditions when the
245 information may not be desired.
247 If this is set to non-zero, this information is shown whenever the
248 OOM killer actually kills a memory-hogging task.
250 The default value is 0.
252 =============================================================
254 oom_kill_allocating_task
256 This enables or disables killing the OOM-triggering task in
257 out-of-memory situations.
259 If this is set to zero, the OOM killer will scan through the entire
260 tasklist and select a task based on heuristics to kill.  This normally
261 selects a rogue memory-hogging task that frees up a large amount of
262 memory when killed.
264 If this is set to non-zero, the OOM killer simply kills the task that
265 triggered the out-of-memory condition.  This avoids the expensive
266 tasklist scan.
268 If panic_on_oom is selected, it takes precedence over whatever value
269 is used in oom_kill_allocating_task.
271 The default value is 0.
273 ==============================================================
275 mmap_min_addr
277 This file indicates the amount of address space  which a user process will
278 be restricted from mmaping.  Since kernel null dereference bugs could
279 accidentally operate based on the information in the first couple of pages
280 of memory userspace processes should not be allowed to write to them.  By
281 default this value is set to 0 and no protections will be enforced by the
282 security module.  Setting this value to something like 64k will allow the
283 vast majority of applications to work correctly and provide defense in depth
284 against future potential kernel bugs.
286 ==============================================================
288 numa_zonelist_order
290 This sysctl is only for NUMA.
291 'where the memory is allocated from' is controlled by zonelists.
292 (This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
293  you may be able to read ZONE_DMA as ZONE_DMA32...)
295 In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
296 ZONE_NORMAL -> ZONE_DMA
297 This means that a memory allocation request for GFP_KERNEL will
298 get memory from ZONE_DMA only when ZONE_NORMAL is not available.
300 In NUMA case, you can think of following 2 types of order.
301 Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
303 (A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
304 (B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
306 Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
307 will be used before ZONE_NORMAL exhaustion. This increases possibility of
308 out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
310 Type(B) cannot offer the best locality but is more robust against OOM of
311 the DMA zone.
313 Type(A) is called as "Node" order. Type (B) is "Zone" order.
315 "Node order" orders the zonelists by node, then by zone within each node.
316 Specify "[Nn]ode" for zone order
318 "Zone Order" orders the zonelists by zone type, then by node within each
319 zone.  Specify "[Zz]one"for zode order.
321 Specify "[Dd]efault" to request automatic configuration.  Autoconfiguration
322 will select "node" order in following case.
323 (1) if the DMA zone does not exist or
324 (2) if the DMA zone comprises greater than 50% of the available memory or
325 (3) if any node's DMA zone comprises greater than 60% of its local memory and
326     the amount of local memory is big enough.
328 Otherwise, "zone" order will be selected. Default order is recommended unless
329 this is causing problems for your system/application.