drivers/staging/android/ashmem.c

   1 /* mm/ashmem.c
   2  *
   3  * Anonymous Shared Memory Subsystem, ashmem
   4  *
   5  * Copyright (C) 2008 Google, Inc.
   6  *
   7  * Robert Love <rlove@google.com>
   8  *
   9  * This software is licensed under the terms of the GNU General Public
  10  * License version 2, as published by the Free Software Foundation, and
  11  * may be copied, distributed, and modified under those terms.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  */
  18
  19 #define pr_fmt(fmt) "ashmem: " fmt
  20
  21 #include <linux/init.h>
  22 #include <linux/export.h>
  23 #include <linux/file.h>
  24 #include <linux/fs.h>
  25 #include <linux/falloc.h>
  26 #include <linux/miscdevice.h>
  27 #include <linux/security.h>
  28 #include <linux/mm.h>
  29 #include <linux/mman.h>
  30 #include <linux/uaccess.h>
  31 #include <linux/personality.h>
  32 #include <linux/bitops.h>
  33 #include <linux/mutex.h>
  34 #include <linux/shmem_fs.h>
  35 #include "ashmem.h"
  36
  37 #define ASHMEM_NAME_PREFIX "dev/ashmem/"
  38 #define ASHMEM_NAME_PREFIX_LEN (sizeof(ASHMEM_NAME_PREFIX) - 1)
  39 #define ASHMEM_FULL_NAME_LEN (ASHMEM_NAME_LEN + ASHMEM_NAME_PREFIX_LEN)
  40
  41 /**
  42  * struct ashmem_area - The anonymous shared memory area
  43  * @name:               The optional name in /proc/pid/maps
  44  * @unpinned_list:      The list of all ashmem areas
  45  * @file:               The shmem-based backing file
  46  * @size:               The size of the mapping, in bytes
  47  * @prot_mask:          The allowed protection bits, as vm_flags
  48  *
  49  * The lifecycle of this structure is from our parent file's open() until
  50  * its release(). It is also protected by 'ashmem_mutex'
  51  *
  52  * Warning: Mappings do NOT pin this structure; It dies on close()
  53  */
  54 struct ashmem_area {
  55         char name[ASHMEM_FULL_NAME_LEN];
  56         struct list_head unpinned_list;
  57         struct file *file;
  58         size_t size;
  59         unsigned long prot_mask;
  60 };
  61
  62 /**
  63  * struct ashmem_range - A range of unpinned/evictable pages
  64  * @lru:                 The entry in the LRU list
  65  * @unpinned:            The entry in its area's unpinned list
  66  * @asma:                The associated anonymous shared memory area.
  67  * @pgstart:             The starting page (inclusive)
  68  * @pgend:               The ending page (inclusive)
  69  * @purged:              The purge status (ASHMEM_NOT or ASHMEM_WAS_PURGED)
  70  *
  71  * The lifecycle of this structure is from unpin to pin.
  72  * It is protected by 'ashmem_mutex'
  73  */
  74 struct ashmem_range {
  75         struct list_head lru;
  76         struct list_head unpinned;
  77         struct ashmem_area *asma;
  78         size_t pgstart;
  79         size_t pgend;
  80         unsigned int purged;
  81 };
  82
  83 /* LRU list of unpinned pages, protected by ashmem_mutex */
  84 static LIST_HEAD(ashmem_lru_list);
  85
  86 /*
  87  * long lru_count - The count of pages on our LRU list.
  88  *
  89  * This is protected by ashmem_mutex.
  90  */
  91 static unsigned long lru_count;
  92
  93 /*
  94  * ashmem_mutex - protects the list of and each individual ashmem_area
  95  *
  96  * Lock Ordering: ashmex_mutex -> i_mutex -> i_alloc_sem
  97  */
  98 static DEFINE_MUTEX(ashmem_mutex);
  99
 100 static struct kmem_cache *ashmem_area_cachep __read_mostly;
 101 static struct kmem_cache *ashmem_range_cachep __read_mostly;
 102
 103 #define range_size(range) \
 104         ((range)->pgend - (range)->pgstart + 1)
 105
 106 #define range_on_lru(range) \
 107         ((range)->purged == ASHMEM_NOT_PURGED)
 108
 109 #define page_range_subsumes_range(range, start, end) \
 110         (((range)->pgstart >= (start)) && ((range)->pgend <= (end)))
 111
 112 #define page_range_subsumed_by_range(range, start, end) \
 113         (((range)->pgstart <= (start)) && ((range)->pgend >= (end)))
 114
 115 #define page_in_range(range, page) \
 116         (((range)->pgstart <= (page)) && ((range)->pgend >= (page)))
 117
 118 #define page_range_in_range(range, start, end) \
 119         (page_in_range(range, start) || page_in_range(range, end) || \
 120                 page_range_subsumes_range(range, start, end))
 121
 122 #define range_before_page(range, page) \
 123         ((range)->pgend < (page))
 124
 125 #define PROT_MASK               (PROT_EXEC | PROT_READ | PROT_WRITE)
 126
 127 /**
 128  * lru_add() - Adds a range of memory to the LRU list
 129  * @range:     The memory range being added.
 130  *
 131  * The range is first added to the end (tail) of the LRU list.
 132  * After this, the size of the range is added to @lru_count
 133  */
 134 static inline void lru_add(struct ashmem_range *range)
 135 {
 136         list_add_tail(&range->lru, &ashmem_lru_list);
 137         lru_count += range_size(range);
 138 }
 139
 140 /**
 141  * lru_del() - Removes a range of memory from the LRU list
 142  * @range:     The memory range being removed
 143  *
 144  * The range is first deleted from the LRU list.
 145  * After this, the size of the range is removed from @lru_count
 146  */
 147 static inline void lru_del(struct ashmem_range *range)
 148 {
 149         list_del(&range->lru);
 150         lru_count -= range_size(range);
 151 }
 152
 153 /**
 154  * range_alloc() - Allocates and initializes a new ashmem_range structure
 155  * @asma:          The associated ashmem_area
 156  * @prev_range:    The previous ashmem_range in the sorted asma->unpinned list
 157  * @purged:        Initial purge status (ASMEM_NOT_PURGED or ASHMEM_WAS_PURGED)
 158  * @start:         The starting page (inclusive)
 159  * @end:           The ending page (inclusive)
 160  *
 161  * This function is protected by ashmem_mutex.
 162  *
 163  * Return: 0 if successful, or -ENOMEM if there is an error
 164  */
 165 static int range_alloc(struct ashmem_area *asma,
 166                        struct ashmem_range *prev_range, unsigned int purged,
 167                        size_t start, size_t end)
 168 {
 169         struct ashmem_range *range;
 170
 171         range = kmem_cache_zalloc(ashmem_range_cachep, GFP_KERNEL);
 172         if (unlikely(!range))
 173                 return -ENOMEM;
 174
 175         range->asma = asma;
 176         range->pgstart = start;
 177         range->pgend = end;
 178         range->purged = purged;
 179
 180         list_add_tail(&range->unpinned, &prev_range->unpinned);
 181
 182         if (range_on_lru(range))
 183                 lru_add(range);
 184
 185         return 0;
 186 }
 187
 188 /**
 189  * range_del() - Deletes and dealloctes an ashmem_range structure
 190  * @range:       The associated ashmem_range that has previously been allocated
 191  */
 192 static void range_del(struct ashmem_range *range)
 193 {
 194         list_del(&range->unpinned);
 195         if (range_on_lru(range))
 196                 lru_del(range);
 197         kmem_cache_free(ashmem_range_cachep, range);
 198 }
 199
 200 /**
 201  * range_shrink() - Shrinks an ashmem_range
 202  * @range:          The associated ashmem_range being shrunk
 203  * @start:          The starting byte of the new range
 204  * @end:            The ending byte of the new range
 205  *
 206  * This does not modify the data inside the existing range in any way - It
 207  * simply shrinks the boundaries of the range.
 208  *
 209  * Theoretically, with a little tweaking, this could eventually be changed
 210  * to range_resize, and expand the lru_count if the new range is larger.
 211  */
 212 static inline void range_shrink(struct ashmem_range *range,
 213                                 size_t start, size_t end)
 214 {
 215         size_t pre = range_size(range);
 216
 217         range->pgstart = start;
 218         range->pgend = end;
 219
 220         if (range_on_lru(range))
 221                 lru_count -= pre - range_size(range);
 222 }
 223
 224 /**
 225  * ashmem_open() - Opens an Anonymous Shared Memory structure
 226  * @inode:         The backing file's index node(?)
 227  * @file:          The backing file
 228  *
 229  * Please note that the ashmem_area is not returned by this function - It is
 230  * instead written to "file->private_data".
 231  *
 232  * Return: 0 if successful, or another code if unsuccessful.
 233  */
 234 static int ashmem_open(struct inode *inode, struct file *file)
 235 {
 236         struct ashmem_area *asma;
 237         int ret;
 238
 239         ret = generic_file_open(inode, file);
 240         if (unlikely(ret))
 241                 return ret;
 242
 243         asma = kmem_cache_zalloc(ashmem_area_cachep, GFP_KERNEL);
 244         if (unlikely(!asma))
 245                 return -ENOMEM;
 246
 247         INIT_LIST_HEAD(&asma->unpinned_list);
 248         memcpy(asma->name, ASHMEM_NAME_PREFIX, ASHMEM_NAME_PREFIX_LEN);
 249         asma->prot_mask = PROT_MASK;
 250         file->private_data = asma;
 251
 252         return 0;
 253 }
 254
 255 /**
 256  * ashmem_release() - Releases an Anonymous Shared Memory structure
 257  * @ignored:          The backing file's Index Node(?) - It is ignored here.
 258  * @file:             The backing file
 259  *
 260  * Return: 0 if successful. If it is anything else, go have a coffee and
 261  * try again.
 262  */
 263 static int ashmem_release(struct inode *ignored, struct file *file)
 264 {
 265         struct ashmem_area *asma = file->private_data;
 266         struct ashmem_range *range, *next;
 267
 268         mutex_lock(&ashmem_mutex);
 269         list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned)
 270                 range_del(range);
 271         mutex_unlock(&ashmem_mutex);
 272
 273         if (asma->file)
 274                 fput(asma->file);
 275         kmem_cache_free(ashmem_area_cachep, asma);
 276
 277         return 0;
 278 }
 279
 280 /**
 281  * ashmem_read() - Reads a set of bytes from an Ashmem-enabled file
 282  * @file:          The associated backing file.
 283  * @buf:           The buffer of data being written to
 284  * @len:           The number of bytes being read
 285  * @pos:           The position of the first byte to read.
 286  *
 287  * Return: 0 if successful, or another return code if not.
 288  */
 289 static ssize_t ashmem_read(struct file *file, char __user *buf,
 290                            size_t len, loff_t *pos)
 291 {
 292         struct ashmem_area *asma = file->private_data;
 293         int ret = 0;
 294
 295         mutex_lock(&ashmem_mutex);
 296
 297         /* If size is not set, or set to 0, always return EOF. */
 298         if (asma->size == 0)
 299                 goto out_unlock;
 300
 301         if (!asma->file) {
 302                 ret = -EBADF;
 303                 goto out_unlock;
 304         }
 305
 306         mutex_unlock(&ashmem_mutex);
 307
 308         /*
 309          * asma and asma->file are used outside the lock here.  We assume
 310          * once asma->file is set it will never be changed, and will not
 311          * be destroyed until all references to the file are dropped and
 312          * ashmem_release is called.
 313          */
 314         ret = __vfs_read(asma->file, buf, len, pos);
 315         if (ret >= 0)
 316                 /** Update backing file pos, since f_ops->read() doesn't */
 317                 asma->file->f_pos = *pos;
 318         return ret;
 319
 320 out_unlock:
 321         mutex_unlock(&ashmem_mutex);
 322         return ret;
 323 }
 324
 325 static loff_t ashmem_llseek(struct file *file, loff_t offset, int origin)
 326 {
 327         struct ashmem_area *asma = file->private_data;
 328         int ret;
 329
 330         mutex_lock(&ashmem_mutex);
 331
 332         if (asma->size == 0) {
 333                 mutex_unlock(&ashmem_mutex);
 334                 return -EINVAL;
 335         }
 336
 337         if (!asma->file) {
 338                 mutex_unlock(&ashmem_mutex);
 339                 return -EBADF;
 340         }
 341
 342         mutex_unlock(&ashmem_mutex);
 343
 344         ret = vfs_llseek(asma->file, offset, origin);
 345         if (ret < 0)
 346                 return ret;
 347
 348         /** Copy f_pos from backing file, since f_ops->llseek() sets it */
 349         file->f_pos = asma->file->f_pos;
 350         return ret;
 351 }
 352
 353 static inline vm_flags_t calc_vm_may_flags(unsigned long prot)
 354 {
 355         return _calc_vm_trans(prot, PROT_READ,  VM_MAYREAD) |
 356                _calc_vm_trans(prot, PROT_WRITE, VM_MAYWRITE) |
 357                _calc_vm_trans(prot, PROT_EXEC,  VM_MAYEXEC);
 358 }
 359
 360 static int ashmem_vmfile_mmap(struct file *file, struct vm_area_struct *vma)
 361 {
 362         /* do not allow to mmap ashmem backing shmem file directly */
 363         return -EPERM;
 364 }
 365
 366 static unsigned long
 367 ashmem_vmfile_get_unmapped_area(struct file *file, unsigned long addr,
 368                                 unsigned long len, unsigned long pgoff,
 369                                 unsigned long flags)
 370 {
 371         return current->mm->get_unmapped_area(file, addr, len, pgoff, flags);
 372 }
 373
 374 static int ashmem_mmap(struct file *file, struct vm_area_struct *vma)
 375 {
 376         static struct file_operations vmfile_fops;
 377         struct ashmem_area *asma = file->private_data;
 378         int ret = 0;
 379
 380         mutex_lock(&ashmem_mutex);
 381
 382         /* user needs to SET_SIZE before mapping */
 383         if (unlikely(!asma->size)) {
 384                 ret = -EINVAL;
 385                 goto out;
 386         }
 387
 388         /* requested mapping size larger than object size */
 389         if (vma->vm_end - vma->vm_start > PAGE_ALIGN(asma->size)) {
 390                 ret = -EINVAL;
 391                 goto out;
 392         }
 393
 394         /* requested protection bits must match our allowed protection mask */
 395         if (unlikely((vma->vm_flags & ~calc_vm_prot_bits(asma->prot_mask)) &
 396                      calc_vm_prot_bits(PROT_MASK))) {
 397                 ret = -EPERM;
 398                 goto out;
 399         }
 400         vma->vm_flags &= ~calc_vm_may_flags(~asma->prot_mask);
 401
 402         if (!asma->file) {
 403                 char *name = ASHMEM_NAME_DEF;
 404                 struct file *vmfile;
 405
 406                 if (asma->name[ASHMEM_NAME_PREFIX_LEN] != '\0')
 407                         name = asma->name;
 408
 409                 /* ... and allocate the backing shmem file */
 410                 vmfile = shmem_file_setup(name, asma->size, vma->vm_flags);
 411                 if (IS_ERR(vmfile)) {
 412                         ret = PTR_ERR(vmfile);
 413                         goto out;
 414                 }
 415                 vmfile->f_mode |= FMODE_LSEEK;
 416                 asma->file = vmfile;
 417                 /*
 418                  * override mmap operation of the vmfile so that it can't be
 419                  * remapped which would lead to creation of a new vma with no
 420                  * asma permission checks. Have to override get_unmapped_area
 421                  * as well to prevent VM_BUG_ON check for f_ops modification.
 422                  */
 423                 if (!vmfile_fops.mmap) {
 424                         vmfile_fops = *vmfile->f_op;
 425                         vmfile_fops.mmap = ashmem_vmfile_mmap;
 426                         vmfile_fops.get_unmapped_area =
 427                                         ashmem_vmfile_get_unmapped_area;
 428                 }
 429                 vmfile->f_op = &vmfile_fops;
 430         }
 431         get_file(asma->file);
 432
 433         /*
 434          * XXX - Reworked to use shmem_zero_setup() instead of
 435          * shmem_set_file while we're in staging. -jstultz
 436          */
 437         if (vma->vm_flags & VM_SHARED) {
 438                 ret = shmem_zero_setup(vma);
 439                 if (ret) {
 440                         fput(asma->file);
 441                         goto out;
 442                 }
 443         }
 444
 445         if (vma->vm_file)
 446                 fput(vma->vm_file);
 447         vma->vm_file = asma->file;
 448
 449 out:
 450         mutex_unlock(&ashmem_mutex);
 451         return ret;
 452 }
 453
 454 /*
 455  * ashmem_shrink - our cache shrinker, called from mm/vmscan.c
 456  *
 457  * 'nr_to_scan' is the number of objects to scan for freeing.
 458  *
 459  * 'gfp_mask' is the mask of the allocation that got us into this mess.
 460  *
 461  * Return value is the number of objects freed or -1 if we cannot
 462  * proceed without risk of deadlock (due to gfp_mask).
 463  *
 464  * We approximate LRU via least-recently-unpinned, jettisoning unpinned partial
 465  * chunks of ashmem regions LRU-wise one-at-a-time until we hit 'nr_to_scan'
 466  * pages freed.
 467  */
 468 static unsigned long
 469 ashmem_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)
 470 {
 471         struct ashmem_range *range, *next;
 472         unsigned long freed = 0;
 473
 474         /* We might recurse into filesystem code, so bail out if necessary */
 475         if (!(sc->gfp_mask & __GFP_FS))
 476                 return SHRINK_STOP;
 477
 478         if (!mutex_trylock(&ashmem_mutex))
 479                 return -1;
 480
 481         list_for_each_entry_safe(range, next, &ashmem_lru_list, lru) {
 482                 loff_t start = range->pgstart * PAGE_SIZE;
 483                 loff_t end = (range->pgend + 1) * PAGE_SIZE;
 484
 485                 vfs_fallocate(range->asma->file,
 486                               FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
 487                               start, end - start);
 488                 range->purged = ASHMEM_WAS_PURGED;
 489                 lru_del(range);
 490
 491                 freed += range_size(range);
 492                 if (--sc->nr_to_scan <= 0)
 493                         break;
 494         }
 495         mutex_unlock(&ashmem_mutex);
 496         return freed;
 497 }
 498
 499 static unsigned long
 500 ashmem_shrink_count(struct shrinker *shrink, struct shrink_control *sc)
 501 {
 502         /*
 503          * note that lru_count is count of pages on the lru, not a count of
 504          * objects on the list. This means the scan function needs to return the
 505          * number of pages freed, not the number of objects scanned.
 506          */
 507         return lru_count;
 508 }
 509
 510 static struct shrinker ashmem_shrinker = {
 511         .count_objects = ashmem_shrink_count,
 512         .scan_objects = ashmem_shrink_scan,
 513         /*
 514          * XXX (dchinner): I wish people would comment on why they need on
 515          * significant changes to the default value here
 516          */
 517         .seeks = DEFAULT_SEEKS * 4,
 518 };
 519
 520 static int set_prot_mask(struct ashmem_area *asma, unsigned long prot)
 521 {
 522         int ret = 0;
 523
 524         mutex_lock(&ashmem_mutex);
 525
 526         /* the user can only remove, not add, protection bits */
 527         if (unlikely((asma->prot_mask & prot) != prot)) {
 528                 ret = -EINVAL;
 529                 goto out;
 530         }
 531
 532         /* does the application expect PROT_READ to imply PROT_EXEC? */
 533         if ((prot & PROT_READ) && (current->personality & READ_IMPLIES_EXEC))
 534                 prot |= PROT_EXEC;
 535
 536         asma->prot_mask = prot;
 537
 538 out:
 539         mutex_unlock(&ashmem_mutex);
 540         return ret;
 541 }
 542
 543 static int set_name(struct ashmem_area *asma, void __user *name)
 544 {
 545         int len;
 546         int ret = 0;
 547         char local_name[ASHMEM_NAME_LEN];
 548
 549         /*
 550          * Holding the ashmem_mutex while doing a copy_from_user might cause
 551          * an data abort which would try to access mmap_sem. If another
 552          * thread has invoked ashmem_mmap then it will be holding the
 553          * semaphore and will be waiting for ashmem_mutex, there by leading to
 554          * deadlock. We'll release the mutex  and take the name to a local
 555          * variable that does not need protection and later copy the local
 556          * variable to the structure member with lock held.
 557          */
 558         len = strncpy_from_user(local_name, name, ASHMEM_NAME_LEN);
 559         if (len < 0)
 560                 return len;
 561         if (len == ASHMEM_NAME_LEN)
 562                 local_name[ASHMEM_NAME_LEN - 1] = '\0';
 563         mutex_lock(&ashmem_mutex);
 564         /* cannot change an existing mapping's name */
 565         if (unlikely(asma->file))
 566                 ret = -EINVAL;
 567         else
 568                 strcpy(asma->name + ASHMEM_NAME_PREFIX_LEN, local_name);
 569
 570         mutex_unlock(&ashmem_mutex);
 571         return ret;
 572 }
 573
 574 static int get_name(struct ashmem_area *asma, void __user *name)
 575 {
 576         int ret = 0;
 577         size_t len;
 578         /*
 579          * Have a local variable to which we'll copy the content
 580          * from asma with the lock held. Later we can copy this to the user
 581          * space safely without holding any locks. So even if we proceed to
 582          * wait for mmap_sem, it won't lead to deadlock.
 583          */
 584         char local_name[ASHMEM_NAME_LEN];
 585
 586         mutex_lock(&ashmem_mutex);
 587         if (asma->name[ASHMEM_NAME_PREFIX_LEN] != '\0') {
 588                 /*
 589                  * Copying only `len', instead of ASHMEM_NAME_LEN, bytes
 590                  * prevents us from revealing one user's stack to another.
 591                  */
 592                 len = strlen(asma->name + ASHMEM_NAME_PREFIX_LEN) + 1;
 593                 memcpy(local_name, asma->name + ASHMEM_NAME_PREFIX_LEN, len);
 594         } else {
 595                 len = sizeof(ASHMEM_NAME_DEF);
 596                 memcpy(local_name, ASHMEM_NAME_DEF, len);
 597         }
 598         mutex_unlock(&ashmem_mutex);
 599
 600         /*
 601          * Now we are just copying from the stack variable to userland
 602          * No lock held
 603          */
 604         if (unlikely(copy_to_user(name, local_name, len)))
 605                 ret = -EFAULT;
 606         return ret;
 607 }
 608
 609 /*
 610  * ashmem_pin - pin the given ashmem region, returning whether it was
 611  * previously purged (ASHMEM_WAS_PURGED) or not (ASHMEM_NOT_PURGED).
 612  *
 613  * Caller must hold ashmem_mutex.
 614  */
 615 static int ashmem_pin(struct ashmem_area *asma, size_t pgstart, size_t pgend)
 616 {
 617         struct ashmem_range *range, *next;
 618         int ret = ASHMEM_NOT_PURGED;
 619
 620         list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned) {
 621                 /* moved past last applicable page; we can short circuit */
 622                 if (range_before_page(range, pgstart))
 623                         break;
 624
 625                 /*
 626                  * The user can ask us to pin pages that span multiple ranges,
 627                  * or to pin pages that aren't even unpinned, so this is messy.
 628                  *
 629                  * Four cases:
 630                  * 1. The requested range subsumes an existing range, so we
 631                  *    just remove the entire matching range.
 632                  * 2. The requested range overlaps the start of an existing
 633                  *    range, so we just update that range.
 634                  * 3. The requested range overlaps the end of an existing
 635                  *    range, so we just update that range.
 636                  * 4. The requested range punches a hole in an existing range,
 637                  *    so we have to update one side of the range and then
 638                  *    create a new range for the other side.
 639                  */
 640                 if (page_range_in_range(range, pgstart, pgend)) {
 641                         ret |= range->purged;
 642
 643                         /* Case #1: Easy. Just nuke the whole thing. */
 644                         if (page_range_subsumes_range(range, pgstart, pgend)) {
 645                                 range_del(range);
 646                                 continue;
 647                         }
 648
 649                         /* Case #2: We overlap from the start, so adjust it */
 650                         if (range->pgstart >= pgstart) {
 651                                 range_shrink(range, pgend + 1, range->pgend);
 652                                 continue;
 653                         }
 654
 655                         /* Case #3: We overlap from the rear, so adjust it */
 656                         if (range->pgend <= pgend) {
 657                                 range_shrink(range, range->pgstart,
 658                                              pgstart - 1);
 659                                 continue;
 660                         }
 661
 662                         /*
 663                          * Case #4: We eat a chunk out of the middle. A bit
 664                          * more complicated, we allocate a new range for the
 665                          * second half and adjust the first chunk's endpoint.
 666                          */
 667                         range_alloc(asma, range, range->purged,
 668                                     pgend + 1, range->pgend);
 669                         range_shrink(range, range->pgstart, pgstart - 1);
 670                         break;
 671                 }
 672         }
 673
 674         return ret;
 675 }
 676
 677 /*
 678  * ashmem_unpin - unpin the given range of pages. Returns zero on success.
 679  *
 680  * Caller must hold ashmem_mutex.
 681  */
 682 static int ashmem_unpin(struct ashmem_area *asma, size_t pgstart, size_t pgend)
 683 {
 684         struct ashmem_range *range, *next;
 685         unsigned int purged = ASHMEM_NOT_PURGED;
 686
 687 restart:
 688         list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned) {
 689                 /* short circuit: this is our insertion point */
 690                 if (range_before_page(range, pgstart))
 691                         break;
 692
 693                 /*
 694                  * The user can ask us to unpin pages that are already entirely
 695                  * or partially pinned. We handle those two cases here.
 696                  */
 697                 if (page_range_subsumed_by_range(range, pgstart, pgend))
 698                         return 0;
 699                 if (page_range_in_range(range, pgstart, pgend)) {
 700                         pgstart = min_t(size_t, range->pgstart, pgstart);
 701                         pgend = max_t(size_t, range->pgend, pgend);
 702                         purged |= range->purged;
 703                         range_del(range);
 704                         goto restart;
 705                 }
 706         }
 707
 708         return range_alloc(asma, range, purged, pgstart, pgend);
 709 }
 710
 711 /*
 712  * ashmem_get_pin_status - Returns ASHMEM_IS_UNPINNED if _any_ pages in the
 713  * given interval are unpinned and ASHMEM_IS_PINNED otherwise.
 714  *
 715  * Caller must hold ashmem_mutex.
 716  */
 717 static int ashmem_get_pin_status(struct ashmem_area *asma, size_t pgstart,
 718                                  size_t pgend)
 719 {
 720         struct ashmem_range *range;
 721         int ret = ASHMEM_IS_PINNED;
 722
 723         list_for_each_entry(range, &asma->unpinned_list, unpinned) {
 724                 if (range_before_page(range, pgstart))
 725                         break;
 726                 if (page_range_in_range(range, pgstart, pgend)) {
 727                         ret = ASHMEM_IS_UNPINNED;
 728                         break;
 729                 }
 730         }
 731
 732         return ret;
 733 }
 734
 735 static int ashmem_pin_unpin(struct ashmem_area *asma, unsigned long cmd,
 736                             void __user *p)
 737 {
 738         struct ashmem_pin pin;
 739         size_t pgstart, pgend;
 740         int ret = -EINVAL;
 741
 742         if (unlikely(copy_from_user(&pin, p, sizeof(pin))))
 743                 return -EFAULT;
 744
 745         mutex_lock(&ashmem_mutex);
 746
 747         if (unlikely(!asma->file))
 748                 goto out_unlock;
 749
 750         /* per custom, you can pass zero for len to mean "everything onward" */
 751         if (!pin.len)
 752                 pin.len = PAGE_ALIGN(asma->size) - pin.offset;
 753
 754         if (unlikely((pin.offset | pin.len) & ~PAGE_MASK))
 755                 goto out_unlock;
 756
 757         if (unlikely(((__u32)-1) - pin.offset < pin.len))
 758                 goto out_unlock;
 759
 760         if (unlikely(PAGE_ALIGN(asma->size) < pin.offset + pin.len))
 761                 goto out_unlock;
 762
 763         pgstart = pin.offset / PAGE_SIZE;
 764         pgend = pgstart + (pin.len / PAGE_SIZE) - 1;
 765
 766         switch (cmd) {
 767         case ASHMEM_PIN:
 768                 ret = ashmem_pin(asma, pgstart, pgend);
 769                 break;
 770         case ASHMEM_UNPIN:
 771                 ret = ashmem_unpin(asma, pgstart, pgend);
 772                 break;
 773         case ASHMEM_GET_PIN_STATUS:
 774                 ret = ashmem_get_pin_status(asma, pgstart, pgend);
 775                 break;
 776         }
 777
 778 out_unlock:
 779         mutex_unlock(&ashmem_mutex);
 780
 781         return ret;
 782 }
 783
 784 static long ashmem_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 785 {
 786         struct ashmem_area *asma = file->private_data;
 787         long ret = -ENOTTY;
 788
 789         switch (cmd) {
 790         case ASHMEM_SET_NAME:
 791                 ret = set_name(asma, (void __user *)arg);
 792                 break;
 793         case ASHMEM_GET_NAME:
 794                 ret = get_name(asma, (void __user *)arg);
 795                 break;
 796         case ASHMEM_SET_SIZE:
 797                 ret = -EINVAL;
 798                 mutex_lock(&ashmem_mutex);
 799                 if (!asma->file) {
 800                         ret = 0;
 801                         asma->size = (size_t)arg;
 802                 }
 803                 mutex_unlock(&ashmem_mutex);
 804                 break;
 805         case ASHMEM_GET_SIZE:
 806                 ret = asma->size;
 807                 break;
 808         case ASHMEM_SET_PROT_MASK:
 809                 ret = set_prot_mask(asma, arg);
 810                 break;
 811         case ASHMEM_GET_PROT_MASK:
 812                 ret = asma->prot_mask;
 813                 break;
 814         case ASHMEM_PIN:
 815         case ASHMEM_UNPIN:
 816         case ASHMEM_GET_PIN_STATUS:
 817                 ret = ashmem_pin_unpin(asma, cmd, (void __user *)arg);
 818                 break;
 819         case ASHMEM_PURGE_ALL_CACHES:
 820                 ret = -EPERM;
 821                 if (capable(CAP_SYS_ADMIN)) {
 822                         struct shrink_control sc = {
 823                                 .gfp_mask = GFP_KERNEL,
 824                                 .nr_to_scan = LONG_MAX,
 825                         };
 826                         ret = ashmem_shrink_count(&ashmem_shrinker, &sc);
 827                         ashmem_shrink_scan(&ashmem_shrinker, &sc);
 828                 }
 829                 break;
 830         }
 831
 832         return ret;
 833 }
 834
 835 /* support of 32bit userspace on 64bit platforms */
 836 #ifdef CONFIG_COMPAT
 837 static long compat_ashmem_ioctl(struct file *file, unsigned int cmd,
 838                                 unsigned long arg)
 839 {
 840         switch (cmd) {
 841         case COMPAT_ASHMEM_SET_SIZE:
 842                 cmd = ASHMEM_SET_SIZE;
 843                 break;
 844         case COMPAT_ASHMEM_SET_PROT_MASK:
 845                 cmd = ASHMEM_SET_PROT_MASK;
 846                 break;
 847         }
 848         return ashmem_ioctl(file, cmd, arg);
 849 }
 850 #endif
 851
 852 static const struct file_operations ashmem_fops = {
 853         .owner = THIS_MODULE,
 854         .open = ashmem_open,
 855         .release = ashmem_release,
 856         .read = ashmem_read,
 857         .llseek = ashmem_llseek,
 858         .mmap = ashmem_mmap,
 859         .unlocked_ioctl = ashmem_ioctl,
 860 #ifdef CONFIG_COMPAT
 861         .compat_ioctl = compat_ashmem_ioctl,
 862 #endif
 863 };
 864
 865 static struct miscdevice ashmem_misc = {
 866         .minor = MISC_DYNAMIC_MINOR,
 867         .name = "ashmem",
 868         .fops = &ashmem_fops,
 869 };
 870
 871 static int __init ashmem_init(void)
 872 {
 873         int ret;
 874
 875         ashmem_area_cachep = kmem_cache_create("ashmem_area_cache",
 876                                                sizeof(struct ashmem_area),
 877                                                0, 0, NULL);
 878         if (unlikely(!ashmem_area_cachep)) {
 879                 pr_err("failed to create slab cache\n");
 880                 return -ENOMEM;
 881         }
 882
 883         ashmem_range_cachep = kmem_cache_create("ashmem_range_cache",
 884                                                 sizeof(struct ashmem_range),
 885                                                 0, 0, NULL);
 886         if (unlikely(!ashmem_range_cachep)) {
 887                 pr_err("failed to create slab cache\n");
 888                 return -ENOMEM;
 889         }
 890
 891         ret = misc_register(&ashmem_misc);
 892         if (unlikely(ret)) {
 893                 pr_err("failed to register misc device!\n");
 894                 return ret;
 895         }
 896
 897         register_shrinker(&ashmem_shrinker);
 898
 899         pr_info("initialized\n");
 900
 901         return 0;
 902 }
 903 device_initcall(ashmem_init);