2 * Copyright 2017 Red Hat
3 * Parts ported from amdgpu (fence wait code).
4 * Copyright 2016 Advanced Micro Devices, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
32 * DRM synchronisation objects (syncobj) are a persistent objects,
33 * that contain an optional fence. The fence can be updated with a new
36 * syncobj's can be waited upon, where it will wait for the underlying
39 * syncobj's can be export to fd's and back, these fd's are opaque and
40 * have no other use case, except passing the syncobj between processes.
42 * Their primary use-case is to implement Vulkan fences and semaphores.
44 * syncobj have a kref reference count, but also have an optional file.
45 * The file is only created once the syncobj is exported.
46 * The file takes a reference on the kref.
50 #include <linux/file.h>
52 #include <linux/anon_inodes.h>
53 #include <linux/sync_file.h>
54 #include <linux/sched/signal.h>
56 #include "drm_internal.h"
57 #include <drm/drm_syncobj.h>
60 * drm_syncobj_find - lookup and reference a sync object.
61 * @file_private: drm file private pointer
62 * @handle: sync object handle to lookup.
64 * Returns a reference to the syncobj pointed to by handle or NULL.
66 struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
69 struct drm_syncobj *syncobj;
71 spin_lock(&file_private->syncobj_table_lock);
73 /* Check if we currently have a reference on the object */
74 syncobj = idr_find(&file_private->syncobj_idr, handle);
76 drm_syncobj_get(syncobj);
78 spin_unlock(&file_private->syncobj_table_lock);
82 EXPORT_SYMBOL(drm_syncobj_find);
84 static void drm_syncobj_add_callback_locked(struct drm_syncobj *syncobj,
85 struct drm_syncobj_cb *cb,
86 drm_syncobj_func_t func)
89 list_add_tail(&cb->node, &syncobj->cb_list);
92 static int drm_syncobj_fence_get_or_add_callback(struct drm_syncobj *syncobj,
93 struct dma_fence **fence,
94 struct drm_syncobj_cb *cb,
95 drm_syncobj_func_t func)
99 *fence = drm_syncobj_fence_get(syncobj);
103 spin_lock(&syncobj->lock);
104 /* We've already tried once to get a fence and failed. Now that we
105 * have the lock, try one more time just to be sure we don't add a
106 * callback when a fence has already been set.
108 if (syncobj->fence) {
109 *fence = dma_fence_get(rcu_dereference_protected(syncobj->fence,
110 lockdep_is_held(&syncobj->lock)));
114 drm_syncobj_add_callback_locked(syncobj, cb, func);
117 spin_unlock(&syncobj->lock);
123 * drm_syncobj_add_callback - adds a callback to syncobj::cb_list
124 * @syncobj: Sync object to which to add the callback
125 * @cb: Callback to add
126 * @func: Func to use when initializing the drm_syncobj_cb struct
128 * This adds a callback to be called next time the fence is replaced
130 void drm_syncobj_add_callback(struct drm_syncobj *syncobj,
131 struct drm_syncobj_cb *cb,
132 drm_syncobj_func_t func)
134 spin_lock(&syncobj->lock);
135 drm_syncobj_add_callback_locked(syncobj, cb, func);
136 spin_unlock(&syncobj->lock);
138 EXPORT_SYMBOL(drm_syncobj_add_callback);
141 * drm_syncobj_add_callback - removes a callback to syncobj::cb_list
142 * @syncobj: Sync object from which to remove the callback
143 * @cb: Callback to remove
145 void drm_syncobj_remove_callback(struct drm_syncobj *syncobj,
146 struct drm_syncobj_cb *cb)
148 spin_lock(&syncobj->lock);
149 list_del_init(&cb->node);
150 spin_unlock(&syncobj->lock);
152 EXPORT_SYMBOL(drm_syncobj_remove_callback);
155 * drm_syncobj_replace_fence - replace fence in a sync object.
156 * @syncobj: Sync object to replace fence in
157 * @fence: fence to install in sync file.
159 * This replaces the fence on a sync object.
161 void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
162 struct dma_fence *fence)
164 struct dma_fence *old_fence;
165 struct drm_syncobj_cb *cur, *tmp;
168 dma_fence_get(fence);
170 spin_lock(&syncobj->lock);
172 old_fence = rcu_dereference_protected(syncobj->fence,
173 lockdep_is_held(&syncobj->lock));
174 rcu_assign_pointer(syncobj->fence, fence);
176 if (fence != old_fence) {
177 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node) {
178 list_del_init(&cur->node);
179 cur->func(syncobj, cur);
183 spin_unlock(&syncobj->lock);
185 dma_fence_put(old_fence);
187 EXPORT_SYMBOL(drm_syncobj_replace_fence);
189 struct drm_syncobj_null_fence {
190 struct dma_fence base;
194 static const char *drm_syncobj_null_fence_get_name(struct dma_fence *fence)
196 return "syncobjnull";
199 static bool drm_syncobj_null_fence_enable_signaling(struct dma_fence *fence)
201 dma_fence_enable_sw_signaling(fence);
202 return !dma_fence_is_signaled(fence);
205 static const struct dma_fence_ops drm_syncobj_null_fence_ops = {
206 .get_driver_name = drm_syncobj_null_fence_get_name,
207 .get_timeline_name = drm_syncobj_null_fence_get_name,
208 .enable_signaling = drm_syncobj_null_fence_enable_signaling,
209 .wait = dma_fence_default_wait,
213 static int drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
215 struct drm_syncobj_null_fence *fence;
216 fence = kzalloc(sizeof(*fence), GFP_KERNEL);
220 spin_lock_init(&fence->lock);
221 dma_fence_init(&fence->base, &drm_syncobj_null_fence_ops,
223 dma_fence_signal(&fence->base);
225 drm_syncobj_replace_fence(syncobj, &fence->base);
227 dma_fence_put(&fence->base);
232 int drm_syncobj_find_fence(struct drm_file *file_private,
234 struct dma_fence **fence)
236 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
242 *fence = drm_syncobj_fence_get(syncobj);
246 drm_syncobj_put(syncobj);
249 EXPORT_SYMBOL(drm_syncobj_find_fence);
252 * drm_syncobj_free - free a sync object.
253 * @kref: kref to free.
255 * Only to be called from kref_put in drm_syncobj_put.
257 void drm_syncobj_free(struct kref *kref)
259 struct drm_syncobj *syncobj = container_of(kref,
262 drm_syncobj_replace_fence(syncobj, NULL);
265 EXPORT_SYMBOL(drm_syncobj_free);
267 static int drm_syncobj_create(struct drm_file *file_private,
268 u32 *handle, uint32_t flags)
271 struct drm_syncobj *syncobj;
273 syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
277 kref_init(&syncobj->refcount);
278 INIT_LIST_HEAD(&syncobj->cb_list);
279 spin_lock_init(&syncobj->lock);
281 if (flags & DRM_SYNCOBJ_CREATE_SIGNALED) {
282 ret = drm_syncobj_assign_null_handle(syncobj);
284 drm_syncobj_put(syncobj);
289 idr_preload(GFP_KERNEL);
290 spin_lock(&file_private->syncobj_table_lock);
291 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
292 spin_unlock(&file_private->syncobj_table_lock);
297 drm_syncobj_put(syncobj);
305 static int drm_syncobj_destroy(struct drm_file *file_private,
308 struct drm_syncobj *syncobj;
310 spin_lock(&file_private->syncobj_table_lock);
311 syncobj = idr_remove(&file_private->syncobj_idr, handle);
312 spin_unlock(&file_private->syncobj_table_lock);
317 drm_syncobj_put(syncobj);
321 static int drm_syncobj_file_release(struct inode *inode, struct file *file)
323 struct drm_syncobj *syncobj = file->private_data;
325 drm_syncobj_put(syncobj);
329 static const struct file_operations drm_syncobj_file_fops = {
330 .release = drm_syncobj_file_release,
333 static int drm_syncobj_alloc_file(struct drm_syncobj *syncobj)
335 struct file *file = anon_inode_getfile("syncobj_file",
336 &drm_syncobj_file_fops,
339 return PTR_ERR(file);
341 drm_syncobj_get(syncobj);
342 if (cmpxchg(&syncobj->file, NULL, file)) {
350 static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
351 u32 handle, int *p_fd)
353 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
360 fd = get_unused_fd_flags(O_CLOEXEC);
362 drm_syncobj_put(syncobj);
366 if (!syncobj->file) {
367 ret = drm_syncobj_alloc_file(syncobj);
371 fd_install(fd, syncobj->file);
372 drm_syncobj_put(syncobj);
377 drm_syncobj_put(syncobj);
381 static struct drm_syncobj *drm_syncobj_fdget(int fd)
383 struct file *file = fget(fd);
387 if (file->f_op != &drm_syncobj_file_fops)
390 return file->private_data;
396 static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
399 struct drm_syncobj *syncobj = drm_syncobj_fdget(fd);
405 /* take a reference to put in the idr */
406 drm_syncobj_get(syncobj);
408 idr_preload(GFP_KERNEL);
409 spin_lock(&file_private->syncobj_table_lock);
410 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
411 spin_unlock(&file_private->syncobj_table_lock);
422 static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
425 struct dma_fence *fence = sync_file_get_fence(fd);
426 struct drm_syncobj *syncobj;
431 syncobj = drm_syncobj_find(file_private, handle);
433 dma_fence_put(fence);
437 drm_syncobj_replace_fence(syncobj, fence);
438 dma_fence_put(fence);
439 drm_syncobj_put(syncobj);
443 static int drm_syncobj_export_sync_file(struct drm_file *file_private,
444 int handle, int *p_fd)
447 struct dma_fence *fence;
448 struct sync_file *sync_file;
449 int fd = get_unused_fd_flags(O_CLOEXEC);
454 ret = drm_syncobj_find_fence(file_private, handle, &fence);
458 sync_file = sync_file_create(fence);
460 dma_fence_put(fence);
467 fd_install(fd, sync_file->file);
476 * drm_syncobj_open - initalizes syncobj file-private structures at devnode open time
477 * @file_private: drm file-private structure to set up
479 * Called at device open time, sets up the structure for handling refcounting
483 drm_syncobj_open(struct drm_file *file_private)
485 idr_init(&file_private->syncobj_idr);
486 spin_lock_init(&file_private->syncobj_table_lock);
490 drm_syncobj_release_handle(int id, void *ptr, void *data)
492 struct drm_syncobj *syncobj = ptr;
494 drm_syncobj_put(syncobj);
499 * drm_syncobj_release - release file-private sync object resources
500 * @file_private: drm file-private structure to clean up
502 * Called at close time when the filp is going away.
504 * Releases any remaining references on objects by this filp.
507 drm_syncobj_release(struct drm_file *file_private)
509 idr_for_each(&file_private->syncobj_idr,
510 &drm_syncobj_release_handle, file_private);
511 idr_destroy(&file_private->syncobj_idr);
515 drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
516 struct drm_file *file_private)
518 struct drm_syncobj_create *args = data;
520 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
523 /* no valid flags yet */
524 if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
527 return drm_syncobj_create(file_private,
528 &args->handle, args->flags);
532 drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
533 struct drm_file *file_private)
535 struct drm_syncobj_destroy *args = data;
537 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
540 /* make sure padding is empty */
543 return drm_syncobj_destroy(file_private, args->handle);
547 drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
548 struct drm_file *file_private)
550 struct drm_syncobj_handle *args = data;
552 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
558 if (args->flags != 0 &&
559 args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
562 if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
563 return drm_syncobj_export_sync_file(file_private, args->handle,
566 return drm_syncobj_handle_to_fd(file_private, args->handle,
571 drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
572 struct drm_file *file_private)
574 struct drm_syncobj_handle *args = data;
576 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
582 if (args->flags != 0 &&
583 args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
586 if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
587 return drm_syncobj_import_sync_file_fence(file_private,
591 return drm_syncobj_fd_to_handle(file_private, args->fd,
595 struct syncobj_wait_entry {
596 struct task_struct *task;
597 struct dma_fence *fence;
598 struct dma_fence_cb fence_cb;
599 struct drm_syncobj_cb syncobj_cb;
602 static void syncobj_wait_fence_func(struct dma_fence *fence,
603 struct dma_fence_cb *cb)
605 struct syncobj_wait_entry *wait =
606 container_of(cb, struct syncobj_wait_entry, fence_cb);
608 wake_up_process(wait->task);
611 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
612 struct drm_syncobj_cb *cb)
614 struct syncobj_wait_entry *wait =
615 container_of(cb, struct syncobj_wait_entry, syncobj_cb);
617 /* This happens inside the syncobj lock */
618 wait->fence = dma_fence_get(rcu_dereference_protected(syncobj->fence,
619 lockdep_is_held(&syncobj->lock)));
620 wake_up_process(wait->task);
623 static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
629 struct syncobj_wait_entry *entries;
630 struct dma_fence *fence;
632 uint32_t signaled_count, i;
634 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
638 /* Walk the list of sync objects and initialize entries. We do
639 * this up-front so that we can properly return -EINVAL if there is
640 * a syncobj with a missing fence and then never have the chance of
641 * returning -EINVAL again.
644 for (i = 0; i < count; ++i) {
645 entries[i].task = current;
646 entries[i].fence = drm_syncobj_fence_get(syncobjs[i]);
647 if (!entries[i].fence) {
648 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
652 goto cleanup_entries;
656 if (dma_fence_is_signaled(entries[i].fence)) {
657 if (signaled_count == 0 && idx)
663 /* Initialize ret to the max of timeout and 1. That way, the
664 * default return value indicates a successful wait and not a
667 ret = max_t(signed long, timeout, 1);
669 if (signaled_count == count ||
670 (signaled_count > 0 &&
671 !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
672 goto cleanup_entries;
674 /* There's a very annoying laxness in the dma_fence API here, in
675 * that backends are not required to automatically report when a
676 * fence is signaled prior to fence->ops->enable_signaling() being
677 * called. So here if we fail to match signaled_count, we need to
678 * fallthough and try a 0 timeout wait!
681 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
682 for (i = 0; i < count; ++i) {
683 drm_syncobj_fence_get_or_add_callback(syncobjs[i],
685 &entries[i].syncobj_cb,
686 syncobj_wait_syncobj_func);
691 set_current_state(TASK_INTERRUPTIBLE);
694 for (i = 0; i < count; ++i) {
695 fence = entries[i].fence;
699 if (dma_fence_is_signaled(fence) ||
700 (!entries[i].fence_cb.func &&
701 dma_fence_add_callback(fence,
702 &entries[i].fence_cb,
703 syncobj_wait_fence_func))) {
704 /* The fence has been signaled */
705 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
715 if (signaled_count == count)
719 /* If we are doing a 0 timeout wait and we got
720 * here, then we just timed out.
726 ret = schedule_timeout(ret);
728 if (ret > 0 && signal_pending(current))
733 __set_current_state(TASK_RUNNING);
736 for (i = 0; i < count; ++i) {
737 if (entries[i].syncobj_cb.func)
738 drm_syncobj_remove_callback(syncobjs[i],
739 &entries[i].syncobj_cb);
740 if (entries[i].fence_cb.func)
741 dma_fence_remove_callback(entries[i].fence,
742 &entries[i].fence_cb);
743 dma_fence_put(entries[i].fence);
751 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
753 * @timeout_nsec: timeout nsec component in ns, 0 for poll
755 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
757 static signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
759 ktime_t abs_timeout, now;
760 u64 timeout_ns, timeout_jiffies64;
762 /* make 0 timeout means poll - absolute 0 doesn't seem valid */
763 if (timeout_nsec == 0)
766 abs_timeout = ns_to_ktime(timeout_nsec);
769 if (!ktime_after(abs_timeout, now))
772 timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
774 timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
775 /* clamp timeout to avoid infinite timeout */
776 if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
777 return MAX_SCHEDULE_TIMEOUT - 1;
779 return timeout_jiffies64 + 1;
782 static int drm_syncobj_array_wait(struct drm_device *dev,
783 struct drm_file *file_private,
784 struct drm_syncobj_wait *wait,
785 struct drm_syncobj **syncobjs)
787 signed long timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
791 ret = drm_syncobj_array_wait_timeout(syncobjs,
798 wait->first_signaled = first;
804 static int drm_syncobj_array_find(struct drm_file *file_private,
805 void __user *user_handles,
806 uint32_t count_handles,
807 struct drm_syncobj ***syncobjs_out)
809 uint32_t i, *handles;
810 struct drm_syncobj **syncobjs;
813 handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
817 if (copy_from_user(handles, user_handles,
818 sizeof(uint32_t) * count_handles)) {
820 goto err_free_handles;
823 syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
824 if (syncobjs == NULL) {
826 goto err_free_handles;
829 for (i = 0; i < count_handles; i++) {
830 syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
833 goto err_put_syncobjs;
838 *syncobjs_out = syncobjs;
843 drm_syncobj_put(syncobjs[i]);
851 static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
855 for (i = 0; i < count; i++)
856 drm_syncobj_put(syncobjs[i]);
861 drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
862 struct drm_file *file_private)
864 struct drm_syncobj_wait *args = data;
865 struct drm_syncobj **syncobjs;
868 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
871 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
872 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
875 if (args->count_handles == 0)
878 ret = drm_syncobj_array_find(file_private,
879 u64_to_user_ptr(args->handles),
885 ret = drm_syncobj_array_wait(dev, file_private,
888 drm_syncobj_array_free(syncobjs, args->count_handles);
894 drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
895 struct drm_file *file_private)
897 struct drm_syncobj_array *args = data;
898 struct drm_syncobj **syncobjs;
902 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
908 if (args->count_handles == 0)
911 ret = drm_syncobj_array_find(file_private,
912 u64_to_user_ptr(args->handles),
918 for (i = 0; i < args->count_handles; i++)
919 drm_syncobj_replace_fence(syncobjs[i], NULL);
921 drm_syncobj_array_free(syncobjs, args->count_handles);
927 drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
928 struct drm_file *file_private)
930 struct drm_syncobj_array *args = data;
931 struct drm_syncobj **syncobjs;
935 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
941 if (args->count_handles == 0)
944 ret = drm_syncobj_array_find(file_private,
945 u64_to_user_ptr(args->handles),
951 for (i = 0; i < args->count_handles; i++) {
952 ret = drm_syncobj_assign_null_handle(syncobjs[i]);
957 drm_syncobj_array_free(syncobjs, args->count_handles);