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