[RAMEN9610-21029]staGing: android: ashmem: Disallow ashmem memory from being remapped
[GitHub/MotorolaMobilityLLC/kernel-slsi.git] / drivers / staging / android / ashmem.c
CommitLineData
11980c2a 1/* mm/ashmem.c
2258937b
CJB
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 */
11980c2a 18
c810a399
SK
19#define pr_fmt(fmt) "ashmem: " fmt
20
12950595
PG
21#include <linux/init.h>
22#include <linux/export.h>
11980c2a
RL
23#include <linux/file.h>
24#include <linux/fs.h>
3f31d075 25#include <linux/falloc.h>
11980c2a
RL
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
4d2c9d5d
CJB
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
7d92ea5d 47 * @prot_mask: The allowed protection bits, as vm_flags
4d2c9d5d
CJB
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()
11980c2a
RL
53 */
54struct ashmem_area {
4d2c9d5d
CJB
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;
11980c2a
RL
60};
61
4d2c9d5d
CJB
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'
11980c2a
RL
73 */
74struct ashmem_range {
4d2c9d5d
CJB
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;
11980c2a
RL
81};
82
83/* LRU list of unpinned pages, protected by ashmem_mutex */
84static LIST_HEAD(ashmem_lru_list);
85
801b798c 86/*
4d2c9d5d
CJB
87 * long lru_count - The count of pages on our LRU list.
88 *
89 * This is protected by ashmem_mutex.
90 */
11980c2a
RL
91static unsigned long lru_count;
92
801b798c 93/*
11980c2a
RL
94 * ashmem_mutex - protects the list of and each individual ashmem_area
95 *
96 * Lock Ordering: ashmex_mutex -> i_mutex -> i_alloc_sem
97 */
98static DEFINE_MUTEX(ashmem_mutex);
99
100static struct kmem_cache *ashmem_area_cachep __read_mostly;
101static struct kmem_cache *ashmem_range_cachep __read_mostly;
102
40270ca0
GT
103static inline unsigned long range_size(struct ashmem_range *range)
104{
105 return range->pgend - range->pgstart + 1;
106}
11980c2a 107
40270ca0
GT
108static inline bool range_on_lru(struct ashmem_range *range)
109{
110 return range->purged == ASHMEM_NOT_PURGED;
111}
11980c2a 112
8d60b476
GT
113static inline bool page_range_subsumes_range(struct ashmem_range *range,
114 size_t start, size_t end)
c0ece6c3 115{
8d60b476 116 return (range->pgstart >= start) && (range->pgend <= end);
c0ece6c3 117}
11980c2a 118
8d60b476
GT
119static inline bool page_range_subsumed_by_range(struct ashmem_range *range,
120 size_t start, size_t end)
c0ece6c3 121{
8d60b476 122 return (range->pgstart <= start) && (range->pgend >= end);
c0ece6c3 123}
11980c2a 124
8d60b476 125static inline bool page_in_range(struct ashmem_range *range, size_t page)
e2a83f32 126{
8d60b476 127 return (range->pgstart <= page) && (range->pgend >= page);
e2a83f32 128}
11980c2a 129
8d60b476
GT
130static inline bool page_range_in_range(struct ashmem_range *range,
131 size_t start, size_t end)
c0ece6c3 132{
8d60b476
GT
133 return page_in_range(range, start) || page_in_range(range, end) ||
134 page_range_subsumes_range(range, start, end);
c0ece6c3 135}
11980c2a 136
8d60b476 137static inline bool range_before_page(struct ashmem_range *range, size_t page)
e2a83f32 138{
8d60b476 139 return range->pgend < page;
e2a83f32 140}
11980c2a
RL
141
142#define PROT_MASK (PROT_EXEC | PROT_READ | PROT_WRITE)
143
4d2c9d5d
CJB
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 */
11980c2a
RL
151static 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
4d2c9d5d
CJB
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 */
11980c2a
RL
164static inline void lru_del(struct ashmem_range *range)
165{
166 list_del(&range->lru);
167 lru_count -= range_size(range);
168}
169
4d2c9d5d
CJB
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)
11980c2a 177 *
4d2c9d5d 178 * This function is protected by ashmem_mutex.
11980c2a 179 *
4d2c9d5d 180 * Return: 0 if successful, or -ENOMEM if there is an error
11980c2a
RL
181 */
182static 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
4d2c9d5d
CJB
205/**
206 * range_del() - Deletes and dealloctes an ashmem_range structure
207 * @range: The associated ashmem_range that has previously been allocated
208 */
11980c2a
RL
209static 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
781114ce
CJB
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.
11980c2a 225 *
781114ce
CJB
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.
11980c2a
RL
228 */
229static 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
781114ce
CJB
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 */
11980c2a
RL
251static int ashmem_open(struct inode *inode, struct file *file)
252{
253 struct ashmem_area *asma;
254 int ret;
255
5154b93b 256 ret = generic_file_open(inode, file);
11980c2a
RL
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
781114ce
CJB
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 */
11980c2a
RL
280static 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
8a2af064 297static ssize_t ashmem_read_iter(struct kiocb *iocb, struct iov_iter *iter)
853ca7ae 298{
8a2af064 299 struct ashmem_area *asma = iocb->ki_filp->private_data;
853ca7ae
BB
300 int ret = 0;
301
302 mutex_lock(&ashmem_mutex);
303
304 /* If size is not set, or set to 0, always return EOF. */
1efb3439 305 if (asma->size == 0)
077f6db9 306 goto out_unlock;
853ca7ae
BB
307
308 if (!asma->file) {
309 ret = -EBADF;
077f6db9 310 goto out_unlock;
853ca7ae
BB
311 }
312
077f6db9
TP
313 /*
314 * asma and asma->file are used outside the lock here. We assume
315 * once asma->file is set it will never be changed, and will not
316 * be destroyed until all references to the file are dropped and
317 * ashmem_release is called.
318 */
8a2af064
CH
319 mutex_unlock(&ashmem_mutex);
320 ret = vfs_iter_read(asma->file, iter, &iocb->ki_pos, 0);
321 mutex_lock(&ashmem_mutex);
322 if (ret > 0)
323 asma->file->f_pos = iocb->ki_pos;
077f6db9 324out_unlock:
5154b93b
BB
325 mutex_unlock(&ashmem_mutex);
326 return ret;
327}
328
329static loff_t ashmem_llseek(struct file *file, loff_t offset, int origin)
330{
331 struct ashmem_area *asma = file->private_data;
332 int ret;
333
334 mutex_lock(&ashmem_mutex);
335
336 if (asma->size == 0) {
6de9ee2f
JF
337 mutex_unlock(&ashmem_mutex);
338 return -EINVAL;
5154b93b
BB
339 }
340
341 if (!asma->file) {
6de9ee2f
JF
342 mutex_unlock(&ashmem_mutex);
343 return -EBADF;
5154b93b
BB
344 }
345
6de9ee2f
JF
346 mutex_unlock(&ashmem_mutex);
347
91360b02 348 ret = vfs_llseek(asma->file, offset, origin);
1efb3439 349 if (ret < 0)
6de9ee2f 350 return ret;
5154b93b
BB
351
352 /** Copy f_pos from backing file, since f_ops->llseek() sets it */
353 file->f_pos = asma->file->f_pos;
853ca7ae
BB
354 return ret;
355}
356
7cfce77d 357static inline vm_flags_t calc_vm_may_flags(unsigned long prot)
56f76fc6 358{
1efb3439 359 return _calc_vm_trans(prot, PROT_READ, VM_MAYREAD) |
56f76fc6
AH
360 _calc_vm_trans(prot, PROT_WRITE, VM_MAYWRITE) |
361 _calc_vm_trans(prot, PROT_EXEC, VM_MAYEXEC);
362}
853ca7ae 363
42a49d8a
SB
364static int ashmem_vmfile_mmap(struct file *file, struct vm_area_struct *vma)
365{
366 /* do not allow to mmap ashmem backing shmem file directly */
367 return -EPERM;
368}
369
370static unsigned long
371ashmem_vmfile_get_unmapped_area(struct file *file, unsigned long addr,
372 unsigned long len, unsigned long pgoff,
373 unsigned long flags)
374{
375 return current->mm->get_unmapped_area(file, addr, len, pgoff, flags);
376}
377
11980c2a
RL
378static int ashmem_mmap(struct file *file, struct vm_area_struct *vma)
379{
42a49d8a 380 static struct file_operations vmfile_fops;
11980c2a
RL
381 struct ashmem_area *asma = file->private_data;
382 int ret = 0;
383
384 mutex_lock(&ashmem_mutex);
385
386 /* user needs to SET_SIZE before mapping */
387 if (unlikely(!asma->size)) {
388 ret = -EINVAL;
389 goto out;
390 }
391
3af342f5
AS
392 /* requested mapping size larger than object size */
393 if (vma->vm_end - vma->vm_start > PAGE_ALIGN(asma->size)) {
394 ret = -EINVAL;
395 goto out;
396 }
397
11980c2a 398 /* requested protection bits must match our allowed protection mask */
e6bfb709
DH
399 if (unlikely((vma->vm_flags & ~calc_vm_prot_bits(asma->prot_mask, 0)) &
400 calc_vm_prot_bits(PROT_MASK, 0))) {
11980c2a
RL
401 ret = -EPERM;
402 goto out;
403 }
56f76fc6 404 vma->vm_flags &= ~calc_vm_may_flags(~asma->prot_mask);
11980c2a
RL
405
406 if (!asma->file) {
407 char *name = ASHMEM_NAME_DEF;
408 struct file *vmfile;
409
410 if (asma->name[ASHMEM_NAME_PREFIX_LEN] != '\0')
411 name = asma->name;
412
413 /* ... and allocate the backing shmem file */
414 vmfile = shmem_file_setup(name, asma->size, vma->vm_flags);
7f44cb0b 415 if (IS_ERR(vmfile)) {
11980c2a
RL
416 ret = PTR_ERR(vmfile);
417 goto out;
418 }
97fbfef6 419 vmfile->f_mode |= FMODE_LSEEK;
11980c2a 420 asma->file = vmfile;
42a49d8a
SB
421 /*
422 * override mmap operation of the vmfile so that it can't be
423 * remapped which would lead to creation of a new vma with no
424 * asma permission checks. Have to override get_unmapped_area
425 * as well to prevent VM_BUG_ON check for f_ops modification.
426 */
427 if (!vmfile_fops.mmap) {
428 vmfile_fops = *vmfile->f_op;
429 vmfile_fops.mmap = ashmem_vmfile_mmap;
430 vmfile_fops.get_unmapped_area =
431 ashmem_vmfile_get_unmapped_area;
432 }
433 vmfile->f_op = &vmfile_fops;
11980c2a
RL
434 }
435 get_file(asma->file);
436
ebfc8d64
JS
437 if (vma->vm_flags & VM_SHARED)
438 shmem_set_file(vma, asma->file);
439 else {
440 if (vma->vm_file)
441 fput(vma->vm_file);
442 vma->vm_file = asma->file;
11980c2a
RL
443 }
444
11980c2a
RL
445out:
446 mutex_unlock(&ashmem_mutex);
447 return ret;
448}
449
450/*
6b4f7799 451 * ashmem_shrink - our cache shrinker, called from mm/vmscan.c
11980c2a 452 *
7dc19d5a 453 * 'nr_to_scan' is the number of objects to scan for freeing.
11980c2a
RL
454 *
455 * 'gfp_mask' is the mask of the allocation that got us into this mess.
456 *
7dc19d5a 457 * Return value is the number of objects freed or -1 if we cannot
11980c2a
RL
458 * proceed without risk of deadlock (due to gfp_mask).
459 *
460 * We approximate LRU via least-recently-unpinned, jettisoning unpinned partial
461 * chunks of ashmem regions LRU-wise one-at-a-time until we hit 'nr_to_scan'
462 * pages freed.
463 */
7dc19d5a
DC
464static unsigned long
465ashmem_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)
11980c2a
RL
466{
467 struct ashmem_range *range, *next;
7dc19d5a 468 unsigned long freed = 0;
11980c2a
RL
469
470 /* We might recurse into filesystem code, so bail out if necessary */
7dc19d5a
DC
471 if (!(sc->gfp_mask & __GFP_FS))
472 return SHRINK_STOP;
11980c2a 473
18e77054
LA
474 if (!mutex_trylock(&ashmem_mutex))
475 return -1;
476
11980c2a 477 list_for_each_entry_safe(range, next, &ashmem_lru_list, lru) {
11980c2a 478 loff_t start = range->pgstart * PAGE_SIZE;
3f31d075 479 loff_t end = (range->pgend + 1) * PAGE_SIZE;
11980c2a 480
daf3169c
TL
481 range->asma->file->f_op->fallocate(range->asma->file,
482 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
483 start, end - start);
11980c2a
RL
484 range->purged = ASHMEM_WAS_PURGED;
485 lru_del(range);
486
7dc19d5a
DC
487 freed += range_size(range);
488 if (--sc->nr_to_scan <= 0)
11980c2a
RL
489 break;
490 }
491 mutex_unlock(&ashmem_mutex);
7dc19d5a
DC
492 return freed;
493}
11980c2a 494
7dc19d5a
DC
495static unsigned long
496ashmem_shrink_count(struct shrinker *shrink, struct shrink_control *sc)
497{
498 /*
499 * note that lru_count is count of pages on the lru, not a count of
500 * objects on the list. This means the scan function needs to return the
501 * number of pages freed, not the number of objects scanned.
502 */
11980c2a
RL
503 return lru_count;
504}
505
506static struct shrinker ashmem_shrinker = {
7dc19d5a
DC
507 .count_objects = ashmem_shrink_count,
508 .scan_objects = ashmem_shrink_scan,
509 /*
510 * XXX (dchinner): I wish people would comment on why they need on
511 * significant changes to the default value here
512 */
11980c2a
RL
513 .seeks = DEFAULT_SEEKS * 4,
514};
515
516static int set_prot_mask(struct ashmem_area *asma, unsigned long prot)
517{
518 int ret = 0;
519
520 mutex_lock(&ashmem_mutex);
521
522 /* the user can only remove, not add, protection bits */
523 if (unlikely((asma->prot_mask & prot) != prot)) {
524 ret = -EINVAL;
525 goto out;
526 }
527
528 /* does the application expect PROT_READ to imply PROT_EXEC? */
529 if ((prot & PROT_READ) && (current->personality & READ_IMPLIES_EXEC))
530 prot |= PROT_EXEC;
531
532 asma->prot_mask = prot;
533
534out:
535 mutex_unlock(&ashmem_mutex);
536 return ret;
537}
538
539static int set_name(struct ashmem_area *asma, void __user *name)
540{
077f6db9 541 int len;
11980c2a 542 int ret = 0;
e5834d62 543 char local_name[ASHMEM_NAME_LEN];
11980c2a 544
e5834d62
SB
545 /*
546 * Holding the ashmem_mutex while doing a copy_from_user might cause
547 * an data abort which would try to access mmap_sem. If another
548 * thread has invoked ashmem_mmap then it will be holding the
549 * semaphore and will be waiting for ashmem_mutex, there by leading to
550 * deadlock. We'll release the mutex and take the name to a local
551 * variable that does not need protection and later copy the local
552 * variable to the structure member with lock held.
553 */
077f6db9
TP
554 len = strncpy_from_user(local_name, name, ASHMEM_NAME_LEN);
555 if (len < 0)
556 return len;
557 if (len == ASHMEM_NAME_LEN)
558 local_name[ASHMEM_NAME_LEN - 1] = '\0';
e5834d62 559 mutex_lock(&ashmem_mutex);
11980c2a 560 /* cannot change an existing mapping's name */
077f6db9 561 if (unlikely(asma->file))
11980c2a 562 ret = -EINVAL;
077f6db9
TP
563 else
564 strcpy(asma->name + ASHMEM_NAME_PREFIX_LEN, local_name);
11980c2a 565
077f6db9 566 mutex_unlock(&ashmem_mutex);
11980c2a
RL
567 return ret;
568}
569
570static int get_name(struct ashmem_area *asma, void __user *name)
571{
572 int ret = 0;
e5834d62
SB
573 size_t len;
574 /*
575 * Have a local variable to which we'll copy the content
576 * from asma with the lock held. Later we can copy this to the user
577 * space safely without holding any locks. So even if we proceed to
578 * wait for mmap_sem, it won't lead to deadlock.
579 */
580 char local_name[ASHMEM_NAME_LEN];
11980c2a
RL
581
582 mutex_lock(&ashmem_mutex);
583 if (asma->name[ASHMEM_NAME_PREFIX_LEN] != '\0') {
11980c2a
RL
584 /*
585 * Copying only `len', instead of ASHMEM_NAME_LEN, bytes
586 * prevents us from revealing one user's stack to another.
587 */
588 len = strlen(asma->name + ASHMEM_NAME_PREFIX_LEN) + 1;
e5834d62 589 memcpy(local_name, asma->name + ASHMEM_NAME_PREFIX_LEN, len);
11980c2a 590 } else {
e5834d62
SB
591 len = sizeof(ASHMEM_NAME_DEF);
592 memcpy(local_name, ASHMEM_NAME_DEF, len);
11980c2a
RL
593 }
594 mutex_unlock(&ashmem_mutex);
595
e5834d62
SB
596 /*
597 * Now we are just copying from the stack variable to userland
598 * No lock held
599 */
600 if (unlikely(copy_to_user(name, local_name, len)))
601 ret = -EFAULT;
11980c2a
RL
602 return ret;
603}
604
605/*
606 * ashmem_pin - pin the given ashmem region, returning whether it was
607 * previously purged (ASHMEM_WAS_PURGED) or not (ASHMEM_NOT_PURGED).
608 *
609 * Caller must hold ashmem_mutex.
610 */
611static int ashmem_pin(struct ashmem_area *asma, size_t pgstart, size_t pgend)
612{
613 struct ashmem_range *range, *next;
614 int ret = ASHMEM_NOT_PURGED;
615
616 list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned) {
617 /* moved past last applicable page; we can short circuit */
618 if (range_before_page(range, pgstart))
619 break;
620
621 /*
622 * The user can ask us to pin pages that span multiple ranges,
623 * or to pin pages that aren't even unpinned, so this is messy.
624 *
625 * Four cases:
626 * 1. The requested range subsumes an existing range, so we
627 * just remove the entire matching range.
628 * 2. The requested range overlaps the start of an existing
629 * range, so we just update that range.
630 * 3. The requested range overlaps the end of an existing
631 * range, so we just update that range.
632 * 4. The requested range punches a hole in an existing range,
633 * so we have to update one side of the range and then
634 * create a new range for the other side.
635 */
636 if (page_range_in_range(range, pgstart, pgend)) {
637 ret |= range->purged;
638
639 /* Case #1: Easy. Just nuke the whole thing. */
640 if (page_range_subsumes_range(range, pgstart, pgend)) {
641 range_del(range);
642 continue;
643 }
644
645 /* Case #2: We overlap from the start, so adjust it */
646 if (range->pgstart >= pgstart) {
647 range_shrink(range, pgend + 1, range->pgend);
648 continue;
649 }
650
651 /* Case #3: We overlap from the rear, so adjust it */
652 if (range->pgend <= pgend) {
d2e4f687
PS
653 range_shrink(range, range->pgstart,
654 pgstart - 1);
11980c2a
RL
655 continue;
656 }
657
658 /*
659 * Case #4: We eat a chunk out of the middle. A bit
660 * more complicated, we allocate a new range for the
661 * second half and adjust the first chunk's endpoint.
662 */
663 range_alloc(asma, range, range->purged,
664 pgend + 1, range->pgend);
665 range_shrink(range, range->pgstart, pgstart - 1);
666 break;
667 }
668 }
669
670 return ret;
671}
672
673/*
674 * ashmem_unpin - unpin the given range of pages. Returns zero on success.
675 *
676 * Caller must hold ashmem_mutex.
677 */
678static int ashmem_unpin(struct ashmem_area *asma, size_t pgstart, size_t pgend)
679{
680 struct ashmem_range *range, *next;
681 unsigned int purged = ASHMEM_NOT_PURGED;
682
683restart:
684 list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned) {
685 /* short circuit: this is our insertion point */
686 if (range_before_page(range, pgstart))
687 break;
688
689 /*
690 * The user can ask us to unpin pages that are already entirely
691 * or partially pinned. We handle those two cases here.
692 */
693 if (page_range_subsumed_by_range(range, pgstart, pgend))
694 return 0;
695 if (page_range_in_range(range, pgstart, pgend)) {
9f1c427d
AKC
696 pgstart = min(range->pgstart, pgstart);
697 pgend = max(range->pgend, pgend);
11980c2a
RL
698 purged |= range->purged;
699 range_del(range);
700 goto restart;
701 }
702 }
703
704 return range_alloc(asma, range, purged, pgstart, pgend);
705}
706
707/*
708 * ashmem_get_pin_status - Returns ASHMEM_IS_UNPINNED if _any_ pages in the
709 * given interval are unpinned and ASHMEM_IS_PINNED otherwise.
710 *
711 * Caller must hold ashmem_mutex.
712 */
713static int ashmem_get_pin_status(struct ashmem_area *asma, size_t pgstart,
714 size_t pgend)
715{
716 struct ashmem_range *range;
717 int ret = ASHMEM_IS_PINNED;
718
719 list_for_each_entry(range, &asma->unpinned_list, unpinned) {
720 if (range_before_page(range, pgstart))
721 break;
722 if (page_range_in_range(range, pgstart, pgend)) {
723 ret = ASHMEM_IS_UNPINNED;
724 break;
725 }
726 }
727
728 return ret;
729}
730
731static int ashmem_pin_unpin(struct ashmem_area *asma, unsigned long cmd,
732 void __user *p)
733{
734 struct ashmem_pin pin;
735 size_t pgstart, pgend;
736 int ret = -EINVAL;
737
fdcb8f51
YX
738 if (unlikely(copy_from_user(&pin, p, sizeof(pin))))
739 return -EFAULT;
740
95f9c2ed
BH
741 mutex_lock(&ashmem_mutex);
742
11980c2a 743 if (unlikely(!asma->file))
95f9c2ed 744 goto out_unlock;
11980c2a 745
11980c2a
RL
746 /* per custom, you can pass zero for len to mean "everything onward" */
747 if (!pin.len)
748 pin.len = PAGE_ALIGN(asma->size) - pin.offset;
749
750 if (unlikely((pin.offset | pin.len) & ~PAGE_MASK))
95f9c2ed 751 goto out_unlock;
11980c2a 752
b8d3bfa7 753 if (unlikely(((__u32)-1) - pin.offset < pin.len))
95f9c2ed 754 goto out_unlock;
11980c2a
RL
755
756 if (unlikely(PAGE_ALIGN(asma->size) < pin.offset + pin.len))
95f9c2ed 757 goto out_unlock;
11980c2a
RL
758
759 pgstart = pin.offset / PAGE_SIZE;
760 pgend = pgstart + (pin.len / PAGE_SIZE) - 1;
761
11980c2a
RL
762 switch (cmd) {
763 case ASHMEM_PIN:
764 ret = ashmem_pin(asma, pgstart, pgend);
765 break;
766 case ASHMEM_UNPIN:
767 ret = ashmem_unpin(asma, pgstart, pgend);
768 break;
769 case ASHMEM_GET_PIN_STATUS:
770 ret = ashmem_get_pin_status(asma, pgstart, pgend);
771 break;
772 }
773
95f9c2ed 774out_unlock:
11980c2a
RL
775 mutex_unlock(&ashmem_mutex);
776
777 return ret;
778}
779
780static long ashmem_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
781{
782 struct ashmem_area *asma = file->private_data;
783 long ret = -ENOTTY;
784
785 switch (cmd) {
786 case ASHMEM_SET_NAME:
1703ca90 787 ret = set_name(asma, (void __user *)arg);
11980c2a
RL
788 break;
789 case ASHMEM_GET_NAME:
1703ca90 790 ret = get_name(asma, (void __user *)arg);
11980c2a
RL
791 break;
792 case ASHMEM_SET_SIZE:
793 ret = -EINVAL;
242e20a5 794 mutex_lock(&ashmem_mutex);
11980c2a
RL
795 if (!asma->file) {
796 ret = 0;
b8d3bfa7 797 asma->size = (size_t)arg;
11980c2a 798 }
242e20a5 799 mutex_unlock(&ashmem_mutex);
11980c2a
RL
800 break;
801 case ASHMEM_GET_SIZE:
802 ret = asma->size;
803 break;
804 case ASHMEM_SET_PROT_MASK:
805 ret = set_prot_mask(asma, arg);
806 break;
807 case ASHMEM_GET_PROT_MASK:
808 ret = asma->prot_mask;
809 break;
810 case ASHMEM_PIN:
811 case ASHMEM_UNPIN:
812 case ASHMEM_GET_PIN_STATUS:
1703ca90 813 ret = ashmem_pin_unpin(asma, cmd, (void __user *)arg);
11980c2a
RL
814 break;
815 case ASHMEM_PURGE_ALL_CACHES:
816 ret = -EPERM;
817 if (capable(CAP_SYS_ADMIN)) {
33e8fc46
CC
818 struct shrink_control sc = {
819 .gfp_mask = GFP_KERNEL,
7dc19d5a 820 .nr_to_scan = LONG_MAX,
33e8fc46 821 };
59573240 822 ret = ashmem_shrink_count(&ashmem_shrinker, &sc);
7dc19d5a 823 ashmem_shrink_scan(&ashmem_shrinker, &sc);
11980c2a
RL
824 }
825 break;
826 }
827
828 return ret;
829}
830
e9f5b814
SC
831/* support of 32bit userspace on 64bit platforms */
832#ifdef CONFIG_COMPAT
017ca3bf
MR
833static long compat_ashmem_ioctl(struct file *file, unsigned int cmd,
834 unsigned long arg)
e9f5b814 835{
e9f5b814
SC
836 switch (cmd) {
837 case COMPAT_ASHMEM_SET_SIZE:
838 cmd = ASHMEM_SET_SIZE;
839 break;
840 case COMPAT_ASHMEM_SET_PROT_MASK:
841 cmd = ASHMEM_SET_PROT_MASK;
842 break;
843 }
844 return ashmem_ioctl(file, cmd, arg);
845}
846#endif
847
aa5af974 848static const struct file_operations ashmem_fops = {
11980c2a
RL
849 .owner = THIS_MODULE,
850 .open = ashmem_open,
851 .release = ashmem_release,
8a2af064 852 .read_iter = ashmem_read_iter,
1efb3439 853 .llseek = ashmem_llseek,
11980c2a
RL
854 .mmap = ashmem_mmap,
855 .unlocked_ioctl = ashmem_ioctl,
e9f5b814
SC
856#ifdef CONFIG_COMPAT
857 .compat_ioctl = compat_ashmem_ioctl,
858#endif
11980c2a
RL
859};
860
861static struct miscdevice ashmem_misc = {
862 .minor = MISC_DYNAMIC_MINOR,
863 .name = "ashmem",
864 .fops = &ashmem_fops,
865};
866
867static int __init ashmem_init(void)
868{
a2df4e33 869 int ret = -ENOMEM;
11980c2a
RL
870
871 ashmem_area_cachep = kmem_cache_create("ashmem_area_cache",
7048c1fc
PS
872 sizeof(struct ashmem_area),
873 0, 0, NULL);
11980c2a 874 if (unlikely(!ashmem_area_cachep)) {
c810a399 875 pr_err("failed to create slab cache\n");
a2df4e33 876 goto out;
11980c2a
RL
877 }
878
879 ashmem_range_cachep = kmem_cache_create("ashmem_range_cache",
7048c1fc
PS
880 sizeof(struct ashmem_range),
881 0, 0, NULL);
11980c2a 882 if (unlikely(!ashmem_range_cachep)) {
c810a399 883 pr_err("failed to create slab cache\n");
a2df4e33 884 goto out_free1;
11980c2a
RL
885 }
886
887 ret = misc_register(&ashmem_misc);
888 if (unlikely(ret)) {
c810a399 889 pr_err("failed to register misc device!\n");
a2df4e33 890 goto out_free2;
11980c2a
RL
891 }
892
893 register_shrinker(&ashmem_shrinker);
894
c810a399 895 pr_info("initialized\n");
11980c2a
RL
896
897 return 0;
a2df4e33
WT
898
899out_free2:
900 kmem_cache_destroy(ashmem_range_cachep);
901out_free1:
902 kmem_cache_destroy(ashmem_area_cachep);
903out:
904 return ret;
11980c2a 905}
12950595 906device_initcall(ashmem_init);