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(struct ion_handle *handle)
392 struct ion_client *client = handle->client;
395 mutex_lock(&client->lock);
396 ret = kref_put(&handle->ref, ion_handle_destroy);
397 mutex_unlock(&client->lock);
402 static struct ion_handle *ion_handle_lookup(struct ion_client *client,
403 struct ion_buffer *buffer)
405 struct rb_node *n = client->handles.rb_node;
408 struct ion_handle *entry = rb_entry(n, struct ion_handle, node);
410 if (buffer < entry->buffer)
412 else if (buffer > entry->buffer)
417 return ERR_PTR(-EINVAL);
420 static struct ion_handle *ion_handle_get_by_id(struct ion_client *client,
423 struct ion_handle *handle;
425 mutex_lock(&client->lock);
426 handle = idr_find(&client->idr, id);
428 ion_handle_get(handle);
429 mutex_unlock(&client->lock);
431 return handle ? handle : ERR_PTR(-EINVAL);
434 static bool ion_handle_validate(struct ion_client *client,
435 struct ion_handle *handle)
437 WARN_ON(!mutex_is_locked(&client->lock));
438 return idr_find(&client->idr, handle->id) == handle;
441 static int ion_handle_add(struct ion_client *client, struct ion_handle *handle)
444 struct rb_node **p = &client->handles.rb_node;
445 struct rb_node *parent = NULL;
446 struct ion_handle *entry;
448 id = idr_alloc(&client->idr, handle, 1, 0, GFP_KERNEL);
456 entry = rb_entry(parent, struct ion_handle, node);
458 if (handle->buffer < entry->buffer)
460 else if (handle->buffer > entry->buffer)
463 WARN(1, "%s: buffer already found.", __func__);
466 rb_link_node(&handle->node, parent, p);
467 rb_insert_color(&handle->node, &client->handles);
472 struct ion_handle *ion_alloc(struct ion_client *client, size_t len,
473 size_t align, unsigned int heap_id_mask,
476 struct ion_handle *handle;
477 struct ion_device *dev = client->dev;
478 struct ion_buffer *buffer = NULL;
479 struct ion_heap *heap;
482 pr_debug("%s: len %zu align %zu heap_id_mask %u flags %x\n", __func__,
483 len, align, heap_id_mask, flags);
485 * traverse the list of heaps available in this system in priority
486 * order. If the heap type is supported by the client, and matches the
487 * request of the caller allocate from it. Repeat until allocate has
488 * succeeded or all heaps have been tried
490 len = PAGE_ALIGN(len);
493 return ERR_PTR(-EINVAL);
495 down_read(&dev->lock);
496 plist_for_each_entry(heap, &dev->heaps, node) {
497 /* if the caller didn't specify this heap id */
498 if (!((1 << heap->id) & heap_id_mask))
500 buffer = ion_buffer_create(heap, dev, len, align, flags);
507 return ERR_PTR(-ENODEV);
510 return ERR_CAST(buffer);
512 handle = ion_handle_create(client, buffer);
515 * ion_buffer_create will create a buffer with a ref_cnt of 1,
516 * and ion_handle_create will take a second reference, drop one here
518 ion_buffer_put(buffer);
523 mutex_lock(&client->lock);
524 ret = ion_handle_add(client, handle);
525 mutex_unlock(&client->lock);
527 ion_handle_put(handle);
528 handle = ERR_PTR(ret);
533 EXPORT_SYMBOL(ion_alloc);
535 void ion_free(struct ion_client *client, struct ion_handle *handle)
539 BUG_ON(client != handle->client);
541 mutex_lock(&client->lock);
542 valid_handle = ion_handle_validate(client, handle);
545 WARN(1, "%s: invalid handle passed to free.\n", __func__);
546 mutex_unlock(&client->lock);
549 mutex_unlock(&client->lock);
550 ion_handle_put(handle);
552 EXPORT_SYMBOL(ion_free);
554 int ion_phys(struct ion_client *client, struct ion_handle *handle,
555 ion_phys_addr_t *addr, size_t *len)
557 struct ion_buffer *buffer;
560 mutex_lock(&client->lock);
561 if (!ion_handle_validate(client, handle)) {
562 mutex_unlock(&client->lock);
566 buffer = handle->buffer;
568 if (!buffer->heap->ops->phys) {
569 pr_err("%s: ion_phys is not implemented by this heap (name=%s, type=%d).\n",
570 __func__, buffer->heap->name, buffer->heap->type);
571 mutex_unlock(&client->lock);
574 mutex_unlock(&client->lock);
575 ret = buffer->heap->ops->phys(buffer->heap, buffer, addr, len);
578 EXPORT_SYMBOL(ion_phys);
580 static void *ion_buffer_kmap_get(struct ion_buffer *buffer)
584 if (buffer->kmap_cnt) {
586 return buffer->vaddr;
588 vaddr = buffer->heap->ops->map_kernel(buffer->heap, buffer);
589 if (WARN_ONCE(vaddr == NULL,
590 "heap->ops->map_kernel should return ERR_PTR on error"))
591 return ERR_PTR(-EINVAL);
594 buffer->vaddr = vaddr;
599 static void *ion_handle_kmap_get(struct ion_handle *handle)
601 struct ion_buffer *buffer = handle->buffer;
604 if (handle->kmap_cnt) {
606 return buffer->vaddr;
608 vaddr = ion_buffer_kmap_get(buffer);
615 static void ion_buffer_kmap_put(struct ion_buffer *buffer)
618 if (!buffer->kmap_cnt) {
619 buffer->heap->ops->unmap_kernel(buffer->heap, buffer);
620 buffer->vaddr = NULL;
624 static void ion_handle_kmap_put(struct ion_handle *handle)
626 struct ion_buffer *buffer = handle->buffer;
628 if (!handle->kmap_cnt) {
629 WARN(1, "%s: Double unmap detected! bailing...\n", __func__);
633 if (!handle->kmap_cnt)
634 ion_buffer_kmap_put(buffer);
637 void *ion_map_kernel(struct ion_client *client, struct ion_handle *handle)
639 struct ion_buffer *buffer;
642 mutex_lock(&client->lock);
643 if (!ion_handle_validate(client, handle)) {
644 pr_err("%s: invalid handle passed to map_kernel.\n",
646 mutex_unlock(&client->lock);
647 return ERR_PTR(-EINVAL);
650 buffer = handle->buffer;
652 if (!handle->buffer->heap->ops->map_kernel) {
653 pr_err("%s: map_kernel is not implemented by this heap.\n",
655 mutex_unlock(&client->lock);
656 return ERR_PTR(-ENODEV);
659 mutex_lock(&buffer->lock);
660 vaddr = ion_handle_kmap_get(handle);
661 mutex_unlock(&buffer->lock);
662 mutex_unlock(&client->lock);
665 EXPORT_SYMBOL(ion_map_kernel);
667 void ion_unmap_kernel(struct ion_client *client, struct ion_handle *handle)
669 struct ion_buffer *buffer;
671 mutex_lock(&client->lock);
672 buffer = handle->buffer;
673 mutex_lock(&buffer->lock);
674 ion_handle_kmap_put(handle);
675 mutex_unlock(&buffer->lock);
676 mutex_unlock(&client->lock);
678 EXPORT_SYMBOL(ion_unmap_kernel);
680 static int ion_debug_client_show(struct seq_file *s, void *unused)
682 struct ion_client *client = s->private;
684 size_t sizes[ION_NUM_HEAP_IDS] = {0};
685 const char *names[ION_NUM_HEAP_IDS] = {NULL};
688 mutex_lock(&client->lock);
689 for (n = rb_first(&client->handles); n; n = rb_next(n)) {
690 struct ion_handle *handle = rb_entry(n, struct ion_handle,
692 unsigned int id = handle->buffer->heap->id;
695 names[id] = handle->buffer->heap->name;
696 sizes[id] += handle->buffer->size;
698 mutex_unlock(&client->lock);
700 seq_printf(s, "%16.16s: %16.16s\n", "heap_name", "size_in_bytes");
701 for (i = 0; i < ION_NUM_HEAP_IDS; i++) {
704 seq_printf(s, "%16.16s: %16zu\n", names[i], sizes[i]);
709 static int ion_debug_client_open(struct inode *inode, struct file *file)
711 return single_open(file, ion_debug_client_show, inode->i_private);
714 static const struct file_operations debug_client_fops = {
715 .open = ion_debug_client_open,
718 .release = single_release,
721 static int ion_get_client_serial(const struct rb_root *root,
722 const unsigned char *name)
725 struct rb_node *node;
727 for (node = rb_first(root); node; node = rb_next(node)) {
728 struct ion_client *client = rb_entry(node, struct ion_client,
731 if (strcmp(client->name, name))
733 serial = max(serial, client->display_serial);
738 struct ion_client *ion_client_create(struct ion_device *dev,
741 struct ion_client *client;
742 struct task_struct *task;
744 struct rb_node *parent = NULL;
745 struct ion_client *entry;
749 pr_err("%s: Name cannot be null\n", __func__);
750 return ERR_PTR(-EINVAL);
753 get_task_struct(current->group_leader);
754 task_lock(current->group_leader);
755 pid = task_pid_nr(current->group_leader);
757 * don't bother to store task struct for kernel threads,
758 * they can't be killed anyway
760 if (current->group_leader->flags & PF_KTHREAD) {
761 put_task_struct(current->group_leader);
764 task = current->group_leader;
766 task_unlock(current->group_leader);
768 client = kzalloc(sizeof(struct ion_client), GFP_KERNEL);
770 goto err_put_task_struct;
773 client->handles = RB_ROOT;
774 idr_init(&client->idr);
775 mutex_init(&client->lock);
778 client->name = kstrdup(name, GFP_KERNEL);
780 goto err_free_client;
782 down_write(&dev->lock);
783 client->display_serial = ion_get_client_serial(&dev->clients, name);
784 client->display_name = kasprintf(
785 GFP_KERNEL, "%s-%d", name, client->display_serial);
786 if (!client->display_name) {
787 up_write(&dev->lock);
788 goto err_free_client_name;
790 p = &dev->clients.rb_node;
793 entry = rb_entry(parent, struct ion_client, node);
797 else if (client > entry)
800 rb_link_node(&client->node, parent, p);
801 rb_insert_color(&client->node, &dev->clients);
803 client->debug_root = debugfs_create_file(client->display_name, 0664,
804 dev->clients_debug_root,
805 client, &debug_client_fops);
806 if (!client->debug_root) {
807 char buf[256], *path;
809 path = dentry_path(dev->clients_debug_root, buf, 256);
810 pr_err("Failed to create client debugfs at %s/%s\n",
811 path, client->display_name);
814 up_write(&dev->lock);
818 err_free_client_name:
824 put_task_struct(current->group_leader);
825 return ERR_PTR(-ENOMEM);
827 EXPORT_SYMBOL(ion_client_create);
829 void ion_client_destroy(struct ion_client *client)
831 struct ion_device *dev = client->dev;
834 pr_debug("%s: %d\n", __func__, __LINE__);
835 while ((n = rb_first(&client->handles))) {
836 struct ion_handle *handle = rb_entry(n, struct ion_handle,
838 ion_handle_destroy(&handle->ref);
841 idr_destroy(&client->idr);
843 down_write(&dev->lock);
845 put_task_struct(client->task);
846 rb_erase(&client->node, &dev->clients);
847 debugfs_remove_recursive(client->debug_root);
848 up_write(&dev->lock);
850 kfree(client->display_name);
854 EXPORT_SYMBOL(ion_client_destroy);
856 struct sg_table *ion_sg_table(struct ion_client *client,
857 struct ion_handle *handle)
859 struct ion_buffer *buffer;
860 struct sg_table *table;
862 mutex_lock(&client->lock);
863 if (!ion_handle_validate(client, handle)) {
864 pr_err("%s: invalid handle passed to map_dma.\n",
866 mutex_unlock(&client->lock);
867 return ERR_PTR(-EINVAL);
869 buffer = handle->buffer;
870 table = buffer->sg_table;
871 mutex_unlock(&client->lock);
874 EXPORT_SYMBOL(ion_sg_table);
876 static void ion_buffer_sync_for_device(struct ion_buffer *buffer,
878 enum dma_data_direction direction);
880 static struct sg_table *ion_map_dma_buf(struct dma_buf_attachment *attachment,
881 enum dma_data_direction direction)
883 struct dma_buf *dmabuf = attachment->dmabuf;
884 struct ion_buffer *buffer = dmabuf->priv;
886 ion_buffer_sync_for_device(buffer, attachment->dev, direction);
887 return buffer->sg_table;
890 static void ion_unmap_dma_buf(struct dma_buf_attachment *attachment,
891 struct sg_table *table,
892 enum dma_data_direction direction)
896 void ion_pages_sync_for_device(struct device *dev, struct page *page,
897 size_t size, enum dma_data_direction dir)
899 struct scatterlist sg;
901 sg_init_table(&sg, 1);
902 sg_set_page(&sg, page, size, 0);
904 * This is not correct - sg_dma_address needs a dma_addr_t that is valid
905 * for the targeted device, but this works on the currently targeted
908 sg_dma_address(&sg) = page_to_phys(page);
909 dma_sync_sg_for_device(dev, &sg, 1, dir);
912 struct ion_vma_list {
913 struct list_head list;
914 struct vm_area_struct *vma;
917 static void ion_buffer_sync_for_device(struct ion_buffer *buffer,
919 enum dma_data_direction dir)
921 struct ion_vma_list *vma_list;
922 int pages = PAGE_ALIGN(buffer->size) / PAGE_SIZE;
925 pr_debug("%s: syncing for device %s\n", __func__,
926 dev ? dev_name(dev) : "null");
928 if (!ion_buffer_fault_user_mappings(buffer))
931 mutex_lock(&buffer->lock);
932 for (i = 0; i < pages; i++) {
933 struct page *page = buffer->pages[i];
935 if (ion_buffer_page_is_dirty(page))
936 ion_pages_sync_for_device(dev, ion_buffer_page(page),
939 ion_buffer_page_clean(buffer->pages + i);
941 list_for_each_entry(vma_list, &buffer->vmas, list) {
942 struct vm_area_struct *vma = vma_list->vma;
944 zap_page_range(vma, vma->vm_start, vma->vm_end - vma->vm_start,
947 mutex_unlock(&buffer->lock);
950 static int ion_vm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
952 struct ion_buffer *buffer = vma->vm_private_data;
956 mutex_lock(&buffer->lock);
957 ion_buffer_page_dirty(buffer->pages + vmf->pgoff);
958 BUG_ON(!buffer->pages || !buffer->pages[vmf->pgoff]);
960 pfn = page_to_pfn(ion_buffer_page(buffer->pages[vmf->pgoff]));
961 ret = vm_insert_pfn(vma, (unsigned long)vmf->virtual_address, pfn);
962 mutex_unlock(&buffer->lock);
964 return VM_FAULT_ERROR;
966 return VM_FAULT_NOPAGE;
969 static void ion_vm_open(struct vm_area_struct *vma)
971 struct ion_buffer *buffer = vma->vm_private_data;
972 struct ion_vma_list *vma_list;
974 vma_list = kmalloc(sizeof(struct ion_vma_list), GFP_KERNEL);
978 mutex_lock(&buffer->lock);
979 list_add(&vma_list->list, &buffer->vmas);
980 mutex_unlock(&buffer->lock);
981 pr_debug("%s: adding %p\n", __func__, vma);
984 static void ion_vm_close(struct vm_area_struct *vma)
986 struct ion_buffer *buffer = vma->vm_private_data;
987 struct ion_vma_list *vma_list, *tmp;
989 pr_debug("%s\n", __func__);
990 mutex_lock(&buffer->lock);
991 list_for_each_entry_safe(vma_list, tmp, &buffer->vmas, list) {
992 if (vma_list->vma != vma)
994 list_del(&vma_list->list);
996 pr_debug("%s: deleting %p\n", __func__, vma);
999 mutex_unlock(&buffer->lock);
1002 static const struct vm_operations_struct ion_vma_ops = {
1003 .open = ion_vm_open,
1004 .close = ion_vm_close,
1005 .fault = ion_vm_fault,
1008 static int ion_mmap(struct dma_buf *dmabuf, struct vm_area_struct *vma)
1010 struct ion_buffer *buffer = dmabuf->priv;
1013 if (!buffer->heap->ops->map_user) {
1014 pr_err("%s: this heap does not define a method for mapping to userspace\n",
1019 if (ion_buffer_fault_user_mappings(buffer)) {
1020 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND |
1022 vma->vm_private_data = buffer;
1023 vma->vm_ops = &ion_vma_ops;
1028 if (!(buffer->flags & ION_FLAG_CACHED))
1029 vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
1031 mutex_lock(&buffer->lock);
1032 /* now map it to userspace */
1033 ret = buffer->heap->ops->map_user(buffer->heap, buffer, vma);
1034 mutex_unlock(&buffer->lock);
1037 pr_err("%s: failure mapping buffer to userspace\n",
1043 static void ion_dma_buf_release(struct dma_buf *dmabuf)
1045 struct ion_buffer *buffer = dmabuf->priv;
1047 ion_buffer_put(buffer);
1050 static void *ion_dma_buf_kmap(struct dma_buf *dmabuf, unsigned long offset)
1052 struct ion_buffer *buffer = dmabuf->priv;
1054 return buffer->vaddr + offset * PAGE_SIZE;
1057 static void ion_dma_buf_kunmap(struct dma_buf *dmabuf, unsigned long offset,
1062 static int ion_dma_buf_begin_cpu_access(struct dma_buf *dmabuf, size_t start,
1064 enum dma_data_direction direction)
1066 struct ion_buffer *buffer = dmabuf->priv;
1069 if (!buffer->heap->ops->map_kernel) {
1070 pr_err("%s: map kernel is not implemented by this heap.\n",
1075 mutex_lock(&buffer->lock);
1076 vaddr = ion_buffer_kmap_get(buffer);
1077 mutex_unlock(&buffer->lock);
1078 return PTR_ERR_OR_ZERO(vaddr);
1081 static void ion_dma_buf_end_cpu_access(struct dma_buf *dmabuf, size_t start,
1083 enum dma_data_direction direction)
1085 struct ion_buffer *buffer = dmabuf->priv;
1087 mutex_lock(&buffer->lock);
1088 ion_buffer_kmap_put(buffer);
1089 mutex_unlock(&buffer->lock);
1092 static struct dma_buf_ops dma_buf_ops = {
1093 .map_dma_buf = ion_map_dma_buf,
1094 .unmap_dma_buf = ion_unmap_dma_buf,
1096 .release = ion_dma_buf_release,
1097 .begin_cpu_access = ion_dma_buf_begin_cpu_access,
1098 .end_cpu_access = ion_dma_buf_end_cpu_access,
1099 .kmap_atomic = ion_dma_buf_kmap,
1100 .kunmap_atomic = ion_dma_buf_kunmap,
1101 .kmap = ion_dma_buf_kmap,
1102 .kunmap = ion_dma_buf_kunmap,
1105 struct dma_buf *ion_share_dma_buf(struct ion_client *client,
1106 struct ion_handle *handle)
1108 DEFINE_DMA_BUF_EXPORT_INFO(exp_info);
1109 struct ion_buffer *buffer;
1110 struct dma_buf *dmabuf;
1113 mutex_lock(&client->lock);
1114 valid_handle = ion_handle_validate(client, handle);
1115 if (!valid_handle) {
1116 WARN(1, "%s: invalid handle passed to share.\n", __func__);
1117 mutex_unlock(&client->lock);
1118 return ERR_PTR(-EINVAL);
1120 buffer = handle->buffer;
1121 ion_buffer_get(buffer);
1122 mutex_unlock(&client->lock);
1124 exp_info.ops = &dma_buf_ops;
1125 exp_info.size = buffer->size;
1126 exp_info.flags = O_RDWR;
1127 exp_info.priv = buffer;
1129 dmabuf = dma_buf_export(&exp_info);
1130 if (IS_ERR(dmabuf)) {
1131 ion_buffer_put(buffer);
1137 EXPORT_SYMBOL(ion_share_dma_buf);
1139 int ion_share_dma_buf_fd(struct ion_client *client, struct ion_handle *handle)
1141 struct dma_buf *dmabuf;
1144 dmabuf = ion_share_dma_buf(client, handle);
1146 return PTR_ERR(dmabuf);
1148 fd = dma_buf_fd(dmabuf, O_CLOEXEC);
1150 dma_buf_put(dmabuf);
1154 EXPORT_SYMBOL(ion_share_dma_buf_fd);
1156 struct ion_handle *ion_import_dma_buf(struct ion_client *client, int fd)
1158 struct dma_buf *dmabuf;
1159 struct ion_buffer *buffer;
1160 struct ion_handle *handle;
1163 dmabuf = dma_buf_get(fd);
1165 return ERR_CAST(dmabuf);
1166 /* if this memory came from ion */
1168 if (dmabuf->ops != &dma_buf_ops) {
1169 pr_err("%s: can not import dmabuf from another exporter\n",
1171 dma_buf_put(dmabuf);
1172 return ERR_PTR(-EINVAL);
1174 buffer = dmabuf->priv;
1176 mutex_lock(&client->lock);
1177 /* if a handle exists for this buffer just take a reference to it */
1178 handle = ion_handle_lookup(client, buffer);
1179 if (!IS_ERR(handle)) {
1180 ion_handle_get(handle);
1181 mutex_unlock(&client->lock);
1185 handle = ion_handle_create(client, buffer);
1186 if (IS_ERR(handle)) {
1187 mutex_unlock(&client->lock);
1191 ret = ion_handle_add(client, handle);
1192 mutex_unlock(&client->lock);
1194 ion_handle_put(handle);
1195 handle = ERR_PTR(ret);
1199 dma_buf_put(dmabuf);
1202 EXPORT_SYMBOL(ion_import_dma_buf);
1204 static int ion_sync_for_device(struct ion_client *client, int fd)
1206 struct dma_buf *dmabuf;
1207 struct ion_buffer *buffer;
1209 dmabuf = dma_buf_get(fd);
1211 return PTR_ERR(dmabuf);
1213 /* if this memory came from ion */
1214 if (dmabuf->ops != &dma_buf_ops) {
1215 pr_err("%s: can not sync dmabuf from another exporter\n",
1217 dma_buf_put(dmabuf);
1220 buffer = dmabuf->priv;
1222 dma_sync_sg_for_device(NULL, buffer->sg_table->sgl,
1223 buffer->sg_table->nents, DMA_BIDIRECTIONAL);
1224 dma_buf_put(dmabuf);
1228 /* fix up the cases where the ioctl direction bits are incorrect */
1229 static unsigned int ion_ioctl_dir(unsigned int cmd)
1234 case ION_IOC_CUSTOM:
1237 return _IOC_DIR(cmd);
1241 static long ion_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1243 struct ion_client *client = filp->private_data;
1244 struct ion_device *dev = client->dev;
1245 struct ion_handle *cleanup_handle = NULL;
1250 struct ion_fd_data fd;
1251 struct ion_allocation_data allocation;
1252 struct ion_handle_data handle;
1253 struct ion_custom_data custom;
1256 dir = ion_ioctl_dir(cmd);
1258 if (_IOC_SIZE(cmd) > sizeof(data))
1261 if (dir & _IOC_WRITE)
1262 if (copy_from_user(&data, (void __user *)arg, _IOC_SIZE(cmd)))
1268 struct ion_handle *handle;
1270 handle = ion_alloc(client, data.allocation.len,
1271 data.allocation.align,
1272 data.allocation.heap_id_mask,
1273 data.allocation.flags);
1275 return PTR_ERR(handle);
1277 data.allocation.handle = handle->id;
1279 cleanup_handle = handle;
1284 struct ion_handle *handle;
1286 handle = ion_handle_get_by_id(client, data.handle.handle);
1288 return PTR_ERR(handle);
1289 ion_free(client, handle);
1290 ion_handle_put(handle);
1296 struct ion_handle *handle;
1298 handle = ion_handle_get_by_id(client, data.handle.handle);
1300 return PTR_ERR(handle);
1301 data.fd.fd = ion_share_dma_buf_fd(client, handle);
1302 ion_handle_put(handle);
1307 case ION_IOC_IMPORT:
1309 struct ion_handle *handle;
1311 handle = ion_import_dma_buf(client, data.fd.fd);
1313 ret = PTR_ERR(handle);
1315 data.handle.handle = handle->id;
1320 ret = ion_sync_for_device(client, data.fd.fd);
1323 case ION_IOC_CUSTOM:
1325 if (!dev->custom_ioctl)
1327 ret = dev->custom_ioctl(client, data.custom.cmd,
1335 if (dir & _IOC_READ) {
1336 if (copy_to_user((void __user *)arg, &data, _IOC_SIZE(cmd))) {
1338 ion_free(client, cleanup_handle);
1345 static int ion_release(struct inode *inode, struct file *file)
1347 struct ion_client *client = file->private_data;
1349 pr_debug("%s: %d\n", __func__, __LINE__);
1350 ion_client_destroy(client);
1354 static int ion_open(struct inode *inode, struct file *file)
1356 struct miscdevice *miscdev = file->private_data;
1357 struct ion_device *dev = container_of(miscdev, struct ion_device, dev);
1358 struct ion_client *client;
1359 char debug_name[64];
1361 pr_debug("%s: %d\n", __func__, __LINE__);
1362 snprintf(debug_name, 64, "%u", task_pid_nr(current->group_leader));
1363 client = ion_client_create(dev, debug_name);
1365 return PTR_ERR(client);
1366 file->private_data = client;
1371 static const struct file_operations ion_fops = {
1372 .owner = THIS_MODULE,
1374 .release = ion_release,
1375 .unlocked_ioctl = ion_ioctl,
1376 .compat_ioctl = compat_ion_ioctl,
1379 static size_t ion_debug_heap_total(struct ion_client *client,
1385 mutex_lock(&client->lock);
1386 for (n = rb_first(&client->handles); n; n = rb_next(n)) {
1387 struct ion_handle *handle = rb_entry(n,
1390 if (handle->buffer->heap->id == id)
1391 size += handle->buffer->size;
1393 mutex_unlock(&client->lock);
1397 static int ion_debug_heap_show(struct seq_file *s, void *unused)
1399 struct ion_heap *heap = s->private;
1400 struct ion_device *dev = heap->dev;
1402 size_t total_size = 0;
1403 size_t total_orphaned_size = 0;
1405 seq_printf(s, "%16s %16s %16s\n", "client", "pid", "size");
1406 seq_puts(s, "----------------------------------------------------\n");
1408 for (n = rb_first(&dev->clients); n; n = rb_next(n)) {
1409 struct ion_client *client = rb_entry(n, struct ion_client,
1411 size_t size = ion_debug_heap_total(client, heap->id);
1416 char task_comm[TASK_COMM_LEN];
1418 get_task_comm(task_comm, client->task);
1419 seq_printf(s, "%16s %16u %16zu\n", task_comm,
1422 seq_printf(s, "%16s %16u %16zu\n", client->name,
1426 seq_puts(s, "----------------------------------------------------\n");
1427 seq_puts(s, "orphaned allocations (info is from last known client):\n");
1428 mutex_lock(&dev->buffer_lock);
1429 for (n = rb_first(&dev->buffers); n; n = rb_next(n)) {
1430 struct ion_buffer *buffer = rb_entry(n, struct ion_buffer,
1432 if (buffer->heap->id != heap->id)
1434 total_size += buffer->size;
1435 if (!buffer->handle_count) {
1436 seq_printf(s, "%16s %16u %16zu %d %d\n",
1437 buffer->task_comm, buffer->pid,
1438 buffer->size, buffer->kmap_cnt,
1439 atomic_read(&buffer->ref.refcount));
1440 total_orphaned_size += buffer->size;
1443 mutex_unlock(&dev->buffer_lock);
1444 seq_puts(s, "----------------------------------------------------\n");
1445 seq_printf(s, "%16s %16zu\n", "total orphaned",
1446 total_orphaned_size);
1447 seq_printf(s, "%16s %16zu\n", "total ", total_size);
1448 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
1449 seq_printf(s, "%16s %16zu\n", "deferred free",
1450 heap->free_list_size);
1451 seq_puts(s, "----------------------------------------------------\n");
1453 if (heap->debug_show)
1454 heap->debug_show(heap, s, unused);
1459 static int ion_debug_heap_open(struct inode *inode, struct file *file)
1461 return single_open(file, ion_debug_heap_show, inode->i_private);
1464 static const struct file_operations debug_heap_fops = {
1465 .open = ion_debug_heap_open,
1467 .llseek = seq_lseek,
1468 .release = single_release,
1471 static int debug_shrink_set(void *data, u64 val)
1473 struct ion_heap *heap = data;
1474 struct shrink_control sc;
1478 sc.nr_to_scan = val;
1481 objs = heap->shrinker.count_objects(&heap->shrinker, &sc);
1482 sc.nr_to_scan = objs;
1485 heap->shrinker.scan_objects(&heap->shrinker, &sc);
1489 static int debug_shrink_get(void *data, u64 *val)
1491 struct ion_heap *heap = data;
1492 struct shrink_control sc;
1498 objs = heap->shrinker.count_objects(&heap->shrinker, &sc);
1503 DEFINE_SIMPLE_ATTRIBUTE(debug_shrink_fops, debug_shrink_get,
1504 debug_shrink_set, "%llu\n");
1506 void ion_device_add_heap(struct ion_device *dev, struct ion_heap *heap)
1508 struct dentry *debug_file;
1510 if (!heap->ops->allocate || !heap->ops->free || !heap->ops->map_dma ||
1511 !heap->ops->unmap_dma)
1512 pr_err("%s: can not add heap with invalid ops struct.\n",
1515 spin_lock_init(&heap->free_lock);
1516 heap->free_list_size = 0;
1518 if (heap->flags & ION_HEAP_FLAG_DEFER_FREE)
1519 ion_heap_init_deferred_free(heap);
1521 if ((heap->flags & ION_HEAP_FLAG_DEFER_FREE) || heap->ops->shrink)
1522 ion_heap_init_shrinker(heap);
1525 down_write(&dev->lock);
1527 * use negative heap->id to reverse the priority -- when traversing
1528 * the list later attempt higher id numbers first
1530 plist_node_init(&heap->node, -heap->id);
1531 plist_add(&heap->node, &dev->heaps);
1532 debug_file = debugfs_create_file(heap->name, 0664,
1533 dev->heaps_debug_root, heap,
1537 char buf[256], *path;
1539 path = dentry_path(dev->heaps_debug_root, buf, 256);
1540 pr_err("Failed to create heap debugfs at %s/%s\n",
1544 if (heap->shrinker.count_objects && heap->shrinker.scan_objects) {
1545 char debug_name[64];
1547 snprintf(debug_name, 64, "%s_shrink", heap->name);
1548 debug_file = debugfs_create_file(
1549 debug_name, 0644, dev->heaps_debug_root, heap,
1550 &debug_shrink_fops);
1552 char buf[256], *path;
1554 path = dentry_path(dev->heaps_debug_root, buf, 256);
1555 pr_err("Failed to create heap shrinker debugfs at %s/%s\n",
1560 up_write(&dev->lock);
1562 EXPORT_SYMBOL(ion_device_add_heap);
1564 struct ion_device *ion_device_create(long (*custom_ioctl)
1565 (struct ion_client *client,
1569 struct ion_device *idev;
1572 idev = kzalloc(sizeof(struct ion_device), GFP_KERNEL);
1574 return ERR_PTR(-ENOMEM);
1576 idev->dev.minor = MISC_DYNAMIC_MINOR;
1577 idev->dev.name = "ion";
1578 idev->dev.fops = &ion_fops;
1579 idev->dev.parent = NULL;
1580 ret = misc_register(&idev->dev);
1582 pr_err("ion: failed to register misc device.\n");
1584 return ERR_PTR(ret);
1587 idev->debug_root = debugfs_create_dir("ion", NULL);
1588 if (!idev->debug_root) {
1589 pr_err("ion: failed to create debugfs root directory.\n");
1592 idev->heaps_debug_root = debugfs_create_dir("heaps", idev->debug_root);
1593 if (!idev->heaps_debug_root) {
1594 pr_err("ion: failed to create debugfs heaps directory.\n");
1597 idev->clients_debug_root = debugfs_create_dir("clients",
1599 if (!idev->clients_debug_root)
1600 pr_err("ion: failed to create debugfs clients directory.\n");
1604 idev->custom_ioctl = custom_ioctl;
1605 idev->buffers = RB_ROOT;
1606 mutex_init(&idev->buffer_lock);
1607 init_rwsem(&idev->lock);
1608 plist_head_init(&idev->heaps);
1609 idev->clients = RB_ROOT;
1612 EXPORT_SYMBOL(ion_device_create);
1614 void ion_device_destroy(struct ion_device *dev)
1616 misc_deregister(&dev->dev);
1617 debugfs_remove_recursive(dev->debug_root);
1618 /* XXX need to free the heaps and clients ? */
1621 EXPORT_SYMBOL(ion_device_destroy);
1623 void __init ion_reserve(struct ion_platform_data *data)
1627 for (i = 0; i < data->nr; i++) {
1628 if (data->heaps[i].size == 0)
1631 if (data->heaps[i].base == 0) {
1634 paddr = memblock_alloc_base(data->heaps[i].size,
1635 data->heaps[i].align,
1636 MEMBLOCK_ALLOC_ANYWHERE);
1638 pr_err("%s: error allocating memblock for heap %d\n",
1642 data->heaps[i].base = paddr;
1644 int ret = memblock_reserve(data->heaps[i].base,
1645 data->heaps[i].size);
1647 pr_err("memblock reserve of %zx@%lx failed\n",
1648 data->heaps[i].size,
1649 data->heaps[i].base);
1651 pr_info("%s: %s reserved base %lx size %zu\n", __func__,
1652 data->heaps[i].name,
1653 data->heaps[i].base,
1654 data->heaps[i].size);