blob: 5e795202111f2fb206851701bafbaaec7100d8bc [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
Mel Gorman76ab0f52010-05-24 14:32:28 -070028- compact_memory
Fam Zheng62af6962020-10-22 07:54:03 +010029- compaction_proactiveness
Eric B Munson5bbe3542015-04-15 16:13:20 -070030- compact_unevictable_allowed
Peter W Morrealedb0fb182009-01-15 13:50:42 -080031- dirty_background_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -070032- dirty_background_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080033- dirty_bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -070034- dirty_expire_centisecs
Peter W Morrealedb0fb182009-01-15 13:50:42 -080035- dirty_ratio
Yang Shifc1ca3d2018-06-19 07:59:18 +080036- dirtytime_expire_seconds
Linus Torvalds1da177e2005-04-16 15:20:36 -070037- dirty_writeback_centisecs
Peter W Morrealedb0fb182009-01-15 13:50:42 -080038- drop_caches
Mel Gorman5e771902010-05-24 14:32:31 -070039- extfrag_threshold
Fam Zheng62af6962020-10-22 07:54:03 +010040- highmem_is_dirtyable
Peter W Morrealedb0fb182009-01-15 13:50:42 -080041- hugetlb_shm_group
42- laptop_mode
43- legacy_va_layout
44- lowmem_reserve_ratio
Linus Torvalds1da177e2005-04-16 15:20:36 -070045- max_map_count
Andi Kleen6a460792009-09-16 11:50:15 +020046- memory_failure_early_kill
47- memory_failure_recovery
Linus Torvalds1da177e2005-04-16 15:20:36 -070048- min_free_kbytes
Christoph Lameter0ff38492006-09-25 23:31:52 -070049- min_slab_ratio
Peter W Morrealedb0fb182009-01-15 13:50:42 -080050- min_unmapped_ratio
51- mmap_min_addr
Daniel Cashmand07e2252016-01-14 15:19:53 -080052- mmap_rnd_bits
53- mmap_rnd_compat_bits
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -080054- nr_hugepages
Prashant Dhamdhered1634e12018-07-20 19:05:00 +053055- nr_hugepages_mempolicy
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -080056- nr_overcommit_hugepages
Peter W Morrealedb0fb182009-01-15 13:50:42 -080057- nr_trim_pages (only if CONFIG_MMU=n)
58- numa_zonelist_order
59- oom_dump_tasks
60- oom_kill_allocating_task
Jerome Marchand49f0ce52014-01-21 15:49:14 -080061- overcommit_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080062- overcommit_memory
63- overcommit_ratio
64- page-cluster
65- panic_on_oom
Mel Gorman74f44822021-06-28 19:42:24 -070066- percpu_pagelist_high_fraction
Peter W Morrealedb0fb182009-01-15 13:50:42 -080067- stat_interval
Hugh Dickins52b6f462016-05-19 17:12:50 -070068- stat_refresh
Kemi Wang45180852017-11-15 17:38:22 -080069- numa_stat
Peter W Morrealedb0fb182009-01-15 13:50:42 -080070- swappiness
Peter Xucefdca02019-05-13 17:16:41 -070071- unprivileged_userfaultfd
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -070072- user_reserve_kbytes
Peter W Morrealedb0fb182009-01-15 13:50:42 -080073- vfs_cache_pressure
Mel Gorman1c308442018-12-28 00:35:52 -080074- watermark_boost_factor
Jerome Marchande6507a02016-07-12 12:05:59 +020075- watermark_scale_factor
Peter W Morrealedb0fb182009-01-15 13:50:42 -080076- zone_reclaim_mode
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070079admin_reserve_kbytes
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -030080====================
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -070081
82The amount of free memory in the system that should be reserved for users
83with the capability cap_sys_admin.
84
85admin_reserve_kbytes defaults to min(3% of free pages, 8MB)
86
87That should provide enough for the admin to log in and kill a process,
88if necessary, under the default overcommit 'guess' mode.
89
90Systems running under overcommit 'never' should increase this to account
91for the full Virtual Memory Size of programs used to recover. Otherwise,
92root may not be able to log in to recover the system.
93
94How do you calculate a minimum useful reserve?
95
96sshd or login + bash (or some other shell) + top (or ps, kill, etc.)
97
98For overcommit 'guess', we can sum resident set sizes (RSS).
99On x86_64 this is about 8MB.
100
101For overcommit 'never', we can take the max of their virtual sizes (VSZ)
102and add the sum of their RSS.
103On x86_64 this is about 128MB.
104
105Changing this takes effect whenever an application requests memory.
106
Andrew Shewmaker4eeab4f2013-04-29 15:08:11 -0700107
Mel Gorman76ab0f52010-05-24 14:32:28 -0700108compact_memory
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300109==============
Mel Gorman76ab0f52010-05-24 14:32:28 -0700110
111Available only when CONFIG_COMPACTION is set. When 1 is written to the file,
112all zones are compacted such that free memory is available in contiguous
113blocks where possible. This can be important for example in the allocation of
114huge pages although processes will also directly compact memory as required.
115
Nitin Guptafacdaa92020-08-11 18:31:00 -0700116compaction_proactiveness
117========================
118
119This tunable takes a value in the range [0, 100] with a default value of
12020. This tunable determines how aggressively compaction is done in the
Charan Teja Reddy65d759c2021-09-02 14:59:59 -0700121background. Write of a non zero value to this tunable will immediately
122trigger the proactive compaction. Setting it to 0 disables proactive compaction.
Nitin Guptafacdaa92020-08-11 18:31:00 -0700123
124Note that compaction has a non-trivial system-wide impact as pages
125belonging to different processes are moved around, which could also lead
126to latency spikes in unsuspecting applications. The kernel employs
127various heuristics to avoid wasting CPU cycles if it detects that
128proactive compaction is not being effective.
129
130Be careful when setting it to extreme values like 100, as that may
131cause excessive background compaction activity.
Mel Gorman76ab0f52010-05-24 14:32:28 -0700132
Eric B Munson5bbe3542015-04-15 16:13:20 -0700133compact_unevictable_allowed
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300134===========================
Eric B Munson5bbe3542015-04-15 16:13:20 -0700135
136Available only when CONFIG_COMPACTION is set. When set to 1, compaction is
137allowed to examine the unevictable lru (mlocked pages) for pages to compact.
138This should be used on systems where stalls for minor page faults are an
139acceptable trade for large contiguous free memory. Set to 0 to prevent
140compaction from moving pages that are unevictable. Default value is 1.
Sebastian Andrzej Siewior6923aa02020-04-01 21:10:42 -0700141On CONFIG_PREEMPT_RT the default value is 0 in order to avoid a page fault, due
Andrew Klychkov751d5b22020-12-04 10:28:48 +0300142to compaction, which would block the task from becoming active until the fault
Sebastian Andrzej Siewior6923aa02020-04-01 21:10:42 -0700143is resolved.
Eric B Munson5bbe3542015-04-15 16:13:20 -0700144
Eric B Munson5bbe3542015-04-15 16:13:20 -0700145
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800146dirty_background_bytes
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300147======================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300149Contains the amount of dirty memory at which the background kernel
150flusher threads will start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300152Note:
153 dirty_background_bytes is the counterpart of dirty_background_ratio. Only
154 one of them may be specified at a time. When one sysctl is written it is
155 immediately taken into account to evaluate the dirty memory limits and the
156 other appears as 0 when read.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800159dirty_background_ratio
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300160======================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Zheng Liu715ea412013-11-12 15:08:30 -0800162Contains, as a percentage of total available memory that contains free pages
163and reclaimable pages, the number of pages at which the background kernel
164flusher threads will start writing out dirty data.
165
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000166The total available memory is not equal to total system memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800169dirty_bytes
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300170===========
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800172Contains the amount of dirty memory at which a process generating disk writes
173will itself start writeback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Andrea Righiabffc022010-10-27 15:33:31 -0700175Note: dirty_bytes is the counterpart of dirty_ratio. Only one of them may be
176specified at a time. When one sysctl is written it is immediately taken into
177account to evaluate the dirty memory limits and the other appears as 0 when
178read.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800179
Andrea Righi9e4a5bd2009-04-30 15:08:57 -0700180Note: the minimum value allowed for dirty_bytes is two pages (in bytes); any
181value lower than this limit will be ignored and the old configuration will be
182retained.
183
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800184
185dirty_expire_centisecs
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300186======================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800187
188This tunable is used to define when dirty data is old enough to be eligible
Artem Bityutskiy6601fac2012-07-25 18:12:01 +0300189for writeout by the kernel flusher threads. It is expressed in 100'ths
190of a second. Data which has been dirty in-memory for longer than this
191interval will be written out next time a flusher thread wakes up.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800192
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800193
194dirty_ratio
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300195===========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800196
Zheng Liu715ea412013-11-12 15:08:30 -0800197Contains, as a percentage of total available memory that contains free pages
198and reclaimable pages, the number of pages at which a process which is
199generating disk writes will itself start writing out dirty data.
200
Chris Dunlopd83e2a42015-09-18 16:10:55 +1000201The total available memory is not equal to total system memory.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800202
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800203
Yang Shifc1ca3d2018-06-19 07:59:18 +0800204dirtytime_expire_seconds
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300205========================
Yang Shifc1ca3d2018-06-19 07:59:18 +0800206
207When a lazytime inode is constantly having its pages dirtied, the inode with
208an updated timestamp will never get chance to be written out. And, if the
209only thing that has happened on the file system is a dirtytime inode caused
210by an atime update, a worker will be scheduled to make sure that inode
211eventually gets pushed out to disk. This tunable is used to define when dirty
212inode is old enough to be eligible for writeback by the kernel flusher threads.
213And, it is also used as the interval to wakeup dirtytime_writeback thread.
214
Yang Shifc1ca3d2018-06-19 07:59:18 +0800215
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800216dirty_writeback_centisecs
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300217=========================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800218
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300219The kernel flusher threads will periodically wake up and write `old` data
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800220out to disk. This tunable expresses the interval between those wakeups, in
221100'ths of a second.
222
223Setting this to zero disables periodic writeback altogether.
224
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800225
226drop_caches
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300227===========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800228
Dave Hansen5509a5d2014-04-03 14:48:19 -0700229Writing to this will cause the kernel to drop clean caches, as well as
230reclaimable slab objects like dentries and inodes. Once dropped, their
231memory becomes free.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800232
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300233To free pagecache::
234
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800235 echo 1 > /proc/sys/vm/drop_caches
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300236
237To free reclaimable slab objects (includes dentries and inodes)::
238
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800239 echo 2 > /proc/sys/vm/drop_caches
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300240
241To free slab objects and pagecache::
242
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800243 echo 3 > /proc/sys/vm/drop_caches
244
Dave Hansen5509a5d2014-04-03 14:48:19 -0700245This is a non-destructive operation and will not free any dirty objects.
246To increase the number of objects freed by this operation, the user may run
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300247`sync` prior to writing to /proc/sys/vm/drop_caches. This will minimize the
Dave Hansen5509a5d2014-04-03 14:48:19 -0700248number of dirty objects on the system and create more candidates to be
249dropped.
250
251This file is not a means to control the growth of the various kernel caches
252(inodes, dentries, pagecache, etc...) These objects are automatically
253reclaimed by the kernel when memory is needed elsewhere on the system.
254
255Use of this file can cause performance problems. Since it discards cached
256objects, it may cost a significant amount of I/O and CPU to recreate the
257dropped objects, especially if they were under heavy use. Because of this,
258use outside of a testing or debugging environment is not recommended.
259
260You may see informational messages in your kernel log when this file is
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300261used::
Dave Hansen5509a5d2014-04-03 14:48:19 -0700262
263 cat (1234): drop_caches: 3
264
265These are informational only. They do not mean that anything is wrong
Vincent Whitchurch631605c2019-01-11 17:14:10 +0100266with your system. To disable them, echo 4 (bit 2) into drop_caches.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800267
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800268
Mel Gorman5e771902010-05-24 14:32:31 -0700269extfrag_threshold
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300270=================
Mel Gorman5e771902010-05-24 14:32:31 -0700271
272This parameter affects whether the kernel will compact memory or direct
Rabin Vincenta10726b2015-07-14 07:35:11 +0200273reclaim to satisfy a high-order allocation. The extfrag/extfrag_index file in
274debugfs shows what the fragmentation index for each order is in each zone in
275the system. Values tending towards 0 imply allocations would fail due to lack
276of memory, values towards 1000 imply failures are due to fragmentation and -1
277implies that the allocation will succeed as long as watermarks are met.
Mel Gorman5e771902010-05-24 14:32:31 -0700278
279The kernel will not compact memory in a zone if the
280fragmentation index is <= extfrag_threshold. The default value is 500.
281
Mel Gorman5e771902010-05-24 14:32:31 -0700282
Michal Hockod09b6462017-07-10 15:49:38 -0700283highmem_is_dirtyable
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300284====================
Michal Hockod09b6462017-07-10 15:49:38 -0700285
286Available only for systems with CONFIG_HIGHMEM enabled (32b systems).
287
288This parameter controls whether the high memory is considered for dirty
289writers throttling. This is not the case by default which means that
290only the amount of memory directly visible/usable by the kernel can
291be dirtied. As a result, on systems with a large amount of memory and
292lowmem basically depleted writers might be throttled too early and
293streaming writes can get very slow.
294
295Changing the value to non zero would allow more memory to be dirtied
296and thus allow writers to write more data which can be flushed to the
297storage more effectively. Note this also comes with a risk of pre-mature
298OOM killer because some writers (e.g. direct block device writes) can
299only use the low memory and they can fill it up with dirty data without
300any throttling.
301
Michal Hockod09b6462017-07-10 15:49:38 -0700302
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800303hugetlb_shm_group
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300304=================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800305
306hugetlb_shm_group contains group id that is allowed to create SysV
307shared memory segment using hugetlb page.
308
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800309
310laptop_mode
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300311===========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800312
313laptop_mode is a knob that controls "laptop mode". All the things that are
Mauro Carvalho Chehab9e1cbed2019-06-13 15:07:43 -0300314controlled by this knob are discussed in Documentation/admin-guide/laptops/laptop-mode.rst.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800315
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800316
317legacy_va_layout
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300318================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800319
Kulikov Vasiliy2174efb2010-06-28 13:59:28 +0200320If non-zero, this sysctl disables the new 32-bit mmap layout - the kernel
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800321will use the legacy (2.4) layout for all processes.
322
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800323
324lowmem_reserve_ratio
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300325====================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800326
327For some specialised workloads on highmem machines it is dangerous for
328the kernel to allow process memory to be allocated from the "lowmem"
329zone. This is because that memory could then be pinned via the mlock()
330system call, or by unavailability of swapspace.
331
332And on large highmem machines this lack of reclaimable lowmem memory
333can be fatal.
334
335So the Linux page allocator has a mechanism which prevents allocations
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300336which *could* use highmem from using too much lowmem. This means that
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800337a certain amount of lowmem is defended from the possibility of being
338captured into pinned user memory.
339
340(The same argument applies to the old 16 megabyte ISA DMA region. This
341mechanism will also defend that region from allocations which could use
342highmem or lowmem).
343
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300344The `lowmem_reserve_ratio` tunable determines how aggressive the kernel is
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800345in defending these lower zones.
346
347If you have a machine which uses highmem or ISA DMA and your
348applications are using mlock(), or if you are running with no swap then
349you probably should change the lowmem_reserve_ratio setting.
350
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300351The lowmem_reserve_ratio is an array. You can see them by reading this file::
352
353 % cat /proc/sys/vm/lowmem_reserve_ratio
354 256 256 32
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800355
356But, these values are not used directly. The kernel calculates # of protection
357pages for each zones from them. These are shown as array of protection pages
358in /proc/zoneinfo like followings. (This is an example of x86-64 box).
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300359Each zone has an array of protection pages like this::
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800360
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300361 Node 0, zone DMA
362 pages free 1355
363 min 3
364 low 3
365 high 4
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800366 :
367 :
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300368 numa_other 0
369 protection: (0, 2004, 2004, 2004)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800370 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300371 pagesets
372 cpu: 0 pcp: 0
373 :
374
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800375These protections are added to score to judge whether this zone should be used
376for page allocation or should be reclaimed.
377
378In this example, if normal pages (index=2) are required to this DMA zone and
Mel Gorman41858962009-06-16 15:32:12 -0700379watermark[WMARK_HIGH] is used for watermark, the kernel judges this zone should
380not be used because pages_free(1355) is smaller than watermark + protection[2]
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800381(4 + 2004 = 2008). If this protection value is 0, this zone would be used for
382normal page requirement. If requirement is DMA zone(index=0), protection[0]
383(=0) is used.
384
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300385zone[i]'s protection[j] is calculated by following expression::
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800386
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300387 (i < j):
388 zone[i]->protection[j]
389 = (total sums of managed_pages from zone[i+1] to zone[j] on the node)
390 / lowmem_reserve_ratio[i];
391 (i = j):
392 (should not be protected. = 0;
393 (i > j):
394 (not necessary, but looks 0)
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800395
396The default values of lowmem_reserve_ratio[i] are
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300397
398 === ====================================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800399 256 (if zone[i] means DMA or DMA32 zone)
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300400 32 (others)
401 === ====================================
402
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800403As above expression, they are reciprocal number of ratio.
Yaowei Bai013110a2015-09-08 15:04:10 -0700404256 means 1/256. # of protection pages becomes about "0.39%" of total managed
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800405pages of higher zones on the node.
406
407If you would like to protect more pages, smaller values are effective.
Joonsoo Kimd3cda232018-04-10 16:30:11 -0700408The minimum value is 1 (1/1 -> 100%). The value less than 1 completely
409disables protection of the pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412max_map_count:
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300413==============
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415This file contains the maximum number of memory map areas a process
416may have. Memory map areas are used as a side-effect of calling
David Rientjesdef5efe2017-02-24 14:58:47 -0800417malloc, directly by mmap, mprotect, and madvise, and also when loading
418shared libraries.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
420While most applications need less than a thousand maps, certain
421programs, particularly malloc debuggers, may consume lots of them,
422e.g., up to one or two maps per allocation.
423
Fengfei Xic635b0c2020-12-10 16:21:34 +0800424The default value is 65530.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Andi Kleen6a460792009-09-16 11:50:15 +0200426
427memory_failure_early_kill:
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300428==========================
Andi Kleen6a460792009-09-16 11:50:15 +0200429
430Control how to kill processes when uncorrected memory error (typically
431a 2bit error in a memory module) is detected in the background by hardware
432that cannot be handled by the kernel. In some cases (like the page
433still having a valid copy on disk) the kernel will handle the failure
434transparently without affecting any applications. But if there is
435no other uptodate copy of the data it will kill to prevent any data
436corruptions from propagating.
437
4381: Kill all processes that have the corrupted and not reloadable page mapped
439as soon as the corruption is detected. Note this is not supported
440for a few types of pages, like kernel internally allocated data or
441the swap cache, but works for the majority of user pages.
442
4430: Only unmap the corrupted page from all processes and only kill a process
444who tries to access it.
445
446The kill is done using a catchable SIGBUS with BUS_MCEERR_AO, so processes can
447handle this if they want to.
448
449This is only active on architectures/platforms with advanced machine
450check handling and depends on the hardware capabilities.
451
452Applications can override this setting individually with the PR_MCE_KILL prctl
453
Andi Kleen6a460792009-09-16 11:50:15 +0200454
455memory_failure_recovery
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300456=======================
Andi Kleen6a460792009-09-16 11:50:15 +0200457
458Enable memory failure recovery (when supported by the platform)
459
4601: Attempt recovery.
461
4620: Always panic on a memory failure.
463
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300465min_free_kbytes
466===============
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800468This is used to force the Linux VM to keep a minimum number
Mel Gorman41858962009-06-16 15:32:12 -0700469of kilobytes free. The VM uses this number to compute a
470watermark[WMARK_MIN] value for each lowmem zone in the system.
471Each lowmem zone gets a number of reserved free pages based
472proportionally on its size.
Rohit Seth8ad4b1f2006-01-08 01:00:40 -0800473
Matt LaPlanted9195882008-07-25 19:45:33 -0700474Some minimal amount of memory is needed to satisfy PF_MEMALLOC
Pavel Machek24950892007-10-16 23:31:28 -0700475allocations; if you set this to lower than 1024KB, your system will
476become subtly broken, and prone to deadlock under high loads.
477
478Setting this too high will OOM your machine instantly.
479
Christoph Lameter96146342006-07-03 00:24:13 -0700480
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300481min_slab_ratio
482==============
Christoph Lameter0ff38492006-09-25 23:31:52 -0700483
484This is available only on NUMA kernels.
485
486A percentage of the total pages in each zone. On Zone reclaim
487(fallback from the local zone occurs) slabs will be reclaimed if more
488than this percentage of pages in a zone are reclaimable slab pages.
489This insures that the slab growth stays under control even in NUMA
490systems that rarely perform global reclaim.
491
492The default is 5 percent.
493
494Note that slab reclaim is triggered in a per zone / node fashion.
495The process of reclaiming slab memory is currently not node specific
496and may not be fast.
497
Christoph Lameter0ff38492006-09-25 23:31:52 -0700498
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300499min_unmapped_ratio
500==================
KAMEZAWA Hiroyukifadd8fb2006-06-23 02:03:13 -0700501
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800502This is available only on NUMA kernels.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700503
Mel Gorman90afa5d2009-06-16 15:33:20 -0700504This is a percentage of the total pages in each zone. Zone reclaim will
505only occur if more than this percentage of pages are in a state that
506zone_reclaim_mode allows to be reclaimed.
507
508If zone_reclaim_mode has the value 4 OR'd, then the percentage is compared
509against all file-backed unmapped pages including swapcache pages and tmpfs
510files. Otherwise, only unmapped pages backed by normal files but not tmpfs
511files and similar are considered.
Yasunori Goto2b744c02007-05-06 14:49:59 -0700512
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800513The default is 1 percent.
David Rientjesfe071d72007-10-16 23:25:56 -0700514
Eric Parised032182007-06-28 15:55:21 -0400515
516mmap_min_addr
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300517=============
Eric Parised032182007-06-28 15:55:21 -0400518
519This file indicates the amount of address space which a user process will
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200520be restricted from mmapping. Since kernel null dereference bugs could
Eric Parised032182007-06-28 15:55:21 -0400521accidentally operate based on the information in the first couple of pages
522of memory userspace processes should not be allowed to write to them. By
523default this value is set to 0 and no protections will be enforced by the
524security module. Setting this value to something like 64k will allow the
525vast majority of applications to work correctly and provide defense in depth
526against future potential kernel bugs.
527
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700528
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300529mmap_rnd_bits
530=============
Daniel Cashmand07e2252016-01-14 15:19:53 -0800531
532This value can be used to select the number of bits to use to
533determine the random offset to the base address of vma regions
534resulting from mmap allocations on architectures which support
535tuning address space randomization. This value will be bounded
536by the architecture's minimum and maximum supported values.
537
538This value can be changed after boot using the
539/proc/sys/vm/mmap_rnd_bits tunable
540
Daniel Cashmand07e2252016-01-14 15:19:53 -0800541
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300542mmap_rnd_compat_bits
543====================
Daniel Cashmand07e2252016-01-14 15:19:53 -0800544
545This value can be used to select the number of bits to use to
546determine the random offset to the base address of vma regions
547resulting from mmap allocations for applications run in
548compatibility mode on architectures which support tuning address
549space randomization. This value will be bounded by the
550architecture's minimum and maximum supported values.
551
552This value can be changed after boot using the
553/proc/sys/vm/mmap_rnd_compat_bits tunable
554
Daniel Cashmand07e2252016-01-14 15:19:53 -0800555
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800556nr_hugepages
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300557============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800558
559Change the minimum size of the hugepage pool.
560
Mike Rapoport1ad13352018-04-18 11:07:49 +0300561See Documentation/admin-guide/mm/hugetlbpage.rst
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800562
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800563
Prashant Dhamdhered1634e12018-07-20 19:05:00 +0530564nr_hugepages_mempolicy
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300565======================
Prashant Dhamdhered1634e12018-07-20 19:05:00 +0530566
567Change the size of the hugepage pool at run-time on a specific
568set of NUMA nodes.
569
570See Documentation/admin-guide/mm/hugetlbpage.rst
571
Prashant Dhamdhered1634e12018-07-20 19:05:00 +0530572
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800573nr_overcommit_hugepages
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300574=======================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800575
576Change the maximum size of the hugepage pool. The maximum is
577nr_hugepages + nr_overcommit_hugepages.
578
Mike Rapoport1ad13352018-04-18 11:07:49 +0300579See Documentation/admin-guide/mm/hugetlbpage.rst
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800580
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800581
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800582nr_trim_pages
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300583=============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800584
585This is available only on NOMMU kernels.
586
587This value adjusts the excess page trimming behaviour of power-of-2 aligned
588NOMMU mmap allocations.
589
590A value of 0 disables trimming of allocations entirely, while a value of 1
591trims excess pages aggressively. Any value >= 1 acts as the watermark where
592trimming of allocations is initiated.
593
594The default value is 1.
595
Mauro Carvalho Chehab800c02f2020-06-23 15:31:36 +0200596See Documentation/admin-guide/mm/nommu-mmap.rst for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800597
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800598
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700599numa_zonelist_order
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300600===================
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700601
Michal Hockoc9bff3e2017-09-06 16:20:13 -0700602This sysctl is only for NUMA and it is deprecated. Anything but
603Node order will fail!
604
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700605'where the memory is allocated from' is controlled by zonelists.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300606
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700607(This documentation ignores ZONE_HIGHMEM/ZONE_DMA32 for simple explanation.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300608you may be able to read ZONE_DMA as ZONE_DMA32...)
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700609
610In non-NUMA case, a zonelist for GFP_KERNEL is ordered as following.
611ZONE_NORMAL -> ZONE_DMA
612This means that a memory allocation request for GFP_KERNEL will
613get memory from ZONE_DMA only when ZONE_NORMAL is not available.
614
615In NUMA case, you can think of following 2 types of order.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300616Assume 2 node NUMA and below is zonelist of Node(0)'s GFP_KERNEL::
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700617
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300618 (A) Node(0) ZONE_NORMAL -> Node(0) ZONE_DMA -> Node(1) ZONE_NORMAL
619 (B) Node(0) ZONE_NORMAL -> Node(1) ZONE_NORMAL -> Node(0) ZONE_DMA.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700620
621Type(A) offers the best locality for processes on Node(0), but ZONE_DMA
622will be used before ZONE_NORMAL exhaustion. This increases possibility of
623out-of-memory(OOM) of ZONE_DMA because ZONE_DMA is tend to be small.
624
625Type(B) cannot offer the best locality but is more robust against OOM of
626the DMA zone.
627
628Type(A) is called as "Node" order. Type (B) is "Zone" order.
629
630"Node order" orders the zonelists by node, then by zone within each node.
Paul Bolle5a3016a2011-04-06 11:09:55 +0200631Specify "[Nn]ode" for node order
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700632
633"Zone Order" orders the zonelists by zone type, then by node within each
Paul Bolle5a3016a2011-04-06 11:09:55 +0200634zone. Specify "[Zz]one" for zone order.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700635
Xishi Qiu7c88a292016-04-28 16:19:11 -0700636Specify "[Dd]efault" to request automatic configuration.
KAMEZAWA Hiroyukif0c0b2b2007-07-15 23:38:01 -0700637
Xishi Qiu7c88a292016-04-28 16:19:11 -0700638On 32-bit, the Normal zone needs to be preserved for allocations accessible
639by the kernel, so "zone" order will be selected.
640
641On 64-bit, devices that require DMA32/DMA are relatively rare, so "node"
642order will be selected.
643
644Default order is recommended unless this is causing problems for your
645system/application.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800646
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800647
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800648oom_dump_tasks
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300649==============
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800650
Kirill A. Shutemovdc6c9a32015-02-11 15:26:50 -0800651Enables a system-wide task dump (excluding kernel threads) to be produced
652when the kernel performs an OOM-killing and includes such information as
Kirill A. Shutemovaf5b0f62017-11-15 17:35:40 -0800653pid, uid, tgid, vm size, rss, pgtables_bytes, swapents, oom_score_adj
654score, and name. This is helpful to determine why the OOM killer was
655invoked, to identify the rogue task that caused it, and to determine why
656the OOM killer chose the task it did to kill.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800657
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800658If this is set to zero, this information is suppressed. On very
659large systems with thousands of tasks it may not be feasible to dump
660the memory state information for each one. Such systems should not
661be forced to incur a performance penalty in OOM conditions when the
662information may not be desired.
663
664If this is set to non-zero, this information is shown whenever the
665OOM killer actually kills a memory-hogging task.
666
David Rientjesad915c42010-08-09 17:18:53 -0700667The default value is 1 (enabled).
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800668
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800669
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800670oom_kill_allocating_task
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300671========================
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800672
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800673This enables or disables killing the OOM-triggering task in
674out-of-memory situations.
Nishanth Aravamudand5dbac82007-12-17 16:20:25 -0800675
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800676If this is set to zero, the OOM killer will scan through the entire
677tasklist and select a task based on heuristics to kill. This normally
678selects a rogue memory-hogging task that frees up a large amount of
679memory when killed.
680
681If this is set to non-zero, the OOM killer simply kills the task that
682triggered the out-of-memory condition. This avoids the expensive
683tasklist scan.
684
685If panic_on_oom is selected, it takes precedence over whatever value
686is used in oom_kill_allocating_task.
687
688The default value is 0.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000689
Paul Mundtdd8632a2009-01-08 12:04:47 +0000690
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300691overcommit_kbytes
692=================
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800693
694When overcommit_memory is set to 2, the committed address space is not
695permitted to exceed swap plus this amount of physical RAM. See below.
696
697Note: overcommit_kbytes is the counterpart of overcommit_ratio. Only one
698of them may be specified at a time. Setting one disables the other (which
699then appears as 0 when read).
700
Jerome Marchand49f0ce52014-01-21 15:49:14 -0800701
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300702overcommit_memory
703=================
Paul Mundtdd8632a2009-01-08 12:04:47 +0000704
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800705This value contains a flag that enables memory overcommitment.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000706
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800707When this flag is 0, the kernel attempts to estimate the amount
708of free memory left when userspace requests more memory.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000709
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800710When this flag is 1, the kernel pretends there is always enough
711memory until it actually runs out.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000712
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800713When this flag is 2, the kernel uses a "never overcommit"
714policy that attempts to prevent any overcommit of memory.
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700715Note that user_reserve_kbytes affects this policy.
Paul Mundtdd8632a2009-01-08 12:04:47 +0000716
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800717This feature can be very useful because there are a lot of
718programs that malloc() huge amounts of memory "just-in-case"
719and don't use much of it.
720
721The default value is 0.
722
Mike Rapoportad56b732018-03-21 21:22:47 +0200723See Documentation/vm/overcommit-accounting.rst and
juviliu85f237a2018-08-21 21:53:20 -0700724mm/util.c::__vm_enough_memory() for more information.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800725
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800726
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300727overcommit_ratio
728================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800729
730When overcommit_memory is set to 2, the committed address
731space is not permitted to exceed swap plus this percentage
732of physical RAM. See above.
733
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800734
735page-cluster
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300736============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800737
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700738page-cluster controls the number of pages up to which consecutive pages
739are read in from swap in a single attempt. This is the swap counterpart
740to page cache readahead.
741The mentioned consecutivity is not in terms of virtual/physical addresses,
742but consecutive on swap space - that means they were swapped out together.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800743
744It is a logarithmic value - setting it to zero means "1 page", setting
745it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700746Zero disables swap readahead completely.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800747
748The default value is three (eight pages at a time). There may be some
749small benefits in tuning this to a different value if your workload is
750swap-intensive.
751
Christian Ehrhardtdf858fa2012-07-31 16:41:46 -0700752Lower values mean lower latencies for initial faults, but at the same time
753extra faults and I/O delays for following faults if they would have been part of
754that consecutive pages readahead would have brought in.
755
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800756
757panic_on_oom
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300758============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800759
760This enables or disables panic on out-of-memory feature.
761
762If this is set to 0, the kernel will kill some rogue process,
763called oom_killer. Usually, oom_killer can kill rogue processes and
764system will survive.
765
766If this is set to 1, the kernel panics when out-of-memory happens.
767However, if a process limits using nodes by mempolicy/cpusets,
768and those nodes become memory exhaustion status, one process
769may be killed by oom-killer. No panic occurs in this case.
770Because other nodes' memory may be free. This means system total status
771may be not fatal yet.
772
773If this is set to 2, the kernel panics compulsorily even on the
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800774above-mentioned. Even oom happens under memory cgroup, the whole
775system panics.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800776
777The default value is 0.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300778
Peter W Morrealedb0fb182009-01-15 13:50:42 -08007791 and 2 are for failover of clustering. Please select either
780according to your policy of failover.
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300781
KAMEZAWA Hiroyukidaaf1e62010-03-10 15:22:32 -0800782panic_on_oom=2+kdump gives you very strong tool to investigate
783why oom happens. You can get snapshot.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800784
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800785
Mel Gorman74f44822021-06-28 19:42:24 -0700786percpu_pagelist_high_fraction
787=============================
788
789This is the fraction of pages in each zone that are can be stored to
790per-cpu page lists. It is an upper boundary that is divided depending
791on the number of online CPUs. The min value for this is 8 which means
792that we do not allow more than 1/8th of pages in each zone to be stored
793on per-cpu page lists. This entry only changes the value of hot per-cpu
794page lists. A user can specify a number like 100 to allocate 1/100th of
795each zone between per-cpu lists.
796
797The batch value of each per-cpu page list remains the same regardless of
798the value of the high fraction so allocation latencies are unaffected.
799
800The initial value is zero. Kernel uses this value to set the high pcp->high
801mark based on the low watermark for the zone and the number of local
802online CPUs. If the user writes '0' to this sysctl, it will revert to
803this default behavior.
804
805
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800806stat_interval
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300807=============
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800808
809The time interval between which vm statistics are updated. The default
810is 1 second.
811
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800812
Hugh Dickins52b6f462016-05-19 17:12:50 -0700813stat_refresh
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300814============
Hugh Dickins52b6f462016-05-19 17:12:50 -0700815
816Any read or write (by root only) flushes all the per-cpu vm statistics
817into their global totals, for more accurate reports when testing
818e.g. cat /proc/sys/vm/stat_refresh /proc/meminfo
819
820As a side-effect, it also checks for negative totals (elsewhere reported
821as 0) and "fails" with EINVAL if any are found, with a warning in dmesg.
822(At time of writing, a few stats are known sometimes to be found negative,
823with no ill effects: errors and warnings on these stats are suppressed.)
824
Hugh Dickins52b6f462016-05-19 17:12:50 -0700825
Kemi Wang45180852017-11-15 17:38:22 -0800826numa_stat
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300827=========
Kemi Wang45180852017-11-15 17:38:22 -0800828
829This interface allows runtime configuration of numa statistics.
830
831When page allocation performance becomes a bottleneck and you can tolerate
832some possible tool breakage and decreased numa counter precision, you can
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300833do::
834
Kemi Wang45180852017-11-15 17:38:22 -0800835 echo 0 > /proc/sys/vm/numa_stat
836
837When page allocation performance is not a bottleneck and you want all
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300838tooling to work, you can do::
839
Kemi Wang45180852017-11-15 17:38:22 -0800840 echo 1 > /proc/sys/vm/numa_stat
841
Kemi Wang45180852017-11-15 17:38:22 -0800842
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800843swappiness
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300844==========
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800845
Johannes Weinerc8439662020-06-03 16:02:37 -0700846This control is used to define the rough relative IO cost of swapping
847and filesystem paging, as a value between 0 and 200. At 100, the VM
848assumes equal IO cost and will thus apply memory pressure to the page
849cache and swap-backed pages equally; lower values signify more
850expensive swap IO, higher values indicates cheaper.
851
852Keep in mind that filesystem IO patterns under memory pressure tend to
853be more efficient than swap's random IO. An optimal value will require
854experimentation and will also be workload-dependent.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800855
856The default value is 60.
857
Johannes Weinerc8439662020-06-03 16:02:37 -0700858For in-memory swap, like zram or zswap, as well as hybrid setups that
859have swap on faster devices than the filesystem, values beyond 100 can
860be considered. For example, if the random IO against the swap device
861is on average 2x faster than IO from the filesystem, swappiness should
862be 133 (x + 2x = 200, 2x = 133.33).
863
864At 0, the kernel will not initiate swap until the amount of free and
865file-backed pages is less than the high watermark in a zone.
866
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800867
Peter Xucefdca02019-05-13 17:16:41 -0700868unprivileged_userfaultfd
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300869========================
Peter Xucefdca02019-05-13 17:16:41 -0700870
Lokesh Gidrad0d47302020-12-14 19:13:54 -0800871This flag controls the mode in which unprivileged users can use the
872userfaultfd system calls. Set this to 0 to restrict unprivileged users
873to handle page faults in user mode only. In this case, users without
874SYS_CAP_PTRACE must pass UFFD_USER_MODE_ONLY in order for userfaultfd to
875succeed. Prohibiting use of userfaultfd for handling faults from kernel
876mode may make certain vulnerabilities more difficult to exploit.
Peter Xucefdca02019-05-13 17:16:41 -0700877
Lokesh Gidrad0d47302020-12-14 19:13:54 -0800878Set this to 1 to allow unprivileged users to use the userfaultfd system
879calls without any restrictions.
880
881The default value is 0.
Peter Xucefdca02019-05-13 17:16:41 -0700882
Peter Xucefdca02019-05-13 17:16:41 -0700883
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300884user_reserve_kbytes
885===================
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700886
Masanari Iida633708a2015-01-02 12:03:19 +0900887When overcommit_memory is set to 2, "never overcommit" mode, reserve
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700888min(3% of current process size, user_reserve_kbytes) of free memory.
889This is intended to prevent a user from starting a single memory hogging
890process, such that they cannot recover (kill the hog).
891
892user_reserve_kbytes defaults to min(3% of the current process size, 128MB).
893
894If this is reduced to zero, then the user will be allowed to allocate
895all free memory with a single process, minus admin_reserve_kbytes.
896Any subsequent attempts to execute a command will result in
897"fork: Cannot allocate memory".
898
899Changing this takes effect whenever an application requests memory.
900
Andrew Shewmakerc9b1d092013-04-29 15:08:10 -0700901
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800902vfs_cache_pressure
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300903==================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800904
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700905This percentage value controls the tendency of the kernel to reclaim
906the memory which is used for caching of directory and inode objects.
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800907
908At the default value of vfs_cache_pressure=100 the kernel will attempt to
909reclaim dentries and inodes at a "fair" rate with respect to pagecache and
910swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
Jan Kara55c37a82009-09-21 17:01:40 -0700911to retain dentry and inode caches. When vfs_cache_pressure=0, the kernel will
912never reclaim dentries and inodes due to memory pressure and this can easily
913lead to out-of-memory conditions. Increasing vfs_cache_pressure beyond 100
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800914causes the kernel to prefer to reclaim dentries and inodes.
915
Denys Vlasenko4a0da712014-06-04 16:11:03 -0700916Increasing vfs_cache_pressure significantly beyond 100 may have negative
917performance impact. Reclaim code needs to take various locks to find freeable
918directory and inode objects. With vfs_cache_pressure=1000, it will look for
919ten times more freeable objects than there are.
920
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700921
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300922watermark_boost_factor
923======================
Mel Gorman1c308442018-12-28 00:35:52 -0800924
925This factor controls the level of reclaim when memory is being fragmented.
926It defines the percentage of the high watermark of a zone that will be
927reclaimed if pages of different mobility are being mixed within pageblocks.
928The intent is that compaction has less work to do in the future and to
929increase the success rate of future high-order allocations such as SLUB
930allocations, THP and hugetlbfs pages.
931
Mel Gorman24512228b2019-04-25 22:23:51 -0700932To make it sensible with respect to the watermark_scale_factor
933parameter, the unit is in fractions of 10,000. The default value of
Mike Rapoport48d9f332021-06-28 19:42:58 -070093415,000 means that up to 150% of the high watermark will be reclaimed in the
935event of a pageblock being mixed due to fragmentation. The level of reclaim
936is determined by the number of fragmentation events that occurred in the
937recent past. If this value is smaller than a pageblock then a pageblocks
938worth of pages will be reclaimed (e.g. 2MB on 64-bit x86). A boost factor
939of 0 will disable the feature.
Mel Gorman1c308442018-12-28 00:35:52 -0800940
Mel Gorman1c308442018-12-28 00:35:52 -0800941
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300942watermark_scale_factor
943======================
Johannes Weiner795ae7a2016-03-17 14:19:14 -0700944
945This factor controls the aggressiveness of kswapd. It defines the
946amount of memory left in a node/system before kswapd is woken up and
947how much memory needs to be free before kswapd goes back to sleep.
948
949The unit is in fractions of 10,000. The default value of 10 means the
950distances between watermarks are 0.1% of the available memory in the
951node/system. The maximum value is 1000, or 10% of memory.
952
953A high rate of threads entering direct reclaim (allocstall) or kswapd
954going to sleep prematurely (kswapd_low_wmark_hit_quickly) can indicate
955that the number of free pages kswapd maintains for latency reasons is
956too small for the allocation bursts occurring in the system. This knob
957can then be used to tune kswapd aggressiveness accordingly.
958
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800959
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300960zone_reclaim_mode
961=================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800962
963Zone_reclaim_mode allows someone to set more or less aggressive approaches to
964reclaim memory when a zone runs out of memory. If it is set to zero then no
965zone reclaim occurs. Allocations will be satisfied from other zones / nodes
966in the system.
967
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300968This is value OR'ed together of
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800969
Mauro Carvalho Chehab53b95372019-04-18 18:35:54 -0300970= ===================================
9711 Zone reclaim on
9722 Zone reclaim writes dirty pages out
9734 Zone reclaim swaps pages
974= ===================================
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800975
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700976zone_reclaim_mode is disabled by default. For file servers or workloads
977that benefit from having their data cached, zone_reclaim_mode should be
978left disabled as the caching effect is likely to be more important than
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800979data locality.
980
Dave Hansen51998362021-02-24 12:09:15 -0800981Consider enabling one or more zone_reclaim mode bits if it's known that the
982workload is partitioned such that each partition fits within a NUMA node
983and that accessing remote memory would cause a measurable performance
984reduction. The page allocator will take additional actions before
985allocating off node pages.
Mel Gorman4f9b16a2014-06-04 16:07:14 -0700986
Peter W Morrealedb0fb182009-01-15 13:50:42 -0800987Allowing zone reclaim to write out pages stops processes that are
988writing large amounts of data from dirtying pages on other nodes. Zone
989reclaim will write out dirty pages if a zone fills up and so effectively
990throttle the process. This may decrease the performance of a single process
991since it cannot use all of system memory to buffer the outgoing writes
992anymore but it preserve the memory on other nodes so that the performance
993of other processes running on other nodes will not be affected.
994
995Allowing regular swap effectively restricts allocations to the local
996node unless explicitly overridden by memory policies or cpuset
997configurations.