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         int nr_pages = (end - start) / PAGE_SIZE;
 163         int gup_flags;
 164         int ret;
 165
 166         VM_BUG_ON(start & ~PAGE_MASK);
 167         VM_BUG_ON(end   & ~PAGE_MASK);
 168         VM_BUG_ON(start < vma->vm_start);
 169         VM_BUG_ON(end   > vma->vm_end);
 170         VM_BUG_ON(!rwsem_is_locked(&mm->mmap_sem));
 171
 172         gup_flags = FOLL_TOUCH | FOLL_MLOCK;
 173         /*
 174          * We want to touch writable mappings with a write fault in order
 175          * to break COW, except for shared mappings because these don't COW
 176          * and we would not want to dirty them for nothing.
 177          */
 178         if ((vma->vm_flags & (VM_WRITE | VM_SHARED)) == VM_WRITE)
 179                 gup_flags |= FOLL_WRITE;
 180
 181         /* We don't try to access the guard page of a stack vma */
 182         if (stack_guard_page(vma, start)) {
 183                 addr += PAGE_SIZE;
 184                 nr_pages--;
 185         }
 186
 187         ret = __get_user_pages(current, mm, addr, nr_pages, gup_flags,
 188                                NULL, NULL);
 189         return max(ret, 0);     /* 0 or negative error code */
 190 }
 191
 192 /*
 193  * convert get_user_pages() return value to posix mlock() error
 194  */
 195 static 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  * mlock_vma_pages_range() - mlock pages in specified vma range.
 206  * @vma - the vma containing the specfied address range
 207  * @start - starting address in @vma to mlock
 208  * @end   - end address [+1] in @vma to mlock
 209  *
 210  * For mmap()/mremap()/expansion of mlocked vma.
 211  *
 212  * return 0 on success for "normal" vmas.
 213  *
 214  * return number of pages [> 0] to be removed from locked_vm on success
 215  * of "special" vmas.
 216  */
 217 long mlock_vma_pages_range(struct vm_area_struct *vma,
 218                         unsigned long start, unsigned long end)
 219 {
 220         int nr_pages = (end - start) / PAGE_SIZE;
 221         BUG_ON(!(vma->vm_flags & VM_LOCKED));
 222
 223         /*
 224          * filter unlockable vmas
 225          */
 226         if (vma->vm_flags & (VM_IO | VM_PFNMAP))
 227                 goto no_mlock;
 228
 229         if (!((vma->vm_flags & (VM_DONTEXPAND | VM_RESERVED)) ||
 230                         is_vm_hugetlb_page(vma) ||
 231                         vma == get_gate_vma(current))) {
 232
 233                 __mlock_vma_pages_range(vma, start, end);
 234
 235                 /* Hide errors from mmap() and other callers */
 236                 return 0;
 237         }
 238
 239         /*
 240          * User mapped kernel pages or huge pages:
 241          * make these pages present to populate the ptes, but
 242          * fall thru' to reset VM_LOCKED--no need to unlock, and
 243          * return nr_pages so these don't get counted against task's
 244          * locked limit.  huge pages are already counted against
 245          * locked vm limit.
 246          */
 247         make_pages_present(start, end);
 248
 249 no_mlock:
 250         vma->vm_flags &= ~VM_LOCKED;    /* and don't come back! */
 251         return nr_pages;                /* error or pages NOT mlocked */
 252 }
 253
 254 /*
 255  * munlock_vma_pages_range() - munlock all pages in the vma range.'
 256  * @vma - vma containing range to be munlock()ed.
 257  * @start - start address in @vma of the range
 258  * @end - end of range in @vma.
 259  *
 260  *  For mremap(), munmap() and exit().
 261  *
 262  * Called with @vma VM_LOCKED.
 263  *
 264  * Returns with VM_LOCKED cleared.  Callers must be prepared to
 265  * deal with this.
 266  *
 267  * We don't save and restore VM_LOCKED here because pages are
 268  * still on lru.  In unmap path, pages might be scanned by reclaim
 269  * and re-mlocked by try_to_{munlock|unmap} before we unmap and
 270  * free them.  This will result in freeing mlocked pages.
 271  */
 272 void munlock_vma_pages_range(struct vm_area_struct *vma,
 273                              unsigned long start, unsigned long end)
 274 {
 275         unsigned long addr;
 276
 277         lru_add_drain();
 278         vma->vm_flags &= ~VM_LOCKED;
 279
 280         for (addr = start; addr < end; addr += PAGE_SIZE) {
 281                 struct page *page;
 282                 /*
 283                  * Although FOLL_DUMP is intended for get_dump_page(),
 284                  * it just so happens that its special treatment of the
 285                  * ZERO_PAGE (returning an error instead of doing get_page)
 286                  * suits munlock very well (and if somehow an abnormal page
 287                  * has sneaked into the range, we won't oops here: great).
 288                  */
 289                 page = follow_page(vma, addr, FOLL_GET | FOLL_DUMP);
 290                 if (page && !IS_ERR(page)) {
 291                         lock_page(page);
 292                         /*
 293                          * Like in __mlock_vma_pages_range(),
 294                          * because we lock page here and migration is
 295                          * blocked by the elevated reference, we need
 296                          * only check for file-cache page truncation.
 297                          */
 298                         if (page->mapping)
 299                                 munlock_vma_page(page);
 300                         unlock_page(page);
 301                         put_page(page);
 302                 }
 303                 cond_resched();
 304         }
 305 }
 306
 307 /*
 308  * mlock_fixup  - handle mlock[all]/munlock[all] requests.
 309  *
 310  * Filters out "special" vmas -- VM_LOCKED never gets set for these, and
 311  * munlock is a no-op.  However, for some special vmas, we go ahead and
 312  * populate the ptes via make_pages_present().
 313  *
 314  * For vmas that pass the filters, merge/split as appropriate.
 315  */
 316 static int mlock_fixup(struct vm_area_struct *vma, struct vm_area_struct **prev,
 317         unsigned long start, unsigned long end, unsigned int newflags)
 318 {
 319         struct mm_struct *mm = vma->vm_mm;
 320         pgoff_t pgoff;
 321         int nr_pages;
 322         int ret = 0;
 323         int lock = newflags & VM_LOCKED;
 324
 325         if (newflags == vma->vm_flags || (vma->vm_flags & VM_SPECIAL) ||
 326             is_vm_hugetlb_page(vma) || vma == get_gate_vma(current))
 327                 goto out;       /* don't set VM_LOCKED,  don't count */
 328
 329         pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
 330         *prev = vma_merge(mm, *prev, start, end, newflags, vma->anon_vma,
 331                           vma->vm_file, pgoff, vma_policy(vma));
 332         if (*prev) {
 333                 vma = *prev;
 334                 goto success;
 335         }
 336
 337         if (start != vma->vm_start) {
 338                 ret = split_vma(mm, vma, start, 1);
 339                 if (ret)
 340                         goto out;
 341         }
 342
 343         if (end != vma->vm_end) {
 344                 ret = split_vma(mm, vma, end, 0);
 345                 if (ret)
 346                         goto out;
 347         }
 348
 349 success:
 350         /*
 351          * Keep track of amount of locked VM.
 352          */
 353         nr_pages = (end - start) >> PAGE_SHIFT;
 354         if (!lock)
 355                 nr_pages = -nr_pages;
 356         mm->locked_vm += nr_pages;
 357
 358         /*
 359          * vm_flags is protected by the mmap_sem held in write mode.
 360          * It's okay if try_to_unmap_one unmaps a page just after we
 361          * set VM_LOCKED, __mlock_vma_pages_range will bring it back.
 362          */
 363
 364         if (lock)
 365                 vma->vm_flags = newflags;
 366         else
 367                 munlock_vma_pages_range(vma, start, end);
 368
 369 out:
 370         *prev = vma;
 371         return ret;
 372 }
 373
 374 static int do_mlock(unsigned long start, size_t len, int on)
 375 {
 376         unsigned long nstart, end, tmp;
 377         struct vm_area_struct * vma, * prev;
 378         int error;
 379
 380         VM_BUG_ON(start & ~PAGE_MASK);
 381         VM_BUG_ON(len != PAGE_ALIGN(len));
 382         end = start + len;
 383         if (end < start)
 384                 return -EINVAL;
 385         if (end == start)
 386                 return 0;
 387         vma = find_vma_prev(current->mm, start, &prev);
 388         if (!vma || vma->vm_start > start)
 389                 return -ENOMEM;
 390
 391         if (start > vma->vm_start)
 392                 prev = vma;
 393
 394         for (nstart = start ; ; ) {
 395                 unsigned int newflags;
 396
 397                 /* Here we know that  vma->vm_start <= nstart < vma->vm_end. */
 398
 399                 newflags = vma->vm_flags | VM_LOCKED;
 400                 if (!on)
 401                         newflags &= ~VM_LOCKED;
 402
 403                 tmp = vma->vm_end;
 404                 if (tmp > end)
 405                         tmp = end;
 406                 error = mlock_fixup(vma, &prev, nstart, tmp, newflags);
 407                 if (error)
 408                         break;
 409                 nstart = tmp;
 410                 if (nstart < prev->vm_end)
 411                         nstart = prev->vm_end;
 412                 if (nstart >= end)
 413                         break;
 414
 415                 vma = prev->vm_next;
 416                 if (!vma || vma->vm_start != nstart) {
 417                         error = -ENOMEM;
 418                         break;
 419                 }
 420         }
 421         return error;
 422 }
 423
 424 static int do_mlock_pages(unsigned long start, size_t len, int ignore_errors)
 425 {
 426         struct mm_struct *mm = current->mm;
 427         unsigned long end, nstart, nend;
 428         struct vm_area_struct *vma = NULL;
 429         int ret = 0;
 430
 431         VM_BUG_ON(start & ~PAGE_MASK);
 432         VM_BUG_ON(len != PAGE_ALIGN(len));
 433         end = start + len;
 434
 435         down_read(&mm->mmap_sem);
 436         for (nstart = start; nstart < end; nstart = nend) {
 437                 /*
 438                  * We want to fault in pages for [nstart; end) address range.
 439                  * Find first corresponding VMA.
 440                  */
 441                 if (!vma)
 442                         vma = find_vma(mm, nstart);
 443                 else
 444                         vma = vma->vm_next;
 445                 if (!vma || vma->vm_start >= end)
 446                         break;
 447                 /*
 448                  * Set [nstart; nend) to intersection of desired address
 449                  * range with the first VMA. Also, skip undesirable VMA types.
 450                  */
 451                 nend = min(end, vma->vm_end);
 452                 if (vma->vm_flags & (VM_IO | VM_PFNMAP))
 453                         continue;
 454                 if (nstart < vma->vm_start)
 455                         nstart = vma->vm_start;
 456                 /*
 457                  * Now fault in a range of pages within the first VMA.
 458                  */
 459                 if (vma->vm_flags & VM_LOCKED) {
 460                         ret = __mlock_vma_pages_range(vma, nstart, nend);
 461                         if (ret < 0 && ignore_errors) {
 462                                 ret = 0;
 463                                 continue;       /* continue at next VMA */
 464                         }
 465                         if (ret) {
 466                                 ret = __mlock_posix_error_return(ret);
 467                                 break;
 468                         }
 469                 } else
 470                         make_pages_present(nstart, nend);
 471         }
 472         up_read(&mm->mmap_sem);
 473         return ret;     /* 0 or negative error code */
 474 }
 475
 476 SYSCALL_DEFINE2(mlock, unsigned long, start, size_t, len)
 477 {
 478         unsigned long locked;
 479         unsigned long lock_limit;
 480         int error = -ENOMEM;
 481
 482         if (!can_do_mlock())
 483                 return -EPERM;
 484
 485         lru_add_drain_all();    /* flush pagevec */
 486
 487         down_write(&current->mm->mmap_sem);
 488         len = PAGE_ALIGN(len + (start & ~PAGE_MASK));
 489         start &= PAGE_MASK;
 490
 491         locked = len >> PAGE_SHIFT;
 492         locked += current->mm->locked_vm;
 493
 494         lock_limit = rlimit(RLIMIT_MEMLOCK);
 495         lock_limit >>= PAGE_SHIFT;
 496
 497         /* check against resource limits */
 498         if ((locked <= lock_limit) || capable(CAP_IPC_LOCK))
 499                 error = do_mlock(start, len, 1);
 500         up_write(&current->mm->mmap_sem);
 501         if (!error)
 502                 error = do_mlock_pages(start, len, 0);
 503         return error;
 504 }
 505
 506 SYSCALL_DEFINE2(munlock, unsigned long, start, size_t, len)
 507 {
 508         int ret;
 509
 510         down_write(&current->mm->mmap_sem);
 511         len = PAGE_ALIGN(len + (start & ~PAGE_MASK));
 512         start &= PAGE_MASK;
 513         ret = do_mlock(start, len, 0);
 514         up_write(&current->mm->mmap_sem);
 515         return ret;
 516 }
 517
 518 static int do_mlockall(int flags)
 519 {
 520         struct vm_area_struct * vma, * prev = NULL;
 521         unsigned int def_flags = 0;
 522
 523         if (flags & MCL_FUTURE)
 524                 def_flags = VM_LOCKED;
 525         current->mm->def_flags = def_flags;
 526         if (flags == MCL_FUTURE)
 527                 goto out;
 528
 529         for (vma = current->mm->mmap; vma ; vma = prev->vm_next) {
 530                 unsigned int newflags;
 531
 532                 newflags = vma->vm_flags | VM_LOCKED;
 533                 if (!(flags & MCL_CURRENT))
 534                         newflags &= ~VM_LOCKED;
 535
 536                 /* Ignore errors */
 537                 mlock_fixup(vma, &prev, vma->vm_start, vma->vm_end, newflags);
 538         }
 539 out:
 540         return 0;
 541 }
 542
 543 SYSCALL_DEFINE1(mlockall, int, flags)
 544 {
 545         unsigned long lock_limit;
 546         int ret = -EINVAL;
 547
 548         if (!flags || (flags & ~(MCL_CURRENT | MCL_FUTURE)))
 549                 goto out;
 550
 551         ret = -EPERM;
 552         if (!can_do_mlock())
 553                 goto out;
 554
 555         lru_add_drain_all();    /* flush pagevec */
 556
 557         down_write(&current->mm->mmap_sem);
 558
 559         lock_limit = rlimit(RLIMIT_MEMLOCK);
 560         lock_limit >>= PAGE_SHIFT;
 561
 562         ret = -ENOMEM;
 563         if (!(flags & MCL_CURRENT) || (current->mm->total_vm <= lock_limit) ||
 564             capable(CAP_IPC_LOCK))
 565                 ret = do_mlockall(flags);
 566         up_write(&current->mm->mmap_sem);
 567         if (!ret && (flags & MCL_CURRENT)) {
 568                 /* Ignore errors */
 569                 do_mlock_pages(0, TASK_SIZE, 1);
 570         }
 571 out:
 572         return ret;
 573 }
 574
 575 SYSCALL_DEFINE0(munlockall)
 576 {
 577         int ret;
 578
 579         down_write(&current->mm->mmap_sem);
 580         ret = do_mlockall(0);
 581         up_write(&current->mm->mmap_sem);
 582         return ret;
 583 }
 584
 585 /*
 586  * Objects with different lifetime than processes (SHM_LOCK and SHM_HUGETLB
 587  * shm segments) get accounted against the user_struct instead.
 588  */
 589 static DEFINE_SPINLOCK(shmlock_user_lock);
 590
 591 int user_shm_lock(size_t size, struct user_struct *user)
 592 {
 593         unsigned long lock_limit, locked;
 594         int allowed = 0;
 595
 596         locked = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
 597         lock_limit = rlimit(RLIMIT_MEMLOCK);
 598         if (lock_limit == RLIM_INFINITY)
 599                 allowed = 1;
 600         lock_limit >>= PAGE_SHIFT;
 601         spin_lock(&shmlock_user_lock);
 602         if (!allowed &&
 603             locked + user->locked_shm > lock_limit && !capable(CAP_IPC_LOCK))
 604                 goto out;
 605         get_uid(user);
 606         user->locked_shm += locked;
 607         allowed = 1;
 608 out:
 609         spin_unlock(&shmlock_user_lock);
 610         return allowed;
 611 }
 612
 613 void user_shm_unlock(size_t size, struct user_struct *user)
 614 {
 615         spin_lock(&shmlock_user_lock);
 616         user->locked_shm -= (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
 617         spin_unlock(&shmlock_user_lock);
 618         free_uid(user);
 619 }