2 * drivers/video/tegra/nvmap/nvmap_handle.c
4 * Handle allocation and freeing routines for nvmap
6 * Copyright (c) 2009-2014, NVIDIA CORPORATION. All rights reserved.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 #define pr_fmt(fmt) "%s: " fmt, __func__
25 #include <linux/err.h>
27 #include <linux/kernel.h>
28 #include <linux/list.h>
30 #include <linux/rbtree.h>
31 #include <linux/dma-buf.h>
32 #include <linux/moduleparam.h>
33 #include <linux/nvmap.h>
34 #include <linux/tegra-soc.h>
36 #include <asm/pgtable.h>
38 #include <trace/events/nvmap.h>
40 #include "nvmap_priv.h"
41 #include "nvmap_ioctl.h"
43 #ifdef CONFIG_NVMAP_FORCE_ZEROED_USER_PAGES
49 static int zero_memory_set(const char *arg, const struct kernel_param *kp)
51 #ifdef CONFIG_NVMAP_FORCE_ZEROED_USER_PAGES
54 param_set_bool(arg, kp);
55 #ifdef CONFIG_NVMAP_PAGE_POOLS
56 nvmap_page_pool_clear();
62 static struct kernel_param_ops zero_memory_ops = {
63 .get = param_get_bool,
64 .set = zero_memory_set,
67 module_param_cb(zero_memory, &zero_memory_ops, &zero_memory, 0644);
69 u32 nvmap_max_handle_count;
71 /* handles may be arbitrarily large (16+MiB), and any handle allocated from
72 * the kernel (i.e., not a carveout handle) includes its array of pages. to
73 * preserve kmalloc space, if the array of pages exceeds PAGELIST_VMALLOC_MIN,
74 * the array is allocated using vmalloc. */
75 #define PAGELIST_VMALLOC_MIN (PAGE_SIZE)
77 void *nvmap_altalloc(size_t len)
79 if (len > PAGELIST_VMALLOC_MIN)
82 return kmalloc(len, GFP_KERNEL);
85 void nvmap_altfree(void *ptr, size_t len)
90 if (len > PAGELIST_VMALLOC_MIN)
96 void _nvmap_handle_free(struct nvmap_handle *h)
98 unsigned int i, nr_page, page_index = 0;
99 struct nvmap_page_pool *pool;
102 h->nvhost_priv_delete(h->nvhost_priv);
104 if (nvmap_handle_remove(nvmap_dev, h) != 0)
110 nvmap_stats_inc(NS_RELEASE, h->size);
111 nvmap_stats_dec(NS_TOTAL, PAGE_ALIGN(h->orig_size));
112 if (!h->heap_pgalloc) {
113 nvmap_heap_free(h->carveout);
117 nr_page = DIV_ROUND_UP(h->size, PAGE_SIZE);
119 BUG_ON(h->size & ~PAGE_MASK);
120 BUG_ON(!h->pgalloc.pages);
122 #ifdef NVMAP_LAZY_VFREE
125 vm_unmap_ram(h->vaddr, h->size >> PAGE_SHIFT);
129 for (i = 0; i < nr_page; i++)
130 h->pgalloc.pages[i] = nvmap_to_page(h->pgalloc.pages[i]);
133 pool = &nvmap_dev->pool;
135 nvmap_page_pool_lock(pool);
136 page_index = __nvmap_page_pool_fill_lots_locked(pool,
137 h->pgalloc.pages, nr_page);
138 nvmap_page_pool_unlock(pool);
141 for (i = page_index; i < nr_page; i++)
142 __free_page(h->pgalloc.pages[i]);
144 nvmap_altfree(h->pgalloc.pages, nr_page * sizeof(struct page *));
150 static struct page *nvmap_alloc_pages_exact(gfp_t gfp, size_t size)
152 struct page *page, *p, *e;
155 size = PAGE_ALIGN(size);
156 order = get_order(size);
157 page = alloc_pages(gfp, order);
162 split_page(page, order);
163 e = page + (1 << order);
164 for (p = page + (size >> PAGE_SHIFT); p < e; p++)
170 static int handle_page_alloc(struct nvmap_client *client,
171 struct nvmap_handle *h, bool contiguous)
173 size_t size = PAGE_ALIGN(h->size);
174 unsigned int nr_page = size >> PAGE_SHIFT;
176 unsigned int i = 0, page_index = 0;
178 #ifdef CONFIG_NVMAP_PAGE_POOLS
179 struct nvmap_page_pool *pool = NULL;
181 gfp_t gfp = GFP_NVMAP;
186 pages = nvmap_altalloc(nr_page * sizeof(*pages));
190 prot = nvmap_pgprot(h, PG_PROT_KERNEL);
194 page = nvmap_alloc_pages_exact(gfp, size);
198 for (i = 0; i < nr_page; i++)
199 pages[i] = nth_page(page, i);
202 #ifdef CONFIG_NVMAP_PAGE_POOLS
203 pool = &nvmap_dev->pool;
206 * Get as many pages from the pools as possible.
208 nvmap_page_pool_lock(pool);
209 page_index = __nvmap_page_pool_alloc_lots_locked(pool, pages,
211 nvmap_page_pool_unlock(pool);
213 for (i = page_index; i < nr_page; i++) {
214 pages[i] = nvmap_alloc_pages_exact(gfp, PAGE_SIZE);
221 * Make sure any data in the caches is cleaned out before
222 * passing these pages to userspace. otherwise, It can lead to
223 * corruption in pages that get mapped as something other than WB in
224 * userspace and leaked kernel data structures.
226 * FIXME: For ARMv7 we don't have __clean_dcache_page() so we continue
227 * to use the flush cache version.
230 nvmap_clean_cache(pages, nr_page);
232 nvmap_flush_cache(pages, nr_page);
236 h->pgalloc.pages = pages;
237 h->pgalloc.contig = contiguous;
238 atomic_set(&h->pgalloc.ndirty, 0);
243 __free_page(pages[i]);
244 nvmap_altfree(pages, nr_page * sizeof(*pages));
249 static void alloc_handle(struct nvmap_client *client,
250 struct nvmap_handle *h, unsigned int type)
252 unsigned int carveout_mask = NVMAP_HEAP_CARVEOUT_MASK;
253 unsigned int iovmm_mask = NVMAP_HEAP_IOVMM;
255 BUG_ON(type & (type - 1));
257 #ifdef CONFIG_NVMAP_CONVERT_CARVEOUT_TO_IOVMM
258 /* Convert generic carveout requests to iovmm requests. */
259 carveout_mask &= ~NVMAP_HEAP_CARVEOUT_GENERIC;
260 iovmm_mask |= NVMAP_HEAP_CARVEOUT_GENERIC;
263 if (type & carveout_mask) {
264 struct nvmap_heap_block *b;
266 b = nvmap_carveout_alloc(client, h, type);
268 h->heap_pgalloc = false;
269 /* barrier to ensure all handle alloc data
270 * is visible before alloc is seen by other
275 nvmap_carveout_commit_add(client,
276 nvmap_heap_to_arg(nvmap_block_to_heap(b)),
279 } else if (type & iovmm_mask) {
282 ret = handle_page_alloc(client, h,
283 h->userflags & NVMAP_HANDLE_PHYS_CONTIG);
286 h->heap_pgalloc = true;
292 /* small allocations will try to allocate from generic OS memory before
293 * any of the limited heaps, to increase the effective memory for graphics
294 * allocations, and to reduce fragmentation of the graphics heaps with
295 * sub-page splinters */
296 static const unsigned int heap_policy_small[] = {
297 NVMAP_HEAP_CARVEOUT_VPR,
298 NVMAP_HEAP_CARVEOUT_IRAM,
299 NVMAP_HEAP_CARVEOUT_MASK,
304 static const unsigned int heap_policy_large[] = {
305 NVMAP_HEAP_CARVEOUT_VPR,
306 NVMAP_HEAP_CARVEOUT_IRAM,
308 NVMAP_HEAP_CARVEOUT_MASK,
312 int nvmap_alloc_handle(struct nvmap_client *client,
313 struct nvmap_handle *h, unsigned int heap_mask,
318 const unsigned int *alloc_policy;
322 h = nvmap_handle_get(h);
332 nvmap_stats_inc(NS_TOTAL, PAGE_ALIGN(h->orig_size));
333 nvmap_stats_inc(NS_ALLOC, PAGE_ALIGN(h->size));
334 trace_nvmap_alloc_handle(client, h,
335 h->size, heap_mask, align, flags,
336 nvmap_stats_read(NS_TOTAL),
337 nvmap_stats_read(NS_ALLOC));
338 h->userflags = flags;
339 nr_page = ((h->size + PAGE_SIZE - 1) >> PAGE_SHIFT);
340 h->flags = (flags & NVMAP_HANDLE_CACHE_FLAG);
341 h->align = max_t(size_t, align, L1_CACHE_BYTES);
344 /* convert iovmm requests to generic carveout. */
345 if (heap_mask & NVMAP_HEAP_IOVMM) {
346 heap_mask = (heap_mask & ~NVMAP_HEAP_IOVMM) |
347 NVMAP_HEAP_CARVEOUT_GENERIC;
355 alloc_policy = (nr_page == 1) ? heap_policy_small : heap_policy_large;
357 while (!h->alloc && *alloc_policy) {
358 unsigned int heap_type;
360 heap_type = *alloc_policy++;
361 heap_type &= heap_mask;
366 heap_mask &= ~heap_type;
368 while (heap_type && !h->alloc) {
371 /* iterate possible heaps MSB-to-LSB, since higher-
372 * priority carveouts will have higher usage masks */
373 heap = 1 << __fls(heap_type);
374 alloc_handle(client, h, heap);
381 if (client->kernel_client)
382 nvmap_stats_inc(NS_KALLOC, h->size);
384 nvmap_stats_inc(NS_UALLOC, h->size);
386 nvmap_stats_dec(NS_TOTAL, PAGE_ALIGN(h->orig_size));
387 nvmap_stats_dec(NS_ALLOC, PAGE_ALIGN(h->orig_size));
390 err = (h->alloc) ? 0 : err;
395 void nvmap_free_handle(struct nvmap_client *client,
396 struct nvmap_handle *handle)
398 struct nvmap_handle_ref *ref;
399 struct nvmap_handle *h;
402 nvmap_ref_lock(client);
404 ref = __nvmap_validate_locked(client, handle);
406 nvmap_ref_unlock(client);
410 trace_nvmap_free_handle(client, handle);
411 BUG_ON(!ref->handle);
414 if (atomic_dec_return(&ref->dupes)) {
415 nvmap_ref_unlock(client);
420 pins = atomic_read(&ref->pin);
421 rb_erase(&ref->node, &client->handle_refs);
422 client->handle_count--;
423 atomic_dec(&ref->handle->share_count);
425 if (h->alloc && !h->heap_pgalloc) {
426 mutex_lock(&h->lock);
427 nvmap_carveout_commit_subtract(client,
428 nvmap_heap_to_arg(nvmap_block_to_heap(h->carveout)),
430 mutex_unlock(&h->lock);
433 nvmap_ref_unlock(client);
436 pr_debug("%s freeing pinned handle %p\n",
437 current->group_leader->comm, h);
439 while (atomic_read(&ref->pin))
442 if (h->owner == client)
445 dma_buf_put(ref->handle->dmabuf);
449 BUG_ON(!atomic_read(&h->ref));
452 EXPORT_SYMBOL(nvmap_free_handle);
454 void nvmap_free_handle_user_id(struct nvmap_client *client,
455 unsigned long user_id)
457 nvmap_free_handle(client, nvmap_fd_to_handle(user_id));
460 static void add_handle_ref(struct nvmap_client *client,
461 struct nvmap_handle_ref *ref)
463 struct rb_node **p, *parent = NULL;
465 nvmap_ref_lock(client);
466 p = &client->handle_refs.rb_node;
468 struct nvmap_handle_ref *node;
470 node = rb_entry(parent, struct nvmap_handle_ref, node);
471 if (ref->handle > node->handle)
472 p = &parent->rb_right;
474 p = &parent->rb_left;
476 rb_link_node(&ref->node, parent, p);
477 rb_insert_color(&ref->node, &client->handle_refs);
478 client->handle_count++;
479 if (client->handle_count > nvmap_max_handle_count)
480 nvmap_max_handle_count = client->handle_count;
481 atomic_inc(&ref->handle->share_count);
482 nvmap_ref_unlock(client);
485 struct nvmap_handle_ref *nvmap_create_handle(struct nvmap_client *client,
488 void *err = ERR_PTR(-ENOMEM);
489 struct nvmap_handle *h;
490 struct nvmap_handle_ref *ref = NULL;
493 return ERR_PTR(-EINVAL);
496 return ERR_PTR(-EINVAL);
498 h = kzalloc(sizeof(*h), GFP_KERNEL);
500 return ERR_PTR(-ENOMEM);
502 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
506 atomic_set(&h->ref, 1);
507 atomic_set(&h->pin, 0);
510 h->size = h->orig_size = size;
511 h->flags = NVMAP_HANDLE_WRITE_COMBINE;
512 mutex_init(&h->lock);
513 INIT_LIST_HEAD(&h->vmas);
514 INIT_LIST_HEAD(&h->lru);
517 * This takes out 1 ref on the dambuf. This corresponds to the
518 * handle_ref that gets automatically made by nvmap_create_handle().
520 h->dmabuf = __nvmap_make_dmabuf(client, h);
521 if (IS_ERR(h->dmabuf)) {
523 goto make_dmabuf_fail;
527 * Pre-attach nvmap to this new dmabuf. This gets unattached during the
528 * dma_buf_release() operation.
530 h->attachment = dma_buf_attach(h->dmabuf, nvmap_dev->dev_user.parent);
531 if (IS_ERR(h->attachment)) {
533 goto dma_buf_attach_fail;
536 nvmap_handle_add(nvmap_dev, h);
539 * Major assumption here: the dma_buf object that the handle contains
540 * is created with a ref count of 1.
542 atomic_set(&ref->dupes, 1);
544 atomic_set(&ref->pin, 0);
545 add_handle_ref(client, ref);
546 trace_nvmap_create_handle(client, client->name, h, size, ref);
550 dma_buf_put(h->dmabuf);
558 struct nvmap_handle_ref *nvmap_duplicate_handle(struct nvmap_client *client,
559 struct nvmap_handle *h, bool skip_val)
561 struct nvmap_handle_ref *ref = NULL;
564 /* on success, the reference count for the handle should be
565 * incremented, so the success paths will not call nvmap_handle_put */
566 h = nvmap_validate_get(h);
569 pr_debug("%s duplicate handle failed\n",
570 current->group_leader->comm);
571 return ERR_PTR(-EPERM);
575 pr_err("%s duplicating unallocated handle\n",
576 current->group_leader->comm);
578 return ERR_PTR(-EINVAL);
581 nvmap_ref_lock(client);
582 ref = __nvmap_validate_locked(client, h);
585 /* handle already duplicated in client; just increment
586 * the reference count rather than re-duplicating it */
587 atomic_inc(&ref->dupes);
588 nvmap_ref_unlock(client);
592 nvmap_ref_unlock(client);
594 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
597 return ERR_PTR(-ENOMEM);
600 if (!h->heap_pgalloc) {
601 mutex_lock(&h->lock);
602 nvmap_carveout_commit_add(client,
603 nvmap_heap_to_arg(nvmap_block_to_heap(h->carveout)),
605 mutex_unlock(&h->lock);
608 atomic_set(&ref->dupes, 1);
610 atomic_set(&ref->pin, 0);
611 add_handle_ref(client, ref);
614 * Ref counting on the dma_bufs follows the creation and destruction of
615 * nvmap_handle_refs. That is every time a handle_ref is made the
616 * dma_buf ref count goes up and everytime a handle_ref is destroyed
617 * the dma_buf ref count goes down.
619 get_dma_buf(h->dmabuf);
621 trace_nvmap_duplicate_handle(client, h, ref);
625 struct nvmap_handle_ref *nvmap_create_handle_from_fd(
626 struct nvmap_client *client, int fd)
628 struct nvmap_handle *handle;
629 struct nvmap_handle_ref *ref;
633 handle = nvmap_get_id_from_dmabuf_fd(client, fd);
635 return ERR_CAST(handle);
636 ref = nvmap_duplicate_handle(client, handle, 1);
640 struct nvmap_handle *nvmap_duplicate_handle_id_ex(struct nvmap_client *client,
641 struct nvmap_handle *h)
643 struct nvmap_handle_ref *ref = nvmap_duplicate_handle(client, h, 0);
648 return __nvmap_ref_to_id(ref);
650 EXPORT_SYMBOL(nvmap_duplicate_handle_id_ex);
652 int nvmap_get_page_list_info(struct nvmap_client *client,
653 struct nvmap_handle *handle, u32 *size,
654 u32 *flags, u32 *nr_page, bool *contig)
656 struct nvmap_handle *h;
658 BUG_ON(!size || !flags || !nr_page || !contig);
665 h = nvmap_handle_get(handle);
668 pr_err("%s query invalid handle %p\n",
669 current->group_leader->comm, handle);
673 if (!h->alloc || !h->heap_pgalloc) {
674 pr_err("%s query unallocated handle %p\n",
675 current->group_leader->comm, handle);
681 *size = h->orig_size;
682 *nr_page = PAGE_ALIGN(h->size) >> PAGE_SHIFT;
683 *contig = h->pgalloc.contig;
688 EXPORT_SYMBOL(nvmap_get_page_list_info);
690 int nvmap_acquire_page_list(struct nvmap_client *client,
691 struct nvmap_handle *handle, struct page **pages,
694 struct nvmap_handle *h;
695 struct nvmap_handle_ref *ref;
701 h = nvmap_handle_get(handle);
704 pr_err("%s query invalid handle %p\n",
705 current->group_leader->comm, handle);
709 if (!h->alloc || !h->heap_pgalloc) {
710 pr_err("%s query unallocated handle %p\n",
711 current->group_leader->comm, handle);
716 BUG_ON(nr_page != PAGE_ALIGN(h->size) >> PAGE_SHIFT);
718 for (idx = 0; idx < nr_page; idx++)
719 pages[idx] = h->pgalloc.pages[idx];
721 nvmap_ref_lock(client);
722 ref = __nvmap_validate_locked(client, h);
724 __nvmap_pin(ref, &dummy);
725 nvmap_ref_unlock(client);
729 EXPORT_SYMBOL(nvmap_acquire_page_list);
731 int nvmap_release_page_list(struct nvmap_client *client,
732 struct nvmap_handle *handle)
734 struct nvmap_handle_ref *ref;
735 struct nvmap_handle *h = NULL;
739 nvmap_ref_lock(client);
741 ref = __nvmap_validate_locked(client, handle);
745 nvmap_ref_unlock(client);
754 EXPORT_SYMBOL(nvmap_release_page_list);
756 int __nvmap_get_handle_param(struct nvmap_client *client,
757 struct nvmap_handle *h, u32 param, u64 *result)
761 if (WARN_ON(!virt_addr_valid(h)))
765 case NVMAP_HANDLE_PARAM_SIZE:
766 *result = h->orig_size;
768 case NVMAP_HANDLE_PARAM_ALIGNMENT:
771 case NVMAP_HANDLE_PARAM_BASE:
772 if (!h->alloc || !atomic_read(&h->pin))
774 else if (!h->heap_pgalloc) {
775 mutex_lock(&h->lock);
776 *result = h->carveout->base;
777 mutex_unlock(&h->lock);
778 } else if (h->attachment->priv)
779 *result = sg_dma_address(
780 ((struct sg_table *)h->attachment->priv)->sgl);
784 case NVMAP_HANDLE_PARAM_HEAP:
787 else if (!h->heap_pgalloc) {
788 mutex_lock(&h->lock);
789 *result = nvmap_carveout_usage(client, h->carveout);
790 mutex_unlock(&h->lock);
792 *result = NVMAP_HEAP_IOVMM;
794 case NVMAP_HANDLE_PARAM_KIND:
797 case NVMAP_HANDLE_PARAM_COMPR:
798 /* ignored, to be removed */
807 int nvmap_get_handle_param(struct nvmap_client *client,
808 struct nvmap_handle_ref *ref, u32 param, u64 *result)
810 if (WARN_ON(!virt_addr_valid(ref)) ||
811 WARN_ON(!virt_addr_valid(client)) ||
815 return __nvmap_get_handle_param(client, ref->handle, param, result);