vm.rst 33.4 KB
Newer Older
1 2 3
===============================
Documentation for /proc/sys/vm/
===============================
L
Linus Torvalds 已提交
4

5
kernel version 2.6.29
L
Linus Torvalds 已提交
6

7 8 9 10 11 12 13
Copyright (c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>

Copyright (c) 2008         Peter W. Morreale <pmorreale@novell.com>

For general info and legal blurb, please look in index.rst.

------------------------------------------------------------------------------
L
Linus Torvalds 已提交
14 15

This file contains the documentation for the sysctl files in
16
/proc/sys/vm and is valid for Linux kernel version 2.6.29.
L
Linus Torvalds 已提交
17 18 19 20 21 22 23 24 25

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:
26

27
- admin_reserve_kbytes
28
- block_dump
29
- compact_memory
30
- compact_unevictable_allowed
31
- dirty_background_bytes
L
Linus Torvalds 已提交
32
- dirty_background_ratio
33
- dirty_bytes
L
Linus Torvalds 已提交
34
- dirty_expire_centisecs
35
- dirty_ratio
36
- dirtytime_expire_seconds
L
Linus Torvalds 已提交
37
- dirty_writeback_centisecs
38
- drop_caches
39
- extfrag_threshold
40 41 42 43
- hugetlb_shm_group
- laptop_mode
- legacy_va_layout
- lowmem_reserve_ratio
L
Linus Torvalds 已提交
44
- max_map_count
45 46
- memory_failure_early_kill
- memory_failure_recovery
L
Linus Torvalds 已提交
47
- min_free_kbytes
48
- min_slab_ratio
49 50
- min_unmapped_ratio
- mmap_min_addr
51 52
- mmap_rnd_bits
- mmap_rnd_compat_bits
53
- nr_hugepages
54
- nr_hugepages_mempolicy
55
- nr_overcommit_hugepages
56 57 58 59
- nr_trim_pages         (only if CONFIG_MMU=n)
- numa_zonelist_order
- oom_dump_tasks
- oom_kill_allocating_task
60
- overcommit_kbytes
61 62 63 64 65 66
- overcommit_memory
- overcommit_ratio
- page-cluster
- panic_on_oom
- percpu_pagelist_fraction
- stat_interval
67
- stat_refresh
68
- numa_stat
69
- swappiness
70
- unprivileged_userfaultfd
71
- user_reserve_kbytes
72
- vfs_cache_pressure
73
- watermark_boost_factor
74
- watermark_scale_factor
75 76
- zone_reclaim_mode

L
Linus Torvalds 已提交
77

78
admin_reserve_kbytes
79
====================
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

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.


107
block_dump
108
==========
L
Linus Torvalds 已提交
109

110
block_dump enables block I/O debugging when set to a nonzero value. More
111
information on block I/O debugging is in Documentation/admin-guide/laptops/laptop-mode.rst.
L
Linus Torvalds 已提交
112 113


114
compact_memory
115
==============
116 117 118 119 120 121 122

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.


123
compact_unevictable_allowed
124
===========================
125 126 127 128 129 130

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.
131 132 133
On CONFIG_PREEMPT_RT the default value is 0 in order to avoid a page fault, due
to compaction, which would block the task from becomming active until the fault
is resolved.
134 135


136
dirty_background_bytes
137
======================
L
Linus Torvalds 已提交
138

139 140
Contains the amount of dirty memory at which the background kernel
flusher threads will start writeback.
L
Linus Torvalds 已提交
141

142 143 144 145 146
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.
L
Linus Torvalds 已提交
147 148


149
dirty_background_ratio
150
======================
L
Linus Torvalds 已提交
151

152 153 154 155
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.

C
Chris Dunlop 已提交
156
The total available memory is not equal to total system memory.
L
Linus Torvalds 已提交
157 158


159
dirty_bytes
160
===========
161 162 163 164

Contains the amount of dirty memory at which a process generating disk writes
will itself start writeback.

165 166 167 168
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.
L
Linus Torvalds 已提交
169

170 171 172 173
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.

L
Linus Torvalds 已提交
174

175
dirty_expire_centisecs
176
======================
L
Linus Torvalds 已提交
177

178
This tunable is used to define when dirty data is old enough to be eligible
179 180 181
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.
182 183 184


dirty_ratio
185
===========
186

187 188 189 190
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.

C
Chris Dunlop 已提交
191
The total available memory is not equal to total system memory.
L
Linus Torvalds 已提交
192 193


194
dirtytime_expire_seconds
195
========================
196 197 198 199 200 201 202 203 204 205

When a lazytime inode is constantly having its pages dirtied, the inode with
an updated timestamp will never get chance to be written out.  And, if the
only thing that has happened on the file system is a dirtytime inode caused
by an atime update, a worker will be scheduled to make sure that inode
eventually gets pushed out to disk.  This tunable is used to define when dirty
inode is old enough to be eligible for writeback by the kernel flusher threads.
And, it is also used as the interval to wakeup dirtytime_writeback thread.


206
dirty_writeback_centisecs
207
=========================
L
Linus Torvalds 已提交
208

209
The kernel flusher threads will periodically wake up and write `old` data
210 211
out to disk.  This tunable expresses the interval between those wakeups, in
100'ths of a second.
L
Linus Torvalds 已提交
212

213
Setting this to zero disables periodic writeback altogether.
L
Linus Torvalds 已提交
214 215


216
drop_caches
217
===========
L
Linus Torvalds 已提交
218

219 220 221
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.
L
Linus Torvalds 已提交
222

223 224
To free pagecache::

225
	echo 1 > /proc/sys/vm/drop_caches
226 227 228

To free reclaimable slab objects (includes dentries and inodes)::

229
	echo 2 > /proc/sys/vm/drop_caches
230 231 232

To free slab objects and pagecache::

233
	echo 3 > /proc/sys/vm/drop_caches
L
Linus Torvalds 已提交
234

235 236
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
237
`sync` prior to writing to /proc/sys/vm/drop_caches.  This will minimize the
238 239 240 241 242 243 244 245 246 247 248 249 250
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
251
used::
252 253 254 255

	cat (1234): drop_caches: 3

These are informational only.  They do not mean that anything is wrong
256
with your system.  To disable them, echo 4 (bit 2) into drop_caches.
L
Linus Torvalds 已提交
257 258


259
extfrag_threshold
260
=================
261 262

This parameter affects whether the kernel will compact memory or direct
263 264 265 266 267
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.
268 269 270 271 272

The kernel will not compact memory in a zone if the
fragmentation index is <= extfrag_threshold. The default value is 500.


273
highmem_is_dirtyable
274
====================
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

Available only for systems with CONFIG_HIGHMEM enabled (32b systems).

This parameter controls whether the high memory is considered for dirty
writers throttling.  This is not the case by default which means that
only the amount of memory directly visible/usable by the kernel can
be dirtied. As a result, on systems with a large amount of memory and
lowmem basically depleted writers might be throttled too early and
streaming writes can get very slow.

Changing the value to non zero would allow more memory to be dirtied
and thus allow writers to write more data which can be flushed to the
storage more effectively. Note this also comes with a risk of pre-mature
OOM killer because some writers (e.g. direct block device writes) can
only use the low memory and they can fill it up with dirty data without
any throttling.


293
hugetlb_shm_group
294
=================
295

296 297
hugetlb_shm_group contains group id that is allowed to create SysV
shared memory segment using hugetlb page.
298 299


300
laptop_mode
301
===========
302

303
laptop_mode is a knob that controls "laptop mode". All the things that are
304
controlled by this knob are discussed in Documentation/admin-guide/laptops/laptop-mode.rst.
305 306


307
legacy_va_layout
308
================
309

310
If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
311
will use the legacy (2.4) layout for all processes.
312 313


314
lowmem_reserve_ratio
315
====================
316 317 318 319 320 321 322 323 324 325

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
326
which *could* use highmem from using too much lowmem.  This means that
327 328 329 330 331 332 333
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).

