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, see struct &drm_syncobj) are
33 * persistent objects that contain an optional fence. The fence can be updated
34 * with a new fence, or be NULL.
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. The
65 * reference must be released by calling drm_syncobj_put().
67 struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
70 struct drm_syncobj *syncobj;
72 spin_lock(&file_private->syncobj_table_lock);
74 /* Check if we currently have a reference on the object */
75 syncobj = idr_find(&file_private->syncobj_idr, handle);
77 drm_syncobj_get(syncobj);
79 spin_unlock(&file_private->syncobj_table_lock);
83 EXPORT_SYMBOL(drm_syncobj_find);
85 static void drm_syncobj_add_callback_locked(struct drm_syncobj *syncobj,
86 struct drm_syncobj_cb *cb,
87 drm_syncobj_func_t func)
90 list_add_tail(&cb->node, &syncobj->cb_list);
93 static int drm_syncobj_fence_get_or_add_callback(struct drm_syncobj *syncobj,
94 struct dma_fence **fence,
95 struct drm_syncobj_cb *cb,
96 drm_syncobj_func_t func)
100 *fence = drm_syncobj_fence_get(syncobj);
104 spin_lock(&syncobj->lock);
105 /* We've already tried once to get a fence and failed. Now that we
106 * have the lock, try one more time just to be sure we don't add a
107 * callback when a fence has already been set.
109 if (syncobj->fence) {
110 *fence = dma_fence_get(rcu_dereference_protected(syncobj->fence,
111 lockdep_is_held(&syncobj->lock)));
115 drm_syncobj_add_callback_locked(syncobj, cb, func);
118 spin_unlock(&syncobj->lock);
123 void drm_syncobj_add_callback(struct drm_syncobj *syncobj,
124 struct drm_syncobj_cb *cb,
125 drm_syncobj_func_t func)
127 spin_lock(&syncobj->lock);
128 drm_syncobj_add_callback_locked(syncobj, cb, func);
129 spin_unlock(&syncobj->lock);
132 void drm_syncobj_remove_callback(struct drm_syncobj *syncobj,
133 struct drm_syncobj_cb *cb)
135 spin_lock(&syncobj->lock);
136 list_del_init(&cb->node);
137 spin_unlock(&syncobj->lock);
141 * drm_syncobj_replace_fence - replace fence in a sync object.
142 * @syncobj: Sync object to replace fence in
143 * @fence: fence to install in sync file.
145 * This replaces the fence on a sync object.
147 void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
148 struct dma_fence *fence)
150 struct dma_fence *old_fence;
151 struct drm_syncobj_cb *cur, *tmp;
154 dma_fence_get(fence);
156 spin_lock(&syncobj->lock);
158 old_fence = rcu_dereference_protected(syncobj->fence,
159 lockdep_is_held(&syncobj->lock));
160 rcu_assign_pointer(syncobj->fence, fence);
162 if (fence != old_fence) {
163 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node) {
164 list_del_init(&cur->node);
165 cur->func(syncobj, cur);
169 spin_unlock(&syncobj->lock);
171 dma_fence_put(old_fence);
173 EXPORT_SYMBOL(drm_syncobj_replace_fence);
176 * drm_syncobj_assign_null_handle - assign a stub fence to the sync object
177 * @syncobj: sync object to assign the fence on
179 * Assign a already signaled stub fence to the sync object.
181 static void drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
183 struct dma_fence *fence = dma_fence_get_stub();
185 drm_syncobj_replace_fence(syncobj, fence);
186 dma_fence_put(fence);
190 * drm_syncobj_find_fence - lookup and reference the fence in a sync object
191 * @file_private: drm file private pointer
192 * @handle: sync object handle to lookup.
193 * @point: timeline point
194 * @flags: DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT or not
195 * @fence: out parameter for the fence
197 * This is just a convenience function that combines drm_syncobj_find() and
198 * drm_syncobj_fence_get().
200 * Returns 0 on success or a negative error value on failure. On success @fence
201 * contains a reference to the fence, which must be released by calling
204 int drm_syncobj_find_fence(struct drm_file *file_private,
205 u32 handle, u64 point, u64 flags,
206 struct dma_fence **fence)
208 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
214 *fence = drm_syncobj_fence_get(syncobj);
218 drm_syncobj_put(syncobj);
221 EXPORT_SYMBOL(drm_syncobj_find_fence);
224 * drm_syncobj_free - free a sync object.
225 * @kref: kref to free.
227 * Only to be called from kref_put in drm_syncobj_put.
229 void drm_syncobj_free(struct kref *kref)
231 struct drm_syncobj *syncobj = container_of(kref,
234 drm_syncobj_replace_fence(syncobj, NULL);
237 EXPORT_SYMBOL(drm_syncobj_free);
240 * drm_syncobj_create - create a new syncobj
241 * @out_syncobj: returned syncobj
242 * @flags: DRM_SYNCOBJ_* flags
243 * @fence: if non-NULL, the syncobj will represent this fence
245 * This is the first function to create a sync object. After creating, drivers
246 * probably want to make it available to userspace, either through
247 * drm_syncobj_get_handle() or drm_syncobj_get_fd().
249 * Returns 0 on success or a negative error value on failure.
251 int drm_syncobj_create(struct drm_syncobj **out_syncobj, uint32_t flags,
252 struct dma_fence *fence)
254 struct drm_syncobj *syncobj;
256 syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
260 kref_init(&syncobj->refcount);
261 INIT_LIST_HEAD(&syncobj->cb_list);
262 spin_lock_init(&syncobj->lock);
264 if (flags & DRM_SYNCOBJ_CREATE_SIGNALED)
265 drm_syncobj_assign_null_handle(syncobj);
268 drm_syncobj_replace_fence(syncobj, fence);
270 *out_syncobj = syncobj;
273 EXPORT_SYMBOL(drm_syncobj_create);
276 * drm_syncobj_get_handle - get a handle from a syncobj
277 * @file_private: drm file private pointer
278 * @syncobj: Sync object to export
279 * @handle: out parameter with the new handle
281 * Exports a sync object created with drm_syncobj_create() as a handle on
282 * @file_private to userspace.
284 * Returns 0 on success or a negative error value on failure.
286 int drm_syncobj_get_handle(struct drm_file *file_private,
287 struct drm_syncobj *syncobj, u32 *handle)
291 /* take a reference to put in the idr */
292 drm_syncobj_get(syncobj);
294 idr_preload(GFP_KERNEL);
295 spin_lock(&file_private->syncobj_table_lock);
296 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
297 spin_unlock(&file_private->syncobj_table_lock);
302 drm_syncobj_put(syncobj);
309 EXPORT_SYMBOL(drm_syncobj_get_handle);
311 static int drm_syncobj_create_as_handle(struct drm_file *file_private,
312 u32 *handle, uint32_t flags)
315 struct drm_syncobj *syncobj;
317 ret = drm_syncobj_create(&syncobj, flags, NULL);
321 ret = drm_syncobj_get_handle(file_private, syncobj, handle);
322 drm_syncobj_put(syncobj);
326 static int drm_syncobj_destroy(struct drm_file *file_private,
329 struct drm_syncobj *syncobj;
331 spin_lock(&file_private->syncobj_table_lock);
332 syncobj = idr_remove(&file_private->syncobj_idr, handle);
333 spin_unlock(&file_private->syncobj_table_lock);
338 drm_syncobj_put(syncobj);
342 static int drm_syncobj_file_release(struct inode *inode, struct file *file)
344 struct drm_syncobj *syncobj = file->private_data;
346 drm_syncobj_put(syncobj);
350 static const struct file_operations drm_syncobj_file_fops = {
351 .release = drm_syncobj_file_release,
355 * drm_syncobj_get_fd - get a file descriptor from a syncobj
356 * @syncobj: Sync object to export
357 * @p_fd: out parameter with the new file descriptor
359 * Exports a sync object created with drm_syncobj_create() as a file descriptor.
361 * Returns 0 on success or a negative error value on failure.
363 int drm_syncobj_get_fd(struct drm_syncobj *syncobj, int *p_fd)
368 fd = get_unused_fd_flags(O_CLOEXEC);
372 file = anon_inode_getfile("syncobj_file",
373 &drm_syncobj_file_fops,
377 return PTR_ERR(file);
380 drm_syncobj_get(syncobj);
381 fd_install(fd, file);
386 EXPORT_SYMBOL(drm_syncobj_get_fd);
388 static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
389 u32 handle, int *p_fd)
391 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
397 ret = drm_syncobj_get_fd(syncobj, p_fd);
398 drm_syncobj_put(syncobj);
402 static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
405 struct drm_syncobj *syncobj;
413 if (file->f_op != &drm_syncobj_file_fops) {
418 /* take a reference to put in the idr */
419 syncobj = file->private_data;
420 drm_syncobj_get(syncobj);
422 idr_preload(GFP_KERNEL);
423 spin_lock(&file_private->syncobj_table_lock);
424 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
425 spin_unlock(&file_private->syncobj_table_lock);
432 drm_syncobj_put(syncobj);
438 static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
441 struct dma_fence *fence = sync_file_get_fence(fd);
442 struct drm_syncobj *syncobj;
447 syncobj = drm_syncobj_find(file_private, handle);
449 dma_fence_put(fence);
453 drm_syncobj_replace_fence(syncobj, fence);
454 dma_fence_put(fence);
455 drm_syncobj_put(syncobj);
459 static int drm_syncobj_export_sync_file(struct drm_file *file_private,
460 int handle, int *p_fd)
463 struct dma_fence *fence;
464 struct sync_file *sync_file;
465 int fd = get_unused_fd_flags(O_CLOEXEC);
470 ret = drm_syncobj_find_fence(file_private, handle, 0, 0, &fence);
474 sync_file = sync_file_create(fence);
476 dma_fence_put(fence);
483 fd_install(fd, sync_file->file);
492 * drm_syncobj_open - initalizes syncobj file-private structures at devnode open time
493 * @file_private: drm file-private structure to set up
495 * Called at device open time, sets up the structure for handling refcounting
499 drm_syncobj_open(struct drm_file *file_private)
501 idr_init_base(&file_private->syncobj_idr, 1);
502 spin_lock_init(&file_private->syncobj_table_lock);
506 drm_syncobj_release_handle(int id, void *ptr, void *data)
508 struct drm_syncobj *syncobj = ptr;
510 drm_syncobj_put(syncobj);
515 * drm_syncobj_release - release file-private sync object resources
516 * @file_private: drm file-private structure to clean up
518 * Called at close time when the filp is going away.
520 * Releases any remaining references on objects by this filp.
523 drm_syncobj_release(struct drm_file *file_private)
525 idr_for_each(&file_private->syncobj_idr,
526 &drm_syncobj_release_handle, file_private);
527 idr_destroy(&file_private->syncobj_idr);
531 drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
532 struct drm_file *file_private)
534 struct drm_syncobj_create *args = data;
536 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
539 /* no valid flags yet */
540 if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
543 return drm_syncobj_create_as_handle(file_private,
544 &args->handle, args->flags);
548 drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
549 struct drm_file *file_private)
551 struct drm_syncobj_destroy *args = data;
553 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
556 /* make sure padding is empty */
559 return drm_syncobj_destroy(file_private, args->handle);
563 drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
564 struct drm_file *file_private)
566 struct drm_syncobj_handle *args = data;
568 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
574 if (args->flags != 0 &&
575 args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
578 if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
579 return drm_syncobj_export_sync_file(file_private, args->handle,
582 return drm_syncobj_handle_to_fd(file_private, args->handle,
587 drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
588 struct drm_file *file_private)
590 struct drm_syncobj_handle *args = data;
592 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
598 if (args->flags != 0 &&
599 args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
602 if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
603 return drm_syncobj_import_sync_file_fence(file_private,
607 return drm_syncobj_fd_to_handle(file_private, args->fd,
611 struct syncobj_wait_entry {
612 struct task_struct *task;
613 struct dma_fence *fence;
614 struct dma_fence_cb fence_cb;
615 struct drm_syncobj_cb syncobj_cb;
618 static void syncobj_wait_fence_func(struct dma_fence *fence,
619 struct dma_fence_cb *cb)
621 struct syncobj_wait_entry *wait =
622 container_of(cb, struct syncobj_wait_entry, fence_cb);
624 wake_up_process(wait->task);
627 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
628 struct drm_syncobj_cb *cb)
630 struct syncobj_wait_entry *wait =
631 container_of(cb, struct syncobj_wait_entry, syncobj_cb);
633 /* This happens inside the syncobj lock */
634 wait->fence = dma_fence_get(rcu_dereference_protected(syncobj->fence,
635 lockdep_is_held(&syncobj->lock)));
636 wake_up_process(wait->task);
639 static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
645 struct syncobj_wait_entry *entries;
646 struct dma_fence *fence;
647 uint32_t signaled_count, i;
649 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
653 /* Walk the list of sync objects and initialize entries. We do
654 * this up-front so that we can properly return -EINVAL if there is
655 * a syncobj with a missing fence and then never have the chance of
656 * returning -EINVAL again.
659 for (i = 0; i < count; ++i) {
660 entries[i].task = current;
661 entries[i].fence = drm_syncobj_fence_get(syncobjs[i]);
662 if (!entries[i].fence) {
663 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
667 goto cleanup_entries;
671 if (dma_fence_is_signaled(entries[i].fence)) {
672 if (signaled_count == 0 && idx)
678 if (signaled_count == count ||
679 (signaled_count > 0 &&
680 !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
681 goto cleanup_entries;
683 /* There's a very annoying laxness in the dma_fence API here, in
684 * that backends are not required to automatically report when a
685 * fence is signaled prior to fence->ops->enable_signaling() being
686 * called. So here if we fail to match signaled_count, we need to
687 * fallthough and try a 0 timeout wait!
690 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
691 for (i = 0; i < count; ++i) {
692 drm_syncobj_fence_get_or_add_callback(syncobjs[i],
694 &entries[i].syncobj_cb,
695 syncobj_wait_syncobj_func);
700 set_current_state(TASK_INTERRUPTIBLE);
703 for (i = 0; i < count; ++i) {
704 fence = entries[i].fence;
708 if (dma_fence_is_signaled(fence) ||
709 (!entries[i].fence_cb.func &&
710 dma_fence_add_callback(fence,
711 &entries[i].fence_cb,
712 syncobj_wait_fence_func))) {
713 /* The fence has been signaled */
714 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
724 if (signaled_count == count)
732 if (signal_pending(current)) {
733 timeout = -ERESTARTSYS;
737 timeout = schedule_timeout(timeout);
741 __set_current_state(TASK_RUNNING);
744 for (i = 0; i < count; ++i) {
745 if (entries[i].syncobj_cb.func)
746 drm_syncobj_remove_callback(syncobjs[i],
747 &entries[i].syncobj_cb);
748 if (entries[i].fence_cb.func)
749 dma_fence_remove_callback(entries[i].fence,
750 &entries[i].fence_cb);
751 dma_fence_put(entries[i].fence);
759 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
761 * @timeout_nsec: timeout nsec component in ns, 0 for poll
763 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
765 static signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
767 ktime_t abs_timeout, now;
768 u64 timeout_ns, timeout_jiffies64;
770 /* make 0 timeout means poll - absolute 0 doesn't seem valid */
771 if (timeout_nsec == 0)
774 abs_timeout = ns_to_ktime(timeout_nsec);
777 if (!ktime_after(abs_timeout, now))
780 timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
782 timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
783 /* clamp timeout to avoid infinite timeout */
784 if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
785 return MAX_SCHEDULE_TIMEOUT - 1;
787 return timeout_jiffies64 + 1;
790 static int drm_syncobj_array_wait(struct drm_device *dev,
791 struct drm_file *file_private,
792 struct drm_syncobj_wait *wait,
793 struct drm_syncobj **syncobjs)
795 signed long timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
798 timeout = drm_syncobj_array_wait_timeout(syncobjs,
805 wait->first_signaled = first;
809 static int drm_syncobj_array_find(struct drm_file *file_private,
810 void __user *user_handles,
811 uint32_t count_handles,
812 struct drm_syncobj ***syncobjs_out)
814 uint32_t i, *handles;
815 struct drm_syncobj **syncobjs;
818 handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
822 if (copy_from_user(handles, user_handles,
823 sizeof(uint32_t) * count_handles)) {
825 goto err_free_handles;
828 syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
829 if (syncobjs == NULL) {
831 goto err_free_handles;
834 for (i = 0; i < count_handles; i++) {
835 syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
838 goto err_put_syncobjs;
843 *syncobjs_out = syncobjs;
848 drm_syncobj_put(syncobjs[i]);
856 static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
860 for (i = 0; i < count; i++)
861 drm_syncobj_put(syncobjs[i]);
866 drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
867 struct drm_file *file_private)
869 struct drm_syncobj_wait *args = data;
870 struct drm_syncobj **syncobjs;
873 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
876 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
877 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
880 if (args->count_handles == 0)
883 ret = drm_syncobj_array_find(file_private,
884 u64_to_user_ptr(args->handles),
890 ret = drm_syncobj_array_wait(dev, file_private,
893 drm_syncobj_array_free(syncobjs, args->count_handles);
899 drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
900 struct drm_file *file_private)
902 struct drm_syncobj_array *args = data;
903 struct drm_syncobj **syncobjs;
907 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
913 if (args->count_handles == 0)
916 ret = drm_syncobj_array_find(file_private,
917 u64_to_user_ptr(args->handles),
923 for (i = 0; i < args->count_handles; i++)
924 drm_syncobj_replace_fence(syncobjs[i], NULL);
926 drm_syncobj_array_free(syncobjs, args->count_handles);
932 drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
933 struct drm_file *file_private)
935 struct drm_syncobj_array *args = data;
936 struct drm_syncobj **syncobjs;
940 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
946 if (args->count_handles == 0)
949 ret = drm_syncobj_array_find(file_private,
950 u64_to_user_ptr(args->handles),
956 for (i = 0; i < args->count_handles; i++)
957 drm_syncobj_assign_null_handle(syncobjs[i]);
959 drm_syncobj_array_free(syncobjs, args->count_handles);