SAFE public projects git trees. - safe/jmp/linux-2.6/blob - mm/madvise.c

   1 /*
   2  *      linux/mm/madvise.c
   3  *
   4  * Copyright (C) 1999  Linus Torvalds
   5  * Copyright (C) 2002  Christoph Hellwig
   6  */
   7
   8 #include <linux/mman.h>
   9 #include <linux/pagemap.h>
  10 #include <linux/syscalls.h>
  11 #include <linux/mempolicy.h>
  12 #include <linux/hugetlb.h>
  13 #include <linux/sched.h>
  14
  15 /*
  16  * Any behaviour which results in changes to the vma->vm_flags needs to
  17  * take mmap_sem for writing. Others, which simply traverse vmas, need
  18  * to only take it for reading.
  19  */
  20 static int madvise_need_mmap_write(int behavior)
  21 {
  22         switch (behavior) {
  23         case MADV_REMOVE:
  24         case MADV_WILLNEED:
  25         case MADV_DONTNEED:
  26                 return 0;
  27         default:
  28                 /* be safe, default to 1. list exceptions explicitly */
  29                 return 1;
  30         }
  31 }
  32
  33 /*
  34  * We can potentially split a vm area into separate
  35  * areas, each area with its own behavior.
  36  */
  37 static long madvise_behavior(struct vm_area_struct * vma,
  38                      struct vm_area_struct **prev,
  39                      unsigned long start, unsigned long end, int behavior)
  40 {
  41         struct mm_struct * mm = vma->vm_mm;
  42         int error = 0;
  43         pgoff_t pgoff;
  44         unsigned long new_flags = vma->vm_flags;
  45
  46         switch (behavior) {
  47         case MADV_NORMAL:
  48                 new_flags = new_flags & ~VM_RAND_READ & ~VM_SEQ_READ;
  49                 break;
  50         case MADV_SEQUENTIAL:
  51                 new_flags = (new_flags & ~VM_RAND_READ) | VM_SEQ_READ;
  52                 break;
  53         case MADV_RANDOM:
  54                 new_flags = (new_flags & ~VM_SEQ_READ) | VM_RAND_READ;
  55                 break;
  56         case MADV_DONTFORK:
  57                 new_flags |= VM_DONTCOPY;
  58                 break;
  59         case MADV_DOFORK:
  60                 if (vma->vm_flags & VM_IO) {
  61                         error = -EINVAL;
  62                         goto out;
  63                 }
  64                 new_flags &= ~VM_DONTCOPY;
  65                 break;
  66         }
  67
  68         if (new_flags == vma->vm_flags) {
  69                 *prev = vma;
  70                 goto out;
  71         }
  72
  73         pgoff = vma->vm_pgoff + ((start - vma->vm_start) >> PAGE_SHIFT);
  74         *prev = vma_merge(mm, *prev, start, end, new_flags, vma->anon_vma,
  75                                 vma->vm_file, pgoff, vma_policy(vma));
  76         if (*prev) {
  77                 vma = *prev;
  78                 goto success;
  79         }
  80
  81         *prev = vma;
  82
  83         if (start != vma->vm_start) {
  84                 error = split_vma(mm, vma, start, 1);
  85                 if (error)
  86                         goto out;
  87         }
  88
  89         if (end != vma->vm_end) {
  90                 error = split_vma(mm, vma, end, 0);
  91                 if (error)
  92                         goto out;
  93         }
  94
  95 success:
  96         /*
  97          * vm_flags is protected by the mmap_sem held in write mode.
  98          */
  99         vma->vm_flags = new_flags;
 100
 101 out:
 102         if (error == -ENOMEM)
 103                 error = -EAGAIN;
 104         return error;
 105 }
 106
 107 /*
 108  * Schedule all required I/O operations.  Do not wait for completion.
 109  */
 110 static long madvise_willneed(struct vm_area_struct * vma,
 111                              struct vm_area_struct ** prev,
 112                              unsigned long start, unsigned long end)
 113 {
 114         struct file *file = vma->vm_file;
 115
 116         if (!file)
 117                 return -EBADF;
 118
 119         if (file->f_mapping->a_ops->get_xip_mem) {
 120                 /* no bad return value, but ignore advice */
 121                 return 0;
 122         }
 123
 124         *prev = vma;
 125         start = ((start - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
 126         if (end > vma->vm_end)
 127                 end = vma->vm_end;
 128         end = ((end - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
 129
 130         force_page_cache_readahead(file->f_mapping, file, start, end - start);
 131         return 0;
 132 }
 133
 134 /*
 135  * Application no longer needs these pages.  If the pages are dirty,
 136  * it's OK to just throw them away.  The app will be more careful about
 137  * data it wants to keep.  Be sure to free swap resources too.  The
 138  * zap_page_range call sets things up for shrink_active_list to actually free
 139  * these pages later if no one else has touched them in the meantime,
 140  * although we could add these pages to a global reuse list for
 141  * shrink_active_list to pick up before reclaiming other pages.
 142  *
 143  * NB: This interface discards data rather than pushes it out to swap,
 144  * as some implementations do.  This has performance implications for
 145  * applications like large transactional databases which want to discard
 146  * pages in anonymous maps after committing to backing store the data
 147  * that was kept in them.  There is no reason to write this data out to
 148  * the swap area if the application is discarding it.
 149  *
 150  * An interface that causes the system to free clean pages and flush
 151  * dirty pages is already available as msync(MS_INVALIDATE).
 152  */
 153 static long madvise_dontneed(struct vm_area_struct * vma,
 154                              struct vm_area_struct ** prev,
 155                              unsigned long start, unsigned long end)
 156 {
 157         *prev = vma;
 158         if (vma->vm_flags & (VM_LOCKED|VM_HUGETLB|VM_PFNMAP))
 159                 return -EINVAL;
 160
 161         if (unlikely(vma->vm_flags & VM_NONLINEAR)) {
 162                 struct zap_details details = {
 163                         .nonlinear_vma = vma,
 164                         .last_index = ULONG_MAX,
 165                 };
 166                 zap_page_range(vma, start, end - start, &details);
 167         } else
 168                 zap_page_range(vma, start, end - start, NULL);
 169         return 0;
 170 }
 171
 172 /*
 173  * Application wants to free up the pages and associated backing store.
 174  * This is effectively punching a hole into the middle of a file.
 175  *
 176  * NOTE: Currently, only shmfs/tmpfs is supported for this operation.
 177  * Other filesystems return -ENOSYS.
 178  */
 179 static long madvise_remove(struct vm_area_struct *vma,
 180                                 struct vm_area_struct **prev,
 181                                 unsigned long start, unsigned long end)
 182 {
 183         struct address_space *mapping;
 184         loff_t offset, endoff;
 185         int error;
 186
 187         *prev = NULL;   /* tell sys_madvise we drop mmap_sem */
 188
 189         if (vma->vm_flags & (VM_LOCKED|VM_NONLINEAR|VM_HUGETLB))
 190                 return -EINVAL;
 191
 192         if (!vma->vm_file || !vma->vm_file->f_mapping
 193                 || !vma->vm_file->f_mapping->host) {
 194                         return -EINVAL;
 195         }
 196
 197         if ((vma->vm_flags & (VM_SHARED|VM_WRITE)) != (VM_SHARED|VM_WRITE))
 198                 return -EACCES;
 199
 200         mapping = vma->vm_file->f_mapping;
 201
 202         offset = (loff_t)(start - vma->vm_start)
 203                         + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
 204         endoff = (loff_t)(end - vma->vm_start - 1)
 205                         + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
 206
 207         /* vmtruncate_range needs to take i_mutex and i_alloc_sem */
 208         up_read(&current->mm->mmap_sem);
 209         error = vmtruncate_range(mapping->host, offset, endoff);
 210         down_read(&current->mm->mmap_sem);
 211         return error;
 212 }
 213
 214 static long
 215 madvise_vma(struct vm_area_struct *vma, struct vm_area_struct **prev,
 216                 unsigned long start, unsigned long end, int behavior)
 217 {
 218         switch (behavior) {
 219         case MADV_REMOVE:
 220                 return madvise_remove(vma, prev, start, end);
 221         case MADV_WILLNEED:
 222                 return madvise_willneed(vma, prev, start, end);
 223         case MADV_DONTNEED:
 224                 return madvise_dontneed(vma, prev, start, end);
 225         default:
 226                 return madvise_behavior(vma, prev, start, end, behavior);
 227         }
 228 }
 229
 230 static int
 231 madvise_behavior_valid(int behavior)
 232 {
 233         switch (behavior) {
 234         case MADV_DOFORK:
 235         case MADV_DONTFORK:
 236         case MADV_NORMAL:
 237         case MADV_SEQUENTIAL:
 238         case MADV_RANDOM:
 239         case MADV_REMOVE:
 240         case MADV_WILLNEED:
 241         case MADV_DONTNEED:
 242                 return 1;
 243
 244         default:
 245                 return 0;
 246         }
 247 }
 248
 249 /*
 250  * The madvise(2) system call.
 251  *
 252  * Applications can use madvise() to advise the kernel how it should
 253  * handle paging I/O in this VM area.  The idea is to help the kernel
 254  * use appropriate read-ahead and caching techniques.  The information
 255  * provided is advisory only, and can be safely disregarded by the
 256  * kernel without affecting the correct operation of the application.
 257  *
 258  * behavior values:
 259  *  MADV_NORMAL - the default behavior is to read clusters.  This
 260  *              results in some read-ahead and read-behind.
 261  *  MADV_RANDOM - the system should read the minimum amount of data
 262  *              on any access, since it is unlikely that the appli-
 263  *              cation will need more than what it asks for.
 264  *  MADV_SEQUENTIAL - pages in the given range will probably be accessed
 265  *              once, so they can be aggressively read ahead, and
 266  *              can be freed soon after they are accessed.
 267  *  MADV_WILLNEED - the application is notifying the system to read
 268  *              some pages ahead.
 269  *  MADV_DONTNEED - the application is finished with the given range,
 270  *              so the kernel can free resources associated with it.
 271  *  MADV_REMOVE - the application wants to free up the given range of
 272  *              pages and associated backing store.
 273  *  MADV_DONTFORK - omit this area from child's address space when forking:
 274  *              typically, to avoid COWing pages pinned by get_user_pages().
 275  *  MADV_DOFORK - cancel MADV_DONTFORK: no longer omit this area when forking.
 276  *
 277  * return values:
 278  *  zero    - success
 279  *  -EINVAL - start + len < 0, start is not page-aligned,
 280  *              "behavior" is not a valid value, or application
 281  *              is attempting to release locked or shared pages.
 282  *  -ENOMEM - addresses in the specified range are not currently
 283  *              mapped, or are outside the AS of the process.
 284  *  -EIO    - an I/O error occurred while paging in data.
 285  *  -EBADF  - map exists, but area maps something that isn't a file.
 286  *  -EAGAIN - a kernel resource was temporarily unavailable.
 287  */
 288 SYSCALL_DEFINE3(madvise, unsigned long, start, size_t, len_in, int, behavior)
 289 {
 290         unsigned long end, tmp;
 291         struct vm_area_struct * vma, *prev;
 292         int unmapped_error = 0;
 293         int error = -EINVAL;
 294         int write;
 295         size_t len;
 296
 297         if (!madvise_behavior_valid(behavior))
 298                 return error;
 299
 300         write = madvise_need_mmap_write(behavior);
 301         if (write)
 302                 down_write(&current->mm->mmap_sem);
 303         else
 304                 down_read(&current->mm->mmap_sem);
 305
 306         if (start & ~PAGE_MASK)
 307                 goto out;
 308         len = (len_in + ~PAGE_MASK) & PAGE_MASK;
 309
 310         /* Check to see whether len was rounded up from small -ve to zero */
 311         if (len_in && !len)
 312                 goto out;
 313
 314         end = start + len;
 315         if (end < start)
 316                 goto out;
 317
 318         error = 0;
 319         if (end == start)
 320                 goto out;
 321
 322         /*
 323          * If the interval [start,end) covers some unmapped address
 324          * ranges, just ignore them, but return -ENOMEM at the end.
 325          * - different from the way of handling in mlock etc.
 326          */
 327         vma = find_vma_prev(current->mm, start, &prev);
 328         if (vma && start > vma->vm_start)
 329                 prev = vma;
 330
 331         for (;;) {
 332                 /* Still start < end. */
 333                 error = -ENOMEM;
 334                 if (!vma)
 335                         goto out;
 336
 337                 /* Here start < (end|vma->vm_end). */
 338                 if (start < vma->vm_start) {
 339                         unmapped_error = -ENOMEM;
 340                         start = vma->vm_start;
 341                         if (start >= end)
 342                                 goto out;
 343                 }
 344
 345                 /* Here vma->vm_start <= start < (end|vma->vm_end) */
 346                 tmp = vma->vm_end;
 347                 if (end < tmp)
 348                         tmp = end;
 349
 350                 /* Here vma->vm_start <= start < tmp <= (end|vma->vm_end). */
 351                 error = madvise_vma(vma, &prev, start, tmp, behavior);
 352                 if (error)
 353                         goto out;
 354                 start = tmp;
 355                 if (prev && start < prev->vm_end)
 356                         start = prev->vm_end;
 357                 error = unmapped_error;
 358                 if (start >= end)
 359                         goto out;
 360                 if (prev)
 361                         vma = prev->vm_next;
 362                 else    /* madvise_remove dropped mmap_sem */
 363                         vma = find_vma(current->mm, start);
 364         }
 365 out:
 366         if (write)
 367                 up_write(&current->mm->mmap_sem);
 368         else
 369                 up_read(&current->mm->mmap_sem);
 370
 371         return error;
 372 }