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;
91 h->nvhost_priv_delete(h->nvhost_priv);
93 if (nvmap_handle_remove(nvmap_dev, h) != 0)
99 nvmap_stats_inc(NS_RELEASE, h->size);
100 nvmap_stats_dec(NS_TOTAL, PAGE_ALIGN(h->orig_size));
101 if (!h->heap_pgalloc) {
102 nvmap_heap_free(h->carveout);
106 nr_page = DIV_ROUND_UP(h->size, PAGE_SIZE);
108 BUG_ON(h->size & ~PAGE_MASK);
109 BUG_ON(!h->pgalloc.pages);
111 #ifdef NVMAP_LAZY_VFREE
113 vm_unmap_ram(h->vaddr, h->size >> PAGE_SHIFT);
116 for (i = 0; i < nr_page; i++)
117 h->pgalloc.pages[i] = nvmap_to_page(h->pgalloc.pages[i]);
120 page_index = nvmap_page_pool_fill_lots(&nvmap_dev->pool,
121 h->pgalloc.pages, nr_page);
123 for (i = page_index; i < nr_page; i++)
124 __free_page(h->pgalloc.pages[i]);
126 nvmap_altfree(h->pgalloc.pages, nr_page * sizeof(struct page *));
132 static struct page *nvmap_alloc_pages_exact(gfp_t gfp, size_t size)
134 struct page *page, *p, *e;
137 size = PAGE_ALIGN(size);
138 order = get_order(size);
139 page = alloc_pages(gfp, order);
144 split_page(page, order);
145 e = page + (1 << order);
146 for (p = page + (size >> PAGE_SHIFT); p < e; p++)
152 static int handle_page_alloc(struct nvmap_client *client,
153 struct nvmap_handle *h, bool contiguous)
155 size_t size = PAGE_ALIGN(h->size);
156 unsigned int nr_page = size >> PAGE_SHIFT;
158 unsigned int i = 0, page_index = 0;
160 gfp_t gfp = GFP_NVMAP;
165 pages = nvmap_altalloc(nr_page * sizeof(*pages));
169 prot = nvmap_pgprot(h, PG_PROT_KERNEL);
173 page = nvmap_alloc_pages_exact(gfp, size);
177 for (i = 0; i < nr_page; i++)
178 pages[i] = nth_page(page, i);
181 #ifdef CONFIG_NVMAP_PAGE_POOLS
183 * Get as many pages from the pools as possible.
185 page_index = nvmap_page_pool_alloc_lots(&nvmap_dev->pool, pages,
188 for (i = page_index; i < nr_page; i++) {
189 pages[i] = nvmap_alloc_pages_exact(gfp, PAGE_SIZE);
196 * Make sure any data in the caches is cleaned out before
197 * passing these pages to userspace. otherwise, It can lead to
198 * corruption in pages that get mapped as something other than WB in
199 * userspace and leaked kernel data structures.
201 * FIXME: For ARMv7 we don't have __clean_dcache_page() so we continue
202 * to use the flush cache version.
205 nvmap_clean_cache(pages, nr_page);
207 nvmap_flush_cache(pages, nr_page);
211 h->pgalloc.pages = pages;
212 h->pgalloc.contig = contiguous;
213 atomic_set(&h->pgalloc.ndirty, 0);
218 __free_page(pages[i]);
219 nvmap_altfree(pages, nr_page * sizeof(*pages));
224 static void alloc_handle(struct nvmap_client *client,
225 struct nvmap_handle *h, unsigned int type)
227 unsigned int carveout_mask = NVMAP_HEAP_CARVEOUT_MASK;
228 unsigned int iovmm_mask = NVMAP_HEAP_IOVMM;
230 BUG_ON(type & (type - 1));
232 #ifdef CONFIG_NVMAP_CONVERT_CARVEOUT_TO_IOVMM
233 /* Convert generic carveout requests to iovmm requests. */
234 carveout_mask &= ~NVMAP_HEAP_CARVEOUT_GENERIC;
235 iovmm_mask |= NVMAP_HEAP_CARVEOUT_GENERIC;
238 if (type & carveout_mask) {
239 struct nvmap_heap_block *b;
241 b = nvmap_carveout_alloc(client, h, type);
244 h->heap_pgalloc = false;
245 /* barrier to ensure all handle alloc data
246 * is visible before alloc is seen by other
252 } else if (type & iovmm_mask) {
255 ret = handle_page_alloc(client, h,
256 h->userflags & NVMAP_HANDLE_PHYS_CONTIG);
259 h->heap_type = NVMAP_HEAP_IOVMM;
260 h->heap_pgalloc = true;
266 /* small allocations will try to allocate from generic OS memory before
267 * any of the limited heaps, to increase the effective memory for graphics
268 * allocations, and to reduce fragmentation of the graphics heaps with
269 * sub-page splinters */
270 static const unsigned int heap_policy_small[] = {
271 NVMAP_HEAP_CARVEOUT_VPR,
272 NVMAP_HEAP_CARVEOUT_IRAM,
273 NVMAP_HEAP_CARVEOUT_MASK,
278 static const unsigned int heap_policy_large[] = {
279 NVMAP_HEAP_CARVEOUT_VPR,
280 NVMAP_HEAP_CARVEOUT_IRAM,
282 NVMAP_HEAP_CARVEOUT_MASK,
286 int nvmap_alloc_handle(struct nvmap_client *client,
287 struct nvmap_handle *h, unsigned int heap_mask,
292 const unsigned int *alloc_policy;
296 h = nvmap_handle_get(h);
306 nvmap_stats_inc(NS_TOTAL, PAGE_ALIGN(h->orig_size));
307 nvmap_stats_inc(NS_ALLOC, PAGE_ALIGN(h->size));
308 trace_nvmap_alloc_handle(client, h,
309 h->size, heap_mask, align, flags,
310 nvmap_stats_read(NS_TOTAL),
311 nvmap_stats_read(NS_ALLOC));
312 h->userflags = flags;
313 nr_page = ((h->size + PAGE_SIZE - 1) >> PAGE_SHIFT);
314 h->flags = (flags & NVMAP_HANDLE_CACHE_FLAG);
315 h->align = max_t(size_t, align, L1_CACHE_BYTES);
318 /* convert iovmm requests to generic carveout. */
319 if (heap_mask & NVMAP_HEAP_IOVMM) {
320 heap_mask = (heap_mask & ~NVMAP_HEAP_IOVMM) |
321 NVMAP_HEAP_CARVEOUT_GENERIC;
329 alloc_policy = (nr_page == 1) ? heap_policy_small : heap_policy_large;
331 while (!h->alloc && *alloc_policy) {
332 unsigned int heap_type;
334 heap_type = *alloc_policy++;
335 heap_type &= heap_mask;
340 heap_mask &= ~heap_type;
342 while (heap_type && !h->alloc) {
345 /* iterate possible heaps MSB-to-LSB, since higher-
346 * priority carveouts will have higher usage masks */
347 heap = 1 << __fls(heap_type);
348 alloc_handle(client, h, heap);
355 if (client->kernel_client)
356 nvmap_stats_inc(NS_KALLOC, h->size);
358 nvmap_stats_inc(NS_UALLOC, h->size);
360 nvmap_stats_dec(NS_TOTAL, PAGE_ALIGN(h->orig_size));
361 nvmap_stats_dec(NS_ALLOC, PAGE_ALIGN(h->orig_size));
364 err = (h->alloc) ? 0 : err;
369 void nvmap_free_handle(struct nvmap_client *client,
370 struct nvmap_handle *handle)
372 struct nvmap_handle_ref *ref;
373 struct nvmap_handle *h;
376 nvmap_ref_lock(client);
378 ref = __nvmap_validate_locked(client, handle);
380 nvmap_ref_unlock(client);
384 trace_nvmap_free_handle(client, handle);
385 BUG_ON(!ref->handle);
388 if (atomic_dec_return(&ref->dupes)) {
389 nvmap_ref_unlock(client);
394 pins = atomic_read(&ref->pin);
395 rb_erase(&ref->node, &client->handle_refs);
396 client->handle_count--;
397 atomic_dec(&ref->handle->share_count);
399 nvmap_ref_unlock(client);
402 pr_debug("%s freeing pinned handle %p\n",
403 current->group_leader->comm, h);
405 while (atomic_read(&ref->pin))
408 if (h->owner == client)
411 dma_buf_put(ref->handle->dmabuf);
415 BUG_ON(!atomic_read(&h->ref));
418 EXPORT_SYMBOL(nvmap_free_handle);
420 void nvmap_free_handle_user_id(struct nvmap_client *client,
421 unsigned long user_id)
423 struct nvmap_handle *handle = unmarshal_user_handle(user_id);
425 nvmap_free_handle(client, handle);
426 nvmap_handle_put(handle);
430 static void add_handle_ref(struct nvmap_client *client,
431 struct nvmap_handle_ref *ref)
433 struct rb_node **p, *parent = NULL;
435 nvmap_ref_lock(client);
436 p = &client->handle_refs.rb_node;
438 struct nvmap_handle_ref *node;
440 node = rb_entry(parent, struct nvmap_handle_ref, node);
441 if (ref->handle > node->handle)
442 p = &parent->rb_right;
444 p = &parent->rb_left;
446 rb_link_node(&ref->node, parent, p);
447 rb_insert_color(&ref->node, &client->handle_refs);
448 client->handle_count++;
449 if (client->handle_count > nvmap_max_handle_count)
450 nvmap_max_handle_count = client->handle_count;
451 atomic_inc(&ref->handle->share_count);
452 nvmap_ref_unlock(client);
455 struct nvmap_handle_ref *nvmap_create_handle(struct nvmap_client *client,
458 void *err = ERR_PTR(-ENOMEM);
459 struct nvmap_handle *h;
460 struct nvmap_handle_ref *ref = NULL;
463 return ERR_PTR(-EINVAL);
466 return ERR_PTR(-EINVAL);
468 h = kzalloc(sizeof(*h), GFP_KERNEL);
470 return ERR_PTR(-ENOMEM);
472 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
476 atomic_set(&h->ref, 1);
477 atomic_set(&h->pin, 0);
480 h->size = h->orig_size = size;
481 h->flags = NVMAP_HANDLE_WRITE_COMBINE;
482 mutex_init(&h->lock);
483 INIT_LIST_HEAD(&h->vmas);
486 * This takes out 1 ref on the dambuf. This corresponds to the
487 * handle_ref that gets automatically made by nvmap_create_handle().
489 h->dmabuf = __nvmap_make_dmabuf(client, h);
490 if (IS_ERR(h->dmabuf)) {
492 goto make_dmabuf_fail;
496 * Pre-attach nvmap to this new dmabuf. This gets unattached during the
497 * dma_buf_release() operation.
499 h->attachment = dma_buf_attach(h->dmabuf, nvmap_dev->dev_user.parent);
500 if (IS_ERR(h->attachment)) {
502 goto dma_buf_attach_fail;
505 nvmap_handle_add(nvmap_dev, h);
508 * Major assumption here: the dma_buf object that the handle contains
509 * is created with a ref count of 1.
511 atomic_set(&ref->dupes, 1);
513 atomic_set(&ref->pin, 0);
514 add_handle_ref(client, ref);
515 trace_nvmap_create_handle(client, client->name, h, size, ref);
519 dma_buf_put(h->dmabuf);
527 struct nvmap_handle_ref *nvmap_duplicate_handle(struct nvmap_client *client,
528 struct nvmap_handle *h, bool skip_val)
530 struct nvmap_handle_ref *ref = NULL;
533 /* on success, the reference count for the handle should be
534 * incremented, so the success paths will not call nvmap_handle_put */
535 h = nvmap_validate_get(h);
538 pr_debug("%s duplicate handle failed\n",
539 current->group_leader->comm);
540 return ERR_PTR(-EPERM);
544 pr_err("%s duplicating unallocated handle\n",
545 current->group_leader->comm);
547 return ERR_PTR(-EINVAL);
550 nvmap_ref_lock(client);
551 ref = __nvmap_validate_locked(client, h);
554 /* handle already duplicated in client; just increment
555 * the reference count rather than re-duplicating it */
556 atomic_inc(&ref->dupes);
557 nvmap_ref_unlock(client);
561 nvmap_ref_unlock(client);
563 ref = kzalloc(sizeof(*ref), GFP_KERNEL);
566 return ERR_PTR(-ENOMEM);
569 atomic_set(&ref->dupes, 1);
571 atomic_set(&ref->pin, 0);
572 add_handle_ref(client, ref);
575 * Ref counting on the dma_bufs follows the creation and destruction of
576 * nvmap_handle_refs. That is every time a handle_ref is made the
577 * dma_buf ref count goes up and everytime a handle_ref is destroyed
578 * the dma_buf ref count goes down.
580 get_dma_buf(h->dmabuf);
582 trace_nvmap_duplicate_handle(client, h, ref);
586 struct nvmap_handle_ref *nvmap_create_handle_from_fd(
587 struct nvmap_client *client, int fd)
589 struct nvmap_handle *handle;
590 struct nvmap_handle_ref *ref;
594 handle = nvmap_get_id_from_dmabuf_fd(client, fd);
596 return ERR_CAST(handle);
597 ref = nvmap_duplicate_handle(client, handle, 1);
598 nvmap_handle_put(handle);
602 struct nvmap_handle *nvmap_duplicate_handle_id_ex(struct nvmap_client *client,
603 struct nvmap_handle *h)
605 struct nvmap_handle_ref *ref = nvmap_duplicate_handle(client, h, 0);
610 return __nvmap_ref_to_id(ref);
612 EXPORT_SYMBOL(nvmap_duplicate_handle_id_ex);
614 int nvmap_get_page_list_info(struct nvmap_client *client,
615 struct nvmap_handle *handle, u32 *size,
616 u32 *flags, u32 *nr_page, bool *contig)
618 struct nvmap_handle *h;
620 BUG_ON(!size || !flags || !nr_page || !contig);
627 h = nvmap_handle_get(handle);
630 pr_err("%s query invalid handle %p\n",
631 current->group_leader->comm, handle);
635 if (!h->alloc || !h->heap_pgalloc) {
636 pr_err("%s query unallocated handle %p\n",
637 current->group_leader->comm, handle);
643 *size = h->orig_size;
644 *nr_page = PAGE_ALIGN(h->size) >> PAGE_SHIFT;
645 *contig = h->pgalloc.contig;
650 EXPORT_SYMBOL(nvmap_get_page_list_info);
652 int nvmap_acquire_page_list(struct nvmap_client *client,
653 struct nvmap_handle *handle, struct page **pages,
656 struct nvmap_handle *h;
657 struct nvmap_handle_ref *ref;
663 h = nvmap_handle_get(handle);
666 pr_err("%s query invalid handle %p\n",
667 current->group_leader->comm, handle);
671 if (!h->alloc || !h->heap_pgalloc) {
672 pr_err("%s query unallocated handle %p\n",
673 current->group_leader->comm, handle);
678 BUG_ON(nr_page != PAGE_ALIGN(h->size) >> PAGE_SHIFT);
680 for (idx = 0; idx < nr_page; idx++)
681 pages[idx] = h->pgalloc.pages[idx];
683 nvmap_ref_lock(client);
684 ref = __nvmap_validate_locked(client, h);
686 __nvmap_pin(ref, &dummy);
687 nvmap_ref_unlock(client);
691 EXPORT_SYMBOL(nvmap_acquire_page_list);
693 int nvmap_release_page_list(struct nvmap_client *client,
694 struct nvmap_handle *handle)
696 struct nvmap_handle_ref *ref;
697 struct nvmap_handle *h = NULL;
701 nvmap_ref_lock(client);
703 ref = __nvmap_validate_locked(client, handle);
707 nvmap_ref_unlock(client);
716 EXPORT_SYMBOL(nvmap_release_page_list);
718 int __nvmap_get_handle_param(struct nvmap_client *client,
719 struct nvmap_handle *h, u32 param, u64 *result)
723 if (WARN_ON(!virt_addr_valid(h)))
727 case NVMAP_HANDLE_PARAM_SIZE:
728 *result = h->orig_size;
730 case NVMAP_HANDLE_PARAM_ALIGNMENT:
733 case NVMAP_HANDLE_PARAM_BASE:
734 if (!h->alloc || !atomic_read(&h->pin))
736 else if (!h->heap_pgalloc) {
737 mutex_lock(&h->lock);
738 *result = h->carveout->base;
739 mutex_unlock(&h->lock);
740 } else if (h->attachment->priv)
741 *result = sg_dma_address(
742 ((struct sg_table *)h->attachment->priv)->sgl);
746 case NVMAP_HANDLE_PARAM_HEAP:
749 else if (!h->heap_pgalloc) {
750 mutex_lock(&h->lock);
751 *result = nvmap_carveout_usage(client, h->carveout);
752 mutex_unlock(&h->lock);
754 *result = NVMAP_HEAP_IOVMM;
756 case NVMAP_HANDLE_PARAM_KIND:
759 case NVMAP_HANDLE_PARAM_COMPR:
760 /* ignored, to be removed */
769 int nvmap_get_handle_param(struct nvmap_client *client,
770 struct nvmap_handle_ref *ref, u32 param, u64 *result)
772 if (WARN_ON(!virt_addr_valid(ref)) ||
773 WARN_ON(!virt_addr_valid(client)) ||
777 return __nvmap_get_handle_param(client, ref->handle, param, result);