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"
45 static int zero_memory_set(const char *arg, const struct kernel_param *kp)
47 param_set_bool(arg, kp);
48 nvmap_page_pool_clear();
52 static struct kernel_param_ops zero_memory_ops = {
53 .get = param_get_bool,
54 .set = zero_memory_set,
57 module_param_cb(zero_memory, &zero_memory_ops, &zero_memory, 0644);
59 u32 nvmap_max_handle_count;
61 /* handles may be arbitrarily large (16+MiB), and any handle allocated from
62 * the kernel (i.e., not a carveout handle) includes its array of pages. to
63 * preserve kmalloc space, if the array of pages exceeds PAGELIST_VMALLOC_MIN,
64 * the array is allocated using vmalloc. */
65 #define PAGELIST_VMALLOC_MIN (PAGE_SIZE)
67 void *nvmap_altalloc(size_t len)
69 if (len > PAGELIST_VMALLOC_MIN)
72 return kmalloc(len, GFP_KERNEL);
75 void nvmap_altfree(void *ptr, size_t len)
80 if (len > PAGELIST_VMALLOC_MIN)
86 void _nvmap_handle_free(struct nvmap_handle *h)
88 unsigned int i, nr_page, page_index = 0;
89 #if defined(CONFIG_NVMAP_PAGE_POOLS) && \
90 !defined(CONFIG_NVMAP_FORCE_ZEROED_USER_PAGES)
91 struct nvmap_page_pool *pool;
95 h->nvhost_priv_delete(h->nvhost_priv);
97 if (nvmap_handle_remove(nvmap_dev, h) != 0)
103 nvmap_stats_inc(NS_RELEASE, h->size);
104 nvmap_stats_dec(NS_TOTAL, PAGE_ALIGN(h->orig_size));
105 if (!h->heap_pgalloc) {
106 nvmap_heap_free(h->carveout);
110 nr_page = DIV_ROUND_UP(h->size, PAGE_SIZE);
112 BUG_ON(h->size & ~PAGE_MASK);
113 BUG_ON(!h->pgalloc.pages);
115 #ifdef NVMAP_LAZY_VFREE
117 vm_unmap_ram(h->vaddr, h->size >> PAGE_SHIFT);
120 for (i = 0; i < nr_page; i++)
121 h->pgalloc.pages[i] = nvmap_to_page(h->pgalloc.pages[i]);
123 #if defined(CONFIG_NVMAP_PAGE_POOLS) && \
124 !defined(CONFIG_NVMAP_FORCE_ZEROED_USER_PAGES)
126 pool = &nvmap_dev->pool;
128 nvmap_page_pool_lock(pool);
129 page_index = __nvmap_page_pool_fill_lots_locked(pool,
130 h->pgalloc.pages, nr_page);
131 nvmap_page_pool_unlock(pool);
135 for (i = page_index; i < nr_page; i++)
136 __free_page(h->pgalloc.pages[i]);
138 nvmap_altfree(h->pgalloc.pages, nr_page * sizeof(struct page *));
144 static struct page *nvmap_alloc_pages_exact(gfp_t gfp, size_t size)
146 struct page *page, *p, *e;
149 size = PAGE_ALIGN(size);
150 order = get_order(size);
151 page = alloc_pages(gfp, order);
156 split_page(page, order);
157 e = page + (1 << order);
158 for (p = page + (size >> PAGE_SHIFT); p < e; p++)
164 static int handle_page_alloc(struct nvmap_client *client,
165 struct nvmap_handle *h, bool contiguous)
167 size_t size = PAGE_ALIGN(h->size);
168 unsigned int nr_page = size >> PAGE_SHIFT;
170 unsigned int i = 0, page_index = 0;
172 #ifdef CONFIG_NVMAP_PAGE_POOLS
173 struct nvmap_page_pool *pool = NULL;
175 gfp_t gfp = GFP_NVMAP;
180 pages = nvmap_altalloc(nr_page * sizeof(*pages));
184 prot = nvmap_pgprot(h, PG_PROT_KERNEL);
188 page = nvmap_alloc_pages_exact(gfp, size);
192 for (i = 0; i < nr_page; i++)
193 pages[i] = nth_page(page, i);
196 #ifdef CONFIG_NVMAP_PAGE_POOLS
197 pool = &nvmap_dev->pool;
200 * Get as many pages from the pools as possible.
202 nvmap_page_pool_lock(pool);
203 page_index = __nvmap_page_pool_alloc_lots_locked(pool, pages,
205 nvmap_page_pool_unlock(pool);
207 for (i = page_index; i < nr_page; i++) {
208 pages[i] = nvmap_alloc_pages_exact(gfp, PAGE_SIZE);
215 * Make sure any data in the caches is cleaned out before
216 * passing these pages to userspace. otherwise, It can lead to
217 * corruption in pages that get mapped as something other than WB in
218 * userspace and leaked kernel data structures.
220 * FIXME: For ARMv7 we don't have __clean_dcache_page() so we continue
221 * to use the flush cache version.
223 if (page_index < nr_page)
225 nvmap_clean_cache(&pages[page_index], nr_page - page_index);
227 nvmap_flush_cache(&pages[page_index], nr_page - page_index);
231 h->pgalloc.pages = pages;
232 h->pgalloc.contig = contiguous;
233 atomic_set(&h->pgalloc.ndirty, 0);
238 __free_page(pages[i]);
239 nvmap_altfree(pages, nr_page * sizeof(*pages));
244 static void alloc_handle(struct nvmap_client *client,
245 struct nvmap_handle *h, unsigned int type)
247 unsigned int carveout_mask = NVMAP_HEAP_CARVEOUT_MASK;
248 unsigned int iovmm_mask = NVMAP_HEAP_IOVMM;
250 BUG_ON(type & (type - 1));
252 #ifdef CONFIG_NVMAP_CONVERT_CARVEOUT_TO_IOVMM
253 /* Convert generic carveout requests to iovmm requests. */
254 carveout_mask &= ~NVMAP_HEAP_CARVEOUT_GENERIC;
255 iovmm_mask |= NVMAP_HEAP_CARVEOUT_GENERIC;
258 if (type & carveout_mask) {
259 struct nvmap_heap_block *b;
261 b = nvmap_carveout_alloc(client, h, type);
264 h->heap_pgalloc = false;
265 /* barrier to ensure all handle alloc data
266 * is visible before alloc is seen by other
272 } else if (type & iovmm_mask) {
275 ret = handle_page_alloc(client, h,
276 h->userflags & NVMAP_HANDLE_PHYS_CONTIG);
279 h->heap_type = NVMAP_HEAP_IOVMM;
280 h->heap_pgalloc = true;
286 /* small allocations will try to allocate from generic OS memory before
287 * any of the limited heaps, to increase the effective memory for graphics
288 * allocations, and to reduce fragmentation of the graphics heaps with
289 * sub-page splinters */
290 static const unsigned int heap_policy_small[] = {
291 NVMAP_HEAP_CARVEOUT_VPR,
292 NVMAP_HEAP_CARVEOUT_IRAM,
293 NVMAP_HEAP_CARVEOUT_MASK,
298 static const unsigned int heap_policy_large[] = {
299 NVMAP_HEAP_CARVEOUT_VPR,
300 NVMAP_HEAP_CARVEOUT_IRAM,
302 NVMAP_HEAP_CARVEOUT_MASK,
306 int nvmap_alloc_handle(struct nvmap_client *client,
307 struct nvmap_handle *h, unsigned int heap_mask,
312 const unsigned int *alloc_policy;
316 h = nvmap_handle_get(h);
326 nvmap_stats_inc(NS_TOTAL, PAGE_ALIGN(h->orig_size));
327 nvmap_stats_inc(NS_ALLOC, PAGE_ALIGN(h->size));
328 trace_nvmap_alloc_handle(client, h,
329 h->size, heap_mask, align, flags,
330 nvmap_stats_read(NS_TOTAL),
331 nvmap_stats_read(NS_ALLOC));
332 h->userflags = flags;
333 nr_page = ((h->size + PAGE_SIZE - 1) >> PAGE_SHIFT);
334 h->flags = (flags & NVMAP_HANDLE_CACHE_FLAG);
335 h->align = max_t(size_t, align, L1_CACHE_BYTES);
338 /* convert iovmm requests to generic carveout. */
339 if (heap_mask & NVMAP_HEAP_IOVMM) {
340 heap_mask = (heap_mask & ~NVMAP_HEAP_IOVMM) |
341 NVMAP_HEAP_CARVEOUT_GENERIC;
349 alloc_policy = (nr_page == 1) ? heap_policy_small : heap_policy_large;
351 while (!h->alloc && *alloc_policy) {
352 unsigned int heap_type;
354 heap_type = *alloc_policy++;
355 heap_type &= heap_mask;
360 heap_mask &= ~heap_type;
362 while (heap_type && !h->alloc) {
365 /* iterate possible heaps MSB-to-LSB, since higher-
366 * priority carveouts will have higher usage masks */
367 heap = 1 << __fls(heap_type);
368 alloc_handle(client, h, heap);
375 if (client->kernel_client)
376 nvmap_stats_inc(NS_KALLOC, h->size);
378 nvmap_stats_inc(NS_UALLOC, h->size);
380 nvmap_stats_dec(NS_TOTAL, PAGE_ALIGN(h->orig_size));
381 nvmap_stats_dec(NS_ALLOC, PAGE_ALIGN(h->orig_size));
384 err = (h->alloc) ? 0 : err;
389 void nvmap_free_handle(struct nvmap_client *client,
390 struct nvmap_handle *handle)
392 struct nvmap_handle_ref *ref;
393 struct nvmap_handle *h;
396 nvmap_ref_lock(client);
398 ref = __nvmap_validate_locked(client, handle);
400 nvmap_ref_unlock(client);
404 trace_nvmap_free_handle(client, handle);
405 BUG_ON(!ref->handle);
408 if (atomic_dec_return(&ref->dupes)) {
409 nvmap_ref_unlock(client);
414 pins = atomic_read(&ref->pin);
415 rb_erase(&ref->node, &client->handle_refs);
416 client->handle_count--;
417 atomic_dec(&ref->handle->share_count);
419 nvmap_ref_unlock(client);
422 pr_debug("%s freeing pinned handle %p\n",
423 current->group_leader->comm, h);
425 while (atomic_read(&ref->pin))
428 if (h->owner == client)
431 dma_buf_put(ref->handle->dmabuf);
435 BUG_ON(!atomic_read(&h->ref));
438 EXPORT_SYMBOL(nvmap_free_handle);
440 void nvmap_free_handle_user_id(struct nvmap_client *client,
441 unsigned long user_id)
443 nvmap_free_handle(client, unmarshal_user_id(user_id));
446 static void add_handle_ref(struct nvmap_client *client,
447 struct nvmap_handle_ref *ref)
449 struct rb_node **p, *parent = NULL;
451 nvmap_ref_lock(client);
452 p = &client->handle_refs.rb_node;
454 struct nvmap_handle_ref *node;
456 node = rb_entry(parent, struct nvmap_handle_ref, node);
457 if (ref->handle > node->handle)
458 p = &parent->rb_right;
460 p = &parent->rb_left;
462 rb_link_node(&ref->node, parent, p);
463 rb_insert_color(&ref->node, &client->handle_refs);
464 client->handle_count++;
465 if (client->handle_count > nvmap_max_handle_count)
466 nvmap_max_handle_count = client->handle_count;
467 atomic_inc(&ref->handle->share_count);
468 nvmap_ref_unlock(client);
471 struct nvmap_handle_ref *nvmap_create_handle(struct nvmap_client *client,
474 void *err = ERR_PTR(-ENOMEM);
475 struct nvmap_handle *h;
476 struct nvmap_handle_ref *ref = NULL;
479 return ERR_PTR(-EINVAL);
482 return ERR_PTR(-EINVAL);
484 h = kzalloc(sizeof(*h), GFP_KERNEL);
486 return ERR_PTR(-ENOMEM);
488 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
492 atomic_set(&h->ref, 1);
493 atomic_set(&h->pin, 0);
496 h->size = h->orig_size = size;
497 h->flags = NVMAP_HANDLE_WRITE_COMBINE;
498 mutex_init(&h->lock);
499 INIT_LIST_HEAD(&h->vmas);
502 * This takes out 1 ref on the dambuf. This corresponds to the
503 * handle_ref that gets automatically made by nvmap_create_handle().
505 h->dmabuf = __nvmap_make_dmabuf(client, h);
506 if (IS_ERR(h->dmabuf)) {
508 goto make_dmabuf_fail;
512 * Pre-attach nvmap to this new dmabuf. This gets unattached during the
513 * dma_buf_release() operation.
515 h->attachment = dma_buf_attach(h->dmabuf, nvmap_dev->dev_user.parent);
516 if (IS_ERR(h->attachment)) {
518 goto dma_buf_attach_fail;
521 nvmap_handle_add(nvmap_dev, h);
524 * Major assumption here: the dma_buf object that the handle contains
525 * is created with a ref count of 1.
527 atomic_set(&ref->dupes, 1);
529 atomic_set(&ref->pin, 0);
530 add_handle_ref(client, ref);
531 trace_nvmap_create_handle(client, client->name, h, size, ref);
535 dma_buf_put(h->dmabuf);
543 struct nvmap_handle_ref *nvmap_duplicate_handle(struct nvmap_client *client,
544 struct nvmap_handle *h, bool skip_val)
546 struct nvmap_handle_ref *ref = NULL;
549 /* on success, the reference count for the handle should be
550 * incremented, so the success paths will not call nvmap_handle_put */
551 h = nvmap_validate_get(h);
554 pr_debug("%s duplicate handle failed\n",
555 current->group_leader->comm);
556 return ERR_PTR(-EPERM);
560 pr_err("%s duplicating unallocated handle\n",
561 current->group_leader->comm);
563 return ERR_PTR(-EINVAL);
566 nvmap_ref_lock(client);
567 ref = __nvmap_validate_locked(client, h);
570 /* handle already duplicated in client; just increment
571 * the reference count rather than re-duplicating it */
572 atomic_inc(&ref->dupes);
573 nvmap_ref_unlock(client);
577 nvmap_ref_unlock(client);
579 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
582 return ERR_PTR(-ENOMEM);
585 atomic_set(&ref->dupes, 1);
587 atomic_set(&ref->pin, 0);
588 add_handle_ref(client, ref);
591 * Ref counting on the dma_bufs follows the creation and destruction of
592 * nvmap_handle_refs. That is every time a handle_ref is made the
593 * dma_buf ref count goes up and everytime a handle_ref is destroyed
594 * the dma_buf ref count goes down.
596 get_dma_buf(h->dmabuf);
598 trace_nvmap_duplicate_handle(client, h, ref);
602 struct nvmap_handle_ref *nvmap_create_handle_from_fd(
603 struct nvmap_client *client, int fd)
605 struct nvmap_handle *handle;
606 struct nvmap_handle_ref *ref;
610 handle = nvmap_get_id_from_dmabuf_fd(client, fd);
612 return ERR_CAST(handle);
613 ref = nvmap_duplicate_handle(client, handle, 1);
617 struct nvmap_handle *nvmap_duplicate_handle_id_ex(struct nvmap_client *client,
618 struct nvmap_handle *h)
620 struct nvmap_handle_ref *ref = nvmap_duplicate_handle(client, h, 0);
625 return __nvmap_ref_to_id(ref);
627 EXPORT_SYMBOL(nvmap_duplicate_handle_id_ex);
629 int nvmap_get_page_list_info(struct nvmap_client *client,
630 struct nvmap_handle *handle, u32 *size,
631 u32 *flags, u32 *nr_page, bool *contig)
633 struct nvmap_handle *h;
635 BUG_ON(!size || !flags || !nr_page || !contig);
642 h = nvmap_handle_get(handle);
645 pr_err("%s query invalid handle %p\n",
646 current->group_leader->comm, handle);
650 if (!h->alloc || !h->heap_pgalloc) {
651 pr_err("%s query unallocated handle %p\n",
652 current->group_leader->comm, handle);
658 *size = h->orig_size;
659 *nr_page = PAGE_ALIGN(h->size) >> PAGE_SHIFT;
660 *contig = h->pgalloc.contig;
665 EXPORT_SYMBOL(nvmap_get_page_list_info);
667 int nvmap_acquire_page_list(struct nvmap_client *client,
668 struct nvmap_handle *handle, struct page **pages,
671 struct nvmap_handle *h;
672 struct nvmap_handle_ref *ref;
678 h = nvmap_handle_get(handle);
681 pr_err("%s query invalid handle %p\n",
682 current->group_leader->comm, handle);
686 if (!h->alloc || !h->heap_pgalloc) {
687 pr_err("%s query unallocated handle %p\n",
688 current->group_leader->comm, handle);
693 BUG_ON(nr_page != PAGE_ALIGN(h->size) >> PAGE_SHIFT);
695 for (idx = 0; idx < nr_page; idx++)
696 pages[idx] = h->pgalloc.pages[idx];
698 nvmap_ref_lock(client);
699 ref = __nvmap_validate_locked(client, h);
701 __nvmap_pin(ref, &dummy);
702 nvmap_ref_unlock(client);
706 EXPORT_SYMBOL(nvmap_acquire_page_list);
708 int nvmap_release_page_list(struct nvmap_client *client,
709 struct nvmap_handle *handle)
711 struct nvmap_handle_ref *ref;
712 struct nvmap_handle *h = NULL;
716 nvmap_ref_lock(client);
718 ref = __nvmap_validate_locked(client, handle);
722 nvmap_ref_unlock(client);
731 EXPORT_SYMBOL(nvmap_release_page_list);
733 int __nvmap_get_handle_param(struct nvmap_client *client,
734 struct nvmap_handle *h, u32 param, u64 *result)
738 if (WARN_ON(!virt_addr_valid(h)))
742 case NVMAP_HANDLE_PARAM_SIZE:
743 *result = h->orig_size;
745 case NVMAP_HANDLE_PARAM_ALIGNMENT:
748 case NVMAP_HANDLE_PARAM_BASE:
749 if (!h->alloc || !atomic_read(&h->pin))
751 else if (!h->heap_pgalloc) {
752 mutex_lock(&h->lock);
753 *result = h->carveout->base;
754 mutex_unlock(&h->lock);
755 } else if (h->attachment->priv)
756 *result = sg_dma_address(
757 ((struct sg_table *)h->attachment->priv)->sgl);
761 case NVMAP_HANDLE_PARAM_HEAP:
764 else if (!h->heap_pgalloc) {
765 mutex_lock(&h->lock);
766 *result = nvmap_carveout_usage(client, h->carveout);
767 mutex_unlock(&h->lock);
769 *result = NVMAP_HEAP_IOVMM;
771 case NVMAP_HANDLE_PARAM_KIND:
774 case NVMAP_HANDLE_PARAM_COMPR:
775 /* ignored, to be removed */
784 int nvmap_get_handle_param(struct nvmap_client *client,
785 struct nvmap_handle_ref *ref, u32 param, u64 *result)
787 if (WARN_ON(!virt_addr_valid(ref)) ||
788 WARN_ON(!virt_addr_valid(client)) ||
792 return __nvmap_get_handle_param(client, ref->handle, param, result);