drivers/staging/android/ashmem.c

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