1 /**************************************************************************
3 * Copyright (c) 2009-2013 VMware, Inc., Palo Alto, CA., USA
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24 * USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
30 * While no substantial code is shared, the prime code is inspired by
33 * Dave Airlie <airlied@redhat.com>
34 * Rob Clark <rob.clark@linaro.org>
36 /** @file ttm_ref_object.c
38 * Base- and reference object implementation for the various
39 * ttm objects. Implements reference counting, minimal security checks
40 * and release on file close.
45 * struct ttm_object_file
47 * @tdev: Pointer to the ttm_object_device.
49 * @lock: Lock that protects the ref_list list and the
50 * ref_hash hash tables.
52 * @ref_list: List of ttm_ref_objects to be destroyed at
55 * @ref_hash: Hash tables of ref objects, one per ttm_ref_type,
56 * for fast lookup of ref objects given a base object.
59 #define pr_fmt(fmt) "[TTM] " fmt
61 #include <drm/ttm/ttm_object.h>
62 #include <drm/ttm/ttm_module.h>
63 #include <linux/list.h>
64 #include <linux/spinlock.h>
65 #include <linux/slab.h>
66 #include <linux/module.h>
67 #include <linux/atomic.h>
69 struct ttm_object_file
{
70 struct ttm_object_device
*tdev
;
72 struct list_head ref_list
;
73 struct drm_open_hash ref_hash
[TTM_REF_NUM
];
78 * struct ttm_object_device
80 * @object_lock: lock that protects the object_hash hash table.
82 * @object_hash: hash table for fast lookup of object global names.
84 * @object_count: Per device object count.
86 * This is the per-device data structure needed for ttm object management.
89 struct ttm_object_device
{
90 spinlock_t object_lock
;
91 struct drm_open_hash object_hash
;
92 atomic_t object_count
;
93 struct ttm_mem_global
*mem_glob
;
94 struct dma_buf_ops ops
;
95 void (*dmabuf_release
)(struct dma_buf
*dma_buf
);
100 * struct ttm_ref_object
102 * @hash: Hash entry for the per-file object reference hash.
104 * @head: List entry for the per-file list of ref-objects.
108 * @obj: Base object this ref object is referencing.
110 * @ref_type: Type of ref object.
112 * This is similar to an idr object, but it also has a hash table entry
113 * that allows lookup with a pointer to the referenced object as a key. In
114 * that way, one can easily detect whether a base object is referenced by
115 * a particular ttm_object_file. It also carries a ref count to avoid creating
116 * multiple ref objects if a ttm_object_file references the same base
117 * object more than once.
120 struct ttm_ref_object
{
121 struct rcu_head rcu_head
;
122 struct drm_hash_item hash
;
123 struct list_head head
;
125 enum ttm_ref_type ref_type
;
126 struct ttm_base_object
*obj
;
127 struct ttm_object_file
*tfile
;
130 static void ttm_prime_dmabuf_release(struct dma_buf
*dma_buf
);
132 static inline struct ttm_object_file
*
133 ttm_object_file_ref(struct ttm_object_file
*tfile
)
135 kref_get(&tfile
->refcount
);
139 static void ttm_object_file_destroy(struct kref
*kref
)
141 struct ttm_object_file
*tfile
=
142 container_of(kref
, struct ttm_object_file
, refcount
);
148 static inline void ttm_object_file_unref(struct ttm_object_file
**p_tfile
)
150 struct ttm_object_file
*tfile
= *p_tfile
;
153 kref_put(&tfile
->refcount
, ttm_object_file_destroy
);
157 int ttm_base_object_init(struct ttm_object_file
*tfile
,
158 struct ttm_base_object
*base
,
160 enum ttm_object_type object_type
,
161 void (*refcount_release
) (struct ttm_base_object
**),
162 void (*ref_obj_release
) (struct ttm_base_object
*,
163 enum ttm_ref_type ref_type
))
165 struct ttm_object_device
*tdev
= tfile
->tdev
;
168 base
->shareable
= shareable
;
169 base
->tfile
= ttm_object_file_ref(tfile
);
170 base
->refcount_release
= refcount_release
;
171 base
->ref_obj_release
= ref_obj_release
;
172 base
->object_type
= object_type
;
173 kref_init(&base
->refcount
);
174 spin_lock(&tdev
->object_lock
);
175 ret
= drm_ht_just_insert_please_rcu(&tdev
->object_hash
,
177 (unsigned long)base
, 31, 0, 0);
178 spin_unlock(&tdev
->object_lock
);
179 if (unlikely(ret
!= 0))
182 ret
= ttm_ref_object_add(tfile
, base
, TTM_REF_USAGE
, NULL
, false);
183 if (unlikely(ret
!= 0))
186 ttm_base_object_unref(&base
);
190 spin_lock(&tdev
->object_lock
);
191 (void)drm_ht_remove_item_rcu(&tdev
->object_hash
, &base
->hash
);
192 spin_unlock(&tdev
->object_lock
);
196 EXPORT_SYMBOL(ttm_base_object_init
);
198 static void ttm_release_base(struct kref
*kref
)
200 struct ttm_base_object
*base
=
201 container_of(kref
, struct ttm_base_object
, refcount
);
202 struct ttm_object_device
*tdev
= base
->tfile
->tdev
;
204 spin_lock(&tdev
->object_lock
);
205 (void)drm_ht_remove_item_rcu(&tdev
->object_hash
, &base
->hash
);
206 spin_unlock(&tdev
->object_lock
);
209 * Note: We don't use synchronize_rcu() here because it's far
210 * too slow. It's up to the user to free the object using
211 * call_rcu() or ttm_base_object_kfree().
214 ttm_object_file_unref(&base
->tfile
);
215 if (base
->refcount_release
)
216 base
->refcount_release(&base
);
219 void ttm_base_object_unref(struct ttm_base_object
**p_base
)
221 struct ttm_base_object
*base
= *p_base
;
225 kref_put(&base
->refcount
, ttm_release_base
);
227 EXPORT_SYMBOL(ttm_base_object_unref
);
229 struct ttm_base_object
*ttm_base_object_lookup(struct ttm_object_file
*tfile
,
232 struct ttm_base_object
*base
= NULL
;
233 struct drm_hash_item
*hash
;
234 struct drm_open_hash
*ht
= &tfile
->ref_hash
[TTM_REF_USAGE
];
238 ret
= drm_ht_find_item_rcu(ht
, key
, &hash
);
240 if (likely(ret
== 0)) {
241 base
= drm_hash_entry(hash
, struct ttm_ref_object
, hash
)->obj
;
242 if (!kref_get_unless_zero(&base
->refcount
))
249 EXPORT_SYMBOL(ttm_base_object_lookup
);
251 struct ttm_base_object
*
252 ttm_base_object_lookup_for_ref(struct ttm_object_device
*tdev
, uint32_t key
)
254 struct ttm_base_object
*base
= NULL
;
255 struct drm_hash_item
*hash
;
256 struct drm_open_hash
*ht
= &tdev
->object_hash
;
260 ret
= drm_ht_find_item_rcu(ht
, key
, &hash
);
262 if (likely(ret
== 0)) {
263 base
= drm_hash_entry(hash
, struct ttm_base_object
, hash
);
264 if (!kref_get_unless_zero(&base
->refcount
))
271 EXPORT_SYMBOL(ttm_base_object_lookup_for_ref
);
274 * ttm_ref_object_exists - Check whether a caller has a valid ref object
275 * (has opened) a base object.
277 * @tfile: Pointer to a struct ttm_object_file identifying the caller.
278 * @base: Pointer to a struct base object.
280 * Checks wether the caller identified by @tfile has put a valid USAGE
281 * reference object on the base object identified by @base.
283 bool ttm_ref_object_exists(struct ttm_object_file
*tfile
,
284 struct ttm_base_object
*base
)
286 struct drm_open_hash
*ht
= &tfile
->ref_hash
[TTM_REF_USAGE
];
287 struct drm_hash_item
*hash
;
288 struct ttm_ref_object
*ref
;
291 if (unlikely(drm_ht_find_item_rcu(ht
, base
->hash
.key
, &hash
) != 0))
295 * Verify that the ref object is really pointing to our base object.
296 * Our base object could actually be dead, and the ref object pointing
297 * to another base object with the same handle.
299 ref
= drm_hash_entry(hash
, struct ttm_ref_object
, hash
);
300 if (unlikely(base
!= ref
->obj
))
304 * Verify that the ref->obj pointer was actually valid!
307 if (unlikely(kref_read(&ref
->kref
) == 0))
317 EXPORT_SYMBOL(ttm_ref_object_exists
);
319 int ttm_ref_object_add(struct ttm_object_file
*tfile
,
320 struct ttm_base_object
*base
,
321 enum ttm_ref_type ref_type
, bool *existed
,
322 bool require_existed
)
324 struct drm_open_hash
*ht
= &tfile
->ref_hash
[ref_type
];
325 struct ttm_ref_object
*ref
;
326 struct drm_hash_item
*hash
;
327 struct ttm_mem_global
*mem_glob
= tfile
->tdev
->mem_glob
;
328 struct ttm_operation_ctx ctx
= {
329 .interruptible
= false,
334 if (base
->tfile
!= tfile
&& !base
->shareable
)
340 while (ret
== -EINVAL
) {
342 ret
= drm_ht_find_item_rcu(ht
, base
->hash
.key
, &hash
);
345 ref
= drm_hash_entry(hash
, struct ttm_ref_object
, hash
);
346 if (kref_get_unless_zero(&ref
->kref
)) {
356 ret
= ttm_mem_global_alloc(mem_glob
, sizeof(*ref
),
358 if (unlikely(ret
!= 0))
360 ref
= kmalloc(sizeof(*ref
), GFP_KERNEL
);
361 if (unlikely(ref
== NULL
)) {
362 ttm_mem_global_free(mem_glob
, sizeof(*ref
));
366 ref
->hash
.key
= base
->hash
.key
;
369 ref
->ref_type
= ref_type
;
370 kref_init(&ref
->kref
);
372 spin_lock(&tfile
->lock
);
373 ret
= drm_ht_insert_item_rcu(ht
, &ref
->hash
);
375 if (likely(ret
== 0)) {
376 list_add_tail(&ref
->head
, &tfile
->ref_list
);
377 kref_get(&base
->refcount
);
378 spin_unlock(&tfile
->lock
);
384 spin_unlock(&tfile
->lock
);
385 BUG_ON(ret
!= -EINVAL
);
387 ttm_mem_global_free(mem_glob
, sizeof(*ref
));
393 EXPORT_SYMBOL(ttm_ref_object_add
);
395 static void ttm_ref_object_release(struct kref
*kref
)
397 struct ttm_ref_object
*ref
=
398 container_of(kref
, struct ttm_ref_object
, kref
);
399 struct ttm_base_object
*base
= ref
->obj
;
400 struct ttm_object_file
*tfile
= ref
->tfile
;
401 struct drm_open_hash
*ht
;
402 struct ttm_mem_global
*mem_glob
= tfile
->tdev
->mem_glob
;
404 ht
= &tfile
->ref_hash
[ref
->ref_type
];
405 (void)drm_ht_remove_item_rcu(ht
, &ref
->hash
);
406 list_del(&ref
->head
);
407 spin_unlock(&tfile
->lock
);
409 if (ref
->ref_type
!= TTM_REF_USAGE
&& base
->ref_obj_release
)
410 base
->ref_obj_release(base
, ref
->ref_type
);
412 ttm_base_object_unref(&ref
->obj
);
413 ttm_mem_global_free(mem_glob
, sizeof(*ref
));
414 kfree_rcu(ref
, rcu_head
);
415 spin_lock(&tfile
->lock
);
418 int ttm_ref_object_base_unref(struct ttm_object_file
*tfile
,
419 unsigned long key
, enum ttm_ref_type ref_type
)
421 struct drm_open_hash
*ht
= &tfile
->ref_hash
[ref_type
];
422 struct ttm_ref_object
*ref
;
423 struct drm_hash_item
*hash
;
426 spin_lock(&tfile
->lock
);
427 ret
= drm_ht_find_item(ht
, key
, &hash
);
428 if (unlikely(ret
!= 0)) {
429 spin_unlock(&tfile
->lock
);
432 ref
= drm_hash_entry(hash
, struct ttm_ref_object
, hash
);
433 kref_put(&ref
->kref
, ttm_ref_object_release
);
434 spin_unlock(&tfile
->lock
);
437 EXPORT_SYMBOL(ttm_ref_object_base_unref
);
439 void ttm_object_file_release(struct ttm_object_file
**p_tfile
)
441 struct ttm_ref_object
*ref
;
442 struct list_head
*list
;
444 struct ttm_object_file
*tfile
= *p_tfile
;
447 spin_lock(&tfile
->lock
);
450 * Since we release the lock within the loop, we have to
451 * restart it from the beginning each time.
454 while (!list_empty(&tfile
->ref_list
)) {
455 list
= tfile
->ref_list
.next
;
456 ref
= list_entry(list
, struct ttm_ref_object
, head
);
457 ttm_ref_object_release(&ref
->kref
);
460 spin_unlock(&tfile
->lock
);
461 for (i
= 0; i
< TTM_REF_NUM
; ++i
)
462 drm_ht_remove(&tfile
->ref_hash
[i
]);
464 ttm_object_file_unref(&tfile
);
466 EXPORT_SYMBOL(ttm_object_file_release
);
468 struct ttm_object_file
*ttm_object_file_init(struct ttm_object_device
*tdev
,
469 unsigned int hash_order
)
471 struct ttm_object_file
*tfile
= kmalloc(sizeof(*tfile
), GFP_KERNEL
);
476 if (unlikely(tfile
== NULL
))
479 spin_lock_init(&tfile
->lock
);
481 kref_init(&tfile
->refcount
);
482 INIT_LIST_HEAD(&tfile
->ref_list
);
484 for (i
= 0; i
< TTM_REF_NUM
; ++i
) {
485 ret
= drm_ht_create(&tfile
->ref_hash
[i
], hash_order
);
494 for (i
= 0; i
< j
; ++i
)
495 drm_ht_remove(&tfile
->ref_hash
[i
]);
501 EXPORT_SYMBOL(ttm_object_file_init
);
503 struct ttm_object_device
*
504 ttm_object_device_init(struct ttm_mem_global
*mem_glob
,
505 unsigned int hash_order
,
506 const struct dma_buf_ops
*ops
)
508 struct ttm_object_device
*tdev
= kmalloc(sizeof(*tdev
), GFP_KERNEL
);
511 if (unlikely(tdev
== NULL
))
514 tdev
->mem_glob
= mem_glob
;
515 spin_lock_init(&tdev
->object_lock
);
516 atomic_set(&tdev
->object_count
, 0);
517 ret
= drm_ht_create(&tdev
->object_hash
, hash_order
);
519 goto out_no_object_hash
;
522 tdev
->dmabuf_release
= tdev
->ops
.release
;
523 tdev
->ops
.release
= ttm_prime_dmabuf_release
;
524 tdev
->dma_buf_size
= ttm_round_pot(sizeof(struct dma_buf
)) +
525 ttm_round_pot(sizeof(struct file
));
532 EXPORT_SYMBOL(ttm_object_device_init
);
534 void ttm_object_device_release(struct ttm_object_device
**p_tdev
)
536 struct ttm_object_device
*tdev
= *p_tdev
;
540 drm_ht_remove(&tdev
->object_hash
);
544 EXPORT_SYMBOL(ttm_object_device_release
);
547 * get_dma_buf_unless_doomed - get a dma_buf reference if possible.
549 * @dma_buf: Non-refcounted pointer to a struct dma-buf.
551 * Obtain a file reference from a lookup structure that doesn't refcount
552 * the file, but synchronizes with its release method to make sure it has
553 * not been freed yet. See for example kref_get_unless_zero documentation.
554 * Returns true if refcounting succeeds, false otherwise.
556 * Nobody really wants this as a public API yet, so let it mature here
559 static bool __must_check
get_dma_buf_unless_doomed(struct dma_buf
*dmabuf
)
561 return atomic_long_inc_not_zero(&dmabuf
->file
->f_count
) != 0L;
565 * ttm_prime_refcount_release - refcount release method for a prime object.
567 * @p_base: Pointer to ttm_base_object pointer.
569 * This is a wrapper that calls the refcount_release founction of the
570 * underlying object. At the same time it cleans up the prime object.
571 * This function is called when all references to the base object we
572 * derive from are gone.
574 static void ttm_prime_refcount_release(struct ttm_base_object
**p_base
)
576 struct ttm_base_object
*base
= *p_base
;
577 struct ttm_prime_object
*prime
;
580 prime
= container_of(base
, struct ttm_prime_object
, base
);
581 BUG_ON(prime
->dma_buf
!= NULL
);
582 mutex_destroy(&prime
->mutex
);
583 if (prime
->refcount_release
)
584 prime
->refcount_release(&base
);
588 * ttm_prime_dmabuf_release - Release method for the dma-bufs we export
592 * This function first calls the dma_buf release method the driver
593 * provides. Then it cleans up our dma_buf pointer used for lookup,
594 * and finally releases the reference the dma_buf has on our base
597 static void ttm_prime_dmabuf_release(struct dma_buf
*dma_buf
)
599 struct ttm_prime_object
*prime
=
600 (struct ttm_prime_object
*) dma_buf
->priv
;
601 struct ttm_base_object
*base
= &prime
->base
;
602 struct ttm_object_device
*tdev
= base
->tfile
->tdev
;
604 if (tdev
->dmabuf_release
)
605 tdev
->dmabuf_release(dma_buf
);
606 mutex_lock(&prime
->mutex
);
607 if (prime
->dma_buf
== dma_buf
)
608 prime
->dma_buf
= NULL
;
609 mutex_unlock(&prime
->mutex
);
610 ttm_mem_global_free(tdev
->mem_glob
, tdev
->dma_buf_size
);
611 ttm_base_object_unref(&base
);
615 * ttm_prime_fd_to_handle - Get a base object handle from a prime fd
617 * @tfile: A struct ttm_object_file identifying the caller.
618 * @fd: The prime / dmabuf fd.
619 * @handle: The returned handle.
621 * This function returns a handle to an object that previously exported
622 * a dma-buf. Note that we don't handle imports yet, because we simply
623 * have no consumers of that implementation.
625 int ttm_prime_fd_to_handle(struct ttm_object_file
*tfile
,
628 struct ttm_object_device
*tdev
= tfile
->tdev
;
629 struct dma_buf
*dma_buf
;
630 struct ttm_prime_object
*prime
;
631 struct ttm_base_object
*base
;
634 dma_buf
= dma_buf_get(fd
);
636 return PTR_ERR(dma_buf
);
638 if (dma_buf
->ops
!= &tdev
->ops
)
641 prime
= (struct ttm_prime_object
*) dma_buf
->priv
;
643 *handle
= base
->hash
.key
;
644 ret
= ttm_ref_object_add(tfile
, base
, TTM_REF_USAGE
, NULL
, false);
646 dma_buf_put(dma_buf
);
650 EXPORT_SYMBOL_GPL(ttm_prime_fd_to_handle
);
653 * ttm_prime_handle_to_fd - Return a dma_buf fd from a ttm prime object
655 * @tfile: Struct ttm_object_file identifying the caller.
656 * @handle: Handle to the object we're exporting from.
657 * @flags: flags for dma-buf creation. We just pass them on.
658 * @prime_fd: The returned file descriptor.
661 int ttm_prime_handle_to_fd(struct ttm_object_file
*tfile
,
662 uint32_t handle
, uint32_t flags
,
665 struct ttm_object_device
*tdev
= tfile
->tdev
;
666 struct ttm_base_object
*base
;
667 struct dma_buf
*dma_buf
;
668 struct ttm_prime_object
*prime
;
671 base
= ttm_base_object_lookup(tfile
, handle
);
672 if (unlikely(base
== NULL
||
673 base
->object_type
!= ttm_prime_type
)) {
678 prime
= container_of(base
, struct ttm_prime_object
, base
);
679 if (unlikely(!base
->shareable
)) {
684 ret
= mutex_lock_interruptible(&prime
->mutex
);
685 if (unlikely(ret
!= 0)) {
690 dma_buf
= prime
->dma_buf
;
691 if (!dma_buf
|| !get_dma_buf_unless_doomed(dma_buf
)) {
692 DEFINE_DMA_BUF_EXPORT_INFO(exp_info
);
693 struct ttm_operation_ctx ctx
= {
694 .interruptible
= true,
697 exp_info
.ops
= &tdev
->ops
;
698 exp_info
.size
= prime
->size
;
699 exp_info
.flags
= flags
;
700 exp_info
.priv
= prime
;
703 * Need to create a new dma_buf, with memory accounting.
705 ret
= ttm_mem_global_alloc(tdev
->mem_glob
, tdev
->dma_buf_size
,
707 if (unlikely(ret
!= 0)) {
708 mutex_unlock(&prime
->mutex
);
712 dma_buf
= dma_buf_export(&exp_info
);
713 if (IS_ERR(dma_buf
)) {
714 ret
= PTR_ERR(dma_buf
);
715 ttm_mem_global_free(tdev
->mem_glob
,
717 mutex_unlock(&prime
->mutex
);
722 * dma_buf has taken the base object reference
725 prime
->dma_buf
= dma_buf
;
727 mutex_unlock(&prime
->mutex
);
729 ret
= dma_buf_fd(dma_buf
, flags
);
734 dma_buf_put(dma_buf
);
738 ttm_base_object_unref(&base
);
741 EXPORT_SYMBOL_GPL(ttm_prime_handle_to_fd
);
744 * ttm_prime_object_init - Initialize a ttm_prime_object
746 * @tfile: struct ttm_object_file identifying the caller
747 * @size: The size of the dma_bufs we export.
748 * @prime: The object to be initialized.
749 * @shareable: See ttm_base_object_init
750 * @type: See ttm_base_object_init
751 * @refcount_release: See ttm_base_object_init
752 * @ref_obj_release: See ttm_base_object_init
754 * Initializes an object which is compatible with the drm_prime model
755 * for data sharing between processes and devices.
757 int ttm_prime_object_init(struct ttm_object_file
*tfile
, size_t size
,
758 struct ttm_prime_object
*prime
, bool shareable
,
759 enum ttm_object_type type
,
760 void (*refcount_release
) (struct ttm_base_object
**),
761 void (*ref_obj_release
) (struct ttm_base_object
*,
762 enum ttm_ref_type ref_type
))
764 mutex_init(&prime
->mutex
);
765 prime
->size
= PAGE_ALIGN(size
);
766 prime
->real_type
= type
;
767 prime
->dma_buf
= NULL
;
768 prime
->refcount_release
= refcount_release
;
769 return ttm_base_object_init(tfile
, &prime
->base
, shareable
,
771 ttm_prime_refcount_release
,
774 EXPORT_SYMBOL(ttm_prime_object_init
);