blob: d06a98b2a4e76e2c0125fd823fb1c3ab901d96af [file] [log] [blame]
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -03001===============================
2Documentation for /proc/sys/vm/
3===============================
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -03005kernel version 2.6.29
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -03007Copyright (c) 1998, 1999, Rik van Riel <riel@nl.linux.org>
8
9Copyright (c) 2008 Peter W. Morreale <pmorreale@novell.com>
10
11For general info and legal blurb, please look in index.rst.
12
13------------------------------------------------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
15This file contains the documentation for the sysctl files in
Peter W Morrealedb0fb182009-01-15 13:50:42 -080016/proc/sys/vm and is valid for Linux kernel version 2.6.29.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
18The files in this directory can be used to tune the operation
19of the virtual memory (VM) subsystem of the Linux kernel and
20the writeout of dirty data to disk.
21
22Default values and initialization routines for most of these
23files can be found in mm/swap.c.
24
25Currently, these files are in /proc/sys/vm:
Peter W Morrealedb0fb182009-01-15 13:50:42 -080026
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070027- admin_reserve_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080028- block_dump
Mel Gorman76ab0f52010-05-24 14:32:28 -070029- compact_memory
Fam Zheng62af6962020-10-22 07:54:03 +010030- compaction_proactiveness
Eric B Munson5bbe3542015-04-15 16:13:20 -070031- compact_unevictable_allowed
Peter W Morrealedb0fb182009-01-15 13:50:42 -080032- dirty_background_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -070033- dirty_background_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080034- dirty_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -070035- dirty_expire_centisecs
Peter W Morrealedb0fb182009-01-15 13:50:42 -080036- dirty_ratio
Yang Shifc1ca3d2018-06-19 07:59:18 +080037- dirtytime_expire_seconds
Linus Torvalds1da177e2005-04-16 15:20:36 -070038- dirty_writeback_centisecs
Peter W Morrealedb0fb182009-01-15 13:50:42 -080039- drop_caches
Mel Gorman5e771902010-05-24 14:32:31 -070040- extfrag_threshold
Fam Zheng62af6962020-10-22 07:54:03 +010041- highmem_is_dirtyable
Peter W Morrealedb0fb182009-01-15 13:50:42 -080042- hugetlb_shm_group
43- laptop_mode
44- legacy_va_layout
45- lowmem_reserve_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -070046- max_map_count
Andi Kleen6a460792009-09-16 11:50:15 +020047- memory_failure_early_kill
48- memory_failure_recovery
Linus Torvalds1da177e2005-04-16 15:20:36 -070049- min_free_kbytes
Christoph Lameter0ff38492006-09-25 23:31:52 -070050- min_slab_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080051- min_unmapped_ratio
52- mmap_min_addr
Daniel Cashmand07e2252016-01-14 15:19:53 -080053- mmap_rnd_bits
54- mmap_rnd_compat_bits
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -080055- nr_hugepages
Prashant Dhamdhered1634e12018-07-20 19:05:00 +053056- nr_hugepages_mempolicy
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -080057- nr_overcommit_hugepages
Peter W Morrealedb0fb182009-01-15 13:50:42 -080058- nr_trim_pages (only if CONFIG_MMU=n)
59- numa_zonelist_order
60- oom_dump_tasks
61- oom_kill_allocating_task
Jerome Marchand49f0ce52014-01-21 15:49:14 -080062- overcommit_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080063- overcommit_memory
64- overcommit_ratio
65- page-cluster
66- panic_on_oom
67- percpu_pagelist_fraction
68- stat_interval
Hugh Dickins52b6f462016-05-19 17:12:50 -070069- stat_refresh
Kemi Wang45180852017-11-15 17:38:22 -080070- numa_stat
Peter W Morrealedb0fb182009-01-15 13:50:42 -080071- swappiness
Peter Xucefdca02019-05-13 17:16:41 -070072- unprivileged_userfaultfd
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -070073- user_reserve_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080074- vfs_cache_pressure
Mel Gorman1c308442018-12-28 00:35:52 -080075- watermark_boost_factor
Jerome Marchande6507a02016-07-12 12:05:59 +020076- watermark_scale_factor
Peter W Morrealedb0fb182009-01-15 13:50:42 -080077- zone_reclaim_mode
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070080admin_reserve_kbytes
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -030081====================
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070082
83The amount of free memory in the system that should be reserved for users
84with the capability cap_sys_admin.
85
86admin_reserve_kbytes defaults to min(3% of free pages, 8MB)
87
88That should provide enough for the admin to log in and kill a process,
89if necessary, under the default overcommit 'guess' mode.
90
91Systems running under overcommit 'never' should increase this to account
92for the full Virtual Memory Size of programs used to recover. Otherwise,
93root may not be able to log in to recover the system.
94
95How do you calculate a minimum useful reserve?
96
97sshd or login + bash (or some other shell) + top (or ps, kill, etc.)
98
99For overcommit 'guess', we can sum resident set sizes (RSS).
100On x86_64 this is about 8MB.
101
102For overcommit 'never', we can take the max of their virtual sizes (VSZ)
103and add the sum of their RSS.
104On x86_64 this is about 128MB.
105
106Changing this takes effect whenever an application requests memory.
107
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -0700108
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800109block_dump
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300110==========
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800112block_dump enables block I/O debugging when set to a nonzero value. More
Mauro Carvalho Chehab9e1cbed2019-06-13 15:07:43 -0300113information on block I/O debugging is in Documentation/admin-guide/laptops/laptop-mode.rst.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Mel Gorman76ab0f52010-05-24 14:32:28 -0700116compact_memory
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300117==============
Mel Gorman76ab0f52010-05-24 14:32:28 -0700118
119Available only when CONFIG_COMPACTION is set. When 1 is written to the file,
120all zones are compacted such that free memory is available in contiguous
121blocks where possible. This can be important for example in the allocation of
122huge pages although processes will also directly compact memory as required.
123
Nitin Guptafacdaa92020-08-11 18:31:00 -0700124compaction_proactiveness
125========================
126
127This tunable takes a value in the range [0, 100] with a default value of
12820. This tunable determines how aggressively compaction is done in the
129background. Setting it to 0 disables proactive compaction.
130
131Note that compaction has a non-trivial system-wide impact as pages
132belonging to different processes are moved around, which could also lead
133to latency spikes in unsuspecting applications. The kernel employs
134various heuristics to avoid wasting CPU cycles if it detects that
135proactive compaction is not being effective.
136
137Be careful when setting it to extreme values like 100, as that may
138cause excessive background compaction activity.
Mel Gorman76ab0f52010-05-24 14:32:28 -0700139
Eric B Munson5bbe3542015-04-15 16:13:20 -0700140compact_unevictable_allowed
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300141===========================
Eric B Munson5bbe3542015-04-15 16:13:20 -0700142
143Available only when CONFIG_COMPACTION is set. When set to 1, compaction is
144allowed to examine the unevictable lru (mlocked pages) for pages to compact.
145This should be used on systems where stalls for minor page faults are an
146acceptable trade for large contiguous free memory. Set to 0 to prevent
147compaction from moving pages that are unevictable. Default value is 1.
Sebastian Andrzej Siewior6923aa02020-04-01 21:10:42 -0700148On CONFIG_PREEMPT_RT the default value is 0 in order to avoid a page fault, due
149to compaction, which would block the task from becomming active until the fault
150is resolved.
Eric B Munson5bbe3542015-04-15 16:13:20 -0700151
Eric B Munson5bbe3542015-04-15 16:13:20 -0700152
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800153dirty_background_bytes
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300154======================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300156Contains the amount of dirty memory at which the background kernel
157flusher threads will start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300159Note:
160 dirty_background_bytes is the counterpart of dirty_background_ratio. Only
161 one of them may be specified at a time. When one sysctl is written it is
162 immediately taken into account to evaluate the dirty memory limits and the
163 other appears as 0 when read.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800166dirty_background_ratio
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300167======================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Zheng Liu715ea412013-11-12 15:08:30 -0800169Contains, as a percentage of total available memory that contains free pages
170and reclaimable pages, the number of pages at which the background kernel
171flusher threads will start writing out dirty data.
172
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000173The total available memory is not equal to total system memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800176dirty_bytes
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300177===========
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800179Contains the amount of dirty memory at which a process generating disk writes
180will itself start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Andrea Righiabffc022010-10-27 15:33:31 -0700182Note: dirty_bytes is the counterpart of dirty_ratio. Only one of them may be
183specified at a time. When one sysctl is written it is immediately taken into
184account to evaluate the dirty memory limits and the other appears as 0 when
185read.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800186
Andrea Righi9e4a5bd2009-04-30 15:08:57 -0700187Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
188value lower than this limit will be ignored and the old configuration will be
189retained.
190
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800191
192dirty_expire_centisecs
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300193======================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800194
195This tunable is used to define when dirty data is old enough to be eligible
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300196for writeout by the kernel flusher threads. It is expressed in 100'ths
197of a second. Data which has been dirty in-memory for longer than this
198interval will be written out next time a flusher thread wakes up.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800199
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800200
201dirty_ratio
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300202===========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800203
Zheng Liu715ea412013-11-12 15:08:30 -0800204Contains, as a percentage of total available memory that contains free pages
205and reclaimable pages, the number of pages at which a process which is
206generating disk writes will itself start writing out dirty data.
207
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000208The total available memory is not equal to total system memory.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800209
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800210
Yang Shifc1ca3d2018-06-19 07:59:18 +0800211dirtytime_expire_seconds
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300212========================
Yang Shifc1ca3d2018-06-19 07:59:18 +0800213
214When a lazytime inode is constantly having its pages dirtied, the inode with
215an updated timestamp will never get chance to be written out. And, if the
216only thing that has happened on the file system is a dirtytime inode caused
217by an atime update, a worker will be scheduled to make sure that inode
218eventually gets pushed out to disk. This tunable is used to define when dirty
219inode is old enough to be eligible for writeback by the kernel flusher threads.
220And, it is also used as the interval to wakeup dirtytime_writeback thread.
221
Yang Shifc1ca3d2018-06-19 07:59:18 +0800222
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800223dirty_writeback_centisecs
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300224=========================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800225
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300226The kernel flusher threads will periodically wake up and write `old` data
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800227out to disk. This tunable expresses the interval between those wakeups, in
228100'ths of a second.
229
230Setting this to zero disables periodic writeback altogether.
231
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800232
233drop_caches
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300234===========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800235
Dave Hansen5509a5d2014-04-03 14:48:19 -0700236Writing to this will cause the kernel to drop clean caches, as well as
237reclaimable slab objects like dentries and inodes. Once dropped, their
238memory becomes free.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800239
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300240To free pagecache::
241
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800242 echo 1 > /proc/sys/vm/drop_caches
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300243
244To free reclaimable slab objects (includes dentries and inodes)::
245
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800246 echo 2 > /proc/sys/vm/drop_caches
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300247
248To free slab objects and pagecache::
249
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800250 echo 3 > /proc/sys/vm/drop_caches
251
Dave Hansen5509a5d2014-04-03 14:48:19 -0700252This is a non-destructive operation and will not free any dirty objects.
253To increase the number of objects freed by this operation, the user may run
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300254`sync` prior to writing to /proc/sys/vm/drop_caches. This will minimize the
Dave Hansen5509a5d2014-04-03 14:48:19 -0700255number of dirty objects on the system and create more candidates to be
256dropped.
257
258This file is not a means to control the growth of the various kernel caches
259(inodes, dentries, pagecache, etc...) These objects are automatically
260reclaimed by the kernel when memory is needed elsewhere on the system.
261
262Use of this file can cause performance problems. Since it discards cached
263objects, it may cost a significant amount of I/O and CPU to recreate the
264dropped objects, especially if they were under heavy use. Because of this,
265use outside of a testing or debugging environment is not recommended.
266
267You may see informational messages in your kernel log when this file is
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300268used::
Dave Hansen5509a5d2014-04-03 14:48:19 -0700269
270 cat (1234): drop_caches: 3
271
272These are informational only. They do not mean that anything is wrong
Vincent Whitchurch631605c2019-01-11 17:14:10 +0100273with your system. To disable them, echo 4 (bit 2) into drop_caches.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800274
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800275
Mel Gorman5e771902010-05-24 14:32:31 -0700276extfrag_threshold
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300277=================
Mel Gorman5e771902010-05-24 14:32:31 -0700278
279This parameter affects whether the kernel will compact memory or direct
Rabin Vincenta10726b2015-07-14 07:35:11 +0200280reclaim to satisfy a high-order allocation. The extfrag/extfrag_index file in
281debugfs shows what the fragmentation index for each order is in each zone in
282the system. Values tending towards 0 imply allocations would fail due to lack
283of memory, values towards 1000 imply failures are due to fragmentation and -1
284implies that the allocation will succeed as long as watermarks are met.
Mel Gorman5e771902010-05-24 14:32:31 -0700285
286The kernel will not compact memory in a zone if the
287fragmentation index is <= extfrag_threshold. The default value is 500.
288
Mel Gorman5e771902010-05-24 14:32:31 -0700289
Michal Hockod09b6462017-07-10 15:49:38 -0700290highmem_is_dirtyable
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300291====================
Michal Hockod09b6462017-07-10 15:49:38 -0700292
293Available only for systems with CONFIG_HIGHMEM enabled (32b systems).
294
295This parameter controls whether the high memory is considered for dirty
296writers throttling. This is not the case by default which means that
297only the amount of memory directly visible/usable by the kernel can
298be dirtied. As a result, on systems with a large amount of memory and
299lowmem basically depleted writers might be throttled too early and
300streaming writes can get very slow.
301
302Changing the value to non zero would allow more memory to be dirtied
303and thus allow writers to write more data which can be flushed to the
304storage more effectively. Note this also comes with a risk of pre-mature
305OOM killer because some writers (e.g. direct block device writes) can
306only use the low memory and they can fill it up with dirty data without
307any throttling.
308
Michal Hockod09b6462017-07-10 15:49:38 -0700309
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800310hugetlb_shm_group
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300311=================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800312
313hugetlb_shm_group contains group id that is allowed to create SysV
314shared memory segment using hugetlb page.
315
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800316
317laptop_mode
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300318===========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800319
320laptop_mode is a knob that controls "laptop mode". All the things that are
Mauro Carvalho Chehab9e1cbed2019-06-13 15:07:43 -0300321controlled by this knob are discussed in Documentation/admin-guide/laptops/laptop-mode.rst.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800322
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800323
324legacy_va_layout
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300325================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800326
Kulikov Vasiliy2174efb2010-06-28 13:59:28 +0200327If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800328will use the legacy (2.4) layout for all processes.
329
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800330
331lowmem_reserve_ratio
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300332====================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800333
334For some specialised workloads on highmem machines it is dangerous for
335the kernel to allow process memory to be allocated from the "lowmem"
336zone. This is because that memory could then be pinned via the mlock()
337system call, or by unavailability of swapspace.
338
339And on large highmem machines this lack of reclaimable lowmem memory
340can be fatal.
341
342So the Linux page allocator has a mechanism which prevents allocations
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300343which *could* use highmem from using too much lowmem. This means that
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800344a certain amount of lowmem is defended from the possibility of being
345captured into pinned user memory.
346
347(The same argument applies to the old 16 megabyte ISA DMA region. This
348mechanism will also defend that region from allocations which could use
349highmem or lowmem).
350
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300351The `lowmem_reserve_ratio` tunable determines how aggressive the kernel is
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800352in defending these lower zones.
353
354If you have a machine which uses highmem or ISA DMA and your
355applications are using mlock(), or if you are running with no swap then
356you probably should change the lowmem_reserve_ratio setting.
357
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300358The lowmem_reserve_ratio is an array. You can see them by reading this file::
359
360 % cat /proc/sys/vm/lowmem_reserve_ratio
361 256 256 32
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800362
363But, these values are not used directly. The kernel calculates # of protection
364pages for each zones from them. These are shown as array of protection pages
365in /proc/zoneinfo like followings. (This is an example of x86-64 box).
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300366Each zone has an array of protection pages like this::
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800367
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300368 Node 0, zone DMA
369 pages free 1355
370 min 3
371 low 3
372 high 4
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800373 :
374 :
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300375 numa_other 0
376 protection: (0, 2004, 2004, 2004)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300378 pagesets
379 cpu: 0 pcp: 0
380 :
381
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800382These protections are added to score to judge whether this zone should be used
383for page allocation or should be reclaimed.
384
385In this example, if normal pages (index=2) are required to this DMA zone and
Mel Gorman41858962009-06-16 15:32:12 -0700386watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
387not be used because pages_free(1355) is smaller than watermark + protection[2]
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800388(4 + 2004 = 2008). If this protection value is 0, this zone would be used for
389normal page requirement. If requirement is DMA zone(index=0), protection[0]
390(=0) is used.
391
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300392zone[i]'s protection[j] is calculated by following expression::
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800393
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300394 (i < j):
395 zone[i]->protection[j]
396 = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
397 / lowmem_reserve_ratio[i];
398 (i = j):
399 (should not be protected. = 0;
400 (i > j):
401 (not necessary, but looks 0)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800402
403The default values of lowmem_reserve_ratio[i] are
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300404
405 === ====================================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800406 256 (if zone[i] means DMA or DMA32 zone)
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300407 32 (others)
408 === ====================================
409
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800410As above expression, they are reciprocal number of ratio.
Yaowei Bai013110a2015-09-08 15:04:10 -0700411256 means 1/256. # of protection pages becomes about "0.39%" of total managed
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800412pages of higher zones on the node.
413
414If you would like to protect more pages, smaller values are effective.
Joonsoo Kimd3cda232018-04-10 16:30:11 -0700415The minimum value is 1 (1/1 -> 100%). The value less than 1 completely
416disables protection of the pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419max_map_count:
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300420==============
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422This file contains the maximum number of memory map areas a process
423may have. Memory map areas are used as a side-effect of calling
David Rientjesdef5efe2017-02-24 14:58:47 -0800424malloc, directly by mmap, mprotect, and madvise, and also when loading
425shared libraries.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427While most applications need less than a thousand maps, certain
428programs, particularly malloc debuggers, may consume lots of them,
429e.g., up to one or two maps per allocation.
430
431The default value is 65536.
432
Andi Kleen6a460792009-09-16 11:50:15 +0200433
434memory_failure_early_kill:
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300435==========================
Andi Kleen6a460792009-09-16 11:50:15 +0200436
437Control how to kill processes when uncorrected memory error (typically
438a 2bit error in a memory module) is detected in the background by hardware
439that cannot be handled by the kernel. In some cases (like the page
440still having a valid copy on disk) the kernel will handle the failure
441transparently without affecting any applications. But if there is
442no other uptodate copy of the data it will kill to prevent any data
443corruptions from propagating.
444
4451: Kill all processes that have the corrupted and not reloadable page mapped
446as soon as the corruption is detected. Note this is not supported
447for a few types of pages, like kernel internally allocated data or
448the swap cache, but works for the majority of user pages.
449
4500: Only unmap the corrupted page from all processes and only kill a process
451who tries to access it.
452
453The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
454handle this if they want to.
455
456This is only active on architectures/platforms with advanced machine
457check handling and depends on the hardware capabilities.
458
459Applications can override this setting individually with the PR_MCE_KILL prctl
460
Andi Kleen6a460792009-09-16 11:50:15 +0200461
462memory_failure_recovery
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300463=======================
Andi Kleen6a460792009-09-16 11:50:15 +0200464
465Enable memory failure recovery (when supported by the platform)
466
4671: Attempt recovery.
468
4690: Always panic on a memory failure.
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300472min_free_kbytes
473===============
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800475This is used to force the Linux VM to keep a minimum number
Mel Gorman41858962009-06-16 15:32:12 -0700476of kilobytes free. The VM uses this number to compute a
477watermark[WMARK_MIN] value for each lowmem zone in the system.
478Each lowmem zone gets a number of reserved free pages based
479proportionally on its size.
Rohit Seth8ad4b1f2006-01-08 01:00:40 -0800480
Matt LaPlanted9195882008-07-25 19:45:33 -0700481Some minimal amount of memory is needed to satisfy PF_MEMALLOC
Pavel Machek24950892007-10-16 23:31:28 -0700482allocations; if you set this to lower than 1024KB, your system will
483become subtly broken, and prone to deadlock under high loads.
484
485Setting this too high will OOM your machine instantly.
486
Christoph Lameter96146342006-07-03 00:24:13 -0700487
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300488min_slab_ratio
489==============
Christoph Lameter0ff38492006-09-25 23:31:52 -0700490
491This is available only on NUMA kernels.
492
493A percentage of the total pages in each zone. On Zone reclaim
494(fallback from the local zone occurs) slabs will be reclaimed if more
495than this percentage of pages in a zone are reclaimable slab pages.
496This insures that the slab growth stays under control even in NUMA
497systems that rarely perform global reclaim.
498
499The default is 5 percent.
500
501Note that slab reclaim is triggered in a per zone / node fashion.
502The process of reclaiming slab memory is currently not node specific
503and may not be fast.
504
Christoph Lameter0ff38492006-09-25 23:31:52 -0700505
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300506min_unmapped_ratio
507==================
KAMEZAWA Hiroyukifadd8fb2006-06-23 02:03:13 -0700508
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800509This is available only on NUMA kernels.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700510
Mel Gorman90afa5d2009-06-16 15:33:20 -0700511This is a percentage of the total pages in each zone. Zone reclaim will
512only occur if more than this percentage of pages are in a state that
513zone_reclaim_mode allows to be reclaimed.
514
515If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
516against all file-backed unmapped pages including swapcache pages and tmpfs
517files. Otherwise, only unmapped pages backed by normal files but not tmpfs
518files and similar are considered.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700519
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800520The default is 1 percent.
David Rientjesfe071d72007-10-16 23:25:56 -0700521
Eric Parised032182007-06-28 15:55:21 -0400522
523mmap_min_addr
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300524=============
Eric Parised032182007-06-28 15:55:21 -0400525
526This file indicates the amount of address space which a user process will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200527be restricted from mmapping. Since kernel null dereference bugs could
Eric Parised032182007-06-28 15:55:21 -0400528accidentally operate based on the information in the first couple of pages
529of memory userspace processes should not be allowed to write to them. By
530default this value is set to 0 and no protections will be enforced by the
531security module. Setting this value to something like 64k will allow the
532vast majority of applications to work correctly and provide defense in depth
533against future potential kernel bugs.
534
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700535
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300536mmap_rnd_bits
537=============
Daniel Cashmand07e2252016-01-14 15:19:53 -0800538
539This value can be used to select the number of bits to use to
540determine the random offset to the base address of vma regions
541resulting from mmap allocations on architectures which support
542tuning address space randomization. This value will be bounded
543by the architecture's minimum and maximum supported values.
544
545This value can be changed after boot using the
546/proc/sys/vm/mmap_rnd_bits tunable
547
Daniel Cashmand07e2252016-01-14 15:19:53 -0800548
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300549mmap_rnd_compat_bits
550====================
Daniel Cashmand07e2252016-01-14 15:19:53 -0800551
552This value can be used to select the number of bits to use to
553determine the random offset to the base address of vma regions
554resulting from mmap allocations for applications run in
555compatibility mode on architectures which support tuning address
556space randomization. This value will be bounded by the
557architecture's minimum and maximum supported values.
558
559This value can be changed after boot using the
560/proc/sys/vm/mmap_rnd_compat_bits tunable
561
Daniel Cashmand07e2252016-01-14 15:19:53 -0800562
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800563nr_hugepages
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300564============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800565
566Change the minimum size of the hugepage pool.
567
Mike Rapoport1ad13352018-04-18 11:07:49 +0300568See Documentation/admin-guide/mm/hugetlbpage.rst
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800569
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800570
Prashant Dhamdhered1634e12018-07-20 19:05:00 +0530571nr_hugepages_mempolicy
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300572======================
Prashant Dhamdhered1634e12018-07-20 19:05:00 +0530573
574Change the size of the hugepage pool at run-time on a specific
575set of NUMA nodes.
576
577See Documentation/admin-guide/mm/hugetlbpage.rst
578
Prashant Dhamdhered1634e12018-07-20 19:05:00 +0530579
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800580nr_overcommit_hugepages
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300581=======================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800582
583Change the maximum size of the hugepage pool. The maximum is
584nr_hugepages + nr_overcommit_hugepages.
585
Mike Rapoport1ad13352018-04-18 11:07:49 +0300586See Documentation/admin-guide/mm/hugetlbpage.rst
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800587
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800588
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800589nr_trim_pages
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300590=============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800591
592This is available only on NOMMU kernels.
593
594This value adjusts the excess page trimming behaviour of power-of-2 aligned
595NOMMU mmap allocations.
596
597A value of 0 disables trimming of allocations entirely, while a value of 1
598trims excess pages aggressively. Any value >= 1 acts as the watermark where
599trimming of allocations is initiated.
600
601The default value is 1.
602
Mauro Carvalho Chehab800c02f2020-06-23 15:31:36 +0200603See Documentation/admin-guide/mm/nommu-mmap.rst for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800604
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800605
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700606numa_zonelist_order
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300607===================
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700608
Michal Hockoc9bff3e2017-09-06 16:20:13 -0700609This sysctl is only for NUMA and it is deprecated. Anything but
610Node order will fail!
611
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700612'where the memory is allocated from' is controlled by zonelists.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300613
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700614(This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300615you may be able to read ZONE_DMA as ZONE_DMA32...)
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700616
617In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
618ZONE_NORMAL -> ZONE_DMA
619This means that a memory allocation request for GFP_KERNEL will
620get memory from ZONE_DMA only when ZONE_NORMAL is not available.
621
622In NUMA case, you can think of following 2 types of order.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300623Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL::
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700624
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300625 (A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
626 (B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700627
628Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
629will be used before ZONE_NORMAL exhaustion. This increases possibility of
630out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
631
632Type(B) cannot offer the best locality but is more robust against OOM of
633the DMA zone.
634
635Type(A) is called as "Node" order. Type (B) is "Zone" order.
636
637"Node order" orders the zonelists by node, then by zone within each node.
Paul Bolle5a3016a2011-04-06 11:09:55 +0200638Specify "[Nn]ode" for node order
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700639
640"Zone Order" orders the zonelists by zone type, then by node within each
Paul Bolle5a3016a2011-04-06 11:09:55 +0200641zone. Specify "[Zz]one" for zone order.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700642
Xishi Qiu7c88a292016-04-28 16:19:11 -0700643Specify "[Dd]efault" to request automatic configuration.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700644
Xishi Qiu7c88a292016-04-28 16:19:11 -0700645On 32-bit, the Normal zone needs to be preserved for allocations accessible
646by the kernel, so "zone" order will be selected.
647
648On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
649order will be selected.
650
651Default order is recommended unless this is causing problems for your
652system/application.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800653
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800654
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800655oom_dump_tasks
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300656==============
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800657
Kirill A. Shutemovdc6c9a32015-02-11 15:26:50 -0800658Enables a system-wide task dump (excluding kernel threads) to be produced
659when the kernel performs an OOM-killing and includes such information as
Kirill A. Shutemovaf5b0f62017-11-15 17:35:40 -0800660pid, uid, tgid, vm size, rss, pgtables_bytes, swapents, oom_score_adj
661score, and name. This is helpful to determine why the OOM killer was
662invoked, to identify the rogue task that caused it, and to determine why
663the OOM killer chose the task it did to kill.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800664
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800665If this is set to zero, this information is suppressed. On very
666large systems with thousands of tasks it may not be feasible to dump
667the memory state information for each one. Such systems should not
668be forced to incur a performance penalty in OOM conditions when the
669information may not be desired.
670
671If this is set to non-zero, this information is shown whenever the
672OOM killer actually kills a memory-hogging task.
673
David Rientjesad915c42010-08-09 17:18:53 -0700674The default value is 1 (enabled).
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800675
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800676
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800677oom_kill_allocating_task
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300678========================
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800679
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800680This enables or disables killing the OOM-triggering task in
681out-of-memory situations.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800682
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800683If this is set to zero, the OOM killer will scan through the entire
684tasklist and select a task based on heuristics to kill. This normally
685selects a rogue memory-hogging task that frees up a large amount of
686memory when killed.
687
688If this is set to non-zero, the OOM killer simply kills the task that
689triggered the out-of-memory condition. This avoids the expensive
690tasklist scan.
691
692If panic_on_oom is selected, it takes precedence over whatever value
693is used in oom_kill_allocating_task.
694
695The default value is 0.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000696
Paul Mundtdd8632a2009-01-08 12:04:47 +0000697
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300698overcommit_kbytes
699=================
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800700
701When overcommit_memory is set to 2, the committed address space is not
702permitted to exceed swap plus this amount of physical RAM. See below.
703
704Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
705of them may be specified at a time. Setting one disables the other (which
706then appears as 0 when read).
707
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800708
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300709overcommit_memory
710=================
Paul Mundtdd8632a2009-01-08 12:04:47 +0000711
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800712This value contains a flag that enables memory overcommitment.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000713
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800714When this flag is 0, the kernel attempts to estimate the amount
715of free memory left when userspace requests more memory.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000716
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800717When this flag is 1, the kernel pretends there is always enough
718memory until it actually runs out.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000719
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800720When this flag is 2, the kernel uses a "never overcommit"
721policy that attempts to prevent any overcommit of memory.
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700722Note that user_reserve_kbytes affects this policy.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000723
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800724This feature can be very useful because there are a lot of
725programs that malloc() huge amounts of memory "just-in-case"
726and don't use much of it.
727
728The default value is 0.
729
Mike Rapoportad56b732018-03-21 21:22:47 +0200730See Documentation/vm/overcommit-accounting.rst and
juviliu85f237a2018-08-21 21:53:20 -0700731mm/util.c::__vm_enough_memory() for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800732
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800733
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300734overcommit_ratio
735================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800736
737When overcommit_memory is set to 2, the committed address
738space is not permitted to exceed swap plus this percentage
739of physical RAM. See above.
740
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800741
742page-cluster
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300743============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800744
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700745page-cluster controls the number of pages up to which consecutive pages
746are read in from swap in a single attempt. This is the swap counterpart
747to page cache readahead.
748The mentioned consecutivity is not in terms of virtual/physical addresses,
749but consecutive on swap space - that means they were swapped out together.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800750
751It is a logarithmic value - setting it to zero means "1 page", setting
752it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700753Zero disables swap readahead completely.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800754
755The default value is three (eight pages at a time). There may be some
756small benefits in tuning this to a different value if your workload is
757swap-intensive.
758
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700759Lower values mean lower latencies for initial faults, but at the same time
760extra faults and I/O delays for following faults if they would have been part of
761that consecutive pages readahead would have brought in.
762
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800763
764panic_on_oom
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300765============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800766
767This enables or disables panic on out-of-memory feature.
768
769If this is set to 0, the kernel will kill some rogue process,
770called oom_killer. Usually, oom_killer can kill rogue processes and
771system will survive.
772
773If this is set to 1, the kernel panics when out-of-memory happens.
774However, if a process limits using nodes by mempolicy/cpusets,
775and those nodes become memory exhaustion status, one process
776may be killed by oom-killer. No panic occurs in this case.
777Because other nodes' memory may be free. This means system total status
778may be not fatal yet.
779
780If this is set to 2, the kernel panics compulsorily even on the
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800781above-mentioned. Even oom happens under memory cgroup, the whole
782system panics.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800783
784The default value is 0.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300785
Peter W Morrealedb0fb182009-01-15 13:50:42 -08007861 and 2 are for failover of clustering. Please select either
787according to your policy of failover.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300788
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800789panic_on_oom=2+kdump gives you very strong tool to investigate
790why oom happens. You can get snapshot.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800791
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800792
793percpu_pagelist_fraction
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300794========================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800795
796This is the fraction of pages at most (high mark pcp->high) in each zone that
797are allocated for each per cpu page list. The min value for this is 8. It
798means that we don't allow more than 1/8th of pages in each zone to be
799allocated in any single per_cpu_pagelist. This entry only changes the value
800of hot per cpu pagelists. User can specify a number like 100 to allocate
8011/100th of each zone to each per cpu page list.
802
803The batch value of each per cpu pagelist is also updated as a result. It is
804set to pcp->high/4. The upper limit of batch is (PAGE_SHIFT * 8)
805
806The initial value is zero. Kernel does not use this value at boot time to set
David Rientjes7cd2b0a2014-06-23 13:22:04 -0700807the high water marks for each per cpu page list. If the user writes '0' to this
808sysctl, it will revert to this default behavior.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800809
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800810
811stat_interval
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300812=============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800813
814The time interval between which vm statistics are updated. The default
815is 1 second.
816
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800817
Hugh Dickins52b6f462016-05-19 17:12:50 -0700818stat_refresh
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300819============
Hugh Dickins52b6f462016-05-19 17:12:50 -0700820
821Any read or write (by root only) flushes all the per-cpu vm statistics
822into their global totals, for more accurate reports when testing
823e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
824
825As a side-effect, it also checks for negative totals (elsewhere reported
826as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
827(At time of writing, a few stats are known sometimes to be found negative,
828with no ill effects: errors and warnings on these stats are suppressed.)
829
Hugh Dickins52b6f462016-05-19 17:12:50 -0700830
Kemi Wang45180852017-11-15 17:38:22 -0800831numa_stat
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300832=========
Kemi Wang45180852017-11-15 17:38:22 -0800833
834This interface allows runtime configuration of numa statistics.
835
836When page allocation performance becomes a bottleneck and you can tolerate
837some possible tool breakage and decreased numa counter precision, you can
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300838do::
839
Kemi Wang45180852017-11-15 17:38:22 -0800840 echo 0 > /proc/sys/vm/numa_stat
841
842When page allocation performance is not a bottleneck and you want all
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300843tooling to work, you can do::
844
Kemi Wang45180852017-11-15 17:38:22 -0800845 echo 1 > /proc/sys/vm/numa_stat
846
Kemi Wang45180852017-11-15 17:38:22 -0800847
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800848swappiness
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300849==========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800850
Johannes Weinerc8439662020-06-03 16:02:37 -0700851This control is used to define the rough relative IO cost of swapping
852and filesystem paging, as a value between 0 and 200. At 100, the VM
853assumes equal IO cost and will thus apply memory pressure to the page
854cache and swap-backed pages equally; lower values signify more
855expensive swap IO, higher values indicates cheaper.
856
857Keep in mind that filesystem IO patterns under memory pressure tend to
858be more efficient than swap's random IO. An optimal value will require
859experimentation and will also be workload-dependent.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800860
861The default value is 60.
862
Johannes Weinerc8439662020-06-03 16:02:37 -0700863For in-memory swap, like zram or zswap, as well as hybrid setups that
864have swap on faster devices than the filesystem, values beyond 100 can
865be considered. For example, if the random IO against the swap device
866is on average 2x faster than IO from the filesystem, swappiness should
867be 133 (x + 2x = 200, 2x = 133.33).
868
869At 0, the kernel will not initiate swap until the amount of free and
870file-backed pages is less than the high watermark in a zone.
871
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800872
Peter Xucefdca02019-05-13 17:16:41 -0700873unprivileged_userfaultfd
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300874========================
Peter Xucefdca02019-05-13 17:16:41 -0700875
Lokesh Gidrad0d47302020-12-14 19:13:54 -0800876This flag controls the mode in which unprivileged users can use the
877userfaultfd system calls. Set this to 0 to restrict unprivileged users
878to handle page faults in user mode only. In this case, users without
879SYS_CAP_PTRACE must pass UFFD_USER_MODE_ONLY in order for userfaultfd to
880succeed. Prohibiting use of userfaultfd for handling faults from kernel
881mode may make certain vulnerabilities more difficult to exploit.
Peter Xucefdca02019-05-13 17:16:41 -0700882
Lokesh Gidrad0d47302020-12-14 19:13:54 -0800883Set this to 1 to allow unprivileged users to use the userfaultfd system
884calls without any restrictions.
885
886The default value is 0.
Peter Xucefdca02019-05-13 17:16:41 -0700887
Peter Xucefdca02019-05-13 17:16:41 -0700888
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300889user_reserve_kbytes
890===================
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700891
Masanari Iida633708a2015-01-02 12:03:19 +0900892When overcommit_memory is set to 2, "never overcommit" mode, reserve
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700893min(3% of current process size, user_reserve_kbytes) of free memory.
894This is intended to prevent a user from starting a single memory hogging
895process, such that they cannot recover (kill the hog).
896
897user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
898
899If this is reduced to zero, then the user will be allowed to allocate
900all free memory with a single process, minus admin_reserve_kbytes.
901Any subsequent attempts to execute a command will result in
902"fork: Cannot allocate memory".
903
904Changing this takes effect whenever an application requests memory.
905
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700906
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800907vfs_cache_pressure
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300908==================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800909
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700910This percentage value controls the tendency of the kernel to reclaim
911the memory which is used for caching of directory and inode objects.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800912
913At the default value of vfs_cache_pressure=100 the kernel will attempt to
914reclaim dentries and inodes at a "fair" rate with respect to pagecache and
915swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
Jan Kara55c37a82009-09-21 17:01:40 -0700916to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
917never reclaim dentries and inodes due to memory pressure and this can easily
918lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800919causes the kernel to prefer to reclaim dentries and inodes.
920
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700921Increasing vfs_cache_pressure significantly beyond 100 may have negative
922performance impact. Reclaim code needs to take various locks to find freeable
923directory and inode objects. With vfs_cache_pressure=1000, it will look for
924ten times more freeable objects than there are.
925
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700926
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300927watermark_boost_factor
928======================
Mel Gorman1c308442018-12-28 00:35:52 -0800929
930This factor controls the level of reclaim when memory is being fragmented.
931It defines the percentage of the high watermark of a zone that will be
932reclaimed if pages of different mobility are being mixed within pageblocks.
933The intent is that compaction has less work to do in the future and to
934increase the success rate of future high-order allocations such as SLUB
935allocations, THP and hugetlbfs pages.
936
Mel Gorman24512228b2019-04-25 22:23:51 -0700937To make it sensible with respect to the watermark_scale_factor
938parameter, the unit is in fractions of 10,000. The default value of
93915,000 on !DISCONTIGMEM configurations means that up to 150% of the high
940watermark will be reclaimed in the event of a pageblock being mixed due
941to fragmentation. The level of reclaim is determined by the number of
942fragmentation events that occurred in the recent past. If this value is
943smaller than a pageblock then a pageblocks worth of pages will be reclaimed
944(e.g. 2MB on 64-bit x86). A boost factor of 0 will disable the feature.
Mel Gorman1c308442018-12-28 00:35:52 -0800945
Mel Gorman1c308442018-12-28 00:35:52 -0800946
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300947watermark_scale_factor
948======================
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700949
950This factor controls the aggressiveness of kswapd. It defines the
951amount of memory left in a node/system before kswapd is woken up and
952how much memory needs to be free before kswapd goes back to sleep.
953
954The unit is in fractions of 10,000. The default value of 10 means the
955distances between watermarks are 0.1% of the available memory in the
956node/system. The maximum value is 1000, or 10% of memory.
957
958A high rate of threads entering direct reclaim (allocstall) or kswapd
959going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
960that the number of free pages kswapd maintains for latency reasons is
961too small for the allocation bursts occurring in the system. This knob
962can then be used to tune kswapd aggressiveness accordingly.
963
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800964
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300965zone_reclaim_mode
966=================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800967
968Zone_reclaim_mode allows someone to set more or less aggressive approaches to
969reclaim memory when a zone runs out of memory. If it is set to zero then no
970zone reclaim occurs. Allocations will be satisfied from other zones / nodes
971in the system.
972
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300973This is value OR'ed together of
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800974
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300975= ===================================
9761 Zone reclaim on
9772 Zone reclaim writes dirty pages out
9784 Zone reclaim swaps pages
979= ===================================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800980
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700981zone_reclaim_mode is disabled by default. For file servers or workloads
982that benefit from having their data cached, zone_reclaim_mode should be
983left disabled as the caching effect is likely to be more important than
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800984data locality.
985
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700986zone_reclaim may be enabled if it's known that the workload is partitioned
987such that each partition fits within a NUMA node and that accessing remote
988memory would cause a measurable performance reduction. The page allocator
989will then reclaim easily reusable pages (those page cache pages that are
990currently not used) before allocating off node pages.
991
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800992Allowing zone reclaim to write out pages stops processes that are
993writing large amounts of data from dirtying pages on other nodes. Zone
994reclaim will write out dirty pages if a zone fills up and so effectively
995throttle the process. This may decrease the performance of a single process
996since it cannot use all of system memory to buffer the outgoing writes
997anymore but it preserve the memory on other nodes so that the performance
998of other processes running on other nodes will not be affected.
999
1000Allowing regular swap effectively restricts allocations to the local
1001node unless explicitly overridden by memory policies or cpuset
1002configurations.