blob: 17d0861b0f1de42676747ca2da344b75ca210c9c [file] [log] [blame]
Mike Rapoporta5e4da92018-03-21 21:22:42 +02001.. _unevictable_lru:
Lee Schermerhornfa07e782008-10-18 20:26:47 -07002
Mike Rapoporta5e4da92018-03-21 21:22:42 +02003==============================
4Unevictable LRU Infrastructure
5==============================
Lee Schermerhornfa07e782008-10-18 20:26:47 -07006
Mike Rapoporta5e4da92018-03-21 21:22:42 +02007.. contents:: :local:
David Howellsc24b7202009-04-13 14:40:01 -07008
9
Mike Rapoporta5e4da92018-03-21 21:22:42 +020010Introduction
David Howellsc24b7202009-04-13 14:40:01 -070011============
12
13This document describes the Linux memory manager's "Unevictable LRU"
14infrastructure and the use of this to manage several types of "unevictable"
15pages.
16
17The document attempts to provide the overall rationale behind this mechanism
18and the rationale for some of the design decisions that drove the
19implementation. The latter design rationale is discussed in the context of an
20implementation description. Admittedly, one can obtain the implementation
21details - the "what does it do?" - by reading the code. One hopes that the
22descriptions below add value by provide the answer to "why does it do that?".
23
24
Mike Rapoporta5e4da92018-03-21 21:22:42 +020025
26The Unevictable LRU
David Howellsc24b7202009-04-13 14:40:01 -070027===================
28
29The Unevictable LRU facility adds an additional LRU list to track unevictable
30pages and to hide these pages from vmscan. This mechanism is based on a patch
31by Larry Woodman of Red Hat to address several scalability problems with page
Lee Schermerhornfa07e782008-10-18 20:26:47 -070032reclaim in Linux. The problems have been observed at customer sites on large
David Howellsc24b7202009-04-13 14:40:01 -070033memory x86_64 systems.
Lee Schermerhornfa07e782008-10-18 20:26:47 -070034
David Howellsc24b7202009-04-13 14:40:01 -070035To illustrate this with an example, a non-NUMA x86_64 platform with 128GB of
36main memory will have over 32 million 4k pages in a single zone. When a large
37fraction of these pages are not evictable for any reason [see below], vmscan
38will spend a lot of time scanning the LRU lists looking for the small fraction
39of pages that are evictable. This can result in a situation where all CPUs are
40spending 100% of their time in vmscan for hours or days on end, with the system
41completely unresponsive.
Lee Schermerhornfa07e782008-10-18 20:26:47 -070042
David Howellsc24b7202009-04-13 14:40:01 -070043The unevictable list addresses the following classes of unevictable pages:
Lee Schermerhornfa07e782008-10-18 20:26:47 -070044
Mike Rapoporta5e4da92018-03-21 21:22:42 +020045 * Those owned by ramfs.
David Howellsc24b7202009-04-13 14:40:01 -070046
Mike Rapoporta5e4da92018-03-21 21:22:42 +020047 * Those mapped into SHM_LOCK'd shared memory regions.
David Howellsc24b7202009-04-13 14:40:01 -070048
Mike Rapoporta5e4da92018-03-21 21:22:42 +020049 * Those mapped into VM_LOCKED [mlock()ed] VMAs.
David Howellsc24b7202009-04-13 14:40:01 -070050
51The infrastructure may also be able to handle other conditions that make pages
Lee Schermerhornfa07e782008-10-18 20:26:47 -070052unevictable, either by definition or by circumstance, in the future.
53
54
Mike Rapoporta5e4da92018-03-21 21:22:42 +020055The Unevictable Page List
David Howellsc24b7202009-04-13 14:40:01 -070056-------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -070057
58The Unevictable LRU infrastructure consists of an additional, per-zone, LRU list
59called the "unevictable" list and an associated page flag, PG_unevictable, to
David Howellsc24b7202009-04-13 14:40:01 -070060indicate that the page is being managed on the unevictable list.
61
62The PG_unevictable flag is analogous to, and mutually exclusive with, the
63PG_active flag in that it indicates on which LRU list a page resides when
Michal Hockoe6e8dd52011-03-16 15:01:37 +010064PG_lru is set.
Lee Schermerhornfa07e782008-10-18 20:26:47 -070065
66The Unevictable LRU infrastructure maintains unevictable pages on an additional
67LRU list for a few reasons:
68
David Howellsc24b7202009-04-13 14:40:01 -070069 (1) We get to "treat unevictable pages just like we treat other pages in the
70 system - which means we get to use the same code to manipulate them, the
71 same code to isolate them (for migrate, etc.), the same code to keep track
72 of the statistics, etc..." [Rik van Riel]
Lee Schermerhornfa07e782008-10-18 20:26:47 -070073
David Howellsc24b7202009-04-13 14:40:01 -070074 (2) We want to be able to migrate unevictable pages between nodes for memory
75 defragmentation, workload management and memory hotplug. The linux kernel
76 can only migrate pages that it can successfully isolate from the LRU
77 lists. If we were to maintain pages elsewhere than on an LRU-like list,
78 where they can be found by isolate_lru_page(), we would prevent their
79 migration, unless we reworked migration code to find the unevictable pages
80 itself.
Lee Schermerhornfa07e782008-10-18 20:26:47 -070081
82
David Howellsc24b7202009-04-13 14:40:01 -070083The unevictable list does not differentiate between file-backed and anonymous,
84swap-backed pages. This differentiation is only important while the pages are,
85in fact, evictable.
Lee Schermerhornfa07e782008-10-18 20:26:47 -070086
David Howellsc24b7202009-04-13 14:40:01 -070087The unevictable list benefits from the "arrayification" of the per-zone LRU
88lists and statistics originally proposed and posted by Christoph Lameter.
Lee Schermerhornfa07e782008-10-18 20:26:47 -070089
David Howellsc24b7202009-04-13 14:40:01 -070090The unevictable list does not use the LRU pagevec mechanism. Rather,
91unevictable pages are placed directly on the page's zone's unevictable list
92under the zone lru_lock. This allows us to prevent the stranding of pages on
93the unevictable list when one task has the page isolated from the LRU and other
94tasks are changing the "evictability" state of the page.
Lee Schermerhornfa07e782008-10-18 20:26:47 -070095
96
Mike Rapoporta5e4da92018-03-21 21:22:42 +020097Memory Control Group Interaction
David Howellsc24b7202009-04-13 14:40:01 -070098--------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -070099
David Howellsc24b7202009-04-13 14:40:01 -0700100The unevictable LRU facility interacts with the memory control group [aka
Mauro Carvalho Chehabda82c922019-06-27 13:08:35 -0300101memory controller; see Documentation/admin-guide/cgroup-v1/memory.rst] by extending the
David Howellsc24b7202009-04-13 14:40:01 -0700102lru_list enum.
103
104The memory controller data structure automatically gets a per-zone unevictable
105list as a result of the "arrayification" of the per-zone LRU lists (one per
106lru_list enum element). The memory controller tracks the movement of pages to
107and from the unevictable list.
108
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700109When a memory control group comes under memory pressure, the controller will
110not attempt to reclaim pages on the unevictable list. This has a couple of
David Howellsc24b7202009-04-13 14:40:01 -0700111effects:
112
113 (1) Because the pages are "hidden" from reclaim on the unevictable list, the
114 reclaim process can be more efficient, dealing only with pages that have a
115 chance of being reclaimed.
116
117 (2) On the other hand, if too many of the pages charged to the control group
118 are unevictable, the evictable portion of the working set of the tasks in
119 the control group may not fit into the available memory. This can cause
120 the control group to thrash or to OOM-kill tasks.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700121
122
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200123.. _mark_addr_space_unevict:
124
125Marking Address Spaces Unevictable
David Howellsc24b7202009-04-13 14:40:01 -0700126----------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700127
David Howellsc24b7202009-04-13 14:40:01 -0700128For facilities such as ramfs none of the pages attached to the address space
129may be evicted. To prevent eviction of any such pages, the AS_UNEVICTABLE
130address space flag is provided, and this can be manipulated by a filesystem
131using a number of wrapper functions:
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700132
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200133 * ``void mapping_set_unevictable(struct address_space *mapping);``
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700134
David Howellsc24b7202009-04-13 14:40:01 -0700135 Mark the address space as being completely unevictable.
136
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200137 * ``void mapping_clear_unevictable(struct address_space *mapping);``
David Howellsc24b7202009-04-13 14:40:01 -0700138
139 Mark the address space as being evictable.
140
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200141 * ``int mapping_unevictable(struct address_space *mapping);``
David Howellsc24b7202009-04-13 14:40:01 -0700142
143 Query the address space, and return true if it is completely
144 unevictable.
145
Kuo-Hsin Yang64e3d122018-11-06 13:23:24 +0000146These are currently used in three places in the kernel:
David Howellsc24b7202009-04-13 14:40:01 -0700147
148 (1) By ramfs to mark the address spaces of its inodes when they are created,
149 and this mark remains for the life of the inode.
150
151 (2) By SYSV SHM to mark SHM_LOCK'd address spaces until SHM_UNLOCK is called.
152
153 Note that SHM_LOCK is not required to page in the locked pages if they're
154 swapped out; the application must touch the pages manually if it wants to
155 ensure they're in memory.
156
Kuo-Hsin Yang64e3d122018-11-06 13:23:24 +0000157 (3) By the i915 driver to mark pinned address space until it's unpinned. The
158 amount of unevictable memory marked by i915 driver is roughly the bounded
159 object size in debugfs/dri/0/i915_gem_objects.
160
David Howellsc24b7202009-04-13 14:40:01 -0700161
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200162Detecting Unevictable Pages
David Howellsc24b7202009-04-13 14:40:01 -0700163---------------------------
164
165The function page_evictable() in vmscan.c determines whether a page is
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200166evictable or not using the query function outlined above [see section
167:ref:`Marking address spaces unevictable <mark_addr_space_unevict>`]
168to check the AS_UNEVICTABLE flag.
David Howellsc24b7202009-04-13 14:40:01 -0700169
170For address spaces that are so marked after being populated (as SHM regions
171might be), the lock action (eg: SHM_LOCK) can be lazy, and need not populate
172the page tables for the region as does, for example, mlock(), nor need it make
173any special effort to push any pages in the SHM_LOCK'd area to the unevictable
174list. Instead, vmscan will do this if and when it encounters the pages during
175a reclamation scan.
176
177On an unlock action (such as SHM_UNLOCK), the unlocker (eg: shmctl()) must scan
178the pages in the region and "rescue" them from the unevictable list if no other
179condition is keeping them unevictable. If an unevictable region is destroyed,
180the pages are also "rescued" from the unevictable list in the process of
181freeing them.
182
183page_evictable() also checks for mlocked pages by testing an additional page
Hugh Dickins39b5f292012-10-08 16:33:18 -0700184flag, PG_mlocked (as wrapped by PageMlocked()), which is set when a page is
185faulted into a VM_LOCKED vma, or found in a vma being VM_LOCKED.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700186
187
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200188Vmscan's Handling of Unevictable Pages
David Howellsc24b7202009-04-13 14:40:01 -0700189--------------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700190
191If unevictable pages are culled in the fault path, or moved to the unevictable
David Howellsc24b7202009-04-13 14:40:01 -0700192list at mlock() or mmap() time, vmscan will not encounter the pages until they
193have become evictable again (via munlock() for example) and have been "rescued"
194from the unevictable list. However, there may be situations where we decide,
195for the sake of expediency, to leave a unevictable page on one of the regular
196active/inactive LRU lists for vmscan to deal with. vmscan checks for such
197pages in all of the shrink_{active|inactive|page}_list() functions and will
198"cull" such pages that it encounters: that is, it diverts those pages to the
199unevictable list for the zone being scanned.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700200
David Howellsc24b7202009-04-13 14:40:01 -0700201There may be situations where a page is mapped into a VM_LOCKED VMA, but the
202page is not marked as PG_mlocked. Such pages will make it all the way to
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700203shrink_page_list() where they will be detected when vmscan walks the reverse
David Howellsc24b7202009-04-13 14:40:01 -0700204map in try_to_unmap(). If try_to_unmap() returns SWAP_MLOCK,
205shrink_page_list() will cull the page at that point.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700206
David Howellsc24b7202009-04-13 14:40:01 -0700207To "cull" an unevictable page, vmscan simply puts the page back on the LRU list
208using putback_lru_page() - the inverse operation to isolate_lru_page() - after
209dropping the page lock. Because the condition which makes the page unevictable
210may change once the page is unlocked, putback_lru_page() will recheck the
211unevictable state of a page that it places on the unevictable list. If the
212page has become unevictable, putback_lru_page() removes it from the list and
213retries, including the page_unevictable() test. Because such a race is a rare
214event and movement of pages onto the unevictable list should be rare, these
215extra evictabilty checks should not occur in the majority of calls to
216putback_lru_page().
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700217
218
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200219MLOCKED Pages
David Howellsc24b7202009-04-13 14:40:01 -0700220=============
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700221
David Howellsc24b7202009-04-13 14:40:01 -0700222The unevictable page list is also useful for mlock(), in addition to ramfs and
223SYSV SHM. Note that mlock() is only available in CONFIG_MMU=y situations; in
224NOMMU situations, all mappings are effectively mlocked.
225
226
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200227History
David Howellsc24b7202009-04-13 14:40:01 -0700228-------
229
230The "Unevictable mlocked Pages" infrastructure is based on work originally
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700231posted by Nick Piggin in an RFC patch entitled "mm: mlocked pages off LRU".
David Howellsc24b7202009-04-13 14:40:01 -0700232Nick posted his patch as an alternative to a patch posted by Christoph Lameter
233to achieve the same objective: hiding mlocked pages from vmscan.
234
235In Nick's patch, he used one of the struct page LRU list link fields as a count
236of VM_LOCKED VMAs that map the page. This use of the link field for a count
237prevented the management of the pages on an LRU list, and thus mlocked pages
238were not migratable as isolate_lru_page() could not find them, and the LRU list
239link field was not available to the migration subsystem.
240
241Nick resolved this by putting mlocked pages back on the lru list before
242attempting to isolate them, thus abandoning the count of VM_LOCKED VMAs. When
243Nick's patch was integrated with the Unevictable LRU work, the count was
244replaced by walking the reverse map to determine whether any VM_LOCKED VMAs
245mapped the page. More on this below.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700246
247
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200248Basic Management
David Howellsc24b7202009-04-13 14:40:01 -0700249----------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700250
David Howellsc24b7202009-04-13 14:40:01 -0700251mlocked pages - pages mapped into a VM_LOCKED VMA - are a class of unevictable
252pages. When such a page has been "noticed" by the memory management subsystem,
253the page is marked with the PG_mlocked flag. This can be manipulated using the
254PageMlocked() functions.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700255
David Howellsc24b7202009-04-13 14:40:01 -0700256A PG_mlocked page will be placed on the unevictable list when it is added to
257the LRU. Such pages can be "noticed" by memory management in several places:
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700258
David Howellsc24b7202009-04-13 14:40:01 -0700259 (1) in the mlock()/mlockall() system call handlers;
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700260
David Howellsc24b7202009-04-13 14:40:01 -0700261 (2) in the mmap() system call handler when mmapping a region with the
262 MAP_LOCKED flag;
263
264 (3) mmapping a region in a task that has called mlockall() with the MCL_FUTURE
265 flag
266
267 (4) in the fault path, if mlocked pages are "culled" in the fault path,
268 and when a VM_LOCKED stack segment is expanded; or
269
270 (5) as mentioned above, in vmscan:shrink_page_list() when attempting to
271 reclaim a page in a VM_LOCKED VMA via try_to_unmap()
272
273all of which result in the VM_LOCKED flag being set for the VMA if it doesn't
274already have it set.
275
276mlocked pages become unlocked and rescued from the unevictable list when:
277
278 (1) mapped in a range unlocked via the munlock()/munlockall() system calls;
279
280 (2) munmap()'d out of the last VM_LOCKED VMA that maps the page, including
281 unmapping at task exit;
282
283 (3) when the page is truncated from the last VM_LOCKED VMA of an mmapped file;
284 or
285
286 (4) before a page is COW'd in a VM_LOCKED VMA.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700287
288
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200289mlock()/mlockall() System Call Handling
David Howellsc24b7202009-04-13 14:40:01 -0700290---------------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700291
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200292Both [do\_]mlock() and [do\_]mlockall() system call handlers call mlock_fixup()
David Howellsc24b7202009-04-13 14:40:01 -0700293for each VMA in the range specified by the call. In the case of mlockall(),
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700294this is the entire active address space of the task. Note that mlock_fixup()
David Howellsc24b7202009-04-13 14:40:01 -0700295is used for both mlocking and munlocking a range of memory. A call to mlock()
296an already VM_LOCKED VMA, or to munlock() a VMA that is not VM_LOCKED is
297treated as a no-op, and mlock_fixup() simply returns.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700298
David Howellsc24b7202009-04-13 14:40:01 -0700299If the VMA passes some filtering as described in "Filtering Special Vmas"
300below, mlock_fixup() will attempt to merge the VMA with its neighbors or split
301off a subset of the VMA if the range does not cover the entire VMA. Once the
302VMA has been merged or split or neither, mlock_fixup() will call
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700303populate_vma_page_range() to fault in the pages via get_user_pages() and to
David Howellsc24b7202009-04-13 14:40:01 -0700304mark the pages as mlocked via mlock_vma_page().
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700305
David Howellsc24b7202009-04-13 14:40:01 -0700306Note that the VMA being mlocked might be mapped with PROT_NONE. In this case,
307get_user_pages() will be unable to fault in the pages. That's okay. If pages
308do end up getting faulted into this VM_LOCKED VMA, we'll handle them in the
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700309fault path or in vmscan.
310
311Also note that a page returned by get_user_pages() could be truncated or
David Howellsc24b7202009-04-13 14:40:01 -0700312migrated out from under us, while we're trying to mlock it. To detect this,
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700313populate_vma_page_range() checks page_mapping() after acquiring the page lock.
David Howellsc24b7202009-04-13 14:40:01 -0700314If the page is still associated with its mapping, we'll go ahead and call
315mlock_vma_page(). If the mapping is gone, we just unlock the page and move on.
316In the worst case, this will result in a page mapped in a VM_LOCKED VMA
317remaining on a normal LRU list without being PageMlocked(). Again, vmscan will
318detect and cull such pages.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700319
David Howellsc24b7202009-04-13 14:40:01 -0700320mlock_vma_page() will call TestSetPageMlocked() for each page returned by
321get_user_pages(). We use TestSetPageMlocked() because the page might already
322be mlocked by another task/VMA and we don't want to do extra work. We
323especially do not want to count an mlocked page more than once in the
324statistics. If the page was already mlocked, mlock_vma_page() need do nothing
325more.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700326
327If the page was NOT already mlocked, mlock_vma_page() attempts to isolate the
328page from the LRU, as it is likely on the appropriate active or inactive list
David Howellsc24b7202009-04-13 14:40:01 -0700329at that time. If the isolate_lru_page() succeeds, mlock_vma_page() will put
330back the page - by calling putback_lru_page() - which will notice that the page
331is now mlocked and divert the page to the zone's unevictable list. If
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700332mlock_vma_page() is unable to isolate the page from the LRU, vmscan will handle
David Howellsc24b7202009-04-13 14:40:01 -0700333it later if and when it attempts to reclaim the page.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700334
335
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200336Filtering Special VMAs
David Howellsc24b7202009-04-13 14:40:01 -0700337----------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700338
David Howellsc24b7202009-04-13 14:40:01 -0700339mlock_fixup() filters several classes of "special" VMAs:
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700340
David Howellsc24b7202009-04-13 14:40:01 -07003411) VMAs with VM_IO or VM_PFNMAP set are skipped entirely. The pages behind
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700342 these mappings are inherently pinned, so we don't need to mark them as
David Howellsc24b7202009-04-13 14:40:01 -0700343 mlocked. In any case, most of the pages have no struct page in which to so
344 mark the page. Because of this, get_user_pages() will fail for these VMAs,
345 so there is no sense in attempting to visit them.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700346
David Howellsc24b7202009-04-13 14:40:01 -07003472) VMAs mapping hugetlbfs page are already effectively pinned into memory. We
348 neither need nor want to mlock() these pages. However, to preserve the
349 prior behavior of mlock() - before the unevictable/mlock changes -
350 mlock_fixup() will call make_pages_present() in the hugetlbfs VMA range to
351 allocate the huge pages and populate the ptes.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700352
Konstantin Khlebnikov314e51b2012-10-08 16:29:02 -07003533) VMAs with VM_DONTEXPAND are generally userspace mappings of kernel pages,
354 such as the VDSO page, relay channel pages, etc. These pages
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700355 are inherently unevictable and are not managed on the LRU lists.
David Howellsc24b7202009-04-13 14:40:01 -0700356 mlock_fixup() treats these VMAs the same as hugetlbfs VMAs. It calls
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700357 make_pages_present() to populate the ptes.
358
David Howellsc24b7202009-04-13 14:40:01 -0700359Note that for all of these special VMAs, mlock_fixup() does not set the
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700360VM_LOCKED flag. Therefore, we won't have to deal with them later during
David Howellsc24b7202009-04-13 14:40:01 -0700361munlock(), munmap() or task exit. Neither does mlock_fixup() account these
362VMAs against the task's "locked_vm".
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700363
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200364.. _munlock_munlockall_handling:
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700365
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200366munlock()/munlockall() System Call Handling
David Howellsc24b7202009-04-13 14:40:01 -0700367-------------------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700368
David Howellsc24b7202009-04-13 14:40:01 -0700369The munlock() and munlockall() system calls are handled by the same functions -
370do_mlock[all]() - as the mlock() and mlockall() system calls with the unlock vs
371lock operation indicated by an argument. So, these system calls are also
372handled by mlock_fixup(). Again, if called for an already munlocked VMA,
373mlock_fixup() simply returns. Because of the VMA filtering discussed above,
374VM_LOCKED will not be set in any "special" VMAs. So, these VMAs will be
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700375ignored for munlock.
376
David Howellsc24b7202009-04-13 14:40:01 -0700377If the VMA is VM_LOCKED, mlock_fixup() again attempts to merge or split off the
378specified range. The range is then munlocked via the function
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700379populate_vma_page_range() - the same function used to mlock a VMA range -
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700380passing a flag to indicate that munlock() is being performed.
381
David Howellsc24b7202009-04-13 14:40:01 -0700382Because the VMA access protections could have been changed to PROT_NONE after
Hugh Dickins63d6c5a2009-01-06 14:39:38 -0800383faulting in and mlocking pages, get_user_pages() was unreliable for visiting
David Howellsc24b7202009-04-13 14:40:01 -0700384these pages for munlocking. Because we don't want to leave pages mlocked,
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700385get_user_pages() was enhanced to accept a flag to ignore the permissions when
David Howellsc24b7202009-04-13 14:40:01 -0700386fetching the pages - all of which should be resident as a result of previous
387mlocking.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700388
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700389For munlock(), populate_vma_page_range() unlocks individual pages by calling
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700390munlock_vma_page(). munlock_vma_page() unconditionally clears the PG_mlocked
David Howellsc24b7202009-04-13 14:40:01 -0700391flag using TestClearPageMlocked(). As with mlock_vma_page(),
392munlock_vma_page() use the Test*PageMlocked() function to handle the case where
393the page might have already been unlocked by another task. If the page was
394mlocked, munlock_vma_page() updates that zone statistics for the number of
395mlocked pages. Note, however, that at this point we haven't checked whether
396the page is mapped by other VM_LOCKED VMAs.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700397
David Howellsc24b7202009-04-13 14:40:01 -0700398We can't call try_to_munlock(), the function that walks the reverse map to
399check for other VM_LOCKED VMAs, without first isolating the page from the LRU.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700400try_to_munlock() is a variant of try_to_unmap() and thus requires that the page
David Howellsc24b7202009-04-13 14:40:01 -0700401not be on an LRU list [more on these below]. However, the call to
402isolate_lru_page() could fail, in which case we couldn't try_to_munlock(). So,
403we go ahead and clear PG_mlocked up front, as this might be the only chance we
404have. If we can successfully isolate the page, we go ahead and
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700405try_to_munlock(), which will restore the PG_mlocked flag and update the zone
David Howellsc24b7202009-04-13 14:40:01 -0700406page statistics if it finds another VMA holding the page mlocked. If we fail
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700407to isolate the page, we'll have left a potentially mlocked page on the LRU.
David Howellsc24b7202009-04-13 14:40:01 -0700408This is fine, because we'll catch it later if and if vmscan tries to reclaim
409the page. This should be relatively rare.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700410
411
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200412Migrating MLOCKED Pages
David Howellsc24b7202009-04-13 14:40:01 -0700413-----------------------
414
415A page that is being migrated has been isolated from the LRU lists and is held
416locked across unmapping of the page, updating the page's address space entry
417and copying the contents and state, until the page table entry has been
418replaced with an entry that refers to the new page. Linux supports migration
419of mlocked pages and other unevictable pages. This involves simply moving the
420PG_mlocked and PG_unevictable states from the old page to the new page.
421
422Note that page migration can race with mlocking or munlocking of the same page.
423This has been discussed from the mlock/munlock perspective in the respective
424sections above. Both processes (migration and m[un]locking) hold the page
425locked. This provides the first level of synchronization. Page migration
426zeros out the page_mapping of the old page before unlocking it, so m[un]lock
427can skip these pages by testing the page mapping under page lock.
428
429To complete page migration, we place the new and old pages back onto the LRU
430after dropping the page lock. The "unneeded" page - old page on success, new
431page on failure - will be freed when the reference count held by the migration
432process is released. To ensure that we don't strand pages on the unevictable
433list because of a race between munlock and migration, page migration uses the
434putback_lru_page() function to add migrated pages back to the LRU.
435
436
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200437Compacting MLOCKED Pages
Eric B Munson922c0552015-04-15 16:13:23 -0700438------------------------
439
440The unevictable LRU can be scanned for compactable regions and the default
441behavior is to do so. /proc/sys/vm/compact_unevictable_allowed controls
Mauro Carvalho Chehab57043242019-04-22 16:48:00 -0300442this behavior (see Documentation/admin-guide/sysctl/vm.rst). Once scanning of the
Eric B Munson922c0552015-04-15 16:13:23 -0700443unevictable LRU is enabled, the work of compaction is mostly handled by
444the page migration code and the same work flow as described in MIGRATING
445MLOCKED PAGES will apply.
446
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200447MLOCKING Transparent Huge Pages
Kirill A. Shutemov6fb8ddf2016-07-26 15:25:15 -0700448-------------------------------
449
450A transparent huge page is represented by a single entry on an LRU list.
451Therefore, we can only make unevictable an entire compound page, not
452individual subpages.
453
454If a user tries to mlock() part of a huge page, we want the rest of the
455page to be reclaimable.
456
457We cannot just split the page on partial mlock() as split_huge_page() can
458fail and new intermittent failure mode for the syscall is undesirable.
459
460We handle this by keeping PTE-mapped huge pages on normal LRU lists: the
461PMD on border of VM_LOCKED VMA will be split into PTE table.
462
463This way the huge page is accessible for vmscan. Under memory pressure the
464page will be split, subpages which belong to VM_LOCKED VMAs will be moved
465to unevictable LRU and the rest can be reclaimed.
466
467See also comment in follow_trans_huge_pmd().
Eric B Munson922c0552015-04-15 16:13:23 -0700468
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200469mmap(MAP_LOCKED) System Call Handling
David Howellsc24b7202009-04-13 14:40:01 -0700470-------------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700471
Masanari Iidadf5cbb22014-03-21 10:04:30 +0900472In addition the mlock()/mlockall() system calls, an application can request
David Howellsc24b7202009-04-13 14:40:01 -0700473that a region of memory be mlocked supplying the MAP_LOCKED flag to the mmap()
Michal Hocko9b012a22015-06-24 16:57:50 -0700474call. There is one important and subtle difference here, though. mmap() + mlock()
475will fail if the range cannot be faulted in (e.g. because mm_populate fails)
476and returns with ENOMEM while mmap(MAP_LOCKED) will not fail. The mmaped
477area will still have properties of the locked area - aka. pages will not get
478swapped out - but major page faults to fault memory in might still happen.
479
480Furthermore, any mmap() call or brk() call that expands the heap by a
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700481task that has previously called mlockall() with the MCL_FUTURE flag will result
David Howellsc24b7202009-04-13 14:40:01 -0700482in the newly mapped memory being mlocked. Before the unevictable/mlock
483changes, the kernel simply called make_pages_present() to allocate pages and
484populate the page table.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700485
486To mlock a range of memory under the unevictable/mlock infrastructure, the
487mmap() handler and task address space expansion functions call
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700488populate_vma_page_range() specifying the vma and the address range to mlock.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700489
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700490The callers of populate_vma_page_range() will have already added the memory range
David Howellsc24b7202009-04-13 14:40:01 -0700491to be mlocked to the task's "locked_vm". To account for filtered VMAs,
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700492populate_vma_page_range() returns the number of pages NOT mlocked. All of the
David Howellsc24b7202009-04-13 14:40:01 -0700493callers then subtract a non-negative return value from the task's locked_vm. A
494negative return value represent an error - for example, from get_user_pages()
495attempting to fault in a VMA with PROT_NONE access. In this case, we leave the
496memory range accounted as locked_vm, as the protections could be changed later
497and pages allocated into that region.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700498
499
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200500munmap()/exit()/exec() System Call Handling
David Howellsc24b7202009-04-13 14:40:01 -0700501-------------------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700502
503When unmapping an mlocked region of memory, whether by an explicit call to
504munmap() or via an internal unmap from exit() or exec() processing, we must
David Howellsc24b7202009-04-13 14:40:01 -0700505munlock the pages if we're removing the last VM_LOCKED VMA that maps the pages.
Hugh Dickins63d6c5a2009-01-06 14:39:38 -0800506Before the unevictable/mlock changes, mlocking did not mark the pages in any
507way, so unmapping them required no processing.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700508
509To munlock a range of memory under the unevictable/mlock infrastructure, the
David Howellsc24b7202009-04-13 14:40:01 -0700510munmap() handler and task address space call tear down function
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700511munlock_vma_pages_all(). The name reflects the observation that one always
David Howellsc24b7202009-04-13 14:40:01 -0700512specifies the entire VMA range when munlock()ing during unmap of a region.
513Because of the VMA filtering when mlocking() regions, only "normal" VMAs that
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700514actually contain mlocked pages will be passed to munlock_vma_pages_all().
515
David Howellsc24b7202009-04-13 14:40:01 -0700516munlock_vma_pages_all() clears the VM_LOCKED VMA flag and, like mlock_fixup()
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700517for the munlock case, calls __munlock_vma_pages_range() to walk the page table
David Howellsc24b7202009-04-13 14:40:01 -0700518for the VMA's memory range and munlock_vma_page() each resident page mapped by
519the VMA. This effectively munlocks the page, only if this is the last
520VM_LOCKED VMA that maps the page.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700521
522
David Howellsc24b7202009-04-13 14:40:01 -0700523try_to_unmap()
524--------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700525
David Howellsc24b7202009-04-13 14:40:01 -0700526Pages can, of course, be mapped into multiple VMAs. Some of these VMAs may
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700527have VM_LOCKED flag set. It is possible for a page mapped into one or more
David Howellsc24b7202009-04-13 14:40:01 -0700528VM_LOCKED VMAs not to have the PG_mlocked flag set and therefore reside on one
529of the active or inactive LRU lists. This could happen if, for example, a task
530in the process of munlocking the page could not isolate the page from the LRU.
531As a result, vmscan/shrink_page_list() might encounter such a page as described
532in section "vmscan's handling of unevictable pages". To handle this situation,
533try_to_unmap() checks for VM_LOCKED VMAs while it is walking a page's reverse
534map.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700535
536try_to_unmap() is always called, by either vmscan for reclaim or for page
David Howellsc24b7202009-04-13 14:40:01 -0700537migration, with the argument page locked and isolated from the LRU. Separate
Hugh Dickinsb87537d9e2015-11-05 18:49:33 -0800538functions handle anonymous and mapped file and KSM pages, as these types of
539pages have different reverse map lookup mechanisms, with different locking.
540In each case, whether rmap_walk_anon() or rmap_walk_file() or rmap_walk_ksm(),
541it will call try_to_unmap_one() for every VMA which might contain the page.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700542
Hugh Dickinsb87537d9e2015-11-05 18:49:33 -0800543When trying to reclaim, if try_to_unmap_one() finds the page in a VM_LOCKED
544VMA, it will then mlock the page via mlock_vma_page() instead of unmapping it,
545and return SWAP_MLOCK to indicate that the page is unevictable: and the scan
546stops there.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700547
Hugh Dickinsb87537d9e2015-11-05 18:49:33 -0800548mlock_vma_page() is called while holding the page table's lock (in addition
549to the page lock, and the rmap lock): to serialize against concurrent mlock or
550munlock or munmap system calls, mm teardown (munlock_vma_pages_all), reclaim,
551holepunching, and truncation of file pages and their anonymous COWed pages.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700552
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700553
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200554try_to_munlock() Reverse Map Scan
David Howellsc24b7202009-04-13 14:40:01 -0700555---------------------------------
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700556
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200557.. warning::
558 [!] TODO/FIXME: a better name might be page_mlocked() - analogous to the
559 page_referenced() reverse map walker.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700560
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200561When munlock_vma_page() [see section :ref:`munlock()/munlockall() System Call
562Handling <munlock_munlockall_handling>` above] tries to munlock a
563page, it needs to determine whether or not the page is mapped by any
564VM_LOCKED VMA without actually attempting to unmap all PTEs from the
565page. For this purpose, the unevictable/mlock infrastructure
David Howellsc24b7202009-04-13 14:40:01 -0700566introduced a variant of try_to_unmap() called try_to_munlock().
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700567
568try_to_munlock() calls the same functions as try_to_unmap() for anonymous and
Hugh Dickinsb87537d9e2015-11-05 18:49:33 -0800569mapped file and KSM pages with a flag argument specifying unlock versus unmap
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700570processing. Again, these functions walk the respective reverse maps looking
Hugh Dickins7a142392015-11-05 18:49:30 -0800571for VM_LOCKED VMAs. When such a VMA is found, as in the try_to_unmap() case,
Hugh Dickinsb87537d9e2015-11-05 18:49:33 -0800572the functions mlock the page via mlock_vma_page() and return SWAP_MLOCK. This
573undoes the pre-clearing of the page's PG_mlocked done by munlock_vma_page.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700574
David Howellsc24b7202009-04-13 14:40:01 -0700575Note that try_to_munlock()'s reverse map walk must visit every VMA in a page's
576reverse map to determine that a page is NOT mapped into any VM_LOCKED VMA.
Hugh Dickinsb87537d9e2015-11-05 18:49:33 -0800577However, the scan can terminate when it encounters a VM_LOCKED VMA.
David Howellsc24b7202009-04-13 14:40:01 -0700578Although try_to_munlock() might be called a great many times when munlocking a
579large region or tearing down a large address space that has been mlocked via
580mlockall(), overall this is a fairly rare event.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700581
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700582
Mike Rapoporta5e4da92018-03-21 21:22:42 +0200583Page Reclaim in shrink_*_list()
David Howellsc24b7202009-04-13 14:40:01 -0700584-------------------------------
585
586shrink_active_list() culls any obviously unevictable pages - i.e.
Hugh Dickins39b5f292012-10-08 16:33:18 -0700587!page_evictable(page) - diverting these to the unevictable list.
David Howellsc24b7202009-04-13 14:40:01 -0700588However, shrink_active_list() only sees unevictable pages that made it onto the
589active/inactive lru lists. Note that these pages do not have PageUnevictable
590set - otherwise they would be on the unevictable list and shrink_active_list
591would never see them.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700592
593Some examples of these unevictable pages on the LRU lists are:
594
David Howellsc24b7202009-04-13 14:40:01 -0700595 (1) ramfs pages that have been placed on the LRU lists when first allocated.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700596
David Howellsc24b7202009-04-13 14:40:01 -0700597 (2) SHM_LOCK'd shared memory pages. shmctl(SHM_LOCK) does not attempt to
598 allocate or fault in the pages in the shared memory region. This happens
599 when an application accesses the page the first time after SHM_LOCK'ing
600 the segment.
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700601
David Howellsc24b7202009-04-13 14:40:01 -0700602 (3) mlocked pages that could not be isolated from the LRU and moved to the
603 unevictable list in mlock_vma_page().
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700604
David Howellsc24b7202009-04-13 14:40:01 -0700605shrink_inactive_list() also diverts any unevictable pages that it finds on the
606inactive lists to the appropriate zone's unevictable list.
607
608shrink_inactive_list() should only see SHM_LOCK'd pages that became SHM_LOCK'd
609after shrink_active_list() had moved them to the inactive list, or pages mapped
610into VM_LOCKED VMAs that munlock_vma_page() couldn't isolate from the LRU to
611recheck via try_to_munlock(). shrink_inactive_list() won't notice the latter,
612but will pass on to shrink_page_list().
Lee Schermerhornfa07e782008-10-18 20:26:47 -0700613
614shrink_page_list() again culls obviously unevictable pages that it could
Hugh Dickins63d6c5a2009-01-06 14:39:38 -0800615encounter for similar reason to shrink_inactive_list(). Pages mapped into
David Howellsc24b7202009-04-13 14:40:01 -0700616VM_LOCKED VMAs but without PG_mlocked set will make it all the way to
Hugh Dickins63d6c5a2009-01-06 14:39:38 -0800617try_to_unmap(). shrink_page_list() will divert them to the unevictable list
618when try_to_unmap() returns SWAP_MLOCK, as discussed above.