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) provide a
33 * container for a synchronization primitive which can be used by userspace
34 * to explicitly synchronize GPU commands, can be shared between userspace
35 * processes, and can be shared between different DRM drivers.
36 * Their primary use-case is to implement Vulkan fences and semaphores.
37 * The syncobj userspace API provides ioctls for several operations:
39 * - Creation and destruction of syncobjs
40 * - Import and export of syncobjs to/from a syncobj file descriptor
41 * - Import and export a syncobj's underlying fence to/from a sync file
42 * - Reset a syncobj (set its fence to NULL)
43 * - Signal a syncobj (set a trivially signaled fence)
44 * - Wait for a syncobj's fence to appear and be signaled
46 * The syncobj userspace API also provides operations to manipulate a syncobj
47 * in terms of a timeline of struct &dma_fence_chain rather than a single
48 * struct &dma_fence, through the following operations:
50 * - Signal a given point on the timeline
51 * - Wait for a given point to appear and/or be signaled
52 * - Import and export from/to a given point of a timeline
54 * At it's core, a syncobj is simply a wrapper around a pointer to a struct
55 * &dma_fence which may be NULL.
56 * When a syncobj is first created, its pointer is either NULL or a pointer
57 * to an already signaled fence depending on whether the
58 * &DRM_SYNCOBJ_CREATE_SIGNALED flag is passed to
59 * &DRM_IOCTL_SYNCOBJ_CREATE.
61 * If the syncobj is considered as a binary (its state is either signaled or
62 * unsignaled) primitive, when GPU work is enqueued in a DRM driver to signal
63 * the syncobj, the syncobj's fence is replaced with a fence which will be
64 * signaled by the completion of that work.
65 * If the syncobj is considered as a timeline primitive, when GPU work is
66 * enqueued in a DRM driver to signal the a given point of the syncobj, a new
67 * struct &dma_fence_chain pointing to the DRM driver's fence and also
68 * pointing to the previous fence that was in the syncobj. The new struct
69 * &dma_fence_chain fence replace the syncobj's fence and will be signaled by
70 * completion of the DRM driver's work and also any work associated with the
71 * fence previously in the syncobj.
73 * When GPU work which waits on a syncobj is enqueued in a DRM driver, at the
74 * time the work is enqueued, it waits on the syncobj's fence before
75 * submitting the work to hardware. That fence is either :
77 * - The syncobj's current fence if the syncobj is considered as a binary
79 * - The struct &dma_fence associated with a given point if the syncobj is
80 * considered as a timeline primitive.
82 * If the syncobj's fence is NULL or not present in the syncobj's timeline,
83 * the enqueue operation is expected to fail.
85 * With binary syncobj, all manipulation of the syncobjs's fence happens in
86 * terms of the current fence at the time the ioctl is called by userspace
87 * regardless of whether that operation is an immediate host-side operation
88 * (signal or reset) or or an operation which is enqueued in some driver
89 * queue. &DRM_IOCTL_SYNCOBJ_RESET and &DRM_IOCTL_SYNCOBJ_SIGNAL can be used
90 * to manipulate a syncobj from the host by resetting its pointer to NULL or
91 * setting its pointer to a fence which is already signaled.
93 * With a timeline syncobj, all manipulation of the synobj's fence happens in
94 * terms of a u64 value referring to point in the timeline. See
95 * dma_fence_chain_find_seqno() to see how a given point is found in the
98 * Note that applications should be careful to always use timeline set of
99 * ioctl() when dealing with syncobj considered as timeline. Using a binary
100 * set of ioctl() with a syncobj considered as timeline could result incorrect
101 * synchronization. The use of binary syncobj is supported through the
102 * timeline set of ioctl() by using a point value of 0, this will reproduce
103 * the behavior of the binary set of ioctl() (for example replace the
104 * syncobj's fence when signaling).
107 * Host-side wait on syncobjs
108 * --------------------------
110 * &DRM_IOCTL_SYNCOBJ_WAIT takes an array of syncobj handles and does a
111 * host-side wait on all of the syncobj fences simultaneously.
112 * If &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL is set, the wait ioctl will wait on
113 * all of the syncobj fences to be signaled before it returns.
114 * Otherwise, it returns once at least one syncobj fence has been signaled
115 * and the index of a signaled fence is written back to the client.
117 * Unlike the enqueued GPU work dependencies which fail if they see a NULL
118 * fence in a syncobj, if &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT is set,
119 * the host-side wait will first wait for the syncobj to receive a non-NULL
120 * fence and then wait on that fence.
121 * If &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT is not set and any one of the
122 * syncobjs in the array has a NULL fence, -EINVAL will be returned.
123 * Assuming the syncobj starts off with a NULL fence, this allows a client
124 * to do a host wait in one thread (or process) which waits on GPU work
125 * submitted in another thread (or process) without having to manually
126 * synchronize between the two.
127 * This requirement is inherited from the Vulkan fence API.
129 * Similarly, &DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT takes an array of syncobj
130 * handles as well as an array of u64 points and does a host-side wait on all
131 * of syncobj fences at the given points simultaneously.
133 * &DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT also adds the ability to wait for a given
134 * fence to materialize on the timeline without waiting for the fence to be
135 * signaled by using the &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE flag. This
136 * requirement is inherited from the wait-before-signal behavior required by
137 * the Vulkan timeline semaphore API.
139 * Alternatively, &DRM_IOCTL_SYNCOBJ_EVENTFD can be used to wait without
140 * blocking: an eventfd will be signaled when the syncobj is. This is useful to
141 * integrate the wait in an event loop.
144 * Import/export of syncobjs
145 * -------------------------
147 * &DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE and &DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD
148 * provide two mechanisms for import/export of syncobjs.
150 * The first lets the client import or export an entire syncobj to a file
152 * These fd's are opaque and have no other use case, except passing the
153 * syncobj between processes.
154 * All exported file descriptors and any syncobj handles created as a
155 * result of importing those file descriptors own a reference to the
156 * same underlying struct &drm_syncobj and the syncobj can be used
157 * persistently across all the processes with which it is shared.
158 * The syncobj is freed only once the last reference is dropped.
159 * Unlike dma-buf, importing a syncobj creates a new handle (with its own
160 * reference) for every import instead of de-duplicating.
161 * The primary use-case of this persistent import/export is for shared
162 * Vulkan fences and semaphores.
164 * The second import/export mechanism, which is indicated by
165 * &DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE or
166 * &DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE lets the client
167 * import/export the syncobj's current fence from/to a &sync_file.
168 * When a syncobj is exported to a sync file, that sync file wraps the
169 * sycnobj's fence at the time of export and any later signal or reset
170 * operations on the syncobj will not affect the exported sync file.
171 * When a sync file is imported into a syncobj, the syncobj's fence is set
172 * to the fence wrapped by that sync file.
173 * Because sync files are immutable, resetting or signaling the syncobj
174 * will not affect any sync files whose fences have been imported into the
178 * Import/export of timeline points in timeline syncobjs
179 * -----------------------------------------------------
181 * &DRM_IOCTL_SYNCOBJ_TRANSFER provides a mechanism to transfer a struct
182 * &dma_fence_chain of a syncobj at a given u64 point to another u64 point
183 * into another syncobj.
185 * Note that if you want to transfer a struct &dma_fence_chain from a given
186 * point on a timeline syncobj from/into a binary syncobj, you can use the
187 * point 0 to mean take/replace the fence in the syncobj.
190 #include <linux/anon_inodes.h>
191 #include <linux/dma-fence-unwrap.h>
192 #include <linux/eventfd.h>
193 #include <linux/file.h>
194 #include <linux/fs.h>
195 #include <linux/sched/signal.h>
196 #include <linux/sync_file.h>
197 #include <linux/uaccess.h>
200 #include <drm/drm_drv.h>
201 #include <drm/drm_file.h>
202 #include <drm/drm_gem.h>
203 #include <drm/drm_print.h>
204 #include <drm/drm_syncobj.h>
205 #include <drm/drm_utils.h>
207 #include "drm_internal.h"
209 struct syncobj_wait_entry {
210 struct list_head node;
211 struct task_struct *task;
212 struct dma_fence *fence;
213 struct dma_fence_cb fence_cb;
217 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
218 struct syncobj_wait_entry *wait);
220 struct syncobj_eventfd_entry {
221 struct list_head node;
222 struct dma_fence *fence;
223 struct dma_fence_cb fence_cb;
224 struct drm_syncobj *syncobj;
225 struct eventfd_ctx *ev_fd_ctx;
231 syncobj_eventfd_entry_func(struct drm_syncobj *syncobj,
232 struct syncobj_eventfd_entry *entry);
235 * drm_syncobj_find - lookup and reference a sync object.
236 * @file_private: drm file private pointer
237 * @handle: sync object handle to lookup.
239 * Returns a reference to the syncobj pointed to by handle or NULL. The
240 * reference must be released by calling drm_syncobj_put().
242 struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
245 struct drm_syncobj *syncobj;
247 spin_lock(&file_private->syncobj_table_lock);
249 /* Check if we currently have a reference on the object */
250 syncobj = idr_find(&file_private->syncobj_idr, handle);
252 drm_syncobj_get(syncobj);
254 spin_unlock(&file_private->syncobj_table_lock);
258 EXPORT_SYMBOL(drm_syncobj_find);
260 static void drm_syncobj_fence_add_wait(struct drm_syncobj *syncobj,
261 struct syncobj_wait_entry *wait)
263 struct dma_fence *fence;
268 spin_lock(&syncobj->lock);
269 /* We've already tried once to get a fence and failed. Now that we
270 * have the lock, try one more time just to be sure we don't add a
271 * callback when a fence has already been set.
273 fence = dma_fence_get(rcu_dereference_protected(syncobj->fence, 1));
274 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
275 dma_fence_put(fence);
276 list_add_tail(&wait->node, &syncobj->cb_list);
278 wait->fence = dma_fence_get_stub();
282 spin_unlock(&syncobj->lock);
285 static void drm_syncobj_remove_wait(struct drm_syncobj *syncobj,
286 struct syncobj_wait_entry *wait)
288 if (!wait->node.next)
291 spin_lock(&syncobj->lock);
292 list_del_init(&wait->node);
293 spin_unlock(&syncobj->lock);
297 syncobj_eventfd_entry_free(struct syncobj_eventfd_entry *entry)
299 eventfd_ctx_put(entry->ev_fd_ctx);
300 dma_fence_put(entry->fence);
301 /* This happens either inside the syncobj lock, or after the node has
302 * already been removed from the list.
304 list_del(&entry->node);
309 drm_syncobj_add_eventfd(struct drm_syncobj *syncobj,
310 struct syncobj_eventfd_entry *entry)
312 spin_lock(&syncobj->lock);
313 list_add_tail(&entry->node, &syncobj->ev_fd_list);
314 syncobj_eventfd_entry_func(syncobj, entry);
315 spin_unlock(&syncobj->lock);
319 * drm_syncobj_add_point - add new timeline point to the syncobj
320 * @syncobj: sync object to add timeline point do
321 * @chain: chain node to use to add the point
322 * @fence: fence to encapsulate in the chain node
323 * @point: sequence number to use for the point
325 * Add the chain node as new timeline point to the syncobj.
327 void drm_syncobj_add_point(struct drm_syncobj *syncobj,
328 struct dma_fence_chain *chain,
329 struct dma_fence *fence,
332 struct syncobj_wait_entry *wait_cur, *wait_tmp;
333 struct syncobj_eventfd_entry *ev_fd_cur, *ev_fd_tmp;
334 struct dma_fence *prev;
336 dma_fence_get(fence);
338 spin_lock(&syncobj->lock);
340 prev = drm_syncobj_fence_get(syncobj);
341 /* You are adding an unorder point to timeline, which could cause payload returned from query_ioctl is 0! */
342 if (prev && prev->seqno >= point)
343 DRM_DEBUG("You are adding an unorder point to timeline!\n");
344 dma_fence_chain_init(chain, prev, fence, point);
345 rcu_assign_pointer(syncobj->fence, &chain->base);
347 list_for_each_entry_safe(wait_cur, wait_tmp, &syncobj->cb_list, node)
348 syncobj_wait_syncobj_func(syncobj, wait_cur);
349 list_for_each_entry_safe(ev_fd_cur, ev_fd_tmp, &syncobj->ev_fd_list, node)
350 syncobj_eventfd_entry_func(syncobj, ev_fd_cur);
351 spin_unlock(&syncobj->lock);
353 /* Walk the chain once to trigger garbage collection */
354 dma_fence_chain_for_each(fence, prev);
357 EXPORT_SYMBOL(drm_syncobj_add_point);
360 * drm_syncobj_replace_fence - replace fence in a sync object.
361 * @syncobj: Sync object to replace fence in
362 * @fence: fence to install in sync file.
364 * This replaces the fence on a sync object.
366 void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
367 struct dma_fence *fence)
369 struct dma_fence *old_fence;
370 struct syncobj_wait_entry *wait_cur, *wait_tmp;
371 struct syncobj_eventfd_entry *ev_fd_cur, *ev_fd_tmp;
374 dma_fence_get(fence);
376 spin_lock(&syncobj->lock);
378 old_fence = rcu_dereference_protected(syncobj->fence,
379 lockdep_is_held(&syncobj->lock));
380 rcu_assign_pointer(syncobj->fence, fence);
382 if (fence != old_fence) {
383 list_for_each_entry_safe(wait_cur, wait_tmp, &syncobj->cb_list, node)
384 syncobj_wait_syncobj_func(syncobj, wait_cur);
385 list_for_each_entry_safe(ev_fd_cur, ev_fd_tmp, &syncobj->ev_fd_list, node)
386 syncobj_eventfd_entry_func(syncobj, ev_fd_cur);
389 spin_unlock(&syncobj->lock);
391 dma_fence_put(old_fence);
393 EXPORT_SYMBOL(drm_syncobj_replace_fence);
396 * drm_syncobj_assign_null_handle - assign a stub fence to the sync object
397 * @syncobj: sync object to assign the fence on
399 * Assign a already signaled stub fence to the sync object.
401 static int drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
403 struct dma_fence *fence = dma_fence_allocate_private_stub(ktime_get());
408 drm_syncobj_replace_fence(syncobj, fence);
409 dma_fence_put(fence);
413 /* 5s default for wait submission */
414 #define DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT 5000000000ULL
416 * drm_syncobj_find_fence - lookup and reference the fence in a sync object
417 * @file_private: drm file private pointer
418 * @handle: sync object handle to lookup.
419 * @point: timeline point
420 * @flags: DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT or not
421 * @fence: out parameter for the fence
423 * This is just a convenience function that combines drm_syncobj_find() and
424 * drm_syncobj_fence_get().
426 * Returns 0 on success or a negative error value on failure. On success @fence
427 * contains a reference to the fence, which must be released by calling
430 int drm_syncobj_find_fence(struct drm_file *file_private,
431 u32 handle, u64 point, u64 flags,
432 struct dma_fence **fence)
434 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
435 struct syncobj_wait_entry wait;
436 u64 timeout = nsecs_to_jiffies64(DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT);
442 /* Waiting for userspace with locks help is illegal cause that can
443 * trivial deadlock with page faults for example. Make lockdep complain
446 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
448 lockdep_assert_none_held_once();
451 *fence = drm_syncobj_fence_get(syncobj);
454 ret = dma_fence_chain_find_seqno(fence, point);
456 /* If the requested seqno is already signaled
457 * drm_syncobj_find_fence may return a NULL
458 * fence. To make sure the recipient gets
459 * signalled, use a new fence instead.
462 *fence = dma_fence_get_stub();
466 dma_fence_put(*fence);
471 if (!(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
474 memset(&wait, 0, sizeof(wait));
477 drm_syncobj_fence_add_wait(syncobj, &wait);
480 set_current_state(TASK_INTERRUPTIBLE);
490 if (signal_pending(current)) {
495 timeout = schedule_timeout(timeout);
498 __set_current_state(TASK_RUNNING);
502 drm_syncobj_remove_wait(syncobj, &wait);
505 drm_syncobj_put(syncobj);
509 EXPORT_SYMBOL(drm_syncobj_find_fence);
512 * drm_syncobj_free - free a sync object.
513 * @kref: kref to free.
515 * Only to be called from kref_put in drm_syncobj_put.
517 void drm_syncobj_free(struct kref *kref)
519 struct drm_syncobj *syncobj = container_of(kref,
522 struct syncobj_eventfd_entry *ev_fd_cur, *ev_fd_tmp;
524 drm_syncobj_replace_fence(syncobj, NULL);
526 list_for_each_entry_safe(ev_fd_cur, ev_fd_tmp, &syncobj->ev_fd_list, node)
527 syncobj_eventfd_entry_free(ev_fd_cur);
531 EXPORT_SYMBOL(drm_syncobj_free);
534 * drm_syncobj_create - create a new syncobj
535 * @out_syncobj: returned syncobj
536 * @flags: DRM_SYNCOBJ_* flags
537 * @fence: if non-NULL, the syncobj will represent this fence
539 * This is the first function to create a sync object. After creating, drivers
540 * probably want to make it available to userspace, either through
541 * drm_syncobj_get_handle() or drm_syncobj_get_fd().
543 * Returns 0 on success or a negative error value on failure.
545 int drm_syncobj_create(struct drm_syncobj **out_syncobj, uint32_t flags,
546 struct dma_fence *fence)
549 struct drm_syncobj *syncobj;
551 syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
555 kref_init(&syncobj->refcount);
556 INIT_LIST_HEAD(&syncobj->cb_list);
557 INIT_LIST_HEAD(&syncobj->ev_fd_list);
558 spin_lock_init(&syncobj->lock);
560 if (flags & DRM_SYNCOBJ_CREATE_SIGNALED) {
561 ret = drm_syncobj_assign_null_handle(syncobj);
563 drm_syncobj_put(syncobj);
569 drm_syncobj_replace_fence(syncobj, fence);
571 *out_syncobj = syncobj;
574 EXPORT_SYMBOL(drm_syncobj_create);
577 * drm_syncobj_get_handle - get a handle from a syncobj
578 * @file_private: drm file private pointer
579 * @syncobj: Sync object to export
580 * @handle: out parameter with the new handle
582 * Exports a sync object created with drm_syncobj_create() as a handle on
583 * @file_private to userspace.
585 * Returns 0 on success or a negative error value on failure.
587 int drm_syncobj_get_handle(struct drm_file *file_private,
588 struct drm_syncobj *syncobj, u32 *handle)
592 /* take a reference to put in the idr */
593 drm_syncobj_get(syncobj);
595 idr_preload(GFP_KERNEL);
596 spin_lock(&file_private->syncobj_table_lock);
597 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
598 spin_unlock(&file_private->syncobj_table_lock);
603 drm_syncobj_put(syncobj);
610 EXPORT_SYMBOL(drm_syncobj_get_handle);
612 static int drm_syncobj_create_as_handle(struct drm_file *file_private,
613 u32 *handle, uint32_t flags)
616 struct drm_syncobj *syncobj;
618 ret = drm_syncobj_create(&syncobj, flags, NULL);
622 ret = drm_syncobj_get_handle(file_private, syncobj, handle);
623 drm_syncobj_put(syncobj);
627 static int drm_syncobj_destroy(struct drm_file *file_private,
630 struct drm_syncobj *syncobj;
632 spin_lock(&file_private->syncobj_table_lock);
633 syncobj = idr_remove(&file_private->syncobj_idr, handle);
634 spin_unlock(&file_private->syncobj_table_lock);
639 drm_syncobj_put(syncobj);
643 static int drm_syncobj_file_release(struct inode *inode, struct file *file)
645 struct drm_syncobj *syncobj = file->private_data;
647 drm_syncobj_put(syncobj);
651 static const struct file_operations drm_syncobj_file_fops = {
652 .release = drm_syncobj_file_release,
656 * drm_syncobj_get_fd - get a file descriptor from a syncobj
657 * @syncobj: Sync object to export
658 * @p_fd: out parameter with the new file descriptor
660 * Exports a sync object created with drm_syncobj_create() as a file descriptor.
662 * Returns 0 on success or a negative error value on failure.
664 int drm_syncobj_get_fd(struct drm_syncobj *syncobj, int *p_fd)
669 fd = get_unused_fd_flags(O_CLOEXEC);
673 file = anon_inode_getfile("syncobj_file",
674 &drm_syncobj_file_fops,
678 return PTR_ERR(file);
681 drm_syncobj_get(syncobj);
682 fd_install(fd, file);
687 EXPORT_SYMBOL(drm_syncobj_get_fd);
689 static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
690 u32 handle, int *p_fd)
692 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
698 ret = drm_syncobj_get_fd(syncobj, p_fd);
699 drm_syncobj_put(syncobj);
703 static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
706 struct drm_syncobj *syncobj;
707 struct fd f = fdget(fd);
713 if (f.file->f_op != &drm_syncobj_file_fops) {
718 /* take a reference to put in the idr */
719 syncobj = f.file->private_data;
720 drm_syncobj_get(syncobj);
722 idr_preload(GFP_KERNEL);
723 spin_lock(&file_private->syncobj_table_lock);
724 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
725 spin_unlock(&file_private->syncobj_table_lock);
732 drm_syncobj_put(syncobj);
738 static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
741 struct dma_fence *fence = sync_file_get_fence(fd);
742 struct drm_syncobj *syncobj;
747 syncobj = drm_syncobj_find(file_private, handle);
749 dma_fence_put(fence);
753 drm_syncobj_replace_fence(syncobj, fence);
754 dma_fence_put(fence);
755 drm_syncobj_put(syncobj);
759 static int drm_syncobj_export_sync_file(struct drm_file *file_private,
760 int handle, int *p_fd)
763 struct dma_fence *fence;
764 struct sync_file *sync_file;
765 int fd = get_unused_fd_flags(O_CLOEXEC);
770 ret = drm_syncobj_find_fence(file_private, handle, 0, 0, &fence);
774 sync_file = sync_file_create(fence);
776 dma_fence_put(fence);
783 fd_install(fd, sync_file->file);
792 * drm_syncobj_open - initializes syncobj file-private structures at devnode open time
793 * @file_private: drm file-private structure to set up
795 * Called at device open time, sets up the structure for handling refcounting
799 drm_syncobj_open(struct drm_file *file_private)
801 idr_init_base(&file_private->syncobj_idr, 1);
802 spin_lock_init(&file_private->syncobj_table_lock);
806 drm_syncobj_release_handle(int id, void *ptr, void *data)
808 struct drm_syncobj *syncobj = ptr;
810 drm_syncobj_put(syncobj);
815 * drm_syncobj_release - release file-private sync object resources
816 * @file_private: drm file-private structure to clean up
818 * Called at close time when the filp is going away.
820 * Releases any remaining references on objects by this filp.
823 drm_syncobj_release(struct drm_file *file_private)
825 idr_for_each(&file_private->syncobj_idr,
826 &drm_syncobj_release_handle, file_private);
827 idr_destroy(&file_private->syncobj_idr);
831 drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
832 struct drm_file *file_private)
834 struct drm_syncobj_create *args = data;
836 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
839 /* no valid flags yet */
840 if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
843 return drm_syncobj_create_as_handle(file_private,
844 &args->handle, args->flags);
848 drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
849 struct drm_file *file_private)
851 struct drm_syncobj_destroy *args = data;
853 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
856 /* make sure padding is empty */
859 return drm_syncobj_destroy(file_private, args->handle);
863 drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
864 struct drm_file *file_private)
866 struct drm_syncobj_handle *args = data;
868 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
874 if (args->flags != 0 &&
875 args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
878 if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
879 return drm_syncobj_export_sync_file(file_private, args->handle,
882 return drm_syncobj_handle_to_fd(file_private, args->handle,
887 drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
888 struct drm_file *file_private)
890 struct drm_syncobj_handle *args = data;
892 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
898 if (args->flags != 0 &&
899 args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
902 if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
903 return drm_syncobj_import_sync_file_fence(file_private,
907 return drm_syncobj_fd_to_handle(file_private, args->fd,
911 static int drm_syncobj_transfer_to_timeline(struct drm_file *file_private,
912 struct drm_syncobj_transfer *args)
914 struct drm_syncobj *timeline_syncobj = NULL;
915 struct dma_fence *fence, *tmp;
916 struct dma_fence_chain *chain;
919 timeline_syncobj = drm_syncobj_find(file_private, args->dst_handle);
920 if (!timeline_syncobj) {
923 ret = drm_syncobj_find_fence(file_private, args->src_handle,
924 args->src_point, args->flags,
927 goto err_put_timeline;
929 fence = dma_fence_unwrap_merge(tmp);
933 goto err_put_timeline;
936 chain = dma_fence_chain_alloc();
942 drm_syncobj_add_point(timeline_syncobj, chain, fence, args->dst_point);
944 dma_fence_put(fence);
946 drm_syncobj_put(timeline_syncobj);
952 drm_syncobj_transfer_to_binary(struct drm_file *file_private,
953 struct drm_syncobj_transfer *args)
955 struct drm_syncobj *binary_syncobj = NULL;
956 struct dma_fence *fence;
959 binary_syncobj = drm_syncobj_find(file_private, args->dst_handle);
962 ret = drm_syncobj_find_fence(file_private, args->src_handle,
963 args->src_point, args->flags, &fence);
966 drm_syncobj_replace_fence(binary_syncobj, fence);
967 dma_fence_put(fence);
969 drm_syncobj_put(binary_syncobj);
974 drm_syncobj_transfer_ioctl(struct drm_device *dev, void *data,
975 struct drm_file *file_private)
977 struct drm_syncobj_transfer *args = data;
980 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
987 ret = drm_syncobj_transfer_to_timeline(file_private, args);
989 ret = drm_syncobj_transfer_to_binary(file_private, args);
994 static void syncobj_wait_fence_func(struct dma_fence *fence,
995 struct dma_fence_cb *cb)
997 struct syncobj_wait_entry *wait =
998 container_of(cb, struct syncobj_wait_entry, fence_cb);
1000 wake_up_process(wait->task);
1003 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
1004 struct syncobj_wait_entry *wait)
1006 struct dma_fence *fence;
1008 /* This happens inside the syncobj lock */
1009 fence = rcu_dereference_protected(syncobj->fence,
1010 lockdep_is_held(&syncobj->lock));
1011 dma_fence_get(fence);
1012 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
1013 dma_fence_put(fence);
1015 } else if (!fence) {
1016 wait->fence = dma_fence_get_stub();
1018 wait->fence = fence;
1021 wake_up_process(wait->task);
1022 list_del_init(&wait->node);
1025 static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
1026 void __user *user_points,
1029 signed long timeout,
1032 struct syncobj_wait_entry *entries;
1033 struct dma_fence *fence;
1035 uint32_t signaled_count, i;
1037 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT)
1038 lockdep_assert_none_held_once();
1040 points = kmalloc_array(count, sizeof(*points), GFP_KERNEL);
1045 memset(points, 0, count * sizeof(uint64_t));
1047 } else if (copy_from_user(points, user_points,
1048 sizeof(uint64_t) * count)) {
1050 goto err_free_points;
1053 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
1056 goto err_free_points;
1058 /* Walk the list of sync objects and initialize entries. We do
1059 * this up-front so that we can properly return -EINVAL if there is
1060 * a syncobj with a missing fence and then never have the chance of
1061 * returning -EINVAL again.
1064 for (i = 0; i < count; ++i) {
1065 struct dma_fence *fence;
1067 entries[i].task = current;
1068 entries[i].point = points[i];
1069 fence = drm_syncobj_fence_get(syncobjs[i]);
1070 if (!fence || dma_fence_chain_find_seqno(&fence, points[i])) {
1071 dma_fence_put(fence);
1072 if (flags & (DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1073 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)) {
1077 goto cleanup_entries;
1082 entries[i].fence = fence;
1084 entries[i].fence = dma_fence_get_stub();
1086 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1087 dma_fence_is_signaled(entries[i].fence)) {
1088 if (signaled_count == 0 && idx)
1094 if (signaled_count == count ||
1095 (signaled_count > 0 &&
1096 !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
1097 goto cleanup_entries;
1099 /* There's a very annoying laxness in the dma_fence API here, in
1100 * that backends are not required to automatically report when a
1101 * fence is signaled prior to fence->ops->enable_signaling() being
1102 * called. So here if we fail to match signaled_count, we need to
1103 * fallthough and try a 0 timeout wait!
1106 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
1107 for (i = 0; i < count; ++i)
1108 drm_syncobj_fence_add_wait(syncobjs[i], &entries[i]);
1112 set_current_state(TASK_INTERRUPTIBLE);
1115 for (i = 0; i < count; ++i) {
1116 fence = entries[i].fence;
1120 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1121 dma_fence_is_signaled(fence) ||
1122 (!entries[i].fence_cb.func &&
1123 dma_fence_add_callback(fence,
1124 &entries[i].fence_cb,
1125 syncobj_wait_fence_func))) {
1126 /* The fence has been signaled */
1127 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
1137 if (signaled_count == count)
1145 if (signal_pending(current)) {
1146 timeout = -ERESTARTSYS;
1150 timeout = schedule_timeout(timeout);
1154 __set_current_state(TASK_RUNNING);
1157 for (i = 0; i < count; ++i) {
1158 drm_syncobj_remove_wait(syncobjs[i], &entries[i]);
1159 if (entries[i].fence_cb.func)
1160 dma_fence_remove_callback(entries[i].fence,
1161 &entries[i].fence_cb);
1162 dma_fence_put(entries[i].fence);
1173 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
1175 * @timeout_nsec: timeout nsec component in ns, 0 for poll
1177 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
1179 signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
1181 ktime_t abs_timeout, now;
1182 u64 timeout_ns, timeout_jiffies64;
1184 /* make 0 timeout means poll - absolute 0 doesn't seem valid */
1185 if (timeout_nsec == 0)
1188 abs_timeout = ns_to_ktime(timeout_nsec);
1191 if (!ktime_after(abs_timeout, now))
1194 timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
1196 timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
1197 /* clamp timeout to avoid infinite timeout */
1198 if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
1199 return MAX_SCHEDULE_TIMEOUT - 1;
1201 return timeout_jiffies64 + 1;
1203 EXPORT_SYMBOL(drm_timeout_abs_to_jiffies);
1205 static int drm_syncobj_array_wait(struct drm_device *dev,
1206 struct drm_file *file_private,
1207 struct drm_syncobj_wait *wait,
1208 struct drm_syncobj_timeline_wait *timeline_wait,
1209 struct drm_syncobj **syncobjs, bool timeline)
1211 signed long timeout = 0;
1212 uint32_t first = ~0;
1215 timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
1216 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1218 wait->count_handles,
1223 wait->first_signaled = first;
1225 timeout = drm_timeout_abs_to_jiffies(timeline_wait->timeout_nsec);
1226 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1227 u64_to_user_ptr(timeline_wait->points),
1228 timeline_wait->count_handles,
1229 timeline_wait->flags,
1233 timeline_wait->first_signaled = first;
1238 static int drm_syncobj_array_find(struct drm_file *file_private,
1239 void __user *user_handles,
1240 uint32_t count_handles,
1241 struct drm_syncobj ***syncobjs_out)
1243 uint32_t i, *handles;
1244 struct drm_syncobj **syncobjs;
1247 handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
1248 if (handles == NULL)
1251 if (copy_from_user(handles, user_handles,
1252 sizeof(uint32_t) * count_handles)) {
1254 goto err_free_handles;
1257 syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
1258 if (syncobjs == NULL) {
1260 goto err_free_handles;
1263 for (i = 0; i < count_handles; i++) {
1264 syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
1267 goto err_put_syncobjs;
1272 *syncobjs_out = syncobjs;
1277 drm_syncobj_put(syncobjs[i]);
1285 static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
1290 for (i = 0; i < count; i++)
1291 drm_syncobj_put(syncobjs[i]);
1296 drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
1297 struct drm_file *file_private)
1299 struct drm_syncobj_wait *args = data;
1300 struct drm_syncobj **syncobjs;
1303 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1306 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1307 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
1310 if (args->count_handles == 0)
1313 ret = drm_syncobj_array_find(file_private,
1314 u64_to_user_ptr(args->handles),
1315 args->count_handles,
1320 ret = drm_syncobj_array_wait(dev, file_private,
1321 args, NULL, syncobjs, false);
1323 drm_syncobj_array_free(syncobjs, args->count_handles);
1329 drm_syncobj_timeline_wait_ioctl(struct drm_device *dev, void *data,
1330 struct drm_file *file_private)
1332 struct drm_syncobj_timeline_wait *args = data;
1333 struct drm_syncobj **syncobjs;
1336 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1339 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1340 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1341 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE))
1344 if (args->count_handles == 0)
1347 ret = drm_syncobj_array_find(file_private,
1348 u64_to_user_ptr(args->handles),
1349 args->count_handles,
1354 ret = drm_syncobj_array_wait(dev, file_private,
1355 NULL, args, syncobjs, true);
1357 drm_syncobj_array_free(syncobjs, args->count_handles);
1362 static void syncobj_eventfd_entry_fence_func(struct dma_fence *fence,
1363 struct dma_fence_cb *cb)
1365 struct syncobj_eventfd_entry *entry =
1366 container_of(cb, struct syncobj_eventfd_entry, fence_cb);
1368 eventfd_signal(entry->ev_fd_ctx, 1);
1369 syncobj_eventfd_entry_free(entry);
1373 syncobj_eventfd_entry_func(struct drm_syncobj *syncobj,
1374 struct syncobj_eventfd_entry *entry)
1377 struct dma_fence *fence;
1379 /* This happens inside the syncobj lock */
1380 fence = dma_fence_get(rcu_dereference_protected(syncobj->fence, 1));
1381 ret = dma_fence_chain_find_seqno(&fence, entry->point);
1382 if (ret != 0 || !fence) {
1383 dma_fence_put(fence);
1387 list_del_init(&entry->node);
1388 entry->fence = fence;
1390 if (entry->flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) {
1391 eventfd_signal(entry->ev_fd_ctx, 1);
1392 syncobj_eventfd_entry_free(entry);
1394 ret = dma_fence_add_callback(fence, &entry->fence_cb,
1395 syncobj_eventfd_entry_fence_func);
1396 if (ret == -ENOENT) {
1397 eventfd_signal(entry->ev_fd_ctx, 1);
1398 syncobj_eventfd_entry_free(entry);
1404 drm_syncobj_eventfd_ioctl(struct drm_device *dev, void *data,
1405 struct drm_file *file_private)
1407 struct drm_syncobj_eventfd *args = data;
1408 struct drm_syncobj *syncobj;
1409 struct eventfd_ctx *ev_fd_ctx;
1410 struct syncobj_eventfd_entry *entry;
1412 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1415 if (args->flags & ~DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)
1421 syncobj = drm_syncobj_find(file_private, args->handle);
1425 ev_fd_ctx = eventfd_ctx_fdget(args->fd);
1426 if (IS_ERR(ev_fd_ctx))
1427 return PTR_ERR(ev_fd_ctx);
1429 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
1431 eventfd_ctx_put(ev_fd_ctx);
1434 entry->syncobj = syncobj;
1435 entry->ev_fd_ctx = ev_fd_ctx;
1436 entry->point = args->point;
1437 entry->flags = args->flags;
1439 drm_syncobj_add_eventfd(syncobj, entry);
1440 drm_syncobj_put(syncobj);
1446 drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
1447 struct drm_file *file_private)
1449 struct drm_syncobj_array *args = data;
1450 struct drm_syncobj **syncobjs;
1454 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1460 if (args->count_handles == 0)
1463 ret = drm_syncobj_array_find(file_private,
1464 u64_to_user_ptr(args->handles),
1465 args->count_handles,
1470 for (i = 0; i < args->count_handles; i++)
1471 drm_syncobj_replace_fence(syncobjs[i], NULL);
1473 drm_syncobj_array_free(syncobjs, args->count_handles);
1479 drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
1480 struct drm_file *file_private)
1482 struct drm_syncobj_array *args = data;
1483 struct drm_syncobj **syncobjs;
1487 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1493 if (args->count_handles == 0)
1496 ret = drm_syncobj_array_find(file_private,
1497 u64_to_user_ptr(args->handles),
1498 args->count_handles,
1503 for (i = 0; i < args->count_handles; i++) {
1504 ret = drm_syncobj_assign_null_handle(syncobjs[i]);
1509 drm_syncobj_array_free(syncobjs, args->count_handles);
1515 drm_syncobj_timeline_signal_ioctl(struct drm_device *dev, void *data,
1516 struct drm_file *file_private)
1518 struct drm_syncobj_timeline_array *args = data;
1519 struct drm_syncobj **syncobjs;
1520 struct dma_fence_chain **chains;
1525 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1528 if (args->flags != 0)
1531 if (args->count_handles == 0)
1534 ret = drm_syncobj_array_find(file_private,
1535 u64_to_user_ptr(args->handles),
1536 args->count_handles,
1541 points = kmalloc_array(args->count_handles, sizeof(*points),
1547 if (!u64_to_user_ptr(args->points)) {
1548 memset(points, 0, args->count_handles * sizeof(uint64_t));
1549 } else if (copy_from_user(points, u64_to_user_ptr(args->points),
1550 sizeof(uint64_t) * args->count_handles)) {
1555 chains = kmalloc_array(args->count_handles, sizeof(void *), GFP_KERNEL);
1560 for (i = 0; i < args->count_handles; i++) {
1561 chains[i] = dma_fence_chain_alloc();
1563 for (j = 0; j < i; j++)
1564 dma_fence_chain_free(chains[j]);
1570 for (i = 0; i < args->count_handles; i++) {
1571 struct dma_fence *fence = dma_fence_get_stub();
1573 drm_syncobj_add_point(syncobjs[i], chains[i],
1575 dma_fence_put(fence);
1582 drm_syncobj_array_free(syncobjs, args->count_handles);
1587 int drm_syncobj_query_ioctl(struct drm_device *dev, void *data,
1588 struct drm_file *file_private)
1590 struct drm_syncobj_timeline_array *args = data;
1591 struct drm_syncobj **syncobjs;
1592 uint64_t __user *points = u64_to_user_ptr(args->points);
1596 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1599 if (args->flags & ~DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED)
1602 if (args->count_handles == 0)
1605 ret = drm_syncobj_array_find(file_private,
1606 u64_to_user_ptr(args->handles),
1607 args->count_handles,
1612 for (i = 0; i < args->count_handles; i++) {
1613 struct dma_fence_chain *chain;
1614 struct dma_fence *fence;
1617 fence = drm_syncobj_fence_get(syncobjs[i]);
1618 chain = to_dma_fence_chain(fence);
1620 struct dma_fence *iter, *last_signaled =
1621 dma_fence_get(fence);
1624 DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED) {
1625 point = fence->seqno;
1627 dma_fence_chain_for_each(iter, fence) {
1628 if (iter->context != fence->context) {
1629 dma_fence_put(iter);
1630 /* It is most likely that timeline has
1631 * unorder points. */
1634 dma_fence_put(last_signaled);
1635 last_signaled = dma_fence_get(iter);
1637 point = dma_fence_is_signaled(last_signaled) ?
1638 last_signaled->seqno :
1639 to_dma_fence_chain(last_signaled)->prev_seqno;
1641 dma_fence_put(last_signaled);
1645 dma_fence_put(fence);
1646 ret = copy_to_user(&points[i], &point, sizeof(uint64_t));
1647 ret = ret ? -EFAULT : 0;
1651 drm_syncobj_array_free(syncobjs, args->count_handles);