blob: a655a50cdc8d76c18fecdb140b362d5ef89f7c68 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/mm/mlock.c
3 *
4 * (C) Copyright 1995 Linus Torvalds
5 * (C) Copyright 2002 Christoph Hellwig
6 */
7
Randy.Dunlapc59ede72006-01-11 12:17:46 -08008#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/mman.h>
10#include <linux/mm.h>
Nick Pigginb291f002008-10-18 20:26:44 -070011#include <linux/swap.h>
12#include <linux/swapops.h>
13#include <linux/pagemap.h>
Vlastimil Babka72255222013-09-11 14:22:29 -070014#include <linux/pagevec.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/mempolicy.h>
16#include <linux/syscalls.h>
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040017#include <linux/sched.h>
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040018#include <linux/export.h>
Nick Pigginb291f002008-10-18 20:26:44 -070019#include <linux/rmap.h>
20#include <linux/mmzone.h>
21#include <linux/hugetlb.h>
Vlastimil Babka72255222013-09-11 14:22:29 -070022#include <linux/memcontrol.h>
23#include <linux/mm_inline.h>
Nick Pigginb291f002008-10-18 20:26:44 -070024
25#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
Wang Xiaoqiang7f43add2016-01-15 16:57:22 -080027bool can_do_mlock(void)
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040028{
Jiri Slaby59e99e52010-03-05 13:41:44 -080029 if (rlimit(RLIMIT_MEMLOCK) != 0)
Wang Xiaoqiang7f43add2016-01-15 16:57:22 -080030 return true;
Jeff Vander Stoepa5a65792015-03-12 16:26:17 -070031 if (capable(CAP_IPC_LOCK))
Wang Xiaoqiang7f43add2016-01-15 16:57:22 -080032 return true;
33 return false;
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040034}
35EXPORT_SYMBOL(can_do_mlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Nick Pigginb291f002008-10-18 20:26:44 -070037/*
38 * Mlocked pages are marked with PageMlocked() flag for efficient testing
39 * in vmscan and, possibly, the fault path; and to support semi-accurate
40 * statistics.
41 *
42 * An mlocked page [PageMlocked(page)] is unevictable. As such, it will
43 * be placed on the LRU "unevictable" list, rather than the [in]active lists.
44 * The unevictable list is an LRU sibling list to the [in]active lists.
45 * PageUnevictable is set to indicate the unevictable state.
46 *
47 * When lazy mlocking via vmscan, it is important to ensure that the
48 * vma's VM_LOCKED status is not concurrently being modified, otherwise we
49 * may have mlocked a page that is being munlocked. So lazy mlock must take
50 * the mmap_sem for read, and verify that the vma really is locked
51 * (see mm/rmap.c).
52 */
53
54/*
55 * LRU accounting for clear_page_mlock()
56 */
Hugh Dickinse6c509f2012-10-08 16:33:19 -070057void clear_page_mlock(struct page *page)
Nick Pigginb291f002008-10-18 20:26:44 -070058{
Hugh Dickinse6c509f2012-10-08 16:33:19 -070059 if (!TestClearPageMlocked(page))
Nick Pigginb291f002008-10-18 20:26:44 -070060 return;
Nick Pigginb291f002008-10-18 20:26:44 -070061
David Rientjes8449d212012-10-08 16:34:06 -070062 mod_zone_page_state(page_zone(page), NR_MLOCK,
63 -hpage_nr_pages(page));
Nick Piggin5344b7e2008-10-18 20:26:51 -070064 count_vm_event(UNEVICTABLE_PGCLEARED);
Nick Pigginb291f002008-10-18 20:26:44 -070065 if (!isolate_lru_page(page)) {
66 putback_lru_page(page);
67 } else {
68 /*
KOSAKI Motohiro8891d6d2008-11-12 13:26:53 -080069 * We lost the race. the page already moved to evictable list.
Nick Pigginb291f002008-10-18 20:26:44 -070070 */
KOSAKI Motohiro8891d6d2008-11-12 13:26:53 -080071 if (PageUnevictable(page))
Nick Piggin5344b7e2008-10-18 20:26:51 -070072 count_vm_event(UNEVICTABLE_PGSTRANDED);
Nick Pigginb291f002008-10-18 20:26:44 -070073 }
74}
75
76/*
77 * Mark page as mlocked if not already.
78 * If page on LRU, isolate and putback to move to unevictable list.
79 */
80void mlock_vma_page(struct page *page)
81{
Vlastimil Babka57e68e92014-04-07 15:37:50 -070082 /* Serialize with page migration */
Nick Pigginb291f002008-10-18 20:26:44 -070083 BUG_ON(!PageLocked(page));
84
Kirill A. Shutemove90309c2016-01-15 16:54:33 -080085 VM_BUG_ON_PAGE(PageTail(page), page);
86 VM_BUG_ON_PAGE(PageCompound(page) && PageDoubleMap(page), page);
87
Nick Piggin5344b7e2008-10-18 20:26:51 -070088 if (!TestSetPageMlocked(page)) {
David Rientjes8449d212012-10-08 16:34:06 -070089 mod_zone_page_state(page_zone(page), NR_MLOCK,
90 hpage_nr_pages(page));
Nick Piggin5344b7e2008-10-18 20:26:51 -070091 count_vm_event(UNEVICTABLE_PGMLOCKED);
92 if (!isolate_lru_page(page))
93 putback_lru_page(page);
94 }
Nick Pigginb291f002008-10-18 20:26:44 -070095}
96
Vlastimil Babka72255222013-09-11 14:22:29 -070097/*
Vlastimil Babka01cc2e52014-01-23 15:52:50 -080098 * Isolate a page from LRU with optional get_page() pin.
99 * Assumes lru_lock already held and page already pinned.
100 */
101static bool __munlock_isolate_lru_page(struct page *page, bool getpage)
102{
103 if (PageLRU(page)) {
104 struct lruvec *lruvec;
105
Mel Gorman599d0c92016-07-28 15:45:31 -0700106 lruvec = mem_cgroup_page_lruvec(page, page_pgdat(page));
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800107 if (getpage)
108 get_page(page);
109 ClearPageLRU(page);
110 del_page_from_lru_list(page, lruvec, page_lru(page));
111 return true;
112 }
113
114 return false;
115}
116
117/*
Vlastimil Babka72255222013-09-11 14:22:29 -0700118 * Finish munlock after successful page isolation
119 *
120 * Page must be locked. This is a wrapper for try_to_munlock()
121 * and putback_lru_page() with munlock accounting.
122 */
123static void __munlock_isolated_page(struct page *page)
124{
125 int ret = SWAP_AGAIN;
126
127 /*
128 * Optimization: if the page was mapped just once, that's our mapping
129 * and we don't need to check all the other vmas.
130 */
131 if (page_mapcount(page) > 1)
132 ret = try_to_munlock(page);
133
134 /* Did try_to_unlock() succeed or punt? */
135 if (ret != SWAP_MLOCK)
136 count_vm_event(UNEVICTABLE_PGMUNLOCKED);
137
138 putback_lru_page(page);
139}
140
141/*
142 * Accounting for page isolation fail during munlock
143 *
144 * Performs accounting when page isolation fails in munlock. There is nothing
145 * else to do because it means some other task has already removed the page
146 * from the LRU. putback_lru_page() will take care of removing the page from
147 * the unevictable list, if necessary. vmscan [page_referenced()] will move
148 * the page back to the unevictable list if some other vma has it mlocked.
149 */
150static void __munlock_isolation_failed(struct page *page)
151{
152 if (PageUnevictable(page))
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800153 __count_vm_event(UNEVICTABLE_PGSTRANDED);
Vlastimil Babka72255222013-09-11 14:22:29 -0700154 else
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800155 __count_vm_event(UNEVICTABLE_PGMUNLOCKED);
Vlastimil Babka72255222013-09-11 14:22:29 -0700156}
157
Lee Schermerhorn6927c1d2009-12-14 17:59:55 -0800158/**
159 * munlock_vma_page - munlock a vma page
Vlastimil Babkac424be12014-01-02 12:58:43 -0800160 * @page - page to be unlocked, either a normal page or THP page head
161 *
162 * returns the size of the page as a page mask (0 for normal page,
163 * HPAGE_PMD_NR - 1 for THP head page)
Nick Pigginb291f002008-10-18 20:26:44 -0700164 *
Lee Schermerhorn6927c1d2009-12-14 17:59:55 -0800165 * called from munlock()/munmap() path with page supposedly on the LRU.
166 * When we munlock a page, because the vma where we found the page is being
167 * munlock()ed or munmap()ed, we want to check whether other vmas hold the
168 * page locked so that we can leave it on the unevictable lru list and not
169 * bother vmscan with it. However, to walk the page's rmap list in
170 * try_to_munlock() we must isolate the page from the LRU. If some other
171 * task has removed the page from the LRU, we won't be able to do that.
172 * So we clear the PageMlocked as we might not get another chance. If we
173 * can't isolate the page, we leave it for putback_lru_page() and vmscan
174 * [page_referenced()/try_to_unmap()] to deal with.
Nick Pigginb291f002008-10-18 20:26:44 -0700175 */
Michel Lespinasseff6a6da2013-02-27 17:02:44 -0800176unsigned int munlock_vma_page(struct page *page)
Nick Pigginb291f002008-10-18 20:26:44 -0700177{
Kirill A. Shutemov7162a1e2016-01-21 16:40:27 -0800178 int nr_pages;
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800179 struct zone *zone = page_zone(page);
Michel Lespinasseff6a6da2013-02-27 17:02:44 -0800180
Vlastimil Babka57e68e92014-04-07 15:37:50 -0700181 /* For try_to_munlock() and to serialize with page migration */
Nick Pigginb291f002008-10-18 20:26:44 -0700182 BUG_ON(!PageLocked(page));
183
Kirill A. Shutemove90309c2016-01-15 16:54:33 -0800184 VM_BUG_ON_PAGE(PageTail(page), page);
185
Vlastimil Babkac424be12014-01-02 12:58:43 -0800186 /*
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800187 * Serialize with any parallel __split_huge_page_refcount() which
188 * might otherwise copy PageMlocked to part of the tail pages before
189 * we clear it in the head page. It also stabilizes hpage_nr_pages().
Vlastimil Babkac424be12014-01-02 12:58:43 -0800190 */
Mel Gormana52633d2016-07-28 15:45:28 -0700191 spin_lock_irq(zone_lru_lock(zone));
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800192
Kirill A. Shutemov655548b2016-11-30 15:54:05 -0800193 if (!TestClearPageMlocked(page)) {
194 /* Potentially, PTE-mapped THP: do not skip the rest PTEs */
195 nr_pages = 1;
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800196 goto unlock_out;
Kirill A. Shutemov655548b2016-11-30 15:54:05 -0800197 }
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800198
Kirill A. Shutemov655548b2016-11-30 15:54:05 -0800199 nr_pages = hpage_nr_pages(page);
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800200 __mod_zone_page_state(zone, NR_MLOCK, -nr_pages);
201
202 if (__munlock_isolate_lru_page(page, true)) {
Mel Gormana52633d2016-07-28 15:45:28 -0700203 spin_unlock_irq(zone_lru_lock(zone));
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800204 __munlock_isolated_page(page);
205 goto out;
206 }
207 __munlock_isolation_failed(page);
208
209unlock_out:
Mel Gormana52633d2016-07-28 15:45:28 -0700210 spin_unlock_irq(zone_lru_lock(zone));
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800211
212out:
Vlastimil Babkac424be12014-01-02 12:58:43 -0800213 return nr_pages - 1;
Nick Pigginb291f002008-10-18 20:26:44 -0700214}
215
Lee Schermerhorn9978ad52008-10-18 20:26:56 -0700216/*
217 * convert get_user_pages() return value to posix mlock() error
218 */
219static int __mlock_posix_error_return(long retval)
220{
221 if (retval == -EFAULT)
222 retval = -ENOMEM;
223 else if (retval == -ENOMEM)
224 retval = -EAGAIN;
225 return retval;
Nick Pigginb291f002008-10-18 20:26:44 -0700226}
227
Nick Pigginb291f002008-10-18 20:26:44 -0700228/*
Vlastimil Babka56afe472013-09-11 14:22:32 -0700229 * Prepare page for fast batched LRU putback via putback_lru_evictable_pagevec()
230 *
231 * The fast path is available only for evictable pages with single mapping.
232 * Then we can bypass the per-cpu pvec and get better performance.
233 * when mapcount > 1 we need try_to_munlock() which can fail.
234 * when !page_evictable(), we need the full redo logic of putback_lru_page to
235 * avoid leaving evictable page in unevictable list.
236 *
237 * In case of success, @page is added to @pvec and @pgrescued is incremented
238 * in case that the page was previously unevictable. @page is also unlocked.
239 */
240static bool __putback_lru_fast_prepare(struct page *page, struct pagevec *pvec,
241 int *pgrescued)
242{
Sasha Levin309381fea2014-01-23 15:52:54 -0800243 VM_BUG_ON_PAGE(PageLRU(page), page);
244 VM_BUG_ON_PAGE(!PageLocked(page), page);
Vlastimil Babka56afe472013-09-11 14:22:32 -0700245
246 if (page_mapcount(page) <= 1 && page_evictable(page)) {
247 pagevec_add(pvec, page);
248 if (TestClearPageUnevictable(page))
249 (*pgrescued)++;
250 unlock_page(page);
251 return true;
252 }
253
254 return false;
255}
256
257/*
258 * Putback multiple evictable pages to the LRU
259 *
260 * Batched putback of evictable pages that bypasses the per-cpu pvec. Some of
261 * the pages might have meanwhile become unevictable but that is OK.
262 */
263static void __putback_lru_fast(struct pagevec *pvec, int pgrescued)
264{
265 count_vm_events(UNEVICTABLE_PGMUNLOCKED, pagevec_count(pvec));
266 /*
267 *__pagevec_lru_add() calls release_pages() so we don't call
268 * put_page() explicitly
269 */
270 __pagevec_lru_add(pvec);
271 count_vm_events(UNEVICTABLE_PGRESCUED, pgrescued);
272}
273
274/*
Vlastimil Babka72255222013-09-11 14:22:29 -0700275 * Munlock a batch of pages from the same zone
276 *
277 * The work is split to two main phases. First phase clears the Mlocked flag
278 * and attempts to isolate the pages, all under a single zone lru lock.
279 * The second phase finishes the munlock only for pages where isolation
280 * succeeded.
281 *
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700282 * Note that the pagevec may be modified during the process.
Vlastimil Babka72255222013-09-11 14:22:29 -0700283 */
284static void __munlock_pagevec(struct pagevec *pvec, struct zone *zone)
285{
286 int i;
287 int nr = pagevec_count(pvec);
Yisheng Xie1163e782017-06-02 14:46:43 -0700288 int delta_munlocked = -nr;
Vlastimil Babka56afe472013-09-11 14:22:32 -0700289 struct pagevec pvec_putback;
290 int pgrescued = 0;
Vlastimil Babka72255222013-09-11 14:22:29 -0700291
Vlastimil Babka3b25df92014-01-02 12:58:44 -0800292 pagevec_init(&pvec_putback, 0);
293
Vlastimil Babka72255222013-09-11 14:22:29 -0700294 /* Phase 1: page isolation */
Mel Gormana52633d2016-07-28 15:45:28 -0700295 spin_lock_irq(zone_lru_lock(zone));
Vlastimil Babka72255222013-09-11 14:22:29 -0700296 for (i = 0; i < nr; i++) {
297 struct page *page = pvec->pages[i];
298
299 if (TestClearPageMlocked(page)) {
Vlastimil Babka72255222013-09-11 14:22:29 -0700300 /*
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800301 * We already have pin from follow_page_mask()
302 * so we can spare the get_page() here.
Vlastimil Babka72255222013-09-11 14:22:29 -0700303 */
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800304 if (__munlock_isolate_lru_page(page, false))
305 continue;
306 else
307 __munlock_isolation_failed(page);
Yisheng Xie1163e782017-06-02 14:46:43 -0700308 } else {
309 delta_munlocked++;
Vlastimil Babka72255222013-09-11 14:22:29 -0700310 }
Vlastimil Babka01cc2e52014-01-23 15:52:50 -0800311
312 /*
313 * We won't be munlocking this page in the next phase
314 * but we still need to release the follow_page_mask()
315 * pin. We cannot do it under lru_lock however. If it's
316 * the last pin, __page_cache_release() would deadlock.
317 */
318 pagevec_add(&pvec_putback, pvec->pages[i]);
319 pvec->pages[i] = NULL;
Vlastimil Babka72255222013-09-11 14:22:29 -0700320 }
Vlastimil Babka1ebb7cc2013-09-11 14:22:30 -0700321 __mod_zone_page_state(zone, NR_MLOCK, delta_munlocked);
Mel Gormana52633d2016-07-28 15:45:28 -0700322 spin_unlock_irq(zone_lru_lock(zone));
Vlastimil Babka72255222013-09-11 14:22:29 -0700323
Vlastimil Babka3b25df92014-01-02 12:58:44 -0800324 /* Now we can release pins of pages that we are not munlocking */
325 pagevec_release(&pvec_putback);
326
Vlastimil Babka56afe472013-09-11 14:22:32 -0700327 /* Phase 2: page munlock */
Vlastimil Babka72255222013-09-11 14:22:29 -0700328 for (i = 0; i < nr; i++) {
329 struct page *page = pvec->pages[i];
330
331 if (page) {
332 lock_page(page);
Vlastimil Babka56afe472013-09-11 14:22:32 -0700333 if (!__putback_lru_fast_prepare(page, &pvec_putback,
334 &pgrescued)) {
Vlastimil Babka5b409982013-09-11 14:22:33 -0700335 /*
336 * Slow path. We don't want to lose the last
337 * pin before unlock_page()
338 */
339 get_page(page); /* for putback_lru_page() */
Vlastimil Babka56afe472013-09-11 14:22:32 -0700340 __munlock_isolated_page(page);
341 unlock_page(page);
Vlastimil Babka5b409982013-09-11 14:22:33 -0700342 put_page(page); /* from follow_page_mask() */
Vlastimil Babka56afe472013-09-11 14:22:32 -0700343 }
Vlastimil Babka72255222013-09-11 14:22:29 -0700344 }
345 }
Vlastimil Babka56afe472013-09-11 14:22:32 -0700346
Vlastimil Babka5b409982013-09-11 14:22:33 -0700347 /*
348 * Phase 3: page putback for pages that qualified for the fast path
349 * This will also call put_page() to return pin from follow_page_mask()
350 */
Vlastimil Babka56afe472013-09-11 14:22:32 -0700351 if (pagevec_count(&pvec_putback))
352 __putback_lru_fast(&pvec_putback, pgrescued);
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700353}
Vlastimil Babka56afe472013-09-11 14:22:32 -0700354
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700355/*
356 * Fill up pagevec for __munlock_pagevec using pte walk
357 *
358 * The function expects that the struct page corresponding to @start address is
359 * a non-TPH page already pinned and in the @pvec, and that it belongs to @zone.
360 *
361 * The rest of @pvec is filled by subsequent pages within the same pmd and same
362 * zone, as long as the pte's are present and vm_normal_page() succeeds. These
363 * pages also get pinned.
364 *
365 * Returns the address of the next page that should be scanned. This equals
366 * @start + PAGE_SIZE when no page could be added by the pte walk.
367 */
368static unsigned long __munlock_pagevec_fill(struct pagevec *pvec,
369 struct vm_area_struct *vma, int zoneid, unsigned long start,
370 unsigned long end)
371{
372 pte_t *pte;
373 spinlock_t *ptl;
374
375 /*
376 * Initialize pte walk starting at the already pinned page where we
Vlastimil Babkaeadb41a2013-09-30 13:45:18 -0700377 * are sure that there is a pte, as it was pinned under the same
378 * mmap_sem write op.
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700379 */
380 pte = get_locked_pte(vma->vm_mm, start, &ptl);
Vlastimil Babkaeadb41a2013-09-30 13:45:18 -0700381 /* Make sure we do not cross the page table boundary */
382 end = pgd_addr_end(start, end);
383 end = pud_addr_end(start, end);
384 end = pmd_addr_end(start, end);
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700385
386 /* The page next to the pinned page is the first we will try to get */
387 start += PAGE_SIZE;
388 while (start < end) {
389 struct page *page = NULL;
390 pte++;
391 if (pte_present(*pte))
392 page = vm_normal_page(vma, start, *pte);
393 /*
394 * Break if page could not be obtained or the page's node+zone does not
395 * match
396 */
397 if (!page || page_zone_id(page) != zoneid)
398 break;
399
Kirill A. Shutemove90309c2016-01-15 16:54:33 -0800400 /*
401 * Do not use pagevec for PTE-mapped THP,
402 * munlock_vma_pages_range() will handle them.
403 */
404 if (PageTransCompound(page))
405 break;
406
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700407 get_page(page);
408 /*
409 * Increase the address that will be returned *before* the
410 * eventual break due to pvec becoming full by adding the page
411 */
412 start += PAGE_SIZE;
413 if (pagevec_add(pvec, page) == 0)
414 break;
415 }
416 pte_unmap_unlock(pte, ptl);
417 return start;
Vlastimil Babka72255222013-09-11 14:22:29 -0700418}
419
420/*
Rik van Rielba470de2008-10-18 20:26:50 -0700421 * munlock_vma_pages_range() - munlock all pages in the vma range.'
422 * @vma - vma containing range to be munlock()ed.
423 * @start - start address in @vma of the range
424 * @end - end of range in @vma.
425 *
426 * For mremap(), munmap() and exit().
427 *
428 * Called with @vma VM_LOCKED.
429 *
430 * Returns with VM_LOCKED cleared. Callers must be prepared to
431 * deal with this.
432 *
433 * We don't save and restore VM_LOCKED here because pages are
434 * still on lru. In unmap path, pages might be scanned by reclaim
435 * and re-mlocked by try_to_{munlock|unmap} before we unmap and
436 * free them. This will result in freeing mlocked pages.
Nick Pigginb291f002008-10-18 20:26:44 -0700437 */
Rik van Rielba470de2008-10-18 20:26:50 -0700438void munlock_vma_pages_range(struct vm_area_struct *vma,
Hugh Dickins408e82b2009-09-21 17:03:23 -0700439 unsigned long start, unsigned long end)
Nick Pigginb291f002008-10-18 20:26:44 -0700440{
Laurent Dufourdd2b4652018-04-17 16:33:15 +0200441 vm_write_begin(vma);
442 WRITE_ONCE(vma->vm_flags, vma->vm_flags & VM_LOCKED_CLEAR_MASK);
443 vm_write_end(vma);
Hugh Dickins408e82b2009-09-21 17:03:23 -0700444
Michel Lespinasseff6a6da2013-02-27 17:02:44 -0800445 while (start < end) {
Alexey Klimovab7a5af2016-01-14 15:18:24 -0800446 struct page *page;
Kirill A. Shutemov1771fc52017-03-09 16:17:23 -0800447 unsigned int page_mask = 0;
Vlastimil Babkac424be12014-01-02 12:58:43 -0800448 unsigned long page_increm;
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700449 struct pagevec pvec;
450 struct zone *zone;
451 int zoneid;
Michel Lespinasseff6a6da2013-02-27 17:02:44 -0800452
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700453 pagevec_init(&pvec, 0);
Hugh Dickins6e919712009-09-21 17:03:32 -0700454 /*
455 * Although FOLL_DUMP is intended for get_dump_page(),
456 * it just so happens that its special treatment of the
457 * ZERO_PAGE (returning an error instead of doing get_page)
458 * suits munlock very well (and if somehow an abnormal page
459 * has sneaked into the range, we won't oops here: great).
460 */
Kirill A. Shutemov1771fc52017-03-09 16:17:23 -0800461 page = follow_page(vma, start, FOLL_GET | FOLL_DUMP);
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700462
Kirill A. Shutemove90309c2016-01-15 16:54:33 -0800463 if (page && !IS_ERR(page)) {
464 if (PageTransTail(page)) {
465 VM_BUG_ON_PAGE(PageMlocked(page), page);
466 put_page(page); /* follow_page_mask() */
467 } else if (PageTransHuge(page)) {
468 lock_page(page);
469 /*
470 * Any THP page found by follow_page_mask() may
471 * have gotten split before reaching
Kirill A. Shutemov1771fc52017-03-09 16:17:23 -0800472 * munlock_vma_page(), so we need to compute
473 * the page_mask here instead.
Kirill A. Shutemove90309c2016-01-15 16:54:33 -0800474 */
475 page_mask = munlock_vma_page(page);
476 unlock_page(page);
477 put_page(page); /* follow_page_mask() */
478 } else {
479 /*
480 * Non-huge pages are handled in batches via
481 * pagevec. The pin from follow_page_mask()
482 * prevents them from collapsing by THP.
483 */
484 pagevec_add(&pvec, page);
485 zone = page_zone(page);
486 zoneid = page_zone_id(page);
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700487
Kirill A. Shutemove90309c2016-01-15 16:54:33 -0800488 /*
489 * Try to fill the rest of pagevec using fast
490 * pte walk. This will also update start to
491 * the next page to process. Then munlock the
492 * pagevec.
493 */
494 start = __munlock_pagevec_fill(&pvec, vma,
495 zoneid, start, end);
496 __munlock_pagevec(&pvec, zone);
497 goto next;
498 }
Hugh Dickins408e82b2009-09-21 17:03:23 -0700499 }
Vlastimil Babkac424be12014-01-02 12:58:43 -0800500 page_increm = 1 + page_mask;
Michel Lespinasseff6a6da2013-02-27 17:02:44 -0800501 start += page_increm * PAGE_SIZE;
Vlastimil Babka7a8010c2013-09-11 14:22:35 -0700502next:
Hugh Dickins408e82b2009-09-21 17:03:23 -0700503 cond_resched();
504 }
Nick Pigginb291f002008-10-18 20:26:44 -0700505}
506
507/*
508 * mlock_fixup - handle mlock[all]/munlock[all] requests.
509 *
510 * Filters out "special" vmas -- VM_LOCKED never gets set for these, and
511 * munlock is a no-op. However, for some special vmas, we go ahead and
Michel Lespinassecea10a12013-02-22 16:32:44 -0800512 * populate the ptes.
Nick Pigginb291f002008-10-18 20:26:44 -0700513 *
514 * For vmas that pass the filters, merge/split as appropriate.
515 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516static int mlock_fixup(struct vm_area_struct *vma, struct vm_area_struct **prev,
KOSAKI Motohiroca16d142011-05-26 19:16:19 +0900517 unsigned long start, unsigned long end, vm_flags_t newflags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518{
Nick Pigginb291f002008-10-18 20:26:44 -0700519 struct mm_struct *mm = vma->vm_mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 pgoff_t pgoff;
Nick Pigginb291f002008-10-18 20:26:44 -0700521 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 int ret = 0;
KOSAKI Motohiroca16d142011-05-26 19:16:19 +0900523 int lock = !!(newflags & VM_LOCKED);
Simon Guob155b4f2016-10-07 16:59:40 -0700524 vm_flags_t old_flags = vma->vm_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Michel Lespinassefed067d2011-01-13 15:46:10 -0800526 if (newflags == vma->vm_flags || (vma->vm_flags & VM_SPECIAL) ||
Stephen Wilson31db58b2011-03-13 15:49:15 -0400527 is_vm_hugetlb_page(vma) || vma == get_gate_vma(current->mm))
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800528 /* don't set VM_LOCKED or VM_LOCKONFAULT and don't count */
529 goto out;
Nick Pigginb291f002008-10-18 20:26:44 -0700530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
532 *prev = vma_merge(mm, *prev, start, end, newflags, vma->anon_vma,
Andrea Arcangeli19a809a2015-09-04 15:46:24 -0700533 vma->vm_file, pgoff, vma_policy(vma),
Colin Cross3e4578f2015-10-27 16:42:08 -0700534 vma->vm_userfaultfd_ctx, vma_get_anon_name(vma));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 if (*prev) {
536 vma = *prev;
537 goto success;
538 }
539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 if (start != vma->vm_start) {
541 ret = split_vma(mm, vma, start, 1);
542 if (ret)
543 goto out;
544 }
545
546 if (end != vma->vm_end) {
547 ret = split_vma(mm, vma, end, 0);
548 if (ret)
549 goto out;
550 }
551
552success:
553 /*
Nick Pigginb291f002008-10-18 20:26:44 -0700554 * Keep track of amount of locked VM.
555 */
556 nr_pages = (end - start) >> PAGE_SHIFT;
557 if (!lock)
558 nr_pages = -nr_pages;
Simon Guob155b4f2016-10-07 16:59:40 -0700559 else if (old_flags & VM_LOCKED)
560 nr_pages = 0;
Nick Pigginb291f002008-10-18 20:26:44 -0700561 mm->locked_vm += nr_pages;
562
563 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 * vm_flags is protected by the mmap_sem held in write mode.
565 * It's okay if try_to_unmap_one unmaps a page just after we
Kirill A. Shutemovfc05f562015-04-14 15:44:39 -0700566 * set VM_LOCKED, populate_vma_page_range will bring it back.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 */
Laurent Dufourdd2b4652018-04-17 16:33:15 +0200568 if (lock) {
569 vm_write_begin(vma);
570 WRITE_ONCE(vma->vm_flags, newflags);
571 vm_write_end(vma);
572 } else
Hugh Dickins408e82b2009-09-21 17:03:23 -0700573 munlock_vma_pages_range(vma, start, end);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575out:
Nick Pigginb291f002008-10-18 20:26:44 -0700576 *prev = vma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 return ret;
578}
579
Eric B Munson1aab92e2015-11-05 18:51:29 -0800580static int apply_vma_lock_flags(unsigned long start, size_t len,
581 vm_flags_t flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
583 unsigned long nstart, end, tmp;
584 struct vm_area_struct * vma, * prev;
585 int error;
586
Alexander Kuleshov8fd9e482015-11-05 18:46:49 -0800587 VM_BUG_ON(offset_in_page(start));
Michel Lespinassefed067d2011-01-13 15:46:10 -0800588 VM_BUG_ON(len != PAGE_ALIGN(len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 end = start + len;
590 if (end < start)
591 return -EINVAL;
592 if (end == start)
593 return 0;
Linus Torvalds097d5912012-03-06 18:23:36 -0800594 vma = find_vma(current->mm, start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 if (!vma || vma->vm_start > start)
596 return -ENOMEM;
597
Linus Torvalds097d5912012-03-06 18:23:36 -0800598 prev = vma->vm_prev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 if (start > vma->vm_start)
600 prev = vma;
601
602 for (nstart = start ; ; ) {
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800603 vm_flags_t newflags = vma->vm_flags & VM_LOCKED_CLEAR_MASK;
Eric B Munson1aab92e2015-11-05 18:51:29 -0800604
605 newflags |= flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
607 /* Here we know that vma->vm_start <= nstart < vma->vm_end. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 tmp = vma->vm_end;
609 if (tmp > end)
610 tmp = end;
611 error = mlock_fixup(vma, &prev, nstart, tmp, newflags);
612 if (error)
613 break;
614 nstart = tmp;
615 if (nstart < prev->vm_end)
616 nstart = prev->vm_end;
617 if (nstart >= end)
618 break;
619
620 vma = prev->vm_next;
621 if (!vma || vma->vm_start != nstart) {
622 error = -ENOMEM;
623 break;
624 }
625 }
626 return error;
627}
628
Simon Guo0cf2f6f2016-10-07 16:59:36 -0700629/*
630 * Go through vma areas and sum size of mlocked
631 * vma pages, as return value.
632 * Note deferred memory locking case(mlock2(,,MLOCK_ONFAULT)
633 * is also counted.
634 * Return value: previously mlocked page counts
635 */
swkhack32b21342019-06-13 15:56:08 -0700636static unsigned long count_mm_mlocked_page_nr(struct mm_struct *mm,
Simon Guo0cf2f6f2016-10-07 16:59:36 -0700637 unsigned long start, size_t len)
638{
639 struct vm_area_struct *vma;
swkhack32b21342019-06-13 15:56:08 -0700640 unsigned long count = 0;
Simon Guo0cf2f6f2016-10-07 16:59:36 -0700641
642 if (mm == NULL)
643 mm = current->mm;
644
645 vma = find_vma(mm, start);
646 if (vma == NULL)
647 vma = mm->mmap;
648
649 for (; vma ; vma = vma->vm_next) {
650 if (start >= vma->vm_end)
651 continue;
652 if (start + len <= vma->vm_start)
653 break;
654 if (vma->vm_flags & VM_LOCKED) {
655 if (start > vma->vm_start)
656 count -= (start - vma->vm_start);
657 if (start + len < vma->vm_end) {
658 count += start + len - vma->vm_start;
659 break;
660 }
661 count += vma->vm_end - vma->vm_start;
662 }
663 }
664
665 return count >> PAGE_SHIFT;
666}
667
Michal Hockodc0ef0d2016-05-23 16:25:27 -0700668static __must_check int do_mlock(unsigned long start, size_t len, vm_flags_t flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669{
670 unsigned long locked;
671 unsigned long lock_limit;
672 int error = -ENOMEM;
673
674 if (!can_do_mlock())
675 return -EPERM;
676
KOSAKI Motohiro8891d6d2008-11-12 13:26:53 -0800677 lru_add_drain_all(); /* flush pagevec */
678
Alexander Kuleshov8fd9e482015-11-05 18:46:49 -0800679 len = PAGE_ALIGN(len + (offset_in_page(start)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 start &= PAGE_MASK;
681
Jiri Slaby59e99e52010-03-05 13:41:44 -0800682 lock_limit = rlimit(RLIMIT_MEMLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 lock_limit >>= PAGE_SHIFT;
Davidlohr Bueso1f1cd702014-01-21 15:49:16 -0800684 locked = len >> PAGE_SHIFT;
685
Michal Hockodc0ef0d2016-05-23 16:25:27 -0700686 if (down_write_killable(&current->mm->mmap_sem))
687 return -EINTR;
Davidlohr Bueso1f1cd702014-01-21 15:49:16 -0800688
689 locked += current->mm->locked_vm;
Simon Guo0cf2f6f2016-10-07 16:59:36 -0700690 if ((locked > lock_limit) && (!capable(CAP_IPC_LOCK))) {
691 /*
692 * It is possible that the regions requested intersect with
693 * previously mlocked areas, that part area in "mm->locked_vm"
694 * should not be counted to new mlock increment count. So check
695 * and adjust locked count if necessary.
696 */
697 locked -= count_mm_mlocked_page_nr(current->mm,
698 start, len);
699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
701 /* check against resource limits */
702 if ((locked <= lock_limit) || capable(CAP_IPC_LOCK))
Eric B Munson1aab92e2015-11-05 18:51:29 -0800703 error = apply_vma_lock_flags(start, len, flags);
Davidlohr Bueso1f1cd702014-01-21 15:49:16 -0800704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 up_write(&current->mm->mmap_sem);
Kirill A. Shutemovc5612592015-04-14 15:44:42 -0700706 if (error)
707 return error;
708
709 error = __mm_populate(start, len, 0);
710 if (error)
711 return __mlock_posix_error_return(error);
712 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713}
714
Eric B Munson1aab92e2015-11-05 18:51:29 -0800715SYSCALL_DEFINE2(mlock, unsigned long, start, size_t, len)
716{
717 return do_mlock(start, len, VM_LOCKED);
718}
719
Eric B Munsona8ca5d02015-11-05 18:51:33 -0800720SYSCALL_DEFINE3(mlock2, unsigned long, start, size_t, len, int, flags)
721{
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800722 vm_flags_t vm_flags = VM_LOCKED;
723
724 if (flags & ~MLOCK_ONFAULT)
Eric B Munsona8ca5d02015-11-05 18:51:33 -0800725 return -EINVAL;
726
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800727 if (flags & MLOCK_ONFAULT)
728 vm_flags |= VM_LOCKONFAULT;
729
730 return do_mlock(start, len, vm_flags);
Eric B Munsona8ca5d02015-11-05 18:51:33 -0800731}
732
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100733SYSCALL_DEFINE2(munlock, unsigned long, start, size_t, len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
735 int ret;
736
Alexander Kuleshov8fd9e482015-11-05 18:46:49 -0800737 len = PAGE_ALIGN(len + (offset_in_page(start)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 start &= PAGE_MASK;
Davidlohr Bueso1f1cd702014-01-21 15:49:16 -0800739
Michal Hockodc0ef0d2016-05-23 16:25:27 -0700740 if (down_write_killable(&current->mm->mmap_sem))
741 return -EINTR;
Eric B Munson1aab92e2015-11-05 18:51:29 -0800742 ret = apply_vma_lock_flags(start, len, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 up_write(&current->mm->mmap_sem);
Davidlohr Bueso1f1cd702014-01-21 15:49:16 -0800744
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 return ret;
746}
747
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800748/*
749 * Take the MCL_* flags passed into mlockall (or 0 if called from munlockall)
750 * and translate into the appropriate modifications to mm->def_flags and/or the
751 * flags for all current VMAs.
752 *
753 * There are a couple of subtleties with this. If mlockall() is called multiple
754 * times with different flags, the values do not necessarily stack. If mlockall
755 * is called once including the MCL_FUTURE flag and then a second time without
756 * it, VM_LOCKED and VM_LOCKONFAULT will be cleared from mm->def_flags.
757 */
Eric B Munson1aab92e2015-11-05 18:51:29 -0800758static int apply_mlockall_flags(int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759{
760 struct vm_area_struct * vma, * prev = NULL;
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800761 vm_flags_t to_add = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800763 current->mm->def_flags &= VM_LOCKED_CLEAR_MASK;
764 if (flags & MCL_FUTURE) {
Michel Lespinasse09a9f1d2013-03-28 16:26:23 -0700765 current->mm->def_flags |= VM_LOCKED;
Eric B Munson1aab92e2015-11-05 18:51:29 -0800766
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800767 if (flags & MCL_ONFAULT)
768 current->mm->def_flags |= VM_LOCKONFAULT;
769
770 if (!(flags & MCL_CURRENT))
771 goto out;
772 }
773
774 if (flags & MCL_CURRENT) {
775 to_add |= VM_LOCKED;
776 if (flags & MCL_ONFAULT)
777 to_add |= VM_LOCKONFAULT;
778 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
780 for (vma = current->mm->mmap; vma ; vma = prev->vm_next) {
KOSAKI Motohiroca16d142011-05-26 19:16:19 +0900781 vm_flags_t newflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800783 newflags = vma->vm_flags & VM_LOCKED_CLEAR_MASK;
784 newflags |= to_add;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
786 /* Ignore errors */
787 mlock_fixup(vma, &prev, vma->vm_start, vma->vm_end, newflags);
Paul E. McKenneybde6c3a2014-07-01 11:26:57 -0700788 cond_resched_rcu_qs();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 }
790out:
791 return 0;
792}
793
Heiko Carstens3480b252009-01-14 14:14:16 +0100794SYSCALL_DEFINE1(mlockall, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795{
796 unsigned long lock_limit;
Alexey Klimov86d2adc2015-11-05 18:46:00 -0800797 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Eric B Munsonb0f205c2015-11-05 18:51:39 -0800799 if (!flags || (flags & ~(MCL_CURRENT | MCL_FUTURE | MCL_ONFAULT)))
Alexey Klimov86d2adc2015-11-05 18:46:00 -0800800 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 if (!can_do_mlock())
Alexey Klimov86d2adc2015-11-05 18:46:00 -0800803 return -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Christoph Lameterdf9d6982011-10-31 17:09:35 -0700805 if (flags & MCL_CURRENT)
806 lru_add_drain_all(); /* flush pagevec */
KOSAKI Motohiro8891d6d2008-11-12 13:26:53 -0800807
Jiri Slaby59e99e52010-03-05 13:41:44 -0800808 lock_limit = rlimit(RLIMIT_MEMLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 lock_limit >>= PAGE_SHIFT;
810
Michal Hockodc0ef0d2016-05-23 16:25:27 -0700811 if (down_write_killable(&current->mm->mmap_sem))
812 return -EINTR;
Davidlohr Bueso1f1cd702014-01-21 15:49:16 -0800813
Michal Hockodc0ef0d2016-05-23 16:25:27 -0700814 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 if (!(flags & MCL_CURRENT) || (current->mm->total_vm <= lock_limit) ||
816 capable(CAP_IPC_LOCK))
Eric B Munson1aab92e2015-11-05 18:51:29 -0800817 ret = apply_mlockall_flags(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 up_write(&current->mm->mmap_sem);
Michel Lespinassebebeb3d2013-02-22 16:32:37 -0800819 if (!ret && (flags & MCL_CURRENT))
820 mm_populate(0, TASK_SIZE);
Alexey Klimov86d2adc2015-11-05 18:46:00 -0800821
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 return ret;
823}
824
Heiko Carstens3480b252009-01-14 14:14:16 +0100825SYSCALL_DEFINE0(munlockall)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
827 int ret;
828
Michal Hockodc0ef0d2016-05-23 16:25:27 -0700829 if (down_write_killable(&current->mm->mmap_sem))
830 return -EINTR;
Eric B Munson1aab92e2015-11-05 18:51:29 -0800831 ret = apply_mlockall_flags(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 up_write(&current->mm->mmap_sem);
833 return ret;
834}
835
836/*
837 * Objects with different lifetime than processes (SHM_LOCK and SHM_HUGETLB
838 * shm segments) get accounted against the user_struct instead.
839 */
840static DEFINE_SPINLOCK(shmlock_user_lock);
841
842int user_shm_lock(size_t size, struct user_struct *user)
843{
844 unsigned long lock_limit, locked;
845 int allowed = 0;
846
847 locked = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
Jiri Slaby59e99e52010-03-05 13:41:44 -0800848 lock_limit = rlimit(RLIMIT_MEMLOCK);
Herbert van den Bergh5ed44a42007-07-15 23:38:25 -0700849 if (lock_limit == RLIM_INFINITY)
850 allowed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 lock_limit >>= PAGE_SHIFT;
852 spin_lock(&shmlock_user_lock);
Herbert van den Bergh5ed44a42007-07-15 23:38:25 -0700853 if (!allowed &&
854 locked + user->locked_shm > lock_limit && !capable(CAP_IPC_LOCK))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 goto out;
856 get_uid(user);
857 user->locked_shm += locked;
858 allowed = 1;
859out:
860 spin_unlock(&shmlock_user_lock);
861 return allowed;
862}
863
864void user_shm_unlock(size_t size, struct user_struct *user)
865{
866 spin_lock(&shmlock_user_lock);
867 user->locked_shm -= (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
868 spin_unlock(&shmlock_user_lock);
869 free_uid(user);
870}