release/src-rt-6.x/linux/linux-2.6/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
  35 ==============================================================
  36
  37 dirty_ratio, dirty_background_ratio, dirty_expire_centisecs,
  38 dirty_writeback_centisecs, vfs_cache_pressure, laptop_mode,
  39 block_dump, swap_token_timeout, drop-caches:
  40
  41 See Documentation/filesystems/proc.txt
  42
  43 ==============================================================
  44
  45 overcommit_memory:
  46
  47 This value contains a flag that enables memory overcommitment.
  48
  49 When this flag is 0, the kernel attempts to estimate the amount
  50 of free memory left when userspace requests more memory.
  51
  52 When this flag is 1, the kernel pretends there is always enough
  53 memory until it actually runs out.
  54
  55 When this flag is 2, the kernel uses a "never overcommit"
  56 policy that attempts to prevent any overcommit of memory.
  57
  58 This feature can be very useful because there are a lot of
  59 programs that malloc() huge amounts of memory "just-in-case"
  60 and don't use much of it.
  61
  62 The default value is 0.
  63
  64 See Documentation/vm/overcommit-accounting and
  65 security/commoncap.c::cap_vm_enough_memory() for more information.
  66
  67 ==============================================================
  68
  69 overcommit_ratio:
  70
  71 When overcommit_memory is set to 2, the committed address
  72 space is not permitted to exceed swap plus this percentage
  73 of physical RAM.  See above.
  74
  75 ==============================================================
  76
  77 page-cluster:
  78
  79 The Linux VM subsystem avoids excessive disk seeks by reading
  80 multiple pages on a page fault. The number of pages it reads
  81 is dependent on the amount of memory in your machine.
  82
  83 The number of pages the kernel reads in at once is equal to
  84 2 ^ page-cluster. Values above 2 ^ 5 don't make much sense
  85 for swap because we only cluster swap data in 32-page groups.
  86
  87 ==============================================================
  88
  89 max_map_count:
  90
  91 This file contains the maximum number of memory map areas a process
  92 may have. Memory map areas are used as a side-effect of calling
  93 malloc, directly by mmap and mprotect, and also when loading shared
  94 libraries.
  95
  96 While most applications need less than a thousand maps, certain
  97 programs, particularly malloc debuggers, may consume lots of them,
  98 e.g., up to one or two maps per allocation.
  99
 100 The default value is 65536.
 101
 102 ==============================================================
 103
 104 min_free_kbytes:
 105
 106 This is used to force the Linux VM to keep a minimum number
 107 of kilobytes free.  The VM uses this number to compute a pages_min
 108 value for each lowmem zone in the system.  Each lowmem zone gets
 109 a number of reserved free pages based proportionally on its size.
 110
 111 =============================================================
 112
 113 oom_kill_allocating_task
 114
 115 This enables or disables killing the OOM-triggering task in
 116 out-of-memory situations.
 117
 118 If this is set to zero, the OOM killer will scan through the entire
 119 tasklist and select a task based on heuristics to kill.  This normally
 120 selects a rogue memory-hogging task that frees up a large amount of
 121 memory when killed.
 122
 123 If this is set to non-zero, the OOM killer simply kills the task that
 124 triggered the out-of-memory condition.  This avoids the expensive
 125 tasklist scan.
 126
 127 If panic_on_oom is selected, it takes precedence over whatever value
 128 is used in oom_kill_allocating_task.
 129
 130 The default value is 0.
 131
 132 ==============================================================
 133
 134 percpu_pagelist_fraction
 135
 136 This is the fraction of pages at most (high mark pcp->high) in each zone that
 137 are allocated for each per cpu page list.  The min value for this is 8.  It
 138 means that we don't allow more than 1/8th of pages in each zone to be
 139 allocated in any single per_cpu_pagelist.  This entry only changes the value
 140 of hot per cpu pagelists.  User can specify a number like 100 to allocate
 141 1/100th of each zone to each per cpu page list.
 142
 143 The batch value of each per cpu pagelist is also updated as a result.  It is
 144 set to pcp->high/4.  The upper limit of batch is (PAGE_SHIFT * 8)
 145
 146 The initial value is zero.  Kernel does not use this value at boot time to set
 147 the high water marks for each per cpu page list.
 148
 149 ===============================================================
 150
 151 zone_reclaim_mode:
 152
 153 Zone_reclaim_mode allows someone to set more or less aggressive approaches to
 154 reclaim memory when a zone runs out of memory. If it is set to zero then no
 155 zone reclaim occurs. Allocations will be satisfied from other zones / nodes
 156 in the system.
 157
 158 This is value ORed together of
 159
 160 1       = Zone reclaim on
 161 2       = Zone reclaim writes dirty pages out
 162 4       = Zone reclaim swaps pages
 163
 164 zone_reclaim_mode is set during bootup to 1 if it is determined that pages
 165 from remote zones will cause a measurable performance reduction. The
 166 page allocator will then reclaim easily reusable pages (those page
 167 cache pages that are currently not used) before allocating off node pages.
 168
 169 It may be beneficial to switch off zone reclaim if the system is
 170 used for a file server and all of memory should be used for caching files
 171 from disk. In that case the caching effect is more important than
 172 data locality.
 173
 174 Allowing zone reclaim to write out pages stops processes that are
 175 writing large amounts of data from dirtying pages on other nodes. Zone
 176 reclaim will write out dirty pages if a zone fills up and so effectively
 177 throttle the process. This may decrease the performance of a single process
 178 since it cannot use all of system memory to buffer the outgoing writes
 179 anymore but it preserve the memory on other nodes so that the performance
 180 of other processes running on other nodes will not be affected.
 181
 182 Allowing regular swap effectively restricts allocations to the local
 183 node unless explicitly overridden by memory policies or cpuset
 184 configurations.
 185
 186 =============================================================
 187
 188 min_unmapped_ratio:
 189
 190 This is available only on NUMA kernels.
 191
 192 A percentage of the total pages in each zone.  Zone reclaim will only
 193 occur if more than this percentage of pages are file backed and unmapped.
 194 This is to insure that a minimal amount of local pages is still available for
 195 file I/O even if the node is overallocated.
 196
 197 The default is 1 percent.
 198
 199 =============================================================
 200
 201 min_slab_ratio:
 202
 203 This is available only on NUMA kernels.
 204
 205 A percentage of the total pages in each zone.  On Zone reclaim
 206 (fallback from the local zone occurs) slabs will be reclaimed if more
 207 than this percentage of pages in a zone are reclaimable slab pages.
 208 This insures that the slab growth stays under control even in NUMA
 209 systems that rarely perform global reclaim.
 210
 211 The default is 5 percent.
 212
 213 Note that slab reclaim is triggered in a per zone / node fashion.
 214 The process of reclaiming slab memory is currently not node specific
 215 and may not be fast.
 216
 217 =============================================================
 218
 219 panic_on_oom
 220
 221 This enables or disables panic on out-of-memory feature.
 222
 223 If this is set to 0, the kernel will kill some rogue process,
 224 called oom_killer.  Usually, oom_killer can kill rogue processes and
 225 system will survive.
 226
 227 If this is set to 1, the kernel panics when out-of-memory happens.
 228 However, if a process limits using nodes by mempolicy/cpusets,
 229 and those nodes become memory exhaustion status, one process
 230 may be killed by oom-killer. No panic occurs in this case.
 231 Because other nodes' memory may be free. This means system total status
 232 may be not fatal yet.
 233
 234 If this is set to 2, the kernel panics compulsorily even on the
 235 above-mentioned.
 236
 237 The default value is 0.
 238 1 and 2 are for failover of clustering. Please select either
 239 according to your policy of failover.