Staging: lustre: indent an if statement
[linux/fpc-iii.git] / mm / madvise.c
blob93fb63e88b5ef505d196b722527f09827f54f32e
1 /*
2 * linux/mm/madvise.c
4 * Copyright (C) 1999 Linus Torvalds
5 * Copyright (C) 2002 Christoph Hellwig
6 */
8 #include <linux/mman.h>
9 #include <linux/pagemap.h>
10 #include <linux/syscalls.h>
11 #include <linux/mempolicy.h>
12 #include <linux/page-isolation.h>
13 #include <linux/hugetlb.h>
14 #include <linux/falloc.h>
15 #include <linux/sched.h>
16 #include <linux/ksm.h>
17 #include <linux/fs.h>
18 #include <linux/file.h>
19 #include <linux/blkdev.h>
20 #include <linux/backing-dev.h>
21 #include <linux/swap.h>
22 #include <linux/swapops.h>
23 #include <linux/mmu_notifier.h>
25 #include <asm/tlb.h>
28 * Any behaviour which results in changes to the vma->vm_flags needs to
29 * take mmap_sem for writing. Others, which simply traverse vmas, need
30 * to only take it for reading.
32 static int madvise_need_mmap_write(int behavior)
34 switch (behavior) {
35 case MADV_REMOVE:
36 case MADV_WILLNEED:
37 case MADV_DONTNEED:
38 case MADV_FREE:
39 return 0;
40 default:
41 /* be safe, default to 1. list exceptions explicitly */
42 return 1;
47 * We can potentially split a vm area into separate
48 * areas, each area with its own behavior.
50 static long madvise_behavior(struct vm_area_struct *vma,
51 struct vm_area_struct **prev,
52 unsigned long start, unsigned long end, int behavior)
54 struct mm_struct *mm = vma->vm_mm;
55 int error = 0;
56 pgoff_t pgoff;
57 unsigned long new_flags = vma->vm_flags;
59 switch (behavior) {
60 case MADV_NORMAL:
61 new_flags = new_flags & ~VM_RAND_READ & ~VM_SEQ_READ;
62 break;
63 case MADV_SEQUENTIAL:
64 new_flags = (new_flags & ~VM_RAND_READ) | VM_SEQ_READ;
65 break;
66 case MADV_RANDOM:
67 new_flags = (new_flags & ~VM_SEQ_READ) | VM_RAND_READ;
68 break;
69 case MADV_DONTFORK:
70 new_flags |= VM_DONTCOPY;
71 break;
72 case MADV_DOFORK:
73 if (vma->vm_flags & VM_IO) {
74 error = -EINVAL;
75 goto out;
77 new_flags &= ~VM_DONTCOPY;
78 break;
79 case MADV_DONTDUMP:
80 new_flags |= VM_DONTDUMP;
81 break;
82 case MADV_DODUMP:
83 if (new_flags & VM_SPECIAL) {
84 error = -EINVAL;
85 goto out;
87 new_flags &= ~VM_DONTDUMP;
88 break;
89 case MADV_MERGEABLE:
90 case MADV_UNMERGEABLE:
91 error = ksm_madvise(vma, start, end, behavior, &new_flags);
92 if (error)
93 goto out;
94 break;
95 case MADV_HUGEPAGE:
96 case MADV_NOHUGEPAGE:
97 error = hugepage_madvise(vma, &new_flags, behavior);
98 if (error)
99 goto out;
100 break;
103 if (new_flags == vma->vm_flags) {
104 *prev = vma;
105 goto out;
108 pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
109 *prev = vma_merge(mm, *prev, start, end, new_flags, vma->anon_vma,
110 vma->vm_file, pgoff, vma_policy(vma),
111 vma->vm_userfaultfd_ctx);
112 if (*prev) {
113 vma = *prev;
114 goto success;
117 *prev = vma;
119 if (start != vma->vm_start) {
120 error = split_vma(mm, vma, start, 1);
121 if (error)
122 goto out;
125 if (end != vma->vm_end) {
126 error = split_vma(mm, vma, end, 0);
127 if (error)
128 goto out;
131 success:
133 * vm_flags is protected by the mmap_sem held in write mode.
135 vma->vm_flags = new_flags;
137 out:
138 if (error == -ENOMEM)
139 error = -EAGAIN;
140 return error;
143 #ifdef CONFIG_SWAP
144 static int swapin_walk_pmd_entry(pmd_t *pmd, unsigned long start,
145 unsigned long end, struct mm_walk *walk)
147 pte_t *orig_pte;
148 struct vm_area_struct *vma = walk->private;
149 unsigned long index;
151 if (pmd_none_or_trans_huge_or_clear_bad(pmd))
152 return 0;
154 for (index = start; index != end; index += PAGE_SIZE) {
155 pte_t pte;
156 swp_entry_t entry;
157 struct page *page;
158 spinlock_t *ptl;
160 orig_pte = pte_offset_map_lock(vma->vm_mm, pmd, start, &ptl);
161 pte = *(orig_pte + ((index - start) / PAGE_SIZE));
162 pte_unmap_unlock(orig_pte, ptl);
164 if (pte_present(pte) || pte_none(pte))
165 continue;
166 entry = pte_to_swp_entry(pte);
167 if (unlikely(non_swap_entry(entry)))
168 continue;
170 page = read_swap_cache_async(entry, GFP_HIGHUSER_MOVABLE,
171 vma, index);
172 if (page)
173 put_page(page);
176 return 0;
179 static void force_swapin_readahead(struct vm_area_struct *vma,
180 unsigned long start, unsigned long end)
182 struct mm_walk walk = {
183 .mm = vma->vm_mm,
184 .pmd_entry = swapin_walk_pmd_entry,
185 .private = vma,
188 walk_page_range(start, end, &walk);
190 lru_add_drain(); /* Push any new pages onto the LRU now */
193 static void force_shm_swapin_readahead(struct vm_area_struct *vma,
194 unsigned long start, unsigned long end,
195 struct address_space *mapping)
197 pgoff_t index;
198 struct page *page;
199 swp_entry_t swap;
201 for (; start < end; start += PAGE_SIZE) {
202 index = ((start - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
204 page = find_get_entry(mapping, index);
205 if (!radix_tree_exceptional_entry(page)) {
206 if (page)
207 put_page(page);
208 continue;
210 swap = radix_to_swp_entry(page);
211 page = read_swap_cache_async(swap, GFP_HIGHUSER_MOVABLE,
212 NULL, 0);
213 if (page)
214 put_page(page);
217 lru_add_drain(); /* Push any new pages onto the LRU now */
219 #endif /* CONFIG_SWAP */
222 * Schedule all required I/O operations. Do not wait for completion.
224 static long madvise_willneed(struct vm_area_struct *vma,
225 struct vm_area_struct **prev,
226 unsigned long start, unsigned long end)
228 struct file *file = vma->vm_file;
230 #ifdef CONFIG_SWAP
231 if (!file) {
232 *prev = vma;
233 force_swapin_readahead(vma, start, end);
234 return 0;
237 if (shmem_mapping(file->f_mapping)) {
238 *prev = vma;
239 force_shm_swapin_readahead(vma, start, end,
240 file->f_mapping);
241 return 0;
243 #else
244 if (!file)
245 return -EBADF;
246 #endif
248 if (IS_DAX(file_inode(file))) {
249 /* no bad return value, but ignore advice */
250 return 0;
253 *prev = vma;
254 start = ((start - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
255 if (end > vma->vm_end)
256 end = vma->vm_end;
257 end = ((end - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
259 force_page_cache_readahead(file->f_mapping, file, start, end - start);
260 return 0;
263 static int madvise_free_pte_range(pmd_t *pmd, unsigned long addr,
264 unsigned long end, struct mm_walk *walk)
267 struct mmu_gather *tlb = walk->private;
268 struct mm_struct *mm = tlb->mm;
269 struct vm_area_struct *vma = walk->vma;
270 spinlock_t *ptl;
271 pte_t *orig_pte, *pte, ptent;
272 struct page *page;
273 int nr_swap = 0;
274 unsigned long next;
276 next = pmd_addr_end(addr, end);
277 if (pmd_trans_huge(*pmd))
278 if (madvise_free_huge_pmd(tlb, vma, pmd, addr, next))
279 goto next;
281 if (pmd_trans_unstable(pmd))
282 return 0;
284 orig_pte = pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
285 arch_enter_lazy_mmu_mode();
286 for (; addr != end; pte++, addr += PAGE_SIZE) {
287 ptent = *pte;
289 if (pte_none(ptent))
290 continue;
292 * If the pte has swp_entry, just clear page table to
293 * prevent swap-in which is more expensive rather than
294 * (page allocation + zeroing).
296 if (!pte_present(ptent)) {
297 swp_entry_t entry;
299 entry = pte_to_swp_entry(ptent);
300 if (non_swap_entry(entry))
301 continue;
302 nr_swap--;
303 free_swap_and_cache(entry);
304 pte_clear_not_present_full(mm, addr, pte, tlb->fullmm);
305 continue;
308 page = vm_normal_page(vma, addr, ptent);
309 if (!page)
310 continue;
313 * If pmd isn't transhuge but the page is THP and
314 * is owned by only this process, split it and
315 * deactivate all pages.
317 if (PageTransCompound(page)) {
318 if (page_mapcount(page) != 1)
319 goto out;
320 get_page(page);
321 if (!trylock_page(page)) {
322 put_page(page);
323 goto out;
325 pte_unmap_unlock(orig_pte, ptl);
326 if (split_huge_page(page)) {
327 unlock_page(page);
328 put_page(page);
329 pte_offset_map_lock(mm, pmd, addr, &ptl);
330 goto out;
332 put_page(page);
333 unlock_page(page);
334 pte = pte_offset_map_lock(mm, pmd, addr, &ptl);
335 pte--;
336 addr -= PAGE_SIZE;
337 continue;
340 VM_BUG_ON_PAGE(PageTransCompound(page), page);
342 if (PageSwapCache(page) || PageDirty(page)) {
343 if (!trylock_page(page))
344 continue;
346 * If page is shared with others, we couldn't clear
347 * PG_dirty of the page.
349 if (page_mapcount(page) != 1) {
350 unlock_page(page);
351 continue;
354 if (PageSwapCache(page) && !try_to_free_swap(page)) {
355 unlock_page(page);
356 continue;
359 ClearPageDirty(page);
360 unlock_page(page);
363 if (pte_young(ptent) || pte_dirty(ptent)) {
365 * Some of architecture(ex, PPC) don't update TLB
366 * with set_pte_at and tlb_remove_tlb_entry so for
367 * the portability, remap the pte with old|clean
368 * after pte clearing.
370 ptent = ptep_get_and_clear_full(mm, addr, pte,
371 tlb->fullmm);
373 ptent = pte_mkold(ptent);
374 ptent = pte_mkclean(ptent);
375 set_pte_at(mm, addr, pte, ptent);
376 if (PageActive(page))
377 deactivate_page(page);
378 tlb_remove_tlb_entry(tlb, pte, addr);
381 out:
382 if (nr_swap) {
383 if (current->mm == mm)
384 sync_mm_rss(mm);
386 add_mm_counter(mm, MM_SWAPENTS, nr_swap);
388 arch_leave_lazy_mmu_mode();
389 pte_unmap_unlock(orig_pte, ptl);
390 cond_resched();
391 next:
392 return 0;
395 static void madvise_free_page_range(struct mmu_gather *tlb,
396 struct vm_area_struct *vma,
397 unsigned long addr, unsigned long end)
399 struct mm_walk free_walk = {
400 .pmd_entry = madvise_free_pte_range,
401 .mm = vma->vm_mm,
402 .private = tlb,
405 tlb_start_vma(tlb, vma);
406 walk_page_range(addr, end, &free_walk);
407 tlb_end_vma(tlb, vma);
410 static int madvise_free_single_vma(struct vm_area_struct *vma,
411 unsigned long start_addr, unsigned long end_addr)
413 unsigned long start, end;
414 struct mm_struct *mm = vma->vm_mm;
415 struct mmu_gather tlb;
417 if (vma->vm_flags & (VM_LOCKED|VM_HUGETLB|VM_PFNMAP))
418 return -EINVAL;
420 /* MADV_FREE works for only anon vma at the moment */
421 if (!vma_is_anonymous(vma))
422 return -EINVAL;
424 start = max(vma->vm_start, start_addr);
425 if (start >= vma->vm_end)
426 return -EINVAL;
427 end = min(vma->vm_end, end_addr);
428 if (end <= vma->vm_start)
429 return -EINVAL;
431 lru_add_drain();
432 tlb_gather_mmu(&tlb, mm, start, end);
433 update_hiwater_rss(mm);
435 mmu_notifier_invalidate_range_start(mm, start, end);
436 madvise_free_page_range(&tlb, vma, start, end);
437 mmu_notifier_invalidate_range_end(mm, start, end);
438 tlb_finish_mmu(&tlb, start, end);
440 return 0;
443 static long madvise_free(struct vm_area_struct *vma,
444 struct vm_area_struct **prev,
445 unsigned long start, unsigned long end)
447 *prev = vma;
448 return madvise_free_single_vma(vma, start, end);
452 * Application no longer needs these pages. If the pages are dirty,
453 * it's OK to just throw them away. The app will be more careful about
454 * data it wants to keep. Be sure to free swap resources too. The
455 * zap_page_range call sets things up for shrink_active_list to actually free
456 * these pages later if no one else has touched them in the meantime,
457 * although we could add these pages to a global reuse list for
458 * shrink_active_list to pick up before reclaiming other pages.
460 * NB: This interface discards data rather than pushes it out to swap,
461 * as some implementations do. This has performance implications for
462 * applications like large transactional databases which want to discard
463 * pages in anonymous maps after committing to backing store the data
464 * that was kept in them. There is no reason to write this data out to
465 * the swap area if the application is discarding it.
467 * An interface that causes the system to free clean pages and flush
468 * dirty pages is already available as msync(MS_INVALIDATE).
470 static long madvise_dontneed(struct vm_area_struct *vma,
471 struct vm_area_struct **prev,
472 unsigned long start, unsigned long end)
474 *prev = vma;
475 if (vma->vm_flags & (VM_LOCKED|VM_HUGETLB|VM_PFNMAP))
476 return -EINVAL;
478 zap_page_range(vma, start, end - start, NULL);
479 return 0;
483 * Application wants to free up the pages and associated backing store.
484 * This is effectively punching a hole into the middle of a file.
486 static long madvise_remove(struct vm_area_struct *vma,
487 struct vm_area_struct **prev,
488 unsigned long start, unsigned long end)
490 loff_t offset;
491 int error;
492 struct file *f;
494 *prev = NULL; /* tell sys_madvise we drop mmap_sem */
496 if (vma->vm_flags & VM_LOCKED)
497 return -EINVAL;
499 f = vma->vm_file;
501 if (!f || !f->f_mapping || !f->f_mapping->host) {
502 return -EINVAL;
505 if ((vma->vm_flags & (VM_SHARED|VM_WRITE)) != (VM_SHARED|VM_WRITE))
506 return -EACCES;
508 offset = (loff_t)(start - vma->vm_start)
509 + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
512 * Filesystem's fallocate may need to take i_mutex. We need to
513 * explicitly grab a reference because the vma (and hence the
514 * vma's reference to the file) can go away as soon as we drop
515 * mmap_sem.
517 get_file(f);
518 up_read(&current->mm->mmap_sem);
519 error = vfs_fallocate(f,
520 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
521 offset, end - start);
522 fput(f);
523 down_read(&current->mm->mmap_sem);
524 return error;
527 #ifdef CONFIG_MEMORY_FAILURE
529 * Error injection support for memory error handling.
531 static int madvise_hwpoison(int bhv, unsigned long start, unsigned long end)
533 struct page *p;
534 if (!capable(CAP_SYS_ADMIN))
535 return -EPERM;
536 for (; start < end; start += PAGE_SIZE <<
537 compound_order(compound_head(p))) {
538 int ret;
540 ret = get_user_pages_fast(start, 1, 0, &p);
541 if (ret != 1)
542 return ret;
544 if (PageHWPoison(p)) {
545 put_page(p);
546 continue;
548 if (bhv == MADV_SOFT_OFFLINE) {
549 pr_info("Soft offlining page %#lx at %#lx\n",
550 page_to_pfn(p), start);
551 ret = soft_offline_page(p, MF_COUNT_INCREASED);
552 if (ret)
553 return ret;
554 continue;
556 pr_info("Injecting memory failure for page %#lx at %#lx\n",
557 page_to_pfn(p), start);
558 ret = memory_failure(page_to_pfn(p), 0, MF_COUNT_INCREASED);
559 if (ret)
560 return ret;
562 return 0;
564 #endif
566 static long
567 madvise_vma(struct vm_area_struct *vma, struct vm_area_struct **prev,
568 unsigned long start, unsigned long end, int behavior)
570 switch (behavior) {
571 case MADV_REMOVE:
572 return madvise_remove(vma, prev, start, end);
573 case MADV_WILLNEED:
574 return madvise_willneed(vma, prev, start, end);
575 case MADV_FREE:
577 * XXX: In this implementation, MADV_FREE works like
578 * MADV_DONTNEED on swapless system or full swap.
580 if (get_nr_swap_pages() > 0)
581 return madvise_free(vma, prev, start, end);
582 /* passthrough */
583 case MADV_DONTNEED:
584 return madvise_dontneed(vma, prev, start, end);
585 default:
586 return madvise_behavior(vma, prev, start, end, behavior);
590 static bool
591 madvise_behavior_valid(int behavior)
593 switch (behavior) {
594 case MADV_DOFORK:
595 case MADV_DONTFORK:
596 case MADV_NORMAL:
597 case MADV_SEQUENTIAL:
598 case MADV_RANDOM:
599 case MADV_REMOVE:
600 case MADV_WILLNEED:
601 case MADV_DONTNEED:
602 case MADV_FREE:
603 #ifdef CONFIG_KSM
604 case MADV_MERGEABLE:
605 case MADV_UNMERGEABLE:
606 #endif
607 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
608 case MADV_HUGEPAGE:
609 case MADV_NOHUGEPAGE:
610 #endif
611 case MADV_DONTDUMP:
612 case MADV_DODUMP:
613 return true;
615 default:
616 return false;
621 * The madvise(2) system call.
623 * Applications can use madvise() to advise the kernel how it should
624 * handle paging I/O in this VM area. The idea is to help the kernel
625 * use appropriate read-ahead and caching techniques. The information
626 * provided is advisory only, and can be safely disregarded by the
627 * kernel without affecting the correct operation of the application.
629 * behavior values:
630 * MADV_NORMAL - the default behavior is to read clusters. This
631 * results in some read-ahead and read-behind.
632 * MADV_RANDOM - the system should read the minimum amount of data
633 * on any access, since it is unlikely that the appli-
634 * cation will need more than what it asks for.
635 * MADV_SEQUENTIAL - pages in the given range will probably be accessed
636 * once, so they can be aggressively read ahead, and
637 * can be freed soon after they are accessed.
638 * MADV_WILLNEED - the application is notifying the system to read
639 * some pages ahead.
640 * MADV_DONTNEED - the application is finished with the given range,
641 * so the kernel can free resources associated with it.
642 * MADV_FREE - the application marks pages in the given range as lazy free,
643 * where actual purges are postponed until memory pressure happens.
644 * MADV_REMOVE - the application wants to free up the given range of
645 * pages and associated backing store.
646 * MADV_DONTFORK - omit this area from child's address space when forking:
647 * typically, to avoid COWing pages pinned by get_user_pages().
648 * MADV_DOFORK - cancel MADV_DONTFORK: no longer omit this area when forking.
649 * MADV_HWPOISON - trigger memory error handler as if the given memory range
650 * were corrupted by unrecoverable hardware memory failure.
651 * MADV_SOFT_OFFLINE - try to soft-offline the given range of memory.
652 * MADV_MERGEABLE - the application recommends that KSM try to merge pages in
653 * this area with pages of identical content from other such areas.
654 * MADV_UNMERGEABLE- cancel MADV_MERGEABLE: no longer merge pages with others.
655 * MADV_HUGEPAGE - the application wants to back the given range by transparent
656 * huge pages in the future. Existing pages might be coalesced and
657 * new pages might be allocated as THP.
658 * MADV_NOHUGEPAGE - mark the given range as not worth being backed by
659 * transparent huge pages so the existing pages will not be
660 * coalesced into THP and new pages will not be allocated as THP.
661 * MADV_DONTDUMP - the application wants to prevent pages in the given range
662 * from being included in its core dump.
663 * MADV_DODUMP - cancel MADV_DONTDUMP: no longer exclude from core dump.
665 * return values:
666 * zero - success
667 * -EINVAL - start + len < 0, start is not page-aligned,
668 * "behavior" is not a valid value, or application
669 * is attempting to release locked or shared pages.
670 * -ENOMEM - addresses in the specified range are not currently
671 * mapped, or are outside the AS of the process.
672 * -EIO - an I/O error occurred while paging in data.
673 * -EBADF - map exists, but area maps something that isn't a file.
674 * -EAGAIN - a kernel resource was temporarily unavailable.
676 SYSCALL_DEFINE3(madvise, unsigned long, start, size_t, len_in, int, behavior)
678 unsigned long end, tmp;
679 struct vm_area_struct *vma, *prev;
680 int unmapped_error = 0;
681 int error = -EINVAL;
682 int write;
683 size_t len;
684 struct blk_plug plug;
686 #ifdef CONFIG_MEMORY_FAILURE
687 if (behavior == MADV_HWPOISON || behavior == MADV_SOFT_OFFLINE)
688 return madvise_hwpoison(behavior, start, start+len_in);
689 #endif
690 if (!madvise_behavior_valid(behavior))
691 return error;
693 if (start & ~PAGE_MASK)
694 return error;
695 len = (len_in + ~PAGE_MASK) & PAGE_MASK;
697 /* Check to see whether len was rounded up from small -ve to zero */
698 if (len_in && !len)
699 return error;
701 end = start + len;
702 if (end < start)
703 return error;
705 error = 0;
706 if (end == start)
707 return error;
709 write = madvise_need_mmap_write(behavior);
710 if (write) {
711 if (down_write_killable(&current->mm->mmap_sem))
712 return -EINTR;
713 } else {
714 down_read(&current->mm->mmap_sem);
718 * If the interval [start,end) covers some unmapped address
719 * ranges, just ignore them, but return -ENOMEM at the end.
720 * - different from the way of handling in mlock etc.
722 vma = find_vma_prev(current->mm, start, &prev);
723 if (vma && start > vma->vm_start)
724 prev = vma;
726 blk_start_plug(&plug);
727 for (;;) {
728 /* Still start < end. */
729 error = -ENOMEM;
730 if (!vma)
731 goto out;
733 /* Here start < (end|vma->vm_end). */
734 if (start < vma->vm_start) {
735 unmapped_error = -ENOMEM;
736 start = vma->vm_start;
737 if (start >= end)
738 goto out;
741 /* Here vma->vm_start <= start < (end|vma->vm_end) */
742 tmp = vma->vm_end;
743 if (end < tmp)
744 tmp = end;
746 /* Here vma->vm_start <= start < tmp <= (end|vma->vm_end). */
747 error = madvise_vma(vma, &prev, start, tmp, behavior);
748 if (error)
749 goto out;
750 start = tmp;
751 if (prev && start < prev->vm_end)
752 start = prev->vm_end;
753 error = unmapped_error;
754 if (start >= end)
755 goto out;
756 if (prev)
757 vma = prev->vm_next;
758 else /* madvise_remove dropped mmap_sem */
759 vma = find_vma(current->mm, start);
761 out:
762 blk_finish_plug(&plug);
763 if (write)
764 up_write(&current->mm->mmap_sem);
765 else
766 up_read(&current->mm->mmap_sem);
768 return error;