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