mlock: avoid dirtying pages and triggering writeback
[linux-2.6.git] / mm / mlock.c
1 /*
2  *      linux/mm/mlock.c
3  *
4  *  (C) Copyright 1995 Linus Torvalds
5  *  (C) Copyright 2002 Christoph Hellwig
6  */
7
8 #include <linux/capability.h>
9 #include <linux/mman.h>
10 #include <linux/mm.h>
11 #include <linux/swap.h>
12 #include <linux/swapops.h>
13 #include <linux/pagemap.h>
14 #include <linux/mempolicy.h>
15 #include <linux/syscalls.h>
16 #include <linux/sched.h>
17 #include <linux/module.h>
18 #include <linux/rmap.h>
19 #include <linux/mmzone.h>
20 #include <linux/hugetlb.h>
21
22 #include "internal.h"
23
24 int can_do_mlock(void)
25 {
26         if (capable(CAP_IPC_LOCK))
27                 return 1;
28         if (rlimit(RLIMIT_MEMLOCK) != 0)
29                 return 1;
30         return 0;
31 }
32 EXPORT_SYMBOL(can_do_mlock);
33
34 /*
35  * Mlocked pages are marked with PageMlocked() flag for efficient testing
36  * in vmscan and, possibly, the fault path; and to support semi-accurate
37  * statistics.
38  *
39  * An mlocked page [PageMlocked(page)] is unevictable.  As such, it will
40  * be placed on the LRU "unevictable" list, rather than the [in]active lists.
41  * The unevictable list is an LRU sibling list to the [in]active lists.
42  * PageUnevictable is set to indicate the unevictable state.
43  *
44  * When lazy mlocking via vmscan, it is important to ensure that the
45  * vma's VM_LOCKED status is not concurrently being modified, otherwise we
46  * may have mlocked a page that is being munlocked. So lazy mlock must take
47  * the mmap_sem for read, and verify that the vma really is locked
48  * (see mm/rmap.c).
49  */
50
51 /*
52  *  LRU accounting for clear_page_mlock()
53  */
54 void __clear_page_mlock(struct page *page)
55 {
56         VM_BUG_ON(!PageLocked(page));
57
58         if (!page->mapping) {   /* truncated ? */
59                 return;
60         }
61
62         dec_zone_page_state(page, NR_MLOCK);
63         count_vm_event(UNEVICTABLE_PGCLEARED);
64         if (!isolate_lru_page(page)) {
65                 putback_lru_page(page);
66         } else {
67                 /*
68                  * We lost the race. the page already moved to evictable list.
69                  */
70                 if (PageUnevictable(page))
71                         count_vm_event(UNEVICTABLE_PGSTRANDED);
72         }
73 }
74
75 /*
76  * Mark page as mlocked if not already.
77  * If page on LRU, isolate and putback to move to unevictable list.
78  */
79 void mlock_vma_page(struct page *page)
80 {
81         BUG_ON(!PageLocked(page));
82
83         if (!TestSetPageMlocked(page)) {
84                 inc_zone_page_state(page, NR_MLOCK);
85                 count_vm_event(UNEVICTABLE_PGMLOCKED);
86                 if (!isolate_lru_page(page))
87                         putback_lru_page(page);
88         }
89 }
90
91 /**
92  * munlock_vma_page - munlock a vma page
93  * @page - page to be unlocked
94  *
95  * called from munlock()/munmap() path with page supposedly on the LRU.
96  * When we munlock a page, because the vma where we found the page is being
97  * munlock()ed or munmap()ed, we want to check whether other vmas hold the
98  * page locked so that we can leave it on the unevictable lru list and not
99  * bother vmscan with it.  However, to walk the page's rmap list in
100  * try_to_munlock() we must isolate the page from the LRU.  If some other
101  * task has removed the page from the LRU, we won't be able to do that.
102  * So we clear the PageMlocked as we might not get another chance.  If we
103  * can't isolate the page, we leave it for putback_lru_page() and vmscan
104  * [page_referenced()/try_to_unmap()] to deal with.
105  */
106 void munlock_vma_page(struct page *page)
107 {
108         BUG_ON(!PageLocked(page));
109
110         if (TestClearPageMlocked(page)) {
111                 dec_zone_page_state(page, NR_MLOCK);
112                 if (!isolate_lru_page(page)) {
113                         int ret = try_to_munlock(page);
114                         /*
115                          * did try_to_unlock() succeed or punt?
116                          */
117                         if (ret != SWAP_MLOCK)
118                                 count_vm_event(UNEVICTABLE_PGMUNLOCKED);
119
120                         putback_lru_page(page);
121                 } else {
122                         /*
123                          * Some other task has removed the page from the LRU.
124                          * putback_lru_page() will take care of removing the
125                          * page from the unevictable list, if necessary.
126                          * vmscan [page_referenced()] will move the page back
127                          * to the unevictable list if some other vma has it
128                          * mlocked.
129                          */
130                         if (PageUnevictable(page))
131                                 count_vm_event(UNEVICTABLE_PGSTRANDED);
132                         else
133                                 count_vm_event(UNEVICTABLE_PGMUNLOCKED);
134                 }
135         }
136 }
137
138 static inline int stack_guard_page(struct vm_area_struct *vma, unsigned long addr)
139 {
140         return (vma->vm_flags & VM_GROWSDOWN) &&
141                 (vma->vm_start == addr) &&
142                 !vma_stack_continue(vma->vm_prev, addr);
143 }
144
145 /**
146  * __mlock_vma_pages_range() -  mlock a range of pages in the vma.
147  * @vma:   target vma
148  * @start: start address
149  * @end:   end address
150  *
151  * This takes care of making the pages present too.
152  *
153  * return 0 on success, negative error code on error.
154  *
155  * vma->vm_mm->mmap_sem must be held for at least read.
156  */
157 static long __mlock_vma_pages_range(struct vm_area_struct *vma,
158                                     unsigned long start, unsigned long end)
159 {
160         struct mm_struct *mm = vma->vm_mm;
161         unsigned long addr = start;
162         struct page *pages[16]; /* 16 gives a reasonable batch */
163         int nr_pages = (end - start) / PAGE_SIZE;
164         int ret = 0;
165         int gup_flags;
166
167         VM_BUG_ON(start & ~PAGE_MASK);
168         VM_BUG_ON(end   & ~PAGE_MASK);
169         VM_BUG_ON(start < vma->vm_start);
170         VM_BUG_ON(end   > vma->vm_end);
171         VM_BUG_ON(!rwsem_is_locked(&mm->mmap_sem));
172
173         gup_flags = FOLL_TOUCH | FOLL_GET;
174         /*
175          * We want to touch writable mappings with a write fault in order
176          * to break COW, except for shared mappings because these don't COW
177          * and we would not want to dirty them for nothing.
178          */
179         if ((vma->vm_flags & (VM_WRITE | VM_SHARED)) == VM_WRITE)
180                 gup_flags |= FOLL_WRITE;
181
182         /* We don't try to access the guard page of a stack vma */
183         if (stack_guard_page(vma, start)) {
184                 addr += PAGE_SIZE;
185                 nr_pages--;
186         }
187
188         while (nr_pages > 0) {
189                 int i;
190
191                 cond_resched();
192
193                 /*
194                  * get_user_pages makes pages present if we are
195                  * setting mlock. and this extra reference count will
196                  * disable migration of this page.  However, page may
197                  * still be truncated out from under us.
198                  */
199                 ret = __get_user_pages(current, mm, addr,
200                                 min_t(int, nr_pages, ARRAY_SIZE(pages)),
201                                 gup_flags, pages, NULL);
202                 /*
203                  * This can happen for, e.g., VM_NONLINEAR regions before
204                  * a page has been allocated and mapped at a given offset,
205                  * or for addresses that map beyond end of a file.
206                  * We'll mlock the pages if/when they get faulted in.
207                  */
208                 if (ret < 0)
209                         break;
210
211                 lru_add_drain();        /* push cached pages to LRU */
212
213                 for (i = 0; i < ret; i++) {
214                         struct page *page = pages[i];
215
216                         if (page->mapping) {
217                                 /*
218                                  * That preliminary check is mainly to avoid
219                                  * the pointless overhead of lock_page on the
220                                  * ZERO_PAGE: which might bounce very badly if
221                                  * there is contention.  However, we're still
222                                  * dirtying its cacheline with get/put_page:
223                                  * we'll add another __get_user_pages flag to
224                                  * avoid it if that case turns out to matter.
225                                  */
226                                 lock_page(page);
227                                 /*
228                                  * Because we lock page here and migration is
229                                  * blocked by the elevated reference, we need
230                                  * only check for file-cache page truncation.
231                                  */
232                                 if (page->mapping)
233                                         mlock_vma_page(page);
234                                 unlock_page(page);
235                         }
236                         put_page(page); /* ref from get_user_pages() */
237                 }
238
239                 addr += ret * PAGE_SIZE;
240                 nr_pages -= ret;
241                 ret = 0;
242         }
243
244         return ret;     /* 0 or negative error code */
245 }
246
247 /*
248  * convert get_user_pages() return value to posix mlock() error
249  */
250 static int __mlock_posix_error_return(long retval)
251 {
252         if (retval == -EFAULT)
253                 retval = -ENOMEM;
254         else if (retval == -ENOMEM)
255                 retval = -EAGAIN;
256         return retval;
257 }
258
259 /**
260  * mlock_vma_pages_range() - mlock pages in specified vma range.
261  * @vma - the vma containing the specfied address range
262  * @start - starting address in @vma to mlock
263  * @end   - end address [+1] in @vma to mlock
264  *
265  * For mmap()/mremap()/expansion of mlocked vma.
266  *
267  * return 0 on success for "normal" vmas.
268  *
269  * return number of pages [> 0] to be removed from locked_vm on success
270  * of "special" vmas.
271  */
272 long mlock_vma_pages_range(struct vm_area_struct *vma,
273                         unsigned long start, unsigned long end)
274 {
275         int nr_pages = (end - start) / PAGE_SIZE;
276         BUG_ON(!(vma->vm_flags & VM_LOCKED));
277
278         /*
279          * filter unlockable vmas
280          */
281         if (vma->vm_flags & (VM_IO | VM_PFNMAP))
282                 goto no_mlock;
283
284         if (!((vma->vm_flags & (VM_DONTEXPAND | VM_RESERVED)) ||
285                         is_vm_hugetlb_page(vma) ||
286                         vma == get_gate_vma(current))) {
287
288                 __mlock_vma_pages_range(vma, start, end);
289
290                 /* Hide errors from mmap() and other callers */
291                 return 0;
292         }
293
294         /*
295          * User mapped kernel pages or huge pages:
296          * make these pages present to populate the ptes, but
297          * fall thru' to reset VM_LOCKED--no need to unlock, and
298          * return nr_pages so these don't get counted against task's
299          * locked limit.  huge pages are already counted against
300          * locked vm limit.
301          */
302         make_pages_present(start, end);
303
304 no_mlock:
305         vma->vm_flags &= ~VM_LOCKED;    /* and don't come back! */
306         return nr_pages;                /* error or pages NOT mlocked */
307 }
308
309 /*
310  * munlock_vma_pages_range() - munlock all pages in the vma range.'
311  * @vma - vma containing range to be munlock()ed.
312  * @start - start address in @vma of the range
313  * @end - end of range in @vma.
314  *
315  *  For mremap(), munmap() and exit().
316  *
317  * Called with @vma VM_LOCKED.
318  *
319  * Returns with VM_LOCKED cleared.  Callers must be prepared to
320  * deal with this.
321  *
322  * We don't save and restore VM_LOCKED here because pages are
323  * still on lru.  In unmap path, pages might be scanned by reclaim
324  * and re-mlocked by try_to_{munlock|unmap} before we unmap and
325  * free them.  This will result in freeing mlocked pages.
326  */
327 void munlock_vma_pages_range(struct vm_area_struct *vma,
328                              unsigned long start, unsigned long end)
329 {
330         unsigned long addr;
331
332         lru_add_drain();
333         vma->vm_flags &= ~VM_LOCKED;
334
335         for (addr = start; addr < end; addr += PAGE_SIZE) {
336                 struct page *page;
337                 /*
338                  * Although FOLL_DUMP is intended for get_dump_page(),
339                  * it just so happens that its special treatment of the
340                  * ZERO_PAGE (returning an error instead of doing get_page)
341                  * suits munlock very well (and if somehow an abnormal page
342                  * has sneaked into the range, we won't oops here: great).
343                  */
344                 page = follow_page(vma, addr, FOLL_GET | FOLL_DUMP);
345                 if (page && !IS_ERR(page)) {
346                         lock_page(page);
347                         /*
348                          * Like in __mlock_vma_pages_range(),
349                          * because we lock page here and migration is
350                          * blocked by the elevated reference, we need
351                          * only check for file-cache page truncation.
352                          */
353                         if (page->mapping)
354                                 munlock_vma_page(page);
355                         unlock_page(page);
356                         put_page(page);
357                 }
358                 cond_resched();
359         }
360 }
361
362 /*
363  * mlock_fixup  - handle mlock[all]/munlock[all] requests.
364  *
365  * Filters out "special" vmas -- VM_LOCKED never gets set for these, and
366  * munlock is a no-op.  However, for some special vmas, we go ahead and
367  * populate the ptes via make_pages_present().
368  *
369  * For vmas that pass the filters, merge/split as appropriate.
370  */
371 static int mlock_fixup(struct vm_area_struct *vma, struct vm_area_struct **prev,
372         unsigned long start, unsigned long end, unsigned int newflags)
373 {
374         struct mm_struct *mm = vma->vm_mm;
375         pgoff_t pgoff;
376         int nr_pages;
377         int ret = 0;
378         int lock = newflags & VM_LOCKED;
379
380         if (newflags == vma->vm_flags ||
381                         (vma->vm_flags & (VM_IO | VM_PFNMAP)))
382                 goto out;       /* don't set VM_LOCKED,  don't count */
383
384         if ((vma->vm_flags & (VM_DONTEXPAND | VM_RESERVED)) ||
385                         is_vm_hugetlb_page(vma) ||
386                         vma == get_gate_vma(current)) {
387                 if (lock)
388                         make_pages_present(start, end);
389                 goto out;       /* don't set VM_LOCKED,  don't count */
390         }
391
392         pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
393         *prev = vma_merge(mm, *prev, start, end, newflags, vma->anon_vma,
394                           vma->vm_file, pgoff, vma_policy(vma));
395         if (*prev) {
396                 vma = *prev;
397                 goto success;
398         }
399
400         if (start != vma->vm_start) {
401                 ret = split_vma(mm, vma, start, 1);
402                 if (ret)
403                         goto out;
404         }
405
406         if (end != vma->vm_end) {
407                 ret = split_vma(mm, vma, end, 0);
408                 if (ret)
409                         goto out;
410         }
411
412 success:
413         /*
414          * Keep track of amount of locked VM.
415          */
416         nr_pages = (end - start) >> PAGE_SHIFT;
417         if (!lock)
418                 nr_pages = -nr_pages;
419         mm->locked_vm += nr_pages;
420
421         /*
422          * vm_flags is protected by the mmap_sem held in write mode.
423          * It's okay if try_to_unmap_one unmaps a page just after we
424          * set VM_LOCKED, __mlock_vma_pages_range will bring it back.
425          */
426
427         if (lock) {
428                 vma->vm_flags = newflags;
429                 ret = __mlock_vma_pages_range(vma, start, end);
430                 if (ret < 0)
431                         ret = __mlock_posix_error_return(ret);
432         } else {
433                 munlock_vma_pages_range(vma, start, end);
434         }
435
436 out:
437         *prev = vma;
438         return ret;
439 }
440
441 static int do_mlock(unsigned long start, size_t len, int on)
442 {
443         unsigned long nstart, end, tmp;
444         struct vm_area_struct * vma, * prev;
445         int error;
446
447         len = PAGE_ALIGN(len);
448         end = start + len;
449         if (end < start)
450                 return -EINVAL;
451         if (end == start)
452                 return 0;
453         vma = find_vma_prev(current->mm, start, &prev);
454         if (!vma || vma->vm_start > start)
455                 return -ENOMEM;
456
457         if (start > vma->vm_start)
458                 prev = vma;
459
460         for (nstart = start ; ; ) {
461                 unsigned int newflags;
462
463                 /* Here we know that  vma->vm_start <= nstart < vma->vm_end. */
464
465                 newflags = vma->vm_flags | VM_LOCKED;
466                 if (!on)
467                         newflags &= ~VM_LOCKED;
468
469                 tmp = vma->vm_end;
470                 if (tmp > end)
471                         tmp = end;
472                 error = mlock_fixup(vma, &prev, nstart, tmp, newflags);
473                 if (error)
474                         break;
475                 nstart = tmp;
476                 if (nstart < prev->vm_end)
477                         nstart = prev->vm_end;
478                 if (nstart >= end)
479                         break;
480
481                 vma = prev->vm_next;
482                 if (!vma || vma->vm_start != nstart) {
483                         error = -ENOMEM;
484                         break;
485                 }
486         }
487         return error;
488 }
489
490 SYSCALL_DEFINE2(mlock, unsigned long, start, size_t, len)
491 {
492         unsigned long locked;
493         unsigned long lock_limit;
494         int error = -ENOMEM;
495
496         if (!can_do_mlock())
497                 return -EPERM;
498
499         lru_add_drain_all();    /* flush pagevec */
500
501         down_write(&current->mm->mmap_sem);
502         len = PAGE_ALIGN(len + (start & ~PAGE_MASK));
503         start &= PAGE_MASK;
504
505         locked = len >> PAGE_SHIFT;
506         locked += current->mm->locked_vm;
507
508         lock_limit = rlimit(RLIMIT_MEMLOCK);
509         lock_limit >>= PAGE_SHIFT;
510
511         /* check against resource limits */
512         if ((locked <= lock_limit) || capable(CAP_IPC_LOCK))
513                 error = do_mlock(start, len, 1);
514         up_write(&current->mm->mmap_sem);
515         return error;
516 }
517
518 SYSCALL_DEFINE2(munlock, unsigned long, start, size_t, len)
519 {
520         int ret;
521
522         down_write(&current->mm->mmap_sem);
523         len = PAGE_ALIGN(len + (start & ~PAGE_MASK));
524         start &= PAGE_MASK;
525         ret = do_mlock(start, len, 0);
526         up_write(&current->mm->mmap_sem);
527         return ret;
528 }
529
530 static int do_mlockall(int flags)
531 {
532         struct vm_area_struct * vma, * prev = NULL;
533         unsigned int def_flags = 0;
534
535         if (flags & MCL_FUTURE)
536                 def_flags = VM_LOCKED;
537         current->mm->def_flags = def_flags;
538         if (flags == MCL_FUTURE)
539                 goto out;
540
541         for (vma = current->mm->mmap; vma ; vma = prev->vm_next) {
542                 unsigned int newflags;
543
544                 newflags = vma->vm_flags | VM_LOCKED;
545                 if (!(flags & MCL_CURRENT))
546                         newflags &= ~VM_LOCKED;
547
548                 /* Ignore errors */
549                 mlock_fixup(vma, &prev, vma->vm_start, vma->vm_end, newflags);
550         }
551 out:
552         return 0;
553 }
554
555 SYSCALL_DEFINE1(mlockall, int, flags)
556 {
557         unsigned long lock_limit;
558         int ret = -EINVAL;
559
560         if (!flags || (flags & ~(MCL_CURRENT | MCL_FUTURE)))
561                 goto out;
562
563         ret = -EPERM;
564         if (!can_do_mlock())
565                 goto out;
566
567         lru_add_drain_all();    /* flush pagevec */
568
569         down_write(&current->mm->mmap_sem);
570
571         lock_limit = rlimit(RLIMIT_MEMLOCK);
572         lock_limit >>= PAGE_SHIFT;
573
574         ret = -ENOMEM;
575         if (!(flags & MCL_CURRENT) || (current->mm->total_vm <= lock_limit) ||
576             capable(CAP_IPC_LOCK))
577                 ret = do_mlockall(flags);
578         up_write(&current->mm->mmap_sem);
579 out:
580         return ret;
581 }
582
583 SYSCALL_DEFINE0(munlockall)
584 {
585         int ret;
586
587         down_write(&current->mm->mmap_sem);
588         ret = do_mlockall(0);
589         up_write(&current->mm->mmap_sem);
590         return ret;
591 }
592
593 /*
594  * Objects with different lifetime than processes (SHM_LOCK and SHM_HUGETLB
595  * shm segments) get accounted against the user_struct instead.
596  */
597 static DEFINE_SPINLOCK(shmlock_user_lock);
598
599 int user_shm_lock(size_t size, struct user_struct *user)
600 {
601         unsigned long lock_limit, locked;
602         int allowed = 0;
603
604         locked = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
605         lock_limit = rlimit(RLIMIT_MEMLOCK);
606         if (lock_limit == RLIM_INFINITY)
607                 allowed = 1;
608         lock_limit >>= PAGE_SHIFT;
609         spin_lock(&shmlock_user_lock);
610         if (!allowed &&
611             locked + user->locked_shm > lock_limit && !capable(CAP_IPC_LOCK))
612                 goto out;
613         get_uid(user);
614         user->locked_shm += locked;
615         allowed = 1;
616 out:
617         spin_unlock(&shmlock_user_lock);
618         return allowed;
619 }
620
621 void user_shm_unlock(size_t size, struct user_struct *user)
622 {
623         spin_lock(&shmlock_user_lock);
624         user->locked_shm -= (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
625         spin_unlock(&shmlock_user_lock);
626         free_uid(user);
627 }