blob: 5af176b707a3e65dc8ba4922c64a1217884609a4 [file] [log] [blame]
Robert Love11980c22011-12-20 16:49:48 -08001/* mm/ashmem.c
Cruz Julian Bishop22589372012-08-01 14:54:16 +10002 *
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 */
Robert Love11980c22011-12-20 16:49:48 -080018
Sachin Kamatc810a392012-06-05 16:40:10 +053019#define pr_fmt(fmt) "ashmem: " fmt
20
Paul Gortmaker129505952015-10-11 15:47:28 -040021#include <linux/init.h>
22#include <linux/export.h>
Robert Love11980c22011-12-20 16:49:48 -080023#include <linux/file.h>
24#include <linux/fs.h>
Hugh Dickins3f31d072012-05-29 15:06:40 -070025#include <linux/falloc.h>
Robert Love11980c22011-12-20 16:49:48 -080026#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
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +100041/**
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
Cristina Moraru7d92ea52015-10-03 18:20:47 +030047 * @prot_mask: The allowed protection bits, as vm_flags
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +100048 *
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()
Robert Love11980c22011-12-20 16:49:48 -080053 */
54struct ashmem_area {
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +100055 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;
Robert Love11980c22011-12-20 16:49:48 -080060};
61
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +100062/**
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'
Robert Love11980c22011-12-20 16:49:48 -080073 */
74struct ashmem_range {
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +100075 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;
Robert Love11980c22011-12-20 16:49:48 -080081};
82
83/* LRU list of unpinned pages, protected by ashmem_mutex */
84static LIST_HEAD(ashmem_lru_list);
85
Cristina Moraru801b7982015-10-03 18:45:01 +030086/*
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +100087 * long lru_count - The count of pages on our LRU list.
88 *
89 * This is protected by ashmem_mutex.
90 */
Robert Love11980c22011-12-20 16:49:48 -080091static unsigned long lru_count;
92
Cristina Moraru801b7982015-10-03 18:45:01 +030093/*
Robert Love11980c22011-12-20 16:49:48 -080094 * 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
103#define range_size(range) \
John Stultz1efb3432011-12-20 16:49:54 -0800104 ((range)->pgend - (range)->pgstart + 1)
Robert Love11980c22011-12-20 16:49:48 -0800105
106#define range_on_lru(range) \
John Stultz1efb3432011-12-20 16:49:54 -0800107 ((range)->purged == ASHMEM_NOT_PURGED)
Robert Love11980c22011-12-20 16:49:48 -0800108
Bhumika Goyalc0ece6c2016-03-11 19:33:05 +0530109static inline int page_range_subsumes_range(struct ashmem_range *range,
110 size_t start, size_t end)
111{
112 return (((range)->pgstart >= (start)) && ((range)->pgend <= (end)));
113}
Robert Love11980c22011-12-20 16:49:48 -0800114
Bhumika Goyalc0ece6c2016-03-11 19:33:05 +0530115static inline int page_range_subsumed_by_range(struct ashmem_range *range,
116 size_t start, size_t end)
117{
118 return (((range)->pgstart <= (start)) && ((range)->pgend >= (end)));
119}
Robert Love11980c22011-12-20 16:49:48 -0800120
Bhumika Goyale2a83f32016-03-11 19:33:04 +0530121static inline int page_in_range(struct ashmem_range *range, size_t page)
122{
123 return (((range)->pgstart <= (page)) && ((range)->pgend >= (page)));
124}
Robert Love11980c22011-12-20 16:49:48 -0800125
Bhumika Goyalc0ece6c2016-03-11 19:33:05 +0530126static inline int page_range_in_range(struct ashmem_range *range,
127 size_t start, size_t end)
128{
129 return (page_in_range(range, start) || page_in_range(range, end) ||
130 page_range_subsumes_range(range, start, end));
131}
Robert Love11980c22011-12-20 16:49:48 -0800132
Bhumika Goyale2a83f32016-03-11 19:33:04 +0530133static inline int range_before_page(struct ashmem_range *range, size_t page)
134{
135 return ((range)->pgend < (page));
136}
Robert Love11980c22011-12-20 16:49:48 -0800137
138#define PROT_MASK (PROT_EXEC | PROT_READ | PROT_WRITE)
139
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +1000140/**
141 * lru_add() - Adds a range of memory to the LRU list
142 * @range: The memory range being added.
143 *
144 * The range is first added to the end (tail) of the LRU list.
145 * After this, the size of the range is added to @lru_count
146 */
Robert Love11980c22011-12-20 16:49:48 -0800147static inline void lru_add(struct ashmem_range *range)
148{
149 list_add_tail(&range->lru, &ashmem_lru_list);
150 lru_count += range_size(range);
151}
152
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +1000153/**
154 * lru_del() - Removes a range of memory from the LRU list
155 * @range: The memory range being removed
156 *
157 * The range is first deleted from the LRU list.
158 * After this, the size of the range is removed from @lru_count
159 */
Robert Love11980c22011-12-20 16:49:48 -0800160static inline void lru_del(struct ashmem_range *range)
161{
162 list_del(&range->lru);
163 lru_count -= range_size(range);
164}
165
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +1000166/**
167 * range_alloc() - Allocates and initializes a new ashmem_range structure
168 * @asma: The associated ashmem_area
169 * @prev_range: The previous ashmem_range in the sorted asma->unpinned list
170 * @purged: Initial purge status (ASMEM_NOT_PURGED or ASHMEM_WAS_PURGED)
171 * @start: The starting page (inclusive)
172 * @end: The ending page (inclusive)
Robert Love11980c22011-12-20 16:49:48 -0800173 *
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +1000174 * This function is protected by ashmem_mutex.
Robert Love11980c22011-12-20 16:49:48 -0800175 *
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +1000176 * Return: 0 if successful, or -ENOMEM if there is an error
Robert Love11980c22011-12-20 16:49:48 -0800177 */
178static int range_alloc(struct ashmem_area *asma,
179 struct ashmem_range *prev_range, unsigned int purged,
180 size_t start, size_t end)
181{
182 struct ashmem_range *range;
183
184 range = kmem_cache_zalloc(ashmem_range_cachep, GFP_KERNEL);
185 if (unlikely(!range))
186 return -ENOMEM;
187
188 range->asma = asma;
189 range->pgstart = start;
190 range->pgend = end;
191 range->purged = purged;
192
193 list_add_tail(&range->unpinned, &prev_range->unpinned);
194
195 if (range_on_lru(range))
196 lru_add(range);
197
198 return 0;
199}
200
Cruz Julian Bishop4d2c9d52013-09-03 22:05:07 +1000201/**
202 * range_del() - Deletes and dealloctes an ashmem_range structure
203 * @range: The associated ashmem_range that has previously been allocated
204 */
Robert Love11980c22011-12-20 16:49:48 -0800205static void range_del(struct ashmem_range *range)
206{
207 list_del(&range->unpinned);
208 if (range_on_lru(range))
209 lru_del(range);
210 kmem_cache_free(ashmem_range_cachep, range);
211}
212
Cruz Julian Bishop781114c2013-09-03 22:05:08 +1000213/**
214 * range_shrink() - Shrinks an ashmem_range
215 * @range: The associated ashmem_range being shrunk
216 * @start: The starting byte of the new range
217 * @end: The ending byte of the new range
Robert Love11980c22011-12-20 16:49:48 -0800218 *
Cruz Julian Bishop781114c2013-09-03 22:05:08 +1000219 * This does not modify the data inside the existing range in any way - It
220 * simply shrinks the boundaries of the range.
221 *
222 * Theoretically, with a little tweaking, this could eventually be changed
223 * to range_resize, and expand the lru_count if the new range is larger.
Robert Love11980c22011-12-20 16:49:48 -0800224 */
225static inline void range_shrink(struct ashmem_range *range,
226 size_t start, size_t end)
227{
228 size_t pre = range_size(range);
229
230 range->pgstart = start;
231 range->pgend = end;
232
233 if (range_on_lru(range))
234 lru_count -= pre - range_size(range);
235}
236
Cruz Julian Bishop781114c2013-09-03 22:05:08 +1000237/**
238 * ashmem_open() - Opens an Anonymous Shared Memory structure
239 * @inode: The backing file's index node(?)
240 * @file: The backing file
241 *
242 * Please note that the ashmem_area is not returned by this function - It is
243 * instead written to "file->private_data".
244 *
245 * Return: 0 if successful, or another code if unsuccessful.
246 */
Robert Love11980c22011-12-20 16:49:48 -0800247static int ashmem_open(struct inode *inode, struct file *file)
248{
249 struct ashmem_area *asma;
250 int ret;
251
Bjorn Bringert5154b932011-12-20 16:49:52 -0800252 ret = generic_file_open(inode, file);
Robert Love11980c22011-12-20 16:49:48 -0800253 if (unlikely(ret))
254 return ret;
255
256 asma = kmem_cache_zalloc(ashmem_area_cachep, GFP_KERNEL);
257 if (unlikely(!asma))
258 return -ENOMEM;
259
260 INIT_LIST_HEAD(&asma->unpinned_list);
261 memcpy(asma->name, ASHMEM_NAME_PREFIX, ASHMEM_NAME_PREFIX_LEN);
262 asma->prot_mask = PROT_MASK;
263 file->private_data = asma;
264
265 return 0;
266}
267
Cruz Julian Bishop781114c2013-09-03 22:05:08 +1000268/**
269 * ashmem_release() - Releases an Anonymous Shared Memory structure
270 * @ignored: The backing file's Index Node(?) - It is ignored here.
271 * @file: The backing file
272 *
273 * Return: 0 if successful. If it is anything else, go have a coffee and
274 * try again.
275 */
Robert Love11980c22011-12-20 16:49:48 -0800276static int ashmem_release(struct inode *ignored, struct file *file)
277{
278 struct ashmem_area *asma = file->private_data;
279 struct ashmem_range *range, *next;
280
281 mutex_lock(&ashmem_mutex);
282 list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned)
283 range_del(range);
284 mutex_unlock(&ashmem_mutex);
285
286 if (asma->file)
287 fput(asma->file);
288 kmem_cache_free(ashmem_area_cachep, asma);
289
290 return 0;
291}
292
Cruz Julian Bishop781114c2013-09-03 22:05:08 +1000293/**
294 * ashmem_read() - Reads a set of bytes from an Ashmem-enabled file
295 * @file: The associated backing file.
296 * @buf: The buffer of data being written to
297 * @len: The number of bytes being read
298 * @pos: The position of the first byte to read.
299 *
300 * Return: 0 if successful, or another return code if not.
301 */
Bjorn Bringert853ca7a2011-12-20 16:49:49 -0800302static ssize_t ashmem_read(struct file *file, char __user *buf,
303 size_t len, loff_t *pos)
304{
305 struct ashmem_area *asma = file->private_data;
306 int ret = 0;
307
308 mutex_lock(&ashmem_mutex);
309
310 /* If size is not set, or set to 0, always return EOF. */
John Stultz1efb3432011-12-20 16:49:54 -0800311 if (asma->size == 0)
Todd Poynor077f6db92014-02-04 16:08:37 -0800312 goto out_unlock;
Bjorn Bringert853ca7a2011-12-20 16:49:49 -0800313
314 if (!asma->file) {
315 ret = -EBADF;
Todd Poynor077f6db92014-02-04 16:08:37 -0800316 goto out_unlock;
Bjorn Bringert853ca7a2011-12-20 16:49:49 -0800317 }
318
Todd Poynor077f6db92014-02-04 16:08:37 -0800319 mutex_unlock(&ashmem_mutex);
320
321 /*
322 * asma and asma->file are used outside the lock here. We assume
323 * once asma->file is set it will never be changed, and will not
324 * be destroyed until all references to the file are dropped and
325 * ashmem_release is called.
326 */
Al Viroe1452862015-04-03 15:09:38 -0400327 ret = __vfs_read(asma->file, buf, len, pos);
Shraddha Barke72737732015-09-05 18:58:26 +0530328 if (ret >= 0)
Todd Poynor077f6db92014-02-04 16:08:37 -0800329 /** Update backing file pos, since f_ops->read() doesn't */
330 asma->file->f_pos = *pos;
Todd Poynor077f6db92014-02-04 16:08:37 -0800331 return ret;
Bjorn Bringert5154b932011-12-20 16:49:52 -0800332
Todd Poynor077f6db92014-02-04 16:08:37 -0800333out_unlock:
Bjorn Bringert5154b932011-12-20 16:49:52 -0800334 mutex_unlock(&ashmem_mutex);
335 return ret;
336}
337
338static loff_t ashmem_llseek(struct file *file, loff_t offset, int origin)
339{
340 struct ashmem_area *asma = file->private_data;
341 int ret;
342
343 mutex_lock(&ashmem_mutex);
344
345 if (asma->size == 0) {
Joel Fernandes1d47c872018-02-16 11:02:01 -0800346 mutex_unlock(&ashmem_mutex);
347 return -EINVAL;
Bjorn Bringert5154b932011-12-20 16:49:52 -0800348 }
349
350 if (!asma->file) {
Joel Fernandes1d47c872018-02-16 11:02:01 -0800351 mutex_unlock(&ashmem_mutex);
352 return -EBADF;
Bjorn Bringert5154b932011-12-20 16:49:52 -0800353 }
354
Joel Fernandes1d47c872018-02-16 11:02:01 -0800355 mutex_unlock(&ashmem_mutex);
356
Al Viro91360b02014-08-19 11:08:22 -0400357 ret = vfs_llseek(asma->file, offset, origin);
John Stultz1efb3432011-12-20 16:49:54 -0800358 if (ret < 0)
Joel Fernandes1d47c872018-02-16 11:02:01 -0800359 return ret;
Bjorn Bringert5154b932011-12-20 16:49:52 -0800360
361 /** Copy f_pos from backing file, since f_ops->llseek() sets it */
362 file->f_pos = asma->file->f_pos;
Bjorn Bringert853ca7a2011-12-20 16:49:49 -0800363 return ret;
364}
365
Konstantin Khlebnikov7cfce772012-03-21 02:56:33 -0300366static inline vm_flags_t calc_vm_may_flags(unsigned long prot)
Arve Hjønnevåg56f76fc2011-12-20 16:49:50 -0800367{
John Stultz1efb3432011-12-20 16:49:54 -0800368 return _calc_vm_trans(prot, PROT_READ, VM_MAYREAD) |
Arve Hjønnevåg56f76fc2011-12-20 16:49:50 -0800369 _calc_vm_trans(prot, PROT_WRITE, VM_MAYWRITE) |
370 _calc_vm_trans(prot, PROT_EXEC, VM_MAYEXEC);
371}
Bjorn Bringert853ca7a2011-12-20 16:49:49 -0800372
Robert Love11980c22011-12-20 16:49:48 -0800373static int ashmem_mmap(struct file *file, struct vm_area_struct *vma)
374{
375 struct ashmem_area *asma = file->private_data;
376 int ret = 0;
377
378 mutex_lock(&ashmem_mutex);
379
380 /* user needs to SET_SIZE before mapping */
381 if (unlikely(!asma->size)) {
382 ret = -EINVAL;
383 goto out;
384 }
385
Alistair Strachand4d0edc2018-06-19 17:57:35 -0700386 /* requested mapping size larger than object size */
387 if (vma->vm_end - vma->vm_start > PAGE_ALIGN(asma->size)) {
388 ret = -EINVAL;
389 goto out;
390 }
391
Robert Love11980c22011-12-20 16:49:48 -0800392 /* requested protection bits must match our allowed protection mask */
Dave Hansene6bfb702016-02-12 13:02:31 -0800393 if (unlikely((vma->vm_flags & ~calc_vm_prot_bits(asma->prot_mask, 0)) &
394 calc_vm_prot_bits(PROT_MASK, 0))) {
Robert Love11980c22011-12-20 16:49:48 -0800395 ret = -EPERM;
396 goto out;
397 }
Arve Hjønnevåg56f76fc2011-12-20 16:49:50 -0800398 vma->vm_flags &= ~calc_vm_may_flags(~asma->prot_mask);
Robert Love11980c22011-12-20 16:49:48 -0800399
400 if (!asma->file) {
401 char *name = ASHMEM_NAME_DEF;
402 struct file *vmfile;
403
404 if (asma->name[ASHMEM_NAME_PREFIX_LEN] != '\0')
405 name = asma->name;
406
407 /* ... and allocate the backing shmem file */
408 vmfile = shmem_file_setup(name, asma->size, vma->vm_flags);
Viresh Kumar7f44cb02015-07-31 14:08:30 +0530409 if (IS_ERR(vmfile)) {
Robert Love11980c22011-12-20 16:49:48 -0800410 ret = PTR_ERR(vmfile);
411 goto out;
412 }
zhangshuxiaob8b8c5a2017-03-08 16:53:24 +0800413 vmfile->f_mode |= FMODE_LSEEK;
Robert Love11980c22011-12-20 16:49:48 -0800414 asma->file = vmfile;
415 }
416 get_file(asma->file);
417
John Stultz6f193672011-12-15 18:51:04 -0800418 if (vma->vm_flags & VM_SHARED)
419 shmem_set_file(vma, asma->file);
420 else {
421 if (vma->vm_file)
422 fput(vma->vm_file);
423 vma->vm_file = asma->file;
Robert Love11980c22011-12-20 16:49:48 -0800424 }
425
Robert Love11980c22011-12-20 16:49:48 -0800426out:
427 mutex_unlock(&ashmem_mutex);
428 return ret;
429}
430
431/*
Johannes Weiner6b4f7792014-12-12 16:56:13 -0800432 * ashmem_shrink - our cache shrinker, called from mm/vmscan.c
Robert Love11980c22011-12-20 16:49:48 -0800433 *
Dave Chinner7dc19d52013-08-28 10:18:11 +1000434 * 'nr_to_scan' is the number of objects to scan for freeing.
Robert Love11980c22011-12-20 16:49:48 -0800435 *
436 * 'gfp_mask' is the mask of the allocation that got us into this mess.
437 *
Dave Chinner7dc19d52013-08-28 10:18:11 +1000438 * Return value is the number of objects freed or -1 if we cannot
Robert Love11980c22011-12-20 16:49:48 -0800439 * proceed without risk of deadlock (due to gfp_mask).
440 *
441 * We approximate LRU via least-recently-unpinned, jettisoning unpinned partial
442 * chunks of ashmem regions LRU-wise one-at-a-time until we hit 'nr_to_scan'
443 * pages freed.
444 */
Dave Chinner7dc19d52013-08-28 10:18:11 +1000445static unsigned long
446ashmem_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)
Robert Love11980c22011-12-20 16:49:48 -0800447{
448 struct ashmem_range *range, *next;
Dave Chinner7dc19d52013-08-28 10:18:11 +1000449 unsigned long freed = 0;
Robert Love11980c22011-12-20 16:49:48 -0800450
451 /* We might recurse into filesystem code, so bail out if necessary */
Dave Chinner7dc19d52013-08-28 10:18:11 +1000452 if (!(sc->gfp_mask & __GFP_FS))
453 return SHRINK_STOP;
Robert Love11980c22011-12-20 16:49:48 -0800454
Laura Abbott18e77052016-01-29 22:07:30 -0800455 if (!mutex_trylock(&ashmem_mutex))
456 return -1;
457
Robert Love11980c22011-12-20 16:49:48 -0800458 list_for_each_entry_safe(range, next, &ashmem_lru_list, lru) {
Robert Love11980c22011-12-20 16:49:48 -0800459 loff_t start = range->pgstart * PAGE_SIZE;
Hugh Dickins3f31d072012-05-29 15:06:40 -0700460 loff_t end = (range->pgend + 1) * PAGE_SIZE;
Robert Love11980c22011-12-20 16:49:48 -0800461
Tobias Lindskogb3505d22015-02-09 08:10:39 +0100462 range->asma->file->f_op->fallocate(range->asma->file,
463 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
464 start, end - start);
Robert Love11980c22011-12-20 16:49:48 -0800465 range->purged = ASHMEM_WAS_PURGED;
466 lru_del(range);
467
Dave Chinner7dc19d52013-08-28 10:18:11 +1000468 freed += range_size(range);
469 if (--sc->nr_to_scan <= 0)
Robert Love11980c22011-12-20 16:49:48 -0800470 break;
471 }
472 mutex_unlock(&ashmem_mutex);
Dave Chinner7dc19d52013-08-28 10:18:11 +1000473 return freed;
474}
Robert Love11980c22011-12-20 16:49:48 -0800475
Dave Chinner7dc19d52013-08-28 10:18:11 +1000476static unsigned long
477ashmem_shrink_count(struct shrinker *shrink, struct shrink_control *sc)
478{
479 /*
480 * note that lru_count is count of pages on the lru, not a count of
481 * objects on the list. This means the scan function needs to return the
482 * number of pages freed, not the number of objects scanned.
483 */
Robert Love11980c22011-12-20 16:49:48 -0800484 return lru_count;
485}
486
487static struct shrinker ashmem_shrinker = {
Dave Chinner7dc19d52013-08-28 10:18:11 +1000488 .count_objects = ashmem_shrink_count,
489 .scan_objects = ashmem_shrink_scan,
490 /*
491 * XXX (dchinner): I wish people would comment on why they need on
492 * significant changes to the default value here
493 */
Robert Love11980c22011-12-20 16:49:48 -0800494 .seeks = DEFAULT_SEEKS * 4,
495};
496
497static int set_prot_mask(struct ashmem_area *asma, unsigned long prot)
498{
499 int ret = 0;
500
501 mutex_lock(&ashmem_mutex);
502
503 /* the user can only remove, not add, protection bits */
504 if (unlikely((asma->prot_mask & prot) != prot)) {
505 ret = -EINVAL;
506 goto out;
507 }
508
509 /* does the application expect PROT_READ to imply PROT_EXEC? */
510 if ((prot & PROT_READ) && (current->personality & READ_IMPLIES_EXEC))
511 prot |= PROT_EXEC;
512
513 asma->prot_mask = prot;
514
515out:
516 mutex_unlock(&ashmem_mutex);
517 return ret;
518}
519
520static int set_name(struct ashmem_area *asma, void __user *name)
521{
Todd Poynor077f6db92014-02-04 16:08:37 -0800522 int len;
Robert Love11980c22011-12-20 16:49:48 -0800523 int ret = 0;
Shankar Brahadeeswarane5834d62013-02-20 23:41:26 +0530524 char local_name[ASHMEM_NAME_LEN];
525
526 /*
527 * Holding the ashmem_mutex while doing a copy_from_user might cause
528 * an data abort which would try to access mmap_sem. If another
529 * thread has invoked ashmem_mmap then it will be holding the
530 * semaphore and will be waiting for ashmem_mutex, there by leading to
531 * deadlock. We'll release the mutex and take the name to a local
532 * variable that does not need protection and later copy the local
533 * variable to the structure member with lock held.
534 */
Todd Poynor077f6db92014-02-04 16:08:37 -0800535 len = strncpy_from_user(local_name, name, ASHMEM_NAME_LEN);
536 if (len < 0)
537 return len;
538 if (len == ASHMEM_NAME_LEN)
539 local_name[ASHMEM_NAME_LEN - 1] = '\0';
Robert Love11980c22011-12-20 16:49:48 -0800540 mutex_lock(&ashmem_mutex);
Robert Love11980c22011-12-20 16:49:48 -0800541 /* cannot change an existing mapping's name */
Todd Poynor077f6db92014-02-04 16:08:37 -0800542 if (unlikely(asma->file))
Robert Love11980c22011-12-20 16:49:48 -0800543 ret = -EINVAL;
Todd Poynor077f6db92014-02-04 16:08:37 -0800544 else
545 strcpy(asma->name + ASHMEM_NAME_PREFIX_LEN, local_name);
Robert Love11980c22011-12-20 16:49:48 -0800546
Todd Poynor077f6db92014-02-04 16:08:37 -0800547 mutex_unlock(&ashmem_mutex);
Robert Love11980c22011-12-20 16:49:48 -0800548 return ret;
549}
550
551static int get_name(struct ashmem_area *asma, void __user *name)
552{
553 int ret = 0;
Shankar Brahadeeswarane5834d62013-02-20 23:41:26 +0530554 size_t len;
555 /*
556 * Have a local variable to which we'll copy the content
557 * from asma with the lock held. Later we can copy this to the user
558 * space safely without holding any locks. So even if we proceed to
559 * wait for mmap_sem, it won't lead to deadlock.
560 */
561 char local_name[ASHMEM_NAME_LEN];
Robert Love11980c22011-12-20 16:49:48 -0800562
563 mutex_lock(&ashmem_mutex);
564 if (asma->name[ASHMEM_NAME_PREFIX_LEN] != '\0') {
Robert Love11980c22011-12-20 16:49:48 -0800565 /*
566 * Copying only `len', instead of ASHMEM_NAME_LEN, bytes
567 * prevents us from revealing one user's stack to another.
568 */
569 len = strlen(asma->name + ASHMEM_NAME_PREFIX_LEN) + 1;
Shankar Brahadeeswarane5834d62013-02-20 23:41:26 +0530570 memcpy(local_name, asma->name + ASHMEM_NAME_PREFIX_LEN, len);
Robert Love11980c22011-12-20 16:49:48 -0800571 } else {
Shankar Brahadeeswarane5834d62013-02-20 23:41:26 +0530572 len = sizeof(ASHMEM_NAME_DEF);
573 memcpy(local_name, ASHMEM_NAME_DEF, len);
Robert Love11980c22011-12-20 16:49:48 -0800574 }
575 mutex_unlock(&ashmem_mutex);
576
Shankar Brahadeeswarane5834d62013-02-20 23:41:26 +0530577 /*
578 * Now we are just copying from the stack variable to userland
579 * No lock held
580 */
581 if (unlikely(copy_to_user(name, local_name, len)))
582 ret = -EFAULT;
Robert Love11980c22011-12-20 16:49:48 -0800583 return ret;
584}
585
586/*
587 * ashmem_pin - pin the given ashmem region, returning whether it was
588 * previously purged (ASHMEM_WAS_PURGED) or not (ASHMEM_NOT_PURGED).
589 *
590 * Caller must hold ashmem_mutex.
591 */
592static int ashmem_pin(struct ashmem_area *asma, size_t pgstart, size_t pgend)
593{
594 struct ashmem_range *range, *next;
595 int ret = ASHMEM_NOT_PURGED;
596
597 list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned) {
598 /* moved past last applicable page; we can short circuit */
599 if (range_before_page(range, pgstart))
600 break;
601
602 /*
603 * The user can ask us to pin pages that span multiple ranges,
604 * or to pin pages that aren't even unpinned, so this is messy.
605 *
606 * Four cases:
607 * 1. The requested range subsumes an existing range, so we
608 * just remove the entire matching range.
609 * 2. The requested range overlaps the start of an existing
610 * range, so we just update that range.
611 * 3. The requested range overlaps the end of an existing
612 * range, so we just update that range.
613 * 4. The requested range punches a hole in an existing range,
614 * so we have to update one side of the range and then
615 * create a new range for the other side.
616 */
617 if (page_range_in_range(range, pgstart, pgend)) {
618 ret |= range->purged;
619
620 /* Case #1: Easy. Just nuke the whole thing. */
621 if (page_range_subsumes_range(range, pgstart, pgend)) {
622 range_del(range);
623 continue;
624 }
625
626 /* Case #2: We overlap from the start, so adjust it */
627 if (range->pgstart >= pgstart) {
628 range_shrink(range, pgend + 1, range->pgend);
629 continue;
630 }
631
632 /* Case #3: We overlap from the rear, so adjust it */
633 if (range->pgend <= pgend) {
Peng Sund2e4f682015-08-27 15:41:05 +0800634 range_shrink(range, range->pgstart,
635 pgstart - 1);
Robert Love11980c22011-12-20 16:49:48 -0800636 continue;
637 }
638
639 /*
640 * Case #4: We eat a chunk out of the middle. A bit
641 * more complicated, we allocate a new range for the
642 * second half and adjust the first chunk's endpoint.
643 */
644 range_alloc(asma, range, range->purged,
645 pgend + 1, range->pgend);
646 range_shrink(range, range->pgstart, pgstart - 1);
647 break;
648 }
649 }
650
651 return ret;
652}
653
654/*
655 * ashmem_unpin - unpin the given range of pages. Returns zero on success.
656 *
657 * Caller must hold ashmem_mutex.
658 */
659static int ashmem_unpin(struct ashmem_area *asma, size_t pgstart, size_t pgend)
660{
661 struct ashmem_range *range, *next;
662 unsigned int purged = ASHMEM_NOT_PURGED;
663
664restart:
665 list_for_each_entry_safe(range, next, &asma->unpinned_list, unpinned) {
666 /* short circuit: this is our insertion point */
667 if (range_before_page(range, pgstart))
668 break;
669
670 /*
671 * The user can ask us to unpin pages that are already entirely
672 * or partially pinned. We handle those two cases here.
673 */
674 if (page_range_subsumed_by_range(range, pgstart, pgend))
675 return 0;
676 if (page_range_in_range(range, pgstart, pgend)) {
Amitoj Kaur Chawla9f1c4272016-02-25 08:18:52 +0530677 pgstart = min(range->pgstart, pgstart);
678 pgend = max(range->pgend, pgend);
Robert Love11980c22011-12-20 16:49:48 -0800679 purged |= range->purged;
680 range_del(range);
681 goto restart;
682 }
683 }
684
685 return range_alloc(asma, range, purged, pgstart, pgend);
686}
687
688/*
689 * ashmem_get_pin_status - Returns ASHMEM_IS_UNPINNED if _any_ pages in the
690 * given interval are unpinned and ASHMEM_IS_PINNED otherwise.
691 *
692 * Caller must hold ashmem_mutex.
693 */
694static int ashmem_get_pin_status(struct ashmem_area *asma, size_t pgstart,
695 size_t pgend)
696{
697 struct ashmem_range *range;
698 int ret = ASHMEM_IS_PINNED;
699
700 list_for_each_entry(range, &asma->unpinned_list, unpinned) {
701 if (range_before_page(range, pgstart))
702 break;
703 if (page_range_in_range(range, pgstart, pgend)) {
704 ret = ASHMEM_IS_UNPINNED;
705 break;
706 }
707 }
708
709 return ret;
710}
711
712static int ashmem_pin_unpin(struct ashmem_area *asma, unsigned long cmd,
713 void __user *p)
714{
715 struct ashmem_pin pin;
716 size_t pgstart, pgend;
717 int ret = -EINVAL;
718
Yisheng Xie71df7bb2018-02-28 14:59:22 +0800719 if (unlikely(copy_from_user(&pin, p, sizeof(pin))))
720 return -EFAULT;
721
Ben Hutchings2dfe49d2018-02-04 02:06:27 +0000722 mutex_lock(&ashmem_mutex);
Robert Love11980c22011-12-20 16:49:48 -0800723
Ben Hutchings2dfe49d2018-02-04 02:06:27 +0000724 if (unlikely(!asma->file))
725 goto out_unlock;
726
Robert Love11980c22011-12-20 16:49:48 -0800727 /* per custom, you can pass zero for len to mean "everything onward" */
728 if (!pin.len)
729 pin.len = PAGE_ALIGN(asma->size) - pin.offset;
730
731 if (unlikely((pin.offset | pin.len) & ~PAGE_MASK))
Ben Hutchings2dfe49d2018-02-04 02:06:27 +0000732 goto out_unlock;
Robert Love11980c22011-12-20 16:49:48 -0800733
Peng Sunb8d3bfa2015-08-27 15:41:06 +0800734 if (unlikely(((__u32)-1) - pin.offset < pin.len))
Ben Hutchings2dfe49d2018-02-04 02:06:27 +0000735 goto out_unlock;
Robert Love11980c22011-12-20 16:49:48 -0800736
737 if (unlikely(PAGE_ALIGN(asma->size) < pin.offset + pin.len))
Ben Hutchings2dfe49d2018-02-04 02:06:27 +0000738 goto out_unlock;
Robert Love11980c22011-12-20 16:49:48 -0800739
740 pgstart = pin.offset / PAGE_SIZE;
741 pgend = pgstart + (pin.len / PAGE_SIZE) - 1;
742
Robert Love11980c22011-12-20 16:49:48 -0800743 switch (cmd) {
744 case ASHMEM_PIN:
745 ret = ashmem_pin(asma, pgstart, pgend);
746 break;
747 case ASHMEM_UNPIN:
748 ret = ashmem_unpin(asma, pgstart, pgend);
749 break;
750 case ASHMEM_GET_PIN_STATUS:
751 ret = ashmem_get_pin_status(asma, pgstart, pgend);
752 break;
753 }
754
Ben Hutchings2dfe49d2018-02-04 02:06:27 +0000755out_unlock:
Robert Love11980c22011-12-20 16:49:48 -0800756 mutex_unlock(&ashmem_mutex);
757
758 return ret;
759}
760
761static long ashmem_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
762{
763 struct ashmem_area *asma = file->private_data;
764 long ret = -ENOTTY;
765
766 switch (cmd) {
767 case ASHMEM_SET_NAME:
Fabian Holler1703ca92015-01-07 10:39:54 +0100768 ret = set_name(asma, (void __user *)arg);
Robert Love11980c22011-12-20 16:49:48 -0800769 break;
770 case ASHMEM_GET_NAME:
Fabian Holler1703ca92015-01-07 10:39:54 +0100771 ret = get_name(asma, (void __user *)arg);
Robert Love11980c22011-12-20 16:49:48 -0800772 break;
773 case ASHMEM_SET_SIZE:
774 ret = -EINVAL;
Viktor Slavkovicc51d23d2018-01-08 10:43:03 -0800775 mutex_lock(&ashmem_mutex);
Robert Love11980c22011-12-20 16:49:48 -0800776 if (!asma->file) {
777 ret = 0;
Peng Sunb8d3bfa2015-08-27 15:41:06 +0800778 asma->size = (size_t)arg;
Robert Love11980c22011-12-20 16:49:48 -0800779 }
Viktor Slavkovicc51d23d2018-01-08 10:43:03 -0800780 mutex_unlock(&ashmem_mutex);
Robert Love11980c22011-12-20 16:49:48 -0800781 break;
782 case ASHMEM_GET_SIZE:
783 ret = asma->size;
784 break;
785 case ASHMEM_SET_PROT_MASK:
786 ret = set_prot_mask(asma, arg);
787 break;
788 case ASHMEM_GET_PROT_MASK:
789 ret = asma->prot_mask;
790 break;
791 case ASHMEM_PIN:
792 case ASHMEM_UNPIN:
793 case ASHMEM_GET_PIN_STATUS:
Fabian Holler1703ca92015-01-07 10:39:54 +0100794 ret = ashmem_pin_unpin(asma, cmd, (void __user *)arg);
Robert Love11980c22011-12-20 16:49:48 -0800795 break;
796 case ASHMEM_PURGE_ALL_CACHES:
797 ret = -EPERM;
798 if (capable(CAP_SYS_ADMIN)) {
Colin Cross33e8fc42011-12-20 16:49:53 -0800799 struct shrink_control sc = {
800 .gfp_mask = GFP_KERNEL,
Dave Chinner7dc19d52013-08-28 10:18:11 +1000801 .nr_to_scan = LONG_MAX,
Colin Cross33e8fc42011-12-20 16:49:53 -0800802 };
John Stultz59573242013-10-21 09:58:07 -0700803 ret = ashmem_shrink_count(&ashmem_shrinker, &sc);
Dave Chinner7dc19d52013-08-28 10:18:11 +1000804 ashmem_shrink_scan(&ashmem_shrinker, &sc);
Robert Love11980c22011-12-20 16:49:48 -0800805 }
806 break;
807 }
808
809 return ret;
810}
811
Serban Constantinescue9f5b812013-03-05 15:27:38 +0000812/* support of 32bit userspace on 64bit platforms */
813#ifdef CONFIG_COMPAT
Marlies Ruck017ca3b2013-05-10 16:26:30 -0400814static long compat_ashmem_ioctl(struct file *file, unsigned int cmd,
815 unsigned long arg)
Serban Constantinescue9f5b812013-03-05 15:27:38 +0000816{
Serban Constantinescue9f5b812013-03-05 15:27:38 +0000817 switch (cmd) {
818 case COMPAT_ASHMEM_SET_SIZE:
819 cmd = ASHMEM_SET_SIZE;
820 break;
821 case COMPAT_ASHMEM_SET_PROT_MASK:
822 cmd = ASHMEM_SET_PROT_MASK;
823 break;
824 }
825 return ashmem_ioctl(file, cmd, arg);
826}
827#endif
828
Tracey Dentaa5af972012-01-22 21:28:44 -0500829static const struct file_operations ashmem_fops = {
Robert Love11980c22011-12-20 16:49:48 -0800830 .owner = THIS_MODULE,
831 .open = ashmem_open,
832 .release = ashmem_release,
John Stultz1efb3432011-12-20 16:49:54 -0800833 .read = ashmem_read,
834 .llseek = ashmem_llseek,
Robert Love11980c22011-12-20 16:49:48 -0800835 .mmap = ashmem_mmap,
836 .unlocked_ioctl = ashmem_ioctl,
Serban Constantinescue9f5b812013-03-05 15:27:38 +0000837#ifdef CONFIG_COMPAT
838 .compat_ioctl = compat_ashmem_ioctl,
839#endif
Robert Love11980c22011-12-20 16:49:48 -0800840};
841
842static struct miscdevice ashmem_misc = {
843 .minor = MISC_DYNAMIC_MINOR,
844 .name = "ashmem",
845 .fops = &ashmem_fops,
846};
847
848static int __init ashmem_init(void)
849{
Wenwei Taoa2df4e32015-12-09 00:15:52 +0800850 int ret = -ENOMEM;
Robert Love11980c22011-12-20 16:49:48 -0800851
852 ashmem_area_cachep = kmem_cache_create("ashmem_area_cache",
Peng Sun7048c1f2015-08-27 15:41:07 +0800853 sizeof(struct ashmem_area),
854 0, 0, NULL);
Robert Love11980c22011-12-20 16:49:48 -0800855 if (unlikely(!ashmem_area_cachep)) {
Sachin Kamatc810a392012-06-05 16:40:10 +0530856 pr_err("failed to create slab cache\n");
Wenwei Taoa2df4e32015-12-09 00:15:52 +0800857 goto out;
Robert Love11980c22011-12-20 16:49:48 -0800858 }
859
860 ashmem_range_cachep = kmem_cache_create("ashmem_range_cache",
Peng Sun7048c1f2015-08-27 15:41:07 +0800861 sizeof(struct ashmem_range),
862 0, 0, NULL);
Robert Love11980c22011-12-20 16:49:48 -0800863 if (unlikely(!ashmem_range_cachep)) {
Sachin Kamatc810a392012-06-05 16:40:10 +0530864 pr_err("failed to create slab cache\n");
Wenwei Taoa2df4e32015-12-09 00:15:52 +0800865 goto out_free1;
Robert Love11980c22011-12-20 16:49:48 -0800866 }
867
868 ret = misc_register(&ashmem_misc);
869 if (unlikely(ret)) {
Sachin Kamatc810a392012-06-05 16:40:10 +0530870 pr_err("failed to register misc device!\n");
Wenwei Taoa2df4e32015-12-09 00:15:52 +0800871 goto out_free2;
Robert Love11980c22011-12-20 16:49:48 -0800872 }
873
874 register_shrinker(&ashmem_shrinker);
875
Sachin Kamatc810a392012-06-05 16:40:10 +0530876 pr_info("initialized\n");
Robert Love11980c22011-12-20 16:49:48 -0800877
878 return 0;
Wenwei Taoa2df4e32015-12-09 00:15:52 +0800879
880out_free2:
881 kmem_cache_destroy(ashmem_range_cachep);
882out_free1:
883 kmem_cache_destroy(ashmem_area_cachep);
884out:
885 return ret;
Robert Love11980c22011-12-20 16:49:48 -0800886}
Paul Gortmaker129505952015-10-11 15:47:28 -0400887device_initcall(ashmem_init);