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