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.
140 * Import/export of syncobjs
141 * -------------------------
143 * &DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE and &DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD
144 * provide two mechanisms for import/export of syncobjs.
146 * The first lets the client import or export an entire syncobj to a file
148 * These fd's are opaque and have no other use case, except passing the
149 * syncobj between processes.
150 * All exported file descriptors and any syncobj handles created as a
151 * result of importing those file descriptors own a reference to the
152 * same underlying struct &drm_syncobj and the syncobj can be used
153 * persistently across all the processes with which it is shared.
154 * The syncobj is freed only once the last reference is dropped.
155 * Unlike dma-buf, importing a syncobj creates a new handle (with its own
156 * reference) for every import instead of de-duplicating.
157 * The primary use-case of this persistent import/export is for shared
158 * Vulkan fences and semaphores.
160 * The second import/export mechanism, which is indicated by
161 * &DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE or
162 * &DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE lets the client
163 * import/export the syncobj's current fence from/to a &sync_file.
164 * When a syncobj is exported to a sync file, that sync file wraps the
165 * sycnobj's fence at the time of export and any later signal or reset
166 * operations on the syncobj will not affect the exported sync file.
167 * When a sync file is imported into a syncobj, the syncobj's fence is set
168 * to the fence wrapped by that sync file.
169 * Because sync files are immutable, resetting or signaling the syncobj
170 * will not affect any sync files whose fences have been imported into the
174 * Import/export of timeline points in timeline syncobjs
175 * -----------------------------------------------------
177 * &DRM_IOCTL_SYNCOBJ_TRANSFER provides a mechanism to transfer a struct
178 * &dma_fence_chain of a syncobj at a given u64 point to another u64 point
179 * into another syncobj.
181 * Note that if you want to transfer a struct &dma_fence_chain from a given
182 * point on a timeline syncobj from/into a binary syncobj, you can use the
183 * point 0 to mean take/replace the fence in the syncobj.
186 #include <linux/anon_inodes.h>
187 #include <linux/file.h>
188 #include <linux/fs.h>
189 #include <linux/sched/signal.h>
190 #include <linux/sync_file.h>
191 #include <linux/uaccess.h>
194 #include <drm/drm_drv.h>
195 #include <drm/drm_file.h>
196 #include <drm/drm_gem.h>
197 #include <drm/drm_print.h>
198 #include <drm/drm_syncobj.h>
199 #include <drm/drm_utils.h>
201 #include "drm_internal.h"
203 struct syncobj_wait_entry {
204 struct list_head node;
205 struct task_struct *task;
206 struct dma_fence *fence;
207 struct dma_fence_cb fence_cb;
211 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
212 struct syncobj_wait_entry *wait);
215 * drm_syncobj_find - lookup and reference a sync object.
216 * @file_private: drm file private pointer
217 * @handle: sync object handle to lookup.
219 * Returns a reference to the syncobj pointed to by handle or NULL. The
220 * reference must be released by calling drm_syncobj_put().
222 struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
225 struct drm_syncobj *syncobj;
227 spin_lock(&file_private->syncobj_table_lock);
229 /* Check if we currently have a reference on the object */
230 syncobj = idr_find(&file_private->syncobj_idr, handle);
232 drm_syncobj_get(syncobj);
234 spin_unlock(&file_private->syncobj_table_lock);
238 EXPORT_SYMBOL(drm_syncobj_find);
240 static void drm_syncobj_fence_add_wait(struct drm_syncobj *syncobj,
241 struct syncobj_wait_entry *wait)
243 struct dma_fence *fence;
248 spin_lock(&syncobj->lock);
249 /* We've already tried once to get a fence and failed. Now that we
250 * have the lock, try one more time just to be sure we don't add a
251 * callback when a fence has already been set.
253 fence = dma_fence_get(rcu_dereference_protected(syncobj->fence, 1));
254 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
255 dma_fence_put(fence);
256 list_add_tail(&wait->node, &syncobj->cb_list);
258 wait->fence = dma_fence_get_stub();
262 spin_unlock(&syncobj->lock);
265 static void drm_syncobj_remove_wait(struct drm_syncobj *syncobj,
266 struct syncobj_wait_entry *wait)
268 if (!wait->node.next)
271 spin_lock(&syncobj->lock);
272 list_del_init(&wait->node);
273 spin_unlock(&syncobj->lock);
277 * drm_syncobj_add_point - add new timeline point to the syncobj
278 * @syncobj: sync object to add timeline point do
279 * @chain: chain node to use to add the point
280 * @fence: fence to encapsulate in the chain node
281 * @point: sequence number to use for the point
283 * Add the chain node as new timeline point to the syncobj.
285 void drm_syncobj_add_point(struct drm_syncobj *syncobj,
286 struct dma_fence_chain *chain,
287 struct dma_fence *fence,
290 struct syncobj_wait_entry *cur, *tmp;
291 struct dma_fence *prev;
293 dma_fence_get(fence);
295 spin_lock(&syncobj->lock);
297 prev = drm_syncobj_fence_get(syncobj);
298 /* You are adding an unorder point to timeline, which could cause payload returned from query_ioctl is 0! */
299 if (prev && prev->seqno >= point)
300 DRM_DEBUG("You are adding an unorder point to timeline!\n");
301 dma_fence_chain_init(chain, prev, fence, point);
302 rcu_assign_pointer(syncobj->fence, &chain->base);
304 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
305 syncobj_wait_syncobj_func(syncobj, cur);
306 spin_unlock(&syncobj->lock);
308 /* Walk the chain once to trigger garbage collection */
309 dma_fence_chain_for_each(fence, prev);
312 EXPORT_SYMBOL(drm_syncobj_add_point);
315 * drm_syncobj_replace_fence - replace fence in a sync object.
316 * @syncobj: Sync object to replace fence in
317 * @fence: fence to install in sync file.
319 * This replaces the fence on a sync object.
321 void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
322 struct dma_fence *fence)
324 struct dma_fence *old_fence;
325 struct syncobj_wait_entry *cur, *tmp;
328 dma_fence_get(fence);
330 spin_lock(&syncobj->lock);
332 old_fence = rcu_dereference_protected(syncobj->fence,
333 lockdep_is_held(&syncobj->lock));
334 rcu_assign_pointer(syncobj->fence, fence);
336 if (fence != old_fence) {
337 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
338 syncobj_wait_syncobj_func(syncobj, cur);
341 spin_unlock(&syncobj->lock);
343 dma_fence_put(old_fence);
345 EXPORT_SYMBOL(drm_syncobj_replace_fence);
348 * drm_syncobj_assign_null_handle - assign a stub fence to the sync object
349 * @syncobj: sync object to assign the fence on
351 * Assign a already signaled stub fence to the sync object.
353 static void drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
355 struct dma_fence *fence = dma_fence_get_stub();
357 drm_syncobj_replace_fence(syncobj, fence);
358 dma_fence_put(fence);
361 /* 5s default for wait submission */
362 #define DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT 5000000000ULL
364 * drm_syncobj_find_fence - lookup and reference the fence in a sync object
365 * @file_private: drm file private pointer
366 * @handle: sync object handle to lookup.
367 * @point: timeline point
368 * @flags: DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT or not
369 * @fence: out parameter for the fence
371 * This is just a convenience function that combines drm_syncobj_find() and
372 * drm_syncobj_fence_get().
374 * Returns 0 on success or a negative error value on failure. On success @fence
375 * contains a reference to the fence, which must be released by calling
378 int drm_syncobj_find_fence(struct drm_file *file_private,
379 u32 handle, u64 point, u64 flags,
380 struct dma_fence **fence)
382 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
383 struct syncobj_wait_entry wait;
384 u64 timeout = nsecs_to_jiffies64(DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT);
390 /* Waiting for userspace with locks help is illegal cause that can
391 * trivial deadlock with page faults for example. Make lockdep complain
394 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
396 lockdep_assert_none_held_once();
399 *fence = drm_syncobj_fence_get(syncobj);
402 ret = dma_fence_chain_find_seqno(fence, point);
405 dma_fence_put(*fence);
410 if (!(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
413 memset(&wait, 0, sizeof(wait));
416 drm_syncobj_fence_add_wait(syncobj, &wait);
419 set_current_state(TASK_INTERRUPTIBLE);
429 if (signal_pending(current)) {
434 timeout = schedule_timeout(timeout);
437 __set_current_state(TASK_RUNNING);
441 drm_syncobj_remove_wait(syncobj, &wait);
444 drm_syncobj_put(syncobj);
448 EXPORT_SYMBOL(drm_syncobj_find_fence);
451 * drm_syncobj_free - free a sync object.
452 * @kref: kref to free.
454 * Only to be called from kref_put in drm_syncobj_put.
456 void drm_syncobj_free(struct kref *kref)
458 struct drm_syncobj *syncobj = container_of(kref,
461 drm_syncobj_replace_fence(syncobj, NULL);
464 EXPORT_SYMBOL(drm_syncobj_free);
467 * drm_syncobj_create - create a new syncobj
468 * @out_syncobj: returned syncobj
469 * @flags: DRM_SYNCOBJ_* flags
470 * @fence: if non-NULL, the syncobj will represent this fence
472 * This is the first function to create a sync object. After creating, drivers
473 * probably want to make it available to userspace, either through
474 * drm_syncobj_get_handle() or drm_syncobj_get_fd().
476 * Returns 0 on success or a negative error value on failure.
478 int drm_syncobj_create(struct drm_syncobj **out_syncobj, uint32_t flags,
479 struct dma_fence *fence)
481 struct drm_syncobj *syncobj;
483 syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
487 kref_init(&syncobj->refcount);
488 INIT_LIST_HEAD(&syncobj->cb_list);
489 spin_lock_init(&syncobj->lock);
491 if (flags & DRM_SYNCOBJ_CREATE_SIGNALED)
492 drm_syncobj_assign_null_handle(syncobj);
495 drm_syncobj_replace_fence(syncobj, fence);
497 *out_syncobj = syncobj;
500 EXPORT_SYMBOL(drm_syncobj_create);
503 * drm_syncobj_get_handle - get a handle from a syncobj
504 * @file_private: drm file private pointer
505 * @syncobj: Sync object to export
506 * @handle: out parameter with the new handle
508 * Exports a sync object created with drm_syncobj_create() as a handle on
509 * @file_private to userspace.
511 * Returns 0 on success or a negative error value on failure.
513 int drm_syncobj_get_handle(struct drm_file *file_private,
514 struct drm_syncobj *syncobj, u32 *handle)
518 /* take a reference to put in the idr */
519 drm_syncobj_get(syncobj);
521 idr_preload(GFP_KERNEL);
522 spin_lock(&file_private->syncobj_table_lock);
523 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
524 spin_unlock(&file_private->syncobj_table_lock);
529 drm_syncobj_put(syncobj);
536 EXPORT_SYMBOL(drm_syncobj_get_handle);
538 static int drm_syncobj_create_as_handle(struct drm_file *file_private,
539 u32 *handle, uint32_t flags)
542 struct drm_syncobj *syncobj;
544 ret = drm_syncobj_create(&syncobj, flags, NULL);
548 ret = drm_syncobj_get_handle(file_private, syncobj, handle);
549 drm_syncobj_put(syncobj);
553 static int drm_syncobj_destroy(struct drm_file *file_private,
556 struct drm_syncobj *syncobj;
558 spin_lock(&file_private->syncobj_table_lock);
559 syncobj = idr_remove(&file_private->syncobj_idr, handle);
560 spin_unlock(&file_private->syncobj_table_lock);
565 drm_syncobj_put(syncobj);
569 static int drm_syncobj_file_release(struct inode *inode, struct file *file)
571 struct drm_syncobj *syncobj = file->private_data;
573 drm_syncobj_put(syncobj);
577 static const struct file_operations drm_syncobj_file_fops = {
578 .release = drm_syncobj_file_release,
582 * drm_syncobj_get_fd - get a file descriptor from a syncobj
583 * @syncobj: Sync object to export
584 * @p_fd: out parameter with the new file descriptor
586 * Exports a sync object created with drm_syncobj_create() as a file descriptor.
588 * Returns 0 on success or a negative error value on failure.
590 int drm_syncobj_get_fd(struct drm_syncobj *syncobj, int *p_fd)
595 fd = get_unused_fd_flags(O_CLOEXEC);
599 file = anon_inode_getfile("syncobj_file",
600 &drm_syncobj_file_fops,
604 return PTR_ERR(file);
607 drm_syncobj_get(syncobj);
608 fd_install(fd, file);
613 EXPORT_SYMBOL(drm_syncobj_get_fd);
615 static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
616 u32 handle, int *p_fd)
618 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
624 ret = drm_syncobj_get_fd(syncobj, p_fd);
625 drm_syncobj_put(syncobj);
629 static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
632 struct drm_syncobj *syncobj;
633 struct fd f = fdget(fd);
639 if (f.file->f_op != &drm_syncobj_file_fops) {
644 /* take a reference to put in the idr */
645 syncobj = f.file->private_data;
646 drm_syncobj_get(syncobj);
648 idr_preload(GFP_KERNEL);
649 spin_lock(&file_private->syncobj_table_lock);
650 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
651 spin_unlock(&file_private->syncobj_table_lock);
658 drm_syncobj_put(syncobj);
664 static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
667 struct dma_fence *fence = sync_file_get_fence(fd);
668 struct drm_syncobj *syncobj;
673 syncobj = drm_syncobj_find(file_private, handle);
675 dma_fence_put(fence);
679 drm_syncobj_replace_fence(syncobj, fence);
680 dma_fence_put(fence);
681 drm_syncobj_put(syncobj);
685 static int drm_syncobj_export_sync_file(struct drm_file *file_private,
686 int handle, int *p_fd)
689 struct dma_fence *fence;
690 struct sync_file *sync_file;
691 int fd = get_unused_fd_flags(O_CLOEXEC);
696 ret = drm_syncobj_find_fence(file_private, handle, 0, 0, &fence);
700 sync_file = sync_file_create(fence);
702 dma_fence_put(fence);
709 fd_install(fd, sync_file->file);
718 * drm_syncobj_open - initalizes syncobj file-private structures at devnode open time
719 * @file_private: drm file-private structure to set up
721 * Called at device open time, sets up the structure for handling refcounting
725 drm_syncobj_open(struct drm_file *file_private)
727 idr_init_base(&file_private->syncobj_idr, 1);
728 spin_lock_init(&file_private->syncobj_table_lock);
732 drm_syncobj_release_handle(int id, void *ptr, void *data)
734 struct drm_syncobj *syncobj = ptr;
736 drm_syncobj_put(syncobj);
741 * drm_syncobj_release - release file-private sync object resources
742 * @file_private: drm file-private structure to clean up
744 * Called at close time when the filp is going away.
746 * Releases any remaining references on objects by this filp.
749 drm_syncobj_release(struct drm_file *file_private)
751 idr_for_each(&file_private->syncobj_idr,
752 &drm_syncobj_release_handle, file_private);
753 idr_destroy(&file_private->syncobj_idr);
757 drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
758 struct drm_file *file_private)
760 struct drm_syncobj_create *args = data;
762 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
765 /* no valid flags yet */
766 if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
769 return drm_syncobj_create_as_handle(file_private,
770 &args->handle, args->flags);
774 drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
775 struct drm_file *file_private)
777 struct drm_syncobj_destroy *args = data;
779 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
782 /* make sure padding is empty */
785 return drm_syncobj_destroy(file_private, args->handle);
789 drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
790 struct drm_file *file_private)
792 struct drm_syncobj_handle *args = data;
794 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
800 if (args->flags != 0 &&
801 args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
804 if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
805 return drm_syncobj_export_sync_file(file_private, args->handle,
808 return drm_syncobj_handle_to_fd(file_private, args->handle,
813 drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
814 struct drm_file *file_private)
816 struct drm_syncobj_handle *args = data;
818 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
824 if (args->flags != 0 &&
825 args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
828 if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
829 return drm_syncobj_import_sync_file_fence(file_private,
833 return drm_syncobj_fd_to_handle(file_private, args->fd,
837 static int drm_syncobj_transfer_to_timeline(struct drm_file *file_private,
838 struct drm_syncobj_transfer *args)
840 struct drm_syncobj *timeline_syncobj = NULL;
841 struct dma_fence *fence;
842 struct dma_fence_chain *chain;
845 timeline_syncobj = drm_syncobj_find(file_private, args->dst_handle);
846 if (!timeline_syncobj) {
849 ret = drm_syncobj_find_fence(file_private, args->src_handle,
850 args->src_point, args->flags,
854 chain = kzalloc(sizeof(struct dma_fence_chain), GFP_KERNEL);
859 drm_syncobj_add_point(timeline_syncobj, chain, fence, args->dst_point);
861 dma_fence_put(fence);
863 drm_syncobj_put(timeline_syncobj);
869 drm_syncobj_transfer_to_binary(struct drm_file *file_private,
870 struct drm_syncobj_transfer *args)
872 struct drm_syncobj *binary_syncobj = NULL;
873 struct dma_fence *fence;
876 binary_syncobj = drm_syncobj_find(file_private, args->dst_handle);
879 ret = drm_syncobj_find_fence(file_private, args->src_handle,
880 args->src_point, args->flags, &fence);
883 drm_syncobj_replace_fence(binary_syncobj, fence);
884 dma_fence_put(fence);
886 drm_syncobj_put(binary_syncobj);
891 drm_syncobj_transfer_ioctl(struct drm_device *dev, void *data,
892 struct drm_file *file_private)
894 struct drm_syncobj_transfer *args = data;
897 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
904 ret = drm_syncobj_transfer_to_timeline(file_private, args);
906 ret = drm_syncobj_transfer_to_binary(file_private, args);
911 static void syncobj_wait_fence_func(struct dma_fence *fence,
912 struct dma_fence_cb *cb)
914 struct syncobj_wait_entry *wait =
915 container_of(cb, struct syncobj_wait_entry, fence_cb);
917 wake_up_process(wait->task);
920 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
921 struct syncobj_wait_entry *wait)
923 struct dma_fence *fence;
925 /* This happens inside the syncobj lock */
926 fence = rcu_dereference_protected(syncobj->fence,
927 lockdep_is_held(&syncobj->lock));
928 dma_fence_get(fence);
929 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
930 dma_fence_put(fence);
933 wait->fence = dma_fence_get_stub();
938 wake_up_process(wait->task);
939 list_del_init(&wait->node);
942 static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
943 void __user *user_points,
949 struct syncobj_wait_entry *entries;
950 struct dma_fence *fence;
952 uint32_t signaled_count, i;
954 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT)
955 lockdep_assert_none_held_once();
957 points = kmalloc_array(count, sizeof(*points), GFP_KERNEL);
962 memset(points, 0, count * sizeof(uint64_t));
964 } else if (copy_from_user(points, user_points,
965 sizeof(uint64_t) * count)) {
967 goto err_free_points;
970 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
973 goto err_free_points;
975 /* Walk the list of sync objects and initialize entries. We do
976 * this up-front so that we can properly return -EINVAL if there is
977 * a syncobj with a missing fence and then never have the chance of
978 * returning -EINVAL again.
981 for (i = 0; i < count; ++i) {
982 struct dma_fence *fence;
984 entries[i].task = current;
985 entries[i].point = points[i];
986 fence = drm_syncobj_fence_get(syncobjs[i]);
987 if (!fence || dma_fence_chain_find_seqno(&fence, points[i])) {
988 dma_fence_put(fence);
989 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
993 goto cleanup_entries;
998 entries[i].fence = fence;
1000 entries[i].fence = dma_fence_get_stub();
1002 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1003 dma_fence_is_signaled(entries[i].fence)) {
1004 if (signaled_count == 0 && idx)
1010 if (signaled_count == count ||
1011 (signaled_count > 0 &&
1012 !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
1013 goto cleanup_entries;
1015 /* There's a very annoying laxness in the dma_fence API here, in
1016 * that backends are not required to automatically report when a
1017 * fence is signaled prior to fence->ops->enable_signaling() being
1018 * called. So here if we fail to match signaled_count, we need to
1019 * fallthough and try a 0 timeout wait!
1022 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
1023 for (i = 0; i < count; ++i)
1024 drm_syncobj_fence_add_wait(syncobjs[i], &entries[i]);
1028 set_current_state(TASK_INTERRUPTIBLE);
1031 for (i = 0; i < count; ++i) {
1032 fence = entries[i].fence;
1036 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1037 dma_fence_is_signaled(fence) ||
1038 (!entries[i].fence_cb.func &&
1039 dma_fence_add_callback(fence,
1040 &entries[i].fence_cb,
1041 syncobj_wait_fence_func))) {
1042 /* The fence has been signaled */
1043 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
1053 if (signaled_count == count)
1061 if (signal_pending(current)) {
1062 timeout = -ERESTARTSYS;
1066 timeout = schedule_timeout(timeout);
1070 __set_current_state(TASK_RUNNING);
1073 for (i = 0; i < count; ++i) {
1074 drm_syncobj_remove_wait(syncobjs[i], &entries[i]);
1075 if (entries[i].fence_cb.func)
1076 dma_fence_remove_callback(entries[i].fence,
1077 &entries[i].fence_cb);
1078 dma_fence_put(entries[i].fence);
1089 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
1091 * @timeout_nsec: timeout nsec component in ns, 0 for poll
1093 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
1095 signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
1097 ktime_t abs_timeout, now;
1098 u64 timeout_ns, timeout_jiffies64;
1100 /* make 0 timeout means poll - absolute 0 doesn't seem valid */
1101 if (timeout_nsec == 0)
1104 abs_timeout = ns_to_ktime(timeout_nsec);
1107 if (!ktime_after(abs_timeout, now))
1110 timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
1112 timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
1113 /* clamp timeout to avoid infinite timeout */
1114 if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
1115 return MAX_SCHEDULE_TIMEOUT - 1;
1117 return timeout_jiffies64 + 1;
1119 EXPORT_SYMBOL(drm_timeout_abs_to_jiffies);
1121 static int drm_syncobj_array_wait(struct drm_device *dev,
1122 struct drm_file *file_private,
1123 struct drm_syncobj_wait *wait,
1124 struct drm_syncobj_timeline_wait *timeline_wait,
1125 struct drm_syncobj **syncobjs, bool timeline)
1127 signed long timeout = 0;
1128 uint32_t first = ~0;
1131 timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
1132 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1134 wait->count_handles,
1139 wait->first_signaled = first;
1141 timeout = drm_timeout_abs_to_jiffies(timeline_wait->timeout_nsec);
1142 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1143 u64_to_user_ptr(timeline_wait->points),
1144 timeline_wait->count_handles,
1145 timeline_wait->flags,
1149 timeline_wait->first_signaled = first;
1154 static int drm_syncobj_array_find(struct drm_file *file_private,
1155 void __user *user_handles,
1156 uint32_t count_handles,
1157 struct drm_syncobj ***syncobjs_out)
1159 uint32_t i, *handles;
1160 struct drm_syncobj **syncobjs;
1163 handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
1164 if (handles == NULL)
1167 if (copy_from_user(handles, user_handles,
1168 sizeof(uint32_t) * count_handles)) {
1170 goto err_free_handles;
1173 syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
1174 if (syncobjs == NULL) {
1176 goto err_free_handles;
1179 for (i = 0; i < count_handles; i++) {
1180 syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
1183 goto err_put_syncobjs;
1188 *syncobjs_out = syncobjs;
1193 drm_syncobj_put(syncobjs[i]);
1201 static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
1206 for (i = 0; i < count; i++)
1207 drm_syncobj_put(syncobjs[i]);
1212 drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
1213 struct drm_file *file_private)
1215 struct drm_syncobj_wait *args = data;
1216 struct drm_syncobj **syncobjs;
1219 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1222 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1223 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
1226 if (args->count_handles == 0)
1229 ret = drm_syncobj_array_find(file_private,
1230 u64_to_user_ptr(args->handles),
1231 args->count_handles,
1236 ret = drm_syncobj_array_wait(dev, file_private,
1237 args, NULL, syncobjs, false);
1239 drm_syncobj_array_free(syncobjs, args->count_handles);
1245 drm_syncobj_timeline_wait_ioctl(struct drm_device *dev, void *data,
1246 struct drm_file *file_private)
1248 struct drm_syncobj_timeline_wait *args = data;
1249 struct drm_syncobj **syncobjs;
1252 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1255 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1256 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1257 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE))
1260 if (args->count_handles == 0)
1263 ret = drm_syncobj_array_find(file_private,
1264 u64_to_user_ptr(args->handles),
1265 args->count_handles,
1270 ret = drm_syncobj_array_wait(dev, file_private,
1271 NULL, args, syncobjs, true);
1273 drm_syncobj_array_free(syncobjs, args->count_handles);
1280 drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
1281 struct drm_file *file_private)
1283 struct drm_syncobj_array *args = data;
1284 struct drm_syncobj **syncobjs;
1288 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1294 if (args->count_handles == 0)
1297 ret = drm_syncobj_array_find(file_private,
1298 u64_to_user_ptr(args->handles),
1299 args->count_handles,
1304 for (i = 0; i < args->count_handles; i++)
1305 drm_syncobj_replace_fence(syncobjs[i], NULL);
1307 drm_syncobj_array_free(syncobjs, args->count_handles);
1313 drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
1314 struct drm_file *file_private)
1316 struct drm_syncobj_array *args = data;
1317 struct drm_syncobj **syncobjs;
1321 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1327 if (args->count_handles == 0)
1330 ret = drm_syncobj_array_find(file_private,
1331 u64_to_user_ptr(args->handles),
1332 args->count_handles,
1337 for (i = 0; i < args->count_handles; i++)
1338 drm_syncobj_assign_null_handle(syncobjs[i]);
1340 drm_syncobj_array_free(syncobjs, args->count_handles);
1346 drm_syncobj_timeline_signal_ioctl(struct drm_device *dev, void *data,
1347 struct drm_file *file_private)
1349 struct drm_syncobj_timeline_array *args = data;
1350 struct drm_syncobj **syncobjs;
1351 struct dma_fence_chain **chains;
1356 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1359 if (args->flags != 0)
1362 if (args->count_handles == 0)
1365 ret = drm_syncobj_array_find(file_private,
1366 u64_to_user_ptr(args->handles),
1367 args->count_handles,
1372 points = kmalloc_array(args->count_handles, sizeof(*points),
1378 if (!u64_to_user_ptr(args->points)) {
1379 memset(points, 0, args->count_handles * sizeof(uint64_t));
1380 } else if (copy_from_user(points, u64_to_user_ptr(args->points),
1381 sizeof(uint64_t) * args->count_handles)) {
1386 chains = kmalloc_array(args->count_handles, sizeof(void *), GFP_KERNEL);
1391 for (i = 0; i < args->count_handles; i++) {
1392 chains[i] = kzalloc(sizeof(struct dma_fence_chain), GFP_KERNEL);
1394 for (j = 0; j < i; j++)
1401 for (i = 0; i < args->count_handles; i++) {
1402 struct dma_fence *fence = dma_fence_get_stub();
1404 drm_syncobj_add_point(syncobjs[i], chains[i],
1406 dma_fence_put(fence);
1413 drm_syncobj_array_free(syncobjs, args->count_handles);
1418 int drm_syncobj_query_ioctl(struct drm_device *dev, void *data,
1419 struct drm_file *file_private)
1421 struct drm_syncobj_timeline_array *args = data;
1422 struct drm_syncobj **syncobjs;
1423 uint64_t __user *points = u64_to_user_ptr(args->points);
1427 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1430 if (args->flags & ~DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED)
1433 if (args->count_handles == 0)
1436 ret = drm_syncobj_array_find(file_private,
1437 u64_to_user_ptr(args->handles),
1438 args->count_handles,
1443 for (i = 0; i < args->count_handles; i++) {
1444 struct dma_fence_chain *chain;
1445 struct dma_fence *fence;
1448 fence = drm_syncobj_fence_get(syncobjs[i]);
1449 chain = to_dma_fence_chain(fence);
1451 struct dma_fence *iter, *last_signaled =
1452 dma_fence_get(fence);
1455 DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED) {
1456 point = fence->seqno;
1458 dma_fence_chain_for_each(iter, fence) {
1459 if (iter->context != fence->context) {
1460 dma_fence_put(iter);
1461 /* It is most likely that timeline has
1462 * unorder points. */
1465 dma_fence_put(last_signaled);
1466 last_signaled = dma_fence_get(iter);
1468 point = dma_fence_is_signaled(last_signaled) ?
1469 last_signaled->seqno :
1470 to_dma_fence_chain(last_signaled)->prev_seqno;
1472 dma_fence_put(last_signaled);
1476 dma_fence_put(fence);
1477 ret = copy_to_user(&points[i], &point, sizeof(uint64_t));
1478 ret = ret ? -EFAULT : 0;
1482 drm_syncobj_array_free(syncobjs, args->count_handles);