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/file.h>
20 #include <linux/freezer.h>
22 #include <linux/anon_inodes.h>
23 #include <linux/kthread.h>
24 #include <linux/list.h>
25 #include <linux/memblock.h>
26 #include <linux/miscdevice.h>
27 #include <linux/export.h>
29 #include <linux/mm_types.h>
30 #include <linux/rbtree.h>
31 #include <linux/slab.h>
32 #include <linux/seq_file.h>
33 #include <linux/uaccess.h>
34 #include <linux/vmalloc.h>
35 #include <linux/debugfs.h>
36 #include <linux/dma-buf.h>
37 #include <linux/idr.h>
41 #include "compat_ion.h"
44 * struct ion_device - the metadata of the ion device node
45 * @dev: the actual misc device
46 * @buffers: an rb tree of all the existing buffers
47 * @buffer_lock: lock protecting the tree of buffers
48 * @lock: rwsem protecting the tree of heaps and clients
49 * @heaps: list of all the heaps in the system
50 * @user_clients: list of all the clients created from userspace
53 struct miscdevice dev;
54 struct rb_root buffers;
55 struct mutex buffer_lock;
56 struct rw_semaphore lock;
57 struct plist_head heaps;
58 long (*custom_ioctl) (struct ion_client *client, unsigned int cmd,
60 struct rb_root clients;
61 struct dentry *debug_root;
65 * struct ion_client - a process/hw block local address space
66 * @node: node in the tree of all clients
67 * @dev: backpointer to ion device
68 * @handles: an rb tree of all the handles in this client
69 * @idr: an idr space for allocating handle ids
70 * @lock: lock protecting the tree of handles
71 * @name: used for debugging
72 * @task: used for debugging
74 * A client represents a list of buffers this client may access.
75 * The mutex stored here is used to protect both handles tree
76 * as well as the handles themselves, and should be held while modifying either.
80 struct ion_device *dev;
81 struct rb_root handles;
85 struct task_struct *task;
87 struct dentry *debug_root;
91 * ion_handle - a client local reference to a buffer
92 * @ref: reference count
93 * @client: back pointer to the client the buffer resides in
94 * @buffer: pointer to the buffer
95 * @node: node in the client's handle rbtree
96 * @kmap_cnt: count of times this client has mapped to kernel
97 * @id: client-unique id allocated by client->idr
99 * Modifications to node, map_cnt or mapping should be protected by the
100 * lock in the client. Other fields are never changed after initialization.
104 struct ion_client *client;
105 struct ion_buffer *buffer;
107 unsigned int kmap_cnt;
111 bool ion_buffer_fault_user_mappings(struct ion_buffer *buffer)
113 return ((buffer->flags & ION_FLAG_CACHED) &&
114 !(buffer->flags & ION_FLAG_CACHED_NEEDS_SYNC));
117 bool ion_buffer_cached(struct ion_buffer *buffer)
119 return !!(buffer->flags & ION_FLAG_CACHED);
122 static inline struct page *ion_buffer_page(struct page *page)
124 return (struct page *)((unsigned long)page & ~(1UL));
127 static inline bool ion_buffer_page_is_dirty(struct page *page)
129 return !!((unsigned long)page & 1UL);
132 static inline void ion_buffer_page_dirty(struct page **page)
134 *page = (struct page *)((unsigned long)(*page) | 1UL);
137 static inline void ion_buffer_page_clean(struct page **page)
139 *page = (struct page *)((unsigned long)(*page) & ~(1UL));
142 /* this function should only be called while dev->lock is held */
143 static void ion_buffer_add(struct ion_device *dev,
144 struct ion_buffer *buffer)
146 struct rb_node **p = &dev->buffers.rb_node;
147 struct rb_node *parent = NULL;
148 struct ion_buffer *entry;
152 entry = rb_entry(parent, struct ion_buffer, node);
154 if (buffer < entry) {
156 } else if (buffer > entry) {
159 pr_err("%s: buffer already found.", __func__);
164 rb_link_node(&buffer->node, parent, p);
165 rb_insert_color(&buffer->node, &dev->buffers);
168 /* this function should only be called while dev->lock is held */
169 static struct ion_buffer *ion_buffer_create(struct ion_heap *heap,
170 struct ion_device *dev,
175 struct ion_buffer *buffer;
176 struct sg_table *table;
177 struct scatterlist *sg;
180 buffer = kzalloc(sizeof(struct ion_buffer), GFP_KERNEL);
182 return ERR_PTR(-ENOMEM);
185 buffer->flags = flags;
186 kref_init(&buffer->ref);
188 ret = heap->ops->allocate(heap, buffer, len, align, flags);
191 if (!(heap->flags & ION_HEAP_FLAG_DEFER_FREE))
194 ion_heap_freelist_drain(heap, 0);
195 ret = heap->ops->allocate(heap, buffer, len, align,
204 table = heap->ops->map_dma(heap, buffer);
205 if (WARN_ONCE(table == NULL, "heap->ops->map_dma should return ERR_PTR on error"))
206 table = ERR_PTR(-EINVAL);
208 heap->ops->free(buffer);
210 return ERR_PTR(PTR_ERR(table));
212 buffer->sg_table = table;
213 if (ion_buffer_fault_user_mappings(buffer)) {
214 int num_pages = PAGE_ALIGN(buffer->size) / PAGE_SIZE;
215 struct scatterlist *sg;
218 buffer->pages = vmalloc(sizeof(struct page *) * num_pages);
219 if (!buffer->pages) {
224 for_each_sg(table->sgl, sg, table->nents, i) {
225 struct page *page = sg_page(sg);
227 for (j = 0; j < sg->length / PAGE_SIZE; j++)
228 buffer->pages[k++] = page++;
237 INIT_LIST_HEAD(&buffer->vmas);
238 mutex_init(&buffer->lock);
239 /* this will set up dma addresses for the sglist -- it is not
240 technically correct as per the dma api -- a specific
241 device isn't really taking ownership here. However, in practice on
242 our systems the only dma_address space is physical addresses.
243 Additionally, we can't afford the overhead of invalidating every
244 allocation via dma_map_sg. The implicit contract here is that
245 memory comming from the heaps is ready for dma, ie if it has a
246 cached mapping that mapping has been invalidated */
247 for_each_sg(buffer->sg_table->sgl, sg, buffer->sg_table->nents, i)
248 sg_dma_address(sg) = sg_phys(sg);
249 mutex_lock(&dev->buffer_lock);
250 ion_buffer_add(dev, buffer);
251 mutex_unlock(&dev->buffer_lock);
255 heap->ops->unmap_dma(heap, buffer);
256 heap->ops->free(buffer);
259 vfree(buffer->pages);
265 void ion_buffer_destroy(struct ion_buffer *buffer)
267 if (WARN_ON(buffer->kmap_cnt > 0))
268 buffer->heap->ops->unmap_kernel(buffer->heap, buffer);
269 buffer->heap->ops->unmap_dma(buffer->heap, buffer);
270 buffer->heap->ops->free(buffer);
272 vfree(buffer->pages);
276 static void _ion_buffer_destroy(struct kref *kref)
278 struct ion_buffer *buffer = container_of(kref, struct ion_buffer, ref);
279 struct ion_heap *heap = buffer->heap;
280 struct ion_device *dev = buffer->dev;
282 mutex_lock(&dev->buffer_lock);
283 rb_erase(&buffer->node, &dev->buffers);
284 mutex_unlock(&dev->buffer_lock);
286 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
287 ion_heap_freelist_add(heap, buffer);
289 ion_buffer_destroy(buffer);
292 static void ion_buffer_get(struct ion_buffer *buffer)
294 kref_get(&buffer->ref);
297 static int ion_buffer_put(struct ion_buffer *buffer)
299 return kref_put(&buffer->ref, _ion_buffer_destroy);
302 static void ion_buffer_add_to_handle(struct ion_buffer *buffer)
304 mutex_lock(&buffer->lock);
305 buffer->handle_count++;
306 mutex_unlock(&buffer->lock);
309 static void ion_buffer_remove_from_handle(struct ion_buffer *buffer)
312 * when a buffer is removed from a handle, if it is not in
313 * any other handles, copy the taskcomm and the pid of the
314 * process it's being removed from into the buffer. At this
315 * point there will be no way to track what processes this buffer is
316 * being used by, it only exists as a dma_buf file descriptor.
317 * The taskcomm and pid can provide a debug hint as to where this fd
320 mutex_lock(&buffer->lock);
321 buffer->handle_count--;
322 BUG_ON(buffer->handle_count < 0);
323 if (!buffer->handle_count) {
324 struct task_struct *task;
326 task = current->group_leader;
327 get_task_comm(buffer->task_comm, task);
328 buffer->pid = task_pid_nr(task);
330 mutex_unlock(&buffer->lock);
333 static struct ion_handle *ion_handle_create(struct ion_client *client,
334 struct ion_buffer *buffer)
336 struct ion_handle *handle;
338 handle = kzalloc(sizeof(struct ion_handle), GFP_KERNEL);
340 return ERR_PTR(-ENOMEM);
341 kref_init(&handle->ref);
342 RB_CLEAR_NODE(&handle->node);
343 handle->client = client;
344 ion_buffer_get(buffer);
345 ion_buffer_add_to_handle(buffer);
346 handle->buffer = buffer;
351 static void ion_handle_kmap_put(struct ion_handle *);
353 static void ion_handle_destroy(struct kref *kref)
355 struct ion_handle *handle = container_of(kref, struct ion_handle, ref);
356 struct ion_client *client = handle->client;
357 struct ion_buffer *buffer = handle->buffer;
359 mutex_lock(&buffer->lock);
360 while (handle->kmap_cnt)
361 ion_handle_kmap_put(handle);
362 mutex_unlock(&buffer->lock);
364 idr_remove(&client->idr, handle->id);
365 if (!RB_EMPTY_NODE(&handle->node))
366 rb_erase(&handle->node, &client->handles);
368 ion_buffer_remove_from_handle(buffer);
369 ion_buffer_put(buffer);
374 struct ion_buffer *ion_handle_buffer(struct ion_handle *handle)
376 return handle->buffer;
379 static void ion_handle_get(struct ion_handle *handle)
381 kref_get(&handle->ref);
384 static int ion_handle_put(struct ion_handle *handle)
386 struct ion_client *client = handle->client;
389 mutex_lock(&client->lock);
390 ret = kref_put(&handle->ref, ion_handle_destroy);
391 mutex_unlock(&client->lock);
396 static struct ion_handle *ion_handle_lookup(struct ion_client *client,
397 struct ion_buffer *buffer)
399 struct rb_node *n = client->handles.rb_node;
402 struct ion_handle *entry = rb_entry(n, struct ion_handle, node);
403 if (buffer < entry->buffer)
405 else if (buffer > entry->buffer)
410 return ERR_PTR(-EINVAL);
413 static struct ion_handle *ion_handle_get_by_id(struct ion_client *client,
416 struct ion_handle *handle;
418 mutex_lock(&client->lock);
419 handle = idr_find(&client->idr, id);
421 ion_handle_get(handle);
422 mutex_unlock(&client->lock);
424 return handle ? handle : ERR_PTR(-EINVAL);
427 static bool ion_handle_validate(struct ion_client *client, struct ion_handle *handle)
429 WARN_ON(!mutex_is_locked(&client->lock));
430 return (idr_find(&client->idr, handle->id) == handle);
433 static int ion_handle_add(struct ion_client *client, struct ion_handle *handle)
436 struct rb_node **p = &client->handles.rb_node;
437 struct rb_node *parent = NULL;
438 struct ion_handle *entry;
440 id = idr_alloc(&client->idr, handle, 1, 0, GFP_KERNEL);
448 entry = rb_entry(parent, struct ion_handle, node);
450 if (handle->buffer < entry->buffer)
452 else if (handle->buffer > entry->buffer)
455 WARN(1, "%s: buffer already found.", __func__);
458 rb_link_node(&handle->node, parent, p);
459 rb_insert_color(&handle->node, &client->handles);
464 struct ion_handle *ion_alloc(struct ion_client *client, size_t len,
465 size_t align, unsigned int heap_id_mask,
468 struct ion_handle *handle;
469 struct ion_device *dev = client->dev;
470 struct ion_buffer *buffer = NULL;
471 struct ion_heap *heap;
474 pr_debug("%s: len %zu align %zu heap_id_mask %u flags %x\n", __func__,
475 len, align, heap_id_mask, flags);
477 * traverse the list of heaps available in this system in priority
478 * order. If the heap type is supported by the client, and matches the
479 * request of the caller allocate from it. Repeat until allocate has
480 * succeeded or all heaps have been tried
482 len = PAGE_ALIGN(len);
485 return ERR_PTR(-EINVAL);
487 down_read(&dev->lock);
488 plist_for_each_entry(heap, &dev->heaps, node) {
489 /* if the caller didn't specify this heap id */
490 if (!((1 << heap->id) & heap_id_mask))
492 buffer = ion_buffer_create(heap, dev, len, align, flags);
499 return ERR_PTR(-ENODEV);
502 return ERR_PTR(PTR_ERR(buffer));
504 handle = ion_handle_create(client, buffer);
507 * ion_buffer_create will create a buffer with a ref_cnt of 1,
508 * and ion_handle_create will take a second reference, drop one here
510 ion_buffer_put(buffer);
515 mutex_lock(&client->lock);
516 ret = ion_handle_add(client, handle);
517 mutex_unlock(&client->lock);
519 ion_handle_put(handle);
520 handle = ERR_PTR(ret);
525 EXPORT_SYMBOL(ion_alloc);
527 void ion_free(struct ion_client *client, struct ion_handle *handle)
531 BUG_ON(client != handle->client);
533 mutex_lock(&client->lock);
534 valid_handle = ion_handle_validate(client, handle);
537 WARN(1, "%s: invalid handle passed to free.\n", __func__);
538 mutex_unlock(&client->lock);
541 mutex_unlock(&client->lock);
542 ion_handle_put(handle);
544 EXPORT_SYMBOL(ion_free);
546 int ion_phys(struct ion_client *client, struct ion_handle *handle,
547 ion_phys_addr_t *addr, size_t *len)
549 struct ion_buffer *buffer;
552 mutex_lock(&client->lock);
553 if (!ion_handle_validate(client, handle)) {
554 mutex_unlock(&client->lock);
558 buffer = handle->buffer;
560 if (!buffer->heap->ops->phys) {
561 pr_err("%s: ion_phys is not implemented by this heap.\n",
563 mutex_unlock(&client->lock);
566 mutex_unlock(&client->lock);
567 ret = buffer->heap->ops->phys(buffer->heap, buffer, addr, len);
570 EXPORT_SYMBOL(ion_phys);
572 static void *ion_buffer_kmap_get(struct ion_buffer *buffer)
576 if (buffer->kmap_cnt) {
578 return buffer->vaddr;
580 vaddr = buffer->heap->ops->map_kernel(buffer->heap, buffer);
581 if (WARN_ONCE(vaddr == NULL, "heap->ops->map_kernel should return ERR_PTR on error"))
582 return ERR_PTR(-EINVAL);
585 buffer->vaddr = vaddr;
590 static void *ion_handle_kmap_get(struct ion_handle *handle)
592 struct ion_buffer *buffer = handle->buffer;
595 if (handle->kmap_cnt) {
597 return buffer->vaddr;
599 vaddr = ion_buffer_kmap_get(buffer);
606 static void ion_buffer_kmap_put(struct ion_buffer *buffer)
609 if (!buffer->kmap_cnt) {
610 buffer->heap->ops->unmap_kernel(buffer->heap, buffer);
611 buffer->vaddr = NULL;
615 static void ion_handle_kmap_put(struct ion_handle *handle)
617 struct ion_buffer *buffer = handle->buffer;
620 if (!handle->kmap_cnt)
621 ion_buffer_kmap_put(buffer);
624 void *ion_map_kernel(struct ion_client *client, struct ion_handle *handle)
626 struct ion_buffer *buffer;
629 mutex_lock(&client->lock);
630 if (!ion_handle_validate(client, handle)) {
631 pr_err("%s: invalid handle passed to map_kernel.\n",
633 mutex_unlock(&client->lock);
634 return ERR_PTR(-EINVAL);
637 buffer = handle->buffer;
639 if (!handle->buffer->heap->ops->map_kernel) {
640 pr_err("%s: map_kernel is not implemented by this heap.\n",
642 mutex_unlock(&client->lock);
643 return ERR_PTR(-ENODEV);
646 mutex_lock(&buffer->lock);
647 vaddr = ion_handle_kmap_get(handle);
648 mutex_unlock(&buffer->lock);
649 mutex_unlock(&client->lock);
652 EXPORT_SYMBOL(ion_map_kernel);
654 void ion_unmap_kernel(struct ion_client *client, struct ion_handle *handle)
656 struct ion_buffer *buffer;
658 mutex_lock(&client->lock);
659 buffer = handle->buffer;
660 mutex_lock(&buffer->lock);
661 ion_handle_kmap_put(handle);
662 mutex_unlock(&buffer->lock);
663 mutex_unlock(&client->lock);
665 EXPORT_SYMBOL(ion_unmap_kernel);
667 static int ion_debug_client_show(struct seq_file *s, void *unused)
669 struct ion_client *client = s->private;
671 size_t sizes[ION_NUM_HEAP_IDS] = {0};
672 const char *names[ION_NUM_HEAP_IDS] = {NULL};
675 mutex_lock(&client->lock);
676 for (n = rb_first(&client->handles); n; n = rb_next(n)) {
677 struct ion_handle *handle = rb_entry(n, struct ion_handle,
679 unsigned int id = handle->buffer->heap->id;
682 names[id] = handle->buffer->heap->name;
683 sizes[id] += handle->buffer->size;
685 mutex_unlock(&client->lock);
687 seq_printf(s, "%16.16s: %16.16s\n", "heap_name", "size_in_bytes");
688 for (i = 0; i < ION_NUM_HEAP_IDS; i++) {
691 seq_printf(s, "%16.16s: %16zu\n", names[i], sizes[i]);
696 static int ion_debug_client_open(struct inode *inode, struct file *file)
698 return single_open(file, ion_debug_client_show, inode->i_private);
701 static const struct file_operations debug_client_fops = {
702 .open = ion_debug_client_open,
705 .release = single_release,
708 struct ion_client *ion_client_create(struct ion_device *dev,
711 struct ion_client *client;
712 struct task_struct *task;
714 struct rb_node *parent = NULL;
715 struct ion_client *entry;
719 get_task_struct(current->group_leader);
720 task_lock(current->group_leader);
721 pid = task_pid_nr(current->group_leader);
722 /* don't bother to store task struct for kernel threads,
723 they can't be killed anyway */
724 if (current->group_leader->flags & PF_KTHREAD) {
725 put_task_struct(current->group_leader);
728 task = current->group_leader;
730 task_unlock(current->group_leader);
732 client = kzalloc(sizeof(struct ion_client), GFP_KERNEL);
735 put_task_struct(current->group_leader);
736 return ERR_PTR(-ENOMEM);
740 client->handles = RB_ROOT;
741 idr_init(&client->idr);
742 mutex_init(&client->lock);
747 down_write(&dev->lock);
748 p = &dev->clients.rb_node;
751 entry = rb_entry(parent, struct ion_client, node);
755 else if (client > entry)
758 rb_link_node(&client->node, parent, p);
759 rb_insert_color(&client->node, &dev->clients);
761 snprintf(debug_name, 64, "%u", client->pid);
762 client->debug_root = debugfs_create_file(debug_name, 0664,
763 dev->debug_root, client,
765 up_write(&dev->lock);
769 EXPORT_SYMBOL(ion_client_create);
771 void ion_client_destroy(struct ion_client *client)
773 struct ion_device *dev = client->dev;
776 pr_debug("%s: %d\n", __func__, __LINE__);
777 while ((n = rb_first(&client->handles))) {
778 struct ion_handle *handle = rb_entry(n, struct ion_handle,
780 ion_handle_destroy(&handle->ref);
783 idr_destroy(&client->idr);
785 down_write(&dev->lock);
787 put_task_struct(client->task);
788 rb_erase(&client->node, &dev->clients);
789 debugfs_remove_recursive(client->debug_root);
790 up_write(&dev->lock);
794 EXPORT_SYMBOL(ion_client_destroy);
796 struct sg_table *ion_sg_table(struct ion_client *client,
797 struct ion_handle *handle)
799 struct ion_buffer *buffer;
800 struct sg_table *table;
802 mutex_lock(&client->lock);
803 if (!ion_handle_validate(client, handle)) {
804 pr_err("%s: invalid handle passed to map_dma.\n",
806 mutex_unlock(&client->lock);
807 return ERR_PTR(-EINVAL);
809 buffer = handle->buffer;
810 table = buffer->sg_table;
811 mutex_unlock(&client->lock);
814 EXPORT_SYMBOL(ion_sg_table);
816 static void ion_buffer_sync_for_device(struct ion_buffer *buffer,
818 enum dma_data_direction direction);
820 static struct sg_table *ion_map_dma_buf(struct dma_buf_attachment *attachment,
821 enum dma_data_direction direction)
823 struct dma_buf *dmabuf = attachment->dmabuf;
824 struct ion_buffer *buffer = dmabuf->priv;
826 ion_buffer_sync_for_device(buffer, attachment->dev, direction);
827 return buffer->sg_table;
830 static void ion_unmap_dma_buf(struct dma_buf_attachment *attachment,
831 struct sg_table *table,
832 enum dma_data_direction direction)
836 void ion_pages_sync_for_device(struct device *dev, struct page *page,
837 size_t size, enum dma_data_direction dir)
839 struct scatterlist sg;
841 sg_init_table(&sg, 1);
842 sg_set_page(&sg, page, size, 0);
844 * This is not correct - sg_dma_address needs a dma_addr_t that is valid
845 * for the the targeted device, but this works on the currently targeted
848 sg_dma_address(&sg) = page_to_phys(page);
849 dma_sync_sg_for_device(dev, &sg, 1, dir);
852 struct ion_vma_list {
853 struct list_head list;
854 struct vm_area_struct *vma;
857 static void ion_buffer_sync_for_device(struct ion_buffer *buffer,
859 enum dma_data_direction dir)
861 struct ion_vma_list *vma_list;
862 int pages = PAGE_ALIGN(buffer->size) / PAGE_SIZE;
865 pr_debug("%s: syncing for device %s\n", __func__,
866 dev ? dev_name(dev) : "null");
868 if (!ion_buffer_fault_user_mappings(buffer))
871 mutex_lock(&buffer->lock);
872 for (i = 0; i < pages; i++) {
873 struct page *page = buffer->pages[i];
875 if (ion_buffer_page_is_dirty(page))
876 ion_pages_sync_for_device(dev, ion_buffer_page(page),
879 ion_buffer_page_clean(buffer->pages + i);
881 list_for_each_entry(vma_list, &buffer->vmas, list) {
882 struct vm_area_struct *vma = vma_list->vma;
884 zap_page_range(vma, vma->vm_start, vma->vm_end - vma->vm_start,
887 mutex_unlock(&buffer->lock);
890 static int ion_vm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
892 struct ion_buffer *buffer = vma->vm_private_data;
896 mutex_lock(&buffer->lock);
897 ion_buffer_page_dirty(buffer->pages + vmf->pgoff);
898 BUG_ON(!buffer->pages || !buffer->pages[vmf->pgoff]);
900 pfn = page_to_pfn(ion_buffer_page(buffer->pages[vmf->pgoff]));
901 ret = vm_insert_pfn(vma, (unsigned long)vmf->virtual_address, pfn);
902 mutex_unlock(&buffer->lock);
904 return VM_FAULT_ERROR;
906 return VM_FAULT_NOPAGE;
909 static void ion_vm_open(struct vm_area_struct *vma)
911 struct ion_buffer *buffer = vma->vm_private_data;
912 struct ion_vma_list *vma_list;
914 vma_list = kmalloc(sizeof(struct ion_vma_list), GFP_KERNEL);
918 mutex_lock(&buffer->lock);
919 list_add(&vma_list->list, &buffer->vmas);
920 mutex_unlock(&buffer->lock);
921 pr_debug("%s: adding %p\n", __func__, vma);
924 static void ion_vm_close(struct vm_area_struct *vma)
926 struct ion_buffer *buffer = vma->vm_private_data;
927 struct ion_vma_list *vma_list, *tmp;
929 pr_debug("%s\n", __func__);
930 mutex_lock(&buffer->lock);
931 list_for_each_entry_safe(vma_list, tmp, &buffer->vmas, list) {
932 if (vma_list->vma != vma)
934 list_del(&vma_list->list);
936 pr_debug("%s: deleting %p\n", __func__, vma);
939 mutex_unlock(&buffer->lock);
942 static struct vm_operations_struct ion_vma_ops = {
944 .close = ion_vm_close,
945 .fault = ion_vm_fault,
948 static int ion_mmap(struct dma_buf *dmabuf, struct vm_area_struct *vma)
950 struct ion_buffer *buffer = dmabuf->priv;
953 if (!buffer->heap->ops->map_user) {
954 pr_err("%s: this heap does not define a method for mapping "
955 "to userspace\n", __func__);
959 if (ion_buffer_fault_user_mappings(buffer)) {
960 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND |
962 vma->vm_private_data = buffer;
963 vma->vm_ops = &ion_vma_ops;
968 if (!(buffer->flags & ION_FLAG_CACHED))
969 vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
971 mutex_lock(&buffer->lock);
972 /* now map it to userspace */
973 ret = buffer->heap->ops->map_user(buffer->heap, buffer, vma);
974 mutex_unlock(&buffer->lock);
977 pr_err("%s: failure mapping buffer to userspace\n",
983 static void ion_dma_buf_release(struct dma_buf *dmabuf)
985 struct ion_buffer *buffer = dmabuf->priv;
986 ion_buffer_put(buffer);
989 static void *ion_dma_buf_kmap(struct dma_buf *dmabuf, unsigned long offset)
991 struct ion_buffer *buffer = dmabuf->priv;
992 return buffer->vaddr + offset * PAGE_SIZE;
995 static void ion_dma_buf_kunmap(struct dma_buf *dmabuf, unsigned long offset,
1001 static int ion_dma_buf_begin_cpu_access(struct dma_buf *dmabuf, size_t start,
1003 enum dma_data_direction direction)
1005 struct ion_buffer *buffer = dmabuf->priv;
1008 if (!buffer->heap->ops->map_kernel) {
1009 pr_err("%s: map kernel is not implemented by this heap.\n",
1014 mutex_lock(&buffer->lock);
1015 vaddr = ion_buffer_kmap_get(buffer);
1016 mutex_unlock(&buffer->lock);
1018 return PTR_ERR(vaddr);
1022 static void ion_dma_buf_end_cpu_access(struct dma_buf *dmabuf, size_t start,
1024 enum dma_data_direction direction)
1026 struct ion_buffer *buffer = dmabuf->priv;
1028 mutex_lock(&buffer->lock);
1029 ion_buffer_kmap_put(buffer);
1030 mutex_unlock(&buffer->lock);
1033 static struct dma_buf_ops dma_buf_ops = {
1034 .map_dma_buf = ion_map_dma_buf,
1035 .unmap_dma_buf = ion_unmap_dma_buf,
1037 .release = ion_dma_buf_release,
1038 .begin_cpu_access = ion_dma_buf_begin_cpu_access,
1039 .end_cpu_access = ion_dma_buf_end_cpu_access,
1040 .kmap_atomic = ion_dma_buf_kmap,
1041 .kunmap_atomic = ion_dma_buf_kunmap,
1042 .kmap = ion_dma_buf_kmap,
1043 .kunmap = ion_dma_buf_kunmap,
1046 struct dma_buf *ion_share_dma_buf(struct ion_client *client,
1047 struct ion_handle *handle)
1049 struct ion_buffer *buffer;
1050 struct dma_buf *dmabuf;
1053 mutex_lock(&client->lock);
1054 valid_handle = ion_handle_validate(client, handle);
1055 if (!valid_handle) {
1056 WARN(1, "%s: invalid handle passed to share.\n", __func__);
1057 mutex_unlock(&client->lock);
1058 return ERR_PTR(-EINVAL);
1060 buffer = handle->buffer;
1061 ion_buffer_get(buffer);
1062 mutex_unlock(&client->lock);
1064 dmabuf = dma_buf_export(buffer, &dma_buf_ops, buffer->size, O_RDWR);
1065 if (IS_ERR(dmabuf)) {
1066 ion_buffer_put(buffer);
1072 EXPORT_SYMBOL(ion_share_dma_buf);
1074 int ion_share_dma_buf_fd(struct ion_client *client, struct ion_handle *handle)
1076 struct dma_buf *dmabuf;
1079 dmabuf = ion_share_dma_buf(client, handle);
1081 return PTR_ERR(dmabuf);
1083 fd = dma_buf_fd(dmabuf, O_CLOEXEC);
1085 dma_buf_put(dmabuf);
1089 EXPORT_SYMBOL(ion_share_dma_buf_fd);
1091 struct ion_handle *ion_import_dma_buf(struct ion_client *client, int fd)
1093 struct dma_buf *dmabuf;
1094 struct ion_buffer *buffer;
1095 struct ion_handle *handle;
1098 dmabuf = dma_buf_get(fd);
1100 return ERR_PTR(PTR_ERR(dmabuf));
1101 /* if this memory came from ion */
1103 if (dmabuf->ops != &dma_buf_ops) {
1104 pr_err("%s: can not import dmabuf from another exporter\n",
1106 dma_buf_put(dmabuf);
1107 return ERR_PTR(-EINVAL);
1109 buffer = dmabuf->priv;
1111 mutex_lock(&client->lock);
1112 /* if a handle exists for this buffer just take a reference to it */
1113 handle = ion_handle_lookup(client, buffer);
1114 if (!IS_ERR(handle)) {
1115 ion_handle_get(handle);
1116 mutex_unlock(&client->lock);
1119 mutex_unlock(&client->lock);
1121 handle = ion_handle_create(client, buffer);
1125 mutex_lock(&client->lock);
1126 ret = ion_handle_add(client, handle);
1127 mutex_unlock(&client->lock);
1129 ion_handle_put(handle);
1130 handle = ERR_PTR(ret);
1134 dma_buf_put(dmabuf);
1137 EXPORT_SYMBOL(ion_import_dma_buf);
1139 static int ion_sync_for_device(struct ion_client *client, int fd)
1141 struct dma_buf *dmabuf;
1142 struct ion_buffer *buffer;
1144 dmabuf = dma_buf_get(fd);
1146 return PTR_ERR(dmabuf);
1148 /* if this memory came from ion */
1149 if (dmabuf->ops != &dma_buf_ops) {
1150 pr_err("%s: can not sync dmabuf from another exporter\n",
1152 dma_buf_put(dmabuf);
1155 buffer = dmabuf->priv;
1157 dma_sync_sg_for_device(NULL, buffer->sg_table->sgl,
1158 buffer->sg_table->nents, DMA_BIDIRECTIONAL);
1159 dma_buf_put(dmabuf);
1163 /* fix up the cases where the ioctl direction bits are incorrect */
1164 static unsigned int ion_ioctl_dir(unsigned int cmd)
1169 case ION_IOC_CUSTOM:
1172 return _IOC_DIR(cmd);
1176 static long ion_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1178 struct ion_client *client = filp->private_data;
1179 struct ion_device *dev = client->dev;
1180 struct ion_handle *cleanup_handle = NULL;
1185 struct ion_fd_data fd;
1186 struct ion_allocation_data allocation;
1187 struct ion_handle_data handle;
1188 struct ion_custom_data custom;
1191 dir = ion_ioctl_dir(cmd);
1193 if (_IOC_SIZE(cmd) > sizeof(data))
1196 if (dir & _IOC_WRITE)
1197 if (copy_from_user(&data, (void __user *)arg, _IOC_SIZE(cmd)))
1203 struct ion_handle *handle;
1205 handle = ion_alloc(client, data.allocation.len,
1206 data.allocation.align,
1207 data.allocation.heap_id_mask,
1208 data.allocation.flags);
1210 return PTR_ERR(handle);
1212 data.allocation.handle = handle->id;
1214 cleanup_handle = handle;
1219 struct ion_handle *handle;
1221 handle = ion_handle_get_by_id(client, data.handle.handle);
1223 return PTR_ERR(handle);
1224 ion_free(client, handle);
1225 ion_handle_put(handle);
1231 struct ion_handle *handle;
1233 handle = ion_handle_get_by_id(client, data.handle.handle);
1235 return PTR_ERR(handle);
1236 data.fd.fd = ion_share_dma_buf_fd(client, handle);
1237 ion_handle_put(handle);
1242 case ION_IOC_IMPORT:
1244 struct ion_handle *handle;
1245 handle = ion_import_dma_buf(client, data.fd.fd);
1247 ret = PTR_ERR(handle);
1249 data.handle.handle = handle->id;
1254 ret = ion_sync_for_device(client, data.fd.fd);
1257 case ION_IOC_CUSTOM:
1259 if (!dev->custom_ioctl)
1261 ret = dev->custom_ioctl(client, data.custom.cmd,
1269 if (dir & _IOC_READ) {
1270 if (copy_to_user((void __user *)arg, &data, _IOC_SIZE(cmd))) {
1272 ion_free(client, cleanup_handle);
1279 static int ion_release(struct inode *inode, struct file *file)
1281 struct ion_client *client = file->private_data;
1283 pr_debug("%s: %d\n", __func__, __LINE__);
1284 ion_client_destroy(client);
1288 static int ion_open(struct inode *inode, struct file *file)
1290 struct miscdevice *miscdev = file->private_data;
1291 struct ion_device *dev = container_of(miscdev, struct ion_device, dev);
1292 struct ion_client *client;
1294 pr_debug("%s: %d\n", __func__, __LINE__);
1295 client = ion_client_create(dev, "user");
1297 return PTR_ERR(client);
1298 file->private_data = client;
1303 static const struct file_operations ion_fops = {
1304 .owner = THIS_MODULE,
1306 .release = ion_release,
1307 .unlocked_ioctl = ion_ioctl,
1308 .compat_ioctl = compat_ion_ioctl,
1311 static size_t ion_debug_heap_total(struct ion_client *client,
1317 mutex_lock(&client->lock);
1318 for (n = rb_first(&client->handles); n; n = rb_next(n)) {
1319 struct ion_handle *handle = rb_entry(n,
1322 if (handle->buffer->heap->id == id)
1323 size += handle->buffer->size;
1325 mutex_unlock(&client->lock);
1329 static int ion_debug_heap_show(struct seq_file *s, void *unused)
1331 struct ion_heap *heap = s->private;
1332 struct ion_device *dev = heap->dev;
1334 size_t total_size = 0;
1335 size_t total_orphaned_size = 0;
1337 seq_printf(s, "%16.s %16.s %16.s\n", "client", "pid", "size");
1338 seq_printf(s, "----------------------------------------------------\n");
1340 for (n = rb_first(&dev->clients); n; n = rb_next(n)) {
1341 struct ion_client *client = rb_entry(n, struct ion_client,
1343 size_t size = ion_debug_heap_total(client, heap->id);
1347 char task_comm[TASK_COMM_LEN];
1349 get_task_comm(task_comm, client->task);
1350 seq_printf(s, "%16.s %16u %16zu\n", task_comm,
1353 seq_printf(s, "%16.s %16u %16zu\n", client->name,
1357 seq_printf(s, "----------------------------------------------------\n");
1358 seq_printf(s, "orphaned allocations (info is from last known client):"
1360 mutex_lock(&dev->buffer_lock);
1361 for (n = rb_first(&dev->buffers); n; n = rb_next(n)) {
1362 struct ion_buffer *buffer = rb_entry(n, struct ion_buffer,
1364 if (buffer->heap->id != heap->id)
1366 total_size += buffer->size;
1367 if (!buffer->handle_count) {
1368 seq_printf(s, "%16.s %16u %16zu %d %d\n",
1369 buffer->task_comm, buffer->pid,
1370 buffer->size, buffer->kmap_cnt,
1371 atomic_read(&buffer->ref.refcount));
1372 total_orphaned_size += buffer->size;
1375 mutex_unlock(&dev->buffer_lock);
1376 seq_printf(s, "----------------------------------------------------\n");
1377 seq_printf(s, "%16.s %16zu\n", "total orphaned",
1378 total_orphaned_size);
1379 seq_printf(s, "%16.s %16zu\n", "total ", total_size);
1380 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
1381 seq_printf(s, "%16.s %16zu\n", "deferred free",
1382 heap->free_list_size);
1383 seq_printf(s, "----------------------------------------------------\n");
1385 if (heap->debug_show)
1386 heap->debug_show(heap, s, unused);
1391 static int ion_debug_heap_open(struct inode *inode, struct file *file)
1393 return single_open(file, ion_debug_heap_show, inode->i_private);
1396 static const struct file_operations debug_heap_fops = {
1397 .open = ion_debug_heap_open,
1399 .llseek = seq_lseek,
1400 .release = single_release,
1403 #ifdef DEBUG_HEAP_SHRINKER
1404 static int debug_shrink_set(void *data, u64 val)
1406 struct ion_heap *heap = data;
1407 struct shrink_control sc;
1416 objs = heap->shrinker.shrink(&heap->shrinker, &sc);
1417 sc.nr_to_scan = objs;
1419 heap->shrinker.shrink(&heap->shrinker, &sc);
1423 static int debug_shrink_get(void *data, u64 *val)
1425 struct ion_heap *heap = data;
1426 struct shrink_control sc;
1432 objs = heap->shrinker.shrink(&heap->shrinker, &sc);
1437 DEFINE_SIMPLE_ATTRIBUTE(debug_shrink_fops, debug_shrink_get,
1438 debug_shrink_set, "%llu\n");
1441 void ion_device_add_heap(struct ion_device *dev, struct ion_heap *heap)
1443 if (!heap->ops->allocate || !heap->ops->free || !heap->ops->map_dma ||
1444 !heap->ops->unmap_dma)
1445 pr_err("%s: can not add heap with invalid ops struct.\n",
1448 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
1449 ion_heap_init_deferred_free(heap);
1452 down_write(&dev->lock);
1453 /* use negative heap->id to reverse the priority -- when traversing
1454 the list later attempt higher id numbers first */
1455 plist_node_init(&heap->node, -heap->id);
1456 plist_add(&heap->node, &dev->heaps);
1457 debugfs_create_file(heap->name, 0664, dev->debug_root, heap,
1459 #ifdef DEBUG_HEAP_SHRINKER
1460 if (heap->shrinker.shrink) {
1461 char debug_name[64];
1463 snprintf(debug_name, 64, "%s_shrink", heap->name);
1464 debugfs_create_file(debug_name, 0644, dev->debug_root, heap,
1465 &debug_shrink_fops);
1468 up_write(&dev->lock);
1471 struct ion_device *ion_device_create(long (*custom_ioctl)
1472 (struct ion_client *client,
1476 struct ion_device *idev;
1479 idev = kzalloc(sizeof(struct ion_device), GFP_KERNEL);
1481 return ERR_PTR(-ENOMEM);
1483 idev->dev.minor = MISC_DYNAMIC_MINOR;
1484 idev->dev.name = "ion";
1485 idev->dev.fops = &ion_fops;
1486 idev->dev.parent = NULL;
1487 ret = misc_register(&idev->dev);
1489 pr_err("ion: failed to register misc device.\n");
1490 return ERR_PTR(ret);
1493 idev->debug_root = debugfs_create_dir("ion", NULL);
1494 if (!idev->debug_root)
1495 pr_err("ion: failed to create debug files.\n");
1497 idev->custom_ioctl = custom_ioctl;
1498 idev->buffers = RB_ROOT;
1499 mutex_init(&idev->buffer_lock);
1500 init_rwsem(&idev->lock);
1501 plist_head_init(&idev->heaps);
1502 idev->clients = RB_ROOT;
1506 void ion_device_destroy(struct ion_device *dev)
1508 misc_deregister(&dev->dev);
1509 /* XXX need to free the heaps and clients ? */
1513 void __init ion_reserve(struct ion_platform_data *data)
1517 for (i = 0; i < data->nr; i++) {
1518 if (data->heaps[i].size == 0)
1521 if (data->heaps[i].base == 0) {
1523 paddr = memblock_alloc_base(data->heaps[i].size,
1524 data->heaps[i].align,
1525 MEMBLOCK_ALLOC_ANYWHERE);
1527 pr_err("%s: error allocating memblock for "
1532 data->heaps[i].base = paddr;
1534 int ret = memblock_reserve(data->heaps[i].base,
1535 data->heaps[i].size);
1537 pr_err("memblock reserve of %zx@%lx failed\n",
1538 data->heaps[i].size,
1539 data->heaps[i].base);
1541 pr_info("%s: %s reserved base %lx size %zu\n", __func__,
1542 data->heaps[i].name,
1543 data->heaps[i].base,
1544 data->heaps[i].size);