handle kernelcore=: generic
[linux-2.6.git] / Documentation / sysctl / vm.txt
1 Documentation for /proc/sys/vm/*        kernel version 2.2.10
2         (c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
3
4 For general info and legal blurb, please look in README.
5
6 ==============================================================
7
8 This file contains the documentation for the sysctl files in
9 /proc/sys/vm and is valid for Linux kernel version 2.2.
10
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.
14
15 Default values and initialization routines for most of these
16 files can be found in mm/swap.c.
17
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 - mmap_min_address
35 - numa_zonelist_order
36
37 ==============================================================
38
39 dirty_ratio, dirty_background_ratio, dirty_expire_centisecs,
40 dirty_writeback_centisecs, vfs_cache_pressure, laptop_mode,
41 block_dump, swap_token_timeout, drop-caches,
42 hugepages_treat_as_movable:
43
44 See Documentation/filesystems/proc.txt
45
46 ==============================================================
47
48 overcommit_memory:
49
50 This value contains a flag that enables memory overcommitment.
51
52 When this flag is 0, the kernel attempts to estimate the amount
53 of free memory left when userspace requests more memory.
54
55 When this flag is 1, the kernel pretends there is always enough
56 memory until it actually runs out.
57
58 When this flag is 2, the kernel uses a "never overcommit"
59 policy that attempts to prevent any overcommit of memory.  
60
61 This feature can be very useful because there are a lot of
62 programs that malloc() huge amounts of memory "just-in-case"
63 and don't use much of it.
64
65 The default value is 0.
66
67 See Documentation/vm/overcommit-accounting and
68 security/commoncap.c::cap_vm_enough_memory() for more information.
69
70 ==============================================================
71
72 overcommit_ratio:
73
74 When overcommit_memory is set to 2, the committed address
75 space is not permitted to exceed swap plus this percentage
76 of physical RAM.  See above.
77
78 ==============================================================
79
80 page-cluster:
81
82 The Linux VM subsystem avoids excessive disk seeks by reading
83 multiple pages on a page fault. The number of pages it reads
84 is dependent on the amount of memory in your machine.
85
86 The number of pages the kernel reads in at once is equal to
87 2 ^ page-cluster. Values above 2 ^ 5 don't make much sense
88 for swap because we only cluster swap data in 32-page groups.
89
90 ==============================================================
91
92 max_map_count:
93
94 This file contains the maximum number of memory map areas a process
95 may have. Memory map areas are used as a side-effect of calling
96 malloc, directly by mmap and mprotect, and also when loading shared
97 libraries.
98
99 While most applications need less than a thousand maps, certain
100 programs, particularly malloc debuggers, may consume lots of them,
101 e.g., up to one or two maps per allocation.
102
103 The default value is 65536.
104
105 ==============================================================
106
107 min_free_kbytes:
108
109 This is used to force the Linux VM to keep a minimum number 
110 of kilobytes free.  The VM uses this number to compute a pages_min
111 value for each lowmem zone in the system.  Each lowmem zone gets 
112 a number of reserved free pages based proportionally on its size.
113
114 ==============================================================
115
116 percpu_pagelist_fraction
117
118 This is the fraction of pages at most (high mark pcp->high) in each zone that
119 are allocated for each per cpu page list.  The min value for this is 8.  It
120 means that we don't allow more than 1/8th of pages in each zone to be
121 allocated in any single per_cpu_pagelist.  This entry only changes the value
122 of hot per cpu pagelists.  User can specify a number like 100 to allocate
123 1/100th of each zone to each per cpu page list.
124
125 The batch value of each per cpu pagelist is also updated as a result.  It is
126 set to pcp->high/4.  The upper limit of batch is (PAGE_SHIFT * 8)
127
128 The initial value is zero.  Kernel does not use this value at boot time to set
129 the high water marks for each per cpu page list.
130
131 ===============================================================
132
133 zone_reclaim_mode:
134
135 Zone_reclaim_mode allows someone to set more or less aggressive approaches to
136 reclaim memory when a zone runs out of memory. If it is set to zero then no
137 zone reclaim occurs. Allocations will be satisfied from other zones / nodes
138 in the system.
139
140 This is value ORed together of
141
142 1       = Zone reclaim on
143 2       = Zone reclaim writes dirty pages out
144 4       = Zone reclaim swaps pages
145
146 zone_reclaim_mode is set during bootup to 1 if it is determined that pages
147 from remote zones will cause a measurable performance reduction. The
148 page allocator will then reclaim easily reusable pages (those page
149 cache pages that are currently not used) before allocating off node pages.
150
151 It may be beneficial to switch off zone reclaim if the system is
152 used for a file server and all of memory should be used for caching files
153 from disk. In that case the caching effect is more important than
154 data locality.
155
156 Allowing zone reclaim to write out pages stops processes that are
157 writing large amounts of data from dirtying pages on other nodes. Zone
158 reclaim will write out dirty pages if a zone fills up and so effectively
159 throttle the process. This may decrease the performance of a single process
160 since it cannot use all of system memory to buffer the outgoing writes
161 anymore but it preserve the memory on other nodes so that the performance
162 of other processes running on other nodes will not be affected.
163
164 Allowing regular swap effectively restricts allocations to the local
165 node unless explicitly overridden by memory policies or cpuset
166 configurations.
167
168 =============================================================
169
170 min_unmapped_ratio:
171
172 This is available only on NUMA kernels.
173
174 A percentage of the total pages in each zone.  Zone reclaim will only
175 occur if more than this percentage of pages are file backed and unmapped.
176 This is to insure that a minimal amount of local pages is still available for
177 file I/O even if the node is overallocated.
178
179 The default is 1 percent.
180
181 =============================================================
182
183 min_slab_ratio:
184
185 This is available only on NUMA kernels.
186
187 A percentage of the total pages in each zone.  On Zone reclaim
188 (fallback from the local zone occurs) slabs will be reclaimed if more
189 than this percentage of pages in a zone are reclaimable slab pages.
190 This insures that the slab growth stays under control even in NUMA
191 systems that rarely perform global reclaim.
192
193 The default is 5 percent.
194
195 Note that slab reclaim is triggered in a per zone / node fashion.
196 The process of reclaiming slab memory is currently not node specific
197 and may not be fast.
198
199 =============================================================
200
201 panic_on_oom
202
203 This enables or disables panic on out-of-memory feature.
204
205 If this is set to 0, the kernel will kill some rogue process,
206 called oom_killer.  Usually, oom_killer can kill rogue processes and
207 system will survive.
208
209 If this is set to 1, the kernel panics when out-of-memory happens.
210 However, if a process limits using nodes by mempolicy/cpusets,
211 and those nodes become memory exhaustion status, one process
212 may be killed by oom-killer. No panic occurs in this case.
213 Because other nodes' memory may be free. This means system total status
214 may be not fatal yet.
215
216 If this is set to 2, the kernel panics compulsorily even on the
217 above-mentioned.
218
219 The default value is 0.
220 1 and 2 are for failover of clustering. Please select either
221 according to your policy of failover.
222
223 ==============================================================
224
225 mmap_min_addr
226
227 This file indicates the amount of address space  which a user process will
228 be restricted from mmaping.  Since kernel null dereference bugs could
229 accidentally operate based on the information in the first couple of pages
230 of memory userspace processes should not be allowed to write to them.  By
231 default this value is set to 0 and no protections will be enforced by the
232 security module.  Setting this value to something like 64k will allow the
233 vast majority of applications to work correctly and provide defense in depth
234 against future potential kernel bugs.
235
236 ==============================================================
237
238 numa_zonelist_order
239
240 This sysctl is only for NUMA.
241 'where the memory is allocated from' is controlled by zonelists.
242 (This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
243  you may be able to read ZONE_DMA as ZONE_DMA32...)
244
245 In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
246 ZONE_NORMAL -> ZONE_DMA
247 This means that a memory allocation request for GFP_KERNEL will
248 get memory from ZONE_DMA only when ZONE_NORMAL is not available.
249
250 In NUMA case, you can think of following 2 types of order.
251 Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
252
253 (A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
254 (B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
255
256 Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
257 will be used before ZONE_NORMAL exhaustion. This increases possibility of
258 out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
259
260 Type(B) cannot offer the best locality but is more robust against OOM of
261 the DMA zone.
262
263 Type(A) is called as "Node" order. Type (B) is "Zone" order.
264
265 "Node order" orders the zonelists by node, then by zone within each node.
266 Specify "[Nn]ode" for zone order
267
268 "Zone Order" orders the zonelists by zone type, then by node within each
269 zone.  Specify "[Zz]one"for zode order.
270
271 Specify "[Dd]efault" to request automatic configuration.  Autoconfiguration
272 will select "node" order in following case.
273 (1) if the DMA zone does not exist or
274 (2) if the DMA zone comprises greater than 50% of the available memory or
275 (3) if any node's DMA zone comprises greater than 60% of its local memory and
276     the amount of local memory is big enough.
277
278 Otherwise, "zone" order will be selected. Default order is recommended unless
279 this is causing problems for your system/application.