Blame view

Documentation/sysctl/vm.txt 32.1 KB
db0fb1848   Peter W Morreale   Update of Documen...
1
  Documentation for /proc/sys/vm/*	kernel version 2.6.29
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
2
  	(c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
db0fb1848   Peter W Morreale   Update of Documen...
3
  	(c) 2008         Peter W. Morreale <pmorreale@novell.com>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
4
5
6
7
8
9
  
  For general info and legal blurb, please look in README.
  
  ==============================================================
  
  This file contains the documentation for the sysctl files in
db0fb1848   Peter W Morreale   Update of Documen...
10
  /proc/sys/vm and is valid for Linux kernel version 2.6.29.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
11
12
13
14
15
16
17
18
19
  
  The files in this directory can be used to tune the operation
  of the virtual memory (VM) subsystem of the Linux kernel and
  the writeout of dirty data to disk.
  
  Default values and initialization routines for most of these
  files can be found in mm/swap.c.
  
  Currently, these files are in /proc/sys/vm:
db0fb1848   Peter W Morreale   Update of Documen...
20

4eeab4f55   Andrew Shewmaker   mm: replace hardc...
21
  - admin_reserve_kbytes
db0fb1848   Peter W Morreale   Update of Documen...
22
  - block_dump
76ab0f530   Mel Gorman   mm: compaction: a...
23
  - compact_memory
5bbe3547a   Eric B Munson   mm: allow compact...
24
  - compact_unevictable_allowed
db0fb1848   Peter W Morreale   Update of Documen...
25
  - dirty_background_bytes
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
26
  - dirty_background_ratio
db0fb1848   Peter W Morreale   Update of Documen...
27
  - dirty_bytes
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
28
  - dirty_expire_centisecs
db0fb1848   Peter W Morreale   Update of Documen...
29
  - dirty_ratio
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
30
  - dirty_writeback_centisecs
db0fb1848   Peter W Morreale   Update of Documen...
31
  - drop_caches
5e7719058   Mel Gorman   mm: compaction: a...
32
  - extfrag_threshold
db0fb1848   Peter W Morreale   Update of Documen...
33
34
35
36
37
  - hugepages_treat_as_movable
  - hugetlb_shm_group
  - laptop_mode
  - legacy_va_layout
  - lowmem_reserve_ratio
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
38
  - max_map_count
6a46079cf   Andi Kleen   HWPOISON: The hig...
39
40
  - memory_failure_early_kill
  - memory_failure_recovery
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
41
  - min_free_kbytes
0ff38490c   Christoph Lameter   [PATCH] zone_recl...
42
  - min_slab_ratio
db0fb1848   Peter W Morreale   Update of Documen...
43
44
  - min_unmapped_ratio
  - mmap_min_addr
d07e22597   Daniel Cashman   mm: mmap: add new...
45
46
  - mmap_rnd_bits
  - mmap_rnd_compat_bits
d5dbac87b   Nishanth Aravamudan   Documentation: up...
47
48
  - nr_hugepages
  - nr_overcommit_hugepages
db0fb1848   Peter W Morreale   Update of Documen...
49
50
51
52
  - nr_trim_pages         (only if CONFIG_MMU=n)
  - numa_zonelist_order
  - oom_dump_tasks
  - oom_kill_allocating_task
49f0ce5f9   Jerome Marchand   mm: add overcommi...
53
  - overcommit_kbytes
db0fb1848   Peter W Morreale   Update of Documen...
54
55
56
57
58
59
  - overcommit_memory
  - overcommit_ratio
  - page-cluster
  - panic_on_oom
  - percpu_pagelist_fraction
  - stat_interval
52b6f46bc   Hugh Dickins   mm: /proc/sys/vm/...
60
  - stat_refresh
db0fb1848   Peter W Morreale   Update of Documen...
61
  - swappiness
c9b1d0981   Andrew Shewmaker   mm: limit growth ...
62
  - user_reserve_kbytes
db0fb1848   Peter W Morreale   Update of Documen...
63
  - vfs_cache_pressure
e6507a00f   Jerome Marchand   Documentation: ad...
64
  - watermark_scale_factor
db0fb1848   Peter W Morreale   Update of Documen...
65
  - zone_reclaim_mode
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
66
  ==============================================================
4eeab4f55   Andrew Shewmaker   mm: replace hardc...
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
  admin_reserve_kbytes
  
  The amount of free memory in the system that should be reserved for users
  with the capability cap_sys_admin.
  
  admin_reserve_kbytes defaults to min(3% of free pages, 8MB)
  
  That should provide enough for the admin to log in and kill a process,
  if necessary, under the default overcommit 'guess' mode.
  
  Systems running under overcommit 'never' should increase this to account
  for the full Virtual Memory Size of programs used to recover. Otherwise,
  root may not be able to log in to recover the system.
  
  How do you calculate a minimum useful reserve?
  
  sshd or login + bash (or some other shell) + top (or ps, kill, etc.)
  
  For overcommit 'guess', we can sum resident set sizes (RSS).
  On x86_64 this is about 8MB.
  
  For overcommit 'never', we can take the max of their virtual sizes (VSZ)
  and add the sum of their RSS.
  On x86_64 this is about 128MB.
  
  Changing this takes effect whenever an application requests memory.
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
95
  block_dump
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
96

db0fb1848   Peter W Morreale   Update of Documen...
97
98
  block_dump enables block I/O debugging when set to a nonzero value. More
  information on block I/O debugging is in Documentation/laptops/laptop-mode.txt.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
99
100
  
  ==============================================================
76ab0f530   Mel Gorman   mm: compaction: a...
101
102
103
104
105
106
107
108
  compact_memory
  
  Available only when CONFIG_COMPACTION is set. When 1 is written to the file,
  all zones are compacted such that free memory is available in contiguous
  blocks where possible. This can be important for example in the allocation of
  huge pages although processes will also directly compact memory as required.
  
  ==============================================================
5bbe3547a   Eric B Munson   mm: allow compact...
109
110
111
112
113
114
115
116
117
  compact_unevictable_allowed
  
  Available only when CONFIG_COMPACTION is set. When set to 1, compaction is
  allowed to examine the unevictable lru (mlocked pages) for pages to compact.
  This should be used on systems where stalls for minor page faults are an
  acceptable trade for large contiguous free memory.  Set to 0 to prevent
  compaction from moving pages that are unevictable.  Default value is 1.
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
118
  dirty_background_bytes
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
119

6601fac82   Artem Bityutskiy   Documentation: fi...
120
121
  Contains the amount of dirty memory at which the background kernel
  flusher threads will start writeback.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
122

abffc0207   Andrea Righi   doc: clarify the ...
123
124
125
126
  Note: dirty_background_bytes is the counterpart of dirty_background_ratio. Only
  one of them may be specified at a time. When one sysctl is written it is
  immediately taken into account to evaluate the dirty memory limits and the
  other appears as 0 when read.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
127

db0fb1848   Peter W Morreale   Update of Documen...
128
  ==============================================================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
129

db0fb1848   Peter W Morreale   Update of Documen...
130
  dirty_background_ratio
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
131

715ea41e6   Zheng Liu   mm: improve the d...
132
133
134
  Contains, as a percentage of total available memory that contains free pages
  and reclaimable pages, the number of pages at which the background kernel
  flusher threads will start writing out dirty data.
d83e2a4ea   Chris Dunlop   Documentation: fi...
135
  The total available memory is not equal to total system memory.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
136

db0fb1848   Peter W Morreale   Update of Documen...
137
  ==============================================================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
138

db0fb1848   Peter W Morreale   Update of Documen...
139
140
141
142
  dirty_bytes
  
  Contains the amount of dirty memory at which a process generating disk writes
  will itself start writeback.
abffc0207   Andrea Righi   doc: clarify the ...
143
144
145
146
  Note: dirty_bytes is the counterpart of dirty_ratio. Only one of them may be
  specified at a time. When one sysctl is written it is immediately taken into
  account to evaluate the dirty memory limits and the other appears as 0 when
  read.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
147

9e4a5bda8   Andrea Righi   mm: prevent divid...
148
149
150
  Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
  value lower than this limit will be ignored and the old configuration will be
  retained.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
151
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
152
  dirty_expire_centisecs
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
153

db0fb1848   Peter W Morreale   Update of Documen...
154
  This tunable is used to define when dirty data is old enough to be eligible
6601fac82   Artem Bityutskiy   Documentation: fi...
155
156
157
  for writeout by the kernel flusher threads.  It is expressed in 100'ths
  of a second.  Data which has been dirty in-memory for longer than this
  interval will be written out next time a flusher thread wakes up.
db0fb1848   Peter W Morreale   Update of Documen...
158
159
160
161
  
  ==============================================================
  
  dirty_ratio
715ea41e6   Zheng Liu   mm: improve the d...
162
163
164
  Contains, as a percentage of total available memory that contains free pages
  and reclaimable pages, the number of pages at which a process which is
  generating disk writes will itself start writing out dirty data.
d83e2a4ea   Chris Dunlop   Documentation: fi...
165
  The total available memory is not equal to total system memory.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
166
167
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
168
  dirty_writeback_centisecs
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
169

6601fac82   Artem Bityutskiy   Documentation: fi...
170
  The kernel flusher threads will periodically wake up and write `old' data
db0fb1848   Peter W Morreale   Update of Documen...
171
172
  out to disk.  This tunable expresses the interval between those wakeups, in
  100'ths of a second.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
173

db0fb1848   Peter W Morreale   Update of Documen...
174
  Setting this to zero disables periodic writeback altogether.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
175
176
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
177
  drop_caches
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
178

5509a5d27   Dave Hansen   drop_caches: add ...
179
180
181
  Writing to this will cause the kernel to drop clean caches, as well as
  reclaimable slab objects like dentries and inodes.  Once dropped, their
  memory becomes free.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
182

db0fb1848   Peter W Morreale   Update of Documen...
183
184
  To free pagecache:
  	echo 1 > /proc/sys/vm/drop_caches
5509a5d27   Dave Hansen   drop_caches: add ...
185
  To free reclaimable slab objects (includes dentries and inodes):
db0fb1848   Peter W Morreale   Update of Documen...
186
  	echo 2 > /proc/sys/vm/drop_caches
5509a5d27   Dave Hansen   drop_caches: add ...
187
  To free slab objects and pagecache:
db0fb1848   Peter W Morreale   Update of Documen...
188
  	echo 3 > /proc/sys/vm/drop_caches
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
189

5509a5d27   Dave Hansen   drop_caches: add ...
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
  This is a non-destructive operation and will not free any dirty objects.
  To increase the number of objects freed by this operation, the user may run
  `sync' prior to writing to /proc/sys/vm/drop_caches.  This will minimize the
  number of dirty objects on the system and create more candidates to be
  dropped.
  
  This file is not a means to control the growth of the various kernel caches
  (inodes, dentries, pagecache, etc...)  These objects are automatically
  reclaimed by the kernel when memory is needed elsewhere on the system.
  
  Use of this file can cause performance problems.  Since it discards cached
  objects, it may cost a significant amount of I/O and CPU to recreate the
  dropped objects, especially if they were under heavy use.  Because of this,
  use outside of a testing or debugging environment is not recommended.
  
  You may see informational messages in your kernel log when this file is
  used:
  
  	cat (1234): drop_caches: 3
  
  These are informational only.  They do not mean that anything is wrong
  with your system.  To disable them, echo 4 (bit 3) into drop_caches.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
212
213
  
  ==============================================================
5e7719058   Mel Gorman   mm: compaction: a...
214
215
216
  extfrag_threshold
  
  This parameter affects whether the kernel will compact memory or direct
a10726bb5   Rabin Vincent   Documentation: mm...
217
218
219
220
221
  reclaim to satisfy a high-order allocation. The extfrag/extfrag_index file in
  debugfs shows what the fragmentation index for each order is in each zone in
  the system. Values tending towards 0 imply allocations would fail due to lack
  of memory, values towards 1000 imply failures are due to fragmentation and -1
  implies that the allocation will succeed as long as watermarks are met.
5e7719058   Mel Gorman   mm: compaction: a...
222
223
224
225
226
  
  The kernel will not compact memory in a zone if the
  fragmentation index is <= extfrag_threshold. The default value is 500.
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
227
  hugepages_treat_as_movable
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
228

86cdb465c   Naoya Horiguchi   mm: prepare to re...
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
  This parameter controls whether we can allocate hugepages from ZONE_MOVABLE
  or not. If set to non-zero, hugepages can be allocated from ZONE_MOVABLE.
  ZONE_MOVABLE is created when kernel boot parameter kernelcore= is specified,
  so this parameter has no effect if used without kernelcore=.
  
  Hugepage migration is now available in some situations which depend on the
  architecture and/or the hugepage size. If a hugepage supports migration,
  allocation from ZONE_MOVABLE is always enabled for the hugepage regardless
  of the value of this parameter.
  IOW, this parameter affects only non-migratable hugepages.
  
  Assuming that hugepages are not migratable in your system, one usecase of
  this parameter is that users can make hugepage pool more extensible by
  enabling the allocation from ZONE_MOVABLE. This is because on ZONE_MOVABLE
  page reclaim/migration/compaction work more and you can get contiguous
  memory more likely. Note that using ZONE_MOVABLE for non-migratable
  hugepages can do harm to other features like memory hotremove (because
  memory hotremove expects that memory blocks on ZONE_MOVABLE are always
  removable,) so it's a trade-off responsible for the users.
24950898f   Pavel Machek   vm.txt: document ...
248

8ad4b1fb8   Rohit Seth   [PATCH] Make high...
249
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
250
  hugetlb_shm_group
8ad4b1fb8   Rohit Seth   [PATCH] Make high...
251

db0fb1848   Peter W Morreale   Update of Documen...
252
253
  hugetlb_shm_group contains group id that is allowed to create SysV
  shared memory segment using hugetlb page.
8ad4b1fb8   Rohit Seth   [PATCH] Make high...
254

db0fb1848   Peter W Morreale   Update of Documen...
255
  ==============================================================
8ad4b1fb8   Rohit Seth   [PATCH] Make high...
256

db0fb1848   Peter W Morreale   Update of Documen...
257
  laptop_mode
1743660b9   Christoph Lameter   [PATCH] Zone recl...
258

db0fb1848   Peter W Morreale   Update of Documen...
259
260
  laptop_mode is a knob that controls "laptop mode". All the things that are
  controlled by this knob are discussed in Documentation/laptops/laptop-mode.txt.
1743660b9   Christoph Lameter   [PATCH] Zone recl...
261

db0fb1848   Peter W Morreale   Update of Documen...
262
  ==============================================================
1743660b9   Christoph Lameter   [PATCH] Zone recl...
263

db0fb1848   Peter W Morreale   Update of Documen...
264
  legacy_va_layout
1b2ffb789   Christoph Lameter   [PATCH] Zone recl...
265

2174efb6a   Kulikov Vasiliy   Documentation/sys...
266
  If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
db0fb1848   Peter W Morreale   Update of Documen...
267
  will use the legacy (2.4) layout for all processes.
1b2ffb789   Christoph Lameter   [PATCH] Zone recl...
268

db0fb1848   Peter W Morreale   Update of Documen...
269
  ==============================================================
1b2ffb789   Christoph Lameter   [PATCH] Zone recl...
270

db0fb1848   Peter W Morreale   Update of Documen...
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
  lowmem_reserve_ratio
  
  For some specialised workloads on highmem machines it is dangerous for
  the kernel to allow process memory to be allocated from the "lowmem"
  zone.  This is because that memory could then be pinned via the mlock()
  system call, or by unavailability of swapspace.
  
  And on large highmem machines this lack of reclaimable lowmem memory
  can be fatal.
  
  So the Linux page allocator has a mechanism which prevents allocations
  which _could_ use highmem from using too much lowmem.  This means that
  a certain amount of lowmem is defended from the possibility of being
  captured into pinned user memory.
  
  (The same argument applies to the old 16 megabyte ISA DMA region.  This
  mechanism will also defend that region from allocations which could use
  highmem or lowmem).
  
  The `lowmem_reserve_ratio' tunable determines how aggressive the kernel is
  in defending these lower zones.
  
  If you have a machine which uses highmem or ISA DMA and your
  applications are using mlock(), or if you are running with no swap then
  you probably should change the lowmem_reserve_ratio setting.
  
  The lowmem_reserve_ratio is an array. You can see them by reading this file.
  -
  % cat /proc/sys/vm/lowmem_reserve_ratio
  256     256     32
  -
  Note: # of this elements is one fewer than number of zones. Because the highest
        zone's value is not necessary for following calculation.
  
  But, these values are not used directly. The kernel calculates # of protection
  pages for each zones from them. These are shown as array of protection pages
  in /proc/zoneinfo like followings. (This is an example of x86-64 box).
  Each zone has an array of protection pages like this.
  
  -
  Node 0, zone      DMA
    pages free     1355
          min      3
          low      3
          high     4
  	:
  	:
      numa_other   0
          protection: (0, 2004, 2004, 2004)
  	^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    pagesets
      cpu: 0 pcp: 0
          :
  -
  These protections are added to score to judge whether this zone should be used
  for page allocation or should be reclaimed.
  
  In this example, if normal pages (index=2) are required to this DMA zone and
418589663   Mel Gorman   page allocator: u...
329
330
  watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
  not be used because pages_free(1355) is smaller than watermark + protection[2]
db0fb1848   Peter W Morreale   Update of Documen...
331
332
333
334
335
336
337
338
  (4 + 2004 = 2008). If this protection value is 0, this zone would be used for
  normal page requirement. If requirement is DMA zone(index=0), protection[0]
  (=0) is used.
  
  zone[i]'s protection[j] is calculated by following expression.
  
  (i < j):
    zone[i]->protection[j]
013110a73   Yaowei Bai   mm/page_alloc.c: ...
339
    = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
db0fb1848   Peter W Morreale   Update of Documen...
340
341
342
343
344
345
346
347
348
349
      / lowmem_reserve_ratio[i];
  (i = j):
     (should not be protected. = 0;
  (i > j):
     (not necessary, but looks 0)
  
  The default values of lowmem_reserve_ratio[i] are
      256 (if zone[i] means DMA or DMA32 zone)
      32  (others).
  As above expression, they are reciprocal number of ratio.
013110a73   Yaowei Bai   mm/page_alloc.c: ...
350
  256 means 1/256. # of protection pages becomes about "0.39%" of total managed
db0fb1848   Peter W Morreale   Update of Documen...
351
352
353
354
  pages of higher zones on the node.
  
  If you would like to protect more pages, smaller values are effective.
  The minimum value is 1 (1/1 -> 100%).
1b2ffb789   Christoph Lameter   [PATCH] Zone recl...
355

db0fb1848   Peter W Morreale   Update of Documen...
356
  ==============================================================
1b2ffb789   Christoph Lameter   [PATCH] Zone recl...
357

db0fb1848   Peter W Morreale   Update of Documen...
358
  max_map_count:
1743660b9   Christoph Lameter   [PATCH] Zone recl...
359

db0fb1848   Peter W Morreale   Update of Documen...
360
361
362
363
  This file contains the maximum number of memory map areas a process
  may have. Memory map areas are used as a side-effect of calling
  malloc, directly by mmap and mprotect, and also when loading shared
  libraries.
1743660b9   Christoph Lameter   [PATCH] Zone recl...
364

db0fb1848   Peter W Morreale   Update of Documen...
365
366
367
  While most applications need less than a thousand maps, certain
  programs, particularly malloc debuggers, may consume lots of them,
  e.g., up to one or two maps per allocation.
fadd8fbd1   KAMEZAWA Hiroyuki   [PATCH] support f...
368

db0fb1848   Peter W Morreale   Update of Documen...
369
  The default value is 65536.
9614634fe   Christoph Lameter   [PATCH] ZVC/zone_...
370

6a46079cf   Andi Kleen   HWPOISON: The hig...
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
  =============================================================
  
  memory_failure_early_kill:
  
  Control how to kill processes when uncorrected memory error (typically
  a 2bit error in a memory module) is detected in the background by hardware
  that cannot be handled by the kernel. In some cases (like the page
  still having a valid copy on disk) the kernel will handle the failure
  transparently without affecting any applications. But if there is
  no other uptodate copy of the data it will kill to prevent any data
  corruptions from propagating.
  
  1: Kill all processes that have the corrupted and not reloadable page mapped
  as soon as the corruption is detected.  Note this is not supported
  for a few types of pages, like kernel internally allocated data or
  the swap cache, but works for the majority of user pages.
  
  0: Only unmap the corrupted page from all processes and only kill a process
  who tries to access it.
  
  The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
  handle this if they want to.
  
  This is only active on architectures/platforms with advanced machine
  check handling and depends on the hardware capabilities.
  
  Applications can override this setting individually with the PR_MCE_KILL prctl
  
  ==============================================================
  
  memory_failure_recovery
  
  Enable memory failure recovery (when supported by the platform)
  
  1: Attempt recovery.
  
  0: Always panic on a memory failure.
db0fb1848   Peter W Morreale   Update of Documen...
408
  ==============================================================
9614634fe   Christoph Lameter   [PATCH] ZVC/zone_...
409

db0fb1848   Peter W Morreale   Update of Documen...
410
  min_free_kbytes:
9614634fe   Christoph Lameter   [PATCH] ZVC/zone_...
411

db0fb1848   Peter W Morreale   Update of Documen...
412
  This is used to force the Linux VM to keep a minimum number
418589663   Mel Gorman   page allocator: u...
413
414
415
416
  of kilobytes free.  The VM uses this number to compute a
  watermark[WMARK_MIN] value for each lowmem zone in the system.
  Each lowmem zone gets a number of reserved free pages based
  proportionally on its size.
db0fb1848   Peter W Morreale   Update of Documen...
417
418
419
420
421
422
  
  Some minimal amount of memory is needed to satisfy PF_MEMALLOC
  allocations; if you set this to lower than 1024KB, your system will
  become subtly broken, and prone to deadlock under high loads.
  
  Setting this too high will OOM your machine instantly.
9614634fe   Christoph Lameter   [PATCH] ZVC/zone_...
423
424
  
  =============================================================
0ff38490c   Christoph Lameter   [PATCH] zone_recl...
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
  min_slab_ratio:
  
  This is available only on NUMA kernels.
  
  A percentage of the total pages in each zone.  On Zone reclaim
  (fallback from the local zone occurs) slabs will be reclaimed if more
  than this percentage of pages in a zone are reclaimable slab pages.
  This insures that the slab growth stays under control even in NUMA
  systems that rarely perform global reclaim.
  
  The default is 5 percent.
  
  Note that slab reclaim is triggered in a per zone / node fashion.
  The process of reclaiming slab memory is currently not node specific
  and may not be fast.
  
  =============================================================
db0fb1848   Peter W Morreale   Update of Documen...
442
  min_unmapped_ratio:
fadd8fbd1   KAMEZAWA Hiroyuki   [PATCH] support f...
443

db0fb1848   Peter W Morreale   Update of Documen...
444
  This is available only on NUMA kernels.
fadd8fbd1   KAMEZAWA Hiroyuki   [PATCH] support f...
445

90afa5de6   Mel Gorman   vmscan: properly ...
446
447
448
449
450
451
452
453
  This is a percentage of the total pages in each zone. Zone reclaim will
  only occur if more than this percentage of pages are in a state that
  zone_reclaim_mode allows to be reclaimed.
  
  If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
  against all file-backed unmapped pages including swapcache pages and tmpfs
  files. Otherwise, only unmapped pages backed by normal files but not tmpfs
  files and similar are considered.
2b744c01a   Yasunori Goto   mm: fix handling ...
454

db0fb1848   Peter W Morreale   Update of Documen...
455
  The default is 1 percent.
fadd8fbd1   KAMEZAWA Hiroyuki   [PATCH] support f...
456

db0fb1848   Peter W Morreale   Update of Documen...
457
  ==============================================================
2b744c01a   Yasunori Goto   mm: fix handling ...
458

db0fb1848   Peter W Morreale   Update of Documen...
459
  mmap_min_addr
ed0321895   Eric Paris   security: Protect...
460

db0fb1848   Peter W Morreale   Update of Documen...
461
  This file indicates the amount of address space  which a user process will
af901ca18   André Goddard Rosa   tree-wide: fix as...
462
  be restricted from mmapping.  Since kernel null dereference bugs could
db0fb1848   Peter W Morreale   Update of Documen...
463
464
465
466
467
468
  accidentally operate based on the information in the first couple of pages
  of memory userspace processes should not be allowed to write to them.  By
  default this value is set to 0 and no protections will be enforced by the
  security module.  Setting this value to something like 64k will allow the
  vast majority of applications to work correctly and provide defense in depth
  against future potential kernel bugs.
fe071d7e8   David Rientjes   oom: add oom_kill...
469

db0fb1848   Peter W Morreale   Update of Documen...
470
  ==============================================================
fef1bdd68   David Rientjes   oom: add sysctl t...
471

d07e22597   Daniel Cashman   mm: mmap: add new...
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
  mmap_rnd_bits:
  
  This value can be used to select the number of bits to use to
  determine the random offset to the base address of vma regions
  resulting from mmap allocations on architectures which support
  tuning address space randomization.  This value will be bounded
  by the architecture's minimum and maximum supported values.
  
  This value can be changed after boot using the
  /proc/sys/vm/mmap_rnd_bits tunable
  
  ==============================================================
  
  mmap_rnd_compat_bits:
  
  This value can be used to select the number of bits to use to
  determine the random offset to the base address of vma regions
  resulting from mmap allocations for applications run in
  compatibility mode on architectures which support tuning address
  space randomization.  This value will be bounded by the
  architecture's minimum and maximum supported values.
  
  This value can be changed after boot using the
  /proc/sys/vm/mmap_rnd_compat_bits tunable
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
498
  nr_hugepages
fef1bdd68   David Rientjes   oom: add sysctl t...
499

db0fb1848   Peter W Morreale   Update of Documen...
500
  Change the minimum size of the hugepage pool.
fef1bdd68   David Rientjes   oom: add sysctl t...
501

db0fb1848   Peter W Morreale   Update of Documen...
502
  See Documentation/vm/hugetlbpage.txt
fef1bdd68   David Rientjes   oom: add sysctl t...
503

db0fb1848   Peter W Morreale   Update of Documen...
504
  ==============================================================
fef1bdd68   David Rientjes   oom: add sysctl t...
505

db0fb1848   Peter W Morreale   Update of Documen...
506
  nr_overcommit_hugepages
fef1bdd68   David Rientjes   oom: add sysctl t...
507

db0fb1848   Peter W Morreale   Update of Documen...
508
509
  Change the maximum size of the hugepage pool. The maximum is
  nr_hugepages + nr_overcommit_hugepages.
fe071d7e8   David Rientjes   oom: add oom_kill...
510

db0fb1848   Peter W Morreale   Update of Documen...
511
  See Documentation/vm/hugetlbpage.txt
fe071d7e8   David Rientjes   oom: add oom_kill...
512

db0fb1848   Peter W Morreale   Update of Documen...
513
  ==============================================================
fe071d7e8   David Rientjes   oom: add oom_kill...
514

db0fb1848   Peter W Morreale   Update of Documen...
515
  nr_trim_pages
ed0321895   Eric Paris   security: Protect...
516

db0fb1848   Peter W Morreale   Update of Documen...
517
518
519
520
521
522
523
524
525
526
527
528
  This is available only on NOMMU kernels.
  
  This value adjusts the excess page trimming behaviour of power-of-2 aligned
  NOMMU mmap allocations.
  
  A value of 0 disables trimming of allocations entirely, while a value of 1
  trims excess pages aggressively. Any value >= 1 acts as the watermark where
  trimming of allocations is initiated.
  
  The default value is 1.
  
  See Documentation/nommu-mmap.txt for more information.
ed0321895   Eric Paris   security: Protect...
529

f0c0b2b80   KAMEZAWA Hiroyuki   change zonelist o...
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
  ==============================================================
  
  numa_zonelist_order
  
  This sysctl is only for NUMA.
  'where the memory is allocated from' is controlled by zonelists.
  (This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
   you may be able to read ZONE_DMA as ZONE_DMA32...)
  
  In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
  ZONE_NORMAL -> ZONE_DMA
  This means that a memory allocation request for GFP_KERNEL will
  get memory from ZONE_DMA only when ZONE_NORMAL is not available.
  
  In NUMA case, you can think of following 2 types of order.
  Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL
  
  (A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
  (B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
  
  Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
  will be used before ZONE_NORMAL exhaustion. This increases possibility of
  out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
  
  Type(B) cannot offer the best locality but is more robust against OOM of
  the DMA zone.
  
  Type(A) is called as "Node" order. Type (B) is "Zone" order.
  
  "Node order" orders the zonelists by node, then by zone within each node.
5a3016a61   Paul Bolle   doc: fix 3 typos ...
560
  Specify "[Nn]ode" for node order
f0c0b2b80   KAMEZAWA Hiroyuki   change zonelist o...
561
562
  
  "Zone Order" orders the zonelists by zone type, then by node within each
5a3016a61   Paul Bolle   doc: fix 3 typos ...
563
  zone.  Specify "[Zz]one" for zone order.
f0c0b2b80   KAMEZAWA Hiroyuki   change zonelist o...
564

7c88a292d   Xishi Qiu   Documentation/sys...
565
566
567
568
569
570
571
572
573
574
  Specify "[Dd]efault" to request automatic configuration.
  
  On 32-bit, the Normal zone needs to be preserved for allocations accessible
  by the kernel, so "zone" order will be selected.
  
  On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
  order will be selected.
  
  Default order is recommended unless this is causing problems for your
  system/application.
d5dbac87b   Nishanth Aravamudan   Documentation: up...
575
576
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
577
  oom_dump_tasks
d5dbac87b   Nishanth Aravamudan   Documentation: up...
578

dc6c9a35b   Kirill A. Shutemov   mm: account pmd p...
579
580
581
582
583
584
  Enables a system-wide task dump (excluding kernel threads) to be produced
  when the kernel performs an OOM-killing and includes such information as
  pid, uid, tgid, vm size, rss, nr_ptes, nr_pmds, swapents, oom_score_adj
  score, and name.  This is helpful to determine why the OOM killer was
  invoked, to identify the rogue task that caused it, and to determine why
  the OOM killer chose the task it did to kill.
d5dbac87b   Nishanth Aravamudan   Documentation: up...
585

db0fb1848   Peter W Morreale   Update of Documen...
586
587
588
589
590
591
592
593
  If this is set to zero, this information is suppressed.  On very
  large systems with thousands of tasks it may not be feasible to dump
  the memory state information for each one.  Such systems should not
  be forced to incur a performance penalty in OOM conditions when the
  information may not be desired.
  
  If this is set to non-zero, this information is shown whenever the
  OOM killer actually kills a memory-hogging task.
ad915c432   David Rientjes   oom: enable oom t...
594
  The default value is 1 (enabled).
d5dbac87b   Nishanth Aravamudan   Documentation: up...
595
596
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
597
  oom_kill_allocating_task
d5dbac87b   Nishanth Aravamudan   Documentation: up...
598

db0fb1848   Peter W Morreale   Update of Documen...
599
600
  This enables or disables killing the OOM-triggering task in
  out-of-memory situations.
d5dbac87b   Nishanth Aravamudan   Documentation: up...
601

db0fb1848   Peter W Morreale   Update of Documen...
602
603
604
605
606
607
608
609
610
611
612
613
614
  If this is set to zero, the OOM killer will scan through the entire
  tasklist and select a task based on heuristics to kill.  This normally
  selects a rogue memory-hogging task that frees up a large amount of
  memory when killed.
  
  If this is set to non-zero, the OOM killer simply kills the task that
  triggered the out-of-memory condition.  This avoids the expensive
  tasklist scan.
  
  If panic_on_oom is selected, it takes precedence over whatever value
  is used in oom_kill_allocating_task.
  
  The default value is 0.
dd8632a12   Paul Mundt   NOMMU: Make mmap ...
615
616
  
  ==============================================================
49f0ce5f9   Jerome Marchand   mm: add overcommi...
617
618
619
620
621
622
623
624
625
626
  overcommit_kbytes:
  
  When overcommit_memory is set to 2, the committed address space is not
  permitted to exceed swap plus this amount of physical RAM. See below.
  
  Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
  of them may be specified at a time. Setting one disables the other (which
  then appears as 0 when read).
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
627
  overcommit_memory:
dd8632a12   Paul Mundt   NOMMU: Make mmap ...
628

db0fb1848   Peter W Morreale   Update of Documen...
629
  This value contains a flag that enables memory overcommitment.
dd8632a12   Paul Mundt   NOMMU: Make mmap ...
630

db0fb1848   Peter W Morreale   Update of Documen...
631
632
  When this flag is 0, the kernel attempts to estimate the amount
  of free memory left when userspace requests more memory.
dd8632a12   Paul Mundt   NOMMU: Make mmap ...
633

db0fb1848   Peter W Morreale   Update of Documen...
634
635
  When this flag is 1, the kernel pretends there is always enough
  memory until it actually runs out.
dd8632a12   Paul Mundt   NOMMU: Make mmap ...
636

db0fb1848   Peter W Morreale   Update of Documen...
637
638
  When this flag is 2, the kernel uses a "never overcommit"
  policy that attempts to prevent any overcommit of memory.
c9b1d0981   Andrew Shewmaker   mm: limit growth ...
639
  Note that user_reserve_kbytes affects this policy.
dd8632a12   Paul Mundt   NOMMU: Make mmap ...
640

db0fb1848   Peter W Morreale   Update of Documen...
641
642
643
644
645
646
647
  This feature can be very useful because there are a lot of
  programs that malloc() huge amounts of memory "just-in-case"
  and don't use much of it.
  
  The default value is 0.
  
  See Documentation/vm/overcommit-accounting and
c56050c70   Chun Chen   Documentation/sys...
648
  mm/mmap.c::__vm_enough_memory() for more information.
db0fb1848   Peter W Morreale   Update of Documen...
649
650
651
652
653
654
655
656
657
658
659
660
  
  ==============================================================
  
  overcommit_ratio:
  
  When overcommit_memory is set to 2, the committed address
  space is not permitted to exceed swap plus this percentage
  of physical RAM.  See above.
  
  ==============================================================
  
  page-cluster
df858fa82   Christian Ehrhardt   documentation: up...
661
662
663
664
665
  page-cluster controls the number of pages up to which consecutive pages
  are read in from swap in a single attempt. This is the swap counterpart
  to page cache readahead.
  The mentioned consecutivity is not in terms of virtual/physical addresses,
  but consecutive on swap space - that means they were swapped out together.
db0fb1848   Peter W Morreale   Update of Documen...
666
667
668
  
  It is a logarithmic value - setting it to zero means "1 page", setting
  it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
df858fa82   Christian Ehrhardt   documentation: up...
669
  Zero disables swap readahead completely.
db0fb1848   Peter W Morreale   Update of Documen...
670
671
672
673
  
  The default value is three (eight pages at a time).  There may be some
  small benefits in tuning this to a different value if your workload is
  swap-intensive.
df858fa82   Christian Ehrhardt   documentation: up...
674
675
676
  Lower values mean lower latencies for initial faults, but at the same time
  extra faults and I/O delays for following faults if they would have been part of
  that consecutive pages readahead would have brought in.
db0fb1848   Peter W Morreale   Update of Documen...
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
  =============================================================
  
  panic_on_oom
  
  This enables or disables panic on out-of-memory feature.
  
  If this is set to 0, the kernel will kill some rogue process,
  called oom_killer.  Usually, oom_killer can kill rogue processes and
  system will survive.
  
  If this is set to 1, the kernel panics when out-of-memory happens.
  However, if a process limits using nodes by mempolicy/cpusets,
  and those nodes become memory exhaustion status, one process
  may be killed by oom-killer. No panic occurs in this case.
  Because other nodes' memory may be free. This means system total status
  may be not fatal yet.
  
  If this is set to 2, the kernel panics compulsorily even on the
daaf1e688   KAMEZAWA Hiroyuki   memcg: handle pan...
695
696
  above-mentioned. Even oom happens under memory cgroup, the whole
  system panics.
db0fb1848   Peter W Morreale   Update of Documen...
697
698
699
700
  
  The default value is 0.
  1 and 2 are for failover of clustering. Please select either
  according to your policy of failover.
daaf1e688   KAMEZAWA Hiroyuki   memcg: handle pan...
701
702
  panic_on_oom=2+kdump gives you very strong tool to investigate
  why oom happens. You can get snapshot.
db0fb1848   Peter W Morreale   Update of Documen...
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
  
  =============================================================
  
  percpu_pagelist_fraction
  
  This is the fraction of pages at most (high mark pcp->high) in each zone that
  are allocated for each per cpu page list.  The min value for this is 8.  It
  means that we don't allow more than 1/8th of pages in each zone to be
  allocated in any single per_cpu_pagelist.  This entry only changes the value
  of hot per cpu pagelists.  User can specify a number like 100 to allocate
  1/100th of each zone to each per cpu page list.
  
  The batch value of each per cpu pagelist is also updated as a result.  It is
  set to pcp->high/4.  The upper limit of batch is (PAGE_SHIFT * 8)
  
  The initial value is zero.  Kernel does not use this value at boot time to set
7cd2b0a34   David Rientjes   mm, pcp: allow re...
719
720
  the high water marks for each per cpu page list.  If the user writes '0' to this
  sysctl, it will revert to this default behavior.
db0fb1848   Peter W Morreale   Update of Documen...
721
722
723
724
725
726
727
728
729
  
  ==============================================================
  
  stat_interval
  
  The time interval between which vm statistics are updated.  The default
  is 1 second.
  
  ==============================================================
52b6f46bc   Hugh Dickins   mm: /proc/sys/vm/...
730
731
732
733
734
735
736
737
738
739
740
741
  stat_refresh
  
  Any read or write (by root only) flushes all the per-cpu vm statistics
  into their global totals, for more accurate reports when testing
  e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
  
  As a side-effect, it also checks for negative totals (elsewhere reported
  as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
  (At time of writing, a few stats are known sometimes to be found negative,
  with no ill effects: errors and warnings on these stats are suppressed.)
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
742
743
744
745
  swappiness
  
  This control is used to define how aggressive the kernel will swap
  memory pages.  Higher values will increase agressiveness, lower values
8582cb96b   Aaron Tomlin   mm: document impr...
746
747
748
  decrease the amount of swap.  A value of 0 instructs the kernel not to
  initiate swap until the amount of free and file-backed pages is less
  than the high water mark in a zone.
db0fb1848   Peter W Morreale   Update of Documen...
749
750
751
752
  
  The default value is 60.
  
  ==============================================================
c9b1d0981   Andrew Shewmaker   mm: limit growth ...
753
  - user_reserve_kbytes
633708a4a   Masanari Iida   Documentation: mm...
754
  When overcommit_memory is set to 2, "never overcommit" mode, reserve
c9b1d0981   Andrew Shewmaker   mm: limit growth ...
755
756
757
758
759
760
761
762
763
764
765
766
767
768
  min(3% of current process size, user_reserve_kbytes) of free memory.
  This is intended to prevent a user from starting a single memory hogging
  process, such that they cannot recover (kill the hog).
  
  user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
  
  If this is reduced to zero, then the user will be allowed to allocate
  all free memory with a single process, minus admin_reserve_kbytes.
  Any subsequent attempts to execute a command will result in
  "fork: Cannot allocate memory".
  
  Changing this takes effect whenever an application requests memory.
  
  ==============================================================
db0fb1848   Peter W Morreale   Update of Documen...
769
770
  vfs_cache_pressure
  ------------------
4a0da71b9   Denys Vlasenko   Documentation/sys...
771
772
  This percentage value controls the tendency of the kernel to reclaim
  the memory which is used for caching of directory and inode objects.
db0fb1848   Peter W Morreale   Update of Documen...
773
774
775
776
  
  At the default value of vfs_cache_pressure=100 the kernel will attempt to
  reclaim dentries and inodes at a "fair" rate with respect to pagecache and
  swapcache reclaim.  Decreasing vfs_cache_pressure causes the kernel to prefer
55c37a840   Jan Kara   vm: document that...
777
778
779
  to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
  never reclaim dentries and inodes due to memory pressure and this can easily
  lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
db0fb1848   Peter W Morreale   Update of Documen...
780
  causes the kernel to prefer to reclaim dentries and inodes.
4a0da71b9   Denys Vlasenko   Documentation/sys...
781
782
783
784
  Increasing vfs_cache_pressure significantly beyond 100 may have negative
  performance impact. Reclaim code needs to take various locks to find freeable
  directory and inode objects. With vfs_cache_pressure=1000, it will look for
  ten times more freeable objects than there are.
795ae7a0d   Johannes Weiner   mm: scale kswapd ...
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
  =============================================================
  
  watermark_scale_factor:
  
  This factor controls the aggressiveness of kswapd. It defines the
  amount of memory left in a node/system before kswapd is woken up and
  how much memory needs to be free before kswapd goes back to sleep.
  
  The unit is in fractions of 10,000. The default value of 10 means the
  distances between watermarks are 0.1% of the available memory in the
  node/system. The maximum value is 1000, or 10% of memory.
  
  A high rate of threads entering direct reclaim (allocstall) or kswapd
  going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
  that the number of free pages kswapd maintains for latency reasons is
  too small for the allocation bursts occurring in the system. This knob
  can then be used to tune kswapd aggressiveness accordingly.
db0fb1848   Peter W Morreale   Update of Documen...
802
803
804
805
806
807
808
809
810
811
812
813
814
815
  ==============================================================
  
  zone_reclaim_mode:
  
  Zone_reclaim_mode allows someone to set more or less aggressive approaches to
  reclaim memory when a zone runs out of memory. If it is set to zero then no
  zone reclaim occurs. Allocations will be satisfied from other zones / nodes
  in the system.
  
  This is value ORed together of
  
  1	= Zone reclaim on
  2	= Zone reclaim writes dirty pages out
  4	= Zone reclaim swaps pages
4f9b16a64   Mel Gorman   mm: disable zone_...
816
817
818
  zone_reclaim_mode is disabled by default.  For file servers or workloads
  that benefit from having their data cached, zone_reclaim_mode should be
  left disabled as the caching effect is likely to be more important than
db0fb1848   Peter W Morreale   Update of Documen...
819
  data locality.
4f9b16a64   Mel Gorman   mm: disable zone_...
820
821
822
823
824
  zone_reclaim may be enabled if it's known that the workload is partitioned
  such that each partition fits within a NUMA node and that accessing remote
  memory would cause a measurable performance reduction.  The page allocator
  will then reclaim easily reusable pages (those page cache pages that are
  currently not used) before allocating off node pages.
db0fb1848   Peter W Morreale   Update of Documen...
825
826
827
828
829
830
831
832
833
834
835
836
837
  Allowing zone reclaim to write out pages stops processes that are
  writing large amounts of data from dirtying pages on other nodes. Zone
  reclaim will write out dirty pages if a zone fills up and so effectively
  throttle the process. This may decrease the performance of a single process
  since it cannot use all of system memory to buffer the outgoing writes
  anymore but it preserve the memory on other nodes so that the performance
  of other processes running on other nodes will not be affected.
  
  Allowing regular swap effectively restricts allocations to the local
  node unless explicitly overridden by memory policies or cpuset
  configurations.
  
  ============ End of Document =================================