334
The `lowmem_reserve_ratio` tunable determines how aggressive the kernel is
335 336 337 338 339 340
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.

341 342 343 344
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
345 346 347 348

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).
349 350 351 352 353 354 355
Each zone has an array of protection pages like this::

  Node 0, zone      DMA
    pages free     1355
          min      3
          low      3
          high     4
356 357
	:
	:
358 359
      numa_other   0
          protection: (0, 2004, 2004, 2004)
360
	^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
361 362 363 364
    pagesets
      cpu: 0 pcp: 0
          :

365 366 367 368
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
369 370
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]
371 372 373 374
(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.

375
zone[i]'s protection[j] is calculated by following expression::
376

377 378 379 380 381 382 383 384
  (i < j):
    zone[i]->protection[j]
    = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
      / lowmem_reserve_ratio[i];
  (i = j):
     (should not be protected. = 0;
  (i > j):
     (not necessary, but looks 0)
385 386

The default values of lowmem_reserve_ratio[i] are
387 388

    === ====================================
389
    256 (if zone[i] means DMA or DMA32 zone)
390 391 392
    32  (others)
    === ====================================

393
As above expression, they are reciprocal number of ratio.
394
256 means 1/256. # of protection pages becomes about "0.39%" of total managed
395 396 397
pages of higher zones on the node.

If you would like to protect more pages, smaller values are effective.
398 399
The minimum value is 1 (1/1 -> 100%). The value less than 1 completely
disables protection of the pages.
400 401


402
max_map_count:
403
==============
404

405 406
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
407 408
malloc, directly by mmap, mprotect, and madvise, and also when loading
shared libraries.
409

410 411 412
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.
413

414
The default value is 65536.
415

416 417

memory_failure_early_kill:
418
==========================
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

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
446
=======================
447 448 449 450 451 452 453

Enable memory failure recovery (when supported by the platform)

1: Attempt recovery.

0: Always panic on a memory failure.

454

455 456
min_free_kbytes
===============
457

458
This is used to force the Linux VM to keep a minimum number
459 460 461 462
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.
463 464 465 466 467 468

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.
469 470


471 472
min_slab_ratio
==============
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

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.


489 490
min_unmapped_ratio
==================
491

492
This is available only on NUMA kernels.
493

494 495 496 497 498 499 500 501
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.
502

503
The default is 1 percent.
504

505

506
mmap_min_addr
507
=============
508

509
This file indicates the amount of address space  which a user process will
510
be restricted from mmapping.  Since kernel null dereference bugs could
511 512 513 514 515 516
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.
517

518

519 520
mmap_rnd_bits
=============
521 522 523 524 525 526 527 528 529 530 531

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


532 533
mmap_rnd_compat_bits
====================
534 535 536 537 538 539 540 541 542 543 544 545

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


546
nr_hugepages
547
============
548

549
Change the minimum size of the hugepage pool.
550

551
See Documentation/admin-guide/mm/hugetlbpage.rst
552

553 554

nr_hugepages_mempolicy
555
======================
556 557 558 559 560 561

Change the size of the hugepage pool at run-time on a specific
set of NUMA nodes.

See Documentation/admin-guide/mm/hugetlbpage.rst

562

563
nr_overcommit_hugepages
564
=======================
565

566 567
Change the maximum size of the hugepage pool. The maximum is
nr_hugepages + nr_overcommit_hugepages.
568

569
See Documentation/admin-guide/mm/hugetlbpage.rst
570 571


572
nr_trim_pages
573
=============
574

575 576 577 578 579 580 581 582 583 584 585
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.

586
See Documentation/admin-guide/mm/nommu-mmap.rst for more information.
587

588 589

numa_zonelist_order
590
===================
591

592 593 594
This sysctl is only for NUMA and it is deprecated. Anything but
Node order will fail!

595
'where the memory is allocated from' is controlled by zonelists.
596

597
(This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
598
you may be able to read ZONE_DMA as ZONE_DMA32...)
599 600 601 602 603 604 605

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.
606
Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL::
607

608 609
  (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.
610 611 612 613 614 615 616 617 618 619 620

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.
P
Paul Bolle 已提交
621
Specify "[Nn]ode" for node order
622 623

"Zone Order" orders the zonelists by zone type, then by node within each
P
Paul Bolle 已提交
624
zone.  Specify "[Zz]one" for zone order.
625

626 627 628 629 630 631 632 633 634 635
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.
636 637


638
oom_dump_tasks
639
==============
640

641 642
Enables a system-wide task dump (excluding kernel threads) to be produced
when the kernel performs an OOM-killing and includes such information as
643 644 645 646
pid, uid, tgid, vm size, rss, pgtables_bytes, 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.
647

648 649 650 651 652 653 654 655 656
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.

657
The default value is 1 (enabled).
658 659


660
oom_kill_allocating_task
661
========================
662

663 664
This enables or disables killing the OOM-triggering task in
out-of-memory situations.
665

666 667 668 669 670 671 672 673 674 675 676 677 678
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.
679 680


681 682
overcommit_kbytes
=================
683 684 685 686 687 688 689 690 691

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).


692 693
overcommit_memory
=================
694

695
This value contains a flag that enables memory overcommitment.
696

697 698
When this flag is 0, the kernel attempts to estimate the amount
of free memory left when userspace requests more memory.
699

700 701
When this flag is 1, the kernel pretends there is always enough
memory until it actually runs out.
702

703 704
When this flag is 2, the kernel uses a "never overcommit"
policy that attempts to prevent any overcommit of memory.
705
Note that user_reserve_kbytes affects this policy.
706

707 708 709 710 711 712
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.

713
See Documentation/vm/overcommit-accounting.rst and
714
mm/util.c::__vm_enough_memory() for more information.
715 716


717 718
overcommit_ratio
================
719 720 721 722 723 724 725

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
726
============
727

728 729 730 731 732
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.
733 734 735

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.
736
Zero disables swap readahead completely.
737 738 739 740 741

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.

742 743 744 745
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.

746 747

panic_on_oom
748
============
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

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
764 765
above-mentioned. Even oom happens under memory cgroup, the whole
system panics.
766 767

The default value is 0.
768

769 770
1 and 2 are for failover of clustering. Please select either
according to your policy of failover.
771

772 773
panic_on_oom=2+kdump gives you very strong tool to investigate
why oom happens. You can get snapshot.
774 775 776


percpu_pagelist_fraction
777
========================
778 779 780 781 782 783 784 785 786 787 788 789

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
790 791
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.
792 793 794


stat_interval
795
=============
796 797 798 799 800

The time interval between which vm statistics are updated.  The default
is 1 second.


801
stat_refresh
802
============
803 804 805 806 807 808 809 810 811 812 813

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.)


814
numa_stat
815
=========
816 817 818 819 820

This interface allows runtime configuration of numa statistics.

When page allocation performance becomes a bottleneck and you can tolerate
some possible tool breakage and decreased numa counter precision, you can
821 822
do::

823 824 825
	echo 0 > /proc/sys/vm/numa_stat

When page allocation performance is not a bottleneck and you want all
826 827
tooling to work, you can do::

828 829 830
	echo 1 > /proc/sys/vm/numa_stat


831
swappiness
832
==========
833

834 835 836 837 838 839 840 841 842
This control is used to define the rough relative IO cost of swapping
and filesystem paging, as a value between 0 and 200. At 100, the VM
assumes equal IO cost and will thus apply memory pressure to the page
cache and swap-backed pages equally; lower values signify more
expensive swap IO, higher values indicates cheaper.

Keep in mind that filesystem IO patterns under memory pressure tend to
be more efficient than swap's random IO. An optimal value will require
experimentation and will also be workload-dependent.
843 844 845

The default value is 60.

846 847 848 849 850 851 852 853 854
For in-memory swap, like zram or zswap, as well as hybrid setups that
have swap on faster devices than the filesystem, values beyond 100 can
be considered. For example, if the random IO against the swap device
is on average 2x faster than IO from the filesystem, swappiness should
be 133 (x + 2x = 200, 2x = 133.33).

At 0, the kernel will not initiate swap until the amount of free and
file-backed pages is less than the high watermark in a zone.

855

856
unprivileged_userfaultfd
857
========================
858 859 860 861 862 863 864 865 866

This flag controls whether unprivileged users can use the userfaultfd
system calls.  Set this to 1 to allow unprivileged users to use the
userfaultfd system calls, or set this to 0 to restrict userfaultfd to only
privileged users (with SYS_CAP_PTRACE capability).

The default value is 1.


867 868
user_reserve_kbytes
===================
869

870
When overcommit_memory is set to 2, "never overcommit" mode, reserve
871 872 873 874 875 876 877 878 879 880 881 882 883 884
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.


885
vfs_cache_pressure
886
==================
887

888 889
This percentage value controls the tendency of the kernel to reclaim
the memory which is used for caching of directory and inode objects.
890 891 892 893

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
894 895 896
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
897 898
causes the kernel to prefer to reclaim dentries and inodes.

899 900 901 902 903
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.

904

905 906
watermark_boost_factor
======================
907 908 909 910 911 912 913 914

This factor controls the level of reclaim when memory is being fragmented.
It defines the percentage of the high watermark of a zone that will be
reclaimed if pages of different mobility are being mixed within pageblocks.
The intent is that compaction has less work to do in the future and to
increase the success rate of future high-order allocations such as SLUB
allocations, THP and hugetlbfs pages.

915 916 917 918 919 920 921 922
To make it sensible with respect to the watermark_scale_factor
parameter, the unit is in fractions of 10,000. The default value of
15,000 on !DISCONTIGMEM configurations means that up to 150% of the high
watermark will be reclaimed in the event of a pageblock being mixed due
to fragmentation. The level of reclaim is determined by the number of
fragmentation events that occurred in the recent past. If this value is
smaller than a pageblock then a pageblocks worth of pages will be reclaimed
(e.g.  2MB on 64-bit x86). A boost factor of 0 will disable the feature.
923 924


925 926
watermark_scale_factor
======================
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941

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.

942

943 944
zone_reclaim_mode
=================
945 946 947 948 949 950

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.

951
This is value OR'ed together of
952

953 954 955 956 957
=	===================================
1	Zone reclaim on
2	Zone reclaim writes dirty pages out
4	Zone reclaim swaps pages
=	===================================
958

959 960 961
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
962 963
data locality.

964 965 966 967 968 969
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.

970 971 972 973 974 975 976 977 978 979 980
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.