Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * linux/mm/mlock.c
4 *
5 * (C) Copyright 1995 Linus Torvalds
6 * (C) Copyright 2002 Christoph Hellwig
7 */
8
9#include <linux/capability.h>
10#include <linux/mman.h>
11#include <linux/mm.h>
12#include <linux/sched/user.h>
13#include <linux/swap.h>
14#include <linux/swapops.h>
15#include <linux/pagemap.h>
16#include <linux/pagevec.h>
17#include <linux/mempolicy.h>
18#include <linux/syscalls.h>
19#include <linux/sched.h>
20#include <linux/export.h>
21#include <linux/rmap.h>
22#include <linux/mmzone.h>
23#include <linux/hugetlb.h>
24#include <linux/memcontrol.h>
25#include <linux/mm_inline.h>
26
27#include "internal.h"
28
29bool can_do_mlock(void)
30{
31 if (rlimit(RLIMIT_MEMLOCK) != 0)
32 return true;
33 if (capable(CAP_IPC_LOCK))
34 return true;
35 return false;
36}
37EXPORT_SYMBOL(can_do_mlock);
38
39/*
40 * Mlocked pages are marked with PageMlocked() flag for efficient testing
41 * in vmscan and, possibly, the fault path; and to support semi-accurate
42 * statistics.
43 *
44 * An mlocked page [PageMlocked(page)] is unevictable. As such, it will
45 * be placed on the LRU "unevictable" list, rather than the [in]active lists.
46 * The unevictable list is an LRU sibling list to the [in]active lists.
47 * PageUnevictable is set to indicate the unevictable state.
48 *
49 * When lazy mlocking via vmscan, it is important to ensure that the
50 * vma's VM_LOCKED status is not concurrently being modified, otherwise we
51 * may have mlocked a page that is being munlocked. So lazy mlock must take
52 * the mmap_sem for read, and verify that the vma really is locked
53 * (see mm/rmap.c).
54 */
55
56/*
57 * LRU accounting for clear_page_mlock()
58 */
59void clear_page_mlock(struct page *page)
60{
61 if (!TestClearPageMlocked(page))
62 return;
63
64 mod_zone_page_state(page_zone(page), NR_MLOCK,
65 -hpage_nr_pages(page));
66 count_vm_event(UNEVICTABLE_PGCLEARED);
67 /*
68 * The previous TestClearPageMlocked() corresponds to the smp_mb()
69 * in __pagevec_lru_add_fn().
70 *
71 * See __pagevec_lru_add_fn for more explanation.
72 */
73 if (!isolate_lru_page(page)) {
74 putback_lru_page(page);
75 } else {
76 /*
77 * We lost the race. the page already moved to evictable list.
78 */
79 if (PageUnevictable(page))
80 count_vm_event(UNEVICTABLE_PGSTRANDED);
81 }
82}
83
84/*
85 * Mark page as mlocked if not already.
86 * If page on LRU, isolate and putback to move to unevictable list.
87 */
88void mlock_vma_page(struct page *page)
89{
90 /* Serialize with page migration */
91 BUG_ON(!PageLocked(page));
92
93 VM_BUG_ON_PAGE(PageTail(page), page);
94 VM_BUG_ON_PAGE(PageCompound(page) && PageDoubleMap(page), page);
95
96 if (!TestSetPageMlocked(page)) {
97 mod_zone_page_state(page_zone(page), NR_MLOCK,
98 hpage_nr_pages(page));
99 count_vm_event(UNEVICTABLE_PGMLOCKED);
100 if (!isolate_lru_page(page))
101 putback_lru_page(page);
102 }
103}
104
105/*
106 * Isolate a page from LRU with optional get_page() pin.
107 * Assumes lru_lock already held and page already pinned.
108 */
109static bool __munlock_isolate_lru_page(struct page *page, bool getpage)
110{
111 if (PageLRU(page)) {
112 struct lruvec *lruvec;
113
114 lruvec = mem_cgroup_page_lruvec(page, page_pgdat(page));
115 if (getpage)
116 get_page(page);
117 ClearPageLRU(page);
118 del_page_from_lru_list(page, lruvec, page_lru(page));
119 return true;
120 }
121
122 return false;
123}
124
125/*
126 * Finish munlock after successful page isolation
127 *
128 * Page must be locked. This is a wrapper for try_to_munlock()
129 * and putback_lru_page() with munlock accounting.
130 */
131static void __munlock_isolated_page(struct page *page)
132{
133 /*
134 * Optimization: if the page was mapped just once, that's our mapping
135 * and we don't need to check all the other vmas.
136 */
137 if (page_mapcount(page) > 1)
138 try_to_munlock(page);
139
140 /* Did try_to_unlock() succeed or punt? */
141 if (!PageMlocked(page))
142 count_vm_event(UNEVICTABLE_PGMUNLOCKED);
143
144 putback_lru_page(page);
145}
146
147/*
148 * Accounting for page isolation fail during munlock
149 *
150 * Performs accounting when page isolation fails in munlock. There is nothing
151 * else to do because it means some other task has already removed the page
152 * from the LRU. putback_lru_page() will take care of removing the page from
153 * the unevictable list, if necessary. vmscan [page_referenced()] will move
154 * the page back to the unevictable list if some other vma has it mlocked.
155 */
156static void __munlock_isolation_failed(struct page *page)
157{
158 if (PageUnevictable(page))
159 __count_vm_event(UNEVICTABLE_PGSTRANDED);
160 else
161 __count_vm_event(UNEVICTABLE_PGMUNLOCKED);
162}
163
164/**
165 * munlock_vma_page - munlock a vma page
166 * @page: page to be unlocked, either a normal page or THP page head
167 *
168 * returns the size of the page as a page mask (0 for normal page,
169 * HPAGE_PMD_NR - 1 for THP head page)
170 *
171 * called from munlock()/munmap() path with page supposedly on the LRU.
172 * When we munlock a page, because the vma where we found the page is being
173 * munlock()ed or munmap()ed, we want to check whether other vmas hold the
174 * page locked so that we can leave it on the unevictable lru list and not
175 * bother vmscan with it. However, to walk the page's rmap list in
176 * try_to_munlock() we must isolate the page from the LRU. If some other
177 * task has removed the page from the LRU, we won't be able to do that.
178 * So we clear the PageMlocked as we might not get another chance. If we
179 * can't isolate the page, we leave it for putback_lru_page() and vmscan
180 * [page_referenced()/try_to_unmap()] to deal with.
181 */
182unsigned int munlock_vma_page(struct page *page)
183{
184 int nr_pages;
185 struct zone *zone = page_zone(page);
186
187 /* For try_to_munlock() and to serialize with page migration */
188 BUG_ON(!PageLocked(page));
189
190 VM_BUG_ON_PAGE(PageTail(page), page);
191
192 /*
193 * Serialize with any parallel __split_huge_page_refcount() which
194 * might otherwise copy PageMlocked to part of the tail pages before
195 * we clear it in the head page. It also stabilizes hpage_nr_pages().
196 */
197 spin_lock_irq(zone_lru_lock(zone));
198
199 if (!TestClearPageMlocked(page)) {
200 /* Potentially, PTE-mapped THP: do not skip the rest PTEs */
201 nr_pages = 1;
202 goto unlock_out;
203 }
204
205 nr_pages = hpage_nr_pages(page);
206 __mod_zone_page_state(zone, NR_MLOCK, -nr_pages);
207
208 if (__munlock_isolate_lru_page(page, true)) {
209 spin_unlock_irq(zone_lru_lock(zone));
210 __munlock_isolated_page(page);
211 goto out;
212 }
213 __munlock_isolation_failed(page);
214
215unlock_out:
216 spin_unlock_irq(zone_lru_lock(zone));
217
218out:
219 return nr_pages - 1;
220}
221
222/*
223 * convert get_user_pages() return value to posix mlock() error
224 */
225static int __mlock_posix_error_return(long retval)
226{
227 if (retval == -EFAULT)
228 retval = -ENOMEM;
229 else if (retval == -ENOMEM)
230 retval = -EAGAIN;
231 return retval;
232}
233
234/*
235 * Prepare page for fast batched LRU putback via putback_lru_evictable_pagevec()
236 *
237 * The fast path is available only for evictable pages with single mapping.
238 * Then we can bypass the per-cpu pvec and get better performance.
239 * when mapcount > 1 we need try_to_munlock() which can fail.
240 * when !page_evictable(), we need the full redo logic of putback_lru_page to
241 * avoid leaving evictable page in unevictable list.
242 *
243 * In case of success, @page is added to @pvec and @pgrescued is incremented
244 * in case that the page was previously unevictable. @page is also unlocked.
245 */
246static bool __putback_lru_fast_prepare(struct page *page, struct pagevec *pvec,
247 int *pgrescued)
248{
249 VM_BUG_ON_PAGE(PageLRU(page), page);
250 VM_BUG_ON_PAGE(!PageLocked(page), page);
251
252 if (page_mapcount(page) <= 1 && page_evictable(page)) {
253 pagevec_add(pvec, page);
254 if (TestClearPageUnevictable(page))
255 (*pgrescued)++;
256 unlock_page(page);
257 return true;
258 }
259
260 return false;
261}
262
263/*
264 * Putback multiple evictable pages to the LRU
265 *
266 * Batched putback of evictable pages that bypasses the per-cpu pvec. Some of
267 * the pages might have meanwhile become unevictable but that is OK.
268 */
269static void __putback_lru_fast(struct pagevec *pvec, int pgrescued)
270{
271 count_vm_events(UNEVICTABLE_PGMUNLOCKED, pagevec_count(pvec));
272 /*
273 *__pagevec_lru_add() calls release_pages() so we don't call
274 * put_page() explicitly
275 */
276 __pagevec_lru_add(pvec);
277 count_vm_events(UNEVICTABLE_PGRESCUED, pgrescued);
278}
279
280/*
281 * Munlock a batch of pages from the same zone
282 *
283 * The work is split to two main phases. First phase clears the Mlocked flag
284 * and attempts to isolate the pages, all under a single zone lru lock.
285 * The second phase finishes the munlock only for pages where isolation
286 * succeeded.
287 *
288 * Note that the pagevec may be modified during the process.
289 */
290static void __munlock_pagevec(struct pagevec *pvec, struct zone *zone)
291{
292 int i;
293 int nr = pagevec_count(pvec);
294 int delta_munlocked = -nr;
295 struct pagevec pvec_putback;
296 int pgrescued = 0;
297
298 pagevec_init(&pvec_putback);
299
300 /* Phase 1: page isolation */
301 spin_lock_irq(zone_lru_lock(zone));
302 for (i = 0; i < nr; i++) {
303 struct page *page = pvec->pages[i];
304
305 if (TestClearPageMlocked(page)) {
306 /*
307 * We already have pin from follow_page_mask()
308 * so we can spare the get_page() here.
309 */
310 if (__munlock_isolate_lru_page(page, false))
311 continue;
312 else
313 __munlock_isolation_failed(page);
314 } else {
315 delta_munlocked++;
316 }
317
318 /*
319 * We won't be munlocking this page in the next phase
320 * but we still need to release the follow_page_mask()
321 * pin. We cannot do it under lru_lock however. If it's
322 * the last pin, __page_cache_release() would deadlock.
323 */
324 pagevec_add(&pvec_putback, pvec->pages[i]);
325 pvec->pages[i] = NULL;
326 }
327 __mod_zone_page_state(zone, NR_MLOCK, delta_munlocked);
328 spin_unlock_irq(zone_lru_lock(zone));
329
330 /* Now we can release pins of pages that we are not munlocking */
331 pagevec_release(&pvec_putback);
332
333 /* Phase 2: page munlock */
334 for (i = 0; i < nr; i++) {
335 struct page *page = pvec->pages[i];
336
337 if (page) {
338 lock_page(page);
339 if (!__putback_lru_fast_prepare(page, &pvec_putback,
340 &pgrescued)) {
341 /*
342 * Slow path. We don't want to lose the last
343 * pin before unlock_page()
344 */
345 get_page(page); /* for putback_lru_page() */
346 __munlock_isolated_page(page);
347 unlock_page(page);
348 put_page(page); /* from follow_page_mask() */
349 }
350 }
351 }
352
353 /*
354 * Phase 3: page putback for pages that qualified for the fast path
355 * This will also call put_page() to return pin from follow_page_mask()
356 */
357 if (pagevec_count(&pvec_putback))
358 __putback_lru_fast(&pvec_putback, pgrescued);
359}
360
361/*
362 * Fill up pagevec for __munlock_pagevec using pte walk
363 *
364 * The function expects that the struct page corresponding to @start address is
365 * a non-TPH page already pinned and in the @pvec, and that it belongs to @zone.
366 *
367 * The rest of @pvec is filled by subsequent pages within the same pmd and same
368 * zone, as long as the pte's are present and vm_normal_page() succeeds. These
369 * pages also get pinned.
370 *
371 * Returns the address of the next page that should be scanned. This equals
372 * @start + PAGE_SIZE when no page could be added by the pte walk.
373 */
374static unsigned long __munlock_pagevec_fill(struct pagevec *pvec,
375 struct vm_area_struct *vma, struct zone *zone,
376 unsigned long start, unsigned long end)
377{
378 pte_t *pte;
379 spinlock_t *ptl;
380
381 /*
382 * Initialize pte walk starting at the already pinned page where we
383 * are sure that there is a pte, as it was pinned under the same
384 * mmap_sem write op.
385 */
386 pte = get_locked_pte(vma->vm_mm, start, &ptl);
387 /* Make sure we do not cross the page table boundary */
388 end = pgd_addr_end(start, end);
389 end = p4d_addr_end(start, end);
390 end = pud_addr_end(start, end);
391 end = pmd_addr_end(start, end);
392
393 /* The page next to the pinned page is the first we will try to get */
394 start += PAGE_SIZE;
395 while (start < end) {
396 struct page *page = NULL;
397 pte++;
398 if (pte_present(*pte))
399 page = vm_normal_page(vma, start, *pte);
400 /*
401 * Break if page could not be obtained or the page's node+zone does not
402 * match
403 */
404 if (!page || page_zone(page) != zone)
405 break;
406
407 /*
408 * Do not use pagevec for PTE-mapped THP,
409 * munlock_vma_pages_range() will handle them.
410 */
411 if (PageTransCompound(page))
412 break;
413
414 get_page(page);
415 /*
416 * Increase the address that will be returned *before* the
417 * eventual break due to pvec becoming full by adding the page
418 */
419 start += PAGE_SIZE;
420 if (pagevec_add(pvec, page) == 0)
421 break;
422 }
423 pte_unmap_unlock(pte, ptl);
424 return start;
425}
426
427/*
428 * munlock_vma_pages_range() - munlock all pages in the vma range.'
429 * @vma - vma containing range to be munlock()ed.
430 * @start - start address in @vma of the range
431 * @end - end of range in @vma.
432 *
433 * For mremap(), munmap() and exit().
434 *
435 * Called with @vma VM_LOCKED.
436 *
437 * Returns with VM_LOCKED cleared. Callers must be prepared to
438 * deal with this.
439 *
440 * We don't save and restore VM_LOCKED here because pages are
441 * still on lru. In unmap path, pages might be scanned by reclaim
442 * and re-mlocked by try_to_{munlock|unmap} before we unmap and
443 * free them. This will result in freeing mlocked pages.
444 */
445void munlock_vma_pages_range(struct vm_area_struct *vma,
446 unsigned long start, unsigned long end)
447{
448 vma->vm_flags &= VM_LOCKED_CLEAR_MASK;
449
450 while (start < end) {
451 struct page *page;
452 unsigned int page_mask = 0;
453 unsigned long page_increm;
454 struct pagevec pvec;
455 struct zone *zone;
456
457 pagevec_init(&pvec);
458 /*
459 * Although FOLL_DUMP is intended for get_dump_page(),
460 * it just so happens that its special treatment of the
461 * ZERO_PAGE (returning an error instead of doing get_page)
462 * suits munlock very well (and if somehow an abnormal page
463 * has sneaked into the range, we won't oops here: great).
464 */
465 page = follow_page(vma, start, FOLL_GET | FOLL_DUMP);
466
467 if (page && !IS_ERR(page)) {
468 if (PageTransTail(page)) {
469 VM_BUG_ON_PAGE(PageMlocked(page), page);
470 put_page(page); /* follow_page_mask() */
471 } else if (PageTransHuge(page)) {
472 lock_page(page);
473 /*
474 * Any THP page found by follow_page_mask() may
475 * have gotten split before reaching
476 * munlock_vma_page(), so we need to compute
477 * the page_mask here instead.
478 */
479 page_mask = munlock_vma_page(page);
480 unlock_page(page);
481 put_page(page); /* follow_page_mask() */
482 } else {
483 /*
484 * Non-huge pages are handled in batches via
485 * pagevec. The pin from follow_page_mask()
486 * prevents them from collapsing by THP.
487 */
488 pagevec_add(&pvec, page);
489 zone = page_zone(page);
490
491 /*
492 * Try to fill the rest of pagevec using fast
493 * pte walk. This will also update start to
494 * the next page to process. Then munlock the
495 * pagevec.
496 */
497 start = __munlock_pagevec_fill(&pvec, vma,
498 zone, start, end);
499 __munlock_pagevec(&pvec, zone);
500 goto next;
501 }
502 }
503 page_increm = 1 + page_mask;
504 start += page_increm * PAGE_SIZE;
505next:
506 cond_resched();
507 }
508}
509
510/*
511 * mlock_fixup - handle mlock[all]/munlock[all] requests.
512 *
513 * Filters out "special" vmas -- VM_LOCKED never gets set for these, and
514 * munlock is a no-op. However, for some special vmas, we go ahead and
515 * populate the ptes.
516 *
517 * For vmas that pass the filters, merge/split as appropriate.
518 */
519static int mlock_fixup(struct vm_area_struct *vma, struct vm_area_struct **prev,
520 unsigned long start, unsigned long end, vm_flags_t newflags)
521{
522 struct mm_struct *mm = vma->vm_mm;
523 pgoff_t pgoff;
524 int nr_pages;
525 int ret = 0;
526 int lock = !!(newflags & VM_LOCKED);
527 vm_flags_t old_flags = vma->vm_flags;
528
529 if (newflags == vma->vm_flags || (vma->vm_flags & VM_SPECIAL) ||
530 is_vm_hugetlb_page(vma) || vma == get_gate_vma(current->mm))
531 /* don't set VM_LOCKED or VM_LOCKONFAULT and don't count */
532 goto out;
533
534 pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
535 *prev = vma_merge(mm, *prev, start, end, newflags, vma->anon_vma,
536 vma->vm_file, pgoff, vma_policy(vma),
537 vma->vm_userfaultfd_ctx);
538 if (*prev) {
539 vma = *prev;
540 goto success;
541 }
542
543 if (start != vma->vm_start) {
544 ret = split_vma(mm, vma, start, 1);
545 if (ret)
546 goto out;
547 }
548
549 if (end != vma->vm_end) {
550 ret = split_vma(mm, vma, end, 0);
551 if (ret)
552 goto out;
553 }
554
555success:
556 /*
557 * Keep track of amount of locked VM.
558 */
559 nr_pages = (end - start) >> PAGE_SHIFT;
560 if (!lock)
561 nr_pages = -nr_pages;
562 else if (old_flags & VM_LOCKED)
563 nr_pages = 0;
564 mm->locked_vm += nr_pages;
565
566 /*
567 * vm_flags is protected by the mmap_sem held in write mode.
568 * It's okay if try_to_unmap_one unmaps a page just after we
569 * set VM_LOCKED, populate_vma_page_range will bring it back.
570 */
571
572 if (lock)
573 vma->vm_flags = newflags;
574 else
575 munlock_vma_pages_range(vma, start, end);
576
577out:
578 *prev = vma;
579 return ret;
580}
581
582static int apply_vma_lock_flags(unsigned long start, size_t len,
583 vm_flags_t flags)
584{
585 unsigned long nstart, end, tmp;
586 struct vm_area_struct * vma, * prev;
587 int error;
588
589 VM_BUG_ON(offset_in_page(start));
590 VM_BUG_ON(len != PAGE_ALIGN(len));
591 end = start + len;
592 if (end < start)
593 return -EINVAL;
594 if (end == start)
595 return 0;
596 vma = find_vma(current->mm, start);
597 if (!vma || vma->vm_start > start)
598 return -ENOMEM;
599
600 prev = vma->vm_prev;
601 if (start > vma->vm_start)
602 prev = vma;
603
604 for (nstart = start ; ; ) {
605 vm_flags_t newflags = vma->vm_flags & VM_LOCKED_CLEAR_MASK;
606
607 newflags |= flags;
608
609 /* Here we know that vma->vm_start <= nstart < vma->vm_end. */
610 tmp = vma->vm_end;
611 if (tmp > end)
612 tmp = end;
613 error = mlock_fixup(vma, &prev, nstart, tmp, newflags);
614 if (error)
615 break;
616 nstart = tmp;
617 if (nstart < prev->vm_end)
618 nstart = prev->vm_end;
619 if (nstart >= end)
620 break;
621
622 vma = prev->vm_next;
623 if (!vma || vma->vm_start != nstart) {
624 error = -ENOMEM;
625 break;
626 }
627 }
628 return error;
629}
630
631/*
632 * Go through vma areas and sum size of mlocked
633 * vma pages, as return value.
634 * Note deferred memory locking case(mlock2(,,MLOCK_ONFAULT)
635 * is also counted.
636 * Return value: previously mlocked page counts
637 */
638static int count_mm_mlocked_page_nr(struct mm_struct *mm,
639 unsigned long start, size_t len)
640{
641 struct vm_area_struct *vma;
642 int count = 0;
643
644 if (mm == NULL)
645 mm = current->mm;
646
647 vma = find_vma(mm, start);
648 if (vma == NULL)
649 vma = mm->mmap;
650
651 for (; vma ; vma = vma->vm_next) {
652 if (start >= vma->vm_end)
653 continue;
654 if (start + len <= vma->vm_start)
655 break;
656 if (vma->vm_flags & VM_LOCKED) {
657 if (start > vma->vm_start)
658 count -= (start - vma->vm_start);
659 if (start + len < vma->vm_end) {
660 count += start + len - vma->vm_start;
661 break;
662 }
663 count += vma->vm_end - vma->vm_start;
664 }
665 }
666
667 return count >> PAGE_SHIFT;
668}
669
670static __must_check int do_mlock(unsigned long start, size_t len, vm_flags_t flags)
671{
672 unsigned long locked;
673 unsigned long lock_limit;
674 int error = -ENOMEM;
675
676 if (!can_do_mlock())
677 return -EPERM;
678
679 len = PAGE_ALIGN(len + (offset_in_page(start)));
680 start &= PAGE_MASK;
681
682 lock_limit = rlimit(RLIMIT_MEMLOCK);
683 lock_limit >>= PAGE_SHIFT;
684 locked = len >> PAGE_SHIFT;
685
686 if (down_write_killable(¤t->mm->mmap_sem))
687 return -EINTR;
688
689 locked += current->mm->locked_vm;
690 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 }
700
701 /* check against resource limits */
702 if ((locked <= lock_limit) || capable(CAP_IPC_LOCK))
703 error = apply_vma_lock_flags(start, len, flags);
704
705 up_write(¤t->mm->mmap_sem);
706 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;
713}
714
715SYSCALL_DEFINE2(mlock, unsigned long, start, size_t, len)
716{
717 return do_mlock(start, len, VM_LOCKED);
718}
719
720SYSCALL_DEFINE3(mlock2, unsigned long, start, size_t, len, int, flags)
721{
722 vm_flags_t vm_flags = VM_LOCKED;
723
724 if (flags & ~MLOCK_ONFAULT)
725 return -EINVAL;
726
727 if (flags & MLOCK_ONFAULT)
728 vm_flags |= VM_LOCKONFAULT;
729
730 return do_mlock(start, len, vm_flags);
731}
732
733SYSCALL_DEFINE2(munlock, unsigned long, start, size_t, len)
734{
735 int ret;
736
737 len = PAGE_ALIGN(len + (offset_in_page(start)));
738 start &= PAGE_MASK;
739
740 if (down_write_killable(¤t->mm->mmap_sem))
741 return -EINTR;
742 ret = apply_vma_lock_flags(start, len, 0);
743 up_write(¤t->mm->mmap_sem);
744
745 return ret;
746}
747
748/*
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 */
758static int apply_mlockall_flags(int flags)
759{
760 struct vm_area_struct * vma, * prev = NULL;
761 vm_flags_t to_add = 0;
762
763 current->mm->def_flags &= VM_LOCKED_CLEAR_MASK;
764 if (flags & MCL_FUTURE) {
765 current->mm->def_flags |= VM_LOCKED;
766
767 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 }
779
780 for (vma = current->mm->mmap; vma ; vma = prev->vm_next) {
781 vm_flags_t newflags;
782
783 newflags = vma->vm_flags & VM_LOCKED_CLEAR_MASK;
784 newflags |= to_add;
785
786 /* Ignore errors */
787 mlock_fixup(vma, &prev, vma->vm_start, vma->vm_end, newflags);
788 cond_resched();
789 }
790out:
791 return 0;
792}
793
794SYSCALL_DEFINE1(mlockall, int, flags)
795{
796 unsigned long lock_limit;
797 int ret;
798
799 if (!flags || (flags & ~(MCL_CURRENT | MCL_FUTURE | MCL_ONFAULT)))
800 return -EINVAL;
801
802 if (!can_do_mlock())
803 return -EPERM;
804
805 lock_limit = rlimit(RLIMIT_MEMLOCK);
806 lock_limit >>= PAGE_SHIFT;
807
808 if (down_write_killable(¤t->mm->mmap_sem))
809 return -EINTR;
810
811 ret = -ENOMEM;
812 if (!(flags & MCL_CURRENT) || (current->mm->total_vm <= lock_limit) ||
813 capable(CAP_IPC_LOCK))
814 ret = apply_mlockall_flags(flags);
815 up_write(¤t->mm->mmap_sem);
816 if (!ret && (flags & MCL_CURRENT))
817 mm_populate(0, TASK_SIZE);
818
819 return ret;
820}
821
822SYSCALL_DEFINE0(munlockall)
823{
824 int ret;
825
826 if (down_write_killable(¤t->mm->mmap_sem))
827 return -EINTR;
828 ret = apply_mlockall_flags(0);
829 up_write(¤t->mm->mmap_sem);
830 return ret;
831}
832
833/*
834 * Objects with different lifetime than processes (SHM_LOCK and SHM_HUGETLB
835 * shm segments) get accounted against the user_struct instead.
836 */
837static DEFINE_SPINLOCK(shmlock_user_lock);
838
839int user_shm_lock(size_t size, struct user_struct *user)
840{
841 unsigned long lock_limit, locked;
842 int allowed = 0;
843
844 locked = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
845 lock_limit = rlimit(RLIMIT_MEMLOCK);
846 if (lock_limit == RLIM_INFINITY)
847 allowed = 1;
848 lock_limit >>= PAGE_SHIFT;
849 spin_lock(&shmlock_user_lock);
850 if (!allowed &&
851 locked + user->locked_shm > lock_limit && !capable(CAP_IPC_LOCK))
852 goto out;
853 get_uid(user);
854 user->locked_shm += locked;
855 allowed = 1;
856out:
857 spin_unlock(&shmlock_user_lock);
858 return allowed;
859}
860
861void user_shm_unlock(size_t size, struct user_struct *user)
862{
863 spin_lock(&shmlock_user_lock);
864 user->locked_shm -= (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
865 spin_unlock(&shmlock_user_lock);
866 free_uid(user);
867}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * linux/mm/mlock.c
4 *
5 * (C) Copyright 1995 Linus Torvalds
6 * (C) Copyright 2002 Christoph Hellwig
7 */
8
9#include <linux/capability.h>
10#include <linux/mman.h>
11#include <linux/mm.h>
12#include <linux/sched/user.h>
13#include <linux/swap.h>
14#include <linux/swapops.h>
15#include <linux/pagemap.h>
16#include <linux/pagevec.h>
17#include <linux/mempolicy.h>
18#include <linux/syscalls.h>
19#include <linux/sched.h>
20#include <linux/export.h>
21#include <linux/rmap.h>
22#include <linux/mmzone.h>
23#include <linux/hugetlb.h>
24#include <linux/memcontrol.h>
25#include <linux/mm_inline.h>
26#include <linux/secretmem.h>
27
28#include "internal.h"
29
30bool can_do_mlock(void)
31{
32 if (rlimit(RLIMIT_MEMLOCK) != 0)
33 return true;
34 if (capable(CAP_IPC_LOCK))
35 return true;
36 return false;
37}
38EXPORT_SYMBOL(can_do_mlock);
39
40/*
41 * Mlocked pages are marked with PageMlocked() flag for efficient testing
42 * in vmscan and, possibly, the fault path; and to support semi-accurate
43 * statistics.
44 *
45 * An mlocked page [PageMlocked(page)] is unevictable. As such, it will
46 * be placed on the LRU "unevictable" list, rather than the [in]active lists.
47 * The unevictable list is an LRU sibling list to the [in]active lists.
48 * PageUnevictable is set to indicate the unevictable state.
49 *
50 * When lazy mlocking via vmscan, it is important to ensure that the
51 * vma's VM_LOCKED status is not concurrently being modified, otherwise we
52 * may have mlocked a page that is being munlocked. So lazy mlock must take
53 * the mmap_lock for read, and verify that the vma really is locked
54 * (see mm/rmap.c).
55 */
56
57/*
58 * LRU accounting for clear_page_mlock()
59 */
60void clear_page_mlock(struct page *page)
61{
62 int nr_pages;
63
64 if (!TestClearPageMlocked(page))
65 return;
66
67 nr_pages = thp_nr_pages(page);
68 mod_zone_page_state(page_zone(page), NR_MLOCK, -nr_pages);
69 count_vm_events(UNEVICTABLE_PGCLEARED, nr_pages);
70 /*
71 * The previous TestClearPageMlocked() corresponds to the smp_mb()
72 * in __pagevec_lru_add_fn().
73 *
74 * See __pagevec_lru_add_fn for more explanation.
75 */
76 if (!isolate_lru_page(page)) {
77 putback_lru_page(page);
78 } else {
79 /*
80 * We lost the race. the page already moved to evictable list.
81 */
82 if (PageUnevictable(page))
83 count_vm_events(UNEVICTABLE_PGSTRANDED, nr_pages);
84 }
85}
86
87/*
88 * Mark page as mlocked if not already.
89 * If page on LRU, isolate and putback to move to unevictable list.
90 */
91void mlock_vma_page(struct page *page)
92{
93 /* Serialize with page migration */
94 BUG_ON(!PageLocked(page));
95
96 VM_BUG_ON_PAGE(PageTail(page), page);
97 VM_BUG_ON_PAGE(PageCompound(page) && PageDoubleMap(page), page);
98
99 if (!TestSetPageMlocked(page)) {
100 int nr_pages = thp_nr_pages(page);
101
102 mod_zone_page_state(page_zone(page), NR_MLOCK, nr_pages);
103 count_vm_events(UNEVICTABLE_PGMLOCKED, nr_pages);
104 if (!isolate_lru_page(page))
105 putback_lru_page(page);
106 }
107}
108
109/*
110 * Finish munlock after successful page isolation
111 *
112 * Page must be locked. This is a wrapper for page_mlock()
113 * and putback_lru_page() with munlock accounting.
114 */
115static void __munlock_isolated_page(struct page *page)
116{
117 /*
118 * Optimization: if the page was mapped just once, that's our mapping
119 * and we don't need to check all the other vmas.
120 */
121 if (page_mapcount(page) > 1)
122 page_mlock(page);
123
124 /* Did try_to_unlock() succeed or punt? */
125 if (!PageMlocked(page))
126 count_vm_events(UNEVICTABLE_PGMUNLOCKED, thp_nr_pages(page));
127
128 putback_lru_page(page);
129}
130
131/*
132 * Accounting for page isolation fail during munlock
133 *
134 * Performs accounting when page isolation fails in munlock. There is nothing
135 * else to do because it means some other task has already removed the page
136 * from the LRU. putback_lru_page() will take care of removing the page from
137 * the unevictable list, if necessary. vmscan [page_referenced()] will move
138 * the page back to the unevictable list if some other vma has it mlocked.
139 */
140static void __munlock_isolation_failed(struct page *page)
141{
142 int nr_pages = thp_nr_pages(page);
143
144 if (PageUnevictable(page))
145 __count_vm_events(UNEVICTABLE_PGSTRANDED, nr_pages);
146 else
147 __count_vm_events(UNEVICTABLE_PGMUNLOCKED, nr_pages);
148}
149
150/**
151 * munlock_vma_page - munlock a vma page
152 * @page: page to be unlocked, either a normal page or THP page head
153 *
154 * returns the size of the page as a page mask (0 for normal page,
155 * HPAGE_PMD_NR - 1 for THP head page)
156 *
157 * called from munlock()/munmap() path with page supposedly on the LRU.
158 * When we munlock a page, because the vma where we found the page is being
159 * munlock()ed or munmap()ed, we want to check whether other vmas hold the
160 * page locked so that we can leave it on the unevictable lru list and not
161 * bother vmscan with it. However, to walk the page's rmap list in
162 * page_mlock() we must isolate the page from the LRU. If some other
163 * task has removed the page from the LRU, we won't be able to do that.
164 * So we clear the PageMlocked as we might not get another chance. If we
165 * can't isolate the page, we leave it for putback_lru_page() and vmscan
166 * [page_referenced()/try_to_unmap()] to deal with.
167 */
168unsigned int munlock_vma_page(struct page *page)
169{
170 int nr_pages;
171
172 /* For page_mlock() and to serialize with page migration */
173 BUG_ON(!PageLocked(page));
174 VM_BUG_ON_PAGE(PageTail(page), page);
175
176 if (!TestClearPageMlocked(page)) {
177 /* Potentially, PTE-mapped THP: do not skip the rest PTEs */
178 return 0;
179 }
180
181 nr_pages = thp_nr_pages(page);
182 mod_zone_page_state(page_zone(page), NR_MLOCK, -nr_pages);
183
184 if (!isolate_lru_page(page))
185 __munlock_isolated_page(page);
186 else
187 __munlock_isolation_failed(page);
188
189 return nr_pages - 1;
190}
191
192/*
193 * convert get_user_pages() return value to posix mlock() error
194 */
195static int __mlock_posix_error_return(long retval)
196{
197 if (retval == -EFAULT)
198 retval = -ENOMEM;
199 else if (retval == -ENOMEM)
200 retval = -EAGAIN;
201 return retval;
202}
203
204/*
205 * Prepare page for fast batched LRU putback via putback_lru_evictable_pagevec()
206 *
207 * The fast path is available only for evictable pages with single mapping.
208 * Then we can bypass the per-cpu pvec and get better performance.
209 * when mapcount > 1 we need page_mlock() which can fail.
210 * when !page_evictable(), we need the full redo logic of putback_lru_page to
211 * avoid leaving evictable page in unevictable list.
212 *
213 * In case of success, @page is added to @pvec and @pgrescued is incremented
214 * in case that the page was previously unevictable. @page is also unlocked.
215 */
216static bool __putback_lru_fast_prepare(struct page *page, struct pagevec *pvec,
217 int *pgrescued)
218{
219 VM_BUG_ON_PAGE(PageLRU(page), page);
220 VM_BUG_ON_PAGE(!PageLocked(page), page);
221
222 if (page_mapcount(page) <= 1 && page_evictable(page)) {
223 pagevec_add(pvec, page);
224 if (TestClearPageUnevictable(page))
225 (*pgrescued)++;
226 unlock_page(page);
227 return true;
228 }
229
230 return false;
231}
232
233/*
234 * Putback multiple evictable pages to the LRU
235 *
236 * Batched putback of evictable pages that bypasses the per-cpu pvec. Some of
237 * the pages might have meanwhile become unevictable but that is OK.
238 */
239static void __putback_lru_fast(struct pagevec *pvec, int pgrescued)
240{
241 count_vm_events(UNEVICTABLE_PGMUNLOCKED, pagevec_count(pvec));
242 /*
243 *__pagevec_lru_add() calls release_pages() so we don't call
244 * put_page() explicitly
245 */
246 __pagevec_lru_add(pvec);
247 count_vm_events(UNEVICTABLE_PGRESCUED, pgrescued);
248}
249
250/*
251 * Munlock a batch of pages from the same zone
252 *
253 * The work is split to two main phases. First phase clears the Mlocked flag
254 * and attempts to isolate the pages, all under a single zone lru lock.
255 * The second phase finishes the munlock only for pages where isolation
256 * succeeded.
257 *
258 * Note that the pagevec may be modified during the process.
259 */
260static void __munlock_pagevec(struct pagevec *pvec, struct zone *zone)
261{
262 int i;
263 int nr = pagevec_count(pvec);
264 int delta_munlocked = -nr;
265 struct pagevec pvec_putback;
266 struct lruvec *lruvec = NULL;
267 int pgrescued = 0;
268
269 pagevec_init(&pvec_putback);
270
271 /* Phase 1: page isolation */
272 for (i = 0; i < nr; i++) {
273 struct page *page = pvec->pages[i];
274
275 if (TestClearPageMlocked(page)) {
276 /*
277 * We already have pin from follow_page_mask()
278 * so we can spare the get_page() here.
279 */
280 if (TestClearPageLRU(page)) {
281 lruvec = relock_page_lruvec_irq(page, lruvec);
282 del_page_from_lru_list(page, lruvec);
283 continue;
284 } else
285 __munlock_isolation_failed(page);
286 } else {
287 delta_munlocked++;
288 }
289
290 /*
291 * We won't be munlocking this page in the next phase
292 * but we still need to release the follow_page_mask()
293 * pin. We cannot do it under lru_lock however. If it's
294 * the last pin, __page_cache_release() would deadlock.
295 */
296 pagevec_add(&pvec_putback, pvec->pages[i]);
297 pvec->pages[i] = NULL;
298 }
299 if (lruvec) {
300 __mod_zone_page_state(zone, NR_MLOCK, delta_munlocked);
301 unlock_page_lruvec_irq(lruvec);
302 } else if (delta_munlocked) {
303 mod_zone_page_state(zone, NR_MLOCK, delta_munlocked);
304 }
305
306 /* Now we can release pins of pages that we are not munlocking */
307 pagevec_release(&pvec_putback);
308
309 /* Phase 2: page munlock */
310 for (i = 0; i < nr; i++) {
311 struct page *page = pvec->pages[i];
312
313 if (page) {
314 lock_page(page);
315 if (!__putback_lru_fast_prepare(page, &pvec_putback,
316 &pgrescued)) {
317 /*
318 * Slow path. We don't want to lose the last
319 * pin before unlock_page()
320 */
321 get_page(page); /* for putback_lru_page() */
322 __munlock_isolated_page(page);
323 unlock_page(page);
324 put_page(page); /* from follow_page_mask() */
325 }
326 }
327 }
328
329 /*
330 * Phase 3: page putback for pages that qualified for the fast path
331 * This will also call put_page() to return pin from follow_page_mask()
332 */
333 if (pagevec_count(&pvec_putback))
334 __putback_lru_fast(&pvec_putback, pgrescued);
335}
336
337/*
338 * Fill up pagevec for __munlock_pagevec using pte walk
339 *
340 * The function expects that the struct page corresponding to @start address is
341 * a non-TPH page already pinned and in the @pvec, and that it belongs to @zone.
342 *
343 * The rest of @pvec is filled by subsequent pages within the same pmd and same
344 * zone, as long as the pte's are present and vm_normal_page() succeeds. These
345 * pages also get pinned.
346 *
347 * Returns the address of the next page that should be scanned. This equals
348 * @start + PAGE_SIZE when no page could be added by the pte walk.
349 */
350static unsigned long __munlock_pagevec_fill(struct pagevec *pvec,
351 struct vm_area_struct *vma, struct zone *zone,
352 unsigned long start, unsigned long end)
353{
354 pte_t *pte;
355 spinlock_t *ptl;
356
357 /*
358 * Initialize pte walk starting at the already pinned page where we
359 * are sure that there is a pte, as it was pinned under the same
360 * mmap_lock write op.
361 */
362 pte = get_locked_pte(vma->vm_mm, start, &ptl);
363 /* Make sure we do not cross the page table boundary */
364 end = pgd_addr_end(start, end);
365 end = p4d_addr_end(start, end);
366 end = pud_addr_end(start, end);
367 end = pmd_addr_end(start, end);
368
369 /* The page next to the pinned page is the first we will try to get */
370 start += PAGE_SIZE;
371 while (start < end) {
372 struct page *page = NULL;
373 pte++;
374 if (pte_present(*pte))
375 page = vm_normal_page(vma, start, *pte);
376 /*
377 * Break if page could not be obtained or the page's node+zone does not
378 * match
379 */
380 if (!page || page_zone(page) != zone)
381 break;
382
383 /*
384 * Do not use pagevec for PTE-mapped THP,
385 * munlock_vma_pages_range() will handle them.
386 */
387 if (PageTransCompound(page))
388 break;
389
390 get_page(page);
391 /*
392 * Increase the address that will be returned *before* the
393 * eventual break due to pvec becoming full by adding the page
394 */
395 start += PAGE_SIZE;
396 if (pagevec_add(pvec, page) == 0)
397 break;
398 }
399 pte_unmap_unlock(pte, ptl);
400 return start;
401}
402
403/*
404 * munlock_vma_pages_range() - munlock all pages in the vma range.'
405 * @vma - vma containing range to be munlock()ed.
406 * @start - start address in @vma of the range
407 * @end - end of range in @vma.
408 *
409 * For mremap(), munmap() and exit().
410 *
411 * Called with @vma VM_LOCKED.
412 *
413 * Returns with VM_LOCKED cleared. Callers must be prepared to
414 * deal with this.
415 *
416 * We don't save and restore VM_LOCKED here because pages are
417 * still on lru. In unmap path, pages might be scanned by reclaim
418 * and re-mlocked by page_mlock/try_to_unmap before we unmap and
419 * free them. This will result in freeing mlocked pages.
420 */
421void munlock_vma_pages_range(struct vm_area_struct *vma,
422 unsigned long start, unsigned long end)
423{
424 vma->vm_flags &= VM_LOCKED_CLEAR_MASK;
425
426 while (start < end) {
427 struct page *page;
428 unsigned int page_mask = 0;
429 unsigned long page_increm;
430 struct pagevec pvec;
431 struct zone *zone;
432
433 pagevec_init(&pvec);
434 /*
435 * Although FOLL_DUMP is intended for get_dump_page(),
436 * it just so happens that its special treatment of the
437 * ZERO_PAGE (returning an error instead of doing get_page)
438 * suits munlock very well (and if somehow an abnormal page
439 * has sneaked into the range, we won't oops here: great).
440 */
441 page = follow_page(vma, start, FOLL_GET | FOLL_DUMP);
442
443 if (page && !IS_ERR(page)) {
444 if (PageTransTail(page)) {
445 VM_BUG_ON_PAGE(PageMlocked(page), page);
446 put_page(page); /* follow_page_mask() */
447 } else if (PageTransHuge(page)) {
448 lock_page(page);
449 /*
450 * Any THP page found by follow_page_mask() may
451 * have gotten split before reaching
452 * munlock_vma_page(), so we need to compute
453 * the page_mask here instead.
454 */
455 page_mask = munlock_vma_page(page);
456 unlock_page(page);
457 put_page(page); /* follow_page_mask() */
458 } else {
459 /*
460 * Non-huge pages are handled in batches via
461 * pagevec. The pin from follow_page_mask()
462 * prevents them from collapsing by THP.
463 */
464 pagevec_add(&pvec, page);
465 zone = page_zone(page);
466
467 /*
468 * Try to fill the rest of pagevec using fast
469 * pte walk. This will also update start to
470 * the next page to process. Then munlock the
471 * pagevec.
472 */
473 start = __munlock_pagevec_fill(&pvec, vma,
474 zone, start, end);
475 __munlock_pagevec(&pvec, zone);
476 goto next;
477 }
478 }
479 page_increm = 1 + page_mask;
480 start += page_increm * PAGE_SIZE;
481next:
482 cond_resched();
483 }
484}
485
486/*
487 * mlock_fixup - handle mlock[all]/munlock[all] requests.
488 *
489 * Filters out "special" vmas -- VM_LOCKED never gets set for these, and
490 * munlock is a no-op. However, for some special vmas, we go ahead and
491 * populate the ptes.
492 *
493 * For vmas that pass the filters, merge/split as appropriate.
494 */
495static int mlock_fixup(struct vm_area_struct *vma, struct vm_area_struct **prev,
496 unsigned long start, unsigned long end, vm_flags_t newflags)
497{
498 struct mm_struct *mm = vma->vm_mm;
499 pgoff_t pgoff;
500 int nr_pages;
501 int ret = 0;
502 int lock = !!(newflags & VM_LOCKED);
503 vm_flags_t old_flags = vma->vm_flags;
504
505 if (newflags == vma->vm_flags || (vma->vm_flags & VM_SPECIAL) ||
506 is_vm_hugetlb_page(vma) || vma == get_gate_vma(current->mm) ||
507 vma_is_dax(vma) || vma_is_secretmem(vma))
508 /* don't set VM_LOCKED or VM_LOCKONFAULT and don't count */
509 goto out;
510
511 pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
512 *prev = vma_merge(mm, *prev, start, end, newflags, vma->anon_vma,
513 vma->vm_file, pgoff, vma_policy(vma),
514 vma->vm_userfaultfd_ctx);
515 if (*prev) {
516 vma = *prev;
517 goto success;
518 }
519
520 if (start != vma->vm_start) {
521 ret = split_vma(mm, vma, start, 1);
522 if (ret)
523 goto out;
524 }
525
526 if (end != vma->vm_end) {
527 ret = split_vma(mm, vma, end, 0);
528 if (ret)
529 goto out;
530 }
531
532success:
533 /*
534 * Keep track of amount of locked VM.
535 */
536 nr_pages = (end - start) >> PAGE_SHIFT;
537 if (!lock)
538 nr_pages = -nr_pages;
539 else if (old_flags & VM_LOCKED)
540 nr_pages = 0;
541 mm->locked_vm += nr_pages;
542
543 /*
544 * vm_flags is protected by the mmap_lock held in write mode.
545 * It's okay if try_to_unmap_one unmaps a page just after we
546 * set VM_LOCKED, populate_vma_page_range will bring it back.
547 */
548
549 if (lock)
550 vma->vm_flags = newflags;
551 else
552 munlock_vma_pages_range(vma, start, end);
553
554out:
555 *prev = vma;
556 return ret;
557}
558
559static int apply_vma_lock_flags(unsigned long start, size_t len,
560 vm_flags_t flags)
561{
562 unsigned long nstart, end, tmp;
563 struct vm_area_struct *vma, *prev;
564 int error;
565
566 VM_BUG_ON(offset_in_page(start));
567 VM_BUG_ON(len != PAGE_ALIGN(len));
568 end = start + len;
569 if (end < start)
570 return -EINVAL;
571 if (end == start)
572 return 0;
573 vma = find_vma(current->mm, start);
574 if (!vma || vma->vm_start > start)
575 return -ENOMEM;
576
577 prev = vma->vm_prev;
578 if (start > vma->vm_start)
579 prev = vma;
580
581 for (nstart = start ; ; ) {
582 vm_flags_t newflags = vma->vm_flags & VM_LOCKED_CLEAR_MASK;
583
584 newflags |= flags;
585
586 /* Here we know that vma->vm_start <= nstart < vma->vm_end. */
587 tmp = vma->vm_end;
588 if (tmp > end)
589 tmp = end;
590 error = mlock_fixup(vma, &prev, nstart, tmp, newflags);
591 if (error)
592 break;
593 nstart = tmp;
594 if (nstart < prev->vm_end)
595 nstart = prev->vm_end;
596 if (nstart >= end)
597 break;
598
599 vma = prev->vm_next;
600 if (!vma || vma->vm_start != nstart) {
601 error = -ENOMEM;
602 break;
603 }
604 }
605 return error;
606}
607
608/*
609 * Go through vma areas and sum size of mlocked
610 * vma pages, as return value.
611 * Note deferred memory locking case(mlock2(,,MLOCK_ONFAULT)
612 * is also counted.
613 * Return value: previously mlocked page counts
614 */
615static unsigned long count_mm_mlocked_page_nr(struct mm_struct *mm,
616 unsigned long start, size_t len)
617{
618 struct vm_area_struct *vma;
619 unsigned long count = 0;
620
621 if (mm == NULL)
622 mm = current->mm;
623
624 vma = find_vma(mm, start);
625 if (vma == NULL)
626 return 0;
627
628 for (; vma ; vma = vma->vm_next) {
629 if (start >= vma->vm_end)
630 continue;
631 if (start + len <= vma->vm_start)
632 break;
633 if (vma->vm_flags & VM_LOCKED) {
634 if (start > vma->vm_start)
635 count -= (start - vma->vm_start);
636 if (start + len < vma->vm_end) {
637 count += start + len - vma->vm_start;
638 break;
639 }
640 count += vma->vm_end - vma->vm_start;
641 }
642 }
643
644 return count >> PAGE_SHIFT;
645}
646
647static __must_check int do_mlock(unsigned long start, size_t len, vm_flags_t flags)
648{
649 unsigned long locked;
650 unsigned long lock_limit;
651 int error = -ENOMEM;
652
653 start = untagged_addr(start);
654
655 if (!can_do_mlock())
656 return -EPERM;
657
658 len = PAGE_ALIGN(len + (offset_in_page(start)));
659 start &= PAGE_MASK;
660
661 lock_limit = rlimit(RLIMIT_MEMLOCK);
662 lock_limit >>= PAGE_SHIFT;
663 locked = len >> PAGE_SHIFT;
664
665 if (mmap_write_lock_killable(current->mm))
666 return -EINTR;
667
668 locked += current->mm->locked_vm;
669 if ((locked > lock_limit) && (!capable(CAP_IPC_LOCK))) {
670 /*
671 * It is possible that the regions requested intersect with
672 * previously mlocked areas, that part area in "mm->locked_vm"
673 * should not be counted to new mlock increment count. So check
674 * and adjust locked count if necessary.
675 */
676 locked -= count_mm_mlocked_page_nr(current->mm,
677 start, len);
678 }
679
680 /* check against resource limits */
681 if ((locked <= lock_limit) || capable(CAP_IPC_LOCK))
682 error = apply_vma_lock_flags(start, len, flags);
683
684 mmap_write_unlock(current->mm);
685 if (error)
686 return error;
687
688 error = __mm_populate(start, len, 0);
689 if (error)
690 return __mlock_posix_error_return(error);
691 return 0;
692}
693
694SYSCALL_DEFINE2(mlock, unsigned long, start, size_t, len)
695{
696 return do_mlock(start, len, VM_LOCKED);
697}
698
699SYSCALL_DEFINE3(mlock2, unsigned long, start, size_t, len, int, flags)
700{
701 vm_flags_t vm_flags = VM_LOCKED;
702
703 if (flags & ~MLOCK_ONFAULT)
704 return -EINVAL;
705
706 if (flags & MLOCK_ONFAULT)
707 vm_flags |= VM_LOCKONFAULT;
708
709 return do_mlock(start, len, vm_flags);
710}
711
712SYSCALL_DEFINE2(munlock, unsigned long, start, size_t, len)
713{
714 int ret;
715
716 start = untagged_addr(start);
717
718 len = PAGE_ALIGN(len + (offset_in_page(start)));
719 start &= PAGE_MASK;
720
721 if (mmap_write_lock_killable(current->mm))
722 return -EINTR;
723 ret = apply_vma_lock_flags(start, len, 0);
724 mmap_write_unlock(current->mm);
725
726 return ret;
727}
728
729/*
730 * Take the MCL_* flags passed into mlockall (or 0 if called from munlockall)
731 * and translate into the appropriate modifications to mm->def_flags and/or the
732 * flags for all current VMAs.
733 *
734 * There are a couple of subtleties with this. If mlockall() is called multiple
735 * times with different flags, the values do not necessarily stack. If mlockall
736 * is called once including the MCL_FUTURE flag and then a second time without
737 * it, VM_LOCKED and VM_LOCKONFAULT will be cleared from mm->def_flags.
738 */
739static int apply_mlockall_flags(int flags)
740{
741 struct vm_area_struct *vma, *prev = NULL;
742 vm_flags_t to_add = 0;
743
744 current->mm->def_flags &= VM_LOCKED_CLEAR_MASK;
745 if (flags & MCL_FUTURE) {
746 current->mm->def_flags |= VM_LOCKED;
747
748 if (flags & MCL_ONFAULT)
749 current->mm->def_flags |= VM_LOCKONFAULT;
750
751 if (!(flags & MCL_CURRENT))
752 goto out;
753 }
754
755 if (flags & MCL_CURRENT) {
756 to_add |= VM_LOCKED;
757 if (flags & MCL_ONFAULT)
758 to_add |= VM_LOCKONFAULT;
759 }
760
761 for (vma = current->mm->mmap; vma ; vma = prev->vm_next) {
762 vm_flags_t newflags;
763
764 newflags = vma->vm_flags & VM_LOCKED_CLEAR_MASK;
765 newflags |= to_add;
766
767 /* Ignore errors */
768 mlock_fixup(vma, &prev, vma->vm_start, vma->vm_end, newflags);
769 cond_resched();
770 }
771out:
772 return 0;
773}
774
775SYSCALL_DEFINE1(mlockall, int, flags)
776{
777 unsigned long lock_limit;
778 int ret;
779
780 if (!flags || (flags & ~(MCL_CURRENT | MCL_FUTURE | MCL_ONFAULT)) ||
781 flags == MCL_ONFAULT)
782 return -EINVAL;
783
784 if (!can_do_mlock())
785 return -EPERM;
786
787 lock_limit = rlimit(RLIMIT_MEMLOCK);
788 lock_limit >>= PAGE_SHIFT;
789
790 if (mmap_write_lock_killable(current->mm))
791 return -EINTR;
792
793 ret = -ENOMEM;
794 if (!(flags & MCL_CURRENT) || (current->mm->total_vm <= lock_limit) ||
795 capable(CAP_IPC_LOCK))
796 ret = apply_mlockall_flags(flags);
797 mmap_write_unlock(current->mm);
798 if (!ret && (flags & MCL_CURRENT))
799 mm_populate(0, TASK_SIZE);
800
801 return ret;
802}
803
804SYSCALL_DEFINE0(munlockall)
805{
806 int ret;
807
808 if (mmap_write_lock_killable(current->mm))
809 return -EINTR;
810 ret = apply_mlockall_flags(0);
811 mmap_write_unlock(current->mm);
812 return ret;
813}
814
815/*
816 * Objects with different lifetime than processes (SHM_LOCK and SHM_HUGETLB
817 * shm segments) get accounted against the user_struct instead.
818 */
819static DEFINE_SPINLOCK(shmlock_user_lock);
820
821int user_shm_lock(size_t size, struct ucounts *ucounts)
822{
823 unsigned long lock_limit, locked;
824 long memlock;
825 int allowed = 0;
826
827 locked = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
828 lock_limit = rlimit(RLIMIT_MEMLOCK);
829 if (lock_limit == RLIM_INFINITY)
830 allowed = 1;
831 lock_limit >>= PAGE_SHIFT;
832 spin_lock(&shmlock_user_lock);
833 memlock = inc_rlimit_ucounts(ucounts, UCOUNT_RLIMIT_MEMLOCK, locked);
834
835 if (!allowed && (memlock == LONG_MAX || memlock > lock_limit) && !capable(CAP_IPC_LOCK)) {
836 dec_rlimit_ucounts(ucounts, UCOUNT_RLIMIT_MEMLOCK, locked);
837 goto out;
838 }
839 if (!get_ucounts(ucounts)) {
840 dec_rlimit_ucounts(ucounts, UCOUNT_RLIMIT_MEMLOCK, locked);
841 goto out;
842 }
843 allowed = 1;
844out:
845 spin_unlock(&shmlock_user_lock);
846 return allowed;
847}
848
849void user_shm_unlock(size_t size, struct ucounts *ucounts)
850{
851 spin_lock(&shmlock_user_lock);
852 dec_rlimit_ucounts(ucounts, UCOUNT_RLIMIT_MEMLOCK, (size + PAGE_SIZE - 1) >> PAGE_SHIFT);
853 spin_unlock(&shmlock_user_lock);
854 put_ucounts(ucounts);
855}