3 * drivers/staging/android/ion/ion.c
5 * Copyright (C) 2011 Google, Inc.
7 * This software is licensed under the terms of the GNU General Public
8 * License version 2, as published by the Free Software Foundation, and
9 * may be copied, distributed, and modified under those terms.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
18 #include <linux/device.h>
19 #include <linux/err.h>
20 #include <linux/file.h>
21 #include <linux/freezer.h>
23 #include <linux/anon_inodes.h>
24 #include <linux/kthread.h>
25 #include <linux/list.h>
26 #include <linux/memblock.h>
27 #include <linux/miscdevice.h>
28 #include <linux/export.h>
30 #include <linux/mm_types.h>
31 #include <linux/rbtree.h>
32 #include <linux/slab.h>
33 #include <linux/seq_file.h>
34 #include <linux/uaccess.h>
35 #include <linux/vmalloc.h>
36 #include <linux/debugfs.h>
37 #include <linux/dma-buf.h>
38 #include <linux/idr.h>
42 #include "compat_ion.h"
45 * struct ion_device - the metadata of the ion device node
46 * @dev: the actual misc device
47 * @buffers: an rb tree of all the existing buffers
48 * @buffer_lock: lock protecting the tree of buffers
49 * @lock: rwsem protecting the tree of heaps and clients
50 * @heaps: list of all the heaps in the system
51 * @user_clients: list of all the clients created from userspace
54 struct miscdevice dev;
55 struct rb_root buffers;
56 struct mutex buffer_lock;
57 struct rw_semaphore lock;
58 struct plist_head heaps;
59 long (*custom_ioctl)(struct ion_client *client, unsigned int cmd,
61 struct rb_root clients;
62 struct dentry *debug_root;
63 struct dentry *heaps_debug_root;
64 struct dentry *clients_debug_root;
68 * struct ion_client - a process/hw block local address space
69 * @node: node in the tree of all clients
70 * @dev: backpointer to ion device
71 * @handles: an rb tree of all the handles in this client
72 * @idr: an idr space for allocating handle ids
73 * @lock: lock protecting the tree of handles
74 * @name: used for debugging
75 * @display_name: used for debugging (unique version of @name)
76 * @display_serial: used for debugging (to make display_name unique)
77 * @task: used for debugging
79 * A client represents a list of buffers this client may access.
80 * The mutex stored here is used to protect both handles tree
81 * as well as the handles themselves, and should be held while modifying either.
85 struct ion_device *dev;
86 struct rb_root handles;
92 struct task_struct *task;
94 struct dentry *debug_root;
98 * ion_handle - a client local reference to a buffer
99 * @ref: reference count
100 * @client: back pointer to the client the buffer resides in
101 * @buffer: pointer to the buffer
102 * @node: node in the client's handle rbtree
103 * @kmap_cnt: count of times this client has mapped to kernel
104 * @id: client-unique id allocated by client->idr
106 * Modifications to node, map_cnt or mapping should be protected by the
107 * lock in the client. Other fields are never changed after initialization.
111 struct ion_client *client;
112 struct ion_buffer *buffer;
114 unsigned int kmap_cnt;
118 bool ion_buffer_fault_user_mappings(struct ion_buffer *buffer)
120 return (buffer->flags & ION_FLAG_CACHED) &&
121 !(buffer->flags & ION_FLAG_CACHED_NEEDS_SYNC);
124 bool ion_buffer_cached(struct ion_buffer *buffer)
126 return !!(buffer->flags & ION_FLAG_CACHED);
129 static inline struct page *ion_buffer_page(struct page *page)
131 return (struct page *)((unsigned long)page & ~(1UL));
134 static inline bool ion_buffer_page_is_dirty(struct page *page)
136 return !!((unsigned long)page & 1UL);
139 static inline void ion_buffer_page_dirty(struct page **page)
141 *page = (struct page *)((unsigned long)(*page) | 1UL);
144 static inline void ion_buffer_page_clean(struct page **page)
146 *page = (struct page *)((unsigned long)(*page) & ~(1UL));
149 /* this function should only be called while dev->lock is held */
150 static void ion_buffer_add(struct ion_device *dev,
151 struct ion_buffer *buffer)
153 struct rb_node **p = &dev->buffers.rb_node;
154 struct rb_node *parent = NULL;
155 struct ion_buffer *entry;
159 entry = rb_entry(parent, struct ion_buffer, node);
161 if (buffer < entry) {
163 } else if (buffer > entry) {
166 pr_err("%s: buffer already found.", __func__);
171 rb_link_node(&buffer->node, parent, p);
172 rb_insert_color(&buffer->node, &dev->buffers);
175 /* this function should only be called while dev->lock is held */
176 static struct ion_buffer *ion_buffer_create(struct ion_heap *heap,
177 struct ion_device *dev,
182 struct ion_buffer *buffer;
183 struct sg_table *table;
184 struct scatterlist *sg;
187 buffer = kzalloc(sizeof(struct ion_buffer), GFP_KERNEL);
189 return ERR_PTR(-ENOMEM);
192 buffer->flags = flags;
193 kref_init(&buffer->ref);
195 ret = heap->ops->allocate(heap, buffer, len, align, flags);
198 if (!(heap->flags & ION_HEAP_FLAG_DEFER_FREE))
201 ion_heap_freelist_drain(heap, 0);
202 ret = heap->ops->allocate(heap, buffer, len, align,
211 table = heap->ops->map_dma(heap, buffer);
212 if (WARN_ONCE(table == NULL,
213 "heap->ops->map_dma should return ERR_PTR on error"))
214 table = ERR_PTR(-EINVAL);
220 buffer->sg_table = table;
221 if (ion_buffer_fault_user_mappings(buffer)) {
222 int num_pages = PAGE_ALIGN(buffer->size) / PAGE_SIZE;
223 struct scatterlist *sg;
226 buffer->pages = vmalloc(sizeof(struct page *) * num_pages);
227 if (!buffer->pages) {
232 for_each_sg(table->sgl, sg, table->nents, i) {
233 struct page *page = sg_page(sg);
235 for (j = 0; j < sg->length / PAGE_SIZE; j++)
236 buffer->pages[k++] = page++;
242 INIT_LIST_HEAD(&buffer->vmas);
243 mutex_init(&buffer->lock);
245 * this will set up dma addresses for the sglist -- it is not
246 * technically correct as per the dma api -- a specific
247 * device isn't really taking ownership here. However, in practice on
248 * our systems the only dma_address space is physical addresses.
249 * Additionally, we can't afford the overhead of invalidating every
250 * allocation via dma_map_sg. The implicit contract here is that
251 * memory coming from the heaps is ready for dma, ie if it has a
252 * cached mapping that mapping has been invalidated
254 for_each_sg(buffer->sg_table->sgl, sg, buffer->sg_table->nents, i) {
255 sg_dma_address(sg) = sg_phys(sg);
256 sg_dma_len(sg) = sg->length;
258 mutex_lock(&dev->buffer_lock);
259 ion_buffer_add(dev, buffer);
260 mutex_unlock(&dev->buffer_lock);
264 heap->ops->unmap_dma(heap, buffer);
266 heap->ops->free(buffer);
272 void ion_buffer_destroy(struct ion_buffer *buffer)
274 if (WARN_ON(buffer->kmap_cnt > 0))
275 buffer->heap->ops->unmap_kernel(buffer->heap, buffer);
276 buffer->heap->ops->unmap_dma(buffer->heap, buffer);
277 buffer->heap->ops->free(buffer);
278 vfree(buffer->pages);
282 static void _ion_buffer_destroy(struct kref *kref)
284 struct ion_buffer *buffer = container_of(kref, struct ion_buffer, ref);
285 struct ion_heap *heap = buffer->heap;
286 struct ion_device *dev = buffer->dev;
288 mutex_lock(&dev->buffer_lock);
289 rb_erase(&buffer->node, &dev->buffers);
290 mutex_unlock(&dev->buffer_lock);
292 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
293 ion_heap_freelist_add(heap, buffer);
295 ion_buffer_destroy(buffer);
298 static void ion_buffer_get(struct ion_buffer *buffer)
300 kref_get(&buffer->ref);
303 static int ion_buffer_put(struct ion_buffer *buffer)
305 return kref_put(&buffer->ref, _ion_buffer_destroy);
308 static void ion_buffer_add_to_handle(struct ion_buffer *buffer)
310 mutex_lock(&buffer->lock);
311 buffer->handle_count++;
312 mutex_unlock(&buffer->lock);
315 static void ion_buffer_remove_from_handle(struct ion_buffer *buffer)
318 * when a buffer is removed from a handle, if it is not in
319 * any other handles, copy the taskcomm and the pid of the
320 * process it's being removed from into the buffer. At this
321 * point there will be no way to track what processes this buffer is
322 * being used by, it only exists as a dma_buf file descriptor.
323 * The taskcomm and pid can provide a debug hint as to where this fd
326 mutex_lock(&buffer->lock);
327 buffer->handle_count--;
328 BUG_ON(buffer->handle_count < 0);
329 if (!buffer->handle_count) {
330 struct task_struct *task;
332 task = current->group_leader;
333 get_task_comm(buffer->task_comm, task);
334 buffer->pid = task_pid_nr(task);
336 mutex_unlock(&buffer->lock);
339 static struct ion_handle *ion_handle_create(struct ion_client *client,
340 struct ion_buffer *buffer)
342 struct ion_handle *handle;
344 handle = kzalloc(sizeof(struct ion_handle), GFP_KERNEL);
346 return ERR_PTR(-ENOMEM);
347 kref_init(&handle->ref);
348 RB_CLEAR_NODE(&handle->node);
349 handle->client = client;
350 ion_buffer_get(buffer);
351 ion_buffer_add_to_handle(buffer);
352 handle->buffer = buffer;
357 static void ion_handle_kmap_put(struct ion_handle *);
359 static void ion_handle_destroy(struct kref *kref)
361 struct ion_handle *handle = container_of(kref, struct ion_handle, ref);
362 struct ion_client *client = handle->client;
363 struct ion_buffer *buffer = handle->buffer;
365 mutex_lock(&buffer->lock);
366 while (handle->kmap_cnt)
367 ion_handle_kmap_put(handle);
368 mutex_unlock(&buffer->lock);
370 idr_remove(&client->idr, handle->id);
371 if (!RB_EMPTY_NODE(&handle->node))
372 rb_erase(&handle->node, &client->handles);
374 ion_buffer_remove_from_handle(buffer);
375 ion_buffer_put(buffer);
380 struct ion_buffer *ion_handle_buffer(struct ion_handle *handle)
382 return handle->buffer;
385 static void ion_handle_get(struct ion_handle *handle)
387 kref_get(&handle->ref);
390 static int ion_handle_put_nolock(struct ion_handle *handle)
394 ret = kref_put(&handle->ref, ion_handle_destroy);
399 int ion_handle_put(struct ion_handle *handle)
401 struct ion_client *client = handle->client;
404 mutex_lock(&client->lock);
405 ret = ion_handle_put_nolock(handle);
406 mutex_unlock(&client->lock);
411 static struct ion_handle *ion_handle_lookup(struct ion_client *client,
412 struct ion_buffer *buffer)
414 struct rb_node *n = client->handles.rb_node;
417 struct ion_handle *entry = rb_entry(n, struct ion_handle, node);
419 if (buffer < entry->buffer)
421 else if (buffer > entry->buffer)
426 return ERR_PTR(-EINVAL);
429 static struct ion_handle *ion_handle_get_by_id_nolock(struct ion_client *client,
432 struct ion_handle *handle;
434 handle = idr_find(&client->idr, id);
436 ion_handle_get(handle);
438 return handle ? handle : ERR_PTR(-EINVAL);
441 struct ion_handle *ion_handle_get_by_id(struct ion_client *client,
444 struct ion_handle *handle;
446 mutex_lock(&client->lock);
447 handle = ion_handle_get_by_id_nolock(client, id);
448 mutex_unlock(&client->lock);
453 static bool ion_handle_validate(struct ion_client *client,
454 struct ion_handle *handle)
456 WARN_ON(!mutex_is_locked(&client->lock));
457 return idr_find(&client->idr, handle->id) == handle;
460 static int ion_handle_add(struct ion_client *client, struct ion_handle *handle)
463 struct rb_node **p = &client->handles.rb_node;
464 struct rb_node *parent = NULL;
465 struct ion_handle *entry;
467 id = idr_alloc(&client->idr, handle, 1, 0, GFP_KERNEL);
475 entry = rb_entry(parent, struct ion_handle, node);
477 if (handle->buffer < entry->buffer)
479 else if (handle->buffer > entry->buffer)
482 WARN(1, "%s: buffer already found.", __func__);
485 rb_link_node(&handle->node, parent, p);
486 rb_insert_color(&handle->node, &client->handles);
491 struct ion_handle *ion_alloc(struct ion_client *client, size_t len,
492 size_t align, unsigned int heap_id_mask,
495 struct ion_handle *handle;
496 struct ion_device *dev = client->dev;
497 struct ion_buffer *buffer = NULL;
498 struct ion_heap *heap;
501 pr_debug("%s: len %zu align %zu heap_id_mask %u flags %x\n", __func__,
502 len, align, heap_id_mask, flags);
504 * traverse the list of heaps available in this system in priority
505 * order. If the heap type is supported by the client, and matches the
506 * request of the caller allocate from it. Repeat until allocate has
507 * succeeded or all heaps have been tried
509 len = PAGE_ALIGN(len);
512 return ERR_PTR(-EINVAL);
514 down_read(&dev->lock);
515 plist_for_each_entry(heap, &dev->heaps, node) {
516 /* if the caller didn't specify this heap id */
517 if (!((1 << heap->id) & heap_id_mask))
519 buffer = ion_buffer_create(heap, dev, len, align, flags);
526 return ERR_PTR(-ENODEV);
529 return ERR_CAST(buffer);
531 handle = ion_handle_create(client, buffer);
534 * ion_buffer_create will create a buffer with a ref_cnt of 1,
535 * and ion_handle_create will take a second reference, drop one here
537 ion_buffer_put(buffer);
542 mutex_lock(&client->lock);
543 ret = ion_handle_add(client, handle);
544 mutex_unlock(&client->lock);
546 ion_handle_put(handle);
547 handle = ERR_PTR(ret);
552 EXPORT_SYMBOL(ion_alloc);
554 static void ion_free_nolock(struct ion_client *client, struct ion_handle *handle)
558 BUG_ON(client != handle->client);
560 valid_handle = ion_handle_validate(client, handle);
563 WARN(1, "%s: invalid handle passed to free.\n", __func__);
566 ion_handle_put_nolock(handle);
569 void ion_free(struct ion_client *client, struct ion_handle *handle)
571 BUG_ON(client != handle->client);
573 mutex_lock(&client->lock);
574 ion_free_nolock(client, handle);
575 mutex_unlock(&client->lock);
577 EXPORT_SYMBOL(ion_free);
579 int ion_phys(struct ion_client *client, struct ion_handle *handle,
580 ion_phys_addr_t *addr, size_t *len)
582 struct ion_buffer *buffer;
585 mutex_lock(&client->lock);
586 if (!ion_handle_validate(client, handle)) {
587 mutex_unlock(&client->lock);
591 buffer = handle->buffer;
593 if (!buffer->heap->ops->phys) {
594 pr_err("%s: ion_phys is not implemented by this heap (name=%s, type=%d).\n",
595 __func__, buffer->heap->name, buffer->heap->type);
596 mutex_unlock(&client->lock);
599 mutex_unlock(&client->lock);
600 ret = buffer->heap->ops->phys(buffer->heap, buffer, addr, len);
603 EXPORT_SYMBOL(ion_phys);
605 static void *ion_buffer_kmap_get(struct ion_buffer *buffer)
609 if (buffer->kmap_cnt) {
611 return buffer->vaddr;
613 vaddr = buffer->heap->ops->map_kernel(buffer->heap, buffer);
614 if (WARN_ONCE(vaddr == NULL,
615 "heap->ops->map_kernel should return ERR_PTR on error"))
616 return ERR_PTR(-EINVAL);
619 buffer->vaddr = vaddr;
624 static void *ion_handle_kmap_get(struct ion_handle *handle)
626 struct ion_buffer *buffer = handle->buffer;
629 if (handle->kmap_cnt) {
631 return buffer->vaddr;
633 vaddr = ion_buffer_kmap_get(buffer);
640 static void ion_buffer_kmap_put(struct ion_buffer *buffer)
643 if (!buffer->kmap_cnt) {
644 buffer->heap->ops->unmap_kernel(buffer->heap, buffer);
645 buffer->vaddr = NULL;
649 static void ion_handle_kmap_put(struct ion_handle *handle)
651 struct ion_buffer *buffer = handle->buffer;
653 if (!handle->kmap_cnt) {
654 WARN(1, "%s: Double unmap detected! bailing...\n", __func__);
658 if (!handle->kmap_cnt)
659 ion_buffer_kmap_put(buffer);
662 void *ion_map_kernel(struct ion_client *client, struct ion_handle *handle)
664 struct ion_buffer *buffer;
667 mutex_lock(&client->lock);
668 if (!ion_handle_validate(client, handle)) {
669 pr_err("%s: invalid handle passed to map_kernel.\n",
671 mutex_unlock(&client->lock);
672 return ERR_PTR(-EINVAL);
675 buffer = handle->buffer;
677 if (!handle->buffer->heap->ops->map_kernel) {
678 pr_err("%s: map_kernel is not implemented by this heap.\n",
680 mutex_unlock(&client->lock);
681 return ERR_PTR(-ENODEV);
684 mutex_lock(&buffer->lock);
685 vaddr = ion_handle_kmap_get(handle);
686 mutex_unlock(&buffer->lock);
687 mutex_unlock(&client->lock);
690 EXPORT_SYMBOL(ion_map_kernel);
692 void ion_unmap_kernel(struct ion_client *client, struct ion_handle *handle)
694 struct ion_buffer *buffer;
696 mutex_lock(&client->lock);
697 buffer = handle->buffer;
698 mutex_lock(&buffer->lock);
699 ion_handle_kmap_put(handle);
700 mutex_unlock(&buffer->lock);
701 mutex_unlock(&client->lock);
703 EXPORT_SYMBOL(ion_unmap_kernel);
705 static int ion_debug_client_show(struct seq_file *s, void *unused)
707 struct ion_client *client = s->private;
709 size_t sizes[ION_NUM_HEAP_IDS] = {0};
710 const char *names[ION_NUM_HEAP_IDS] = {NULL};
713 mutex_lock(&client->lock);
714 for (n = rb_first(&client->handles); n; n = rb_next(n)) {
715 struct ion_handle *handle = rb_entry(n, struct ion_handle,
717 unsigned int id = handle->buffer->heap->id;
720 names[id] = handle->buffer->heap->name;
721 sizes[id] += handle->buffer->size;
723 mutex_unlock(&client->lock);
725 seq_printf(s, "%16.16s: %16.16s\n", "heap_name", "size_in_bytes");
726 for (i = 0; i < ION_NUM_HEAP_IDS; i++) {
729 seq_printf(s, "%16.16s: %16zu\n", names[i], sizes[i]);
734 static int ion_debug_client_open(struct inode *inode, struct file *file)
736 return single_open(file, ion_debug_client_show, inode->i_private);
739 static const struct file_operations debug_client_fops = {
740 .open = ion_debug_client_open,
743 .release = single_release,
746 static int ion_get_client_serial(const struct rb_root *root,
747 const unsigned char *name)
750 struct rb_node *node;
752 for (node = rb_first(root); node; node = rb_next(node)) {
753 struct ion_client *client = rb_entry(node, struct ion_client,
756 if (strcmp(client->name, name))
758 serial = max(serial, client->display_serial);
763 struct ion_client *ion_client_create(struct ion_device *dev,
766 struct ion_client *client;
767 struct task_struct *task;
769 struct rb_node *parent = NULL;
770 struct ion_client *entry;
774 pr_err("%s: Name cannot be null\n", __func__);
775 return ERR_PTR(-EINVAL);
778 get_task_struct(current->group_leader);
779 task_lock(current->group_leader);
780 pid = task_pid_nr(current->group_leader);
782 * don't bother to store task struct for kernel threads,
783 * they can't be killed anyway
785 if (current->group_leader->flags & PF_KTHREAD) {
786 put_task_struct(current->group_leader);
789 task = current->group_leader;
791 task_unlock(current->group_leader);
793 client = kzalloc(sizeof(struct ion_client), GFP_KERNEL);
795 goto err_put_task_struct;
798 client->handles = RB_ROOT;
799 idr_init(&client->idr);
800 mutex_init(&client->lock);
803 client->name = kstrdup(name, GFP_KERNEL);
805 goto err_free_client;
807 down_write(&dev->lock);
808 client->display_serial = ion_get_client_serial(&dev->clients, name);
809 client->display_name = kasprintf(
810 GFP_KERNEL, "%s-%d", name, client->display_serial);
811 if (!client->display_name) {
812 up_write(&dev->lock);
813 goto err_free_client_name;
815 p = &dev->clients.rb_node;
818 entry = rb_entry(parent, struct ion_client, node);
822 else if (client > entry)
825 rb_link_node(&client->node, parent, p);
826 rb_insert_color(&client->node, &dev->clients);
828 client->debug_root = debugfs_create_file(client->display_name, 0664,
829 dev->clients_debug_root,
830 client, &debug_client_fops);
831 if (!client->debug_root) {
832 char buf[256], *path;
834 path = dentry_path(dev->clients_debug_root, buf, 256);
835 pr_err("Failed to create client debugfs at %s/%s\n",
836 path, client->display_name);
839 up_write(&dev->lock);
843 err_free_client_name:
849 put_task_struct(current->group_leader);
850 return ERR_PTR(-ENOMEM);
852 EXPORT_SYMBOL(ion_client_create);
854 void ion_client_destroy(struct ion_client *client)
856 struct ion_device *dev = client->dev;
859 while ((n = rb_first(&client->handles))) {
860 struct ion_handle *handle = rb_entry(n, struct ion_handle,
862 ion_handle_destroy(&handle->ref);
865 idr_destroy(&client->idr);
867 down_write(&dev->lock);
869 put_task_struct(client->task);
870 rb_erase(&client->node, &dev->clients);
871 debugfs_remove_recursive(client->debug_root);
872 up_write(&dev->lock);
874 kfree(client->display_name);
878 EXPORT_SYMBOL(ion_client_destroy);
880 struct sg_table *ion_sg_table(struct ion_client *client,
881 struct ion_handle *handle)
883 struct ion_buffer *buffer;
884 struct sg_table *table;
886 mutex_lock(&client->lock);
887 if (!ion_handle_validate(client, handle)) {
888 pr_err("%s: invalid handle passed to map_dma.\n",
890 mutex_unlock(&client->lock);
891 return ERR_PTR(-EINVAL);
893 buffer = handle->buffer;
894 table = buffer->sg_table;
895 mutex_unlock(&client->lock);
898 EXPORT_SYMBOL(ion_sg_table);
900 static void ion_buffer_sync_for_device(struct ion_buffer *buffer,
902 enum dma_data_direction direction);
904 static struct sg_table *ion_map_dma_buf(struct dma_buf_attachment *attachment,
905 enum dma_data_direction direction)
907 struct dma_buf *dmabuf = attachment->dmabuf;
908 struct ion_buffer *buffer = dmabuf->priv;
910 ion_buffer_sync_for_device(buffer, attachment->dev, direction);
911 return buffer->sg_table;
914 static void ion_unmap_dma_buf(struct dma_buf_attachment *attachment,
915 struct sg_table *table,
916 enum dma_data_direction direction)
920 void ion_pages_sync_for_device(struct device *dev, struct page *page,
921 size_t size, enum dma_data_direction dir)
923 struct scatterlist sg;
925 sg_init_table(&sg, 1);
926 sg_set_page(&sg, page, size, 0);
928 * This is not correct - sg_dma_address needs a dma_addr_t that is valid
929 * for the targeted device, but this works on the currently targeted
932 sg_dma_address(&sg) = page_to_phys(page);
933 dma_sync_sg_for_device(dev, &sg, 1, dir);
936 struct ion_vma_list {
937 struct list_head list;
938 struct vm_area_struct *vma;
941 static void ion_buffer_sync_for_device(struct ion_buffer *buffer,
943 enum dma_data_direction dir)
945 struct ion_vma_list *vma_list;
946 int pages = PAGE_ALIGN(buffer->size) / PAGE_SIZE;
949 if (!ion_buffer_fault_user_mappings(buffer))
952 mutex_lock(&buffer->lock);
953 for (i = 0; i < pages; i++) {
954 struct page *page = buffer->pages[i];
956 if (ion_buffer_page_is_dirty(page))
957 ion_pages_sync_for_device(dev, ion_buffer_page(page),
960 ion_buffer_page_clean(buffer->pages + i);
962 list_for_each_entry(vma_list, &buffer->vmas, list) {
963 struct vm_area_struct *vma = vma_list->vma;
965 zap_page_range(vma, vma->vm_start, vma->vm_end - vma->vm_start,
968 mutex_unlock(&buffer->lock);
971 static int ion_vm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
973 struct ion_buffer *buffer = vma->vm_private_data;
977 mutex_lock(&buffer->lock);
978 ion_buffer_page_dirty(buffer->pages + vmf->pgoff);
979 BUG_ON(!buffer->pages || !buffer->pages[vmf->pgoff]);
981 pfn = page_to_pfn(ion_buffer_page(buffer->pages[vmf->pgoff]));
982 ret = vm_insert_pfn(vma, (unsigned long)vmf->virtual_address, pfn);
983 mutex_unlock(&buffer->lock);
985 return VM_FAULT_ERROR;
987 return VM_FAULT_NOPAGE;
990 static void ion_vm_open(struct vm_area_struct *vma)
992 struct ion_buffer *buffer = vma->vm_private_data;
993 struct ion_vma_list *vma_list;
995 vma_list = kmalloc(sizeof(struct ion_vma_list), GFP_KERNEL);
999 mutex_lock(&buffer->lock);
1000 list_add(&vma_list->list, &buffer->vmas);
1001 mutex_unlock(&buffer->lock);
1004 static void ion_vm_close(struct vm_area_struct *vma)
1006 struct ion_buffer *buffer = vma->vm_private_data;
1007 struct ion_vma_list *vma_list, *tmp;
1009 mutex_lock(&buffer->lock);
1010 list_for_each_entry_safe(vma_list, tmp, &buffer->vmas, list) {
1011 if (vma_list->vma != vma)
1013 list_del(&vma_list->list);
1017 mutex_unlock(&buffer->lock);
1020 static const struct vm_operations_struct ion_vma_ops = {
1021 .open = ion_vm_open,
1022 .close = ion_vm_close,
1023 .fault = ion_vm_fault,
1026 static int ion_mmap(struct dma_buf *dmabuf, struct vm_area_struct *vma)
1028 struct ion_buffer *buffer = dmabuf->priv;
1031 if (!buffer->heap->ops->map_user) {
1032 pr_err("%s: this heap does not define a method for mapping to userspace\n",
1037 if (ion_buffer_fault_user_mappings(buffer)) {
1038 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND |
1040 vma->vm_private_data = buffer;
1041 vma->vm_ops = &ion_vma_ops;
1046 if (!(buffer->flags & ION_FLAG_CACHED))
1047 vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
1049 mutex_lock(&buffer->lock);
1050 /* now map it to userspace */
1051 ret = buffer->heap->ops->map_user(buffer->heap, buffer, vma);
1052 mutex_unlock(&buffer->lock);
1055 pr_err("%s: failure mapping buffer to userspace\n",
1061 static void ion_dma_buf_release(struct dma_buf *dmabuf)
1063 struct ion_buffer *buffer = dmabuf->priv;
1065 ion_buffer_put(buffer);
1068 static void *ion_dma_buf_kmap(struct dma_buf *dmabuf, unsigned long offset)
1070 struct ion_buffer *buffer = dmabuf->priv;
1072 return buffer->vaddr + offset * PAGE_SIZE;
1075 static void ion_dma_buf_kunmap(struct dma_buf *dmabuf, unsigned long offset,
1080 static int ion_dma_buf_begin_cpu_access(struct dma_buf *dmabuf, size_t start,
1082 enum dma_data_direction direction)
1084 struct ion_buffer *buffer = dmabuf->priv;
1087 if (!buffer->heap->ops->map_kernel) {
1088 pr_err("%s: map kernel is not implemented by this heap.\n",
1093 mutex_lock(&buffer->lock);
1094 vaddr = ion_buffer_kmap_get(buffer);
1095 mutex_unlock(&buffer->lock);
1096 return PTR_ERR_OR_ZERO(vaddr);
1099 static void ion_dma_buf_end_cpu_access(struct dma_buf *dmabuf, size_t start,
1101 enum dma_data_direction direction)
1103 struct ion_buffer *buffer = dmabuf->priv;
1105 mutex_lock(&buffer->lock);
1106 ion_buffer_kmap_put(buffer);
1107 mutex_unlock(&buffer->lock);
1110 static struct dma_buf_ops dma_buf_ops = {
1111 .map_dma_buf = ion_map_dma_buf,
1112 .unmap_dma_buf = ion_unmap_dma_buf,
1114 .release = ion_dma_buf_release,
1115 .begin_cpu_access = ion_dma_buf_begin_cpu_access,
1116 .end_cpu_access = ion_dma_buf_end_cpu_access,
1117 .kmap_atomic = ion_dma_buf_kmap,
1118 .kunmap_atomic = ion_dma_buf_kunmap,
1119 .kmap = ion_dma_buf_kmap,
1120 .kunmap = ion_dma_buf_kunmap,
1123 struct dma_buf *ion_share_dma_buf(struct ion_client *client,
1124 struct ion_handle *handle)
1126 DEFINE_DMA_BUF_EXPORT_INFO(exp_info);
1127 struct ion_buffer *buffer;
1128 struct dma_buf *dmabuf;
1131 mutex_lock(&client->lock);
1132 valid_handle = ion_handle_validate(client, handle);
1133 if (!valid_handle) {
1134 WARN(1, "%s: invalid handle passed to share.\n", __func__);
1135 mutex_unlock(&client->lock);
1136 return ERR_PTR(-EINVAL);
1138 buffer = handle->buffer;
1139 ion_buffer_get(buffer);
1140 mutex_unlock(&client->lock);
1142 exp_info.ops = &dma_buf_ops;
1143 exp_info.size = buffer->size;
1144 exp_info.flags = O_RDWR;
1145 exp_info.priv = buffer;
1147 dmabuf = dma_buf_export(&exp_info);
1148 if (IS_ERR(dmabuf)) {
1149 ion_buffer_put(buffer);
1155 EXPORT_SYMBOL(ion_share_dma_buf);
1157 int ion_share_dma_buf_fd(struct ion_client *client, struct ion_handle *handle)
1159 struct dma_buf *dmabuf;
1162 dmabuf = ion_share_dma_buf(client, handle);
1164 return PTR_ERR(dmabuf);
1166 fd = dma_buf_fd(dmabuf, O_CLOEXEC);
1168 dma_buf_put(dmabuf);
1172 EXPORT_SYMBOL(ion_share_dma_buf_fd);
1174 struct ion_handle *ion_import_dma_buf(struct ion_client *client, int fd)
1176 struct dma_buf *dmabuf;
1177 struct ion_buffer *buffer;
1178 struct ion_handle *handle;
1181 dmabuf = dma_buf_get(fd);
1183 return ERR_CAST(dmabuf);
1184 /* if this memory came from ion */
1186 if (dmabuf->ops != &dma_buf_ops) {
1187 pr_err("%s: can not import dmabuf from another exporter\n",
1189 dma_buf_put(dmabuf);
1190 return ERR_PTR(-EINVAL);
1192 buffer = dmabuf->priv;
1194 mutex_lock(&client->lock);
1195 /* if a handle exists for this buffer just take a reference to it */
1196 handle = ion_handle_lookup(client, buffer);
1197 if (!IS_ERR(handle)) {
1198 ion_handle_get(handle);
1199 mutex_unlock(&client->lock);
1203 handle = ion_handle_create(client, buffer);
1204 if (IS_ERR(handle)) {
1205 mutex_unlock(&client->lock);
1209 ret = ion_handle_add(client, handle);
1210 mutex_unlock(&client->lock);
1212 ion_handle_put(handle);
1213 handle = ERR_PTR(ret);
1217 dma_buf_put(dmabuf);
1220 EXPORT_SYMBOL(ion_import_dma_buf);
1222 static int ion_sync_for_device(struct ion_client *client, int fd)
1224 struct dma_buf *dmabuf;
1225 struct ion_buffer *buffer;
1227 dmabuf = dma_buf_get(fd);
1229 return PTR_ERR(dmabuf);
1231 /* if this memory came from ion */
1232 if (dmabuf->ops != &dma_buf_ops) {
1233 pr_err("%s: can not sync dmabuf from another exporter\n",
1235 dma_buf_put(dmabuf);
1238 buffer = dmabuf->priv;
1240 dma_sync_sg_for_device(NULL, buffer->sg_table->sgl,
1241 buffer->sg_table->nents, DMA_BIDIRECTIONAL);
1242 dma_buf_put(dmabuf);
1246 /* fix up the cases where the ioctl direction bits are incorrect */
1247 static unsigned int ion_ioctl_dir(unsigned int cmd)
1252 case ION_IOC_CUSTOM:
1255 return _IOC_DIR(cmd);
1259 static long ion_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1261 struct ion_client *client = filp->private_data;
1262 struct ion_device *dev = client->dev;
1263 struct ion_handle *cleanup_handle = NULL;
1268 struct ion_fd_data fd;
1269 struct ion_allocation_data allocation;
1270 struct ion_handle_data handle;
1271 struct ion_custom_data custom;
1274 dir = ion_ioctl_dir(cmd);
1276 if (_IOC_SIZE(cmd) > sizeof(data))
1279 if (dir & _IOC_WRITE)
1280 if (copy_from_user(&data, (void __user *)arg, _IOC_SIZE(cmd)))
1286 struct ion_handle *handle;
1288 handle = ion_alloc(client, data.allocation.len,
1289 data.allocation.align,
1290 data.allocation.heap_id_mask,
1291 data.allocation.flags);
1293 return PTR_ERR(handle);
1295 data.allocation.handle = handle->id;
1297 cleanup_handle = handle;
1302 struct ion_handle *handle;
1304 mutex_lock(&client->lock);
1305 handle = ion_handle_get_by_id_nolock(client, data.handle.handle);
1306 if (IS_ERR(handle)) {
1307 mutex_unlock(&client->lock);
1308 return PTR_ERR(handle);
1310 ion_free_nolock(client, handle);
1311 ion_handle_put_nolock(handle);
1312 mutex_unlock(&client->lock);
1318 struct ion_handle *handle;
1320 handle = ion_handle_get_by_id(client, data.handle.handle);
1322 return PTR_ERR(handle);
1323 data.fd.fd = ion_share_dma_buf_fd(client, handle);
1324 ion_handle_put(handle);
1329 case ION_IOC_IMPORT:
1331 struct ion_handle *handle;
1333 handle = ion_import_dma_buf(client, data.fd.fd);
1335 ret = PTR_ERR(handle);
1337 data.handle.handle = handle->id;
1342 ret = ion_sync_for_device(client, data.fd.fd);
1345 case ION_IOC_CUSTOM:
1347 if (!dev->custom_ioctl)
1349 ret = dev->custom_ioctl(client, data.custom.cmd,
1357 if (dir & _IOC_READ) {
1358 if (copy_to_user((void __user *)arg, &data, _IOC_SIZE(cmd))) {
1360 ion_free(client, cleanup_handle);
1367 static int ion_release(struct inode *inode, struct file *file)
1369 struct ion_client *client = file->private_data;
1371 ion_client_destroy(client);
1375 static int ion_open(struct inode *inode, struct file *file)
1377 struct miscdevice *miscdev = file->private_data;
1378 struct ion_device *dev = container_of(miscdev, struct ion_device, dev);
1379 struct ion_client *client;
1380 char debug_name[64];
1382 snprintf(debug_name, 64, "%u", task_pid_nr(current->group_leader));
1383 client = ion_client_create(dev, debug_name);
1385 return PTR_ERR(client);
1386 file->private_data = client;
1391 static const struct file_operations ion_fops = {
1392 .owner = THIS_MODULE,
1394 .release = ion_release,
1395 .unlocked_ioctl = ion_ioctl,
1396 .compat_ioctl = compat_ion_ioctl,
1399 static size_t ion_debug_heap_total(struct ion_client *client,
1405 mutex_lock(&client->lock);
1406 for (n = rb_first(&client->handles); n; n = rb_next(n)) {
1407 struct ion_handle *handle = rb_entry(n,
1410 if (handle->buffer->heap->id == id)
1411 size += handle->buffer->size;
1413 mutex_unlock(&client->lock);
1417 static int ion_debug_heap_show(struct seq_file *s, void *unused)
1419 struct ion_heap *heap = s->private;
1420 struct ion_device *dev = heap->dev;
1422 size_t total_size = 0;
1423 size_t total_orphaned_size = 0;
1425 seq_printf(s, "%16s %16s %16s\n", "client", "pid", "size");
1426 seq_puts(s, "----------------------------------------------------\n");
1428 for (n = rb_first(&dev->clients); n; n = rb_next(n)) {
1429 struct ion_client *client = rb_entry(n, struct ion_client,
1431 size_t size = ion_debug_heap_total(client, heap->id);
1436 char task_comm[TASK_COMM_LEN];
1438 get_task_comm(task_comm, client->task);
1439 seq_printf(s, "%16s %16u %16zu\n", task_comm,
1442 seq_printf(s, "%16s %16u %16zu\n", client->name,
1446 seq_puts(s, "----------------------------------------------------\n");
1447 seq_puts(s, "orphaned allocations (info is from last known client):\n");
1448 mutex_lock(&dev->buffer_lock);
1449 for (n = rb_first(&dev->buffers); n; n = rb_next(n)) {
1450 struct ion_buffer *buffer = rb_entry(n, struct ion_buffer,
1452 if (buffer->heap->id != heap->id)
1454 total_size += buffer->size;
1455 if (!buffer->handle_count) {
1456 seq_printf(s, "%16s %16u %16zu %d %d\n",
1457 buffer->task_comm, buffer->pid,
1458 buffer->size, buffer->kmap_cnt,
1459 atomic_read(&buffer->ref.refcount));
1460 total_orphaned_size += buffer->size;
1463 mutex_unlock(&dev->buffer_lock);
1464 seq_puts(s, "----------------------------------------------------\n");
1465 seq_printf(s, "%16s %16zu\n", "total orphaned",
1466 total_orphaned_size);
1467 seq_printf(s, "%16s %16zu\n", "total ", total_size);
1468 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
1469 seq_printf(s, "%16s %16zu\n", "deferred free",
1470 heap->free_list_size);
1471 seq_puts(s, "----------------------------------------------------\n");
1473 if (heap->debug_show)
1474 heap->debug_show(heap, s, unused);
1479 static int ion_debug_heap_open(struct inode *inode, struct file *file)
1481 return single_open(file, ion_debug_heap_show, inode->i_private);
1484 static const struct file_operations debug_heap_fops = {
1485 .open = ion_debug_heap_open,
1487 .llseek = seq_lseek,
1488 .release = single_release,
1491 static int debug_shrink_set(void *data, u64 val)
1493 struct ion_heap *heap = data;
1494 struct shrink_control sc;
1498 sc.nr_to_scan = val;
1501 objs = heap->shrinker.count_objects(&heap->shrinker, &sc);
1502 sc.nr_to_scan = objs;
1505 heap->shrinker.scan_objects(&heap->shrinker, &sc);
1509 static int debug_shrink_get(void *data, u64 *val)
1511 struct ion_heap *heap = data;
1512 struct shrink_control sc;
1518 objs = heap->shrinker.count_objects(&heap->shrinker, &sc);
1523 DEFINE_SIMPLE_ATTRIBUTE(debug_shrink_fops, debug_shrink_get,
1524 debug_shrink_set, "%llu\n");
1526 void ion_device_add_heap(struct ion_device *dev, struct ion_heap *heap)
1528 struct dentry *debug_file;
1530 if (!heap->ops->allocate || !heap->ops->free || !heap->ops->map_dma ||
1531 !heap->ops->unmap_dma)
1532 pr_err("%s: can not add heap with invalid ops struct.\n",
1535 spin_lock_init(&heap->free_lock);
1536 heap->free_list_size = 0;
1538 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
1539 ion_heap_init_deferred_free(heap);
1541 if ((heap->flags & ION_HEAP_FLAG_DEFER_FREE) || heap->ops->shrink)
1542 ion_heap_init_shrinker(heap);
1545 down_write(&dev->lock);
1547 * use negative heap->id to reverse the priority -- when traversing
1548 * the list later attempt higher id numbers first
1550 plist_node_init(&heap->node, -heap->id);
1551 plist_add(&heap->node, &dev->heaps);
1552 debug_file = debugfs_create_file(heap->name, 0664,
1553 dev->heaps_debug_root, heap,
1557 char buf[256], *path;
1559 path = dentry_path(dev->heaps_debug_root, buf, 256);
1560 pr_err("Failed to create heap debugfs at %s/%s\n",
1564 if (heap->shrinker.count_objects && heap->shrinker.scan_objects) {
1565 char debug_name[64];
1567 snprintf(debug_name, 64, "%s_shrink", heap->name);
1568 debug_file = debugfs_create_file(
1569 debug_name, 0644, dev->heaps_debug_root, heap,
1570 &debug_shrink_fops);
1572 char buf[256], *path;
1574 path = dentry_path(dev->heaps_debug_root, buf, 256);
1575 pr_err("Failed to create heap shrinker debugfs at %s/%s\n",
1580 up_write(&dev->lock);
1582 EXPORT_SYMBOL(ion_device_add_heap);
1584 struct ion_device *ion_device_create(long (*custom_ioctl)
1585 (struct ion_client *client,
1589 struct ion_device *idev;
1592 idev = kzalloc(sizeof(struct ion_device), GFP_KERNEL);
1594 return ERR_PTR(-ENOMEM);
1596 idev->dev.minor = MISC_DYNAMIC_MINOR;
1597 idev->dev.name = "ion";
1598 idev->dev.fops = &ion_fops;
1599 idev->dev.parent = NULL;
1600 ret = misc_register(&idev->dev);
1602 pr_err("ion: failed to register misc device.\n");
1604 return ERR_PTR(ret);
1607 idev->debug_root = debugfs_create_dir("ion", NULL);
1608 if (!idev->debug_root) {
1609 pr_err("ion: failed to create debugfs root directory.\n");
1612 idev->heaps_debug_root = debugfs_create_dir("heaps", idev->debug_root);
1613 if (!idev->heaps_debug_root) {
1614 pr_err("ion: failed to create debugfs heaps directory.\n");
1617 idev->clients_debug_root = debugfs_create_dir("clients",
1619 if (!idev->clients_debug_root)
1620 pr_err("ion: failed to create debugfs clients directory.\n");
1624 idev->custom_ioctl = custom_ioctl;
1625 idev->buffers = RB_ROOT;
1626 mutex_init(&idev->buffer_lock);
1627 init_rwsem(&idev->lock);
1628 plist_head_init(&idev->heaps);
1629 idev->clients = RB_ROOT;
1632 EXPORT_SYMBOL(ion_device_create);
1634 void ion_device_destroy(struct ion_device *dev)
1636 misc_deregister(&dev->dev);
1637 debugfs_remove_recursive(dev->debug_root);
1638 /* XXX need to free the heaps and clients ? */
1641 EXPORT_SYMBOL(ion_device_destroy);
1643 void __init ion_reserve(struct ion_platform_data *data)
1647 for (i = 0; i < data->nr; i++) {
1648 if (data->heaps[i].size == 0)
1651 if (data->heaps[i].base == 0) {
1654 paddr = memblock_alloc_base(data->heaps[i].size,
1655 data->heaps[i].align,
1656 MEMBLOCK_ALLOC_ANYWHERE);
1658 pr_err("%s: error allocating memblock for heap %d\n",
1662 data->heaps[i].base = paddr;
1664 int ret = memblock_reserve(data->heaps[i].base,
1665 data->heaps[i].size);
1667 pr_err("memblock reserve of %zx@%lx failed\n",
1668 data->heaps[i].size,
1669 data->heaps[i].base);
1671 pr_info("%s: %s reserved base %lx size %zu\n", __func__,
1672 data->heaps[i].name,
1673 data->heaps[i].base,
1674 data->heaps[i].size);