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